VirtualBox.xidl@ 46775

Last change on this file since 46775 was 46775, checked in by vboxsync, 11 years ago
Main/Host(HostPower)+Session+Console: convert HostPower code to signal pause/resume/savestate through internal methods, conveying information why the method was called, preparing for VM/PDM passing this information to devices and drivers
Property svn:eol-style set to `native`
File size: 763.0 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="39463ecd-b4b8-401f-b168-76cfa87e11f0"
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="UnrestrictedExecution" value="5">
986	<desc>
987	Whether VT-x unrestricted execution is enabled. If this feature is not available, it will not be used.
988	</desc>
989	</const>
990	<const name="LargePages" value="6">
991	<desc>
992	Whether large page allocation is enabled; requires nested paging and a 64-bit host.
993	</desc>
994	</const>
995	<const name="Force" value="7">
996	<desc>
997	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
998	not set, there will be an automatic fallback to software virtualization.
999	</desc>
1000	</const>
1001	</enum>
1002
1003	<enum
1004	name="FaultToleranceState"
1005	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
1006	>
1007	<desc>
1008	Used with <link to="IMachine::faultToleranceState" />.
1009	</desc>
1010	<const name="Inactive" value="1">
1011	<desc>No fault tolerance enabled.</desc>
1012	</const>
1013	<const name="Master" value="2">
1014	<desc>Fault tolerant master VM.</desc>
1015	</const>
1016	<const name="Standby" value="3">
1017	<desc>Fault tolerant standby VM.</desc>
1018	</const>
1019	</enum>
1020
1021	<enum
1022	name="LockType"
1023	uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
1024	>
1025	<desc>
1026	Used with <link to="IMachine::lockMachine" />.
1027	</desc>
1028	<const name="Write" value="2">
1029	<desc>Lock the machine for writing. This requests an exclusive lock, i.e.
1030	there cannot be any other API client holding any type of lock for this
1031	VM concurrently. Remember that a VM process counts as an API client
1032	which implicitly holds the equivalent of a shared lock during the
1033	entire VM runtime.</desc>
1034	</const>
1035	<const name="Shared" value="1">
1036	<desc>Request only a shared lock for remote-controlling the machine.
1037	Such a lock allows changing certain VM settings which can be safely
1038	modified for a running VM.</desc>
1039	</const>
1040	<const name="VM" value="3">
1041	<desc>Lock the machine for writing, and create objects necessary for
1042	running a VM in this process.</desc>
1043	</const>
1044	</enum>
1045
1046	<enum
1047	name="SessionType"
1048	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
1049	>
1050	<desc>
1051	Session type. This enumeration represents possible values of the
1052	<link to="ISession::type"/> attribute.
1053	</desc>
1054
1055	<const name="Null" value="0">
1056	<desc>Null value (never used by the API).</desc>
1057	</const>
1058	<const name="WriteLock" value="1">
1059	<desc>
1060	Session has acquired an exclusive write lock on a machine
1061	using <link to="IMachine::lockMachine"/>.
1062	</desc>
1063	</const>
1064	<const name="Remote" value="2">
1065	<desc>
1066	Session has launched a VM process using
1067	<link to="IMachine::launchVMProcess"/>
1068	</desc>
1069	</const>
1070	<const name="Shared" value="3">
1071	<desc>
1072	Session has obtained a link to another session using
1073	<link to="IMachine::lockMachine"/>
1074	</desc>
1075	</const>
1076	</enum>
1077
1078	<enum
1079	name="DeviceType"
1080	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1081	>
1082	<desc>
1083	Device type.
1084	</desc>
1085	<const name="Null" value="0">
1086	<desc>
1087	Null value, may also mean "no device" (not allowed for
1088	<link to="IConsole::getDeviceActivity"/>).
1089	</desc>
1090	</const>
1091	<const name="Floppy" value="1">
1092	<desc>Floppy device.</desc>
1093	</const>
1094	<const name="DVD" value="2">
1095	<desc>CD/DVD-ROM device.</desc>
1096	</const>
1097	<const name="HardDisk" value="3">
1098	<desc>Hard disk device.</desc>
1099	</const>
1100	<const name="Network" value="4">
1101	<desc>Network device.</desc>
1102	</const>
1103	<const name="USB" value="5">
1104	<desc>USB device.</desc>
1105	</const>
1106	<const name="SharedFolder" value="6">
1107	<desc>Shared folder device.</desc>
1108	</const>
1109	</enum>
1110
1111	<enum
1112	name="DeviceActivity"
1113	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1114	>
1115	<desc>
1116	Device activity for <link to="IConsole::getDeviceActivity"/>.
1117	</desc>
1118
1119	<const name="Null" value="0"/>
1120	<const name="Idle" value="1"/>
1121	<const name="Reading" value="2"/>
1122	<const name="Writing" value="3"/>
1123	</enum>
1124
1125	<enum
1126	name="ClipboardMode"
1127	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1128	>
1129	<desc>
1130	Host-Guest clipboard interchange mode.
1131	</desc>
1132
1133	<const name="Disabled" value="0"/>
1134	<const name="HostToGuest" value="1"/>
1135	<const name="GuestToHost" value="2"/>
1136	<const name="Bidirectional" value="3"/>
1137	</enum>
1138
1139	<enum
1140	name="DragAndDropMode"
1141	uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1142	>
1143	<desc>
1144	Drag'n'Drop interchange mode.
1145	</desc>
1146
1147	<const name="Disabled" value="0"/>
1148	<const name="HostToGuest" value="1"/>
1149	<const name="GuestToHost" value="2"/>
1150	<const name="Bidirectional" value="3"/>
1151	</enum>
1152
1153	<enum
1154	name="Scope"
1155	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1156	>
1157	<desc>
1158	Scope of the operation.
1159
1160	A generic enumeration used in various methods to define the action or
1161	argument scope.
1162	</desc>
1163
1164	<const name="Global" value="0"/>
1165	<const name="Machine" value="1"/>
1166	<const name="Session" value="2"/>
1167	</enum>
1168
1169	<enum
1170	name="BIOSBootMenuMode"
1171	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1172	>
1173	<desc>
1174	BIOS boot menu mode.
1175	</desc>
1176
1177	<const name="Disabled" value="0"/>
1178	<const name="MenuOnly" value="1"/>
1179	<const name="MessageAndMenu" value="2"/>
1180	</enum>
1181
1182	<enum
1183	name="ProcessorFeature"
1184	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1185	>
1186	<desc>
1187	CPU features.
1188	</desc>
1189
1190	<const name="HWVirtEx" value="0"/>
1191	<const name="PAE" value="1"/>
1192	<const name="LongMode" value="2"/>
1193	<const name="NestedPaging" value="3"/>
1194	</enum>
1195
1196	<enum
1197	name="FirmwareType"
1198	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1199	>
1200	<desc>
1201	Firmware type.
1202	</desc>
1203	<const name="BIOS" value="1">
1204	<desc>BIOS Firmware.</desc>
1205	</const>
1206	<const name="EFI" value="2">
1207	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1208	</const>
1209	<const name="EFI32" value="3">
1210	<desc>Efi firmware, 32-bit.</desc>
1211	</const>
1212	<const name="EFI64" value="4">
1213	<desc>Efi firmware, 64-bit.</desc>
1214	</const>
1215	<const name="EFIDUAL" value="5">
1216	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1217	</const>
1218	</enum>
1219
1220	<enum
1221	name="PointingHIDType"
1222	uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1223	>
1224	<desc>
1225	Type of pointing device used in a virtual machine.
1226	</desc>
1227	<const name="None" value="1">
1228	<desc>No mouse.</desc>
1229	</const>
1230	<const name="PS2Mouse" value="2">
1231	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1232	</const>
1233	<const name="USBMouse" value="3">
1234	<desc>USB mouse (relative pointer).</desc>
1235	</const>
1236	<const name="USBTablet" value="4">
1237	<desc>USB tablet (absolute pointer).</desc>
1238	</const>
1239	<const name="ComboMouse" value="5">
1240	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1241	Using of such device can have negative performance implications.</desc>
1242	</const>
1243	</enum>
1244
1245	<enum
1246	name="KeyboardHIDType"
1247	uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1248	>
1249	<desc>
1250	Type of keyboard device used in a virtual machine.
1251	</desc>
1252	<const name="None" value="1">
1253	<desc>No keyboard.</desc>
1254	</const>
1255	<const name="PS2Keyboard" value="2">
1256	<desc>PS/2 keyboard.</desc>
1257	</const>
1258	<const name="USBKeyboard" value="3">
1259	<desc>USB keyboard.</desc>
1260	</const>
1261	<const name="ComboKeyboard" value="4">
1262	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1263	Using of such device can have negative performance implications.</desc>
1264	</const>
1265	</enum>
1266
1267	<!--
1268	// IVirtualBoxErrorInfo
1269	/////////////////////////////////////////////////////////////////////////
1270	-->
1271
1272	<interface
1273	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1274	uuid="c1bcc6d5-7966-481d-ab0b-d0ed73e28135"
1275	supportsErrorInfo="no"
1276	wsmap="managed"
1277	>
1278	<desc>
1279	The IVirtualBoxErrorInfo interface represents extended error information.
1280
1281	Extended error information can be set by VirtualBox components after
1282	unsuccessful or partially successful method invocation. This information
1283	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1284	and then shown to the client in addition to the plain 32-bit result code.
1285
1286	In MS COM, this interface extends the IErrorInfo interface,
1287	in XPCOM, it extends the nsIException interface. In both cases,
1288	it provides a set of common attributes to retrieve error
1289	information.
1290
1291	Sometimes invocation of some component's method may involve methods of
1292	other components that may also fail (independently of this method's
1293	failure), or a series of non-fatal errors may precede a fatal error that
1294	causes method failure. In cases like that, it may be desirable to preserve
1295	information about all errors happened during method invocation and deliver
1296	it to the caller. The <link to="#next"/> attribute is intended
1297	specifically for this purpose and allows to represent a chain of errors
1298	through a single IVirtualBoxErrorInfo object set after method invocation.
1299
1300	<note>errors are stored to a chain in the reverse order, i.e. the
1301	initial error object you query right after method invocation is the last
1302	error set by the callee, the object it points to in the @a next attribute
1303	is the previous error and so on, up to the first error (which is the last
1304	in the chain).</note>
1305	</desc>
1306
1307	<attribute name="resultCode" type="long" readonly="yes">
1308	<desc>
1309	Result code of the error.
1310	Usually, it will be the same as the result code returned
1311	by the method that provided this error information, but not
1312	always. For example, on Win32, CoCreateInstance() will most
1313	likely return E_NOINTERFACE upon unsuccessful component
1314	instantiation attempt, but not the value the component factory
1315	returned. Value is typed 'long', not 'result',
1316	to make interface usable from scripting languages.
1317	<note>
1318	In MS COM, there is no equivalent.
1319	In XPCOM, it is the same as nsIException::result.
1320	</note>
1321	</desc>
1322	</attribute>
1323
1324	<attribute name="resultDetail" type="long" readonly="yes">
1325	<desc>
1326	Optional result data of this error. This will vary depending on the
1327	actual error usage. By default this attribute is not being used.
1328	</desc>
1329	</attribute>
1330
1331	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1332	<desc>
1333	UUID of the interface that defined the error.
1334	<note>
1335	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1336	data type.
1337	In XPCOM, there is no equivalent.
1338	</note>
1339	</desc>
1340	</attribute>
1341
1342	<attribute name="component" type="wstring" readonly="yes">
1343	<desc>
1344	Name of the component that generated the error.
1345	<note>
1346	In MS COM, it is the same as IErrorInfo::GetSource.
1347	In XPCOM, there is no equivalent.
1348	</note>
1349	</desc>
1350	</attribute>
1351
1352	<attribute name="text" type="wstring" readonly="yes">
1353	<desc>
1354	Text description of the error.
1355	<note>
1356	In MS COM, it is the same as IErrorInfo::GetDescription.
1357	In XPCOM, it is the same as nsIException::message.
1358	</note>
1359	</desc>
1360	</attribute>
1361
1362	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1363	<desc>
1364	Next error object if there is any, or @c null otherwise.
1365	<note>
1366	In MS COM, there is no equivalent.
1367	In XPCOM, it is the same as nsIException::inner.
1368	</note>
1369	</desc>
1370	</attribute>
1371
1372	</interface>
1373
1374	<!--
1375	// IVirtualBox
1376	/////////////////////////////////////////////////////////////////////////
1377	-->
1378	<!-- This is experimental interface to LWIP based NAT server -->
1379	<interface name="INATNetwork" extends="$unknown"
1380	uuid="03DFD6F7-1B78-48A3-8345-C785281E9523"
1381	wsmap="managed">
1382	<attribute name="networkName" type="wstring">
1383	<desc>
1384	TBD: the idea, technically we can start any number of the NAT networks,
1385	but we should expect that at some point we will get collisions because of
1386	port-forwanding rules. so perhaps we should support only single instance of NAT
1387	network.
1388	</desc>
1389	</attribute>
1390	<attribute name="enabled" type="boolean"/>
1391	<attribute name="network" type="wstring">
1392	<desc>
1393	This is CIDR IPv4 string. Specifiying it user defines IPv4 addresses
1394	of gateway (low address + 1) and dhcp server (= low address + 2).
1395	Note: if there're defined IPv4 port-forward rules update of network
1396	will be ignored (because new assignment could break existing rules).
1397	</desc>
1398	</attribute>
1399	<attribute name="gateway" type="wstring" readonly="yes">
1400	<desc>
1401	This attribute is read-only. It's recalculated on changing
1402	network attribute (low address of network + 1).
1403	</desc>
1404	</attribute>
1405	<attribute name="IPv6Enabled" type="boolean">
1406	<desc>
1407	This attribute define whether gateway will support IPv6 or not.
1408	</desc>
1409	</attribute>
1410	<attribute name="IPv6Prefix" type="wstring">
1411	<desc>
1412	This a CIDR IPv6 defining prefix for link-local addresses
1413	autoconfiguration within network. Note: ignored if attribute
1414	IPv6Enabled is false.
1415	</desc>
1416	</attribute>
1417	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean"/>
1418	<attribute name="needDhcpServer" type="boolean"/>
1419	<attribute name="eventSource" type="IEventSource" readonly="yes"/>
1420	<attribute name="portForwardRules4" type="wstring" readonly="yes" safearray="yes">
1421	<desc>Array of NAT port-forwarding rules in string representation,
1422	in the following format:
1423	"name:protocolid:[host ip]:host port:[guest ip]:guest port".
1424	</desc>
1425	</attribute>
1426	<attribute name="portForwardRules6" type="wstring" readonly="yes" safearray="yes">
1427	<desc>Array of NAT port-forwarding rules in string representation, in the
1428	following format: "name:protocolid:[host ip]:host port:[guest ip]:guest port".
1429	</desc>
1430	</attribute>
1431	<method name="addPortForwardRule">
1432	<param name="isIpv6" type="boolean" dir="in"/>
1433	<param name="ruleName" type="wstring" dir="in"/>
1434	<param name="proto" type="NATProtocol" dir="in">
1435	<desc>Protocol handled with the rule.</desc>
1436	</param>
1437	<param name="hostIP" type="wstring" dir="in">
1438	<desc>IP of the host interface to which the rule should apply.
1439	An empty ip address is acceptable, in which case the NAT engine
1440	binds the handling socket to any interface.
1441	</desc>
1442	</param>
1443	<param name="hostPort" type="unsigned short" dir="in">
1444	<desc>The port number to listen on.</desc>
1445	</param>
1446	<param name="guestIP" type="wstring" dir="in">
1447	<desc>The IP address of the guest which the NAT engine will forward
1448	matching packets to. An empty IP address is not acceptable.</desc>
1449	</param>
1450	<param name="guestPort" type="unsigned short" dir="in">
1451	<desc>The port number to forward.</desc>
1452	</param>
1453	</method>
1454	<method name="removePortForwardRule">
1455	<param name="iSipv6" type="boolean" dir="in"/>
1456	<param name="ruleName" type="wstring" dir="in"/>
1457	</method>
1458	<method name="start">
1459	<param name="trunkType" type="wstring" dir="in">
1460	<desc>
1461	Type of internal network trunk.
1462	</desc>
1463	</param>
1464	</method>
1465	<method name="stop"/>
1466	</interface>
1467
1468	<interface
1469	name="IDHCPServer" extends="$unknown"
1470	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1471	wsmap="managed"
1472	>
1473	<desc>
1474	The IDHCPServer interface represents the vbox DHCP server configuration.
1475
1476	To enumerate all the DHCP servers on the host, use the
1477	<link to="IVirtualBox::DHCPServers"/> attribute.
1478	</desc>
1479
1480	<attribute name="enabled" type="boolean">
1481	<desc>
1482	specifies if the DHCP server is enabled
1483	</desc>
1484	</attribute>
1485
1486	<attribute name="IPAddress" type="wstring" readonly="yes">
1487	<desc>
1488	specifies server IP
1489	</desc>
1490	</attribute>
1491
1492	<attribute name="networkMask" type="wstring" readonly="yes">
1493	<desc>
1494	specifies server network mask
1495	</desc>
1496	</attribute>
1497
1498	<attribute name="networkName" type="wstring" readonly="yes">
1499	<desc>
1500	specifies internal network name the server is used for
1501	</desc>
1502	</attribute>
1503
1504	<attribute name="lowerIP" type="wstring" readonly="yes">
1505	<desc>
1506	specifies from IP address in server address range
1507	</desc>
1508	</attribute>
1509
1510	<attribute name="upperIP" type="wstring" readonly="yes">
1511	<desc>
1512	specifies to IP address in server address range
1513	</desc>
1514	</attribute>
1515
1516	<method name="setConfiguration">
1517	<desc>
1518	configures the server
1519	<result name="E_INVALIDARG">
1520	invalid configuration supplied
1521	</result>
1522	</desc>
1523	<param name="IPAddress" type="wstring" dir="in">
1524	<desc>
1525	server IP address
1526	</desc>
1527	</param>
1528	<param name="networkMask" type="wstring" dir="in">
1529	<desc>
1530	server network mask
1531	</desc>
1532	</param>
1533	<param name="FromIPAddress" type="wstring" dir="in">
1534	<desc>
1535	server From IP address for address range
1536	</desc>
1537	</param>
1538	<param name="ToIPAddress" type="wstring" dir="in">
1539	<desc>
1540	server To IP address for address range
1541	</desc>
1542	</param>
1543	</method>
1544
1545	<method name="start">
1546	<desc>
1547	Starts DHCP server process.
1548	<result name="E_FAIL">
1549	Failed to start the process.
1550	</result>
1551	</desc>
1552	<param name="networkName" type="wstring" dir="in">
1553	<desc>
1554	Name of internal network DHCP server should attach to.
1555	</desc>
1556	</param>
1557	<param name="trunkName" type="wstring" dir="in">
1558	<desc>
1559	Name of internal network trunk.
1560	</desc>
1561	</param>
1562	<param name="trunkType" type="wstring" dir="in">
1563	<desc>
1564	Type of internal network trunk.
1565	</desc>
1566	</param>
1567	</method>
1568
1569	<method name="stop">
1570	<desc>
1571	Stops DHCP server process.
1572	<result name="E_FAIL">
1573	Failed to stop the process.
1574	</result>
1575	</desc>
1576	</method>
1577	</interface>
1578
1579	<interface
1580	name="IVirtualBox" extends="$unknown"
1581	uuid="fafa4e17-1ee2-4905-a10e-fe7c18bf5554"
1582	wsmap="managed"
1583	>
1584	<desc>
1585	The IVirtualBox interface represents the main interface exposed by the
1586	product that provides virtual machine management.
1587
1588	An instance of IVirtualBox is required for the product to do anything
1589	useful. Even though the interface does not expose this, internally,
1590	IVirtualBox is implemented as a singleton and actually lives in the
1591	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1592	IVirtualBox can track the state of all virtual machines on a particular
1593	host, regardless of which frontend started them.
1594
1595	To enumerate all the virtual machines on the host, use the
1596	<link to="IVirtualBox::machines"/> attribute.
1597	</desc>
1598
1599	<attribute name="version" type="wstring" readonly="yes">
1600	<desc>
1601	A string representing the version number of the product. The
1602	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1603	last number represents the build number and will frequently change.
1604
1605	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1606	in prerelease builds. Non-Oracle builds may (/shall) also have a
1607	publisher tag, at the end. The publisher tag starts with an underscore
1608	just like the prerelease build type tag.
1609	</desc>
1610	</attribute>
1611
1612	<attribute name="versionNormalized" type="wstring" readonly="yes">
1613	<desc>
1614	A string representing the version number of the product,
1615	without the publisher information (but still with other tags).
1616	See <link to="#version" />.
1617	</desc>
1618	</attribute>
1619
1620	<attribute name="revision" type="unsigned long" readonly="yes">
1621	<desc>
1622	The internal build revision number of the product.
1623	</desc>
1624	</attribute>
1625
1626	<attribute name="packageType" type="wstring" readonly="yes">
1627	<desc>
1628	A string representing the package type of this product. The
1629	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1630	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1631	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1632	this.
1633	</desc>
1634	</attribute>
1635
1636	<attribute name="APIVersion" type="wstring" readonly="yes">
1637	<desc>
1638	A string representing the VirtualBox API version number. The format is
1639	2 integer numbers divided by an underscore (e.g. 1_0). After the
1640	first public release of packages with a particular API version the
1641	API will not be changed in an incompatible way. Note that this
1642	guarantee does not apply to development builds, and also there is no
1643	guarantee that this version is identical to the first two integer
1644	numbers of the package version.
1645	</desc>
1646	</attribute>
1647
1648	<attribute name="homeFolder" type="wstring" readonly="yes">
1649	<desc>
1650	Full path to the directory where the global settings file,
1651	<tt>VirtualBox.xml</tt>, is stored.
1652
1653	In this version of VirtualBox, the value of this property is
1654	always <tt><user_dir>/.VirtualBox</tt> (where
1655	<tt><user_dir></tt> is the path to the user directory,
1656	as determined by the host OS), and cannot be changed.
1657
1658	This path is also used as the base to resolve relative paths in
1659	places where relative paths are allowed (unless otherwise
1660	expressly indicated).
1661	</desc>
1662	</attribute>
1663
1664	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1665	<desc>
1666	Full name of the global settings file.
1667	The value of this property corresponds to the value of
1668	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1669	</desc>
1670	</attribute>
1671
1672	<attribute name="host" type="IHost" readonly="yes">
1673	<desc>Associated host object.</desc>
1674	</attribute>
1675
1676	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1677	<desc>Associated system information object.</desc>
1678	</attribute>
1679
1680	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1681	<desc>
1682	Array of machine objects registered within this VirtualBox instance.
1683	</desc>
1684	</attribute>
1685
1686	<attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1687	<desc>
1688	Array of all machine group names which are used by the machines which
1689	are accessible. Each group is only listed once, however they are listed
1690	in no particular order and there is no guarantee that there are no gaps
1691	in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1692	is a valid result).
1693	</desc>
1694	</attribute>
1695
1696	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1697	<desc>
1698	Array of medium objects known to this VirtualBox installation.
1699
1700	This array contains only base media. All differencing
1701	media of the given base medium can be enumerated using
1702	<link to="IMedium::children"/>.
1703	</desc>
1704	</attribute>
1705
1706	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1707	<desc>
1708	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1709	</desc>
1710	</attribute>
1711
1712	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1713	<desc>
1714	Array of floppy image objects currently in use by this VirtualBox instance.
1715	</desc>
1716	</attribute>
1717
1718	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1719
1720	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1721
1722	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1723	<desc>
1724	Collection of global shared folders. Global shared folders are
1725	available to all virtual machines.
1726
1727	New shared folders are added to the collection using
1728	<link to="#createSharedFolder"/>. Existing shared folders can be
1729	removed using <link to="#removeSharedFolder"/>.
1730
1731	<note>
1732	In the current version of the product, global shared folders are not
1733	implemented and therefore this collection is always empty.
1734	</note>
1735	</desc>
1736	</attribute>
1737
1738	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1739	<desc>
1740	Associated performance collector object.
1741	</desc>
1742	</attribute>
1743
1744	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1745	<desc>
1746	DHCP servers.
1747	</desc>
1748	</attribute>
1749	<!-- Array of NAT networks -->
1750	<attribute name="NATNetworks" type="INATNetwork" safearray="yes" readonly="yes"/>
1751
1752	<attribute name="eventSource" type="IEventSource" readonly="yes">
1753	<desc>
1754	Event source for VirtualBox events.
1755	</desc>
1756	</attribute>
1757
1758	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1759	<desc>
1760	The extension pack manager.
1761	</desc>
1762	</attribute>
1763
1764
1765	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1766	<desc>
1767	Names of all internal networks.
1768	</desc>
1769	</attribute>
1770
1771	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1772	<desc>
1773	Names of all generic network drivers.
1774	</desc>
1775	</attribute>
1776
1777	<method name="composeMachineFilename">
1778	<desc>
1779	Returns a recommended full path of the settings file name for a new virtual
1780	machine.
1781
1782	This API serves two purposes:
1783
1784	<ul>
1785	<li>It gets called by <link to="#createMachine" /> if @c null or
1786	empty string (which is recommended) is specified for the
1787	@a settingsFile argument there, which means that API should use
1788	a recommended default file name.</li>
1789
1790	<li>It can be called manually by a client software before creating a machine,
1791	e.g. if that client wants to pre-create the machine directory to create
1792	virtual hard disks in that directory together with the new machine
1793	settings file. In that case, the file name should be stripped from the
1794	full settings file path returned by this function to obtain the
1795	machine directory.</li>
1796	</ul>
1797
1798	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1799	details about the machine name.
1800
1801	@a groupName defines which additional subdirectory levels should be
1802	included. It must be either a valid group name or @c null or empty
1803	string which designates that the machine will not be related to a
1804	machine group.
1805
1806	If @a baseFolder is a @c null or empty string (which is recommended), the
1807	default machine settings folder
1808	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1809	a base folder for the created machine, resulting in a file name like
1810	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1811	will be used.
1812
1813	This method does not access the host disks. In particular, it does not check
1814	for whether a machine with this name already exists.
1815	</desc>
1816	<param name="name" type="wstring" dir="in">
1817	<desc>Suggested machine name.</desc>
1818	</param>
1819	<param name="group" type="wstring" dir="in">
1820	<desc>Machine group name for the new machine or machine group. It is
1821	used to determine the right subdirectory.</desc>
1822	</param>
1823	<param name="createFlags" type="wstring" dir="in">
1824	<desc>Machine creation flags, see <link to="#createMachine" /> (optional).</desc>
1825	</param>
1826	<param name="baseFolder" type="wstring" dir="in">
1827	<desc>Base machine folder (optional).</desc>
1828	</param>
1829	<param name="file" type="wstring" dir="return">
1830	<desc>Fully qualified path where the machine would be created.</desc>
1831	</param>
1832	</method>
1833
1834	<method name="createMachine">
1835	<desc>
1836	Creates a new virtual machine by creating a machine settings file at
1837	the given location.
1838
1839	VirtualBox machine settings files use a custom XML dialect. Starting
1840	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1841	and machine files can be created at arbitrary locations.
1842
1843	However, it is recommended that machines are created in the default
1844	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1845	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1846	@c null or empty string (which is recommended) for the @a settingsFile
1847	argument, <link to="#composeMachineFilename" /> is called automatically
1848	to have such a recommended name composed based on the machine name
1849	given in the @a name argument and the primary group.
1850
1851	If the resulting settings file already exists, this method will fail,
1852	unless the forceOverwrite flag is set.
1853
1854	The new machine is created unregistered, with the initial configuration
1855	set according to the specified guest OS type. A typical sequence of
1856	actions to create a new virtual machine is as follows:
1857
1858	<ol>
1859	<li>
1860	Call this method to have a new machine created. The returned machine
1861	object will be "mutable" allowing to change any machine property.
1862	</li>
1863
1864	<li>
1865	Configure the machine using the appropriate attributes and methods.
1866	</li>
1867
1868	<li>
1869	Call <link to="IMachine::saveSettings" /> to write the settings
1870	to the machine's XML settings file. The configuration of the newly
1871	created machine will not be saved to disk until this method is
1872	called.
1873	</li>
1874
1875	<li>
1876	Call <link to="#registerMachine" /> to add the machine to the list
1877	of machines known to VirtualBox.
1878	</li>
1879	</ol>
1880
1881	The specified guest OS type identifier must match an ID of one of known
1882	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1883	array.
1884
1885	<note>
1886	There is no way to change the name of the settings file or
1887	subfolder of the created machine directly.
1888	</note>
1889
1890	<result name="VBOX_E_OBJECT_NOT_FOUND">
1891	@a osTypeId is invalid.
1892	</result>
1893	<result name="VBOX_E_FILE_ERROR">
1894	Resulting settings file name is invalid or the settings file already
1895	exists or could not be created due to an I/O error.
1896	</result>
1897	<result name="E_INVALIDARG">
1898	@a name is empty or @c null.
1899	</result>
1900	</desc>
1901
1902	<param name="settingsFile" type="wstring" dir="in">
1903	<desc>Fully qualified path where the settings file should be created,
1904	empty string or @c null for a default folder and file based on the
1905	@a name argument and the primary group.
1906	(see <link to="#composeMachineFilename" />).</desc>
1907	</param>
1908	<param name="name" type="wstring" dir="in">
1909	<desc>Machine name.</desc>
1910	</param>
1911	<param name="groups" type="wstring" safearray="yes" dir="in">
1912	<desc>Array of group names. @c null or an empty array have the same
1913	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1914	create a machine without group association.</desc>
1915	</param>
1916	<param name="osTypeId" type="wstring" dir="in">
1917	<desc>Guest OS Type ID.</desc>
1918	</param>
1919	<param name="flags" type="wstring" dir="in">
1920	<desc>
1921	Additional property parameters, passed as a comma-separated list of
1922	"name=value" type entries. The following ones are recognized:
1923	<tt>forceOverwrite=1</tt> to overwrite an existing machine settings
1924	file, <tt>UUID=<uuid></tt> to specify a machine UUID and
1925	<tt>directoryIncludesUUID=1</tt> to switch to a special VM directory
1926	naming scheme which should not be used unless necessary.
1927	</desc>
1928	</param>
1929	<param name="machine" type="IMachine" dir="return">
1930	<desc>Created machine object.</desc>
1931	</param>
1932	</method>
1933
1934	<method name="openMachine">
1935	<desc>
1936	Opens a virtual machine from the existing settings file.
1937	The opened machine remains unregistered until you call
1938	<link to="#registerMachine"/>.
1939
1940	The specified settings file name must be fully qualified.
1941	The file must exist and be a valid machine XML settings file
1942	whose contents will be used to construct the machine object.
1943
1944	<result name="VBOX_E_FILE_ERROR">
1945	Settings file name invalid, not found or sharing violation.
1946	</result>
1947	</desc>
1948	<param name="settingsFile" type="wstring" dir="in">
1949	<desc>
1950	Name of the machine settings file.
1951	</desc>
1952	</param>
1953	<param name="machine" type="IMachine" dir="return">
1954	<desc>Opened machine object.</desc>
1955	</param>
1956	<note>
1957	<link to="IMachine::settingsModified"/> will return
1958	@c false for the created machine, until any of machine settings
1959	are changed.
1960	</note>
1961	</method>
1962
1963	<method name="registerMachine">
1964	<desc>
1965
1966	Registers the machine previously created using
1967	<link to="#createMachine"/> or opened using
1968	<link to="#openMachine"/> within this VirtualBox installation. After
1969	successful method invocation, the
1970	<link to="IMachineRegisteredEvent"/> event is fired.
1971
1972	<note>
1973	This method implicitly calls <link to="IMachine::saveSettings"/>
1974	to save all current machine settings before registering it.
1975	</note>
1976
1977	<result name="VBOX_E_OBJECT_NOT_FOUND">
1978	No matching virtual machine found.
1979	</result>
1980	<result name="VBOX_E_INVALID_OBJECT_STATE">
1981	Virtual machine was not created within this VirtualBox instance.
1982	</result>
1983
1984	</desc>
1985	<param name="machine" type="IMachine" dir="in"/>
1986	</method>
1987
1988	<method name="findMachine">
1989	<desc>
1990	Attempts to find a virtual machine given its name or UUID.
1991
1992	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1993	cannot safely be determined.</note>
1994
1995	<result name="VBOX_E_OBJECT_NOT_FOUND">
1996	Could not find registered machine matching @a nameOrId.
1997	</result>
1998
1999	</desc>
2000	<param name="nameOrId" type="wstring" dir="in">
2001	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
2002	</param>
2003	<param name="machine" type="IMachine" dir="return">
2004	<desc>Machine object, if found.</desc>
2005	</param>
2006	</method>
2007
2008	<method name="getMachinesByGroups">
2009	<desc>
2010	Gets all machine references which are in one of the specified groups.
2011	</desc>
2012	<param name="groups" type="wstring" dir="in" safearray="yes">
2013	<desc>What groups to match. The usual group list rules apply, i.e.
2014	passing an empty list will match VMs in the toplevel group, likewise
2015	the empty string.</desc>
2016	</param>
2017	<param name="machines" type="IMachine" dir="return" safearray="yes">
2018	<desc>All machines which matched.</desc>
2019	</param>
2020	</method>
2021
2022	<method name="getMachineStates">
2023	<desc>
2024	Gets the state of several machines in a single operation.
2025	</desc>
2026	<param name="machines" type="IMachine" dir="in" safearray="yes">
2027	<desc>Array with the machine references.</desc>
2028	</param>
2029	<param name="states" type="MachineState" dir="return" safearray="yes">
2030	<desc>Machine states, corresponding to the machines.</desc>
2031	</param>
2032	</method>
2033
2034	<method name="createAppliance">
2035	<desc>
2036	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2037	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2038	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2039	</desc>
2040	<param name="appliance" type="IAppliance" dir="return">
2041	<desc>New appliance.</desc>
2042	</param>
2043	</method>
2044
2045	<method name="createHardDisk">
2046	<desc>
2047	Creates a new base medium object that will use the given storage
2048	format and location for medium data.
2049
2050	The actual storage unit is not created by this method. In order to
2051	do it, and before you are able to attach the created medium to
2052	virtual machines, you must call one of the following methods to
2053	allocate a format-specific storage unit at the specified location:
2054	<ul>
2055	<li><link to="IMedium::createBaseStorage"/></li>
2056	<li><link to="IMedium::createDiffStorage"/></li>
2057	</ul>
2058
2059	Some medium attributes, such as <link to="IMedium::id"/>, may
2060	remain uninitialized until the medium storage unit is successfully
2061	created by one of the above methods.
2062
2063	After the storage unit is successfully created, it will be
2064	accessible through the <link to="#openMedium"/> method and can
2065	be found in the <link to="#hardDisks"/> array.
2066
2067	The list of all storage formats supported by this VirtualBox
2068	installation can be obtained using
2069	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2070	attribute is empty or @c null then the default storage format
2071	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2072	be used for creating a storage unit of the medium.
2073
2074	Note that the format of the location string is storage format specific.
2075	See <link to="IMedium::location"/> and IMedium for more details.
2076
2077	<result name="VBOX_E_OBJECT_NOT_FOUND">
2078	@a format identifier is invalid. See
2079	<link to="ISystemProperties::mediumFormats"/>.
2080	</result>
2081	<result name="VBOX_E_FILE_ERROR">
2082	@a location is a not valid file name (for file-based formats only).
2083	</result>
2084	</desc>
2085	<param name="format" type="wstring" dir="in">
2086	<desc>
2087	Identifier of the storage format to use for the new medium.
2088	</desc>
2089	</param>
2090	<param name="location" type="wstring" dir="in">
2091	<desc>
2092	Location of the storage unit for the new medium.
2093	</desc>
2094	</param>
2095	<param name="medium" type="IMedium" dir="return">
2096	<desc>Created medium object.</desc>
2097	</param>
2098	</method>
2099
2100	<method name="openMedium">
2101	<desc>
2102	Finds existing media or opens a medium from an existing storage location.
2103
2104	Once a medium has been opened, it can be passed to other VirtualBox
2105	methods, in particular to <link to="IMachine::attachDevice" />.
2106
2107	Depending on the given device type, the file at the storage location
2108	must be in one of the media formats understood by VirtualBox:
2109
2110	<ul>
2111	<li>With a "HardDisk" device type, the file must be a hard disk image
2112	in one of the formats supported by VirtualBox (see
2113	<link to="ISystemProperties::mediumFormats" />).
2114	After this method succeeds, if the medium is a base medium, it
2115	will be added to the <link to="#hardDisks"/> array attribute. </li>
2116	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
2117	After this method succeeds, the medium will be added to the
2118	<link to="#DVDImages"/> array attribute.</li>
2119	<li>With a "Floppy" device type, the file must be an RAW floppy image.
2120	After this method succeeds, the medium will be added to the
2121	<link to="#floppyImages"/> array attribute.</li>
2122	</ul>
2123
2124	After having been opened, the medium can be re-found by this method
2125	and can be attached to virtual machines. See <link to="IMedium" /> for
2126	more details.
2127
2128	The UUID of the newly opened medium will either be retrieved from the
2129	storage location, if the format supports it (e.g. for hard disk images),
2130	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
2131	If for some reason you need to change the medium's UUID, use
2132	<link to="IMedium::setIds" />.
2133
2134	If a differencing hard disk medium is to be opened by this method, the
2135	operation will succeed only if its parent medium and all ancestors,
2136	if any, are already known to this VirtualBox installation (for example,
2137	were opened by this method before).
2138
2139	This method attempts to guess the storage format of the specified medium
2140	by reading medium data at the specified location.
2141
2142	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
2143	the image is opened for read/write access and must have according permissions,
2144	as VirtualBox may actually write status information into the disk's metadata
2145	sections.
2146
2147	Note that write access is required for all typical hard disk usage in VirtualBox,
2148	since VirtualBox may need to write metadata such as a UUID into the image.
2149	The only exception is opening a source image temporarily for copying and
2150	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
2151	again soon.
2152
2153	The format of the location string is storage format specific. See
2154	<link to="IMedium::location"/> and IMedium for more details.
2155
2156	<result name="VBOX_E_FILE_ERROR">
2157	Invalid medium storage file location or could not find the medium
2158	at the specified location.
2159	</result>
2160	<result name="VBOX_E_IPRT_ERROR">
2161	Could not get medium storage format.
2162	</result>
2163	<result name="E_INVALIDARG">
2164	Invalid medium storage format.
2165	</result>
2166	<result name="VBOX_E_INVALID_OBJECT_STATE">
2167	Medium has already been added to a media registry.
2168	</result>
2169	</desc>
2170	<param name="location" type="wstring" dir="in">
2171	<desc>
2172	Location of the storage unit that contains medium data in one of
2173	the supported storage formats.
2174	</desc>
2175	</param>
2176	<param name="deviceType" type="DeviceType" dir="in">
2177	<desc>
2178	Must be one of "HardDisk", "DVD" or "Floppy".
2179	</desc>
2180	</param>
2181	<param name="accessMode" type="AccessMode" dir="in">
2182	<desc>Whether to open the image in read/write or read-only mode. For
2183	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2184	</param>
2185	<param name="forceNewUuid" type="boolean" dir="in">
2186	<desc>Allows the caller to request a completely new medium UUID for
2187	the image which is to be opened. Useful if one intends to open an exact
2188	copy of a previously opened image, as this would normally fail due to
2189	the duplicate UUID.</desc>
2190	</param>
2191	<param name="medium" type="IMedium" dir="return">
2192	<desc>Opened medium object.</desc>
2193	</param>
2194	</method>
2195
2196	<method name="getGuestOSType">
2197	<desc>
2198	Returns an object describing the specified guest OS type.
2199
2200	The requested guest OS type is specified using a string which is a
2201	mnemonic identifier of the guest operating system, such as
2202	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2203	particular virtual machine can be read or set using the
2204	<link to="IMachine::OSTypeId"/> attribute.
2205
2206	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2207	available guest OS type objects. Each object has an
2208	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2209	the guest OS this object describes.
2210
2211	<result name="E_INVALIDARG">
2212	@a id is not a valid Guest OS type.
2213	</result>
2214
2215	</desc>
2216	<param name="id" type="uuid" mod="string" dir="in">
2217	<desc>Guest OS type ID string.</desc>
2218	</param>
2219	<param name="type" type="IGuestOSType" dir="return">
2220	<desc>Guest OS type object.</desc>
2221	</param>
2222	</method>
2223
2224	<method name="createSharedFolder">
2225	<desc>
2226	Creates a new global shared folder by associating the given logical
2227	name with the given host path, adds it to the collection of shared
2228	folders and starts sharing it. Refer to the description of
2229	<link to="ISharedFolder"/> to read more about logical names.
2230	<note>
2231	In the current implementation, this operation is not
2232	implemented.
2233	</note>
2234	</desc>
2235	<param name="name" type="wstring" dir="in">
2236	<desc>Unique logical name of the shared folder.</desc>
2237	</param>
2238	<param name="hostPath" type="wstring" dir="in">
2239	<desc>Full path to the shared folder in the host file system.</desc>
2240	</param>
2241	<param name="writable" type="boolean" dir="in">
2242	<desc>Whether the share is writable or readonly</desc>
2243	</param>
2244	<param name="automount" type="boolean" dir="in">
2245	<desc>Whether the share gets automatically mounted by the guest
2246	or not.</desc>
2247	</param>
2248	</method>
2249
2250	<method name="removeSharedFolder">
2251	<desc>
2252	Removes the global shared folder with the given name previously
2253	created by <link to="#createSharedFolder"/> from the collection of
2254	shared folders and stops sharing it.
2255	<note>
2256	In the current implementation, this operation is not
2257	implemented.
2258	</note>
2259	</desc>
2260	<param name="name" type="wstring" dir="in">
2261	<desc>Logical name of the shared folder to remove.</desc>
2262	</param>
2263	</method>
2264
2265	<method name="getExtraDataKeys">
2266	<desc>
2267	Returns an array representing the global extra data keys which currently
2268	have values defined.
2269	</desc>
2270	<param name="keys" type="wstring" dir="return" safearray="yes">
2271	<desc>Array of extra data keys.</desc>
2272	</param>
2273	</method>
2274
2275	<method name="getExtraData">
2276	<desc>
2277	Returns associated global extra data.
2278
2279	If the requested data @a key does not exist, this function will
2280	succeed and return an empty string in the @a value argument.
2281
2282	<result name="VBOX_E_FILE_ERROR">
2283	Settings file not accessible.
2284	</result>
2285	<result name="VBOX_E_XML_ERROR">
2286	Could not parse the settings file.
2287	</result>
2288
2289	</desc>
2290	<param name="key" type="wstring" dir="in">
2291	<desc>Name of the data key to get.</desc>
2292	</param>
2293	<param name="value" type="wstring" dir="return">
2294	<desc>Value of the requested data key.</desc>
2295	</param>
2296	</method>
2297
2298	<method name="setExtraData">
2299	<desc>
2300	Sets associated global extra data.
2301
2302	If you pass @c null or empty string as a key @a value, the given @a key
2303	will be deleted.
2304
2305	<note>
2306	Before performing the actual data change, this method will ask all
2307	registered event listener using the
2308	<link to="IExtraDataCanChangeEvent"/>
2309	notification for a permission. If one of the listeners refuses the
2310	new value, the change will not be performed.
2311	</note>
2312	<note>
2313	On success, the
2314	<link to="IExtraDataChangedEvent"/> notification
2315	is called to inform all registered listeners about a successful data
2316	change.
2317	</note>
2318
2319	<result name="VBOX_E_FILE_ERROR">
2320	Settings file not accessible.
2321	</result>
2322	<result name="VBOX_E_XML_ERROR">
2323	Could not parse the settings file.
2324	</result>
2325	<result name="E_ACCESSDENIED">
2326	Modification request refused.
2327	</result>
2328
2329	</desc>
2330	<param name="key" type="wstring" dir="in">
2331	<desc>Name of the data key to set.</desc>
2332	</param>
2333	<param name="value" type="wstring" dir="in">
2334	<desc>Value to assign to the key.</desc>
2335	</param>
2336	</method>
2337
2338	<method name="setSettingsSecret">
2339	<desc>
2340	Unlocks the secret data by passing the unlock password to the
2341	server. The server will cache the password for that machine.
2342
2343	<result name="VBOX_E_INVALID_VM_STATE">
2344	Virtual machine is not mutable.
2345	</result>
2346
2347	</desc>
2348	<param name="password" type="wstring" dir="in">
2349	<desc>
2350	The cipher key.
2351	</desc>
2352	</param>
2353	</method>
2354
2355	<!--method name="createDHCPServerForInterface">
2356	<desc>
2357	Creates a DHCP server settings to be used for the given interface
2358	<result name="E_INVALIDARG">
2359	Host network interface @a name already exists.
2360	</result>
2361	</desc>
2362	<param name="interface" type="IHostNetworkInterface" dir="in">
2363	<desc>Network Interface</desc>
2364	</param>
2365	<param name="server" type="IDHCPServer" dir="out">
2366	<desc>DHCP server settings</desc>
2367	</param>
2368	</method-->
2369
2370	<method name="createDHCPServer">
2371	<desc>
2372	Creates a DHCP server settings to be used for the given internal network name
2373	<result name="E_INVALIDARG">
2374	Host network interface @a name already exists.
2375	</result>
2376	</desc>
2377	<param name="name" type="wstring" dir="in">
2378	<desc>server name</desc>
2379	</param>
2380	<param name="server" type="IDHCPServer" dir="return">
2381	<desc>DHCP server settings</desc>
2382	</param>
2383	</method>
2384
2385	<method name="findDHCPServerByNetworkName">
2386	<desc>
2387	Searches a DHCP server settings to be used for the given internal network name
2388	<result name="E_INVALIDARG">
2389	Host network interface @a name already exists.
2390	</result>
2391
2392	</desc>
2393	<param name="name" type="wstring" dir="in">
2394	<desc>server name</desc>
2395	</param>
2396	<param name="server" type="IDHCPServer" dir="return">
2397	<desc>DHCP server settings</desc>
2398	</param>
2399	</method>
2400
2401	<!--method name="findDHCPServerForInterface">
2402	<desc>
2403	Searches a DHCP server settings to be used for the given interface
2404	<result name="E_INVALIDARG">
2405	Host network interface @a name already exists.
2406	</result>
2407	</desc>
2408	<param name="interface" type="IHostNetworkInterface" dir="in">
2409	<desc>Network Interface</desc>
2410	</param>
2411	<param name="server" type="IDHCPServer" dir="out">
2412	<desc>DHCP server settings</desc>
2413	</param>
2414	</method-->
2415
2416	<method name="removeDHCPServer">
2417	<desc>
2418	Removes the DHCP server settings
2419	<result name="E_INVALIDARG">
2420	Host network interface @a name already exists.
2421	</result>
2422	</desc>
2423	<param name="server" type="IDHCPServer" dir="in">
2424	<desc>DHCP server settings to be removed</desc>
2425	</param>
2426	</method>
2427
2428	<!-- bunch of metods to create NAT -->
2429	<method name="createNATNetwork">
2430	<!-- Here we create a record in NAT network array with name
2431	and gateway/network parameters this information should
2432	be enough for VBoxNet[Lwip]NAT and VBoxNetDHCP for
2433	servicing the guests.
2434	-->
2435	<param name="networkName" type="wstring" dir="in"/>
2436	<param name="network" type="INATNetwork" dir="return"/>
2437	</method>
2438
2439	<!--
2440	Returns the NATNetwork by name, e.g. for adding porforward rule or delition.
2441	-->
2442	<method name="findNATNetworkByName">
2443	<param name="networkName" type="wstring" dir="in"/>
2444	<param name="network" type="INATNetwork" dir="return"/>
2445	</method>
2446	<!--
2447	Deletes given NAT network.
2448	-->
2449	<method name="removeNATNetwork">
2450	<param name="network" type="INATNetwork" dir="in"/>
2451	</method>
2452
2453	<method name="checkFirmwarePresent">
2454	<desc>
2455	Check if this VirtualBox installation has a firmware
2456	of the given type available, either system-wide or per-user.
2457	Optionally, this may return a hint where this firmware can be
2458	downloaded from.
2459	</desc>
2460	<param name="firmwareType" type="FirmwareType" dir="in">
2461	<desc>
2462	Type of firmware to check.
2463	</desc>
2464	</param>
2465	<param name="version" type="wstring" dir="in">
2466	<desc>Expected version number, usually empty string (presently ignored).</desc>
2467	</param>
2468
2469	<param name="url" type="wstring" dir="out">
2470	<desc>
2471	Suggested URL to download this firmware from.
2472	</desc>
2473	</param>
2474
2475	<param name="file" type="wstring" dir="out">
2476	<desc>
2477	Filename of firmware, only valid if result == TRUE.
2478	</desc>
2479	</param>
2480
2481	<param name="result" type="boolean" dir="return">
2482	<desc>If firmware of this type and version is available.</desc>
2483	</param>
2484	</method>
2485
2486	</interface>
2487
2488	<!--
2489	// IVFSExplorer
2490	/////////////////////////////////////////////////////////////////////////
2491	-->
2492
2493	<enum
2494	name="VFSType"
2495	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2496	>
2497	<desc>
2498	Virtual file systems supported by VFSExplorer.
2499	</desc>
2500
2501	<const name="File" value="1" />
2502	<const name="Cloud" value="2" />
2503	<const name="S3" value="3" />
2504	<const name="WebDav" value="4" />
2505	</enum>
2506
2507	<enum
2508	name="VFSFileType"
2509	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2510	>
2511	<desc>
2512	File types known by VFSExplorer.
2513	</desc>
2514
2515	<const name="Unknown" value="1" />
2516	<const name="Fifo" value="2" />
2517	<const name="DevChar" value="3" />
2518	<const name="Directory" value="4" />
2519	<const name="DevBlock" value="5" />
2520	<const name="File" value="6" />
2521	<const name="SymLink" value="7" />
2522	<const name="Socket" value="8" />
2523	<const name="WhiteOut" value="9" />
2524	</enum>
2525
2526	<interface
2527	name="IVFSExplorer" extends="$unknown"
2528	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2529	wsmap="managed"
2530	>
2531	<desc>
2532	The VFSExplorer interface unifies access to different file system
2533	types. This includes local file systems as well remote file systems like
2534	S3. For a list of supported types see <link to="VFSType" />.
2535	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2536	</desc>
2537
2538	<attribute name="path" type="wstring" readonly="yes">
2539	<desc>Returns the current path in the virtual file system.</desc>
2540	</attribute>
2541
2542	<attribute name="type" type="VFSType" readonly="yes">
2543	<desc>Returns the file system type which is currently in use.</desc>
2544	</attribute>
2545
2546	<method name="update">
2547	<desc>Updates the internal list of files/directories from the
2548	current directory level. Use <link to="#entryList" /> to get the full list
2549	after a call to this method.</desc>
2550
2551	<param name="progress" type="IProgress" dir="return">
2552	<desc>Progress object to track the operation completion.</desc>
2553	</param>
2554	</method>
2555
2556	<method name="cd">
2557	<desc>Change the current directory level.</desc>
2558
2559	<param name="dir" type="wstring" dir="in">
2560	<desc>The name of the directory to go in.</desc>
2561	</param>
2562
2563	<param name="progress" type="IProgress" dir="return">
2564	<desc>Progress object to track the operation completion.</desc>
2565	</param>
2566	</method>
2567
2568	<method name="cdUp">
2569	<desc>Go one directory upwards from the current directory level.</desc>
2570
2571	<param name="progress" type="IProgress" dir="return">
2572	<desc>Progress object to track the operation completion.</desc>
2573	</param>
2574	</method>
2575
2576	<method name="entryList">
2577	<desc>Returns a list of files/directories after a call to <link
2578	to="#update" />. The user is responsible for keeping this internal
2579	list up do date.</desc>
2580
2581	<param name="names" type="wstring" safearray="yes" dir="out">
2582	<desc>The list of names for the entries.</desc>
2583	</param>
2584
2585	<param name="types" type="unsigned long" safearray="yes" dir="out">
2586	<desc>The list of types for the entries.</desc>
2587	</param>
2588
2589	<param name="sizes" type="unsigned long" safearray="yes" dir="out">
2590	<desc>The list of sizes (in bytes) for the entries.</desc>
2591	</param>
2592
2593	<param name="modes" type="unsigned long" safearray="yes" dir="out">
2594	<desc>The list of file modes (in octal form) for the entries.</desc>
2595	</param>
2596	</method>
2597
2598	<method name="exists">
2599	<desc>Checks if the given file list exists in the current directory
2600	level.</desc>
2601
2602	<param name="names" type="wstring" safearray="yes" dir="in">
2603	<desc>The names to check.</desc>
2604	</param>
2605
2606	<param name="exists" type="wstring" safearray="yes" dir="return">
2607	<desc>The names which exist.</desc>
2608	</param>
2609	</method>
2610
2611	<method name="remove">
2612	<desc>Deletes the given files in the current directory level.</desc>
2613
2614	<param name="names" type="wstring" safearray="yes" dir="in">
2615	<desc>The names to remove.</desc>
2616	</param>
2617
2618	<param name="progress" type="IProgress" dir="return">
2619	<desc>Progress object to track the operation completion.</desc>
2620	</param>
2621	</method>
2622
2623	</interface>
2624
2625	<enum
2626	name="ImportOptions" extends="$unknown"
2627	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2628	>
2629
2630	<desc>
2631	Import options, used with <link to="IAppliance::importMachines" />.
2632	</desc>
2633
2634	<const name="KeepAllMACs" value="1">
2635	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2636	</const>
2637	<const name="KeepNATMACs" value="2">
2638	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2639	</const>
2640
2641	</enum>
2642
2643
2644	<!--
2645	// IAppliance
2646	/////////////////////////////////////////////////////////////////////////
2647	-->
2648
2649	<interface
2650	name="IAppliance" extends="$unknown"
2651	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2652	wsmap="managed"
2653	>
2654	<desc>
2655	Represents a platform-independent appliance in OVF format. An instance of this is returned
2656	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2657	virtual machines within an appliance with VirtualBox.
2658
2659	The OVF standard suggests two different physical file formats:
2660
2661	<ol>
2662	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2663	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2664	this descriptor file references other files such as disk images, as OVF appliances typically
2665	do, those additional files must be in the same directory as the descriptor file.</li>
2666
2667	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2668	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2669	files and optionally other files.
2670
2671	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2672	be added with a later version.</li>
2673	</ol>
2674
2675	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2676	<link to="IMachine" /> involves the following sequence of API calls:
2677
2678	<ol>
2679	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2680	</li>
2681
2682	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2683	would like to import. So long as this file is syntactically valid, this will succeed
2684	and fill the appliance object with the parsed data from the OVF file.
2685	</li>
2686
2687	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2688	contents of the IAppliance attributes accordingly. These can be inspected by a
2689	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2690	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2691	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2692	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2693	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2694	The GUI can then give the user the option to confirm and/or change these suggestions.
2695	</li>
2696
2697	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2698	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2699	</li>
2700
2701	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2702	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2703	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2704	can be found in the <link to="#machines" /> array attribute.
2705	</li>
2706	</ol>
2707
2708	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2709
2710	<ol>
2711	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2712	an empty IAppliance object.
2713	</li>
2714
2715	<li>For each machine you would like to export, call <link to="IMachine::exportTo" />
2716	with the IAppliance object you just created. Each such call creates one instance of
2717	<link to="IVirtualSystemDescription" /> inside the appliance.
2718	</li>
2719
2720	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2721	virtual system (machine) to override the suggestions made by the <link to="IMachine::exportTo"/> routine.
2722	</li>
2723
2724	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2725	file written.</li>
2726	</ol>
2727
2728	</desc>
2729
2730	<attribute name="path" type="wstring" readonly="yes">
2731	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2732	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2733	<link to="#write" /> (for export).
2734	This attribute is empty until one of these methods has been called.
2735	</desc>
2736	</attribute>
2737
2738	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2739	<desc>
2740	Array of virtual disk definitions. One such description exists for each
2741	disk definition in the OVF; each string array item represents one such piece of
2742	disk information, with the information fields separated by tab (\\t) characters.
2743
2744	The caller should be prepared for additional fields being appended to
2745	this string in future versions of VirtualBox and therefore check for
2746	the number of tabs in the strings returned.
2747
2748	In the current version, the following eight fields are returned per string
2749	in the array:
2750
2751	<ol>
2752	<li>Disk ID (unique string identifier given to disk)</li>
2753
2754	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2755
2756	<li>Populated size (optional unsigned integer indicating the current size of the
2757	disk; can be approximate; -1 if unspecified)</li>
2758
2759	<li>Format (string identifying the disk format, typically
2760	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2761
2762	<li>Reference (where to find the disk image, typically a file name; if empty,
2763	then the disk should be created on import)</li>
2764
2765	<li>Image size (optional unsigned integer indicating the size of the image,
2766	which need not necessarily be the same as the values specified above, since
2767	the image may be compressed or sparse; -1 if not specified)</li>
2768
2769	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2770	presently unsupported and always -1)</li>
2771
2772	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2773	</ol>
2774	</desc>
2775	</attribute>
2776
2777	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2778	<desc> Array of virtual system descriptions. One such description is created
2779	for each virtual system (machine) found in the OVF.
2780	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::exportTo" />
2781	(for export) has been called.
2782	</desc>
2783	</attribute>
2784
2785	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2786	<desc>
2787	Contains the UUIDs of the machines created from the information in this appliances. This is only
2788	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2789	succeeded.
2790	</desc>
2791	</attribute>
2792
2793	<method name="read">
2794	<desc>
2795	Reads an OVF file into the appliance object.
2796
2797	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2798	mere fact that this method returns successfully does not mean that VirtualBox supports all
2799	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2800	</desc>
2801	<param name="file" type="wstring" dir="in">
2802	<desc>
2803	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2804	on whether the appliance is distributed as a set of files or as a single file, respectively).
2805	</desc>
2806	</param>
2807	<param name="progress" type="IProgress" dir="return">
2808	<desc>Progress object to track the operation completion.</desc>
2809	</param>
2810	</method>
2811
2812	<method name="interpret">
2813	<desc>
2814	Interprets the OVF data that was read when the appliance was constructed. After
2815	calling this method, one can inspect the
2816	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2817	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2818	the appliance.
2819
2820	Calling this method is the second step of importing an appliance into VirtualBox;
2821	see <link to="IAppliance" /> for an overview.
2822
2823	After calling this method, one should call <link to="#getWarnings" /> to find out
2824	if problems were encountered during the processing which might later lead to
2825	errors.
2826	</desc>
2827	</method>
2828
2829	<method name="importMachines">
2830	<desc>
2831	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2832	and other interfaces that match the information contained in the appliance as
2833	closely as possible, as represented by the import instructions in the
2834	<link to="#virtualSystemDescriptions" /> array.
2835
2836	Calling this method is the final step of importing an appliance into VirtualBox;
2837	see <link to="IAppliance" /> for an overview.
2838
2839	Since importing the appliance will most probably involve copying and converting
2840	disk images, which can take a long time, this method operates asynchronously and
2841	returns an IProgress object to allow the caller to monitor the progress.
2842
2843	After the import succeeded, the UUIDs of the IMachine instances created can be
2844	retrieved from the <link to="#machines" /> array attribute.
2845	</desc>
2846
2847	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2848	<desc>Options for the importing operation.</desc>
2849	</param>
2850
2851	<param name="progress" type="IProgress" dir="return">
2852	<desc>Progress object to track the operation completion.</desc>
2853	</param>
2854	</method>
2855
2856	<method name="createVFSExplorer">
2857	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2858
2859	<param name="URI" type="wstring" dir="in">
2860	<desc>The URI describing the file system to use.</desc>
2861	</param>
2862
2863	<param name="explorer" type="IVFSExplorer" dir="return">
2864	<desc></desc>
2865	</param>
2866	</method>
2867
2868	<method name="write">
2869	<desc>
2870	Writes the contents of the appliance exports into a new OVF file.
2871
2872	Calling this method is the final step of exporting an appliance from VirtualBox;
2873	see <link to="IAppliance" /> for an overview.
2874
2875	Since exporting the appliance will most probably involve copying and converting
2876	disk images, which can take a long time, this method operates asynchronously and
2877	returns an IProgress object to allow the caller to monitor the progress.
2878	</desc>
2879	<param name="format" type="wstring" dir="in">
2880	<desc>
2881	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2882	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2883	</desc>
2884	</param>
2885	<param name="manifest" type="boolean" dir="in">
2886	<desc>
2887	Indicate if the optional manifest file (.mf) should be written. The manifest file
2888	is used for integrity checks prior import.
2889	</desc>
2890	</param>
2891	<param name="path" type="wstring" dir="in">
2892	<desc>
2893	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2894	on whether the appliance is distributed as a set of files or as a single file, respectively).
2895	</desc>
2896	</param>
2897	<param name="progress" type="IProgress" dir="return">
2898	<desc>Progress object to track the operation completion.</desc>
2899	</param>
2900	</method>
2901
2902	<method name="getWarnings">
2903	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2904
2905	<param name="warnings" type="wstring" dir="return" safearray="yes">
2906	<desc></desc>
2907	</param>
2908	</method>
2909
2910	</interface>
2911
2912	<enum
2913	name="VirtualSystemDescriptionType"
2914	uuid="303c0900-a746-4612-8c67-79003e91f459"
2915	>
2916	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2917	a configuration value.</desc>
2918
2919	<const name="Ignore" value="1" />
2920	<const name="OS" value="2" />
2921	<const name="Name" value="3" />
2922	<const name="Product" value="4" />
2923	<const name="Vendor" value="5" />
2924	<const name="Version" value="6" />
2925	<const name="ProductUrl" value="7" />
2926	<const name="VendorUrl" value="8" />
2927	<const name="Description" value="9" />
2928	<const name="License" value="10" />
2929	<const name="Miscellaneous" value="11" />
2930	<const name="CPU" value="12" />
2931	<const name="Memory" value="13" />
2932	<const name="HardDiskControllerIDE" value="14" />
2933	<const name="HardDiskControllerSATA" value="15" />
2934	<const name="HardDiskControllerSCSI" value="16" />
2935	<const name="HardDiskControllerSAS" value="17" />
2936	<const name="HardDiskImage" value="18" />
2937	<const name="Floppy" value="19" />
2938	<const name="CDROM" value="20" />
2939	<const name="NetworkAdapter" value="21" />
2940	<const name="USBController" value="22" />
2941	<const name="SoundCard" value="23" />
2942	<const name="SettingsFile" value="24">
2943	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2944	</const>
2945	</enum>
2946
2947	<enum
2948	name="VirtualSystemDescriptionValueType"
2949	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2950	>
2951	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2952	type to fetch.</desc>
2953
2954	<const name="Reference" value="1" />
2955	<const name="Original" value="2" />
2956	<const name="Auto" value="3" />
2957	<const name="ExtraConfig" value="4" />
2958
2959	</enum>
2960
2961	<interface
2962	name="IVirtualSystemDescription" extends="$unknown"
2963	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2964	wsmap="managed"
2965	>
2966
2967	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2968	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2969	<link to="IAppliance::interpret" /> has been called, that array contains information
2970	about how the virtual systems described in the OVF should best be imported into
2971	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2972	import an OVF into VirtualBox.
2973	</desc>
2974
2975	<attribute name="count" type="unsigned long" readonly="yes">
2976	<desc>Return the number of virtual system description entries.</desc>
2977	</attribute>
2978
2979	<method name="getDescription">
2980	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2981	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2982
2983	The list below identifies the value sets that are possible depending on the
2984	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2985	the array item with the same index in @a OVFValues[] will contain the original value as contained
2986	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2987	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2988	the @a aExtraConfigValues[] array item may also be used.
2989
2990	<ul>
2991	<li>
2992	"OS": the guest operating system type. There must be exactly one such array item on import. The
2993	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2994	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2995	item in @a OVFValues[] will contain a numerical value that described the operating system in the OVF.
2996	</li>
2997	<li>
2998	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2999	if none is present on import, then an automatic name will be created from the operating system
3000	type. The corresponding item im @a OVFValues[] will contain the suggested virtual machine name
3001	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
3002	<link to="IMachine" /> name that does not exist yet.
3003	</li>
3004	<li>
3005	"Description": an arbitrary description.
3006	</li>
3007	<li>
3008	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
3009	code to display such a license for agreement; the Main API does not enforce any such policy.
3010	</li>
3011	<li>
3012	Miscellaneous: reserved for future use.
3013	</li>
3014	<li>
3015	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3016	</li>
3017	<li>
3018	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3019	is present on import, then VirtualBox will set a meaningful default based on the operating system
3020	type.
3021	</li>
3022	<li>
3023	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
3024	An optional value in @a OVFValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
3025	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
3026	writes into the OVF.
3027	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
3028	type can use to specify which hard disk controller a virtual disk should be connected to.
3029	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
3030	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
3031	its virtual machines supports four channels (primary master, primary slave, secondary master,
3032	secondary slave) and thus maps to two IDE controllers in the OVF sense.
3033	</li>
3034	<li>
3035	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3036	has no value in @a OVFValues[] or @a aVBoxValues[].
3037	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3038	</li>
3039	<li>
3040	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3041	The items in @a OVFValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
3042	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
3043	whereas VirtualBox considers it a class of storage controllers of its own; see
3044	<link to="StorageControllerType" />).
3045	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3046	</li>
3047	<li>
3048	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3049	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3050
3051	The array item in @a OVFValues[] will contain the file specification from the OVF file (without
3052	a path since the image file should be in the same location as the OVF file itself), whereas the
3053	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3054	hard disk image. This means that on import the image will be copied and converted from the
3055	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3056
3057	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
3058	format: "controller=<index>;channel=<c>"
3059	In this string, <index> must be an integer specifying the hard disk controller to connect
3060	the image to. That number must be the index of an array item with one of the hard disk controller
3061	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3062	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3063	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3064	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3065	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3066	</li>
3067	<li>
3068	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3069	attachment information as with "HardDiskImage" items.
3070	</li>
3071	<li>
3072	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3073	attachment information as with "HardDiskImage" items.
3074	</li>
3075	<li>
3076	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3077	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3078	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3079	</li>
3080	<li>
3081	"USBController": a USB controller. There can be at most one such item. If and only if such an
3082	item ispresent, USB support will be enabled for the new virtual machine.
3083	</li>
3084	<li>
3085	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3086	present, sound support will be enabled for the new virtual machine. Note that the virtual
3087	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3088	may be different from the virtual soundcard expected by the appliance.
3089	</li>
3090	</ul>
3091
3092	</desc>
3093
3094	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3095	<desc></desc>
3096	</param>
3097
3098	<param name="refs" type="wstring" dir="out" safearray="yes">
3099	<desc></desc>
3100	</param>
3101
3102	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3103	<desc></desc>
3104	</param>
3105
3106	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3107	<desc></desc>
3108	</param>
3109
3110	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3111	<desc></desc>
3112	</param>
3113
3114	</method>
3115
3116	<method name="getDescriptionByType">
3117	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3118	should be returned.</desc>
3119
3120	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3121	<desc></desc>
3122	</param>
3123
3124	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3125	<desc></desc>
3126	</param>
3127
3128	<param name="refs" type="wstring" dir="out" safearray="yes">
3129	<desc></desc>
3130	</param>
3131
3132	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3133	<desc></desc>
3134	</param>
3135
3136	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3137	<desc></desc>
3138	</param>
3139
3140	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3141	<desc></desc>
3142	</param>
3143
3144	</method>
3145
3146	<method name="getValuesByType">
3147	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3148	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3149	values.</desc>
3150
3151	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3152	<desc></desc>
3153	</param>
3154
3155	<param name="which" type="VirtualSystemDescriptionValueType" dir="in">
3156	<desc></desc>
3157	</param>
3158
3159	<param name="values" type="wstring" dir="return" safearray="yes">
3160	<desc></desc>
3161	</param>
3162
3163	</method>
3164
3165	<method name="setFinalValues">
3166	<desc>
3167	This method allows the appliance's user to change the configuration for the virtual
3168	system descriptions. For each array item returned from <link to="#getDescription" />,
3169	you must pass in one boolean value and one configuration value.
3170
3171	Each item in the boolean array determines whether the particular configuration item
3172	should be enabled.
3173	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3174	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3175	and SoundCard.
3176
3177	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3178	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
3179	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
3180	for valid configuration values for the individual array item types. If the
3181	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3182	</desc>
3183
3184	<param name="enabled" type="boolean" dir="in" safearray="yes">
3185	<desc></desc>
3186	</param>
3187
3188	<param name="VBoxValues" type="wstring" dir="in" safearray="yes">
3189	<desc></desc>
3190	</param>
3191
3192	<param name="extraConfigValues" type="wstring" dir="in" safearray="yes">
3193	<desc></desc>
3194	</param>
3195	</method>
3196
3197	<method name="addDescription">
3198	<desc>
3199	This method adds an additional description entry to the stack of already
3200	available descriptions for this virtual system. This is handy for writing
3201	values which aren't directly supported by VirtualBox. One example would
3202	be the License type of <link to="VirtualSystemDescriptionType" />.
3203	</desc>
3204
3205	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3206	<desc></desc>
3207	</param>
3208
3209	<param name="VBoxValue" type="wstring" dir="in">
3210	<desc></desc>
3211	</param>
3212
3213	<param name="extraConfigValue" type="wstring" dir="in">
3214	<desc></desc>
3215	</param>
3216	</method>
3217	</interface>
3218
3219
3220	<!--
3221	// IMachine
3222	/////////////////////////////////////////////////////////////////////////
3223	-->
3224
3225	<interface
3226	name="IInternalMachineControl" extends="$unknown"
3227	uuid="dca36a92-703c-4649-98a4-f40c1ef0c336"
3228	internal="yes"
3229	wsmap="suppress"
3230	>
3231	<method name="setRemoveSavedStateFile">
3232	<desc>
3233	Updates the flag whether the saved state file is removed on a
3234	machine state change from Saved to PoweredOff.
3235	</desc>
3236	<param name="remove" type="boolean" dir="in"/>
3237	</method>
3238
3239	<method name="updateState">
3240	<desc>
3241	Updates the VM state.
3242	<note>
3243	This operation will also update the settings file with the correct
3244	information about the saved state file and delete this file from disk
3245	when appropriate.
3246	</note>
3247	</desc>
3248	<param name="state" type="MachineState" dir="in"/>
3249	</method>
3250
3251	<method name="getIPCId">
3252	<param name="id" type="wstring" dir="return"/>
3253	</method>
3254
3255	<method name="beginPowerUp">
3256	<desc>
3257	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3258	gives it the progress object that should be part of any pending
3259	<link to="IMachine::launchVMProcess"/> operations. The progress
3260	object may be called back to reflect an early cancelation, so some care
3261	have to be taken with respect to any cancelation callbacks. The console
3262	object will call <link to="IInternalMachineControl::endPowerUp"/>
3263	to signal the completion of the progress object.
3264	</desc>
3265	<param name="progress" type="IProgress" dir="in" />
3266	</method>
3267
3268	<method name="endPowerUp">
3269	<desc>
3270	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3271	This method may query status information from the progress object it
3272	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3273	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3274	call in order to complete that progress object.
3275	</desc>
3276	<param name="result" type="long" dir="in"/>
3277	</method>
3278
3279	<method name="beginPoweringDown">
3280	<desc>
3281	Called by the VM process to inform the server it wants to
3282	stop the VM execution and power down.
3283	</desc>
3284	<param name="progress" type="IProgress" dir="out">
3285	<desc>
3286	Progress object created by VBoxSVC to wait until
3287	the VM is powered down.
3288	</desc>
3289	</param>
3290	</method>
3291
3292	<method name="endPoweringDown">
3293	<desc>
3294	Called by the VM process to inform the server that powering
3295	down previously requested by #beginPoweringDown is either
3296	successfully finished or there was a failure.
3297
3298	<result name="VBOX_E_FILE_ERROR">
3299	Settings file not accessible.
3300	</result>
3301	<result name="VBOX_E_XML_ERROR">
3302	Could not parse the settings file.
3303	</result>
3304
3305	</desc>
3306
3307	<param name="result" type="long" dir="in">
3308	<desc>@c S_OK to indicate success.
3309	</desc>
3310	</param>
3311	<param name="errMsg" type="wstring" dir="in">
3312	<desc>@c human readable error message in case of failure.
3313	</desc>
3314	</param>
3315	</method>
3316
3317	<method name="runUSBDeviceFilters">
3318	<desc>
3319	Asks the server to run USB devices filters of the associated
3320	machine against the given USB device and tell if there is
3321	a match.
3322	<note>
3323	Intended to be used only for remote USB devices. Local
3324	ones don't require to call this method (this is done
3325	implicitly by the Host and USBProxyService).
3326	</note>
3327	</desc>
3328	<param name="device" type="IUSBDevice" dir="in"/>
3329	<param name="matched" type="boolean" dir="out"/>
3330	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3331	</method>
3332
3333	<method name="captureUSBDevice">
3334	<desc>
3335	Requests a capture of the given host USB device.
3336	When the request is completed, the VM process will
3337	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3338	notification.
3339	</desc>
3340	<param name="id" type="uuid" mod="string" dir="in"/>
3341	</method>
3342
3343	<method name="detachUSBDevice">
3344	<desc>
3345	Notification that a VM is going to detach (@a done = @c false) or has
3346	already detached (@a done = @c true) the given USB device.
3347	When the @a done = @c true request is completed, the VM process will
3348	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3349	notification.
3350	<note>
3351	In the @a done = @c true case, the server must run its own filters
3352	and filters of all VMs but this one on the detached device
3353	as if it were just attached to the host computer.
3354	</note>
3355	</desc>
3356	<param name="id" type="uuid" mod="string" dir="in"/>
3357	<param name="done" type="boolean" dir="in"/>
3358	</method>
3359
3360	<method name="autoCaptureUSBDevices">
3361	<desc>
3362	Requests a capture all matching USB devices attached to the host.
3363	When the request is completed, the VM process will
3364	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3365	notification per every captured device.
3366	</desc>
3367	</method>
3368
3369	<method name="detachAllUSBDevices">
3370	<desc>
3371	Notification that a VM that is being powered down. The done
3372	parameter indicates whether which stage of the power down
3373	we're at. When @a done = @c false the VM is announcing its
3374	intentions, while when @a done = @c true the VM is reporting
3375	what it has done.
3376	<note>
3377	In the @a done = @c true case, the server must run its own filters
3378	and filters of all VMs but this one on all detach devices as
3379	if they were just attached to the host computer.
3380	</note>
3381	</desc>
3382	<param name="done" type="boolean" dir="in"/>
3383	</method>
3384
3385	<method name="onSessionEnd">
3386	<desc>
3387	Triggered by the given session object when the session is about
3388	to close normally.
3389	</desc>
3390	<param name="session" type="ISession" dir="in">
3391	<desc>Session that is being closed</desc>
3392	</param>
3393	<param name="progress" type="IProgress" dir="return">
3394	<desc>
3395	Used to wait until the corresponding machine is actually
3396	dissociated from the given session on the server.
3397	Returned only when this session is a direct one.
3398	</desc>
3399	</param>
3400	</method>
3401
3402	<method name="beginSavingState">
3403	<desc>
3404	Called by the VM process to inform the server it wants to
3405	save the current state and stop the VM execution.
3406	</desc>
3407	<param name="progress" type="IProgress" dir="out">
3408	<desc>
3409	Progress object created by VBoxSVC to wait until
3410	the state is saved.
3411	</desc>
3412	</param>
3413	<param name="stateFilePath" type="wstring" dir="out">
3414	<desc>
3415	File path the VM process must save the execution state to.
3416	</desc>
3417	</param>
3418	</method>
3419
3420	<method name="endSavingState">
3421	<desc>
3422	Called by the VM process to inform the server that saving
3423	the state previously requested by #beginSavingState is either
3424	successfully finished or there was a failure.
3425
3426	<result name="VBOX_E_FILE_ERROR">
3427	Settings file not accessible.
3428	</result>
3429	<result name="VBOX_E_XML_ERROR">
3430	Could not parse the settings file.
3431	</result>
3432
3433	</desc>
3434
3435	<param name="result" type="long" dir="in">
3436	<desc>@c S_OK to indicate success.
3437	</desc>
3438	</param>
3439	<param name="errMsg" type="wstring" dir="in">
3440	<desc>@c human readable error message in case of failure.
3441	</desc>
3442	</param>
3443	</method>
3444
3445	<method name="adoptSavedState">
3446	<desc>
3447	Gets called by <link to="IConsole::adoptSavedState"/>.
3448	<result name="VBOX_E_FILE_ERROR">
3449	Invalid saved state file path.
3450	</result>
3451	</desc>
3452	<param name="savedStateFile" type="wstring" dir="in">
3453	<desc>Path to the saved state file to adopt.</desc>
3454	</param>
3455	</method>
3456
3457	<method name="beginTakingSnapshot">
3458	<desc>
3459	Called from the VM process to request from the server to perform the
3460	server-side actions of creating a snapshot (creating differencing images
3461	and the snapshot object).
3462
3463	<result name="VBOX_E_FILE_ERROR">
3464	Settings file not accessible.
3465	</result>
3466	<result name="VBOX_E_XML_ERROR">
3467	Could not parse the settings file.
3468	</result>
3469	</desc>
3470	<param name="initiator" type="IConsole" dir="in">
3471	<desc>The console object that initiated this call.</desc>
3472	</param>
3473	<param name="name" type="wstring" dir="in">
3474	<desc>Snapshot name.</desc>
3475	</param>
3476	<param name="description" type="wstring" dir="in">
3477	<desc>Snapshot description.</desc>
3478	</param>
3479	<param name="consoleProgress" type="IProgress" dir="in">
3480	<desc>
3481	Progress object created by the VM process tracking the
3482	snapshot's progress. This has the following sub-operations:
3483	<ul>
3484	<li>setting up (weight 1);</li>
3485	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3486	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3487	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3488	<li>finishing up (weight 1)</li>
3489	</ul>
3490	</desc>
3491	</param>
3492	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3493	<desc>
3494	Whether this is an online snapshot (i.e. the machine is running).
3495	</desc>
3496	</param>
3497	<param name="stateFilePath" type="wstring" dir="out">
3498	<desc>
3499	File path the VM process must save the execution state to.
3500	</desc>
3501	</param>
3502	</method>
3503
3504	<method name="endTakingSnapshot">
3505	<desc>
3506	Called by the VM process to inform the server that the snapshot
3507	previously requested by #beginTakingSnapshot is either
3508	successfully taken or there was a failure.
3509	</desc>
3510
3511	<param name="success" type="boolean" dir="in">
3512	<desc>@c true to indicate success and @c false otherwise</desc>
3513	</param>
3514	</method>
3515
3516	<method name="deleteSnapshot">
3517	<desc>
3518	Gets called by <link to="IConsole::deleteSnapshot"/>,
3519	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3520	<link to="IConsole::deleteSnapshotRange"/>.
3521	<result name="VBOX_E_INVALID_OBJECT_STATE">
3522	Snapshot has more than one child snapshot. Only possible if the
3523	delete operation does not delete all children or the range does
3524	not meet the linearity condition.
3525	</result>
3526	</desc>
3527	<param name="initiator" type="IConsole" dir="in">
3528	<desc>The console object that initiated this call.</desc>
3529	</param>
3530	<param name="startId" type="uuid" mod="string" dir="in">
3531	<desc>UUID of the first snapshot to delete.</desc>
3532	</param>
3533	<param name="endId" type="uuid" mod="string" dir="in">
3534	<desc>UUID of the last snapshot to delete.</desc>
3535	</param>
3536	<param name="deleteAllChildren" type="boolean" dir="in">
3537	<desc>Whether all children should be deleted.</desc>
3538	</param>
3539	<param name="machineState" type="MachineState" dir="out">
3540	<desc>New machine state after this operation is started.</desc>
3541	</param>
3542	<param name="progress" type="IProgress" dir="return">
3543	<desc>Progress object to track the operation completion.</desc>
3544	</param>
3545	</method>
3546
3547	<method name="finishOnlineMergeMedium">
3548	<desc>
3549	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3550	</desc>
3551	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3552	<desc>The medium attachment which needs to be cleaned up.</desc>
3553	</param>
3554	<param name="source" type="IMedium" dir="in">
3555	<desc>Merge source medium.</desc>
3556	</param>
3557	<param name="target" type="IMedium" dir="in">
3558	<desc>Merge target medium.</desc>
3559	</param>
3560	<param name="mergeForward" type="boolean" dir="in">
3561	<desc>Merge direction.</desc>
3562	</param>
3563	<param name="parentForTarget" type="IMedium" dir="in">
3564	<desc>For forward merges: new parent for target medium.</desc>
3565	</param>
3566	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3567	<desc>For backward merges: list of media which need their parent UUID
3568	updated.</desc>
3569	</param>
3570	</method>
3571
3572	<method name="restoreSnapshot">
3573	<desc>
3574	Gets called by <link to="IConsole::restoreSnapshot"/>.
3575	</desc>
3576	<param name="initiator" type="IConsole" dir="in">
3577	<desc>The console object that initiated this call.</desc>
3578	</param>
3579	<param name="snapshot" type="ISnapshot" dir="in">
3580	<desc>The snapshot to restore the VM state from.</desc>
3581	</param>
3582	<param name="machineState" type="MachineState" dir="out">
3583	<desc>New machine state after this operation is started.</desc>
3584	</param>
3585	<param name="progress" type="IProgress" dir="return">
3586	<desc>Progress object to track the operation completion.</desc>
3587	</param>
3588	</method>
3589
3590	<method name="pullGuestProperties">
3591	<desc>
3592	Get the list of the guest properties matching a set of patterns along
3593	with their values, time stamps and flags and give responsibility for
3594	managing properties to the console.
3595	</desc>
3596	<param name="names" type="wstring" dir="out" safearray="yes">
3597	<desc>
3598	The names of the properties returned.
3599	</desc>
3600	</param>
3601	<param name="values" type="wstring" dir="out" safearray="yes">
3602	<desc>
3603	The values of the properties returned. The array entries match the
3604	corresponding entries in the @a name array.
3605	</desc>
3606	</param>
3607	<param name="timestamps" type="long long" dir="out" safearray="yes">
3608	<desc>
3609	The time stamps of the properties returned. The array entries match
3610	the corresponding entries in the @a name array.
3611	</desc>
3612	</param>
3613	<param name="flags" type="wstring" dir="out" safearray="yes">
3614	<desc>
3615	The flags of the properties returned. The array entries match the
3616	corresponding entries in the @a name array.
3617	</desc>
3618	</param>
3619	</method>
3620
3621	<method name="pushGuestProperty">
3622	<desc>
3623	Update a single guest property in IMachine.
3624	</desc>
3625	<param name="name" type="wstring" dir="in">
3626	<desc>
3627	The name of the property to be updated.
3628	</desc>
3629	</param>
3630	<param name="value" type="wstring" dir="in">
3631	<desc>
3632	The value of the property.
3633	</desc>
3634	</param>
3635	<param name="timestamp" type="long long" dir="in">
3636	<desc>
3637	The timestamp of the property.
3638	</desc>
3639	</param>
3640	<param name="flags" type="wstring" dir="in">
3641	<desc>
3642	The flags of the property.
3643	</desc>
3644	</param>
3645	</method>
3646
3647	<method name="lockMedia">
3648	<desc>
3649	Locks all media attached to the machine for writing and parents of
3650	attached differencing media (if any) for reading. This operation is
3651	atomic so that if it fails no media is actually locked.
3652
3653	This method is intended to be called when the machine is in Starting or
3654	Restoring state. The locked media will be automatically unlocked when
3655	the machine is powered off or crashed.
3656	</desc>
3657	</method>
3658	<method name="unlockMedia">
3659	<desc>
3660	Unlocks all media previously locked using
3661	<link to="IInternalMachineControl::lockMedia"/>.
3662
3663	This method is intended to be used with teleportation so that it is
3664	possible to teleport between processes on the same machine.
3665	</desc>
3666	</method>
3667
3668	<method name="ejectMedium">
3669	<desc>
3670	Tells VBoxSVC that the guest has ejected the medium associated with
3671	the medium attachment.
3672	</desc>
3673	<param name="attachment" type="IMediumAttachment" dir="in">
3674	<desc>
3675	The medium attachment where the eject happened.
3676	</desc>
3677	</param>
3678	<param name="newAttachment" type="IMediumAttachment" dir="return">
3679	<desc>
3680	A new reference to the medium attachment, as the config change can
3681	result in the creation of a new instance.
3682	</desc>
3683	</param>
3684	</method>
3685
3686	<method name="reportVmStatistics">
3687	<desc>
3688	Passes statistics collected by VM (including guest statistics) to VBoxSVC.
3689	</desc>
3690	<param name="validStats" type="unsigned long" dir="in">
3691	<desc>
3692	Mask defining which parameters are valid. For example: 0x11 means
3693	that cpuIdle and XXX are valid. Other parameters should be ignored.
3694	</desc>
3695	</param>
3696	<param name="cpuUser" type="unsigned long" dir="in">
3697	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3698	</param>
3699	<param name="cpuKernel" type="unsigned long" dir="in">
3700	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3701	</param>
3702	<param name="cpuIdle" type="unsigned long" dir="in">
3703	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3704	</param>
3705	<param name="memTotal" type="unsigned long" dir="in">
3706	<desc>Total amount of physical guest RAM.</desc>
3707	</param>
3708	<param name="memFree" type="unsigned long" dir="in">
3709	<desc>Free amount of physical guest RAM.</desc>
3710	</param>
3711	<param name="memBalloon" type="unsigned long" dir="in">
3712	<desc>Amount of ballooned physical guest RAM.</desc>
3713	</param>
3714	<param name="memShared" type="unsigned long" dir="in">
3715	<desc>Amount of shared physical guest RAM.</desc>
3716	</param>
3717	<param name="memCache" type="unsigned long" dir="in">
3718	<desc>Total amount of guest (disk) cache memory.</desc>
3719	</param>
3720	<param name="pagedTotal" type="unsigned long" dir="in">
3721	<desc>Total amount of space in the page file.</desc>
3722	</param>
3723	<param name="memAllocTotal" type="unsigned long" dir="in">
3724	<desc>Total amount of memory allocated by the hypervisor.</desc>
3725	</param>
3726	<param name="memFreeTotal" type="unsigned long" dir="in">
3727	<desc>Total amount of free memory available in the hypervisor.</desc>
3728	</param>
3729	<param name="memBalloonTotal" type="unsigned long" dir="in">
3730	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3731	</param>
3732	<param name="memSharedTotal" type="unsigned long" dir="in">
3733	<desc>Total amount of shared memory in the hypervisor.</desc>
3734	</param>
3735	<param name="vmNetRx" type="unsigned long" dir="in">
3736	<desc>Network receive rate for VM.</desc>
3737	</param>
3738	<param name="vmNetTx" type="unsigned long" dir="in">
3739	<desc>Network transmit rate for VM.</desc>
3740	</param>
3741	</method>
3742	</interface>
3743
3744	<interface
3745	name="IBIOSSettings" extends="$unknown"
3746	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3747	wsmap="managed"
3748	>
3749	<desc>
3750	The IBIOSSettings interface represents BIOS settings of the virtual
3751	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3752	</desc>
3753	<attribute name="logoFadeIn" type="boolean">
3754	<desc>Fade in flag for BIOS logo animation.</desc>
3755	</attribute>
3756
3757	<attribute name="logoFadeOut" type="boolean">
3758	<desc>Fade out flag for BIOS logo animation.</desc>
3759	</attribute>
3760
3761	<attribute name="logoDisplayTime" type="unsigned long">
3762	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3763	</attribute>
3764
3765	<attribute name="logoImagePath" type="wstring">
3766	<desc>
3767	Local file system path for external BIOS splash image. Empty string
3768	means the default image is shown on boot.
3769	</desc>
3770	</attribute>
3771
3772	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3773	<desc>Mode of the BIOS boot device menu.</desc>
3774	</attribute>
3775
3776	<attribute name="ACPIEnabled" type="boolean">
3777	<desc>ACPI support flag.</desc>
3778	</attribute>
3779
3780	<attribute name="IOAPICEnabled" type="boolean">
3781	<desc>
3782	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3783	and support IRQs above 15.
3784	</desc>
3785	</attribute>
3786
3787	<attribute name="timeOffset" type="long long">
3788	<desc>
3789	Offset in milliseconds from the host system time. This allows for
3790	guests running with a different system date/time than the host.
3791	It is equivalent to setting the system date/time in the BIOS except
3792	it is not an absolute value but a relative one. Guest Additions
3793	time synchronization honors this offset.
3794	</desc>
3795	</attribute>
3796
3797	<attribute name="PXEDebugEnabled" type="boolean">
3798	<desc>
3799	PXE debug logging flag. If set, VirtualBox will write extensive
3800	PXE trace information to the release log.
3801	</desc>
3802	</attribute>
3803	</interface>
3804
3805	<interface
3806	name="IPCIAddress" extends="$unknown"
3807	uuid="c984d15f-e191-400b-840e-970f3dad7296"
3808	wsmap="managed"
3809	>
3810
3811	<desc>
3812	Address on the PCI bus.
3813	</desc>
3814
3815	<attribute name="bus" type="short">
3816	<desc>
3817	Bus number.
3818	</desc>
3819	</attribute>
3820
3821	<attribute name="device" type="short">
3822	<desc>
3823	Device number.
3824	</desc>
3825	</attribute>
3826
3827	<attribute name="devFunction" type="short">
3828	<desc>
3829	Device function number.
3830	</desc>
3831	</attribute>
3832
3833	<method name="asLong">
3834	<desc>
3835	Convert PCI address into long.
3836	</desc>
3837	<param name="result" type="long" dir="return" />
3838	</method>
3839
3840	<method name="fromLong">
3841	<desc>
3842	Make PCI address from long.
3843	</desc>
3844	<param name="number" type="long" dir="in" />
3845	</method>
3846	</interface>
3847
3848	<interface
3849	name="IPCIDeviceAttachment" extends="$unknown"
3850	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3851	wsmap="struct"
3852	>
3853
3854	<desc>
3855	Information about PCI attachments.
3856	</desc>
3857
3858	<attribute name="name" type="wstring" readonly="yes">
3859	<desc>
3860	Device name.
3861	</desc>
3862	</attribute>
3863
3864	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3865	<desc>
3866	If this is physical or virtual device.
3867	</desc>
3868	</attribute>
3869
3870	<attribute name="hostAddress" type="long" readonly="yes">
3871	<desc>
3872	Address of device on the host, applicable only to host devices.
3873	</desc>
3874	</attribute>
3875
3876	<attribute name="guestAddress" type="long" readonly="yes">
3877	<desc>
3878	Address of device on the guest.
3879	</desc>
3880	</attribute>
3881
3882	</interface>
3883
3884	<enum
3885	name="GraphicsControllerType"
3886	uuid="79c96ca0-9f39-4900-948e-68c41cbe127a"
3887	>
3888	<desc>Graphics controller type, used with <link to="IMachine::unregister" />.
3889	</desc>
3890	<const name="Null" value="0">
3891	<desc>Reserved value, invalid.</desc>
3892	</const>
3893	<const name="VBoxVGA" value="1">
3894	<desc>Default VirtualBox VGA device.</desc>
3895	</const>
3896	</enum>
3897
3898	<enum
3899	name="CleanupMode"
3900	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3901	>
3902	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3903	</desc>
3904	<const name="UnregisterOnly" value="1">
3905	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3906	</const>
3907	<const name="DetachAllReturnNone" value="2">
3908	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3909	</const>
3910	<const name="DetachAllReturnHardDisksOnly" value="3">
3911	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3912	</const>
3913	<const name="Full" value="4">
3914	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3915	</const>
3916	</enum>
3917
3918	<enum
3919	name="CloneMode" extends="$unknown"
3920	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3921	>
3922
3923	<desc>
3924	Clone mode, used with <link to="IMachine::cloneTo" />.
3925	</desc>
3926
3927	<const name="MachineState" value="1">
3928	<desc>Clone the state of the selected machine.</desc>
3929	</const>
3930	<const name="MachineAndChildStates" value="2">
3931	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3932	</const>
3933	<const name="AllStates" value="3">
3934	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3935	</const>
3936
3937	</enum>
3938
3939	<enum
3940	name="CloneOptions" extends="$unknown"
3941	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3942	>
3943
3944	<desc>
3945	Clone options, used with <link to="IMachine::cloneTo" />.
3946	</desc>
3947
3948	<const name="Link" value="1">
3949	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3950	</const>
3951	<const name="KeepAllMACs" value="2">
3952	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3953	</const>
3954	<const name="KeepNATMACs" value="3">
3955	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3956	</const>
3957	<const name="KeepDiskNames" value="4">
3958	<desc>Don't change the disk names.</desc>
3959	</const>
3960
3961	</enum>
3962
3963	<enum
3964	name="AutostopType" extends="$unknown"
3965	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3966	>
3967
3968	<desc>
3969	Autostop types, used with <link to="IMachine::autostopType" />.
3970	</desc>
3971
3972	<const name="Disabled" value="1">
3973	<desc>Stopping the VM during system shutdown is disabled.</desc>
3974	</const>
3975	<const name="SaveState" value="2">
3976	<desc>The state of the VM will be saved when the system shuts down.</desc>
3977	</const>
3978	<const name="PowerOff" value="3">
3979	<desc>The VM is powered off when the system shuts down.</desc>
3980	</const>
3981	<const name="AcpiShutdown" value="4">
3982	<desc>An ACPI shutdown event is generated.</desc>
3983	</const>
3984
3985	</enum>
3986
3987
3988	<interface
3989	name="IMachine" extends="$unknown"
3990	uuid="f6258810-a760-11e2-9e96-0800200c9a66"
3991	wsmap="managed"
3992	>
3993	<desc>
3994	The IMachine interface represents a virtual machine, or guest, created
3995	in VirtualBox.
3996
3997	This interface is used in two contexts. First of all, a collection of
3998	objects implementing this interface is stored in the
3999	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
4000	machines that are currently registered with this VirtualBox
4001	installation. Also, once a session has been opened for the given virtual
4002	machine (e.g. the virtual machine is running), the machine object
4003	associated with the open session can be queried from the session object;
4004	see <link to="ISession"/> for details.
4005
4006	The main role of this interface is to expose the settings of the virtual
4007	machine and provide methods to change various aspects of the virtual
4008	machine's configuration. For machine objects stored in the
4009	<link to="IVirtualBox::machines"/> collection, all attributes are
4010	read-only unless explicitly stated otherwise in individual attribute
4011	and method descriptions.
4012
4013	In order to change a machine setting, a session for this machine must be
4014	opened using one of the <link to="IMachine::lockMachine" /> or
4015	<link to="IMachine::launchVMProcess"/> methods. After the
4016	machine has been successfully locked for a session, a mutable machine object
4017	needs to be queried from the session object and then the desired settings
4018	changes can be applied to the returned object using IMachine attributes and
4019	methods. See the <link to="ISession"/> interface description for more
4020	information about sessions.
4021
4022	Note that IMachine does not provide methods to control virtual machine
4023	execution (such as start the machine, or power it down) -- these methods
4024	are grouped in a separate interface called <link to="IConsole" />.
4025
4026	<see><link to="ISession"/>, <link to="IConsole"/></see>
4027	</desc>
4028
4029	<attribute name="parent" type="IVirtualBox" readonly="yes">
4030	<desc>Associated parent object.</desc>
4031	</attribute>
4032
4033	<attribute name="icon" type="octet" safearray="yes">
4034	<desc>Overriden VM Icon details.</desc>
4035	</attribute>
4036
4037	<attribute name="accessible" type="boolean" readonly="yes">
4038	<desc>
4039	Whether this virtual machine is currently accessible or not.
4040
4041	A machine is always deemed accessible unless it is registered <i>and</i>
4042	its settings file cannot be read or parsed (either because the file itself
4043	is unavailable or has invalid XML contents).
4044
4045	Every time this property is read, the accessibility state of
4046	this machine is re-evaluated. If the returned value is @c false,
4047	the <link to="#accessError"/> property may be used to get the
4048	detailed error information describing the reason of
4049	inaccessibility, including XML error messages.
4050
4051	When the machine is inaccessible, only the following properties
4052	can be used on it:
4053	<ul>
4054	<li><link to="#parent"/></li>
4055	<li><link to="#id"/></li>
4056	<li><link to="#settingsFilePath"/></li>
4057	<li><link to="#accessible"/></li>
4058	<li><link to="#accessError"/></li>
4059	</ul>
4060
4061	An attempt to access any other property or method will return
4062	an error.
4063
4064	The only possible action you can perform on an inaccessible
4065	machine is to unregister it using the
4066	<link to="IMachine::unregister"/> call (or, to check
4067	for the accessibility state once more by querying this
4068	property).
4069
4070	<note>
4071	In the current implementation, once this property returns
4072	@c true, the machine will never become inaccessible
4073	later, even if its settings file cannot be successfully
4074	read/written any more (at least, until the VirtualBox
4075	server is restarted). This limitation may be removed in
4076	future releases.
4077	</note>
4078	</desc>
4079	</attribute>
4080
4081	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4082	<desc>
4083	Error information describing the reason of machine
4084	inaccessibility.
4085
4086	Reading this property is only valid after the last call to
4087	<link to="#accessible"/> returned @c false (i.e. the
4088	machine is currently inaccessible). Otherwise, a @c null
4089	IVirtualBoxErrorInfo object will be returned.
4090	</desc>
4091	</attribute>
4092
4093	<attribute name="name" type="wstring">
4094	<desc>
4095	Name of the virtual machine.
4096
4097	Besides being used for human-readable identification purposes
4098	everywhere in VirtualBox, the virtual machine name is also used
4099	as a name of the machine's settings file and as a name of the
4100	subdirectory this settings file resides in. Thus, every time you
4101	change the value of this property, the settings file will be
4102	renamed once you call <link to="#saveSettings"/> to confirm the
4103	change. The containing subdirectory will be also renamed, but
4104	only if it has exactly the same name as the settings file
4105	itself prior to changing this property (for backward compatibility
4106	with previous API releases). The above implies the following
4107	limitations:
4108	<ul>
4109	<li>The machine name cannot be empty.</li>
4110	<li>The machine name can contain only characters that are valid
4111	file name characters according to the rules of the file
4112	system used to store VirtualBox configuration.</li>
4113	<li>You cannot have two or more machines with the same name
4114	if they use the same subdirectory for storing the machine
4115	settings files.</li>
4116	<li>You cannot change the name of the machine if it is running,
4117	or if any file in the directory containing the settings file
4118	is being used by another running machine or by any other
4119	process in the host operating system at a time when
4120	<link to="#saveSettings"/> is called.
4121	</li>
4122	</ul>
4123	If any of the above limitations are hit, <link to="#saveSettings"/>
4124	will return an appropriate error message explaining the exact
4125	reason and the changes you made to this machine will not be saved.
4126
4127	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
4128	file is recommended, but not enforced. (Previous versions always
4129	used a generic ".xml" extension.)
4130	</desc>
4131	</attribute>
4132
4133	<attribute name="description" type="wstring">
4134	<desc>
4135	Description of the virtual machine.
4136
4137	The description attribute can contain any text and is
4138	typically used to describe the hardware and software
4139	configuration of the virtual machine in detail (i.e. network
4140	settings, versions of the installed software and so on).
4141	</desc>
4142	</attribute>
4143
4144	<attribute name="id" type="uuid" mod="string" readonly="yes">
4145	<desc>UUID of the virtual machine.</desc>
4146	</attribute>
4147
4148	<attribute name="groups" type="wstring" safearray="yes">
4149	<desc>
4150	Array of machine group names of which this machine is a member.
4151	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
4152	group is only listed once, however they are listed in no particular
4153	order and there is no guarantee that there are no gaps in the group
4154	hierarchy (i.e. <tt>"/group"</tt>,
4155	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
4156	</desc>
4157	</attribute>
4158
4159	<attribute name="OSTypeId" type="wstring">
4160	<desc>
4161	User-defined identifier of the Guest OS type.
4162	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4163	an IGuestOSType object representing details about the given
4164	Guest OS type.
4165	<note>
4166	This value may differ from the value returned by
4167	<link to="IGuest::OSTypeId"/> if Guest Additions are
4168	installed to the guest OS.
4169	</note>
4170	</desc>
4171	</attribute>
4172
4173	<attribute name="hardwareVersion" type="wstring">
4174	<desc>Hardware version identifier. Internal use only for now.</desc>
4175	</attribute>
4176
4177	<attribute name="hardwareUUID" type="uuid" mod="string">
4178	<desc>
4179	The UUID presented to the guest via memory tables, hardware and guest
4180	properties. For most VMs this is the same as the @a id, but for VMs
4181	which have been cloned or teleported it may be the same as the source
4182	VM. The latter is because the guest shouldn't notice that it was
4183	cloned or teleported.
4184	</desc>
4185	</attribute>
4186
4187	<attribute name="CPUCount" type="unsigned long">
4188	<desc>Number of virtual CPUs in the VM.</desc>
4189	</attribute>
4190
4191	<attribute name="CPUHotPlugEnabled" type="boolean">
4192	<desc>
4193	This setting determines whether VirtualBox allows CPU
4194	hotplugging for this machine.</desc>
4195	</attribute>
4196
4197	<attribute name="CPUExecutionCap" type="unsigned long">
4198	<desc>
4199	Means to limit the number of CPU cycles a guest can use. The unit
4200	is percentage of host CPU cycles per second. The valid range
4201	is 1 - 100. 100 (the default) implies no limit.
4202	</desc>
4203	</attribute>
4204
4205	<attribute name="memorySize" type="unsigned long">
4206	<desc>System memory size in megabytes.</desc>
4207	</attribute>
4208
4209	<attribute name="memoryBalloonSize" type="unsigned long">
4210	<desc>Memory balloon size in megabytes.</desc>
4211	</attribute>
4212
4213	<attribute name="pageFusionEnabled" type="boolean">
4214	<desc>
4215	This setting determines whether VirtualBox allows page
4216	fusion for this machine (64-bit hosts only).
4217	</desc>
4218	</attribute>
4219
4220	<attribute name="graphicsControllerType" type="GraphicsControllerType">
4221	<desc>Graphics controller type.</desc>
4222	</attribute>
4223
4224	<attribute name="VRAMSize" type="unsigned long">
4225	<desc>Video memory size in megabytes.</desc>
4226	</attribute>
4227
4228	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4229	<desc>
4230	This setting determines whether VirtualBox allows this machine to make
4231	use of the 3D graphics support available on the host.</desc>
4232	</attribute>
4233
4234	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4235	<desc>
4236	This setting determines whether VirtualBox allows this machine to make
4237	use of the 2D video acceleration support available on the host.</desc>
4238	</attribute>
4239
4240	<attribute name="monitorCount" type="unsigned long">
4241	<desc>
4242	Number of virtual monitors.
4243	<note>
4244	Only effective on Windows XP and later guests with
4245	Guest Additions installed.
4246	</note>
4247	</desc>
4248	</attribute>
4249
4250	<attribute name="videoCaptureEnabled" type="boolean" default="false">
4251	<desc>
4252	This setting determines whether VirtualBox uses video recording to
4253	record VM session.</desc>
4254	</attribute>
4255
4256	<attribute name="videoCaptureScreens" type="boolean" safearray="yes">
4257	<desc>
4258	This setting determines for which screens video recording is
4259	enabled.</desc>
4260	</attribute>
4261
4262	<attribute name="videoCaptureFile" type="wstring">
4263	<desc>
4264	This setting determines the filename VirtualBox uses to save
4265	the recorded content. This setting cannot be changed while video
4266	capturing is enabled.
4267	<note>
4268	When setting this attribute, the specified path has to be
4269	absolute (full path). When reading this attribute, a full path is
4270	always returned.
4271	</note>
4272	</desc>
4273	</attribute>
4274
4275	<attribute name="videoCaptureWidth" type="unsigned long" default="640">
4276	<desc>
4277	This setting determines the horizontal resolution of the recorded
4278	video. This setting cannot be changed while video capturing is
4279	enabled.
4280	</desc>
4281	</attribute>
4282
4283	<attribute name="videoCaptureHeight" type="unsigned long" default="480">
4284	<desc>
4285	This setting determines the vertical resolution of the recorded
4286	video. This setting cannot be changed while video capturing is
4287	enabled.
4288	</desc>
4289	</attribute>
4290
4291	<attribute name="videoCaptureRate" type="unsigned long" default="512">
4292	<desc>
4293	This setting determines the bitrate in kilobits per second.
4294	Increasing this value makes the video look better for the
4295	cost of an increased file size. This setting cannot be changed
4296	while video capturing is enabled.
4297	</desc>
4298	</attribute>
4299
4300	<attribute name="videoCaptureFPS" type="unsigned long" default="25">
4301	<desc>
4302	This setting determines the maximum number of frames per second.
4303	Frames with a higher frequency will be skipped. Reducing this
4304	value increases the number of skipped frames and reduces the
4305	file size. This setting cannot be changed while video capturing
4306	is enabled.
4307	</desc>
4308	</attribute>
4309
4310	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4311	<desc>Object containing all BIOS settings.</desc>
4312	</attribute>
4313
4314	<attribute name="firmwareType" type="FirmwareType">
4315	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4316	bootstrap in this VM.</desc>
4317	</attribute>
4318
4319	<attribute name="pointingHIDType" type="PointingHIDType">
4320	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4321	The default is typically "PS2Mouse" but can vary depending on the
4322	requirements of the guest operating system.</desc>
4323	</attribute>
4324
4325	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4326	<desc>Type of keyboard HID used in this VM.
4327	The default is typically "PS2Keyboard" but can vary depending on the
4328	requirements of the guest operating system.</desc>
4329	</attribute>
4330
4331	<attribute name="HPETEnabled" type="boolean">
4332	<desc>This attribute controls if High Precision Event Timer (HPET) is
4333	enabled in this VM. Use this property if you want to provide guests
4334	with additional time source, or if guest requires HPET to function correctly.
4335	Default is false.</desc>
4336	</attribute>
4337
4338	<attribute name="chipsetType" type="ChipsetType">
4339	<desc>Chipset type used in this VM.</desc>
4340	</attribute>
4341
4342	<attribute name="snapshotFolder" type="wstring">
4343	<desc>
4344	Full path to the directory used to store snapshot data
4345	(differencing media and saved state files) of this machine.
4346
4347	The initial value of this property is
4348	<tt><</tt><link to="#settingsFilePath">
4349	path_to_settings_file</link><tt>>/<</tt>
4350	<link to="#id">machine_uuid</link>
4351	<tt>></tt>.
4352
4353	Currently, it is an error to try to change this property on
4354	a machine that has snapshots (because this would require to
4355	move possibly large files to a different location).
4356	A separate method will be available for this purpose later.
4357
4358	<note>
4359	Setting this property to @c null or to an empty string will restore
4360	the initial value.
4361	</note>
4362	<note>
4363	When setting this property, the specified path can be
4364	absolute (full path) or relative to the directory where the
4365	<link to="#settingsFilePath">machine settings file</link>
4366	is located. When reading this property, a full path is
4367	always returned.
4368	</note>
4369	<note>
4370	The specified path may not exist, it will be created
4371	when necessary.
4372	</note>
4373	</desc>
4374	</attribute>
4375
4376	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4377	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4378	</attribute>
4379
4380	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4381	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4382
4383	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4384	<desc>Array of media attached to this machine.</desc>
4385	</attribute>
4386
4387	<attribute name="USBController" type="IUSBController" readonly="yes">
4388	<desc>
4389	Associated USB controller object.
4390
4391	<note>
4392	If USB functionality is not available in the given edition of
4393	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4394	</note>
4395	</desc>
4396	</attribute>
4397
4398	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4399	<desc>Associated audio adapter, always present.</desc>
4400	</attribute>
4401
4402	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4403	<desc>Array of storage controllers attached to this machine.</desc>
4404	</attribute>
4405
4406	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4407	<desc>
4408	Full name of the file containing machine settings data.
4409	</desc>
4410	</attribute>
4411
4412	<attribute name="settingsModified" type="boolean" readonly="yes">
4413	<desc>
4414	Whether the settings of this machine have been modified
4415	(but neither yet saved nor discarded).
4416	<note>
4417	Reading this property is only valid on instances returned
4418	by <link to="ISession::machine"/> and on new machines
4419	created by <link to="IVirtualBox::createMachine"/> or opened
4420	by <link to="IVirtualBox::openMachine"/> but not
4421	yet registered, or on unregistered machines after calling
4422	<link to="IMachine::unregister"/>. For all other
4423	cases, the settings can never be modified.
4424	</note>
4425	<note>
4426	For newly created unregistered machines, the value of this
4427	property is always @c true until <link to="#saveSettings"/>
4428	is called (no matter if any machine settings have been
4429	changed after the creation or not). For opened machines
4430	the value is set to @c false (and then follows to normal rules).
4431	</note>
4432	</desc>
4433	</attribute>
4434
4435	<attribute name="sessionState" type="SessionState" readonly="yes">
4436	<desc>Current session state for this machine.</desc>
4437	</attribute>
4438
4439	<attribute name="sessionType" type="wstring" readonly="yes">
4440	<desc>
4441	Type of the session. If <link to="#sessionState"/> is
4442	Spawning or Locked, this attribute contains the
4443	same value as passed to the
4444	<link to="IMachine::launchVMProcess"/> method in the
4445	@a type parameter. If the session was used with
4446	<link to="IMachine::lockMachine" />, or if
4447	<link to="#sessionState"/> is SessionClosed, the value of this
4448	attribute is an empty string.
4449	</desc>
4450	</attribute>
4451
4452	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4453	<desc>
4454	Identifier of the session process. This attribute contains the
4455	platform-dependent identifier of the process whose session was
4456	used with <link to="IMachine::lockMachine" /> call. The returned
4457	value is only valid if <link to="#sessionState"/> is Locked or
4458	Unlocking by the time this property is read.
4459	</desc>
4460	</attribute>
4461
4462	<attribute name="state" type="MachineState" readonly="yes">
4463	<desc>Current execution state of this machine.</desc>
4464	</attribute>
4465
4466	<attribute name="lastStateChange" type="long long" readonly="yes">
4467	<desc>
4468	Time stamp of the last execution state change,
4469	in milliseconds since 1970-01-01 UTC.
4470	</desc>
4471	</attribute>
4472
4473	<attribute name="stateFilePath" type="wstring" readonly="yes">
4474	<desc>
4475	Full path to the file that stores the execution state of
4476	the machine when it is in the <link to="MachineState_Saved"/> state.
4477	<note>
4478	When the machine is not in the Saved state, this attribute is
4479	an empty string.
4480	</note>
4481	</desc>
4482	</attribute>
4483
4484	<attribute name="logFolder" type="wstring" readonly="yes">
4485	<desc>
4486	Full path to the folder that stores a set of rotated log files
4487	recorded during machine execution. The most recent log file is
4488	named <tt>VBox.log</tt>, the previous log file is
4489	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4490	in the current version).
4491	</desc>
4492	</attribute>
4493
4494	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4495	<desc>
4496	Current snapshot of this machine. This is @c null if the machine
4497	currently has no snapshots. If it is not @c null, then it was
4498	set by one of <link to="IConsole::takeSnapshot" />,
4499	<link to="IConsole::deleteSnapshot" />
4500	or <link to="IConsole::restoreSnapshot" />, depending on which
4501	was called last. See <link to="ISnapshot"/> for details.
4502	</desc>
4503	</attribute>
4504
4505	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4506	<desc>
4507	Number of snapshots taken on this machine. Zero means the
4508	machine doesn't have any snapshots.
4509	</desc>
4510	</attribute>
4511
4512	<attribute name="currentStateModified" type="boolean" readonly="yes">
4513	<desc>
4514	Returns @c true if the current state of the machine is not
4515	identical to the state stored in the current snapshot.
4516
4517	The current state is identical to the current snapshot only
4518	directly after one of the following calls are made:
4519
4520	<ul>
4521	<li><link to="IConsole::restoreSnapshot"/>
4522	</li>
4523	<li><link to="IConsole::takeSnapshot"/> (issued on a
4524	"powered off" or "saved" machine, for which
4525	<link to="#settingsModified"/> returns @c false)
4526	</li>
4527	</ul>
4528
4529	The current state remains identical until one of the following
4530	happens:
4531	<ul>
4532	<li>settings of the machine are changed</li>
4533	<li>the saved state is deleted</li>
4534	<li>the current snapshot is deleted</li>
4535	<li>an attempt to execute the machine is made</li>
4536	</ul>
4537
4538	<note>
4539	For machines that don't have snapshots, this property is
4540	always @c false.
4541	</note>
4542	</desc>
4543	</attribute>
4544
4545	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4546	<desc>
4547	Collection of shared folders for this machine (permanent shared
4548	folders). These folders are shared automatically at machine startup
4549	and available only to the guest OS installed within this machine.
4550
4551	New shared folders are added to the collection using
4552	<link to="#createSharedFolder"/>. Existing shared folders can be
4553	removed using <link to="#removeSharedFolder"/>.
4554	</desc>
4555	</attribute>
4556
4557	<attribute name="clipboardMode" type="ClipboardMode">
4558	<desc>
4559	Synchronization mode between the host OS clipboard
4560	and the guest OS clipboard.
4561	</desc>
4562	</attribute>
4563
4564	<attribute name="dragAndDropMode" type="DragAndDropMode">
4565	<desc>
4566	Which mode is allowed for drag'n'drop.
4567	</desc>
4568	</attribute>
4569
4570	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4571	<desc>
4572	A comma-separated list of simple glob patterns. Changes to guest
4573	properties whose name matches one of the patterns will generate an
4574	<link to="IGuestPropertyChangedEvent"/> signal.
4575	</desc>
4576	</attribute>
4577
4578	<attribute name="teleporterEnabled" type="boolean">
4579	<desc>
4580	When set to @a true, the virtual machine becomes a target teleporter
4581	the next time it is powered on. This can only set to @a true when the
4582	VM is in the @a PoweredOff or @a Aborted state.
4583
4584	<!-- This property is automatically set to @a false when the VM is powered
4585	on. (bird: This doesn't work yet ) -->
4586	</desc>
4587	</attribute>
4588
4589	<attribute name="teleporterPort" type="unsigned long">
4590	<desc>
4591	The TCP port the target teleporter will listen for incoming
4592	teleportations on.
4593
4594	0 means the port is automatically selected upon power on. The actual
4595	value can be read from this property while the machine is waiting for
4596	incoming teleportations.
4597	</desc>
4598	</attribute>
4599
4600	<attribute name="teleporterAddress" type="wstring">
4601	<desc>
4602	The address the target teleporter will listen on. If set to an empty
4603	string, it will listen on all addresses.
4604	</desc>
4605	</attribute>
4606
4607	<attribute name="teleporterPassword" type="wstring">
4608	<desc>
4609	The password to check for on the target teleporter. This is just a
4610	very basic measure to prevent simple hacks and operators accidentally
4611	beaming a virtual machine to the wrong place.
4612
4613	Note that you SET a plain text password while reading back a HASHED
4614	password. Setting a hashed password is currently not supported.
4615	</desc>
4616	</attribute>
4617
4618	<attribute name="faultToleranceState" type="FaultToleranceState">
4619	<desc>
4620	Fault tolerance state; disabled, source or target.
4621	This property can be changed at any time. If you change it for a running
4622	VM, then the fault tolerance address and port must be set beforehand.
4623	</desc>
4624	</attribute>
4625
4626	<attribute name="faultTolerancePort" type="unsigned long">
4627	<desc>
4628	The TCP port the fault tolerance source or target will use for
4629	communication.
4630	</desc>
4631	</attribute>
4632
4633	<attribute name="faultToleranceAddress" type="wstring">
4634	<desc>
4635	The address the fault tolerance source or target.
4636	</desc>
4637	</attribute>
4638
4639	<attribute name="faultTolerancePassword" type="wstring">
4640	<desc>
4641	The password to check for on the standby VM. This is just a
4642	very basic measure to prevent simple hacks and operators accidentally
4643	choosing the wrong standby VM.
4644	</desc>
4645	</attribute>
4646
4647	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4648	<desc>
4649	The interval in ms used for syncing the state between source and target.
4650	</desc>
4651	</attribute>
4652
4653	<attribute name="RTCUseUTC" type="boolean">
4654	<desc>
4655	When set to @a true, the RTC device of the virtual machine will run
4656	in UTC time, otherwise in local time. Especially Unix guests prefer
4657	the time in UTC.
4658	</desc>
4659	</attribute>
4660
4661	<attribute name="IOCacheEnabled" type="boolean">
4662	<desc>
4663	When set to @a true, the builtin I/O cache of the virtual machine
4664	will be enabled.
4665	</desc>
4666	</attribute>
4667
4668	<attribute name="IOCacheSize" type="unsigned long">
4669	<desc>
4670	Maximum size of the I/O cache in MB.
4671	</desc>
4672	</attribute>
4673
4674	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4675	<desc>Array of PCI devices assigned to this machine, to get list of all
4676	PCI devices attached to the machine use
4677	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4678	is intended to list only devices additional to what described in
4679	virtual hardware config. Usually, this list keeps host's physical
4680	devices assigned to the particular machine.
4681	</desc>
4682	</attribute>
4683
4684	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4685	<desc>
4686	Bandwidth control manager.
4687	</desc>
4688	</attribute>
4689
4690	<attribute name="tracingEnabled" type="boolean">
4691	<desc>
4692	Enables the tracing facility in the VMM (including PDM devices +
4693	drivers). The VMM will consume about 0.5MB of more memory when
4694	enabled and there may be some extra overhead from tracepoints that are
4695	always enabled.
4696	</desc>
4697	</attribute>
4698
4699	<attribute name="tracingConfig" type="wstring">
4700	<desc>
4701	Tracepoint configuration to apply at startup when
4702	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4703	a space separated of tracepoint group names to enable. The special
4704	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4705	more details on available tracepoint groups and such.
4706
4707	Note that on hosts supporting DTrace (or similar), a lot of the
4708	tracepoints may be implemented exclusivly as DTrace probes. So, the
4709	effect of the same config may differ between Solaris and Windows for
4710	example.
4711	</desc>
4712	</attribute>
4713
4714	<attribute name="allowTracingToAccessVM" type="boolean">
4715	<desc>
4716	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4717	structures when firing off trace points. This is especially useful
4718	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4719	pointer to obtain useful information such as guest register state.
4720
4721	This is disabled by default because devices and drivers normally has no
4722	business accessing the VMCPU or VM structures, and are therefore unable
4723	to get any pointers to these.
4724	</desc>
4725	</attribute>
4726
4727	<attribute name="autostartEnabled" type="boolean">
4728	<desc>
4729	Enables autostart of the VM during system boot.
4730	</desc>
4731	</attribute>
4732
4733	<attribute name="autostartDelay" type="unsigned long">
4734	<desc>
4735	Number of seconds to wait until the VM should be started during system boot.
4736	</desc>
4737	</attribute>
4738
4739	<attribute name="autostopType" type="AutostopType">
4740	<desc>
4741	Action type to do when the system is shutting down.
4742	</desc>
4743	</attribute>
4744
4745	<attribute name="defaultFrontend" type="wstring">
4746	<desc>
4747	Selects which VM frontend should be used by default when launching
4748	this VM through the <link to="IMachine::launchVMProcess" /> method.
4749	Empty or @c null strings do not define a particular default, it is up
4750	to <link to="IMachine::launchVMProcess" /> to select one. See the
4751	description of <link to="IMachine::launchVMProcess" /> for the valid
4752	frontend types.
4753
4754	This per-VM setting overrides the default defined by
4755	<link to="ISystemProperties::defaultFrontend" /> attribute, and is
4756	overridden by a frontend type passed to
4757	<link to="IMachine::launchVMProcess" />.
4758	</desc>
4759	</attribute>
4760
4761	<method name="lockMachine">
4762	<desc>
4763	Locks the machine for the given session to enable the caller
4764	to make changes to the machine or start the VM or control
4765	VM execution.
4766
4767	There are two ways to lock a machine for such uses:
4768
4769	<ul>
4770	<li>If you want to make changes to the machine settings,
4771	you must obtain an exclusive write lock on the machine
4772	by setting @a lockType to @c Write.
4773
4774	This will only succeed if no other process has locked
4775	the machine to prevent conflicting changes. Only after
4776	an exclusive write lock has been obtained using this method, one
4777	can change all VM settings or execute the VM in the process
4778	space of the session object. (Note that the latter is only of
4779	interest if you actually want to write a new front-end for
4780	virtual machines; but this API gets called internally by
4781	the existing front-ends such as VBoxHeadless and the VirtualBox
4782	GUI to acquire a write lock on the machine that they are running.)
4783
4784	On success, write-locking the machine for a session creates
4785	a second copy of the IMachine object. It is this second object
4786	upon which changes can be made; in VirtualBox terminology, the
4787	second copy is "mutable". It is only this second, mutable machine
4788	object upon which you can call methods that change the
4789	machine state. After having called this method, you can
4790	obtain this second, mutable machine object using the
4791	<link to="ISession::machine" /> attribute.
4792	</li>
4793	<li>If you only want to check the machine state or control
4794	machine execution without actually changing machine
4795	settings (e.g. to get access to VM statistics or take
4796	a snapshot or save the machine state), then set the
4797	@a lockType argument to @c Shared.
4798
4799	If no other session has obtained a lock, you will obtain an
4800	exclusive write lock as described above. However, if another
4801	session has already obtained such a lock, then a link to that
4802	existing session will be established which allows you
4803	to control that existing session.
4804
4805	To find out which type of lock was obtained, you can
4806	inspect <link to="ISession::type" />, which will have been
4807	set to either @c WriteLock or @c Shared.
4808	</li>
4809	</ul>
4810
4811	In either case, you can get access to the <link to="IConsole" />
4812	object which controls VM execution.
4813
4814	Also in all of the above cases, one must always call
4815	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4816	the machine's state will eventually be set to "Aborted".
4817
4818	To change settings on a machine, the following sequence is typically
4819	performed:
4820
4821	<ol>
4822	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4823
4824	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4825
4826	<li>Change the settings of the machine by invoking IMachine methods.</li>
4827
4828	<li>Call <link to="IMachine::saveSettings" />.</li>
4829
4830	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4831	</ol>
4832
4833	<result name="E_UNEXPECTED">
4834	Virtual machine not registered.
4835	</result>
4836	<result name="E_ACCESSDENIED">
4837	Process not started by OpenRemoteSession.
4838	</result>
4839	<result name="VBOX_E_INVALID_OBJECT_STATE">
4840	Session already open or being opened.
4841	</result>
4842	<result name="VBOX_E_VM_ERROR">
4843	Failed to assign machine to session.
4844	</result>
4845	</desc>
4846	<param name="session" type="ISession" dir="in">
4847	<desc>
4848	Session object for which the machine will be locked.
4849	</desc>
4850	</param>
4851	<param name="lockType" type="LockType" dir="in">
4852	<desc>
4853	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4854	If set to @c Shared, then either acquire an exclusive write lock or establish
4855	a link to an existing session.
4856	</desc>
4857	</param>
4858	</method>
4859
4860	<method name="launchVMProcess">
4861	<desc>
4862	Spawns a new process that will execute the virtual machine and obtains a shared
4863	lock on the machine for the calling session.
4864
4865	If launching the VM succeeds, the new VM process will create its own session
4866	and write-lock the machine for it, preventing conflicting changes from other
4867	processes. If the machine is already locked (because it is already running or
4868	because another session has a write lock), launching the VM process will therefore
4869	fail. Reversely, future attempts to obtain a write lock will also fail while the
4870	machine is running.
4871
4872	The caller's session object remains separate from the session opened by the new
4873	VM process. It receives its own <link to="IConsole" /> object which can be used
4874	to control machine execution, but it cannot be used to change all VM settings
4875	which would be available after a <link to="#lockMachine" /> call.
4876
4877	The caller must eventually release the session's shared lock by calling
4878	<link to="ISession::unlockMachine" /> on the local session object once this call
4879	has returned. However, the session's state (see <link to="ISession::state" />)
4880	will not return to "Unlocked" until the remote session has also unlocked
4881	the machine (i.e. the machine has stopped running).
4882
4883	Launching a VM process can take some time (a new VM is started in a new process,
4884	for which memory and other resources need to be set up). Because of this,
4885	an <link to="IProgress" /> object is returned to allow the caller to wait
4886	for this asynchronous operation to be completed. Until then, the caller's
4887	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4888	and <link to="ISession::console" /> attributes cannot be accessed.
4889	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4890	similar calls to wait for completion. Completion is signalled when the VM
4891	is powered on. If launching the VM fails, error messages can be queried
4892	via the progress object, if available.
4893
4894	The progress object will have at least 2 sub-operations. The first
4895	operation covers the period up to the new VM process calls powerUp.
4896	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4897	progress object. Because <link to="IConsole::powerUp"/> may require
4898	some extra sub-operations, the <link to="IProgress::operationCount"/>
4899	may change at the completion of operation.
4900
4901	For details on the teleportation progress operation, see
4902	<link to="IConsole::powerUp"/>.
4903
4904	The @a environment argument is a string containing definitions of
4905	environment variables in the following format:
4906	<pre>
4907	NAME[=VALUE]\n
4908	NAME[=VALUE]\n
4909	...
4910	</pre>
4911	where <tt>\\n</tt> is the new line character. These environment
4912	variables will be appended to the environment of the VirtualBox server
4913	process. If an environment variable exists both in the server process
4914	and in this list, the value from this list takes precedence over the
4915	server's variable. If the value of the environment variable is
4916	omitted, this variable will be removed from the resulting environment.
4917	If the environment string is @c null or empty, the server environment
4918	is inherited by the started process as is.
4919
4920	<result name="E_UNEXPECTED">
4921	Virtual machine not registered.
4922	</result>
4923	<result name="E_INVALIDARG">
4924	Invalid session type @a type.
4925	</result>
4926	<result name="VBOX_E_OBJECT_NOT_FOUND">
4927	No machine matching @a machineId found.
4928	</result>
4929	<result name="VBOX_E_INVALID_OBJECT_STATE">
4930	Session already open or being opened.
4931	</result>
4932	<result name="VBOX_E_IPRT_ERROR">
4933	Launching process for machine failed.
4934	</result>
4935	<result name="VBOX_E_VM_ERROR">
4936	Failed to assign machine to session.
4937	</result>
4938	</desc>
4939	<param name="session" type="ISession" dir="in">
4940	<desc>
4941	Client session object to which the VM process will be connected (this
4942	must be in "Unlocked" state).
4943	</desc>
4944	</param>
4945	<param name="type" type="wstring" dir="in">
4946	<desc>
4947	Front-end to use for the new VM process. The following are currently supported:
4948	<ul>
4949	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4950	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4951	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4952	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4953	the currently running VM or session owner. In this case the
4954	@a session parameter may be @c null (if it is non-null it isn't
4955	used in any way), and the @a progress return value will be always
4956	@c null. The operation completes immediately.</li>
4957	<li><tt>""</tt>: use the per-VM default frontend if set, otherwise
4958	the global default defined in the system properties. If neither
4959	are set, the API will launch a <tt>"gui"</tt> session, which may
4960	fail if there is no windowing environment available. See
4961	<link to="IMachine::defaultFrontend"/> and
4962	<link to="ISystemProperties::defaultFrontend"/>.</li>
4963	</ul>
4964	</desc>
4965	</param>
4966	<param name="environment" type="wstring" dir="in">
4967	<desc>
4968	Environment to pass to the VM process.
4969	</desc>
4970	</param>
4971	<param name="progress" type="IProgress" dir="return">
4972	<desc>Progress object to track the operation completion.</desc>
4973	</param>
4974	</method>
4975
4976	<method name="setBootOrder">
4977	<desc>
4978	Puts the given device to the specified position in
4979	the boot order.
4980
4981	To indicate that no device is associated with the given position,
4982	<link to="DeviceType_Null"/> should be used.
4983
4984	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4985
4986	<result name="E_INVALIDARG">
4987	Boot @a position out of range.
4988	</result>
4989	<result name="E_NOTIMPL">
4990	Booting from USB @a device currently not supported.
4991	</result>
4992
4993	</desc>
4994	<param name="position" type="unsigned long" dir="in">
4995	<desc>
4996	Position in the boot order (@c 1 to the total number of
4997	devices the machine can boot from, as returned by
4998	<link to="ISystemProperties::maxBootPosition"/>).
4999	</desc>
5000	</param>
5001	<param name="device" type="DeviceType" dir="in">
5002	<desc>
5003	The type of the device used to boot at the given position.
5004	</desc>
5005	</param>
5006	</method>
5007
5008	<method name="getBootOrder" const="yes">
5009	<desc>
5010	Returns the device type that occupies the specified
5011	position in the boot order.
5012
5013	@todo [remove?]
5014	If the machine can have more than one device of the returned type
5015	(such as hard disks), then a separate method should be used to
5016	retrieve the individual device that occupies the given position.
5017
5018	If here are no devices at the given position, then
5019	<link to="DeviceType_Null"/> is returned.
5020
5021	@todo getHardDiskBootOrder(), getNetworkBootOrder()
5022
5023	<result name="E_INVALIDARG">
5024	Boot @a position out of range.
5025	</result>
5026
5027	</desc>
5028	<param name="position" type="unsigned long" dir="in">
5029	<desc>
5030	Position in the boot order (@c 1 to the total number of
5031	devices the machine can boot from, as returned by
5032	<link to="ISystemProperties::maxBootPosition"/>).
5033	</desc>
5034	</param>
5035	<param name="device" type="DeviceType" dir="return">
5036	<desc>
5037	Device at the given position.
5038	</desc>
5039	</param>
5040	</method>
5041
5042	<method name="attachDevice">
5043	<desc>
5044	Attaches a device and optionally mounts a medium to the given storage
5045	controller (<link to="IStorageController" />, identified by @a name),
5046	at the indicated port and device.
5047
5048	This method is intended for managing storage devices in general while a
5049	machine is powered off. It can be used to attach and detach fixed
5050	and removable media. The following kind of media can be attached
5051	to a machine:
5052
5053	<ul>
5054	<li>For fixed and removable media, you can pass in a medium that was
5055	previously opened using <link to="IVirtualBox::openMedium" />.
5056	</li>
5057
5058	<li>Only for storage devices supporting removable media (such as
5059	DVDs and floppies), you can also specify a null pointer to
5060	indicate an empty drive or one of the medium objects listed
5061	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
5062	arrays to indicate a host drive.
5063	For removable devices, you can also use <link to="IMachine::mountMedium"/>
5064	to change the media while the machine is running.
5065	</li>
5066	</ul>
5067
5068	In a VM's default configuration of virtual machines, the secondary
5069	master of the IDE controller is used for a CD/DVD drive.
5070
5071	After calling this returns successfully, a new instance of
5072	<link to="IMediumAttachment"/> will appear in the machine's list of medium
5073	attachments (see <link to="IMachine::mediumAttachments"/>).
5074
5075	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
5076	information about attaching media.
5077
5078	The specified device slot must not have a device attached to it,
5079	or this method will fail.
5080
5081	<note>
5082	You cannot attach a device to a newly created machine until
5083	this machine's settings are saved to disk using
5084	<link to="#saveSettings"/>.
5085	</note>
5086	<note>
5087	If the medium is being attached indirectly, a new differencing medium
5088	will implicitly be created for it and attached instead. If the
5089	changes made to the machine settings (including this indirect
5090	attachment) are later cancelled using <link to="#discardSettings"/>,
5091	this implicitly created differencing medium will implicitly
5092	be deleted.
5093	</note>
5094
5095	<result name="E_INVALIDARG">
5096	SATA device, SATA port, IDE port or IDE slot out of range, or
5097	file or UUID not found.
5098	</result>
5099	<result name="VBOX_E_INVALID_OBJECT_STATE">
5100	Machine must be registered before media can be attached.
5101	</result>
5102	<result name="VBOX_E_INVALID_VM_STATE">
5103	Invalid machine state.
5104	</result>
5105	<result name="VBOX_E_OBJECT_IN_USE">
5106	A medium is already attached to this or another virtual machine.
5107	</result>
5108
5109	</desc>
5110	<param name="name" type="wstring" dir="in">
5111	<desc>Name of the storage controller to attach the device to.</desc>
5112	</param>
5113	<param name="controllerPort" type="long" dir="in">
5114	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5115	the primary controller and 1 specifies the secondary controller.
5116	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5117	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5118	</param>
5119	<param name="device" type="long" dir="in">
5120	<desc>Device slot in the given port to attach the device to. This is only
5121	relevant for IDE controllers, for which 0 specifies the master device and
5122	1 specifies the slave device. For all other controller types, this must
5123	be 0.</desc>
5124	</param>
5125	<param name="type" type="DeviceType" dir="in">
5126	<desc>Device type of the attached device. For media opened by
5127	<link to="IVirtualBox::openMedium" />, this must match the device type
5128	specified there.</desc>
5129	</param>
5130	<param name="medium" type="IMedium" dir="in">
5131	<desc>Medium to mount or @c null for an empty drive.</desc>
5132	</param>
5133	</method>
5134
5135	<method name="attachDeviceWithoutMedium">
5136	<desc>
5137	Attaches a device and optionally mounts a medium to the given storage
5138	controller (<link to="IStorageController" />, identified by @a name),
5139	at the indicated port and device.
5140
5141	This method is intended for managing storage devices in general while a
5142	machine is powered off. It can be used to attach and detach fixed
5143	and removable media. The following kind of media can be attached
5144	to a machine:
5145	<ul>
5146	<li>
5147	For fixed and removable media, you can pass in a medium that was
5148	previously opened using <link to="IVirtualBox::openMedium" />.
5149	</li>
5150
5151	<li>Only for storage devices supporting removable media (such as
5152	DVDs and floppies) with an empty drive or one of the medium objects listed
5153	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
5154	arrays to indicate a host drive.
5155	For removable devices, you can also use <link to="IMachine::mountMedium"/>
5156	to change the media while the machine is running.
5157	</li>
5158	</ul>
5159
5160	In a VM's default configuration of virtual machines, the secondary
5161	master of the IDE controller is used for a CD/DVD drive.
5162	<link to="IMediumAttachment"/> will appear in the machine's list of medium
5163	attachments (see <link to="IMachine::mediumAttachments"/>).
5164
5165	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
5166	information about attaching media.
5167
5168	The specified device slot must not have a device attached to it,
5169	or this method will fail.
5170	<note>
5171	You cannot attach a device to a newly created machine until
5172	this machine's settings are saved to disk using
5173	<link to="#saveSettings"/>.
5174	</note>
5175	<note>
5176	If the medium is being attached indirectly, a new differencing medium
5177	will implicitly be created for it and attached instead. If the
5178	changes made to the machine settings (including this indirect
5179	attachment) are later cancelled using <link to="#discardSettings"/>,
5180	this implicitly created differencing medium will implicitly
5181	be deleted.
5182	</note>
5183
5184	<result name="E_INVALIDARG">
5185	SATA device, SATA port, IDE port or IDE slot out of range, or
5186	file or UUID not found.
5187	</result>
5188	<result name="VBOX_E_INVALID_OBJECT_STATE">
5189	Machine must be registered before media can be attached.
5190	</result>
5191	<result name="VBOX_E_INVALID_VM_STATE">
5192	Invalid machine state.
5193	</result>
5194	<result name="VBOX_E_OBJECT_IN_USE">
5195	A medium is already attached to this or another virtual machine.
5196	</result>
5197	</desc>
5198	<param name="name" type="wstring" dir="in">
5199	<desc>Name of the storage controller to attach the device to.</desc>
5200	</param>
5201	<param name="controllerPort" type="long" dir="in">
5202	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5203	the primary controller and 1 specifies the secondary controller.
5204	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5205	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5206	</param>
5207	<param name="device" type="long" dir="in">
5208	<desc>Device slot in the given port to attach the device to. This is only
5209	relevant for IDE controllers, for which 0 specifies the master device and
5210	1 specifies the slave device. For all other controller types, this must
5211	be 0.</desc>
5212	</param>
5213	<param name="type" type="DeviceType" dir="in">
5214	<desc>Device type of the attached device. For media opened by
5215	<link to="IVirtualBox::openMedium" />, this must match the device type
5216	specified there.</desc>
5217	</param>
5218	</method>
5219
5220	<method name="detachDevice">
5221	<desc>
5222	Detaches the device attached to a device slot of the specified bus.
5223
5224	Detaching the device from the virtual machine is deferred. This means
5225	that the medium remains associated with the machine when this method
5226	returns and gets actually de-associated only after a successful
5227	<link to="#saveSettings"/> call. See <link to="IMedium"/>
5228	for more detailed information about attaching media.
5229
5230	<note>
5231	You cannot detach a device from a running machine.
5232	</note>
5233	<note>
5234	Detaching differencing media implicitly created by <link
5235	to="#attachDevice"/> for the indirect attachment using this
5236	method will <b>not</b> implicitly delete them. The
5237	<link to="IMedium::deleteStorage"/> operation should be
5238	explicitly performed by the caller after the medium is successfully
5239	detached and the settings are saved with
5240	<link to="#saveSettings"/>, if it is the desired action.
5241	</note>
5242
5243	<result name="VBOX_E_INVALID_VM_STATE">
5244	Attempt to detach medium from a running virtual machine.
5245	</result>
5246	<result name="VBOX_E_OBJECT_NOT_FOUND">
5247	No medium attached to given slot/bus.
5248	</result>
5249	<result name="VBOX_E_NOT_SUPPORTED">
5250	Medium format does not support storage deletion (only for implicitly
5251	created differencing media, should not happen).
5252	</result>
5253
5254	</desc>
5255	<param name="name" type="wstring" dir="in">
5256	<desc>Name of the storage controller to detach the medium from.</desc>
5257	</param>
5258	<param name="controllerPort" type="long" dir="in">
5259	<desc>Port number to detach the medium from.</desc>
5260	</param>
5261	<param name="device" type="long" dir="in">
5262	<desc>Device slot number to detach the medium from.</desc>
5263	</param>
5264	</method>
5265
5266	<method name="passthroughDevice">
5267	<desc>
5268	Sets the passthrough mode of an existing DVD device. Changing the
5269	setting while the VM is running is forbidden. The setting is only used
5270	if at VM start the device is configured as a host DVD drive, in all
5271	other cases it is ignored. The device must already exist; see
5272	<link to="IMachine::attachDevice"/> for how to attach a new device.
5273
5274	The @a controllerPort and @a device parameters specify the device slot and
5275	have have the same meaning as with <link to="IMachine::attachDevice" />.
5276
5277	<result name="E_INVALIDARG">
5278	SATA device, SATA port, IDE port or IDE slot out of range.
5279	</result>
5280	<result name="VBOX_E_INVALID_OBJECT_STATE">
5281	Attempt to modify an unregistered virtual machine.
5282	</result>
5283	<result name="VBOX_E_INVALID_VM_STATE">
5284	Invalid machine state.
5285	</result>
5286
5287	</desc>
5288	<param name="name" type="wstring" dir="in">
5289	<desc>Name of the storage controller.</desc>
5290	</param>
5291	<param name="controllerPort" type="long" dir="in">
5292	<desc>Storage controller port.</desc>
5293	</param>
5294	<param name="device" type="long" dir="in">
5295	<desc>Device slot in the given port.</desc>
5296	</param>
5297	<param name="passthrough" type="boolean" dir="in">
5298	<desc>New value for the passthrough setting.</desc>
5299	</param>
5300	</method>
5301
5302	<method name="temporaryEjectDevice">
5303	<desc>
5304	Sets the behavior for guest-triggered medium eject. In some situations
5305	it is desirable that such ejects update the VM configuration, and in
5306	others the eject should keep the VM configuration. The device must
5307	already exist; see <link to="IMachine::attachDevice"/> for how to
5308	attach a new device.
5309
5310	The @a controllerPort and @a device parameters specify the device slot and
5311	have have the same meaning as with <link to="IMachine::attachDevice" />.
5312
5313	<result name="E_INVALIDARG">
5314	SATA device, SATA port, IDE port or IDE slot out of range.
5315	</result>
5316	<result name="VBOX_E_INVALID_OBJECT_STATE">
5317	Attempt to modify an unregistered virtual machine.
5318	</result>
5319	<result name="VBOX_E_INVALID_VM_STATE">
5320	Invalid machine state.
5321	</result>
5322
5323	</desc>
5324	<param name="name" type="wstring" dir="in">
5325	<desc>Name of the storage controller.</desc>
5326	</param>
5327	<param name="controllerPort" type="long" dir="in">
5328	<desc>Storage controller port.</desc>
5329	</param>
5330	<param name="device" type="long" dir="in">
5331	<desc>Device slot in the given port.</desc>
5332	</param>
5333	<param name="temporaryEject" type="boolean" dir="in">
5334	<desc>New value for the eject behavior.</desc>
5335	</param>
5336	</method>
5337
5338	<method name="nonRotationalDevice">
5339	<desc>
5340	Sets a flag in the device information which indicates that the medium
5341	is not based on rotational technology, i.e. that the access times are
5342	more or less independent of the position on the medium. This may or may
5343	not be supported by a particular drive, and is silently ignored in the
5344	latter case. At the moment only hard disks (which is a misnomer in this
5345	context) accept this setting. Changing the setting while the VM is
5346	running is forbidden. The device must already exist; see
5347	<link to="IMachine::attachDevice"/> for how to attach a new device.
5348
5349	The @a controllerPort and @a device parameters specify the device slot and
5350	have have the same meaning as with <link to="IMachine::attachDevice" />.
5351
5352	<result name="E_INVALIDARG">
5353	SATA device, SATA port, IDE port or IDE slot out of range.
5354	</result>
5355	<result name="VBOX_E_INVALID_OBJECT_STATE">
5356	Attempt to modify an unregistered virtual machine.
5357	</result>
5358	<result name="VBOX_E_INVALID_VM_STATE">
5359	Invalid machine state.
5360	</result>
5361
5362	</desc>
5363	<param name="name" type="wstring" dir="in">
5364	<desc>Name of the storage controller.</desc>
5365	</param>
5366	<param name="controllerPort" type="long" dir="in">
5367	<desc>Storage controller port.</desc>
5368	</param>
5369	<param name="device" type="long" dir="in">
5370	<desc>Device slot in the given port.</desc>
5371	</param>
5372	<param name="nonRotational" type="boolean" dir="in">
5373	<desc>New value for the non-rotational device flag.</desc>
5374	</param>
5375	</method>
5376
5377	<method name="setAutoDiscardForDevice">
5378	<desc>
5379	Sets a flag in the device information which indicates that the medium
5380	supports discarding unsused blocks (called trimming for SATA or unmap
5381	for SCSI devices) .This may or may not be supported by a particular drive,
5382	and is silently ignored in the latter case. At the moment only hard disks
5383	(which is a misnomer in this context) accept this setting. Changing the
5384	setting while the VM is running is forbidden. The device must already
5385	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5386	device.
5387
5388	The @a controllerPort and @a device parameters specify the device slot and
5389	have have the same meaning as with <link to="IMachine::attachDevice" />.
5390
5391	<result name="E_INVALIDARG">
5392	SATA device, SATA port, SCSI port out of range.
5393	</result>
5394	<result name="VBOX_E_INVALID_OBJECT_STATE">
5395	Attempt to modify an unregistered virtual machine.
5396	</result>
5397	<result name="VBOX_E_INVALID_VM_STATE">
5398	Invalid machine state.
5399	</result>
5400
5401	</desc>
5402	<param name="name" type="wstring" dir="in">
5403	<desc>Name of the storage controller.</desc>
5404	</param>
5405	<param name="controllerPort" type="long" dir="in">
5406	<desc>Storage controller port.</desc>
5407	</param>
5408	<param name="device" type="long" dir="in">
5409	<desc>Device slot in the given port.</desc>
5410	</param>
5411	<param name="discard" type="boolean" dir="in">
5412	<desc>New value for the discard device flag.</desc>
5413	</param>
5414	</method>
5415
5416	<method name="setBandwidthGroupForDevice">
5417	<desc>
5418	Sets the bandwidth group of an existing storage device.
5419	The device must already exist; see <link to="IMachine::attachDevice"/>
5420	for how to attach a new device.
5421
5422	The @a controllerPort and @a device parameters specify the device slot and
5423	have have the same meaning as with <link to="IMachine::attachDevice" />.
5424
5425	<result name="E_INVALIDARG">
5426	SATA device, SATA port, IDE port or IDE slot out of range.
5427	</result>
5428	<result name="VBOX_E_INVALID_OBJECT_STATE">
5429	Attempt to modify an unregistered virtual machine.
5430	</result>
5431	<result name="VBOX_E_INVALID_VM_STATE">
5432	Invalid machine state.
5433	</result>
5434
5435	</desc>
5436	<param name="name" type="wstring" dir="in">
5437	<desc>Name of the storage controller.</desc>
5438	</param>
5439	<param name="controllerPort" type="long" dir="in">
5440	<desc>Storage controller port.</desc>
5441	</param>
5442	<param name="device" type="long" dir="in">
5443	<desc>Device slot in the given port.</desc>
5444	</param>
5445	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5446	<desc>New value for the bandwidth group or @c null for no group.</desc>
5447	</param>
5448	</method>
5449
5450	<method name="setNoBandwidthGroupForDevice">
5451	<desc>
5452	Sets no bandwidth group for an existing storage device.
5453	The device must already exist; see <link to="IMachine::attachDevice"/>
5454	for how to attach a new device.
5455	The @a controllerPort and @a device parameters specify the device slot and
5456	have have the same meaning as with <link to="IMachine::attachDevice" />.
5457	<result name="E_INVALIDARG">
5458	SATA device, SATA port, IDE port or IDE slot out of range.
5459	</result>
5460	<result name="VBOX_E_INVALID_OBJECT_STATE">
5461	Attempt to modify an unregistered virtual machine.
5462	</result>
5463	<result name="VBOX_E_INVALID_VM_STATE">
5464	Invalid machine state.
5465	</result>
5466
5467	</desc>
5468	<param name="name" type="wstring" dir="in">
5469	<desc>Name of the storage controller.</desc>
5470	</param>
5471	<param name="controllerPort" type="long" dir="in">
5472	<desc>Storage controller port.</desc>
5473	</param>
5474	<param name="device" type="long" dir="in">
5475	<desc>Device slot in the given port.</desc>
5476	</param>
5477	</method>
5478
5479
5480	<method name="unmountMedium">
5481	<desc>
5482	Unmounts any currently mounted medium (<link to="IMedium" />,
5483	identified by the given UUID @a id) to the given storage controller
5484	(<link to="IStorageController" />, identified by @a name),
5485	at the indicated port and device. The device must already exist;
5486
5487	This method is intended only for managing removable media, where the
5488	device is fixed but media is changeable at runtime (such as DVDs
5489	and floppies). It cannot be used for fixed media such as hard disks.
5490
5491	The @a controllerPort and @a device parameters specify the device slot
5492	and have have the same meaning as with
5493	<link to="IMachine::attachDevice" />.
5494
5495	The specified device slot must have a medium mounted, which will be
5496	unmounted. If there is no mounted medium it will do nothing.
5497	See <link to="IMedium"/> for more detailed information about
5498	attaching/unmounting media.
5499
5500	<result name="E_INVALIDARG">
5501	SATA device, SATA port, IDE port or IDE slot out of range.
5502	</result>
5503	<result name="VBOX_E_INVALID_OBJECT_STATE">
5504	Attempt to unmount medium that is not removeable - not dvd or floppy.
5505	</result>
5506	<result name="VBOX_E_INVALID_VM_STATE">
5507	Invalid machine state.
5508	</result>
5509	<result name="VBOX_E_OBJECT_IN_USE">
5510	Medium already attached to this or another virtual machine.
5511	</result>
5512	<result name="VBOX_E_OBJECT_NOT_FOUND">
5513	Medium not attached to specified port, device, controller.
5514	</result>
5515
5516	</desc>
5517	<param name="name" type="wstring" dir="in">
5518	<desc>Name of the storage controller to unmount the medium from.</desc>
5519	</param>
5520	<param name="controllerPort" type="long" dir="in">
5521	<desc>Port to unmount the medium from.</desc>
5522	</param>
5523	<param name="device" type="long" dir="in">
5524	<desc>Device slot in the given port to unmount the medium from.</desc>
5525	</param>
5526	<param name="force" type="boolean" dir="in">
5527	<desc>Allows to force unmount of a medium which is locked by
5528	the device slot in the given port medium is attached to.</desc>
5529	</param>
5530	</method>
5531
5532	<method name="mountMedium">
5533	<desc>
5534	Mounts a medium (<link to="IMedium" />, identified
5535	by the given UUID @a id) to the given storage controller
5536	(<link to="IStorageController" />, identified by @a name),
5537	at the indicated port and device. The device must already exist;
5538	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5539
5540	This method is intended only for managing removable media, where the
5541	device is fixed but media is changeable at runtime (such as DVDs
5542	and floppies). It cannot be used for fixed media such as hard disks.
5543
5544	The @a controllerPort and @a device parameters specify the device slot and
5545	have have the same meaning as with <link to="IMachine::attachDevice" />.
5546
5547	The specified device slot can have a medium mounted, which will be
5548	unmounted first. Specifying a zero UUID (or an empty string) for
5549	@a medium does just an unmount.
5550
5551	See <link to="IMedium"/> for more detailed information about
5552	attaching media.
5553
5554	<result name="E_INVALIDARG">
5555	SATA device, SATA port, IDE port or IDE slot out of range.
5556	</result>
5557	<result name="VBOX_E_INVALID_OBJECT_STATE">
5558	Attempt to attach medium to an unregistered virtual machine.
5559	</result>
5560	<result name="VBOX_E_INVALID_VM_STATE">
5561	Invalid machine state.
5562	</result>
5563	<result name="VBOX_E_OBJECT_IN_USE">
5564	Medium already attached to this or another virtual machine.
5565	</result>
5566
5567	</desc>
5568	<param name="name" type="wstring" dir="in">
5569	<desc>Name of the storage controller to attach the medium to.</desc>
5570	</param>
5571	<param name="controllerPort" type="long" dir="in">
5572	<desc>Port to attach the medium to.</desc>
5573	</param>
5574	<param name="device" type="long" dir="in">
5575	<desc>Device slot in the given port to attach the medium to.</desc>
5576	</param>
5577	<param name="medium" type="IMedium" dir="in">
5578	<desc>Medium to mount or @c null for an empty drive.</desc>
5579	</param>
5580	<param name="force" type="boolean" dir="in">
5581	<desc>Allows to force unmount/mount of a medium which is locked by
5582	the device slot in the given port to attach the medium to.</desc>
5583	</param>
5584	</method>
5585
5586	<method name="getMedium" const="yes">
5587	<desc>
5588	Returns the virtual medium attached to a device slot of the specified
5589	bus.
5590
5591	Note that if the medium was indirectly attached by
5592	<link to="#mountMedium"/> to the given device slot then this
5593	method will return not the same object as passed to the
5594	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5595	more detailed information about mounting a medium.
5596
5597	<result name="VBOX_E_OBJECT_NOT_FOUND">
5598	No medium attached to given slot/bus.
5599	</result>
5600
5601	</desc>
5602	<param name="name" type="wstring" dir="in">
5603	<desc>Name of the storage controller the medium is attached to.</desc>
5604	</param>
5605	<param name="controllerPort" type="long" dir="in">
5606	<desc>Port to query.</desc>
5607	</param>
5608	<param name="device" type="long" dir="in">
5609	<desc>Device slot in the given port to query.</desc>
5610	</param>
5611	<param name="medium" type="IMedium" dir="return">
5612	<desc>Attached medium object.</desc>
5613	</param>
5614	</method>
5615
5616	<method name="getMediumAttachmentsOfController" const="yes">
5617	<desc>
5618	Returns an array of medium attachments which are attached to the
5619	the controller with the given name.
5620
5621	<result name="VBOX_E_OBJECT_NOT_FOUND">
5622	A storage controller with given name doesn't exist.
5623	</result>
5624	</desc>
5625	<param name="name" type="wstring" dir="in"/>
5626	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5627	</method>
5628
5629	<method name="getMediumAttachment" const="yes">
5630	<desc>
5631	Returns a medium attachment which corresponds to the controller with
5632	the given name, on the given port and device slot.
5633
5634	<result name="VBOX_E_OBJECT_NOT_FOUND">
5635	No attachment exists for the given controller/port/device combination.
5636	</result>
5637	</desc>
5638	<param name="name" type="wstring" dir="in"/>
5639	<param name="controllerPort" type="long" dir="in"/>
5640	<param name="device" type="long" dir="in"/>
5641	<param name="attachment" type="IMediumAttachment" dir="return"/>
5642	</method>
5643
5644	<method name="attachHostPCIDevice">
5645	<desc>
5646	Attaches host PCI device with the given (host) PCI address to the
5647	PCI bus of the virtual machine. Please note, that this operation
5648	is two phase, as real attachment will happen when VM will start,
5649	and most information will be delivered as IHostPCIDevicePlugEvent
5650	on IVirtualBox event source.
5651
5652	<see><link to="IHostPCIDevicePlugEvent"/></see>
5653
5654	<result name="VBOX_E_INVALID_VM_STATE">
5655	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5656	</result>
5657	<result name="VBOX_E_PDM_ERROR">
5658	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5659	</result>
5660	<result name="VBOX_E_NOT_SUPPORTED">
5661	Hardware or host OS doesn't allow PCI device passthrought.
5662	</result>
5663	</desc>
5664	<param name="hostAddress" type="long" dir="in">
5665	<desc>Address of the host PCI device.</desc>
5666	</param>
5667	<param name="desiredGuestAddress" type="long" dir="in">
5668	<desc>Desired position of this device on guest PCI bus.</desc>
5669	</param>
5670	<param name="tryToUnbind" type="boolean" dir="in">
5671	<desc>If VMM shall try to unbind existing drivers from the
5672	device before attaching it to the guest.</desc>
5673	</param>
5674	</method>
5675
5676	<method name="detachHostPCIDevice">
5677	<desc>
5678	Detach host PCI device from the virtual machine.
5679	Also HostPCIDevicePlugEvent on IVirtualBox event source
5680	will be delivered. As currently we don't support hot device
5681	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5682
5683	<see><link to="IHostPCIDevicePlugEvent"/></see>
5684
5685	<result name="VBOX_E_INVALID_VM_STATE">
5686	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5687	</result>
5688	<result name="VBOX_E_OBJECT_NOT_FOUND">
5689	This host device is not attached to this machine.
5690	</result>
5691	<result name="VBOX_E_PDM_ERROR">
5692	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5693	</result>
5694	<result name="VBOX_E_NOT_SUPPORTED">
5695	Hardware or host OS doesn't allow PCI device passthrought.
5696	</result>
5697	</desc>
5698	<param name="hostAddress" type="long" dir="in">
5699	<desc>Address of the host PCI device.</desc>
5700	</param>
5701	</method>
5702
5703	<method name="getNetworkAdapter" const="yes">
5704	<desc>
5705	Returns the network adapter associated with the given slot.
5706	Slots are numbered sequentially, starting with zero. The total
5707	number of adapters per machine is defined by the
5708	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5709	so the maximum slot number is one less than that property's value.
5710
5711	<result name="E_INVALIDARG">
5712	Invalid @a slot number.
5713	</result>
5714
5715	</desc>
5716	<param name="slot" type="unsigned long" dir="in"/>
5717	<param name="adapter" type="INetworkAdapter" dir="return"/>
5718	</method>
5719
5720	<method name="addStorageController">
5721	<desc>
5722	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5723	machine and returns it as an instance of
5724	<link to="IStorageController" />.
5725
5726	@a name identifies the controller for subsequent calls such as
5727	<link to="#getStorageControllerByName" />,
5728	<link to="#getStorageControllerByInstance" />,
5729	<link to="#removeStorageController" />,
5730	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5731
5732	After the controller has been added, you can set its exact
5733	type by setting the <link to="IStorageController::controllerType" />.
5734
5735	<result name="VBOX_E_OBJECT_IN_USE">
5736	A storage controller with given name exists already.
5737	</result>
5738	<result name="E_INVALIDARG">
5739	Invalid @a controllerType.
5740	</result>
5741	</desc>
5742	<param name="name" type="wstring" dir="in"/>
5743	<param name="connectionType" type="StorageBus" dir="in"/>
5744	<param name="controller" type="IStorageController" dir="return"/>
5745	</method>
5746
5747	<method name="getStorageControllerByName" const="yes">
5748	<desc>
5749	Returns a storage controller with the given name.
5750
5751	<result name="VBOX_E_OBJECT_NOT_FOUND">
5752	A storage controller with given name doesn't exist.
5753	</result>
5754	</desc>
5755	<param name="name" type="wstring" dir="in"/>
5756	<param name="storageController" type="IStorageController" dir="return"/>
5757	</method>
5758
5759	<method name="getStorageControllerByInstance" const="yes">
5760	<desc>
5761	Returns a storage controller with the given instance number.
5762
5763	<result name="VBOX_E_OBJECT_NOT_FOUND">
5764	A storage controller with given instance number doesn't exist.
5765	</result>
5766	</desc>
5767	<param name="instance" type="unsigned long" dir="in"/>
5768	<param name="storageController" type="IStorageController" dir="return"/>
5769	</method>
5770
5771	<method name="removeStorageController">
5772	<desc>
5773	Removes a storage controller from the machine with all devices attached to it.
5774
5775	<result name="VBOX_E_OBJECT_NOT_FOUND">
5776	A storage controller with given name doesn't exist.
5777	</result>
5778	<result name="VBOX_E_NOT_SUPPORTED">
5779	Medium format does not support storage deletion (only for implicitly
5780	created differencing media, should not happen).
5781	</result>
5782	</desc>
5783	<param name="name" type="wstring" dir="in"/>
5784	</method>
5785
5786	<method name="setStorageControllerBootable">
5787	<desc>
5788	Sets the bootable flag of the storage controller with the given name.
5789
5790	<result name="VBOX_E_OBJECT_NOT_FOUND">
5791	A storage controller with given name doesn't exist.
5792	</result>
5793	<result name="VBOX_E_OBJECT_IN_USE">
5794	Another storage controller is marked as bootable already.
5795	</result>
5796	</desc>
5797	<param name="name" type="wstring" dir="in"/>
5798	<param name="bootable" type="boolean" dir="in"/>
5799	</method>
5800
5801	<method name="getSerialPort" const="yes">
5802	<desc>
5803	Returns the serial port associated with the given slot.
5804	Slots are numbered sequentially, starting with zero. The total
5805	number of serial ports per machine is defined by the
5806	<link to="ISystemProperties::serialPortCount"/> property,
5807	so the maximum slot number is one less than that property's value.
5808
5809	<result name="E_INVALIDARG">
5810	Invalid @a slot number.
5811	</result>
5812
5813	</desc>
5814	<param name="slot" type="unsigned long" dir="in"/>
5815	<param name="port" type="ISerialPort" dir="return"/>
5816	</method>
5817
5818	<method name="getParallelPort" const="yes">
5819	<desc>
5820	Returns the parallel port associated with the given slot.
5821	Slots are numbered sequentially, starting with zero. The total
5822	number of parallel ports per machine is defined by the
5823	<link to="ISystemProperties::parallelPortCount"/> property,
5824	so the maximum slot number is one less than that property's value.
5825
5826	<result name="E_INVALIDARG">
5827	Invalid @a slot number.
5828	</result>
5829
5830	</desc>
5831	<param name="slot" type="unsigned long" dir="in"/>
5832	<param name="port" type="IParallelPort" dir="return"/>
5833	</method>
5834
5835	<method name="getExtraDataKeys">
5836	<desc>
5837	Returns an array representing the machine-specific extra data keys
5838	which currently have values defined.
5839	</desc>
5840	<param name="keys" type="wstring" dir="return" safearray="yes">
5841	<desc>Array of extra data keys.</desc>
5842	</param>
5843	</method>
5844
5845	<method name="getExtraData">
5846	<desc>
5847	Returns associated machine-specific extra data.
5848
5849	If the requested data @a key does not exist, this function will
5850	succeed and return an empty string in the @a value argument.
5851
5852	<result name="VBOX_E_FILE_ERROR">
5853	Settings file not accessible.
5854	</result>
5855	<result name="VBOX_E_XML_ERROR">
5856	Could not parse the settings file.
5857	</result>
5858
5859	</desc>
5860	<param name="key" type="wstring" dir="in">
5861	<desc>Name of the data key to get.</desc>
5862	</param>
5863	<param name="value" type="wstring" dir="return">
5864	<desc>Value of the requested data key.</desc>
5865	</param>
5866	</method>
5867
5868	<method name="setExtraData">
5869	<desc>
5870	Sets associated machine-specific extra data.
5871
5872	If you pass @c null or an empty string as a key @a value, the given
5873	@a key will be deleted.
5874
5875	<note>
5876	Before performing the actual data change, this method will ask all
5877	registered listeners using the
5878	<link to="IExtraDataCanChangeEvent"/>
5879	notification for a permission. If one of the listeners refuses the
5880	new value, the change will not be performed.
5881	</note>
5882	<note>
5883	On success, the
5884	<link to="IExtraDataChangedEvent"/> notification
5885	is called to inform all registered listeners about a successful data
5886	change.
5887	</note>
5888	<note>
5889	This method can be called outside the machine session and therefore
5890	it's a caller's responsibility to handle possible race conditions
5891	when several clients change the same key at the same time.
5892	</note>
5893
5894	<result name="VBOX_E_FILE_ERROR">
5895	Settings file not accessible.
5896	</result>
5897	<result name="VBOX_E_XML_ERROR">
5898	Could not parse the settings file.
5899	</result>
5900
5901	</desc>
5902	<param name="key" type="wstring" dir="in">
5903	<desc>Name of the data key to set.</desc>
5904	</param>
5905	<param name="value" type="wstring" dir="in">
5906	<desc>Value to assign to the key.</desc>
5907	</param>
5908	</method>
5909
5910	<method name="getCPUProperty" const="yes">
5911	<desc>
5912	Returns the virtual CPU boolean value of the specified property.
5913
5914	<result name="E_INVALIDARG">
5915	Invalid property.
5916	</result>
5917
5918	</desc>
5919	<param name="property" type="CPUPropertyType" dir="in">
5920	<desc>
5921	Property type to query.
5922	</desc>
5923	</param>
5924	<param name="value" type="boolean" dir="return">
5925	<desc>
5926	Property value.
5927	</desc>
5928	</param>
5929	</method>
5930
5931	<method name="setCPUProperty">
5932	<desc>
5933	Sets the virtual CPU boolean value of the specified property.
5934
5935	<result name="E_INVALIDARG">
5936	Invalid property.
5937	</result>
5938
5939	</desc>
5940	<param name="property" type="CPUPropertyType" dir="in">
5941	<desc>
5942	Property type to query.
5943	</desc>
5944	</param>
5945	<param name="value" type="boolean" dir="in">
5946	<desc>
5947	Property value.
5948	</desc>
5949	</param>
5950	</method>
5951
5952	<method name="getCPUIDLeaf" const="yes">
5953	<desc>
5954	Returns the virtual CPU cpuid information for the specified leaf.
5955
5956	Currently supported index values for cpuid:
5957	Standard CPUID leafs: 0 - 0xA
5958	Extended CPUID leafs: 0x80000000 - 0x8000000A
5959
5960	See the Intel and AMD programmer's manuals for detailed information
5961	about the cpuid instruction and its leafs.
5962	<result name="E_INVALIDARG">
5963	Invalid id.
5964	</result>
5965
5966	</desc>
5967	<param name="id" type="unsigned long" dir="in">
5968	<desc>
5969	CPUID leaf index.
5970	</desc>
5971	</param>
5972	<param name="valEax" type="unsigned long" dir="out">
5973	<desc>
5974	CPUID leaf value for register eax.
5975	</desc>
5976	</param>
5977	<param name="valEbx" type="unsigned long" dir="out">
5978	<desc>
5979	CPUID leaf value for register ebx.
5980	</desc>
5981	</param>
5982	<param name="valEcx" type="unsigned long" dir="out">
5983	<desc>
5984	CPUID leaf value for register ecx.
5985	</desc>
5986	</param>
5987	<param name="valEdx" type="unsigned long" dir="out">
5988	<desc>
5989	CPUID leaf value for register edx.
5990	</desc>
5991	</param>
5992	</method>
5993
5994	<method name="setCPUIDLeaf">
5995	<desc>
5996	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5997	are not passed unmodified. VirtualBox clears features that it doesn't support.
5998
5999	Currently supported index values for cpuid:
6000	Standard CPUID leafs: 0 - 0xA
6001	Extended CPUID leafs: 0x80000000 - 0x8000000A
6002
6003	See the Intel and AMD programmer's manuals for detailed information
6004	about the cpuid instruction and its leafs.
6005
6006	Do not use this method unless you know exactly what you're doing. Misuse can lead to
6007	random crashes inside VMs.
6008	<result name="E_INVALIDARG">
6009	Invalid id.
6010	</result>
6011
6012	</desc>
6013	<param name="id" type="unsigned long" dir="in">
6014	<desc>
6015	CPUID leaf index.
6016	</desc>
6017	</param>
6018	<param name="valEax" type="unsigned long" dir="in">
6019	<desc>
6020	CPUID leaf value for register eax.
6021	</desc>
6022	</param>
6023	<param name="valEbx" type="unsigned long" dir="in">
6024	<desc>
6025	CPUID leaf value for register ebx.
6026	</desc>
6027	</param>
6028	<param name="valEcx" type="unsigned long" dir="in">
6029	<desc>
6030	CPUID leaf value for register ecx.
6031	</desc>
6032	</param>
6033	<param name="valEdx" type="unsigned long" dir="in">
6034	<desc>
6035	CPUID leaf value for register edx.
6036	</desc>
6037	</param>
6038	</method>
6039
6040	<method name="removeCPUIDLeaf">
6041	<desc>
6042	Removes the virtual CPU cpuid leaf for the specified index
6043
6044	<result name="E_INVALIDARG">
6045	Invalid id.
6046	</result>
6047
6048	</desc>
6049	<param name="id" type="unsigned long" dir="in">
6050	<desc>
6051	CPUID leaf index.
6052	</desc>
6053	</param>
6054	</method>
6055
6056	<method name="removeAllCPUIDLeaves">
6057	<desc>
6058	Removes all the virtual CPU cpuid leaves
6059	</desc>
6060	</method>
6061
6062	<method name="getHWVirtExProperty" const="yes">
6063	<desc>
6064	Returns the value of the specified hardware virtualization boolean property.
6065
6066	<result name="E_INVALIDARG">
6067	Invalid property.
6068	</result>
6069
6070	</desc>
6071	<param name="property" type="HWVirtExPropertyType" dir="in">
6072	<desc>
6073	Property type to query.
6074	</desc>
6075	</param>
6076	<param name="value" type="boolean" dir="return">
6077	<desc>
6078	Property value.
6079	</desc>
6080	</param>
6081	</method>
6082
6083	<method name="setHWVirtExProperty">
6084	<desc>
6085	Sets a new value for the specified hardware virtualization boolean property.
6086
6087	<result name="E_INVALIDARG">
6088	Invalid property.
6089	</result>
6090
6091	</desc>
6092	<param name="property" type="HWVirtExPropertyType" dir="in">
6093	<desc>
6094	Property type to set.
6095	</desc>
6096	</param>
6097	<param name="value" type="boolean" dir="in">
6098	<desc>
6099	New property value.
6100	</desc>
6101	</param>
6102	</method>
6103
6104	<method name="saveSettings">
6105	<desc>
6106	Saves any changes to machine settings made since the session
6107	has been opened or a new machine has been created, or since the
6108	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
6109	For registered machines, new settings become visible to all
6110	other VirtualBox clients after successful invocation of this
6111	method.
6112	<note>
6113	The method sends <link to="IMachineDataChangedEvent"/>
6114	notification event after the configuration has been successfully
6115	saved (only for registered machines).
6116	</note>
6117	<note>
6118	Calling this method is only valid on instances returned
6119	by <link to="ISession::machine"/> and on new machines
6120	created by <link to="IVirtualBox::createMachine"/> but not
6121	yet registered, or on unregistered machines after calling
6122	<link to="IMachine::unregister"/>.
6123	</note>
6124
6125	<result name="VBOX_E_FILE_ERROR">
6126	Settings file not accessible.
6127	</result>
6128	<result name="VBOX_E_XML_ERROR">
6129	Could not parse the settings file.
6130	</result>
6131	<result name="E_ACCESSDENIED">
6132	Modification request refused.
6133	</result>
6134
6135	</desc>
6136	</method>
6137
6138	<method name="discardSettings">
6139	<desc>
6140	Discards any changes to the machine settings made since the session
6141	has been opened or since the last call to <link to="#saveSettings"/>
6142	or <link to="#discardSettings"/>.
6143	<note>
6144	Calling this method is only valid on instances returned
6145	by <link to="ISession::machine"/> and on new machines
6146	created by <link to="IVirtualBox::createMachine"/> or
6147	opened by <link to="IVirtualBox::openMachine"/> but not
6148	yet registered, or on unregistered machines after calling
6149	<link to="IMachine::unregister"/>.
6150	</note>
6151
6152	<result name="VBOX_E_INVALID_VM_STATE">
6153	Virtual machine is not mutable.
6154	</result>
6155
6156	</desc>
6157	</method>
6158
6159	<method name="unregister">
6160	<desc>
6161	Unregisters a machine previously registered with
6162	<link to="IVirtualBox::registerMachine"/> and optionally do additional
6163	cleanup before the machine is unregistered.
6164
6165	This method does not delete any files. It only changes the machine configuration and
6166	the list of registered machines in the VirtualBox object. To delete the files which
6167	belonged to the machine, including the XML file of the machine itself, call
6168	<link to="#deleteConfig"/>, optionally with the array of IMedium objects which was returned
6169	from this method.
6170
6171	How thoroughly this method cleans up the machine configuration before unregistering
6172	the machine depends on the @a cleanupMode argument.
6173
6174	<ul>
6175	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
6176	cleanup will be performed. The call will fail if the machine is in "Saved" state
6177	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
6178	It is the responsibility of the caller to delete all such configuration in this mode.
6179	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
6180	which it replaces.</li>
6181	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
6182	state or if it has snapshots or media attached. All media attached to the current machine
6183	state or in snapshots will be detached. No medium objects will be returned;
6184	all of the machine's media will remain open.</li>
6185	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
6186	except that all the hard disk medium objects which were detached from the machine will
6187	be returned as an array. This allows for quickly passing them to the <link to="#deleteConfig" />
6188	API for closing and deletion.</li>
6189	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
6190	that all media will be returned in the array, including removable media like DVDs and
6191	floppies. This might be useful if the user wants to inspect in detail which media were
6192	attached to the machine. Be careful when passing the media array to <link to="#deleteConfig" />
6193	in that case because users will typically want to preserve ISO and RAW image files.</li>
6194	</ul>
6195
6196	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
6197	resulting IMedium array to <link to="#deleteConfig"/>. This way, the machine is completely
6198	deleted with all its saved states and hard disk images, but images for removable
6199	drives (such as ISO and RAW files) will remain on disk.
6200
6201	This API does not verify whether the media files returned in the array are still
6202	attached to other machines (i.e. shared between several machines). If such a shared
6203	image is passed to <link to="#deleteConfig" /> however, closing the image will fail there
6204	and the image will be silently skipped.
6205
6206	This API may, however, move media from this machine's media registry to other media
6207	registries (see <link to="IMedium" /> for details on media registries). For machines
6208	created with VirtualBox 4.0 or later, if media from this machine's media registry
6209	are also attached to another machine (shared attachments), each such medium will be
6210	moved to another machine's registry. This is because without this machine's media
6211	registry, the other machine cannot find its media any more and would become inaccessible.
6212
6213	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
6214	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
6215	if media are moved to other machines' media registries.
6216
6217	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
6218	is fired.
6219
6220	The call will fail if the machine is currently locked (see <link to="ISession" />).
6221
6222	<note>
6223	If the given machine is inaccessible (see <link to="#accessible"/>), it
6224	will be unregistered and fully uninitialized right afterwards. As a result,
6225	the returned machine object will be unusable and an attempt to call
6226	<b>any</b> method will return the "Object not ready" error.
6227	</note>
6228
6229	<result name="VBOX_E_INVALID_OBJECT_STATE">
6230	Machine is currently locked for a session.
6231	</result>
6232	</desc>
6233
6234	<param name="cleanupMode" type="CleanupMode" dir="in">
6235	<desc>How to clean up after the machine has been unregistered.</desc>
6236	</param>
6237	<param name="media" type="IMedium" safearray="yes" dir="return">
6238	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
6239	</param>
6240	</method>
6241
6242	<method name="deleteConfig">
6243	<desc>
6244	Deletes the files associated with this machine from disk. If medium objects are passed
6245	in with the @a aMedia argument, they are closed and, if closing was successful, their
6246	storage files are deleted as well. For convenience, this array of media files can be
6247	the same as the one returned from a previous <link to="#unregister" /> call.
6248
6249	This method must only be called on machines which are either write-locked (i.e. on instances
6250	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
6251	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
6252	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
6253
6254	The following files will be deleted by this method:
6255	<ul>
6256	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
6257	argument other than "UnregisterOnly", this will delete all saved state files that
6258	the machine had in use; possibly one if the machine was in "Saved" state and one
6259	for each online snapshot that the machine had.</li>
6260	<li>On each medium object passed in the @a aMedia array, this will call
6261	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
6262	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
6263	in use, e.g. because it is still attached to a second machine; in that case the
6264	storage will not be deleted.</li>
6265	<li>Finally, the machine's own XML file will be deleted.</li>
6266	</ul>
6267
6268	Since deleting large disk image files can be a time-consuming I/O operation, this
6269	method operates asynchronously and returns an IProgress object to allow the caller
6270	to monitor the progress. There will be one sub-operation for each file that is
6271	being deleted (saved state or medium storage file).
6272
6273	<note>
6274	<link to="#settingsModified"/> will return @c true after this
6275	method successfully returns.
6276	</note>
6277
6278	<result name="VBOX_E_INVALID_VM_STATE">
6279	Machine is registered but not write-locked.
6280	</result>
6281	<result name="VBOX_E_IPRT_ERROR">
6282	Could not delete the settings file.
6283	</result>
6284	</desc>
6285	<param name="media" type="IMedium" safearray="yes" dir="in">
6286	<desc>List of media to be closed and whose storage files will be deleted.</desc>
6287	</param>
6288	<param name="progress" type="IProgress" dir="return">
6289	<desc>Progress object to track the operation completion.</desc>
6290	</param>
6291	</method>
6292
6293	<method name="exportTo">
6294	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6295	steps required to export VirtualBox machines to OVF.
6296	</desc>
6297
6298	<param name="appliance" type="IAppliance" dir="in">
6299	<desc>Appliance to export this machine to.</desc>
6300	</param>
6301	<param name="location" type="wstring" dir="in">
6302	<desc>The target location.</desc>
6303	</param>
6304	<param name="description" type="IVirtualSystemDescription" dir="return">
6305	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6306	</param>
6307	</method>
6308
6309	<method name="findSnapshot">
6310	<desc>
6311	Returns a snapshot of this machine with the given name or UUID.
6312
6313	Returns a snapshot of this machine with the given UUID.
6314	A @c null argument can be used to obtain the first snapshot
6315	taken on this machine. To traverse the whole tree of snapshots
6316	starting from the root, inspect the root snapshot's
6317	<link to="ISnapshot::children" /> attribute and recurse over those children.
6318
6319	<result name="VBOX_E_OBJECT_NOT_FOUND">
6320	Virtual machine has no snapshots or snapshot not found.
6321	</result>
6322
6323	</desc>
6324	<param name="nameOrId" type="wstring" dir="in">
6325	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6326	</param>
6327	<param name="snapshot" type="ISnapshot" dir="return">
6328	<desc>Snapshot object with the given name.</desc>
6329	</param>
6330	</method>
6331
6332	<method name="createSharedFolder">
6333	<desc>
6334	Creates a new permanent shared folder by associating the given logical
6335	name with the given host path, adds it to the collection of shared
6336	folders and starts sharing it. Refer to the description of
6337	<link to="ISharedFolder"/> to read more about logical names.
6338
6339	<result name="VBOX_E_OBJECT_IN_USE">
6340	Shared folder already exists.
6341	</result>
6342	<result name="VBOX_E_FILE_ERROR">
6343	Shared folder @a hostPath not accessible.
6344	</result>
6345
6346	</desc>
6347	<param name="name" type="wstring" dir="in">
6348	<desc>Unique logical name of the shared folder.</desc>
6349	</param>
6350	<param name="hostPath" type="wstring" dir="in">
6351	<desc>Full path to the shared folder in the host file system.</desc>
6352	</param>
6353	<param name="writable" type="boolean" dir="in">
6354	<desc>Whether the share is writable or readonly.</desc>
6355	</param>
6356	<param name="automount" type="boolean" dir="in">
6357	<desc>Whether the share gets automatically mounted by the guest
6358	or not.</desc>
6359	</param>
6360	</method>
6361
6362	<method name="removeSharedFolder">
6363	<desc>
6364	Removes the permanent shared folder with the given name previously
6365	created by <link to="#createSharedFolder"/> from the collection of
6366	shared folders and stops sharing it.
6367
6368	<result name="VBOX_E_INVALID_VM_STATE">
6369	Virtual machine is not mutable.
6370	</result>
6371	<result name="VBOX_E_OBJECT_NOT_FOUND">
6372	Shared folder @a name does not exist.
6373	</result>
6374
6375	</desc>
6376	<param name="name" type="wstring" dir="in">
6377	<desc>Logical name of the shared folder to remove.</desc>
6378	</param>
6379	</method>
6380
6381	<method name="canShowConsoleWindow">
6382	<desc>
6383	Returns @c true if the VM console process can activate the
6384	console window and bring it to foreground on the desktop of
6385	the host PC.
6386	<note>
6387	This method will fail if a session for this machine is not
6388	currently open.
6389	</note>
6390
6391	<result name="VBOX_E_INVALID_VM_STATE">
6392	Machine session is not open.
6393	</result>
6394
6395	</desc>
6396	<param name="canShow" type="boolean" dir="return">
6397	<desc>
6398	@c true if the console window can be shown and @c false otherwise.
6399	</desc>
6400	</param>
6401	</method>
6402
6403	<method name="showConsoleWindow">
6404	<desc>
6405	Activates the console window and brings it to foreground on
6406	the desktop of the host PC. Many modern window managers on
6407	many platforms implement some sort of focus stealing
6408	prevention logic, so that it may be impossible to activate
6409	a window without the help of the currently active
6410	application. In this case, this method will return a non-zero
6411	identifier that represents the top-level window of the VM
6412	console process. The caller, if it represents a currently
6413	active process, is responsible to use this identifier (in a
6414	platform-dependent manner) to perform actual window
6415	activation.
6416	<note>
6417	This method will fail if a session for this machine is not
6418	currently open.
6419	</note>
6420
6421	<result name="VBOX_E_INVALID_VM_STATE">
6422	Machine session is not open.
6423	</result>
6424
6425	</desc>
6426	<param name="winId" type="long long" dir="return">
6427	<desc>
6428	Platform-dependent identifier of the top-level VM console
6429	window, or zero if this method has performed all actions
6430	necessary to implement the <i>show window</i> semantics for
6431	the given platform and/or VirtualBox front-end.
6432	</desc>
6433	</param>
6434	</method>
6435
6436	<method name="getGuestProperty" const="yes">
6437	<desc>
6438	Reads an entry from the machine's guest property store.
6439
6440	<result name="VBOX_E_INVALID_VM_STATE">
6441	Machine session is not open.
6442	</result>
6443
6444	</desc>
6445	<param name="name" type="wstring" dir="in">
6446	<desc>
6447	The name of the property to read.
6448	</desc>
6449	</param>
6450	<param name="value" type="wstring" dir="out">
6451	<desc>
6452	The value of the property. If the property does not exist then this
6453	will be empty.
6454	</desc>
6455	</param>
6456	<param name="timestamp" type="long long" dir="out">
6457	<desc>
6458	The time at which the property was last modified, as seen by the
6459	server process.
6460	</desc>
6461	</param>
6462	<param name="flags" type="wstring" dir="out">
6463	<desc>
6464	Additional property parameters, passed as a comma-separated list of
6465	"name=value" type entries.
6466	</desc>
6467	</param>
6468	</method>
6469
6470	<method name="getGuestPropertyValue" const="yes">
6471	<desc>
6472	Reads a value from the machine's guest property store.
6473
6474	<result name="VBOX_E_INVALID_VM_STATE">
6475	Machine session is not open.
6476	</result>
6477
6478	</desc>
6479	<param name="property" type="wstring" dir="in">
6480	<desc>
6481	The name of the property to read.
6482	</desc>
6483	</param>
6484	<param name="value" type="wstring" dir="return">
6485	<desc>
6486	The value of the property. If the property does not exist then this
6487	will be empty.
6488	</desc>
6489	</param>
6490	</method>
6491
6492	<method name="getGuestPropertyTimestamp" const="yes">
6493	<desc>
6494	Reads a property timestamp from the machine's guest property store.
6495
6496	<result name="VBOX_E_INVALID_VM_STATE">
6497	Machine session is not open.
6498	</result>
6499
6500	</desc>
6501	<param name="property" type="wstring" dir="in">
6502	<desc>
6503	The name of the property to read.
6504	</desc>
6505	</param>
6506	<param name="value" type="long long" dir="return">
6507	<desc>
6508	The timestamp. If the property does not exist then this will be
6509	empty.
6510	</desc>
6511	</param>
6512	</method>
6513
6514	<method name="setGuestProperty">
6515	<desc>
6516	Sets, changes or deletes an entry in the machine's guest property
6517	store.
6518
6519	<result name="E_ACCESSDENIED">
6520	Property cannot be changed.
6521	</result>
6522	<result name="E_INVALIDARG">
6523	Invalid @a flags.
6524	</result>
6525	<result name="VBOX_E_INVALID_VM_STATE">
6526	Virtual machine is not mutable or session not open.
6527	</result>
6528	<result name="VBOX_E_INVALID_OBJECT_STATE">
6529	Cannot set transient property when machine not running.
6530	</result>
6531
6532	</desc>
6533	<param name="property" type="wstring" dir="in">
6534	<desc>
6535	The name of the property to set, change or delete.
6536	</desc>
6537	</param>
6538	<param name="value" type="wstring" dir="in">
6539	<desc>
6540	The new value of the property to set, change or delete. If the
6541	property does not yet exist and value is non-empty, it will be
6542	created. If the value is @c null or empty, the property will be
6543	deleted if it exists.
6544	</desc>
6545	</param>
6546	<param name="flags" type="wstring" dir="in">
6547	<desc>
6548	Additional property parameters, passed as a comma-separated list of
6549	"name=value" type entries.
6550	</desc>
6551	</param>
6552	</method>
6553
6554	<method name="setGuestPropertyValue">
6555	<desc>
6556	Sets or changes a value in the machine's guest property
6557	store. The flags field will be left unchanged or created empty for a
6558	new property.
6559
6560	<result name="E_ACCESSDENIED">
6561	Property cannot be changed.
6562	</result>
6563	<result name="VBOX_E_INVALID_VM_STATE">
6564	Virtual machine is not mutable or session not open.
6565	</result>
6566	<result name="VBOX_E_INVALID_OBJECT_STATE">
6567	Cannot set transient property when machine not running.
6568	</result>
6569	</desc>
6570
6571	<param name="property" type="wstring" dir="in">
6572	<desc>
6573	The name of the property to set or change.
6574	</desc>
6575	</param>
6576	<param name="value" type="wstring" dir="in">
6577	<desc>
6578	The new value of the property to set or change. If the
6579	property does not yet exist and value is non-empty, it will be
6580	created.
6581	</desc>
6582	</param>
6583	</method>
6584
6585	<method name="deleteGuestProperty" const="yes">
6586	<desc>
6587	Deletes an entry from the machine's guest property store.
6588
6589	<result name="VBOX_E_INVALID_VM_STATE">
6590	Machine session is not open.
6591	</result>
6592
6593	</desc>
6594	<param name="name" type="wstring" dir="in">
6595	<desc>
6596	The name of the property to delete.
6597	</desc>
6598	</param>
6599	</method>
6600
6601	<method name="enumerateGuestProperties" const="yes">
6602	<desc>
6603	Return a list of the guest properties matching a set of patterns along
6604	with their values, time stamps and flags.
6605	</desc>
6606	<param name="patterns" type="wstring" dir="in">
6607	<desc>
6608	The patterns to match the properties against, separated by '\|'
6609	characters. If this is empty or @c null, all properties will match.
6610	</desc>
6611	</param>
6612	<param name="names" type="wstring" dir="out" safearray="yes">
6613	<desc>
6614	The names of the properties returned.
6615	</desc>
6616	</param>
6617	<param name="values" type="wstring" dir="out" safearray="yes">
6618	<desc>
6619	The values of the properties returned. The array entries match the
6620	corresponding entries in the @a name array.
6621	</desc>
6622	</param>
6623	<param name="timestamps" type="long long" dir="out" safearray="yes">
6624	<desc>
6625	The time stamps of the properties returned. The array entries match
6626	the corresponding entries in the @a name array.
6627	</desc>
6628	</param>
6629	<param name="flags" type="wstring" dir="out" safearray="yes">
6630	<desc>
6631	The flags of the properties returned. The array entries match the
6632	corresponding entries in the @a name array.
6633	</desc>
6634	</param>
6635	</method>
6636
6637	<method name="querySavedGuestScreenInfo" const="yes">
6638	<desc>
6639	Returns the guest dimensions from the saved state.
6640	</desc>
6641	<param name="screenId" type="unsigned long" dir="in">
6642	<desc>
6643	Saved guest screen to query info from.
6644	</desc>
6645	</param>
6646	<param name="originX" type="unsigned long" dir="out">
6647	<desc>
6648	The X position of the guest monitor top left corner.
6649	</desc>
6650	</param>
6651	<param name="originY" type="unsigned long" dir="out">
6652	<desc>
6653	The Y position of the guest monitor top left corner.
6654	</desc>
6655	</param>
6656	<param name="width" type="unsigned long" dir="out">
6657	<desc>
6658	Guest width at the time of the saved state was taken.
6659	</desc>
6660	</param>
6661	<param name="height" type="unsigned long" dir="out">
6662	<desc>
6663	Guest height at the time of the saved state was taken.
6664	</desc>
6665	</param>
6666	<param name="enabled" type="boolean" dir="out">
6667	<desc>
6668	Whether the monitor is enabled in the guest.
6669	</desc>
6670	</param>
6671	</method>
6672
6673	<method name="querySavedThumbnailSize">
6674	<desc>
6675	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6676	</desc>
6677	<param name="screenId" type="unsigned long" dir="in">
6678	<desc>
6679	Saved guest screen to query info from.
6680	</desc>
6681	</param>
6682	<param name="size" type="unsigned long" dir="out">
6683	<desc>
6684	Size of buffer required to store the bitmap.
6685	</desc>
6686	</param>
6687	<param name="width" type="unsigned long" dir="out">
6688	<desc>
6689	Bitmap width.
6690	</desc>
6691	</param>
6692	<param name="height" type="unsigned long" dir="out">
6693	<desc>
6694	Bitmap height.
6695	</desc>
6696	</param>
6697	</method>
6698
6699	<method name="readSavedThumbnailToArray">
6700	<desc>
6701	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6702	</desc>
6703	<param name="screenId" type="unsigned long" dir="in">
6704	<desc>
6705	Saved guest screen to read from.
6706	</desc>
6707	</param>
6708	<param name="BGR" type="boolean" dir="in">
6709	<desc>
6710	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6711	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6712	</desc>
6713	</param>
6714	<param name="width" type="unsigned long" dir="out">
6715	<desc>
6716	Bitmap width.
6717	</desc>
6718	</param>
6719	<param name="height" type="unsigned long" dir="out">
6720	<desc>
6721	Bitmap height.
6722	</desc>
6723	</param>
6724	<param name="data" type="octet" safearray="yes" dir="return">
6725	<desc>
6726	Array with resulting bitmap data.
6727	</desc>
6728	</param>
6729	</method>
6730
6731	<method name="readSavedThumbnailPNGToArray">
6732	<desc>
6733	Thumbnail in PNG format is retrieved to an array of bytes.
6734	</desc>
6735	<param name="screenId" type="unsigned long" dir="in">
6736	<desc>
6737	Saved guest screen to read from.
6738	</desc>
6739	</param>
6740	<param name="width" type="unsigned long" dir="out">
6741	<desc>
6742	Image width.
6743	</desc>
6744	</param>
6745	<param name="height" type="unsigned long" dir="out">
6746	<desc>
6747	Image height.
6748	</desc>
6749	</param>
6750	<param name="data" type="octet" dir="return" safearray="yes">
6751	<desc>
6752	Array with resulting PNG data.
6753	</desc>
6754	</param>
6755	</method>
6756
6757	<method name="querySavedScreenshotPNGSize">
6758	<desc>
6759	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6760	</desc>
6761	<param name="screenId" type="unsigned long" dir="in">
6762	<desc>
6763	Saved guest screen to query info from.
6764	</desc>
6765	</param>
6766	<param name="size" type="unsigned long" dir="out">
6767	<desc>
6768	Size of buffer required to store the PNG binary data.
6769	</desc>
6770	</param>
6771	<param name="width" type="unsigned long" dir="out">
6772	<desc>
6773	Image width.
6774	</desc>
6775	</param>
6776	<param name="height" type="unsigned long" dir="out">
6777	<desc>
6778	Image height.
6779	</desc>
6780	</param>
6781	</method>
6782
6783	<method name="readSavedScreenshotPNGToArray">
6784	<desc>
6785	Screenshot in PNG format is retrieved to an array of bytes.
6786	</desc>
6787	<param name="screenId" type="unsigned long" dir="in">
6788	<desc>
6789	Saved guest screen to read from.
6790	</desc>
6791	</param>
6792	<param name="width" type="unsigned long" dir="out">
6793	<desc>
6794	Image width.
6795	</desc>
6796	</param>
6797	<param name="height" type="unsigned long" dir="out">
6798	<desc>
6799	Image height.
6800	</desc>
6801	</param>
6802	<param name="data" type="octet" dir="return" safearray="yes">
6803	<desc>
6804	Array with resulting PNG data.
6805	</desc>
6806	</param>
6807	</method>
6808
6809	<method name="hotPlugCPU">
6810	<desc>
6811	Plugs a CPU into the machine.
6812	</desc>
6813	<param name="cpu" type="unsigned long" dir="in">
6814	<desc>
6815	The CPU id to insert.
6816	</desc>
6817	</param>
6818	</method>
6819
6820	<method name="hotUnplugCPU">
6821	<desc>
6822	Removes a CPU from the machine.
6823	</desc>
6824	<param name="cpu" type="unsigned long" dir="in">
6825	<desc>
6826	The CPU id to remove.
6827	</desc>
6828	</param>
6829	</method>
6830
6831	<method name="getCPUStatus">
6832	<desc>
6833	Returns the current status of the given CPU.
6834	</desc>
6835	<param name="cpu" type="unsigned long" dir="in">
6836	<desc>
6837	The CPU id to check for.
6838	</desc>
6839	</param>
6840	<param name="attached" type="boolean" dir="return">
6841	<desc>
6842	Status of the CPU.
6843	</desc>
6844	</param>
6845	</method>
6846
6847	<method name="queryLogFilename">
6848	<desc>
6849	Queries for the VM log file name of an given index. Returns an empty
6850	string if a log file with that index doesn't exists.
6851	</desc>
6852	<param name="idx" type="unsigned long" dir="in">
6853	<desc>
6854	Which log file name to query. 0=current log file.
6855	</desc>
6856	</param>
6857	<param name="filename" type="wstring" dir="return">
6858	<desc>
6859	On return the full path to the log file or an empty string on error.
6860	</desc>
6861	</param>
6862	</method>
6863
6864	<method name="readLog">
6865	<desc>
6866	Reads the VM log file. The chunk size is limited, so even if you
6867	ask for a big piece there might be less data returned.
6868	</desc>
6869	<param name="idx" type="unsigned long" dir="in">
6870	<desc>
6871	Which log file to read. 0=current log file.
6872	</desc>
6873	</param>
6874	<param name="offset" type="long long" dir="in">
6875	<desc>
6876	Offset in the log file.
6877	</desc>
6878	</param>
6879	<param name="size" type="long long" dir="in">
6880	<desc>
6881	Chunk size to read in the log file.
6882	</desc>
6883	</param>
6884	<param name="data" type="octet" dir="return" safearray="yes">
6885	<desc>
6886	Data read from the log file. A data size of 0 means end of file
6887	if the requested chunk size was not 0. This is the unprocessed
6888	file data, i.e. the line ending style depends on the platform of
6889	the system the server is running on.
6890	</desc>
6891	</param>
6892	</method>
6893
6894	<method name="cloneTo">
6895	<desc>
6896	Creates a clone of this machine, either as a full clone (which means
6897	creating independent copies of the hard disk media, save states and so
6898	on), or as a linked clone (which uses its own differencing media,
6899	sharing the parent media with the source machine).
6900
6901	The target machine object must have been created previously with <link
6902	to="IVirtualBox::createMachine"/>, and all the settings will be
6903	transferred except the VM name and the hardware UUID. You can set the
6904	VM name and the new hardware UUID when creating the target machine. The
6905	network MAC addresses are newly created for all newtwork adapters. You
6906	can change that behaviour with the options parameter. The operation is
6907	performed asynchronously, so the machine object will be not be usable
6908	until the @a progress object signals completion.
6909
6910	<result name="E_INVALIDARG">
6911	@a target is @c null.
6912	</result>
6913	</desc>
6914
6915	<param name="target" type="IMachine" dir="in">
6916	<desc>Target machine object.</desc>
6917	</param>
6918	<param name="mode" type="CloneMode" dir="in">
6919	<desc>Which states should be cloned.</desc>
6920	</param>
6921	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6922	<desc>Options for the cloning operation.</desc>
6923	</param>
6924	<param name="progress" type="IProgress" dir="return">
6925	<desc>Progress object to track the operation completion.</desc>
6926	</param>
6927	</method>
6928
6929	</interface>
6930
6931	<!--
6932	// IConsole
6933	/////////////////////////////////////////////////////////////////////////
6934	-->
6935
6936	<interface
6937	name="IVRDEServerInfo" extends="$unknown"
6938	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6939	wsmap="struct"
6940	>
6941	<desc>
6942	Contains information about the remote desktop (VRDE) server capabilities and status.
6943	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6944	</desc>
6945
6946	<attribute name="active" type="boolean" readonly="yes">
6947	<desc>
6948	Whether the remote desktop connection is active.
6949	</desc>
6950	</attribute>
6951
6952	<attribute name="port" type="long" readonly="yes">
6953	<desc>
6954	VRDE server port number. If this property is equal to <tt>0</tt>, then
6955	the VRDE server failed to start, usually because there are no free IP
6956	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6957	server has not yet been started.
6958	</desc>
6959	</attribute>
6960
6961	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6962	<desc>
6963	How many times a client connected.
6964	</desc>
6965	</attribute>
6966
6967	<attribute name="beginTime" type="long long" readonly="yes">
6968	<desc>
6969	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6970	</desc>
6971	</attribute>
6972
6973	<attribute name="endTime" type="long long" readonly="yes">
6974	<desc>
6975	When the last connection was terminated or the current time, if
6976	connection is still active, in milliseconds since 1970-01-01 UTC.
6977	</desc>
6978	</attribute>
6979
6980	<attribute name="bytesSent" type="long long" readonly="yes">
6981	<desc>
6982	How many bytes were sent in last or current, if still active, connection.
6983	</desc>
6984	</attribute>
6985
6986	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6987	<desc>
6988	How many bytes were sent in all connections.
6989	</desc>
6990	</attribute>
6991
6992	<attribute name="bytesReceived" type="long long" readonly="yes">
6993	<desc>
6994	How many bytes were received in last or current, if still active, connection.
6995	</desc>
6996	</attribute>
6997
6998	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6999	<desc>
7000	How many bytes were received in all connections.
7001	</desc>
7002	</attribute>
7003
7004	<attribute name="user" type="wstring" readonly="yes">
7005	<desc>
7006	Login user name supplied by the client.
7007	</desc>
7008	</attribute>
7009
7010	<attribute name="domain" type="wstring" readonly="yes">
7011	<desc>
7012	Login domain name supplied by the client.
7013	</desc>
7014	</attribute>
7015
7016	<attribute name="clientName" type="wstring" readonly="yes">
7017	<desc>
7018	The client name supplied by the client.
7019	</desc>
7020	</attribute>
7021
7022	<attribute name="clientIP" type="wstring" readonly="yes">
7023	<desc>
7024	The IP address of the client.
7025	</desc>
7026	</attribute>
7027
7028	<attribute name="clientVersion" type="unsigned long" readonly="yes">
7029	<desc>
7030	The client software version number.
7031	</desc>
7032	</attribute>
7033
7034	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
7035	<desc>
7036	Public key exchange method used when connection was established.
7037	Values: 0 - RDP4 public key exchange scheme.
7038	1 - X509 certificates were sent to client.
7039	</desc>
7040	</attribute>
7041
7042	</interface>
7043
7044	<interface
7045	name="IConsole" extends="$unknown"
7046	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
7047	wsmap="managed"
7048	>
7049	<desc>
7050	The IConsole interface represents an interface to control virtual
7051	machine execution.
7052
7053	A console object gets created when a machine has been locked for a
7054	particular session (client process) using <link to="IMachine::lockMachine" />
7055	or <link to="IMachine::launchVMProcess"/>. The console object can
7056	then be found in the session's <link to="ISession::console" /> attribute.
7057
7058	Methods of the IConsole interface allow the caller to query the current
7059	virtual machine execution state, pause the machine or power it down, save
7060	the machine state or take a snapshot, attach and detach removable media
7061	and so on.
7062
7063	<see><link to="ISession"/></see>
7064	</desc>
7065
7066	<attribute name="machine" type="IMachine" readonly="yes">
7067	<desc>
7068	Machine object for this console session.
7069	<note>
7070	This is a convenience property, it has the same value as
7071	<link to="ISession::machine"/> of the corresponding session
7072	object.
7073	</note>
7074	</desc>
7075	</attribute>
7076
7077	<attribute name="state" type="MachineState" readonly="yes">
7078	<desc>
7079	Current execution state of the machine.
7080	<note>
7081	This property always returns the same value as the corresponding
7082	property of the IMachine object for this console session.
7083	For the process that owns (executes) the VM, this is the
7084	preferable way of querying the VM state, because no IPC
7085	calls are made.
7086	</note>
7087	</desc>
7088	</attribute>
7089
7090	<attribute name="guest" type="IGuest" readonly="yes">
7091	<desc>Guest object.</desc>
7092	</attribute>
7093
7094	<attribute name="keyboard" type="IKeyboard" readonly="yes">
7095	<desc>
7096	Virtual keyboard object.
7097	<note>
7098	If the machine is not running, any attempt to use
7099	the returned object will result in an error.
7100	</note>
7101	</desc>
7102	</attribute>
7103
7104	<attribute name="mouse" type="IMouse" readonly="yes">
7105	<desc>
7106	Virtual mouse object.
7107	<note>
7108	If the machine is not running, any attempt to use
7109	the returned object will result in an error.
7110	</note>
7111	</desc>
7112	</attribute>
7113
7114	<attribute name="display" type="IDisplay" readonly="yes">
7115	<desc>Virtual display object.
7116	<note>
7117	If the machine is not running, any attempt to use
7118	the returned object will result in an error.
7119	</note>
7120	</desc>
7121	</attribute>
7122
7123	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
7124	<desc>Debugging interface.</desc>
7125	</attribute>
7126
7127	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
7128	<desc>
7129	Collection of USB devices currently attached to the virtual
7130	USB controller.
7131	<note>
7132	The collection is empty if the machine is not running.
7133	</note>
7134	</desc>
7135	</attribute>
7136
7137	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7138	<desc>
7139	List of USB devices currently attached to the remote VRDE client.
7140	Once a new device is physically attached to the remote host computer,
7141	it appears in this list and remains there until detached.
7142	</desc>
7143	</attribute>
7144
7145	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
7146	<desc>
7147	Collection of shared folders for the current session. These folders
7148	are called transient shared folders because they are available to the
7149	guest OS running inside the associated virtual machine only for the
7150	duration of the session (as opposed to
7151	<link to="IMachine::sharedFolders"/> which represent permanent shared
7152	folders). When the session is closed (e.g. the machine is powered down),
7153	these folders are automatically discarded.
7154
7155	New shared folders are added to the collection using
7156	<link to="#createSharedFolder"/>. Existing shared folders can be
7157	removed using <link to="#removeSharedFolder"/>.
7158	</desc>
7159	</attribute>
7160
7161	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
7162	<desc>
7163	Interface that provides information on Remote Desktop Extension (VRDE) connection.
7164	</desc>
7165	</attribute>
7166
7167	<attribute name="eventSource" type="IEventSource" readonly="yes">
7168	<desc>
7169	Event source for console events.
7170	</desc>
7171	</attribute>
7172
7173	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
7174	<desc>Array of PCI devices attached to this machine.</desc>
7175	</attribute>
7176
7177	<attribute name="useHostClipboard" type="boolean">
7178	<desc>
7179	Whether the guest clipboard should be connected to the host one or
7180	whether it should only be allowed access to the VRDE clipboard. This
7181	setting may not affect existing guest clipboard connections which
7182	are already connected to the host clipboard.
7183	</desc>
7184	</attribute>
7185
7186	<method name="powerUp">
7187	<desc>
7188	Starts the virtual machine execution using the current machine
7189	state (that is, its current execution state, current settings and
7190	current storage devices).
7191
7192	<note>
7193	This method is only useful for front-ends that want to actually
7194	execute virtual machines in their own process (like the VirtualBox
7195	or VBoxSDL front-ends). Unless you are intending to write such a
7196	front-end, do not call this method. If you simply want to
7197	start virtual machine execution using one of the existing front-ends
7198	(for example the VirtualBox GUI or headless server), use
7199	<link to="IMachine::launchVMProcess"/> instead; these
7200	front-ends will power up the machine automatically for you.
7201	</note>
7202
7203	If the machine is powered off or aborted, the execution will
7204	start from the beginning (as if the real hardware were just
7205	powered on).
7206
7207	If the machine is in the <link to="MachineState_Saved"/> state,
7208	it will continue its execution the point where the state has
7209	been saved.
7210
7211	If the machine <link to="IMachine::teleporterEnabled"/> property is
7212	enabled on the machine being powered up, the machine will wait for an
7213	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
7214	state. The returned progress object will have at least three
7215	operations where the last three are defined as: (1) powering up and
7216	starting TCP server, (2) waiting for incoming teleportations, and
7217	(3) perform teleportation. These operations will be reflected as the
7218	last three operations of the progress objected returned by
7219	<link to="IMachine::launchVMProcess"/> as well.
7220
7221	<see><link to="#saveState"/></see>
7222
7223	<result name="VBOX_E_INVALID_VM_STATE">
7224	Virtual machine already running.
7225	</result>
7226	<result name="VBOX_E_HOST_ERROR">
7227	Host interface does not exist or name not set.
7228	</result>
7229	<result name="VBOX_E_FILE_ERROR">
7230	Invalid saved state file.
7231	</result>
7232	</desc>
7233	<param name="progress" type="IProgress" dir="return">
7234	<desc>Progress object to track the operation completion.</desc>
7235	</param>
7236	</method>
7237
7238	<method name="powerUpPaused">
7239	<desc>
7240	Identical to powerUp except that the VM will enter the
7241	<link to="MachineState_Paused"/> state, instead of
7242	<link to="MachineState_Running"/>.
7243
7244	<see><link to="#powerUp"/></see>
7245	<result name="VBOX_E_INVALID_VM_STATE">
7246	Virtual machine already running.
7247	</result>
7248	<result name="VBOX_E_HOST_ERROR">
7249	Host interface does not exist or name not set.
7250	</result>
7251	<result name="VBOX_E_FILE_ERROR">
7252	Invalid saved state file.
7253	</result>
7254	</desc>
7255	<param name="progress" type="IProgress" dir="return">
7256	<desc>Progress object to track the operation completion.</desc>
7257	</param>
7258	</method>
7259
7260	<method name="powerDown">
7261	<desc>
7262	Initiates the power down procedure to stop the virtual machine
7263	execution.
7264
7265	The completion of the power down procedure is tracked using the returned
7266	IProgress object. After the operation is complete, the machine will go
7267	to the PoweredOff state.
7268	<result name="VBOX_E_INVALID_VM_STATE">
7269	Virtual machine must be Running, Paused or Stuck to be powered down.
7270	</result>
7271	</desc>
7272	<param name="progress" type="IProgress" dir="return">
7273	<desc>Progress object to track the operation completion.</desc>
7274	</param>
7275	</method>
7276
7277	<method name="reset">
7278	<desc>Resets the virtual machine.
7279	<result name="VBOX_E_INVALID_VM_STATE">
7280	Virtual machine not in Running state.
7281	</result>
7282	<result name="VBOX_E_VM_ERROR">
7283	Virtual machine error in reset operation.
7284	</result>
7285	</desc>
7286	</method>
7287
7288	<method name="pause">
7289	<desc>Pauses the virtual machine execution.
7290	<result name="VBOX_E_INVALID_VM_STATE">
7291	Virtual machine not in Running state.
7292	</result>
7293	<result name="VBOX_E_VM_ERROR">
7294	Virtual machine error in suspend operation.
7295	</result>
7296	</desc>
7297	</method>
7298
7299	<method name="resume">
7300	<desc>Resumes the virtual machine execution.
7301	<result name="VBOX_E_INVALID_VM_STATE">
7302	Virtual machine not in Paused state.
7303	</result>
7304	<result name="VBOX_E_VM_ERROR">
7305	Virtual machine error in resume operation.
7306	</result>
7307	</desc>
7308	</method>
7309
7310	<method name="powerButton">
7311	<desc>Sends the ACPI power button event to the guest.
7312	<result name="VBOX_E_INVALID_VM_STATE">
7313	Virtual machine not in Running state.
7314	</result>
7315	<result name="VBOX_E_PDM_ERROR">
7316	Controlled power off failed.
7317	</result>
7318	</desc>
7319	</method>
7320
7321	<method name="sleepButton">
7322	<desc>Sends the ACPI sleep button event to the guest.
7323	<result name="VBOX_E_INVALID_VM_STATE">
7324	Virtual machine not in Running state.
7325	</result>
7326	<result name="VBOX_E_PDM_ERROR">
7327	Sending sleep button event failed.
7328	</result>
7329	</desc>
7330	</method>
7331
7332	<method name="getPowerButtonHandled">
7333	<desc>Checks if the last power button event was handled by guest.
7334	<result name="VBOX_E_PDM_ERROR">
7335	Checking if the event was handled by the guest OS failed.
7336	</result>
7337	</desc>
7338	<param name="handled" type="boolean" dir="return"/>
7339	</method>
7340
7341	<method name="getGuestEnteredACPIMode">
7342	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7343	G1 (sleeping). If this method returns @c false, the guest will
7344	most likely not respond to external ACPI events.
7345	<result name="VBOX_E_INVALID_VM_STATE">
7346	Virtual machine not in Running state.
7347	</result>
7348	</desc>
7349	<param name="entered" type="boolean" dir="return"/>
7350	</method>
7351
7352	<method name="saveState">
7353	<desc>
7354	Saves the current execution state of a running virtual machine
7355	and stops its execution.
7356
7357	After this operation completes, the machine will go to the
7358	Saved state. Next time it is powered up, this state will
7359	be restored and the machine will continue its execution from
7360	the place where it was saved.
7361
7362	This operation differs from taking a snapshot to the effect
7363	that it doesn't create new differencing media. Also, once
7364	the machine is powered up from the state saved using this method,
7365	the saved state is deleted, so it will be impossible to return
7366	to this state later.
7367
7368	<note>
7369	On success, this method implicitly calls
7370	<link to="IMachine::saveSettings"/> to save all current machine
7371	settings (including runtime changes to the DVD medium, etc.).
7372	Together with the impossibility to change any VM settings when it is
7373	in the Saved state, this guarantees adequate hardware
7374	configuration of the machine when it is restored from the saved
7375	state file.
7376	</note>
7377
7378	<note>
7379	The machine must be in the Running or Paused state, otherwise
7380	the operation will fail.
7381	</note>
7382	<result name="VBOX_E_INVALID_VM_STATE">
7383	Virtual machine state neither Running nor Paused.
7384	</result>
7385	<result name="VBOX_E_FILE_ERROR">
7386	Failed to create directory for saved state file.
7387	</result>
7388
7389	<see><link to="#takeSnapshot"/></see>
7390	</desc>
7391	<param name="progress" type="IProgress" dir="return">
7392	<desc>Progress object to track the operation completion.</desc>
7393	</param>
7394	</method>
7395
7396	<method name="adoptSavedState">
7397	<desc>
7398	Associates the given saved state file to the virtual machine.
7399
7400	On success, the machine will go to the Saved state. Next time it is
7401	powered up, it will be restored from the adopted saved state and
7402	continue execution from the place where the saved state file was
7403	created.
7404
7405	The specified saved state file path may be absolute or relative to the
7406	folder the VM normally saves the state to (usually,
7407	<link to="IMachine::snapshotFolder"/>).
7408
7409	<note>
7410	It's a caller's responsibility to make sure the given saved state
7411	file is compatible with the settings of this virtual machine that
7412	represent its virtual hardware (memory size, storage disk configuration
7413	etc.). If there is a mismatch, the behavior of the virtual machine
7414	is undefined.
7415	</note>
7416	<result name="VBOX_E_INVALID_VM_STATE">
7417	Virtual machine state neither PoweredOff nor Aborted.
7418	</result>
7419	</desc>
7420	<param name="savedStateFile" type="wstring" dir="in">
7421	<desc>Path to the saved state file to adopt.</desc>
7422	</param>
7423	</method>
7424
7425	<method name="discardSavedState">
7426	<desc>
7427	Forcibly resets the machine to "Powered Off" state if it is
7428	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7429	Next time the machine is powered up, a clean boot will occur.
7430	<note>
7431	This operation is equivalent to resetting or powering off
7432	the machine without doing a proper shutdown of the guest
7433	operating system; as with resetting a running phyiscal
7434	computer, it can can lead to data loss.
7435	</note>
7436	If @a fRemoveFile is @c true, the file in the machine directory
7437	into which the machine state was saved is also deleted. If
7438	this is @c false, then the state can be recovered and later
7439	re-inserted into a machine using <link to="#adoptSavedState" />.
7440	The location of the file can be found in the
7441	<link to="IMachine::stateFilePath" /> attribute.
7442	<result name="VBOX_E_INVALID_VM_STATE">
7443	Virtual machine not in state Saved.
7444	</result>
7445	</desc>
7446	<param name="fRemoveFile" type="boolean" dir="in" >
7447	<desc>Whether to also remove the saved state file.</desc>
7448	</param>
7449	</method>
7450
7451	<method name="getDeviceActivity">
7452	<desc>
7453	Gets the current activity type of a given device or device group.
7454	<result name="E_INVALIDARG">
7455	Invalid device type.
7456	</result>
7457	</desc>
7458	<param name="type" type="DeviceType" dir="in"/>
7459	<param name="activity" type="DeviceActivity" dir="return"/>
7460	</method>
7461
7462	<method name="attachUSBDevice">
7463	<desc>
7464	Attaches a host USB device with the given UUID to the
7465	USB controller of the virtual machine.
7466
7467	The device needs to be in one of the following states:
7468	<link to="USBDeviceState_Busy"/>,
7469	<link to="USBDeviceState_Available"/> or
7470	<link to="USBDeviceState_Held"/>,
7471	otherwise an error is immediately returned.
7472
7473	When the device state is
7474	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7475	be returned if the host computer refuses to release it for some reason.
7476
7477	<see><link to="IUSBController::deviceFilters"/>,
7478	<link to="USBDeviceState"/></see>
7479	<result name="VBOX_E_INVALID_VM_STATE">
7480	Virtual machine state neither Running nor Paused.
7481	</result>
7482	<result name="VBOX_E_PDM_ERROR">
7483	Virtual machine does not have a USB controller.
7484	</result>
7485	</desc>
7486	<param name="id" type="uuid" mod="string" dir="in">
7487	<desc>UUID of the host USB device to attach.</desc>
7488	</param>
7489	</method>
7490
7491	<method name="detachUSBDevice">
7492	<desc>
7493	Detaches an USB device with the given UUID from the USB controller
7494	of the virtual machine.
7495
7496	After this method succeeds, the VirtualBox server re-initiates
7497	all USB filters as if the device were just physically attached
7498	to the host, but filters of this machine are ignored to avoid
7499	a possible automatic re-attachment.
7500
7501	<see><link to="IUSBController::deviceFilters"/>,
7502	<link to="USBDeviceState"/></see>
7503
7504	<result name="VBOX_E_PDM_ERROR">
7505	Virtual machine does not have a USB controller.
7506	</result>
7507	<result name="E_INVALIDARG">
7508	USB device not attached to this virtual machine.
7509	</result>
7510	</desc>
7511	<param name="id" type="uuid" mod="string" dir="in">
7512	<desc>UUID of the USB device to detach.</desc>
7513	</param>
7514	<param name="device" type="IUSBDevice" dir="return">
7515	<desc>Detached USB device.</desc>
7516	</param>
7517	</method>
7518
7519	<method name="findUSBDeviceByAddress">
7520	<desc>
7521	Searches for a USB device with the given host address.
7522
7523	<result name="VBOX_E_OBJECT_NOT_FOUND">
7524	Given @c name does not correspond to any USB device.
7525	</result>
7526
7527	<see><link to="IUSBDevice::address"/></see>
7528	</desc>
7529	<param name="name" type="wstring" dir="in">
7530	<desc>
7531	Address of the USB device (as assigned by the host) to
7532	search for.
7533	</desc>
7534	</param>
7535	<param name="device" type="IUSBDevice" dir="return">
7536	<desc>Found USB device object.</desc>
7537	</param>
7538	</method>
7539
7540	<method name="findUSBDeviceById">
7541	<desc>
7542	Searches for a USB device with the given UUID.
7543
7544	<result name="VBOX_E_OBJECT_NOT_FOUND">
7545	Given @c id does not correspond to any USB device.
7546	</result>
7547
7548	<see><link to="IUSBDevice::id"/></see>
7549	</desc>
7550	<param name="id" type="uuid" mod="string" dir="in">
7551	<desc>UUID of the USB device to search for.</desc>
7552	</param>
7553	<param name="device" type="IUSBDevice" dir="return">
7554	<desc>Found USB device object.</desc>
7555	</param>
7556	</method>
7557
7558	<method name="createSharedFolder">
7559	<desc>
7560	Creates a transient new shared folder by associating the given logical
7561	name with the given host path, adds it to the collection of shared
7562	folders and starts sharing it. Refer to the description of
7563	<link to="ISharedFolder"/> to read more about logical names.
7564
7565	<result name="VBOX_E_INVALID_VM_STATE">
7566	Virtual machine in Saved state or currently changing state.
7567	</result>
7568	<result name="VBOX_E_FILE_ERROR">
7569	Shared folder already exists or not accessible.
7570	</result>
7571	</desc>
7572	<param name="name" type="wstring" dir="in">
7573	<desc>Unique logical name of the shared folder.</desc>
7574	</param>
7575	<param name="hostPath" type="wstring" dir="in">
7576	<desc>Full path to the shared folder in the host file system.</desc>
7577	</param>
7578	<param name="writable" type="boolean" dir="in">
7579	<desc>Whether the share is writable or readonly</desc>
7580	</param>
7581	<param name="automount" type="boolean" dir="in">
7582	<desc>Whether the share gets automatically mounted by the guest
7583	or not.</desc>
7584	</param>
7585	</method>
7586
7587	<method name="removeSharedFolder">
7588	<desc>
7589	Removes a transient shared folder with the given name previously
7590	created by <link to="#createSharedFolder"/> from the collection of
7591	shared folders and stops sharing it.
7592	<result name="VBOX_E_INVALID_VM_STATE">
7593	Virtual machine in Saved state or currently changing state.
7594	</result>
7595	<result name="VBOX_E_FILE_ERROR">
7596	Shared folder does not exists.
7597	</result>
7598	</desc>
7599	<param name="name" type="wstring" dir="in">
7600	<desc>Logical name of the shared folder to remove.</desc>
7601	</param>
7602	</method>
7603
7604	<method name="takeSnapshot">
7605	<desc>
7606	Saves the current execution state
7607	and all settings of the machine and creates differencing images
7608	for all normal (non-independent) media.
7609	See <link to="ISnapshot" /> for an introduction to snapshots.
7610
7611	This method can be called for a PoweredOff, Saved (see
7612	<link to="#saveState"/>), Running or
7613	Paused virtual machine. When the machine is PoweredOff, an
7614	offline snapshot is created. When the machine is Running a live
7615	snapshot is created, and an online snapshot is created when Paused.
7616
7617	The taken snapshot is always based on the
7618	<link to="IMachine::currentSnapshot">current snapshot</link>
7619	of the associated virtual machine and becomes a new current snapshot.
7620
7621	<note>
7622	This method implicitly calls <link to="IMachine::saveSettings"/> to
7623	save all current machine settings before taking an offline snapshot.
7624	</note>
7625
7626	<result name="VBOX_E_INVALID_VM_STATE">
7627	Virtual machine currently changing state.
7628	</result>
7629	</desc>
7630	<param name="name" type="wstring" dir="in">
7631	<desc>Short name for the snapshot.</desc>
7632	</param>
7633	<param name="description" type="wstring" dir="in">
7634	<desc>Optional description of the snapshot.</desc>
7635	</param>
7636	<param name="progress" type="IProgress" dir="return">
7637	<desc>Progress object to track the operation completion.</desc>
7638	</param>
7639	</method>
7640
7641	<method name="deleteSnapshot">
7642	<desc>
7643	Starts deleting the specified snapshot asynchronously.
7644	See <link to="ISnapshot" /> for an introduction to snapshots.
7645
7646	The execution state and settings of the associated machine stored in
7647	the snapshot will be deleted. The contents of all differencing media of
7648	this snapshot will be merged with the contents of their dependent child
7649	media to keep the medium chain valid (in other words, all changes
7650	represented by media being deleted will be propagated to their child
7651	medium). After that, this snapshot's differencing medium will be
7652	deleted. The parent of this snapshot will become a new parent for all
7653	its child snapshots.
7654
7655	If the deleted snapshot is the current one, its parent snapshot will
7656	become a new current snapshot. The current machine state is not directly
7657	affected in this case, except that currently attached differencing
7658	media based on media of the deleted snapshot will be also merged as
7659	described above.
7660
7661	If the deleted snapshot is the first or current snapshot, then the
7662	respective IMachine attributes will be adjusted. Deleting the current
7663	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7664	to make all current machine settings permanent.
7665
7666	Deleting a snapshot has the following preconditions:
7667
7668	<ul>
7669	<li>Child media of all normal media of the deleted snapshot
7670	must be accessible (see <link to="IMedium::state"/>) for this
7671	operation to succeed. If only one running VM refers to all images
7672	which participates in merging the operation can be performed while
7673	the VM is running. Otherwise all virtual machines whose media are
7674	directly or indirectly based on the media of deleted snapshot must
7675	be powered off. In any case, online snapshot deleting usually is
7676	slower than the same operation without any running VM.</li>
7677
7678	<li>You cannot delete the snapshot if a medium attached to it has
7679	more than one child medium (differencing images) because otherwise
7680	merging would be impossible. This might be the case if there is
7681	more than one child snapshot or differencing images were created
7682	for other reason (e.g. implicitly because of multiple machine
7683	attachments).</li>
7684	</ul>
7685
7686	The virtual machine's <link to="IMachine::state">state</link> is
7687	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7688	"DeletingSnapshotPaused" while this operation is in progress.
7689
7690	<note>
7691	Merging medium contents can be very time and disk space
7692	consuming, if these media are big in size and have many
7693	children. However, if the snapshot being deleted is the last
7694	(head) snapshot on the branch, the operation will be rather
7695	quick.
7696	</note>
7697	<result name="VBOX_E_INVALID_VM_STATE">
7698	The running virtual machine prevents deleting this snapshot. This
7699	happens only in very specific situations, usually snapshots can be
7700	deleted without trouble while a VM is running. The error message
7701	text explains the reason for the failure.
7702	</result>
7703	</desc>
7704	<param name="id" type="uuid" mod="string" dir="in">
7705	<desc>UUID of the snapshot to delete.</desc>
7706	</param>
7707	<param name="progress" type="IProgress" dir="return">
7708	<desc>Progress object to track the operation completion.</desc>
7709	</param>
7710	</method>
7711
7712	<method name="deleteSnapshotAndAllChildren">
7713	<desc>
7714	Starts deleting the specified snapshot and all its children
7715	asynchronously. See <link to="ISnapshot" /> for an introduction to
7716	snapshots. The conditions and many details are the same as with
7717	<link to="#deleteSnapshot"/>.
7718
7719	This operation is very fast if the snapshot subtree does not include
7720	the current state. It is still significantly faster than deleting the
7721	snapshots one by one if the current state is in the subtree and there
7722	are more than one snapshots from current state to the snapshot which
7723	marks the subtree, since it eliminates the incremental image merging.
7724
7725	<note>This API method is right now not implemented!</note>
7726
7727	<result name="VBOX_E_INVALID_VM_STATE">
7728	The running virtual machine prevents deleting this snapshot. This
7729	happens only in very specific situations, usually snapshots can be
7730	deleted without trouble while a VM is running. The error message
7731	text explains the reason for the failure.
7732	</result>
7733	<result name="E_NOTIMPL">
7734	The method is not implemented yet.
7735	</result>
7736	</desc>
7737	<param name="id" type="uuid" mod="string" dir="in">
7738	<desc>UUID of the snapshot to delete, including all its children.</desc>
7739	</param>
7740	<param name="progress" type="IProgress" dir="return">
7741	<desc>Progress object to track the operation completion.</desc>
7742	</param>
7743	</method>
7744
7745	<method name="deleteSnapshotRange">
7746	<desc>
7747	Starts deleting the specified snapshot range. This is limited to
7748	linear snapshot lists, which means there may not be any other child
7749	snapshots other than the direct sequence between the start and end
7750	snapshot. If the start and end snapshot point to the same snapshot this
7751	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7752	<link to="ISnapshot" /> for an introduction to snapshots. The
7753	conditions and many details are the same as with
7754	<link to="#deleteSnapshot"/>.
7755
7756	This operation is generally faster than deleting snapshots one by one
7757	and often also needs less extra disk space before freeing up disk space
7758	by deleting the removed disk images corresponding to the snapshot.
7759
7760	<note>This API method is right now not implemented!</note>
7761
7762	<result name="VBOX_E_INVALID_VM_STATE">
7763	The running virtual machine prevents deleting this snapshot. This
7764	happens only in very specific situations, usually snapshots can be
7765	deleted without trouble while a VM is running. The error message
7766	text explains the reason for the failure.
7767	</result>
7768	<result name="E_NOTIMPL">
7769	The method is not implemented yet.
7770	</result>
7771	</desc>
7772	<param name="startId" type="uuid" mod="string" dir="in">
7773	<desc>UUID of the first snapshot to delete.</desc>
7774	</param>
7775	<param name="endId" type="uuid" mod="string" dir="in">
7776	<desc>UUID of the last snapshot to delete.</desc>
7777	</param>
7778	<param name="progress" type="IProgress" dir="return">
7779	<desc>Progress object to track the operation completion.</desc>
7780	</param>
7781	</method>
7782
7783	<method name="restoreSnapshot">
7784	<desc>
7785	Starts resetting the machine's current state to the state contained
7786	in the given snapshot, asynchronously. All current settings of the
7787	machine will be reset and changes stored in differencing media
7788	will be lost.
7789	See <link to="ISnapshot" /> for an introduction to snapshots.
7790
7791	After this operation is successfully completed, new empty differencing
7792	media are created for all normal media of the machine.
7793
7794	If the given snapshot is an online snapshot, the machine will go to
7795	the <link to="MachineState_Saved"> saved state</link>, so that the
7796	next time it is powered on, the execution state will be restored
7797	from the state of the snapshot.
7798
7799	<note>
7800	The machine must not be running, otherwise the operation will fail.
7801	</note>
7802
7803	<note>
7804	If the machine state is <link to="MachineState_Saved">Saved</link>
7805	prior to this operation, the saved state file will be implicitly
7806	deleted (as if <link to="IConsole::discardSavedState"/> were
7807	called).
7808	</note>
7809
7810	<result name="VBOX_E_INVALID_VM_STATE">
7811	Virtual machine is running.
7812	</result>
7813	</desc>
7814	<param name="snapshot" type="ISnapshot" dir="in">
7815	<desc>The snapshot to restore the VM state from.</desc>
7816	</param>
7817	<param name="progress" type="IProgress" dir="return">
7818	<desc>Progress object to track the operation completion.</desc>
7819	</param>
7820	</method>
7821
7822	<method name="teleport">
7823	<desc>
7824	Teleport the VM to a different host machine or process.
7825
7826	TODO explain the details.
7827
7828	<result name="VBOX_E_INVALID_VM_STATE">
7829	Virtual machine not running or paused.
7830	</result>
7831	</desc>
7832	<param name="hostname" type="wstring" dir="in">
7833	<desc>The name or IP of the host to teleport to.</desc>
7834	</param>
7835	<param name="tcpport" type="unsigned long" dir="in">
7836	<desc>The TCP port to connect to (1..65535).</desc>
7837	</param>
7838	<param name="password" type="wstring" dir="in">
7839	<desc>The password.</desc>
7840	</param>
7841	<param name="maxDowntime" type="unsigned long" dir="in">
7842	<desc>
7843	The maximum allowed downtime given as milliseconds. 0 is not a valid
7844	value. Recommended value: 250 ms.
7845
7846	The higher the value is, the greater the chance for a successful
7847	teleportation. A small value may easily result in the teleportation
7848	process taking hours and eventually fail.
7849
7850	<note>
7851	The current implementation treats this a guideline, not as an
7852	absolute rule.
7853	</note>
7854	</desc>
7855	</param>
7856	<param name="progress" type="IProgress" dir="return">
7857	<desc>Progress object to track the operation completion.</desc>
7858	</param>
7859	</method>
7860
7861	</interface>
7862
7863	<!--
7864	// IHost
7865	/////////////////////////////////////////////////////////////////////////
7866	-->
7867
7868	<enum
7869	name="HostNetworkInterfaceMediumType"
7870	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7871	>
7872	<desc>
7873	Type of encapsulation. Ethernet encapsulation includes both wired and
7874	wireless Ethernet connections.
7875	<see><link to="IHostNetworkInterface"/></see>
7876	</desc>
7877
7878	<const name="Unknown" value="0">
7879	<desc>
7880	The type of interface cannot be determined.
7881	</desc>
7882	</const>
7883	<const name="Ethernet" value="1">
7884	<desc>
7885	Ethernet frame encapsulation.
7886	</desc>
7887	</const>
7888	<const name="PPP" value="2">
7889	<desc>
7890	Point-to-point protocol encapsulation.
7891	</desc>
7892	</const>
7893	<const name="SLIP" value="3">
7894	<desc>
7895	Serial line IP encapsulation.
7896	</desc>
7897	</const>
7898	</enum>
7899
7900	<enum
7901	name="HostNetworkInterfaceStatus"
7902	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7903	>
7904	<desc>
7905	Current status of the interface.
7906	<see><link to="IHostNetworkInterface"/></see>
7907	</desc>
7908
7909	<const name="Unknown" value="0">
7910	<desc>
7911	The state of interface cannot be determined.
7912	</desc>
7913	</const>
7914	<const name="Up" value="1">
7915	<desc>
7916	The interface is fully operational.
7917	</desc>
7918	</const>
7919	<const name="Down" value="2">
7920	<desc>
7921	The interface is not functioning.
7922	</desc>
7923	</const>
7924	</enum>
7925
7926	<enum
7927	name="HostNetworkInterfaceType"
7928	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7929	>
7930	<desc>
7931	Network interface type.
7932	</desc>
7933	<const name="Bridged" value="1"/>
7934	<const name="HostOnly" value="2"/>
7935	</enum>
7936
7937	<interface
7938	name="IHostNetworkInterface" extends="$unknown"
7939	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7940	wsmap="managed"
7941	>
7942	<desc>
7943	Represents one of host's network interfaces. IP V6 address and network
7944	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7945	separated by colons.
7946	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7947	</desc>
7948	<attribute name="name" type="wstring" readonly="yes">
7949	<desc>Returns the host network interface name.</desc>
7950	</attribute>
7951
7952	<attribute name="id" type="uuid" mod="string" readonly="yes">
7953	<desc>Returns the interface UUID.</desc>
7954	</attribute>
7955
7956	<attribute name="networkName" type="wstring" readonly="yes">
7957	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7958	</attribute>
7959
7960	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7961	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7962	</attribute>
7963
7964	<attribute name="IPAddress" type="wstring" readonly="yes">
7965	<desc>Returns the IP V4 address of the interface.</desc>
7966	</attribute>
7967
7968	<attribute name="networkMask" type="wstring" readonly="yes">
7969	<desc>Returns the network mask of the interface.</desc>
7970	</attribute>
7971
7972	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7973	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7974	</attribute>
7975
7976	<attribute name="IPV6Address" type="wstring" readonly="yes">
7977	<desc>Returns the IP V6 address of the interface.</desc>
7978	</attribute>
7979
7980	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7981	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7982	</attribute>
7983
7984	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7985	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7986	</attribute>
7987
7988	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7989	<desc>Type of protocol encapsulation used.</desc>
7990	</attribute>
7991
7992	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7993	<desc>Status of the interface.</desc>
7994	</attribute>
7995
7996	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7997	<desc>specifies the host interface type.</desc>
7998	</attribute>
7999
8000	<method name="enableStaticIPConfig">
8001	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
8002	<param name="IPAddress" type="wstring" dir="in">
8003	<desc>
8004	IP address.
8005	</desc>
8006	</param>
8007	<param name="networkMask" type="wstring" dir="in">
8008	<desc>
8009	network mask.
8010	</desc>
8011	</param>
8012	</method>
8013
8014	<method name="enableStaticIPConfigV6">
8015	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
8016	<param name="IPV6Address" type="wstring" dir="in">
8017	<desc>
8018	IP address.
8019	</desc>
8020	</param>
8021	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
8022	<desc>
8023	network mask.
8024	</desc>
8025	</param>
8026	</method>
8027
8028	<method name="enableDynamicIPConfig">
8029	<desc>enables the dynamic IP configuration.</desc>
8030	</method>
8031
8032	<method name="DHCPRediscover">
8033	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
8034	</method>
8035
8036	</interface>
8037
8038	<interface
8039	name="IHost" extends="$unknown"
8040	uuid="30678943-32df-4830-b413-931b25ac86a0"
8041	wsmap="managed"
8042	>
8043	<desc>
8044	The IHost interface represents the physical machine that this VirtualBox
8045	installation runs on.
8046
8047	An object implementing this interface is returned by the
8048	<link to="IVirtualBox::host" /> attribute. This interface contains
8049	read-only information about the host's physical hardware (such as what
8050	processors and disks are available, what the host operating system is,
8051	and so on) and also allows for manipulating some of the host's hardware,
8052	such as global USB device filters and host interface networking.
8053
8054	</desc>
8055	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
8056	<desc>List of DVD drives available on the host.</desc>
8057	</attribute>
8058
8059	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
8060	<desc>List of floppy drives available on the host.</desc>
8061	</attribute>
8062
8063	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
8064	<desc>
8065	List of USB devices currently attached to the host.
8066	Once a new device is physically attached to the host computer,
8067	it appears in this list and remains there until detached.
8068
8069	<note>
8070	If USB functionality is not available in the given edition of
8071	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8072	</note>
8073	</desc>
8074	</attribute>
8075
8076	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
8077	<desc>
8078	List of USB device filters in action.
8079	When a new device is physically attached to the host computer,
8080	filters from this list are applied to it (in order they are stored
8081	in the list). The first matched filter will determine the
8082	<link to="IHostUSBDeviceFilter::action">action</link>
8083	performed on the device.
8084
8085	Unless the device is ignored by these filters, filters of all
8086	currently running virtual machines
8087	(<link to="IUSBController::deviceFilters"/>) are applied to it.
8088
8089	<note>
8090	If USB functionality is not available in the given edition of
8091	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8092	</note>
8093
8094	<see><link to="IHostUSBDeviceFilter"/>,
8095	<link to="USBDeviceState"/></see>
8096	</desc>
8097	</attribute>
8098
8099	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
8100	<desc>List of host network interfaces currently defined on the host.</desc>
8101	</attribute>
8102
8103	<attribute name="processorCount" type="unsigned long" readonly="yes">
8104	<desc>Number of (logical) CPUs installed in the host system.</desc>
8105	</attribute>
8106
8107	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
8108	<desc>Number of (logical) CPUs online in the host system.</desc>
8109	</attribute>
8110
8111	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
8112	<desc>Number of physical processor cores installed in the host system.</desc>
8113	</attribute>
8114
8115	<method name="getProcessorSpeed">
8116	<desc>Query the (approximate) maximum speed of a specified host CPU in
8117	Megahertz.
8118	</desc>
8119	<param name="cpuId" type="unsigned long" dir="in">
8120	<desc>
8121	Identifier of the CPU.
8122	</desc>
8123	</param>
8124	<param name="speed" type="unsigned long" dir="return">
8125	<desc>
8126	Speed value. 0 is returned if value is not known or @a cpuId is
8127	invalid.
8128	</desc>
8129	</param>
8130	</method>
8131
8132	<method name="getProcessorFeature">
8133	<desc>Query whether a CPU feature is supported or not.</desc>
8134	<param name="feature" type="ProcessorFeature" dir="in">
8135	<desc>
8136	CPU Feature identifier.
8137	</desc>
8138	</param>
8139	<param name="supported" type="boolean" dir="return">
8140	<desc>
8141	Feature is supported or not.
8142	</desc>
8143	</param>
8144	</method>
8145
8146	<method name="getProcessorDescription">
8147	<desc>Query the model string of a specified host CPU.
8148	</desc>
8149	<param name="cpuId" type="unsigned long" dir="in">
8150	<desc>
8151	Identifier of the CPU.
8152	<note>
8153	The current implementation might not necessarily return the
8154	description for this exact CPU.
8155	</note>
8156	</desc>
8157	</param>
8158	<param name="description" type="wstring" dir="return">
8159	<desc>
8160	Model string. An empty string is returned if value is not known or
8161	@a cpuId is invalid.
8162	</desc>
8163	</param>
8164	</method>
8165
8166	<method name="getProcessorCPUIDLeaf">
8167	<desc>
8168	Returns the CPU cpuid information for the specified leaf.
8169	</desc>
8170	<param name="cpuId" type="unsigned long" dir="in">
8171	<desc>
8172	Identifier of the CPU. The CPU most be online.
8173	<note>
8174	The current implementation might not necessarily return the
8175	description for this exact CPU.
8176	</note>
8177	</desc>
8178	</param>
8179	<param name="leaf" type="unsigned long" dir="in">
8180	<desc>
8181	CPUID leaf index (eax).
8182	</desc>
8183	</param>
8184	<param name="subLeaf" type="unsigned long" dir="in">
8185	<desc>
8186	CPUID leaf sub index (ecx). This currently only applies to cache
8187	information on Intel CPUs. Use 0 if retrieving values for
8188	<link to="IMachine::setCPUIDLeaf"/>.
8189	</desc>
8190	</param>
8191	<param name="valEax" type="unsigned long" dir="out">
8192	<desc>
8193	CPUID leaf value for register eax.
8194	</desc>
8195	</param>
8196	<param name="valEbx" type="unsigned long" dir="out">
8197	<desc>
8198	CPUID leaf value for register ebx.
8199	</desc>
8200	</param>
8201	<param name="valEcx" type="unsigned long" dir="out">
8202	<desc>
8203	CPUID leaf value for register ecx.
8204	</desc>
8205	</param>
8206	<param name="valEdx" type="unsigned long" dir="out">
8207	<desc>
8208	CPUID leaf value for register edx.
8209	</desc>
8210	</param>
8211	</method>
8212
8213	<attribute name="memorySize" type="unsigned long" readonly="yes">
8214	<desc>Amount of system memory in megabytes installed in the host system.</desc>
8215	</attribute>
8216
8217	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
8218	<desc>Available system memory in the host system.</desc>
8219	</attribute>
8220
8221	<attribute name="operatingSystem" type="wstring" readonly="yes">
8222	<desc>Name of the host system's operating system.</desc>
8223	</attribute>
8224
8225	<attribute name="OSVersion" type="wstring" readonly="yes">
8226	<desc>Host operating system's version string.</desc>
8227	</attribute>
8228
8229	<attribute name="UTCTime" type="long long" readonly="yes">
8230	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
8231	</attribute>
8232
8233	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
8234	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
8235	</attribute>
8236
8237	<method name="createHostOnlyNetworkInterface">
8238	<desc>
8239	Creates a new adapter for Host Only Networking.
8240	<result name="E_INVALIDARG">
8241	Host network interface @a name already exists.
8242	</result>
8243	</desc>
8244	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
8245	<desc>
8246	Created host interface object.
8247	</desc>
8248	</param>
8249	<param name="progress" type="IProgress" dir="return">
8250	<desc>
8251	Progress object to track the operation completion.
8252	</desc>
8253	</param>
8254	</method>
8255
8256	<method name="removeHostOnlyNetworkInterface">
8257	<desc>
8258	Removes the given Host Only Networking interface.
8259	<result name="VBOX_E_OBJECT_NOT_FOUND">
8260	No host network interface matching @a id found.
8261	</result>
8262	</desc>
8263	<param name="id" type="uuid" mod="string" dir="in">
8264	<desc>
8265	Adapter GUID.
8266	</desc>
8267	</param>
8268	<param name="progress" type="IProgress" dir="return">
8269	<desc>
8270	Progress object to track the operation completion.
8271	</desc>
8272	</param>
8273	</method>
8274
8275	<method name="createUSBDeviceFilter">
8276	<desc>
8277	Creates a new USB device filter. All attributes except
8278	the filter name are set to empty (any match),
8279	<i>active</i> is @c false (the filter is not active).
8280
8281	The created filter can be added to the list of filters using
8282	<link to="#insertUSBDeviceFilter"/>.
8283
8284	<see><link to="#USBDeviceFilters"/></see>
8285	</desc>
8286	<param name="name" type="wstring" dir="in">
8287	<desc>
8288	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8289	</desc>
8290	</param>
8291	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8292	<desc>Created filter object.</desc>
8293	</param>
8294	</method>
8295
8296	<method name="insertUSBDeviceFilter">
8297	<desc>
8298	Inserts the given USB device to the specified position
8299	in the list of filters.
8300
8301	Positions are numbered starting from @c 0. If the specified
8302	position is equal to or greater than the number of elements in
8303	the list, the filter is added at the end of the collection.
8304
8305	<note>
8306	Duplicates are not allowed, so an attempt to insert a
8307	filter already in the list is an error.
8308	</note>
8309	<note>
8310	If USB functionality is not available in the given edition of
8311	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8312	</note>
8313
8314	<see><link to="#USBDeviceFilters"/></see>
8315
8316	<result name="VBOX_E_INVALID_OBJECT_STATE">
8317	USB device filter is not created within this VirtualBox instance.
8318	</result>
8319	<result name="E_INVALIDARG">
8320	USB device filter already in list.
8321	</result>
8322
8323	</desc>
8324	<param name="position" type="unsigned long" dir="in">
8325	<desc>Position to insert the filter to.</desc>
8326	</param>
8327	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8328	<desc>USB device filter to insert.</desc>
8329	</param>
8330	</method>
8331
8332	<method name="removeUSBDeviceFilter">
8333	<desc>
8334	Removes a USB device filter from the specified position in the
8335	list of filters.
8336
8337	Positions are numbered starting from @c 0. Specifying a
8338	position equal to or greater than the number of elements in
8339	the list will produce an error.
8340
8341	<note>
8342	If USB functionality is not available in the given edition of
8343	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8344	</note>
8345
8346	<see><link to="#USBDeviceFilters"/></see>
8347
8348	<result name="E_INVALIDARG">
8349	USB device filter list empty or invalid @a position.
8350	</result>
8351
8352	</desc>
8353	<param name="position" type="unsigned long" dir="in">
8354	<desc>Position to remove the filter from.</desc>
8355	</param>
8356	</method>
8357
8358	<method name="findHostDVDDrive">
8359	<desc>
8360	Searches for a host DVD drive with the given @c name.
8361
8362	<result name="VBOX_E_OBJECT_NOT_FOUND">
8363	Given @c name does not correspond to any host drive.
8364	</result>
8365
8366	</desc>
8367	<param name="name" type="wstring" dir="in">
8368	<desc>Name of the host drive to search for</desc>
8369	</param>
8370	<param name="drive" type="IMedium" dir="return">
8371	<desc>Found host drive object</desc>
8372	</param>
8373	</method>
8374
8375	<method name="findHostFloppyDrive">
8376	<desc>
8377	Searches for a host floppy drive with the given @c name.
8378
8379	<result name="VBOX_E_OBJECT_NOT_FOUND">
8380	Given @c name does not correspond to any host floppy drive.
8381	</result>
8382
8383	</desc>
8384	<param name="name" type="wstring" dir="in">
8385	<desc>Name of the host floppy drive to search for</desc>
8386	</param>
8387	<param name="drive" type="IMedium" dir="return">
8388	<desc>Found host floppy drive object</desc>
8389	</param>
8390	</method>
8391
8392	<method name="findHostNetworkInterfaceByName">
8393	<desc>
8394	Searches through all host network interfaces for an interface with
8395	the given @c name.
8396	<note>
8397	The method returns an error if the given @c name does not
8398	correspond to any host network interface.
8399	</note>
8400	</desc>
8401	<param name="name" type="wstring" dir="in">
8402	<desc>Name of the host network interface to search for.</desc>
8403	</param>
8404	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8405	<desc>Found host network interface object.</desc>
8406	</param>
8407	</method>
8408	<method name="findHostNetworkInterfaceById">
8409	<desc>
8410	Searches through all host network interfaces for an interface with
8411	the given GUID.
8412	<note>
8413	The method returns an error if the given GUID does not
8414	correspond to any host network interface.
8415	</note>
8416	</desc>
8417	<param name="id" type="uuid" mod="string" dir="in">
8418	<desc>GUID of the host network interface to search for.</desc>
8419	</param>
8420	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8421	<desc>Found host network interface object.</desc>
8422	</param>
8423	</method>
8424	<method name="findHostNetworkInterfacesOfType">
8425	<desc>
8426	Searches through all host network interfaces and returns a list of interfaces of the specified type
8427	</desc>
8428	<param name="type" type="HostNetworkInterfaceType" dir="in">
8429	<desc>type of the host network interfaces to search for.</desc>
8430	</param>
8431	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8432	<desc>Found host network interface objects.</desc>
8433	</param>
8434	</method>
8435
8436	<method name="findUSBDeviceById">
8437	<desc>
8438	Searches for a USB device with the given UUID.
8439
8440	<result name="VBOX_E_OBJECT_NOT_FOUND">
8441	Given @c id does not correspond to any USB device.
8442	</result>
8443
8444	<see><link to="IUSBDevice::id"/></see>
8445	</desc>
8446	<param name="id" type="uuid" mod="string" dir="in">
8447	<desc>UUID of the USB device to search for.</desc>
8448	</param>
8449	<param name="device" type="IHostUSBDevice" dir="return">
8450	<desc>Found USB device object.</desc>
8451	</param>
8452	</method>
8453
8454	<method name="findUSBDeviceByAddress">
8455	<desc>
8456	Searches for a USB device with the given host address.
8457
8458	<result name="VBOX_E_OBJECT_NOT_FOUND">
8459	Given @c name does not correspond to any USB device.
8460	</result>
8461
8462	<see><link to="IUSBDevice::address"/></see>
8463	</desc>
8464	<param name="name" type="wstring" dir="in">
8465	<desc>
8466	Address of the USB device (as assigned by the host) to
8467	search for.
8468	</desc>
8469	</param>
8470	<param name="device" type="IHostUSBDevice" dir="return">
8471	<desc>Found USB device object.</desc>
8472	</param>
8473	</method>
8474
8475	<method name="generateMACAddress">
8476	<desc>
8477	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8478	</desc>
8479	<param name="address" type="wstring" dir="return">
8480	<desc>New Ethernet MAC address.</desc>
8481	</param>
8482	</method>
8483
8484	</interface>
8485
8486	<!--
8487	// ISystemProperties
8488	/////////////////////////////////////////////////////////////////////////
8489	-->
8490
8491	<interface
8492	name="ISystemProperties"
8493	extends="$unknown"
8494	uuid="55699910-cc50-11e2-8b8b-0800200c9a66"
8495	wsmap="managed"
8496	>
8497	<desc>
8498	The ISystemProperties interface represents global properties of the given
8499	VirtualBox installation.
8500
8501	These properties define limits and default values for various attributes
8502	and parameters. Most of the properties are read-only, but some can be
8503	changed by a user.
8504	</desc>
8505
8506	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8507	<desc>Minimum guest system memory in Megabytes.</desc>
8508	</attribute>
8509
8510	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8511	<desc>Maximum guest system memory in Megabytes.</desc>
8512	</attribute>
8513
8514	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8515	<desc>Minimum guest video memory in Megabytes.</desc>
8516	</attribute>
8517
8518	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8519	<desc>Maximum guest video memory in Megabytes.</desc>
8520	</attribute>
8521
8522	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8523	<desc>Minimum CPU count.</desc>
8524	</attribute>
8525
8526	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8527	<desc>Maximum CPU count.</desc>
8528	</attribute>
8529
8530	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8531	<desc>Maximum of monitors which could be connected.</desc>
8532	</attribute>
8533
8534	<attribute name="infoVDSize" type="long long" readonly="yes">
8535	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8536	does not reflect the limits of any virtual disk image format.</desc>
8537	</attribute>
8538
8539	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8540	<desc>
8541	Maximum number of serial ports associated with every
8542	<link to="IMachine"/> instance.
8543	</desc>
8544	</attribute>
8545
8546	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8547	<desc>
8548	Maximum number of parallel ports associated with every
8549	<link to="IMachine"/> instance.
8550	</desc>
8551	</attribute>
8552
8553	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8554	<desc>
8555	Maximum device position in the boot order. This value corresponds
8556	to the total number of devices a machine can boot from, to make it
8557	possible to include all possible devices to the boot list.
8558	<see><link to="IMachine::setBootOrder"/></see>
8559	</desc>
8560	</attribute>
8561
8562	<attribute name="defaultMachineFolder" type="wstring">
8563	<desc>
8564	Full path to the default directory used to create new or open
8565	existing machines when a machine settings file name contains no
8566	path.
8567
8568	Starting with VirtualBox 4.0, by default, this attribute contains
8569	the full path of folder named "VirtualBox VMs" in the user's
8570	home directory, which depends on the host platform.
8571
8572	When setting this attribute, a full path must be specified.
8573	Setting this property to @c null or an empty string or the
8574	special value "Machines" (for compatibility reasons) will restore
8575	that default value.
8576
8577	If the folder specified herein does not exist, it will be created
8578	automatically as needed.
8579
8580	<see>
8581	<link to="IVirtualBox::createMachine"/>,
8582	<link to="IVirtualBox::openMachine"/>
8583	</see>
8584	</desc>
8585	</attribute>
8586
8587	<attribute name="loggingLevel" type="wstring">
8588	<desc>
8589	Specifies the logging level in current use by VirtualBox.
8590	</desc>
8591	</attribute>
8592
8593	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8594	<desc>
8595	List of all medium storage formats supported by this VirtualBox
8596	installation.
8597
8598	Keep in mind that the medium format identifier
8599	(<link to="IMediumFormat::id"/>) used in other API calls like
8600	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8601	medium format is a case-insensitive string. This means that, for
8602	example, all of the following strings:
8603	<pre>
8604	"VDI"
8605	"vdi"
8606	"VdI"</pre>
8607	refer to the same medium format.
8608
8609	Note that the virtual medium framework is backend-based, therefore
8610	the list of supported formats depends on what backends are currently
8611	installed.
8612
8613	<see><link to="IMediumFormat"/></see>
8614	</desc>
8615	</attribute>
8616
8617	<attribute name="defaultHardDiskFormat" type="wstring">
8618	<desc>
8619	Identifier of the default medium format used by VirtualBox.
8620
8621	The medium format set by this attribute is used by VirtualBox
8622	when the medium format was not specified explicitly. One example is
8623	<link to="IVirtualBox::createHardDisk"/> with the empty
8624	format argument. A more complex example is implicit creation of
8625	differencing media when taking a snapshot of a virtual machine:
8626	this operation will try to use a format of the parent medium first
8627	and if this format does not support differencing media the default
8628	format specified by this argument will be used.
8629
8630	The list of supported medium formats may be obtained by the
8631	<link to="#mediumFormats"/> call. Note that the default medium
8632	format must have a capability to create differencing media;
8633	otherwise operations that create media implicitly may fail
8634	unexpectedly.
8635
8636	The initial value of this property is <tt>"VDI"</tt> in the current
8637	version of the VirtualBox product, but may change in the future.
8638
8639	<note>
8640	Setting this property to @c null or empty string will restore the
8641	initial value.
8642	</note>
8643
8644	<see>
8645	<link to="#mediumFormats"/>,
8646	<link to="IMediumFormat::id"/>,
8647	<link to="IVirtualBox::createHardDisk"/>
8648	</see>
8649	</desc>
8650	</attribute>
8651
8652	<attribute name="freeDiskSpaceWarning" type="long long">
8653	<desc>Issue a warning if the free disk space is below (or in some disk
8654	intensive operation is expected to go below) the given size in
8655	bytes.</desc>
8656	</attribute>
8657
8658	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8659	<desc>Issue a warning if the free disk space is below (or in some disk
8660	intensive operation is expected to go below) the given percentage.</desc>
8661	</attribute>
8662
8663	<attribute name="freeDiskSpaceError" type="long long">
8664	<desc>Issue an error if the free disk space is below (or in some disk
8665	intensive operation is expected to go below) the given size in
8666	bytes.</desc>
8667	</attribute>
8668
8669	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8670	<desc>Issue an error if the free disk space is below (or in some disk
8671	intensive operation is expected to go below) the given percentage.</desc>
8672	</attribute>
8673
8674	<attribute name="VRDEAuthLibrary" type="wstring">
8675	<desc>
8676	Library that provides authentication for Remote Desktop clients. The library
8677	is used if a virtual machine's authentication type is set to "external"
8678	in the VM RemoteDisplay configuration.
8679
8680	The system library extension (".DLL" or ".so") must be omitted.
8681	A full path can be specified; if not, then the library must reside on the
8682	system's default library path.
8683
8684	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8685	of that name in one of the default VirtualBox library directories.
8686
8687	For details about VirtualBox authentication libraries and how to implement
8688	them, please refer to the VirtualBox manual.
8689
8690	<note>
8691	Setting this property to @c null or empty string will restore the
8692	initial value.
8693	</note>
8694	</desc>
8695	</attribute>
8696
8697	<attribute name="webServiceAuthLibrary" type="wstring">
8698	<desc>
8699	Library that provides authentication for webservice clients. The library
8700	is used if a virtual machine's authentication type is set to "external"
8701	in the VM RemoteDisplay configuration and will be called from
8702	within the <link to="IWebsessionManager::logon" /> implementation.
8703
8704	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8705	there is no per-VM setting for this, as the webservice is a global
8706	resource (if it is running). Only for this setting (for the webservice),
8707	setting this value to a literal <tt>"null"</tt> string disables authentication,
8708	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8709	no matter what user name and password are supplied.
8710
8711	The initial value of this property is <tt>"VBoxAuth"</tt>,
8712	meaning that the webservice will use the same authentication
8713	library that is used by default for VRDE (again, see
8714	<link to="ISystemProperties::VRDEAuthLibrary" />).
8715	The format and calling convention of authentication libraries
8716	is the same for the webservice as it is for VRDE.
8717
8718	<note>
8719	Setting this property to @c null or empty string will restore the
8720	initial value.
8721	</note>
8722	</desc>
8723	</attribute>
8724
8725	<attribute name="defaultVRDEExtPack" type="wstring">
8726	<desc>
8727	The name of the extension pack providing the default VRDE.
8728
8729	This attribute is for choosing between multiple extension packs
8730	providing VRDE. If only one is installed, it will automatically be the
8731	default one. The attribute value can be empty if no VRDE extension
8732	pack is installed.
8733
8734	For details about VirtualBox Remote Desktop Extension and how to
8735	implement one, please refer to the VirtualBox SDK.
8736	</desc>
8737	</attribute>
8738
8739	<attribute name="logHistoryCount" type="unsigned long">
8740	<desc>
8741	This value specifies how many old release log files are kept.
8742	</desc>
8743	</attribute>
8744
8745	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8746	<desc>This value hold the default audio driver for the current
8747	system.</desc>
8748	</attribute>
8749
8750	<attribute name="autostartDatabasePath" type="wstring">
8751	<desc>
8752	The path to the autostart database. Depending on the host this might
8753	be a filesystem path or something else.
8754	</desc>
8755	</attribute>
8756
8757	<attribute name="defaultAdditionsISO" type="wstring">
8758	<desc>
8759	The path to the default Guest Additions ISO image. Can be empty if
8760	the location is not known in this installation.
8761	</desc>
8762	</attribute>
8763
8764	<attribute name="defaultFrontend" type="wstring">
8765	<desc>
8766	Selects which VM frontend should be used by default when launching
8767	a VM through the <link to="IMachine::launchVMProcess" /> method.
8768	Empty or @c null strings do not define a particular default, it is up
8769	to <link to="IMachine::launchVMProcess" /> to select one. See the
8770	description of <link to="IMachine::launchVMProcess" /> for the valid
8771	frontend types.
8772
8773	This global setting is overridden by the per-VM attribute
8774	<link to="IMachine::defaultFrontend" /> or a frontend type
8775	passed to <link to="IMachine::launchVMProcess" />.
8776	</desc>
8777	</attribute>
8778
8779	<method name="getMaxNetworkAdapters">
8780	<desc>
8781	Maximum total number of network adapters associated with every
8782	<link to="IMachine"/> instance.
8783	</desc>
8784
8785	<param name="chipset" type="ChipsetType" dir="in">
8786	<desc>The chipset type to get the value for.</desc>
8787	</param>
8788
8789
8790	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8791	<desc>The maximum total number of network adapters allowed.</desc>
8792	</param>
8793
8794	</method>
8795
8796	<method name="getMaxNetworkAdaptersOfType">
8797	<desc>
8798	Maximum number of network adapters of a given attachment type,
8799	associated with every <link to="IMachine"/> instance.
8800	</desc>
8801
8802	<param name="chipset" type="ChipsetType" dir="in">
8803	<desc>The chipset type to get the value for.</desc>
8804	</param>
8805
8806	<param name="type" type="NetworkAttachmentType" dir="in">
8807	<desc>Type of attachment.</desc>
8808	</param>
8809
8810	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8811	<desc>The maximum number of network adapters allowed for
8812	particular chipset and attachment type.</desc>
8813	</param>
8814
8815	</method>
8816
8817
8818	<method name="getMaxDevicesPerPortForStorageBus">
8819	<desc>Returns the maximum number of devices which can be attached to a port
8820	for the given storage bus.</desc>
8821
8822	<param name="bus" type="StorageBus" dir="in">
8823	<desc>The storage bus type to get the value for.</desc>
8824	</param>
8825
8826	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8827	<desc>The maximum number of devices which can be attached to the port for the given
8828	storage bus.</desc>
8829	</param>
8830	</method>
8831
8832	<method name="getMinPortCountForStorageBus">
8833	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8834
8835	<param name="bus" type="StorageBus" dir="in">
8836	<desc>The storage bus type to get the value for.</desc>
8837	</param>
8838
8839	<param name="minPortCount" type="unsigned long" dir="return">
8840	<desc>The minimum number of ports for the given storage bus.</desc>
8841	</param>
8842	</method>
8843
8844	<method name="getMaxPortCountForStorageBus">
8845	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8846
8847	<param name="bus" type="StorageBus" dir="in">
8848	<desc>The storage bus type to get the value for.</desc>
8849	</param>
8850
8851	<param name="maxPortCount" type="unsigned long" dir="return">
8852	<desc>The maximum number of ports for the given storage bus.</desc>
8853	</param>
8854	</method>
8855
8856	<method name="getMaxInstancesOfStorageBus">
8857	<desc>Returns the maximum number of storage bus instances which
8858	can be configured for each VM. This corresponds to the number of
8859	storage controllers one can have. Value may depend on chipset type
8860	used.</desc>
8861
8862	<param name="chipset" type="ChipsetType" dir="in">
8863	<desc>The chipset type to get the value for.</desc>
8864	</param>
8865
8866	<param name="bus" type="StorageBus" dir="in">
8867	<desc>The storage bus type to get the value for.</desc>
8868	</param>
8869
8870	<param name="maxInstances" type="unsigned long" dir="return">
8871	<desc>The maximum number of instances for the given storage bus.</desc>
8872	</param>
8873	</method>
8874
8875	<method name="getDeviceTypesForStorageBus">
8876	<desc>Returns list of all the supported device types
8877	(<link to="DeviceType"/>) for the given type of storage
8878	bus.</desc>
8879
8880	<param name="bus" type="StorageBus" dir="in">
8881	<desc>The storage bus type to get the value for.</desc>
8882	</param>
8883
8884	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8885	<desc>The list of all supported device types for the given storage bus.</desc>
8886	</param>
8887	</method>
8888
8889	<method name="getDefaultIoCacheSettingForStorageController">
8890	<desc>Returns the default I/O cache setting for the
8891	given storage controller</desc>
8892
8893	<param name="controllerType" type="StorageControllerType" dir="in">
8894	<desc>The storage controller to the setting for.</desc>
8895	</param>
8896
8897	<param name="enabled" type="boolean" dir="return">
8898	<desc>Returned flag indicating the default value</desc>
8899	</param>
8900	</method>
8901	</interface>
8902
8903	<!--
8904	// IGuest
8905	/////////////////////////////////////////////////////////////////////////
8906	-->
8907
8908	<interface
8909	name="IGuestOSType" extends="$unknown"
8910	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8911	wsmap="struct"
8912	>
8913	<desc>
8914	</desc>
8915
8916	<attribute name="familyId" type="wstring" readonly="yes">
8917	<desc>Guest OS family identifier string.</desc>
8918	</attribute>
8919
8920	<attribute name="familyDescription" type="wstring" readonly="yes">
8921	<desc>Human readable description of the guest OS family.</desc>
8922	</attribute>
8923
8924	<attribute name="id" type="wstring" readonly="yes">
8925	<desc>Guest OS identifier string.</desc>
8926	</attribute>
8927
8928	<attribute name="description" type="wstring" readonly="yes">
8929	<desc>Human readable description of the guest OS.</desc>
8930	</attribute>
8931
8932	<attribute name="is64Bit" type="boolean" readonly="yes">
8933	<desc>Returns @c true if the given OS is 64-bit</desc>
8934	</attribute>
8935
8936	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8937	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8938	</attribute>
8939
8940	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8941	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8942	</attribute>
8943
8944	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8945	<desc>Recommended RAM size in Megabytes.</desc>
8946	</attribute>
8947
8948	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8949	<desc>Recommended video RAM size in Megabytes.</desc>
8950	</attribute>
8951
8952	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8953	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8954	</attribute>
8955
8956	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8957	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8958	</attribute>
8959
8960	<attribute name="recommendedHDD" type="long long" readonly="yes">
8961	<desc>Recommended hard disk size in bytes.</desc>
8962	</attribute>
8963
8964	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8965	<desc>Returns recommended network adapter for this OS type.</desc>
8966	</attribute>
8967
8968	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8969	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8970	</attribute>
8971
8972	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8973	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8974	</attribute>
8975
8976	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8977	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8978	</attribute>
8979
8980	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8981	<desc>Recommended storage controller type for HD drives.</desc>
8982	</attribute>
8983
8984	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8985	<desc>Recommended storage bus type for HD drives.</desc>
8986	</attribute>
8987
8988	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8989	<desc>Recommended firmware type.</desc>
8990	</attribute>
8991
8992	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8993	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8994	</attribute>
8995
8996	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8997	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8998	</attribute>
8999
9000	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
9001	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
9002	</attribute>
9003
9004	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
9005	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
9006	</attribute>
9007
9008	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
9009	<desc>Recommended chipset type.</desc>
9010	</attribute>
9011
9012	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
9013	<desc>Recommended audio type.</desc>
9014	</attribute>
9015
9016	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
9017	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
9018	</attribute>
9019
9020	<attribute name="recommendedUSB" type="boolean" readonly="yes">
9021	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
9022	</attribute>
9023
9024	</interface>
9025
9026	<enum
9027	name="AdditionsFacilityType"
9028	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
9029	>
9030	<desc>
9031	Guest Additions facility IDs.
9032	</desc>
9033
9034	<const name="None" value="0">
9035	<desc>No/invalid facility.</desc>
9036	</const>
9037	<const name="VBoxGuestDriver" value="20">
9038	<desc>VirtualBox base driver (VBoxGuest).</desc>
9039	</const>
9040	<const name="AutoLogon" value="90">
9041	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
9042	</const>
9043	<const name="VBoxService" value="100">
9044	<desc>VirtualBox system service (VBoxService).</desc>
9045	</const>
9046	<const name="VBoxTrayClient" value="101">
9047	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
9048	</const>
9049	<const name="Seamless" value="1000">
9050	<desc>Seamless guest desktop integration.</desc>
9051	</const>
9052	<const name="Graphics" value="1100">
9053	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
9054	are not immediately acted on and guest display resizes are probably not initiated by
9055	the guest additions.
9056	</desc>
9057	</const>
9058	<const name="All" value="2147483646">
9059	<desc>All facilities selected.</desc>
9060	</const>
9061	</enum>
9062
9063	<enum
9064	name="AdditionsFacilityClass"
9065	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
9066	>
9067	<desc>
9068	Guest Additions facility classes.
9069	</desc>
9070
9071	<const name="None" value="0">
9072	<desc>No/invalid class.</desc>
9073	</const>
9074	<const name="Driver" value="10">
9075	<desc>Driver.</desc>
9076	</const>
9077	<const name="Service" value="30">
9078	<desc>System service.</desc>
9079	</const>
9080	<const name="Program" value="50">
9081	<desc>Program.</desc>
9082	</const>
9083	<const name="Feature" value="100">
9084	<desc>Feature.</desc>
9085	</const>
9086	<const name="ThirdParty" value="999">
9087	<desc>Third party.</desc>
9088	</const>
9089	<const name="All" value="2147483646">
9090	<desc>All facility classes selected.</desc>
9091	</const>
9092	</enum>
9093
9094	<enum
9095	name="AdditionsFacilityStatus"
9096	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
9097	>
9098	<desc>
9099	Guest Additions facility states.
9100	</desc>
9101
9102	<const name="Inactive" value="0">
9103	<desc>Facility is not active.</desc>
9104	</const>
9105	<const name="Paused" value="1">
9106	<desc>Facility has been paused.</desc>
9107	</const>
9108	<const name="PreInit" value="20">
9109	<desc>Facility is preparing to initialize.</desc>
9110	</const>
9111	<const name="Init" value="30">
9112	<desc>Facility is initializing.</desc>
9113	</const>
9114	<const name="Active" value="50">
9115	<desc>Facility is up and running.</desc>
9116	</const>
9117	<const name="Terminating" value="100">
9118	<desc>Facility is shutting down.</desc>
9119	</const>
9120	<const name="Terminated" value="101">
9121	<desc>Facility successfully shut down.</desc>
9122	</const>
9123	<const name="Failed" value="800">
9124	<desc>Facility failed to start.</desc>
9125	</const>
9126	<const name="Unknown" value="999">
9127	<desc>Facility status is unknown.</desc>
9128	</const>
9129	</enum>
9130
9131	<interface
9132	name="IAdditionsFacility" extends="$unknown"
9133	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
9134	wsmap="struct"
9135	>
9136	<desc>
9137	Structure representing a Guest Additions facility.
9138	</desc>
9139
9140	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
9141	<desc>The class this facility is part of.</desc>
9142	</attribute>
9143
9144	<attribute name="lastUpdated" type="long long" readonly="yes">
9145	<desc>
9146	Time stamp of the last status update,
9147	in milliseconds since 1970-01-01 UTC.
9148	</desc>
9149	</attribute>
9150
9151	<attribute name="name" type="wstring" readonly="yes">
9152	<desc>The facility's friendly name.</desc>
9153	</attribute>
9154
9155	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
9156	<desc>The current status.</desc>
9157	</attribute>
9158
9159	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
9160	<desc>The facility's type ID.</desc>
9161	</attribute>
9162	</interface>
9163
9164	<enum
9165	name="AdditionsRunLevelType"
9166	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
9167	>
9168	<desc>
9169	Guest Additions run level type.
9170	</desc>
9171
9172	<const name="None" value="0">
9173	<desc>Guest Additions are not loaded.</desc>
9174	</const>
9175	<const name="System" value="1">
9176	<desc>Guest drivers are loaded.</desc>
9177	</const>
9178	<const name="Userland" value="2">
9179	<desc>Common components (such as application services) are loaded.</desc>
9180	</const>
9181	<const name="Desktop" value="3">
9182	<desc>Per-user desktop components are loaded.</desc>
9183	</const>
9184	</enum>
9185
9186	<enum
9187	name="AdditionsUpdateFlag"
9188	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
9189	>
9190	<desc>
9191	Guest Additions update flags.
9192	</desc>
9193
9194	<const name="None" value="0">
9195	<desc>No flag set.</desc>
9196	</const>
9197	<const name="WaitForUpdateStartOnly" value="1">
9198	<desc>Starts the regular updating process and waits until the
9199	actual Guest Additions update inside the guest was started.
9200	This can be necessary due to needed interaction with the guest
9201	OS during the installation phase.</desc>
9202	</const>
9203	</enum>
9204
9205	<enum
9206	name="GuestSessionStatus"
9207	uuid="ac2669da-4624-44f2-85b5-0b0bfb8d8673"
9208	>
9209	<desc>
9210	Guest session status. This enumeration represents possible values of
9211	the <link to="IGuestSession::status"/> attribute.
9212	</desc>
9213	<const name="Undefined" value="0">
9214	<desc>Guest session is in an undefined state.</desc>
9215	</const>
9216	<const name="Starting" value="10">
9217	<desc>Guest session is being started.</desc>
9218	</const>
9219	<const name="Started" value="100">
9220	<desc>Guest session has been started.</desc>
9221	</const>
9222	<const name="Terminating" value="480">
9223	<desc>Guest session is being terminated.</desc>
9224	</const>
9225	<const name="Terminated" value="500">
9226	<desc>Guest session terminated normally.</desc>
9227	</const>
9228	<const name="TimedOutKilled" value="512">
9229	<desc>Guest session timed out and was killed.</desc>
9230	</const>
9231	<const name="TimedOutAbnormally" value="513">
9232	<desc>Guest session timed out and was not killed successfully.</desc>
9233	</const>
9234	<const name="Down" value="600">
9235	<desc>Service/OS is stopping, guest session was killed.</desc>
9236	</const>
9237	<const name="Error" value="800">
9238	<desc>Something went wrong.</desc>
9239	</const>
9240	</enum>
9241
9242	<enum
9243	name="GuestSessionWaitForFlag"
9244	uuid="bb7a372a-f635-4e11-a81a-e707f3a52ef5"
9245	>
9246	<desc>
9247	Guest session waiting flags. Multiple flags can be combined.
9248	</desc>
9249
9250	<const name="None" value="0">
9251	<desc>No waiting flags specified. Do not use this.</desc>
9252	</const>
9253	<const name="Start" value="1">
9254	<desc>Wait for the guest session being started.</desc>
9255	</const>
9256	<const name="Terminate" value="2">
9257	<desc>Wait for the guest session being terminated.</desc>
9258	</const>
9259	<const name="Status" value="4">
9260	<desc>Wait for the next guest session status change.</desc>
9261	</const>
9262	</enum>
9263
9264	<enum
9265	name="GuestSessionWaitResult"
9266	uuid="c0f6a8a5-fdb6-42bf-a582-56c6f82bcd2d"
9267	>
9268	<desc>
9269	Guest session waiting results. Depending on the session waiting flags (for
9270	more information see <link to="GuestSessionWaitForFlag"/>) the waiting result
9271	can vary based on the session's current status.
9272
9273	To wait for a guest session to terminate after it has been
9274	created by <link to="IGuest::createSession"/> one would specify
9275	GuestSessionWaitResult_Terminate.
9276	</desc>
9277
9278	<const name="None" value="0">
9279	<desc>No result was returned. Not being used.</desc>
9280	</const>
9281	<const name="Start" value="1">
9282	<desc>The guest session has been started.</desc>
9283	</const>
9284	<const name="Terminate" value="2">
9285	<desc>The guest session has been terminated.</desc>
9286	</const>
9287	<const name="Status" value="3">
9288	<desc>
9289	The guest session has changed its status. The status then can
9290	be retrieved via <link to="IGuestSession::status"/>.
9291	</desc>
9292	</const>
9293	<const name="Error" value="4">
9294	<desc>Error while executing the process.</desc>
9295	</const>
9296	<const name="Timeout" value="5">
9297	<desc>
9298	The waiting operation timed out. This also will happen
9299	when no event has been occured matching the
9300	current waiting flags in a <link to="IGuestSession::waitFor"/> call.
9301	</desc>
9302	</const>
9303	<const name="WaitFlagNotSupported" value="6">
9304	<desc>
9305	A waiting flag specified in the <link to="IGuestSession::waitFor"/> call
9306	is not supported by the guest.
9307	</desc>
9308	</const>
9309	</enum>
9310
9311	<enum
9312	name="FileSeekType"
9313	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
9314	>
9315	<desc>
9316	File seeking types.
9317	</desc>
9318
9319	<const name="Set" value="0">
9320	<desc>Seek from the start of the file.</desc>
9321	</const>
9322	<const name="Current" value="1">
9323	<desc>Seek from the current file position.</desc>
9324	</const>
9325	</enum>
9326
9327	<enum
9328	name="ProcessInputFlag"
9329	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
9330	>
9331	<desc>
9332	Guest process input flags.
9333	</desc>
9334	<const name="None" value="0">
9335	<desc>No flag set.</desc>
9336	</const>
9337	<const name="EndOfFile" value="1">
9338	<desc>End of file (input) reached.</desc>
9339	</const>
9340	</enum>
9341
9342	<enum
9343	name="ProcessOutputFlag"
9344	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
9345	>
9346	<desc>
9347	Guest process output flags for specifying which
9348	type of output to retrieve.
9349	</desc>
9350	<const name="None" value="0">
9351	<desc>No flags set. Get output from stdout.</desc>
9352	</const>
9353	<const name="StdErr" value="1">
9354	<desc>Get output from stderr.</desc>
9355	</const>
9356	</enum>
9357
9358	<enum
9359	name="ProcessWaitForFlag"
9360	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
9361	>
9362	<desc>
9363	Process waiting flags. Multiple flags can be combined.
9364	</desc>
9365
9366	<const name="None" value="0">
9367	<desc>No waiting flags specified. Do not use this.</desc>
9368	</const>
9369	<const name="Start" value="1">
9370	<desc>Wait for the process being started.</desc>
9371	</const>
9372	<const name="Terminate" value="2">
9373	<desc>Wait for the process being terminated.</desc>
9374	</const>
9375	<const name="StdIn" value="4">
9376	<desc>Wait for stdin becoming available.</desc>
9377	</const>
9378	<const name="StdOut" value="8">
9379	<desc>Wait for data becoming available on stdout.</desc>
9380	</const>
9381	<const name="StdErr" value="16">
9382	<desc>Wait for data becoming available on stderr.</desc>
9383	</const>
9384	</enum>
9385
9386	<enum
9387	name="ProcessWaitResult"
9388	uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
9389	>
9390	<desc>
9391	Process waiting results. Depending on the process waiting flags (for
9392	more information see <link to="ProcessWaitForFlag"/>) the waiting result
9393	can vary based on the processes' current status.
9394
9395	To wait for a guest process to terminate after it has been
9396	created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9397	one would specify ProcessWaitResult_Terminate.
9398
9399	If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9400	a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9401	stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9402	ProcessWaitResult_StdErr.
9403	</desc>
9404
9405	<const name="None" value="0">
9406	<desc>No result was returned. Not being used.</desc>
9407	</const>
9408	<const name="Start" value="1">
9409	<desc>The process has been started.</desc>
9410	</const>
9411	<const name="Terminate" value="2">
9412	<desc>The process has been terminated.</desc>
9413	</const>
9414	<const name="Status" value="3">
9415	<desc>
9416	The process has changed its status. The status then can
9417	be retrieved via <link to="IProcess::status"/>.
9418	</desc>
9419	</const>
9420	<const name="Error" value="4">
9421	<desc>Error while executing the process.</desc>
9422	</const>
9423	<const name="Timeout" value="5">
9424	<desc>
9425	The waiting operation timed out. This also will happen
9426	when no event has been occured matching the
9427	current waiting flags in a <link to="IProcess::waitFor"/> call.
9428	</desc>
9429	</const>
9430	<const name="StdIn" value="6">
9431	<desc>
9432	The process signalled that stdin became available for writing
9433	and that the process awaits input now.</desc>
9434	</const>
9435	<const name="StdOut" value="7">
9436	<desc>Data on stdout became available for reading.</desc>
9437	</const>
9438	<const name="StdErr" value="8">
9439	<desc>Data on stderr became available for reading.</desc>
9440	</const>
9441	<const name="WaitFlagNotSupported" value="9">
9442	<desc>
9443	A waiting flag specified in the <link to="IProcess::waitFor"/> call
9444	is not supported by the guest.
9445	</desc>
9446	</const>
9447	</enum>
9448
9449	<enum
9450	name="CopyFileFlag"
9451	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9452	>
9453	<desc>
9454	File copying flags.
9455	</desc>
9456	<const name="None" value="0">
9457	<desc>No flag set.</desc>
9458	</const>
9459	<const name="Recursive" value="1">
9460	<desc>Copy directories recursively.</desc>
9461	</const>
9462	<const name="Update" value="2">
9463	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9464	</const>
9465	<const name="FollowLinks" value="4">
9466	<desc>Follow symbolic links.</desc>
9467	</const>
9468	</enum>
9469
9470	<enum
9471	name="DirectoryCreateFlag"
9472	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9473	>
9474	<desc>
9475	Directory creation flags.
9476	</desc>
9477	<const name="None" value="0">
9478	<desc>No flag set.</desc>
9479	</const>
9480	<const name="Parents" value="1">
9481	<desc>No error if existing, make parent directories as needed.</desc>
9482	</const>
9483	</enum>
9484
9485	<enum
9486	name="DirectoryRemoveRecFlag"
9487	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9488	>
9489	<desc>
9490	Directory recursive removement flags.
9491	</desc>
9492
9493	<const name="None" value="0">
9494	<desc>No flag set.</desc>
9495	</const>
9496	<const name="ContentAndDir" value="1">
9497	<desc>Delete the content of the directory and the directory itself.</desc>
9498	</const>
9499	<const name="ContentOnly" value="2">
9500	<desc>Only delete the content of the directory, omit the directory it self.</desc>
9501	</const>
9502	</enum>
9503
9504	<enum
9505	name="PathRenameFlag"
9506	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9507	>
9508	<desc>
9509	Path renaming flags.
9510	</desc>
9511
9512	<const name="None" value="0">
9513	<desc>No flag set.</desc>
9514	</const>
9515	<const name="NoReplace" value="1">
9516	<desc>Do not replace anything.</desc>
9517	</const>
9518	<const name="Replace" value="2">
9519	<desc>This will replace attempt any target which isn't a directory.</desc>
9520	</const>
9521	<const name="NoSymlinks" value="4">
9522	<desc>Don't allow symbolic links as part of the path.</desc>
9523	</const>
9524	</enum>
9525
9526	<enum
9527	name="ProcessCreateFlag"
9528	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9529	>
9530	<desc>
9531	Guest process execution flags.
9532	</desc>
9533
9534	<const name="None" value="0">
9535	<desc>No flag set.</desc>
9536	</const>
9537	<const name="WaitForProcessStartOnly" value="1">
9538	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9539	process itself then uses an infinite timeout.</desc>
9540	</const>
9541	<const name="IgnoreOrphanedProcesses" value="2">
9542	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9543	</const>
9544	<const name="Hidden" value="4">
9545	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9546	</const>
9547	<const name="NoProfile" value="8">
9548	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9549	</const>
9550	<const name="WaitForStdOut" value="16">
9551	<desc>The guest process waits until all data from stdout is read out.</desc>
9552	</const>
9553	<const name="WaitForStdErr" value="32">
9554	<desc>The guest process waits until all data from stderr is read out.</desc>
9555	</const>
9556	<const name="ExpandArguments" value="64">
9557	<desc>Expands environment variables in process arguments.</desc>
9558	</const>
9559	</enum>
9560
9561	<enum
9562	name="ProcessPriority"
9563	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9564	>
9565	<desc>
9566	Process priorities.
9567	</desc>
9568
9569	<const name="Invalid" value="0">
9570	<desc>Invalid priority, do not use.</desc>
9571	</const>
9572	<const name="Default" value="1">
9573	<desc>Default process priority determined by the OS.</desc>
9574	</const>
9575	</enum>
9576
9577	<enum
9578	name="SymlinkType"
9579	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9580	>
9581	<desc>
9582	Symbolic link types.
9583	</desc>
9584
9585	<const name="Unknown" value="0">
9586	<desc>It is not known what is being targeted.</desc>
9587	</const>
9588	<const name="Directory" value="1">
9589	<desc>The link targets a directory.</desc>
9590	</const>
9591	<const name="File" value="2">
9592	<desc>The link targets a file (or whatever else).</desc>
9593	</const>
9594	</enum>
9595
9596	<enum
9597	name="SymlinkReadFlag"
9598	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9599	>
9600	<desc>
9601	Symbolic link reading flags.
9602	</desc>
9603
9604	<const name="None" value="0">
9605	<desc>No flags set.</desc>
9606	</const>
9607	<const name="NoSymlinks" value="1">
9608	<desc>Don't allow symbolic links as part of the path.</desc>
9609	</const>
9610	</enum>
9611
9612	<enum
9613	name="ProcessStatus"
9614	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9615	>
9616	<desc>
9617	Process execution statuses.
9618	</desc>
9619
9620	<const name="Undefined" value="0">
9621	<desc>Process is in an undefined state.</desc>
9622	</const>
9623	<const name="Starting" value="10">
9624	<desc>Process is being started.</desc>
9625	</const>
9626	<const name="Started" value="100">
9627	<desc>Process has been started.</desc>
9628	</const>
9629	<const name="Paused" value="110">
9630	<desc>Process has been paused.</desc>
9631	</const>
9632	<const name="Terminating" value="480">
9633	<desc>Process is being terminated.</desc>
9634	</const>
9635	<const name="TerminatedNormally" value="500">
9636	<desc>Process terminated normally.</desc>
9637	</const>
9638	<const name="TerminatedSignal" value="510">
9639	<desc>Process terminated via signal.</desc>
9640	</const>
9641	<const name="TerminatedAbnormally" value="511">
9642	<desc>Process terminated abnormally.</desc>
9643	</const>
9644	<const name="TimedOutKilled" value="512">
9645	<desc>Process timed out and was killed.</desc>
9646	</const>
9647	<const name="TimedOutAbnormally" value="513">
9648	<desc>Process timed out and was not killed successfully.</desc>
9649	</const>
9650	<const name="Down" value="600">
9651	<desc>Service/OS is stopping, process was killed.</desc>
9652	</const>
9653	<const name="Error" value="800">
9654	<desc>Something went wrong.</desc>
9655	</const>
9656	</enum>
9657
9658	<enum
9659	name="ProcessInputStatus"
9660	uuid="a4a0ef9c-29cc-4805-9803-c8215ae9da6c"
9661	>
9662	<desc>
9663	Process input statuses.
9664	</desc>
9665
9666	<const name="Undefined" value="0">
9667	<desc>Undefined state.</desc>
9668	</const>
9669	<const name="Broken" value="1">
9670	<desc>Input pipe is broken.</desc>
9671	</const>
9672	<const name="Available" value="10">
9673	<desc>Input pipe became available for writing.</desc>
9674	</const>
9675	<const name="Written" value="50">
9676	<desc>Data has been successfully written.</desc>
9677	</const>
9678	<const name="Overflow" value="100">
9679	<desc>Too much input data supplied, data overflow.</desc>
9680	</const>
9681	</enum>
9682
9683	<enum
9684	name="FileStatus"
9685	uuid="8c86468b-b97b-4080-8914-e29f5b0abd2c"
9686	>
9687	<desc>
9688	File statuses.
9689	</desc>
9690
9691	<const name="Undefined" value="0">
9692	<desc>File is in an undefined state.</desc>
9693	</const>
9694	<const name="Opening" value="10">
9695	<desc>Guest file is opening.</desc>
9696	</const>
9697	<const name="Open" value="100">
9698	<desc>Guest file has been successfully opened.</desc>
9699	</const>
9700	<const name="Closing" value="150">
9701	<desc>Guest file closing.</desc>
9702	</const>
9703	<const name="Closed" value="200">
9704	<desc>Guest file has been closed.</desc>
9705	</const>
9706	<const name="Down" value="600">
9707	<desc>Service/OS is stopping, guest file was closed.</desc>
9708	</const>
9709	<const name="Error" value="800">
9710	<desc>Something went wrong.</desc>
9711	</const>
9712	</enum>
9713
9714	<enum
9715	name="FsObjType"
9716	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9717	>
9718	<desc>
9719	File system object type.
9720	</desc>
9721
9722	<const name="Undefined" value="0">
9723	<desc>Type is undefined / unknown.</desc>
9724	</const>
9725	<const name="FIFO" value="1">
9726	<desc>Named pipe.</desc>
9727	</const>
9728	<const name="DevChar" value="10">
9729	<desc>Character device.</desc>
9730	</const>
9731	<const name="DevBlock" value="11">
9732	<desc>Block device.</desc>
9733	</const>
9734	<const name="Directory" value="50">
9735	<desc>Directory.</desc>
9736	</const>
9737	<const name="File" value="80">
9738	<desc>File.</desc>
9739	</const>
9740	<const name="Symlink" value="100">
9741	<desc>Symlink.</desc>
9742	</const>
9743	<const name="Socket" value="200">
9744	<desc>Socket.</desc>
9745	</const>
9746	<const name="Whiteout" value="400">
9747	<desc>Whiteout.</desc>
9748	</const>
9749	</enum>
9750
9751	<enum
9752	name="DragAndDropAction"
9753	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9754	>
9755	<desc>
9756	Possible actions within an Drag and Drop operation.
9757	</desc>
9758
9759	<const name="Ignore" value="0">
9760	<desc>Do nothing.</desc>
9761	</const>
9762
9763	<const name="Copy" value="1">
9764	<desc>Copy the item to the target.</desc>
9765	</const>
9766
9767	<const name="Move" value="2">
9768	<desc>Move the item to the target.</desc>
9769	</const>
9770
9771	<const name="Link" value="3">
9772	<desc>Link the item from within the target.</desc>
9773	</const>
9774	</enum>
9775
9776	<enum
9777	name="DirectoryOpenFlag"
9778	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9779	>
9780	<desc>
9781	Directory open flags.
9782	</desc>
9783	<const name="None" value="0">
9784	<desc>No flag set.</desc>
9785	</const>
9786	<const name="NoSymlinks" value="1">
9787	<desc>Don't allow symbolic links as part of the path.</desc>
9788	</const>
9789	</enum>
9790
9791	<interface
9792	name="IGuestSession" extends="$unknown"
9793	uuid="c8e8607b-5e67-4073-8f14-146515d0c1ff"
9794	wsmap="managed"
9795	>
9796	<desc>
9797	A guest session represents one impersonated user account on the guest, so
9798	every operation will use the same credentials specified when creating
9799	the session object via <link to="IGuest::createSession"/>.
9800
9801	There can be a maximum of 32 sessions at once per VM. Each session keeps
9802	track of its started guest processes, opened guest files or guest directories.
9803	To work on guest files or directories a guest session offers methods to open
9804	or create such objects (see <link to="IGuestSession::fileOpen"/> or
9805	<link to="IGuestSession::directoryOpen"/> for example).
9806
9807	When done with either of these objects, including the guest session itself,
9808	use the appropriate close() method to let the object do its cleanup work.
9809
9810	Every guest session has its own environment variable block which gets
9811	automatically applied when starting a new guest process via
9812	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9813	To override (or unset) certain environment variables already set by the
9814	guest session, one can specify a per-process environment block when using
9815	one of the both above mentioned process creation calls.
9816	</desc>
9817
9818	<attribute name="user" type="wstring" readonly="yes">
9819	<desc>Returns the user name used by this session to impersonate
9820	users on the guest.
9821	</desc>
9822	</attribute>
9823	<attribute name="domain" type="wstring" readonly="yes">
9824	<desc>Returns the domain name used by this session to impersonate
9825	users on the guest.
9826	</desc>
9827	</attribute>
9828	<attribute name="name" type="wstring" readonly="yes">
9829	<desc>Returns the session's friendly name.</desc>
9830	</attribute>
9831	<attribute name="id" type="unsigned long" readonly="yes">
9832	<desc>Returns the internal session ID.</desc>
9833	</attribute>
9834	<attribute name="timeout" type="unsigned long">
9835	<desc>
9836	Returns the session timeout (in ms).
9837	<result name="E_NOTIMPL">
9838	The method is not implemented yet.
9839	</result>
9840	</desc>
9841	</attribute>
9842	<attribute name="status" type="GuestSessionStatus" readonly="yes">
9843	<desc>Returns the current session status.</desc>
9844	</attribute>
9845	<attribute name="environment" type="wstring" safearray="yes">
9846	<desc>
9847	Returns the current session environment.
9848	</desc>
9849	</attribute>
9850	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9851	<desc>
9852	Returns all current guest processes.
9853	</desc>
9854	</attribute>
9855	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9856	<desc>
9857	Returns all currently opened guest directories.
9858	</desc>
9859	</attribute>
9860	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9861	<desc>
9862	Returns all currently opened guest files.
9863	</desc>
9864	</attribute>
9865	<attribute name="eventSource" type="IEventSource" readonly="yes">
9866	<desc>
9867	Event source for guest session events.
9868	</desc>
9869	</attribute>
9870
9871	<method name="close">
9872	<desc>
9873	Closes this session. All opened guest directories, files and
9874	processes which are not referenced by clients anymore will be
9875	uninitialized.
9876	</desc>
9877	</method>
9878
9879	<method name="copyFrom">
9880	<desc>
9881	Copies a file from guest to the host.
9882
9883	<result name="VBOX_E_IPRT_ERROR">
9884	Error starting the copy operation.
9885	</result>
9886	</desc>
9887	<param name="source" type="wstring" dir="in">
9888	<desc>Source file on the guest to copy to the host.</desc>
9889	</param>
9890	<param name="dest" type="wstring" dir="in">
9891	<desc>Destination file name on the host.</desc>
9892	</param>
9893	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9894	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9895	</param>
9896	<param name="progress" type="IProgress" dir="return">
9897	<desc>Progress object to track the operation completion.</desc>
9898	</param>
9899	</method>
9900
9901	<method name="copyTo">
9902	<desc>
9903	Copies a file from host to the guest.
9904
9905	<result name="VBOX_E_IPRT_ERROR">
9906	Error starting the copy operation.
9907	</result>
9908	</desc>
9909	<param name="source" type="wstring" dir="in">
9910	<desc>Source file on the host to copy to the guest.</desc>
9911	</param>
9912	<param name="dest" type="wstring" dir="in">
9913	<desc>Destination file name on the guest.</desc>
9914	</param>
9915	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9916	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9917	</param>
9918	<param name="progress" type="IProgress" dir="return">
9919	<desc>Progress object to track the operation completion.</desc>
9920	</param>
9921	</method>
9922
9923	<method name="directoryCreate">
9924	<desc>
9925	Create a directory on the guest.
9926
9927	<result name="VBOX_E_IPRT_ERROR">
9928	Error while creating the directory.
9929	</result>
9930	</desc>
9931	<param name="path" type="wstring" dir="in">
9932	<desc>Full path of directory to create.</desc>
9933	</param>
9934	<param name="mode" type="unsigned long" dir="in">
9935	<desc>File creation mode.</desc>
9936	</param>
9937	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9938	<desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9939	</param>
9940	</method>
9941
9942	<method name="directoryCreateTemp">
9943	<desc>
9944	Create a temporary directory on the guest.
9945
9946	<result name="VBOX_E_NOT_SUPPORTED">
9947	The operation is not possible as requested on this particular
9948	guest type.
9949	</result>
9950	<result name="E_INVALIDARG">
9951	Invalid argument. This includes an incorrectly formatted template,
9952	or a non-absolute path.
9953	</result>
9954	<result name="VBOX_E_IPRT_ERROR">
9955	The temporary directory could not be created. Possible reasons
9956	include a non-existing path or an insecure path when the secure
9957	option was requested.
9958	</result>
9959	</desc>
9960	<param name="templateName" type="wstring" dir="in">
9961	<desc>Template for the name of the directory to create. This must
9962	contain at least one 'X' character. The first group of consecutive
9963	'X' characters in the template will be replaced by a random
9964	alphanumeric string to produce a unique name.</desc>
9965	</param>
9966	<param name="mode" type="unsigned long" dir="in">
9967	<desc>The mode of the directory to create. Use 0700 unless there are
9968	reasons not to. This parameter is ignored if "secure" is specified.
9969	</desc>
9970	</param>
9971	<param name="path" type="wstring" dir="in">
9972	<desc>The absolute path to create the temporary directory in.</desc>
9973	</param>
9974	<param name="secure" type="boolean" dir="in">
9975	<desc>Whether to fail if the directory can not be securely created.
9976	Currently this means that another unprivileged user cannot
9977	manipulate the path specified or remove the temporary directory
9978	after it has been created. Also causes the mode specified to be
9979	ignored. May not be supported on all guest types.</desc>
9980	</param>
9981	<param name="directory" type="wstring" dir="return">
9982	<desc>On success this will contain the name of the directory created
9983	with full path.</desc>
9984	</param>
9985	</method>
9986
9987	<method name="directoryExists">
9988	<desc>
9989	Checks whether a directory exists on the guest or not.
9990
9991	<result name="VBOX_E_IPRT_ERROR">
9992	Error while checking existence of the directory specified.
9993	</result>
9994	</desc>
9995	<param name="path" type="wstring" dir="in">
9996	<desc>Directory to check existence for.</desc>
9997	</param>
9998	<param name="exists" type="boolean" dir="return">
9999	<desc>Returns @c true if the directory exists, @c false if not.</desc>
10000	</param>
10001	</method>
10002
10003	<method name="directoryOpen">
10004	<desc>
10005	Opens a directory and creates a <link to="IGuestDirectory"/> object that
10006	can be used for further operations.
10007
10008	<result name="VBOX_E_OBJECT_NOT_FOUND">
10009	Directory to open was not found.
10010	</result>
10011	<result name="VBOX_E_IPRT_ERROR">
10012	Error while opening the directory.
10013	</result>
10014	</desc>
10015	<param name="path" type="wstring" dir="in">
10016	<desc>Full path to file to open.</desc>
10017	</param>
10018	<param name="filter" type="wstring" dir="in">
10019	<desc>Open filter to apply. This can include wildcards like ? and *.</desc>
10020	</param>
10021	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
10022	<desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
10023	</param>
10024	<param name="directory" type="IGuestDirectory" dir="return">
10025	<desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
10026	</param>
10027	</method>
10028
10029	<method name="directoryQueryInfo">
10030	<desc>
10031	Queries information of a directory on the guest.
10032
10033	<result name="VBOX_E_OBJECT_NOT_FOUND">
10034	Directory to query information for was not found.
10035	</result>
10036	<result name="VBOX_E_IPRT_ERROR">
10037	Error querying information.
10038	</result>
10039	</desc>
10040	<param name="path" type="wstring" dir="in">
10041	<desc>Directory to query information for.</desc>
10042	</param>
10043	<param name="info" type="IGuestFsObjInfo" dir="return">
10044	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
10045	</param>
10046	</method>
10047
10048	<method name="directoryRemove">
10049	<desc>
10050	Removes a guest directory if not empty.
10051
10052	<result name="E_NOTIMPL">
10053	The method is not implemented yet.
10054	</result>
10055	</desc>
10056	<param name="path" type="wstring" dir="in">
10057	<desc>Full path of directory to remove.</desc>
10058	</param>
10059	</method>
10060
10061	<method name="directoryRemoveRecursive">
10062	<desc>
10063	Removes a guest directory recursively.
10064
10065	<result name="E_NOTIMPL">
10066	The method is not implemented yet.
10067	</result>
10068	</desc>
10069	<param name="path" type="wstring" dir="in">
10070	<desc>Full path of directory to remove recursively.</desc>
10071	</param>
10072	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
10073	<desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
10074	</param>
10075	<param name="progress" type="IProgress" dir="return">
10076	<desc>Progress object to track the operation completion.</desc>
10077	</param>
10078	</method>
10079
10080	<method name="directoryRename">
10081	<desc>
10082	Renames a directory on the guest.
10083
10084	<result name="E_NOTIMPL">
10085	The method is not implemented yet.
10086	</result>
10087	</desc>
10088	<param name="source" type="wstring" dir="in">
10089	<desc>Source directory to rename.</desc>
10090	</param>
10091	<param name="dest" type="wstring" dir="in">
10092	<desc>Destination directory to rename the source to.</desc>
10093	</param>
10094	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10095	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10096	</param>
10097	</method>
10098
10099	<method name="directorySetACL">
10100	<desc>
10101	Sets the ACL (Access Control List) of a guest directory.
10102
10103	<result name="E_NOTIMPL">
10104	The method is not implemented yet.
10105	</result>
10106	</desc>
10107	<param name="path" type="wstring" dir="in">
10108	<desc>Full path of directory to set the ACL for.</desc>
10109	</param>
10110	<param name="acl" type="wstring" dir="in">
10111	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10112	</param>
10113	</method>
10114
10115	<method name="environmentClear">
10116	<desc>
10117	Clears (deletes) all session environment variables.
10118
10119	<result name="VBOX_E_IPRT_ERROR">
10120	Error while clearing the session environment variables.
10121	</result>
10122	</desc>
10123	</method>
10124
10125	<method name="environmentGet">
10126	<desc>
10127	Gets the value of a session environment variable.
10128
10129	<result name="VBOX_E_IPRT_ERROR">
10130	Error while getting the value of the session environment variable.
10131	</result>
10132	</desc>
10133	<param name="name" type="wstring" dir="in">
10134	<desc>Name of session environment variable to get the value for.</desc>
10135	</param>
10136	<param name="value" type="wstring" dir="return">
10137	<desc>
10138	Value of the session environment variable specified. If this variable
10139	does not exist and empty value will be returned.
10140	</desc>
10141	</param>
10142	</method>
10143
10144	<method name="environmentSet">
10145	<desc>
10146	Sets a session environment variable.
10147
10148	<result name="VBOX_E_IPRT_ERROR">
10149	Error while setting the session environment variable.
10150	</result>
10151	</desc>
10152	<param name="name" type="wstring" dir="in">
10153	<desc>Name of session environment variable to set.</desc>
10154	</param>
10155	<param name="value" type="wstring" dir="in">
10156	<desc>Value to set the session environment variable to.</desc>
10157	</param>
10158	</method>
10159
10160	<method name="environmentUnset">
10161	<desc>
10162	Unsets session environment variable.
10163
10164	<result name="VBOX_E_IPRT_ERROR">
10165	Error while unsetting the session environment variable.
10166	</result>
10167	</desc>
10168	<param name="name" type="wstring" dir="in">
10169	<desc>Name of session environment variable to unset (clear).</desc>
10170	</param>
10171	</method>
10172
10173	<method name="fileCreateTemp">
10174	<desc>
10175	Creates a temporary file on the guest.
10176
10177	<result name="VBOX_E_NOT_SUPPORTED">
10178	The operation is not possible as requested on this particular
10179	guest type.
10180	</result>
10181	<result name="E_INVALIDARG">
10182	Invalid argument. This includes an incorrectly formatted template,
10183	or a non-absolute path.
10184	</result>
10185	<result name="VBOX_E_IPRT_ERROR">
10186	The temporary file could not be created. Possible reasons include
10187	a non-existing path or an insecure path when the secure
10188	option was requested.
10189	</result>
10190	</desc>
10191	<param name="templateName" type="wstring" dir="in">
10192	<desc>Template for the name of the file to create. This must contain
10193	at least one 'X' character. The first group of consecutive 'X'
10194	characters in the template will be replaced by a random
10195	alphanumeric string to produce a unique name.
10196	</desc>
10197	</param>
10198	<param name="mode" type="unsigned long" dir="in">
10199	<desc>The mode of the file to create. Use 0700 unless there are
10200	reasons not to. This parameter is ignored if "secure" is specified.
10201	</desc>
10202	</param>
10203	<param name="path" type="wstring" dir="in">
10204	<desc>The absolute path to create the temporary file in.</desc>
10205	</param>
10206	<param name="secure" type="boolean" dir="in">
10207	<desc>Whether to fail if the file can not be securely created.
10208	Currently this means that another unprivileged user cannot
10209	manipulate the path specified or remove the temporary file after
10210	it has been created. Also causes the mode specified to be ignored.
10211	May not be supported on all guest types.</desc>
10212	</param>
10213	<param name="file" type="IGuestFile" dir="return">
10214	<desc>On success this will contain an open file object for the new
10215	temporary file.
10216	</desc>
10217	</param>
10218	</method>
10219
10220	<method name="fileExists">
10221	<desc>
10222	Checks whether a file exists on the guest or not.
10223
10224	<result name="VBOX_E_IPRT_ERROR">
10225	Error while checking existence of the file specified.
10226	</result>
10227	</desc>
10228	<param name="path" type="wstring" dir="in">
10229	<desc>File to check existence for.</desc>
10230	</param>
10231	<param name="exists" type="boolean" dir="return">
10232	<desc>Returns @c true if the file exists, @c false if not.</desc>
10233	</param>
10234	</method>
10235
10236	<method name="fileRemove">
10237	<desc>
10238	Removes a single file on the guest.
10239
10240	<result name="VBOX_E_OBJECT_NOT_FOUND">
10241	File to remove was not found.
10242	</result>
10243	<result name="VBOX_E_IPRT_ERROR">
10244	Error while removing the file.
10245	</result>
10246	</desc>
10247	<param name="path" type="wstring" dir="in">
10248	<desc>Path to the file to remove.</desc>
10249	</param>
10250	</method>
10251
10252	<method name="fileOpen">
10253	<desc>
10254	Opens a file and creates a <link to="IGuestFile"/> object that
10255	can be used for further operations.
10256
10257	<result name="VBOX_E_OBJECT_NOT_FOUND">
10258	File to open was not found.
10259	</result>
10260	<result name="VBOX_E_IPRT_ERROR">
10261	Error while opening the file.
10262	</result>
10263	</desc>
10264	<param name="path" type="wstring" dir="in">
10265	<desc>Full path to file to open.</desc>
10266	</param>
10267	<param name="openMode" type="wstring" dir="in">
10268	<desc>The file open mode.</desc>
10269	</param>
10270	<param name="disposition" type="wstring" dir="in">
10271	<desc>The file disposition.</desc>
10272	</param>
10273	<param name="creationMode" type="unsigned long" dir="in">
10274	<desc>The file creation mode.</desc>
10275	</param>
10276	<param name="offset" type="long long" dir="in">
10277	<desc>The initial read/write offset.</desc>
10278	</param>
10279	<param name="file" type="IGuestFile" dir="return">
10280	<desc><link to="IGuestFile"/> object representing the opened file.</desc>
10281	</param>
10282	</method>
10283
10284	<method name="fileQueryInfo">
10285	<desc>
10286	Queries information of a file on the guest.
10287
10288	<result name="VBOX_E_OBJECT_NOT_FOUND">
10289	File to query information for was not found.
10290	</result>
10291	<result name="VBOX_E_IPRT_ERROR">
10292	Error querying information.
10293	</result>
10294	</desc>
10295	<param name="path" type="wstring" dir="in">
10296	<desc>File to query information for.</desc>
10297	</param>
10298	<param name="info" type="IGuestFsObjInfo" dir="return">
10299	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
10300	</param>
10301	</method>
10302
10303	<method name="fileQuerySize">
10304	<desc>
10305	Queries the size of a file on the guest.
10306
10307	<result name="VBOX_E_OBJECT_NOT_FOUND">
10308	File to rename was not found.
10309	</result>
10310	<result name="VBOX_E_IPRT_ERROR">
10311	Error querying file size.
10312	</result>
10313	</desc>
10314	<param name="path" type="wstring" dir="in">
10315	<desc>File to query the size for.</desc>
10316	</param>
10317	<param name="size" type="long long" dir="return">
10318	<desc>Queried file size.</desc>
10319	</param>
10320	</method>
10321
10322	<method name="fileRename">
10323	<desc>
10324	Renames a file on the guest.
10325
10326	<result name="E_NOTIMPL">
10327	The method is not implemented yet.
10328	</result>
10329	</desc>
10330	<param name="source" type="wstring" dir="in">
10331	<desc>Source file to rename.</desc>
10332	</param>
10333	<param name="dest" type="wstring" dir="in">
10334	<desc>Destination file to rename the source to.</desc>
10335	</param>
10336	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10337	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10338	</param>
10339	</method>
10340
10341	<method name="fileSetACL">
10342	<desc>
10343	Sets the ACL (Access Control List) of a file on the guest.
10344
10345	<result name="E_NOTIMPL">
10346	The method is not implemented yet.
10347	</result>
10348	</desc>
10349	<param name="file" type="wstring" dir="in">
10350	<desc>Full path of file to set the ACL for.</desc>
10351	</param>
10352	<param name="acl" type="wstring" dir="in">
10353	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10354	</param>
10355	</method>
10356
10357	<method name="processCreate">
10358	<desc>
10359	Creates a new process running on the guest. The new process will be
10360	started asynchronously, meaning on return of this function it is not
10361	guaranteed that the guest process is in a started state. To wait for
10362	successful startup, use the <link to="IProcess::waitFor"/> call.
10363
10364	<note>
10365	Starting at VirtualBox 4.2 guest process execution by default is limited
10366	to serve up to 255 guest processes at a time. If all 255 guest processes
10367	are still active and running, creating a new guest process will result in an
10368	appropriate error message.
10369
10370	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10371	is / are set, the guest process will not exit until all data from the specified
10372	stream(s) is / are read out.
10373
10374	To raise or lower the guest process execution limit, either the guest property
10375	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10376	command line by specifying "--control-procs-max-kept" needs to be modified.
10377	A restart of the guest OS is required afterwards. To serve unlimited guest
10378	processes, a value of "0" needs to be set (not recommended).
10379	</note>
10380
10381	<result name="VBOX_E_IPRT_ERROR">
10382	Error creating guest process.
10383	</result>
10384	</desc>
10385	<param name="command" type="wstring" dir="in">
10386	<desc>
10387	Full path name of the command to execute on the guest; the
10388	commands has to exists in the guest VM in order to be executed.
10389	</desc>
10390	</param>
10391	<param name="arguments" type="wstring" dir="in" safearray="yes">
10392	<desc>Array of arguments passed to the execution command.</desc>
10393	</param>
10394	<param name="environment" type="wstring" dir="in" safearray="yes">
10395	<desc>
10396	<para>Environment variables that can be set while the command is being
10397	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10398	variable just set its name ("NAME") without a value.</para>
10399	<para>This parameter can be used to override environment variables set by
10400	the guest session, which will be applied to the newly started process
10401	in any case.</para>
10402	</desc>
10403	</param>
10404	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10405	<desc>
10406	Process creation flags;
10407	see <link to="ProcessCreateFlag"/> for more information.
10408	</desc>
10409	</param>
10410	<param name="timeoutMS" type="unsigned long" dir="in">
10411	<desc>
10412	Timeout (in ms) for limiting the guest process' running time.
10413	Pass 0 for an infinite timeout. On timeout the guest process will be
10414	killed and its status will be put to an appropriate value. See
10415	<link to="ProcessStatus"/> for more information.
10416	</desc>
10417	</param>
10418	<param name="guestProcess" type="IGuestProcess" dir="return">
10419	<desc>Guest process object of the newly created process.</desc>
10420	</param>
10421	</method>
10422
10423	<method name="processCreateEx">
10424	<desc>
10425	<para>Creates a new process running on the guest. Extended version for
10426	also setting the process priority and affinity.</para>
10427
10428	<para>See <link to="IGuestSession::processCreate"/> for more
10429	information.</para>
10430	</desc>
10431	<param name="command" type="wstring" dir="in">
10432	<desc>
10433	Full path name of the command to execute on the guest; the
10434	commands has to exists in the guest VM in order to be executed.
10435	</desc>
10436	</param>
10437	<param name="arguments" type="wstring" dir="in" safearray="yes">
10438	<desc>Array of arguments passed to the execution command.</desc>
10439	</param>
10440	<param name="environment" type="wstring" dir="in" safearray="yes">
10441	<desc>
10442	<para>Environment variables that can be set while the command is being
10443	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10444	variable just set its name ("NAME") without a value.</para>
10445	<para>This parameter can be used to override environment variables set by
10446	the guest session, which will be applied to the newly started process
10447	in any case.</para>
10448	</desc>
10449	</param>
10450	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10451	<desc>
10452	Process creation flags;
10453	see <link to="ProcessCreateFlag"/> for more information.
10454	</desc>
10455	</param>
10456	<param name="timeoutMS" type="unsigned long" dir="in">
10457	<desc>
10458	Timeout (in ms) for limiting the guest process' running time.
10459	Pass 0 for an infinite timeout. On timeout the guest process will be
10460	killed and its status will be put to an appropriate value. See
10461	<link to="ProcessStatus"/> for more information.
10462	</desc>
10463	</param>
10464	<param name="priority" type="ProcessPriority" dir="in">
10465	<desc>
10466	Process priority to use for execution;
10467	see see <link to="ProcessPriority"/> for more information.</desc>
10468	</param>
10469	<param name="affinity" type="long" dir="in" safearray="yes">
10470	<desc>
10471	Process affinity to use for execution. This parameter
10472	is not implemented yet.
10473	</desc>
10474	</param>
10475	<param name="guestProcess" type="IGuestProcess" dir="return">
10476	<desc>Guest process object of the newly created process.</desc>
10477	</param>
10478	</method>
10479
10480	<method name="processGet">
10481	<desc>
10482	Gets a certain guest process by its process ID (PID).
10483	</desc>
10484	<param name="pid" type="unsigned long" dir="in">
10485	<desc>Process ID (PID) to get guest process for.</desc>
10486	</param>
10487	<param name="guestProcess" type="IGuestProcess" dir="return">
10488	<desc>Guest process of specified process ID (PID).</desc>
10489	</param>
10490	</method>
10491
10492	<method name="symlinkCreate">
10493	<desc>
10494	Creates a symbolic link on the guest.
10495
10496	<result name="E_NOTIMPL">
10497	The method is not implemented yet.
10498	</result>
10499	</desc>
10500	<param name="source" type="wstring" dir="in">
10501	<desc>The name of the symbolic link.</desc>
10502	</param>
10503	<param name="target" type="wstring" dir="in">
10504	<desc>The path to the symbolic link target.</desc>
10505	</param>
10506	<param name="type" type="SymlinkType" dir="in">
10507	<desc>
10508	The symbolic link type;
10509	see <link to="SymlinkReadFlag"/> for more information.
10510	</desc>
10511	</param>
10512	</method>
10513
10514	<method name="symlinkExists">
10515	<desc>
10516	Checks whether a symbolic link exists on the guest or not.
10517
10518	<result name="E_NOTIMPL">
10519	The method is not implemented yet.
10520	</result>
10521	</desc>
10522	<param name="symlink" type="wstring" dir="in">
10523	<desc>Symbolic link to check existence for.</desc>
10524	</param>
10525	<param name="exists" type="boolean" dir="return">
10526	<desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10527	</param>
10528	</method>
10529
10530	<method name="symlinkRead">
10531	<desc>
10532	Reads a symbolic link on the guest.
10533
10534	<result name="E_NOTIMPL">
10535	The method is not implemented yet.
10536	</result>
10537	</desc>
10538	<param name="symlink" type="wstring" dir="in">
10539	<desc>Full path to symbolic link to read.</desc>
10540	</param>
10541	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10542	<desc>
10543	Read flags; see <link to="SymlinkReadFlag"/> for more information.
10544	</desc>
10545	</param>
10546	<param name="target" type="wstring" dir="return">
10547	<desc>
10548	Target of the symbolic link pointing to, if found.
10549	</desc>
10550	</param>
10551	</method>
10552
10553	<method name="symlinkRemoveDirectory">
10554	<desc>
10555	Removes a symbolic link on the guest if it's a directory.
10556
10557	<result name="E_NOTIMPL">
10558	The method is not implemented yet.
10559	</result>
10560	</desc>
10561	<param name="path" type="wstring" dir="in">
10562	<desc>Symbolic link to remove.</desc>
10563	</param>
10564	</method>
10565
10566	<method name="symlinkRemoveFile">
10567	<desc>
10568	Removes a symbolic link on the guest if it's a file.
10569
10570	<result name="E_NOTIMPL">
10571	The method is not implemented yet.
10572	</result>
10573	</desc>
10574	<param name="file" type="wstring" dir="in">
10575	<desc>Symbolic link to remove.</desc>
10576	</param>
10577	</method>
10578
10579	<method name="waitFor">
10580	<desc>
10581	Waits for one more events to happen.
10582	</desc>
10583	<param name="waitFor" type="unsigned long" dir="in">
10584	<desc>
10585	Specifies what to wait for;
10586	see <link to="GuestSessionWaitForFlag"/> for more information.
10587	</desc>
10588	</param>
10589	<param name="timeoutMS" type="unsigned long" dir="in">
10590	<desc>
10591	Timeout (in ms) to wait for the operation to complete.
10592	Pass 0 for an infinite timeout.
10593	</desc>
10594	</param>
10595	<param name="reason" type="GuestSessionWaitResult" dir="return">
10596	<desc>
10597	The overall wait result;
10598	see <link to="GuestSessionWaitResult"/> for more information.
10599	</desc>
10600	</param>
10601	</method>
10602
10603	<method name="waitForArray">
10604	<desc>
10605	Waits for one more events to happen.
10606	Scriptable version of <link to="#waitFor" />.
10607	</desc>
10608	<param name="waitFor" type="GuestSessionWaitForFlag" dir="in" safearray="yes">
10609	<desc>
10610	Specifies what to wait for;
10611	see <link to="GuestSessionWaitForFlag"/> for more information.
10612	</desc>
10613	</param>
10614	<param name="timeoutMS" type="unsigned long" dir="in">
10615	<desc>
10616	Timeout (in ms) to wait for the operation to complete.
10617	Pass 0 for an infinite timeout.
10618	</desc>
10619	</param>
10620	<param name="reason" type="GuestSessionWaitResult" dir="return">
10621	<desc>
10622	The overall wait result;
10623	see <link to="GuestSessionWaitResult"/> for more information.
10624	</desc>
10625	</param>
10626	</method>
10627
10628	</interface>
10629
10630	<interface
10631	name="IProcess" extends="$unknown"
10632	uuid="5a4fe06d-8cb1-40ff-ac9e-9676e32f706e"
10633	wsmap="managed"
10634	>
10635	<desc>
10636	Abstract parent interface for processes handled by VirtualBox.
10637	</desc>
10638
10639	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10640	<desc>
10641	The arguments this process is using for execution.
10642	</desc>
10643	</attribute>
10644	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10645	<desc>
10646	The environment block this process is using during execution.
10647	</desc>
10648	</attribute>
10649	<attribute name="eventSource" type="IEventSource" readonly="yes">
10650	<desc>
10651	Event source for VirtualBox events.
10652	</desc>
10653	</attribute>
10654	<attribute name="executablePath" type="wstring" readonly="yes">
10655	<desc>Full path of the actual executable image.</desc>
10656	</attribute>
10657	<attribute name="exitCode" type="long" readonly="yes">
10658	<desc>
10659	The exit code. Only available when the process has been
10660	terminated normally.
10661	</desc>
10662	</attribute>
10663	<attribute name="name" type="wstring" readonly="yes">
10664	<desc>
10665	The friendly name of this process.
10666	</desc>
10667	</attribute>
10668	<attribute name="PID" type="unsigned long" readonly="yes">
10669	<desc>
10670	The process ID (PID).
10671	</desc>
10672	</attribute>
10673	<attribute name="status" type="ProcessStatus" readonly="yes">
10674	<desc>
10675	The current process status; see <link to="ProcessStatus"/>
10676	for more information.
10677	</desc>
10678	</attribute>
10679
10680	<method name="waitFor">
10681	<desc>
10682	Waits for one more events to happen.
10683	</desc>
10684	<param name="waitFor" type="unsigned long" dir="in">
10685	<desc>
10686	Specifies what to wait for;
10687	see <link to="ProcessWaitForFlag"/> for more information.
10688	</desc>
10689	</param>
10690	<param name="timeoutMS" type="unsigned long" dir="in">
10691	<desc>
10692	Timeout (in ms) to wait for the operation to complete.
10693	Pass 0 for an infinite timeout.
10694	</desc>
10695	</param>
10696	<param name="reason" type="ProcessWaitResult" dir="return">
10697	<desc>
10698	The overall wait result;
10699	see <link to="ProcessWaitResult"/> for more information.
10700	</desc>
10701	</param>
10702	</method>
10703
10704	<method name="waitForArray">
10705	<desc>
10706	Waits for one more events to happen.
10707	Scriptable version of <link to="#waitFor" />.
10708	</desc>
10709	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10710	<desc>
10711	Specifies what to wait for;
10712	see <link to="ProcessWaitForFlag"/> for more information.
10713	</desc>
10714	</param>
10715	<param name="timeoutMS" type="unsigned long" dir="in">
10716	<desc>
10717	Timeout (in ms) to wait for the operation to complete.
10718	Pass 0 for an infinite timeout.
10719	</desc>
10720	</param>
10721	<param name="reason" type="ProcessWaitResult" dir="return">
10722	<desc>
10723	The overall wait result;
10724	see <link to="ProcessWaitResult"/> for more information.
10725	</desc>
10726	</param>
10727	</method>
10728
10729	<method name="read">
10730	<desc>
10731	Reads data from a running process.
10732	</desc>
10733	<param name="handle" type="unsigned long" dir="in">
10734	<desc>Handle to read from. Usually 0 is stdin.</desc>
10735	</param>
10736	<param name="toRead" type="unsigned long" dir="in">
10737	<desc>Number of bytes to read.</desc>
10738	</param>
10739	<param name="timeoutMS" type="unsigned long" dir="in">
10740	<desc>
10741	Timeout (in ms) to wait for the operation to complete.
10742	Pass 0 for an infinite timeout.
10743	</desc>
10744	</param>
10745	<param name="data" type="octet" dir="return" safearray="yes">
10746	<desc>Array of data read.</desc>
10747	</param>
10748	</method>
10749
10750	<method name="write">
10751	<desc>
10752	Writes data to a running process.
10753	</desc>
10754	<param name="handle" type="unsigned long" dir="in">
10755	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10756	</param>
10757	<param name="flags" type="unsigned long" dir="in">
10758	<desc>
10759	A combination of <link to="ProcessInputFlag"/> flags.
10760	</desc>
10761	</param>
10762	<param name="data" type="octet" dir="in" safearray="yes">
10763	<desc>
10764	Array of bytes to write. The size of the array also specifies
10765	how much to write.
10766	</desc>
10767	</param>
10768	<param name="timeoutMS" type="unsigned long" dir="in">
10769	<desc>
10770	Timeout (in ms) to wait for the operation to complete.
10771	Pass 0 for an infinite timeout.
10772	</desc>
10773	</param>
10774	<param name="written" type="unsigned long" dir="return">
10775	<desc>How much bytes were written.</desc>
10776	</param>
10777	</method>
10778
10779	<method name="writeArray">
10780	<desc>
10781	Writes data to a running process.
10782	Scriptable version of <link to="#write" />.
10783	</desc>
10784	<param name="handle" type="unsigned long" dir="in">
10785	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10786	</param>
10787	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10788	<desc>
10789	A combination of <link to="ProcessInputFlag"/> flags.
10790	</desc>
10791	</param>
10792	<param name="data" type="octet" dir="in" safearray="yes">
10793	<desc>
10794	Array of bytes to write. The size of the array also specifies
10795	how much to write.
10796	</desc>
10797	</param>
10798	<param name="timeoutMS" type="unsigned long" dir="in">
10799	<desc>
10800	Timeout (in ms) to wait for the operation to complete.
10801	Pass 0 for an infinite timeout.
10802	</desc>
10803	</param>
10804	<param name="written" type="unsigned long" dir="return">
10805	<desc>How much bytes were written.</desc>
10806	</param>
10807	</method>
10808
10809	<method name="terminate">
10810	<desc>
10811	Terminates (kills) a running process.
10812	</desc>
10813	</method>
10814	</interface>
10815
10816	<interface
10817	name="IGuestProcess" extends="IProcess"
10818	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10819	wsmap="managed"
10820	>
10821	<desc>
10822	Implementation of the <link to="IProcess" /> object
10823	for processes on the guest.
10824	</desc>
10825	</interface>
10826
10827	<interface
10828	name="IDirectory" extends="$unknown"
10829	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10830	wsmap="managed"
10831	>
10832	<desc>
10833	Abstract parent interface for directories handled by VirtualBox.
10834	</desc>
10835
10836	<attribute name="directoryName" type="wstring" readonly="yes">
10837	<desc>
10838	Full path of directory.
10839	</desc>
10840	</attribute>
10841
10842	<attribute name="filter" type="wstring" readonly="yes">
10843	<desc>
10844	The open filter.
10845	</desc>
10846	</attribute>
10847
10848	<method name="close">
10849	<desc>
10850	Closes this directory. After closing operations like reading the next
10851	directory entry will not be possible anymore.
10852	</desc>
10853	</method>
10854
10855	<method name="read">
10856	<desc>
10857	Reads the next directory entry of this directory.
10858	<result name="VBOX_E_OBJECT_NOT_FOUND">
10859	No more directory entries to read.
10860	</result>
10861	</desc>
10862	<param name="objInfo" type="IFsObjInfo" dir="return">
10863	<desc>Object information of the current directory entry read. Also see
10864	<link to="IFsObjInfo"/>.</desc>
10865	</param>
10866	</method>
10867	</interface>
10868
10869	<interface
10870	name="IGuestDirectory" extends="IDirectory"
10871	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10872	wsmap="managed"
10873	>
10874	<desc>
10875	Implementation of the <link to="IDirectory" /> object
10876	for directories on the guest.
10877	</desc>
10878	</interface>
10879
10880	<interface
10881	name="IFile" extends="$unknown"
10882	uuid="ceb895d7-8b2d-4a39-8f7c-7d2270f341d5"
10883	wsmap="managed"
10884	>
10885	<desc>
10886	Abstract parent interface for files handled by VirtualBox.
10887	</desc>
10888	<attribute name="creationMode" type="unsigned long" readonly="yes">
10889	<desc>
10890	The creation mode.
10891	</desc>
10892	</attribute>
10893	<attribute name="disposition" type="unsigned long" readonly="yes">
10894	<desc>
10895	The disposition mode.
10896	</desc>
10897	</attribute>
10898	<attribute name="eventSource" type="IEventSource" readonly="yes">
10899	<desc>
10900	Event source for guest session events.
10901	</desc>
10902	</attribute>
10903	<attribute name="fileName" type="wstring" readonly="yes">
10904	<desc>
10905	Full path of the actual file name of this file.
10906	</desc>
10907	</attribute>
10908	<attribute name="initialSize" type="long long" readonly="yes">
10909	<desc>
10910	The initial size in bytes when opened.
10911	</desc>
10912	</attribute>
10913	<attribute name="openMode" type="unsigned long" readonly="yes">
10914	<desc>
10915	The open mode.
10916	</desc>
10917	</attribute>
10918	<attribute name="offset" type="long long" readonly="yes">
10919	<desc>
10920	Current read/write offset in bytes.
10921	</desc>
10922	</attribute>
10923	<attribute name="status" type="FileStatus" readonly="yes">
10924	<desc>
10925	Current file status.
10926	</desc>
10927	</attribute>
10928
10929	<method name="close">
10930	<desc>
10931	Closes this file. After closing operations like reading data,
10932	writing data or querying information will not be possible anymore.
10933	</desc>
10934	</method>
10935
10936	<method name="queryInfo">
10937	<desc>
10938	Queries information about this file.
10939
10940	<result name="E_NOTIMPL">
10941	The method is not implemented yet.
10942	</result>
10943	</desc>
10944	<param name="objInfo" type="IFsObjInfo" dir="return">
10945	<desc>Object information of this file. Also see
10946	<link to="IFsObjInfo"/>.</desc>
10947	</param>
10948	</method>
10949
10950	<method name="read">
10951	<desc>
10952	Reads data from this file.
10953
10954	<result name="E_NOTIMPL">
10955	The method is not implemented yet.
10956	</result>
10957	</desc>
10958	<param name="toRead" type="unsigned long" dir="in">
10959	<desc>Number of bytes to read.</desc>
10960	</param>
10961	<param name="timeoutMS" type="unsigned long" dir="in">
10962	<desc>
10963	Timeout (in ms) to wait for the operation to complete.
10964	Pass 0 for an infinite timeout.
10965	</desc>
10966	</param>
10967	<param name="data" type="octet" dir="return" safearray="yes">
10968	<desc>Array of data read.</desc>
10969	</param>
10970	</method>
10971
10972	<method name="readAt">
10973	<desc>
10974	Reads data from an offset of this file.
10975
10976	<result name="E_NOTIMPL">
10977	The method is not implemented yet.
10978	</result>
10979	</desc>
10980	<param name="offset" type="long long" dir="in">
10981	<desc>Offset in bytes to start reading.</desc>
10982	</param>
10983	<param name="toRead" type="unsigned long" dir="in">
10984	<desc>Number of bytes to read.</desc>
10985	</param>
10986	<param name="timeoutMS" type="unsigned long" dir="in">
10987	<desc>
10988	Timeout (in ms) to wait for the operation to complete.
10989	Pass 0 for an infinite timeout.
10990	</desc>
10991	</param>
10992	<param name="data" type="octet" dir="return" safearray="yes">
10993	<desc>Array of data read.</desc>
10994	</param>
10995	</method>
10996
10997	<method name="seek">
10998	<desc>
10999	Changes the read and write position of this file.
11000
11001	<result name="E_NOTIMPL">
11002	The method is not implemented yet.
11003	</result>
11004	</desc>
11005	<param name="offset" type="long long" dir="in">
11006	<desc>Offset to seek.</desc>
11007	</param>
11008	<param name="whence" type="FileSeekType" dir="in">
11009	<desc>
11010	Seek mode; see <link to="FileSeekType"/> for more information.
11011	</desc>
11012	</param>
11013	</method>
11014
11015	<method name="setACL">
11016	<desc>
11017	Sets the ACL of this file.
11018
11019	<result name="E_NOTIMPL">
11020	The method is not implemented yet.
11021	</result>
11022	</desc>
11023	<param name="acl" type="wstring" dir="in">
11024	<desc>ACL string to set.</desc>
11025	</param>
11026	</method>
11027
11028	<method name="write">
11029	<desc>
11030	Writes bytes to this file.
11031	</desc>
11032	<param name="data" type="octet" dir="in" safearray="yes">
11033	<desc>
11034	Array of bytes to write. The size of the array also specifies
11035	how much to write.
11036	</desc>
11037	</param>
11038	<param name="timeoutMS" type="unsigned long" dir="in">
11039	<desc>
11040	Timeout (in ms) to wait for the operation to complete.
11041	Pass 0 for an infinite timeout.
11042	</desc>
11043	</param>
11044	<param name="written" type="unsigned long" dir="return">
11045	<desc>How much bytes were written.</desc>
11046	</param>
11047	</method>
11048
11049	<method name="writeAt">
11050	<desc>
11051	Writes bytes at a certain offset to this file.
11052
11053	<result name="E_NOTIMPL">
11054	The method is not implemented yet.
11055	</result>
11056	</desc>
11057	<param name="offset" type="long long" dir="in">
11058	<desc>Offset in bytes to start writing.</desc>
11059	</param>
11060	<param name="data" type="octet" dir="in" safearray="yes">
11061	<desc>
11062	Array of bytes to write. The size of the array also specifies
11063	how much to write.
11064	</desc>
11065	</param>
11066	<param name="timeoutMS" type="unsigned long" dir="in">
11067	<desc>
11068	Timeout (in ms) to wait for the operation to complete.
11069	Pass 0 for an infinite timeout.
11070	</desc>
11071	</param>
11072	<param name="written" type="unsigned long" dir="return">
11073	<desc>How much bytes were written.</desc>
11074	</param>
11075	</method>
11076
11077	</interface>
11078
11079	<interface
11080	name="IGuestFile" extends="IFile"
11081	uuid="60661aec-145f-4d11-b80e-8ea151598093"
11082	wsmap="managed"
11083	>
11084	<desc>
11085	Implementation of the <link to="IFile" /> object
11086	for files on the guest.
11087	</desc>
11088	</interface>
11089
11090	<interface
11091	name="IFsObjInfo" extends="$unknown"
11092	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
11093	wsmap="managed"
11094	>
11095	<desc>
11096	Abstract parent interface for VirtualBox file system object information.
11097	This can be information about a file or a directory, for example.
11098	</desc>
11099
11100	<attribute name="accessTime" type="long long" readonly="yes">
11101	<desc>
11102	Time of last access (st_atime).
11103	</desc>
11104	</attribute>
11105	<attribute name="allocatedSize" type="long long" readonly="yes">
11106	<desc>
11107	Disk allocation size (st_blocks * DEV_BSIZE).
11108	</desc>
11109	</attribute>
11110	<attribute name="birthTime" type="long long" readonly="yes">
11111	<desc>
11112	Time of file birth (st_birthtime).
11113	</desc>
11114	</attribute>
11115	<attribute name="changeTime" type="long long" readonly="yes">
11116	<desc>
11117	Time of last status change (st_ctime).
11118	</desc>
11119	</attribute>
11120	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
11121	<desc>
11122	The device number of a character or block device type object (st_rdev).
11123	</desc>
11124	</attribute>
11125	<attribute name="fileAttributes" type="wstring" readonly="yes">
11126	<desc>
11127	File attributes. Not implemented yet.
11128	</desc>
11129	</attribute>
11130	<attribute name="generationId" type="unsigned long" readonly="yes">
11131	<desc>
11132	The current generation number (st_gen).
11133	</desc>
11134	</attribute>
11135	<attribute name="GID" type="unsigned long" readonly="yes">
11136	<desc>
11137	The group the filesystem object is assigned (st_gid).
11138	</desc>
11139	</attribute>
11140	<attribute name="groupName" type="wstring" readonly="yes">
11141	<desc>
11142	The group name.
11143	</desc>
11144	</attribute>
11145	<attribute name="hardLinks" type="unsigned long" readonly="yes">
11146	<desc>
11147	Number of hard links to this filesystem object (st_nlink).
11148	</desc>
11149	</attribute>
11150	<attribute name="modificationTime" type="long long" readonly="yes">
11151	<desc>
11152	Time of last data modification (st_mtime).
11153	</desc>
11154	</attribute>
11155	<attribute name="name" type="wstring" readonly="yes">
11156	<desc>
11157	The object's name.
11158	</desc>
11159	</attribute>
11160	<attribute name="nodeId" type="long long" readonly="yes">
11161	<desc>
11162	The unique identifier (within the filesystem) of this filesystem object (st_ino).
11163	</desc>
11164	</attribute>
11165	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
11166	<desc>
11167	The device number of the device which this filesystem object resides on (st_dev).
11168	</desc>
11169	</attribute>
11170	<attribute name="objectSize" type="long long" readonly="yes">
11171	<desc>
11172	The logical size (st_size). For normal files this is the size of the file.
11173	For symbolic links, this is the length of the path name contained in the
11174	symbolic link. For other objects this fields needs to be specified.
11175	</desc>
11176	</attribute>
11177	<attribute name="type" type="FsObjType" readonly="yes">
11178	<desc>
11179	The object type. See <link to="FsObjType" /> for more.
11180	</desc>
11181	</attribute>
11182	<attribute name="UID" type="unsigned long" readonly="yes">
11183	<desc>
11184	The user owning the filesystem object (st_uid).
11185	</desc>
11186	</attribute>
11187	<attribute name="userFlags" type="unsigned long" readonly="yes">
11188	<desc>
11189	User flags (st_flags).
11190	</desc>
11191	</attribute>
11192	<attribute name="userName" type="wstring" readonly="yes">
11193	<desc>
11194	The user name.
11195	</desc>
11196	</attribute>
11197
11198	</interface>
11199
11200	<interface
11201	name="IGuestFsObjInfo" extends="IFsObjInfo"
11202	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
11203	wsmap="managed"
11204	>
11205	<desc>
11206	Represents the guest implementation of the
11207	<link to="IFsObjInfo" /> object.
11208	</desc>
11209	</interface>
11210
11211	<interface
11212	name="IGuest" extends="$unknown"
11213	uuid="1a1969c1-a583-4975-9810-1dd0f0e3a8ae"
11214	wsmap="managed"
11215	>
11216	<desc>
11217	The IGuest interface represents information about the operating system
11218	running inside the virtual machine. Used in
11219	<link to="IConsole::guest"/>.
11220
11221	IGuest provides information about the guest operating system, whether
11222	Guest Additions are installed and other OS-specific virtual machine
11223	properties.
11224	</desc>
11225
11226	<attribute name="OSTypeId" type="wstring" readonly="yes">
11227	<desc>
11228	Identifier of the Guest OS type as reported by the Guest
11229	Additions.
11230	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
11231	an IGuestOSType object representing details about the given
11232	Guest OS type.
11233	<note>
11234	If Guest Additions are not installed, this value will be
11235	the same as <link to="IMachine::OSTypeId"/>.
11236	</note>
11237	</desc>
11238	</attribute>
11239
11240	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
11241	<desc>
11242	Current run level of the Guest Additions.
11243	</desc>
11244	</attribute>
11245
11246	<attribute name="additionsVersion" type="wstring" readonly="yes">
11247	<desc>
11248	Version of the Guest Additions in the same format as
11249	<link to="IVirtualBox::version"/>.
11250	</desc>
11251	</attribute>
11252
11253	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
11254	<desc>
11255	The internal build revision number of the additions.
11256
11257	See also <link to="IVirtualBox::revision"/>.
11258	</desc>
11259	</attribute>
11260
11261	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
11262	<desc>
11263	Array of current known facilities. Only returns facilities where a status is known,
11264	e.g. facilities with an unknown status will not be returned.
11265	</desc>
11266	</attribute>
11267
11268	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
11269	<desc>Returns a collection of all opened guest sessions.</desc>
11270	</attribute>
11271
11272	<attribute name="memoryBalloonSize" type="unsigned long">
11273	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
11274	</attribute>
11275
11276	<attribute name="statisticsUpdateInterval" type="unsigned long">
11277	<desc>Interval to update guest statistics in seconds.</desc>
11278	</attribute>
11279
11280	<method name="internalGetStatistics">
11281	<desc>
11282	Internal method; do not use as it might change at any time.
11283	</desc>
11284	<param name="cpuUser" type="unsigned long" dir="out">
11285	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
11286	</param>
11287	<param name="cpuKernel" type="unsigned long" dir="out">
11288	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
11289	</param>
11290	<param name="cpuIdle" type="unsigned long" dir="out">
11291	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
11292	</param>
11293	<param name="memTotal" type="unsigned long" dir="out">
11294	<desc>Total amount of physical guest RAM.</desc>
11295	</param>
11296	<param name="memFree" type="unsigned long" dir="out">
11297	<desc>Free amount of physical guest RAM.</desc>
11298	</param>
11299	<param name="memBalloon" type="unsigned long" dir="out">
11300	<desc>Amount of ballooned physical guest RAM.</desc>
11301	</param>
11302	<param name="memShared" type="unsigned long" dir="out">
11303	<desc>Amount of shared physical guest RAM.</desc>
11304	</param>
11305	<param name="memCache" type="unsigned long" dir="out">
11306	<desc>Total amount of guest (disk) cache memory.</desc>
11307	</param>
11308	<param name="pagedTotal" type="unsigned long" dir="out">
11309	<desc>Total amount of space in the page file.</desc>
11310	</param>
11311	<param name="memAllocTotal" type="unsigned long" dir="out">
11312	<desc>Total amount of memory allocated by the hypervisor.</desc>
11313	</param>
11314	<param name="memFreeTotal" type="unsigned long" dir="out">
11315	<desc>Total amount of free memory available in the hypervisor.</desc>
11316	</param>
11317	<param name="memBalloonTotal" type="unsigned long" dir="out">
11318	<desc>Total amount of memory ballooned by the hypervisor.</desc>
11319	</param>
11320	<param name="memSharedTotal" type="unsigned long" dir="out">
11321	<desc>Total amount of shared memory in the hypervisor.</desc>
11322	</param>
11323	</method>
11324
11325	<method name="getFacilityStatus">
11326	<desc>
11327	Get the current status of a Guest Additions facility.
11328	</desc>
11329	<param name="facility" type="AdditionsFacilityType" dir="in">
11330	<desc>Facility to check status for.</desc>
11331	</param>
11332	<param name="timestamp" type="long long" dir="out">
11333	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
11334	</param>
11335	<param name="status" type="AdditionsFacilityStatus" dir="return">
11336	<desc>The current (latest) facility status.</desc>
11337	</param>
11338	</method>
11339
11340	<method name="getAdditionsStatus">
11341	<desc>
11342	Retrieve the current status of a certain Guest Additions run level.
11343
11344	<result name="VBOX_E_NOT_SUPPORTED">
11345	Wrong status level specified.
11346	</result>
11347
11348	</desc>
11349	<param name="level" type="AdditionsRunLevelType" dir="in">
11350	<desc>Status level to check</desc>
11351	</param>
11352	<param name="active" type="boolean" dir="return">
11353	<desc>Flag whether the status level has been reached or not</desc>
11354	</param>
11355	</method>
11356
11357	<method name="setCredentials">
11358	<desc>
11359	Store login credentials that can be queried by guest operating
11360	systems with Additions installed. The credentials are transient
11361	to the session and the guest may also choose to erase them. Note
11362	that the caller cannot determine whether the guest operating system
11363	has queried or made use of the credentials.
11364
11365	<result name="VBOX_E_VM_ERROR">
11366	VMM device is not available.
11367	</result>
11368
11369	</desc>
11370	<param name="userName" type="wstring" dir="in">
11371	<desc>User name string, can be empty</desc>
11372	</param>
11373	<param name="password" type="wstring" dir="in">
11374	<desc>Password string, can be empty</desc>
11375	</param>
11376	<param name="domain" type="wstring" dir="in">
11377	<desc>Domain name (guest logon scheme specific), can be empty</desc>
11378	</param>
11379	<param name="allowInteractiveLogon" type="boolean" dir="in">
11380	<desc>
11381	Flag whether the guest should alternatively allow the user to
11382	interactively specify different credentials. This flag might
11383	not be supported by all versions of the Additions.
11384	</desc>
11385	</param>
11386	</method>
11387
11388	<method name="dragHGEnter">
11389	<desc>
11390	Informs the guest about a Drag and Drop enter event.
11391
11392	This is used in Host - Guest direction.
11393
11394	<result name="VBOX_E_VM_ERROR">
11395	VMM device is not available.
11396	</result>
11397
11398	</desc>
11399	<param name="screenId" type="unsigned long" dir="in">
11400	<desc>The screen id where the Drag and Drop event occured.</desc>
11401	</param>
11402	<param name="y" type="unsigned long" dir="in">
11403	<desc>y-position of the event.</desc>
11404	</param>
11405	<param name="x" type="unsigned long" dir="in">
11406	<desc>x-position of the event.</desc>
11407	</param>
11408	<param name="defaultAction" type="DragAndDropAction" dir="in">
11409	<desc>The default action to use.</desc>
11410	</param>
11411	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11412	<desc>The actions which are allowed.</desc>
11413	</param>
11414	<param name="formats" type="wstring" dir="in" safearray="yes">
11415	<desc>The supported mime types.</desc>
11416	</param>
11417	<param name="resultAction" type="DragAndDropAction" dir="return">
11418	<desc>The resulting action of this event.</desc>
11419	</param>
11420	</method>
11421
11422	<method name="dragHGMove">
11423	<desc>
11424	Informs the guest about a Drag and Drop move event.
11425
11426	This is used in Host - Guest direction.
11427
11428	<result name="VBOX_E_VM_ERROR">
11429	VMM device is not available.
11430	</result>
11431
11432	</desc>
11433	<param name="screenId" type="unsigned long" dir="in">
11434	<desc>The screen id where the Drag and Drop event occured.</desc>
11435	</param>
11436	<param name="x" type="unsigned long" dir="in">
11437	<desc>x-position of the event.</desc>
11438	</param>
11439	<param name="y" type="unsigned long" dir="in">
11440	<desc>y-position of the event.</desc>
11441	</param>
11442	<param name="defaultAction" type="DragAndDropAction" dir="in">
11443	<desc>The default action to use.</desc>
11444	</param>
11445	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11446	<desc>The actions which are allowed.</desc>
11447	</param>
11448	<param name="formats" type="wstring" dir="in" safearray="yes">
11449	<desc>The supported mime types.</desc>
11450	</param>
11451	<param name="resultAction" type="DragAndDropAction" dir="return">
11452	<desc>The resulting action of this event.</desc>
11453	</param>
11454	</method>
11455
11456	<method name="dragHGLeave">
11457	<desc>
11458	Informs the guest about a Drag and Drop leave event.
11459
11460	This is used in Host - Guest direction.
11461
11462	<result name="VBOX_E_VM_ERROR">
11463	VMM device is not available.
11464	</result>
11465
11466	</desc>
11467	<param name="screenId" type="unsigned long" dir="in">
11468	<desc>The screen id where the Drag and Drop event occured.</desc>
11469	</param>
11470	</method>
11471
11472	<method name="dragHGDrop">
11473	<desc>
11474	Informs the guest about a drop event.
11475
11476	This is used in Host - Guest direction.
11477
11478	<result name="VBOX_E_VM_ERROR">
11479	VMM device is not available.
11480	</result>
11481
11482	</desc>
11483	<param name="screenId" type="unsigned long" dir="in">
11484	<desc>The screen id where the Drag and Drop event occured.</desc>
11485	</param>
11486	<param name="x" type="unsigned long" dir="in">
11487	<desc>x-position of the event.</desc>
11488	</param>
11489	<param name="y" type="unsigned long" dir="in">
11490	<desc>y-position of the event.</desc>
11491	</param>
11492	<param name="defaultAction" type="DragAndDropAction" dir="in">
11493	<desc>The default action to use.</desc>
11494	</param>
11495	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11496	<desc>The actions which are allowed.</desc>
11497	</param>
11498	<param name="formats" type="wstring" dir="in" safearray="yes">
11499	<desc>The supported mime types.</desc>
11500	</param>
11501	<param name="format" type="wstring" dir="out">
11502	<desc>The resulting format of this event.</desc>
11503	</param>
11504	<param name="resultAction" type="DragAndDropAction" dir="return">
11505	<desc>The resulting action of this event.</desc>
11506	</param>
11507	</method>
11508
11509	<method name="dragHGPutData">
11510	<desc>
11511	Informs the guest about a drop data event.
11512
11513	This is used in Host - Guest direction.
11514
11515	<result name="VBOX_E_VM_ERROR">
11516	VMM device is not available.
11517	</result>
11518
11519	</desc>
11520	<param name="screenId" type="unsigned long" dir="in">
11521	<desc>The screen id where the Drag and Drop event occured.</desc>
11522	</param>
11523	<param name="format" type="wstring" dir="in">
11524	<desc>The mime type the data is in.</desc>
11525	</param>
11526	<param name="data" type="octet" dir="in" safearray="yes">
11527	<desc>The actual data.</desc>
11528	</param>
11529	<param name="progress" type="IProgress" dir="return">
11530	<desc>Progress object to track the operation completion.</desc>
11531	</param>
11532	</method>
11533
11534	<method name="dragGHPending">
11535	<desc>
11536	Ask the guest if there is any Drag and Drop operation pending in the guest.
11537
11538	If no Drag and Drop operation is pending currently, Ignore is returned.
11539
11540	This is used in Guest - Host direction.
11541
11542	<result name="VBOX_E_VM_ERROR">
11543	VMM device is not available.
11544	</result>
11545
11546	</desc>
11547	<param name="screenId" type="unsigned long" dir="in">
11548	<desc>The screen id where the Drag and Drop event occured.</desc>
11549	</param>
11550	<param name="formats" type="wstring" dir="out" safearray="yes">
11551	<desc>On return the supported mime types.</desc>
11552	</param>
11553	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11554	<desc>On return the actions which are allowed.</desc>
11555	</param>
11556	<param name="defaultAction" type="DragAndDropAction" dir="return">
11557	<desc>On return the default action to use.</desc>
11558	</param>
11559	</method>
11560
11561	<method name="dragGHDropped">
11562	<desc>
11563	Informs the guest that a drop event occured for a pending Drag and Drop event.
11564
11565	This is used in Guest - Host direction.
11566
11567	<result name="VBOX_E_VM_ERROR">
11568	VMM device is not available.
11569	</result>
11570
11571	</desc>
11572
11573	<param name="format" type="wstring" dir="in">
11574	<desc>The mime type the data must be in.</desc>
11575	</param>
11576	<param name="action" type="DragAndDropAction" dir="in">
11577	<desc>The action to use.</desc>
11578	</param>
11579	<param name="progress" type="IProgress" dir="return">
11580	<desc>Progress object to track the operation completion.</desc>
11581	</param>
11582	</method>
11583
11584	<method name="dragGHGetData">
11585	<desc>
11586	Fetch the data of a previously Drag and Drop event from the guest.
11587
11588	This is used in Guest - Host direction.
11589
11590	<result name="VBOX_E_VM_ERROR">
11591	VMM device is not available.
11592	</result>
11593
11594	</desc>
11595
11596	<param name="data" type="octet" safearray="yes" dir="return">
11597	<desc>The actual data.</desc>
11598	</param>
11599	</method>
11600
11601	<method name="createSession">
11602	<desc>
11603	Creates a new guest session for controlling the guest.
11604
11605	A guest session represents one impersonated user account on the guest, so
11606	every operation will use the same credentials specified when creating
11607	the session object via <link to="IGuest::createSession"/>. Anonymous
11608	sessions, that is, sessions without specifying a valid
11609	user account on the guest are not allowed due to security reasons.
11610
11611	There can be a maximum of 32 sessions at once per VM. Each session keeps
11612	track of its started guest processes, opened guest files or guest directories.
11613	To work on guest files or directories a guest session offers methods to open
11614	or create such objects (see <link to="IGuestSession::fileOpen"/> or
11615	<link to="IGuestSession::directoryOpen"/> for example).
11616
11617	When done with either of these objects, including the guest session itself,
11618	use the appropriate close() method to let the object do its cleanup work.
11619
11620	Every guest session has its own environment variable block which gets
11621	automatically applied when starting a new guest process via
11622	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
11623	To override (or unset) certain environment variables already set by the
11624	guest session, one can specify a per-process environment block when using
11625	one of the both above mentioned process creation calls.
11626
11627	Closing a session via <link to="IGuestSession::close" /> will try to close
11628	all the mentioned objects above unless these objects are still used by
11629	a client.
11630	</desc>
11631	<param name="user" type="wstring" dir="in">
11632	<desc>
11633	User name this session will be using to control the guest; has to exist
11634	and have the appropriate rights to execute programs in the VM. Must not
11635	be empty.
11636	</desc>
11637	</param>
11638	<param name="password" type="wstring" dir="in">
11639	<desc>
11640	Password of the user account to be used. Empty passwords are allowed.
11641	</desc>
11642	</param>
11643	<param name="domain" type="wstring" dir="in">
11644	<desc>
11645	Domain name of the user account to be used if the guest is part of
11646	a domain. Optional. This feature is not implemented yet.
11647	</desc>
11648	</param>
11649	<param name="sessionName" type="wstring" dir="in">
11650	<desc>
11651	The session's friendly name. Optional, can be empty.
11652	</desc>
11653	</param>
11654	<param name="guestSession" type="IGuestSession" dir="return">
11655	<desc>
11656	The newly created session object.
11657	</desc>
11658	</param>
11659	</method>
11660
11661	<method name="findSession">
11662	<desc>
11663	Finds guest sessions by their friendly name and returns an interface
11664	array with all found guest sessions.
11665	</desc>
11666	<param name="sessionName" type="wstring" dir="in">
11667	<desc>
11668	The session's friendly name to find. Wildcards like ? and * are allowed.
11669	</desc>
11670	</param>
11671	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11672	<desc>
11673	Array with all guest sessions found matching the name specified.
11674	</desc>
11675	</param>
11676	</method>
11677
11678	<method name="updateGuestAdditions">
11679	<desc>
11680	Automatically updates already installed Guest Additions in a VM.
11681
11682	At the moment only Windows guests are supported.
11683
11684	Because the VirtualBox Guest Additions drivers are not WHQL-certified
11685	yet there might be warning dialogs during the actual Guest Additions
11686	update. These need to be confirmed manually in order to continue the
11687	installation process. This applies to Windows 2000 and Windows XP guests
11688	and therefore these guests can't be updated in a fully automated fashion
11689	without user interaction. However, to start a Guest Additions update for
11690	the mentioned Windows versions anyway, the flag
11691	AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See
11692	<link to="AdditionsUpdateFlag"/> for more information.
11693
11694	<result name="VBOX_E_NOT_SUPPORTED">
11695	Guest OS is not supported for automated Guest Additions updates or the
11696	already installed Guest Additions are not ready yet.
11697	</result>
11698
11699	<result name="VBOX_E_IPRT_ERROR">
11700	Error while updating.
11701	</result>
11702
11703	</desc>
11704	<param name="source" type="wstring" dir="in">
11705	<desc>
11706	Path to the Guest Additions .ISO file to use for the update.
11707	</desc>
11708	</param>
11709	<param name="arguments" type="wstring" dir="in" safearray="yes">
11710	<desc>
11711	Optional command line arguments to use for the Guest Additions
11712	installer. Useful for retrofitting features which weren't installed
11713	before on the guest.
11714	</desc>
11715	</param>
11716	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11717	<desc>
11718	<link to="AdditionsUpdateFlag"/> flags.
11719	</desc>
11720	</param>
11721	<param name="progress" type="IProgress" dir="return">
11722	<desc>Progress object to track the operation completion.</desc>
11723	</param>
11724	</method>
11725
11726	</interface>
11727
11728
11729	<!--
11730	// IProgress
11731	/////////////////////////////////////////////////////////////////////////
11732	-->
11733
11734	<interface
11735	name="IProgress" extends="$unknown"
11736	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11737	wsmap="managed"
11738	>
11739	<desc>
11740	The IProgress interface is used to track and control
11741	asynchronous tasks within VirtualBox.
11742
11743	An instance of this is returned every time VirtualBox starts
11744	an asynchronous task (in other words, a separate thread) which
11745	continues to run after a method call returns. For example,
11746	<link to="IConsole::saveState" />, which saves the state of
11747	a running virtual machine, can take a long time to complete.
11748	To be able to display a progress bar, a user interface such as
11749	the VirtualBox graphical user interface can use the IProgress
11750	object returned by that method.
11751
11752	Note that IProgress is a "read-only" interface in the sense
11753	that only the VirtualBox internals behind the Main API can
11754	create and manipulate progress objects, whereas client code
11755	can only use the IProgress object to monitor a task's
11756	progress and, if <link to="#cancelable" /> is @c true,
11757	cancel the task by calling <link to="#cancel" />.
11758
11759	A task represented by IProgress consists of either one or
11760	several sub-operations that run sequentially, one by one (see
11761	<link to="#operation" /> and <link to="#operationCount" />).
11762	Every operation is identified by a number (starting from 0)
11763	and has a separate description.
11764
11765	You can find the individual percentage of completion of the current
11766	operation in <link to="#operationPercent" /> and the
11767	percentage of completion of the task as a whole
11768	in <link to="#percent" />.
11769
11770	Similarly, you can wait for the completion of a particular
11771	operation via <link to="#waitForOperationCompletion" /> or
11772	for the completion of the whole task via
11773	<link to="#waitForCompletion" />.
11774	</desc>
11775
11776	<attribute name="id" type="uuid" mod="string" readonly="yes">
11777	<desc>ID of the task.</desc>
11778	</attribute>
11779
11780	<attribute name="description" type="wstring" readonly="yes">
11781	<desc>Description of the task.</desc>
11782	</attribute>
11783
11784	<attribute name="initiator" type="$unknown" readonly="yes">
11785	<desc>Initiator of the task.</desc>
11786	</attribute>
11787
11788	<attribute name="cancelable" type="boolean" readonly="yes">
11789	<desc>Whether the task can be interrupted.</desc>
11790	</attribute>
11791
11792	<attribute name="percent" type="unsigned long" readonly="yes">
11793	<desc>
11794	Current progress value of the task as a whole, in percent.
11795	This value depends on how many operations are already complete.
11796	Returns 100 if <link to="#completed" /> is @c true.
11797	</desc>
11798	</attribute>
11799
11800	<attribute name="timeRemaining" type="long" readonly="yes">
11801	<desc>
11802	Estimated remaining time until the task completes, in
11803	seconds. Returns 0 once the task has completed; returns -1
11804	if the remaining time cannot be computed, in particular if
11805	the current progress is 0.
11806
11807	Even if a value is returned, the estimate will be unreliable
11808	for low progress values. It will become more reliable as the
11809	task progresses; it is not recommended to display an ETA
11810	before at least 20% of a task have completed.
11811	</desc>
11812	</attribute>
11813
11814	<attribute name="completed" type="boolean" readonly="yes">
11815	<desc>Whether the task has been completed.</desc>
11816	</attribute>
11817
11818	<attribute name="canceled" type="boolean" readonly="yes">
11819	<desc>Whether the task has been canceled.</desc>
11820	</attribute>
11821
11822	<attribute name="resultCode" type="long" readonly="yes">
11823	<desc>
11824	Result code of the progress task.
11825	Valid only if <link to="#completed"/> is @c true.
11826	</desc>
11827	</attribute>
11828
11829	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11830	<desc>
11831	Extended information about the unsuccessful result of the
11832	progress operation. May be @c null if no extended information
11833	is available.
11834	Valid only if <link to="#completed"/> is @c true and
11835	<link to="#resultCode"/> indicates a failure.
11836	</desc>
11837	</attribute>
11838
11839	<attribute name="operationCount" type="unsigned long" readonly="yes">
11840	<desc>
11841	Number of sub-operations this task is divided into.
11842	Every task consists of at least one suboperation.
11843	</desc>
11844	</attribute>
11845
11846	<attribute name="operation" type="unsigned long" readonly="yes">
11847	<desc>Number of the sub-operation being currently executed.</desc>
11848	</attribute>
11849
11850	<attribute name="operationDescription" type="wstring" readonly="yes">
11851	<desc>
11852	Description of the sub-operation being currently executed.
11853	</desc>
11854	</attribute>
11855
11856	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11857	<desc>Progress value of the current sub-operation only, in percent.</desc>
11858	</attribute>
11859
11860	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11861	<desc>Weight value of the current sub-operation only.</desc>
11862	</attribute>
11863
11864	<attribute name="timeout" type="unsigned long">
11865	<desc>
11866	When non-zero, this specifies the number of milliseconds after which
11867	the operation will automatically be canceled. This can only be set on
11868	cancelable objects.
11869	</desc>
11870	</attribute>
11871
11872	<method name="setCurrentOperationProgress">
11873	<desc>Internal method, not to be called externally.</desc>
11874	<param name="percent" type="unsigned long" dir="in" />
11875	</method>
11876	<method name="setNextOperation">
11877	<desc>Internal method, not to be called externally.</desc>
11878	<param name="nextOperationDescription" type="wstring" dir="in" />
11879	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11880	</method>
11881
11882	<method name="waitForCompletion">
11883	<desc>
11884	Waits until the task is done (including all sub-operations)
11885	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11886
11887	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11888	thread are not processed while waiting. Neglecting event queues may
11889	have dire consequences (degrade performance, resource hogs,
11890	deadlocks, etc.), this is specially so for the main thread on
11891	platforms using XPCOM. Callers are adviced wait for short periods
11892	and service their event queues between calls, or to create a worker
11893	thread to do the waiting.
11894
11895	<result name="VBOX_E_IPRT_ERROR">
11896	Failed to wait for task completion.
11897	</result>
11898	</desc>
11899
11900	<param name="timeout" type="long" dir="in">
11901	<desc>
11902	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11903	</desc>
11904	</param>
11905	</method>
11906
11907	<method name="waitForOperationCompletion">
11908	<desc>
11909	Waits until the given operation is done with a given timeout in
11910	milliseconds; specify -1 for an indefinite wait.
11911
11912	See <link to="#waitForCompletion"> for event queue considerations.</link>
11913
11914	<result name="VBOX_E_IPRT_ERROR">
11915	Failed to wait for operation completion.
11916	</result>
11917
11918	</desc>
11919	<param name="operation" type="unsigned long" dir="in">
11920	<desc>
11921	Number of the operation to wait for.
11922	Must be less than <link to="#operationCount"/>.
11923	</desc>
11924	</param>
11925	<param name="timeout" type="long" dir="in">
11926	<desc>
11927	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11928	</desc>
11929	</param>
11930	</method>
11931
11932	<method name="waitForAsyncProgressCompletion">
11933	<desc>
11934	Waits until the other task is completed (including all
11935	sub-operations) and forward all changes from the other progress to
11936	this progress. This means sub-operation number, description, percent
11937	and so on.
11938
11939	You have to take care on setting up at least the same count on
11940	sub-operations in this progress object like there are in the other
11941	progress object.
11942
11943	If the other progress object supports cancel and this object gets any
11944	cancel request (when here enabled as well), it will be forwarded to
11945	the other progress object.
11946
11947	If there is an error in the other progress, this error isn't
11948	automatically transfered to this progress object. So you have to
11949	check any operation error within the other progress object, after
11950	this method returns.
11951	</desc>
11952
11953	<param name="pProgressAsync" type="IProgress" dir="in">
11954	<desc>
11955	The progress object of the asynchrony process.
11956	</desc>
11957	</param>
11958	</method>
11959
11960	<method name="cancel">
11961	<desc>
11962	Cancels the task.
11963	<note>
11964	If <link to="#cancelable"/> is @c false, then this method will fail.
11965	</note>
11966
11967	<result name="VBOX_E_INVALID_OBJECT_STATE">
11968	Operation cannot be canceled.
11969	</result>
11970
11971	</desc>
11972	</method>
11973
11974	</interface>
11975
11976	<!--
11977	// ISnapshot
11978	/////////////////////////////////////////////////////////////////////////
11979	-->
11980
11981	<interface
11982	name="ISnapshot" extends="$unknown"
11983	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11984	wsmap="managed"
11985	>
11986	<desc>
11987	The ISnapshot interface represents a snapshot of the virtual
11988	machine.
11989
11990	Together with the differencing media that are created
11991	when a snapshot is taken, a machine can be brought back to
11992	the exact state it was in when the snapshot was taken.
11993
11994	The ISnapshot interface has no methods, only attributes; snapshots
11995	are controlled through methods of the <link to="IConsole" /> interface
11996	which also manage the media associated with the snapshot.
11997	The following operations exist:
11998
11999	<ul>
12000	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
12001	by creating new, empty differencing images for the machine's
12002	media and saving the VM settings and (if the VM is running)
12003	the current VM state in the snapshot.
12004
12005	The differencing images will then receive all data written to
12006	the machine's media, while their parent (base) images
12007	remain unmodified after the snapshot has been taken (see
12008	<link to="IMedium" /> for details about differencing images).
12009	This simplifies restoring a machine to the state of a snapshot:
12010	only the differencing images need to be deleted.
12011
12012	The current machine state is not changed by taking a snapshot
12013	except that <link to="IMachine::currentSnapshot" /> is set to
12014	the newly created snapshot, which is also added to the machine's
12015	snapshots tree.
12016	</li>
12017
12018	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
12019	the state of a previous snapshot by deleting the differencing
12020	image of each of the machine's media and setting the machine's
12021	settings and state to the state that was saved in the snapshot (if any).
12022
12023	This destroys the machine's current state. After calling this,
12024	<link to="IMachine::currentSnapshot" /> points to the snapshot
12025	that was restored.
12026	</li>
12027
12028	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
12029	without affecting the current machine state.
12030
12031	This does not change the current machine state, but instead frees the
12032	resources allocated when the snapshot was taken: the settings and machine
12033	state file are deleted (if any), and the snapshot's differencing image for
12034	each of the machine's media gets merged with its parent image.
12035
12036	Neither the current machine state nor other snapshots are affected
12037	by this operation, except that parent media will be modified
12038	to contain the disk data associated with the snapshot being deleted.
12039
12040	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
12041	attribute is set to the current snapshot's parent or @c null if it
12042	has no parent. Otherwise the attribute is unchanged.
12043	</li>
12044	</ul>
12045
12046	Each snapshot contains a copy of virtual machine's settings (hardware
12047	configuration etc.). This copy is contained in an immutable (read-only)
12048	instance of <link to="IMachine" /> which is available from the snapshot's
12049	<link to="#machine" /> attribute. When restoring the snapshot, these
12050	settings are copied back to the original machine.
12051
12052	In addition, if the machine was running when the
12053	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
12054	the current VM state is saved in the snapshot (similarly to what happens
12055	when a VM's state is saved). The snapshot is then said to be <i>online</i>
12056	because when restoring it, the VM will be running.
12057
12058	If the machine was in <link to="MachineState_Saved">saved</link> saved,
12059	the snapshot receives a copy of the execution state file
12060	(<link to="IMachine::stateFilePath"/>).
12061
12062	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
12063	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
12064	it then contains a so-called "zero execution state", representing a
12065	machine that is powered off.
12066	</desc>
12067
12068	<attribute name="id" type="uuid" mod="string" readonly="yes">
12069	<desc>UUID of the snapshot.</desc>
12070	</attribute>
12071
12072	<attribute name="name" type="wstring">
12073	<desc>Short name of the snapshot.
12074	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12075	be called implicitly.</note>
12076	</desc>
12077	</attribute>
12078
12079	<attribute name="description" type="wstring">
12080	<desc>Optional description of the snapshot.
12081	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12082	be called implicitly.</note>
12083	</desc>
12084	</attribute>
12085
12086	<attribute name="timeStamp" type="long long" readonly="yes">
12087	<desc>
12088	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
12089	</desc>
12090	</attribute>
12091
12092	<attribute name="online" type="boolean" readonly="yes">
12093	<desc>
12094	@c true if this snapshot is an online snapshot and @c false otherwise.
12095
12096	When this attribute is @c true, the
12097	<link to="IMachine::stateFilePath"/> attribute of the
12098	<link to="#machine"/> object associated with this snapshot
12099	will point to the saved state file. Otherwise, it will be
12100	an empty string.
12101	</desc>
12102	</attribute>
12103
12104	<attribute name="machine" type="IMachine" readonly="yes">
12105	<desc>
12106	Virtual machine this snapshot is taken on. This object
12107	stores all settings the machine had when taking this snapshot.
12108	<note>
12109	The returned machine object is immutable, i.e. no
12110	any settings can be changed.
12111	</note>
12112	</desc>
12113	</attribute>
12114
12115	<attribute name="parent" type="ISnapshot" readonly="yes">
12116	<desc>
12117	Parent snapshot (a snapshot this one is based on), or
12118	@c null if the snapshot has no parent (i.e. is the first snapshot).
12119	</desc>
12120	</attribute>
12121
12122	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
12123	<desc>
12124	Child snapshots (all snapshots having this one as a parent).
12125	By inspecting this attribute starting with a machine's root snapshot
12126	(which can be obtained by calling <link to="IMachine::findSnapshot" />
12127	with a @c null UUID), a machine's snapshots tree can be iterated over.
12128	</desc>
12129	</attribute>
12130
12131	<method name="getChildrenCount" const="yes">
12132	<desc>
12133	Returns the number of direct childrens of this snapshot.
12134	</desc>
12135	<param name="childrenCount" type="unsigned long" dir="return">
12136	<desc>
12137	</desc>
12138	</param>
12139	</method>
12140
12141	</interface>
12142
12143
12144	<!--
12145	// IMedium
12146	/////////////////////////////////////////////////////////////////////////
12147	-->
12148
12149	<enum
12150	name="MediumState"
12151	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
12152	>
12153	<desc>
12154	Virtual medium state.
12155	<see><link to="IMedium"/></see>
12156	</desc>
12157
12158	<const name="NotCreated" value="0">
12159	<desc>
12160	Associated medium storage does not exist (either was not created yet or
12161	was deleted).
12162	</desc>
12163	</const>
12164	<const name="Created" value="1">
12165	<desc>
12166	Associated storage exists and accessible; this gets set if the
12167	accessibility check performed by <link to="IMedium::refreshState" />
12168	was successful.
12169	</desc>
12170	</const>
12171	<const name="LockedRead" value="2">
12172	<desc>
12173	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
12174	no data modification is possible.
12175	</desc>
12176	</const>
12177	<const name="LockedWrite" value="3">
12178	<desc>
12179	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
12180	no concurrent data reading or modification is possible.
12181	</desc>
12182	</const>
12183	<const name="Inaccessible" value="4">
12184	<desc>
12185	Medium accessibility check (see <link to="IMedium::refreshState" />) has
12186	not yet been performed, or else, associated medium storage is not
12187	accessible. In the first case, <link to="IMedium::lastAccessError"/>
12188	is empty, in the second case, it describes the error that occurred.
12189	</desc>
12190	</const>
12191	<const name="Creating" value="5">
12192	<desc>
12193	Associated medium storage is being created.
12194	</desc>
12195	</const>
12196	<const name="Deleting" value="6">
12197	<desc>
12198	Associated medium storage is being deleted.
12199	</desc>
12200	</const>
12201	</enum>
12202
12203	<enum
12204	name="MediumType"
12205	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
12206	>
12207	<desc>
12208	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
12209	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
12210	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
12211	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
12212	</desc>
12213
12214	<const name="Normal" value="0">
12215	<desc>
12216	Normal medium (attached directly or indirectly, preserved
12217	when taking snapshots).
12218	</desc>
12219	</const>
12220	<const name="Immutable" value="1">
12221	<desc>
12222	Immutable medium (attached indirectly, changes are wiped out
12223	the next time the virtual machine is started).
12224	</desc>
12225	</const>
12226	<const name="Writethrough" value="2">
12227	<desc>
12228	Write through medium (attached directly, ignored when
12229	taking snapshots).
12230	</desc>
12231	</const>
12232	<const name="Shareable" value="3">
12233	<desc>
12234	Allow using this medium concurrently by several machines.
12235	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
12236	</desc>
12237	</const>
12238	<const name="Readonly" value="4">
12239	<desc>
12240	A readonly medium, which can of course be used by several machines.
12241	<note>Present and accepted since VirtualBox 4.0.</note>
12242	</desc>
12243	</const>
12244	<const name="MultiAttach" value="5">
12245	<desc>
12246	A medium which is indirectly attached, so that one base medium can
12247	be used for several VMs which have their own differencing medium to
12248	store their modifications. In some sense a variant of Immutable
12249	with unset AutoReset flag in each differencing medium.
12250	<note>Present and accepted since VirtualBox 4.0.</note>
12251	</desc>
12252	</const>
12253	</enum>
12254
12255	<enum
12256	name="MediumVariant"
12257	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
12258	>
12259	<desc>
12260	Virtual medium image variant. More than one flag may be set.
12261	<see><link to="IMedium"/></see>
12262	</desc>
12263
12264	<const name="Standard" value="0">
12265	<desc>
12266	No particular variant requested, results in using the backend default.
12267	</desc>
12268	</const>
12269	<const name="VmdkSplit2G" value="0x01">
12270	<desc>
12271	VMDK image split in chunks of less than 2GByte.
12272	</desc>
12273	</const>
12274	<const name="VmdkRawDisk" value="0x02">
12275	<desc>
12276	VMDK image representing a raw disk.
12277	</desc>
12278	</const>
12279	<const name="VmdkStreamOptimized" value="0x04">
12280	<desc>
12281	VMDK streamOptimized image. Special import/export format which is
12282	read-only/append-only.
12283	</desc>
12284	</const>
12285	<const name="VmdkESX" value="0x08">
12286	<desc>
12287	VMDK format variant used on ESX products.
12288	</desc>
12289	</const>
12290	<const name="Fixed" value="0x10000">
12291	<desc>
12292	Fixed image. Only allowed for base images.
12293	</desc>
12294	</const>
12295	<const name="Diff" value="0x20000">
12296	<desc>
12297	Differencing image. Only allowed for child images.
12298	</desc>
12299	</const>
12300	<const name="NoCreateDir" value="0x40000000">
12301	<desc>
12302	Special flag which suppresses automatic creation of the subdirectory.
12303	Only used when passing the medium variant as an input parameter.
12304	</desc>
12305	</const>
12306	</enum>
12307
12308	<interface
12309	name="IMediumAttachment" extends="$unknown"
12310	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
12311	wsmap="struct"
12312	>
12313	<desc>
12314	The IMediumAttachment interface links storage media to virtual machines.
12315	For each medium (<link to="IMedium"/>) which has been attached to a
12316	storage controller (<link to="IStorageController"/>) of a machine
12317	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
12318	method, one instance of IMediumAttachment is added to the machine's
12319	<link to="IMachine::mediumAttachments"/> array attribute.
12320
12321	Each medium attachment specifies the storage controller as well as a
12322	port and device number and the IMedium instance representing a virtual
12323	hard disk or floppy or DVD image.
12324
12325	For removable media (DVDs or floppies), there are two additional
12326	options. For one, the IMedium instance can be @c null to represent
12327	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
12328	secondly, the medium can be one of the pseudo-media for host drives
12329	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
12330
12331	<h3>Attaching Hard Disks</h3>
12332
12333	Hard disks are attached to virtual machines using the
12334	<link to="IMachine::attachDevice"/> method and detached using the
12335	<link to="IMachine::detachDevice"/> method. Depending on a medium's
12336	type (see <link to="IMedium::type" />), hard disks are attached either
12337	<i>directly</i> or <i>indirectly</i>.
12338
12339	When a hard disk is being attached directly, it is associated with the
12340	virtual machine and used for hard disk operations when the machine is
12341	running. When a hard disk is being attached indirectly, a new differencing
12342	hard disk linked to it is implicitly created and this differencing hard
12343	disk is associated with the machine and used for hard disk operations.
12344	This also means that if <link to="IMachine::attachDevice"/> performs
12345	a direct attachment then the same hard disk will be returned in response
12346	to the subsequent <link to="IMachine::getMedium"/> call; however if
12347	an indirect attachment is performed then
12348	<link to="IMachine::getMedium"/> will return the implicitly created
12349	differencing hard disk, not the original one passed to <link
12350	to="IMachine::attachDevice"/>. In detail:
12351
12352	<ul>
12353	<li><b>Normal base</b> hard disks that do not have children (i.e.
12354	differencing hard disks linked to them) and that are not already
12355	attached to virtual machines in snapshots are attached <b>directly</b>.
12356	Otherwise, they are attached <b>indirectly</b> because having
12357	dependent children or being part of the snapshot makes it impossible
12358	to modify hard disk contents without breaking the integrity of the
12359	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
12360	quickly determine the kind of the attachment for the given hard
12361	disk. Note that if a normal base hard disk is to be indirectly
12362	attached to a virtual machine with snapshots then a special
12363	procedure called <i>smart attachment</i> is performed (see below).</li>
12364	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
12365	they are attached <b>directly</b> if they do not have children and are
12366	not attached to virtual machines in snapshots, and <b>indirectly</b>
12367	otherwise. Note that the smart attachment procedure is never performed
12368	for differencing hard disks.</li>
12369	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
12370	they are designed to be non-writable. If an immutable hard disk is
12371	attached to a virtual machine with snapshots then a special
12372	procedure called smart attachment is performed (see below).</li>
12373	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
12374	also as designed. This also means that writethrough hard disks cannot
12375	have other hard disks linked to them at all.</li>
12376	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
12377	also as designed. This also means that shareable hard disks cannot
12378	have other hard disks linked to them at all. They behave almost
12379	like writethrough hard disks, except that shareable hard disks can
12380	be attached to several virtual machines which are running, allowing
12381	concurrent accesses. You need special cluster software running in
12382	the virtual machines to make use of such disks.</li>
12383	</ul>
12384
12385	Note that the same hard disk, regardless of its type, may be attached to
12386	more than one virtual machine at a time. In this case, the machine that is
12387	started first gains exclusive access to the hard disk and attempts to
12388	start other machines having this hard disk attached will fail until the
12389	first machine is powered down.
12390
12391	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
12392	that the given hard disk remains associated with the given machine after a
12393	successful <link to="IMachine::detachDevice"/> call until
12394	<link to="IMachine::saveSettings"/> is called to save all changes to
12395	machine settings to disk. This deferring is necessary to guarantee that
12396	the hard disk configuration may be restored at any time by a call to
12397	<link to="IMachine::discardSettings"/> before the settings
12398	are saved (committed).
12399
12400	Note that if <link to="IMachine::discardSettings"/> is called after
12401	indirectly attaching some hard disks to the machine but before a call to
12402	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
12403	all differencing hard disks implicitly created by
12404	<link to="IMachine::attachDevice"/> for these indirect attachments.
12405	Such implicitly created hard disks will also be immediately deleted when
12406	detached explicitly using the <link to="IMachine::detachDevice"/>
12407	call if it is made before <link to="IMachine::saveSettings"/>. This
12408	implicit deletion is safe because newly created differencing hard
12409	disks do not contain any user data.
12410
12411	However, keep in mind that detaching differencing hard disks that were
12412	implicitly created by <link to="IMachine::attachDevice"/>
12413	before the last <link to="IMachine::saveSettings"/> call will
12414	<b>not</b> implicitly delete them as they may already contain some data
12415	(for example, as a result of virtual machine execution). If these hard
12416	disks are no more necessary, the caller can always delete them explicitly
12417	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
12418	from this machine by the <link to="IMachine::saveSettings"/> call.
12419
12420	<h3>Smart Attachment</h3>
12421
12422	When normal base or immutable hard disks are indirectly attached to a
12423	virtual machine then some additional steps are performed to make sure the
12424	virtual machine will have the most recent "view" of the hard disk being
12425	attached. These steps include walking through the machine's snapshots
12426	starting from the current one and going through ancestors up to the first
12427	snapshot. Hard disks attached to the virtual machine in all
12428	of the encountered snapshots are checked whether they are descendants of
12429	the given normal base or immutable hard disk. The first found child (which
12430	is the differencing hard disk) will be used instead of the normal base or
12431	immutable hard disk as a parent for creating a new differencing hard disk
12432	that will be actually attached to the machine. And only if no descendants
12433	are found or if the virtual machine does not have any snapshots then the
12434	normal base or immutable hard disk will be used itself as a parent for
12435	this differencing hard disk.
12436
12437	It is easier to explain what smart attachment does using the
12438	following example:
12439	<pre>
12440	BEFORE attaching B.vdi: AFTER attaching B.vdi:
12441
12442	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
12443	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
12444	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
12445	Snapshot 4 (none) Snapshot 4 (none)
12446	CurState (none) CurState (D3->D2.vdi)
12447
12448	NOT
12449	...
12450	CurState (D3->B.vdi)
12451	</pre>
12452	The first column is the virtual machine configuration before the base hard
12453	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
12454	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
12455	mean that the hard disk that is actually attached to the machine is a
12456	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
12457	another hard disk, <tt>B.vdi</tt>.
12458
12459	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
12460	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
12461	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
12462	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
12463	it cannot be attached directly and needs an indirect attachment (i.e.
12464	implicit creation of a new differencing hard disk). Due to the smart
12465	attachment procedure, the new differencing hard disk
12466	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
12467	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
12468	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
12469	machine.
12470
12471	Note that if there is more than one descendant hard disk of the given base
12472	hard disk found in a snapshot, and there is an exact device, channel and
12473	bus match, then this exact match will be used. Otherwise, the youngest
12474	descendant will be picked up.
12475
12476	There is one more important aspect of the smart attachment procedure which
12477	is not related to snapshots at all. Before walking through the snapshots
12478	as described above, the backup copy of the current list of hard disk
12479	attachment is searched for descendants. This backup copy is created when
12480	the hard disk configuration is changed for the first time after the last
12481	<link to="IMachine::saveSettings"/> call and used by
12482	<link to="IMachine::discardSettings"/> to undo the recent hard disk
12483	changes. When such a descendant is found in this backup copy, it will be
12484	simply re-attached back, without creating a new differencing hard disk for
12485	it. This optimization is necessary to make it possible to re-attach the
12486	base or immutable hard disk to a different bus, channel or device slot
12487	without losing the contents of the differencing hard disk actually
12488	attached to the machine in place of it.
12489
12490	</desc>
12491
12492	<attribute name="medium" type="IMedium" readonly="yes">
12493	<desc>Medium object associated with this attachment; it
12494	can be @c null for removable devices.</desc>
12495	</attribute>
12496
12497	<attribute name="controller" type="wstring" readonly="yes">
12498	<desc>Name of the storage controller of this attachment; this
12499	refers to one of the controllers in <link to="IMachine::storageControllers" />
12500	by name.</desc>
12501	</attribute>
12502
12503	<attribute name="port" type="long" readonly="yes">
12504	<desc>Port number of this attachment.
12505	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12506	</desc>
12507	</attribute>
12508
12509	<attribute name="device" type="long" readonly="yes">
12510	<desc>Device slot number of this attachment.
12511	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12512	</desc>
12513	</attribute>
12514
12515	<attribute name="type" type="DeviceType" readonly="yes">
12516	<desc>Device type of this attachment.</desc>
12517	</attribute>
12518
12519	<attribute name="passthrough" type="boolean" readonly="yes">
12520	<desc>Pass I/O requests through to a device on the host.</desc>
12521	</attribute>
12522
12523	<attribute name="temporaryEject" type="boolean" readonly="yes">
12524	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12525	</attribute>
12526
12527	<attribute name="isEjected" type="boolean" readonly="yes">
12528	<desc>Signals that the removable medium has been ejected. This is not
12529	necessarily equivalent to having a @c null medium association.</desc>
12530	</attribute>
12531
12532	<attribute name="nonRotational" type="boolean" readonly="yes">
12533	<desc>Whether the associated medium is non-rotational.</desc>
12534	</attribute>
12535
12536	<attribute name="discard" type="boolean" readonly="yes">
12537	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12538	</attribute>
12539
12540	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12541	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12542	</attribute>
12543
12544	</interface>
12545
12546	<interface
12547	name="IMedium" extends="$unknown"
12548	uuid="86fd6208-4c8c-40c2-a4e3-f6b47ac6ef07"
12549	wsmap="managed"
12550	>
12551	<desc>
12552	The IMedium interface represents virtual storage for a machine's
12553	hard disks, CD/DVD or floppy drives. It will typically represent
12554	a disk image on the host, for example a VDI or VMDK file representing
12555	a virtual hard disk, or an ISO or RAW file representing virtual
12556	removable media, but can also point to a network location (e.g.
12557	for iSCSI targets).
12558
12559	Instances of IMedium are connected to virtual machines by way of medium
12560	attachments, which link the storage medium to a particular device slot
12561	of a storage controller of the virtual machine.
12562	In the VirtualBox API, virtual storage is therefore always represented
12563	by the following chain of object links:
12564
12565	<ul>
12566	<li><link to="IMachine::storageControllers"/> contains an array of
12567	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12568	these are instances of <link to="IStorageController"/>).</li>
12569	<li><link to="IMachine::mediumAttachments"/> contains an array of
12570	medium attachments (instances of <link to="IMediumAttachment"/>
12571	created by <link to="IMachine::attachDevice" />),
12572	each containing a storage controller from the above array, a
12573	port/device specification, and an instance of IMedium representing
12574	the medium storage (image file).
12575
12576	For removable media, the storage medium is optional; a medium
12577	attachment with no medium represents a CD/DVD or floppy drive
12578	with no medium inserted. By contrast, hard disk attachments
12579	will always have an IMedium object attached.</li>
12580	<li>Each IMedium in turn points to a storage unit (such as a file
12581	on the host computer or a network resource) that holds actual
12582	data. This location is represented by the <link to="#location"/>
12583	attribute.</li>
12584	</ul>
12585
12586	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12587	new hard disk media can be created with the VirtualBox API using the
12588	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12589	disks (see below) are usually implicitly created by VirtualBox as
12590	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12591	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12592	should be created with external tools and then opened from within VirtualBox.
12593
12594	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12595	drive. In that case the <link to="#id" /> attribute contains the UUID of
12596	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12597
12598	<h3>Media registries</h3>
12599
12600	When a medium has been opened or created using one of the aforementioned
12601	APIs, it becomes "known" to VirtualBox. Known media can be attached
12602	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12603	They also appear in the global
12604	<link to="IVirtualBox::hardDisks" />,
12605	<link to="IVirtualBox::DVDImages" /> and
12606	<link to="IVirtualBox::floppyImages" /> arrays.
12607
12608	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12609	in the VirtualBox.xml file, which was shared between all machines and made
12610	transporting machines and their media from one host to another difficult.
12611
12612	Starting with VirtualBox 4.0, media are only added to a registry when they are
12613	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12614	backwards compatibility, which registry a medium is added to depends on which
12615	VirtualBox version created a machine:
12616
12617	<ul>
12618	<li>If the medium has first been attached to a machine which was created by
12619	VirtualBox 4.0 or later, it is added to that machine's media registry in
12620	the machine XML settings file. This way all information about a machine's
12621	media attachments is contained in a single file and can be transported
12622	easily.</li>
12623	<li>For older media attachments (i.e. if the medium was first attached to a
12624	machine which was created with a VirtualBox version before 4.0), media
12625	continue to be registered in the global VirtualBox settings file, for
12626	backwards compatibility.</li>
12627	</ul>
12628
12629	See <link to="IVirtualBox::openMedium" /> for more information.
12630
12631	Media are removed from media registries by the <link to="IMedium::close"/>,
12632	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12633
12634	<h3>Accessibility checks</h3>
12635
12636	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12637	method is called explicitly on a medium. This is done to make the VirtualBox object
12638	ready for serving requests as fast as possible and let the end-user
12639	application decide if it needs to check media accessibility right away or not.
12640
12641	As a result, when VirtualBox starts up (e.g. the VirtualBox
12642	object gets created for the first time), all known media are in the
12643	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12644	attribute is an empty string because no actual accessibility check has
12645	been made yet.
12646
12647	After calling <link to="#refreshState" />, a medium is considered
12648	<i>accessible</i> if its storage unit can be read. In that case, the
12649	<link to="#state"/> attribute has a value of "Created". If the storage
12650	unit cannot be read (for example, because it is located on a disconnected
12651	network resource, or was accidentally deleted outside VirtualBox),
12652	the medium is considered <i>inaccessible</i>, which is indicated by the
12653	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12654	obtained by reading the <link to="#lastAccessError"/> attribute.
12655
12656	<h3>Medium types</h3>
12657
12658	There are five types of medium behavior which are stored in the
12659	<link to="#type"/> attribute (see <link to="MediumType" />) and
12660	which define the medium's behavior with attachments and snapshots.
12661
12662	All media can be also divided in two groups: <i>base</i> media and
12663	<i>differencing</i> media. A base medium contains all sectors of the
12664	medium data in its own storage and therefore can be used independently.
12665	In contrast, a differencing medium is a "delta" to some other medium and
12666	contains only those sectors which differ from that other medium, which is
12667	then called a <i>parent</i>. The differencing medium is said to be
12668	<i>linked to</i> that parent. The parent may be itself a differencing
12669	medium, thus forming a chain of linked media. The last element in that
12670	chain must always be a base medium. Note that several differencing
12671	media may be linked to the same parent medium.
12672
12673	Differencing media can be distinguished from base media by querying the
12674	<link to="#parent"/> attribute: base media do not have parents they would
12675	depend on, so the value of this attribute is always @c null for them.
12676	Using this attribute, it is possible to walk up the medium tree (from the
12677	child medium to its parent). It is also possible to walk down the tree
12678	using the <link to="#children"/> attribute.
12679
12680	Note that the type of all differencing media is "normal"; all other
12681	values are meaningless for them. Base media may be of any type.
12682
12683	<h3>Automatic composition of the file name part</h3>
12684
12685	Another extension to the <link to="IMedium::location"/> attribute is that
12686	there is a possibility to cause VirtualBox to compose a unique value for
12687	the file name part of the location using the UUID of the hard disk. This
12688	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12689	e.g. before the storage unit is created, and works as follows. You set the
12690	value of the <link to="IMedium::location"/> attribute to a location
12691	specification which only contains the path specification but not the file
12692	name part and ends with either a forward slash or a backslash character.
12693	In response, VirtualBox will generate a new UUID for the hard disk and
12694	compose the file name using the following pattern:
12695	<pre>
12696	<path>/{<uuid>}.<ext>
12697	</pre>
12698	where <tt><path></tt> is the supplied path specification,
12699	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12700	is the default extension for the storage format of this hard disk. After
12701	that, you may call any of the methods that create a new hard disk storage
12702	unit and they will use the generated UUID and file name.
12703	</desc>
12704
12705	<attribute name="id" type="uuid" mod="string" readonly="yes">
12706	<desc>
12707	UUID of the medium. For a newly created medium, this value is a randomly
12708	generated UUID.
12709
12710	<note>
12711	For media in one of MediumState_NotCreated, MediumState_Creating or
12712	MediumState_Deleting states, the value of this property is undefined
12713	and will most likely be an empty UUID.
12714	</note>
12715	</desc>
12716	</attribute>
12717
12718	<attribute name="description" type="wstring">
12719	<desc>
12720	Optional description of the medium. For a newly created medium the value
12721	of this attribute is an empty string.
12722
12723	Medium types that don't support this attribute will return E_NOTIMPL in
12724	attempt to get or set this attribute's value.
12725
12726	<note>
12727	For some storage types, reading this attribute may return an outdated
12728	(last known) value when <link to="#state"/> is <link
12729	to="MediumState_Inaccessible"/> or <link
12730	to="MediumState_LockedWrite"/> because the value of this attribute is
12731	stored within the storage unit itself. Also note that changing the
12732	attribute value is not possible in such case, as well as when the
12733	medium is the <link to="MediumState_LockedRead"/> state.
12734	</note>
12735	</desc>
12736	</attribute>
12737
12738	<attribute name="state" type="MediumState" readonly="yes">
12739	<desc>
12740	Returns the current medium state, which is the last state set by
12741	the accessibility check performed by <link to="#refreshState"/>.
12742	If that method has not yet been called on the medium, the state
12743	is "Inaccessible"; as opposed to truly inaccessible media, the
12744	value of <link to="#lastAccessError"/> will be an empty string in
12745	that case.
12746
12747	<note>As of version 3.1, this no longer performs an accessibility check
12748	automatically; call <link to="#refreshState"/> for that.
12749	</note>
12750	</desc>
12751	</attribute>
12752
12753	<attribute name="variant" type="MediumVariant" safearray="yes" readonly="yes">
12754	<desc>
12755	Returns the storage format variant information for this medium
12756	as an array of the flags described at <link to="MediumVariant" />.
12757	Before <link to="#refreshState"/> is called this method returns
12758	an undefined value.
12759	</desc>
12760	</attribute>
12761
12762	<attribute name="location" type="wstring">
12763	<desc>
12764	Location of the storage unit holding medium data.
12765
12766	The format of the location string is medium type specific. For medium
12767	types using regular files in a host's file system, the location
12768	string is the full file name.
12769
12770	Some medium types may support changing the storage unit location by
12771	simply changing the value of this property. If this operation is not
12772	supported, the implementation will return E_NOTIMPL in attempt to set
12773	this attribute's value.
12774
12775	When setting a value of the location attribute which is a regular file
12776	in the host's file system, the given file name may be either relative to
12777	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12778	absolute. Note that if the given location specification does not contain
12779	the file extension part then a proper default extension will be
12780	automatically appended by the implementation depending on the medium type.
12781	</desc>
12782	</attribute>
12783
12784	<attribute name="name" type="wstring" readonly="yes">
12785	<desc>
12786	Name of the storage unit holding medium data.
12787
12788	The returned string is a short version of the <link to="#location"/>
12789	attribute that is suitable for representing the medium in situations
12790	where the full location specification is too long (such as lists
12791	and comboboxes in GUI frontends). This string is also used by frontends
12792	to sort the media list alphabetically when needed.
12793
12794	For example, for locations that are regular files in the host's file
12795	system, the value of this attribute is just the file name (+ extension),
12796	without the path specification.
12797
12798	Note that as opposed to the <link to="#location"/> attribute, the name
12799	attribute will not necessary be unique for a list of media of the
12800	given type and format.
12801	</desc>
12802	</attribute>
12803
12804	<attribute name="deviceType" type="DeviceType" readonly="yes">
12805	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12806	medium.</desc>
12807	</attribute>
12808
12809	<attribute name="hostDrive" type="boolean" readonly="yes">
12810	<desc>True if this corresponds to a drive on the host.</desc>
12811	</attribute>
12812
12813	<attribute name="size" type="long long" readonly="yes">
12814	<desc>
12815	Physical size of the storage unit used to hold medium data (in bytes).
12816
12817	<note>
12818	For media whose <link to="#state"/> is <link
12819	to="MediumState_Inaccessible"/>, the value of this property is the
12820	last known size. For <link to="MediumState_NotCreated"/> media,
12821	the returned value is zero.
12822	</note>
12823	</desc>
12824	</attribute>
12825
12826	<attribute name="format" type="wstring" readonly="yes">
12827	<desc>
12828	Storage format of this medium.
12829
12830	The value of this attribute is a string that specifies a backend used
12831	to store medium data. The storage format is defined when you create a
12832	new medium or automatically detected when you open an existing medium,
12833	and cannot be changed later.
12834
12835	The list of all storage formats supported by this VirtualBox
12836	installation can be obtained using
12837	<link to="ISystemProperties::mediumFormats"/>.
12838	</desc>
12839	</attribute>
12840
12841	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12842	<desc>
12843	Storage medium format object corresponding to this medium.
12844
12845	The value of this attribute is a reference to the medium format object
12846	that specifies the backend properties used to store medium data. The
12847	storage format is defined when you create a new medium or automatically
12848	detected when you open an existing medium, and cannot be changed later.
12849
12850	<note>@c null is returned if there is no associated medium format
12851	object. This can e.g. happen for medium objects representing host
12852	drives and other special medium objects.</note>
12853	</desc>
12854	</attribute>
12855
12856	<attribute name="type" type="MediumType">
12857	<desc>
12858	Type (role) of this medium.
12859
12860	The following constraints apply when changing the value of this
12861	attribute:
12862	<ul>
12863	<li>If a medium is attached to a virtual machine (either in the
12864	current state or in one of the snapshots), its type cannot be
12865	changed.
12866	</li>
12867	<li>As long as the medium has children, its type cannot be set
12868	to <link to="MediumType_Writethrough"/>.
12869	</li>
12870	<li>The type of all differencing media is
12871	<link to="MediumType_Normal"/> and cannot be changed.
12872	</li>
12873	</ul>
12874
12875	The type of a newly created or opened medium is set to
12876	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12877	which have a type of <link to="MediumType_Writethrough"/>.
12878	</desc>
12879	</attribute>
12880
12881	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12882	<desc>
12883	Returns which medium types can selected for this medium.
12884
12885	<result name="E_NOTIMPL">
12886	This attribute is not implemented at the moment.
12887	</result>
12888	</desc>
12889	</attribute>
12890
12891	<attribute name="parent" type="IMedium" readonly="yes">
12892	<desc>
12893	Parent of this medium (the medium this medium is directly based
12894	on).
12895
12896	Only differencing media have parents. For base (non-differencing)
12897	media, @c null is returned.
12898	</desc>
12899	</attribute>
12900
12901	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12902	<desc>
12903	Children of this medium (all differencing media directly based
12904	on this medium). A @c null array is returned if this medium
12905	does not have any children.
12906	</desc>
12907	</attribute>
12908
12909	<attribute name="base" type="IMedium" readonly="yes">
12910	<desc>
12911	Base medium of this medium.
12912
12913	If this is a differencing medium, its base medium is the medium
12914	the given medium branch starts from. For all other types of media, this
12915	property returns the medium object itself (i.e. the same object this
12916	property is read on).
12917	</desc>
12918	</attribute>
12919
12920	<attribute name="readOnly" type="boolean" readonly="yes">
12921	<desc>
12922	Returns @c true if this medium is read-only and @c false otherwise.
12923
12924	A medium is considered to be read-only when its contents cannot be
12925	modified without breaking the integrity of other parties that depend on
12926	this medium such as its child media or snapshots of virtual machines
12927	where this medium is attached to these machines. If there are no
12928	children and no such snapshots then there is no dependency and the
12929	medium is not read-only.
12930
12931	The value of this attribute can be used to determine the kind of the
12932	attachment that will take place when attaching this medium to a
12933	virtual machine. If the value is @c false then the medium will
12934	be attached directly. If the value is @c true then the medium
12935	will be attached indirectly by creating a new differencing child
12936	medium for that. See the interface description for more information.
12937
12938	Note that all <link to="MediumType_Immutable">Immutable</link> media
12939	are always read-only while all
12940	<link to="MediumType_Writethrough">Writethrough</link> media are
12941	always not.
12942
12943	<note>
12944	The read-only condition represented by this attribute is related to
12945	the medium type and usage, not to the current
12946	<link to="IMedium::state">medium state</link> and not to the read-only
12947	state of the storage unit.
12948	</note>
12949	</desc>
12950	</attribute>
12951
12952	<attribute name="logicalSize" type="long long" readonly="yes">
12953	<desc>
12954	Logical size of this medium (in bytes), as reported to the
12955	guest OS running inside the virtual machine this medium is
12956	attached to. The logical size is defined when the medium is created
12957	and cannot be changed later.
12958
12959	<note>
12960	For media whose state is <link to="#state"/> is <link
12961	to="MediumState_Inaccessible"/>, the value of this property is the
12962	last known logical size. For <link to="MediumState_NotCreated"/>
12963	media, the returned value is zero.
12964	</note>
12965	</desc>
12966	</attribute>
12967
12968	<attribute name="autoReset" type="boolean">
12969	<desc>
12970	Whether this differencing medium will be automatically reset each
12971	time a virtual machine it is attached to is powered up. This
12972	attribute is automatically set to @c true for the last
12973	differencing image of an "immutable" medium (see
12974	<link to="MediumType" />).
12975
12976	See <link to="#reset"/> for more information about resetting
12977	differencing media.
12978
12979	<note>
12980	Reading this property on a base (non-differencing) medium will
12981	always @c false. Changing the value of this property in this
12982	case is not supported.
12983	</note>
12984
12985	<result name="VBOX_E_NOT_SUPPORTED">
12986	This is not a differencing medium (when changing the attribute
12987	value).
12988	</result>
12989	</desc>
12990	</attribute>
12991
12992	<attribute name="lastAccessError" type="wstring" readonly="yes">
12993	<desc>
12994	Text message that represents the result of the last accessibility
12995	check performed by <link to="#refreshState"/>.
12996
12997	An empty string is returned if the last accessibility check
12998	was successful or has not yet been called. As a result, if
12999	<link to="#state" /> is "Inaccessible" and this attribute is empty,
13000	then <link to="#refreshState"/> has yet to be called; this is the
13001	default value of media after VirtualBox initialization.
13002	A non-empty string indicates a failure and should normally describe
13003	a reason of the failure (for example, a file read error).
13004	</desc>
13005	</attribute>
13006
13007	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
13008	<desc>
13009	Array of UUIDs of all machines this medium is attached to.
13010
13011	A @c null array is returned if this medium is not attached to any
13012	machine or to any machine's snapshot.
13013
13014	<note>
13015	The returned array will include a machine even if this medium is not
13016	attached to that machine in the current state but attached to it in
13017	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
13018	details.
13019	</note>
13020	</desc>
13021	</attribute>
13022
13023	<method name="setIds">
13024	<desc>
13025	Changes the UUID and parent UUID for a hard disk medium.
13026	</desc>
13027	<param name="setImageId" type="boolean" dir="in">
13028	<desc>
13029	Select whether a new image UUID is set or not.
13030	</desc>
13031	</param>
13032	<param name="imageId" type="uuid" mod="string" dir="in">
13033	<desc>
13034	New UUID for the image. If an empty string is passed, then a new
13035	UUID is automatically created, provided that @a setImageId is @c true.
13036	Specifying a zero UUID is not allowed.
13037	</desc>
13038	</param>
13039	<param name="setParentId" type="boolean" dir="in">
13040	<desc>
13041	Select whether a new parent UUID is set or not.
13042	</desc>
13043	</param>
13044	<param name="parentId" type="uuid" mod="string" dir="in">
13045	<desc>
13046	New parent UUID for the image. If an empty string is passed, then a
13047	new UUID is automatically created, provided @a setParentId is
13048	@c true. A zero UUID is valid.
13049	</desc>
13050	</param>
13051	<result name="E_INVALIDARG">
13052	Invalid parameter combination.
13053	</result>
13054	<result name="VBOX_E_NOT_SUPPORTED">
13055	Medium is not a hard disk medium.
13056	</result>
13057	</method>
13058
13059	<method name="refreshState">
13060	<desc>
13061	If the current medium state (see <link to="MediumState"/>) is one of
13062	"Created", "Inaccessible" or "LockedRead", then this performs an
13063	accessibility check on the medium and sets the value of the <link to="#state"/>
13064	attribute accordingly; that value is also returned for convenience.
13065
13066	For all other state values, this does not perform a refresh but returns
13067	the state only.
13068
13069	The refresh, if performed, may take a long time (several seconds or even
13070	minutes, depending on the storage unit location and format) because it performs an
13071	accessibility check of the storage unit. This check may cause a significant
13072	delay if the storage unit of the given medium is, for example, a file located
13073	on a network share which is not currently accessible due to connectivity
13074	problems. In that case, the call will not return until a timeout
13075	interval defined by the host OS for this operation expires. For this reason,
13076	it is recommended to never read this attribute on the main UI thread to avoid
13077	making the UI unresponsive.
13078
13079	If the last known state of the medium is "Created" and the accessibility
13080	check fails, then the state would be set to "Inaccessible", and
13081	<link to="#lastAccessError"/> may be used to get more details about the
13082	failure. If the state of the medium is "LockedRead", then it remains the
13083	same, and a non-empty value of <link to="#lastAccessError"/> will
13084	indicate a failed accessibility check in this case.
13085
13086	Note that not all medium states are applicable to all medium types.
13087	</desc>
13088	<param name="state" type="MediumState" dir="return">
13089	<desc>
13090	New medium state.
13091	</desc>
13092	</param>
13093	</method>
13094
13095	<method name="getSnapshotIds">
13096	<desc>
13097	Returns an array of UUIDs of all snapshots of the given machine where
13098	this medium is attached to.
13099
13100	If the medium is attached to the machine in the current state, then the
13101	first element in the array will always be the ID of the queried machine
13102	(i.e. the value equal to the @c machineId argument), followed by
13103	snapshot IDs (if any).
13104
13105	If the medium is not attached to the machine in the current state, then
13106	the array will contain only snapshot IDs.
13107
13108	The returned array may be @c null if this medium is not attached
13109	to the given machine at all, neither in the current state nor in one of
13110	the snapshots.
13111	</desc>
13112	<param name="machineId" type="uuid" mod="string" dir="in">
13113	<desc>
13114	UUID of the machine to query.
13115	</desc>
13116	</param>
13117	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
13118	<desc>
13119	Array of snapshot UUIDs of the given machine using this medium.
13120	</desc>
13121	</param>
13122	</method>
13123
13124	<method name="lockRead">
13125	<desc>
13126	Locks this medium for reading.
13127
13128	A read lock is shared: many clients can simultaneously lock the
13129	same medium for reading unless it is already locked for writing (see
13130	<link to="#lockWrite"/>) in which case an error is returned.
13131
13132	When the medium is locked for reading, it cannot be modified
13133	from within VirtualBox. This means that any method that changes
13134	the properties of this medium or contents of the storage unit
13135	will return an error (unless explicitly stated otherwise). That
13136	includes an attempt to start a virtual machine that wants to
13137	write to the the medium.
13138
13139	When the virtual machine is started up, it locks for reading all
13140	media it uses in read-only mode. If some medium cannot be locked
13141	for reading, the startup procedure will fail.
13142	A medium is typically locked for reading while it is used by a running
13143	virtual machine but has a depending differencing image that receives
13144	the actual write operations. This way one base medium can have
13145	multiple child differencing images which can be written to
13146	simultaneously. Read-only media such as DVD and floppy images are
13147	also locked for reading only (so they can be in use by multiple
13148	machines simultaneously).
13149
13150	A medium is also locked for reading when it is the source of a
13151	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13152
13153	The medium locked for reading must be unlocked using the <link
13154	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
13155	can be nested and must be followed by the same number of paired
13156	<link to="#unlockRead"/> calls.
13157
13158	This method sets the medium state (see <link to="#state"/>) to
13159	"LockedRead" on success. The medium's previous state must be
13160	one of "Created", "Inaccessible" or "LockedRead".
13161
13162	Locking an inaccessible medium is not an error; this method performs
13163	a logical lock that prevents modifications of this medium through
13164	the VirtualBox API, not a physical file-system lock of the underlying
13165	storage unit.
13166
13167	This method returns the current state of the medium
13168	<i>before</i> the operation.
13169
13170	<result name="VBOX_E_INVALID_OBJECT_STATE">
13171	Invalid medium state (e.g. not created, locked, inaccessible,
13172	creating, deleting).
13173	</result>
13174
13175	</desc>
13176	<param name="state" type="MediumState" dir="return">
13177	<desc>
13178	State of the medium after the operation.
13179	</desc>
13180	</param>
13181	</method>
13182
13183	<method name="unlockRead">
13184	<desc>
13185	Cancels the read lock previously set by <link to="#lockRead"/>.
13186
13187	For both success and failure, this method returns the current state
13188	of the medium <i>after</i> the operation.
13189
13190	See <link to="#lockRead"/> for more details.
13191
13192	<result name="VBOX_E_INVALID_OBJECT_STATE">
13193	Medium not locked for reading.
13194	</result>
13195
13196	</desc>
13197	<param name="state" type="MediumState" dir="return">
13198	<desc>
13199	State of the medium after the operation.
13200	</desc>
13201	</param>
13202	</method>
13203
13204	<method name="lockWrite">
13205	<desc>
13206	Locks this medium for writing.
13207
13208	A write lock, as opposed to <link to="#lockRead"/>, is
13209	exclusive: there may be only one client holding a write lock,
13210	and there may be no read locks while the write lock is held.
13211	As a result, read-locking fails if a write lock is held, and
13212	write-locking fails if either a read or another write lock is held.
13213
13214	When a medium is locked for writing, it cannot be modified
13215	from within VirtualBox, and it is not guaranteed that the values
13216	of its properties are up-to-date. Any method that changes the
13217	properties of this medium or contents of the storage unit will
13218	return an error (unless explicitly stated otherwise).
13219
13220	When a virtual machine is started up, it locks for writing all
13221	media it uses to write data to. If any medium could not be locked
13222	for writing, the startup procedure will fail. If a medium has
13223	differencing images, then while the machine is running, only
13224	the last ("leaf") differencing image is locked for writing,
13225	whereas its parents are locked for reading only.
13226
13227	A medium is also locked for writing when it is the target of a
13228	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13229
13230	The medium locked for writing must be unlocked using the <link
13231	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
13232
13233	This method sets the medium state (see <link to="#state"/>) to
13234	"LockedWrite" on success. The medium's previous state must be
13235	either "Created" or "Inaccessible".
13236
13237	Locking an inaccessible medium is not an error; this method performs
13238	a logical lock that prevents modifications of this medium through
13239	the VirtualBox API, not a physical file-system lock of the underlying
13240	storage unit.
13241
13242	For both, success and failure, this method returns the current
13243	state of the medium <i>before</i> the operation.
13244
13245	<result name="VBOX_E_INVALID_OBJECT_STATE">
13246	Invalid medium state (e.g. not created, locked, inaccessible,
13247	creating, deleting).
13248	</result>
13249
13250	</desc>
13251	<param name="state" type="MediumState" dir="return">
13252	<desc>
13253	State of the medium after the operation.
13254	</desc>
13255	</param>
13256	</method>
13257
13258	<method name="unlockWrite">
13259	<desc>
13260	Cancels the write lock previously set by <link to="#lockWrite"/>.
13261
13262	For both success and failure, this method returns the current
13263	state of the medium <i>after</i> the operation.
13264
13265	See <link to="#lockWrite"/> for more details.
13266
13267	<result name="VBOX_E_INVALID_OBJECT_STATE">
13268	Medium not locked for writing.
13269	</result>
13270
13271	</desc>
13272	<param name="state" type="MediumState" dir="return">
13273	<desc>
13274	State of the medium after the operation.
13275	</desc>
13276	</param>
13277	</method>
13278
13279	<method name="close">
13280	<desc>
13281	Closes this medium.
13282
13283	The medium must not be attached to any known virtual machine
13284	and must not have any known child media, otherwise the
13285	operation will fail.
13286
13287	When the medium is successfully closed, it is removed from
13288	the list of registered media, but its storage unit is not
13289	deleted. In particular, this means that this medium can
13290	later be opened again using the <link to="IVirtualBox::openMedium"/>
13291	call.
13292
13293	Note that after this method successfully returns, the given medium
13294	object becomes uninitialized. This means that any attempt
13295	to call any of its methods or attributes will fail with the
13296	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
13297
13298	<result name="VBOX_E_INVALID_OBJECT_STATE">
13299	Invalid medium state (other than not created, created or
13300	inaccessible).
13301	</result>
13302	<result name="VBOX_E_OBJECT_IN_USE">
13303	Medium attached to virtual machine.
13304	</result>
13305	<result name="VBOX_E_FILE_ERROR">
13306	Settings file not accessible.
13307	</result>
13308	<result name="VBOX_E_XML_ERROR">
13309	Could not parse the settings file.
13310	</result>
13311
13312	</desc>
13313	</method>
13314
13315	<!-- property methods -->
13316
13317	<method name="getProperty" const="yes">
13318	<desc>
13319	Returns the value of the custom medium property with the given name.
13320
13321	The list of all properties supported by the given medium format can
13322	be obtained with <link to="IMediumFormat::describeProperties"/>.
13323
13324	<note>If this method returns an empty string in @a value, the requested
13325	property is supported but currently not assigned any value.</note>
13326
13327	<result name="VBOX_E_OBJECT_NOT_FOUND">
13328	Requested property does not exist (not supported by the format).
13329	</result>
13330	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13331	</desc>
13332	<param name="name" type="wstring" dir="in">
13333	<desc>Name of the property to get.</desc>
13334	</param>
13335	<param name="value" type="wstring" dir="return">
13336	<desc>Current property value.</desc>
13337	</param>
13338	</method>
13339
13340	<method name="setProperty">
13341	<desc>
13342	Sets the value of the custom medium property with the given name.
13343
13344	The list of all properties supported by the given medium format can
13345	be obtained with <link to="IMediumFormat::describeProperties"/>.
13346
13347	<note>Setting the property value to @c null or an empty string is
13348	equivalent to deleting the existing value. A default value (if it is
13349	defined for this property) will be used by the format backend in this
13350	case.</note>
13351
13352	<result name="VBOX_E_OBJECT_NOT_FOUND">
13353	Requested property does not exist (not supported by the format).
13354	</result>
13355	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13356	</desc>
13357	<param name="name" type="wstring" dir="in">
13358	<desc>Name of the property to set.</desc>
13359	</param>
13360	<param name="value" type="wstring" dir="in">
13361	<desc>Property value to set.</desc>
13362	</param>
13363	</method>
13364
13365	<method name="getProperties" const="yes">
13366	<desc>
13367	Returns values for a group of properties in one call.
13368
13369	The names of the properties to get are specified using the @a names
13370	argument which is a list of comma-separated property names or
13371	an empty string if all properties are to be returned.
13372	<note>Currently the value of this argument is ignored and the method
13373	always returns all existing properties.</note>
13374
13375	The list of all properties supported by the given medium format can
13376	be obtained with <link to="IMediumFormat::describeProperties"/>.
13377
13378	The method returns two arrays, the array of property names corresponding
13379	to the @a names argument and the current values of these properties.
13380	Both arrays have the same number of elements with each element at the
13381	given index in the first array corresponds to an element at the same
13382	index in the second array.
13383
13384	For properties that do not have assigned values, an empty string is
13385	returned at the appropriate index in the @a returnValues array.
13386
13387	</desc>
13388	<param name="names" type="wstring" dir="in">
13389	<desc>
13390	Names of properties to get.
13391	</desc>
13392	</param>
13393	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13394	<desc>Names of returned properties.</desc>
13395	</param>
13396	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13397	<desc>Values of returned properties.</desc>
13398	</param>
13399	</method>
13400
13401	<method name="setProperties">
13402	<desc>
13403	Sets values for a group of properties in one call.
13404
13405	The names of the properties to set are passed in the @a names
13406	array along with the new values for them in the @a values array. Both
13407	arrays have the same number of elements with each element at the given
13408	index in the first array corresponding to an element at the same index
13409	in the second array.
13410
13411	If there is at least one property name in @a names that is not valid,
13412	the method will fail before changing the values of any other properties
13413	from the @a names array.
13414
13415	Using this method over <link to="#setProperty"/> is preferred if you
13416	need to set several properties at once since it is more efficient.
13417
13418	The list of all properties supported by the given medium format can
13419	be obtained with <link to="IMediumFormat::describeProperties"/>.
13420
13421	Setting the property value to @c null or an empty string is equivalent
13422	to deleting the existing value. A default value (if it is defined for
13423	this property) will be used by the format backend in this case.
13424	</desc>
13425	<param name="names" type="wstring" safearray="yes" dir="in">
13426	<desc>Names of properties to set.</desc>
13427	</param>
13428	<param name="values" type="wstring" safearray="yes" dir="in">
13429	<desc>Values of properties to set.</desc>
13430	</param>
13431	</method>
13432
13433	<!-- storage methods -->
13434
13435	<method name="createBaseStorage">
13436	<desc>
13437	Starts creating a hard disk storage unit (fixed/dynamic, according
13438	to the variant flags) in in the background. The previous storage unit
13439	created for this object, if any, must first be deleted using
13440	<link to="#deleteStorage"/>, otherwise the operation will fail.
13441
13442	Before the operation starts, the medium is placed in
13443	<link to="MediumState_Creating"/> state. If the create operation
13444	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
13445	state.
13446
13447	After the returned progress object reports that the operation has
13448	successfully completed, the medium state will be set to <link
13449	to="MediumState_Created"/>, the medium will be remembered by this
13450	VirtualBox installation and may be attached to virtual machines.
13451
13452	<result name="VBOX_E_NOT_SUPPORTED">
13453	The variant of storage creation operation is not supported. See <link
13454	to="IMediumFormat::capabilities"/>.
13455	</result>
13456	</desc>
13457	<param name="logicalSize" type="long long" dir="in">
13458	<desc>Maximum logical size of the medium in bytes.</desc>
13459	</param>
13460	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13461	<desc>Exact image variant which should be created (as a combination of
13462	<link to="MediumVariant" /> flags).</desc>
13463	</param>
13464	<param name="progress" type="IProgress" dir="return">
13465	<desc>Progress object to track the operation completion.</desc>
13466	</param>
13467	</method>
13468
13469	<method name="deleteStorage">
13470	<desc>
13471	Starts deleting the storage unit of this medium.
13472
13473	The medium must not be attached to any known virtual machine and must
13474	not have any known child media, otherwise the operation will fail.
13475	It will also fail if there is no storage unit to delete or if deletion
13476	is already in progress, or if the medium is being in use (locked for
13477	read or for write) or inaccessible. Therefore, the only valid state for
13478	this operation to succeed is <link to="MediumState_Created"/>.
13479
13480	Before the operation starts, the medium is placed in
13481	<link to="MediumState_Deleting"/> state and gets removed from the list
13482	of remembered hard disks (media registry). If the delete operation
13483	fails, the medium will be remembered again and placed back to
13484	<link to="MediumState_Created"/> state.
13485
13486	After the returned progress object reports that the operation is
13487	complete, the medium state will be set to
13488	<link to="MediumState_NotCreated"/> and you will be able to use one of
13489	the storage creation methods to create it again.
13490
13491	<see><link to="#close"/></see>
13492
13493	<result name="VBOX_E_OBJECT_IN_USE">
13494	Medium is attached to a virtual machine.
13495	</result>
13496	<result name="VBOX_E_NOT_SUPPORTED">
13497	Storage deletion is not allowed because neither of storage creation
13498	operations are supported. See
13499	<link to="IMediumFormat::capabilities"/>.
13500	</result>
13501
13502	<note>
13503	If the deletion operation fails, it is not guaranteed that the storage
13504	unit still exists. You may check the <link to="IMedium::state"/> value
13505	to answer this question.
13506	</note>
13507	</desc>
13508	<param name="progress" type="IProgress" dir="return">
13509	<desc>Progress object to track the operation completion.</desc>
13510	</param>
13511	</method>
13512
13513	<!-- diff methods -->
13514
13515	<method name="createDiffStorage">
13516	<desc>
13517	Starts creating an empty differencing storage unit based on this
13518	medium in the format and at the location defined by the @a target
13519	argument.
13520
13521	The target medium must be in <link to="MediumState_NotCreated"/>
13522	state (i.e. must not have an existing storage unit). Upon successful
13523	completion, this operation will set the type of the target medium to
13524	<link to="MediumType_Normal"/> and create a storage unit necessary to
13525	represent the differencing medium data in the given format (according
13526	to the storage format of the target object).
13527
13528	After the returned progress object reports that the operation is
13529	successfully complete, the target medium gets remembered by this
13530	VirtualBox installation and may be attached to virtual machines.
13531
13532	<note>
13533	The medium will be set to <link to="MediumState_LockedRead"/>
13534	state for the duration of this operation.
13535	</note>
13536	<result name="VBOX_E_OBJECT_IN_USE">
13537	Medium not in @c NotCreated state.
13538	</result>
13539	</desc>
13540	<param name="target" type="IMedium" dir="in">
13541	<desc>Target medium.</desc>
13542	</param>
13543	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13544	<desc>Exact image variant which should be created (as a combination of
13545	<link to="MediumVariant" /> flags).</desc>
13546	</param>
13547	<param name="progress" type="IProgress" dir="return">
13548	<desc>Progress object to track the operation completion.</desc>
13549	</param>
13550	</method>
13551
13552	<method name="mergeTo">
13553	<desc>
13554	Starts merging the contents of this medium and all intermediate
13555	differencing media in the chain to the given target medium.
13556
13557	The target medium must be either a descendant of this medium or
13558	its ancestor (otherwise this method will immediately return a failure).
13559	It follows that there are two logical directions of the merge operation:
13560	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13561	ancestor (<i>backward merge</i>). Let us consider the following medium
13562	chain:
13563
13564	<pre>Base <- Diff_1 <- Diff_2</pre>
13565
13566	Here, calling this method on the <tt>Base</tt> medium object with
13567	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13568	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13569	merge. Note that in both cases the contents of the resulting medium
13570	will be the same, the only difference is the medium object that takes
13571	the result of the merge operation. In case of the forward merge in the
13572	above example, the result will be written to <tt>Diff_2</tt>; in case of
13573	the backward merge, the result will be written to <tt>Base</tt>. In
13574	other words, the result of the operation is always stored in the target
13575	medium.
13576
13577	Upon successful operation completion, the storage units of all media in
13578	the chain between this (source) medium and the target medium, including
13579	the source medium itself, will be automatically deleted and the
13580	relevant medium objects (including this medium) will become
13581	uninitialized. This means that any attempt to call any of
13582	their methods or attributes will fail with the
13583	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13584	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13585	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13586	Note that <tt>Diff_2</tt> in this case will become a base medium
13587	itself since it will no longer be based on any other medium.
13588
13589	Considering the above, all of the following conditions must be met in
13590	order for the merge operation to succeed:
13591	<ul>
13592	<li>
13593	Neither this (source) medium nor any intermediate
13594	differencing medium in the chain between it and the target
13595	medium is attached to any virtual machine.
13596	</li>
13597	<li>
13598	Neither the source medium nor the target medium is an
13599	<link to="MediumType_Immutable"/> medium.
13600	</li>
13601	<li>
13602	The part of the medium tree from the source medium to the
13603	target medium is a linear chain, i.e. all medium in this
13604	chain have exactly one child which is the next medium in this
13605	chain. The only exception from this rule is the target medium in
13606	the forward merge operation; it is allowed to have any number of
13607	child media because the merge operation will not change its
13608	logical contents (as it is seen by the guest OS or by children).
13609	</li>
13610	<li>
13611	None of the involved media are in
13612	<link to="MediumState_LockedRead"/> or
13613	<link to="MediumState_LockedWrite"/> state.
13614	</li>
13615	</ul>
13616
13617	<note>
13618	This (source) medium and all intermediates will be placed to <link
13619	to="MediumState_Deleting"/> state and the target medium will be
13620	placed to <link to="MediumState_LockedWrite"/> state and for the
13621	duration of this operation.
13622	</note>
13623	</desc>
13624	<param name="target" type="IMedium" dir="in">
13625	<desc>Target medium.</desc>
13626	</param>
13627	<param name="progress" type="IProgress" dir="return">
13628	<desc>Progress object to track the operation completion.</desc>
13629	</param>
13630	</method>
13631
13632	<!-- clone method -->
13633
13634	<method name="cloneTo">
13635	<desc>
13636	Starts creating a clone of this medium in the format and at the
13637	location defined by the @a target argument.
13638
13639	The target medium must be either in <link to="MediumState_NotCreated"/>
13640	state (i.e. must not have an existing storage unit) or in
13641	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13642	big enough to hold the data or else the copy will be partial). Upon
13643	successful completion, the cloned medium will contain exactly the
13644	same sector data as the medium being cloned, except that in the
13645	first case a new UUID for the clone will be randomly generated, and in
13646	the second case the UUID will remain unchanged.
13647
13648	The @a parent argument defines which medium will be the parent
13649	of the clone. Passing a @c null reference indicates that the clone will
13650	be a base image, i.e. completely independent. It is possible to specify
13651	an arbitrary medium for this parameter, including the parent of the
13652	medium which is being cloned. Even cloning to a child of the source
13653	medium is possible. Note that when cloning to an existing image, the
13654	@a parent argument is ignored.
13655
13656	After the returned progress object reports that the operation is
13657	successfully complete, the target medium gets remembered by this
13658	VirtualBox installation and may be attached to virtual machines.
13659
13660	<note>
13661	This medium will be placed to <link to="MediumState_LockedRead"/>
13662	state for the duration of this operation.
13663	</note>
13664	<result name="E_NOTIMPL">
13665	The specified cloning variant is not supported at the moment.
13666	</result>
13667	</desc>
13668	<param name="target" type="IMedium" dir="in">
13669	<desc>Target medium.</desc>
13670	</param>
13671	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13672	<desc>Exact image variant which should be created (as a combination of
13673	<link to="MediumVariant" /> flags).</desc>
13674	</param>
13675	<param name="parent" type="IMedium" dir="in">
13676	<desc>Parent of the cloned medium.</desc>
13677	</param>
13678	<param name="progress" type="IProgress" dir="return">
13679	<desc>Progress object to track the operation completion.</desc>
13680	</param>
13681	</method>
13682
13683	<method name="cloneToBase">
13684	<desc>
13685	Starts creating a clone of this medium in the format and at the
13686	location defined by the @a target argument.
13687
13688	The target medium must be either in <link to="MediumState_NotCreated"/>
13689	state (i.e. must not have an existing storage unit) or in
13690	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13691	big enough to hold the data or else the copy will be partial). Upon
13692	successful completion, the cloned medium will contain exactly the
13693	same sector data as the medium being cloned, except that in the
13694	first case a new UUID for the clone will be randomly generated, and in
13695	the second case the UUID will remain unchanged.
13696
13697	The @a parent argument defines which medium will be the parent
13698	of the clone. In this case the clone will be a base image, i.e.
13699	completely independent. It is possible to specify an arbitrary
13700	medium for this parameter, including the parent of the
13701	medium which is being cloned. Even cloning to a child of the source
13702	medium is possible. Note that when cloning to an existing image, the
13703	@a parent argument is ignored.
13704
13705	After the returned progress object reports that the operation is
13706	successfully complete, the target medium gets remembered by this
13707	VirtualBox installation and may be attached to virtual machines.
13708
13709	<note>
13710	This medium will be placed to <link to="MediumState_LockedRead"/>
13711	state for the duration of this operation.
13712	</note>
13713	<result name="E_NOTIMPL">
13714	The specified cloning variant is not supported at the moment.
13715	</result>
13716	</desc>
13717	<param name="target" type="IMedium" dir="in">
13718	<desc>Target medium.</desc>
13719	</param>
13720	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13721	<desc><link to="MediumVariant" /> flags).</desc>
13722	</param>
13723	<param name="progress" type="IProgress" dir="return">
13724	<desc>Progress object to track the operation completion.</desc>
13725	</param>
13726	</method>
13727
13728	<!-- other methods -->
13729
13730	<method name="compact">
13731	<desc>
13732	Starts compacting of this medium. This means that the medium is
13733	transformed into a possibly more compact storage representation.
13734	This potentially creates temporary images, which can require a
13735	substantial amount of additional disk space.
13736
13737	This medium will be placed to <link to="MediumState_LockedWrite"/>
13738	state and all its parent media (if any) will be placed to
13739	<link to="MediumState_LockedRead"/> state for the duration of this
13740	operation.
13741
13742	Please note that the results can be either returned straight away,
13743	or later as the result of the background operation via the object
13744	returned via the @a progress parameter.
13745
13746	<result name="VBOX_E_NOT_SUPPORTED">
13747	Medium format does not support compacting (but potentially
13748	needs it).
13749	</result>
13750	</desc>
13751	<param name="progress" type="IProgress" dir="return">
13752	<desc>Progress object to track the operation completion.</desc>
13753	</param>
13754	</method>
13755
13756	<method name="resize">
13757	<desc>
13758	Starts resizing this medium. This means that the nominal size of the
13759	medium is set to the new value. Both increasing and decreasing the
13760	size is possible, and there are no safety checks, since VirtualBox
13761	does not make any assumptions about the medium contents.
13762
13763	Resizing usually needs additional disk space, and possibly also
13764	some temporary disk space. Note that resize does not create a full
13765	temporary copy of the medium, so the additional disk space requirement
13766	is usually much lower than using the clone operation.
13767
13768	This medium will be placed to <link to="MediumState_LockedWrite"/>
13769	state for the duration of this operation.
13770
13771	Please note that the results can be either returned straight away,
13772	or later as the result of the background operation via the object
13773	returned via the @a progress parameter.
13774
13775	<result name="VBOX_E_NOT_SUPPORTED">
13776	Medium format does not support resizing.
13777	</result>
13778	</desc>
13779	<param name="logicalSize" type="long long" dir="in">
13780	<desc>New nominal capacity of the medium in bytes.</desc>
13781	</param>
13782	<param name="progress" type="IProgress" dir="return">
13783	<desc>Progress object to track the operation completion.</desc>
13784	</param>
13785	</method>
13786
13787	<method name="reset">
13788	<desc>
13789	Starts erasing the contents of this differencing medium.
13790
13791	This operation will reset the differencing medium to its initial
13792	state when it does not contain any sector data and any read operation is
13793	redirected to its parent medium. This automatically gets called
13794	during VM power-up for every medium whose <link to="#autoReset" />
13795	attribute is @c true.
13796
13797	The medium will be write-locked for the duration of this operation (see
13798	<link to="#lockWrite" />).
13799
13800	<result name="VBOX_E_NOT_SUPPORTED">
13801	This is not a differencing medium.
13802	</result>
13803	<result name="VBOX_E_INVALID_OBJECT_STATE">
13804	Medium is not in <link to="MediumState_Created"/> or
13805	<link to="MediumState_Inaccessible"/> state.
13806	</result>
13807	</desc>
13808	<param name="progress" type="IProgress" dir="return">
13809	<desc>Progress object to track the operation completion.</desc>
13810	</param>
13811	</method>
13812
13813	</interface>
13814
13815
13816	<!--
13817	// IMediumFormat
13818	/////////////////////////////////////////////////////////////////////////
13819	-->
13820
13821	<enum
13822	name="DataType"
13823	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13824	>
13825	<const name="Int32" value="0"/>
13826	<const name="Int8" value="1"/>
13827	<const name="String" value="2"/>
13828	</enum>
13829
13830	<enum
13831	name="DataFlags"
13832	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13833	>
13834	<const name="None" value="0x00"/>
13835	<const name="Mandatory" value="0x01"/>
13836	<const name="Expert" value="0x02"/>
13837	<const name="Array" value="0x04"/>
13838	<const name="FlagMask" value="0x07"/>
13839	</enum>
13840
13841	<enum
13842	name="MediumFormatCapabilities"
13843	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13844	>
13845	<desc>
13846	Medium format capability flags.
13847	</desc>
13848
13849	<const name="Uuid" value="0x01">
13850	<desc>
13851	Supports UUIDs as expected by VirtualBox code.
13852	</desc>
13853	</const>
13854
13855	<const name="CreateFixed" value="0x02">
13856	<desc>
13857	Supports creating fixed size images, allocating all space instantly.
13858	</desc>
13859	</const>
13860
13861	<const name="CreateDynamic" value="0x04">
13862	<desc>
13863	Supports creating dynamically growing images, allocating space on
13864	demand.
13865	</desc>
13866	</const>
13867
13868	<const name="CreateSplit2G" value="0x08">
13869	<desc>
13870	Supports creating images split in chunks of a bit less than 2 GBytes.
13871	</desc>
13872	</const>
13873
13874	<const name="Differencing" value="0x10">
13875	<desc>
13876	Supports being used as a format for differencing media (see <link
13877	to="IMedium::createDiffStorage"/>).
13878	</desc>
13879	</const>
13880
13881	<const name="Asynchronous" value="0x20">
13882	<desc>
13883	Supports asynchronous I/O operations for at least some configurations.
13884	</desc>
13885	</const>
13886
13887	<const name="File" value="0x40">
13888	<desc>
13889	The format backend operates on files (the <link to="IMedium::location"/>
13890	attribute of the medium specifies a file used to store medium
13891	data; for a list of supported file extensions see
13892	<link to="IMediumFormat::describeFileExtensions"/>).
13893	</desc>
13894	</const>
13895
13896	<const name="Properties" value="0x80">
13897	<desc>
13898	The format backend uses the property interface to configure the storage
13899	location and properties (the <link to="IMediumFormat::describeProperties"/>
13900	method is used to get access to properties supported by the given medium format).
13901	</desc>
13902	</const>
13903
13904	<const name="TcpNetworking" value="0x100">
13905	<desc>
13906	The format backend uses the TCP networking interface for network access.
13907	</desc>
13908	</const>
13909
13910	<const name="VFS" value="0x200">
13911	<desc>
13912	The format backend supports virtual filesystem functionality.
13913	</desc>
13914	</const>
13915
13916	<const name="CapabilityMask" value="0x3FF"/>
13917	</enum>
13918
13919	<interface
13920	name="IMediumFormat" extends="$unknown"
13921	uuid="6238e1cf-a17d-4ec1-8172-418bfb22b93a"
13922	wsmap="managed"
13923	>
13924	<desc>
13925	The IMediumFormat interface represents a medium format.
13926
13927	Each medium format has an associated backend which is used to handle
13928	media stored in this format. This interface provides information
13929	about the properties of the associated backend.
13930
13931	Each medium format is identified by a string represented by the
13932	<link to="#id"/> attribute. This string is used in calls like
13933	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13934	format.
13935
13936	The list of all supported medium formats can be obtained using
13937	<link to="ISystemProperties::mediumFormats"/>.
13938
13939	<see><link to="IMedium"/></see>
13940	</desc>
13941
13942	<attribute name="id" type="wstring" readonly="yes">
13943	<desc>
13944	Identifier of this format.
13945
13946	The format identifier is a non-@c null non-empty ASCII string. Note that
13947	this string is case-insensitive. This means that, for example, all of
13948	the following strings:
13949	<pre>
13950	"VDI"
13951	"vdi"
13952	"VdI"</pre>
13953	refer to the same medium format.
13954
13955	This string is used in methods of other interfaces where it is necessary
13956	to specify a medium format, such as
13957	<link to="IVirtualBox::createHardDisk"/>.
13958	</desc>
13959	</attribute>
13960
13961	<attribute name="name" type="wstring" readonly="yes">
13962	<desc>
13963	Human readable description of this format.
13964
13965	Mainly for use in file open dialogs.
13966	</desc>
13967	</attribute>
13968
13969	<attribute name="capabilities" type="MediumFormatCapabilities" safearray="yes" readonly="yes">
13970	<desc>
13971	Capabilities of the format as an array of the flags.
13972
13973	For the meaning of individual capability flags see
13974	<link to="MediumFormatCapabilities"/>.
13975	</desc>
13976	</attribute>
13977
13978	<method name="describeFileExtensions">
13979	<desc>
13980	Returns two arrays describing the supported file extensions.
13981
13982	The first array contains the supported extensions and the seconds one
13983	the type each extension supports. Both have the same size.
13984
13985	Note that some backends do not work on files, so this array may be
13986	empty.
13987
13988	<see><link to="IMediumFormat::capabilities"/></see>
13989	</desc>
13990	<param name="extensions" type="wstring" safearray="yes" dir="out">
13991	<desc>The array of supported extensions.</desc>
13992	</param>
13993	<param name="types" type="DeviceType" safearray="yes" dir="out">
13994	<desc>The array which indicates the device type for every given extension.</desc>
13995	</param>
13996	</method>
13997
13998	<method name="describeProperties" const="yes">
13999	<desc>
14000	Returns several arrays describing the properties supported by this
14001	format.
14002
14003	An element with the given index in each array describes one
14004	property. Thus, the number of elements in each returned array is the
14005	same and corresponds to the number of supported properties.
14006
14007	The returned arrays are filled in only if the
14008	<link to="MediumFormatCapabilities_Properties"/> flag is set.
14009	All arguments must be non-@c null.
14010
14011	<see><link to="DataType"/>, <link to="DataFlags"/></see>
14012	</desc>
14013
14014	<param name="names" type="wstring" safearray="yes" dir="out">
14015	<desc>Array of property names.</desc>
14016	</param>
14017	<param name="descriptions" type="wstring" safearray="yes" dir="out">
14018	<desc>Array of property descriptions.</desc>
14019	</param>
14020	<param name="types" type="DataType" safearray="yes" dir="out">
14021	<desc>Array of property types.</desc>
14022	</param>
14023	<param name="flags" type="unsigned long" safearray="yes" dir="out">
14024	<desc>Array of property flags.</desc>
14025	</param>
14026	<param name="defaults" type="wstring" safearray="yes" dir="out">
14027	<desc>Array of default property values.</desc>
14028	</param>
14029	</method>
14030
14031	</interface>
14032
14033
14034	<!--
14035	// IKeyboard
14036	/////////////////////////////////////////////////////////////////////////
14037	-->
14038
14039	<interface
14040	name="IKeyboard" extends="$unknown"
14041	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
14042	wsmap="managed"
14043	>
14044	<desc>
14045	The IKeyboard interface represents the virtual machine's keyboard. Used
14046	in <link to="IConsole::keyboard"/>.
14047
14048	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
14049	to the virtual machine.
14050
14051	</desc>
14052	<method name="putScancode">
14053	<desc>Sends a scancode to the keyboard.
14054
14055	<result name="VBOX_E_IPRT_ERROR">
14056	Could not send scan code to virtual keyboard.
14057	</result>
14058
14059	</desc>
14060	<param name="scancode" type="long" dir="in"/>
14061	</method>
14062
14063	<method name="putScancodes">
14064	<desc>Sends an array of scancodes to the keyboard.
14065
14066	<result name="VBOX_E_IPRT_ERROR">
14067	Could not send all scan codes to virtual keyboard.
14068	</result>
14069
14070	</desc>
14071	<param name="scancodes" type="long" dir="in" safearray="yes"/>
14072	<param name="codesStored" type="unsigned long" dir="return"/>
14073	</method>
14074
14075	<method name="putCAD">
14076	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
14077	function is nothing special, it is just a convenience function
14078	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
14079
14080	<result name="VBOX_E_IPRT_ERROR">
14081	Could not send all scan codes to virtual keyboard.
14082	</result>
14083
14084	</desc>
14085	</method>
14086
14087	<attribute name="eventSource" type="IEventSource" readonly="yes">
14088	<desc>
14089	Event source for keyboard events.
14090	</desc>
14091	</attribute>
14092
14093	</interface>
14094
14095
14096	<!--
14097	// IMouse
14098	/////////////////////////////////////////////////////////////////////////
14099	-->
14100
14101	<enum
14102	name="MouseButtonState"
14103	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
14104	>
14105	<desc>
14106	Mouse button state.
14107	</desc>
14108
14109	<const name="LeftButton" value="0x01"/>
14110	<const name="RightButton" value="0x02"/>
14111	<const name="MiddleButton" value="0x04"/>
14112	<const name="WheelUp" value="0x08"/>
14113	<const name="WheelDown" value="0x10"/>
14114	<const name="XButton1" value="0x20"/>
14115	<const name="XButton2" value="0x40"/>
14116	<const name="MouseStateMask" value="0x7F"/>
14117	</enum>
14118
14119	<interface
14120	name="IMouse" extends="$unknown"
14121	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
14122	wsmap="managed"
14123	>
14124	<desc>
14125	The IMouse interface represents the virtual machine's mouse. Used in
14126	<link to="IConsole::mouse"/>.
14127
14128	Through this interface, the virtual machine's virtual mouse can be
14129	controlled.
14130	</desc>
14131
14132	<attribute name="absoluteSupported" type="boolean" readonly="yes">
14133	<desc>
14134	Whether the guest OS supports absolute mouse pointer positioning
14135	or not.
14136	<note>
14137	You can use the <link to="IMouseCapabilityChangedEvent"/>
14138	event to be instantly informed about changes of this attribute
14139	during virtual machine execution.
14140	</note>
14141	<see><link to="#putMouseEventAbsolute"/></see>
14142	</desc>
14143	</attribute>
14144
14145	<attribute name="relativeSupported" type="boolean" readonly="yes">
14146	<desc>
14147	Whether the guest OS supports relative mouse pointer positioning
14148	or not.
14149	<note>
14150	You can use the <link to="IMouseCapabilityChangedEvent"/>
14151	event to be instantly informed about changes of this attribute
14152	during virtual machine execution.
14153	</note>
14154	<see><link to="#putMouseEvent"/></see>
14155	</desc>
14156	</attribute>
14157
14158	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14159	<desc>
14160	Whether the guest OS can currently switch to drawing it's own mouse
14161	cursor on demand.
14162	<note>
14163	You can use the <link to="IMouseCapabilityChangedEvent"/>
14164	event to be instantly informed about changes of this attribute
14165	during virtual machine execution.
14166	</note>
14167	<see><link to="#putMouseEvent"/></see>
14168	</desc>
14169	</attribute>
14170
14171	<method name="putMouseEvent">
14172	<desc>
14173	Initiates a mouse event using relative pointer movements
14174	along x and y axis.
14175
14176	<result name="E_ACCESSDENIED">
14177	Console not powered up.
14178	</result>
14179	<result name="VBOX_E_IPRT_ERROR">
14180	Could not send mouse event to virtual mouse.
14181	</result>
14182
14183	</desc>
14184
14185	<param name="dx" type="long" dir="in">
14186	<desc>
14187	Amount of pixels the mouse should move to the right.
14188	Negative values move the mouse to the left.
14189	</desc>
14190	</param>
14191	<param name="dy" type="long" dir="in">
14192	<desc>
14193	Amount of pixels the mouse should move downwards.
14194	Negative values move the mouse upwards.
14195	</desc>
14196	</param>
14197	<param name="dz" type="long" dir="in">
14198	<desc>
14199	Amount of mouse wheel moves.
14200	Positive values describe clockwise wheel rotations,
14201	negative values describe counterclockwise rotations.
14202	</desc>
14203	</param>
14204	<param name="dw" type="long" dir="in">
14205	<desc>
14206	Amount of horizontal mouse wheel moves.
14207	Positive values describe a movement to the left,
14208	negative values describe a movement to the right.
14209	</desc>
14210	</param>
14211	<param name="buttonState" type="long" dir="in">
14212	<desc>
14213	The current state of mouse buttons. Every bit represents
14214	a mouse button as follows:
14215	<table>
14216	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14217	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14218	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14219	</table>
14220	A value of <tt>1</tt> means the corresponding button is pressed.
14221	otherwise it is released.
14222	</desc>
14223	</param>
14224	</method>
14225
14226	<method name="putMouseEventAbsolute">
14227	<desc>
14228	Positions the mouse pointer using absolute x and y coordinates.
14229	These coordinates are expressed in pixels and
14230	start from <tt>[1,1]</tt> which corresponds to the top left
14231	corner of the virtual display.
14232
14233	<result name="E_ACCESSDENIED">
14234	Console not powered up.
14235	</result>
14236	<result name="VBOX_E_IPRT_ERROR">
14237	Could not send mouse event to virtual mouse.
14238	</result>
14239
14240	<note>
14241	This method will have effect only if absolute mouse
14242	positioning is supported by the guest OS.
14243	</note>
14244
14245	<see><link to="#absoluteSupported"/></see>
14246	</desc>
14247
14248	<param name="x" type="long" dir="in">
14249	<desc>
14250	X coordinate of the pointer in pixels, starting from @c 1.
14251	</desc>
14252	</param>
14253	<param name="y" type="long" dir="in">
14254	<desc>
14255	Y coordinate of the pointer in pixels, starting from @c 1.
14256	</desc>
14257	</param>
14258	<param name="dz" type="long" dir="in">
14259	<desc>
14260	Amount of mouse wheel moves.
14261	Positive values describe clockwise wheel rotations,
14262	negative values describe counterclockwise rotations.
14263	</desc>
14264	</param>
14265	<param name="dw" type="long" dir="in">
14266	<desc>
14267	Amount of horizontal mouse wheel moves.
14268	Positive values describe a movement to the left,
14269	negative values describe a movement to the right.
14270	</desc>
14271	</param>
14272	<param name="buttonState" type="long" dir="in">
14273	<desc>
14274	The current state of mouse buttons. Every bit represents
14275	a mouse button as follows:
14276	<table>
14277	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14278	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14279	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14280	</table>
14281	A value of @c 1 means the corresponding button is pressed.
14282	otherwise it is released.
14283	</desc>
14284	</param>
14285	</method>
14286
14287	<attribute name="eventSource" type="IEventSource" readonly="yes">
14288	<desc>
14289	Event source for mouse events.
14290	</desc>
14291	</attribute>
14292
14293	</interface>
14294
14295	<!--
14296	// IDisplay
14297	/////////////////////////////////////////////////////////////////////////
14298	-->
14299
14300	<enum
14301	name="FramebufferPixelFormat"
14302	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
14303	>
14304	<desc>
14305	Format of the video memory buffer. Constants represented by this enum can
14306	be used to test for particular values of <link
14307	to="IFramebuffer::pixelFormat"/>.
14308
14309	See also www.fourcc.org for more information about FOURCC pixel formats.
14310	</desc>
14311
14312	<const name="Opaque" value="0">
14313	<desc>
14314	Unknown buffer format (the user may not assume any particular format of
14315	the buffer).
14316	</desc>
14317	</const>
14318	<const name="FOURCC_RGB" value="0x32424752">
14319	<desc>
14320	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
14321	bit layout).
14322	</desc>
14323	</const>
14324	</enum>
14325
14326	<interface
14327	name="IFramebuffer" extends="$unknown"
14328	uuid="e3f122c0-adab-4fc9-a8dc-da112fb48428"
14329	wsmap="managed"
14330	>
14331	<attribute name="address" type="octet" mod="ptr" readonly="yes" wsmap="suppress">
14332	<desc>Address of the start byte of the frame buffer.</desc>
14333	</attribute>
14334
14335	<attribute name="width" type="unsigned long" readonly="yes">
14336	<desc>Frame buffer width, in pixels.</desc>
14337	</attribute>
14338
14339	<attribute name="height" type="unsigned long" readonly="yes">
14340	<desc>Frame buffer height, in pixels.</desc>
14341	</attribute>
14342
14343	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
14344	<desc>
14345	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
14346	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
14347	are: 8, 15, 16, 24 and 32.
14348	</desc>
14349	</attribute>
14350
14351	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
14352	<desc>
14353	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
14354	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
14355	size of the scan line must be aligned to 32 bits.
14356	</desc>
14357	</attribute>
14358
14359	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
14360	<desc>
14361	Frame buffer pixel format. It's either one of the values defined by <link
14362	to="FramebufferPixelFormat"/> or a raw FOURCC code.
14363	<note>
14364	This attribute must never (and will never) return <link
14365	to="FramebufferPixelFormat_Opaque"/> -- the format of the frame
14366	buffer must be always known.
14367	</note>
14368	</desc>
14369	</attribute>
14370
14371	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
14372	<desc>
14373	Defines whether this frame buffer uses the virtual video card's memory
14374	buffer (guest VRAM) directly or not.
14375	</desc>
14376	</attribute>
14377
14378	<attribute name="heightReduction" type="unsigned long" readonly="yes">
14379	<desc>
14380	Hint from the frame buffer about how much of the standard
14381	screen height it wants to use for itself. This information is
14382	exposed to the guest through the VESA BIOS and VMMDev interface
14383	so that it can use it for determining its video mode table. It
14384	is not guaranteed that the guest respects the value.
14385	</desc>
14386	</attribute>
14387
14388	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
14389	<desc>
14390	An alpha-blended overlay which is superposed over the frame buffer.
14391	The initial purpose is to allow the display of icons providing
14392	information about the VM state, including disk activity, in front
14393	ends which do not have other means of doing that. The overlay is
14394	designed to controlled exclusively by IDisplay. It has no locking
14395	of its own, and any changes made to it are not guaranteed to be
14396	visible until the affected portion of IFramebuffer is updated. The
14397	overlay can be created lazily the first time it is requested. This
14398	attribute can also return @c null to signal that the overlay is not
14399	implemented.
14400	</desc>
14401	</attribute>
14402
14403	<attribute name="winId" type="long long" readonly="yes" wsmap="suppress">
14404	<desc>
14405	Platform-dependent identifier of the window where context of this
14406	frame buffer is drawn, or zero if there's no such window.
14407	</desc>
14408	</attribute>
14409
14410	<method name="lock" wsmap="suppress">
14411	<desc>
14412	Locks the frame buffer.
14413	Gets called by the IDisplay object where this frame buffer is
14414	bound to.
14415	</desc>
14416	</method>
14417
14418	<method name="unlock" wsmap="suppress">
14419	<desc>
14420	Unlocks the frame buffer.
14421	Gets called by the IDisplay object where this frame buffer is
14422	bound to.
14423	</desc>
14424	</method>
14425
14426	<method name="notifyUpdate" wsmap="suppress">
14427	<desc>
14428	Informs about an update.
14429	Gets called by the display object where this buffer is
14430	registered.
14431	</desc>
14432	<param name="x" type="unsigned long" dir="in"/>
14433	<param name="y" type="unsigned long" dir="in"/>
14434	<param name="width" type="unsigned long" dir="in"/>
14435	<param name="height" type="unsigned long" dir="in"/>
14436	</method>
14437
14438	<method name="requestResize" wsmap="suppress">
14439	<desc>
14440	Requests a size and pixel format change.
14441
14442	There are two modes of working with the video buffer of the virtual
14443	machine. The <i>indirect</i> mode implies that the IFramebuffer
14444	implementation allocates a memory buffer for the requested display mode
14445	and provides it to the virtual machine. In <i>direct</i> mode, the
14446	IFramebuffer implementation uses the memory buffer allocated and owned
14447	by the virtual machine. This buffer represents the video memory of the
14448	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
14449	usually faster because the implementation gets a raw pointer to the
14450	guest VRAM buffer which it can directly use for visualizing the contents
14451	of the virtual display, as opposed to the indirect mode where the
14452	contents of guest VRAM are copied to the memory buffer provided by
14453	the implementation every time a display update occurs.
14454
14455	It is important to note that the direct mode is really fast only when
14456	the implementation uses the given guest VRAM buffer directly, for
14457	example, by blitting it to the window representing the virtual machine's
14458	display, which saves at least one copy operation comparing to the
14459	indirect mode. However, using the guest VRAM buffer directly is not
14460	always possible: the format and the color depth of this buffer may be
14461	not supported by the target window, or it may be unknown (opaque) as in
14462	case of text or non-linear multi-plane VGA video modes. In this case,
14463	the indirect mode (that is always available) should be used as a
14464	fallback: when the guest VRAM contents are copied to the
14465	implementation-provided memory buffer, color and format conversion is
14466	done automatically by the underlying code.
14467
14468	The @a pixelFormat parameter defines whether the direct mode is
14469	available or not. If @a pixelFormat is <link
14470	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
14471	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
14472	@a bytesPerLine parameters must be ignored and the implementation must use
14473	the indirect mode (where it provides its own buffer in one of the
14474	supported formats). In all other cases, @a pixelFormat together with
14475	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
14476	buffer pointed to by the @a VRAM parameter and the implementation is
14477	free to choose which mode to use. To indicate that this frame buffer uses
14478	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
14479	attribute must return @c true and <link to="#address"/> must
14480	return exactly the same address that is passed in the @a VRAM parameter
14481	of this method; otherwise it is assumed that the indirect strategy is
14482	chosen.
14483
14484	The @a width and @a height parameters represent the size of the
14485	requested display mode in both modes. In case of indirect mode, the
14486	provided memory buffer should be big enough to store data of the given
14487	display mode. In case of direct mode, it is guaranteed that the given
14488	@a VRAM buffer contains enough space to represent the display mode of the
14489	given size. Note that this frame buffer's <link to="#width"/> and <link
14490	to="#height"/> attributes must return exactly the same values as
14491	passed to this method after the resize is completed (see below).
14492
14493	The @a finished output parameter determines if the implementation has
14494	finished resizing the frame buffer or not. If, for some reason, the
14495	resize cannot be finished immediately during this call, @a finished
14496	must be set to @c false, and the implementation must call
14497	<link to="IDisplay::resizeCompleted"/> after it has returned from
14498	this method as soon as possible. If @a finished is @c false, the
14499	machine will not call any frame buffer methods until
14500	<link to="IDisplay::resizeCompleted"/> is called.
14501
14502	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14503	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14504	this frame buffer must return exactly the same values as specified in the
14505	parameters of this method, after the resize is completed. If the
14506	indirect mode is chosen, these attributes must return values describing
14507	the format of the implementation's own memory buffer <link
14508	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14509	value must always correlate with <link to="#pixelFormat"/>. Note that
14510	the <link to="#pixelFormat"/> attribute must never return <link
14511	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14512
14513	<note>
14514	This method is called by the IDisplay object under the
14515	<link to="#lock"/> provided by this IFramebuffer
14516	implementation. If this method returns @c false in @a finished, then
14517	this lock is not released until
14518	<link to="IDisplay::resizeCompleted"/> is called.
14519	</note>
14520	</desc>
14521	<param name="screenId" type="unsigned long" dir="in">
14522	<desc>
14523	Logical screen number. Must be used in the corresponding call to
14524	<link to="IDisplay::resizeCompleted"/> if this call is made.
14525	</desc>
14526	</param>
14527	<param name="pixelFormat" type="unsigned long" dir="in">
14528	<desc>
14529	Pixel format of the memory buffer pointed to by @a VRAM.
14530	See also <link to="FramebufferPixelFormat"/>.
14531	</desc>
14532	</param>
14533	<param name="VRAM" type="octet" mod="ptr" dir="in">
14534	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14535	</param>
14536	<param name="bitsPerPixel" type="unsigned long" dir="in">
14537	<desc>Color depth, bits per pixel.</desc>
14538	</param>
14539	<param name="bytesPerLine" type="unsigned long" dir="in">
14540	<desc>Size of one scan line, in bytes.</desc>
14541	</param>
14542	<param name="width" type="unsigned long" dir="in">
14543	<desc>Width of the guest display, in pixels.</desc>
14544	</param>
14545	<param name="height" type="unsigned long" dir="in">
14546	<desc>Height of the guest display, in pixels.</desc>
14547	</param>
14548	<param name="finished" type="boolean" dir="return">
14549	<desc>
14550	Can the VM start using the new frame buffer immediately
14551	after this method returns or it should wait for
14552	<link to="IDisplay::resizeCompleted"/>.
14553	</desc>
14554	</param>
14555	</method>
14556
14557	<method name="videoModeSupported">
14558	<desc>
14559	Returns whether the frame buffer implementation is willing to
14560	support a given video mode. In case it is not able to render
14561	the video mode (or for some reason not willing), it should
14562	return @c false. Usually this method is called when the guest
14563	asks the VMM device whether a given video mode is supported
14564	so the information returned is directly exposed to the guest.
14565	It is important that this method returns very quickly.
14566	</desc>
14567	<param name="width" type="unsigned long" dir="in"/>
14568	<param name="height" type="unsigned long" dir="in"/>
14569	<param name="bpp" type="unsigned long" dir="in"/>
14570	<param name="supported" type="boolean" dir="return"/>
14571	</method>
14572
14573	<method name="getVisibleRegion" wsmap="suppress">
14574	<desc>
14575	Returns the visible region of this frame buffer.
14576
14577	If the @a rectangles parameter is @c null then the value of the
14578	@a count parameter is ignored and the number of elements necessary to
14579	describe the current visible region is returned in @a countCopied.
14580
14581	If @a rectangles is not @c null but @a count is less
14582	than the required number of elements to store region data, the method
14583	will report a failure. If @a count is equal or greater than the
14584	required number of elements, then the actual number of elements copied
14585	to the provided array will be returned in @a countCopied.
14586
14587	<note>
14588	The address of the provided array must be in the process space of
14589	this IFramebuffer object.
14590	</note>
14591	<note>
14592	Method not yet implemented.
14593	</note>
14594	</desc>
14595	<param name="rectangles" type="octet" mod="ptr" dir="in">
14596	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14597	</param>
14598	<param name="count" type="unsigned long" dir="in">
14599	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14600	</param>
14601	<param name="countCopied" type="unsigned long" dir="return">
14602	<desc>Number of elements copied to the @a rectangles array.</desc>
14603	</param>
14604	</method>
14605
14606	<method name="setVisibleRegion" wsmap="suppress">
14607	<desc>
14608	Suggests a new visible region to this frame buffer. This region
14609	represents the area of the VM display which is a union of regions of
14610	all top-level windows of the guest operating system running inside the
14611	VM (if the Guest Additions for this system support this
14612	functionality). This information may be used by the frontends to
14613	implement the seamless desktop integration feature.
14614
14615	<note>
14616	The address of the provided array must be in the process space of
14617	this IFramebuffer object.
14618	</note>
14619	<note>
14620	The IFramebuffer implementation must make a copy of the provided
14621	array of rectangles.
14622	</note>
14623	<note>
14624	Method not yet implemented.
14625	</note>
14626	</desc>
14627	<param name="rectangles" type="octet" mod="ptr" dir="in">
14628	<desc>Pointer to the @c RTRECT array.</desc>
14629	</param>
14630	<param name="count" type="unsigned long" dir="in">
14631	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14632	</param>
14633	</method>
14634
14635	<method name="processVHWACommand" wsmap="suppress">
14636	<desc>
14637	Posts a Video HW Acceleration Command to the frame buffer for processing.
14638	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14639	are posted from quest to the host to be processed by the host hardware.
14640
14641	<note>
14642	The address of the provided command must be in the process space of
14643	this IFramebuffer object.
14644	</note>
14645	</desc>
14646
14647	<param name="command" type="octet" mod="ptr" dir="in">
14648	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14649	</param>
14650	</method>
14651
14652	<method name="notify3DEvent">
14653	<desc>
14654	Notifies framebuffer about 3D backend event.
14655	</desc>
14656
14657	<param name="type" type="unsigned long" dir="in">
14658	<desc>event type. Currently only VBOX3D_NOTIFY_EVENT_TYPE_VISIBLE_WINDOW is supported.</desc>
14659	</param>
14660	<param name="reserved" type="octet" mod="ptr" dir="in">
14661	<desc>Reserved for future use, must be NULL.</desc>
14662	</param>
14663	</method>
14664
14665	</interface>
14666
14667	<interface
14668	name="IFramebufferOverlay" extends="IFramebuffer"
14669	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14670	wsmap="managed"
14671	>
14672	<desc>
14673	The IFramebufferOverlay interface represents an alpha blended overlay
14674	for displaying status icons above an IFramebuffer. It is always created
14675	not visible, so that it must be explicitly shown. It only covers a
14676	portion of the IFramebuffer, determined by its width, height and
14677	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14678	that order) format, and may be written to directly. Do re-read the
14679	width though, after setting it, as it may be adjusted (increased) to
14680	make it more suitable for the front end.
14681	</desc>
14682	<attribute name="x" type="unsigned long" readonly="yes">
14683	<desc>X position of the overlay, relative to the frame buffer.</desc>
14684	</attribute>
14685
14686	<attribute name="y" type="unsigned long" readonly="yes">
14687	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14688	</attribute>
14689
14690	<attribute name="visible" type="boolean">
14691	<desc>
14692	Whether the overlay is currently visible.
14693	</desc>
14694	</attribute>
14695
14696	<attribute name="alpha" type="unsigned long">
14697	<desc>
14698	The global alpha value for the overlay. This may or may not be
14699	supported by a given front end.
14700	</desc>
14701	</attribute>
14702
14703	<method name="move">
14704	<desc>
14705	Changes the overlay's position relative to the IFramebuffer.
14706	</desc>
14707	<param name="x" type="unsigned long" dir="in"/>
14708	<param name="y" type="unsigned long" dir="in"/>
14709	</method>
14710
14711	</interface>
14712
14713	<interface
14714	name="IDisplay" extends="$unknown"
14715	uuid="23efdcab-1ae5-47ee-951e-e0f9a3935f2a"
14716	wsmap="managed"
14717	>
14718	<desc>
14719	The IDisplay interface represents the virtual machine's display.
14720
14721	The object implementing this interface is contained in each
14722	<link to="IConsole::display"/> attribute and represents the visual
14723	output of the virtual machine.
14724
14725	The virtual display supports pluggable output targets represented by the
14726	IFramebuffer interface. Examples of the output target are a window on
14727	the host computer or an RDP session's display on a remote computer.
14728	</desc>
14729	<method name="getScreenResolution">
14730	<desc>Queries display width, height and color depth for given screen.</desc>
14731	<param name="screenId" type="unsigned long" dir="in"/>
14732	<param name="width" type="unsigned long" dir="out"/>
14733	<param name="height" type="unsigned long" dir="out"/>
14734	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14735	</method>
14736
14737	<method name="setFramebuffer">
14738	<desc>
14739	Sets the framebuffer for given screen.
14740	</desc>
14741	<param name="screenId" type="unsigned long" dir="in"/>
14742	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14743	</method>
14744
14745	<method name="getFramebuffer">
14746	<desc>
14747	Queries the framebuffer for given screen.
14748	</desc>
14749	<param name="screenId" type="unsigned long" dir="in"/>
14750	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14751	<param name="xOrigin" type="long" dir="out"/>
14752	<param name="yOrigin" type="long" dir="out"/>
14753	</method>
14754
14755	<method name="setVideoModeHint">
14756	<desc>
14757	Asks VirtualBox to request the given video mode from
14758	the guest. This is just a hint and it cannot be guaranteed
14759	that the requested resolution will be used. Guest Additions
14760	are required for the request to be seen by guests. The caller
14761	should issue the request and wait for a resolution change and
14762	after a timeout retry.
14763
14764	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14765	parameters means that the corresponding values should be taken from the
14766	current video mode (i.e. left unchanged).
14767
14768	If the guest OS supports multi-monitor configuration then the @a display
14769	parameter specifies the number of the guest display to send the hint to:
14770	@c 0 is the primary display, @c 1 is the first secondary and
14771	so on. If the multi-monitor configuration is not supported, @a display
14772	must be @c 0.
14773
14774	<result name="E_INVALIDARG">
14775	The @a display is not associated with any monitor.
14776	</result>
14777
14778	</desc>
14779	<param name="display" type="unsigned long" dir="in">
14780	<desc>
14781	The number of the guest display to send the hint to.
14782	</desc>
14783	</param>
14784	<param name="enabled" type="boolean" dir="in">
14785	<desc>
14786	@c True, if this guest screen is enabled,
14787	@c False otherwise.
14788	</desc>
14789	</param>
14790	<param name="changeOrigin" type="boolean" dir="in">
14791	<desc>
14792	@c True, if the origin of the guest screen should be changed,
14793	@c False otherwise.
14794	</desc>
14795	</param>
14796	<param name="originX" type="long" dir="in">
14797	<desc>
14798	The X origin of the guest screen.
14799	</desc>
14800	</param>
14801	<param name="originY" type="long" dir="in">
14802	<desc>
14803	The Y origin of the guest screen.
14804	</desc>
14805	</param>
14806	<param name="width" type="unsigned long" dir="in"/>
14807	<param name="height" type="unsigned long" dir="in"/>
14808	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14809	</method>
14810
14811	<method name="setSeamlessMode">
14812	<desc>
14813	Enables or disables seamless guest display rendering (seamless desktop
14814	integration) mode.
14815	<note>
14816	Calling this method has no effect if <link
14817	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14818	does not return @c Active.
14819	</note>
14820	</desc>
14821	<param name="enabled" type="boolean" dir="in"/>
14822	</method>
14823
14824	<method name="takeScreenShot">
14825	<desc>
14826	Takes a screen shot of the requested size and copies it to the
14827	32-bpp buffer allocated by the caller and pointed to by @a address.
14828	A pixel consists of 4 bytes in order: B, G, R, 0.
14829
14830	<note>This API can be used only locally by a VM process through the
14831	COM/XPCOM C++ API as it requires pointer support. It is not
14832	available for scripting langages, Java or any webservice clients.
14833	Unless you are writing a new VM frontend use
14834	<link to="#takeScreenShotToArray" />.
14835	</note>
14836
14837	<result name="E_NOTIMPL">
14838	Feature not implemented.
14839	</result>
14840	<result name="VBOX_E_IPRT_ERROR">
14841	Could not take a screenshot.
14842	</result>
14843
14844	</desc>
14845	<param name="screenId" type="unsigned long" dir="in"/>
14846	<param name="address" type="octet" mod="ptr" dir="in"/>
14847	<param name="width" type="unsigned long" dir="in"/>
14848	<param name="height" type="unsigned long" dir="in"/>
14849	</method>
14850
14851	<method name="takeScreenShotToArray">
14852	<desc>
14853	Takes a guest screen shot of the requested size and returns it as
14854	an array of bytes in uncompressed 32-bpp RGBA format.
14855	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14856
14857	This API is slow, but could be the only option to get guest screenshot
14858	for scriptable languages not allowed to manipulate with addresses
14859	directly.
14860
14861	<result name="E_NOTIMPL">
14862	Feature not implemented.
14863	</result>
14864	<result name="VBOX_E_IPRT_ERROR">
14865	Could not take a screenshot.
14866	</result>
14867	</desc>
14868	<param name="screenId" type="unsigned long" dir="in">
14869	<desc>
14870	Monitor to take screenshot from.
14871	</desc>
14872	</param>
14873	<param name="width" type="unsigned long" dir="in">
14874	<desc>
14875	Desired image width.
14876	</desc>
14877	</param>
14878	<param name="height" type="unsigned long" dir="in">
14879	<desc>
14880	Desired image height.
14881	</desc>
14882	</param>
14883	<param name="screenData" type="octet" dir="return" safearray="yes">
14884	<desc>
14885	Array with resulting screen data.
14886	</desc>
14887	</param>
14888	</method>
14889
14890	<method name="takeScreenShotPNGToArray">
14891	<desc>
14892	Takes a guest screen shot of the requested size and returns it as
14893	PNG image in array.
14894
14895	<result name="E_NOTIMPL">
14896	Feature not implemented.
14897	</result>
14898	<result name="VBOX_E_IPRT_ERROR">
14899	Could not take a screenshot.
14900	</result>
14901	</desc>
14902	<param name="screenId" type="unsigned long" dir="in">
14903	<desc>
14904	Monitor to take the screenshot from.
14905	</desc>
14906	</param>
14907	<param name="width" type="unsigned long" dir="in">
14908	<desc>
14909	Desired image width.
14910	</desc>
14911	</param>
14912	<param name="height" type="unsigned long" dir="in">
14913	<desc>
14914	Desired image height.
14915	</desc>
14916	</param>
14917	<param name="screenData" type="octet" dir="return" safearray="yes">
14918	<desc>
14919	Array with resulting screen data.
14920	</desc>
14921	</param>
14922	</method>
14923
14924	<method name="drawToScreen">
14925	<desc>
14926	Draws a 32-bpp image of the specified size from the given buffer
14927	to the given point on the VM display.
14928
14929	<result name="E_NOTIMPL">
14930	Feature not implemented.
14931	</result>
14932	<result name="VBOX_E_IPRT_ERROR">
14933	Could not draw to screen.
14934	</result>
14935
14936	</desc>
14937	<param name="screenId" type="unsigned long" dir="in">
14938	<desc>
14939	Monitor to take the screenshot from.
14940	</desc>
14941	</param>
14942	<param name="address" type="octet" mod="ptr" dir="in">
14943	<desc>
14944	Address to store the screenshot to
14945	</desc>
14946	</param>
14947	<param name="x" type="unsigned long" dir="in">
14948	<desc>
14949	Relative to the screen top left corner.
14950	</desc>
14951	</param>
14952	<param name="y" type="unsigned long" dir="in">
14953	<desc>
14954	Relative to the screen top left corner.
14955	</desc>
14956	</param>
14957	<param name="width" type="unsigned long" dir="in">
14958	<desc>
14959	Desired image width.
14960	</desc>
14961	</param>
14962	<param name="height" type="unsigned long" dir="in">
14963	<desc>
14964	Desired image height.
14965	</desc>
14966	</param>
14967	</method>
14968
14969	<method name="invalidateAndUpdate">
14970	<desc>
14971	Does a full invalidation of the VM display and instructs the VM
14972	to update it.
14973
14974	<result name="VBOX_E_IPRT_ERROR">
14975	Could not invalidate and update screen.
14976	</result>
14977
14978	</desc>
14979	</method>
14980
14981	<method name="resizeCompleted">
14982	<desc>
14983	Signals that a framebuffer has completed the resize operation.
14984
14985	<result name="VBOX_E_NOT_SUPPORTED">
14986	Operation only valid for external frame buffers.
14987	</result>
14988
14989	</desc>
14990	<param name="screenId" type="unsigned long" dir="in"/>
14991	</method>
14992
14993	<method name="completeVHWACommand">
14994	<desc>
14995	Signals that the Video HW Acceleration command has completed.
14996	</desc>
14997
14998	<param name="command" type="octet" mod="ptr" dir="in">
14999	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
15000	</param>
15001	</method>
15002
15003	<method name="viewportChanged">
15004	<desc>
15005	Signals that framebuffer window viewport has changed.
15006
15007	<result name="E_INVALIDARG">
15008	The specified viewport data is invalid.
15009	</result>
15010
15011	</desc>
15012
15013	<param name="screenId" type="unsigned long" dir="in">
15014	<desc>
15015	Monitor to take the screenshot from.
15016	</desc>
15017	</param>
15018	<param name="x" type="unsigned long" dir="in">
15019	<desc>
15020	Framebuffer x offset.
15021	</desc>
15022	</param>
15023	<param name="y" type="unsigned long" dir="in">
15024	<desc>
15025	Framebuffer y offset.
15026	</desc>
15027	</param>
15028	<param name="width" type="unsigned long" dir="in">
15029	<desc>
15030	Viewport width.
15031	</desc>
15032	</param>
15033	<param name="height" type="unsigned long" dir="in">
15034	<desc>
15035	Viewport height.
15036	</desc>
15037	</param>
15038	</method>
15039	</interface>
15040
15041	<!--
15042	// INetworkAdapter
15043	/////////////////////////////////////////////////////////////////////////
15044	-->
15045
15046	<enum
15047	name="NetworkAttachmentType"
15048	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
15049	>
15050	<desc>
15051	Network attachment type.
15052	</desc>
15053
15054	<const name="Null" value="0">
15055	<desc>Null value, also means "not attached".</desc>
15056	</const>
15057	<const name="NAT" value="1"/>
15058	<const name="Bridged" value="2"/>
15059	<const name="Internal" value="3"/>
15060	<const name="HostOnly" value="4"/>
15061	<const name="Generic" value="5"/>
15062	</enum>
15063
15064	<enum
15065	name="NetworkAdapterType"
15066	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
15067	>
15068	<desc>
15069	Network adapter type.
15070	</desc>
15071
15072	<const name="Null" value="0">
15073	<desc>Null value (never used by the API).</desc>
15074	</const>
15075	<const name="Am79C970A" value="1">
15076	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
15077	</const>
15078	<const name="Am79C973" value="2">
15079	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
15080	</const>
15081	<const name="I82540EM" value="3">
15082	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
15083	</const>
15084	<const name="I82543GC" value="4">
15085	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
15086	</const>
15087	<const name="I82545EM" value="5">
15088	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
15089	</const>
15090	<const name="Virtio" value="6">
15091	<desc>Virtio network device.</desc>
15092	</const>
15093	</enum>
15094
15095	<enum
15096	name="NetworkAdapterPromiscModePolicy"
15097	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
15098	>
15099	<desc>
15100	The promiscuous mode policy of an interface.
15101	</desc>
15102
15103	<const name="Deny" value="1">
15104	<desc>Deny promiscuous mode requests.</desc>
15105	</const>
15106	<const name="AllowNetwork" value="2">
15107	<desc>
15108	Allow promicuous mode, but restrict the scope it to the internal
15109	network so that it only applies to other VMs.
15110	</desc>
15111	</const>
15112	<const name="AllowAll" value="3">
15113	<desc>
15114	Allow promicuous mode, include unrelated traffic going over the wire
15115	and internally on the host.
15116	</desc>
15117	</const>
15118	</enum>
15119
15120	<interface
15121	name="INetworkAdapter" extends="$unknown"
15122	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
15123	wsmap="managed"
15124	>
15125	<desc>
15126	Represents a virtual network adapter that is attached to a virtual machine.
15127	Each virtual machine has a fixed number of network adapter slots with one
15128	instance of this attached to each of them. Call
15129	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
15130	is attached to a given slot in a given machine.
15131
15132	Each network adapter can be in one of five attachment modes, which are
15133	represented by the <link to="NetworkAttachmentType" /> enumeration;
15134	see the <link to="#attachmentType" /> attribute.
15135	</desc>
15136
15137	<attribute name="adapterType" type="NetworkAdapterType">
15138	<desc>
15139	Type of the virtual network adapter. Depending on this value,
15140	VirtualBox will provide a different virtual network hardware
15141	to the guest.
15142	</desc>
15143	</attribute>
15144
15145	<attribute name="slot" type="unsigned long" readonly="yes">
15146	<desc>
15147	Slot number this adapter is plugged into. Corresponds to
15148	the value you pass to <link to="IMachine::getNetworkAdapter"/>
15149	to obtain this instance.
15150	</desc>
15151	</attribute>
15152
15153	<attribute name="enabled" type="boolean">
15154	<desc>
15155	Flag whether the network adapter is present in the
15156	guest system. If disabled, the virtual guest hardware will
15157	not contain this network adapter. Can only be changed when
15158	the VM is not running.
15159	</desc>
15160	</attribute>
15161
15162	<attribute name="MACAddress" type="wstring">
15163	<desc>
15164	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
15165	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
15166	</desc>
15167	</attribute>
15168
15169	<attribute name="attachmentType" type="NetworkAttachmentType">
15170	<desc>
15171	Sets/Gets network attachment type of this network adapter.
15172	</desc>
15173	</attribute>
15174
15175	<attribute name="bridgedInterface" type="wstring">
15176	<desc>
15177	Name of the network interface the VM should be bridged to.
15178	</desc>
15179	</attribute>
15180
15181	<attribute name="hostOnlyInterface" type="wstring">
15182	<desc>
15183	Name of the host only network interface the VM is attached to.
15184	</desc>
15185	</attribute>
15186
15187	<attribute name="internalNetwork" type="wstring">
15188	<desc>
15189	Name of the internal network the VM is attached to.
15190	</desc>
15191	</attribute>
15192
15193	<attribute name="NATNetwork" type="wstring">
15194	<desc>
15195	Name of the NAT network the VM is attached to.
15196	</desc>
15197	</attribute>
15198
15199	<attribute name="genericDriver" type="wstring">
15200	<desc>
15201	Name of the driver to use for the "Generic" network attachment type.
15202	</desc>
15203	</attribute>
15204
15205	<attribute name="cableConnected" type="boolean">
15206	<desc>
15207	Flag whether the adapter reports the cable as connected or not.
15208	It can be used to report offline situations to a VM.
15209	</desc>
15210	</attribute>
15211
15212	<attribute name="lineSpeed" type="unsigned long">
15213	<desc>
15214	Line speed reported by custom drivers, in units of 1 kbps.
15215	</desc>
15216	</attribute>
15217
15218	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
15219	<desc>
15220	The promiscuous mode policy of the network adapter when attached to an
15221	internal network, host only network or a bridge.
15222	</desc>
15223	</attribute>
15224
15225	<attribute name="traceEnabled" type="boolean">
15226	<desc>
15227	Flag whether network traffic from/to the network card should be traced.
15228	Can only be toggled when the VM is turned off.
15229	</desc>
15230	</attribute>
15231
15232	<attribute name="traceFile" type="wstring">
15233	<desc>
15234	Filename where a network trace will be stored. If not set, VBox-pid.pcap
15235	will be used.
15236	</desc>
15237	</attribute>
15238
15239	<attribute name="NATEngine" type="INATEngine" readonly="yes">
15240	<desc>
15241	Points to the NAT engine which handles the network address translation
15242	for this interface. This is active only when the interface actually uses
15243	NAT.
15244	</desc>
15245	</attribute>
15246
15247	<attribute name="bootPriority" type="unsigned long">
15248	<desc>
15249	Network boot priority of the adapter. Priority 1 is highest. If not set,
15250	the priority is considered to be at the lowest possible setting.
15251	</desc>
15252	</attribute>
15253
15254	<attribute name="bandwidthGroup" type="IBandwidthGroup">
15255	<desc>The bandwidth group this network adapter is assigned to.</desc>
15256	</attribute>
15257
15258	<!-- property methods -->
15259
15260	<method name="getProperty" const="yes">
15261	<desc>
15262	Returns the value of the network attachment property with the given name.
15263
15264	If the requested data @a key does not exist, this function will
15265	succeed and return an empty string in the @a value argument.
15266
15267	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15268	</desc>
15269	<param name="key" type="wstring" dir="in">
15270	<desc>Name of the property to get.</desc>
15271	</param>
15272	<param name="value" type="wstring" dir="return">
15273	<desc>Current property value.</desc>
15274	</param>
15275	</method>
15276
15277	<method name="setProperty">
15278	<desc>
15279	Sets the value of the network attachment property with the given name.
15280
15281	Setting the property value to @c null or an empty string is equivalent
15282	to deleting the existing value.
15283
15284	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15285	</desc>
15286	<param name="key" type="wstring" dir="in">
15287	<desc>Name of the property to set.</desc>
15288	</param>
15289	<param name="value" type="wstring" dir="in">
15290	<desc>Property value to set.</desc>
15291	</param>
15292	</method>
15293
15294	<method name="getProperties" const="yes">
15295	<desc>
15296	Returns values for a group of properties in one call.
15297
15298	The names of the properties to get are specified using the @a names
15299	argument which is a list of comma-separated property names or
15300	an empty string if all properties are to be returned.
15301	<note>Currently the value of this argument is ignored and the method
15302	always returns all existing properties.</note>
15303
15304	The method returns two arrays, the array of property names corresponding
15305	to the @a names argument and the current values of these properties.
15306	Both arrays have the same number of elements with each element at the
15307	given index in the first array corresponds to an element at the same
15308	index in the second array.
15309	</desc>
15310	<param name="names" type="wstring" dir="in">
15311	<desc>
15312	Names of properties to get.
15313	</desc>
15314	</param>
15315	<param name="returnNames" type="wstring" safearray="yes" dir="out">
15316	<desc>Names of returned properties.</desc>
15317	</param>
15318	<param name="returnValues" type="wstring" safearray="yes" dir="return">
15319	<desc>Values of returned properties.</desc>
15320	</param>
15321	</method>
15322
15323	</interface>
15324
15325
15326	<!--
15327	// ISerialPort
15328	/////////////////////////////////////////////////////////////////////////
15329	-->
15330
15331	<enum
15332	name="PortMode"
15333	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
15334	>
15335	<desc>
15336	The PortMode enumeration represents possible communication modes for
15337	the virtual serial port device.
15338	</desc>
15339
15340	<const name="Disconnected" value="0">
15341	<desc>Virtual device is not attached to any real host device.</desc>
15342	</const>
15343	<const name="HostPipe" value="1">
15344	<desc>Virtual device is attached to a host pipe.</desc>
15345	</const>
15346	<const name="HostDevice" value="2">
15347	<desc>Virtual device is attached to a host device.</desc>
15348	</const>
15349	<const name="RawFile" value="3">
15350	<desc>Virtual device is attached to a raw file.</desc>
15351	</const>
15352	</enum>
15353
15354	<interface
15355	name="ISerialPort" extends="$unknown"
15356	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
15357	wsmap="managed"
15358	>
15359
15360	<desc>
15361	The ISerialPort interface represents the virtual serial port device.
15362
15363	The virtual serial port device acts like an ordinary serial port
15364	inside the virtual machine. This device communicates to the real
15365	serial port hardware in one of two modes: host pipe or host device.
15366
15367	In host pipe mode, the #path attribute specifies the path to the pipe on
15368	the host computer that represents a serial port. The #server attribute
15369	determines if this pipe is created by the virtual machine process at
15370	machine startup or it must already exist before starting machine
15371	execution.
15372
15373	In host device mode, the #path attribute specifies the name of the
15374	serial port device on the host computer.
15375
15376	There is also a third communication mode: the disconnected mode. In this
15377	mode, the guest OS running inside the virtual machine will be able to
15378	detect the serial port, but all port write operations will be discarded
15379	and all port read operations will return no data.
15380
15381	<see><link to="IMachine::getSerialPort"/></see>
15382	</desc>
15383
15384	<attribute name="slot" type="unsigned long" readonly="yes">
15385	<desc>
15386	Slot number this serial port is plugged into. Corresponds to
15387	the value you pass to <link to="IMachine::getSerialPort"/>
15388	to obtain this instance.
15389	</desc>
15390	</attribute>
15391
15392	<attribute name="enabled" type="boolean">
15393	<desc>
15394	Flag whether the serial port is enabled. If disabled,
15395	the serial port will not be reported to the guest OS.
15396	</desc>
15397	</attribute>
15398
15399	<attribute name="IOBase" type="unsigned long">
15400	<desc>Base I/O address of the serial port.</desc>
15401	</attribute>
15402
15403	<attribute name="IRQ" type="unsigned long">
15404	<desc>IRQ number of the serial port.</desc>
15405	</attribute>
15406
15407	<attribute name="hostMode" type="PortMode">
15408	<desc>
15409	How is this port connected to the host.
15410	<note>
15411	Changing this attribute may fail if the conditions for
15412	<link to="#path"/> are not met.
15413	</note>
15414	</desc>
15415	</attribute>
15416
15417	<attribute name="server" type="boolean">
15418	<desc>
15419	Flag whether this serial port acts as a server (creates a new pipe on
15420	the host) or as a client (uses the existing pipe). This attribute is
15421	used only when <link to="#hostMode"/> is PortMode_HostPipe.
15422	</desc>
15423	</attribute>
15424
15425	<attribute name="path" type="wstring">
15426	<desc>
15427	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
15428	PortMode_HostPipe, or the host serial device name when
15429	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
15430	cases, setting a @c null or empty string as the attribute's value
15431	is an error. Otherwise, the value of this property is ignored.
15432	</desc>
15433	</attribute>
15434
15435	</interface>
15436
15437	<!--
15438	// IParallelPort
15439	/////////////////////////////////////////////////////////////////////////
15440	-->
15441
15442	<interface
15443	name="IParallelPort" extends="$unknown"
15444	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
15445	wsmap="managed"
15446	>
15447
15448	<desc>
15449	The IParallelPort interface represents the virtual parallel port device.
15450
15451	The virtual parallel port device acts like an ordinary parallel port
15452	inside the virtual machine. This device communicates to the real
15453	parallel port hardware using the name of the parallel device on the host
15454	computer specified in the #path attribute.
15455
15456	Each virtual parallel port device is assigned a base I/O address and an
15457	IRQ number that will be reported to the guest operating system and used
15458	to operate the given parallel port from within the virtual machine.
15459
15460	<see><link to="IMachine::getParallelPort"/></see>
15461	</desc>
15462
15463	<attribute name="slot" type="unsigned long" readonly="yes">
15464	<desc>
15465	Slot number this parallel port is plugged into. Corresponds to
15466	the value you pass to <link to="IMachine::getParallelPort"/>
15467	to obtain this instance.
15468	</desc>
15469	</attribute>
15470
15471	<attribute name="enabled" type="boolean">
15472	<desc>
15473	Flag whether the parallel port is enabled. If disabled,
15474	the parallel port will not be reported to the guest OS.
15475	</desc>
15476	</attribute>
15477
15478	<attribute name="IOBase" type="unsigned long">
15479	<desc>Base I/O address of the parallel port.</desc>
15480	</attribute>
15481
15482	<attribute name="IRQ" type="unsigned long">
15483	<desc>IRQ number of the parallel port.</desc>
15484	</attribute>
15485
15486	<attribute name="path" type="wstring">
15487	<desc>
15488	Host parallel device name. If this parallel port is enabled, setting a
15489	@c null or an empty string as this attribute's value will result in
15490	an error.
15491	</desc>
15492	</attribute>
15493
15494	</interface>
15495
15496
15497	<!--
15498	// IMachineDebugger
15499	/////////////////////////////////////////////////////////////////////////
15500	-->
15501
15502	<interface
15503	name="IMachineDebugger" extends="$unknown"
15504	uuid="5e4534dc-21b8-4f6b-8a08-eef50e1a0aa1"
15505	wsmap="managed"
15506	>
15507	<method name="dumpGuestCore">
15508	<desc>
15509	Takes a core dump of the guest.
15510
15511	See include/VBox/dbgfcorefmt.h for details on the file format.
15512	</desc>
15513	<param name="filename" type="wstring" dir="in">
15514	<desc>
15515	The name of the output file. The file must not exist.
15516	</desc>
15517	</param>
15518	<param name="compression" type="wstring" dir="in">
15519	<desc>
15520	Reserved for future compression method indicator.
15521	</desc>
15522	</param>
15523	</method>
15524
15525	<method name="dumpHostProcessCore">
15526	<desc>
15527	Takes a core dump of the VM process on the host.
15528
15529	This feature is not implemented in the 4.0.0 release but it may show up
15530	in a dot release.
15531	</desc>
15532	<param name="filename" type="wstring" dir="in">
15533	<desc>
15534	The name of the output file. The file must not exist.
15535	</desc>
15536	</param>
15537	<param name="compression" type="wstring" dir="in">
15538	<desc>
15539	Reserved for future compression method indicator.
15540	</desc>
15541	</param>
15542	</method>
15543
15544	<method name="info">
15545	<desc>
15546	Interfaces with the info dumpers (DBGFInfo).
15547
15548	This feature is not implemented in the 4.0.0 release but it may show up
15549	in a dot release.
15550	</desc>
15551	<param name="name" type="wstring" dir="in">
15552	<desc>
15553	The name of the info item.
15554	</desc>
15555	</param>
15556	<param name="args" type="wstring" dir="in">
15557	<desc>
15558	Arguments to the info dumper.
15559	</desc>
15560	</param>
15561	<param name="info" type="wstring" dir="return">
15562	<desc>
15563	The into string.
15564	</desc>
15565	</param>
15566	</method>
15567
15568	<method name="injectNMI">
15569	<desc>
15570	Inject an NMI into a running VT-x/AMD-V VM.
15571	</desc>
15572	</method>
15573
15574	<method name="modifyLogGroups">
15575	<desc>
15576	Modifies the group settings of the debug or release logger.
15577	</desc>
15578	<param name="settings" type="wstring" dir="in">
15579	<desc>
15580	The group settings string. See iprt/log.h for details. To target the
15581	release logger, prefix the string with "release:".
15582	</desc>
15583	</param>
15584	</method>
15585
15586	<method name="modifyLogFlags">
15587	<desc>
15588	Modifies the debug or release logger flags.
15589	</desc>
15590	<param name="settings" type="wstring" dir="in">
15591	<desc>
15592	The flags settings string. See iprt/log.h for details. To target the
15593	release logger, prefix the string with "release:".
15594	</desc>
15595	</param>
15596	</method>
15597
15598	<method name="modifyLogDestinations">
15599	<desc>
15600	Modifies the debug or release logger destinations.
15601	</desc>
15602	<param name="settings" type="wstring" dir="in">
15603	<desc>
15604	The destination settings string. See iprt/log.h for details. To target the
15605	release logger, prefix the string with "release:".
15606	</desc>
15607	</param>
15608	</method>
15609
15610	<method name="readPhysicalMemory">
15611	<desc>
15612	Reads guest physical memory, no side effects (MMIO++).
15613
15614	This feature is not implemented in the 4.0.0 release but may show up
15615	in a dot release.
15616	</desc>
15617	<param name="address" type="long long" dir="in">
15618	<desc>The guest physical address.</desc>
15619	</param>
15620	<param name="size" type="unsigned long" dir="in">
15621	<desc>The number of bytes to read.</desc>
15622	</param>
15623	<param name="bytes" type="octet" safearray="yes" dir="return">
15624	<desc>The bytes read.</desc>
15625	</param>
15626	</method>
15627
15628	<method name="writePhysicalMemory">
15629	<desc>
15630	Writes guest physical memory, access handles (MMIO++) are ignored.
15631
15632	This feature is not implemented in the 4.0.0 release but may show up
15633	in a dot release.
15634	</desc>
15635	<param name="address" type="long long" dir="in">
15636	<desc>The guest physical address.</desc>
15637	</param>
15638	<param name="size" type="unsigned long" dir="in">
15639	<desc>The number of bytes to read.</desc>
15640	</param>
15641	<param name="bytes" type="octet" safearray="yes" dir="in">
15642	<desc>The bytes to write.</desc>
15643	</param>
15644	</method>
15645
15646	<method name="readVirtualMemory">
15647	<desc>
15648	Reads guest virtual memory, no side effects (MMIO++).
15649
15650	This feature is not implemented in the 4.0.0 release but may show up
15651	in a dot release.
15652	</desc>
15653	<param name="cpuId" type="unsigned long" dir="in">
15654	<desc>The identifier of the Virtual CPU.</desc>
15655	</param>
15656	<param name="address" type="long long" dir="in">
15657	<desc>The guest virtual address.</desc>
15658	</param>
15659	<param name="size" type="unsigned long" dir="in">
15660	<desc>The number of bytes to read.</desc>
15661	</param>
15662	<param name="bytes" type="octet" safearray="yes" dir="return">
15663	<desc>The bytes read.</desc>
15664	</param>
15665	</method>
15666
15667	<method name="writeVirtualMemory">
15668	<desc>
15669	Writes guest virtual memory, access handles (MMIO++) are ignored.
15670
15671	This feature is not implemented in the 4.0.0 release but may show up
15672	in a dot release.
15673	</desc>
15674	<param name="cpuId" type="unsigned long" dir="in">
15675	<desc>The identifier of the Virtual CPU.</desc>
15676	</param>
15677	<param name="address" type="long long" dir="in">
15678	<desc>The guest virtual address.</desc>
15679	</param>
15680	<param name="size" type="unsigned long" dir="in">
15681	<desc>The number of bytes to read.</desc>
15682	</param>
15683	<param name="bytes" type="octet" safearray="yes" dir="in">
15684	<desc>The bytes to write.</desc>
15685	</param>
15686	</method>
15687
15688	<method name="detectOS">
15689	<desc>
15690	Tries to (re-)detect the guest OS kernel.
15691
15692	This feature is not implemented in the 4.0.0 release but may show up
15693	in a dot release.
15694	</desc>
15695	<param name="os" type="wstring" dir="return">
15696	<desc>
15697	The detected OS kernel on success.
15698	</desc>
15699	</param>
15700	</method>
15701
15702	<method name="getRegister">
15703	<desc>
15704	Gets one register.
15705
15706	This feature is not implemented in the 4.0.0 release but may show up
15707	in a dot release.
15708	</desc>
15709	<param name="cpuId" type="unsigned long" dir="in">
15710	<desc>The identifier of the Virtual CPU.</desc>
15711	</param>
15712	<param name="name" type="wstring" dir="in">
15713	<desc>The register name, case is ignored.</desc>
15714	</param>
15715	<param name="value" type="wstring" dir="return">
15716	<desc>
15717	The register value. This is usually a hex value (always 0x prefixed)
15718	but other format may be used for floating point registers (TBD).
15719	</desc>
15720	</param>
15721	</method>
15722
15723	<method name="getRegisters">
15724	<desc>
15725	Gets all the registers for the given CPU.
15726
15727	This feature is not implemented in the 4.0.0 release but may show up
15728	in a dot release.
15729	</desc>
15730	<param name="cpuId" type="unsigned long" dir="in">
15731	<desc>The identifier of the Virtual CPU.</desc>
15732	</param>
15733	<param name="names" type="wstring" dir="out" safearray="yes">
15734	<desc>Array containing the lowercase register names.</desc>
15735	</param>
15736	<param name="values" type="wstring" dir="out" safearray="yes">
15737	<desc>
15738	Array paralell to the names holding the register values as if the
15739	register was returned by <link to="IMachineDebugger::getRegister"/>.
15740	</desc>
15741	</param>
15742	</method>
15743
15744	<method name="setRegister">
15745	<desc>
15746	Gets one register.
15747
15748	This feature is not implemented in the 4.0.0 release but may show up
15749	in a dot release.
15750	</desc>
15751	<param name="cpuId" type="unsigned long" dir="in">
15752	<desc>The identifier of the Virtual CPU.</desc>
15753	</param>
15754	<param name="name" type="wstring" dir="in">
15755	<desc>The register name, case is ignored.</desc>
15756	</param>
15757	<param name="value" type="wstring" dir="in">
15758	<desc>
15759	The new register value. Hexadecimal, decimal and octal formattings
15760	are supported in addition to any special formattings returned by
15761	the getters.
15762	</desc>
15763	</param>
15764	</method>
15765
15766	<method name="setRegisters">
15767	<desc>
15768	Sets zero or more registers atomically.
15769
15770	This feature is not implemented in the 4.0.0 release but may show up
15771	in a dot release.
15772	</desc>
15773	<param name="cpuId" type="unsigned long" dir="in">
15774	<desc>The identifier of the Virtual CPU.</desc>
15775	</param>
15776	<param name="names" type="wstring" dir="in" safearray="yes">
15777	<desc>Array containing the register names, case ignored.</desc>
15778	</param>
15779	<param name="values" type="wstring" dir="in" safearray="yes">
15780	<desc>
15781	Array paralell to the names holding the register values. See
15782	<link to="IMachineDebugger::setRegister"/> for formatting
15783	guidelines.
15784	</desc>
15785	</param>
15786	</method>
15787
15788	<method name="dumpGuestStack">
15789	<desc>
15790	Produce a simple stack dump using the current guest state.
15791
15792	This feature is not implemented in the 4.0.0 release but may show up
15793	in a dot release.
15794	</desc>
15795	<param name="cpuId" type="unsigned long" dir="in">
15796	<desc>The identifier of the Virtual CPU.</desc>
15797	</param>
15798	<param name="stack" type="wstring" dir="return">
15799	<desc>String containing the formatted stack dump.</desc>
15800	</param>
15801	</method>
15802
15803	<method name="resetStats">
15804	<desc>
15805	Reset VM statistics.
15806	</desc>
15807	<param name="pattern" type="wstring" dir="in">
15808	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15809	</param>
15810	</method>
15811
15812	<method name="dumpStats">
15813	<desc>
15814	Dumps VM statistics.
15815	</desc>
15816	<param name="pattern" type="wstring" dir="in">
15817	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15818	</param>
15819	</method>
15820
15821	<method name="getStats">
15822	<desc>
15823	Get the VM statistics in a XMLish format.
15824	</desc>
15825	<param name="pattern" type="wstring" dir="in">
15826	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15827	</param>
15828	<param name="withDescriptions" type="boolean" dir="in">
15829	<desc>Whether to include the descriptions.</desc>
15830	</param>
15831	<param name="stats" type="wstring" dir="return">
15832	<desc>The XML document containing the statistics.</desc>
15833	</param>
15834	</method>
15835
15836	<attribute name="singleStep" type="boolean">
15837	<desc>Switch for enabling single-stepping.</desc>
15838	</attribute>
15839
15840	<attribute name="recompileUser" type="boolean">
15841	<desc>Switch for forcing code recompilation for user mode code.</desc>
15842	</attribute>
15843
15844	<attribute name="recompileSupervisor" type="boolean">
15845	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15846	</attribute>
15847
15848	<attribute name="executeAllInIEM" type="boolean">
15849	<desc>
15850	Whether to execute all the code in the instruction interpreter. This
15851	is mainly for testing the interpreter and not an execution mode
15852	intended for general consumption.
15853	</desc>
15854	</attribute>
15855
15856	<attribute name="PATMEnabled" type="boolean">
15857	<desc>Switch for enabling and disabling the PATM component.</desc>
15858	</attribute>
15859
15860	<attribute name="CSAMEnabled" type="boolean">
15861	<desc>Switch for enabling and disabling the CSAM component.</desc>
15862	</attribute>
15863
15864	<attribute name="logEnabled" type="boolean">
15865	<desc>Switch for enabling and disabling the debug logger.</desc>
15866	</attribute>
15867
15868	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15869	<desc>The debug logger flags.</desc>
15870	</attribute>
15871
15872	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15873	<desc>The debug logger's group settings.</desc>
15874	</attribute>
15875
15876	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15877	<desc>The debug logger's destination settings.</desc>
15878	</attribute>
15879
15880	<attribute name="logRelFlags" type="wstring" readonly="yes">
15881	<desc>The release logger flags.</desc>
15882	</attribute>
15883
15884	<attribute name="logRelGroups" type="wstring" readonly="yes">
15885	<desc>The release logger's group settings.</desc>
15886	</attribute>
15887
15888	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15889	<desc>The relase logger's destination settings.</desc>
15890	</attribute>
15891
15892	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15893	<desc>
15894	Flag indicating whether the VM is currently making use of CPU hardware
15895	virtualization extensions.
15896	</desc>
15897	</attribute>
15898
15899	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15900	<desc>
15901	Flag indicating whether the VM is currently making use of the nested paging
15902	CPU hardware virtualization extension.
15903	</desc>
15904	</attribute>
15905
15906	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15907	<desc>
15908	Flag indicating whether the VM is currently making use of the VPID
15909	VT-x extension.
15910	</desc>
15911	</attribute>
15912
15913	<attribute name="HWVirtExUXEnabled" type="boolean" readonly="yes">
15914	<desc>
15915	Flag indicating whether the VM is currently making use of the
15916	unrestricted execution feature of VT-x.
15917	</desc>
15918	</attribute>
15919
15920	<attribute name="OSName" type="wstring" readonly="yes">
15921	<desc>
15922	Query the guest OS kernel name as detected by the DBGF.
15923
15924	This feature is not implemented in the 4.0.0 release but may show up
15925	in a dot release.
15926	</desc>
15927	</attribute>
15928
15929	<attribute name="OSVersion" type="wstring" readonly="yes">
15930	<desc>
15931	Query the guest OS kernel version string as detected by the DBGF.
15932
15933	This feature is not implemented in the 4.0.0 release but may show up
15934	in a dot release.
15935	</desc>
15936	</attribute>
15937
15938	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15939	<desc>
15940	Flag indicating whether the VM is currently making use of the Physical
15941	Address Extension CPU feature.
15942	</desc>
15943	</attribute>
15944
15945	<attribute name="virtualTimeRate" type="unsigned long">
15946	<desc>
15947	The rate at which the virtual time runs expressed as a percentage.
15948	The accepted range is 2% to 20000%.
15949	</desc>
15950	</attribute>
15951
15952	<attribute name="VM" type="long long" readonly="yes" wsmap="suppress">
15953	<desc>
15954	Gets the user-mode VM handle, with a reference. Must be passed to
15955	VMR3ReleaseUVM when done. This is only for internal use while we carve
15956	the details of this interface.
15957	</desc>
15958	</attribute>
15959
15960	</interface>
15961
15962	<!--
15963	// IUSBController
15964	/////////////////////////////////////////////////////////////////////////
15965	-->
15966
15967	<interface
15968	name="IUSBController" extends="$unknown"
15969	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15970	wsmap="managed"
15971	>
15972	<attribute name="enabled" type="boolean">
15973	<desc>
15974	Flag whether the USB controller is present in the
15975	guest system. If disabled, the virtual guest hardware will
15976	not contain any USB controller. Can only be changed when
15977	the VM is powered off.
15978	</desc>
15979	</attribute>
15980
15981	<attribute name="enabledEHCI" type="boolean">
15982	<desc>
15983	Flag whether the USB EHCI controller is present in the
15984	guest system. If disabled, the virtual guest hardware will
15985	not contain a USB EHCI controller. Can only be changed when
15986	the VM is powered off.
15987	</desc>
15988	</attribute>
15989
15990	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15991	<desc>
15992	Flag whether there is an USB proxy available.
15993	</desc>
15994	</attribute>
15995
15996	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15997	<desc>
15998	USB standard version which the controller implements.
15999	This is a BCD which means that the major version is in the
16000	high byte and minor version is in the low byte.
16001	</desc>
16002	</attribute>
16003
16004	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
16005	<desc>
16006	List of USB device filters associated with the machine.
16007
16008	If the machine is currently running, these filters are activated
16009	every time a new (supported) USB device is attached to the host
16010	computer that was not ignored by global filters
16011	(<link to="IHost::USBDeviceFilters"/>).
16012
16013	These filters are also activated when the machine is powered up.
16014	They are run against a list of all currently available USB
16015	devices (in states
16016	<link to="USBDeviceState_Available"/>,
16017	<link to="USBDeviceState_Busy"/>,
16018	<link to="USBDeviceState_Held"/>) that were not previously
16019	ignored by global filters.
16020
16021	If at least one filter matches the USB device in question, this
16022	device is automatically captured (attached to) the virtual USB
16023	controller of this machine.
16024
16025	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
16026	</desc>
16027	</attribute>
16028
16029	<method name="createDeviceFilter">
16030	<desc>
16031	Creates a new USB device filter. All attributes except
16032	the filter name are set to empty (any match),
16033	<i>active</i> is @c false (the filter is not active).
16034
16035	The created filter can then be added to the list of filters using
16036	<link to="#insertDeviceFilter"/>.
16037
16038	<result name="VBOX_E_INVALID_VM_STATE">
16039	The virtual machine is not mutable.
16040	</result>
16041
16042	<see><link to="#deviceFilters"/></see>
16043	</desc>
16044	<param name="name" type="wstring" dir="in">
16045	<desc>
16046	Filter name. See <link to="IUSBDeviceFilter::name"/>
16047	for more info.
16048	</desc>
16049	</param>
16050	<param name="filter" type="IUSBDeviceFilter" dir="return">
16051	<desc>Created filter object.</desc>
16052	</param>
16053	</method>
16054
16055	<method name="insertDeviceFilter">
16056	<desc>
16057	Inserts the given USB device to the specified position
16058	in the list of filters.
16059
16060	Positions are numbered starting from <tt>0</tt>. If the specified
16061	position is equal to or greater than the number of elements in
16062	the list, the filter is added to the end of the collection.
16063
16064	<note>
16065	Duplicates are not allowed, so an attempt to insert a
16066	filter that is already in the collection, will return an
16067	error.
16068	</note>
16069
16070	<result name="VBOX_E_INVALID_VM_STATE">
16071	Virtual machine is not mutable.
16072	</result>
16073	<result name="E_INVALIDARG">
16074	USB device filter not created within this VirtualBox instance.
16075	</result>
16076	<result name="VBOX_E_INVALID_OBJECT_STATE">
16077	USB device filter already in list.
16078	</result>
16079
16080	<see><link to="#deviceFilters"/></see>
16081	</desc>
16082	<param name="position" type="unsigned long" dir="in">
16083	<desc>Position to insert the filter to.</desc>
16084	</param>
16085	<param name="filter" type="IUSBDeviceFilter" dir="in">
16086	<desc>USB device filter to insert.</desc>
16087	</param>
16088	</method>
16089
16090	<method name="removeDeviceFilter">
16091	<desc>
16092	Removes a USB device filter from the specified position in the
16093	list of filters.
16094
16095	Positions are numbered starting from <tt>0</tt>. Specifying a
16096	position equal to or greater than the number of elements in
16097	the list will produce an error.
16098
16099	<see><link to="#deviceFilters"/></see>
16100
16101	<result name="VBOX_E_INVALID_VM_STATE">
16102	Virtual machine is not mutable.
16103	</result>
16104	<result name="E_INVALIDARG">
16105	USB device filter list empty or invalid @a position.
16106	</result>
16107
16108	</desc>
16109	<param name="position" type="unsigned long" dir="in">
16110	<desc>Position to remove the filter from.</desc>
16111	</param>
16112	<param name="filter" type="IUSBDeviceFilter" dir="return">
16113	<desc>Removed USB device filter.</desc>
16114	</param>
16115	</method>
16116
16117	</interface>
16118
16119
16120	<!--
16121	// IUSBDevice
16122	/////////////////////////////////////////////////////////////////////////
16123	-->
16124
16125	<interface
16126	name="IUSBDevice" extends="$unknown"
16127	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
16128	wsmap="managed"
16129	>
16130	<desc>
16131	The IUSBDevice interface represents a virtual USB device attached to the
16132	virtual machine.
16133
16134	A collection of objects implementing this interface is stored in the
16135	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
16136	attached to a running virtual machine's USB controller.
16137	</desc>
16138
16139	<attribute name="id" type="uuid" mod="string" readonly="yes">
16140	<desc>
16141	Unique USB device ID. This ID is built from #vendorId,
16142	#productId, #revision and #serialNumber.
16143	</desc>
16144	</attribute>
16145
16146	<attribute name="vendorId" type="unsigned short" readonly="yes">
16147	<desc>Vendor ID.</desc>
16148	</attribute>
16149
16150	<attribute name="productId" type="unsigned short" readonly="yes">
16151	<desc>Product ID.</desc>
16152	</attribute>
16153
16154	<attribute name="revision" type="unsigned short" readonly="yes">
16155	<desc>
16156	Product revision number. This is a packed BCD represented as
16157	unsigned short. The high byte is the integer part and the low
16158	byte is the decimal.
16159	</desc>
16160	</attribute>
16161
16162	<attribute name="manufacturer" type="wstring" readonly="yes">
16163	<desc>Manufacturer string.</desc>
16164	</attribute>
16165
16166	<attribute name="product" type="wstring" readonly="yes">
16167	<desc>Product string.</desc>
16168	</attribute>
16169
16170	<attribute name="serialNumber" type="wstring" readonly="yes">
16171	<desc>Serial number string.</desc>
16172	</attribute>
16173
16174	<attribute name="address" type="wstring" readonly="yes">
16175	<desc>Host specific address of the device.</desc>
16176	</attribute>
16177
16178	<attribute name="port" type="unsigned short" readonly="yes">
16179	<desc>
16180	Host USB port number the device is physically
16181	connected to.
16182	</desc>
16183	</attribute>
16184
16185	<attribute name="version" type="unsigned short" readonly="yes">
16186	<desc>
16187	The major USB version of the device - 1 or 2.
16188	</desc>
16189	</attribute>
16190
16191	<attribute name="portVersion" type="unsigned short" readonly="yes">
16192	<desc>
16193	The major USB version of the host USB port the device is
16194	physically connected to - 1 or 2. For devices not connected to
16195	anything this will have the same value as the version attribute.
16196	</desc>
16197	</attribute>
16198
16199	<attribute name="remote" type="boolean" readonly="yes">
16200	<desc>
16201	Whether the device is physically connected to a remote VRDE
16202	client or to a local host machine.
16203	</desc>
16204	</attribute>
16205
16206	</interface>
16207
16208
16209	<!--
16210	// IUSBDeviceFilter
16211	/////////////////////////////////////////////////////////////////////////
16212	-->
16213
16214	<interface
16215	name="IUSBDeviceFilter" extends="$unknown"
16216	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
16217	wsmap="managed"
16218	>
16219	<desc>
16220	The IUSBDeviceFilter interface represents an USB device filter used
16221	to perform actions on a group of USB devices.
16222
16223	This type of filters is used by running virtual machines to
16224	automatically capture selected USB devices once they are physically
16225	attached to the host computer.
16226
16227	A USB device is matched to the given device filter if and only if all
16228	attributes of the device match the corresponding attributes of the
16229	filter (that is, attributes are joined together using the logical AND
16230	operation). On the other hand, all together, filters in the list of
16231	filters carry the semantics of the logical OR operation. So if it is
16232	desirable to create a match like "this vendor id OR this product id",
16233	one needs to create two filters and specify "any match" (see below)
16234	for unused attributes.
16235
16236	All filter attributes used for matching are strings. Each string
16237	is an expression representing a set of values of the corresponding
16238	device attribute, that will match the given filter. Currently, the
16239	following filtering expressions are supported:
16240
16241	<ul>
16242	<li><i>Interval filters</i>. Used to specify valid intervals for
16243	integer device attributes (Vendor ID, Product ID and Revision).
16244	The format of the string is:
16245
16246	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
16247
16248	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
16249	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
16250	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
16251	is omitted before a dash (<tt>-</tt>), the minimum possible integer
16252	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
16253	possible integer is assumed.
16254	</li>
16255	<li><i>Boolean filters</i>. Used to specify acceptable values for
16256	boolean device attributes. The format of the string is:
16257
16258	<tt>true\|false\|yes\|no\|0\|1</tt>
16259
16260	</li>
16261	<li><i>Exact match</i>. Used to specify a single value for the given
16262	device attribute. Any string that doesn't start with <tt>int:</tt>
16263	represents the exact match. String device attributes are compared to
16264	this string including case of symbols. Integer attributes are first
16265	converted to a string (see individual filter attributes) and then
16266	compared ignoring case.
16267
16268	</li>
16269	<li><i>Any match</i>. Any value of the corresponding device attribute
16270	will match the given filter. An empty or @c null string is
16271	used to construct this type of filtering expressions.
16272
16273	</li>
16274	</ul>
16275
16276	<note>
16277	On the Windows host platform, interval filters are not currently
16278	available. Also all string filter attributes
16279	(<link to="#manufacturer"/>, <link to="#product"/>,
16280	<link to="#serialNumber"/>) are ignored, so they behave as
16281	<i>any match</i> no matter what string expression is specified.
16282	</note>
16283
16284	<see><link to="IUSBController::deviceFilters"/>,
16285	<link to="IHostUSBDeviceFilter"/></see>
16286	</desc>
16287
16288	<attribute name="name" type="wstring">
16289	<desc>
16290	Visible name for this filter.
16291	This name is used to visually distinguish one filter from another,
16292	so it can neither be @c null nor an empty string.
16293	</desc>
16294	</attribute>
16295
16296	<attribute name="active" type="boolean">
16297	<desc>Whether this filter active or has been temporarily disabled.</desc>
16298	</attribute>
16299
16300	<attribute name="vendorId" type="wstring">
16301	<desc>
16302	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
16303	The string representation for the <i>exact matching</i>
16304	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16305	(including leading zeroes).
16306	</desc>
16307	</attribute>
16308
16309	<attribute name="productId" type="wstring">
16310	<desc>
16311	<link to="IUSBDevice::productId">Product ID</link> filter.
16312	The string representation for the <i>exact matching</i>
16313	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16314	(including leading zeroes).
16315	</desc>
16316	</attribute>
16317
16318	<attribute name="revision" type="wstring">
16319	<desc>
16320	<link to="IUSBDevice::productId">Product revision number</link>
16321	filter. The string representation for the <i>exact matching</i>
16322	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
16323	of the integer part of the revision, and <tt>F</tt> is the
16324	decimal digit of its fractional part (including leading and
16325	trailing zeros).
16326	Note that for interval filters, it's best to use the hexadecimal
16327	form, because the revision is stored as a 16 bit packed BCD value;
16328	so the expression <tt>int:0x0100-0x0199</tt> will match any
16329	revision from <tt>1.0</tt> to <tt>1.99</tt>.
16330	</desc>
16331	</attribute>
16332
16333	<attribute name="manufacturer" type="wstring">
16334	<desc>
16335	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
16336	</desc>
16337	</attribute>
16338
16339	<attribute name="product" type="wstring">
16340	<desc>
16341	<link to="IUSBDevice::product">Product</link> filter.
16342	</desc>
16343	</attribute>
16344
16345	<attribute name="serialNumber" type="wstring">
16346	<desc>
16347	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
16348	</desc>
16349	</attribute>
16350
16351	<attribute name="port" type="wstring">
16352	<desc>
16353	<link to="IUSBDevice::port">Host USB port</link> filter.
16354	</desc>
16355	</attribute>
16356
16357	<attribute name="remote" type="wstring">
16358	<desc>
16359	<link to="IUSBDevice::remote">Remote state</link> filter.
16360	<note>
16361	This filter makes sense only for machine USB filters,
16362	i.e. it is ignored by IHostUSBDeviceFilter objects.
16363	</note>
16364	</desc>
16365	</attribute>
16366
16367	<attribute name="maskedInterfaces" type="unsigned long">
16368	<desc>
16369	This is an advanced option for hiding one or more USB interfaces
16370	from the guest. The value is a bit mask where the bits that are set
16371	means the corresponding USB interface should be hidden, masked off
16372	if you like.
16373	This feature only works on Linux hosts.
16374	</desc>
16375	</attribute>
16376
16377	</interface>
16378
16379
16380	<!--
16381	// IHostUSBDevice
16382	/////////////////////////////////////////////////////////////////////////
16383	-->
16384
16385	<enum
16386	name="USBDeviceState"
16387	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
16388	>
16389	<desc>
16390	USB device state. This enumeration represents all possible states
16391	of the USB device physically attached to the host computer regarding
16392	its state on the host computer and availability to guest computers
16393	(all currently running virtual machines).
16394
16395	Once a supported USB device is attached to the host, global USB
16396	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
16397	either ignore the device, or put it to USBDeviceState_Held state, or do
16398	nothing. Unless the device is ignored by global filters, filters of all
16399	currently running guests (<link to="IUSBController::deviceFilters"/>) are
16400	activated that can put it to USBDeviceState_Captured state.
16401
16402	If the device was ignored by global filters, or didn't match
16403	any filters at all (including guest ones), it is handled by the host
16404	in a normal way. In this case, the device state is determined by
16405	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
16406	or USBDeviceState_Available, depending on the current device usage.
16407
16408	Besides auto-capturing based on filters, the device can be manually
16409	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
16410	state is USBDeviceState_Busy, USBDeviceState_Available or
16411	USBDeviceState_Held.
16412
16413	<note>
16414	Due to differences in USB stack implementations in Linux and Win32,
16415	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
16416	only to the Linux version of the product. This also means that (<link
16417	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
16418	device state is USBDeviceState_Held.
16419	</note>
16420
16421	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
16422	</desc>
16423
16424	<const name="NotSupported" value="0">
16425	<desc>
16426	Not supported by the VirtualBox server, not available to guests.
16427	</desc>
16428	</const>
16429	<const name="Unavailable" value="1">
16430	<desc>
16431	Being used by the host computer exclusively,
16432	not available to guests.
16433	</desc>
16434	</const>
16435	<const name="Busy" value="2">
16436	<desc>
16437	Being used by the host computer, potentially available to guests.
16438	</desc>
16439	</const>
16440	<const name="Available" value="3">
16441	<desc>
16442	Not used by the host computer, available to guests (the host computer
16443	can also start using the device at any time).
16444	</desc>
16445	</const>
16446	<const name="Held" value="4">
16447	<desc>
16448	Held by the VirtualBox server (ignored by the host computer),
16449	available to guests.
16450	</desc>
16451	</const>
16452	<const name="Captured" value="5">
16453	<desc>
16454	Captured by one of the guest computers, not available
16455	to anybody else.
16456	</desc>
16457	</const>
16458	</enum>
16459
16460	<interface
16461	name="IHostUSBDevice" extends="IUSBDevice"
16462	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
16463	wsmap="managed"
16464	>
16465	<desc>
16466	The IHostUSBDevice interface represents a physical USB device attached
16467	to the host computer.
16468
16469	Besides properties inherited from IUSBDevice, this interface adds the
16470	<link to="#state"/> property that holds the current state of the USB
16471	device.
16472
16473	<see><link to="IHost::USBDevices"/>,
16474	<link to="IHost::USBDeviceFilters"/></see>
16475	</desc>
16476
16477	<attribute name="state" type="USBDeviceState" readonly="yes">
16478	<desc>
16479	Current state of the device.
16480	</desc>
16481	</attribute>
16482
16483	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
16484
16485	</interface>
16486
16487
16488	<!--
16489	// IHostUSBDeviceFilter
16490	/////////////////////////////////////////////////////////////////////////
16491	-->
16492
16493	<enum
16494	name="USBDeviceFilterAction"
16495	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
16496	>
16497	<desc>
16498	Actions for host USB device filters.
16499	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
16500	</desc>
16501
16502	<const name="Null" value="0">
16503	<desc>Null value (never used by the API).</desc>
16504	</const>
16505	<const name="Ignore" value="1">
16506	<desc>Ignore the matched USB device.</desc>
16507	</const>
16508	<const name="Hold" value="2">
16509	<desc>Hold the matched USB device.</desc>
16510	</const>
16511	</enum>
16512
16513	<interface
16514	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
16515	uuid="4cc70246-d74a-400f-8222-3900489c0374"
16516	wsmap="managed"
16517	>
16518	<desc>
16519	The IHostUSBDeviceFilter interface represents a global filter for a
16520	physical USB device used by the host computer. Used indirectly in
16521	<link to="IHost::USBDeviceFilters"/>.
16522
16523	Using filters of this type, the host computer determines the initial
16524	state of the USB device after it is physically attached to the
16525	host's USB controller.
16526
16527	<note>
16528	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16529	filters, because it makes sense only for
16530	<link to="IUSBController::deviceFilters">machine USB filters</link>.
16531	</note>
16532
16533	<see><link to="IHost::USBDeviceFilters"/></see>
16534	</desc>
16535
16536	<attribute name="action" type="USBDeviceFilterAction">
16537	<desc>
16538	Action performed by the host when an attached USB device
16539	matches this filter.
16540	</desc>
16541	</attribute>
16542
16543	</interface>
16544
16545	<!--
16546	// IAudioAdapter
16547	/////////////////////////////////////////////////////////////////////////
16548	-->
16549
16550	<enum
16551	name="AudioDriverType"
16552	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16553	>
16554	<desc>
16555	Host audio driver type.
16556	</desc>
16557
16558	<const name="Null" value="0">
16559	<desc>Null value, also means "dummy audio driver".</desc>
16560	</const>
16561	<const name="WinMM" value="1">
16562	<desc>Windows multimedia (Windows hosts only).</desc>
16563	</const>
16564	<const name="OSS" value="2">
16565	<desc>Open Sound System (Linux hosts only).</desc>
16566	</const>
16567	<const name="ALSA" value="3">
16568	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16569	</const>
16570	<const name="DirectSound" value="4">
16571	<desc>DirectSound (Windows hosts only).</desc>
16572	</const>
16573	<const name="CoreAudio" value="5">
16574	<desc>CoreAudio (Mac hosts only).</desc>
16575	</const>
16576	<const name="MMPM" value="6">
16577	<desc>Reserved for historical reasons.</desc>
16578	</const>
16579	<const name="Pulse" value="7">
16580	<desc>PulseAudio (Linux hosts only).</desc>
16581	</const>
16582	<const name="SolAudio" value="8">
16583	<desc>Solaris audio (Solaris hosts only).</desc>
16584	</const>
16585	</enum>
16586
16587	<enum
16588	name="AudioControllerType"
16589	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16590	>
16591	<desc>
16592	Virtual audio controller type.
16593	</desc>
16594
16595	<const name="AC97" value="0"/>
16596	<const name="SB16" value="1"/>
16597	<const name="HDA" value="2"/>
16598	</enum>
16599
16600	<interface
16601	name="IAudioAdapter" extends="$unknown"
16602	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16603	wsmap="managed"
16604	>
16605	<desc>
16606	The IAudioAdapter interface represents the virtual audio adapter of
16607	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16608	</desc>
16609	<attribute name="enabled" type="boolean">
16610	<desc>
16611	Flag whether the audio adapter is present in the
16612	guest system. If disabled, the virtual guest hardware will
16613	not contain any audio adapter. Can only be changed when
16614	the VM is not running.
16615	</desc>
16616	</attribute>
16617	<attribute name="audioController" type="AudioControllerType">
16618	<desc>
16619	The audio hardware we emulate.
16620	</desc>
16621	</attribute>
16622	<attribute name="audioDriver" type="AudioDriverType">
16623	<desc>
16624	Audio driver the adapter is connected to. This setting
16625	can only be changed when the VM is not running.
16626	</desc>
16627	</attribute>
16628	</interface>
16629
16630	<enum
16631	name="AuthType"
16632	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16633	>
16634	<desc>
16635	VirtualBox authentication type.
16636	</desc>
16637
16638	<const name="Null" value="0">
16639	<desc>Null value, also means "no authentication".</desc>
16640	</const>
16641	<const name="External" value="1"/>
16642	<const name="Guest" value="2"/>
16643	</enum>
16644
16645	<!--
16646	// IVRDEServer
16647	/////////////////////////////////////////////////////////////////////////
16648	-->
16649
16650	<interface
16651	name="IVRDEServer" extends="$unknown"
16652	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16653	wsmap="managed"
16654	>
16655
16656	<attribute name="enabled" type="boolean">
16657	<desc>Flag if VRDE server is enabled.</desc>
16658	</attribute>
16659
16660	<attribute name="authType" type="AuthType">
16661	<desc>VRDE authentication method.</desc>
16662	</attribute>
16663
16664	<attribute name="authTimeout" type="unsigned long">
16665	<desc>Timeout for guest authentication. Milliseconds.</desc>
16666	</attribute>
16667
16668	<attribute name="allowMultiConnection" type="boolean">
16669	<desc>
16670	Flag whether multiple simultaneous connections to the VM are permitted.
16671	Note that this will be replaced by a more powerful mechanism in the future.
16672	</desc>
16673	</attribute>
16674
16675	<attribute name="reuseSingleConnection" type="boolean">
16676	<desc>
16677	Flag whether the existing connection must be dropped and a new connection
16678	must be established by the VRDE server, when a new client connects in single
16679	connection mode.
16680	</desc>
16681	</attribute>
16682
16683	<attribute name="VRDEExtPack" type="wstring">
16684	<desc>
16685	The name of Extension Pack providing VRDE for this VM. Overrides
16686	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16687	</desc>
16688	</attribute>
16689
16690	<attribute name="authLibrary" type="wstring">
16691	<desc>
16692	Library used for authentication of RDP clients by this VM. Overrides
16693	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16694	</desc>
16695	</attribute>
16696
16697	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16698	<desc>
16699	Array of names of properties, which are supported by this VRDE server.
16700	</desc>
16701	</attribute>
16702
16703	<method name="setVRDEProperty">
16704	<desc>
16705	Sets a VRDE specific property string.
16706
16707	If you pass @c null or empty string as a key @a value, the given @a key
16708	will be deleted.
16709
16710	</desc>
16711	<param name="key" type="wstring" dir="in">
16712	<desc>Name of the key to set.</desc>
16713	</param>
16714	<param name="value" type="wstring" dir="in">
16715	<desc>Value to assign to the key.</desc>
16716	</param>
16717	</method>
16718
16719	<method name="getVRDEProperty" const="yes">
16720	<desc>
16721	Returns a VRDE specific property string.
16722
16723	If the requested data @a key does not exist, this function will
16724	succeed and return an empty string in the @a value argument.
16725
16726	</desc>
16727	<param name="key" type="wstring" dir="in">
16728	<desc>Name of the key to get.</desc>
16729	</param>
16730	<param name="value" type="wstring" dir="return">
16731	<desc>Value of the requested key.</desc>
16732	</param>
16733	</method>
16734
16735	</interface>
16736
16737
16738	<!--
16739	// ISharedFolder
16740	/////////////////////////////////////////////////////////////////////////
16741	-->
16742
16743	<interface
16744	name="ISharedFolder" extends="$unknown"
16745	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16746	wsmap="struct"
16747	>
16748	<desc>
16749	The ISharedFolder interface represents a folder in the host computer's
16750	file system accessible from the guest OS running inside a virtual
16751	machine using an associated logical name.
16752
16753	There are three types of shared folders:
16754	<ul>
16755	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16756	folders available to all virtual machines.</li>
16757	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16758	VM-specific shared folders available to the given virtual machine at
16759	startup.</li>
16760	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16761	VM-specific shared folders created in the session context (for
16762	example, when the virtual machine is running) and automatically
16763	discarded when the session is closed (the VM is powered off).</li>
16764	</ul>
16765
16766	Logical names of shared folders must be unique within the given scope
16767	(global, permanent or transient). However, they do not need to be unique
16768	across scopes. In this case, the definition of the shared folder in a
16769	more specific scope takes precedence over definitions in all other
16770	scopes. The order of precedence is (more specific to more general):
16771	<ol>
16772	<li>Transient definitions</li>
16773	<li>Permanent definitions</li>
16774	<li>Global definitions</li>
16775	</ol>
16776
16777	For example, if MyMachine has a shared folder named
16778	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16779	transient shared folder named <tt>C_DRIVE</tt> (that points
16780	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16781	of <tt>C_DRIVE</tt> in the guest OS so
16782	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16783	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16784	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16785	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16786	to <tt>C:\\</tt> if it still exists.
16787
16788	Note that permanent and transient shared folders of different machines
16789	are in different name spaces, so they don't overlap and don't need to
16790	have unique logical names.
16791
16792	<note>
16793	Global shared folders are not implemented in the current version of the
16794	product.
16795	</note>
16796	</desc>
16797
16798	<attribute name="name" type="wstring" readonly="yes">
16799	<desc>Logical name of the shared folder.</desc>
16800	</attribute>
16801
16802	<attribute name="hostPath" type="wstring" readonly="yes">
16803	<desc>Full path to the shared folder in the host file system.</desc>
16804	</attribute>
16805
16806	<attribute name="accessible" type="boolean" readonly="yes">
16807	<desc>
16808	Whether the folder defined by the host path is currently
16809	accessible or not.
16810	For example, the folder can be inaccessible if it is placed
16811	on the network share that is not available by the time
16812	this property is read.
16813	</desc>
16814	</attribute>
16815
16816	<attribute name="writable" type="boolean" readonly="yes">
16817	<desc>
16818	Whether the folder defined by the host path is writable or
16819	not.
16820	</desc>
16821	</attribute>
16822
16823	<attribute name="autoMount" type="boolean" readonly="yes">
16824	<desc>
16825	Whether the folder gets automatically mounted by the guest or not.
16826	</desc>
16827	</attribute>
16828
16829	<attribute name="lastAccessError" type="wstring" readonly="yes">
16830	<desc>
16831	Text message that represents the result of the last accessibility
16832	check.
16833
16834	Accessibility checks are performed each time the <link to="#accessible"/>
16835	attribute is read. An empty string is returned if the last
16836	accessibility check was successful. A non-empty string indicates a
16837	failure and should normally describe a reason of the failure (for
16838	example, a file read error).
16839	</desc>
16840	</attribute>
16841
16842	</interface>
16843
16844	<!--
16845	// ISession
16846	/////////////////////////////////////////////////////////////////////////
16847	-->
16848
16849	<enum
16850	name="Reason"
16851	uuid="e7e8e097-299d-4e98-8bbc-c31c2d47d0cc"
16852	>
16853	<desc>
16854	Internal event reason type.
16855	</desc>
16856
16857	<const name="Unspecified" value="0">
16858	<desc>Null value, means "no known reason".</desc>
16859	</const>
16860	<const name="HostSuspend" value="1">
16861	<desc>Host is being suspended (power management event).</desc>
16862	</const>
16863	<const name="HostResume" value="2">
16864	<desc>Host is being resumed (power management event).</desc>
16865	</const>
16866	<const name="HostBatteryLow" value="3">
16867	<desc>Host is running low on battery (power management event).</desc>
16868	</const>
16869	</enum>
16870
16871	<interface
16872	name="IInternalSessionControl" extends="$unknown"
16873	uuid="cddf451c-a006-4c33-8245-63b3c9ae6586"
16874	internal="yes"
16875	wsmap="suppress"
16876	>
16877	<method name="getPID">
16878	<desc>PID of the process that has created this Session object.
16879	</desc>
16880	<param name="pid" type="unsigned long" dir="return"/>
16881	</method>
16882
16883	<method name="getRemoteConsole">
16884	<desc>
16885	Returns the console object suitable for remote control.
16886
16887	<result name="VBOX_E_INVALID_VM_STATE">
16888	Session state prevents operation.
16889	</result>
16890	<result name="VBOX_E_INVALID_OBJECT_STATE">
16891	Session type prevents operation.
16892	</result>
16893
16894	</desc>
16895	<param name="console" type="IConsole" dir="return"/>
16896	</method>
16897
16898	<method name="assignMachine">
16899	<desc>
16900	Assigns the machine object associated with this direct-type
16901	session or informs the session that it will be a remote one
16902	(if @a machine == @c null).
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	<param name="machine" type="IMachine" dir="in"/>
16913	<param name="lockType" type="LockType" dir="in"/>
16914	</method>
16915
16916	<method name="assignRemoteMachine">
16917	<desc>
16918	Assigns the machine and the (remote) console object associated with
16919	this remote-type session.
16920
16921	<result name="VBOX_E_INVALID_VM_STATE">
16922	Session state prevents operation.
16923	</result>
16924
16925	</desc>
16926	<param name="machine" type="IMachine" dir="in"/>
16927	<param name="console" type="IConsole" dir="in"/>
16928	</method>
16929
16930	<method name="updateMachineState">
16931	<desc>
16932	Updates the machine state in the VM process.
16933	Must be called only in certain cases
16934	(see the method implementation).
16935
16936	<result name="VBOX_E_INVALID_VM_STATE">
16937	Session state prevents operation.
16938	</result>
16939	<result name="VBOX_E_INVALID_OBJECT_STATE">
16940	Session type prevents operation.
16941	</result>
16942
16943	</desc>
16944	<param name="machineState" type="MachineState" dir="in"/>
16945	</method>
16946
16947	<method name="uninitialize">
16948	<desc>
16949	Uninitializes (closes) this session. Used by VirtualBox to close
16950	the corresponding remote session when the direct session dies
16951	or gets closed.
16952
16953	<result name="VBOX_E_INVALID_VM_STATE">
16954	Session state prevents operation.
16955	</result>
16956
16957	</desc>
16958	</method>
16959
16960	<method name="onNetworkAdapterChange">
16961	<desc>
16962	Triggered when settings of a network adapter of the
16963	associated virtual machine have changed.
16964
16965	<result name="VBOX_E_INVALID_VM_STATE">
16966	Session state prevents operation.
16967	</result>
16968	<result name="VBOX_E_INVALID_OBJECT_STATE">
16969	Session type prevents operation.
16970	</result>
16971
16972	</desc>
16973	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16974	<param name="changeAdapter" type="boolean" dir="in"/>
16975	</method>
16976
16977	<method name="onSerialPortChange">
16978	<desc>
16979	Triggered when settings of a serial port of the
16980	associated virtual machine have changed.
16981
16982	<result name="VBOX_E_INVALID_VM_STATE">
16983	Session state prevents operation.
16984	</result>
16985	<result name="VBOX_E_INVALID_OBJECT_STATE">
16986	Session type prevents operation.
16987	</result>
16988
16989	</desc>
16990	<param name="serialPort" type="ISerialPort" dir="in"/>
16991	</method>
16992
16993	<method name="onParallelPortChange">
16994	<desc>
16995	Triggered when settings of a parallel port of the
16996	associated virtual machine have changed.
16997
16998	<result name="VBOX_E_INVALID_VM_STATE">
16999	Session state prevents operation.
17000	</result>
17001	<result name="VBOX_E_INVALID_OBJECT_STATE">
17002	Session type prevents operation.
17003	</result>
17004
17005	</desc>
17006	<param name="parallelPort" type="IParallelPort" dir="in"/>
17007	</method>
17008
17009	<method name="onStorageControllerChange">
17010	<desc>
17011	Triggered when settings of a storage controller of the
17012	associated virtual machine have changed.
17013
17014	<result name="VBOX_E_INVALID_VM_STATE">
17015	Session state prevents operation.
17016	</result>
17017	<result name="VBOX_E_INVALID_OBJECT_STATE">
17018	Session type prevents operation.
17019	</result>
17020
17021	</desc>
17022	</method>
17023
17024	<method name="onMediumChange">
17025	<desc>
17026	Triggered when attached media of the
17027	associated virtual machine have changed.
17028
17029	<result name="VBOX_E_INVALID_VM_STATE">
17030	Session state prevents operation.
17031	</result>
17032	<result name="VBOX_E_INVALID_OBJECT_STATE">
17033	Session type prevents operation.
17034	</result>
17035
17036	</desc>
17037
17038	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
17039	<desc>The medium attachment which changed.</desc>
17040	</param>
17041	<param name="force" type="boolean" dir="in">
17042	<desc>If the medium change was forced.</desc>
17043	</param>
17044	</method>
17045
17046	<method name="onStorageDeviceChange">
17047	<desc>
17048	Triggered when attached storage devices of the
17049	associated virtual machine have changed.
17050
17051	<result name="VBOX_E_INVALID_VM_STATE">
17052	Session state prevents operation.
17053	</result>
17054	<result name="VBOX_E_INVALID_OBJECT_STATE">
17055	Session type prevents operation.
17056	</result>
17057
17058	</desc>
17059
17060	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
17061	<desc>The medium attachment which changed.</desc>
17062	</param>
17063	<param name="remove" type="boolean" dir="in">
17064	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
17065	</param>
17066	<param name="silent" type="boolean" dir="in">
17067	<desc>TRUE if the device is is silently reconfigured without
17068	notifying the guest about it.</desc>
17069	</param>
17070	</method>
17071
17072	<method name="onClipboardModeChange">
17073	<desc>
17074	Notification when the shared clipboard mode changes.
17075	</desc>
17076	<param name="clipboardMode" type="ClipboardMode" dir="in">
17077	<desc>The new shared clipboard mode.</desc>
17078	</param>
17079	</method>
17080
17081	<method name="onDragAndDropModeChange">
17082	<desc>
17083	Notification when the drag'n'drop mode changes.
17084	</desc>
17085	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
17086	<desc>The new mode for drag'n'drop.</desc>
17087	</param>
17088	</method>
17089
17090	<method name="onCPUChange">
17091	<desc>
17092	Notification when a CPU changes.
17093	</desc>
17094	<param name="cpu" type="unsigned long" dir="in">
17095	<desc>The CPU which changed</desc>
17096	</param>
17097	<param name="add" type="boolean" dir="in">
17098	<desc>Flag whether the CPU was added or removed</desc>
17099	</param>
17100	</method>
17101
17102	<method name="onCPUExecutionCapChange">
17103	<desc>
17104	Notification when the CPU execution cap changes.
17105	</desc>
17106	<param name="executionCap" type="unsigned long" dir="in">
17107	<desc>The new CPU execution cap value. (1-100)</desc>
17108	</param>
17109	</method>
17110
17111	<method name="onVRDEServerChange">
17112	<desc>
17113	Triggered when settings of the VRDE server object of the
17114	associated virtual machine have changed.
17115
17116	<result name="VBOX_E_INVALID_VM_STATE">
17117	Session state prevents operation.
17118	</result>
17119	<result name="VBOX_E_INVALID_OBJECT_STATE">
17120	Session type prevents operation.
17121	</result>
17122
17123	</desc>
17124	<param name="restart" type="boolean" dir="in">
17125	<desc>Flag whether the server must be restarted</desc>
17126	</param>
17127	</method>
17128
17129	<method name="onVideoCaptureChange">
17130	<desc>
17131	Triggered when video capture settings have changed.
17132	</desc>
17133	</method>
17134
17135	<method name="onUSBControllerChange">
17136	<desc>
17137	Triggered when settings of the USB controller object of the
17138	associated virtual machine have changed.
17139
17140	<result name="VBOX_E_INVALID_VM_STATE">
17141	Session state prevents operation.
17142	</result>
17143	<result name="VBOX_E_INVALID_OBJECT_STATE">
17144	Session type prevents operation.
17145	</result>
17146
17147	</desc>
17148	</method>
17149
17150	<method name="onSharedFolderChange">
17151	<desc>
17152	Triggered when a permanent (global or machine) shared folder has been
17153	created or removed.
17154	<note>
17155	We don't pass shared folder parameters in this notification because
17156	the order in which parallel notifications are delivered is not defined,
17157	therefore it could happen that these parameters were outdated by the
17158	time of processing this notification.
17159	</note>
17160
17161	<result name="VBOX_E_INVALID_VM_STATE">
17162	Session state prevents operation.
17163	</result>
17164	<result name="VBOX_E_INVALID_OBJECT_STATE">
17165	Session type prevents operation.
17166	</result>
17167
17168	</desc>
17169	<param name="global" type="boolean" dir="in"/>
17170	</method>
17171
17172	<method name="onUSBDeviceAttach">
17173	<desc>
17174	Triggered when a request to capture a USB device (as a result
17175	of matched USB filters or direct call to
17176	<link to="IConsole::attachUSBDevice"/>) has completed.
17177	A @c null @a error object means success, otherwise it
17178	describes a failure.
17179
17180	<result name="VBOX_E_INVALID_VM_STATE">
17181	Session state prevents operation.
17182	</result>
17183	<result name="VBOX_E_INVALID_OBJECT_STATE">
17184	Session type prevents operation.
17185	</result>
17186
17187	</desc>
17188	<param name="device" type="IUSBDevice" dir="in"/>
17189	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17190	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
17191	</method>
17192
17193	<method name="onUSBDeviceDetach">
17194	<desc>
17195	Triggered when a request to release the USB device (as a result
17196	of machine termination or direct call to
17197	<link to="IConsole::detachUSBDevice"/>) has completed.
17198	A @c null @a error object means success, otherwise it
17199	describes a failure.
17200
17201	<result name="VBOX_E_INVALID_VM_STATE">
17202	Session state prevents operation.
17203	</result>
17204	<result name="VBOX_E_INVALID_OBJECT_STATE">
17205	Session type prevents operation.
17206	</result>
17207
17208	</desc>
17209	<param name="id" type="uuid" mod="string" dir="in"/>
17210	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17211	</method>
17212
17213	<method name="onShowWindow">
17214	<desc>
17215	Called by <link to="IMachine::canShowConsoleWindow"/> and by
17216	<link to="IMachine::showConsoleWindow"/> in order to notify
17217	console listeners
17218	<link to="ICanShowWindowEvent"/>
17219	and <link to="IShowWindowEvent"/>.
17220
17221	<result name="VBOX_E_INVALID_OBJECT_STATE">
17222	Session type prevents operation.
17223	</result>
17224
17225	</desc>
17226	<param name="check" type="boolean" dir="in"/>
17227	<param name="canShow" type="boolean" dir="out"/>
17228	<param name="winId" type="long long" dir="out"/>
17229	</method>
17230
17231	<method name="onBandwidthGroupChange">
17232	<desc>
17233	Notification when one of the bandwidth groups change.
17234	</desc>
17235	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
17236	<desc>The bandwidth group which changed.</desc>
17237	</param>
17238	</method>
17239
17240	<method name="accessGuestProperty">
17241	<desc>
17242	Called by <link to="IMachine::getGuestProperty"/> and by
17243	<link to="IMachine::setGuestProperty"/> in order to read and
17244	modify guest properties.
17245
17246	<result name="VBOX_E_INVALID_VM_STATE">
17247	Machine session is not open.
17248	</result>
17249	<result name="VBOX_E_INVALID_OBJECT_STATE">
17250	Session type is not direct.
17251	</result>
17252
17253	</desc>
17254	<param name="name" type="wstring" dir="in"/>
17255	<param name="value" type="wstring" dir="in"/>
17256	<param name="flags" type="wstring" dir="in"/>
17257	<param name="isSetter" type="boolean" dir="in"/>
17258	<param name="retValue" type="wstring" dir="out"/>
17259	<param name="retTimestamp" type="long long" dir="out"/>
17260	<param name="retFlags" type="wstring" dir="out"/>
17261	</method>
17262
17263	<method name="enumerateGuestProperties" const="yes">
17264	<desc>
17265	Return a list of the guest properties matching a set of patterns along
17266	with their values, time stamps and flags.
17267
17268	<result name="VBOX_E_INVALID_VM_STATE">
17269	Machine session is not open.
17270	</result>
17271	<result name="VBOX_E_INVALID_OBJECT_STATE">
17272	Session type is not direct.
17273	</result>
17274
17275	</desc>
17276	<param name="patterns" type="wstring" dir="in">
17277	<desc>
17278	The patterns to match the properties against as a comma-separated
17279	string. If this is empty, all properties currently set will be
17280	returned.
17281	</desc>
17282	</param>
17283	<param name="keys" type="wstring" dir="out" safearray="yes">
17284	<desc>
17285	The key names of the properties returned.
17286	</desc>
17287	</param>
17288	<param name="values" type="wstring" dir="out" safearray="yes">
17289	<desc>
17290	The values of the properties returned. The array entries match the
17291	corresponding entries in the @a key array.
17292	</desc>
17293	</param>
17294	<param name="timestamps" type="long long" dir="out" safearray="yes">
17295	<desc>
17296	The time stamps of the properties returned. The array entries match
17297	the corresponding entries in the @a key array.
17298	</desc>
17299	</param>
17300	<param name="flags" type="wstring" dir="out" safearray="yes">
17301	<desc>
17302	The flags of the properties returned. The array entries match the
17303	corresponding entries in the @a key array.
17304	</desc>
17305	</param>
17306	</method>
17307
17308	<method name="onlineMergeMedium">
17309	<desc>
17310	Triggers online merging of a hard disk. Used internally when deleting
17311	a snapshot while a VM referring to the same hard disk chain is running.
17312
17313	<result name="VBOX_E_INVALID_VM_STATE">
17314	Machine session is not open.
17315	</result>
17316	<result name="VBOX_E_INVALID_OBJECT_STATE">
17317	Session type is not direct.
17318	</result>
17319
17320	</desc>
17321	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
17322	<desc>The medium attachment to identify the medium chain.</desc>
17323	</param>
17324	<param name="sourceIdx" type="unsigned long" dir="in">
17325	<desc>The index of the source image in the chain.
17326	Redundant, but drastically reduces IPC.</desc>
17327	</param>
17328	<param name="targetIdx" type="unsigned long" dir="in">
17329	<desc>The index of the target image in the chain.
17330	Redundant, but drastically reduces IPC.</desc>
17331	</param>
17332	<param name="source" type="IMedium" dir="in">
17333	<desc>Merge source medium.</desc>
17334	</param>
17335	<param name="target" type="IMedium" dir="in">
17336	<desc>Merge target medium.</desc>
17337	</param>
17338	<param name="mergeForward" type="boolean" dir="in">
17339	<desc>Merge direction.</desc>
17340	</param>
17341	<param name="parentForTarget" type="IMedium" dir="in">
17342	<desc>For forward merges: new parent for target medium.</desc>
17343	</param>
17344	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
17345	<desc>For backward merges: list of media which need their parent UUID
17346	updated.</desc>
17347	</param>
17348	<param name="progress" type="IProgress" dir="in">
17349	<desc>
17350	Progress object for this operation.
17351	</desc>
17352	</param>
17353	</method>
17354
17355	<method name="enableVMMStatistics">
17356	<desc>
17357	Enables or disables collection of VMM RAM statistics.
17358
17359	<result name="VBOX_E_INVALID_VM_STATE">
17360	Machine session is not open.
17361	</result>
17362	<result name="VBOX_E_INVALID_OBJECT_STATE">
17363	Session type is not direct.
17364	</result>
17365
17366	</desc>
17367	<param name="enable" type="boolean" dir="in">
17368	<desc>True enables statistics collection.</desc>
17369	</param>
17370	</method>
17371
17372	<method name="pauseWithReason">
17373	<desc>
17374	Internal method for triggering a VM pause with a specified reason code.
17375	The reason code can be interpreted by device/drivers and thus it might
17376	behave slightly differently than a normal VM pause.
17377
17378	<result name="VBOX_E_INVALID_VM_STATE">
17379	Virtual machine not in Running state.
17380	</result>
17381	<result name="VBOX_E_VM_ERROR">
17382	Virtual machine error in suspend operation.
17383	</result>
17384	<see><link to="Console::pause"/></see>
17385	</desc>
17386
17387	<param name="reason" type="Reason" dir="in">
17388	<desc>Specify the best matching reason code please.</desc>
17389	</param>
17390	</method>
17391
17392	<method name="resumeWithReason">
17393	<desc>
17394	Internal method for triggering a VM resume with a specified reason code.
17395	The reason code can be interpreted by device/drivers and thus it might
17396	behave slightly differently than a normal VM resume.
17397
17398	<result name="VBOX_E_INVALID_VM_STATE">
17399	Virtual machine not in Paused state.
17400	</result>
17401	<result name="VBOX_E_VM_ERROR">
17402	Virtual machine error in resume operation.
17403	</result>
17404	<see><link to="Console::resume"/></see>
17405	</desc>
17406
17407	<param name="reason" type="Reason" dir="in">
17408	<desc>Specify the best matching reason code please.</desc>
17409	</param>
17410	</method>
17411
17412	<method name="saveStateWithReason">
17413	<desc>
17414	Internal method for triggering a VM save state with a specified reason
17415	code. The reason code can be interpreted by device/drivers and thus it
17416	might behave slightly differently than a normal VM save state.
17417
17418	<result name="VBOX_E_INVALID_VM_STATE">
17419	Virtual machine state neither Running nor Paused.
17420	</result>
17421	<result name="VBOX_E_FILE_ERROR">
17422	Failed to create directory for saved state file.
17423	</result>
17424	<see><link to="Console::saveState"/></see>
17425	</desc>
17426
17427	<param name="reason" type="Reason" dir="in">
17428	<desc>Specify the best matching reason code please.</desc>
17429	</param>
17430	<param name="progress" type="IProgress" dir="return">
17431	<desc>Progress object to track the operation completion.</desc>
17432	</param>
17433	</method>
17434
17435	</interface>
17436
17437	<interface
17438	name="ISession" extends="$unknown"
17439	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
17440	wsmap="managed"
17441	>
17442	<desc>
17443	The ISession interface represents a client process and allows for locking
17444	virtual machines (represented by IMachine objects) to prevent conflicting
17445	changes to the machine.
17446
17447	Any caller wishing to manipulate a virtual machine needs to create a session
17448	object first, which lives in its own process space. Such session objects are
17449	then associated with <link to="IMachine" /> objects living in the VirtualBox
17450	server process to coordinate such changes.
17451
17452	There are two typical scenarios in which sessions are used:
17453
17454	<ul>
17455	<li>To alter machine settings or control a running virtual machine, one
17456	needs to lock a machine for a given session (client process) by calling
17457	<link to="IMachine::lockMachine"/>.
17458
17459	Whereas multiple sessions may control a running virtual machine, only
17460	one process can obtain a write lock on the machine to prevent conflicting
17461	changes. A write lock is also needed if a process wants to actually run a
17462	virtual machine in its own context, such as the VirtualBox GUI or
17463	VBoxHeadless front-ends. They must also lock a machine for their own
17464	sessions before they are allowed to power up the virtual machine.
17465
17466	As a result, no machine settings can be altered while another process is
17467	already using it, either because that process is modifying machine settings
17468	or because the machine is running.
17469	</li>
17470	<li>
17471	To start a VM using one of the existing VirtualBox front-ends (e.g. the
17472	VirtualBox GUI or VBoxHeadless), one would use
17473	<link to="IMachine::launchVMProcess"/>, which also takes a session object
17474	as its first parameter. This session then identifies the caller and lets the
17475	caller control the started machine (for example, pause machine execution or
17476	power it down) as well as be notified about machine execution state changes.
17477	</li>
17478	</ul>
17479
17480	How sessions objects are created in a client process depends on whether you use
17481	the Main API via COM or via the webservice:
17482
17483	<ul>
17484	<li>When using the COM API directly, an object of the Session class from the
17485	VirtualBox type library needs to be created. In regular COM C++ client code,
17486	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
17487	This object will then act as a local session object in further calls to open
17488	a session.
17489	</li>
17490
17491	<li>In the webservice, the session manager (IWebsessionManager) instead creates
17492	a session object automatically whenever <link to="IWebsessionManager::logon" />
17493	is called. A managed object reference to that session object can be retrieved by
17494	calling <link to="IWebsessionManager::getSessionObject" />.
17495	</li>
17496	</ul>
17497	</desc>
17498
17499	<attribute name="state" type="SessionState" readonly="yes">
17500	<desc>Current state of this session.</desc>
17501	</attribute>
17502
17503	<attribute name="type" type="SessionType" readonly="yes">
17504	<desc>
17505	Type of this session. The value of this attribute is valid only
17506	if the session currently has a machine locked (i.e. its
17507	<link to="#state" /> is Locked), otherwise an error will be returned.
17508	</desc>
17509	</attribute>
17510
17511	<attribute name="machine" type="IMachine" readonly="yes">
17512	<desc>Machine object associated with this session.</desc>
17513	</attribute>
17514
17515	<attribute name="console" type="IConsole" readonly="yes">
17516	<desc>Console object associated with this session.</desc>
17517	</attribute>
17518
17519	<method name="unlockMachine">
17520	<desc>
17521	Unlocks a machine that was previously locked for the current session.
17522
17523	Calling this method is required every time a machine has been locked
17524	for a particular session using the <link to="IMachine::launchVMProcess" />
17525	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
17526	the machine will be set to <link to="MachineState_Aborted" /> on the
17527	server, and changes made to the machine settings will be lost.
17528
17529	Generally, it is recommended to unlock all machines explicitly
17530	before terminating the application (regardless of the reason for
17531	the termination).
17532
17533	<note>
17534	Do not expect the session state (<link to="ISession::state" />
17535	to return to "Unlocked" immediately after you invoke this method,
17536	particularly if you have started a new VM process. The session
17537	state will automatically return to "Unlocked" once the VM is no
17538	longer executing, which can of course take a very long time.
17539	</note>
17540
17541	<result name="E_UNEXPECTED">
17542	Session is not locked.
17543	</result>
17544
17545	</desc>
17546	</method>
17547
17548	</interface>
17549
17550	<!--
17551	// IStorageController
17552	/////////////////////////////////////////////////////////////////////////
17553	-->
17554
17555	<enum
17556	name="StorageBus"
17557	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
17558	>
17559	<desc>
17560	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
17561	see <link to="IStorageController::bus" />.
17562	</desc>
17563	<const name="Null" value="0">
17564	<desc>@c null value. Never used by the API.</desc>
17565	</const>
17566	<const name="IDE" value="1"/>
17567	<const name="SATA" value="2"/>
17568	<const name="SCSI" value="3"/>
17569	<const name="Floppy" value="4"/>
17570	<const name="SAS" value="5"/>
17571	</enum>
17572
17573	<enum
17574	name="StorageControllerType"
17575	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
17576	>
17577	<desc>
17578	The exact variant of storage controller hardware presented
17579	to the guest; see <link to="IStorageController::controllerType" />.
17580	</desc>
17581
17582	<const name="Null" value="0">
17583	<desc>@c null value. Never used by the API.</desc>
17584	</const>
17585	<const name="LsiLogic" value="1">
17586	<desc>A SCSI controller of the LsiLogic variant.</desc>
17587	</const>
17588	<const name="BusLogic" value="2">
17589	<desc>A SCSI controller of the BusLogic variant.</desc>
17590	</const>
17591	<const name="IntelAhci" value="3">
17592	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
17593	</const>
17594	<const name="PIIX3" value="4">
17595	<desc>An IDE controller of the PIIX3 variant.</desc>
17596	</const>
17597	<const name="PIIX4" value="5">
17598	<desc>An IDE controller of the PIIX4 variant.</desc>
17599	</const>
17600	<const name="ICH6" value="6">
17601	<desc>An IDE controller of the ICH6 variant.</desc>
17602	</const>
17603	<const name="I82078" value="7">
17604	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
17605	</const>
17606	<const name="LsiLogicSas" value="8">
17607	<desc>A variant of the LsiLogic controller using SAS.</desc>
17608	</const>
17609	</enum>
17610
17611	<enum
17612	name="ChipsetType"
17613	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
17614	>
17615	<desc>
17616	Type of emulated chipset (mostly southbridge).
17617	</desc>
17618
17619	<const name="Null" value="0">
17620	<desc>@c null value. Never used by the API.</desc>
17621	</const>
17622	<const name="PIIX3" value="1">
17623	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
17624	</const>
17625	<const name="ICH9" value="2">
17626	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17627	</const>
17628	</enum>
17629
17630	<interface
17631	name="IStorageController" extends="$unknown"
17632	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17633	wsmap="managed"
17634	>
17635	<desc>
17636	Represents a storage controller that is attached to a virtual machine
17637	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17638	attached to storage controllers in a real computer, virtual drives
17639	(represented by <link to="IMediumAttachment" />) are attached to virtual
17640	storage controllers, represented by this interface.
17641
17642	As opposed to physical hardware, VirtualBox has a very generic concept
17643	of a storage controller, and for purposes of the Main API, all virtual
17644	storage is attached to virtual machines via instances of this interface.
17645	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17646	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17647	is used, certain sub-types may be available and can be selected in
17648	<link to="#controllerType" />.
17649
17650	Depending on these settings, the guest operating system might see
17651	significantly different virtual hardware.
17652	</desc>
17653
17654	<attribute name="name" type="wstring" readonly="yes">
17655	<desc>
17656	Name of the storage controller, as originally specified with
17657	<link to="IMachine::addStorageController" />. This then uniquely
17658	identifies this controller with other method calls such as
17659	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17660	</desc>
17661	</attribute>
17662
17663	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17664	<desc>
17665	Maximum number of devices which can be attached to one port.
17666	</desc>
17667	</attribute>
17668
17669	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17670	<desc>
17671	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17672	</desc>
17673	</attribute>
17674
17675	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17676	<desc>
17677	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17678	</desc>
17679	</attribute>
17680
17681	<attribute name="instance" type="unsigned long">
17682	<desc>
17683	The instance number of the device in the running VM.
17684	</desc>
17685	</attribute>
17686
17687	<attribute name="portCount" type="unsigned long">
17688	<desc>
17689	The number of currently usable ports on the controller.
17690	The minimum and maximum number of ports for one controller are
17691	stored in <link to="IStorageController::minPortCount"/>
17692	and <link to="IStorageController::maxPortCount"/>.
17693	</desc>
17694	</attribute>
17695
17696	<attribute name="bus" type="StorageBus" readonly="yes">
17697	<desc>
17698	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17699	</desc>
17700	</attribute>
17701
17702	<attribute name="controllerType" type="StorageControllerType">
17703	<desc>
17704	The exact variant of storage controller hardware presented
17705	to the guest.
17706	Depending on this value, VirtualBox will provide a different
17707	virtual storage controller hardware to the guest.
17708	For SATA, SAS and floppy controllers, only one variant is
17709	available, but for IDE and SCSI, there are several.
17710
17711	For SCSI controllers, the default type is LsiLogic.
17712	</desc>
17713	</attribute>
17714
17715	<attribute name="useHostIOCache" type="boolean">
17716	<desc>
17717	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17718	caches and use synchronous file APIs on the host. This was the only option in the API before
17719	VirtualBox 3.2 and is still the default for IDE controllers.
17720
17721	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17722	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17723	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17724	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17725	virtual machines are running at the same time to prevent I/O cache related hangs.
17726	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17727	</desc>
17728	</attribute>
17729
17730	<attribute name="bootable" type="boolean" readonly="yes">
17731	<desc>
17732	Returns whether it is possible to boot from disks attached to this controller.
17733	</desc>
17734	</attribute>
17735	</interface>
17736
17737	<if target="wsdl">
17738
17739	<!--
17740	// IManagedObjectRef
17741	/////////////////////////////////////////////////////////////////////////
17742	-->
17743
17744	<interface
17745	name="IManagedObjectRef" extends="$unknown"
17746	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17747	internal="yes"
17748	wsmap="managed"
17749	wscpp="hardcoded"
17750	>
17751	<desc>
17752	Managed object reference.
17753
17754	Only within the webservice, a managed object reference (which is really
17755	an opaque number) allows a webservice client to address an object
17756	that lives in the address space of the webservice server.
17757
17758	Behind each managed object reference, there is a COM object that lives
17759	in the webservice server's address space. The COM object is not freed
17760	until the managed object reference is released, either by an explicit
17761	call to <link to="IManagedObjectRef::release" /> or by logging off from
17762	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17763	all objects created during the webservice session.
17764
17765	Whenever a method call of the VirtualBox API returns a COM object, the
17766	webservice representation of that method will instead return a
17767	managed object reference, which can then be used to invoke methods
17768	on that object.
17769	</desc>
17770
17771	<method name="getInterfaceName">
17772	<desc>
17773	Returns the name of the interface that this managed object represents,
17774	for example, "IMachine", as a string.
17775	</desc>
17776	<param name="return" type="wstring" dir="return"/>
17777	</method>
17778
17779	<method name="release">
17780	<desc>
17781	Releases this managed object reference and frees the resources that
17782	were allocated for it in the webservice server process. After calling
17783	this method, the identifier of the reference can no longer be used.
17784	</desc>
17785	</method>
17786
17787	</interface>
17788
17789	<!--
17790	// IWebsessionManager
17791	/////////////////////////////////////////////////////////////////////////
17792	-->
17793
17794	<interface
17795	name="IWebsessionManager" extends="$unknown"
17796	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17797	internal="yes"
17798	wsmap="global"
17799	wscpp="hardcoded"
17800	>
17801	<desc>
17802	Websession manager. This provides essential services
17803	to webservice clients.
17804	</desc>
17805	<method name="logon">
17806	<desc>
17807	Logs a new client onto the webservice and returns a managed object reference to
17808	the IVirtualBox instance, which the client can then use as a basis to further
17809	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17810	interface, in one way or the other.
17811	</desc>
17812	<param name="username" type="wstring" dir="in"/>
17813	<param name="password" type="wstring" dir="in"/>
17814	<param name="return" type="IVirtualBox" dir="return"/>
17815	</method>
17816
17817	<method name="getSessionObject">
17818	<desc>
17819	Returns a managed object reference to the internal ISession object that was created
17820	for this web service session when the client logged on.
17821
17822	<see><link to="ISession"/></see>
17823	</desc>
17824	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17825	<param name="return" type="ISession" dir="return"/>
17826	</method>
17827
17828	<method name="logoff">
17829	<desc>
17830	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17831	and destroys all resources associated with the session (most importantly, all
17832	managed objects created in the server while the session was active).
17833	</desc>
17834	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17835	</method>
17836
17837	</interface>
17838
17839	</if>
17840
17841	<!--
17842	// IPerformanceCollector & friends
17843	/////////////////////////////////////////////////////////////////////////
17844	-->
17845
17846	<interface
17847	name="IPerformanceMetric" extends="$unknown"
17848	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17849	>
17850	<desc>
17851	The IPerformanceMetric interface represents parameters of the given
17852	performance metric.
17853	</desc>
17854
17855	<attribute name="metricName" type="wstring" readonly="yes">
17856	<desc>
17857	Name of the metric.
17858	</desc>
17859	</attribute>
17860
17861	<attribute name="object" type="$unknown" readonly="yes">
17862	<desc>
17863	Object this metric belongs to.
17864	</desc>
17865	</attribute>
17866
17867	<attribute name="description" type="wstring" readonly="yes">
17868	<desc>
17869	Textual description of the metric.
17870	</desc>
17871	</attribute>
17872
17873	<attribute name="period" type="unsigned long" readonly="yes">
17874	<desc>
17875	Time interval between samples, measured in seconds.
17876	</desc>
17877	</attribute>
17878
17879	<attribute name="count" type="unsigned long" readonly="yes">
17880	<desc>
17881	Number of recent samples retained by the performance collector for this
17882	metric.
17883
17884	When the collected sample count exceeds this number, older samples
17885	are discarded.
17886	</desc>
17887	</attribute>
17888
17889	<attribute name="unit" type="wstring" readonly="yes">
17890	<desc>
17891	Unit of measurement.
17892	</desc>
17893	</attribute>
17894
17895	<attribute name="minimumValue" type="long" readonly="yes">
17896	<desc>
17897	Minimum possible value of this metric.
17898	</desc>
17899	</attribute>
17900
17901	<attribute name="maximumValue" type="long" readonly="yes">
17902	<desc>
17903	Maximum possible value of this metric.
17904	</desc>
17905	</attribute>
17906	</interface>
17907
17908	<interface
17909	name="IPerformanceCollector" extends="$unknown"
17910	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17911	wsmap="managed"
17912	>
17913	<desc>
17914	The IPerformanceCollector interface represents a service that collects
17915	and stores performance metrics data.
17916
17917	Performance metrics are associated with objects of interfaces like IHost
17918	and IMachine. Each object has a distinct set of performance metrics. The
17919	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17920
17921	Metric data is collected at the specified intervals and is retained
17922	internally. The interval and the number of retained samples can be set
17923	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17924	and collection settings are not persistent, they are discarded as soon as
17925	VBoxSVC process terminates. Moreover, metric settings and data associated
17926	with a particular VM only exist while VM is running. They disappear as
17927	soon as VM shuts down. It is not possible to set up metrics for machines
17928	that are powered off. One needs to start VM first, then set up metric
17929	collection parameters.
17930
17931	Metrics are organized hierarchically, with each level separated by a
17932	slash (/) character. Generally, the scheme for metric names is like this:
17933
17934	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17935
17936	"Category/Metric" together form the base metric name. A base metric is
17937	the smallest unit for which a sampling interval and the number of
17938	retained samples can be set. Only base metrics can be enabled and
17939	disabled. All sub-metrics are collected when their base metric is
17940	collected. Collected values for any set of sub-metrics can be queried
17941	with <link to="IPerformanceCollector::queryMetricsData" />.
17942
17943	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17944	category, "Load" metric, "User" submetric, "average" aggregate. An
17945	aggregate function is computed over all retained data. Valid aggregate
17946	functions are:
17947
17948	<ul>
17949	<li>avg -- average</li>
17950	<li>min -- minimum</li>
17951	<li>max -- maximum</li>
17952	</ul>
17953
17954	When setting up metric parameters, querying metric data, enabling or
17955	disabling metrics wildcards can be used in metric names to specify a
17956	subset of metrics. For example, to select all CPU-related metrics
17957	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17958	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17959
17960	The valid names for base metrics are:
17961
17962	<ul>
17963	<li>CPU/Load</li>
17964	<li>CPU/MHz</li>
17965	<li>RAM/Usage</li>
17966	<li>RAM/VMM</li>
17967	</ul>
17968
17969	The general sequence for collecting and retrieving the metrics is:
17970	<ul>
17971	<li>
17972	Obtain an instance of IPerformanceCollector with
17973	<link to="IVirtualBox::performanceCollector" />
17974	</li>
17975	<li>
17976	Allocate and populate an array with references to objects the metrics
17977	will be collected for. Use references to IHost and IMachine objects.
17978	</li>
17979	<li>
17980	Allocate and populate an array with base metric names the data will
17981	be collected for.
17982	</li>
17983	<li>
17984	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17985	the metric data will be collected and stored.
17986	</li>
17987	<li>
17988	Wait for the data to get collected.
17989	</li>
17990	<li>
17991	Allocate and populate an array with references to objects the metric
17992	values will be queried for. You can re-use the object array used for
17993	setting base metrics.
17994	</li>
17995	<li>
17996	Allocate and populate an array with metric names the data will be
17997	collected for. Note that metric names differ from base metric names.
17998	</li>
17999	<li>
18000	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
18001	that have been collected so far are returned. Note that the values
18002	are still retained internally and data collection continues.
18003	</li>
18004	</ul>
18005
18006	For an example of usage refer to the following files in VirtualBox SDK:
18007	<ul>
18008	<li>
18009	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
18010	</li>
18011	<li>
18012	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
18013	</li>
18014	</ul>
18015	</desc>
18016
18017	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
18018	<desc>
18019	Array of unique names of metrics.
18020
18021	This array represents all metrics supported by the performance
18022	collector. Individual objects do not necessarily support all of them.
18023	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
18024	list of supported metrics for a particular object.
18025	</desc>
18026	</attribute>
18027
18028	<method name="getMetrics">
18029	<desc>
18030	Returns parameters of specified metrics for a set of objects.
18031	<note>
18032	@c Null metrics array means all metrics. @c Null object array means
18033	all existing objects.
18034	</note>
18035	</desc>
18036	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18037	<desc>
18038	Metric name filter. Currently, only a comma-separated list of metrics
18039	is supported.
18040	</desc>
18041	</param>
18042	<param name="objects" type="$unknown" dir="in" safearray="yes">
18043	<desc>
18044	Set of objects to return metric parameters for.
18045	</desc>
18046	</param>
18047	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
18048	<desc>
18049	Array of returned metric parameters.
18050	</desc>
18051	</param>
18052	</method>
18053
18054	<method name="setupMetrics">
18055	<desc>
18056	Sets parameters of specified base metrics for a set of objects. Returns
18057	an array of <link to="IPerformanceMetric" /> describing the metrics
18058	have been affected.
18059	<note>
18060	@c Null or empty metric name array means all metrics. @c Null or
18061	empty object array means all existing objects. If metric name array
18062	contains a single element and object array contains many, the single
18063	metric name array element is applied to each object array element to
18064	form metric/object pairs.
18065	</note>
18066	</desc>
18067	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18068	<desc>
18069	Metric name filter. Comma-separated list of metrics with wildcard
18070	support.
18071	</desc>
18072	</param>
18073	<param name="objects" type="$unknown" dir="in" safearray="yes">
18074	<desc>
18075	Set of objects to setup metric parameters for.
18076	</desc>
18077	</param>
18078	<param name="period" type="unsigned long" dir="in">
18079	<desc>
18080	Time interval in seconds between two consecutive samples of
18081	performance data.
18082	</desc>
18083	</param>
18084	<param name="count" type="unsigned long" dir="in">
18085	<desc>
18086	Number of samples to retain in performance data history. Older
18087	samples get discarded.
18088	</desc>
18089	</param>
18090	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
18091	<desc>
18092	Array of metrics that have been modified by the call to this method.
18093	</desc>
18094	</param>
18095	</method>
18096
18097	<method name="enableMetrics">
18098	<desc>
18099	Turns on collecting specified base metrics. Returns an array of
18100	<link to="IPerformanceMetric" /> describing the metrics have been
18101	affected.
18102	<note>
18103	@c Null or empty metric name array means all metrics. @c Null or
18104	empty object array means all existing objects. If metric name array
18105	contains a single element and object array contains many, the single
18106	metric name array element is applied to each object array element to
18107	form metric/object pairs.
18108	</note>
18109	</desc>
18110	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18111	<desc>
18112	Metric name filter. Comma-separated list of metrics with wildcard
18113	support.
18114	</desc>
18115	</param>
18116	<param name="objects" type="$unknown" dir="in" safearray="yes">
18117	<desc>
18118	Set of objects to enable metrics for.
18119	</desc>
18120	</param>
18121	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
18122	<desc>
18123	Array of metrics that have been modified by the call to this method.
18124	</desc>
18125	</param>
18126	</method>
18127
18128	<method name="disableMetrics">
18129	<desc>
18130	Turns off collecting specified base metrics. Returns an array of
18131	<link to="IPerformanceMetric" /> describing the metrics have been
18132	affected.
18133	<note>
18134	@c Null or empty metric name array means all metrics. @c Null or
18135	empty object array means all existing objects. If metric name array
18136	contains a single element and object array contains many, the single
18137	metric name array element is applied to each object array element to
18138	form metric/object pairs.
18139	</note>
18140	</desc>
18141	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18142	<desc>
18143	Metric name filter. Comma-separated list of metrics with wildcard
18144	support.
18145	</desc>
18146	</param>
18147	<param name="objects" type="$unknown" dir="in" safearray="yes">
18148	<desc>
18149	Set of objects to disable metrics for.
18150	</desc>
18151	</param>
18152	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
18153	<desc>
18154	Array of metrics that have been modified by the call to this method.
18155	</desc>
18156	</param>
18157	</method>
18158
18159	<method name="queryMetricsData">
18160	<desc>
18161	Queries collected metrics data for a set of objects.
18162
18163	The data itself and related metric information are returned in seven
18164	parallel and one flattened array of arrays. Elements of
18165	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
18166	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
18167	the same index describe one set of values corresponding to a single
18168	metric.
18169
18170	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
18171	start and length of a sub-array is indicated by
18172	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
18173	value for metric <tt>metricNames[i]</tt> is at
18174	<tt>returnData[returnIndices[i]]</tt>.
18175
18176	<note>
18177	@c Null or empty metric name array means all metrics. @c Null or
18178	empty object array means all existing objects. If metric name array
18179	contains a single element and object array contains many, the single
18180	metric name array element is applied to each object array element to
18181	form metric/object pairs.
18182	</note>
18183	<note>
18184	Data collection continues behind the scenes after call to
18185	@c queryMetricsData. The return data can be seen as the snapshot of
18186	the current state at the time of @c queryMetricsData call. The
18187	internally kept metric values are not cleared by the call. This
18188	allows querying different subsets of metrics or aggregates with
18189	subsequent calls. If periodic querying is needed it is highly
18190	suggested to query the values with @c interval*count period to avoid
18191	confusion. This way a completely new set of data values will be
18192	provided by each query.
18193	</note>
18194	</desc>
18195	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18196	<desc>
18197	Metric name filter. Comma-separated list of metrics with wildcard
18198	support.
18199	</desc>
18200	</param>
18201	<param name="objects" type="$unknown" dir="in" safearray="yes">
18202	<desc>
18203	Set of objects to query metrics for.
18204	</desc>
18205	</param>
18206	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
18207	<desc>
18208	Names of metrics returned in @c returnData.
18209	</desc>
18210	</param>
18211	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
18212	<desc>
18213	Objects associated with metrics returned in @c returnData.
18214	</desc>
18215	</param>
18216	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
18217	<desc>
18218	Units of measurement for each returned metric.
18219	</desc>
18220	</param>
18221	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
18222	<desc>
18223	Divisor that should be applied to return values in order to get
18224	floating point values. For example:
18225	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
18226	will retrieve the floating point value of i-th sample of the first
18227	metric.
18228	</desc>
18229	</param>
18230	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
18231	<desc>
18232	Sequence numbers of the first elements of value sequences of
18233	particular metrics returned in @c returnData. For aggregate metrics
18234	it is the sequence number of the sample the aggregate started
18235	calculation from.
18236	</desc>
18237	</param>
18238	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
18239	<desc>
18240	Indices of the first elements of value sequences of particular
18241	metrics returned in @c returnData.
18242	</desc>
18243	</param>
18244	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
18245	<desc>
18246	Lengths of value sequences of particular metrics.
18247	</desc>
18248	</param>
18249	<param name="returnData" type="long" dir="return" safearray="yes">
18250	<desc>
18251	Flattened array of all metric data containing sequences of values for
18252	each metric.
18253	</desc>
18254	</param>
18255	</method>
18256
18257	</interface>
18258
18259	<enum
18260	name="NATAliasMode"
18261	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
18262	>
18263	<desc></desc>
18264	<const name="AliasLog" value="0x1">
18265	<desc></desc>
18266	</const>
18267	<const name="AliasProxyOnly" value="0x02">
18268	<desc></desc>
18269	</const>
18270	<const name="AliasUseSamePorts" value="0x04">
18271	<desc></desc>
18272	</const>
18273	</enum>
18274
18275	<enum
18276	name="NATProtocol"
18277	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
18278	>
18279	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
18280	<const name="UDP" value="0">
18281	<desc>Port-forwarding uses UDP protocol.</desc>
18282	</const>
18283	<const name="TCP" value="1">
18284	<desc>Port-forwarding uses TCP protocol.</desc>
18285	</const>
18286	</enum>
18287
18288	<interface
18289	name="INATEngine" extends="$unknown"
18290	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
18291	wsmap="managed"
18292	>
18293	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
18294	allows for changing NAT behavior such as port-forwarding rules. This interface is
18295	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
18296	<attribute name="network" type="wstring">
18297	<desc>The network attribute of the NAT engine (the same value is used with built-in
18298	DHCP server to fill corresponding fields of DHCP leases).</desc>
18299	</attribute>
18300	<attribute name="hostIP" type="wstring">
18301	<desc>IP of host interface to bind all opened sockets to.
18302	<note>Changing this does not change binding of port forwarding.</note>
18303	</desc>
18304	</attribute>
18305	<attribute name="TFTPPrefix" type="wstring">
18306	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
18307	the corresponding fields of DHCP leases.</desc>
18308	</attribute>
18309	<attribute name="TFTPBootFile" type="wstring">
18310	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
18311	the corresponding fields of DHCP leases.</desc>
18312	</attribute>
18313	<attribute name="TFTPNextServer" type="wstring">
18314	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
18315	the corresponding fields of DHCP leases.
18316	<note>The preferred form is IPv4 addresses.</note>
18317	</desc>
18318	</attribute>
18319	<attribute name="aliasMode" type="unsigned long">
18320	<desc></desc>
18321	</attribute>
18322	<attribute name="DNSPassDomain" type="boolean">
18323	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
18324	</attribute>
18325	<attribute name="DNSProxy" type="boolean">
18326	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18327	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
18328	</attribute>
18329	<attribute name="DNSUseHostResolver" type="boolean">
18330	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18331	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
18332	</attribute>
18333	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
18334	<desc>Array of NAT port-forwarding rules in string representation, in the following
18335	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
18336	</attribute>
18337	<method name="setNetworkSettings">
18338	<desc>Sets network configuration of the NAT engine.</desc>
18339	<param name="mtu" type="unsigned long" dir="in">
18340	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
18341	</param>
18342	<param name="sockSnd" type="unsigned long" dir="in">
18343	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
18344	</param>
18345	<param name="sockRcv" type="unsigned long" dir="in">
18346	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
18347	</param>
18348	<param name="TcpWndSnd" type="unsigned long" dir="in">
18349	<desc>Initial size of the NAT engine's sending TCP window in bytes when
18350	establishing a new TCP connection.</desc>
18351	</param>
18352	<param name="TcpWndRcv" type="unsigned long" dir="in">
18353	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
18354	establishing a new TCP connection.</desc>
18355	</param>
18356	</method>
18357	<method name="getNetworkSettings">
18358	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
18359	for parameter descriptions.</desc>
18360	<param name="mtu" type="unsigned long" dir="out" />
18361	<param name="sockSnd" type="unsigned long" dir="out" />
18362	<param name="sockRcv" type="unsigned long" dir="out" />
18363	<param name="TcpWndSnd" type="unsigned long" dir="out" />
18364	<param name="TcpWndRcv" type="unsigned long" dir="out" />
18365	</method>
18366	<method name="addRedirect">
18367	<desc>Adds a new NAT port-forwarding rule.</desc>
18368	<param name="name" type="wstring" dir="in">
18369	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
18370	auto-generates one using the other parameters.</desc>
18371	</param>
18372	<param name="proto" type="NATProtocol" dir="in">
18373	<desc>Protocol handled with the rule.</desc>
18374	</param>
18375	<param name="hostIP" type="wstring" dir="in">
18376	<desc>IP of the host interface to which the rule should apply. An empty ip address is
18377	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
18378	</param>
18379	<param name="hostPort" type="unsigned short" dir="in">
18380	<desc>The port number to listen on.</desc>
18381	</param>
18382	<param name="guestIP" type="wstring" dir="in">
18383	<desc>The IP address of the guest which the NAT engine will forward matching packets
18384	to. An empty IP address is acceptable, in which case the NAT engine will forward
18385	packets to the first DHCP lease (x.x.x.15).</desc>
18386	</param>
18387	<param name="guestPort" type="unsigned short" dir="in">
18388	<desc>The port number to forward.</desc>
18389	</param>
18390	</method>
18391	<method name="removeRedirect">
18392	<desc>Removes a port-forwarding rule that was previously registered.</desc>
18393	<param name="name" type="wstring" dir="in">
18394	<desc>The name of the rule to delete.</desc>
18395	</param>
18396	</method>
18397	</interface>
18398
18399	<!--
18400	// IExtPackManager
18401	/////////////////////////////////////////////////////////////////////////
18402	-->
18403
18404	<interface
18405	name="IExtPackPlugIn" extends="$unknown"
18406	uuid="58000040-e718-4746-bbce-4b86d96da461"
18407	wsmap="suppress"
18408	>
18409	<desc>
18410	Interface for keeping information about a plug-in that ships with an
18411	extension pack.
18412	</desc>
18413	<attribute name="name" type="wstring" readonly="yes">
18414	<desc>The plug-in name.</desc>
18415	</attribute>
18416	<attribute name="description" type="wstring" readonly="yes">
18417	<desc>The plug-in description.</desc>
18418	</attribute>
18419	<attribute name="frontend" type="wstring" readonly="yes">
18420	<desc>
18421	The name of the frontend or component name this plug-in plugs into.
18422	</desc>
18423	</attribute>
18424	<attribute name="modulePath" type="wstring" readonly="yes">
18425	<desc> The module path. </desc>
18426	</attribute>
18427	</interface>
18428
18429	<interface
18430	name="IExtPackBase" extends="$unknown"
18431	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
18432	wsmap="suppress"
18433	>
18434	<desc>
18435	Interface for querying information about an extension pack as well as
18436	accessing COM objects within it.
18437	</desc>
18438	<attribute name="name" type="wstring" readonly="yes">
18439	<desc>The extension pack name. This is unique.</desc>
18440	</attribute>
18441	<attribute name="description" type="wstring" readonly="yes">
18442	<desc>The extension pack description.</desc>
18443	</attribute>
18444	<attribute name="version" type="wstring" readonly="yes">
18445	<desc>
18446	The extension pack version string. This is restricted to the dotted
18447	version number and optionally a build indicator. No tree revision or
18448	tag will be included in the string as those things are available as
18449	separate properties. An optional publisher tag may be present like for
18450	<link to="IVirtualBox::version"/>.
18451
18452	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
18453	</desc>
18454	</attribute>
18455	<attribute name="revision" type="unsigned long" readonly="yes">
18456	<desc>The extension pack internal revision number.</desc>
18457	</attribute>
18458	<attribute name="edition" type="wstring" readonly="yes">
18459	<desc>
18460	Edition indicator. This is usually empty.
18461
18462	Can for instance be used to help distinguishing between two editions
18463	of the same extension pack where only the license, service contract or
18464	something differs.
18465	</desc>
18466	</attribute>
18467	<attribute name="VRDEModule" type="wstring" readonly="yes">
18468	<desc>The name of the VRDE module if the extension pack sports one.</desc>
18469	</attribute>
18470	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
18471	<desc>Plug-ins provided by this extension pack.</desc>
18472	</attribute>
18473	<attribute name="usable" type="boolean" readonly="yes">
18474	<desc>
18475	Indicates whether the extension pack is usable or not.
18476
18477	There are a number of reasons why an extension pack might be unusable,
18478	typical examples would be broken installation/file or that it is
18479	incompatible with the current VirtualBox version.
18480	</desc>
18481	</attribute>
18482	<attribute name="whyUnusable" type="wstring" readonly="yes">
18483	<desc>
18484	String indicating why the extension pack is not usable. This is an
18485	empty string if usable and always a non-empty string if not usable.
18486	</desc>
18487	</attribute>
18488	<attribute name="showLicense" type="boolean" readonly="yes">
18489	<desc>Whether to show the license before installation</desc>
18490	</attribute>
18491	<attribute name="license" type="wstring" readonly="yes">
18492	<desc>
18493	The default HTML license text for the extension pack. Same as
18494	calling <link to="#queryLicense">queryLicense</link> with
18495	preferredLocale and preferredLanguage as empty strings and format set
18496	to html.
18497	</desc>
18498	</attribute>
18499
18500	<method name="queryLicense">
18501	<desc>
18502	Full feature version of the license attribute.
18503	</desc>
18504	<param name="preferredLocale" type="wstring" dir="in">
18505	<desc>
18506	The preferred license locale. Pass an empty string to get the default
18507	license.
18508	</desc>
18509	</param>
18510	<param name="preferredLanguage" type="wstring" dir="in">
18511	<desc>
18512	The preferred license language. Pass an empty string to get the
18513	default language for the locale.
18514	</desc>
18515	</param>
18516	<param name="format" type="wstring" dir="in">
18517	<desc>
18518	The license format: html, rtf or txt. If a license is present there
18519	will always be an HTML of it, the rich text format (RTF) and plain
18520	text (txt) versions are optional. If
18521	</desc>
18522	</param>
18523	<param name="licenseText" type="wstring" dir="return">
18524	<desc>The license text.</desc>
18525	</param>
18526	</method>
18527
18528	</interface>
18529
18530	<interface
18531	name="IExtPack" extends="IExtPackBase"
18532	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
18533	wsmap="suppress"
18534	>
18535	<desc>
18536	Interface for querying information about an extension pack as well as
18537	accessing COM objects within it.
18538	</desc>
18539	<method name="queryObject">
18540	<desc>
18541	Queries the IUnknown interface to an object in the extension pack
18542	main module. This allows plug-ins and others to talk directly to an
18543	extension pack.
18544	</desc>
18545	<param name="objUuid" type="wstring" dir="in">
18546	<desc>The object ID. What exactly this is </desc>
18547	</param>
18548	<param name="returnInterface" type="$unknown" dir="return">
18549	<desc>The queried interface.</desc>
18550	</param>
18551	</method>
18552	</interface>
18553
18554	<interface
18555	name="IExtPackFile" extends="IExtPackBase"
18556	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
18557	wsmap="suppress"
18558	>
18559	<desc>
18560	Extension pack file (aka tarball, .vbox-extpack) representation returned
18561	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
18562	extension pack information with the addition of the file name.
18563	</desc>
18564	<attribute name="filePath" type="wstring" readonly="yes">
18565	<desc>
18566	The path to the extension pack file.
18567	</desc>
18568	</attribute>
18569
18570	<method name="install">
18571	<desc>
18572	Install the extension pack.
18573	</desc>
18574	<param name="replace" type="boolean" dir="in">
18575	<desc>
18576	Set this to automatically uninstall any existing extension pack with
18577	the same name as the one being installed.
18578	</desc>
18579	</param>
18580	<param name="displayInfo" type="wstring" dir="in">
18581	<desc>
18582	Platform specific display information. Reserved for future hacks.
18583	</desc>
18584	</param>
18585	<param name="progess" type="IProgress" dir="return">
18586	<desc>
18587	Progress object for the operation.
18588	</desc>
18589	</param>
18590	</method>
18591	</interface>
18592
18593	<interface
18594	name="IExtPackManager" extends="$unknown"
18595	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
18596	wsmap="suppress"
18597	>
18598	<desc>
18599	Interface for managing VirtualBox Extension Packs.
18600
18601	TODO: Describe extension packs, how they are managed and how to create
18602	one.
18603	</desc>
18604
18605	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
18606	<desc>
18607	List of the installed extension packs.
18608	</desc>
18609	</attribute>
18610
18611	<method name="find">
18612	<desc>
18613	Returns the extension pack with the specified name if found.
18614
18615	<result name="VBOX_E_OBJECT_NOT_FOUND">
18616	No extension pack matching @a name was found.
18617	</result>
18618	</desc>
18619	<param name="name" type="wstring" dir="in">
18620	<desc>The name of the extension pack to locate.</desc>
18621	</param>
18622	<param name="returnData" type="IExtPack" dir="return">
18623	<desc>The extension pack if found.</desc>
18624	</param>
18625	</method>
18626
18627	<method name="openExtPackFile">
18628	<desc>
18629	Attempts to open an extension pack file in preparation for
18630	installation.
18631	</desc>
18632	<param name="path" type="wstring" dir="in">
18633	<desc>The path of the extension pack tarball. This can optionally be
18634	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18635	</param>
18636	<param name="file" type="IExtPackFile" dir="return">
18637	<desc>The interface of the extension pack file object.</desc>
18638	</param>
18639	</method>
18640
18641	<method name="uninstall">
18642	<desc>Uninstalls an extension pack, removing all related files.</desc>
18643	<param name="name" type="wstring" dir="in">
18644	<desc>The name of the extension pack to uninstall.</desc>
18645	</param>
18646	<param name="forcedRemoval" type="boolean" dir="in">
18647	<desc>
18648	Forced removal of the extension pack. This means that the uninstall
18649	hook will not be called.
18650	</desc>
18651	</param>
18652	<param name="displayInfo" type="wstring" dir="in">
18653	<desc>
18654	Platform specific display information. Reserved for future hacks.
18655	</desc>
18656	</param>
18657	<param name="progess" type="IProgress" dir="return">
18658	<desc>
18659	Progress object for the operation.
18660	</desc>
18661	</param>
18662	</method>
18663
18664	<method name="cleanup">
18665	<desc>Cleans up failed installs and uninstalls</desc>
18666	</method>
18667
18668	<method name="queryAllPlugInsForFrontend">
18669	<desc>
18670	Gets the path to all the plug-in modules for a given frontend.
18671
18672	This is a convenience method that is intended to simplify the plug-in
18673	loading process for a frontend.
18674	</desc>
18675	<param name="frontendName" type="wstring" dir="in">
18676	<desc>The name of the frontend or component.</desc>
18677	</param>
18678	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18679	<desc>Array containing the plug-in modules (full paths).</desc>
18680	</param>
18681	</method>
18682
18683	<method name="isExtPackUsable">
18684	<desc>Check if the given extension pack is loaded and usable.</desc>
18685	<param name="name" type="wstring" dir="in">
18686	<desc>The name of the extension pack to check for.</desc>
18687	</param>
18688	<param name="usable" type="boolean" dir="return">
18689	<desc>Is the given extension pack loaded and usable.</desc>
18690	</param>
18691	</method>
18692
18693	</interface>
18694
18695	<!--
18696	// BandwidthGroupType
18697	/////////////////////////////////////////////////////////////////////////
18698	-->
18699	<enum
18700	name="BandwidthGroupType"
18701	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18702
18703	<desc>
18704	Type of a bandwidth control group.
18705	</desc>
18706
18707	<const name="Null" value="0">
18708	<desc>
18709	Null type, must be first.
18710	</desc>
18711	</const>
18712
18713	<const name="Disk" value="1">
18714	<desc>
18715	The bandwidth group controls disk I/O.
18716	</desc>
18717	</const>
18718
18719	<const name="Network" value="2">
18720	<desc>
18721	The bandwidth group controls network I/O.
18722	</desc>
18723	</const>
18724
18725	</enum>
18726
18727	<!--
18728	// IBandwidthGroup
18729	/////////////////////////////////////////////////////////////////////////
18730	-->
18731	<interface
18732	name="IBandwidthGroup" extends="$unknown"
18733	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18734	wsmap="managed"
18735	>
18736	<desc>Represents one bandwidth group.</desc>
18737
18738	<attribute name="name" type="wstring" readonly="yes">
18739	<desc>Name of the group.</desc>
18740	</attribute>
18741
18742	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18743	<desc>Type of the group.</desc>
18744	</attribute>
18745
18746	<attribute name="reference" type="unsigned long" readonly="yes">
18747	<desc>How many devices/medium attachements use this group.</desc>
18748	</attribute>
18749
18750	<attribute name="maxBytesPerSec" type="long long">
18751	<desc>The maximum number of bytes which can be transfered by all
18752	entities attached to this group during one second.</desc>
18753	</attribute>
18754
18755	</interface>
18756
18757	<!--
18758	// IBandwidthControl
18759	/////////////////////////////////////////////////////////////////////////
18760	-->
18761	<interface
18762	name="IBandwidthControl" extends="$unknown"
18763	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18764	wsmap="managed"
18765	>
18766	<desc>
18767	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18768	This includes network and disk I/O.
18769	</desc>
18770
18771	<attribute name="numGroups" type="unsigned long" readonly="yes">
18772	<desc>
18773	The current number of existing bandwidth groups managed.
18774	</desc>
18775	</attribute>
18776
18777	<method name="createBandwidthGroup">
18778	<desc>
18779	Creates a new bandwidth group.
18780	</desc>
18781
18782	<param name="name" type="wstring" dir="in">
18783	<desc>Name of the bandwidth group.</desc>
18784	</param>
18785	<param name="type" type="BandwidthGroupType" dir="in">
18786	<desc>The type of the bandwidth group (network or disk).</desc>
18787	</param>
18788	<param name="maxBytesPerSec" type="long long" dir="in">
18789	<desc>The maximum number of bytes which can be transfered by all
18790	entities attached to this group during one second.</desc>
18791	</param>
18792	</method>
18793
18794	<method name="deleteBandwidthGroup">
18795	<desc>
18796	Deletes a new bandwidth group.
18797	</desc>
18798
18799	<param name="name" type="wstring" dir="in">
18800	<desc>Name of the bandwidth group to delete.</desc>
18801	</param>
18802	</method>
18803
18804	<method name="getBandwidthGroup" const="yes">
18805	<desc>
18806	Get a bandwidth group by name.
18807	</desc>
18808
18809	<param name="name" type="wstring" dir="in">
18810	<desc>Name of the bandwidth group to get.</desc>
18811	</param>
18812	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18813	<desc>Where to store the bandwidth group on success.</desc>
18814	</param>
18815	</method>
18816
18817	<method name="getAllBandwidthGroups" const="yes">
18818	<desc>
18819	Get all managed bandwidth groups.
18820	</desc>
18821
18822	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18823	<desc>The array of managed bandwidth groups.</desc>
18824	</param>
18825	</method>
18826	</interface>
18827
18828	<!--
18829	// IVirtualBoxClient
18830	/////////////////////////////////////////////////////////////////////////
18831	-->
18832
18833	<interface
18834	name="IVirtualBoxClient" extends="$unknown"
18835	uuid="d191281f-b0cb-4d83-a8fa-0d9fd6ba234c"
18836	wsmap="suppress"
18837	>
18838	<desc>
18839	Convenience interface for client applications. Treat this as a
18840	singleton, i.e. never create more than one instance of this interface.
18841
18842	At the moment only available for clients of the local API (not usable
18843	via the webservice). Once the session logic is redesigned this might
18844	change.
18845	</desc>
18846
18847	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18848	<desc>
18849	Reference to the server-side API root object.
18850	</desc>
18851	</attribute>
18852
18853	<attribute name="session" type="ISession" readonly="yes">
18854	<desc>
18855	Create a new session object and return the reference to it.
18856	</desc>
18857	</attribute>
18858
18859	<attribute name="eventSource" type="IEventSource" readonly="yes">
18860	<desc>
18861	Event source for VirtualBoxClient events.
18862	</desc>
18863	</attribute>
18864
18865	<method name="checkMachineError">
18866	<desc>
18867	Perform error checking before using an <link to="IMachine"/> object.
18868	Generally useful before starting a VM and all other uses. If anything
18869	is not as it should be then this method will return an appropriate
18870	error.
18871	</desc>
18872
18873	<param name="machine" type="IMachine" dir="in">
18874	<desc>The machine object to check.</desc>
18875	</param>
18876	</method>
18877	</interface>
18878
18879	<!--
18880	// Events
18881	/////////////////////////////////////////////////////////////////////////
18882	-->
18883	<enum
18884	name="VBoxEventType"
18885	uuid="f019b8c7-22a6-468a-9f7c-3443b7b6c40a"
18886	>
18887
18888	<desc>
18889	Type of an event.
18890	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18891	</desc>
18892
18893	<const name="Invalid" value="0">
18894	<desc>
18895	Invalid event, must be first.
18896	</desc>
18897	</const>
18898
18899	<const name="Any" value="1">
18900	<desc>
18901	Wildcard for all events.
18902	Events of this type are never delivered, and only used in
18903	<link to="IEventSource::registerListener"/> call to simplify registration.
18904	</desc>
18905	</const>
18906
18907	<const name="Vetoable" value="2">
18908	<desc>
18909	Wildcard for all vetoable events. Events of this type are never delivered, and only
18910	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18911	</desc>
18912	</const>
18913
18914	<const name="MachineEvent" value="3">
18915	<desc>
18916	Wildcard for all machine events. Events of this type are never delivered, and only used in
18917	<link to="IEventSource::registerListener"/> call to simplify registration.
18918	</desc>
18919	</const>
18920
18921	<const name="SnapshotEvent" value="4">
18922	<desc>
18923	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18924	<link to="IEventSource::registerListener"/> call to simplify registration.
18925	</desc>
18926	</const>
18927
18928	<const name="InputEvent" value="5">
18929	<desc>
18930	Wildcard for all input device (keyboard, mouse) events.
18931	Events of this type are never delivered, and only used in
18932	<link to="IEventSource::registerListener"/> call to simplify registration.
18933	</desc>
18934	</const>
18935
18936	<const name="LastWildcard" value="31">
18937	<desc>
18938	Last wildcard.
18939	</desc>
18940	</const>
18941
18942	<const name="OnMachineStateChanged" value="32">
18943	<desc>
18944	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18945	</desc>
18946	</const>
18947	<const name="OnMachineDataChanged" value="33">
18948	<desc>
18949	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18950	</desc>
18951	</const>
18952	<const name="OnExtraDataChanged" value="34">
18953	<desc>
18954	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18955	</desc>
18956	</const>
18957	<const name="OnExtraDataCanChange" value="35">
18958	<desc>
18959	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18960	</desc>
18961	</const>
18962	<const name="OnMediumRegistered" value="36">
18963	<desc>
18964	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18965	</desc>
18966	</const>
18967	<const name="OnMachineRegistered" value="37">
18968	<desc>
18969	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18970	</desc>
18971	</const>
18972	<const name="OnSessionStateChanged" value="38">
18973	<desc>
18974	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18975	</desc>
18976	</const>
18977	<const name="OnSnapshotTaken" value="39">
18978	<desc>
18979	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18980	</desc>
18981	</const>
18982	<const name="OnSnapshotDeleted" value="40">
18983	<desc>
18984	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18985	</desc>
18986	</const>
18987	<const name="OnSnapshotChanged" value="41">
18988	<desc>
18989	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18990	</desc>
18991	</const>
18992	<const name="OnGuestPropertyChanged" value="42">
18993	<desc>
18994	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18995	</desc>
18996	</const>
18997	<!-- Console events -->
18998	<const name="OnMousePointerShapeChanged" value="43">
18999	<desc>
19000	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
19001	</desc>
19002	</const>
19003	<const name="OnMouseCapabilityChanged" value="44">
19004	<desc>
19005	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
19006	</desc>
19007	</const>
19008	<const name="OnKeyboardLedsChanged" value="45">
19009	<desc>
19010	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
19011	</desc>
19012	</const>
19013	<const name="OnStateChanged" value="46">
19014	<desc>
19015	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
19016	</desc>
19017	</const>
19018	<const name="OnAdditionsStateChanged" value="47">
19019	<desc>
19020	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
19021	</desc>
19022	</const>
19023	<const name="OnNetworkAdapterChanged" value="48">
19024	<desc>
19025	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
19026	</desc>
19027	</const>
19028	<const name="OnSerialPortChanged" value="49">
19029	<desc>
19030	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
19031	</desc>
19032	</const>
19033	<const name="OnParallelPortChanged" value="50">
19034	<desc>
19035	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
19036	</desc>
19037	</const>
19038	<const name="OnStorageControllerChanged" value="51">
19039	<desc>
19040	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
19041	</desc>
19042	</const>
19043	<const name="OnMediumChanged" value="52">
19044	<desc>
19045	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
19046	</desc>
19047	</const>
19048	<const name="OnVRDEServerChanged" value="53">
19049	<desc>
19050	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
19051	</desc>
19052	</const>
19053	<const name="OnUSBControllerChanged" value="54">
19054	<desc>
19055	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
19056	</desc>
19057	</const>
19058	<const name="OnUSBDeviceStateChanged" value="55">
19059	<desc>
19060	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
19061	</desc>
19062	</const>
19063	<const name="OnSharedFolderChanged" value="56">
19064	<desc>
19065	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
19066	</desc>
19067	</const>
19068	<const name="OnRuntimeError" value="57">
19069	<desc>
19070	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
19071	</desc>
19072	</const>
19073	<const name="OnCanShowWindow" value="58">
19074	<desc>
19075	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
19076	</desc>
19077	</const>
19078	<const name="OnShowWindow" value="59">
19079	<desc>
19080	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
19081	</desc>
19082	</const>
19083	<const name="OnCPUChanged" value="60">
19084	<desc>
19085	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
19086	</desc>
19087	</const>
19088	<const name="OnVRDEServerInfoChanged" value="61">
19089	<desc>
19090	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
19091	</desc>
19092	</const>
19093	<const name="OnEventSourceChanged" value="62">
19094	<desc>
19095	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
19096	</desc>
19097	</const>
19098	<const name="OnCPUExecutionCapChanged" value="63">
19099	<desc>
19100	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
19101	</desc>
19102	</const>
19103	<const name="OnGuestKeyboard" value="64">
19104	<desc>
19105	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
19106	</desc>
19107	</const>
19108	<const name="OnGuestMouse" value="65">
19109	<desc>
19110	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
19111	</desc>
19112	</const>
19113	<const name="OnNATRedirect" value="66">
19114	<desc>
19115	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
19116	</desc>
19117	</const>
19118	<const name="OnHostPCIDevicePlug" value="67">
19119	<desc>
19120	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
19121	</desc>
19122	</const>
19123	<const name="OnVBoxSVCAvailabilityChanged" value="68">
19124	<desc>
19125	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
19126	</desc>
19127	</const>
19128	<const name="OnBandwidthGroupChanged" value="69">
19129	<desc>
19130	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
19131	</desc>
19132	</const>
19133	<const name="OnGuestMonitorChanged" value="70">
19134	<desc>
19135	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
19136	</desc>
19137	</const>
19138	<const name="OnStorageDeviceChanged" value="71">
19139	<desc>
19140	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
19141	</desc>
19142	</const>
19143	<const name="OnClipboardModeChanged" value="72">
19144	<desc>
19145	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
19146	</desc>
19147	</const>
19148	<const name="OnDragAndDropModeChanged" value="73">
19149	<desc>
19150	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
19151	</desc>
19152	</const>
19153	<const name="OnNATNetworkChanged" value="74">
19154	<desc>
19155	See <link to="INATNetworkChangedEvent">INATNetworkChangedEvent</link>.
19156	</desc>
19157	</const>
19158	<const name="OnNATNetworkStartStop" value="75">
19159	<desc>
19160	See <link to="INATNetworkStartStopEvent">INATNetworkStartStopEvent</link>.
19161	</desc>
19162	</const>
19163	<const name="OnNATNetworkAlter" value="76">
19164	<desc>
19165	See <link to="INATNetworkAlterEvent">INATNetworkAlterEvent</link>.
19166	</desc>
19167	</const>
19168	<const name="OnNATNetworkCreationDeletion" value="77">
19169	<desc>
19170	See <link to="INATNetworkCreationDeletionEvent">INATNetworkCreationDeletionEvent</link>.
19171	</desc>
19172	</const>
19173	<const name="OnNATNetworkSetting" value="78">
19174	<desc>
19175	See <link to="INATNetworkSettingEvent">INATNetworkSettingEvent</link>.
19176	</desc>
19177	</const>
19178	<const name="OnNATNetworkPortForward" value="79">
19179	<desc>
19180	See <link to="INATNetworkPortForwardEvent">INATNetworkPortForwardEvent</link>.
19181	</desc>
19182	</const>
19183	<const name="OnGuestSessionStateChanged" value="80">
19184	<desc>
19185	See <link to="IGuestSessionStateChangedEvent">IGuestSessionStateChangedEvent</link>.
19186	</desc>
19187	</const>
19188	<const name="OnGuestSessionRegistered" value="81">
19189	<desc>
19190	See <link to="IGuestSessionRegisteredEvent">IGuestSessionRegisteredEvent</link>.
19191	</desc>
19192	</const>
19193	<const name="OnGuestProcessRegistered" value="82">
19194	<desc>
19195	See <link to="IGuestProcessRegisteredEvent">IGuestProcessRegisteredEvent</link>.
19196	</desc>
19197	</const>
19198	<const name="OnGuestProcessStateChanged" value="83">
19199	<desc>
19200	See <link to="IGuestProcessStateChangedEvent">IGuestProcessStateChangedEvent</link>.
19201	</desc>
19202	</const>
19203	<const name="OnGuestProcessInputNotify" value="84">
19204	<desc>
19205	See <link to="IGuestProcessInputNotifyEvent">IGuestProcessInputNotifyEvent</link>.
19206	</desc>
19207	</const>
19208	<const name="OnGuestProcessOutput" value="85">
19209	<desc>
19210	See <link to="IGuestProcessOutputEvent">IGuestProcessOutputEvent</link>.
19211	</desc>
19212	</const>
19213	<const name="OnGuestFileRegistered" value="86">
19214	<desc>
19215	See <link to="IGuestFileRegisteredEvent">IGuestFileRegisteredEvent</link>.
19216	</desc>
19217	</const>
19218	<const name="OnGuestFileStateChanged" value="87">
19219	<desc>
19220	See <link to="IGuestFileStateChangedEvent">IGuestFileStateChangedEvent</link>.
19221	</desc>
19222	</const>
19223	<const name="OnGuestFileOffsetChanged" value="88">
19224	<desc>
19225	See <link to="IGuestFileOffsetChangedEvent">IGuestFileOffsetChangedEvent</link>.
19226	</desc>
19227	</const>
19228	<const name="OnGuestFileRead" value="89">
19229	<desc>
19230	See <link to="IGuestFileReadEvent">IGuestFileReadEvent</link>.
19231
19232	<note internal="yes">For performance reasons this is a separate event to
19233	not unnecessarily overflow the event queue.</note>
19234	</desc>
19235	</const>
19236	<const name="OnGuestFileWrite" value="90">
19237	<desc>
19238	See <link to="IGuestFileWriteEvent">IGuestFileWriteEvent</link>.
19239
19240	<note internal="yes">For performance reasons this is a separate event to
19241	not unnecessarily overflow the event queue.</note>
19242	</desc>
19243	</const>
19244	<const name="OnVideoCaptureChanged" value="91">
19245	<desc>
19246	See <link to="IVideoCaptureChangedEvent">IVideoCapturedChangeEvent</link>.
19247	</desc>
19248	</const>
19249	<!-- Last event marker -->
19250	<const name="Last" value="92">
19251	<desc>
19252	Must be last event, used for iterations and structures relying on numerical event values.
19253	</desc>
19254	</const>
19255
19256	</enum>
19257
19258	<interface
19259	name="IEventSource" extends="$unknown"
19260	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
19261	wsmap="managed"
19262	>
19263	<desc>
19264	Event source. Generally, any object which could generate events can be an event source,
19265	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
19266	an event source can work with listeners in either active or passive mode. In active mode it is up to
19267	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
19268	event source keeps track of pending events for each listener and returns available events on demand.
19269
19270	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19271	</desc>
19272
19273	<method name="createListener">
19274	<desc>
19275	Creates a new listener object, useful for passive mode.
19276	</desc>
19277	<param name="listener" type="IEventListener" dir="return"/>
19278	</method>
19279
19280	<method name="createAggregator">
19281	<desc>
19282	Creates an aggregator event source, collecting events from multiple sources.
19283	This way a single listener can listen for events coming from multiple sources,
19284	using a single blocking <link to="#getEvent"/> on the returned aggregator.
19285	</desc>
19286	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
19287	<desc>
19288	Subordinate event source this one aggregatres.
19289	</desc>
19290	</param>
19291	<param name="result" type="IEventSource" dir="return">
19292	<desc>
19293	Event source aggregating passed sources.
19294	</desc>
19295	</param>
19296	</method>
19297
19298	<method name="registerListener">
19299	<desc>
19300	Register an event listener.
19301
19302	<note>
19303	To avoid system overload, the VirtualBox server process checks if passive event
19304	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
19305	current implementation, if more than 500 pending events are detected for a passive
19306	event listener, it is forcefully unregistered by the system, and further
19307	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
19308	</note>
19309	</desc>
19310	<param name="listener" type="IEventListener" dir="in">
19311	<desc>Listener to register.</desc>
19312	</param>
19313	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
19314	<desc>
19315	Event types listener is interested in. One can use wildcards like -
19316	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
19317	than one event.
19318	</desc>
19319	</param>
19320	<param name="active" type="boolean" dir="in">
19321	<desc>
19322	Which mode this listener is operating in.
19323	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
19324	In passive mode, an internal event queue is created for this this IEventListener.
19325	For each event coming in, it is added to queues for all interested registered passive
19326	listeners. It is then up to the external code to call the listener's
19327	<link to="IEventListener::handleEvent" /> method. When done with an event, the
19328	external code must call <link to="#eventProcessed" />.
19329	</desc>
19330	</param>
19331	</method>
19332
19333	<method name="unregisterListener">
19334	<desc>
19335	Unregister an event listener. If listener is passive, and some waitable events are still
19336	in queue they are marked as processed automatically.
19337	</desc>
19338	<param name="listener" type="IEventListener" dir="in">
19339	<desc>Listener to unregister.</desc>
19340	</param>
19341	</method>
19342
19343	<method name="fireEvent">
19344	<desc>
19345	Fire an event for this source.
19346	</desc>
19347	<param name="event" type="IEvent" dir="in">
19348	<desc>Event to deliver.</desc>
19349	</param>
19350	<param name="timeout" type="long" dir="in">
19351	<desc>
19352	Maximum time to wait for event processing (if event is waitable), in ms;
19353	0 = no wait, -1 = indefinite wait.
19354	</desc>
19355	</param>
19356	<param name="result" type="boolean" dir="return">
19357	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
19358	</param>
19359	</method>
19360
19361	<method name="getEvent">
19362	<desc>
19363	Get events from this peer's event queue (for passive mode). Calling this method
19364	regularly is required for passive event listeners to avoid system overload;
19365	see <link to="IEventSource::registerListener" /> for details.
19366
19367	<result name="VBOX_E_OBJECT_NOT_FOUND">
19368	Listener is not registered, or autounregistered.
19369	</result>
19370	</desc>
19371	<param name="listener" type="IEventListener" dir="in">
19372	<desc>Which listener to get data for.</desc>
19373	</param>
19374	<param name="timeout" type="long" dir="in">
19375	<desc>
19376	Maximum time to wait for events, in ms;
19377	0 = no wait, -1 = indefinite wait.
19378	</desc>
19379	</param>
19380	<param name="event" type="IEvent" dir="return">
19381	<desc>Event retrieved, or null if none available.</desc>
19382	</param>
19383	</method>
19384
19385	<method name="eventProcessed">
19386	<desc>
19387	Must be called for waitable events after a particular listener finished its
19388	event processing. When all listeners of a particular event have called this
19389	method, the system will then call <link to="IEvent::setProcessed" />.
19390	</desc>
19391	<param name="listener" type="IEventListener" dir="in">
19392	<desc>Which listener processed event.</desc>
19393	</param>
19394	<param name="event" type="IEvent" dir="in">
19395	<desc>Which event.</desc>
19396	</param>
19397	</method>
19398
19399	</interface>
19400
19401	<interface
19402	name="IEventListener" extends="$unknown"
19403	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
19404	wsmap="managed"
19405	>
19406	<desc>
19407	Event listener. An event listener can work in either active or passive mode, depending on the way
19408	it was registered.
19409	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19410	</desc>
19411
19412	<method name="handleEvent">
19413	<desc>
19414	Handle event callback for active listeners. It is not called for
19415	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
19416	and having received acknowledgement from all passive listeners via
19417	<link to="IEventSource::eventProcessed"/>, the event is marked as
19418	processed and <link to="IEvent::waitProcessed"/> will return
19419	immediately.
19420	</desc>
19421	<param name="event" type="IEvent" dir="in">
19422	<desc>Event available.</desc>
19423	</param>
19424	</method>
19425
19426	</interface>
19427
19428	<interface
19429	name="IEvent" extends="$unknown"
19430	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
19431	wsmap="managed"
19432	>
19433	<desc>
19434	Abstract parent interface for VirtualBox events. Actual events will typically implement
19435	a more specific interface which derives from this (see below).
19436
19437	<b>Introduction to VirtualBox events</b>
19438
19439	Generally speaking, an event (represented by this interface) signals that something
19440	happened, while an event listener (see <link to="IEventListener" />) represents an
19441	entity that is interested in certain events. In order for this to work with
19442	unidirectional protocols (i.e. web services), the concepts of passive and active
19443	listener are used.
19444
19445	Event consumers can register themselves as listeners, providing an array of
19446	events they are interested in (see <link to="IEventSource::registerListener" />).
19447	When an event triggers, the listener is notified about the event. The exact
19448	mechanism of the notification depends on whether the listener was registered as
19449	an active or passive listener:
19450
19451	<ul>
19452	<li>An active listener is very similar to a callback: it is a function invoked
19453	by the API. As opposed to the callbacks that were used in the API before
19454	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
19455	</li>
19456
19457	<li>Passive listeners are somewhat trickier to implement, but do not require
19458	a client function to be callable, which is not an option with scripting
19459	languages or web service clients. Internally the <link to="IEventSource" />
19460	implementation maintains an event queue for each passive listener, and
19461	newly arrived events are put in this queue. When the listener calls
19462	<link to="IEventSource::getEvent"/>, first element from its internal event
19463	queue is returned. When the client completes processing of an event,
19464	the <link to="IEventSource::eventProcessed" /> function must be called,
19465	acknowledging that the event was processed. It supports implementing
19466	waitable events. On passive listener unregistration, all events from its
19467	queue are auto-acknowledged.
19468	</li>
19469	</ul>
19470
19471	Waitable events are useful in situations where the event generator wants to track
19472	delivery or a party wants to wait until all listeners have completed the event. A
19473	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
19474	listeners might veto a certain action, and thus the event producer has to make
19475	sure that all listeners have processed the event and not vetoed before taking
19476	the action.
19477
19478	A given event may have both passive and active listeners at the same time.
19479
19480	<b>Using events</b>
19481
19482	Any VirtualBox object capable of producing externally visible events provides an
19483	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
19484	This event source object is notified by VirtualBox once something has happened, so
19485	consumers may register event listeners with this event source. To register a listener,
19486	an object implementing the <link to="IEventListener" /> interface must be provided.
19487	For active listeners, such an object is typically created by the consumer, while for
19488	passive listeners <link to="IEventSource::createListener" /> should be used. Please
19489	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
19490
19491	Once created, the listener must be registered to listen for the desired events
19492	(see <link to="IEventSource::registerListener" />), providing an array of
19493	<link to="VBoxEventType" /> enums. Those elements can either be the individual
19494	event IDs or wildcards matching multiple event IDs.
19495
19496	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
19497	called automatically when the event is triggered, while passive listeners have to call
19498	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
19499	an event processing loop.
19500
19501	The IEvent interface is an abstract parent interface for all such VirtualBox events
19502	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
19503	or the event processing loop is to check the <link to="#type" /> attribute of the event and
19504	then cast to the appropriate specific interface using @c QueryInterface().
19505	</desc>
19506
19507	<attribute name="type" readonly="yes" type="VBoxEventType">
19508	<desc>
19509	Event type.
19510	</desc>
19511	</attribute>
19512
19513	<attribute name="source" readonly="yes" type="IEventSource">
19514	<desc>
19515	Source of this event.
19516	</desc>
19517	</attribute>
19518
19519	<attribute name="waitable" readonly="yes" type="boolean">
19520	<desc>
19521	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
19522	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
19523	as no additional overhead associated with waitability imposed.
19524	Waitable events are needed when one need to be able to wait for particular event processed,
19525	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
19526	until all consumers confirmed events.
19527	</desc>
19528	</attribute>
19529
19530	<method name="setProcessed">
19531	<desc>
19532	Internal method called by the system when all listeners of a particular event have called
19533	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
19534	</desc>
19535	</method>
19536
19537	<method name="waitProcessed">
19538	<desc>
19539	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
19540	described semantics, for non-waitable returns true immediately.
19541	</desc>
19542	<param name="timeout" type="long" dir="in">
19543	<desc>
19544	Maximum time to wait for event processeing, in ms;
19545	0 = no wait, -1 = indefinite wait.
19546	</desc>
19547	</param>
19548	<param name="result" type="boolean" dir="return">
19549	<desc>If this event was processed before timeout.</desc>
19550	</param>
19551	</method>
19552	</interface>
19553
19554
19555	<interface
19556	name="IReusableEvent" extends="IEvent"
19557	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
19558	wsmap="managed"
19559	>
19560	<desc>Base abstract interface for all reusable events.</desc>
19561
19562	<attribute name="generation" readonly="yes" type="unsigned long">
19563	<desc>Current generation of event, incremented on reuse.</desc>
19564	</attribute>
19565
19566	<method name="reuse">
19567	<desc>
19568	Marks an event as reused, increments 'generation', fields shall no
19569	longer be considered valid.
19570	</desc>
19571	</method>
19572	</interface>
19573
19574	<interface
19575	name="IMachineEvent" extends="IEvent"
19576	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
19577	wsmap="managed" id="MachineEvent"
19578	>
19579	<desc>Base abstract interface for all machine events.</desc>
19580
19581	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
19582	<desc>ID of the machine this event relates to.</desc>
19583	</attribute>
19584
19585	</interface>
19586
19587	<interface
19588	name="IMachineStateChangedEvent" extends="IMachineEvent"
19589	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
19590	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
19591	>
19592	<desc>Machine state change event.</desc>
19593
19594	<attribute name="state" readonly="yes" type="MachineState">
19595	<desc>New execution state.</desc>
19596	</attribute>
19597	</interface>
19598
19599	<interface
19600	name="IMachineDataChangedEvent" extends="IMachineEvent"
19601	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
19602	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
19603	>
19604	<desc>
19605	Any of the settings of the given machine has changed.
19606	</desc>
19607
19608	<attribute name="temporary" readonly="yes" type="boolean">
19609	<desc>@c true if the settings change is temporary. All permanent
19610	settings changes will trigger an event, and only temporary settings
19611	changes for running VMs will trigger an event. Note: sending events
19612	for temporary changes is NOT IMPLEMENTED.</desc>
19613	</attribute>
19614	</interface>
19615
19616	<interface
19617	name="IMediumRegisteredEvent" extends="IEvent"
19618	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
19619	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
19620	>
19621	<desc>
19622	The given medium was registered or unregistered
19623	within this VirtualBox installation.
19624	</desc>
19625
19626	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
19627	<desc>ID of the medium this event relates to.</desc>
19628	</attribute>
19629
19630	<attribute name="mediumType" readonly="yes" type="DeviceType">
19631	<desc>Type of the medium this event relates to.</desc>
19632	</attribute>
19633
19634	<attribute name="registered" type="boolean" readonly="yes">
19635	<desc>
19636	If @c true, the medium was registered, otherwise it was
19637	unregistered.
19638	</desc>
19639	</attribute>
19640	</interface>
19641
19642	<interface
19643	name="IMachineRegisteredEvent" extends="IMachineEvent"
19644	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
19645	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
19646	>
19647	<desc>
19648	The given machine was registered or unregistered
19649	within this VirtualBox installation.
19650	</desc>
19651
19652	<attribute name="registered" type="boolean" readonly="yes">
19653	<desc>
19654	If @c true, the machine was registered, otherwise it was
19655	unregistered.
19656	</desc>
19657	</attribute>
19658	</interface>
19659
19660	<interface
19661	name="ISessionStateChangedEvent" extends="IMachineEvent"
19662	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
19663	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
19664	>
19665	<desc>
19666	The state of the session for the given machine was changed.
19667	<see><link to="IMachine::sessionState"/></see>
19668	</desc>
19669
19670	<attribute name="state" type="SessionState" readonly="yes">
19671	<desc>
19672	New session state.
19673	</desc>
19674	</attribute>
19675	</interface>
19676
19677	<interface
19678	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
19679	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
19680	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
19681	>
19682	<desc>
19683	Notification when a guest property has changed.
19684	</desc>
19685
19686	<attribute name="name" readonly="yes" type="wstring">
19687	<desc>
19688	The name of the property that has changed.
19689	</desc>
19690	</attribute>
19691
19692	<attribute name="value" readonly="yes" type="wstring">
19693	<desc>
19694	The new property value.
19695	</desc>
19696	</attribute>
19697
19698	<attribute name="flags" readonly="yes" type="wstring">
19699	<desc>
19700	The new property flags.
19701	</desc>
19702	</attribute>
19703
19704	</interface>
19705
19706	<interface
19707	name="ISnapshotEvent" extends="IMachineEvent"
19708	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
19709	wsmap="managed" id="SnapshotEvent"
19710	>
19711	<desc>Base interface for all snapshot events.</desc>
19712
19713	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
19714	<desc>ID of the snapshot this event relates to.</desc>
19715	</attribute>
19716
19717	</interface>
19718
19719	<interface
19720	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
19721	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
19722	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
19723	>
19724	<desc>
19725	A new snapshot of the machine has been taken.
19726	<see><link to="ISnapshot"/></see>
19727	</desc>
19728	</interface>
19729
19730	<interface
19731	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
19732	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19733	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19734	>
19735	<desc>
19736	Snapshot of the given machine has been deleted.
19737
19738	<note>
19739	This notification is delivered <b>after</b> the snapshot
19740	object has been uninitialized on the server (so that any
19741	attempt to call its methods will return an error).
19742	</note>
19743
19744	<see><link to="ISnapshot"/></see>
19745	</desc>
19746	</interface>
19747
19748	<interface
19749	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19750	uuid="07541941-8079-447a-a33e-47a69c7980db"
19751	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19752	>
19753	<desc>
19754	Snapshot properties (name and/or description) have been changed.
19755	<see><link to="ISnapshot"/></see>
19756	</desc>
19757	</interface>
19758
19759	<interface
19760	name="IMousePointerShapeChangedEvent" extends="IEvent"
19761	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19762	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19763	>
19764	<desc>
19765	Notification when the guest mouse pointer shape has
19766	changed. The new shape data is given.
19767	</desc>
19768
19769	<attribute name="visible" type="boolean" readonly="yes">
19770	<desc>
19771	Flag whether the pointer is visible.
19772	</desc>
19773	</attribute>
19774	<attribute name="alpha" type="boolean" readonly="yes">
19775	<desc>
19776	Flag whether the pointer has an alpha channel.
19777	</desc>
19778	</attribute>
19779	<attribute name="xhot" type="unsigned long" readonly="yes">
19780	<desc>
19781	The pointer hot spot X coordinate.
19782	</desc>
19783	</attribute>
19784	<attribute name="yhot" type="unsigned long" readonly="yes">
19785	<desc>
19786	The pointer hot spot Y coordinate.
19787	</desc>
19788	</attribute>
19789	<attribute name="width" type="unsigned long" readonly="yes">
19790	<desc>
19791	Width of the pointer shape in pixels.
19792	</desc>
19793	</attribute>
19794	<attribute name="height" type="unsigned long" readonly="yes">
19795	<desc>
19796	Height of the pointer shape in pixels.
19797	</desc>
19798	</attribute>
19799	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19800	<desc>
19801	Shape buffer arrays.
19802
19803	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19804	followed by a 32-bpp XOR (color) mask.
19805
19806	For pointers without alpha channel the XOR mask pixels are
19807	32-bit values: (lsb)BGR0(msb). For pointers with alpha channel
19808	the XOR mask consists of (lsb)BGRA(msb) 32-bit values.
19809
19810	An AND mask is used for pointers with alpha channel, so if the
19811	callback does not support alpha, the pointer could be
19812	displayed as a normal color pointer.
19813
19814	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19815	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19816	height</tt>. The padding bits at the end of each scanline are
19817	undefined.
19818
19819	The XOR mask follows the AND mask on the next 4-byte aligned
19820	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19821	Bytes in the gap between the AND and the XOR mask are undefined.
19822	The XOR mask scanlines have no gap between them and the size of
19823	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19824
19825	<note>
19826	If @a shape is 0, only the pointer visibility is changed.
19827	</note>
19828	</desc>
19829	</attribute>
19830	</interface>
19831
19832	<interface
19833	name="IMouseCapabilityChangedEvent" extends="IEvent"
19834	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19835	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19836	>
19837	<desc>
19838	Notification when the mouse capabilities reported by the
19839	guest have changed. The new capabilities are passed.
19840	</desc>
19841	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19842	<desc>
19843	Supports absolute coordinates.
19844	</desc>
19845	</attribute>
19846	<attribute name="supportsRelative" type="boolean" readonly="yes">
19847	<desc>
19848	Supports relative coordinates.
19849	</desc>
19850	</attribute>
19851	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19852	<desc>
19853	If host cursor is needed.
19854	</desc>
19855	</attribute>
19856	</interface>
19857
19858	<interface
19859	name="IKeyboardLedsChangedEvent" extends="IEvent"
19860	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19861	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19862	>
19863	<desc>
19864	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19865	to alter the state of the keyboard LEDs.
19866	</desc>
19867	<attribute name="numLock" type="boolean" readonly="yes">
19868	<desc>
19869	NumLock status.
19870	</desc>
19871	</attribute>
19872	<attribute name="capsLock" type="boolean" readonly="yes">
19873	<desc>
19874	CapsLock status.
19875	</desc>
19876	</attribute>
19877	<attribute name="scrollLock" type="boolean" readonly="yes">
19878	<desc>
19879	ScrollLock status.
19880	</desc>
19881	</attribute>
19882	</interface>
19883
19884	<interface
19885	name="IStateChangedEvent" extends="IEvent"
19886	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19887	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19888	>
19889	<desc>
19890	Notification when the execution state of the machine has changed.
19891	The new state is given.
19892	</desc>
19893	<attribute name="state" type="MachineState" readonly="yes">
19894	<desc>
19895	New machine state.
19896	</desc>
19897	</attribute>
19898	</interface>
19899
19900	<interface
19901	name="IAdditionsStateChangedEvent" extends="IEvent"
19902	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19903	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19904	>
19905	<desc>
19906	Notification when a Guest Additions property changes.
19907	Interested callees should query IGuest attributes to
19908	find out what has changed.
19909	</desc>
19910	</interface>
19911
19912	<interface
19913	name="INetworkAdapterChangedEvent" extends="IEvent"
19914	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19915	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19916	>
19917	<desc>
19918	Notification when a property of one of the
19919	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19920	changes. Interested callees should use INetworkAdapter methods and
19921	attributes to find out what has changed.
19922	</desc>
19923	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19924	<desc>
19925	Network adapter that is subject to change.
19926	</desc>
19927	</attribute>
19928	</interface>
19929
19930	<interface
19931	name="ISerialPortChangedEvent" extends="IEvent"
19932	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19933	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19934	>
19935	<desc>
19936	Notification when a property of one of the
19937	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19938	Interested callees should use ISerialPort methods and attributes
19939	to find out what has changed.
19940	</desc>
19941	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19942	<desc>
19943	Serial port that is subject to change.
19944	</desc>
19945	</attribute>
19946	</interface>
19947
19948	<interface
19949	name="IParallelPortChangedEvent" extends="IEvent"
19950	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19951	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19952	>
19953	<desc>
19954	Notification when a property of one of the
19955	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19956	changes. Interested callees should use ISerialPort methods and
19957	attributes to find out what has changed.
19958	</desc>
19959	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19960	<desc>
19961	Parallel port that is subject to change.
19962	</desc>
19963	</attribute>
19964	</interface>
19965
19966	<interface
19967	name="IStorageControllerChangedEvent" extends="IEvent"
19968	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19969	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19970	>
19971	<desc>
19972	Notification when a
19973	<link to="IMachine::mediumAttachments">medium attachment</link>
19974	changes.
19975	</desc>
19976	</interface>
19977
19978	<interface
19979	name="IMediumChangedEvent" extends="IEvent"
19980	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19981	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19982	>
19983	<desc>
19984	Notification when a
19985	<link to="IMachine::mediumAttachments">medium attachment</link>
19986	changes.
19987	</desc>
19988	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19989	<desc>
19990	Medium attachment that is subject to change.
19991	</desc>
19992	</attribute>
19993	</interface>
19994
19995	<interface
19996	name="IClipboardModeChangedEvent" extends="IEvent"
19997	uuid="cac21692-7997-4595-a731-3a509db604e5"
19998	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19999	>
20000	<desc>
20001	Notification when the shared clipboard mode changes.
20002	</desc>
20003	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
20004	<desc>
20005	The new clipboard mode.
20006	</desc>
20007	</attribute>
20008	</interface>
20009
20010	<interface
20011	name="IDragAndDropModeChangedEvent" extends="IEvent"
20012	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
20013	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
20014	>
20015	<desc>
20016	Notification when the drag'n'drop mode changes.
20017	</desc>
20018	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
20019	<desc>
20020	The new drag'n'drop mode.
20021	</desc>
20022	</attribute>
20023	</interface>
20024
20025	<interface
20026	name="ICPUChangedEvent" extends="IEvent"
20027	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
20028	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
20029	>
20030	<desc>
20031	Notification when a CPU changes.
20032	</desc>
20033	<attribute name="CPU" type="unsigned long" readonly="yes">
20034	<desc>
20035	The CPU which changed.
20036	</desc>
20037	</attribute>
20038	<attribute name="add" type="boolean" readonly="yes">
20039	<desc>
20040	Flag whether the CPU was added or removed.
20041	</desc>
20042	</attribute>
20043	</interface>
20044
20045	<interface
20046	name="ICPUExecutionCapChangedEvent" extends="IEvent"
20047	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
20048	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
20049	>
20050	<desc>
20051	Notification when the CPU execution cap changes.
20052	</desc>
20053	<attribute name="executionCap" type="unsigned long" readonly="yes">
20054	<desc>
20055	The new CPU execution cap value. (1-100)
20056	</desc>
20057	</attribute>
20058	</interface>
20059
20060	<interface
20061	name="IGuestKeyboardEvent" extends="IEvent"
20062	uuid="88394258-7006-40d4-b339-472ee3801844"
20063	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
20064	>
20065	<desc>
20066	Notification when guest keyboard event happens.
20067	</desc>
20068	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
20069	<desc>
20070	Array of scancodes.
20071	</desc>
20072	</attribute>
20073	</interface>
20074
20075	<interface
20076	name="IGuestMouseEvent" extends="IReusableEvent"
20077	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
20078	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
20079	>
20080	<desc>
20081	Notification when guest mouse event happens.
20082	</desc>
20083
20084	<attribute name="absolute" type="boolean" readonly="yes">
20085	<desc>
20086	If this event is relative or absolute.
20087	</desc>
20088	</attribute>
20089
20090	<attribute name="x" type="long" readonly="yes">
20091	<desc>
20092	New X position, or X delta.
20093	</desc>
20094	</attribute>
20095
20096	<attribute name="y" type="long" readonly="yes">
20097	<desc>
20098	New Y position, or Y delta.
20099	</desc>
20100	</attribute>
20101
20102	<attribute name="z" type="long" readonly="yes">
20103	<desc>
20104	Z delta.
20105	</desc>
20106	</attribute>
20107
20108	<attribute name="w" type="long" readonly="yes">
20109	<desc>
20110	W delta.
20111	</desc>
20112	</attribute>
20113
20114	<attribute name="buttons" type="long" readonly="yes">
20115	<desc>
20116	Button state bitmask.
20117	</desc>
20118	</attribute>
20119
20120	</interface>
20121
20122	<interface
20123	name="IGuestSessionEvent" extends="IEvent"
20124	uuid="b9acd33f-647d-45ac-8fe9-f49b3183ba37"
20125	wsmap="managed"
20126	>
20127	<desc>Base abstract interface for all guest session events.</desc>
20128
20129	<attribute name="session" type="IGuestSession" readonly="yes">
20130	<desc>Guest session that is subject to change.</desc>
20131	</attribute>
20132
20133	</interface>
20134
20135	<interface
20136	name="IGuestSessionStateChangedEvent" extends="IGuestSessionEvent"
20137	uuid="327e3c00-ee61-462f-aed3-0dff6cbf9904"
20138	wsmap="managed" autogen="VBoxEvent" id="OnGuestSessionStateChanged"
20139	>
20140	<desc>
20141	Notification when a guest session changed its state.
20142	</desc>
20143
20144	<attribute name="id" type="unsigned long" readonly="yes">
20145	<desc>
20146	Session ID of guest session which was changed.
20147	</desc>
20148	</attribute>
20149	<attribute name="status" type="GuestSessionStatus" readonly="yes">
20150	<desc>
20151	New session status.
20152	</desc>
20153	</attribute>
20154	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20155	<desc>
20156	Error information in case of new session status is indicating an error.
20157
20158	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
20159	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
20160	include/VBox/err.h for details.
20161	</desc>
20162	</attribute>
20163
20164	</interface>
20165
20166	<interface
20167	name="IGuestSessionRegisteredEvent" extends="IGuestSessionEvent"
20168	uuid="b79de686-eabd-4fa6-960a-f1756c99ea1c"
20169	wsmap="managed" autogen="VBoxEvent" id="OnGuestSessionRegistered"
20170	>
20171	<desc>
20172	Notification when a guest session was registered or unregistered.
20173	</desc>
20174
20175	<attribute name="registered" type="boolean" readonly="yes">
20176	<desc>
20177	If @c true, the guest session was registered, otherwise it was
20178	unregistered.
20179	</desc>
20180	</attribute>
20181
20182	</interface>
20183
20184	<interface
20185	name="IGuestProcessEvent" extends="IGuestSessionEvent"
20186	uuid="2405f0e5-6588-40a3-9b0a-68c05ba52c4b"
20187	wsmap="managed"
20188	>
20189	<desc>Base abstract interface for all guest process events.</desc>
20190
20191	<attribute name="process" type="IGuestProcess" readonly="yes">
20192	<desc>
20193	Guest process object which is related to this event.
20194	</desc>
20195	</attribute>
20196	<attribute name="pid" type="unsigned long" readonly="yes">
20197	<desc>
20198	Guest process ID (PID).
20199	</desc>
20200	</attribute>
20201
20202	</interface>
20203
20204	<interface
20205	name="IGuestProcessRegisteredEvent" extends="IGuestProcessEvent"
20206	uuid="1d89e2b3-c6ea-45b6-9d43-dc6f70cc9f02"
20207	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessRegistered"
20208	>
20209	<desc>
20210	Notification when a guest process was registered or unregistered.
20211	</desc>
20212
20213	<attribute name="registered" type="boolean" readonly="yes">
20214	<desc>
20215	If @c true, the guest process was registered, otherwise it was
20216	unregistered.
20217	</desc>
20218	</attribute>
20219
20220	</interface>
20221
20222	<interface
20223	name="IGuestProcessStateChangedEvent" extends="IGuestProcessEvent"
20224	uuid="c365fb7b-4430-499f-92c8-8bed814a567a"
20225	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessStateChanged"
20226	>
20227	<desc>
20228	Notification when a guest process changed its state.
20229	</desc>
20230
20231	<attribute name="status" type="ProcessStatus" readonly="yes">
20232	<desc>
20233	New guest process status.
20234	</desc>
20235	</attribute>
20236	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20237	<desc>
20238	Error information in case of new session status is indicating an error.
20239
20240	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
20241	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
20242	include/VBox/err.h for details.
20243	</desc>
20244	</attribute>
20245
20246	</interface>
20247
20248	<interface
20249	name="IGuestProcessIOEvent" extends="IGuestProcessEvent"
20250	uuid="9ea9227c-e9bb-49b3-bfc7-c5171e93ef38"
20251	wsmap="managed"
20252	>
20253	<desc>
20254	Base abstract interface for all guest process input/output (IO) events.
20255	</desc>
20256
20257	<attribute name="handle" type="unsigned long" readonly="yes">
20258	<desc>
20259	Input/output (IO) handle involved in this event. Usually 0 is stdin,
20260	1 is stdout and 2 is stderr.
20261	</desc>
20262	</attribute>
20263
20264	<attribute name="processed" type="unsigned long" readonly="yes">
20265	<desc>
20266	Processed input or output (in bytes).
20267	</desc>
20268	</attribute>
20269
20270	</interface>
20271
20272	<interface
20273	name="IGuestProcessInputNotifyEvent" extends="IGuestProcessIOEvent"
20274	uuid="0de887f2-b7db-4616-aac6-cfb94d89ba78"
20275	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessInputNotify"
20276	>
20277	<desc>
20278	Notification when a guest process' stdin became available.
20279	<note>This event is right now not implemented!</note>
20280	</desc>
20281
20282	<attribute name="status" type="ProcessInputStatus" readonly="yes">
20283	<desc>
20284	Current process input status.
20285	</desc>
20286	</attribute>
20287
20288	</interface>
20289
20290	<interface
20291	name="IGuestProcessOutputEvent" extends="IGuestProcessIOEvent"
20292	uuid="d3d5f1ee-bcb2-4905-a7ab-cc85448a742b"
20293	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessOutput"
20294	>
20295	<desc>
20296	Notification when there is guest process output available for reading.
20297	</desc>
20298
20299	<attribute name="data" type="octet" safearray="yes" readonly="yes">
20300	<desc>
20301	Actual output data.
20302	</desc>
20303	</attribute>
20304
20305	</interface>
20306
20307	<interface
20308	name="IGuestFileEvent" extends="IGuestSessionEvent"
20309	uuid="c8adb7b0-057d-4391-b928-f14b06b710c5"
20310	wsmap="managed"
20311	>
20312	<desc>Base abstract interface for all guest file events.</desc>
20313
20314	<attribute name="file" type="IGuestFile" readonly="yes">
20315	<desc>
20316	Guest file object which is related to this event.
20317	</desc>
20318	</attribute>
20319
20320	</interface>
20321
20322	<interface
20323	name="IGuestFileRegisteredEvent" extends="IGuestFileEvent"
20324	uuid="d0d93830-70a2-487e-895e-d3fc9679f7b3"
20325	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileRegistered"
20326	>
20327	<desc>
20328	Notification when a guest file was registered or unregistered.
20329	</desc>
20330
20331	<attribute name="registered" type="boolean" readonly="yes">
20332	<desc>
20333	If @c true, the guest file was registered, otherwise it was
20334	unregistered.
20335	</desc>
20336	</attribute>
20337
20338	</interface>
20339
20340	<interface
20341	name="IGuestFileStateChangedEvent" extends="IGuestFileEvent"
20342	uuid="d37fe88f-0979-486c-baa1-3abb144dc82d"
20343	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileStateChanged"
20344	>
20345	<desc>
20346	Notification when a guest file changed its state.
20347	</desc>
20348
20349	<attribute name="status" type="FileStatus" readonly="yes">
20350	<desc>
20351	New guest file status.
20352	</desc>
20353	</attribute>
20354	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20355	<desc>
20356	Error information in case of new session status is indicating an error.
20357
20358	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
20359	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
20360	include/VBox/err.h for details.
20361	</desc>
20362	</attribute>
20363	<!-- Note: No events for reads/writes for performance reasons.
20364	See dedidcated events IGuestFileReadEvent and
20365	IGuestFileWriteEvent. -->
20366
20367	</interface>
20368
20369	<interface
20370	name="IGuestFileIOEvent" extends="IGuestFileEvent"
20371	uuid="b5191a7c-9536-4ef8-820e-3b0e17e5bbc8"
20372	wsmap="managed"
20373	>
20374	<desc>
20375	Base abstract interface for all guest file input/output (IO) events.
20376	</desc>
20377
20378	<attribute name="offset" type="long long" readonly="yes">
20379	<desc>
20380	Current offset (in bytes).
20381	</desc>
20382	</attribute>
20383	<attribute name="processed" type="unsigned long" readonly="yes">
20384	<desc>
20385	Processed input or output (in bytes).
20386	</desc>
20387	</attribute>
20388
20389	</interface>
20390
20391	<interface
20392	name="IGuestFileOffsetChangedEvent" extends="IGuestFileIOEvent"
20393	uuid="e8f79a21-1207-4179-94cf-ca250036308f"
20394	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileOffsetChanged"
20395	>
20396	<desc>
20397	Notification when a guest file changed its current offset.
20398	</desc>
20399
20400	</interface>
20401
20402	<interface
20403	name="IGuestFileReadEvent" extends="IGuestFileIOEvent"
20404	uuid="4ee3cbcb-486f-40db-9150-deee3fd24189"
20405	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileRead"
20406	>
20407	<desc>
20408	Notification when data has been read from a guest file.
20409	</desc>
20410
20411	<attribute name="data" type="octet" safearray="yes" readonly="yes">
20412	<desc>
20413	Actual data read.
20414	</desc>
20415	</attribute>
20416
20417	</interface>
20418
20419	<interface
20420	name="IGuestFileWriteEvent" extends="IGuestFileIOEvent"
20421	uuid="e062a915-3cf5-4c0a-bc90-9b8d4cc94d89"
20422	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileWrite"
20423	>
20424	<desc>
20425	Notification when data has been written to a guest file.
20426	</desc>
20427
20428	</interface>
20429
20430	<interface
20431	name="IVRDEServerChangedEvent" extends="IEvent"
20432	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
20433	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
20434	>
20435	<desc>
20436	Notification when a property of the
20437	<link to="IMachine::VRDEServer">VRDE server</link> changes.
20438	Interested callees should use IVRDEServer methods and attributes to
20439	find out what has changed.
20440	</desc>
20441	</interface>
20442
20443	<interface
20444	name="IVRDEServerInfoChangedEvent" extends="IEvent"
20445	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
20446	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
20447	>
20448	<desc>
20449	Notification when the status of the VRDE server changes. Interested callees
20450	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
20451	attributes to find out what is the current status.
20452	</desc>
20453	</interface>
20454
20455	<interface
20456	name="IVideoCaptureChangedEvent" extends="IEvent"
20457	uuid="6215d169-25dd-4719-ab34-c908701efb58"
20458	wsmap="managed" autogen="VBoxEvent" id="OnVideoCaptureChanged"
20459	>
20460	<desc>
20461	Notification when video capture settings have changed.
20462	</desc>
20463	</interface>
20464
20465	<interface
20466	name="IUSBControllerChangedEvent" extends="IEvent"
20467	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
20468	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
20469	>
20470	<desc>
20471	Notification when a property of the virtual
20472	<link to="IMachine::USBController">USB controller</link> changes.
20473	Interested callees should use IUSBController methods and attributes to
20474	find out what has changed.
20475	</desc>
20476	</interface>
20477
20478	<interface
20479	name="IUSBDeviceStateChangedEvent" extends="IEvent"
20480	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
20481	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
20482	>
20483	<desc>
20484	Notification when a USB device is attached to or detached from
20485	the virtual USB controller.
20486
20487	This notification is sent as a result of the indirect
20488	request to attach the device because it matches one of the
20489	machine USB filters, or as a result of the direct request
20490	issued by <link to="IConsole::attachUSBDevice"/> or
20491	<link to="IConsole::detachUSBDevice"/>.
20492
20493	This notification is sent in case of both a succeeded and a
20494	failed request completion. When the request succeeds, the
20495	@a error parameter is @c null, and the given device has been
20496	already added to (when @a attached is @c true) or removed from
20497	(when @a attached is @c false) the collection represented by
20498	<link to="IConsole::USBDevices"/>. On failure, the collection
20499	doesn't change and the @a error parameter represents the error
20500	message describing the failure.
20501	</desc>
20502	<attribute name="device" type="IUSBDevice" readonly="yes">
20503	<desc>
20504	Device that is subject to state change.
20505	</desc>
20506	</attribute>
20507	<attribute name="attached" type="boolean" readonly="yes">
20508	<desc>
20509	@c true if the device was attached and @c false otherwise.
20510	</desc>
20511	</attribute>
20512	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20513	<desc>
20514	@c null on success or an error message object on failure.
20515	</desc>
20516	</attribute>
20517	</interface>
20518
20519	<interface
20520	name="ISharedFolderChangedEvent" extends="IEvent"
20521	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
20522	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
20523	>
20524	<desc>
20525	Notification when a shared folder is added or removed.
20526	The @a scope argument defines one of three scopes:
20527	<link to="IVirtualBox::sharedFolders">global shared folders</link>
20528	(<link to="Scope_Global">Global</link>),
20529	<link to="IMachine::sharedFolders">permanent shared folders</link> of
20530	the machine (<link to="Scope_Machine">Machine</link>) or <link
20531	to="IConsole::sharedFolders">transient shared folders</link> of the
20532	machine (<link to="Scope_Session">Session</link>). Interested callees
20533	should use query the corresponding collections to find out what has
20534	changed.
20535	</desc>
20536	<attribute name="scope" type="Scope" readonly="yes">
20537	<desc>
20538	Scope of the notification.
20539	</desc>
20540	</attribute>
20541	</interface>
20542
20543	<interface
20544	name="IRuntimeErrorEvent" extends="IEvent"
20545	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
20546	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
20547	>
20548	<desc>
20549	Notification when an error happens during the virtual
20550	machine execution.
20551
20552	There are three kinds of runtime errors:
20553	<ul>
20554	<li><i>fatal</i></li>
20555	<li><i>non-fatal with retry</i></li>
20556	<li><i>non-fatal warnings</i></li>
20557	</ul>
20558
20559	<b>Fatal</b> errors are indicated by the @a fatal parameter set
20560	to @c true. In case of fatal errors, the virtual machine
20561	execution is always paused before calling this notification, and
20562	the notification handler is supposed either to immediately save
20563	the virtual machine state using <link to="IConsole::saveState"/>
20564	or power it off using <link to="IConsole::powerDown"/>.
20565	Resuming the execution can lead to unpredictable results.
20566
20567	<b>Non-fatal</b> errors and warnings are indicated by the
20568	@a fatal parameter set to @c false. If the virtual machine
20569	is in the Paused state by the time the error notification is
20570	received, it means that the user can <i>try to resume</i> the machine
20571	execution after attempting to solve the problem that caused the
20572	error. In this case, the notification handler is supposed
20573	to show an appropriate message to the user (depending on the
20574	value of the @a id parameter) that offers several actions such
20575	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
20576	wants to retry, the notification handler should continue
20577	the machine execution using the <link to="IConsole::resume"/>
20578	call. If the machine execution is not Paused during this
20579	notification, then it means this notification is a <i>warning</i>
20580	(for example, about a fatal condition that can happen very soon);
20581	no immediate action is required from the user, the machine
20582	continues its normal execution.
20583
20584	Note that in either case the notification handler
20585	<b>must not</b> perform any action directly on a thread
20586	where this notification is called. Everything it is allowed to
20587	do is to post a message to another thread that will then talk
20588	to the user and take the corresponding action.
20589
20590	Currently, the following error identifiers are known:
20591	<ul>
20592	<li><tt>"HostMemoryLow"</tt></li>
20593	<li><tt>"HostAudioNotResponding"</tt></li>
20594	<li><tt>"VDIStorageFull"</tt></li>
20595	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
20596	</ul>
20597	</desc>
20598	<attribute name="fatal" type="boolean" readonly="yes">
20599	<desc>
20600	Whether the error is fatal or not.
20601	</desc>
20602	</attribute>
20603	<attribute name="id" type="wstring" readonly="yes">
20604	<desc>
20605	Error identifier.
20606	</desc>
20607	</attribute>
20608	<attribute name="message" type="wstring" readonly="yes">
20609	<desc>
20610	Optional error message.
20611	</desc>
20612	</attribute>
20613	</interface>
20614
20615
20616	<interface
20617	name="IEventSourceChangedEvent" extends="IEvent"
20618	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
20619	waitable="yes"
20620	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
20621	>
20622	<desc>
20623	Notification when an event source state changes (listener added or removed).
20624	</desc>
20625
20626	<attribute name="listener" type="IEventListener" readonly="yes">
20627	<desc>
20628	Event listener which has changed.
20629	</desc>
20630	</attribute>
20631
20632	<attribute name="add" type="boolean" readonly="yes">
20633	<desc>
20634	Flag whether listener was added or removed.
20635	</desc>
20636	</attribute>
20637	</interface>
20638
20639	<interface
20640	name="IExtraDataChangedEvent" extends="IEvent"
20641	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
20642	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
20643	>
20644	<desc>
20645	Notification when machine specific or global extra data
20646	has changed.
20647	</desc>
20648	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20649	<desc>
20650	ID of the machine this event relates to.
20651	Null for global extra data changes.
20652	</desc>
20653	</attribute>
20654	<attribute name="key" type="wstring" readonly="yes">
20655	<desc>
20656	Extra data key that has changed.
20657	</desc>
20658	</attribute>
20659	<attribute name="value" type="wstring" readonly="yes">
20660	<desc>
20661	Extra data value for the given key.
20662	</desc>
20663	</attribute>
20664	</interface>
20665
20666	<interface
20667	name="IVetoEvent" extends="IEvent"
20668	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
20669	wsmap="managed"
20670	>
20671	<desc>Base abstract interface for veto events.</desc>
20672
20673	<method name="addVeto">
20674	<desc>
20675	Adds a veto on this event.
20676	</desc>
20677	<param name="reason" type="wstring" dir="in">
20678	<desc>
20679	Reason for veto, could be null or empty string.
20680	</desc>
20681	</param>
20682	</method>
20683
20684	<method name="isVetoed">
20685	<desc>
20686	If this event was vetoed.
20687	</desc>
20688	<param name="result" type="boolean" dir="return">
20689	<desc>
20690	Reason for veto.
20691	</desc>
20692	</param>
20693	</method>
20694
20695	<method name="getVetos">
20696	<desc>
20697	Current veto reason list, if size is 0 - no veto.
20698	</desc>
20699	<param name="result" type="wstring" dir="return" safearray="yes">
20700	<desc>
20701	Array of reasons for veto provided by different event handlers.
20702	</desc>
20703	</param>
20704	</method>
20705
20706	</interface>
20707
20708	<interface
20709	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
20710	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
20711	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
20712	waitable="true"
20713	>
20714	<desc>
20715	Notification when someone tries to change extra data for
20716	either the given machine or (if @c null) global extra data.
20717	This gives the chance to veto against changes.
20718	</desc>
20719	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20720	<desc>
20721	ID of the machine this event relates to.
20722	Null for global extra data changes.
20723	</desc>
20724	</attribute>
20725	<attribute name="key" type="wstring" readonly="yes">
20726	<desc>
20727	Extra data key that has changed.
20728	</desc>
20729	</attribute>
20730	<attribute name="value" type="wstring" readonly="yes">
20731	<desc>
20732	Extra data value for the given key.
20733	</desc>
20734	</attribute>
20735	</interface>
20736
20737	<interface
20738	name="ICanShowWindowEvent" extends="IVetoEvent"
20739	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
20740	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
20741	waitable="true"
20742	>
20743	<desc>
20744	Notification when a call to
20745	<link to="IMachine::canShowConsoleWindow"/> is made by a
20746	front-end to check if a subsequent call to
20747	<link to="IMachine::showConsoleWindow"/> can succeed.
20748
20749	The callee should give an answer appropriate to the current
20750	machine state using event veto. This answer must
20751	remain valid at least until the next
20752	<link to="IConsole::state">machine state</link> change.
20753	</desc>
20754	</interface>
20755
20756	<interface
20757	name="IShowWindowEvent" extends="IEvent"
20758	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
20759	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
20760	waitable="true"
20761	>
20762	<desc>
20763	Notification when a call to
20764	<link to="IMachine::showConsoleWindow"/>
20765	requests the console window to be activated and brought to
20766	foreground on the desktop of the host PC.
20767
20768	This notification should cause the VM console process to
20769	perform the requested action as described above. If it is
20770	impossible to do it at a time of this notification, this
20771	method should return a failure.
20772
20773	Note that many modern window managers on many platforms
20774	implement some sort of focus stealing prevention logic, so
20775	that it may be impossible to activate a window without the
20776	help of the currently active application (which is supposedly
20777	an initiator of this notification). In this case, this method
20778	must return a non-zero identifier that represents the
20779	top-level window of the VM console process. The caller, if it
20780	represents a currently active process, is responsible to use
20781	this identifier (in a platform-dependent manner) to perform
20782	actual window activation.
20783
20784	This method must set @a winId to zero if it has performed all
20785	actions necessary to complete the request and the console
20786	window is now active and in foreground, to indicate that no
20787	further action is required on the caller's side.
20788	</desc>
20789	<attribute name="winId" type="long long">
20790	<desc>
20791	Platform-dependent identifier of the top-level VM console
20792	window, or zero if this method has performed all actions
20793	necessary to implement the <i>show window</i> semantics for
20794	the given platform and/or this VirtualBox front-end.
20795	</desc>
20796	</attribute>
20797	</interface>
20798
20799	<interface
20800	name="INATRedirectEvent" extends="IMachineEvent"
20801	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
20802	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
20803	>
20804	<desc>
20805	Notification when NAT redirect rule added or removed.
20806	</desc>
20807	<attribute name="slot" type="unsigned long" readonly="yes">
20808	<desc>
20809	Adapter which NAT attached to.
20810	</desc>
20811	</attribute>
20812	<attribute name="remove" type="boolean" readonly="yes">
20813	<desc>
20814	Whether rule remove or add.
20815	</desc>
20816	</attribute>
20817	<attribute name="name" type="wstring" readonly="yes">
20818	<desc>
20819	Name of the rule.
20820	</desc>
20821	</attribute>
20822	<attribute name="proto" type="NATProtocol" readonly="yes">
20823	<desc>
20824	Protocol (TCP or UDP) of the redirect rule.
20825	</desc>
20826	</attribute>
20827	<attribute name="hostIP" type="wstring" readonly="yes">
20828	<desc>
20829	Host ip address to bind socket on.
20830	</desc>
20831	</attribute>
20832	<attribute name="hostPort" type="long" readonly="yes">
20833	<desc>
20834	Host port to bind socket on.
20835	</desc>
20836	</attribute>
20837	<attribute name="guestIP" type="wstring" readonly="yes">
20838	<desc>
20839	Guest ip address to redirect to.
20840	</desc>
20841	</attribute>
20842	<attribute name="guestPort" type="long" readonly="yes">
20843	<desc>
20844	Guest port to redirect to.
20845	</desc>
20846	</attribute>
20847	</interface>
20848
20849	<interface
20850	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
20851	waitable="yes"
20852	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
20853	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
20854	>
20855	<desc>
20856	Notification when host PCI device is plugged/unplugged. Plugging
20857	usually takes place on VM startup, unplug - when
20858	<link to="IMachine::detachHostPCIDevice"/> is called.
20859
20860	<see><link to="IMachine::detachHostPCIDevice"/></see>
20861
20862	</desc>
20863
20864	<attribute name="plugged" type="boolean" readonly="yes">
20865	<desc>
20866	If device successfully plugged or unplugged.
20867	</desc>
20868	</attribute>
20869
20870	<attribute name="success" type="boolean" readonly="yes">
20871	<desc>
20872	If operation was successful, if false - 'message' attribute
20873	may be of interest.
20874	</desc>
20875	</attribute>
20876
20877	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
20878	<desc>
20879	Attachment info for this device.
20880	</desc>
20881	</attribute>
20882
20883	<attribute name="message" type="wstring" readonly="yes">
20884	<desc>
20885	Optional error message.
20886	</desc>
20887	</attribute>
20888
20889	</interface>
20890
20891	<interface
20892	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
20893	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
20894	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
20895	>
20896	<desc>
20897	Notification when VBoxSVC becomes unavailable (due to a crash or similar
20898	unexpected circumstances) or available again.
20899	</desc>
20900
20901	<attribute name="available" type="boolean" readonly="yes">
20902	<desc>
20903	Whether VBoxSVC is available now.
20904	</desc>
20905	</attribute>
20906	</interface>
20907
20908	<interface
20909	name="IBandwidthGroupChangedEvent" extends="IEvent"
20910	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
20911	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
20912	>
20913	<desc>
20914	Notification when one of the bandwidth groups changed
20915	</desc>
20916	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
20917	<desc>
20918	The changed bandwidth group.
20919	</desc>
20920	</attribute>
20921	</interface>
20922
20923	<enum
20924	name="GuestMonitorChangedEventType"
20925	uuid="ef172985-7e36-4297-95be-e46396968d66"
20926	>
20927
20928	<desc>
20929	How the guest monitor has been changed.
20930	</desc>
20931
20932	<const name="Enabled" value="0">
20933	<desc>
20934	The guest monitor has been enabled by the guest.
20935	</desc>
20936	</const>
20937
20938	<const name="Disabled" value="1">
20939	<desc>
20940	The guest monitor has been disabled by the guest.
20941	</desc>
20942	</const>
20943
20944	<const name="NewOrigin" value="2">
20945	<desc>
20946	The guest monitor origin has changed in the guest.
20947	</desc>
20948	</const>
20949	</enum>
20950
20951	<interface
20952	name="IGuestMonitorChangedEvent" extends="IEvent"
20953	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
20954	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
20955	>
20956	<desc>
20957	Notification when the guest enables one of its monitors.
20958	</desc>
20959
20960	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
20961	<desc>
20962	What was changed for this guest monitor.
20963	</desc>
20964	</attribute>
20965
20966	<attribute name="screenId" type="unsigned long" readonly="yes">
20967	<desc>
20968	The monitor which was changed.
20969	</desc>
20970	</attribute>
20971
20972	<attribute name="originX" type="unsigned long" readonly="yes">
20973	<desc>
20974	Physical X origin relative to the primary screen.
20975	Valid for Enabled and NewOrigin.
20976	</desc>
20977	</attribute>
20978
20979	<attribute name="originY" type="unsigned long" readonly="yes">
20980	<desc>
20981	Physical Y origin relative to the primary screen.
20982	Valid for Enabled and NewOrigin.
20983	</desc>
20984	</attribute>
20985
20986	<attribute name="width" type="unsigned long" readonly="yes">
20987	<desc>
20988	Width of the screen.
20989	Valid for Enabled.
20990	</desc>
20991	</attribute>
20992
20993	<attribute name="height" type="unsigned long" readonly="yes">
20994	<desc>
20995	Height of the screen.
20996	Valid for Enabled.
20997	</desc>
20998	</attribute>
20999
21000	</interface>
21001
21002	<interface
21003	name="IStorageDeviceChangedEvent" extends="IEvent"
21004	uuid="232e9151-ae84-4b8e-b0f3-5c20c35caac9"
21005	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
21006	>
21007	<desc>
21008	Notification when a
21009	<link to="IMachine::mediumAttachments">storage device</link>
21010	is attached or removed.
21011	</desc>
21012	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
21013	<desc>
21014	Storage device that is subject to change.
21015	</desc>
21016	</attribute>
21017	<attribute name="removed" type="boolean" readonly="yes">
21018	<desc>
21019	Flag whether the device was removed or added to the VM.
21020	</desc>
21021	</attribute>
21022	<attribute name="silent" type="boolean" readonly="yes">
21023	<desc>
21024	Flag whether the guest should be notified about the change.
21025	</desc>
21026	</attribute>
21027	</interface>
21028	<interface
21029	name="INATNetworkChangedEvent" extends="IEvent"
21030	uuid="101ae042-1a29-4a19-92cf-02285773f3b5"
21031	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkChanged"
21032	>
21033	<!-- network name is common setting for all event types -->
21034	<attribute name="networkName" type="wstring" readonly="yes"/>
21035	</interface>
21036	<!-- base class for start/stop events -->
21037	<interface name="INATNetworkStartStopEvent" extends="INATNetworkChangedEvent"
21038	uuid="269d8f6b-fa1e-4cee-91c7-6d8496bea3c1"
21039	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkStartStop">
21040	<attribute name="startEvent" type="boolean" readonly="yes">
21041	<desc>
21042	IsStartEvent is true when NAT network is started and false on stopping.
21043	</desc>
21044	</attribute>
21045	</interface>
21046
21047	<!-- base class for modification events -->
21048	<interface name="INATNetworkAlterEvent" extends="INATNetworkChangedEvent"
21049	uuid="3f5a0822-163a-43b1-ad16-8d58b0ef6e75"
21050	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkAlter"/>
21051
21052	<interface name="INATNetworkCreationDeletionEvent" extends="INATNetworkAlterEvent"
21053	uuid="8d984a7e-b855-40b8-ab0c-44d3515b4528"
21054	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkCreationDeletion">
21055	<attribute name="creationEvent" type="boolean" readonly="yes"/>
21056	</interface>
21057	<interface name="INATNetworkSettingEvent" extends="INATNetworkAlterEvent"
21058	uuid="9db3a9e6-7f29-4aae-a627-5a282c83092c"
21059	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkSetting">
21060	<attribute name="enabled" type="boolean" readonly="yes"/>
21061	<attribute name="network" type="wstring" readonly="yes"/>
21062	<attribute name="gateway" type="wstring" readonly="yes"/>
21063	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean" readonly="yes"/>
21064	<attribute name="needDhcpServer" type="boolean" readonly="yes"/>
21065	</interface>
21066	<interface name="INATNetworkPortForwardEvent" extends="INATNetworkAlterEvent"
21067	uuid="2514881b-23d0-430a-a7ff-7ed7f05534bc"
21068	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkPortForward">
21069	<attribute name="create" type="boolean" readonly="yes"/>
21070	<attribute name="ipv6" type="boolean" readonly="yes"/>
21071	<attribute name="name" type="wstring" readonly="yes"/>
21072	<attribute name="proto" type="NATProtocol" readonly="yes"/>
21073	<attribute name="hostIp" type="wstring" readonly="yes"/>
21074	<attribute name="hostPort" type="long" readonly="yes"/>
21075	<attribute name="guestIp" type="wstring" readonly="yes"/>
21076	<attribute name="guestPort" type="long" readonly="yes"/>
21077	</interface>
21078
21079	<module name="VBoxSVC" context="LocalServer">
21080	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
21081	namespace="virtualbox.org">
21082	<interface name="IVirtualBox" default="yes"/>
21083	</class>
21084	</module>
21085
21086	<module name="VBoxC" context="InprocServer" threadingModel="Free">
21087	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
21088	namespace="virtualbox.org">
21089	<interface name="IVirtualBoxClient" default="yes"/>
21090	</class>
21091
21092	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
21093	namespace="virtualbox.org">
21094	<interface name="ISession" default="yes"/>
21095	</class>
21096	</module>
21097
21098	</library>
21099
21100	</idl>
21101
21102	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format