VirtualBox.xidl@ 45805

Last change on this file since 45805 was 45805, checked in by vboxsync, 12 years ago
Main: Removed IGuestErrorInfo, added new attribute resultDetail to IVirtualBoxErrorInfo for (optionally) providing more details on the error happened.
Property svn:eol-style set to `native`
File size: 756.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="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
953	>
954	<desc>
955	Hardware virtualization property type. This enumeration represents possible values
956	for the <link to="IMachine::getHWVirtExProperty"/> and
957	<link to="IMachine::setHWVirtExProperty"/> methods.
958	</desc>
959	<const name="Null" value="0">
960	<desc>Null value (never used by the API).</desc>
961	</const>
962	<const name="Enabled" value="1">
963	<desc>
964	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
965	such extensions are not available, they will not be used.
966	</desc>
967	</const>
968	<const name="Exclusive" value="2">
969	<desc>
970	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
971	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
972	feature of the host. To share these with other hypervisors, you must disable this property.
973	</desc>
974	</const>
975	<const name="VPID" value="3">
976	<desc>
977	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
978	</desc>
979	</const>
980	<const name="NestedPaging" value="4">
981	<desc>
982	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
983	</desc>
984	</const>
985	<const name="LargePages" value="5">
986	<desc>
987	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
988	</desc>
989	</const>
990	<const name="Force" value="6">
991	<desc>
992	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
993	not set, there will be an automatic fallback to software virtualization.
994	</desc>
995	</const>
996	</enum>
997
998	<enum
999	name="FaultToleranceState"
1000	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
1001	>
1002	<desc>
1003	Used with <link to="IMachine::faultToleranceState" />.
1004	</desc>
1005	<const name="Inactive" value="1">
1006	<desc>No fault tolerance enabled.</desc>
1007	</const>
1008	<const name="Master" value="2">
1009	<desc>Fault tolerant master VM.</desc>
1010	</const>
1011	<const name="Standby" value="3">
1012	<desc>Fault tolerant standby VM.</desc>
1013	</const>
1014	</enum>
1015
1016	<enum
1017	name="LockType"
1018	uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
1019	>
1020	<desc>
1021	Used with <link to="IMachine::lockMachine" />.
1022	</desc>
1023	<const name="Write" value="2">
1024	<desc>Lock the machine for writing.</desc>
1025	</const>
1026	<const name="Shared" value="1">
1027	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
1028	</const>
1029	<const name="VM" value="3">
1030	<desc>Lock the machine for writing, and create objects necessary for
1031	running a VM in this process.</desc>
1032	</const>
1033	</enum>
1034
1035	<enum
1036	name="SessionType"
1037	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
1038	>
1039	<desc>
1040	Session type. This enumeration represents possible values of the
1041	<link to="ISession::type"/> attribute.
1042	</desc>
1043
1044	<const name="Null" value="0">
1045	<desc>Null value (never used by the API).</desc>
1046	</const>
1047	<const name="WriteLock" value="1">
1048	<desc>
1049	Session has acquired an exclusive write lock on a machine
1050	using <link to="IMachine::lockMachine"/>.
1051	</desc>
1052	</const>
1053	<const name="Remote" value="2">
1054	<desc>
1055	Session has launched a VM process using
1056	<link to="IMachine::launchVMProcess"/>
1057	</desc>
1058	</const>
1059	<const name="Shared" value="3">
1060	<desc>
1061	Session has obtained a link to another session using
1062	<link to="IMachine::lockMachine"/>
1063	</desc>
1064	</const>
1065	</enum>
1066
1067	<enum
1068	name="DeviceType"
1069	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1070	>
1071	<desc>
1072	Device type.
1073	</desc>
1074	<const name="Null" value="0">
1075	<desc>
1076	Null value, may also mean "no device" (not allowed for
1077	<link to="IConsole::getDeviceActivity"/>).
1078	</desc>
1079	</const>
1080	<const name="Floppy" value="1">
1081	<desc>Floppy device.</desc>
1082	</const>
1083	<const name="DVD" value="2">
1084	<desc>CD/DVD-ROM device.</desc>
1085	</const>
1086	<const name="HardDisk" value="3">
1087	<desc>Hard disk device.</desc>
1088	</const>
1089	<const name="Network" value="4">
1090	<desc>Network device.</desc>
1091	</const>
1092	<const name="USB" value="5">
1093	<desc>USB device.</desc>
1094	</const>
1095	<const name="SharedFolder" value="6">
1096	<desc>Shared folder device.</desc>
1097	</const>
1098	</enum>
1099
1100	<enum
1101	name="DeviceActivity"
1102	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1103	>
1104	<desc>
1105	Device activity for <link to="IConsole::getDeviceActivity"/>.
1106	</desc>
1107
1108	<const name="Null" value="0"/>
1109	<const name="Idle" value="1"/>
1110	<const name="Reading" value="2"/>
1111	<const name="Writing" value="3"/>
1112	</enum>
1113
1114	<enum
1115	name="ClipboardMode"
1116	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1117	>
1118	<desc>
1119	Host-Guest clipboard interchange mode.
1120	</desc>
1121
1122	<const name="Disabled" value="0"/>
1123	<const name="HostToGuest" value="1"/>
1124	<const name="GuestToHost" value="2"/>
1125	<const name="Bidirectional" value="3"/>
1126	</enum>
1127
1128	<enum
1129	name="DragAndDropMode"
1130	uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1131	>
1132	<desc>
1133	Drag'n'Drop interchange mode.
1134	</desc>
1135
1136	<const name="Disabled" value="0"/>
1137	<const name="HostToGuest" value="1"/>
1138	<const name="GuestToHost" value="2"/>
1139	<const name="Bidirectional" value="3"/>
1140	</enum>
1141
1142	<enum
1143	name="Scope"
1144	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1145	>
1146	<desc>
1147	Scope of the operation.
1148
1149	A generic enumeration used in various methods to define the action or
1150	argument scope.
1151	</desc>
1152
1153	<const name="Global" value="0"/>
1154	<const name="Machine" value="1"/>
1155	<const name="Session" value="2"/>
1156	</enum>
1157
1158	<enum
1159	name="BIOSBootMenuMode"
1160	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1161	>
1162	<desc>
1163	BIOS boot menu mode.
1164	</desc>
1165
1166	<const name="Disabled" value="0"/>
1167	<const name="MenuOnly" value="1"/>
1168	<const name="MessageAndMenu" value="2"/>
1169	</enum>
1170
1171	<enum
1172	name="ProcessorFeature"
1173	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1174	>
1175	<desc>
1176	CPU features.
1177	</desc>
1178
1179	<const name="HWVirtEx" value="0"/>
1180	<const name="PAE" value="1"/>
1181	<const name="LongMode" value="2"/>
1182	<const name="NestedPaging" value="3"/>
1183	</enum>
1184
1185	<enum
1186	name="FirmwareType"
1187	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1188	>
1189	<desc>
1190	Firmware type.
1191	</desc>
1192	<const name="BIOS" value="1">
1193	<desc>BIOS Firmware.</desc>
1194	</const>
1195	<const name="EFI" value="2">
1196	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1197	</const>
1198	<const name="EFI32" value="3">
1199	<desc>Efi firmware, 32-bit.</desc>
1200	</const>
1201	<const name="EFI64" value="4">
1202	<desc>Efi firmware, 64-bit.</desc>
1203	</const>
1204	<const name="EFIDUAL" value="5">
1205	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1206	</const>
1207	</enum>
1208
1209	<enum
1210	name="PointingHIDType"
1211	uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1212	>
1213	<desc>
1214	Type of pointing device used in a virtual machine.
1215	</desc>
1216	<const name="None" value="1">
1217	<desc>No mouse.</desc>
1218	</const>
1219	<const name="PS2Mouse" value="2">
1220	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1221	</const>
1222	<const name="USBMouse" value="3">
1223	<desc>USB mouse (relative pointer).</desc>
1224	</const>
1225	<const name="USBTablet" value="4">
1226	<desc>USB tablet (absolute pointer).</desc>
1227	</const>
1228	<const name="ComboMouse" value="5">
1229	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1230	Using of such device can have negative performance implications. </desc>
1231	</const>
1232	</enum>
1233
1234	<enum
1235	name="KeyboardHIDType"
1236	uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1237	>
1238	<desc>
1239	Type of keyboard device used in a virtual machine.
1240	</desc>
1241	<const name="None" value="1">
1242	<desc>No keyboard.</desc>
1243	</const>
1244	<const name="PS2Keyboard" value="2">
1245	<desc>PS/2 keyboard.</desc>
1246	</const>
1247	<const name="USBKeyboard" value="3">
1248	<desc>USB keyboard.</desc>
1249	</const>
1250	<const name="ComboKeyboard" value="4">
1251	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1252	Using of such device can have negative performance implications. </desc>
1253	</const>
1254	</enum>
1255
1256	<!--
1257	// IVirtualBoxErrorInfo
1258	/////////////////////////////////////////////////////////////////////////
1259	-->
1260
1261	<interface
1262	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1263	uuid="c1bcc6d5-7966-481d-ab0b-d0ed73e28135"
1264	supportsErrorInfo="no"
1265	wsmap="managed"
1266	>
1267	<desc>
1268	The IVirtualBoxErrorInfo interface represents extended error information.
1269
1270	Extended error information can be set by VirtualBox components after
1271	unsuccessful or partially successful method invocation. This information
1272	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1273	and then shown to the client in addition to the plain 32-bit result code.
1274
1275	In MS COM, this interface extends the IErrorInfo interface,
1276	in XPCOM, it extends the nsIException interface. In both cases,
1277	it provides a set of common attributes to retrieve error
1278	information.
1279
1280	Sometimes invocation of some component's method may involve methods of
1281	other components that may also fail (independently of this method's
1282	failure), or a series of non-fatal errors may precede a fatal error that
1283	causes method failure. In cases like that, it may be desirable to preserve
1284	information about all errors happened during method invocation and deliver
1285	it to the caller. The <link to="#next"/> attribute is intended
1286	specifically for this purpose and allows to represent a chain of errors
1287	through a single IVirtualBoxErrorInfo object set after method invocation.
1288
1289	<note>errors are stored to a chain in the reverse order, i.e. the
1290	initial error object you query right after method invocation is the last
1291	error set by the callee, the object it points to in the @a next attribute
1292	is the previous error and so on, up to the first error (which is the last
1293	in the chain).</note>
1294	</desc>
1295
1296	<attribute name="resultCode" type="long" readonly="yes">
1297	<desc>
1298	Result code of the error.
1299	Usually, it will be the same as the result code returned
1300	by the method that provided this error information, but not
1301	always. For example, on Win32, CoCreateInstance() will most
1302	likely return E_NOINTERFACE upon unsuccessful component
1303	instantiation attempt, but not the value the component factory
1304	returned. Value is typed 'long', not 'result',
1305	to make interface usable from scripting languages.
1306	<note>
1307	In MS COM, there is no equivalent.
1308	In XPCOM, it is the same as nsIException::result.
1309	</note>
1310	</desc>
1311	</attribute>
1312
1313	<attribute name="resultDetail" type="long" readonly="yes">
1314	<desc>
1315	Optional result data of this error. This will vary depending on the
1316	actual error usage. By default this attribute is not being used.
1317	</desc>
1318	</attribute>
1319
1320	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1321	<desc>
1322	UUID of the interface that defined the error.
1323	<note>
1324	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1325	data type.
1326	In XPCOM, there is no equivalent.
1327	</note>
1328	</desc>
1329	</attribute>
1330
1331	<attribute name="component" type="wstring" readonly="yes">
1332	<desc>
1333	Name of the component that generated the error.
1334	<note>
1335	In MS COM, it is the same as IErrorInfo::GetSource.
1336	In XPCOM, there is no equivalent.
1337	</note>
1338	</desc>
1339	</attribute>
1340
1341	<attribute name="text" type="wstring" readonly="yes">
1342	<desc>
1343	Text description of the error.
1344	<note>
1345	In MS COM, it is the same as IErrorInfo::GetDescription.
1346	In XPCOM, it is the same as nsIException::message.
1347	</note>
1348	</desc>
1349	</attribute>
1350
1351	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1352	<desc>
1353	Next error object if there is any, or @c null otherwise.
1354	<note>
1355	In MS COM, there is no equivalent.
1356	In XPCOM, it is the same as nsIException::inner.
1357	</note>
1358	</desc>
1359	</attribute>
1360
1361	</interface>
1362
1363	<!--
1364	// IVirtualBox
1365	/////////////////////////////////////////////////////////////////////////
1366	-->
1367	<!-- This is experimental interface to LWIP based NAT server -->
1368	<interface name="INATNetwork" extends="$unknown"
1369	uuid="03DFD6F7-1B78-48A3-8345-C785281E9523"
1370	wsmap="managed">
1371	<attribute name="NetworkName" type="wstring">
1372	<desc>
1373	TBD: the idea, technically we can start any number of the NAT networks,
1374	but we should expect that at some point we will get collisions because of
1375	port-forwanding rules. so perhaps we should support only single instance of NAT
1376	network.
1377	</desc>
1378	</attribute>
1379	<attribute name="enabled" type="boolean"/>
1380	<attribute name="network" type="wstring">
1381	<desc>
1382	This is CIDR IPv4 string. Specifiying it user defines IPv4 addresses
1383	of gateway (low address + 1) and dhcp server (= low address + 2).
1384	Note: if there're defined IPv4 port-forward rules update of network
1385	will be ignored (because new assignment could break existing rules).
1386	</desc>
1387	</attribute>
1388	<attribute name="gateway" type="wstring" readonly="yes">
1389	<desc>
1390	This attribute is read-only. It's recalculated on changing
1391	network attribute (low address of network + 1).
1392	</desc>
1393	</attribute>
1394	<attribute name="IPv6Enabled" type="boolean">
1395	<desc>
1396	This attribute define whether gateway will support IPv6 or not.
1397	</desc>
1398	</attribute>
1399	<attribute name="IPv6Prefix" type="wstring">
1400	<desc>
1401	This a CIDR IPv6 defining prefix for link-local addresses autoconfiguration within network. Note: ignored if attribute ipv6enabled is false.
1402	</desc>
1403	</attribute>
1404	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean"/>
1405	<attribute name="needDhcpServer" type="boolean"/>
1406	<attribute name="eventSource" type="IEventSource" readonly="yes"/>
1407	<attribute name="portForwardRules4" type="wstring" readonly="yes" safearray="yes">
1408	<desc>Array of NAT port-forwarding rules in string representation,
1409	in the following format:
1410	"name:protocolid:[host ip]:host port:[guest ip]:guest port".
1411	</desc>
1412	</attribute>
1413	<attribute name="portForwardRules6" type="wstring" readonly="yes" safearray="yes">
1414	<desc>Array of NAT port-forwarding rules in string representation, in the
1415	following format: "name:protocolid:[host ip]:host port:[guest ip]:guest port".
1416	</desc>
1417	</attribute>
1418	<method name="addPortForwardRule">
1419	<param name="isIpv6" type="boolean" dir="in"/>
1420	<param name="ruleName" type="wstring" dir="in"/>
1421	<param name="proto" type="NATProtocol" dir="in">
1422	<desc>Protocol handled with the rule.</desc>
1423	</param>
1424	<param name="hostIP" type="wstring" dir="in">
1425	<desc>IP of the host interface to which the rule should apply.
1426	An empty ip address is acceptable, in which case the NAT engine
1427	binds the handling socket to any interface.
1428	</desc>
1429	</param>
1430	<param name="hostPort" type="unsigned short" dir="in">
1431	<desc>The port number to listen on.</desc>
1432	</param>
1433	<param name="guestIP" type="wstring" dir="in">
1434	<desc>The IP address of the guest which the NAT engine will forward
1435	matching packets to. An empty IP address is not acceptable.</desc>
1436	</param>
1437	<param name="guestPort" type="unsigned short" dir="in">
1438	<desc>The port number to forward.</desc>
1439	</param>
1440	</method>
1441	<method name="removePortForwardRule">
1442	<param name="iSipv6" type="boolean" dir="in"/>
1443	<param name="ruleName" type="wstring" dir="in"/>
1444	</method>
1445	<method name="start">
1446	<param name="trunkType" type="wstring" dir="in">
1447	<desc>
1448	Type of internal network trunk.
1449	</desc>
1450	</param>
1451	</method>
1452	<method name="stop"/>
1453	</interface>
1454
1455	<interface
1456	name="IDHCPServer" extends="$unknown"
1457	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1458	wsmap="managed"
1459	>
1460	<desc>
1461	The IDHCPServer interface represents the vbox DHCP server configuration.
1462
1463	To enumerate all the DHCP servers on the host, use the
1464	<link to="IVirtualBox::DHCPServers"/> attribute.
1465	</desc>
1466
1467	<attribute name="enabled" type="boolean">
1468	<desc>
1469	specifies if the DHCP server is enabled
1470	</desc>
1471	</attribute>
1472
1473	<attribute name="IPAddress" type="wstring" readonly="yes">
1474	<desc>
1475	specifies server IP
1476	</desc>
1477	</attribute>
1478
1479	<attribute name="networkMask" type="wstring" readonly="yes">
1480	<desc>
1481	specifies server network mask
1482	</desc>
1483	</attribute>
1484
1485	<attribute name="networkName" type="wstring" readonly="yes">
1486	<desc>
1487	specifies internal network name the server is used for
1488	</desc>
1489	</attribute>
1490
1491	<attribute name="lowerIP" type="wstring" readonly="yes">
1492	<desc>
1493	specifies from IP address in server address range
1494	</desc>
1495	</attribute>
1496
1497	<attribute name="upperIP" type="wstring" readonly="yes">
1498	<desc>
1499	specifies to IP address in server address range
1500	</desc>
1501	</attribute>
1502
1503	<method name="setConfiguration">
1504	<desc>
1505	configures the server
1506	<result name="E_INVALIDARG">
1507	invalid configuration supplied
1508	</result>
1509	</desc>
1510	<param name="IPAddress" type="wstring" dir="in">
1511	<desc>
1512	server IP address
1513	</desc>
1514	</param>
1515	<param name="networkMask" type="wstring" dir="in">
1516	<desc>
1517	server network mask
1518	</desc>
1519	</param>
1520	<param name="FromIPAddress" type="wstring" dir="in">
1521	<desc>
1522	server From IP address for address range
1523	</desc>
1524	</param>
1525	<param name="ToIPAddress" type="wstring" dir="in">
1526	<desc>
1527	server To IP address for address range
1528	</desc>
1529	</param>
1530	</method>
1531
1532	<method name="start">
1533	<desc>
1534	Starts DHCP server process.
1535	<result name="E_FAIL">
1536	Failed to start the process.
1537	</result>
1538	</desc>
1539	<param name="networkName" type="wstring" dir="in">
1540	<desc>
1541	Name of internal network DHCP server should attach to.
1542	</desc>
1543	</param>
1544	<param name="trunkName" type="wstring" dir="in">
1545	<desc>
1546	Name of internal network trunk.
1547	</desc>
1548	</param>
1549	<param name="trunkType" type="wstring" dir="in">
1550	<desc>
1551	Type of internal network trunk.
1552	</desc>
1553	</param>
1554	</method>
1555
1556	<method name="stop">
1557	<desc>
1558	Stops DHCP server process.
1559	<result name="E_FAIL">
1560	Failed to stop the process.
1561	</result>
1562	</desc>
1563	</method>
1564	</interface>
1565
1566	<interface
1567	name="IVirtualBox" extends="$unknown"
1568	uuid="fafa4e17-1ee2-4905-a10e-fe7c18bf5554"
1569	wsmap="managed"
1570	>
1571	<desc>
1572	The IVirtualBox interface represents the main interface exposed by the
1573	product that provides virtual machine management.
1574
1575	An instance of IVirtualBox is required for the product to do anything
1576	useful. Even though the interface does not expose this, internally,
1577	IVirtualBox is implemented as a singleton and actually lives in the
1578	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1579	IVirtualBox can track the state of all virtual machines on a particular
1580	host, regardless of which frontend started them.
1581
1582	To enumerate all the virtual machines on the host, use the
1583	<link to="IVirtualBox::machines"/> attribute.
1584	</desc>
1585
1586	<attribute name="version" type="wstring" readonly="yes">
1587	<desc>
1588	A string representing the version number of the product. The
1589	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1590	last number represents the build number and will frequently change.
1591
1592	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1593	in prerelease builds. Non-Oracle builds may (/shall) also have a
1594	publisher tag, at the end. The publisher tag starts with an underscore
1595	just like the prerelease build type tag.
1596	</desc>
1597	</attribute>
1598
1599	<attribute name="versionNormalized" type="wstring" readonly="yes">
1600	<desc>
1601	A string representing the version number of the product,
1602	without the publisher information (but still with other tags).
1603	See <link to="#version" />.
1604	</desc>
1605	</attribute>
1606
1607	<attribute name="revision" type="unsigned long" readonly="yes">
1608	<desc>
1609	The internal build revision number of the product.
1610	</desc>
1611	</attribute>
1612
1613	<attribute name="packageType" type="wstring" readonly="yes">
1614	<desc>
1615	A string representing the package type of this product. The
1616	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1617	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1618	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1619	this.
1620	</desc>
1621	</attribute>
1622
1623	<attribute name="APIVersion" type="wstring" readonly="yes">
1624	<desc>
1625	A string representing the VirtualBox API version number. The format is
1626	2 integer numbers divided by an underscore (e.g. 1_0). After the
1627	first public release of packages with a particular API version the
1628	API will not be changed in an incompatible way. Note that this
1629	guarantee does not apply to development builds, and also there is no
1630	guarantee that this version is identical to the first two integer
1631	numbers of the package version.
1632	</desc>
1633	</attribute>
1634
1635	<attribute name="homeFolder" type="wstring" readonly="yes">
1636	<desc>
1637	Full path to the directory where the global settings file,
1638	<tt>VirtualBox.xml</tt>, is stored.
1639
1640	In this version of VirtualBox, the value of this property is
1641	always <tt><user_dir>/.VirtualBox</tt> (where
1642	<tt><user_dir></tt> is the path to the user directory,
1643	as determined by the host OS), and cannot be changed.
1644
1645	This path is also used as the base to resolve relative paths in
1646	places where relative paths are allowed (unless otherwise
1647	expressly indicated).
1648	</desc>
1649	</attribute>
1650
1651	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1652	<desc>
1653	Full name of the global settings file.
1654	The value of this property corresponds to the value of
1655	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1656	</desc>
1657	</attribute>
1658
1659	<attribute name="host" type="IHost" readonly="yes">
1660	<desc>Associated host object.</desc>
1661	</attribute>
1662
1663	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1664	<desc>Associated system information object.</desc>
1665	</attribute>
1666
1667	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1668	<desc>
1669	Array of machine objects registered within this VirtualBox instance.
1670	</desc>
1671	</attribute>
1672
1673	<attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1674	<desc>
1675	Array of all machine group names which are used by the machines which
1676	are accessible. Each group is only listed once, however they are listed
1677	in no particular order and there is no guarantee that there are no gaps
1678	in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1679	is a valid result).
1680	</desc>
1681	</attribute>
1682
1683	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1684	<desc>
1685	Array of medium objects known to this VirtualBox installation.
1686
1687	This array contains only base media. All differencing
1688	media of the given base medium can be enumerated using
1689	<link to="IMedium::children"/>.
1690	</desc>
1691	</attribute>
1692
1693	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1694	<desc>
1695	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1696	</desc>
1697	</attribute>
1698
1699	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1700	<desc>
1701	Array of floppy image objects currently in use by this VirtualBox instance.
1702	</desc>
1703	</attribute>
1704
1705	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1706
1707	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1708
1709	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1710	<desc>
1711	Collection of global shared folders. Global shared folders are
1712	available to all virtual machines.
1713
1714	New shared folders are added to the collection using
1715	<link to="#createSharedFolder"/>. Existing shared folders can be
1716	removed using <link to="#removeSharedFolder"/>.
1717
1718	<note>
1719	In the current version of the product, global shared folders are not
1720	implemented and therefore this collection is always empty.
1721	</note>
1722	</desc>
1723	</attribute>
1724
1725	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1726	<desc>
1727	Associated performance collector object.
1728	</desc>
1729	</attribute>
1730
1731	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1732	<desc>
1733	DHCP servers.
1734	</desc>
1735	</attribute>
1736	<!-- Array of NAT networks -->
1737	<attribute name="NATNetworks" type="INATNetwork" safearray="yes" readonly="yes"/>
1738
1739	<attribute name="eventSource" type="IEventSource" readonly="yes">
1740	<desc>
1741	Event source for VirtualBox events.
1742	</desc>
1743	</attribute>
1744
1745	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1746	<desc>
1747	The extension pack manager.
1748	</desc>
1749	</attribute>
1750
1751
1752	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1753	<desc>
1754	Names of all internal networks.
1755	</desc>
1756	</attribute>
1757
1758	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1759	<desc>
1760	Names of all generic network drivers.
1761	</desc>
1762	</attribute>
1763
1764	<method name="composeMachineFilename">
1765	<desc>
1766	Returns a recommended full path of the settings file name for a new virtual
1767	machine.
1768
1769	This API serves two purposes:
1770
1771	<ul>
1772	<li>It gets called by <link to="#createMachine" /> if @c null or
1773	empty string (which is recommended) is specified for the
1774	@a settingsFile argument there, which means that API should use
1775	a recommended default file name.</li>
1776
1777	<li>It can be called manually by a client software before creating a machine,
1778	e.g. if that client wants to pre-create the machine directory to create
1779	virtual hard disks in that directory together with the new machine
1780	settings file. In that case, the file name should be stripped from the
1781	full settings file path returned by this function to obtain the
1782	machine directory.</li>
1783	</ul>
1784
1785	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1786	details about the machine name.
1787
1788	@a groupName defines which additional subdirectory levels should be
1789	included. It must be either a valid group name or @c null or empty
1790	string which designates that the machine will not be related to a
1791	machine group.
1792
1793	If @a baseFolder is a @c null or empty string (which is recommended), the
1794	default machine settings folder
1795	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1796	a base folder for the created machine, resulting in a file name like
1797	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1798	will be used.
1799
1800	This method does not access the host disks. In particular, it does not check
1801	for whether a machine with this name already exists.
1802	</desc>
1803	<param name="name" type="wstring" dir="in">
1804	<desc>Suggested machine name.</desc>
1805	</param>
1806	<param name="group" type="wstring" dir="in">
1807	<desc>Machine group name for the new machine or machine group. It is
1808	used to determine the right subdirectory.</desc>
1809	</param>
1810	<param name="createFlags" type="wstring" dir="in">
1811	<desc>Machine creation flags, see <link to="#createMachine" /> (optional).</desc>
1812	</param>
1813	<param name="baseFolder" type="wstring" dir="in">
1814	<desc>Base machine folder (optional).</desc>
1815	</param>
1816	<param name="file" type="wstring" dir="return">
1817	<desc>Fully qualified path where the machine would be created.</desc>
1818	</param>
1819	</method>
1820
1821	<method name="createMachine">
1822	<desc>
1823	Creates a new virtual machine by creating a machine settings file at
1824	the given location.
1825
1826	VirtualBox machine settings files use a custom XML dialect. Starting
1827	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1828	and machine files can be created at arbitrary locations.
1829
1830	However, it is recommended that machines are created in the default
1831	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1832	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1833	@c null or empty string (which is recommended) for the @a settingsFile
1834	argument, <link to="#composeMachineFilename" /> is called automatically
1835	to have such a recommended name composed based on the machine name
1836	given in the @a name argument and the primary group.
1837
1838	If the resulting settings file already exists, this method will fail,
1839	unless the forceOverwrite flag is set.
1840
1841	The new machine is created unregistered, with the initial configuration
1842	set according to the specified guest OS type. A typical sequence of
1843	actions to create a new virtual machine is as follows:
1844
1845	<ol>
1846	<li>
1847	Call this method to have a new machine created. The returned machine
1848	object will be "mutable" allowing to change any machine property.
1849	</li>
1850
1851	<li>
1852	Configure the machine using the appropriate attributes and methods.
1853	</li>
1854
1855	<li>
1856	Call <link to="IMachine::saveSettings" /> to write the settings
1857	to the machine's XML settings file. The configuration of the newly
1858	created machine will not be saved to disk until this method is
1859	called.
1860	</li>
1861
1862	<li>
1863	Call <link to="#registerMachine" /> to add the machine to the list
1864	of machines known to VirtualBox.
1865	</li>
1866	</ol>
1867
1868	The specified guest OS type identifier must match an ID of one of known
1869	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1870	array.
1871
1872	<note>
1873	There is no way to change the name of the settings file or
1874	subfolder of the created machine directly.
1875	</note>
1876
1877	<result name="VBOX_E_OBJECT_NOT_FOUND">
1878	@a osTypeId is invalid.
1879	</result>
1880	<result name="VBOX_E_FILE_ERROR">
1881	Resulting settings file name is invalid or the settings file already
1882	exists or could not be created due to an I/O error.
1883	</result>
1884	<result name="E_INVALIDARG">
1885	@a name is empty or @c null.
1886	</result>
1887	</desc>
1888
1889	<param name="settingsFile" type="wstring" dir="in">
1890	<desc>Fully qualified path where the settings file should be created,
1891	empty string or @c null for a default folder and file based on the
1892	@a name argument and the primary group.
1893	(see <link to="#composeMachineFilename" />).</desc>
1894	</param>
1895	<param name="name" type="wstring" dir="in">
1896	<desc>Machine name.</desc>
1897	</param>
1898	<param name="groups" type="wstring" safearray="yes" dir="in">
1899	<desc>Array of group names. @c null or an empty array have the same
1900	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1901	create a machine without group association.</desc>
1902	</param>
1903	<param name="osTypeId" type="wstring" dir="in">
1904	<desc>Guest OS Type ID.</desc>
1905	</param>
1906	<param name="flags" type="wstring" dir="in">
1907	<desc>
1908	Additional property parameters, passed as a comma-separated list of
1909	"name=value" type entries. The following ones are recognized:
1910	<tt>forceOverwrite=1</tt> to overwrite an existing machine settings
1911	file, <tt>UUID=<uuid></tt> to specify a machine UUID and
1912	<tt>directoryIncludesUUID=1</tt> to switch to a special VM directory
1913	naming scheme which should not be used unless necessary.
1914	</desc>
1915	</param>
1916	<param name="machine" type="IMachine" dir="return">
1917	<desc>Created machine object.</desc>
1918	</param>
1919	</method>
1920
1921	<method name="openMachine">
1922	<desc>
1923	Opens a virtual machine from the existing settings file.
1924	The opened machine remains unregistered until you call
1925	<link to="#registerMachine"/>.
1926
1927	The specified settings file name must be fully qualified.
1928	The file must exist and be a valid machine XML settings file
1929	whose contents will be used to construct the machine object.
1930
1931	<result name="VBOX_E_FILE_ERROR">
1932	Settings file name invalid, not found or sharing violation.
1933	</result>
1934	</desc>
1935	<param name="settingsFile" type="wstring" dir="in">
1936	<desc>
1937	Name of the machine settings file.
1938	</desc>
1939	</param>
1940	<param name="machine" type="IMachine" dir="return">
1941	<desc>Opened machine object.</desc>
1942	</param>
1943	<note>
1944	<link to="IMachine::settingsModified"/> will return
1945	@c false for the created machine, until any of machine settings
1946	are changed.
1947	</note>
1948	</method>
1949
1950	<method name="registerMachine">
1951	<desc>
1952
1953	Registers the machine previously created using
1954	<link to="#createMachine"/> or opened using
1955	<link to="#openMachine"/> within this VirtualBox installation. After
1956	successful method invocation, the
1957	<link to="IMachineRegisteredEvent"/> event is fired.
1958
1959	<note>
1960	This method implicitly calls <link to="IMachine::saveSettings"/>
1961	to save all current machine settings before registering it.
1962	</note>
1963
1964	<result name="VBOX_E_OBJECT_NOT_FOUND">
1965	No matching virtual machine found.
1966	</result>
1967	<result name="VBOX_E_INVALID_OBJECT_STATE">
1968	Virtual machine was not created within this VirtualBox instance.
1969	</result>
1970
1971	</desc>
1972	<param name="machine" type="IMachine" dir="in"/>
1973	</method>
1974
1975	<method name="findMachine">
1976	<desc>
1977	Attempts to find a virtual machine given its name or UUID.
1978
1979	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1980	cannot safely be determined.</note>
1981
1982	<result name="VBOX_E_OBJECT_NOT_FOUND">
1983	Could not find registered machine matching @a nameOrId.
1984	</result>
1985
1986	</desc>
1987	<param name="nameOrId" type="wstring" dir="in">
1988	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1989	</param>
1990	<param name="machine" type="IMachine" dir="return">
1991	<desc>Machine object, if found.</desc>
1992	</param>
1993	</method>
1994
1995	<method name="getMachinesByGroups">
1996	<desc>
1997	Gets all machine references which are in one of the specified groups.
1998	</desc>
1999	<param name="groups" type="wstring" dir="in" safearray="yes">
2000	<desc>What groups to match. The usual group list rules apply, i.e.
2001	passing an empty list will match VMs in the toplevel group, likewise
2002	the empty string.</desc>
2003	</param>
2004	<param name="machines" type="IMachine" dir="return" safearray="yes">
2005	<desc>All machines which matched.</desc>
2006	</param>
2007	</method>
2008
2009	<method name="getMachineStates">
2010	<desc>
2011	Gets the state of several machines in a single operation.
2012	</desc>
2013	<param name="machines" type="IMachine" dir="in" safearray="yes">
2014	<desc>Array with the machine references.</desc>
2015	</param>
2016	<param name="states" type="MachineState" dir="return" safearray="yes">
2017	<desc>Machine states, corresponding to the machines.</desc>
2018	</param>
2019	</method>
2020
2021	<method name="createAppliance">
2022	<desc>
2023	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
2024	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
2025	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
2026	</desc>
2027	<param name="appliance" type="IAppliance" dir="return">
2028	<desc>New appliance.</desc>
2029	</param>
2030	</method>
2031
2032	<method name="createHardDisk">
2033	<desc>
2034	Creates a new base medium object that will use the given storage
2035	format and location for medium data.
2036
2037	The actual storage unit is not created by this method. In order to
2038	do it, and before you are able to attach the created medium to
2039	virtual machines, you must call one of the following methods to
2040	allocate a format-specific storage unit at the specified location:
2041	<ul>
2042	<li><link to="IMedium::createBaseStorage"/></li>
2043	<li><link to="IMedium::createDiffStorage"/></li>
2044	</ul>
2045
2046	Some medium attributes, such as <link to="IMedium::id"/>, may
2047	remain uninitialized until the medium storage unit is successfully
2048	created by one of the above methods.
2049
2050	After the storage unit is successfully created, it will be
2051	accessible through the <link to="#openMedium"/> method and can
2052	be found in the <link to="#hardDisks"/> array.
2053
2054	The list of all storage formats supported by this VirtualBox
2055	installation can be obtained using
2056	<link to="ISystemProperties::mediumFormats"/>. If the @a format
2057	attribute is empty or @c null then the default storage format
2058	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
2059	be used for creating a storage unit of the medium.
2060
2061	Note that the format of the location string is storage format specific.
2062	See <link to="IMedium::location"/> and IMedium for more details.
2063
2064	<result name="VBOX_E_OBJECT_NOT_FOUND">
2065	@a format identifier is invalid. See
2066	<link to="ISystemProperties::mediumFormats"/>.
2067	</result>
2068	<result name="VBOX_E_FILE_ERROR">
2069	@a location is a not valid file name (for file-based formats only).
2070	</result>
2071	</desc>
2072	<param name="format" type="wstring" dir="in">
2073	<desc>
2074	Identifier of the storage format to use for the new medium.
2075	</desc>
2076	</param>
2077	<param name="location" type="wstring" dir="in">
2078	<desc>
2079	Location of the storage unit for the new medium.
2080	</desc>
2081	</param>
2082	<param name="medium" type="IMedium" dir="return">
2083	<desc>Created medium object.</desc>
2084	</param>
2085	</method>
2086
2087	<method name="openMedium">
2088	<desc>
2089	Finds existing media or opens a medium from an existing storage location.
2090
2091	Once a medium has been opened, it can be passed to other VirtualBox
2092	methods, in particular to <link to="IMachine::attachDevice" />.
2093
2094	Depending on the given device type, the file at the storage location
2095	must be in one of the media formats understood by VirtualBox:
2096
2097	<ul>
2098	<li>With a "HardDisk" device type, the file must be a hard disk image
2099	in one of the formats supported by VirtualBox (see
2100	<link to="ISystemProperties::mediumFormats" />).
2101	After this method succeeds, if the medium is a base medium, it
2102	will be added to the <link to="#hardDisks"/> array attribute. </li>
2103	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
2104	After this method succeeds, the medium will be added to the
2105	<link to="#DVDImages"/> array attribute.</li>
2106	<li>With a "Floppy" device type, the file must be an RAW floppy image.
2107	After this method succeeds, the medium will be added to the
2108	<link to="#floppyImages"/> array attribute.</li>
2109	</ul>
2110
2111	After having been opened, the medium can be re-found by this method
2112	and can be attached to virtual machines. See <link to="IMedium" /> for
2113	more details.
2114
2115	The UUID of the newly opened medium will either be retrieved from the
2116	storage location, if the format supports it (e.g. for hard disk images),
2117	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
2118	If for some reason you need to change the medium's UUID, use
2119	<link to="IMedium::setIds" />.
2120
2121	If a differencing hard disk medium is to be opened by this method, the
2122	operation will succeed only if its parent medium and all ancestors,
2123	if any, are already known to this VirtualBox installation (for example,
2124	were opened by this method before).
2125
2126	This method attempts to guess the storage format of the specified medium
2127	by reading medium data at the specified location.
2128
2129	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
2130	the image is opened for read/write access and must have according permissions,
2131	as VirtualBox may actually write status information into the disk's metadata
2132	sections.
2133
2134	Note that write access is required for all typical hard disk usage in VirtualBox,
2135	since VirtualBox may need to write metadata such as a UUID into the image.
2136	The only exception is opening a source image temporarily for copying and
2137	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
2138	again soon.
2139
2140	The format of the location string is storage format specific. See
2141	<link to="IMedium::location"/> and IMedium for more details.
2142
2143	<result name="VBOX_E_FILE_ERROR">
2144	Invalid medium storage file location or could not find the medium
2145	at the specified location.
2146	</result>
2147	<result name="VBOX_E_IPRT_ERROR">
2148	Could not get medium storage format.
2149	</result>
2150	<result name="E_INVALIDARG">
2151	Invalid medium storage format.
2152	</result>
2153	<result name="VBOX_E_INVALID_OBJECT_STATE">
2154	Medium has already been added to a media registry.
2155	</result>
2156	</desc>
2157	<param name="location" type="wstring" dir="in">
2158	<desc>
2159	Location of the storage unit that contains medium data in one of
2160	the supported storage formats.
2161	</desc>
2162	</param>
2163	<param name="deviceType" type="DeviceType" dir="in">
2164	<desc>
2165	Must be one of "HardDisk", "DVD" or "Floppy".
2166	</desc>
2167	</param>
2168	<param name="accessMode" type="AccessMode" dir="in">
2169	<desc>Whether to open the image in read/write or read-only mode. For
2170	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2171	</param>
2172	<param name="forceNewUuid" type="boolean" dir="in">
2173	<desc>Allows the caller to request a completely new medium UUID for
2174	the image which is to be opened. Useful if one intends to open an exact
2175	copy of a previously opened image, as this would normally fail due to
2176	the duplicate UUID.</desc>
2177	</param>
2178	<param name="medium" type="IMedium" dir="return">
2179	<desc>Opened medium object.</desc>
2180	</param>
2181	</method>
2182
2183	<method name="getGuestOSType">
2184	<desc>
2185	Returns an object describing the specified guest OS type.
2186
2187	The requested guest OS type is specified using a string which is a
2188	mnemonic identifier of the guest operating system, such as
2189	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2190	particular virtual machine can be read or set using the
2191	<link to="IMachine::OSTypeId"/> attribute.
2192
2193	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2194	available guest OS type objects. Each object has an
2195	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2196	the guest OS this object describes.
2197
2198	<result name="E_INVALIDARG">
2199	@a id is not a valid Guest OS type.
2200	</result>
2201
2202	</desc>
2203	<param name="id" type="uuid" mod="string" dir="in">
2204	<desc>Guest OS type ID string.</desc>
2205	</param>
2206	<param name="type" type="IGuestOSType" dir="return">
2207	<desc>Guest OS type object.</desc>
2208	</param>
2209	</method>
2210
2211	<method name="createSharedFolder">
2212	<desc>
2213	Creates a new global shared folder by associating the given logical
2214	name with the given host path, adds it to the collection of shared
2215	folders and starts sharing it. Refer to the description of
2216	<link to="ISharedFolder"/> to read more about logical names.
2217	<note>
2218	In the current implementation, this operation is not
2219	implemented.
2220	</note>
2221	</desc>
2222	<param name="name" type="wstring" dir="in">
2223	<desc>Unique logical name of the shared folder.</desc>
2224	</param>
2225	<param name="hostPath" type="wstring" dir="in">
2226	<desc>Full path to the shared folder in the host file system.</desc>
2227	</param>
2228	<param name="writable" type="boolean" dir="in">
2229	<desc>Whether the share is writable or readonly</desc>
2230	</param>
2231	<param name="automount" type="boolean" dir="in">
2232	<desc>Whether the share gets automatically mounted by the guest
2233	or not.</desc>
2234	</param>
2235	</method>
2236
2237	<method name="removeSharedFolder">
2238	<desc>
2239	Removes the global shared folder with the given name previously
2240	created by <link to="#createSharedFolder"/> from the collection of
2241	shared folders and stops sharing it.
2242	<note>
2243	In the current implementation, this operation is not
2244	implemented.
2245	</note>
2246	</desc>
2247	<param name="name" type="wstring" dir="in">
2248	<desc>Logical name of the shared folder to remove.</desc>
2249	</param>
2250	</method>
2251
2252	<method name="getExtraDataKeys">
2253	<desc>
2254	Returns an array representing the global extra data keys which currently
2255	have values defined.
2256	</desc>
2257	<param name="keys" type="wstring" dir="return" safearray="yes">
2258	<desc>Array of extra data keys.</desc>
2259	</param>
2260	</method>
2261
2262	<method name="getExtraData">
2263	<desc>
2264	Returns associated global extra data.
2265
2266	If the requested data @a key does not exist, this function will
2267	succeed and return an empty string in the @a value argument.
2268
2269	<result name="VBOX_E_FILE_ERROR">
2270	Settings file not accessible.
2271	</result>
2272	<result name="VBOX_E_XML_ERROR">
2273	Could not parse the settings file.
2274	</result>
2275
2276	</desc>
2277	<param name="key" type="wstring" dir="in">
2278	<desc>Name of the data key to get.</desc>
2279	</param>
2280	<param name="value" type="wstring" dir="return">
2281	<desc>Value of the requested data key.</desc>
2282	</param>
2283	</method>
2284
2285	<method name="setExtraData">
2286	<desc>
2287	Sets associated global extra data.
2288
2289	If you pass @c null or empty string as a key @a value, the given @a key
2290	will be deleted.
2291
2292	<note>
2293	Before performing the actual data change, this method will ask all
2294	registered event listener using the
2295	<link to="IExtraDataCanChangeEvent"/>
2296	notification for a permission. If one of the listeners refuses the
2297	new value, the change will not be performed.
2298	</note>
2299	<note>
2300	On success, the
2301	<link to="IExtraDataChangedEvent"/> notification
2302	is called to inform all registered listeners about a successful data
2303	change.
2304	</note>
2305
2306	<result name="VBOX_E_FILE_ERROR">
2307	Settings file not accessible.
2308	</result>
2309	<result name="VBOX_E_XML_ERROR">
2310	Could not parse the settings file.
2311	</result>
2312	<result name="E_ACCESSDENIED">
2313	Modification request refused.
2314	</result>
2315
2316	</desc>
2317	<param name="key" type="wstring" dir="in">
2318	<desc>Name of the data key to set.</desc>
2319	</param>
2320	<param name="value" type="wstring" dir="in">
2321	<desc>Value to assign to the key.</desc>
2322	</param>
2323	</method>
2324
2325	<method name="setSettingsSecret">
2326	<desc>
2327	Unlocks the secret data by passing the unlock password to the
2328	server. The server will cache the password for that machine.
2329
2330	<result name="VBOX_E_INVALID_VM_STATE">
2331	Virtual machine is not mutable.
2332	</result>
2333
2334	</desc>
2335	<param name="password" type="wstring" dir="in">
2336	<desc>
2337	The cipher key.
2338	</desc>
2339	</param>
2340	</method>
2341
2342	<!--method name="createDHCPServerForInterface">
2343	<desc>
2344	Creates a DHCP server settings to be used for the given interface
2345	<result name="E_INVALIDARG">
2346	Host network interface @a name already exists.
2347	</result>
2348	</desc>
2349	<param name="interface" type="IHostNetworkInterface" dir="in">
2350	<desc>Network Interface</desc>
2351	</param>
2352	<param name="server" type="IDHCPServer" dir="out">
2353	<desc>DHCP server settings</desc>
2354	</param>
2355	</method-->
2356
2357	<method name="createDHCPServer">
2358	<desc>
2359	Creates a DHCP server settings to be used for the given internal network name
2360	<result name="E_INVALIDARG">
2361	Host network interface @a name already exists.
2362	</result>
2363	</desc>
2364	<param name="name" type="wstring" dir="in">
2365	<desc>server name</desc>
2366	</param>
2367	<param name="server" type="IDHCPServer" dir="return">
2368	<desc>DHCP server settings</desc>
2369	</param>
2370	</method>
2371
2372	<method name="findDHCPServerByNetworkName">
2373	<desc>
2374	Searches a DHCP server settings to be used for the given internal network name
2375	<result name="E_INVALIDARG">
2376	Host network interface @a name already exists.
2377	</result>
2378
2379	</desc>
2380	<param name="name" type="wstring" dir="in">
2381	<desc>server name</desc>
2382	</param>
2383	<param name="server" type="IDHCPServer" dir="return">
2384	<desc>DHCP server settings</desc>
2385	</param>
2386	</method>
2387
2388	<!--method name="findDHCPServerForInterface">
2389	<desc>
2390	Searches a DHCP server settings to be used for the given interface
2391	<result name="E_INVALIDARG">
2392	Host network interface @a name already exists.
2393	</result>
2394	</desc>
2395	<param name="interface" type="IHostNetworkInterface" dir="in">
2396	<desc>Network Interface</desc>
2397	</param>
2398	<param name="server" type="IDHCPServer" dir="out">
2399	<desc>DHCP server settings</desc>
2400	</param>
2401	</method-->
2402
2403	<method name="removeDHCPServer">
2404	<desc>
2405	Removes the DHCP server settings
2406	<result name="E_INVALIDARG">
2407	Host network interface @a name already exists.
2408	</result>
2409	</desc>
2410	<param name="server" type="IDHCPServer" dir="in">
2411	<desc>DHCP server settings to be removed</desc>
2412	</param>
2413	</method>
2414
2415	<!-- bunch of metods to create NAT -->
2416	<method name="createNATNetwork">
2417	<!-- Here we create a record in NAT network array with name
2418	and gateway/network parameters this information should
2419	be enough for VBoxNet[Lwip]NAT and VBoxNetDHCP for
2420	servicing the guests.
2421	-->
2422	<param name="networkName" type="wstring" dir="in"/>
2423	<param name="network" type="INATNetwork" dir="return"/>
2424	</method>
2425
2426	<!--
2427	Returns the NATNetwork by name, e.g. for adding porforward rule or delition.
2428	-->
2429	<method name="findNATNetworkByName">
2430	<param name="networkName" type="wstring" dir="in"/>
2431	<param name="network" type="INATNetwork" dir="return"/>
2432	</method>
2433	<!--
2434	Deletes given NAT network.
2435	-->
2436	<method name="removeNATNetwork">
2437	<param name="network" type="INATNetwork" dir="in"/>
2438	</method>
2439
2440	<method name="checkFirmwarePresent">
2441	<desc>
2442	Check if this VirtualBox installation has a firmware
2443	of the given type available, either system-wide or per-user.
2444	Optionally, this may return a hint where this firmware can be
2445	downloaded from.
2446	</desc>
2447	<param name="firmwareType" type="FirmwareType" dir="in">
2448	<desc>
2449	Type of firmware to check.
2450	</desc>
2451	</param>
2452	<param name="version" type="wstring" dir="in">
2453	<desc>Expected version number, usually empty string (presently ignored).</desc>
2454	</param>
2455
2456	<param name="url" type="wstring" dir="out">
2457	<desc>
2458	Suggested URL to download this firmware from.
2459	</desc>
2460	</param>
2461
2462	<param name="file" type="wstring" dir="out">
2463	<desc>
2464	Filename of firmware, only valid if result == TRUE.
2465	</desc>
2466	</param>
2467
2468	<param name="result" type="boolean" dir="return">
2469	<desc>If firmware of this type and version is available.</desc>
2470	</param>
2471	</method>
2472
2473	</interface>
2474
2475	<!--
2476	// IVFSExplorer
2477	/////////////////////////////////////////////////////////////////////////
2478	-->
2479
2480	<enum
2481	name="VFSType"
2482	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2483	>
2484	<desc>
2485	Virtual file systems supported by VFSExplorer.
2486	</desc>
2487
2488	<const name="File" value="1" />
2489	<const name="Cloud" value="2" />
2490	<const name="S3" value="3" />
2491	<const name="WebDav" value="4" />
2492	</enum>
2493
2494	<enum
2495	name="VFSFileType"
2496	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2497	>
2498	<desc>
2499	File types known by VFSExplorer.
2500	</desc>
2501
2502	<const name="Unknown" value="1" />
2503	<const name="Fifo" value="2" />
2504	<const name="DevChar" value="3" />
2505	<const name="Directory" value="4" />
2506	<const name="DevBlock" value="5" />
2507	<const name="File" value="6" />
2508	<const name="SymLink" value="7" />
2509	<const name="Socket" value="8" />
2510	<const name="WhiteOut" value="9" />
2511	</enum>
2512
2513	<interface
2514	name="IVFSExplorer" extends="$unknown"
2515	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2516	wsmap="managed"
2517	>
2518	<desc>
2519	The VFSExplorer interface unifies access to different file system
2520	types. This includes local file systems as well remote file systems like
2521	S3. For a list of supported types see <link to="VFSType" />.
2522	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2523	</desc>
2524
2525	<attribute name="path" type="wstring" readonly="yes">
2526	<desc>Returns the current path in the virtual file system.</desc>
2527	</attribute>
2528
2529	<attribute name="type" type="VFSType" readonly="yes">
2530	<desc>Returns the file system type which is currently in use.</desc>
2531	</attribute>
2532
2533	<method name="update">
2534	<desc>Updates the internal list of files/directories from the
2535	current directory level. Use <link to="#entryList" /> to get the full list
2536	after a call to this method.</desc>
2537
2538	<param name="progress" type="IProgress" dir="return">
2539	<desc>Progress object to track the operation completion.</desc>
2540	</param>
2541	</method>
2542
2543	<method name="cd">
2544	<desc>Change the current directory level.</desc>
2545
2546	<param name="dir" type="wstring" dir="in">
2547	<desc>The name of the directory to go in.</desc>
2548	</param>
2549
2550	<param name="progress" type="IProgress" dir="return">
2551	<desc>Progress object to track the operation completion.</desc>
2552	</param>
2553	</method>
2554
2555	<method name="cdUp">
2556	<desc>Go one directory upwards from the current directory level.</desc>
2557
2558	<param name="progress" type="IProgress" dir="return">
2559	<desc>Progress object to track the operation completion.</desc>
2560	</param>
2561	</method>
2562
2563	<method name="entryList">
2564	<desc>Returns a list of files/directories after a call to <link
2565	to="#update" />. The user is responsible for keeping this internal
2566	list up do date.</desc>
2567
2568	<param name="names" type="wstring" safearray="yes" dir="out">
2569	<desc>The list of names for the entries.</desc>
2570	</param>
2571
2572	<param name="types" type="unsigned long" safearray="yes" dir="out">
2573	<desc>The list of types for the entries.</desc>
2574	</param>
2575
2576	<param name="sizes" type="unsigned long" safearray="yes" dir="out">
2577	<desc>The list of sizes (in bytes) for the entries.</desc>
2578	</param>
2579
2580	<param name="modes" type="unsigned long" safearray="yes" dir="out">
2581	<desc>The list of file modes (in octal form) for the entries.</desc>
2582	</param>
2583	</method>
2584
2585	<method name="exists">
2586	<desc>Checks if the given file list exists in the current directory
2587	level.</desc>
2588
2589	<param name="names" type="wstring" safearray="yes" dir="in">
2590	<desc>The names to check.</desc>
2591	</param>
2592
2593	<param name="exists" type="wstring" safearray="yes" dir="return">
2594	<desc>The names which exist.</desc>
2595	</param>
2596	</method>
2597
2598	<method name="remove">
2599	<desc>Deletes the given files in the current directory level.</desc>
2600
2601	<param name="names" type="wstring" safearray="yes" dir="in">
2602	<desc>The names to remove.</desc>
2603	</param>
2604
2605	<param name="progress" type="IProgress" dir="return">
2606	<desc>Progress object to track the operation completion.</desc>
2607	</param>
2608	</method>
2609
2610	</interface>
2611
2612	<enum
2613	name="ImportOptions" extends="$unknown"
2614	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2615	>
2616
2617	<desc>
2618	Import options, used with <link to="IAppliance::importMachines" />.
2619	</desc>
2620
2621	<const name="KeepAllMACs" value="1">
2622	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2623	</const>
2624	<const name="KeepNATMACs" value="2">
2625	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2626	</const>
2627
2628	</enum>
2629
2630
2631	<!--
2632	// IAppliance
2633	/////////////////////////////////////////////////////////////////////////
2634	-->
2635
2636	<interface
2637	name="IAppliance" extends="$unknown"
2638	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2639	wsmap="managed"
2640	>
2641	<desc>
2642	Represents a platform-independent appliance in OVF format. An instance of this is returned
2643	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2644	virtual machines within an appliance with VirtualBox.
2645
2646	The OVF standard suggests two different physical file formats:
2647
2648	<ol>
2649	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2650	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2651	this descriptor file references other files such as disk images, as OVF appliances typically
2652	do, those additional files must be in the same directory as the descriptor file.</li>
2653
2654	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2655	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2656	files and optionally other files.
2657
2658	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2659	be added with a later version.</li>
2660	</ol>
2661
2662	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2663	<link to="IMachine" /> involves the following sequence of API calls:
2664
2665	<ol>
2666	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2667	</li>
2668
2669	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2670	would like to import. So long as this file is syntactically valid, this will succeed
2671	and fill the appliance object with the parsed data from the OVF file.
2672	</li>
2673
2674	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2675	contents of the IAppliance attributes accordingly. These can be inspected by a
2676	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2677	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2678	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2679	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2680	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2681	The GUI can then give the user the option to confirm and/or change these suggestions.
2682	</li>
2683
2684	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2685	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2686	</li>
2687
2688	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2689	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2690	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2691	can be found in the <link to="#machines" /> array attribute.
2692	</li>
2693	</ol>
2694
2695	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2696
2697	<ol>
2698	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2699	an empty IAppliance object.
2700	</li>
2701
2702	<li>For each machine you would like to export, call <link to="IMachine::exportTo" />
2703	with the IAppliance object you just created. Each such call creates one instance of
2704	<link to="IVirtualSystemDescription" /> inside the appliance.
2705	</li>
2706
2707	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2708	virtual system (machine) to override the suggestions made by the <link to="IMachine::exportTo"/> routine.
2709	</li>
2710
2711	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2712	file written.</li>
2713	</ol>
2714
2715	</desc>
2716
2717	<attribute name="path" type="wstring" readonly="yes">
2718	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2719	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2720	<link to="#write" /> (for export).
2721	This attribute is empty until one of these methods has been called.
2722	</desc>
2723	</attribute>
2724
2725	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2726	<desc>
2727	Array of virtual disk definitions. One such description exists for each
2728	disk definition in the OVF; each string array item represents one such piece of
2729	disk information, with the information fields separated by tab (\\t) characters.
2730
2731	The caller should be prepared for additional fields being appended to
2732	this string in future versions of VirtualBox and therefore check for
2733	the number of tabs in the strings returned.
2734
2735	In the current version, the following eight fields are returned per string
2736	in the array:
2737
2738	<ol>
2739	<li>Disk ID (unique string identifier given to disk)</li>
2740
2741	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2742
2743	<li>Populated size (optional unsigned integer indicating the current size of the
2744	disk; can be approximate; -1 if unspecified)</li>
2745
2746	<li>Format (string identifying the disk format, typically
2747	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2748
2749	<li>Reference (where to find the disk image, typically a file name; if empty,
2750	then the disk should be created on import)</li>
2751
2752	<li>Image size (optional unsigned integer indicating the size of the image,
2753	which need not necessarily be the same as the values specified above, since
2754	the image may be compressed or sparse; -1 if not specified)</li>
2755
2756	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2757	presently unsupported and always -1)</li>
2758
2759	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2760	</ol>
2761	</desc>
2762	</attribute>
2763
2764	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2765	<desc> Array of virtual system descriptions. One such description is created
2766	for each virtual system (machine) found in the OVF.
2767	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::exportTo" />
2768	(for export) has been called.
2769	</desc>
2770	</attribute>
2771
2772	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2773	<desc>
2774	Contains the UUIDs of the machines created from the information in this appliances. This is only
2775	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2776	succeeded.
2777	</desc>
2778	</attribute>
2779
2780	<method name="read">
2781	<desc>
2782	Reads an OVF file into the appliance object.
2783
2784	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2785	mere fact that this method returns successfully does not mean that VirtualBox supports all
2786	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2787	</desc>
2788	<param name="file" type="wstring" dir="in">
2789	<desc>
2790	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2791	on whether the appliance is distributed as a set of files or as a single file, respectively).
2792	</desc>
2793	</param>
2794	<param name="progress" type="IProgress" dir="return">
2795	<desc>Progress object to track the operation completion.</desc>
2796	</param>
2797	</method>
2798
2799	<method name="interpret">
2800	<desc>
2801	Interprets the OVF data that was read when the appliance was constructed. After
2802	calling this method, one can inspect the
2803	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2804	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2805	the appliance.
2806
2807	Calling this method is the second step of importing an appliance into VirtualBox;
2808	see <link to="IAppliance" /> for an overview.
2809
2810	After calling this method, one should call <link to="#getWarnings" /> to find out
2811	if problems were encountered during the processing which might later lead to
2812	errors.
2813	</desc>
2814	</method>
2815
2816	<method name="importMachines">
2817	<desc>
2818	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2819	and other interfaces that match the information contained in the appliance as
2820	closely as possible, as represented by the import instructions in the
2821	<link to="#virtualSystemDescriptions" /> array.
2822
2823	Calling this method is the final step of importing an appliance into VirtualBox;
2824	see <link to="IAppliance" /> for an overview.
2825
2826	Since importing the appliance will most probably involve copying and converting
2827	disk images, which can take a long time, this method operates asynchronously and
2828	returns an IProgress object to allow the caller to monitor the progress.
2829
2830	After the import succeeded, the UUIDs of the IMachine instances created can be
2831	retrieved from the <link to="#machines" /> array attribute.
2832	</desc>
2833
2834	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2835	<desc>Options for the importing operation.</desc>
2836	</param>
2837
2838	<param name="progress" type="IProgress" dir="return">
2839	<desc>Progress object to track the operation completion.</desc>
2840	</param>
2841	</method>
2842
2843	<method name="createVFSExplorer">
2844	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2845
2846	<param name="URI" type="wstring" dir="in">
2847	<desc>The URI describing the file system to use.</desc>
2848	</param>
2849
2850	<param name="explorer" type="IVFSExplorer" dir="return">
2851	<desc></desc>
2852	</param>
2853	</method>
2854
2855	<method name="write">
2856	<desc>
2857	Writes the contents of the appliance exports into a new OVF file.
2858
2859	Calling this method is the final step of exporting an appliance from VirtualBox;
2860	see <link to="IAppliance" /> for an overview.
2861
2862	Since exporting the appliance will most probably involve copying and converting
2863	disk images, which can take a long time, this method operates asynchronously and
2864	returns an IProgress object to allow the caller to monitor the progress.
2865	</desc>
2866	<param name="format" type="wstring" dir="in">
2867	<desc>
2868	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2869	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2870	</desc>
2871	</param>
2872	<param name="manifest" type="boolean" dir="in">
2873	<desc>
2874	Indicate if the optional manifest file (.mf) should be written. The manifest file
2875	is used for integrity checks prior import.
2876	</desc>
2877	</param>
2878	<param name="path" type="wstring" dir="in">
2879	<desc>
2880	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2881	on whether the appliance is distributed as a set of files or as a single file, respectively).
2882	</desc>
2883	</param>
2884	<param name="progress" type="IProgress" dir="return">
2885	<desc>Progress object to track the operation completion.</desc>
2886	</param>
2887	</method>
2888
2889	<method name="getWarnings">
2890	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2891
2892	<param name="warnings" type="wstring" dir="return" safearray="yes">
2893	<desc></desc>
2894	</param>
2895	</method>
2896
2897	</interface>
2898
2899	<enum
2900	name="VirtualSystemDescriptionType"
2901	uuid="303c0900-a746-4612-8c67-79003e91f459"
2902	>
2903	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2904	a configuration value.</desc>
2905
2906	<const name="Ignore" value="1" />
2907	<const name="OS" value="2" />
2908	<const name="Name" value="3" />
2909	<const name="Product" value="4" />
2910	<const name="Vendor" value="5" />
2911	<const name="Version" value="6" />
2912	<const name="ProductUrl" value="7" />
2913	<const name="VendorUrl" value="8" />
2914	<const name="Description" value="9" />
2915	<const name="License" value="10" />
2916	<const name="Miscellaneous" value="11" />
2917	<const name="CPU" value="12" />
2918	<const name="Memory" value="13" />
2919	<const name="HardDiskControllerIDE" value="14" />
2920	<const name="HardDiskControllerSATA" value="15" />
2921	<const name="HardDiskControllerSCSI" value="16" />
2922	<const name="HardDiskControllerSAS" value="17" />
2923	<const name="HardDiskImage" value="18" />
2924	<const name="Floppy" value="19" />
2925	<const name="CDROM" value="20" />
2926	<const name="NetworkAdapter" value="21" />
2927	<const name="USBController" value="22" />
2928	<const name="SoundCard" value="23" />
2929	<const name="SettingsFile" value="24">
2930	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2931	</const>
2932	</enum>
2933
2934	<enum
2935	name="VirtualSystemDescriptionValueType"
2936	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2937	>
2938	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2939	type to fetch.</desc>
2940
2941	<const name="Reference" value="1" />
2942	<const name="Original" value="2" />
2943	<const name="Auto" value="3" />
2944	<const name="ExtraConfig" value="4" />
2945
2946	</enum>
2947
2948	<interface
2949	name="IVirtualSystemDescription" extends="$unknown"
2950	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2951	wsmap="managed"
2952	>
2953
2954	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2955	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2956	<link to="IAppliance::interpret" /> has been called, that array contains information
2957	about how the virtual systems described in the OVF should best be imported into
2958	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2959	import an OVF into VirtualBox.
2960	</desc>
2961
2962	<attribute name="count" type="unsigned long" readonly="yes">
2963	<desc>Return the number of virtual system description entries.</desc>
2964	</attribute>
2965
2966	<method name="getDescription">
2967	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2968	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2969
2970	The list below identifies the value sets that are possible depending on the
2971	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2972	the array item with the same index in @a OVFValues[] will contain the original value as contained
2973	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2974	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2975	the @a aExtraConfigValues[] array item may also be used.
2976
2977	<ul>
2978	<li>
2979	"OS": the guest operating system type. There must be exactly one such array item on import. The
2980	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2981	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2982	item in @a OVFValues[] will contain a numerical value that described the operating system in the OVF.
2983	</li>
2984	<li>
2985	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2986	if none is present on import, then an automatic name will be created from the operating system
2987	type. The corresponding item im @a OVFValues[] will contain the suggested virtual machine name
2988	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2989	<link to="IMachine" /> name that does not exist yet.
2990	</li>
2991	<li>
2992	"Description": an arbitrary description.
2993	</li>
2994	<li>
2995	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2996	code to display such a license for agreement; the Main API does not enforce any such policy.
2997	</li>
2998	<li>
2999	Miscellaneous: reserved for future use.
3000	</li>
3001	<li>
3002	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
3003	</li>
3004	<li>
3005	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
3006	is present on import, then VirtualBox will set a meaningful default based on the operating system
3007	type.
3008	</li>
3009	<li>
3010	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
3011	An optional value in @a OVFValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
3012	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
3013	writes into the OVF.
3014	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
3015	type can use to specify which hard disk controller a virtual disk should be connected to.
3016	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
3017	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
3018	its virtual machines supports four channels (primary master, primary slave, secondary master,
3019	secondary slave) and thus maps to two IDE controllers in the OVF sense.
3020	</li>
3021	<li>
3022	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3023	has no value in @a OVFValues[] or @a aVBoxValues[].
3024	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3025	</li>
3026	<li>
3027	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3028	The items in @a OVFValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
3029	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
3030	whereas VirtualBox considers it a class of storage controllers of its own; see
3031	<link to="StorageControllerType" />).
3032	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3033	</li>
3034	<li>
3035	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3036	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3037
3038	The array item in @a OVFValues[] will contain the file specification from the OVF file (without
3039	a path since the image file should be in the same location as the OVF file itself), whereas the
3040	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3041	hard disk image. This means that on import the image will be copied and converted from the
3042	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3043
3044	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
3045	format: "controller=<index>;channel=<c>"
3046	In this string, <index> must be an integer specifying the hard disk controller to connect
3047	the image to. That number must be the index of an array item with one of the hard disk controller
3048	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3049	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3050	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3051	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3052	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3053	</li>
3054	<li>
3055	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3056	attachment information as with "HardDiskImage" items.
3057	</li>
3058	<li>
3059	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3060	attachment information as with "HardDiskImage" items.
3061	</li>
3062	<li>
3063	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3064	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3065	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3066	</li>
3067	<li>
3068	"USBController": a USB controller. There can be at most one such item. If and only if such an
3069	item ispresent, USB support will be enabled for the new virtual machine.
3070	</li>
3071	<li>
3072	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3073	present, sound support will be enabled for the new virtual machine. Note that the virtual
3074	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3075	may be different from the virtual soundcard expected by the appliance.
3076	</li>
3077	</ul>
3078
3079	</desc>
3080
3081	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3082	<desc></desc>
3083	</param>
3084
3085	<param name="refs" type="wstring" dir="out" safearray="yes">
3086	<desc></desc>
3087	</param>
3088
3089	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3090	<desc></desc>
3091	</param>
3092
3093	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3094	<desc></desc>
3095	</param>
3096
3097	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3098	<desc></desc>
3099	</param>
3100
3101	</method>
3102
3103	<method name="getDescriptionByType">
3104	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3105	should be returned.</desc>
3106
3107	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3108	<desc></desc>
3109	</param>
3110
3111	<param name="types" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3112	<desc></desc>
3113	</param>
3114
3115	<param name="refs" type="wstring" dir="out" safearray="yes">
3116	<desc></desc>
3117	</param>
3118
3119	<param name="OVFValues" type="wstring" dir="out" safearray="yes">
3120	<desc></desc>
3121	</param>
3122
3123	<param name="VBoxValues" type="wstring" dir="out" safearray="yes">
3124	<desc></desc>
3125	</param>
3126
3127	<param name="extraConfigValues" type="wstring" dir="out" safearray="yes">
3128	<desc></desc>
3129	</param>
3130
3131	</method>
3132
3133	<method name="getValuesByType">
3134	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3135	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3136	values.</desc>
3137
3138	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3139	<desc></desc>
3140	</param>
3141
3142	<param name="which" type="VirtualSystemDescriptionValueType" dir="in">
3143	<desc></desc>
3144	</param>
3145
3146	<param name="values" type="wstring" dir="return" safearray="yes">
3147	<desc></desc>
3148	</param>
3149
3150	</method>
3151
3152	<method name="setFinalValues">
3153	<desc>
3154	This method allows the appliance's user to change the configuration for the virtual
3155	system descriptions. For each array item returned from <link to="#getDescription" />,
3156	you must pass in one boolean value and one configuration value.
3157
3158	Each item in the boolean array determines whether the particular configuration item
3159	should be enabled.
3160	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3161	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3162	and SoundCard.
3163
3164	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3165	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
3166	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
3167	for valid configuration values for the individual array item types. If the
3168	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3169	</desc>
3170
3171	<param name="enabled" type="boolean" dir="in" safearray="yes">
3172	<desc></desc>
3173	</param>
3174
3175	<param name="VBoxValues" type="wstring" dir="in" safearray="yes">
3176	<desc></desc>
3177	</param>
3178
3179	<param name="extraConfigValues" type="wstring" dir="in" safearray="yes">
3180	<desc></desc>
3181	</param>
3182	</method>
3183
3184	<method name="addDescription">
3185	<desc>
3186	This method adds an additional description entry to the stack of already
3187	available descriptions for this virtual system. This is handy for writing
3188	values which aren't directly supported by VirtualBox. One example would
3189	be the License type of <link to="VirtualSystemDescriptionType" />.
3190	</desc>
3191
3192	<param name="type" type="VirtualSystemDescriptionType" dir="in">
3193	<desc></desc>
3194	</param>
3195
3196	<param name="VBoxValue" type="wstring" dir="in">
3197	<desc></desc>
3198	</param>
3199
3200	<param name="extraConfigValue" type="wstring" dir="in">
3201	<desc></desc>
3202	</param>
3203	</method>
3204	</interface>
3205
3206
3207	<!--
3208	// IMachine
3209	/////////////////////////////////////////////////////////////////////////
3210	-->
3211
3212	<interface
3213	name="IInternalMachineControl" extends="$unknown"
3214	uuid="dca36a92-703c-4649-98a4-f40c1ef0c336"
3215	internal="yes"
3216	wsmap="suppress"
3217	>
3218	<method name="setRemoveSavedStateFile">
3219	<desc>
3220	Updates the flag whether the saved state file is removed on a
3221	machine state change from Saved to PoweredOff.
3222	</desc>
3223	<param name="remove" type="boolean" dir="in"/>
3224	</method>
3225
3226	<method name="updateState">
3227	<desc>
3228	Updates the VM state.
3229	<note>
3230	This operation will also update the settings file with the correct
3231	information about the saved state file and delete this file from disk
3232	when appropriate.
3233	</note>
3234	</desc>
3235	<param name="state" type="MachineState" dir="in"/>
3236	</method>
3237
3238	<method name="getIPCId">
3239	<param name="id" type="wstring" dir="return"/>
3240	</method>
3241
3242	<method name="beginPowerUp">
3243	<desc>
3244	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3245	gives it the progress object that should be part of any pending
3246	<link to="IMachine::launchVMProcess"/> operations. The progress
3247	object may be called back to reflect an early cancelation, so some care
3248	have to be taken with respect to any cancelation callbacks. The console
3249	object will call <link to="IInternalMachineControl::endPowerUp"/>
3250	to signal the completion of the progress object.
3251	</desc>
3252	<param name="progress" type="IProgress" dir="in" />
3253	</method>
3254
3255	<method name="endPowerUp">
3256	<desc>
3257	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3258	This method may query status information from the progress object it
3259	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3260	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3261	call in order to complete that progress object.
3262	</desc>
3263	<param name="result" type="long" dir="in"/>
3264	</method>
3265
3266	<method name="beginPoweringDown">
3267	<desc>
3268	Called by the VM process to inform the server it wants to
3269	stop the VM execution and power down.
3270	</desc>
3271	<param name="progress" type="IProgress" dir="out">
3272	<desc>
3273	Progress object created by VBoxSVC to wait until
3274	the VM is powered down.
3275	</desc>
3276	</param>
3277	</method>
3278
3279	<method name="endPoweringDown">
3280	<desc>
3281	Called by the VM process to inform the server that powering
3282	down previously requested by #beginPoweringDown is either
3283	successfully finished or there was a failure.
3284
3285	<result name="VBOX_E_FILE_ERROR">
3286	Settings file not accessible.
3287	</result>
3288	<result name="VBOX_E_XML_ERROR">
3289	Could not parse the settings file.
3290	</result>
3291
3292	</desc>
3293
3294	<param name="result" type="long" dir="in">
3295	<desc>@c S_OK to indicate success.
3296	</desc>
3297	</param>
3298	<param name="errMsg" type="wstring" dir="in">
3299	<desc>@c human readable error message in case of failure.
3300	</desc>
3301	</param>
3302	</method>
3303
3304	<method name="runUSBDeviceFilters">
3305	<desc>
3306	Asks the server to run USB devices filters of the associated
3307	machine against the given USB device and tell if there is
3308	a match.
3309	<note>
3310	Intended to be used only for remote USB devices. Local
3311	ones don't require to call this method (this is done
3312	implicitly by the Host and USBProxyService).
3313	</note>
3314	</desc>
3315	<param name="device" type="IUSBDevice" dir="in"/>
3316	<param name="matched" type="boolean" dir="out"/>
3317	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3318	</method>
3319
3320	<method name="captureUSBDevice">
3321	<desc>
3322	Requests a capture of the given host USB device.
3323	When the request is completed, the VM process will
3324	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3325	notification.
3326	</desc>
3327	<param name="id" type="uuid" mod="string" dir="in"/>
3328	</method>
3329
3330	<method name="detachUSBDevice">
3331	<desc>
3332	Notification that a VM is going to detach (@a done = @c false) or has
3333	already detached (@a done = @c true) the given USB device.
3334	When the @a done = @c true request is completed, the VM process will
3335	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3336	notification.
3337	<note>
3338	In the @a done = @c true case, the server must run its own filters
3339	and filters of all VMs but this one on the detached device
3340	as if it were just attached to the host computer.
3341	</note>
3342	</desc>
3343	<param name="id" type="uuid" mod="string" dir="in"/>
3344	<param name="done" type="boolean" dir="in"/>
3345	</method>
3346
3347	<method name="autoCaptureUSBDevices">
3348	<desc>
3349	Requests a capture all matching USB devices attached to the host.
3350	When the request is completed, the VM process will
3351	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3352	notification per every captured device.
3353	</desc>
3354	</method>
3355
3356	<method name="detachAllUSBDevices">
3357	<desc>
3358	Notification that a VM that is being powered down. The done
3359	parameter indicates whether which stage of the power down
3360	we're at. When @a done = @c false the VM is announcing its
3361	intentions, while when @a done = @c true the VM is reporting
3362	what it has done.
3363	<note>
3364	In the @a done = @c true case, the server must run its own filters
3365	and filters of all VMs but this one on all detach devices as
3366	if they were just attached to the host computer.
3367	</note>
3368	</desc>
3369	<param name="done" type="boolean" dir="in"/>
3370	</method>
3371
3372	<method name="onSessionEnd">
3373	<desc>
3374	Triggered by the given session object when the session is about
3375	to close normally.
3376	</desc>
3377	<param name="session" type="ISession" dir="in">
3378	<desc>Session that is being closed</desc>
3379	</param>
3380	<param name="progress" type="IProgress" dir="return">
3381	<desc>
3382	Used to wait until the corresponding machine is actually
3383	dissociated from the given session on the server.
3384	Returned only when this session is a direct one.
3385	</desc>
3386	</param>
3387	</method>
3388
3389	<method name="beginSavingState">
3390	<desc>
3391	Called by the VM process to inform the server it wants to
3392	save the current state and stop the VM execution.
3393	</desc>
3394	<param name="progress" type="IProgress" dir="out">
3395	<desc>
3396	Progress object created by VBoxSVC to wait until
3397	the state is saved.
3398	</desc>
3399	</param>
3400	<param name="stateFilePath" type="wstring" dir="out">
3401	<desc>
3402	File path the VM process must save the execution state to.
3403	</desc>
3404	</param>
3405	</method>
3406
3407	<method name="endSavingState">
3408	<desc>
3409	Called by the VM process to inform the server that saving
3410	the state previously requested by #beginSavingState is either
3411	successfully finished or there was a failure.
3412
3413	<result name="VBOX_E_FILE_ERROR">
3414	Settings file not accessible.
3415	</result>
3416	<result name="VBOX_E_XML_ERROR">
3417	Could not parse the settings file.
3418	</result>
3419
3420	</desc>
3421
3422	<param name="result" type="long" dir="in">
3423	<desc>@c S_OK to indicate success.
3424	</desc>
3425	</param>
3426	<param name="errMsg" type="wstring" dir="in">
3427	<desc>@c human readable error message in case of failure.
3428	</desc>
3429	</param>
3430	</method>
3431
3432	<method name="adoptSavedState">
3433	<desc>
3434	Gets called by <link to="IConsole::adoptSavedState"/>.
3435	<result name="VBOX_E_FILE_ERROR">
3436	Invalid saved state file path.
3437	</result>
3438	</desc>
3439	<param name="savedStateFile" type="wstring" dir="in">
3440	<desc>Path to the saved state file to adopt.</desc>
3441	</param>
3442	</method>
3443
3444	<method name="beginTakingSnapshot">
3445	<desc>
3446	Called from the VM process to request from the server to perform the
3447	server-side actions of creating a snapshot (creating differencing images
3448	and the snapshot object).
3449
3450	<result name="VBOX_E_FILE_ERROR">
3451	Settings file not accessible.
3452	</result>
3453	<result name="VBOX_E_XML_ERROR">
3454	Could not parse the settings file.
3455	</result>
3456	</desc>
3457	<param name="initiator" type="IConsole" dir="in">
3458	<desc>The console object that initiated this call.</desc>
3459	</param>
3460	<param name="name" type="wstring" dir="in">
3461	<desc>Snapshot name.</desc>
3462	</param>
3463	<param name="description" type="wstring" dir="in">
3464	<desc>Snapshot description.</desc>
3465	</param>
3466	<param name="consoleProgress" type="IProgress" dir="in">
3467	<desc>
3468	Progress object created by the VM process tracking the
3469	snapshot's progress. This has the following sub-operations:
3470	<ul>
3471	<li>setting up (weight 1);</li>
3472	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3473	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3474	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3475	<li>finishing up (weight 1)</li>
3476	</ul>
3477	</desc>
3478	</param>
3479	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3480	<desc>
3481	Whether this is an online snapshot (i.e. the machine is running).
3482	</desc>
3483	</param>
3484	<param name="stateFilePath" type="wstring" dir="out">
3485	<desc>
3486	File path the VM process must save the execution state to.
3487	</desc>
3488	</param>
3489	</method>
3490
3491	<method name="endTakingSnapshot">
3492	<desc>
3493	Called by the VM process to inform the server that the snapshot
3494	previously requested by #beginTakingSnapshot is either
3495	successfully taken or there was a failure.
3496	</desc>
3497
3498	<param name="success" type="boolean" dir="in">
3499	<desc>@c true to indicate success and @c false otherwise</desc>
3500	</param>
3501	</method>
3502
3503	<method name="deleteSnapshot">
3504	<desc>
3505	Gets called by <link to="IConsole::deleteSnapshot"/>,
3506	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3507	<link to="IConsole::deleteSnapshotRange"/>.
3508	<result name="VBOX_E_INVALID_OBJECT_STATE">
3509	Snapshot has more than one child snapshot. Only possible if the
3510	delete operation does not delete all children or the range does
3511	not meet the linearity condition.
3512	</result>
3513	</desc>
3514	<param name="initiator" type="IConsole" dir="in">
3515	<desc>The console object that initiated this call.</desc>
3516	</param>
3517	<param name="startId" type="uuid" mod="string" dir="in">
3518	<desc>UUID of the first snapshot to delete.</desc>
3519	</param>
3520	<param name="endId" type="uuid" mod="string" dir="in">
3521	<desc>UUID of the last snapshot to delete.</desc>
3522	</param>
3523	<param name="deleteAllChildren" type="boolean" dir="in">
3524	<desc>Whether all children should be deleted.</desc>
3525	</param>
3526	<param name="machineState" type="MachineState" dir="out">
3527	<desc>New machine state after this operation is started.</desc>
3528	</param>
3529	<param name="progress" type="IProgress" dir="return">
3530	<desc>Progress object to track the operation completion.</desc>
3531	</param>
3532	</method>
3533
3534	<method name="finishOnlineMergeMedium">
3535	<desc>
3536	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3537	</desc>
3538	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3539	<desc>The medium attachment which needs to be cleaned up.</desc>
3540	</param>
3541	<param name="source" type="IMedium" dir="in">
3542	<desc>Merge source medium.</desc>
3543	</param>
3544	<param name="target" type="IMedium" dir="in">
3545	<desc>Merge target medium.</desc>
3546	</param>
3547	<param name="mergeForward" type="boolean" dir="in">
3548	<desc>Merge direction.</desc>
3549	</param>
3550	<param name="parentForTarget" type="IMedium" dir="in">
3551	<desc>For forward merges: new parent for target medium.</desc>
3552	</param>
3553	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3554	<desc>For backward merges: list of media which need their parent UUID
3555	updated.</desc>
3556	</param>
3557	</method>
3558
3559	<method name="restoreSnapshot">
3560	<desc>
3561	Gets called by <link to="IConsole::restoreSnapshot"/>.
3562	</desc>
3563	<param name="initiator" type="IConsole" dir="in">
3564	<desc>The console object that initiated this call.</desc>
3565	</param>
3566	<param name="snapshot" type="ISnapshot" dir="in">
3567	<desc>The snapshot to restore the VM state from.</desc>
3568	</param>
3569	<param name="machineState" type="MachineState" dir="out">
3570	<desc>New machine state after this operation is started.</desc>
3571	</param>
3572	<param name="progress" type="IProgress" dir="return">
3573	<desc>Progress object to track the operation completion.</desc>
3574	</param>
3575	</method>
3576
3577	<method name="pullGuestProperties">
3578	<desc>
3579	Get the list of the guest properties matching a set of patterns along
3580	with their values, time stamps and flags and give responsibility for
3581	managing properties to the console.
3582	</desc>
3583	<param name="names" type="wstring" dir="out" safearray="yes">
3584	<desc>
3585	The names of the properties returned.
3586	</desc>
3587	</param>
3588	<param name="values" type="wstring" dir="out" safearray="yes">
3589	<desc>
3590	The values of the properties returned. The array entries match the
3591	corresponding entries in the @a name array.
3592	</desc>
3593	</param>
3594	<param name="timestamps" type="long long" dir="out" safearray="yes">
3595	<desc>
3596	The time stamps of the properties returned. The array entries match
3597	the corresponding entries in the @a name array.
3598	</desc>
3599	</param>
3600	<param name="flags" type="wstring" dir="out" safearray="yes">
3601	<desc>
3602	The flags of the properties returned. The array entries match the
3603	corresponding entries in the @a name array.
3604	</desc>
3605	</param>
3606	</method>
3607
3608	<method name="pushGuestProperty">
3609	<desc>
3610	Update a single guest property in IMachine.
3611	</desc>
3612	<param name="name" type="wstring" dir="in">
3613	<desc>
3614	The name of the property to be updated.
3615	</desc>
3616	</param>
3617	<param name="value" type="wstring" dir="in">
3618	<desc>
3619	The value of the property.
3620	</desc>
3621	</param>
3622	<param name="timestamp" type="long long" dir="in">
3623	<desc>
3624	The timestamp of the property.
3625	</desc>
3626	</param>
3627	<param name="flags" type="wstring" dir="in">
3628	<desc>
3629	The flags of the property.
3630	</desc>
3631	</param>
3632	</method>
3633
3634	<method name="lockMedia">
3635	<desc>
3636	Locks all media attached to the machine for writing and parents of
3637	attached differencing media (if any) for reading. This operation is
3638	atomic so that if it fails no media is actually locked.
3639
3640	This method is intended to be called when the machine is in Starting or
3641	Restoring state. The locked media will be automatically unlocked when
3642	the machine is powered off or crashed.
3643	</desc>
3644	</method>
3645	<method name="unlockMedia">
3646	<desc>
3647	Unlocks all media previously locked using
3648	<link to="IInternalMachineControl::lockMedia"/>.
3649
3650	This method is intended to be used with teleportation so that it is
3651	possible to teleport between processes on the same machine.
3652	</desc>
3653	</method>
3654
3655	<method name="ejectMedium">
3656	<desc>
3657	Tells VBoxSVC that the guest has ejected the medium associated with
3658	the medium attachment.
3659	</desc>
3660	<param name="attachment" type="IMediumAttachment" dir="in">
3661	<desc>
3662	The medium attachment where the eject happened.
3663	</desc>
3664	</param>
3665	<param name="newAttachment" type="IMediumAttachment" dir="return">
3666	<desc>
3667	A new reference to the medium attachment, as the config change can
3668	result in the creation of a new instance.
3669	</desc>
3670	</param>
3671	</method>
3672
3673	<method name="reportVmStatistics">
3674	<desc>
3675	Passes statistics collected by VM (including guest statistics) to VBoxSVC.
3676	</desc>
3677	<param name="validStats" type="unsigned long" dir="in">
3678	<desc>
3679	Mask defining which parameters are valid. For example: 0x11 means
3680	that cpuIdle and XXX are valid. Other parameters should be ignored.
3681	</desc>
3682	</param>
3683	<param name="cpuUser" type="unsigned long" dir="in">
3684	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3685	</param>
3686	<param name="cpuKernel" type="unsigned long" dir="in">
3687	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3688	</param>
3689	<param name="cpuIdle" type="unsigned long" dir="in">
3690	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3691	</param>
3692	<param name="memTotal" type="unsigned long" dir="in">
3693	<desc>Total amount of physical guest RAM.</desc>
3694	</param>
3695	<param name="memFree" type="unsigned long" dir="in">
3696	<desc>Free amount of physical guest RAM.</desc>
3697	</param>
3698	<param name="memBalloon" type="unsigned long" dir="in">
3699	<desc>Amount of ballooned physical guest RAM.</desc>
3700	</param>
3701	<param name="memShared" type="unsigned long" dir="in">
3702	<desc>Amount of shared physical guest RAM.</desc>
3703	</param>
3704	<param name="memCache" type="unsigned long" dir="in">
3705	<desc>Total amount of guest (disk) cache memory.</desc>
3706	</param>
3707	<param name="pagedTotal" type="unsigned long" dir="in">
3708	<desc>Total amount of space in the page file.</desc>
3709	</param>
3710	<param name="memAllocTotal" type="unsigned long" dir="in">
3711	<desc>Total amount of memory allocated by the hypervisor.</desc>
3712	</param>
3713	<param name="memFreeTotal" type="unsigned long" dir="in">
3714	<desc>Total amount of free memory available in the hypervisor.</desc>
3715	</param>
3716	<param name="memBalloonTotal" type="unsigned long" dir="in">
3717	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3718	</param>
3719	<param name="memSharedTotal" type="unsigned long" dir="in">
3720	<desc>Total amount of shared memory in the hypervisor.</desc>
3721	</param>
3722	<param name="vmNetRx" type="unsigned long" dir="in">
3723	<desc>Network receive rate for VM.</desc>
3724	</param>
3725	<param name="vmNetTx" type="unsigned long" dir="in">
3726	<desc>Network transmit rate for VM.</desc>
3727	</param>
3728	</method>
3729	</interface>
3730
3731	<interface
3732	name="IBIOSSettings" extends="$unknown"
3733	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3734	wsmap="managed"
3735	>
3736	<desc>
3737	The IBIOSSettings interface represents BIOS settings of the virtual
3738	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3739	</desc>
3740	<attribute name="logoFadeIn" type="boolean">
3741	<desc>Fade in flag for BIOS logo animation.</desc>
3742	</attribute>
3743
3744	<attribute name="logoFadeOut" type="boolean">
3745	<desc>Fade out flag for BIOS logo animation.</desc>
3746	</attribute>
3747
3748	<attribute name="logoDisplayTime" type="unsigned long">
3749	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3750	</attribute>
3751
3752	<attribute name="logoImagePath" type="wstring">
3753	<desc>
3754	Local file system path for external BIOS splash image. Empty string
3755	means the default image is shown on boot.
3756	</desc>
3757	</attribute>
3758
3759	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3760	<desc>Mode of the BIOS boot device menu.</desc>
3761	</attribute>
3762
3763	<attribute name="ACPIEnabled" type="boolean">
3764	<desc>ACPI support flag.</desc>
3765	</attribute>
3766
3767	<attribute name="IOAPICEnabled" type="boolean">
3768	<desc>
3769	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3770	and support IRQs above 15.
3771	</desc>
3772	</attribute>
3773
3774	<attribute name="timeOffset" type="long long">
3775	<desc>
3776	Offset in milliseconds from the host system time. This allows for
3777	guests running with a different system date/time than the host.
3778	It is equivalent to setting the system date/time in the BIOS except
3779	it is not an absolute value but a relative one. Guest Additions
3780	time synchronization honors this offset.
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="PXEDebugEnabled" type="boolean">
3785	<desc>
3786	PXE debug logging flag. If set, VirtualBox will write extensive
3787	PXE trace information to the release log.
3788	</desc>
3789	</attribute>
3790	</interface>
3791
3792	<interface
3793	name="IPCIAddress" extends="$unknown"
3794	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3795	wsmap="struct"
3796	>
3797
3798	<desc>
3799	Address on the PCI bus.
3800	</desc>
3801
3802	<attribute name="bus" type="short">
3803	<desc>
3804	Bus number.
3805	</desc>
3806	</attribute>
3807
3808	<attribute name="device" type="short">
3809	<desc>
3810	Device number.
3811	</desc>
3812	</attribute>
3813
3814	<attribute name="devFunction" type="short">
3815	<desc>
3816	Device function number.
3817	</desc>
3818	</attribute>
3819
3820	<method name="asLong">
3821	<desc>
3822	Convert PCI address into long.
3823	</desc>
3824	<param name="result" type="long" dir="return" />
3825	</method>
3826
3827	<method name="fromLong">
3828	<desc>
3829	Make PCI address from long.
3830	</desc>
3831	<param name="number" type="long" dir="in" />
3832	</method>
3833	</interface>
3834
3835	<interface
3836	name="IPCIDeviceAttachment" extends="$unknown"
3837	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3838	wsmap="struct"
3839	>
3840
3841	<desc>
3842	Information about PCI attachments.
3843	</desc>
3844
3845	<attribute name="name" type="wstring" readonly="yes">
3846	<desc>
3847	Device name.
3848	</desc>
3849	</attribute>
3850
3851	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3852	<desc>
3853	If this is physical or virtual device.
3854	</desc>
3855	</attribute>
3856
3857	<attribute name="hostAddress" type="long" readonly="yes">
3858	<desc>
3859	Address of device on the host, applicable only to host devices.
3860	</desc>
3861	</attribute>
3862
3863	<attribute name="guestAddress" type="long" readonly="yes">
3864	<desc>
3865	Address of device on the guest.
3866	</desc>
3867	</attribute>
3868
3869	</interface>
3870
3871	<enum
3872	name="GraphicsControllerType"
3873	uuid="79c96ca0-9f39-4900-948e-68c41cbe127a"
3874	>
3875	<desc>Graphics controller type, used with <link to="IMachine::unregister" />.
3876	</desc>
3877	<const name="Null" value="0">
3878	<desc>Reserved value, invalid.</desc>
3879	</const>
3880	<const name="VBoxVGA" value="1">
3881	<desc>Default VirtualBox VGA device.</desc>
3882	</const>
3883	</enum>
3884
3885	<enum
3886	name="CleanupMode"
3887	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3888	>
3889	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3890	</desc>
3891	<const name="UnregisterOnly" value="1">
3892	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3893	</const>
3894	<const name="DetachAllReturnNone" value="2">
3895	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3896	</const>
3897	<const name="DetachAllReturnHardDisksOnly" value="3">
3898	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3899	</const>
3900	<const name="Full" value="4">
3901	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3902	</const>
3903	</enum>
3904
3905	<enum
3906	name="CloneMode" extends="$unknown"
3907	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3908	>
3909
3910	<desc>
3911	Clone mode, used with <link to="IMachine::cloneTo" />.
3912	</desc>
3913
3914	<const name="MachineState" value="1">
3915	<desc>Clone the state of the selected machine.</desc>
3916	</const>
3917	<const name="MachineAndChildStates" value="2">
3918	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3919	</const>
3920	<const name="AllStates" value="3">
3921	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3922	</const>
3923
3924	</enum>
3925
3926	<enum
3927	name="CloneOptions" extends="$unknown"
3928	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3929	>
3930
3931	<desc>
3932	Clone options, used with <link to="IMachine::cloneTo" />.
3933	</desc>
3934
3935	<const name="Link" value="1">
3936	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3937	</const>
3938	<const name="KeepAllMACs" value="2">
3939	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3940	</const>
3941	<const name="KeepNATMACs" value="3">
3942	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3943	</const>
3944	<const name="KeepDiskNames" value="4">
3945	<desc>Don't change the disk names.</desc>
3946	</const>
3947
3948	</enum>
3949
3950	<enum
3951	name="AutostopType" extends="$unknown"
3952	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3953	>
3954
3955	<desc>
3956	Autostop types, used with <link to="IMachine::autostopType" />.
3957	</desc>
3958
3959	<const name="Disabled" value="1">
3960	<desc>Stopping the VM during system shutdown is disabled.</desc>
3961	</const>
3962	<const name="SaveState" value="2">
3963	<desc>The state of the VM will be saved when the system shuts down.</desc>
3964	</const>
3965	<const name="PowerOff" value="3">
3966	<desc>The VM is powered off when the system shuts down.</desc>
3967	</const>
3968	<const name="AcpiShutdown" value="4">
3969	<desc>An ACPI shutdown event is generated.</desc>
3970	</const>
3971
3972	</enum>
3973
3974
3975	<interface
3976	name="IMachine" extends="$unknown"
3977	uuid="1af27b33-9e69-44a5-b6d2-d375dd329a73"
3978	wsmap="managed"
3979	>
3980	<desc>
3981	The IMachine interface represents a virtual machine, or guest, created
3982	in VirtualBox.
3983
3984	This interface is used in two contexts. First of all, a collection of
3985	objects implementing this interface is stored in the
3986	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3987	machines that are currently registered with this VirtualBox
3988	installation. Also, once a session has been opened for the given virtual
3989	machine (e.g. the virtual machine is running), the machine object
3990	associated with the open session can be queried from the session object;
3991	see <link to="ISession"/> for details.
3992
3993	The main role of this interface is to expose the settings of the virtual
3994	machine and provide methods to change various aspects of the virtual
3995	machine's configuration. For machine objects stored in the
3996	<link to="IVirtualBox::machines"/> collection, all attributes are
3997	read-only unless explicitly stated otherwise in individual attribute
3998	and method descriptions.
3999
4000	In order to change a machine setting, a session for this machine must be
4001	opened using one of the <link to="IMachine::lockMachine" /> or
4002	<link to="IMachine::launchVMProcess"/> methods. After the
4003	machine has been successfully locked for a session, a mutable machine object
4004	needs to be queried from the session object and then the desired settings
4005	changes can be applied to the returned object using IMachine attributes and
4006	methods. See the <link to="ISession"/> interface description for more
4007	information about sessions.
4008
4009	Note that IMachine does not provide methods to control virtual machine
4010	execution (such as start the machine, or power it down) -- these methods
4011	are grouped in a separate interface called <link to="IConsole" />.
4012
4013	<see><link to="ISession"/>, <link to="IConsole"/></see>
4014	</desc>
4015
4016	<attribute name="parent" type="IVirtualBox" readonly="yes">
4017	<desc>Associated parent object.</desc>
4018	</attribute>
4019
4020	<attribute name="accessible" type="boolean" readonly="yes">
4021	<desc>
4022	Whether this virtual machine is currently accessible or not.
4023
4024	A machine is always deemed accessible unless it is registered <i>and</i>
4025	its settings file cannot be read or parsed (either because the file itself
4026	is unavailable or has invalid XML contents).
4027
4028	Every time this property is read, the accessibility state of
4029	this machine is re-evaluated. If the returned value is @c false,
4030	the <link to="#accessError"/> property may be used to get the
4031	detailed error information describing the reason of
4032	inaccessibility, including XML error messages.
4033
4034	When the machine is inaccessible, only the following properties
4035	can be used on it:
4036	<ul>
4037	<li><link to="#parent"/></li>
4038	<li><link to="#id"/></li>
4039	<li><link to="#settingsFilePath"/></li>
4040	<li><link to="#accessible"/></li>
4041	<li><link to="#accessError"/></li>
4042	</ul>
4043
4044	An attempt to access any other property or method will return
4045	an error.
4046
4047	The only possible action you can perform on an inaccessible
4048	machine is to unregister it using the
4049	<link to="IMachine::unregister"/> call (or, to check
4050	for the accessibility state once more by querying this
4051	property).
4052
4053	<note>
4054	In the current implementation, once this property returns
4055	@c true, the machine will never become inaccessible
4056	later, even if its settings file cannot be successfully
4057	read/written any more (at least, until the VirtualBox
4058	server is restarted). This limitation may be removed in
4059	future releases.
4060	</note>
4061	</desc>
4062	</attribute>
4063
4064	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
4065	<desc>
4066	Error information describing the reason of machine
4067	inaccessibility.
4068
4069	Reading this property is only valid after the last call to
4070	<link to="#accessible"/> returned @c false (i.e. the
4071	machine is currently inaccessible). Otherwise, a @c null
4072	IVirtualBoxErrorInfo object will be returned.
4073	</desc>
4074	</attribute>
4075
4076	<attribute name="name" type="wstring">
4077	<desc>
4078	Name of the virtual machine.
4079
4080	Besides being used for human-readable identification purposes
4081	everywhere in VirtualBox, the virtual machine name is also used
4082	as a name of the machine's settings file and as a name of the
4083	subdirectory this settings file resides in. Thus, every time you
4084	change the value of this property, the settings file will be
4085	renamed once you call <link to="#saveSettings"/> to confirm the
4086	change. The containing subdirectory will be also renamed, but
4087	only if it has exactly the same name as the settings file
4088	itself prior to changing this property (for backward compatibility
4089	with previous API releases). The above implies the following
4090	limitations:
4091	<ul>
4092	<li>The machine name cannot be empty.</li>
4093	<li>The machine name can contain only characters that are valid
4094	file name characters according to the rules of the file
4095	system used to store VirtualBox configuration.</li>
4096	<li>You cannot have two or more machines with the same name
4097	if they use the same subdirectory for storing the machine
4098	settings files.</li>
4099	<li>You cannot change the name of the machine if it is running,
4100	or if any file in the directory containing the settings file
4101	is being used by another running machine or by any other
4102	process in the host operating system at a time when
4103	<link to="#saveSettings"/> is called.
4104	</li>
4105	</ul>
4106	If any of the above limitations are hit, <link to="#saveSettings"/>
4107	will return an appropriate error message explaining the exact
4108	reason and the changes you made to this machine will not be saved.
4109
4110	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
4111	file is recommended, but not enforced. (Previous versions always
4112	used a generic ".xml" extension.)
4113	</desc>
4114	</attribute>
4115
4116	<attribute name="description" type="wstring">
4117	<desc>
4118	Description of the virtual machine.
4119
4120	The description attribute can contain any text and is
4121	typically used to describe the hardware and software
4122	configuration of the virtual machine in detail (i.e. network
4123	settings, versions of the installed software and so on).
4124	</desc>
4125	</attribute>
4126
4127	<attribute name="id" type="uuid" mod="string" readonly="yes">
4128	<desc>UUID of the virtual machine.</desc>
4129	</attribute>
4130
4131	<attribute name="groups" type="wstring" safearray="yes">
4132	<desc>
4133	Array of machine group names of which this machine is a member.
4134	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
4135	group is only listed once, however they are listed in no particular
4136	order and there is no guarantee that there are no gaps in the group
4137	hierarchy (i.e. <tt>"/group"</tt>,
4138	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
4139	</desc>
4140	</attribute>
4141
4142	<attribute name="OSTypeId" type="wstring">
4143	<desc>
4144	User-defined identifier of the Guest OS type.
4145	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
4146	an IGuestOSType object representing details about the given
4147	Guest OS type.
4148	<note>
4149	This value may differ from the value returned by
4150	<link to="IGuest::OSTypeId"/> if Guest Additions are
4151	installed to the guest OS.
4152	</note>
4153	</desc>
4154	</attribute>
4155
4156	<attribute name="hardwareVersion" type="wstring">
4157	<desc>Hardware version identifier. Internal use only for now.</desc>
4158	</attribute>
4159
4160	<attribute name="hardwareUUID" type="uuid" mod="string">
4161	<desc>
4162	The UUID presented to the guest via memory tables, hardware and guest
4163	properties. For most VMs this is the same as the @a id, but for VMs
4164	which have been cloned or teleported it may be the same as the source
4165	VM. The latter is because the guest shouldn't notice that it was
4166	cloned or teleported.
4167	</desc>
4168	</attribute>
4169
4170	<attribute name="CPUCount" type="unsigned long">
4171	<desc>Number of virtual CPUs in the VM.</desc>
4172	</attribute>
4173
4174	<attribute name="CPUHotPlugEnabled" type="boolean">
4175	<desc>
4176	This setting determines whether VirtualBox allows CPU
4177	hotplugging for this machine.</desc>
4178	</attribute>
4179
4180	<attribute name="CPUExecutionCap" type="unsigned long">
4181	<desc>
4182	Means to limit the number of CPU cycles a guest can use. The unit
4183	is percentage of host CPU cycles per second. The valid range
4184	is 1 - 100. 100 (the default) implies no limit.
4185	</desc>
4186	</attribute>
4187
4188	<attribute name="memorySize" type="unsigned long">
4189	<desc>System memory size in megabytes.</desc>
4190	</attribute>
4191
4192	<attribute name="memoryBalloonSize" type="unsigned long">
4193	<desc>Memory balloon size in megabytes.</desc>
4194	</attribute>
4195
4196	<attribute name="pageFusionEnabled" type="boolean">
4197	<desc>
4198	This setting determines whether VirtualBox allows page
4199	fusion for this machine (64 bits host only).
4200	</desc>
4201	</attribute>
4202
4203	<attribute name="graphicsControllerType" type="GraphicsControllerType">
4204	<desc>Graphics controller type.</desc>
4205	</attribute>
4206
4207	<attribute name="VRAMSize" type="unsigned long">
4208	<desc>Video memory size in megabytes.</desc>
4209	</attribute>
4210
4211	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4212	<desc>
4213	This setting determines whether VirtualBox allows this machine to make
4214	use of the 3D graphics support available on the host.</desc>
4215	</attribute>
4216
4217	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4218	<desc>
4219	This setting determines whether VirtualBox allows this machine to make
4220	use of the 2D video acceleration support available on the host.</desc>
4221	</attribute>
4222
4223	<attribute name="monitorCount" type="unsigned long">
4224	<desc>
4225	Number of virtual monitors.
4226	<note>
4227	Only effective on Windows XP and later guests with
4228	Guest Additions installed.
4229	</note>
4230	</desc>
4231	</attribute>
4232
4233	<attribute name="VideoCaptureEnabled" type="boolean" default="false">
4234	<desc>
4235	This setting determines whether VirtualBox uses video recording to
4236	record VM session.</desc>
4237	</attribute>
4238
4239	<attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
4240	<desc>
4241	This setting determines what filename VirtualBox uses to save
4242	the recorded content.</desc>
4243	</attribute>
4244
4245	<attribute name="VideoCaptureWidth" type="unsigned long" default="640">
4246	<desc>
4247	This setting determines what should be the horizontal resolution of
4248	recorded video.</desc>
4249	</attribute>
4250
4251	<attribute name="VideoCaptureHeight" type="unsigned long" default="480">
4252	<desc>
4253	This setting determines what should be the vertical resolution
4254	of recorded video.</desc>
4255	</attribute>
4256
4257	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4258	<desc>Object containing all BIOS settings.</desc>
4259	</attribute>
4260
4261	<attribute name="firmwareType" type="FirmwareType">
4262	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4263	bootstrap in this VM.</desc>
4264	</attribute>
4265
4266	<attribute name="pointingHIDType" type="PointingHIDType">
4267	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4268	The default is typically "PS2Mouse" but can vary depending on the
4269	requirements of the guest operating system.</desc>
4270	</attribute>
4271
4272	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4273	<desc>Type of keyboard HID used in this VM.
4274	The default is typically "PS2Keyboard" but can vary depending on the
4275	requirements of the guest operating system.</desc>
4276	</attribute>
4277
4278	<attribute name="HPETEnabled" type="boolean">
4279	<desc>This attribute controls if High Precision Event Timer (HPET) is
4280	enabled in this VM. Use this property if you want to provide guests
4281	with additional time source, or if guest requires HPET to function correctly.
4282	Default is false.</desc>
4283	</attribute>
4284
4285	<attribute name="chipsetType" type="ChipsetType">
4286	<desc>Chipset type used in this VM.</desc>
4287	</attribute>
4288
4289	<attribute name="snapshotFolder" type="wstring">
4290	<desc>
4291	Full path to the directory used to store snapshot data
4292	(differencing media and saved state files) of this machine.
4293
4294	The initial value of this property is
4295	<tt><</tt><link to="#settingsFilePath">
4296	path_to_settings_file</link><tt>>/<</tt>
4297	<link to="#id">machine_uuid</link>
4298	<tt>></tt>.
4299
4300	Currently, it is an error to try to change this property on
4301	a machine that has snapshots (because this would require to
4302	move possibly large files to a different location).
4303	A separate method will be available for this purpose later.
4304
4305	<note>
4306	Setting this property to @c null or to an empty string will restore
4307	the initial value.
4308	</note>
4309	<note>
4310	When setting this property, the specified path can be
4311	absolute (full path) or relative to the directory where the
4312	<link to="#settingsFilePath">machine settings file</link>
4313	is located. When reading this property, a full path is
4314	always returned.
4315	</note>
4316	<note>
4317	The specified path may not exist, it will be created
4318	when necessary.
4319	</note>
4320	</desc>
4321	</attribute>
4322
4323	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4324	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4325	</attribute>
4326
4327	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4328	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4329
4330	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4331	<desc>Array of media attached to this machine.</desc>
4332	</attribute>
4333
4334	<attribute name="USBController" type="IUSBController" readonly="yes">
4335	<desc>
4336	Associated USB controller object.
4337
4338	<note>
4339	If USB functionality is not available in the given edition of
4340	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4341	</note>
4342	</desc>
4343	</attribute>
4344
4345	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4346	<desc>Associated audio adapter, always present.</desc>
4347	</attribute>
4348
4349	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4350	<desc>Array of storage controllers attached to this machine.</desc>
4351	</attribute>
4352
4353	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4354	<desc>
4355	Full name of the file containing machine settings data.
4356	</desc>
4357	</attribute>
4358
4359	<attribute name="settingsModified" type="boolean" readonly="yes">
4360	<desc>
4361	Whether the settings of this machine have been modified
4362	(but neither yet saved nor discarded).
4363	<note>
4364	Reading this property is only valid on instances returned
4365	by <link to="ISession::machine"/> and on new machines
4366	created by <link to="IVirtualBox::createMachine"/> or opened
4367	by <link to="IVirtualBox::openMachine"/> but not
4368	yet registered, or on unregistered machines after calling
4369	<link to="IMachine::unregister"/>. For all other
4370	cases, the settings can never be modified.
4371	</note>
4372	<note>
4373	For newly created unregistered machines, the value of this
4374	property is always @c true until <link to="#saveSettings"/>
4375	is called (no matter if any machine settings have been
4376	changed after the creation or not). For opened machines
4377	the value is set to @c false (and then follows to normal rules).
4378	</note>
4379	</desc>
4380	</attribute>
4381
4382	<attribute name="sessionState" type="SessionState" readonly="yes">
4383	<desc>Current session state for this machine.</desc>
4384	</attribute>
4385
4386	<attribute name="sessionType" type="wstring" readonly="yes">
4387	<desc>
4388	Type of the session. If <link to="#sessionState"/> is
4389	Spawning or Locked, this attribute contains the
4390	same value as passed to the
4391	<link to="IMachine::launchVMProcess"/> method in the
4392	@a type parameter. If the session was used with
4393	<link to="IMachine::lockMachine" />, or if
4394	<link to="#sessionState"/> is SessionClosed, the value of this
4395	attribute is an empty string.
4396	</desc>
4397	</attribute>
4398
4399	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4400	<desc>
4401	Identifier of the session process. This attribute contains the
4402	platform-dependent identifier of the process whose session was
4403	used with <link to="IMachine::lockMachine" /> call. The returned
4404	value is only valid if <link to="#sessionState"/> is Locked or
4405	Unlocking by the time this property is read.
4406	</desc>
4407	</attribute>
4408
4409	<attribute name="state" type="MachineState" readonly="yes">
4410	<desc>Current execution state of this machine.</desc>
4411	</attribute>
4412
4413	<attribute name="lastStateChange" type="long long" readonly="yes">
4414	<desc>
4415	Time stamp of the last execution state change,
4416	in milliseconds since 1970-01-01 UTC.
4417	</desc>
4418	</attribute>
4419
4420	<attribute name="stateFilePath" type="wstring" readonly="yes">
4421	<desc>
4422	Full path to the file that stores the execution state of
4423	the machine when it is in the <link to="MachineState_Saved"/> state.
4424	<note>
4425	When the machine is not in the Saved state, this attribute is
4426	an empty string.
4427	</note>
4428	</desc>
4429	</attribute>
4430
4431	<attribute name="logFolder" type="wstring" readonly="yes">
4432	<desc>
4433	Full path to the folder that stores a set of rotated log files
4434	recorded during machine execution. The most recent log file is
4435	named <tt>VBox.log</tt>, the previous log file is
4436	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4437	in the current version).
4438	</desc>
4439	</attribute>
4440
4441	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4442	<desc>
4443	Current snapshot of this machine. This is @c null if the machine
4444	currently has no snapshots. If it is not @c null, then it was
4445	set by one of <link to="IConsole::takeSnapshot" />,
4446	<link to="IConsole::deleteSnapshot" />
4447	or <link to="IConsole::restoreSnapshot" />, depending on which
4448	was called last. See <link to="ISnapshot"/> for details.
4449	</desc>
4450	</attribute>
4451
4452	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4453	<desc>
4454	Number of snapshots taken on this machine. Zero means the
4455	machine doesn't have any snapshots.
4456	</desc>
4457	</attribute>
4458
4459	<attribute name="currentStateModified" type="boolean" readonly="yes">
4460	<desc>
4461	Returns @c true if the current state of the machine is not
4462	identical to the state stored in the current snapshot.
4463
4464	The current state is identical to the current snapshot only
4465	directly after one of the following calls are made:
4466
4467	<ul>
4468	<li><link to="IConsole::restoreSnapshot"/>
4469	</li>
4470	<li><link to="IConsole::takeSnapshot"/> (issued on a
4471	"powered off" or "saved" machine, for which
4472	<link to="#settingsModified"/> returns @c false)
4473	</li>
4474	</ul>
4475
4476	The current state remains identical until one of the following
4477	happens:
4478	<ul>
4479	<li>settings of the machine are changed</li>
4480	<li>the saved state is deleted</li>
4481	<li>the current snapshot is deleted</li>
4482	<li>an attempt to execute the machine is made</li>
4483	</ul>
4484
4485	<note>
4486	For machines that don't have snapshots, this property is
4487	always @c false.
4488	</note>
4489	</desc>
4490	</attribute>
4491
4492	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4493	<desc>
4494	Collection of shared folders for this machine (permanent shared
4495	folders). These folders are shared automatically at machine startup
4496	and available only to the guest OS installed within this machine.
4497
4498	New shared folders are added to the collection using
4499	<link to="#createSharedFolder"/>. Existing shared folders can be
4500	removed using <link to="#removeSharedFolder"/>.
4501	</desc>
4502	</attribute>
4503
4504	<attribute name="clipboardMode" type="ClipboardMode">
4505	<desc>
4506	Synchronization mode between the host OS clipboard
4507	and the guest OS clipboard.
4508	</desc>
4509	</attribute>
4510
4511	<attribute name="dragAndDropMode" type="DragAndDropMode">
4512	<desc>
4513	Which mode is allowed for drag'n'drop.
4514	</desc>
4515	</attribute>
4516
4517	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4518	<desc>
4519	A comma-separated list of simple glob patterns. Changes to guest
4520	properties whose name matches one of the patterns will generate an
4521	<link to="IGuestPropertyChangedEvent"/> signal.
4522	</desc>
4523	</attribute>
4524
4525	<attribute name="teleporterEnabled" type="boolean">
4526	<desc>
4527	When set to @a true, the virtual machine becomes a target teleporter
4528	the next time it is powered on. This can only set to @a true when the
4529	VM is in the @a PoweredOff or @a Aborted state.
4530
4531	<!-- This property is automatically set to @a false when the VM is powered
4532	on. (bird: This doesn't work yet ) -->
4533	</desc>
4534	</attribute>
4535
4536	<attribute name="teleporterPort" type="unsigned long">
4537	<desc>
4538	The TCP port the target teleporter will listen for incoming
4539	teleportations on.
4540
4541	0 means the port is automatically selected upon power on. The actual
4542	value can be read from this property while the machine is waiting for
4543	incoming teleportations.
4544	</desc>
4545	</attribute>
4546
4547	<attribute name="teleporterAddress" type="wstring">
4548	<desc>
4549	The address the target teleporter will listen on. If set to an empty
4550	string, it will listen on all addresses.
4551	</desc>
4552	</attribute>
4553
4554	<attribute name="teleporterPassword" type="wstring">
4555	<desc>
4556	The password to check for on the target teleporter. This is just a
4557	very basic measure to prevent simple hacks and operators accidentally
4558	beaming a virtual machine to the wrong place.
4559
4560	Note that you SET a plain text password while reading back a HASHED
4561	password. Setting a hashed password is currently not supported.
4562	</desc>
4563	</attribute>
4564
4565	<attribute name="faultToleranceState" type="FaultToleranceState">
4566	<desc>
4567	Fault tolerance state; disabled, source or target.
4568	This property can be changed at any time. If you change it for a running
4569	VM, then the fault tolerance address and port must be set beforehand.
4570	</desc>
4571	</attribute>
4572
4573	<attribute name="faultTolerancePort" type="unsigned long">
4574	<desc>
4575	The TCP port the fault tolerance source or target will use for
4576	communication.
4577	</desc>
4578	</attribute>
4579
4580	<attribute name="faultToleranceAddress" type="wstring">
4581	<desc>
4582	The address the fault tolerance source or target.
4583	</desc>
4584	</attribute>
4585
4586	<attribute name="faultTolerancePassword" type="wstring">
4587	<desc>
4588	The password to check for on the standby VM. This is just a
4589	very basic measure to prevent simple hacks and operators accidentally
4590	choosing the wrong standby VM.
4591	</desc>
4592	</attribute>
4593
4594	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4595	<desc>
4596	The interval in ms used for syncing the state between source and target.
4597	</desc>
4598	</attribute>
4599
4600	<attribute name="RTCUseUTC" type="boolean">
4601	<desc>
4602	When set to @a true, the RTC device of the virtual machine will run
4603	in UTC time, otherwise in local time. Especially Unix guests prefer
4604	the time in UTC.
4605	</desc>
4606	</attribute>
4607
4608	<attribute name="IOCacheEnabled" type="boolean">
4609	<desc>
4610	When set to @a true, the builtin I/O cache of the virtual machine
4611	will be enabled.
4612	</desc>
4613	</attribute>
4614
4615	<attribute name="IOCacheSize" type="unsigned long">
4616	<desc>
4617	Maximum size of the I/O cache in MB.
4618	</desc>
4619	</attribute>
4620
4621	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4622	<desc>Array of PCI devices assigned to this machine, to get list of all
4623	PCI devices attached to the machine use
4624	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4625	is intended to list only devices additional to what described in
4626	virtual hardware config. Usually, this list keeps host's physical
4627	devices assigned to the particular machine.
4628	</desc>
4629	</attribute>
4630
4631	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4632	<desc>
4633	Bandwidth control manager.
4634	</desc>
4635	</attribute>
4636
4637	<attribute name="tracingEnabled" type="boolean">
4638	<desc>
4639	Enables the tracing facility in the VMM (including PDM devices +
4640	drivers). The VMM will consume about 0.5MB of more memory when
4641	enabled and there may be some extra overhead from tracepoints that are
4642	always enabled.
4643	</desc>
4644	</attribute>
4645
4646	<attribute name="tracingConfig" type="wstring">
4647	<desc>
4648	Tracepoint configuration to apply at startup when
4649	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4650	a space separated of tracepoint group names to enable. The special
4651	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4652	more details on available tracepoint groups and such.
4653
4654	Note that on hosts supporting DTrace (or similar), a lot of the
4655	tracepoints may be implemented exclusivly as DTrace probes. So, the
4656	effect of the same config may differ between Solaris and Windows for
4657	example.
4658	</desc>
4659	</attribute>
4660
4661	<attribute name="allowTracingToAccessVM" type="boolean">
4662	<desc>
4663	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4664	structures when firing off trace points. This is especially useful
4665	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4666	pointer to obtain useful information such as guest register state.
4667
4668	This is disabled by default because devices and drivers normally has no
4669	business accessing the VMCPU or VM structures, and are therefore unable
4670	to get any pointers to these.
4671	</desc>
4672	</attribute>
4673
4674	<attribute name="autostartEnabled" type="boolean">
4675	<desc>
4676	Enables autostart of the VM during system boot.
4677	</desc>
4678	</attribute>
4679
4680	<attribute name="autostartDelay" type="unsigned long">
4681	<desc>
4682	Number of seconds to wait until the VM should be started during system boot.
4683	</desc>
4684	</attribute>
4685
4686	<attribute name="autostopType" type="AutostopType">
4687	<desc>
4688	Action type to do when the system is shutting down.
4689	</desc>
4690	</attribute>
4691
4692	<attribute name="defaultFrontend" type="wstring">
4693	<desc>
4694	Selects which VM frontend should be used by default when launching
4695	this VM through the <link to="IMachine::launchVMProcess" /> method.
4696	Empty or @c null strings do not define a particular default, it is up
4697	to <link to="IMachine::launchVMProcess" /> to select one. See the
4698	description of <link to="IMachine::launchVMProcess" /> for the valid
4699	frontend types.
4700
4701	This per-VM setting overrides the default defined by
4702	<link to="ISystemProperties::defaultFrontend" /> attribute, and is
4703	overridden by a frontend type passed to
4704	<link to="IMachine::launchVMProcess" />.
4705	</desc>
4706	</attribute>
4707
4708	<method name="lockMachine">
4709	<desc>
4710	Locks the machine for the given session to enable the caller
4711	to make changes to the machine or start the VM or control
4712	VM execution.
4713
4714	There are two ways to lock a machine for such uses:
4715
4716	<ul>
4717	<li>If you want to make changes to the machine settings,
4718	you must obtain an exclusive write lock on the machine
4719	by setting @a lockType to @c Write.
4720
4721	This will only succeed if no other process has locked
4722	the machine to prevent conflicting changes. Only after
4723	an exclusive write lock has been obtained using this method, one
4724	can change all VM settings or execute the VM in the process
4725	space of the session object. (Note that the latter is only of
4726	interest if you actually want to write a new front-end for
4727	virtual machines; but this API gets called internally by
4728	the existing front-ends such as VBoxHeadless and the VirtualBox
4729	GUI to acquire a write lock on the machine that they are running.)
4730
4731	On success, write-locking the machine for a session creates
4732	a second copy of the IMachine object. It is this second object
4733	upon which changes can be made; in VirtualBox terminology, the
4734	second copy is "mutable". It is only this second, mutable machine
4735	object upon which you can call methods that change the
4736	machine state. After having called this method, you can
4737	obtain this second, mutable machine object using the
4738	<link to="ISession::machine" /> attribute.
4739	</li>
4740	<li>If you only want to check the machine state or control
4741	machine execution without actually changing machine
4742	settings (e.g. to get access to VM statistics or take
4743	a snapshot or save the machine state), then set the
4744	@a lockType argument to @c Shared.
4745
4746	If no other session has obtained a lock, you will obtain an
4747	exclusive write lock as described above. However, if another
4748	session has already obtained such a lock, then a link to that
4749	existing session will be established which allows you
4750	to control that existing session.
4751
4752	To find out which type of lock was obtained, you can
4753	inspect <link to="ISession::type" />, which will have been
4754	set to either @c WriteLock or @c Shared.
4755	</li>
4756	</ul>
4757
4758	In either case, you can get access to the <link to="IConsole" />
4759	object which controls VM execution.
4760
4761	Also in all of the above cases, one must always call
4762	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4763	the machine's state will eventually be set to "Aborted".
4764
4765	To change settings on a machine, the following sequence is typically
4766	performed:
4767
4768	<ol>
4769	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4770
4771	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4772
4773	<li>Change the settings of the machine by invoking IMachine methods.</li>
4774
4775	<li>Call <link to="IMachine::saveSettings" />.</li>
4776
4777	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4778	</ol>
4779
4780	<result name="E_UNEXPECTED">
4781	Virtual machine not registered.
4782	</result>
4783	<result name="E_ACCESSDENIED">
4784	Process not started by OpenRemoteSession.
4785	</result>
4786	<result name="VBOX_E_INVALID_OBJECT_STATE">
4787	Session already open or being opened.
4788	</result>
4789	<result name="VBOX_E_VM_ERROR">
4790	Failed to assign machine to session.
4791	</result>
4792	</desc>
4793	<param name="session" type="ISession" dir="in">
4794	<desc>
4795	Session object for which the machine will be locked.
4796	</desc>
4797	</param>
4798	<param name="lockType" type="LockType" dir="in">
4799	<desc>
4800	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4801	If set to @c Shared, then either acquire an exclusive write lock or establish
4802	a link to an existing session.
4803	</desc>
4804	</param>
4805	</method>
4806
4807	<method name="launchVMProcess">
4808	<desc>
4809	Spawns a new process that will execute the virtual machine and obtains a shared
4810	lock on the machine for the calling session.
4811
4812	If launching the VM succeeds, the new VM process will create its own session
4813	and write-lock the machine for it, preventing conflicting changes from other
4814	processes. If the machine is already locked (because it is already running or
4815	because another session has a write lock), launching the VM process will therefore
4816	fail. Reversely, future attempts to obtain a write lock will also fail while the
4817	machine is running.
4818
4819	The caller's session object remains separate from the session opened by the new
4820	VM process. It receives its own <link to="IConsole" /> object which can be used
4821	to control machine execution, but it cannot be used to change all VM settings
4822	which would be available after a <link to="#lockMachine" /> call.
4823
4824	The caller must eventually release the session's shared lock by calling
4825	<link to="ISession::unlockMachine" /> on the local session object once this call
4826	has returned. However, the session's state (see <link to="ISession::state" />)
4827	will not return to "Unlocked" until the remote session has also unlocked
4828	the machine (i.e. the machine has stopped running).
4829
4830	Launching a VM process can take some time (a new VM is started in a new process,
4831	for which memory and other resources need to be set up). Because of this,
4832	an <link to="IProgress" /> object is returned to allow the caller to wait
4833	for this asynchronous operation to be completed. Until then, the caller's
4834	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4835	and <link to="ISession::console" /> attributes cannot be accessed.
4836	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4837	similar calls to wait for completion. Completion is signalled when the VM
4838	is powered on. If launching the VM fails, error messages can be queried
4839	via the progress object, if available.
4840
4841	The progress object will have at least 2 sub-operations. The first
4842	operation covers the period up to the new VM process calls powerUp.
4843	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4844	progress object. Because <link to="IConsole::powerUp"/> may require
4845	some extra sub-operations, the <link to="IProgress::operationCount"/>
4846	may change at the completion of operation.
4847
4848	For details on the teleportation progress operation, see
4849	<link to="IConsole::powerUp"/>.
4850
4851	The @a environment argument is a string containing definitions of
4852	environment variables in the following format:
4853	<pre>
4854	NAME[=VALUE]\n
4855	NAME[=VALUE]\n
4856	...
4857	</pre>
4858	where <tt>\\n</tt> is the new line character. These environment
4859	variables will be appended to the environment of the VirtualBox server
4860	process. If an environment variable exists both in the server process
4861	and in this list, the value from this list takes precedence over the
4862	server's variable. If the value of the environment variable is
4863	omitted, this variable will be removed from the resulting environment.
4864	If the environment string is @c null or empty, the server environment
4865	is inherited by the started process as is.
4866
4867	<result name="E_UNEXPECTED">
4868	Virtual machine not registered.
4869	</result>
4870	<result name="E_INVALIDARG">
4871	Invalid session type @a type.
4872	</result>
4873	<result name="VBOX_E_OBJECT_NOT_FOUND">
4874	No machine matching @a machineId found.
4875	</result>
4876	<result name="VBOX_E_INVALID_OBJECT_STATE">
4877	Session already open or being opened.
4878	</result>
4879	<result name="VBOX_E_IPRT_ERROR">
4880	Launching process for machine failed.
4881	</result>
4882	<result name="VBOX_E_VM_ERROR">
4883	Failed to assign machine to session.
4884	</result>
4885	</desc>
4886	<param name="session" type="ISession" dir="in">
4887	<desc>
4888	Client session object to which the VM process will be connected (this
4889	must be in "Unlocked" state).
4890	</desc>
4891	</param>
4892	<param name="type" type="wstring" dir="in">
4893	<desc>
4894	Front-end to use for the new VM process. The following are currently supported:
4895	<ul>
4896	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4897	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4898	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4899	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4900	the currently running VM or session owner. In this case the
4901	@a session parameter may be @c null (if it is non-null it isn't
4902	used in any way), and the @a progress return value will be always
4903	@c null. The operation completes immediately.</li>
4904	<li><tt>""</tt>: use the per-VM default frontend if set, otherwise
4905	the global default defined in the system properties. If neither
4906	are set, the API will launch a <tt>"gui"</tt> session, which may
4907	fail if there is no windowing environment available. See
4908	<link to="IMachine::defaultFrontend"/> and
4909	<link to="ISystemProperties::defaultFrontend"/>.</li>
4910	</ul>
4911	</desc>
4912	</param>
4913	<param name="environment" type="wstring" dir="in">
4914	<desc>
4915	Environment to pass to the VM process.
4916	</desc>
4917	</param>
4918	<param name="progress" type="IProgress" dir="return">
4919	<desc>Progress object to track the operation completion.</desc>
4920	</param>
4921	</method>
4922
4923	<method name="setBootOrder">
4924	<desc>
4925	Puts the given device to the specified position in
4926	the boot order.
4927
4928	To indicate that no device is associated with the given position,
4929	<link to="DeviceType_Null"/> should be used.
4930
4931	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4932
4933	<result name="E_INVALIDARG">
4934	Boot @a position out of range.
4935	</result>
4936	<result name="E_NOTIMPL">
4937	Booting from USB @a device currently not supported.
4938	</result>
4939
4940	</desc>
4941	<param name="position" type="unsigned long" dir="in">
4942	<desc>
4943	Position in the boot order (@c 1 to the total number of
4944	devices the machine can boot from, as returned by
4945	<link to="ISystemProperties::maxBootPosition"/>).
4946	</desc>
4947	</param>
4948	<param name="device" type="DeviceType" dir="in">
4949	<desc>
4950	The type of the device used to boot at the given position.
4951	</desc>
4952	</param>
4953	</method>
4954
4955	<method name="getBootOrder" const="yes">
4956	<desc>
4957	Returns the device type that occupies the specified
4958	position in the boot order.
4959
4960	@todo [remove?]
4961	If the machine can have more than one device of the returned type
4962	(such as hard disks), then a separate method should be used to
4963	retrieve the individual device that occupies the given position.
4964
4965	If here are no devices at the given position, then
4966	<link to="DeviceType_Null"/> is returned.
4967
4968	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4969
4970	<result name="E_INVALIDARG">
4971	Boot @a position out of range.
4972	</result>
4973
4974	</desc>
4975	<param name="position" type="unsigned long" dir="in">
4976	<desc>
4977	Position in the boot order (@c 1 to the total number of
4978	devices the machine can boot from, as returned by
4979	<link to="ISystemProperties::maxBootPosition"/>).
4980	</desc>
4981	</param>
4982	<param name="device" type="DeviceType" dir="return">
4983	<desc>
4984	Device at the given position.
4985	</desc>
4986	</param>
4987	</method>
4988
4989	<method name="attachDevice">
4990	<desc>
4991	Attaches a device and optionally mounts a medium to the given storage
4992	controller (<link to="IStorageController" />, identified by @a name),
4993	at the indicated port and device.
4994
4995	This method is intended for managing storage devices in general while a
4996	machine is powered off. It can be used to attach and detach fixed
4997	and removable media. The following kind of media can be attached
4998	to a machine:
4999
5000	<ul>
5001	<li>For fixed and removable media, you can pass in a medium that was
5002	previously opened using <link to="IVirtualBox::openMedium" />.
5003	</li>
5004
5005	<li>Only for storage devices supporting removable media (such as
5006	DVDs and floppies), you can also specify a null pointer to
5007	indicate an empty drive or one of the medium objects listed
5008	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
5009	arrays to indicate a host drive.
5010	For removable devices, you can also use <link to="IMachine::mountMedium"/>
5011	to change the media while the machine is running.
5012	</li>
5013	</ul>
5014
5015	In a VM's default configuration of virtual machines, the secondary
5016	master of the IDE controller is used for a CD/DVD drive.
5017
5018	After calling this returns successfully, a new instance of
5019	<link to="IMediumAttachment"/> will appear in the machine's list of medium
5020	attachments (see <link to="IMachine::mediumAttachments"/>).
5021
5022	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
5023	information about attaching media.
5024
5025	The specified device slot must not have a device attached to it,
5026	or this method will fail.
5027
5028	<note>
5029	You cannot attach a device to a newly created machine until
5030	this machine's settings are saved to disk using
5031	<link to="#saveSettings"/>.
5032	</note>
5033	<note>
5034	If the medium is being attached indirectly, a new differencing medium
5035	will implicitly be created for it and attached instead. If the
5036	changes made to the machine settings (including this indirect
5037	attachment) are later cancelled using <link to="#discardSettings"/>,
5038	this implicitly created differencing medium will implicitly
5039	be deleted.
5040	</note>
5041
5042	<result name="E_INVALIDARG">
5043	SATA device, SATA port, IDE port or IDE slot out of range, or
5044	file or UUID not found.
5045	</result>
5046	<result name="VBOX_E_INVALID_OBJECT_STATE">
5047	Machine must be registered before media can be attached.
5048	</result>
5049	<result name="VBOX_E_INVALID_VM_STATE">
5050	Invalid machine state.
5051	</result>
5052	<result name="VBOX_E_OBJECT_IN_USE">
5053	A medium is already attached to this or another virtual machine.
5054	</result>
5055
5056	</desc>
5057	<param name="name" type="wstring" dir="in">
5058	<desc>Name of the storage controller to attach the device to.</desc>
5059	</param>
5060	<param name="controllerPort" type="long" dir="in">
5061	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5062	the primary controller and 1 specifies the secondary controller.
5063	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5064	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5065	</param>
5066	<param name="device" type="long" dir="in">
5067	<desc>Device slot in the given port to attach the device to. This is only
5068	relevant for IDE controllers, for which 0 specifies the master device and
5069	1 specifies the slave device. For all other controller types, this must
5070	be 0.</desc>
5071	</param>
5072	<param name="type" type="DeviceType" dir="in">
5073	<desc>Device type of the attached device. For media opened by
5074	<link to="IVirtualBox::openMedium" />, this must match the device type
5075	specified there.</desc>
5076	</param>
5077	<param name="medium" type="IMedium" dir="in">
5078	<desc>Medium to mount or @c null for an empty drive.</desc>
5079	</param>
5080	</method>
5081
5082	<method name="attachDeviceWithoutMedium">
5083	<desc>
5084	Attaches a device and optionally mounts a medium to the given storage
5085	controller (<link to="IStorageController" />, identified by @a name),
5086	at the indicated port and device.
5087
5088	This method is intended for managing storage devices in general while a
5089	machine is powered off. It can be used to attach and detach fixed
5090	and removable media. The following kind of media can be attached
5091	to a machine:
5092	<ul>
5093	<li>
5094	For fixed and removable media, you can pass in a medium that was
5095	previously opened using <link to="IVirtualBox::openMedium" />.
5096	</li>
5097
5098	<li>Only for storage devices supporting removable media (such as
5099	DVDs and floppies) with an empty drive or one of the medium objects listed
5100	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
5101	arrays to indicate a host drive.
5102	For removable devices, you can also use <link to="IMachine::mountMedium"/>
5103	to change the media while the machine is running.
5104	</li>
5105	</ul>
5106
5107	In a VM's default configuration of virtual machines, the secondary
5108	master of the IDE controller is used for a CD/DVD drive.
5109	<link to="IMediumAttachment"/> will appear in the machine's list of medium
5110	attachments (see <link to="IMachine::mediumAttachments"/>).
5111
5112	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
5113	information about attaching media.
5114
5115	The specified device slot must not have a device attached to it,
5116	or this method will fail.
5117	<note>
5118	You cannot attach a device to a newly created machine until
5119	this machine's settings are saved to disk using
5120	<link to="#saveSettings"/>.
5121	</note>
5122	<note>
5123	If the medium is being attached indirectly, a new differencing medium
5124	will implicitly be created for it and attached instead. If the
5125	changes made to the machine settings (including this indirect
5126	attachment) are later cancelled using <link to="#discardSettings"/>,
5127	this implicitly created differencing medium will implicitly
5128	be deleted.
5129	</note>
5130
5131	<result name="E_INVALIDARG">
5132	SATA device, SATA port, IDE port or IDE slot out of range, or
5133	file or UUID not found.
5134	</result>
5135	<result name="VBOX_E_INVALID_OBJECT_STATE">
5136	Machine must be registered before media can be attached.
5137	</result>
5138	<result name="VBOX_E_INVALID_VM_STATE">
5139	Invalid machine state.
5140	</result>
5141	<result name="VBOX_E_OBJECT_IN_USE">
5142	A medium is already attached to this or another virtual machine.
5143	</result>
5144	</desc>
5145	<param name="name" type="wstring" dir="in">
5146	<desc>Name of the storage controller to attach the device to.</desc>
5147	</param>
5148	<param name="controllerPort" type="long" dir="in">
5149	<desc>Port to attach the device to. For an IDE controller, 0 specifies
5150	the primary controller and 1 specifies the secondary controller.
5151	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
5152	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
5153	</param>
5154	<param name="device" type="long" dir="in">
5155	<desc>Device slot in the given port to attach the device to. This is only
5156	relevant for IDE controllers, for which 0 specifies the master device and
5157	1 specifies the slave device. For all other controller types, this must
5158	be 0.</desc>
5159	</param>
5160	<param name="type" type="DeviceType" dir="in">
5161	<desc>Device type of the attached device. For media opened by
5162	<link to="IVirtualBox::openMedium" />, this must match the device type
5163	specified there.</desc>
5164	</param>
5165	</method>
5166
5167	<method name="detachDevice">
5168	<desc>
5169	Detaches the device attached to a device slot of the specified bus.
5170
5171	Detaching the device from the virtual machine is deferred. This means
5172	that the medium remains associated with the machine when this method
5173	returns and gets actually de-associated only after a successful
5174	<link to="#saveSettings"/> call. See <link to="IMedium"/>
5175	for more detailed information about attaching media.
5176
5177	<note>
5178	You cannot detach a device from a running machine.
5179	</note>
5180	<note>
5181	Detaching differencing media implicitly created by <link
5182	to="#attachDevice"/> for the indirect attachment using this
5183	method will <b>not</b> implicitly delete them. The
5184	<link to="IMedium::deleteStorage"/> operation should be
5185	explicitly performed by the caller after the medium is successfully
5186	detached and the settings are saved with
5187	<link to="#saveSettings"/>, if it is the desired action.
5188	</note>
5189
5190	<result name="VBOX_E_INVALID_VM_STATE">
5191	Attempt to detach medium from a running virtual machine.
5192	</result>
5193	<result name="VBOX_E_OBJECT_NOT_FOUND">
5194	No medium attached to given slot/bus.
5195	</result>
5196	<result name="VBOX_E_NOT_SUPPORTED">
5197	Medium format does not support storage deletion (only for implicitly
5198	created differencing media, should not happen).
5199	</result>
5200
5201	</desc>
5202	<param name="name" type="wstring" dir="in">
5203	<desc>Name of the storage controller to detach the medium from.</desc>
5204	</param>
5205	<param name="controllerPort" type="long" dir="in">
5206	<desc>Port number to detach the medium from.</desc>
5207	</param>
5208	<param name="device" type="long" dir="in">
5209	<desc>Device slot number to detach the medium from.</desc>
5210	</param>
5211	</method>
5212
5213	<method name="passthroughDevice">
5214	<desc>
5215	Sets the passthrough mode of an existing DVD device. Changing the
5216	setting while the VM is running is forbidden. The setting is only used
5217	if at VM start the device is configured as a host DVD drive, in all
5218	other cases it is ignored. The device must already exist; see
5219	<link to="IMachine::attachDevice"/> for how to attach a new device.
5220
5221	The @a controllerPort and @a device parameters specify the device slot and
5222	have have the same meaning as with <link to="IMachine::attachDevice" />.
5223
5224	<result name="E_INVALIDARG">
5225	SATA device, SATA port, IDE port or IDE slot out of range.
5226	</result>
5227	<result name="VBOX_E_INVALID_OBJECT_STATE">
5228	Attempt to modify an unregistered virtual machine.
5229	</result>
5230	<result name="VBOX_E_INVALID_VM_STATE">
5231	Invalid machine state.
5232	</result>
5233
5234	</desc>
5235	<param name="name" type="wstring" dir="in">
5236	<desc>Name of the storage controller.</desc>
5237	</param>
5238	<param name="controllerPort" type="long" dir="in">
5239	<desc>Storage controller port.</desc>
5240	</param>
5241	<param name="device" type="long" dir="in">
5242	<desc>Device slot in the given port.</desc>
5243	</param>
5244	<param name="passthrough" type="boolean" dir="in">
5245	<desc>New value for the passthrough setting.</desc>
5246	</param>
5247	</method>
5248
5249	<method name="temporaryEjectDevice">
5250	<desc>
5251	Sets the behavior for guest-triggered medium eject. In some situations
5252	it is desirable that such ejects update the VM configuration, and in
5253	others the eject should keep the VM configuration. The device must
5254	already exist; see <link to="IMachine::attachDevice"/> for how to
5255	attach a new device.
5256
5257	The @a controllerPort and @a device parameters specify the device slot and
5258	have have the same meaning as with <link to="IMachine::attachDevice" />.
5259
5260	<result name="E_INVALIDARG">
5261	SATA device, SATA port, IDE port or IDE slot out of range.
5262	</result>
5263	<result name="VBOX_E_INVALID_OBJECT_STATE">
5264	Attempt to modify an unregistered virtual machine.
5265	</result>
5266	<result name="VBOX_E_INVALID_VM_STATE">
5267	Invalid machine state.
5268	</result>
5269
5270	</desc>
5271	<param name="name" type="wstring" dir="in">
5272	<desc>Name of the storage controller.</desc>
5273	</param>
5274	<param name="controllerPort" type="long" dir="in">
5275	<desc>Storage controller port.</desc>
5276	</param>
5277	<param name="device" type="long" dir="in">
5278	<desc>Device slot in the given port.</desc>
5279	</param>
5280	<param name="temporaryEject" type="boolean" dir="in">
5281	<desc>New value for the eject behavior.</desc>
5282	</param>
5283	</method>
5284
5285	<method name="nonRotationalDevice">
5286	<desc>
5287	Sets a flag in the device information which indicates that the medium
5288	is not based on rotational technology, i.e. that the access times are
5289	more or less independent of the position on the medium. This may or may
5290	not be supported by a particular drive, and is silently ignored in the
5291	latter case. At the moment only hard disks (which is a misnomer in this
5292	context) accept this setting. Changing the setting while the VM is
5293	running is forbidden. The device must already exist; see
5294	<link to="IMachine::attachDevice"/> for how to attach a new device.
5295
5296	The @a controllerPort and @a device parameters specify the device slot and
5297	have have the same meaning as with <link to="IMachine::attachDevice" />.
5298
5299	<result name="E_INVALIDARG">
5300	SATA device, SATA port, IDE port or IDE slot out of range.
5301	</result>
5302	<result name="VBOX_E_INVALID_OBJECT_STATE">
5303	Attempt to modify an unregistered virtual machine.
5304	</result>
5305	<result name="VBOX_E_INVALID_VM_STATE">
5306	Invalid machine state.
5307	</result>
5308
5309	</desc>
5310	<param name="name" type="wstring" dir="in">
5311	<desc>Name of the storage controller.</desc>
5312	</param>
5313	<param name="controllerPort" type="long" dir="in">
5314	<desc>Storage controller port.</desc>
5315	</param>
5316	<param name="device" type="long" dir="in">
5317	<desc>Device slot in the given port.</desc>
5318	</param>
5319	<param name="nonRotational" type="boolean" dir="in">
5320	<desc>New value for the non-rotational device flag.</desc>
5321	</param>
5322	</method>
5323
5324	<method name="setAutoDiscardForDevice">
5325	<desc>
5326	Sets a flag in the device information which indicates that the medium
5327	supports discarding unsused blocks (called trimming for SATA or unmap
5328	for SCSI devices) .This may or may not be supported by a particular drive,
5329	and is silently ignored in the latter case. At the moment only hard disks
5330	(which is a misnomer in this context) accept this setting. Changing the
5331	setting while the VM is running is forbidden. The device must already
5332	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5333	device.
5334
5335	The @a controllerPort and @a device parameters specify the device slot and
5336	have have the same meaning as with <link to="IMachine::attachDevice" />.
5337
5338	<result name="E_INVALIDARG">
5339	SATA device, SATA port, SCSI port out of range.
5340	</result>
5341	<result name="VBOX_E_INVALID_OBJECT_STATE">
5342	Attempt to modify an unregistered virtual machine.
5343	</result>
5344	<result name="VBOX_E_INVALID_VM_STATE">
5345	Invalid machine state.
5346	</result>
5347
5348	</desc>
5349	<param name="name" type="wstring" dir="in">
5350	<desc>Name of the storage controller.</desc>
5351	</param>
5352	<param name="controllerPort" type="long" dir="in">
5353	<desc>Storage controller port.</desc>
5354	</param>
5355	<param name="device" type="long" dir="in">
5356	<desc>Device slot in the given port.</desc>
5357	</param>
5358	<param name="discard" type="boolean" dir="in">
5359	<desc>New value for the discard device flag.</desc>
5360	</param>
5361	</method>
5362
5363	<method name="setBandwidthGroupForDevice">
5364	<desc>
5365	Sets the bandwidth group of an existing storage device.
5366	The device must already exist; see <link to="IMachine::attachDevice"/>
5367	for how to attach a new device.
5368
5369	The @a controllerPort and @a device parameters specify the device slot and
5370	have have the same meaning as with <link to="IMachine::attachDevice" />.
5371
5372	<result name="E_INVALIDARG">
5373	SATA device, SATA port, IDE port or IDE slot out of range.
5374	</result>
5375	<result name="VBOX_E_INVALID_OBJECT_STATE">
5376	Attempt to modify an unregistered virtual machine.
5377	</result>
5378	<result name="VBOX_E_INVALID_VM_STATE">
5379	Invalid machine state.
5380	</result>
5381
5382	</desc>
5383	<param name="name" type="wstring" dir="in">
5384	<desc>Name of the storage controller.</desc>
5385	</param>
5386	<param name="controllerPort" type="long" dir="in">
5387	<desc>Storage controller port.</desc>
5388	</param>
5389	<param name="device" type="long" dir="in">
5390	<desc>Device slot in the given port.</desc>
5391	</param>
5392	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5393	<desc>New value for the bandwidth group or @c null for no group.</desc>
5394	</param>
5395	</method>
5396
5397	<method name="setNoBandwidthGroupForDevice">
5398	<desc>
5399	Sets no bandwidth group for an existing storage device.
5400	The device must already exist; see <link to="IMachine::attachDevice"/>
5401	for how to attach a new device.
5402	The @a controllerPort and @a device parameters specify the device slot and
5403	have have the same meaning as with <link to="IMachine::attachDevice" />.
5404	<result name="E_INVALIDARG">
5405	SATA device, SATA port, IDE port or IDE slot out of range.
5406	</result>
5407	<result name="VBOX_E_INVALID_OBJECT_STATE">
5408	Attempt to modify an unregistered virtual machine.
5409	</result>
5410	<result name="VBOX_E_INVALID_VM_STATE">
5411	Invalid machine state.
5412	</result>
5413
5414	</desc>
5415	<param name="name" type="wstring" dir="in">
5416	<desc>Name of the storage controller.</desc>
5417	</param>
5418	<param name="controllerPort" type="long" dir="in">
5419	<desc>Storage controller port.</desc>
5420	</param>
5421	<param name="device" type="long" dir="in">
5422	<desc>Device slot in the given port.</desc>
5423	</param>
5424	</method>
5425
5426
5427	<method name="unmountMedium">
5428	<desc>
5429	Unmounts any currently mounted medium (<link to="IMedium" />,
5430	identified by the given UUID @a id) to the given storage controller
5431	(<link to="IStorageController" />, identified by @a name),
5432	at the indicated port and device. The device must already exist;
5433
5434	This method is intended only for managing removable media, where the
5435	device is fixed but media is changeable at runtime (such as DVDs
5436	and floppies). It cannot be used for fixed media such as hard disks.
5437
5438	The @a controllerPort and @a device parameters specify the device slot
5439	and have have the same meaning as with
5440	<link to="IMachine::attachDevice" />.
5441
5442	The specified device slot must have a medium mounted, which will be
5443	unmounted. If there is no mounted medium it will do nothing.
5444	See <link to="IMedium"/> for more detailed information about
5445	attaching/unmounting media.
5446
5447	<result name="E_INVALIDARG">
5448	SATA device, SATA port, IDE port or IDE slot out of range.
5449	</result>
5450	<result name="VBOX_E_INVALID_OBJECT_STATE">
5451	Attempt to unmount medium that is not removeable - not dvd or floppy.
5452	</result>
5453	<result name="VBOX_E_INVALID_VM_STATE">
5454	Invalid machine state.
5455	</result>
5456	<result name="VBOX_E_OBJECT_IN_USE">
5457	Medium already attached to this or another virtual machine.
5458	</result>
5459	<result name="VBOX_E_OBJECT_NOT_FOUND">
5460	Medium not attached to specified port, device, controller.
5461	</result>
5462
5463	</desc>
5464	<param name="name" type="wstring" dir="in">
5465	<desc>Name of the storage controller to unmount the medium from.</desc>
5466	</param>
5467	<param name="controllerPort" type="long" dir="in">
5468	<desc>Port to unmount the medium from.</desc>
5469	</param>
5470	<param name="device" type="long" dir="in">
5471	<desc>Device slot in the given port to unmount the medium from.</desc>
5472	</param>
5473	<param name="force" type="boolean" dir="in">
5474	<desc>Allows to force unmount of a medium which is locked by
5475	the device slot in the given port medium is attached to.</desc>
5476	</param>
5477	</method>
5478
5479	<method name="mountMedium">
5480	<desc>
5481	Mounts a medium (<link to="IMedium" />, identified
5482	by the given UUID @a id) to the given storage controller
5483	(<link to="IStorageController" />, identified by @a name),
5484	at the indicated port and device. The device must already exist;
5485	see <link to="IMachine::attachDevice"/> for how to attach a new device.
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 and
5492	have have the same meaning as with <link to="IMachine::attachDevice" />.
5493
5494	The specified device slot can have a medium mounted, which will be
5495	unmounted first. Specifying a zero UUID (or an empty string) for
5496	@a medium does just an unmount.
5497
5498	See <link to="IMedium"/> for more detailed information about
5499	attaching media.
5500
5501	<result name="E_INVALIDARG">
5502	SATA device, SATA port, IDE port or IDE slot out of range.
5503	</result>
5504	<result name="VBOX_E_INVALID_OBJECT_STATE">
5505	Attempt to attach medium to an unregistered virtual machine.
5506	</result>
5507	<result name="VBOX_E_INVALID_VM_STATE">
5508	Invalid machine state.
5509	</result>
5510	<result name="VBOX_E_OBJECT_IN_USE">
5511	Medium already attached to this or another virtual machine.
5512	</result>
5513
5514	</desc>
5515	<param name="name" type="wstring" dir="in">
5516	<desc>Name of the storage controller to attach the medium to.</desc>
5517	</param>
5518	<param name="controllerPort" type="long" dir="in">
5519	<desc>Port to attach the medium to.</desc>
5520	</param>
5521	<param name="device" type="long" dir="in">
5522	<desc>Device slot in the given port to attach the medium to.</desc>
5523	</param>
5524	<param name="medium" type="IMedium" dir="in">
5525	<desc>Medium to mount or @c null for an empty drive.</desc>
5526	</param>
5527	<param name="force" type="boolean" dir="in">
5528	<desc>Allows to force unmount/mount of a medium which is locked by
5529	the device slot in the given port to attach the medium to.</desc>
5530	</param>
5531	</method>
5532
5533	<method name="getMedium" const="yes">
5534	<desc>
5535	Returns the virtual medium attached to a device slot of the specified
5536	bus.
5537
5538	Note that if the medium was indirectly attached by
5539	<link to="#mountMedium"/> to the given device slot then this
5540	method will return not the same object as passed to the
5541	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5542	more detailed information about mounting a medium.
5543
5544	<result name="VBOX_E_OBJECT_NOT_FOUND">
5545	No medium attached to given slot/bus.
5546	</result>
5547
5548	</desc>
5549	<param name="name" type="wstring" dir="in">
5550	<desc>Name of the storage controller the medium is attached to.</desc>
5551	</param>
5552	<param name="controllerPort" type="long" dir="in">
5553	<desc>Port to query.</desc>
5554	</param>
5555	<param name="device" type="long" dir="in">
5556	<desc>Device slot in the given port to query.</desc>
5557	</param>
5558	<param name="medium" type="IMedium" dir="return">
5559	<desc>Attached medium object.</desc>
5560	</param>
5561	</method>
5562
5563	<method name="getMediumAttachmentsOfController" const="yes">
5564	<desc>
5565	Returns an array of medium attachments which are attached to the
5566	the controller with the given name.
5567
5568	<result name="VBOX_E_OBJECT_NOT_FOUND">
5569	A storage controller with given name doesn't exist.
5570	</result>
5571	</desc>
5572	<param name="name" type="wstring" dir="in"/>
5573	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5574	</method>
5575
5576	<method name="getMediumAttachment" const="yes">
5577	<desc>
5578	Returns a medium attachment which corresponds to the controller with
5579	the given name, on the given port and device slot.
5580
5581	<result name="VBOX_E_OBJECT_NOT_FOUND">
5582	No attachment exists for the given controller/port/device combination.
5583	</result>
5584	</desc>
5585	<param name="name" type="wstring" dir="in"/>
5586	<param name="controllerPort" type="long" dir="in"/>
5587	<param name="device" type="long" dir="in"/>
5588	<param name="attachment" type="IMediumAttachment" dir="return"/>
5589	</method>
5590
5591	<method name="attachHostPCIDevice">
5592	<desc>
5593	Attaches host PCI device with the given (host) PCI address to the
5594	PCI bus of the virtual machine. Please note, that this operation
5595	is two phase, as real attachment will happen when VM will start,
5596	and most information will be delivered as IHostPCIDevicePlugEvent
5597	on IVirtualBox event source.
5598
5599	<see><link to="IHostPCIDevicePlugEvent"/></see>
5600
5601	<result name="VBOX_E_INVALID_VM_STATE">
5602	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5603	</result>
5604	<result name="VBOX_E_PDM_ERROR">
5605	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5606	</result>
5607	<result name="VBOX_E_NOT_SUPPORTED">
5608	Hardware or host OS doesn't allow PCI device passthrought.
5609	</result>
5610	</desc>
5611	<param name="hostAddress" type="long" dir="in">
5612	<desc>Address of the host PCI device.</desc>
5613	</param>
5614	<param name="desiredGuestAddress" type="long" dir="in">
5615	<desc>Desired position of this device on guest PCI bus.</desc>
5616	</param>
5617	<param name="tryToUnbind" type="boolean" dir="in">
5618	<desc>If VMM shall try to unbind existing drivers from the
5619	device before attaching it to the guest.</desc>
5620	</param>
5621	</method>
5622
5623	<method name="detachHostPCIDevice">
5624	<desc>
5625	Detach host PCI device from the virtual machine.
5626	Also HostPCIDevicePlugEvent on IVirtualBox event source
5627	will be delivered. As currently we don't support hot device
5628	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5629
5630	<see><link to="IHostPCIDevicePlugEvent"/></see>
5631
5632	<result name="VBOX_E_INVALID_VM_STATE">
5633	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5634	</result>
5635	<result name="VBOX_E_OBJECT_NOT_FOUND">
5636	This host device is not attached to this machine.
5637	</result>
5638	<result name="VBOX_E_PDM_ERROR">
5639	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5640	</result>
5641	<result name="VBOX_E_NOT_SUPPORTED">
5642	Hardware or host OS doesn't allow PCI device passthrought.
5643	</result>
5644	</desc>
5645	<param name="hostAddress" type="long" dir="in">
5646	<desc>Address of the host PCI device.</desc>
5647	</param>
5648	</method>
5649
5650	<method name="getNetworkAdapter" const="yes">
5651	<desc>
5652	Returns the network adapter associated with the given slot.
5653	Slots are numbered sequentially, starting with zero. The total
5654	number of adapters per machine is defined by the
5655	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5656	so the maximum slot number is one less than that property's value.
5657
5658	<result name="E_INVALIDARG">
5659	Invalid @a slot number.
5660	</result>
5661
5662	</desc>
5663	<param name="slot" type="unsigned long" dir="in"/>
5664	<param name="adapter" type="INetworkAdapter" dir="return"/>
5665	</method>
5666
5667	<method name="addStorageController">
5668	<desc>
5669	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5670	machine and returns it as an instance of
5671	<link to="IStorageController" />.
5672
5673	@a name identifies the controller for subsequent calls such as
5674	<link to="#getStorageControllerByName" />,
5675	<link to="#getStorageControllerByInstance" />,
5676	<link to="#removeStorageController" />,
5677	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5678
5679	After the controller has been added, you can set its exact
5680	type by setting the <link to="IStorageController::controllerType" />.
5681
5682	<result name="VBOX_E_OBJECT_IN_USE">
5683	A storage controller with given name exists already.
5684	</result>
5685	<result name="E_INVALIDARG">
5686	Invalid @a controllerType.
5687	</result>
5688	</desc>
5689	<param name="name" type="wstring" dir="in"/>
5690	<param name="connectionType" type="StorageBus" dir="in"/>
5691	<param name="controller" type="IStorageController" dir="return"/>
5692	</method>
5693
5694	<method name="getStorageControllerByName" const="yes">
5695	<desc>
5696	Returns a storage controller with the given name.
5697
5698	<result name="VBOX_E_OBJECT_NOT_FOUND">
5699	A storage controller with given name doesn't exist.
5700	</result>
5701	</desc>
5702	<param name="name" type="wstring" dir="in"/>
5703	<param name="storageController" type="IStorageController" dir="return"/>
5704	</method>
5705
5706	<method name="getStorageControllerByInstance" const="yes">
5707	<desc>
5708	Returns a storage controller with the given instance number.
5709
5710	<result name="VBOX_E_OBJECT_NOT_FOUND">
5711	A storage controller with given instance number doesn't exist.
5712	</result>
5713	</desc>
5714	<param name="instance" type="unsigned long" dir="in"/>
5715	<param name="storageController" type="IStorageController" dir="return"/>
5716	</method>
5717
5718	<method name="removeStorageController">
5719	<desc>
5720	Removes a storage controller from the machine with all devices attached to it.
5721
5722	<result name="VBOX_E_OBJECT_NOT_FOUND">
5723	A storage controller with given name doesn't exist.
5724	</result>
5725	<result name="VBOX_E_NOT_SUPPORTED">
5726	Medium format does not support storage deletion (only for implicitly
5727	created differencing media, should not happen).
5728	</result>
5729	</desc>
5730	<param name="name" type="wstring" dir="in"/>
5731	</method>
5732
5733	<method name="setStorageControllerBootable">
5734	<desc>
5735	Sets the bootable flag of the storage controller with the given name.
5736
5737	<result name="VBOX_E_OBJECT_NOT_FOUND">
5738	A storage controller with given name doesn't exist.
5739	</result>
5740	<result name="VBOX_E_OBJECT_IN_USE">
5741	Another storage controller is marked as bootable already.
5742	</result>
5743	</desc>
5744	<param name="name" type="wstring" dir="in"/>
5745	<param name="bootable" type="boolean" dir="in"/>
5746	</method>
5747
5748	<method name="getSerialPort" const="yes">
5749	<desc>
5750	Returns the serial port associated with the given slot.
5751	Slots are numbered sequentially, starting with zero. The total
5752	number of serial ports per machine is defined by the
5753	<link to="ISystemProperties::serialPortCount"/> property,
5754	so the maximum slot number is one less than that property's value.
5755
5756	<result name="E_INVALIDARG">
5757	Invalid @a slot number.
5758	</result>
5759
5760	</desc>
5761	<param name="slot" type="unsigned long" dir="in"/>
5762	<param name="port" type="ISerialPort" dir="return"/>
5763	</method>
5764
5765	<method name="getParallelPort" const="yes">
5766	<desc>
5767	Returns the parallel port associated with the given slot.
5768	Slots are numbered sequentially, starting with zero. The total
5769	number of parallel ports per machine is defined by the
5770	<link to="ISystemProperties::parallelPortCount"/> property,
5771	so the maximum slot number is one less than that property's value.
5772
5773	<result name="E_INVALIDARG">
5774	Invalid @a slot number.
5775	</result>
5776
5777	</desc>
5778	<param name="slot" type="unsigned long" dir="in"/>
5779	<param name="port" type="IParallelPort" dir="return"/>
5780	</method>
5781
5782	<method name="getExtraDataKeys">
5783	<desc>
5784	Returns an array representing the machine-specific extra data keys
5785	which currently have values defined.
5786	</desc>
5787	<param name="keys" type="wstring" dir="return" safearray="yes">
5788	<desc>Array of extra data keys.</desc>
5789	</param>
5790	</method>
5791
5792	<method name="getExtraData">
5793	<desc>
5794	Returns associated machine-specific extra data.
5795
5796	If the requested data @a key does not exist, this function will
5797	succeed and return an empty string in the @a value argument.
5798
5799	<result name="VBOX_E_FILE_ERROR">
5800	Settings file not accessible.
5801	</result>
5802	<result name="VBOX_E_XML_ERROR">
5803	Could not parse the settings file.
5804	</result>
5805
5806	</desc>
5807	<param name="key" type="wstring" dir="in">
5808	<desc>Name of the data key to get.</desc>
5809	</param>
5810	<param name="value" type="wstring" dir="return">
5811	<desc>Value of the requested data key.</desc>
5812	</param>
5813	</method>
5814
5815	<method name="setExtraData">
5816	<desc>
5817	Sets associated machine-specific extra data.
5818
5819	If you pass @c null or an empty string as a key @a value, the given
5820	@a key will be deleted.
5821
5822	<note>
5823	Before performing the actual data change, this method will ask all
5824	registered listeners using the
5825	<link to="IExtraDataCanChangeEvent"/>
5826	notification for a permission. If one of the listeners refuses the
5827	new value, the change will not be performed.
5828	</note>
5829	<note>
5830	On success, the
5831	<link to="IExtraDataChangedEvent"/> notification
5832	is called to inform all registered listeners about a successful data
5833	change.
5834	</note>
5835	<note>
5836	This method can be called outside the machine session and therefore
5837	it's a caller's responsibility to handle possible race conditions
5838	when several clients change the same key at the same time.
5839	</note>
5840
5841	<result name="VBOX_E_FILE_ERROR">
5842	Settings file not accessible.
5843	</result>
5844	<result name="VBOX_E_XML_ERROR">
5845	Could not parse the settings file.
5846	</result>
5847
5848	</desc>
5849	<param name="key" type="wstring" dir="in">
5850	<desc>Name of the data key to set.</desc>
5851	</param>
5852	<param name="value" type="wstring" dir="in">
5853	<desc>Value to assign to the key.</desc>
5854	</param>
5855	</method>
5856
5857	<method name="getCPUProperty" const="yes">
5858	<desc>
5859	Returns the virtual CPU boolean value of the specified property.
5860
5861	<result name="E_INVALIDARG">
5862	Invalid property.
5863	</result>
5864
5865	</desc>
5866	<param name="property" type="CPUPropertyType" dir="in">
5867	<desc>
5868	Property type to query.
5869	</desc>
5870	</param>
5871	<param name="value" type="boolean" dir="return">
5872	<desc>
5873	Property value.
5874	</desc>
5875	</param>
5876	</method>
5877
5878	<method name="setCPUProperty">
5879	<desc>
5880	Sets the virtual CPU boolean value of the specified property.
5881
5882	<result name="E_INVALIDARG">
5883	Invalid property.
5884	</result>
5885
5886	</desc>
5887	<param name="property" type="CPUPropertyType" dir="in">
5888	<desc>
5889	Property type to query.
5890	</desc>
5891	</param>
5892	<param name="value" type="boolean" dir="in">
5893	<desc>
5894	Property value.
5895	</desc>
5896	</param>
5897	</method>
5898
5899	<method name="getCPUIDLeaf" const="yes">
5900	<desc>
5901	Returns the virtual CPU cpuid information for the specified leaf.
5902
5903	Currently supported index values for cpuid:
5904	Standard CPUID leafs: 0 - 0xA
5905	Extended CPUID leafs: 0x80000000 - 0x8000000A
5906
5907	See the Intel and AMD programmer's manuals for detailed information
5908	about the cpuid instruction and its leafs.
5909	<result name="E_INVALIDARG">
5910	Invalid id.
5911	</result>
5912
5913	</desc>
5914	<param name="id" type="unsigned long" dir="in">
5915	<desc>
5916	CPUID leaf index.
5917	</desc>
5918	</param>
5919	<param name="valEax" type="unsigned long" dir="out">
5920	<desc>
5921	CPUID leaf value for register eax.
5922	</desc>
5923	</param>
5924	<param name="valEbx" type="unsigned long" dir="out">
5925	<desc>
5926	CPUID leaf value for register ebx.
5927	</desc>
5928	</param>
5929	<param name="valEcx" type="unsigned long" dir="out">
5930	<desc>
5931	CPUID leaf value for register ecx.
5932	</desc>
5933	</param>
5934	<param name="valEdx" type="unsigned long" dir="out">
5935	<desc>
5936	CPUID leaf value for register edx.
5937	</desc>
5938	</param>
5939	</method>
5940
5941	<method name="setCPUIDLeaf">
5942	<desc>
5943	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5944	are not passed unmodified. VirtualBox clears features that it doesn't support.
5945
5946	Currently supported index values for cpuid:
5947	Standard CPUID leafs: 0 - 0xA
5948	Extended CPUID leafs: 0x80000000 - 0x8000000A
5949
5950	See the Intel and AMD programmer's manuals for detailed information
5951	about the cpuid instruction and its leafs.
5952
5953	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5954	random crashes inside VMs.
5955	<result name="E_INVALIDARG">
5956	Invalid id.
5957	</result>
5958
5959	</desc>
5960	<param name="id" type="unsigned long" dir="in">
5961	<desc>
5962	CPUID leaf index.
5963	</desc>
5964	</param>
5965	<param name="valEax" type="unsigned long" dir="in">
5966	<desc>
5967	CPUID leaf value for register eax.
5968	</desc>
5969	</param>
5970	<param name="valEbx" type="unsigned long" dir="in">
5971	<desc>
5972	CPUID leaf value for register ebx.
5973	</desc>
5974	</param>
5975	<param name="valEcx" type="unsigned long" dir="in">
5976	<desc>
5977	CPUID leaf value for register ecx.
5978	</desc>
5979	</param>
5980	<param name="valEdx" type="unsigned long" dir="in">
5981	<desc>
5982	CPUID leaf value for register edx.
5983	</desc>
5984	</param>
5985	</method>
5986
5987	<method name="removeCPUIDLeaf">
5988	<desc>
5989	Removes the virtual CPU cpuid leaf for the specified index
5990
5991	<result name="E_INVALIDARG">
5992	Invalid id.
5993	</result>
5994
5995	</desc>
5996	<param name="id" type="unsigned long" dir="in">
5997	<desc>
5998	CPUID leaf index.
5999	</desc>
6000	</param>
6001	</method>
6002
6003	<method name="removeAllCPUIDLeaves">
6004	<desc>
6005	Removes all the virtual CPU cpuid leaves
6006	</desc>
6007	</method>
6008
6009	<method name="getHWVirtExProperty" const="yes">
6010	<desc>
6011	Returns the value of the specified hardware virtualization boolean property.
6012
6013	<result name="E_INVALIDARG">
6014	Invalid property.
6015	</result>
6016
6017	</desc>
6018	<param name="property" type="HWVirtExPropertyType" dir="in">
6019	<desc>
6020	Property type to query.
6021	</desc>
6022	</param>
6023	<param name="value" type="boolean" dir="return">
6024	<desc>
6025	Property value.
6026	</desc>
6027	</param>
6028	</method>
6029
6030	<method name="setHWVirtExProperty">
6031	<desc>
6032	Sets a new value for the specified hardware virtualization boolean property.
6033
6034	<result name="E_INVALIDARG">
6035	Invalid property.
6036	</result>
6037
6038	</desc>
6039	<param name="property" type="HWVirtExPropertyType" dir="in">
6040	<desc>
6041	Property type to set.
6042	</desc>
6043	</param>
6044	<param name="value" type="boolean" dir="in">
6045	<desc>
6046	New property value.
6047	</desc>
6048	</param>
6049	</method>
6050
6051	<method name="saveSettings">
6052	<desc>
6053	Saves any changes to machine settings made since the session
6054	has been opened or a new machine has been created, or since the
6055	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
6056	For registered machines, new settings become visible to all
6057	other VirtualBox clients after successful invocation of this
6058	method.
6059	<note>
6060	The method sends <link to="IMachineDataChangedEvent"/>
6061	notification event after the configuration has been successfully
6062	saved (only for registered machines).
6063	</note>
6064	<note>
6065	Calling this method is only valid on instances returned
6066	by <link to="ISession::machine"/> and on new machines
6067	created by <link to="IVirtualBox::createMachine"/> but not
6068	yet registered, or on unregistered machines after calling
6069	<link to="IMachine::unregister"/>.
6070	</note>
6071
6072	<result name="VBOX_E_FILE_ERROR">
6073	Settings file not accessible.
6074	</result>
6075	<result name="VBOX_E_XML_ERROR">
6076	Could not parse the settings file.
6077	</result>
6078	<result name="E_ACCESSDENIED">
6079	Modification request refused.
6080	</result>
6081
6082	</desc>
6083	</method>
6084
6085	<method name="discardSettings">
6086	<desc>
6087	Discards any changes to the machine settings made since the session
6088	has been opened or since the last call to <link to="#saveSettings"/>
6089	or <link to="#discardSettings"/>.
6090	<note>
6091	Calling this method is only valid on instances returned
6092	by <link to="ISession::machine"/> and on new machines
6093	created by <link to="IVirtualBox::createMachine"/> or
6094	opened by <link to="IVirtualBox::openMachine"/> but not
6095	yet registered, or on unregistered machines after calling
6096	<link to="IMachine::unregister"/>.
6097	</note>
6098
6099	<result name="VBOX_E_INVALID_VM_STATE">
6100	Virtual machine is not mutable.
6101	</result>
6102
6103	</desc>
6104	</method>
6105
6106	<method name="unregister">
6107	<desc>
6108	Unregisters a machine previously registered with
6109	<link to="IVirtualBox::registerMachine"/> and optionally do additional
6110	cleanup before the machine is unregistered.
6111
6112	This method does not delete any files. It only changes the machine configuration and
6113	the list of registered machines in the VirtualBox object. To delete the files which
6114	belonged to the machine, including the XML file of the machine itself, call
6115	<link to="#deleteConfig"/>, optionally with the array of IMedium objects which was returned
6116	from this method.
6117
6118	How thoroughly this method cleans up the machine configuration before unregistering
6119	the machine depends on the @a cleanupMode argument.
6120
6121	<ul>
6122	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
6123	cleanup will be performed. The call will fail if the machine is in "Saved" state
6124	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
6125	It is the responsibility of the caller to delete all such configuration in this mode.
6126	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
6127	which it replaces.</li>
6128	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
6129	state or if it has snapshots or media attached. All media attached to the current machine
6130	state or in snapshots will be detached. No medium objects will be returned;
6131	all of the machine's media will remain open.</li>
6132	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
6133	except that all the hard disk medium objects which were detached from the machine will
6134	be returned as an array. This allows for quickly passing them to the <link to="#deleteConfig" />
6135	API for closing and deletion.</li>
6136	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
6137	that all media will be returned in the array, including removable media like DVDs and
6138	floppies. This might be useful if the user wants to inspect in detail which media were
6139	attached to the machine. Be careful when passing the media array to <link to="#deleteConfig" />
6140	in that case because users will typically want to preserve ISO and RAW image files.</li>
6141	</ul>
6142
6143	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
6144	resulting IMedium array to <link to="#deleteConfig"/>. This way, the machine is completely
6145	deleted with all its saved states and hard disk images, but images for removable
6146	drives (such as ISO and RAW files) will remain on disk.
6147
6148	This API does not verify whether the media files returned in the array are still
6149	attached to other machines (i.e. shared between several machines). If such a shared
6150	image is passed to <link to="#deleteConfig" /> however, closing the image will fail there
6151	and the image will be silently skipped.
6152
6153	This API may, however, move media from this machine's media registry to other media
6154	registries (see <link to="IMedium" /> for details on media registries). For machines
6155	created with VirtualBox 4.0 or later, if media from this machine's media registry
6156	are also attached to another machine (shared attachments), each such medium will be
6157	moved to another machine's registry. This is because without this machine's media
6158	registry, the other machine cannot find its media any more and would become inaccessible.
6159
6160	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
6161	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
6162	if media are moved to other machines' media registries.
6163
6164	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
6165	is fired.
6166
6167	The call will fail if the machine is currently locked (see <link to="ISession" />).
6168
6169	<note>
6170	If the given machine is inaccessible (see <link to="#accessible"/>), it
6171	will be unregistered and fully uninitialized right afterwards. As a result,
6172	the returned machine object will be unusable and an attempt to call
6173	<b>any</b> method will return the "Object not ready" error.
6174	</note>
6175
6176	<result name="VBOX_E_INVALID_OBJECT_STATE">
6177	Machine is currently locked for a session.
6178	</result>
6179	</desc>
6180
6181	<param name="cleanupMode" type="CleanupMode" dir="in">
6182	<desc>How to clean up after the machine has been unregistered.</desc>
6183	</param>
6184	<param name="media" type="IMedium" safearray="yes" dir="return">
6185	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
6186	</param>
6187	</method>
6188
6189	<method name="deleteConfig">
6190	<desc>
6191	Deletes the files associated with this machine from disk. If medium objects are passed
6192	in with the @a aMedia argument, they are closed and, if closing was successful, their
6193	storage files are deleted as well. For convenience, this array of media files can be
6194	the same as the one returned from a previous <link to="#unregister" /> call.
6195
6196	This method must only be called on machines which are either write-locked (i.e. on instances
6197	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
6198	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
6199	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
6200
6201	The following files will be deleted by this method:
6202	<ul>
6203	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
6204	argument other than "UnregisterOnly", this will delete all saved state files that
6205	the machine had in use; possibly one if the machine was in "Saved" state and one
6206	for each online snapshot that the machine had.</li>
6207	<li>On each medium object passed in the @a aMedia array, this will call
6208	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
6209	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
6210	in use, e.g. because it is still attached to a second machine; in that case the
6211	storage will not be deleted.</li>
6212	<li>Finally, the machine's own XML file will be deleted.</li>
6213	</ul>
6214
6215	Since deleting large disk image files can be a time-consuming I/O operation, this
6216	method operates asynchronously and returns an IProgress object to allow the caller
6217	to monitor the progress. There will be one sub-operation for each file that is
6218	being deleted (saved state or medium storage file).
6219
6220	<note>
6221	<link to="#settingsModified"/> will return @c true after this
6222	method successfully returns.
6223	</note>
6224
6225	<result name="VBOX_E_INVALID_VM_STATE">
6226	Machine is registered but not write-locked.
6227	</result>
6228	<result name="VBOX_E_IPRT_ERROR">
6229	Could not delete the settings file.
6230	</result>
6231	</desc>
6232	<param name="media" type="IMedium" safearray="yes" dir="in">
6233	<desc>List of media to be closed and whose storage files will be deleted.</desc>
6234	</param>
6235	<param name="progress" type="IProgress" dir="return">
6236	<desc>Progress object to track the operation completion.</desc>
6237	</param>
6238	</method>
6239
6240	<method name="exportTo">
6241	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6242	steps required to export VirtualBox machines to OVF.
6243	</desc>
6244
6245	<param name="appliance" type="IAppliance" dir="in">
6246	<desc>Appliance to export this machine to.</desc>
6247	</param>
6248	<param name="location" type="wstring" dir="in">
6249	<desc>The target location.</desc>
6250	</param>
6251	<param name="description" type="IVirtualSystemDescription" dir="return">
6252	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6253	</param>
6254	</method >
6255
6256	<method name="findSnapshot">
6257	<desc>
6258	Returns a snapshot of this machine with the given name or UUID.
6259
6260	Returns a snapshot of this machine with the given UUID.
6261	A @c null argument can be used to obtain the first snapshot
6262	taken on this machine. To traverse the whole tree of snapshots
6263	starting from the root, inspect the root snapshot's
6264	<link to="ISnapshot::children" /> attribute and recurse over those children.
6265
6266	<result name="VBOX_E_OBJECT_NOT_FOUND">
6267	Virtual machine has no snapshots or snapshot not found.
6268	</result>
6269
6270	</desc>
6271	<param name="nameOrId" type="wstring" dir="in">
6272	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6273	</param>
6274	<param name="snapshot" type="ISnapshot" dir="return">
6275	<desc>Snapshot object with the given name.</desc>
6276	</param>
6277	</method>
6278
6279	<method name="createSharedFolder">
6280	<desc>
6281	Creates a new permanent shared folder by associating the given logical
6282	name with the given host path, adds it to the collection of shared
6283	folders and starts sharing it. Refer to the description of
6284	<link to="ISharedFolder"/> to read more about logical names.
6285
6286	<result name="VBOX_E_OBJECT_IN_USE">
6287	Shared folder already exists.
6288	</result>
6289	<result name="VBOX_E_FILE_ERROR">
6290	Shared folder @a hostPath not accessible.
6291	</result>
6292
6293	</desc>
6294	<param name="name" type="wstring" dir="in">
6295	<desc>Unique logical name of the shared folder.</desc>
6296	</param>
6297	<param name="hostPath" type="wstring" dir="in">
6298	<desc>Full path to the shared folder in the host file system.</desc>
6299	</param>
6300	<param name="writable" type="boolean" dir="in">
6301	<desc>Whether the share is writable or readonly.</desc>
6302	</param>
6303	<param name="automount" type="boolean" dir="in">
6304	<desc>Whether the share gets automatically mounted by the guest
6305	or not.</desc>
6306	</param>
6307	</method>
6308
6309	<method name="removeSharedFolder">
6310	<desc>
6311	Removes the permanent shared folder with the given name previously
6312	created by <link to="#createSharedFolder"/> from the collection of
6313	shared folders and stops sharing it.
6314
6315	<result name="VBOX_E_INVALID_VM_STATE">
6316	Virtual machine is not mutable.
6317	</result>
6318	<result name="VBOX_E_OBJECT_NOT_FOUND">
6319	Shared folder @a name does not exist.
6320	</result>
6321
6322	</desc>
6323	<param name="name" type="wstring" dir="in">
6324	<desc>Logical name of the shared folder to remove.</desc>
6325	</param>
6326	</method>
6327
6328	<method name="canShowConsoleWindow">
6329	<desc>
6330	Returns @c true if the VM console process can activate the
6331	console window and bring it to foreground on the desktop of
6332	the host PC.
6333	<note>
6334	This method will fail if a session for this machine is not
6335	currently open.
6336	</note>
6337
6338	<result name="VBOX_E_INVALID_VM_STATE">
6339	Machine session is not open.
6340	</result>
6341
6342	</desc>
6343	<param name="canShow" type="boolean" dir="return">
6344	<desc>
6345	@c true if the console window can be shown and @c false otherwise.
6346	</desc>
6347	</param>
6348	</method>
6349
6350	<method name="showConsoleWindow">
6351	<desc>
6352	Activates the console window and brings it to foreground on
6353	the desktop of the host PC. Many modern window managers on
6354	many platforms implement some sort of focus stealing
6355	prevention logic, so that it may be impossible to activate
6356	a window without the help of the currently active
6357	application. In this case, this method will return a non-zero
6358	identifier that represents the top-level window of the VM
6359	console process. The caller, if it represents a currently
6360	active process, is responsible to use this identifier (in a
6361	platform-dependent manner) to perform actual window
6362	activation.
6363	<note>
6364	This method will fail if a session for this machine is not
6365	currently open.
6366	</note>
6367
6368	<result name="VBOX_E_INVALID_VM_STATE">
6369	Machine session is not open.
6370	</result>
6371
6372	</desc>
6373	<param name="winId" type="long long" dir="return">
6374	<desc>
6375	Platform-dependent identifier of the top-level VM console
6376	window, or zero if this method has performed all actions
6377	necessary to implement the <i>show window</i> semantics for
6378	the given platform and/or VirtualBox front-end.
6379	</desc>
6380	</param>
6381	</method>
6382
6383	<method name="getGuestProperty" const="yes">
6384	<desc>
6385	Reads an entry from the machine's guest property store.
6386
6387	<result name="VBOX_E_INVALID_VM_STATE">
6388	Machine session is not open.
6389	</result>
6390
6391	</desc>
6392	<param name="name" type="wstring" dir="in">
6393	<desc>
6394	The name of the property to read.
6395	</desc>
6396	</param>
6397	<param name="value" type="wstring" dir="out">
6398	<desc>
6399	The value of the property. If the property does not exist then this
6400	will be empty.
6401	</desc>
6402	</param>
6403	<param name="timestamp" type="long long" dir="out">
6404	<desc>
6405	The time at which the property was last modified, as seen by the
6406	server process.
6407	</desc>
6408	</param>
6409	<param name="flags" type="wstring" dir="out">
6410	<desc>
6411	Additional property parameters, passed as a comma-separated list of
6412	"name=value" type entries.
6413	</desc>
6414	</param>
6415	</method>
6416
6417	<method name="getGuestPropertyValue" const="yes">
6418	<desc>
6419	Reads a value from the machine's guest property store.
6420
6421	<result name="VBOX_E_INVALID_VM_STATE">
6422	Machine session is not open.
6423	</result>
6424
6425	</desc>
6426	<param name="property" type="wstring" dir="in">
6427	<desc>
6428	The name of the property to read.
6429	</desc>
6430	</param>
6431	<param name="value" type="wstring" dir="return">
6432	<desc>
6433	The value of the property. If the property does not exist then this
6434	will be empty.
6435	</desc>
6436	</param>
6437	</method>
6438
6439	<method name="getGuestPropertyTimestamp" const="yes">
6440	<desc>
6441	Reads a property timestamp from the machine's guest property store.
6442
6443	<result name="VBOX_E_INVALID_VM_STATE">
6444	Machine session is not open.
6445	</result>
6446
6447	</desc>
6448	<param name="property" type="wstring" dir="in">
6449	<desc>
6450	The name of the property to read.
6451	</desc>
6452	</param>
6453	<param name="value" type="long long" dir="return">
6454	<desc>
6455	The timestamp. If the property does not exist then this will be
6456	empty.
6457	</desc>
6458	</param>
6459	</method>
6460
6461	<method name="setGuestProperty">
6462	<desc>
6463	Sets, changes or deletes an entry in the machine's guest property
6464	store.
6465
6466	<result name="E_ACCESSDENIED">
6467	Property cannot be changed.
6468	</result>
6469	<result name="E_INVALIDARG">
6470	Invalid @a flags.
6471	</result>
6472	<result name="VBOX_E_INVALID_VM_STATE">
6473	Virtual machine is not mutable or session not open.
6474	</result>
6475	<result name="VBOX_E_INVALID_OBJECT_STATE">
6476	Cannot set transient property when machine not running.
6477	</result>
6478
6479	</desc>
6480	<param name="property" type="wstring" dir="in">
6481	<desc>
6482	The name of the property to set, change or delete.
6483	</desc>
6484	</param>
6485	<param name="value" type="wstring" dir="in">
6486	<desc>
6487	The new value of the property to set, change or delete. If the
6488	property does not yet exist and value is non-empty, it will be
6489	created. If the value is @c null or empty, the property will be
6490	deleted if it exists.
6491	</desc>
6492	</param>
6493	<param name="flags" type="wstring" dir="in">
6494	<desc>
6495	Additional property parameters, passed as a comma-separated list of
6496	"name=value" type entries.
6497	</desc>
6498	</param>
6499	</method>
6500
6501	<method name="setGuestPropertyValue">
6502	<desc>
6503	Sets or changes a value in the machine's guest property
6504	store. The flags field will be left unchanged or created empty for a
6505	new property.
6506
6507	<result name="E_ACCESSDENIED">
6508	Property cannot be changed.
6509	</result>
6510	<result name="VBOX_E_INVALID_VM_STATE">
6511	Virtual machine is not mutable or session not open.
6512	</result>
6513	<result name="VBOX_E_INVALID_OBJECT_STATE">
6514	Cannot set transient property when machine not running.
6515	</result>
6516	</desc>
6517
6518	<param name="property" type="wstring" dir="in">
6519	<desc>
6520	The name of the property to set or change.
6521	</desc>
6522	</param>
6523	<param name="value" type="wstring" dir="in">
6524	<desc>
6525	The new value of the property to set or change. If the
6526	property does not yet exist and value is non-empty, it will be
6527	created.
6528	</desc>
6529	</param>
6530	</method>
6531
6532	<method name="deleteGuestProperty" const="yes">
6533	<desc>
6534	Deletes an entry from the machine's guest property store.
6535
6536	<result name="VBOX_E_INVALID_VM_STATE">
6537	Machine session is not open.
6538	</result>
6539
6540	</desc>
6541	<param name="name" type="wstring" dir="in">
6542	<desc>
6543	The name of the property to delete.
6544	</desc>
6545	</param>
6546	</method>
6547
6548	<method name="enumerateGuestProperties" const="yes">
6549	<desc>
6550	Return a list of the guest properties matching a set of patterns along
6551	with their values, time stamps and flags.
6552	</desc>
6553	<param name="patterns" type="wstring" dir="in">
6554	<desc>
6555	The patterns to match the properties against, separated by '\|'
6556	characters. If this is empty or @c null, all properties will match.
6557	</desc>
6558	</param>
6559	<param name="names" type="wstring" dir="out" safearray="yes">
6560	<desc>
6561	The names of the properties returned.
6562	</desc>
6563	</param>
6564	<param name="values" type="wstring" dir="out" safearray="yes">
6565	<desc>
6566	The values of the properties returned. The array entries match the
6567	corresponding entries in the @a name array.
6568	</desc>
6569	</param>
6570	<param name="timestamps" type="long long" dir="out" safearray="yes">
6571	<desc>
6572	The time stamps of the properties returned. The array entries match
6573	the corresponding entries in the @a name array.
6574	</desc>
6575	</param>
6576	<param name="flags" type="wstring" dir="out" safearray="yes">
6577	<desc>
6578	The flags of the properties returned. The array entries match the
6579	corresponding entries in the @a name array.
6580	</desc>
6581	</param>
6582	</method>
6583
6584	<method name="querySavedGuestScreenInfo" const="yes">
6585	<desc>
6586	Returns the guest dimensions from the saved state.
6587	</desc>
6588	<param name="screenId" type="unsigned long" dir="in">
6589	<desc>
6590	Saved guest screen to query info from.
6591	</desc>
6592	</param>
6593	<param name="originX" type="unsigned long" dir="out">
6594	<desc>
6595	The X position of the guest monitor top left corner.
6596	</desc>
6597	</param>
6598	<param name="originY" type="unsigned long" dir="out">
6599	<desc>
6600	The Y position of the guest monitor top left corner.
6601	</desc>
6602	</param>
6603	<param name="width" type="unsigned long" dir="out">
6604	<desc>
6605	Guest width at the time of the saved state was taken.
6606	</desc>
6607	</param>
6608	<param name="height" type="unsigned long" dir="out">
6609	<desc>
6610	Guest height at the time of the saved state was taken.
6611	</desc>
6612	</param>
6613	<param name="enabled" type="boolean" dir="out">
6614	<desc>
6615	Whether the monitor is enabled in the guest.
6616	</desc>
6617	</param>
6618	</method>
6619
6620	<method name="querySavedThumbnailSize">
6621	<desc>
6622	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6623	</desc>
6624	<param name="screenId" type="unsigned long" dir="in">
6625	<desc>
6626	Saved guest screen to query info from.
6627	</desc>
6628	</param>
6629	<param name="size" type="unsigned long" dir="out">
6630	<desc>
6631	Size of buffer required to store the bitmap.
6632	</desc>
6633	</param>
6634	<param name="width" type="unsigned long" dir="out">
6635	<desc>
6636	Bitmap width.
6637	</desc>
6638	</param>
6639	<param name="height" type="unsigned long" dir="out">
6640	<desc>
6641	Bitmap height.
6642	</desc>
6643	</param>
6644	</method>
6645
6646	<method name="readSavedThumbnailToArray">
6647	<desc>
6648	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6649	</desc>
6650	<param name="screenId" type="unsigned long" dir="in">
6651	<desc>
6652	Saved guest screen to read from.
6653	</desc>
6654	</param>
6655	<param name="BGR" type="boolean" dir="in">
6656	<desc>
6657	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6658	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6659	</desc>
6660	</param>
6661	<param name="width" type="unsigned long" dir="out">
6662	<desc>
6663	Bitmap width.
6664	</desc>
6665	</param>
6666	<param name="height" type="unsigned long" dir="out">
6667	<desc>
6668	Bitmap height.
6669	</desc>
6670	</param>
6671	<param name="data" type="octet" safearray="yes" dir="return">
6672	<desc>
6673	Array with resulting bitmap data.
6674	</desc>
6675	</param>
6676	</method>
6677
6678	<method name="readSavedThumbnailPNGToArray">
6679	<desc>
6680	Thumbnail in PNG format is retrieved to an array of bytes.
6681	</desc>
6682	<param name="screenId" type="unsigned long" dir="in">
6683	<desc>
6684	Saved guest screen to read from.
6685	</desc>
6686	</param>
6687	<param name="width" type="unsigned long" dir="out">
6688	<desc>
6689	Image width.
6690	</desc>
6691	</param>
6692	<param name="height" type="unsigned long" dir="out">
6693	<desc>
6694	Image height.
6695	</desc>
6696	</param>
6697	<param name="data" type="octet" dir="return" safearray="yes">
6698	<desc>
6699	Array with resulting PNG data.
6700	</desc>
6701	</param>
6702	</method>
6703
6704	<method name="querySavedScreenshotPNGSize">
6705	<desc>
6706	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6707	</desc>
6708	<param name="screenId" type="unsigned long" dir="in">
6709	<desc>
6710	Saved guest screen to query info from.
6711	</desc>
6712	</param>
6713	<param name="size" type="unsigned long" dir="out">
6714	<desc>
6715	Size of buffer required to store the PNG binary data.
6716	</desc>
6717	</param>
6718	<param name="width" type="unsigned long" dir="out">
6719	<desc>
6720	Image width.
6721	</desc>
6722	</param>
6723	<param name="height" type="unsigned long" dir="out">
6724	<desc>
6725	Image height.
6726	</desc>
6727	</param>
6728	</method>
6729
6730	<method name="readSavedScreenshotPNGToArray">
6731	<desc>
6732	Screenshot in PNG format is retrieved to an array of bytes.
6733	</desc>
6734	<param name="screenId" type="unsigned long" dir="in">
6735	<desc>
6736	Saved guest screen to read from.
6737	</desc>
6738	</param>
6739	<param name="width" type="unsigned long" dir="out">
6740	<desc>
6741	Image width.
6742	</desc>
6743	</param>
6744	<param name="height" type="unsigned long" dir="out">
6745	<desc>
6746	Image height.
6747	</desc>
6748	</param>
6749	<param name="data" type="octet" dir="return" safearray="yes">
6750	<desc>
6751	Array with resulting PNG data.
6752	</desc>
6753	</param>
6754	</method>
6755
6756	<method name="hotPlugCPU">
6757	<desc>
6758	Plugs a CPU into the machine.
6759	</desc>
6760	<param name="cpu" type="unsigned long" dir="in">
6761	<desc>
6762	The CPU id to insert.
6763	</desc>
6764	</param>
6765	</method>
6766
6767	<method name="hotUnplugCPU">
6768	<desc>
6769	Removes a CPU from the machine.
6770	</desc>
6771	<param name="cpu" type="unsigned long" dir="in">
6772	<desc>
6773	The CPU id to remove.
6774	</desc>
6775	</param>
6776	</method>
6777
6778	<method name="getCPUStatus">
6779	<desc>
6780	Returns the current status of the given CPU.
6781	</desc>
6782	<param name="cpu" type="unsigned long" dir="in">
6783	<desc>
6784	The CPU id to check for.
6785	</desc>
6786	</param>
6787	<param name="attached" type="boolean" dir="return">
6788	<desc>
6789	Status of the CPU.
6790	</desc>
6791	</param>
6792	</method>
6793
6794	<method name="queryLogFilename">
6795	<desc>
6796	Queries for the VM log file name of an given index. Returns an empty
6797	string if a log file with that index doesn't exists.
6798	</desc>
6799	<param name="idx" type="unsigned long" dir="in">
6800	<desc>
6801	Which log file name to query. 0=current log file.
6802	</desc>
6803	</param>
6804	<param name="filename" type="wstring" dir="return">
6805	<desc>
6806	On return the full path to the log file or an empty string on error.
6807	</desc>
6808	</param>
6809	</method>
6810
6811	<method name="readLog">
6812	<desc>
6813	Reads the VM log file. The chunk size is limited, so even if you
6814	ask for a big piece there might be less data returned.
6815	</desc>
6816	<param name="idx" type="unsigned long" dir="in">
6817	<desc>
6818	Which log file to read. 0=current log file.
6819	</desc>
6820	</param>
6821	<param name="offset" type="long long" dir="in">
6822	<desc>
6823	Offset in the log file.
6824	</desc>
6825	</param>
6826	<param name="size" type="long long" dir="in">
6827	<desc>
6828	Chunk size to read in the log file.
6829	</desc>
6830	</param>
6831	<param name="data" type="octet" dir="return" safearray="yes">
6832	<desc>
6833	Data read from the log file. A data size of 0 means end of file
6834	if the requested chunk size was not 0. This is the unprocessed
6835	file data, i.e. the line ending style depends on the platform of
6836	the system the server is running on.
6837	</desc>
6838	</param>
6839	</method>
6840
6841	<method name="cloneTo">
6842	<desc>
6843	Creates a clone of this machine, either as a full clone (which means
6844	creating independent copies of the hard disk media, save states and so
6845	on), or as a linked clone (which uses its own differencing media,
6846	sharing the parent media with the source machine).
6847
6848	The target machine object must have been created previously with <link
6849	to="IVirtualBox::createMachine"/>, and all the settings will be
6850	transferred except the VM name and the hardware UUID. You can set the
6851	VM name and the new hardware UUID when creating the target machine. The
6852	network MAC addresses are newly created for all newtwork adapters. You
6853	can change that behaviour with the options parameter. The operation is
6854	performed asynchronously, so the machine object will be not be usable
6855	until the @a progress object signals completion.
6856
6857	<result name="E_INVALIDARG">
6858	@a target is @c null.
6859	</result>
6860	</desc>
6861
6862	<param name="target" type="IMachine" dir="in">
6863	<desc>Target machine object.</desc>
6864	</param>
6865	<param name="mode" type="CloneMode" dir="in">
6866	<desc>Which states should be cloned.</desc>
6867	</param>
6868	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6869	<desc>Options for the cloning operation.</desc>
6870	</param>
6871	<param name="progress" type="IProgress" dir="return">
6872	<desc>Progress object to track the operation completion.</desc>
6873	</param>
6874	</method>
6875
6876	</interface>
6877
6878	<!--
6879	// IConsole
6880	/////////////////////////////////////////////////////////////////////////
6881	-->
6882
6883	<interface
6884	name="IVRDEServerInfo" extends="$unknown"
6885	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6886	wsmap="struct"
6887	>
6888	<desc>
6889	Contains information about the remote desktop (VRDE) server capabilities and status.
6890	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6891	</desc>
6892
6893	<attribute name="active" type="boolean" readonly="yes">
6894	<desc>
6895	Whether the remote desktop connection is active.
6896	</desc>
6897	</attribute>
6898
6899	<attribute name="port" type="long" readonly="yes">
6900	<desc>
6901	VRDE server port number. If this property is equal to <tt>0</tt>, then
6902	the VRDE server failed to start, usually because there are no free IP
6903	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6904	server has not yet been started.
6905	</desc>
6906	</attribute>
6907
6908	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6909	<desc>
6910	How many times a client connected.
6911	</desc>
6912	</attribute>
6913
6914	<attribute name="beginTime" type="long long" readonly="yes">
6915	<desc>
6916	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6917	</desc>
6918	</attribute>
6919
6920	<attribute name="endTime" type="long long" readonly="yes">
6921	<desc>
6922	When the last connection was terminated or the current time, if
6923	connection is still active, in milliseconds since 1970-01-01 UTC.
6924	</desc>
6925	</attribute>
6926
6927	<attribute name="bytesSent" type="long long" readonly="yes">
6928	<desc>
6929	How many bytes were sent in last or current, if still active, connection.
6930	</desc>
6931	</attribute>
6932
6933	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6934	<desc>
6935	How many bytes were sent in all connections.
6936	</desc>
6937	</attribute>
6938
6939	<attribute name="bytesReceived" type="long long" readonly="yes">
6940	<desc>
6941	How many bytes were received in last or current, if still active, connection.
6942	</desc>
6943	</attribute>
6944
6945	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6946	<desc>
6947	How many bytes were received in all connections.
6948	</desc>
6949	</attribute>
6950
6951	<attribute name="user" type="wstring" readonly="yes">
6952	<desc>
6953	Login user name supplied by the client.
6954	</desc>
6955	</attribute>
6956
6957	<attribute name="domain" type="wstring" readonly="yes">
6958	<desc>
6959	Login domain name supplied by the client.
6960	</desc>
6961	</attribute>
6962
6963	<attribute name="clientName" type="wstring" readonly="yes">
6964	<desc>
6965	The client name supplied by the client.
6966	</desc>
6967	</attribute>
6968
6969	<attribute name="clientIP" type="wstring" readonly="yes">
6970	<desc>
6971	The IP address of the client.
6972	</desc>
6973	</attribute>
6974
6975	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6976	<desc>
6977	The client software version number.
6978	</desc>
6979	</attribute>
6980
6981	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6982	<desc>
6983	Public key exchange method used when connection was established.
6984	Values: 0 - RDP4 public key exchange scheme.
6985	1 - X509 certificates were sent to client.
6986	</desc>
6987	</attribute>
6988
6989	</interface>
6990
6991	<interface
6992	name="IConsole" extends="$unknown"
6993	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6994	wsmap="managed"
6995	>
6996	<desc>
6997	The IConsole interface represents an interface to control virtual
6998	machine execution.
6999
7000	A console object gets created when a machine has been locked for a
7001	particular session (client process) using <link to="IMachine::lockMachine" />
7002	or <link to="IMachine::launchVMProcess"/>. The console object can
7003	then be found in the session's <link to="ISession::console" /> attribute.
7004
7005	Methods of the IConsole interface allow the caller to query the current
7006	virtual machine execution state, pause the machine or power it down, save
7007	the machine state or take a snapshot, attach and detach removable media
7008	and so on.
7009
7010	<see><link to="ISession"/></see>
7011	</desc>
7012
7013	<attribute name="machine" type="IMachine" readonly="yes">
7014	<desc>
7015	Machine object for this console session.
7016	<note>
7017	This is a convenience property, it has the same value as
7018	<link to="ISession::machine"/> of the corresponding session
7019	object.
7020	</note>
7021	</desc>
7022	</attribute>
7023
7024	<attribute name="state" type="MachineState" readonly="yes">
7025	<desc>
7026	Current execution state of the machine.
7027	<note>
7028	This property always returns the same value as the corresponding
7029	property of the IMachine object for this console session.
7030	For the process that owns (executes) the VM, this is the
7031	preferable way of querying the VM state, because no IPC
7032	calls are made.
7033	</note>
7034	</desc>
7035	</attribute>
7036
7037	<attribute name="guest" type="IGuest" readonly="yes">
7038	<desc>Guest object.</desc>
7039	</attribute>
7040
7041	<attribute name="keyboard" type="IKeyboard" readonly="yes">
7042	<desc>
7043	Virtual keyboard object.
7044	<note>
7045	If the machine is not running, any attempt to use
7046	the returned object will result in an error.
7047	</note>
7048	</desc>
7049	</attribute>
7050
7051	<attribute name="mouse" type="IMouse" readonly="yes">
7052	<desc>
7053	Virtual mouse object.
7054	<note>
7055	If the machine is not running, any attempt to use
7056	the returned object will result in an error.
7057	</note>
7058	</desc>
7059	</attribute>
7060
7061	<attribute name="display" type="IDisplay" readonly="yes">
7062	<desc>Virtual display object.
7063	<note>
7064	If the machine is not running, any attempt to use
7065	the returned object will result in an error.
7066	</note>
7067	</desc>
7068	</attribute>
7069
7070	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
7071	<desc>Debugging interface.</desc>
7072	</attribute>
7073
7074	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
7075	<desc>
7076	Collection of USB devices currently attached to the virtual
7077	USB controller.
7078	<note>
7079	The collection is empty if the machine is not running.
7080	</note>
7081	</desc>
7082	</attribute>
7083
7084	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7085	<desc>
7086	List of USB devices currently attached to the remote VRDE client.
7087	Once a new device is physically attached to the remote host computer,
7088	it appears in this list and remains there until detached.
7089	</desc>
7090	</attribute>
7091
7092	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
7093	<desc>
7094	Collection of shared folders for the current session. These folders
7095	are called transient shared folders because they are available to the
7096	guest OS running inside the associated virtual machine only for the
7097	duration of the session (as opposed to
7098	<link to="IMachine::sharedFolders"/> which represent permanent shared
7099	folders). When the session is closed (e.g. the machine is powered down),
7100	these folders are automatically discarded.
7101
7102	New shared folders are added to the collection using
7103	<link to="#createSharedFolder"/>. Existing shared folders can be
7104	removed using <link to="#removeSharedFolder"/>.
7105	</desc>
7106	</attribute>
7107
7108	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
7109	<desc>
7110	Interface that provides information on Remote Desktop Extension (VRDE) connection.
7111	</desc>
7112	</attribute>
7113
7114	<attribute name="eventSource" type="IEventSource" readonly="yes">
7115	<desc>
7116	Event source for console events.
7117	</desc>
7118	</attribute>
7119
7120	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
7121	<desc>Array of PCI devices attached to this machine.</desc>
7122	</attribute>
7123
7124	<attribute name="useHostClipboard" type="boolean">
7125	<desc>
7126	Whether the guest clipboard should be connected to the host one or
7127	whether it should only be allowed access to the VRDE clipboard. This
7128	setting may not affect existing guest clipboard connections which
7129	are already connected to the host clipboard.
7130	</desc>
7131	</attribute>
7132
7133	<method name="powerUp">
7134	<desc>
7135	Starts the virtual machine execution using the current machine
7136	state (that is, its current execution state, current settings and
7137	current storage devices).
7138
7139	<note>
7140	This method is only useful for front-ends that want to actually
7141	execute virtual machines in their own process (like the VirtualBox
7142	or VBoxSDL front-ends). Unless you are intending to write such a
7143	front-end, do not call this method. If you simply want to
7144	start virtual machine execution using one of the existing front-ends
7145	(for example the VirtualBox GUI or headless server), use
7146	<link to="IMachine::launchVMProcess"/> instead; these
7147	front-ends will power up the machine automatically for you.
7148	</note>
7149
7150	If the machine is powered off or aborted, the execution will
7151	start from the beginning (as if the real hardware were just
7152	powered on).
7153
7154	If the machine is in the <link to="MachineState_Saved"/> state,
7155	it will continue its execution the point where the state has
7156	been saved.
7157
7158	If the machine <link to="IMachine::teleporterEnabled"/> property is
7159	enabled on the machine being powered up, the machine will wait for an
7160	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
7161	state. The returned progress object will have at least three
7162	operations where the last three are defined as: (1) powering up and
7163	starting TCP server, (2) waiting for incoming teleportations, and
7164	(3) perform teleportation. These operations will be reflected as the
7165	last three operations of the progress objected returned by
7166	<link to="IMachine::launchVMProcess"/> as well.
7167
7168	<see><link to="#saveState"/></see>
7169
7170	<result name="VBOX_E_INVALID_VM_STATE">
7171	Virtual machine already running.
7172	</result>
7173	<result name="VBOX_E_HOST_ERROR">
7174	Host interface does not exist or name not set.
7175	</result>
7176	<result name="VBOX_E_FILE_ERROR">
7177	Invalid saved state file.
7178	</result>
7179	</desc>
7180	<param name="progress" type="IProgress" dir="return">
7181	<desc>Progress object to track the operation completion.</desc>
7182	</param>
7183	</method>
7184
7185	<method name="powerUpPaused">
7186	<desc>
7187	Identical to powerUp except that the VM will enter the
7188	<link to="MachineState_Paused"/> state, instead of
7189	<link to="MachineState_Running"/>.
7190
7191	<see><link to="#powerUp"/></see>
7192	<result name="VBOX_E_INVALID_VM_STATE">
7193	Virtual machine already running.
7194	</result>
7195	<result name="VBOX_E_HOST_ERROR">
7196	Host interface does not exist or name not set.
7197	</result>
7198	<result name="VBOX_E_FILE_ERROR">
7199	Invalid saved state file.
7200	</result>
7201	</desc>
7202	<param name="progress" type="IProgress" dir="return">
7203	<desc>Progress object to track the operation completion.</desc>
7204	</param>
7205	</method>
7206
7207	<method name="powerDown">
7208	<desc>
7209	Initiates the power down procedure to stop the virtual machine
7210	execution.
7211
7212	The completion of the power down procedure is tracked using the returned
7213	IProgress object. After the operation is complete, the machine will go
7214	to the PoweredOff state.
7215	<result name="VBOX_E_INVALID_VM_STATE">
7216	Virtual machine must be Running, Paused or Stuck to be powered down.
7217	</result>
7218	</desc>
7219	<param name="progress" type="IProgress" dir="return">
7220	<desc>Progress object to track the operation completion.</desc>
7221	</param>
7222	</method>
7223
7224	<method name="reset">
7225	<desc>Resets the virtual machine.
7226	<result name="VBOX_E_INVALID_VM_STATE">
7227	Virtual machine not in Running state.
7228	</result>
7229	<result name="VBOX_E_VM_ERROR">
7230	Virtual machine error in reset operation.
7231	</result>
7232	</desc>
7233	</method>
7234
7235	<method name="pause">
7236	<desc>Pauses the virtual machine execution.
7237	<result name="VBOX_E_INVALID_VM_STATE">
7238	Virtual machine not in Running state.
7239	</result>
7240	<result name="VBOX_E_VM_ERROR">
7241	Virtual machine error in suspend operation.
7242	</result>
7243	</desc>
7244	</method>
7245
7246	<method name="resume">
7247	<desc>Resumes the virtual machine execution.
7248	<result name="VBOX_E_INVALID_VM_STATE">
7249	Virtual machine not in Paused state.
7250	</result>
7251	<result name="VBOX_E_VM_ERROR">
7252	Virtual machine error in resume operation.
7253	</result>
7254	</desc>
7255	</method>
7256
7257	<method name="powerButton">
7258	<desc>Sends the ACPI power button event to the guest.
7259	<result name="VBOX_E_INVALID_VM_STATE">
7260	Virtual machine not in Running state.
7261	</result>
7262	<result name="VBOX_E_PDM_ERROR">
7263	Controlled power off failed.
7264	</result>
7265	</desc>
7266	</method>
7267
7268	<method name="sleepButton">
7269	<desc>Sends the ACPI sleep button event to the guest.
7270	<result name="VBOX_E_INVALID_VM_STATE">
7271	Virtual machine not in Running state.
7272	</result>
7273	<result name="VBOX_E_PDM_ERROR">
7274	Sending sleep button event failed.
7275	</result>
7276	</desc>
7277	</method>
7278
7279	<method name="getPowerButtonHandled">
7280	<desc>Checks if the last power button event was handled by guest.
7281	<result name="VBOX_E_PDM_ERROR">
7282	Checking if the event was handled by the guest OS failed.
7283	</result>
7284	</desc>
7285	<param name="handled" type="boolean" dir="return"/>
7286	</method>
7287
7288	<method name="getGuestEnteredACPIMode">
7289	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7290	G1 (sleeping). If this method returns @c false, the guest will
7291	most likely not respond to external ACPI events.
7292	<result name="VBOX_E_INVALID_VM_STATE">
7293	Virtual machine not in Running state.
7294	</result>
7295	</desc>
7296	<param name="entered" type="boolean" dir="return"/>
7297	</method>
7298
7299	<method name="saveState">
7300	<desc>
7301	Saves the current execution state of a running virtual machine
7302	and stops its execution.
7303
7304	After this operation completes, the machine will go to the
7305	Saved state. Next time it is powered up, this state will
7306	be restored and the machine will continue its execution from
7307	the place where it was saved.
7308
7309	This operation differs from taking a snapshot to the effect
7310	that it doesn't create new differencing media. Also, once
7311	the machine is powered up from the state saved using this method,
7312	the saved state is deleted, so it will be impossible to return
7313	to this state later.
7314
7315	<note>
7316	On success, this method implicitly calls
7317	<link to="IMachine::saveSettings"/> to save all current machine
7318	settings (including runtime changes to the DVD medium, etc.).
7319	Together with the impossibility to change any VM settings when it is
7320	in the Saved state, this guarantees adequate hardware
7321	configuration of the machine when it is restored from the saved
7322	state file.
7323	</note>
7324
7325	<note>
7326	The machine must be in the Running or Paused state, otherwise
7327	the operation will fail.
7328	</note>
7329	<result name="VBOX_E_INVALID_VM_STATE">
7330	Virtual machine state neither Running nor Paused.
7331	</result>
7332	<result name="VBOX_E_FILE_ERROR">
7333	Failed to create directory for saved state file.
7334	</result>
7335
7336	<see><link to="#takeSnapshot"/></see>
7337	</desc>
7338	<param name="progress" type="IProgress" dir="return">
7339	<desc>Progress object to track the operation completion.</desc>
7340	</param>
7341	</method>
7342
7343	<method name="adoptSavedState">
7344	<desc>
7345	Associates the given saved state file to the virtual machine.
7346
7347	On success, the machine will go to the Saved state. Next time it is
7348	powered up, it will be restored from the adopted saved state and
7349	continue execution from the place where the saved state file was
7350	created.
7351
7352	The specified saved state file path may be absolute or relative to the
7353	folder the VM normally saves the state to (usually,
7354	<link to="IMachine::snapshotFolder"/>).
7355
7356	<note>
7357	It's a caller's responsibility to make sure the given saved state
7358	file is compatible with the settings of this virtual machine that
7359	represent its virtual hardware (memory size, storage disk configuration
7360	etc.). If there is a mismatch, the behavior of the virtual machine
7361	is undefined.
7362	</note>
7363	<result name="VBOX_E_INVALID_VM_STATE">
7364	Virtual machine state neither PoweredOff nor Aborted.
7365	</result>
7366	</desc>
7367	<param name="savedStateFile" type="wstring" dir="in">
7368	<desc>Path to the saved state file to adopt.</desc>
7369	</param>
7370	</method>
7371
7372	<method name="discardSavedState">
7373	<desc>
7374	Forcibly resets the machine to "Powered Off" state if it is
7375	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7376	Next time the machine is powered up, a clean boot will occur.
7377	<note>
7378	This operation is equivalent to resetting or powering off
7379	the machine without doing a proper shutdown of the guest
7380	operating system; as with resetting a running phyiscal
7381	computer, it can can lead to data loss.
7382	</note>
7383	If @a fRemoveFile is @c true, the file in the machine directory
7384	into which the machine state was saved is also deleted. If
7385	this is @c false, then the state can be recovered and later
7386	re-inserted into a machine using <link to="#adoptSavedState" />.
7387	The location of the file can be found in the
7388	<link to="IMachine::stateFilePath" /> attribute.
7389	<result name="VBOX_E_INVALID_VM_STATE">
7390	Virtual machine not in state Saved.
7391	</result>
7392	</desc>
7393	<param name="fRemoveFile" type="boolean" dir="in" >
7394	<desc>Whether to also remove the saved state file.</desc>
7395	</param>
7396	</method>
7397
7398	<method name="getDeviceActivity">
7399	<desc>
7400	Gets the current activity type of a given device or device group.
7401	<result name="E_INVALIDARG">
7402	Invalid device type.
7403	</result>
7404	</desc>
7405	<param name="type" type="DeviceType" dir="in"/>
7406	<param name="activity" type="DeviceActivity" dir="return"/>
7407	</method>
7408
7409	<method name="attachUSBDevice">
7410	<desc>
7411	Attaches a host USB device with the given UUID to the
7412	USB controller of the virtual machine.
7413
7414	The device needs to be in one of the following states:
7415	<link to="USBDeviceState_Busy"/>,
7416	<link to="USBDeviceState_Available"/> or
7417	<link to="USBDeviceState_Held"/>,
7418	otherwise an error is immediately returned.
7419
7420	When the device state is
7421	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7422	be returned if the host computer refuses to release it for some reason.
7423
7424	<see><link to="IUSBController::deviceFilters"/>,
7425	<link to="USBDeviceState"/></see>
7426	<result name="VBOX_E_INVALID_VM_STATE">
7427	Virtual machine state neither Running nor Paused.
7428	</result>
7429	<result name="VBOX_E_PDM_ERROR">
7430	Virtual machine does not have a USB controller.
7431	</result>
7432	</desc>
7433	<param name="id" type="uuid" mod="string" dir="in">
7434	<desc>UUID of the host USB device to attach.</desc>
7435	</param>
7436	</method>
7437
7438	<method name="detachUSBDevice">
7439	<desc>
7440	Detaches an USB device with the given UUID from the USB controller
7441	of the virtual machine.
7442
7443	After this method succeeds, the VirtualBox server re-initiates
7444	all USB filters as if the device were just physically attached
7445	to the host, but filters of this machine are ignored to avoid
7446	a possible automatic re-attachment.
7447
7448	<see><link to="IUSBController::deviceFilters"/>,
7449	<link to="USBDeviceState"/></see>
7450
7451	<result name="VBOX_E_PDM_ERROR">
7452	Virtual machine does not have a USB controller.
7453	</result>
7454	<result name="E_INVALIDARG">
7455	USB device not attached to this virtual machine.
7456	</result>
7457	</desc>
7458	<param name="id" type="uuid" mod="string" dir="in">
7459	<desc>UUID of the USB device to detach.</desc>
7460	</param>
7461	<param name="device" type="IUSBDevice" dir="return">
7462	<desc>Detached USB device.</desc>
7463	</param>
7464	</method>
7465
7466	<method name="findUSBDeviceByAddress">
7467	<desc>
7468	Searches for a USB device with the given host address.
7469
7470	<result name="VBOX_E_OBJECT_NOT_FOUND">
7471	Given @c name does not correspond to any USB device.
7472	</result>
7473
7474	<see><link to="IUSBDevice::address"/></see>
7475	</desc>
7476	<param name="name" type="wstring" dir="in">
7477	<desc>
7478	Address of the USB device (as assigned by the host) to
7479	search for.
7480	</desc>
7481	</param>
7482	<param name="device" type="IUSBDevice" dir="return">
7483	<desc>Found USB device object.</desc>
7484	</param>
7485	</method>
7486
7487	<method name="findUSBDeviceById">
7488	<desc>
7489	Searches for a USB device with the given UUID.
7490
7491	<result name="VBOX_E_OBJECT_NOT_FOUND">
7492	Given @c id does not correspond to any USB device.
7493	</result>
7494
7495	<see><link to="IUSBDevice::id"/></see>
7496	</desc>
7497	<param name="id" type="uuid" mod="string" dir="in">
7498	<desc>UUID of the USB device to search for.</desc>
7499	</param>
7500	<param name="device" type="IUSBDevice" dir="return">
7501	<desc>Found USB device object.</desc>
7502	</param>
7503	</method>
7504
7505	<method name="createSharedFolder">
7506	<desc>
7507	Creates a transient new shared folder by associating the given logical
7508	name with the given host path, adds it to the collection of shared
7509	folders and starts sharing it. Refer to the description of
7510	<link to="ISharedFolder"/> to read more about logical names.
7511
7512	<result name="VBOX_E_INVALID_VM_STATE">
7513	Virtual machine in Saved state or currently changing state.
7514	</result>
7515	<result name="VBOX_E_FILE_ERROR">
7516	Shared folder already exists or not accessible.
7517	</result>
7518	</desc>
7519	<param name="name" type="wstring" dir="in">
7520	<desc>Unique logical name of the shared folder.</desc>
7521	</param>
7522	<param name="hostPath" type="wstring" dir="in">
7523	<desc>Full path to the shared folder in the host file system.</desc>
7524	</param>
7525	<param name="writable" type="boolean" dir="in">
7526	<desc>Whether the share is writable or readonly</desc>
7527	</param>
7528	<param name="automount" type="boolean" dir="in">
7529	<desc>Whether the share gets automatically mounted by the guest
7530	or not.</desc>
7531	</param>
7532	</method>
7533
7534	<method name="removeSharedFolder">
7535	<desc>
7536	Removes a transient shared folder with the given name previously
7537	created by <link to="#createSharedFolder"/> from the collection of
7538	shared folders and stops sharing it.
7539	<result name="VBOX_E_INVALID_VM_STATE">
7540	Virtual machine in Saved state or currently changing state.
7541	</result>
7542	<result name="VBOX_E_FILE_ERROR">
7543	Shared folder does not exists.
7544	</result>
7545	</desc>
7546	<param name="name" type="wstring" dir="in">
7547	<desc>Logical name of the shared folder to remove.</desc>
7548	</param>
7549	</method>
7550
7551	<method name="takeSnapshot">
7552	<desc>
7553	Saves the current execution state
7554	and all settings of the machine and creates differencing images
7555	for all normal (non-independent) media.
7556	See <link to="ISnapshot" /> for an introduction to snapshots.
7557
7558	This method can be called for a PoweredOff, Saved (see
7559	<link to="#saveState"/>), Running or
7560	Paused virtual machine. When the machine is PoweredOff, an
7561	offline snapshot is created. When the machine is Running a live
7562	snapshot is created, and an online snapshot is created when Paused.
7563
7564	The taken snapshot is always based on the
7565	<link to="IMachine::currentSnapshot">current snapshot</link>
7566	of the associated virtual machine and becomes a new current snapshot.
7567
7568	<note>
7569	This method implicitly calls <link to="IMachine::saveSettings"/> to
7570	save all current machine settings before taking an offline snapshot.
7571	</note>
7572
7573	<result name="VBOX_E_INVALID_VM_STATE">
7574	Virtual machine currently changing state.
7575	</result>
7576	</desc>
7577	<param name="name" type="wstring" dir="in">
7578	<desc>Short name for the snapshot.</desc>
7579	</param>
7580	<param name="description" type="wstring" dir="in">
7581	<desc>Optional description of the snapshot.</desc>
7582	</param>
7583	<param name="progress" type="IProgress" dir="return">
7584	<desc>Progress object to track the operation completion.</desc>
7585	</param>
7586	</method>
7587
7588	<method name="deleteSnapshot">
7589	<desc>
7590	Starts deleting the specified snapshot asynchronously.
7591	See <link to="ISnapshot" /> for an introduction to snapshots.
7592
7593	The execution state and settings of the associated machine stored in
7594	the snapshot will be deleted. The contents of all differencing media of
7595	this snapshot will be merged with the contents of their dependent child
7596	media to keep the medium chain valid (in other words, all changes
7597	represented by media being deleted will be propagated to their child
7598	medium). After that, this snapshot's differencing medium will be
7599	deleted. The parent of this snapshot will become a new parent for all
7600	its child snapshots.
7601
7602	If the deleted snapshot is the current one, its parent snapshot will
7603	become a new current snapshot. The current machine state is not directly
7604	affected in this case, except that currently attached differencing
7605	media based on media of the deleted snapshot will be also merged as
7606	described above.
7607
7608	If the deleted snapshot is the first or current snapshot, then the
7609	respective IMachine attributes will be adjusted. Deleting the current
7610	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7611	to make all current machine settings permanent.
7612
7613	Deleting a snapshot has the following preconditions:
7614
7615	<ul>
7616	<li>Child media of all normal media of the deleted snapshot
7617	must be accessible (see <link to="IMedium::state"/>) for this
7618	operation to succeed. If only one running VM refers to all images
7619	which participates in merging the operation can be performed while
7620	the VM is running. Otherwise all virtual machines whose media are
7621	directly or indirectly based on the media of deleted snapshot must
7622	be powered off. In any case, online snapshot deleting usually is
7623	slower than the same operation without any running VM.</li>
7624
7625	<li>You cannot delete the snapshot if a medium attached to it has
7626	more than one child medium (differencing images) because otherwise
7627	merging would be impossible. This might be the case if there is
7628	more than one child snapshot or differencing images were created
7629	for other reason (e.g. implicitly because of multiple machine
7630	attachments).</li>
7631	</ul>
7632
7633	The virtual machine's <link to="IMachine::state">state</link> is
7634	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7635	"DeletingSnapshotPaused" while this operation is in progress.
7636
7637	<note>
7638	Merging medium contents can be very time and disk space
7639	consuming, if these media are big in size and have many
7640	children. However, if the snapshot being deleted is the last
7641	(head) snapshot on the branch, the operation will be rather
7642	quick.
7643	</note>
7644	<result name="VBOX_E_INVALID_VM_STATE">
7645	The running virtual machine prevents deleting this snapshot. This
7646	happens only in very specific situations, usually snapshots can be
7647	deleted without trouble while a VM is running. The error message
7648	text explains the reason for the failure.
7649	</result>
7650	</desc>
7651	<param name="id" type="uuid" mod="string" dir="in">
7652	<desc>UUID of the snapshot to delete.</desc>
7653	</param>
7654	<param name="progress" type="IProgress" dir="return">
7655	<desc>Progress object to track the operation completion.</desc>
7656	</param>
7657	</method>
7658
7659	<method name="deleteSnapshotAndAllChildren">
7660	<desc>
7661	Starts deleting the specified snapshot and all its children
7662	asynchronously. See <link to="ISnapshot" /> for an introduction to
7663	snapshots. The conditions and many details are the same as with
7664	<link to="#deleteSnapshot"/>.
7665
7666	This operation is very fast if the snapshot subtree does not include
7667	the current state. It is still significantly faster than deleting the
7668	snapshots one by one if the current state is in the subtree and there
7669	are more than one snapshots from current state to the snapshot which
7670	marks the subtree, since it eliminates the incremental image merging.
7671
7672	<note>This API method is right now not implemented!</note>
7673
7674	<result name="VBOX_E_INVALID_VM_STATE">
7675	The running virtual machine prevents deleting this snapshot. This
7676	happens only in very specific situations, usually snapshots can be
7677	deleted without trouble while a VM is running. The error message
7678	text explains the reason for the failure.
7679	</result>
7680	<result name="E_NOTIMPL">
7681	The method is not implemented yet.
7682	</result>
7683	</desc>
7684	<param name="id" type="uuid" mod="string" dir="in">
7685	<desc>UUID of the snapshot to delete, including all its children.</desc>
7686	</param>
7687	<param name="progress" type="IProgress" dir="return">
7688	<desc>Progress object to track the operation completion.</desc>
7689	</param>
7690	</method>
7691
7692	<method name="deleteSnapshotRange">
7693	<desc>
7694	Starts deleting the specified snapshot range. This is limited to
7695	linear snapshot lists, which means there may not be any other child
7696	snapshots other than the direct sequence between the start and end
7697	snapshot. If the start and end snapshot point to the same snapshot this
7698	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7699	<link to="ISnapshot" /> for an introduction to snapshots. The
7700	conditions and many details are the same as with
7701	<link to="#deleteSnapshot"/>.
7702
7703	This operation is generally faster than deleting snapshots one by one
7704	and often also needs less extra disk space before freeing up disk space
7705	by deleting the removed disk images corresponding to the snapshot.
7706
7707	<note>This API method is right now not implemented!</note>
7708
7709	<result name="VBOX_E_INVALID_VM_STATE">
7710	The running virtual machine prevents deleting this snapshot. This
7711	happens only in very specific situations, usually snapshots can be
7712	deleted without trouble while a VM is running. The error message
7713	text explains the reason for the failure.
7714	</result>
7715	<result name="E_NOTIMPL">
7716	The method is not implemented yet.
7717	</result>
7718	</desc>
7719	<param name="startId" type="uuid" mod="string" dir="in">
7720	<desc>UUID of the first snapshot to delete.</desc>
7721	</param>
7722	<param name="endId" type="uuid" mod="string" dir="in">
7723	<desc>UUID of the last snapshot to delete.</desc>
7724	</param>
7725	<param name="progress" type="IProgress" dir="return">
7726	<desc>Progress object to track the operation completion.</desc>
7727	</param>
7728	</method>
7729
7730	<method name="restoreSnapshot">
7731	<desc>
7732	Starts resetting the machine's current state to the state contained
7733	in the given snapshot, asynchronously. All current settings of the
7734	machine will be reset and changes stored in differencing media
7735	will be lost.
7736	See <link to="ISnapshot" /> for an introduction to snapshots.
7737
7738	After this operation is successfully completed, new empty differencing
7739	media are created for all normal media of the machine.
7740
7741	If the given snapshot is an online snapshot, the machine will go to
7742	the <link to="MachineState_Saved"> saved state</link>, so that the
7743	next time it is powered on, the execution state will be restored
7744	from the state of the snapshot.
7745
7746	<note>
7747	The machine must not be running, otherwise the operation will fail.
7748	</note>
7749
7750	<note>
7751	If the machine state is <link to="MachineState_Saved">Saved</link>
7752	prior to this operation, the saved state file will be implicitly
7753	deleted (as if <link to="IConsole::discardSavedState"/> were
7754	called).
7755	</note>
7756
7757	<result name="VBOX_E_INVALID_VM_STATE">
7758	Virtual machine is running.
7759	</result>
7760	</desc>
7761	<param name="snapshot" type="ISnapshot" dir="in">
7762	<desc>The snapshot to restore the VM state from.</desc>
7763	</param>
7764	<param name="progress" type="IProgress" dir="return">
7765	<desc>Progress object to track the operation completion.</desc>
7766	</param>
7767	</method>
7768
7769	<method name="teleport">
7770	<desc>
7771	Teleport the VM to a different host machine or process.
7772
7773	TODO explain the details.
7774
7775	<result name="VBOX_E_INVALID_VM_STATE">
7776	Virtual machine not running or paused.
7777	</result>
7778	</desc>
7779	<param name="hostname" type="wstring" dir="in">
7780	<desc>The name or IP of the host to teleport to.</desc>
7781	</param>
7782	<param name="tcpport" type="unsigned long" dir="in">
7783	<desc>The TCP port to connect to (1..65535).</desc>
7784	</param>
7785	<param name="password" type="wstring" dir="in">
7786	<desc>The password.</desc>
7787	</param>
7788	<param name="maxDowntime" type="unsigned long" dir="in">
7789	<desc>
7790	The maximum allowed downtime given as milliseconds. 0 is not a valid
7791	value. Recommended value: 250 ms.
7792
7793	The higher the value is, the greater the chance for a successful
7794	teleportation. A small value may easily result in the teleportation
7795	process taking hours and eventually fail.
7796
7797	<note>
7798	The current implementation treats this a guideline, not as an
7799	absolute rule.
7800	</note>
7801	</desc>
7802	</param>
7803	<param name="progress" type="IProgress" dir="return">
7804	<desc>Progress object to track the operation completion.</desc>
7805	</param>
7806	</method>
7807
7808	</interface>
7809
7810	<!--
7811	// IHost
7812	/////////////////////////////////////////////////////////////////////////
7813	-->
7814
7815	<enum
7816	name="HostNetworkInterfaceMediumType"
7817	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7818	>
7819	<desc>
7820	Type of encapsulation. Ethernet encapsulation includes both wired and
7821	wireless Ethernet connections.
7822	<see><link to="IHostNetworkInterface"/></see>
7823	</desc>
7824
7825	<const name="Unknown" value="0">
7826	<desc>
7827	The type of interface cannot be determined.
7828	</desc>
7829	</const>
7830	<const name="Ethernet" value="1">
7831	<desc>
7832	Ethernet frame encapsulation.
7833	</desc>
7834	</const>
7835	<const name="PPP" value="2">
7836	<desc>
7837	Point-to-point protocol encapsulation.
7838	</desc>
7839	</const>
7840	<const name="SLIP" value="3">
7841	<desc>
7842	Serial line IP encapsulation.
7843	</desc>
7844	</const>
7845	</enum>
7846
7847	<enum
7848	name="HostNetworkInterfaceStatus"
7849	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7850	>
7851	<desc>
7852	Current status of the interface.
7853	<see><link to="IHostNetworkInterface"/></see>
7854	</desc>
7855
7856	<const name="Unknown" value="0">
7857	<desc>
7858	The state of interface cannot be determined.
7859	</desc>
7860	</const>
7861	<const name="Up" value="1">
7862	<desc>
7863	The interface is fully operational.
7864	</desc>
7865	</const>
7866	<const name="Down" value="2">
7867	<desc>
7868	The interface is not functioning.
7869	</desc>
7870	</const>
7871	</enum>
7872
7873	<enum
7874	name="HostNetworkInterfaceType"
7875	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7876	>
7877	<desc>
7878	Network interface type.
7879	</desc>
7880	<const name="Bridged" value="1"/>
7881	<const name="HostOnly" value="2"/>
7882	</enum>
7883
7884	<interface
7885	name="IHostNetworkInterface" extends="$unknown"
7886	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7887	wsmap="managed"
7888	>
7889	<desc>
7890	Represents one of host's network interfaces. IP V6 address and network
7891	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7892	separated by colons.
7893	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7894	</desc>
7895	<attribute name="name" type="wstring" readonly="yes">
7896	<desc>Returns the host network interface name.</desc>
7897	</attribute>
7898
7899	<attribute name="id" type="uuid" mod="string" readonly="yes">
7900	<desc>Returns the interface UUID.</desc>
7901	</attribute>
7902
7903	<attribute name="networkName" type="wstring" readonly="yes">
7904	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7905	</attribute>
7906
7907	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7908	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7909	</attribute>
7910
7911	<attribute name="IPAddress" type="wstring" readonly="yes">
7912	<desc>Returns the IP V4 address of the interface.</desc>
7913	</attribute>
7914
7915	<attribute name="networkMask" type="wstring" readonly="yes">
7916	<desc>Returns the network mask of the interface.</desc>
7917	</attribute>
7918
7919	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7920	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7921	</attribute>
7922
7923	<attribute name="IPV6Address" type="wstring" readonly="yes">
7924	<desc>Returns the IP V6 address of the interface.</desc>
7925	</attribute>
7926
7927	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7928	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7929	</attribute>
7930
7931	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7932	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7933	</attribute>
7934
7935	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7936	<desc>Type of protocol encapsulation used.</desc>
7937	</attribute>
7938
7939	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7940	<desc>Status of the interface.</desc>
7941	</attribute>
7942
7943	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7944	<desc>specifies the host interface type.</desc>
7945	</attribute>
7946
7947	<method name="enableStaticIPConfig">
7948	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7949	<param name="IPAddress" type="wstring" dir="in">
7950	<desc>
7951	IP address.
7952	</desc>
7953	</param>
7954	<param name="networkMask" type="wstring" dir="in">
7955	<desc>
7956	network mask.
7957	</desc>
7958	</param>
7959	</method>
7960
7961	<method name="enableStaticIPConfigV6">
7962	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7963	<param name="IPV6Address" type="wstring" dir="in">
7964	<desc>
7965	IP address.
7966	</desc>
7967	</param>
7968	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7969	<desc>
7970	network mask.
7971	</desc>
7972	</param>
7973	</method>
7974
7975	<method name="enableDynamicIPConfig">
7976	<desc>enables the dynamic IP configuration.</desc>
7977	</method>
7978
7979	<method name="DHCPRediscover">
7980	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7981	</method>
7982
7983	</interface>
7984
7985	<interface
7986	name="IHost" extends="$unknown"
7987	uuid="30678943-32df-4830-b413-931b25ac86a0"
7988	wsmap="managed"
7989	>
7990	<desc>
7991	The IHost interface represents the physical machine that this VirtualBox
7992	installation runs on.
7993
7994	An object implementing this interface is returned by the
7995	<link to="IVirtualBox::host" /> attribute. This interface contains
7996	read-only information about the host's physical hardware (such as what
7997	processors and disks are available, what the host operating system is,
7998	and so on) and also allows for manipulating some of the host's hardware,
7999	such as global USB device filters and host interface networking.
8000
8001	</desc>
8002	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
8003	<desc>List of DVD drives available on the host.</desc>
8004	</attribute>
8005
8006	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
8007	<desc>List of floppy drives available on the host.</desc>
8008	</attribute>
8009
8010	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
8011	<desc>
8012	List of USB devices currently attached to the host.
8013	Once a new device is physically attached to the host computer,
8014	it appears in this list and remains there until detached.
8015
8016	<note>
8017	If USB functionality is not available in the given edition of
8018	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8019	</note>
8020	</desc>
8021	</attribute>
8022
8023	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
8024	<desc>
8025	List of USB device filters in action.
8026	When a new device is physically attached to the host computer,
8027	filters from this list are applied to it (in order they are stored
8028	in the list). The first matched filter will determine the
8029	<link to="IHostUSBDeviceFilter::action">action</link>
8030	performed on the device.
8031
8032	Unless the device is ignored by these filters, filters of all
8033	currently running virtual machines
8034	(<link to="IUSBController::deviceFilters"/>) are applied to it.
8035
8036	<note>
8037	If USB functionality is not available in the given edition of
8038	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8039	</note>
8040
8041	<see><link to="IHostUSBDeviceFilter"/>,
8042	<link to="USBDeviceState"/></see>
8043	</desc>
8044	</attribute>
8045
8046	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
8047	<desc>List of host network interfaces currently defined on the host.</desc>
8048	</attribute>
8049
8050	<attribute name="processorCount" type="unsigned long" readonly="yes">
8051	<desc>Number of (logical) CPUs installed in the host system.</desc>
8052	</attribute>
8053
8054	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
8055	<desc>Number of (logical) CPUs online in the host system.</desc>
8056	</attribute>
8057
8058	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
8059	<desc>Number of physical processor cores installed in the host system.</desc>
8060	</attribute>
8061
8062	<method name="getProcessorSpeed">
8063	<desc>Query the (approximate) maximum speed of a specified host CPU in
8064	Megahertz.
8065	</desc>
8066	<param name="cpuId" type="unsigned long" dir="in">
8067	<desc>
8068	Identifier of the CPU.
8069	</desc>
8070	</param>
8071	<param name="speed" type="unsigned long" dir="return">
8072	<desc>
8073	Speed value. 0 is returned if value is not known or @a cpuId is
8074	invalid.
8075	</desc>
8076	</param>
8077	</method>
8078
8079	<method name="getProcessorFeature">
8080	<desc>Query whether a CPU feature is supported or not.</desc>
8081	<param name="feature" type="ProcessorFeature" dir="in">
8082	<desc>
8083	CPU Feature identifier.
8084	</desc>
8085	</param>
8086	<param name="supported" type="boolean" dir="return">
8087	<desc>
8088	Feature is supported or not.
8089	</desc>
8090	</param>
8091	</method>
8092
8093	<method name="getProcessorDescription">
8094	<desc>Query the model string of a specified host CPU.
8095	</desc>
8096	<param name="cpuId" type="unsigned long" dir="in">
8097	<desc>
8098	Identifier of the CPU.
8099	<note>
8100	The current implementation might not necessarily return the
8101	description for this exact CPU.
8102	</note>
8103	</desc>
8104	</param>
8105	<param name="description" type="wstring" dir="return">
8106	<desc>
8107	Model string. An empty string is returned if value is not known or
8108	@a cpuId is invalid.
8109	</desc>
8110	</param>
8111	</method>
8112
8113	<method name="getProcessorCPUIDLeaf">
8114	<desc>
8115	Returns the CPU cpuid information for the specified leaf.
8116	</desc>
8117	<param name="cpuId" type="unsigned long" dir="in">
8118	<desc>
8119	Identifier of the CPU. The CPU most be online.
8120	<note>
8121	The current implementation might not necessarily return the
8122	description for this exact CPU.
8123	</note>
8124	</desc>
8125	</param>
8126	<param name="leaf" type="unsigned long" dir="in">
8127	<desc>
8128	CPUID leaf index (eax).
8129	</desc>
8130	</param>
8131	<param name="subLeaf" type="unsigned long" dir="in">
8132	<desc>
8133	CPUID leaf sub index (ecx). This currently only applies to cache
8134	information on Intel CPUs. Use 0 if retrieving values for
8135	<link to="IMachine::setCPUIDLeaf"/>.
8136	</desc>
8137	</param>
8138	<param name="valEax" type="unsigned long" dir="out">
8139	<desc>
8140	CPUID leaf value for register eax.
8141	</desc>
8142	</param>
8143	<param name="valEbx" type="unsigned long" dir="out">
8144	<desc>
8145	CPUID leaf value for register ebx.
8146	</desc>
8147	</param>
8148	<param name="valEcx" type="unsigned long" dir="out">
8149	<desc>
8150	CPUID leaf value for register ecx.
8151	</desc>
8152	</param>
8153	<param name="valEdx" type="unsigned long" dir="out">
8154	<desc>
8155	CPUID leaf value for register edx.
8156	</desc>
8157	</param>
8158	</method>
8159
8160	<attribute name="memorySize" type="unsigned long" readonly="yes">
8161	<desc>Amount of system memory in megabytes installed in the host system.</desc>
8162	</attribute>
8163
8164	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
8165	<desc>Available system memory in the host system.</desc>
8166	</attribute>
8167
8168	<attribute name="operatingSystem" type="wstring" readonly="yes">
8169	<desc>Name of the host system's operating system.</desc>
8170	</attribute>
8171
8172	<attribute name="OSVersion" type="wstring" readonly="yes">
8173	<desc>Host operating system's version string.</desc>
8174	</attribute>
8175
8176	<attribute name="UTCTime" type="long long" readonly="yes">
8177	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
8178	</attribute>
8179
8180	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
8181	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
8182	</attribute>
8183
8184	<method name="createHostOnlyNetworkInterface">
8185	<desc>
8186	Creates a new adapter for Host Only Networking.
8187	<result name="E_INVALIDARG">
8188	Host network interface @a name already exists.
8189	</result>
8190	</desc>
8191	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
8192	<desc>
8193	Created host interface object.
8194	</desc>
8195	</param>
8196	<param name="progress" type="IProgress" dir="return">
8197	<desc>
8198	Progress object to track the operation completion.
8199	</desc>
8200	</param>
8201	</method>
8202
8203	<method name="removeHostOnlyNetworkInterface">
8204	<desc>
8205	Removes the given Host Only Networking interface.
8206	<result name="VBOX_E_OBJECT_NOT_FOUND">
8207	No host network interface matching @a id found.
8208	</result>
8209	</desc>
8210	<param name="id" type="uuid" mod="string" dir="in">
8211	<desc>
8212	Adapter GUID.
8213	</desc>
8214	</param>
8215	<param name="progress" type="IProgress" dir="return">
8216	<desc>
8217	Progress object to track the operation completion.
8218	</desc>
8219	</param>
8220	</method>
8221
8222	<method name="createUSBDeviceFilter">
8223	<desc>
8224	Creates a new USB device filter. All attributes except
8225	the filter name are set to empty (any match),
8226	<i>active</i> is @c false (the filter is not active).
8227
8228	The created filter can be added to the list of filters using
8229	<link to="#insertUSBDeviceFilter"/>.
8230
8231	<see><link to="#USBDeviceFilters"/></see>
8232	</desc>
8233	<param name="name" type="wstring" dir="in">
8234	<desc>
8235	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8236	</desc>
8237	</param>
8238	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8239	<desc>Created filter object.</desc>
8240	</param>
8241	</method>
8242
8243	<method name="insertUSBDeviceFilter">
8244	<desc>
8245	Inserts the given USB device to the specified position
8246	in the list of filters.
8247
8248	Positions are numbered starting from @c 0. If the specified
8249	position is equal to or greater than the number of elements in
8250	the list, the filter is added at the end of the collection.
8251
8252	<note>
8253	Duplicates are not allowed, so an attempt to insert a
8254	filter already in the list is an error.
8255	</note>
8256	<note>
8257	If USB functionality is not available in the given edition of
8258	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8259	</note>
8260
8261	<see><link to="#USBDeviceFilters"/></see>
8262
8263	<result name="VBOX_E_INVALID_OBJECT_STATE">
8264	USB device filter is not created within this VirtualBox instance.
8265	</result>
8266	<result name="E_INVALIDARG">
8267	USB device filter already in list.
8268	</result>
8269
8270	</desc>
8271	<param name="position" type="unsigned long" dir="in">
8272	<desc>Position to insert the filter to.</desc>
8273	</param>
8274	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8275	<desc>USB device filter to insert.</desc>
8276	</param>
8277	</method>
8278
8279	<method name="removeUSBDeviceFilter">
8280	<desc>
8281	Removes a USB device filter from the specified position in the
8282	list of filters.
8283
8284	Positions are numbered starting from @c 0. Specifying a
8285	position equal to or greater than the number of elements in
8286	the list will produce an error.
8287
8288	<note>
8289	If USB functionality is not available in the given edition of
8290	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8291	</note>
8292
8293	<see><link to="#USBDeviceFilters"/></see>
8294
8295	<result name="E_INVALIDARG">
8296	USB device filter list empty or invalid @a position.
8297	</result>
8298
8299	</desc>
8300	<param name="position" type="unsigned long" dir="in">
8301	<desc>Position to remove the filter from.</desc>
8302	</param>
8303	</method>
8304
8305	<method name="findHostDVDDrive">
8306	<desc>
8307	Searches for a host DVD drive with the given @c name.
8308
8309	<result name="VBOX_E_OBJECT_NOT_FOUND">
8310	Given @c name does not correspond to any host drive.
8311	</result>
8312
8313	</desc>
8314	<param name="name" type="wstring" dir="in">
8315	<desc>Name of the host drive to search for</desc>
8316	</param>
8317	<param name="drive" type="IMedium" dir="return">
8318	<desc>Found host drive object</desc>
8319	</param>
8320	</method>
8321
8322	<method name="findHostFloppyDrive">
8323	<desc>
8324	Searches for a host floppy drive with the given @c name.
8325
8326	<result name="VBOX_E_OBJECT_NOT_FOUND">
8327	Given @c name does not correspond to any host floppy drive.
8328	</result>
8329
8330	</desc>
8331	<param name="name" type="wstring" dir="in">
8332	<desc>Name of the host floppy drive to search for</desc>
8333	</param>
8334	<param name="drive" type="IMedium" dir="return">
8335	<desc>Found host floppy drive object</desc>
8336	</param>
8337	</method>
8338
8339	<method name="findHostNetworkInterfaceByName">
8340	<desc>
8341	Searches through all host network interfaces for an interface with
8342	the given @c name.
8343	<note>
8344	The method returns an error if the given @c name does not
8345	correspond to any host network interface.
8346	</note>
8347	</desc>
8348	<param name="name" type="wstring" dir="in">
8349	<desc>Name of the host network interface to search for.</desc>
8350	</param>
8351	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8352	<desc>Found host network interface object.</desc>
8353	</param>
8354	</method>
8355	<method name="findHostNetworkInterfaceById">
8356	<desc>
8357	Searches through all host network interfaces for an interface with
8358	the given GUID.
8359	<note>
8360	The method returns an error if the given GUID does not
8361	correspond to any host network interface.
8362	</note>
8363	</desc>
8364	<param name="id" type="uuid" mod="string" dir="in">
8365	<desc>GUID of the host network interface to search for.</desc>
8366	</param>
8367	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8368	<desc>Found host network interface object.</desc>
8369	</param>
8370	</method>
8371	<method name="findHostNetworkInterfacesOfType">
8372	<desc>
8373	Searches through all host network interfaces and returns a list of interfaces of the specified type
8374	</desc>
8375	<param name="type" type="HostNetworkInterfaceType" dir="in">
8376	<desc>type of the host network interfaces to search for.</desc>
8377	</param>
8378	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8379	<desc>Found host network interface objects.</desc>
8380	</param>
8381	</method>
8382
8383	<method name="findUSBDeviceById">
8384	<desc>
8385	Searches for a USB device with the given UUID.
8386
8387	<result name="VBOX_E_OBJECT_NOT_FOUND">
8388	Given @c id does not correspond to any USB device.
8389	</result>
8390
8391	<see><link to="IUSBDevice::id"/></see>
8392	</desc>
8393	<param name="id" type="uuid" mod="string" dir="in">
8394	<desc>UUID of the USB device to search for.</desc>
8395	</param>
8396	<param name="device" type="IHostUSBDevice" dir="return">
8397	<desc>Found USB device object.</desc>
8398	</param>
8399	</method>
8400
8401	<method name="findUSBDeviceByAddress">
8402	<desc>
8403	Searches for a USB device with the given host address.
8404
8405	<result name="VBOX_E_OBJECT_NOT_FOUND">
8406	Given @c name does not correspond to any USB device.
8407	</result>
8408
8409	<see><link to="IUSBDevice::address"/></see>
8410	</desc>
8411	<param name="name" type="wstring" dir="in">
8412	<desc>
8413	Address of the USB device (as assigned by the host) to
8414	search for.
8415	</desc>
8416	</param>
8417	<param name="device" type="IHostUSBDevice" dir="return">
8418	<desc>Found USB device object.</desc>
8419	</param>
8420	</method>
8421
8422	<method name="generateMACAddress">
8423	<desc>
8424	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8425	</desc>
8426	<param name="address" type="wstring" dir="return">
8427	<desc>New Ethernet MAC address.</desc>
8428	</param>
8429	</method>
8430
8431	</interface>
8432
8433	<!--
8434	// ISystemProperties
8435	/////////////////////////////////////////////////////////////////////////
8436	-->
8437
8438	<interface
8439	name="ISystemProperties"
8440	extends="$unknown"
8441	uuid="413ea94c-efd9-491e-81fc-5df0c4d864bb"
8442	wsmap="managed"
8443	>
8444	<desc>
8445	The ISystemProperties interface represents global properties of the given
8446	VirtualBox installation.
8447
8448	These properties define limits and default values for various attributes
8449	and parameters. Most of the properties are read-only, but some can be
8450	changed by a user.
8451	</desc>
8452
8453	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8454	<desc>Minimum guest system memory in Megabytes.</desc>
8455	</attribute>
8456
8457	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8458	<desc>Maximum guest system memory in Megabytes.</desc>
8459	</attribute>
8460
8461	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8462	<desc>Minimum guest video memory in Megabytes.</desc>
8463	</attribute>
8464
8465	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8466	<desc>Maximum guest video memory in Megabytes.</desc>
8467	</attribute>
8468
8469	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8470	<desc>Minimum CPU count.</desc>
8471	</attribute>
8472
8473	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8474	<desc>Maximum CPU count.</desc>
8475	</attribute>
8476
8477	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8478	<desc>Maximum of monitors which could be connected.</desc>
8479	</attribute>
8480
8481	<attribute name="infoVDSize" type="long long" readonly="yes">
8482	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8483	does not reflect the limits of any virtual disk image format.</desc>
8484	</attribute>
8485
8486	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8487	<desc>
8488	Maximum number of serial ports associated with every
8489	<link to="IMachine"/> instance.
8490	</desc>
8491	</attribute>
8492
8493	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8494	<desc>
8495	Maximum number of parallel ports associated with every
8496	<link to="IMachine"/> instance.
8497	</desc>
8498	</attribute>
8499
8500	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8501	<desc>
8502	Maximum device position in the boot order. This value corresponds
8503	to the total number of devices a machine can boot from, to make it
8504	possible to include all possible devices to the boot list.
8505	<see><link to="IMachine::setBootOrder"/></see>
8506	</desc>
8507	</attribute>
8508
8509	<attribute name="defaultMachineFolder" type="wstring">
8510	<desc>
8511	Full path to the default directory used to create new or open
8512	existing machines when a machine settings file name contains no
8513	path.
8514
8515	Starting with VirtualBox 4.0, by default, this attribute contains
8516	the full path of folder named "VirtualBox VMs" in the user's
8517	home directory, which depends on the host platform.
8518
8519	When setting this attribute, a full path must be specified.
8520	Setting this property to @c null or an empty string or the
8521	special value "Machines" (for compatibility reasons) will restore
8522	that default value.
8523
8524	If the folder specified herein does not exist, it will be created
8525	automatically as needed.
8526
8527	<see>
8528	<link to="IVirtualBox::createMachine"/>,
8529	<link to="IVirtualBox::openMachine"/>
8530	</see>
8531	</desc>
8532	</attribute>
8533
8534	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8535	<desc>
8536	List of all medium storage formats supported by this VirtualBox
8537	installation.
8538
8539	Keep in mind that the medium format identifier
8540	(<link to="IMediumFormat::id"/>) used in other API calls like
8541	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8542	medium format is a case-insensitive string. This means that, for
8543	example, all of the following strings:
8544	<pre>
8545	"VDI"
8546	"vdi"
8547	"VdI"</pre>
8548	refer to the same medium format.
8549
8550	Note that the virtual medium framework is backend-based, therefore
8551	the list of supported formats depends on what backends are currently
8552	installed.
8553
8554	<see><link to="IMediumFormat"/></see>
8555	</desc>
8556	</attribute>
8557
8558	<attribute name="defaultHardDiskFormat" type="wstring">
8559	<desc>
8560	Identifier of the default medium format used by VirtualBox.
8561
8562	The medium format set by this attribute is used by VirtualBox
8563	when the medium format was not specified explicitly. One example is
8564	<link to="IVirtualBox::createHardDisk"/> with the empty
8565	format argument. A more complex example is implicit creation of
8566	differencing media when taking a snapshot of a virtual machine:
8567	this operation will try to use a format of the parent medium first
8568	and if this format does not support differencing media the default
8569	format specified by this argument will be used.
8570
8571	The list of supported medium formats may be obtained by the
8572	<link to="#mediumFormats"/> call. Note that the default medium
8573	format must have a capability to create differencing media;
8574	otherwise operations that create media implicitly may fail
8575	unexpectedly.
8576
8577	The initial value of this property is <tt>"VDI"</tt> in the current
8578	version of the VirtualBox product, but may change in the future.
8579
8580	<note>
8581	Setting this property to @c null or empty string will restore the
8582	initial value.
8583	</note>
8584
8585	<see>
8586	<link to="#mediumFormats"/>,
8587	<link to="IMediumFormat::id"/>,
8588	<link to="IVirtualBox::createHardDisk"/>
8589	</see>
8590	</desc>
8591	</attribute>
8592
8593	<attribute name="freeDiskSpaceWarning" type="long long">
8594	<desc>Issue a warning if the free disk space is below (or in some disk
8595	intensive operation is expected to go below) the given size in
8596	bytes.</desc>
8597	</attribute>
8598
8599	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8600	<desc>Issue a warning if the free disk space is below (or in some disk
8601	intensive operation is expected to go below) the given percentage.</desc>
8602	</attribute>
8603
8604	<attribute name="freeDiskSpaceError" type="long long">
8605	<desc>Issue an error if the free disk space is below (or in some disk
8606	intensive operation is expected to go below) the given size in
8607	bytes.</desc>
8608	</attribute>
8609
8610	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8611	<desc>Issue an error if the free disk space is below (or in some disk
8612	intensive operation is expected to go below) the given percentage.</desc>
8613	</attribute>
8614
8615	<attribute name="VRDEAuthLibrary" type="wstring">
8616	<desc>
8617	Library that provides authentication for Remote Desktop clients. The library
8618	is used if a virtual machine's authentication type is set to "external"
8619	in the VM RemoteDisplay configuration.
8620
8621	The system library extension (".DLL" or ".so") must be omitted.
8622	A full path can be specified; if not, then the library must reside on the
8623	system's default library path.
8624
8625	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8626	of that name in one of the default VirtualBox library directories.
8627
8628	For details about VirtualBox authentication libraries and how to implement
8629	them, please refer to the VirtualBox manual.
8630
8631	<note>
8632	Setting this property to @c null or empty string will restore the
8633	initial value.
8634	</note>
8635	</desc>
8636	</attribute>
8637
8638	<attribute name="webServiceAuthLibrary" type="wstring">
8639	<desc>
8640	Library that provides authentication for webservice clients. The library
8641	is used if a virtual machine's authentication type is set to "external"
8642	in the VM RemoteDisplay configuration and will be called from
8643	within the <link to="IWebsessionManager::logon" /> implementation.
8644
8645	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8646	there is no per-VM setting for this, as the webservice is a global
8647	resource (if it is running). Only for this setting (for the webservice),
8648	setting this value to a literal <tt>"null"</tt> string disables authentication,
8649	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8650	no matter what user name and password are supplied.
8651
8652	The initial value of this property is <tt>"VBoxAuth"</tt>,
8653	meaning that the webservice will use the same authentication
8654	library that is used by default for VRDE (again, see
8655	<link to="ISystemProperties::VRDEAuthLibrary" />).
8656	The format and calling convention of authentication libraries
8657	is the same for the webservice as it is for VRDE.
8658
8659	<note>
8660	Setting this property to @c null or empty string will restore the
8661	initial value.
8662	</note>
8663	</desc>
8664	</attribute>
8665
8666	<attribute name="defaultVRDEExtPack" type="wstring">
8667	<desc>
8668	The name of the extension pack providing the default VRDE.
8669
8670	This attribute is for choosing between multiple extension packs
8671	providing VRDE. If only one is installed, it will automatically be the
8672	default one. The attribute value can be empty if no VRDE extension
8673	pack is installed.
8674
8675	For details about VirtualBox Remote Desktop Extension and how to
8676	implement one, please refer to the VirtualBox SDK.
8677	</desc>
8678	</attribute>
8679
8680	<attribute name="logHistoryCount" type="unsigned long">
8681	<desc>
8682	This value specifies how many old release log files are kept.
8683	</desc>
8684	</attribute>
8685
8686	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8687	<desc>This value hold the default audio driver for the current
8688	system.</desc>
8689	</attribute>
8690
8691	<attribute name="autostartDatabasePath" type="wstring">
8692	<desc>
8693	The path to the autostart database. Depending on the host this might
8694	be a filesystem path or something else.
8695	</desc>
8696	</attribute>
8697
8698	<attribute name="defaultAdditionsISO" type="wstring">
8699	<desc>
8700	The path to the default Guest Additions ISO image. Can be empty if
8701	the location is not known in this installation.
8702	</desc>
8703	</attribute>
8704
8705	<attribute name="defaultFrontend" type="wstring">
8706	<desc>
8707	Selects which VM frontend should be used by default when launching
8708	a VM through the <link to="IMachine::launchVMProcess" /> method.
8709	Empty or @c null strings do not define a particular default, it is up
8710	to <link to="IMachine::launchVMProcess" /> to select one. See the
8711	description of <link to="IMachine::launchVMProcess" /> for the valid
8712	frontend types.
8713
8714	This global setting is overridden by the per-VM attribute
8715	<link to="IMachine::defaultFrontend" /> or a frontend type
8716	passed to <link to="IMachine::launchVMProcess" />.
8717	</desc>
8718	</attribute>
8719
8720	<method name="getMaxNetworkAdapters">
8721	<desc>
8722	Maximum total number of network adapters associated with every
8723	<link to="IMachine"/> instance.
8724	</desc>
8725
8726	<param name="chipset" type="ChipsetType" dir="in">
8727	<desc>The chipset type to get the value for.</desc>
8728	</param>
8729
8730
8731	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8732	<desc>The maximum total number of network adapters allowed.</desc>
8733	</param>
8734
8735	</method>
8736
8737	<method name="getMaxNetworkAdaptersOfType">
8738	<desc>
8739	Maximum number of network adapters of a given attachment type,
8740	associated with every <link to="IMachine"/> instance.
8741	</desc>
8742
8743	<param name="chipset" type="ChipsetType" dir="in">
8744	<desc>The chipset type to get the value for.</desc>
8745	</param>
8746
8747	<param name="type" type="NetworkAttachmentType" dir="in">
8748	<desc>Type of attachment.</desc>
8749	</param>
8750
8751	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8752	<desc>The maximum number of network adapters allowed for
8753	particular chipset and attachment type.</desc>
8754	</param>
8755
8756	</method>
8757
8758
8759	<method name="getMaxDevicesPerPortForStorageBus">
8760	<desc>Returns the maximum number of devices which can be attached to a port
8761	for the given storage bus.</desc>
8762
8763	<param name="bus" type="StorageBus" dir="in">
8764	<desc>The storage bus type to get the value for.</desc>
8765	</param>
8766
8767	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8768	<desc>The maximum number of devices which can be attached to the port for the given
8769	storage bus.</desc>
8770	</param>
8771	</method>
8772
8773	<method name="getMinPortCountForStorageBus">
8774	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8775
8776	<param name="bus" type="StorageBus" dir="in">
8777	<desc>The storage bus type to get the value for.</desc>
8778	</param>
8779
8780	<param name="minPortCount" type="unsigned long" dir="return">
8781	<desc>The minimum number of ports for the given storage bus.</desc>
8782	</param>
8783	</method>
8784
8785	<method name="getMaxPortCountForStorageBus">
8786	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8787
8788	<param name="bus" type="StorageBus" dir="in">
8789	<desc>The storage bus type to get the value for.</desc>
8790	</param>
8791
8792	<param name="maxPortCount" type="unsigned long" dir="return">
8793	<desc>The maximum number of ports for the given storage bus.</desc>
8794	</param>
8795	</method>
8796
8797	<method name="getMaxInstancesOfStorageBus">
8798	<desc>Returns the maximum number of storage bus instances which
8799	can be configured for each VM. This corresponds to the number of
8800	storage controllers one can have. Value may depend on chipset type
8801	used.</desc>
8802
8803	<param name="chipset" type="ChipsetType" dir="in">
8804	<desc>The chipset type to get the value for.</desc>
8805	</param>
8806
8807	<param name="bus" type="StorageBus" dir="in">
8808	<desc>The storage bus type to get the value for.</desc>
8809	</param>
8810
8811	<param name="maxInstances" type="unsigned long" dir="return">
8812	<desc>The maximum number of instances for the given storage bus.</desc>
8813	</param>
8814	</method>
8815
8816	<method name="getDeviceTypesForStorageBus">
8817	<desc>Returns list of all the supported device types
8818	(<link to="DeviceType"/>) for the given type of storage
8819	bus.</desc>
8820
8821	<param name="bus" type="StorageBus" dir="in">
8822	<desc>The storage bus type to get the value for.</desc>
8823	</param>
8824
8825	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8826	<desc>The list of all supported device types for the given storage bus.</desc>
8827	</param>
8828	</method>
8829
8830	<method name="getDefaultIoCacheSettingForStorageController">
8831	<desc>Returns the default I/O cache setting for the
8832	given storage controller</desc>
8833
8834	<param name="controllerType" type="StorageControllerType" dir="in">
8835	<desc>The storage controller to the setting for.</desc>
8836	</param>
8837
8838	<param name="enabled" type="boolean" dir="return">
8839	<desc>Returned flag indicating the default value</desc>
8840	</param>
8841	</method>
8842	</interface>
8843
8844	<!--
8845	// IGuest
8846	/////////////////////////////////////////////////////////////////////////
8847	-->
8848
8849	<interface
8850	name="IGuestOSType" extends="$unknown"
8851	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8852	wsmap="struct"
8853	>
8854	<desc>
8855	</desc>
8856
8857	<attribute name="familyId" type="wstring" readonly="yes">
8858	<desc>Guest OS family identifier string.</desc>
8859	</attribute>
8860
8861	<attribute name="familyDescription" type="wstring" readonly="yes">
8862	<desc>Human readable description of the guest OS family.</desc>
8863	</attribute>
8864
8865	<attribute name="id" type="wstring" readonly="yes">
8866	<desc>Guest OS identifier string.</desc>
8867	</attribute>
8868
8869	<attribute name="description" type="wstring" readonly="yes">
8870	<desc>Human readable description of the guest OS.</desc>
8871	</attribute>
8872
8873	<attribute name="is64Bit" type="boolean" readonly="yes">
8874	<desc>Returns @c true if the given OS is 64-bit</desc>
8875	</attribute>
8876
8877	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8878	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8879	</attribute>
8880
8881	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8882	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8883	</attribute>
8884
8885	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8886	<desc>Recommended RAM size in Megabytes.</desc>
8887	</attribute>
8888
8889	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8890	<desc>Recommended video RAM size in Megabytes.</desc>
8891	</attribute>
8892
8893	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8894	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8895	</attribute>
8896
8897	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8898	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8899	</attribute>
8900
8901	<attribute name="recommendedHDD" type="long long" readonly="yes">
8902	<desc>Recommended hard disk size in bytes.</desc>
8903	</attribute>
8904
8905	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8906	<desc>Returns recommended network adapter for this OS type.</desc>
8907	</attribute>
8908
8909	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8910	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8911	</attribute>
8912
8913	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8914	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8915	</attribute>
8916
8917	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8918	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8919	</attribute>
8920
8921	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8922	<desc>Recommended storage controller type for HD drives.</desc>
8923	</attribute>
8924
8925	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8926	<desc>Recommended storage bus type for HD drives.</desc>
8927	</attribute>
8928
8929	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8930	<desc>Recommended firmware type.</desc>
8931	</attribute>
8932
8933	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8934	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8935	</attribute>
8936
8937	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8938	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8939	</attribute>
8940
8941	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8942	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8943	</attribute>
8944
8945	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8946	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8947	</attribute>
8948
8949	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8950	<desc>Recommended chipset type.</desc>
8951	</attribute>
8952
8953	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8954	<desc>Recommended audio type.</desc>
8955	</attribute>
8956
8957	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8958	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8959	</attribute>
8960
8961	<attribute name="recommendedUSB" type="boolean" readonly="yes">
8962	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8963	</attribute>
8964
8965	</interface>
8966
8967	<enum
8968	name="AdditionsFacilityType"
8969	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8970	>
8971	<desc>
8972	Guest Additions facility IDs.
8973	</desc>
8974
8975	<const name="None" value="0">
8976	<desc>No/invalid facility.</desc>
8977	</const>
8978	<const name="VBoxGuestDriver" value="20">
8979	<desc>VirtualBox base driver (VBoxGuest).</desc>
8980	</const>
8981	<const name="AutoLogon" value="90">
8982	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8983	</const>
8984	<const name="VBoxService" value="100">
8985	<desc>VirtualBox system service (VBoxService).</desc>
8986	</const>
8987	<const name="VBoxTrayClient" value="101">
8988	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8989	</const>
8990	<const name="Seamless" value="1000">
8991	<desc>Seamless guest desktop integration.</desc>
8992	</const>
8993	<const name="Graphics" value="1100">
8994	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8995	are not immediately acted on and guest display resizes are probably not initiated by
8996	the guest additions.
8997	</desc>
8998	</const>
8999	<const name="All" value="2147483646">
9000	<desc>All facilities selected.</desc>
9001	</const>
9002	</enum>
9003
9004	<enum
9005	name="AdditionsFacilityClass"
9006	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
9007	>
9008	<desc>
9009	Guest Additions facility classes.
9010	</desc>
9011
9012	<const name="None" value="0">
9013	<desc>No/invalid class.</desc>
9014	</const>
9015	<const name="Driver" value="10">
9016	<desc>Driver.</desc>
9017	</const>
9018	<const name="Service" value="30">
9019	<desc>System service.</desc>
9020	</const>
9021	<const name="Program" value="50">
9022	<desc>Program.</desc>
9023	</const>
9024	<const name="Feature" value="100">
9025	<desc>Feature.</desc>
9026	</const>
9027	<const name="ThirdParty" value="999">
9028	<desc>Third party.</desc>
9029	</const>
9030	<const name="All" value="2147483646">
9031	<desc>All facility classes selected.</desc>
9032	</const>
9033	</enum>
9034
9035	<enum
9036	name="AdditionsFacilityStatus"
9037	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
9038	>
9039	<desc>
9040	Guest Additions facility states.
9041	</desc>
9042
9043	<const name="Inactive" value="0">
9044	<desc>Facility is not active.</desc>
9045	</const>
9046	<const name="Paused" value="1">
9047	<desc>Facility has been paused.</desc>
9048	</const>
9049	<const name="PreInit" value="20">
9050	<desc>Facility is preparing to initialize.</desc>
9051	</const>
9052	<const name="Init" value="30">
9053	<desc>Facility is initializing.</desc>
9054	</const>
9055	<const name="Active" value="50">
9056	<desc>Facility is up and running.</desc>
9057	</const>
9058	<const name="Terminating" value="100">
9059	<desc>Facility is shutting down.</desc>
9060	</const>
9061	<const name="Terminated" value="101">
9062	<desc>Facility successfully shut down.</desc>
9063	</const>
9064	<const name="Failed" value="800">
9065	<desc>Facility failed to start.</desc>
9066	</const>
9067	<const name="Unknown" value="999">
9068	<desc>Facility status is unknown.</desc>
9069	</const>
9070	</enum>
9071
9072	<interface
9073	name="IAdditionsFacility" extends="$unknown"
9074	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
9075	wsmap="struct"
9076	>
9077	<desc>
9078	Structure representing a Guest Additions facility.
9079	</desc>
9080
9081	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
9082	<desc>The class this facility is part of.</desc>
9083	</attribute>
9084
9085	<attribute name="lastUpdated" type="long long" readonly="yes">
9086	<desc>
9087	Time stamp of the last status update,
9088	in milliseconds since 1970-01-01 UTC.
9089	</desc>
9090	</attribute>
9091
9092	<attribute name="name" type="wstring" readonly="yes">
9093	<desc>The facility's friendly name.</desc>
9094	</attribute>
9095
9096	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
9097	<desc>The current status.</desc>
9098	</attribute>
9099
9100	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
9101	<desc>The facility's type ID.</desc>
9102	</attribute>
9103	</interface>
9104
9105	<enum
9106	name="AdditionsRunLevelType"
9107	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
9108	>
9109	<desc>
9110	Guest Additions run level type.
9111	</desc>
9112
9113	<const name="None" value="0">
9114	<desc>Guest Additions are not loaded.</desc>
9115	</const>
9116	<const name="System" value="1">
9117	<desc>Guest drivers are loaded.</desc>
9118	</const>
9119	<const name="Userland" value="2">
9120	<desc>Common components (such as application services) are loaded.</desc>
9121	</const>
9122	<const name="Desktop" value="3">
9123	<desc>Per-user desktop components are loaded.</desc>
9124	</const>
9125	</enum>
9126
9127	<enum
9128	name="AdditionsUpdateFlag"
9129	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
9130	>
9131	<desc>
9132	Guest Additions update flags.
9133	</desc>
9134
9135	<const name="None" value="0">
9136	<desc>No flag set.</desc>
9137	</const>
9138	<const name="WaitForUpdateStartOnly" value="1">
9139	<desc>Starts the regular updating process and waits until the
9140	actual Guest Additions update inside the guest was started.
9141	This can be necessary due to needed interaction with the guest
9142	OS during the installation phase.</desc>
9143	</const>
9144	</enum>
9145
9146	<enum
9147	name="GuestSessionStatus"
9148	uuid="ac2669da-4624-44f2-85b5-0b0bfb8d8673"
9149	>
9150	<desc>
9151	Guest session status. This enumeration represents possible values of
9152	the <link to="IGuestSession::status"/> attribute.
9153	</desc>
9154	<const name="Undefined" value="0">
9155	<desc>Guest session is in an undefined state.</desc>
9156	</const>
9157	<const name="Starting" value="10">
9158	<desc>Guest session is being started.</desc>
9159	</const>
9160	<const name="Started" value="100">
9161	<desc>Guest session has been started.</desc>
9162	</const>
9163	<const name="Terminating" value="480">
9164	<desc>Guest session is being terminated.</desc>
9165	</const>
9166	<const name="Terminated" value="500">
9167	<desc>Guest session terminated normally.</desc>
9168	</const>
9169	<const name="TimedOutKilled" value="512">
9170	<desc>Guest session timed out and was killed.</desc>
9171	</const>
9172	<const name="TimedOutAbnormally" value="513">
9173	<desc>Guest session timed out and was not killed successfully.</desc>
9174	</const>
9175	<const name="Down" value="600">
9176	<desc>Service/OS is stopping, guest session was killed.</desc>
9177	</const>
9178	<const name="Error" value="800">
9179	<desc>Something went wrong.</desc>
9180	</const>
9181	</enum>
9182
9183	<enum
9184	name="GuestSessionWaitForFlag"
9185	uuid="bb7a372a-f635-4e11-a81a-e707f3a52ef5"
9186	>
9187	<desc>
9188	Guest session waiting flags. Multiple flags can be combined.
9189	</desc>
9190
9191	<const name="None" value="0">
9192	<desc>No waiting flags specified. Do not use this.</desc>
9193	</const>
9194	<const name="Start" value="1">
9195	<desc>Wait for the guest session being started.</desc>
9196	</const>
9197	<const name="Terminate" value="2">
9198	<desc>Wait for the guest session being terminated.</desc>
9199	</const>
9200	<const name="Status" value="4">
9201	<desc>Wait for the next guest session status change.</desc>
9202	</const>
9203	</enum>
9204
9205	<enum
9206	name="GuestSessionWaitResult"
9207	uuid="c0f6a8a5-fdb6-42bf-a582-56c6f82bcd2d"
9208	>
9209	<desc>
9210	Guest session waiting results. Depending on the session waiting flags (for
9211	more information see <link to="GuestSessionWaitForFlag"/>) the waiting result
9212	can vary based on the session's current status.
9213
9214	To wait for a guest session to terminate after it has been
9215	created by <link to="IGuest::createSession"/> one would specify
9216	GuestSessionWaitResult_Terminate.
9217	</desc>
9218
9219	<const name="None" value="0">
9220	<desc>No result was returned. Not being used.</desc>
9221	</const>
9222	<const name="Start" value="1">
9223	<desc>The guest session has been started.</desc>
9224	</const>
9225	<const name="Terminate" value="2">
9226	<desc>The guest session has been terminated.</desc>
9227	</const>
9228	<const name="Status" value="3">
9229	<desc>
9230	The guest session has changed its status. The status then can
9231	be retrieved via <link to="IGuestSession::status"/>.
9232	</desc>
9233	</const>
9234	<const name="Error" value="4">
9235	<desc>Error while executing the process.</desc>
9236	</const>
9237	<const name="Timeout" value="5">
9238	<desc>
9239	The waiting operation timed out. This also will happen
9240	when no event has been occured matching the
9241	current waiting flags in a <link to="IGuestSession::waitFor"/> call.
9242	</desc>
9243	</const>
9244	<const name="WaitFlagNotSupported" value="6">
9245	<desc>
9246	A waiting flag specified in the <link to="IGuestSession::waitFor"/> call
9247	is not supported by the guest.
9248	</desc>
9249	</const>
9250	</enum>
9251
9252	<enum
9253	name="FileSeekType"
9254	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
9255	>
9256	<desc>
9257	File seeking types.
9258	</desc>
9259
9260	<const name="Set" value="0">
9261	<desc>Seek from the start of the file.</desc>
9262	</const>
9263	<const name="Current" value="1">
9264	<desc>Seek from the current file position.</desc>
9265	</const>
9266	</enum>
9267
9268	<enum
9269	name="ProcessInputFlag"
9270	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
9271	>
9272	<desc>
9273	Guest process input flags.
9274	</desc>
9275	<const name="None" value="0">
9276	<desc>No flag set.</desc>
9277	</const>
9278	<const name="EndOfFile" value="1">
9279	<desc>End of file (input) reached.</desc>
9280	</const>
9281	</enum>
9282
9283	<enum
9284	name="ProcessOutputFlag"
9285	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
9286	>
9287	<desc>
9288	Guest process output flags for specifying which
9289	type of output to retrieve.
9290	</desc>
9291	<const name="None" value="0">
9292	<desc>No flags set. Get output from stdout.</desc>
9293	</const>
9294	<const name="StdErr" value="1">
9295	<desc>Get output from stderr.</desc>
9296	</const>
9297	</enum>
9298
9299	<enum
9300	name="ProcessWaitForFlag"
9301	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
9302	>
9303	<desc>
9304	Process waiting flags. Multiple flags can be combined.
9305	</desc>
9306
9307	<const name="None" value="0">
9308	<desc>No waiting flags specified. Do not use this.</desc>
9309	</const>
9310	<const name="Start" value="1">
9311	<desc>Wait for the process being started.</desc>
9312	</const>
9313	<const name="Terminate" value="2">
9314	<desc>Wait for the process being terminated.</desc>
9315	</const>
9316	<const name="StdIn" value="4">
9317	<desc>Wait for stdin becoming available.</desc>
9318	</const>
9319	<const name="StdOut" value="8">
9320	<desc>Wait for data becoming available on stdout.</desc>
9321	</const>
9322	<const name="StdErr" value="16">
9323	<desc>Wait for data becoming available on stderr.</desc>
9324	</const>
9325	</enum>
9326
9327	<enum
9328	name="ProcessWaitResult"
9329	uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
9330	>
9331	<desc>
9332	Process waiting results. Depending on the process waiting flags (for
9333	more information see <link to="ProcessWaitForFlag"/>) the waiting result
9334	can vary based on the processes' current status.
9335
9336	To wait for a guest process to terminate after it has been
9337	created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9338	one would specify ProcessWaitResult_Terminate.
9339
9340	If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9341	a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9342	stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9343	ProcessWaitResult_StdErr.
9344	</desc>
9345
9346	<const name="None" value="0">
9347	<desc>No result was returned. Not being used.</desc>
9348	</const>
9349	<const name="Start" value="1">
9350	<desc>The process has been started.</desc>
9351	</const>
9352	<const name="Terminate" value="2">
9353	<desc>The process has been terminated.</desc>
9354	</const>
9355	<const name="Status" value="3">
9356	<desc>
9357	The process has changed its status. The status then can
9358	be retrieved via <link to="IProcess::status"/>.
9359	</desc>
9360	</const>
9361	<const name="Error" value="4">
9362	<desc>Error while executing the process.</desc>
9363	</const>
9364	<const name="Timeout" value="5">
9365	<desc>
9366	The waiting operation timed out. This also will happen
9367	when no event has been occured matching the
9368	current waiting flags in a <link to="IProcess::waitFor"/> call.
9369	</desc>
9370	</const>
9371	<const name="StdIn" value="6">
9372	<desc>
9373	The process signalled that stdin became available for writing
9374	and that the process awaits input now.</desc>
9375	</const>
9376	<const name="StdOut" value="7">
9377	<desc>Data on stdout became available for reading.</desc>
9378	</const>
9379	<const name="StdErr" value="8">
9380	<desc>Data on stderr became available for reading.</desc>
9381	</const>
9382	<const name="WaitFlagNotSupported" value="9">
9383	<desc>
9384	A waiting flag specified in the <link to="IProcess::waitFor"/> call
9385	is not supported by the guest.
9386	</desc>
9387	</const>
9388	</enum>
9389
9390	<enum
9391	name="CopyFileFlag"
9392	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9393	>
9394	<desc>
9395	File copying flags.
9396	</desc>
9397	<const name="None" value="0">
9398	<desc>No flag set.</desc>
9399	</const>
9400	<const name="Recursive" value="1">
9401	<desc>Copy directories recursively.</desc>
9402	</const>
9403	<const name="Update" value="2">
9404	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9405	</const>
9406	<const name="FollowLinks" value="4">
9407	<desc>Follow symbolic links.</desc>
9408	</const>
9409	</enum>
9410
9411	<enum
9412	name="DirectoryCreateFlag"
9413	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9414	>
9415	<desc>
9416	Directory creation flags.
9417	</desc>
9418	<const name="None" value="0">
9419	<desc>No flag set.</desc>
9420	</const>
9421	<const name="Parents" value="1">
9422	<desc>No error if existing, make parent directories as needed.</desc>
9423	</const>
9424	</enum>
9425
9426	<enum
9427	name="DirectoryRemoveRecFlag"
9428	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9429	>
9430	<desc>
9431	Directory recursive removement flags.
9432	</desc>
9433
9434	<const name="None" value="0">
9435	<desc>No flag set.</desc>
9436	</const>
9437	<const name="ContentAndDir" value="1">
9438	<desc>Delete the content of the directory and the directory itself.</desc>
9439	</const>
9440	<const name="ContentOnly" value="2">
9441	<desc>Only delete the content of the directory, omit the directory it self.</desc>
9442	</const>
9443	</enum>
9444
9445	<enum
9446	name="PathRenameFlag"
9447	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9448	>
9449	<desc>
9450	Path renaming flags.
9451	</desc>
9452
9453	<const name="None" value="0">
9454	<desc>No flag set.</desc>
9455	</const>
9456	<const name="NoReplace" value="1">
9457	<desc>Do not replace anything.</desc>
9458	</const>
9459	<const name="Replace" value="2">
9460	<desc>This will replace attempt any target which isn't a directory.</desc>
9461	</const>
9462	<const name="NoSymlinks" value="4">
9463	<desc>Don't allow symbolic links as part of the path.</desc>
9464	</const>
9465	</enum>
9466
9467	<enum
9468	name="ProcessCreateFlag"
9469	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9470	>
9471	<desc>
9472	Guest process execution flags.
9473	</desc>
9474
9475	<const name="None" value="0">
9476	<desc>No flag set.</desc>
9477	</const>
9478	<const name="WaitForProcessStartOnly" value="1">
9479	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9480	process itself then uses an infinite timeout.</desc>
9481	</const>
9482	<const name="IgnoreOrphanedProcesses" value="2">
9483	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9484	</const>
9485	<const name="Hidden" value="4">
9486	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9487	</const>
9488	<const name="NoProfile" value="8">
9489	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9490	</const>
9491	<const name="WaitForStdOut" value="16">
9492	<desc>The guest process waits until all data from stdout is read out.</desc>
9493	</const>
9494	<const name="WaitForStdErr" value="32">
9495	<desc>The guest process waits until all data from stderr is read out.</desc>
9496	</const>
9497	<const name="ExpandArguments" value="64">
9498	<desc>Expands environment variables in process arguments.</desc>
9499	</const>
9500	</enum>
9501
9502	<enum
9503	name="ProcessPriority"
9504	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9505	>
9506	<desc>
9507	Process priorities.
9508	</desc>
9509
9510	<const name="Invalid" value="0">
9511	<desc>Invalid priority, do not use.</desc>
9512	</const>
9513	<const name="Default" value="1">
9514	<desc>Default process priority determined by the OS.</desc>
9515	</const>
9516	</enum>
9517
9518	<enum
9519	name="SymlinkType"
9520	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9521	>
9522	<desc>
9523	Symbolic link types.
9524	</desc>
9525
9526	<const name="Unknown" value="0">
9527	<desc>It is not known what is being targeted.</desc>
9528	</const>
9529	<const name="Directory" value="1">
9530	<desc>The link targets a directory.</desc>
9531	</const>
9532	<const name="File" value="2">
9533	<desc>The link targets a file (or whatever else).</desc>
9534	</const>
9535	</enum>
9536
9537	<enum
9538	name="SymlinkReadFlag"
9539	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9540	>
9541	<desc>
9542	Symbolic link reading flags.
9543	</desc>
9544
9545	<const name="None" value="0">
9546	<desc>No flags set.</desc>
9547	</const>
9548	<const name="NoSymlinks" value="1">
9549	<desc>Don't allow symbolic links as part of the path.</desc>
9550	</const>
9551	</enum>
9552
9553	<enum
9554	name="ProcessStatus"
9555	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9556	>
9557	<desc>
9558	Process execution statuses.
9559	</desc>
9560
9561	<const name="Undefined" value="0">
9562	<desc>Process is in an undefined state.</desc>
9563	</const>
9564	<const name="Starting" value="10">
9565	<desc>Process is being started.</desc>
9566	</const>
9567	<const name="Started" value="100">
9568	<desc>Process has been started.</desc>
9569	</const>
9570	<const name="Paused" value="110">
9571	<desc>Process has been paused.</desc>
9572	</const>
9573	<const name="Terminating" value="480">
9574	<desc>Process is being terminated.</desc>
9575	</const>
9576	<const name="TerminatedNormally" value="500">
9577	<desc>Process terminated normally.</desc>
9578	</const>
9579	<const name="TerminatedSignal" value="510">
9580	<desc>Process terminated via signal.</desc>
9581	</const>
9582	<const name="TerminatedAbnormally" value="511">
9583	<desc>Process terminated abnormally.</desc>
9584	</const>
9585	<const name="TimedOutKilled" value="512">
9586	<desc>Process timed out and was killed.</desc>
9587	</const>
9588	<const name="TimedOutAbnormally" value="513">
9589	<desc>Process timed out and was not killed successfully.</desc>
9590	</const>
9591	<const name="Down" value="600">
9592	<desc>Service/OS is stopping, process was killed.</desc>
9593	</const>
9594	<const name="Error" value="800">
9595	<desc>Something went wrong.</desc>
9596	</const>
9597	</enum>
9598
9599	<enum
9600	name="ProcessInputStatus"
9601	uuid="a4a0ef9c-29cc-4805-9803-c8215ae9da6c"
9602	>
9603	<desc>
9604	Process input statuses.
9605	</desc>
9606
9607	<const name="Undefined" value="0">
9608	<desc>Undefined state.</desc>
9609	</const>
9610	<const name="Broken" value="1">
9611	<desc>Input pipe is broken.</desc>
9612	</const>
9613	<const name="Available" value="10">
9614	<desc>Input pipe became available for writing.</desc>
9615	</const>
9616	<const name="Written" value="50">
9617	<desc>Data has been successfully written.</desc>
9618	</const>
9619	<const name="Overflow" value="100">
9620	<desc>Too much input data supplied, data overflow.</desc>
9621	</const>
9622	</enum>
9623
9624	<enum
9625	name="FileStatus"
9626	uuid="8c86468b-b97b-4080-8914-e29f5b0abd2c"
9627	>
9628	<desc>
9629	File statuses.
9630	</desc>
9631
9632	<const name="Undefined" value="0">
9633	<desc>File is in an undefined state.</desc>
9634	</const>
9635	<const name="Opening" value="10">
9636	<desc>Guest file is opening.</desc>
9637	</const>
9638	<const name="Open" value="100">
9639	<desc>Guest file has been successfully opened.</desc>
9640	</const>
9641	<const name="Closing" value="150">
9642	<desc>Guest file closing.</desc>
9643	</const>
9644	<const name="Closed" value="200">
9645	<desc>Guest file has been closed.</desc>
9646	</const>
9647	<const name="Down" value="600">
9648	<desc>Service/OS is stopping, guest file was closed.</desc>
9649	</const>
9650	<const name="Error" value="800">
9651	<desc>Something went wrong.</desc>
9652	</const>
9653	</enum>
9654
9655	<enum
9656	name="FsObjType"
9657	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9658	>
9659	<desc>
9660	File system object type.
9661	</desc>
9662
9663	<const name="Undefined" value="0">
9664	<desc>Type is undefined / unknown.</desc>
9665	</const>
9666	<const name="FIFO" value="1">
9667	<desc>Named pipe.</desc>
9668	</const>
9669	<const name="DevChar" value="10">
9670	<desc>Character device.</desc>
9671	</const>
9672	<const name="DevBlock" value="11">
9673	<desc>Block device.</desc>
9674	</const>
9675	<const name="Directory" value="50">
9676	<desc>Directory.</desc>
9677	</const>
9678	<const name="File" value="80">
9679	<desc>File.</desc>
9680	</const>
9681	<const name="Symlink" value="100">
9682	<desc>Symlink.</desc>
9683	</const>
9684	<const name="Socket" value="200">
9685	<desc>Socket.</desc>
9686	</const>
9687	<const name="Whiteout" value="400">
9688	<desc>Whiteout.</desc>
9689	</const>
9690	</enum>
9691
9692	<enum
9693	name="DragAndDropAction"
9694	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9695	>
9696	<desc>
9697	Possible actions within an Drag and Drop operation.
9698	</desc>
9699
9700	<const name="Ignore" value="0">
9701	<desc>Do nothing.</desc>
9702	</const>
9703
9704	<const name="Copy" value="1">
9705	<desc>Copy the item to the target.</desc>
9706	</const>
9707
9708	<const name="Move" value="2">
9709	<desc>Move the item to the target.</desc>
9710	</const>
9711
9712	<const name="Link" value="3">
9713	<desc>Link the item from within the target.</desc>
9714	</const>
9715	</enum>
9716
9717	<enum
9718	name="DirectoryOpenFlag"
9719	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9720	>
9721	<desc>
9722	Directory open flags.
9723	</desc>
9724	<const name="None" value="0">
9725	<desc>No flag set.</desc>
9726	</const>
9727	<const name="NoSymlinks" value="1">
9728	<desc>Don't allow symbolic links as part of the path.</desc>
9729	</const>
9730	</enum>
9731
9732	<interface
9733	name="IGuestSession" extends="$unknown"
9734	uuid="c8e8607b-5e67-4073-8f14-146515d0c1ff"
9735	wsmap="managed"
9736	>
9737	<desc>
9738	A guest session represents one impersonated user account on the guest, so
9739	every operation will use the same credentials specified when creating
9740	the session object via <link to="IGuest::createSession"/>.
9741
9742	There can be a maximum of 32 sessions at once per VM. Each session keeps
9743	track of its started guest processes, opened guest files or guest directories.
9744	To work on guest files or directories a guest session offers methods to open
9745	or create such objects (see <link to="IGuestSession::fileOpen"/> or
9746	<link to="IGuestSession::directoryOpen"/> for example).
9747
9748	When done with either of these objects, including the guest session itself,
9749	use the appropriate close() method to let the object do its cleanup work.
9750
9751	Every guest session has its own environment variable block which gets
9752	automatically applied when starting a new guest process via
9753	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9754	To override (or unset) certain environment variables already set by the
9755	guest session, one can specify a per-process environment block when using
9756	one of the both above mentioned process creation calls.
9757	</desc>
9758
9759	<attribute name="user" type="wstring" readonly="yes">
9760	<desc>Returns the user name used by this session to impersonate
9761	users on the guest.
9762	</desc>
9763	</attribute>
9764	<attribute name="domain" type="wstring" readonly="yes">
9765	<desc>Returns the domain name used by this session to impersonate
9766	users on the guest.
9767	</desc>
9768	</attribute>
9769	<attribute name="name" type="wstring" readonly="yes">
9770	<desc>Returns the session's friendly name.</desc>
9771	</attribute>
9772	<attribute name="id" type="unsigned long" readonly="yes">
9773	<desc>Returns the internal session ID.</desc>
9774	</attribute>
9775	<attribute name="timeout" type="unsigned long">
9776	<desc>
9777	Returns the session timeout (in ms).
9778	<result name="E_NOTIMPL">
9779	The method is not implemented yet.
9780	</result>
9781	</desc>
9782	</attribute>
9783	<attribute name="status" type="GuestSessionStatus" readonly="yes">
9784	<desc>Returns the current session status.</desc>
9785	</attribute>
9786	<attribute name="environment" type="wstring" safearray="yes">
9787	<desc>
9788	Returns the current session environment.
9789	</desc>
9790	</attribute>
9791	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9792	<desc>
9793	Returns all current guest processes.
9794	</desc>
9795	</attribute>
9796	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9797	<desc>
9798	Returns all currently opened guest directories.
9799	</desc>
9800	</attribute>
9801	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9802	<desc>
9803	Returns all currently opened guest files.
9804	</desc>
9805	</attribute>
9806	<attribute name="eventSource" type="IEventSource" readonly="yes">
9807	<desc>
9808	Event source for guest session events.
9809	</desc>
9810	</attribute>
9811
9812	<method name="close">
9813	<desc>
9814	Closes this session. All opened guest directories, files and
9815	processes which are not referenced by clients anymore will be
9816	uninitialized.
9817	</desc>
9818	</method>
9819
9820	<method name="copyFrom">
9821	<desc>
9822	Copies a file from guest to the host.
9823
9824	<result name="VBOX_E_IPRT_ERROR">
9825	Error starting the copy operation.
9826	</result>
9827	</desc>
9828	<param name="source" type="wstring" dir="in">
9829	<desc>Source file on the guest to copy to the host.</desc>
9830	</param>
9831	<param name="dest" type="wstring" dir="in">
9832	<desc>Destination file name on the host.</desc>
9833	</param>
9834	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9835	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9836	</param>
9837	<param name="progress" type="IProgress" dir="return">
9838	<desc>Progress object to track the operation completion.</desc>
9839	</param>
9840	</method>
9841
9842	<method name="copyTo">
9843	<desc>
9844	Copies a file from host to the guest.
9845
9846	<result name="VBOX_E_IPRT_ERROR">
9847	Error starting the copy operation.
9848	</result>
9849	</desc>
9850	<param name="source" type="wstring" dir="in">
9851	<desc>Source file on the host to copy to the guest.</desc>
9852	</param>
9853	<param name="dest" type="wstring" dir="in">
9854	<desc>Destination file name on the guest.</desc>
9855	</param>
9856	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9857	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9858	</param>
9859	<param name="progress" type="IProgress" dir="return">
9860	<desc>Progress object to track the operation completion.</desc>
9861	</param>
9862	</method>
9863
9864	<method name="directoryCreate">
9865	<desc>
9866	Create a directory on the guest.
9867
9868	<result name="VBOX_E_IPRT_ERROR">
9869	Error while creating the directory.
9870	</result>
9871	</desc>
9872	<param name="path" type="wstring" dir="in">
9873	<desc>Full path of directory to create.</desc>
9874	</param>
9875	<param name="mode" type="unsigned long" dir="in">
9876	<desc>File creation mode.</desc>
9877	</param>
9878	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9879	<desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9880	</param>
9881	</method>
9882
9883	<method name="directoryCreateTemp">
9884	<desc>
9885	Create a temporary directory on the guest.
9886
9887	<result name="VBOX_E_NOT_SUPPORTED">
9888	The operation is not possible as requested on this particular
9889	guest type.
9890	</result>
9891	<result name="E_INVALIDARG">
9892	Invalid argument. This includes an incorrectly formatted template,
9893	or a non-absolute path.
9894	</result>
9895	<result name="VBOX_E_IPRT_ERROR">
9896	The temporary directory could not be created. Possible reasons
9897	include a non-existing path or an insecure path when the secure
9898	option was requested.
9899	</result>
9900	</desc>
9901	<param name="templateName" type="wstring" dir="in">
9902	<desc>Template for the name of the directory to create. This must
9903	contain at least one 'X' character. The first group of consecutive
9904	'X' characters in the template will be replaced by a random
9905	alphanumeric string to produce a unique name.</desc>
9906	</param>
9907	<param name="mode" type="unsigned long" dir="in">
9908	<desc>The mode of the directory to create. Use 0700 unless there are
9909	reasons not to. This parameter is ignored if "secure" is specified.
9910	</desc>
9911	</param>
9912	<param name="path" type="wstring" dir="in">
9913	<desc>The absolute path to create the temporary directory in.</desc>
9914	</param>
9915	<param name="secure" type="boolean" dir="in">
9916	<desc>Whether to fail if the directory can not be securely created.
9917	Currently this means that another unprivileged user cannot
9918	manipulate the path specified or remove the temporary directory
9919	after it has been created. Also causes the mode specified to be
9920	ignored. May not be supported on all guest types.</desc>
9921	</param>
9922	<param name="directory" type="wstring" dir="return">
9923	<desc>On success this will contain the name of the directory created
9924	with full path.</desc>
9925	</param>
9926	</method>
9927
9928	<method name="directoryExists">
9929	<desc>
9930	Checks whether a directory exists on the guest or not.
9931
9932	<result name="VBOX_E_IPRT_ERROR">
9933	Error while checking existence of the directory specified.
9934	</result>
9935	</desc>
9936	<param name="path" type="wstring" dir="in">
9937	<desc>Directory to check existence for.</desc>
9938	</param>
9939	<param name="exists" type="boolean" dir="return">
9940	<desc>Returns @c true if the directory exists, @c false if not.</desc>
9941	</param>
9942	</method>
9943
9944	<method name="directoryOpen">
9945	<desc>
9946	Opens a directory and creates a <link to="IGuestDirectory"/> object that
9947	can be used for further operations.
9948
9949	<result name="VBOX_E_OBJECT_NOT_FOUND">
9950	Directory to open was not found.
9951	</result>
9952	<result name="VBOX_E_IPRT_ERROR">
9953	Error while opening the directory.
9954	</result>
9955	</desc>
9956	<param name="path" type="wstring" dir="in">
9957	<desc>Full path to file to open.</desc>
9958	</param>
9959	<param name="filter" type="wstring" dir="in">
9960	<desc>Open filter to apply. This can include wildcards like ? and *.</desc>
9961	</param>
9962	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9963	<desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
9964	</param>
9965	<param name="directory" type="IGuestDirectory" dir="return">
9966	<desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
9967	</param>
9968	</method>
9969
9970	<method name="directoryQueryInfo">
9971	<desc>
9972	Queries information of a directory on the guest.
9973
9974	<result name="VBOX_E_OBJECT_NOT_FOUND">
9975	Directory to query information for was not found.
9976	</result>
9977	<result name="VBOX_E_IPRT_ERROR">
9978	Error querying information.
9979	</result>
9980	</desc>
9981	<param name="path" type="wstring" dir="in">
9982	<desc>Directory to query information for.</desc>
9983	</param>
9984	<param name="info" type="IGuestFsObjInfo" dir="return">
9985	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9986	</param>
9987	</method>
9988
9989	<method name="directoryRemove">
9990	<desc>
9991	Removes a guest directory if not empty.
9992
9993	<result name="E_NOTIMPL">
9994	The method is not implemented yet.
9995	</result>
9996	</desc>
9997	<param name="path" type="wstring" dir="in">
9998	<desc>Full path of directory to remove.</desc>
9999	</param>
10000	</method>
10001
10002	<method name="directoryRemoveRecursive">
10003	<desc>
10004	Removes a guest directory recursively.
10005
10006	<result name="E_NOTIMPL">
10007	The method is not implemented yet.
10008	</result>
10009	</desc>
10010	<param name="path" type="wstring" dir="in">
10011	<desc>Full path of directory to remove recursively.</desc>
10012	</param>
10013	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
10014	<desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
10015	</param>
10016	<param name="progress" type="IProgress" dir="return">
10017	<desc>Progress object to track the operation completion.</desc>
10018	</param>
10019	</method>
10020
10021	<method name="directoryRename">
10022	<desc>
10023	Renames a directory on the guest.
10024
10025	<result name="E_NOTIMPL">
10026	The method is not implemented yet.
10027	</result>
10028	</desc>
10029	<param name="source" type="wstring" dir="in">
10030	<desc>Source directory to rename.</desc>
10031	</param>
10032	<param name="dest" type="wstring" dir="in">
10033	<desc>Destination directory to rename the source to.</desc>
10034	</param>
10035	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10036	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10037	</param>
10038	</method>
10039
10040	<method name="directorySetACL">
10041	<desc>
10042	Sets the ACL (Access Control List) of a guest directory.
10043
10044	<result name="E_NOTIMPL">
10045	The method is not implemented yet.
10046	</result>
10047	</desc>
10048	<param name="path" type="wstring" dir="in">
10049	<desc>Full path of directory to set the ACL for.</desc>
10050	</param>
10051	<param name="acl" type="wstring" dir="in">
10052	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10053	</param>
10054	</method>
10055
10056	<method name="environmentClear">
10057	<desc>
10058	Clears (deletes) all session environment variables.
10059
10060	<result name="VBOX_E_IPRT_ERROR">
10061	Error while clearing the session environment variables.
10062	</result>
10063	</desc>
10064	</method>
10065
10066	<method name="environmentGet">
10067	<desc>
10068	Gets the value of a session environment variable.
10069
10070	<result name="VBOX_E_IPRT_ERROR">
10071	Error while getting the value of the session environment variable.
10072	</result>
10073	</desc>
10074	<param name="name" type="wstring" dir="in">
10075	<desc>Name of session environment variable to get the value for.</desc>
10076	</param>
10077	<param name="value" type="wstring" dir="return">
10078	<desc>
10079	Value of the session environment variable specified. If this variable
10080	does not exist and empty value will be returned.
10081	</desc>
10082	</param>
10083	</method>
10084
10085	<method name="environmentSet">
10086	<desc>
10087	Sets a session environment variable.
10088
10089	<result name="VBOX_E_IPRT_ERROR">
10090	Error while setting the session environment variable.
10091	</result>
10092	</desc>
10093	<param name="name" type="wstring" dir="in">
10094	<desc>Name of session environment variable to set.</desc>
10095	</param>
10096	<param name="value" type="wstring" dir="in">
10097	<desc>Value to set the session environment variable to.</desc>
10098	</param>
10099	</method>
10100
10101	<method name="environmentUnset">
10102	<desc>
10103	Unsets session environment variable.
10104
10105	<result name="VBOX_E_IPRT_ERROR">
10106	Error while unsetting the session environment variable.
10107	</result>
10108	</desc>
10109	<param name="name" type="wstring" dir="in">
10110	<desc>Name of session environment variable to unset (clear).</desc>
10111	</param>
10112	</method>
10113
10114	<method name="fileCreateTemp">
10115	<desc>
10116	Creates a temporary file on the guest.
10117
10118	<result name="VBOX_E_NOT_SUPPORTED">
10119	The operation is not possible as requested on this particular
10120	guest type.
10121	</result>
10122	<result name="E_INVALIDARG">
10123	Invalid argument. This includes an incorrectly formatted template,
10124	or a non-absolute path.
10125	</result>
10126	<result name="VBOX_E_IPRT_ERROR">
10127	The temporary file could not be created. Possible reasons include
10128	a non-existing path or an insecure path when the secure
10129	option was requested.
10130	</result>
10131	</desc>
10132	<param name="templateName" type="wstring" dir="in">
10133	<desc>Template for the name of the file to create. This must contain
10134	at least one 'X' character. The first group of consecutive 'X'
10135	characters in the template will be replaced by a random
10136	alphanumeric string to produce a unique name.
10137	</desc>
10138	</param>
10139	<param name="mode" type="unsigned long" dir="in">
10140	<desc>The mode of the file to create. Use 0700 unless there are
10141	reasons not to. This parameter is ignored if "secure" is specified.
10142	</desc>
10143	</param>
10144	<param name="path" type="wstring" dir="in">
10145	<desc>The absolute path to create the temporary file in.</desc>
10146	</param>
10147	<param name="secure" type="boolean" dir="in">
10148	<desc>Whether to fail if the file can not be securely created.
10149	Currently this means that another unprivileged user cannot
10150	manipulate the path specified or remove the temporary file after
10151	it has been created. Also causes the mode specified to be ignored.
10152	May not be supported on all guest types.</desc>
10153	</param>
10154	<param name="file" type="IGuestFile" dir="return">
10155	<desc>On success this will contain an open file object for the new
10156	temporary file.
10157	</desc>
10158	</param>
10159	</method>
10160
10161	<method name="fileExists">
10162	<desc>
10163	Checks whether a file exists on the guest or not.
10164
10165	<result name="VBOX_E_IPRT_ERROR">
10166	Error while checking existence of the file specified.
10167	</result>
10168	</desc>
10169	<param name="path" type="wstring" dir="in">
10170	<desc>File to check existence for.</desc>
10171	</param>
10172	<param name="exists" type="boolean" dir="return">
10173	<desc>Returns @c true if the file exists, @c false if not.</desc>
10174	</param>
10175	</method>
10176
10177	<method name="fileRemove">
10178	<desc>
10179	Removes a single file on the guest.
10180
10181	<result name="VBOX_E_OBJECT_NOT_FOUND">
10182	File to remove was not found.
10183	</result>
10184	<result name="VBOX_E_IPRT_ERROR">
10185	Error while removing the file.
10186	</result>
10187	</desc>
10188	<param name="path" type="wstring" dir="in">
10189	<desc>Path to the file to remove.</desc>
10190	</param>
10191	</method>
10192
10193	<method name="fileOpen">
10194	<desc>
10195	Opens a file and creates a <link to="IGuestFile"/> object that
10196	can be used for further operations.
10197
10198	<result name="VBOX_E_OBJECT_NOT_FOUND">
10199	File to open was not found.
10200	</result>
10201	<result name="VBOX_E_IPRT_ERROR">
10202	Error while opening the file.
10203	</result>
10204	</desc>
10205	<param name="path" type="wstring" dir="in">
10206	<desc>Full path to file to open.</desc>
10207	</param>
10208	<param name="openMode" type="wstring" dir="in">
10209	<desc>The file open mode.</desc>
10210	</param>
10211	<param name="disposition" type="wstring" dir="in">
10212	<desc>The file disposition.</desc>
10213	</param>
10214	<param name="creationMode" type="unsigned long" dir="in">
10215	<desc>The file creation mode.</desc>
10216	</param>
10217	<param name="offset" type="long long" dir="in">
10218	<desc>The initial read/write offset.</desc>
10219	</param>
10220	<param name="file" type="IGuestFile" dir="return">
10221	<desc><link to="IGuestFile"/> object representing the opened file.</desc>
10222	</param>
10223	</method>
10224
10225	<method name="fileQueryInfo">
10226	<desc>
10227	Queries information of a file on the guest.
10228
10229	<result name="VBOX_E_OBJECT_NOT_FOUND">
10230	File to query information for was not found.
10231	</result>
10232	<result name="VBOX_E_IPRT_ERROR">
10233	Error querying information.
10234	</result>
10235	</desc>
10236	<param name="path" type="wstring" dir="in">
10237	<desc>File to query information for.</desc>
10238	</param>
10239	<param name="info" type="IGuestFsObjInfo" dir="return">
10240	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
10241	</param>
10242	</method>
10243
10244	<method name="fileQuerySize">
10245	<desc>
10246	Queries the size of a file on the guest.
10247
10248	<result name="VBOX_E_OBJECT_NOT_FOUND">
10249	File to rename was not found.
10250	</result>
10251	<result name="VBOX_E_IPRT_ERROR">
10252	Error querying file size.
10253	</result>
10254	</desc>
10255	<param name="path" type="wstring" dir="in">
10256	<desc>File to query the size for.</desc>
10257	</param>
10258	<param name="size" type="long long" dir="return">
10259	<desc>Queried file size.</desc>
10260	</param>
10261	</method>
10262
10263	<method name="fileRename">
10264	<desc>
10265	Renames a file on the guest.
10266
10267	<result name="E_NOTIMPL">
10268	The method is not implemented yet.
10269	</result>
10270	</desc>
10271	<param name="source" type="wstring" dir="in">
10272	<desc>Source file to rename.</desc>
10273	</param>
10274	<param name="dest" type="wstring" dir="in">
10275	<desc>Destination file to rename the source to.</desc>
10276	</param>
10277	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
10278	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
10279	</param>
10280	</method>
10281
10282	<method name="fileSetACL">
10283	<desc>
10284	Sets the ACL (Access Control List) of a file on the guest.
10285
10286	<result name="E_NOTIMPL">
10287	The method is not implemented yet.
10288	</result>
10289	</desc>
10290	<param name="file" type="wstring" dir="in">
10291	<desc>Full path of file to set the ACL for.</desc>
10292	</param>
10293	<param name="acl" type="wstring" dir="in">
10294	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
10295	</param>
10296	</method>
10297
10298	<method name="processCreate">
10299	<desc>
10300	Creates a new process running on the guest. The new process will be
10301	started asynchronously, meaning on return of this function it is not
10302	guaranteed that the guest process is in a started state. To wait for
10303	successful startup, use the <link to="IProcess::waitFor"/> call.
10304
10305	<note>
10306	Starting at VirtualBox 4.2 guest process execution by default is limited
10307	to serve up to 255 guest processes at a time. If all 255 guest processes
10308	are still active and running, creating a new guest process will result in an
10309	appropriate error message.
10310
10311	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
10312	is / are set, the guest process will not exit until all data from the specified
10313	stream(s) is / are read out.
10314
10315	To raise or lower the guest process execution limit, either the guest property
10316	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
10317	command line by specifying "--control-procs-max-kept" needs to be modified.
10318	A restart of the guest OS is required afterwards. To serve unlimited guest
10319	processes, a value of "0" needs to be set (not recommended).
10320	</note>
10321
10322	<result name="VBOX_E_IPRT_ERROR">
10323	Error creating guest process.
10324	</result>
10325	</desc>
10326	<param name="command" type="wstring" dir="in">
10327	<desc>
10328	Full path name of the command to execute on the guest; the
10329	commands has to exists in the guest VM in order to be executed.
10330	</desc>
10331	</param>
10332	<param name="arguments" type="wstring" dir="in" safearray="yes">
10333	<desc>Array of arguments passed to the execution command.</desc>
10334	</param>
10335	<param name="environment" type="wstring" dir="in" safearray="yes">
10336	<desc>
10337	<para>Environment variables that can be set while the command is being
10338	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10339	variable just set its name ("NAME") without a value.</para>
10340	<para>This parameter can be used to override environment variables set by
10341	the guest session, which will be applied to the newly started process
10342	in any case.</para>
10343	</desc>
10344	</param>
10345	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10346	<desc>
10347	Process creation flags;
10348	see <link to="ProcessCreateFlag"/> for more information.
10349	</desc>
10350	</param>
10351	<param name="timeoutMS" type="unsigned long" dir="in">
10352	<desc>
10353	Timeout (in ms) for limiting the guest process' running time.
10354	Pass 0 for an infinite timeout. On timeout the guest process will be
10355	killed and its status will be put to an appropriate value. See
10356	<link to="ProcessStatus"/> for more information.
10357	</desc>
10358	</param>
10359	<param name="guestProcess" type="IGuestProcess" dir="return">
10360	<desc>Guest process object of the newly created process.</desc>
10361	</param>
10362	</method>
10363
10364	<method name="processCreateEx">
10365	<desc>
10366	<para>Creates a new process running on the guest. Extended version for
10367	also setting the process priority and affinity.</para>
10368
10369	<para>See <link to="IGuestSession::processCreate"/> for more
10370	information.</para>
10371	</desc>
10372	<param name="command" type="wstring" dir="in">
10373	<desc>
10374	Full path name of the command to execute on the guest; the
10375	commands has to exists in the guest VM in order to be executed.
10376	</desc>
10377	</param>
10378	<param name="arguments" type="wstring" dir="in" safearray="yes">
10379	<desc>Array of arguments passed to the execution command.</desc>
10380	</param>
10381	<param name="environment" type="wstring" dir="in" safearray="yes">
10382	<desc>
10383	<para>Environment variables that can be set while the command is being
10384	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10385	variable just set its name ("NAME") without a value.</para>
10386	<para>This parameter can be used to override environment variables set by
10387	the guest session, which will be applied to the newly started process
10388	in any case.</para>
10389	</desc>
10390	</param>
10391	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10392	<desc>
10393	Process creation flags;
10394	see <link to="ProcessCreateFlag"/> for more information.
10395	</desc>
10396	</param>
10397	<param name="timeoutMS" type="unsigned long" dir="in">
10398	<desc>
10399	Timeout (in ms) for limiting the guest process' running time.
10400	Pass 0 for an infinite timeout. On timeout the guest process will be
10401	killed and its status will be put to an appropriate value. See
10402	<link to="ProcessStatus"/> for more information.
10403	</desc>
10404	</param>
10405	<param name="priority" type="ProcessPriority" dir="in">
10406	<desc>
10407	Process priority to use for execution;
10408	see see <link to="ProcessPriority"/> for more information.</desc>
10409	</param>
10410	<param name="affinity" type="long" dir="in" safearray="yes">
10411	<desc>
10412	Process affinity to use for execution. This parameter
10413	is not implemented yet.
10414	</desc>
10415	</param>
10416	<param name="guestProcess" type="IGuestProcess" dir="return">
10417	<desc>Guest process object of the newly created process.</desc>
10418	</param>
10419	</method>
10420
10421	<method name="processGet">
10422	<desc>
10423	Gets a certain guest process by its process ID (PID).
10424	</desc>
10425	<param name="pid" type="unsigned long" dir="in">
10426	<desc>Process ID (PID) to get guest process for.</desc>
10427	</param>
10428	<param name="guestProcess" type="IGuestProcess" dir="return">
10429	<desc>Guest process of specified process ID (PID).</desc>
10430	</param>
10431	</method>
10432
10433	<method name="symlinkCreate">
10434	<desc>
10435	Creates a symbolic link on the guest.
10436
10437	<result name="E_NOTIMPL">
10438	The method is not implemented yet.
10439	</result>
10440	</desc>
10441	<param name="source" type="wstring" dir="in">
10442	<desc>The name of the symbolic link.</desc>
10443	</param>
10444	<param name="target" type="wstring" dir="in">
10445	<desc>The path to the symbolic link target.</desc>
10446	</param>
10447	<param name="type" type="SymlinkType" dir="in">
10448	<desc>
10449	The symbolic link type;
10450	see <link to="SymlinkReadFlag"/> for more information.
10451	</desc>
10452	</param>
10453	</method>
10454
10455	<method name="symlinkExists">
10456	<desc>
10457	Checks whether a symbolic link exists on the guest or not.
10458
10459	<result name="E_NOTIMPL">
10460	The method is not implemented yet.
10461	</result>
10462	</desc>
10463	<param name="symlink" type="wstring" dir="in">
10464	<desc>Symbolic link to check existence for.</desc>
10465	</param>
10466	<param name="exists" type="boolean" dir="return">
10467	<desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10468	</param>
10469	</method>
10470
10471	<method name="symlinkRead">
10472	<desc>
10473	Reads a symbolic link on the guest.
10474
10475	<result name="E_NOTIMPL">
10476	The method is not implemented yet.
10477	</result>
10478	</desc>
10479	<param name="symlink" type="wstring" dir="in">
10480	<desc>Full path to symbolic link to read.</desc>
10481	</param>
10482	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10483	<desc>
10484	Read flags; see <link to="SymlinkReadFlag"/> for more information.
10485	</desc>
10486	</param>
10487	<param name="target" type="wstring" dir="return">
10488	<desc>
10489	Target of the symbolic link pointing to, if found.
10490	</desc>
10491	</param>
10492	</method>
10493
10494	<method name="symlinkRemoveDirectory">
10495	<desc>
10496	Removes a symbolic link on the guest if it's a directory.
10497
10498	<result name="E_NOTIMPL">
10499	The method is not implemented yet.
10500	</result>
10501	</desc>
10502	<param name="path" type="wstring" dir="in">
10503	<desc>Symbolic link to remove.</desc>
10504	</param>
10505	</method>
10506
10507	<method name="symlinkRemoveFile">
10508	<desc>
10509	Removes a symbolic link on the guest if it's a file.
10510
10511	<result name="E_NOTIMPL">
10512	The method is not implemented yet.
10513	</result>
10514	</desc>
10515	<param name="file" type="wstring" dir="in">
10516	<desc>Symbolic link to remove.</desc>
10517	</param>
10518	</method>
10519
10520	<method name="waitFor">
10521	<desc>
10522	Waits for one more events to happen.
10523	</desc>
10524	<param name="waitFor" type="unsigned long" dir="in">
10525	<desc>
10526	Specifies what to wait for;
10527	see <link to="GuestSessionWaitForFlag"/> for more information.
10528	</desc>
10529	</param>
10530	<param name="timeoutMS" type="unsigned long" dir="in">
10531	<desc>
10532	Timeout (in ms) to wait for the operation to complete.
10533	Pass 0 for an infinite timeout.
10534	</desc>
10535	</param>
10536	<param name="reason" type="GuestSessionWaitResult" dir="return">
10537	<desc>
10538	The overall wait result;
10539	see <link to="GuestSessionWaitResult"/> for more information.
10540	</desc>
10541	</param>
10542	</method>
10543
10544	<method name="waitForArray">
10545	<desc>
10546	Waits for one more events to happen.
10547	Scriptable version of <link to="#waitFor" />.
10548	</desc>
10549	<param name="waitFor" type="GuestSessionWaitForFlag" dir="in" safearray="yes">
10550	<desc>
10551	Specifies what to wait for;
10552	see <link to="GuestSessionWaitForFlag"/> for more information.
10553	</desc>
10554	</param>
10555	<param name="timeoutMS" type="unsigned long" dir="in">
10556	<desc>
10557	Timeout (in ms) to wait for the operation to complete.
10558	Pass 0 for an infinite timeout.
10559	</desc>
10560	</param>
10561	<param name="reason" type="GuestSessionWaitResult" dir="return">
10562	<desc>
10563	The overall wait result;
10564	see <link to="GuestSessionWaitResult"/> for more information.
10565	</desc>
10566	</param>
10567	</method>
10568
10569	</interface>
10570
10571	<interface
10572	name="IProcess" extends="$unknown"
10573	uuid="5a4fe06d-8cb1-40ff-ac9e-9676e32f706e"
10574	wsmap="managed"
10575	>
10576	<desc>
10577	Abstract parent interface for processes handled by VirtualBox.
10578	</desc>
10579
10580	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10581	<desc>
10582	The arguments this process is using for execution.
10583	</desc>
10584	</attribute>
10585	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10586	<desc>
10587	The environment block this process is using during execution.
10588	</desc>
10589	</attribute>
10590	<attribute name="eventSource" type="IEventSource" readonly="yes">
10591	<desc>
10592	Event source for VirtualBox events.
10593	</desc>
10594	</attribute>
10595	<attribute name="executablePath" type="wstring" readonly="yes">
10596	<desc>Full path of the actual executable image.</desc>
10597	</attribute>
10598	<attribute name="exitCode" type="long" readonly="yes">
10599	<desc>
10600	The exit code. Only available when the process has been
10601	terminated normally.
10602	</desc>
10603	</attribute>
10604	<attribute name="name" type="wstring" readonly="yes">
10605	<desc>
10606	The friendly name of this process.
10607	</desc>
10608	</attribute>
10609	<attribute name="PID" type="unsigned long" readonly="yes">
10610	<desc>
10611	The process ID (PID).
10612	</desc>
10613	</attribute>
10614	<attribute name="status" type="ProcessStatus" readonly="yes">
10615	<desc>
10616	The current process status; see <link to="ProcessStatus"/>
10617	for more information.
10618	</desc>
10619	</attribute>
10620
10621	<method name="waitFor">
10622	<desc>
10623	Waits for one more events to happen.
10624	</desc>
10625	<param name="waitFor" type="unsigned long" dir="in">
10626	<desc>
10627	Specifies what to wait for;
10628	see <link to="ProcessWaitForFlag"/> for more information.
10629	</desc>
10630	</param>
10631	<param name="timeoutMS" type="unsigned long" dir="in">
10632	<desc>
10633	Timeout (in ms) to wait for the operation to complete.
10634	Pass 0 for an infinite timeout.
10635	</desc>
10636	</param>
10637	<param name="reason" type="ProcessWaitResult" dir="return">
10638	<desc>
10639	The overall wait result;
10640	see <link to="ProcessWaitResult"/> for more information.
10641	</desc>
10642	</param>
10643	</method>
10644
10645	<method name="waitForArray">
10646	<desc>
10647	Waits for one more events to happen.
10648	Scriptable version of <link to="#waitFor" />.
10649	</desc>
10650	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10651	<desc>
10652	Specifies what to wait for;
10653	see <link to="ProcessWaitForFlag"/> for more information.
10654	</desc>
10655	</param>
10656	<param name="timeoutMS" type="unsigned long" dir="in">
10657	<desc>
10658	Timeout (in ms) to wait for the operation to complete.
10659	Pass 0 for an infinite timeout.
10660	</desc>
10661	</param>
10662	<param name="reason" type="ProcessWaitResult" dir="return">
10663	<desc>
10664	The overall wait result;
10665	see <link to="ProcessWaitResult"/> for more information.
10666	</desc>
10667	</param>
10668	</method>
10669
10670	<method name="read">
10671	<desc>
10672	Reads data from a running process.
10673	</desc>
10674	<param name="handle" type="unsigned long" dir="in">
10675	<desc>Handle to read from. Usually 0 is stdin.</desc>
10676	</param>
10677	<param name="toRead" type="unsigned long" dir="in">
10678	<desc>Number of bytes to read.</desc>
10679	</param>
10680	<param name="timeoutMS" type="unsigned long" dir="in">
10681	<desc>
10682	Timeout (in ms) to wait for the operation to complete.
10683	Pass 0 for an infinite timeout.
10684	</desc>
10685	</param>
10686	<param name="data" type="octet" dir="return" safearray="yes">
10687	<desc>Array of data read.</desc>
10688	</param>
10689	</method>
10690
10691	<method name="write">
10692	<desc>
10693	Writes data to a running process.
10694	</desc>
10695	<param name="handle" type="unsigned long" dir="in">
10696	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10697	</param>
10698	<param name="flags" type="unsigned long" dir="in">
10699	<desc>
10700	A combination of <link to="ProcessInputFlag"/> flags.
10701	</desc>
10702	</param>
10703	<param name="data" type="octet" dir="in" safearray="yes">
10704	<desc>
10705	Array of bytes to write. The size of the array also specifies
10706	how much to write.
10707	</desc>
10708	</param>
10709	<param name="timeoutMS" type="unsigned long" dir="in">
10710	<desc>
10711	Timeout (in ms) to wait for the operation to complete.
10712	Pass 0 for an infinite timeout.
10713	</desc>
10714	</param>
10715	<param name="written" type="unsigned long" dir="return">
10716	<desc>How much bytes were written.</desc>
10717	</param>
10718	</method>
10719
10720	<method name="writeArray">
10721	<desc>
10722	Writes data to a running process.
10723	Scriptable version of <link to="#write" />.
10724	</desc>
10725	<param name="handle" type="unsigned long" dir="in">
10726	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10727	</param>
10728	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10729	<desc>
10730	A combination of <link to="ProcessInputFlag"/> flags.
10731	</desc>
10732	</param>
10733	<param name="data" type="octet" dir="in" safearray="yes">
10734	<desc>
10735	Array of bytes to write. The size of the array also specifies
10736	how much to write.
10737	</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="written" type="unsigned long" dir="return">
10746	<desc>How much bytes were written.</desc>
10747	</param>
10748	</method>
10749
10750	<method name="terminate">
10751	<desc>
10752	Terminates (kills) a running process.
10753	</desc>
10754	</method>
10755	</interface>
10756
10757	<interface
10758	name="IGuestProcess" extends="IProcess"
10759	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10760	wsmap="managed"
10761	>
10762	<desc>
10763	Implementation of the <link to="IProcess" /> object
10764	for processes on the guest.
10765	</desc>
10766	</interface>
10767
10768	<interface
10769	name="IDirectory" extends="$unknown"
10770	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10771	wsmap="managed"
10772	>
10773	<desc>
10774	Abstract parent interface for directories handled by VirtualBox.
10775	</desc>
10776
10777	<attribute name="directoryName" type="wstring" readonly="yes">
10778	<desc>
10779	Full path of directory.
10780	</desc>
10781	</attribute>
10782
10783	<attribute name="filter" type="wstring" readonly="yes">
10784	<desc>
10785	The open filter.
10786	</desc>
10787	</attribute>
10788
10789	<method name="close">
10790	<desc>
10791	Closes this directory. After closing operations like reading the next
10792	directory entry will not be possible anymore.
10793	</desc>
10794	</method>
10795
10796	<method name="read">
10797	<desc>
10798	Reads the next directory entry of this directory.
10799	<result name="VBOX_E_OBJECT_NOT_FOUND">
10800	No more directory entries to read.
10801	</result>
10802	</desc>
10803	<param name="objInfo" type="IFsObjInfo" dir="return">
10804	<desc>Object information of the current directory entry read. Also see
10805	<link to="IFsObjInfo"/>.</desc>
10806	</param>
10807	</method>
10808	</interface>
10809
10810	<interface
10811	name="IGuestDirectory" extends="IDirectory"
10812	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10813	wsmap="managed"
10814	>
10815	<desc>
10816	Implementation of the <link to="IDirectory" /> object
10817	for directories on the guest.
10818	</desc>
10819	</interface>
10820
10821	<interface
10822	name="IFile" extends="$unknown"
10823	uuid="ceb895d7-8b2d-4a39-8f7c-7d2270f341d5"
10824	wsmap="managed"
10825	>
10826	<desc>
10827	Abstract parent interface for files handled by VirtualBox.
10828	</desc>
10829	<attribute name="creationMode" type="unsigned long" readonly="yes">
10830	<desc>
10831	The creation mode.
10832	</desc>
10833	</attribute>
10834	<attribute name="disposition" type="unsigned long" readonly="yes">
10835	<desc>
10836	The disposition mode.
10837	</desc>
10838	</attribute>
10839	<attribute name="eventSource" type="IEventSource" readonly="yes">
10840	<desc>
10841	Event source for guest session events.
10842	</desc>
10843	</attribute>
10844	<attribute name="fileName" type="wstring" readonly="yes">
10845	<desc>
10846	Full path of the actual file name of this file.
10847	</desc>
10848	</attribute>
10849	<attribute name="initialSize" type="long long" readonly="yes">
10850	<desc>
10851	The initial size in bytes when opened.
10852	</desc>
10853	</attribute>
10854	<attribute name="openMode" type="unsigned long" readonly="yes">
10855	<desc>
10856	The open mode.
10857	</desc>
10858	</attribute>
10859	<attribute name="offset" type="long long" readonly="yes">
10860	<desc>
10861	Current read/write offset in bytes.
10862	</desc>
10863	</attribute>
10864	<attribute name="status" type="FileStatus" readonly="yes">
10865	<desc>
10866	Current file status.
10867	</desc>
10868	</attribute>
10869
10870	<method name="close">
10871	<desc>
10872	Closes this file. After closing operations like reading data,
10873	writing data or querying information will not be possible anymore.
10874	</desc>
10875	</method>
10876
10877	<method name="queryInfo">
10878	<desc>
10879	Queries information about this file.
10880
10881	<result name="E_NOTIMPL">
10882	The method is not implemented yet.
10883	</result>
10884	</desc>
10885	<param name="objInfo" type="IFsObjInfo" dir="return">
10886	<desc>Object information of this file. Also see
10887	<link to="IFsObjInfo"/>.</desc>
10888	</param>
10889	</method>
10890
10891	<method name="read">
10892	<desc>
10893	Reads data from this file.
10894
10895	<result name="E_NOTIMPL">
10896	The method is not implemented yet.
10897	</result>
10898	</desc>
10899	<param name="toRead" type="unsigned long" dir="in">
10900	<desc>Number of bytes to read.</desc>
10901	</param>
10902	<param name="timeoutMS" type="unsigned long" dir="in">
10903	<desc>
10904	Timeout (in ms) to wait for the operation to complete.
10905	Pass 0 for an infinite timeout.
10906	</desc>
10907	</param>
10908	<param name="data" type="octet" dir="return" safearray="yes">
10909	<desc>Array of data read.</desc>
10910	</param>
10911	</method>
10912
10913	<method name="readAt">
10914	<desc>
10915	Reads data from an offset of this file.
10916
10917	<result name="E_NOTIMPL">
10918	The method is not implemented yet.
10919	</result>
10920	</desc>
10921	<param name="offset" type="long long" dir="in">
10922	<desc>Offset in bytes to start reading.</desc>
10923	</param>
10924	<param name="toRead" type="unsigned long" dir="in">
10925	<desc>Number of bytes to read.</desc>
10926	</param>
10927	<param name="timeoutMS" type="unsigned long" dir="in">
10928	<desc>
10929	Timeout (in ms) to wait for the operation to complete.
10930	Pass 0 for an infinite timeout.
10931	</desc>
10932	</param>
10933	<param name="data" type="octet" dir="return" safearray="yes">
10934	<desc>Array of data read.</desc>
10935	</param>
10936	</method>
10937
10938	<method name="seek">
10939	<desc>
10940	Changes the read and write position of this file.
10941
10942	<result name="E_NOTIMPL">
10943	The method is not implemented yet.
10944	</result>
10945	</desc>
10946	<param name="offset" type="long long" dir="in">
10947	<desc>Offset to seek.</desc>
10948	</param>
10949	<param name="whence" type="FileSeekType" dir="in">
10950	<desc>
10951	Seek mode; see <link to="FileSeekType"/> for more information.
10952	</desc>
10953	</param>
10954	</method>
10955
10956	<method name="setACL">
10957	<desc>
10958	Sets the ACL of this file.
10959
10960	<result name="E_NOTIMPL">
10961	The method is not implemented yet.
10962	</result>
10963	</desc>
10964	<param name="acl" type="wstring" dir="in">
10965	<desc>ACL string to set.</desc>
10966	</param>
10967	</method>
10968
10969	<method name="write">
10970	<desc>
10971	Writes bytes to this file.
10972	</desc>
10973	<param name="data" type="octet" dir="in" safearray="yes">
10974	<desc>
10975	Array of bytes to write. The size of the array also specifies
10976	how much to write.
10977	</desc>
10978	</param>
10979	<param name="timeoutMS" type="unsigned long" dir="in">
10980	<desc>
10981	Timeout (in ms) to wait for the operation to complete.
10982	Pass 0 for an infinite timeout.
10983	</desc>
10984	</param>
10985	<param name="written" type="unsigned long" dir="return">
10986	<desc>How much bytes were written.</desc>
10987	</param>
10988	</method>
10989
10990	<method name="writeAt">
10991	<desc>
10992	Writes bytes at a certain offset to this file.
10993
10994	<result name="E_NOTIMPL">
10995	The method is not implemented yet.
10996	</result>
10997	</desc>
10998	<param name="offset" type="long long" dir="in">
10999	<desc>Offset in bytes to start writing.</desc>
11000	</param>
11001	<param name="data" type="octet" dir="in" safearray="yes">
11002	<desc>
11003	Array of bytes to write. The size of the array also specifies
11004	how much to write.
11005	</desc>
11006	</param>
11007	<param name="timeoutMS" type="unsigned long" dir="in">
11008	<desc>
11009	Timeout (in ms) to wait for the operation to complete.
11010	Pass 0 for an infinite timeout.
11011	</desc>
11012	</param>
11013	<param name="written" type="unsigned long" dir="return">
11014	<desc>How much bytes were written.</desc>
11015	</param>
11016	</method>
11017
11018	</interface>
11019
11020	<interface
11021	name="IGuestFile" extends="IFile"
11022	uuid="60661aec-145f-4d11-b80e-8ea151598093"
11023	wsmap="managed"
11024	>
11025	<desc>
11026	Implementation of the <link to="IFile" /> object
11027	for files on the guest.
11028	</desc>
11029	</interface>
11030
11031	<interface
11032	name="IFsObjInfo" extends="$unknown"
11033	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
11034	wsmap="managed"
11035	>
11036	<desc>
11037	Abstract parent interface for VirtualBox file system object information.
11038	This can be information about a file or a directory, for example.
11039	</desc>
11040
11041	<attribute name="accessTime" type="long long" readonly="yes">
11042	<desc>
11043	Time of last access (st_atime).
11044	</desc>
11045	</attribute>
11046	<attribute name="allocatedSize" type="long long" readonly="yes">
11047	<desc>
11048	Disk allocation size (st_blocks * DEV_BSIZE).
11049	</desc>
11050	</attribute>
11051	<attribute name="birthTime" type="long long" readonly="yes">
11052	<desc>
11053	Time of file birth (st_birthtime).
11054	</desc>
11055	</attribute>
11056	<attribute name="changeTime" type="long long" readonly="yes">
11057	<desc>
11058	Time of last status change (st_ctime).
11059	</desc>
11060	</attribute>
11061	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
11062	<desc>
11063	The device number of a character or block device type object (st_rdev).
11064	</desc>
11065	</attribute>
11066	<attribute name="fileAttributes" type="wstring" readonly="yes">
11067	<desc>
11068	File attributes. Not implemented yet.
11069	</desc>
11070	</attribute>
11071	<attribute name="generationId" type="unsigned long" readonly="yes">
11072	<desc>
11073	The current generation number (st_gen).
11074	</desc>
11075	</attribute>
11076	<attribute name="GID" type="unsigned long" readonly="yes">
11077	<desc>
11078	The group the filesystem object is assigned (st_gid).
11079	</desc>
11080	</attribute>
11081	<attribute name="groupName" type="wstring" readonly="yes">
11082	<desc>
11083	The group name.
11084	</desc>
11085	</attribute>
11086	<attribute name="hardLinks" type="unsigned long" readonly="yes">
11087	<desc>
11088	Number of hard links to this filesystem object (st_nlink).
11089	</desc>
11090	</attribute>
11091	<attribute name="modificationTime" type="long long" readonly="yes">
11092	<desc>
11093	Time of last data modification (st_mtime).
11094	</desc>
11095	</attribute>
11096	<attribute name="name" type="wstring" readonly="yes">
11097	<desc>
11098	The object's name.
11099	</desc>
11100	</attribute>
11101	<attribute name="nodeId" type="long long" readonly="yes">
11102	<desc>
11103	The unique identifier (within the filesystem) of this filesystem object (st_ino).
11104	</desc>
11105	</attribute>
11106	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
11107	<desc>
11108	The device number of the device which this filesystem object resides on (st_dev).
11109	</desc>
11110	</attribute>
11111	<attribute name="objectSize" type="long long" readonly="yes">
11112	<desc>
11113	The logical size (st_size). For normal files this is the size of the file.
11114	For symbolic links, this is the length of the path name contained in the
11115	symbolic link. For other objects this fields needs to be specified.
11116	</desc>
11117	</attribute>
11118	<attribute name="type" type="FsObjType" readonly="yes">
11119	<desc>
11120	The object type. See <link to="FsObjType" /> for more.
11121	</desc>
11122	</attribute>
11123	<attribute name="UID" type="unsigned long" readonly="yes">
11124	<desc>
11125	The user owning the filesystem object (st_uid).
11126	</desc>
11127	</attribute>
11128	<attribute name="userFlags" type="unsigned long" readonly="yes">
11129	<desc>
11130	User flags (st_flags).
11131	</desc>
11132	</attribute>
11133	<attribute name="userName" type="wstring" readonly="yes">
11134	<desc>
11135	The user name.
11136	</desc>
11137	</attribute>
11138
11139	</interface>
11140
11141	<interface
11142	name="IGuestFsObjInfo" extends="IFsObjInfo"
11143	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
11144	wsmap="managed"
11145	>
11146	<desc>
11147	Represents the guest implementation of the
11148	<link to="IFsObjInfo" /> object.
11149	</desc>
11150	</interface>
11151
11152	<interface
11153	name="IGuest" extends="$unknown"
11154	uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
11155	wsmap="managed"
11156	>
11157	<desc>
11158	The IGuest interface represents information about the operating system
11159	running inside the virtual machine. Used in
11160	<link to="IConsole::guest"/>.
11161
11162	IGuest provides information about the guest operating system, whether
11163	Guest Additions are installed and other OS-specific virtual machine
11164	properties.
11165	</desc>
11166
11167	<attribute name="OSTypeId" type="wstring" readonly="yes">
11168	<desc>
11169	Identifier of the Guest OS type as reported by the Guest
11170	Additions.
11171	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
11172	an IGuestOSType object representing details about the given
11173	Guest OS type.
11174	<note>
11175	If Guest Additions are not installed, this value will be
11176	the same as <link to="IMachine::OSTypeId"/>.
11177	</note>
11178	</desc>
11179	</attribute>
11180
11181	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
11182	<desc>
11183	Current run level of the Guest Additions.
11184	</desc>
11185	</attribute>
11186
11187	<attribute name="additionsVersion" type="wstring" readonly="yes">
11188	<desc>
11189	Version of the Guest Additions in the same format as
11190	<link to="IVirtualBox::version"/>.
11191	</desc>
11192	</attribute>
11193
11194	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
11195	<desc>
11196	The internal build revision number of the additions.
11197
11198	See also <link to="IVirtualBox::revision"/>.
11199	</desc>
11200	</attribute>
11201
11202	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
11203	<desc>
11204	Array of current known facilities. Only returns facilities where a status is known,
11205	e.g. facilities with an unknown status will not be returned.
11206	</desc>
11207	</attribute>
11208
11209	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
11210	<desc>Returns a collection of all opened guest sessions.</desc>
11211	</attribute>
11212
11213	<attribute name="memoryBalloonSize" type="unsigned long">
11214	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
11215	</attribute>
11216
11217	<attribute name="statisticsUpdateInterval" type="unsigned long">
11218	<desc>Interval to update guest statistics in seconds.</desc>
11219	</attribute>
11220
11221	<method name="internalGetStatistics">
11222	<desc>
11223	Internal method; do not use as it might change at any time.
11224	</desc>
11225	<param name="cpuUser" type="unsigned long" dir="out">
11226	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
11227	</param>
11228	<param name="cpuKernel" type="unsigned long" dir="out">
11229	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
11230	</param>
11231	<param name="cpuIdle" type="unsigned long" dir="out">
11232	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
11233	</param>
11234	<param name="memTotal" type="unsigned long" dir="out">
11235	<desc>Total amount of physical guest RAM.</desc>
11236	</param>
11237	<param name="memFree" type="unsigned long" dir="out">
11238	<desc>Free amount of physical guest RAM.</desc>
11239	</param>
11240	<param name="memBalloon" type="unsigned long" dir="out">
11241	<desc>Amount of ballooned physical guest RAM.</desc>
11242	</param>
11243	<param name="memShared" type="unsigned long" dir="out">
11244	<desc>Amount of shared physical guest RAM.</desc>
11245	</param>
11246	<param name="memCache" type="unsigned long" dir="out">
11247	<desc>Total amount of guest (disk) cache memory.</desc>
11248	</param>
11249	<param name="pagedTotal" type="unsigned long" dir="out">
11250	<desc>Total amount of space in the page file.</desc>
11251	</param>
11252	<param name="memAllocTotal" type="unsigned long" dir="out">
11253	<desc>Total amount of memory allocated by the hypervisor.</desc>
11254	</param>
11255	<param name="memFreeTotal" type="unsigned long" dir="out">
11256	<desc>Total amount of free memory available in the hypervisor.</desc>
11257	</param>
11258	<param name="memBalloonTotal" type="unsigned long" dir="out">
11259	<desc>Total amount of memory ballooned by the hypervisor.</desc>
11260	</param>
11261	<param name="memSharedTotal" type="unsigned long" dir="out">
11262	<desc>Total amount of shared memory in the hypervisor.</desc>
11263	</param>
11264	</method>
11265
11266	<method name="getFacilityStatus">
11267	<desc>
11268	Get the current status of a Guest Additions facility.
11269	</desc>
11270	<param name="facility" type="AdditionsFacilityType" dir="in">
11271	<desc>Facility to check status for.</desc>
11272	</param>
11273	<param name="timestamp" type="long long" dir="out">
11274	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
11275	</param>
11276	<param name="status" type="AdditionsFacilityStatus" dir="return">
11277	<desc>The current (latest) facility status.</desc>
11278	</param>
11279	</method>
11280
11281	<method name="getAdditionsStatus">
11282	<desc>
11283	Retrieve the current status of a certain Guest Additions run level.
11284
11285	<result name="VBOX_E_NOT_SUPPORTED">
11286	Wrong status level specified.
11287	</result>
11288
11289	</desc>
11290	<param name="level" type="AdditionsRunLevelType" dir="in">
11291	<desc>Status level to check</desc>
11292	</param>
11293	<param name="active" type="boolean" dir="return">
11294	<desc>Flag whether the status level has been reached or not</desc>
11295	</param>
11296	</method>
11297
11298	<method name="setCredentials">
11299	<desc>
11300	Store login credentials that can be queried by guest operating
11301	systems with Additions installed. The credentials are transient
11302	to the session and the guest may also choose to erase them. Note
11303	that the caller cannot determine whether the guest operating system
11304	has queried or made use of the credentials.
11305
11306	<result name="VBOX_E_VM_ERROR">
11307	VMM device is not available.
11308	</result>
11309
11310	</desc>
11311	<param name="userName" type="wstring" dir="in">
11312	<desc>User name string, can be empty</desc>
11313	</param>
11314	<param name="password" type="wstring" dir="in">
11315	<desc>Password string, can be empty</desc>
11316	</param>
11317	<param name="domain" type="wstring" dir="in">
11318	<desc>Domain name (guest logon scheme specific), can be empty</desc>
11319	</param>
11320	<param name="allowInteractiveLogon" type="boolean" dir="in">
11321	<desc>
11322	Flag whether the guest should alternatively allow the user to
11323	interactively specify different credentials. This flag might
11324	not be supported by all versions of the Additions.
11325	</desc>
11326	</param>
11327	</method>
11328
11329	<method name="dragHGEnter">
11330	<desc>
11331	Informs the guest about a Drag and Drop enter event.
11332
11333	This is used in Host - Guest direction.
11334
11335	<result name="VBOX_E_VM_ERROR">
11336	VMM device is not available.
11337	</result>
11338
11339	</desc>
11340	<param name="screenId" type="unsigned long" dir="in">
11341	<desc>The screen id where the Drag and Drop event occured.</desc>
11342	</param>
11343	<param name="y" type="unsigned long" dir="in">
11344	<desc>y-position of the event.</desc>
11345	</param>
11346	<param name="x" type="unsigned long" dir="in">
11347	<desc>x-position of the event.</desc>
11348	</param>
11349	<param name="defaultAction" type="DragAndDropAction" dir="in">
11350	<desc>The default action to use.</desc>
11351	</param>
11352	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11353	<desc>The actions which are allowed.</desc>
11354	</param>
11355	<param name="formats" type="wstring" dir="in" safearray="yes">
11356	<desc>The supported mime types.</desc>
11357	</param>
11358	<param name="resultAction" type="DragAndDropAction" dir="return">
11359	<desc>The resulting action of this event.</desc>
11360	</param>
11361	</method>
11362
11363	<method name="dragHGMove">
11364	<desc>
11365	Informs the guest about a Drag and Drop move event.
11366
11367	This is used in Host - Guest direction.
11368
11369	<result name="VBOX_E_VM_ERROR">
11370	VMM device is not available.
11371	</result>
11372
11373	</desc>
11374	<param name="screenId" type="unsigned long" dir="in">
11375	<desc>The screen id where the Drag and Drop event occured.</desc>
11376	</param>
11377	<param name="x" type="unsigned long" dir="in">
11378	<desc>x-position of the event.</desc>
11379	</param>
11380	<param name="y" type="unsigned long" dir="in">
11381	<desc>y-position of the event.</desc>
11382	</param>
11383	<param name="defaultAction" type="DragAndDropAction" dir="in">
11384	<desc>The default action to use.</desc>
11385	</param>
11386	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11387	<desc>The actions which are allowed.</desc>
11388	</param>
11389	<param name="formats" type="wstring" dir="in" safearray="yes">
11390	<desc>The supported mime types.</desc>
11391	</param>
11392	<param name="resultAction" type="DragAndDropAction" dir="return">
11393	<desc>The resulting action of this event.</desc>
11394	</param>
11395	</method>
11396
11397	<method name="dragHGLeave">
11398	<desc>
11399	Informs the guest about a Drag and Drop leave event.
11400
11401	This is used in Host - Guest direction.
11402
11403	<result name="VBOX_E_VM_ERROR">
11404	VMM device is not available.
11405	</result>
11406
11407	</desc>
11408	<param name="screenId" type="unsigned long" dir="in">
11409	<desc>The screen id where the Drag and Drop event occured.</desc>
11410	</param>
11411	</method>
11412
11413	<method name="dragHGDrop">
11414	<desc>
11415	Informs the guest about a drop event.
11416
11417	This is used in Host - Guest direction.
11418
11419	<result name="VBOX_E_VM_ERROR">
11420	VMM device is not available.
11421	</result>
11422
11423	</desc>
11424	<param name="screenId" type="unsigned long" dir="in">
11425	<desc>The screen id where the Drag and Drop event occured.</desc>
11426	</param>
11427	<param name="x" type="unsigned long" dir="in">
11428	<desc>x-position of the event.</desc>
11429	</param>
11430	<param name="y" type="unsigned long" dir="in">
11431	<desc>y-position of the event.</desc>
11432	</param>
11433	<param name="defaultAction" type="DragAndDropAction" dir="in">
11434	<desc>The default action to use.</desc>
11435	</param>
11436	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
11437	<desc>The actions which are allowed.</desc>
11438	</param>
11439	<param name="formats" type="wstring" dir="in" safearray="yes">
11440	<desc>The supported mime types.</desc>
11441	</param>
11442	<param name="format" type="wstring" dir="out">
11443	<desc>The resulting format of this event.</desc>
11444	</param>
11445	<param name="resultAction" type="DragAndDropAction" dir="return">
11446	<desc>The resulting action of this event.</desc>
11447	</param>
11448	</method>
11449
11450	<method name="dragHGPutData">
11451	<desc>
11452	Informs the guest about a drop data event.
11453
11454	This is used in Host - Guest direction.
11455
11456	<result name="VBOX_E_VM_ERROR">
11457	VMM device is not available.
11458	</result>
11459
11460	</desc>
11461	<param name="screenId" type="unsigned long" dir="in">
11462	<desc>The screen id where the Drag and Drop event occured.</desc>
11463	</param>
11464	<param name="format" type="wstring" dir="in">
11465	<desc>The mime type the data is in.</desc>
11466	</param>
11467	<param name="data" type="octet" dir="in" safearray="yes">
11468	<desc>The actual data.</desc>
11469	</param>
11470	<param name="progress" type="IProgress" dir="return">
11471	<desc>Progress object to track the operation completion.</desc>
11472	</param>
11473	</method>
11474
11475	<method name="dragGHPending">
11476	<desc>
11477	Ask the guest if there is any Drag and Drop operation pending in the guest.
11478
11479	If no Drag and Drop operation is pending currently, Ignore is returned.
11480
11481	This is used in Guest - Host direction.
11482
11483	<result name="VBOX_E_VM_ERROR">
11484	VMM device is not available.
11485	</result>
11486
11487	</desc>
11488	<param name="screenId" type="unsigned long" dir="in">
11489	<desc>The screen id where the Drag and Drop event occured.</desc>
11490	</param>
11491	<param name="formats" type="wstring" dir="out" safearray="yes">
11492	<desc>On return the supported mime types.</desc>
11493	</param>
11494	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11495	<desc>On return the actions which are allowed.</desc>
11496	</param>
11497	<param name="defaultAction" type="DragAndDropAction" dir="return">
11498	<desc>On return the default action to use.</desc>
11499	</param>
11500	</method>
11501
11502	<method name="dragGHDropped">
11503	<desc>
11504	Informs the guest that a drop event occured for a pending Drag and Drop event.
11505
11506	This is used in Guest - Host direction.
11507
11508	<result name="VBOX_E_VM_ERROR">
11509	VMM device is not available.
11510	</result>
11511
11512	</desc>
11513
11514	<param name="format" type="wstring" dir="in">
11515	<desc>The mime type the data must be in.</desc>
11516	</param>
11517	<param name="action" type="DragAndDropAction" dir="in">
11518	<desc>The action to use.</desc>
11519	</param>
11520	<param name="progress" type="IProgress" dir="return">
11521	<desc>Progress object to track the operation completion.</desc>
11522	</param>
11523	</method>
11524
11525	<method name="dragGHGetData">
11526	<desc>
11527	Fetch the data of a previously Drag and Drop event from the guest.
11528
11529	This is used in Guest - Host direction.
11530
11531	<result name="VBOX_E_VM_ERROR">
11532	VMM device is not available.
11533	</result>
11534
11535	</desc>
11536
11537	<param name="data" type="octet" safearray="yes" dir="return">
11538	<desc>The actual data.</desc>
11539	</param>
11540	</method>
11541
11542	<method name="createSession">
11543	<desc>
11544	Creates a new guest session for controlling the guest.
11545
11546	A guest session represents one impersonated user account on the guest, so
11547	every operation will use the same credentials specified when creating
11548	the session object via <link to="IGuest::createSession"/>. Anonymous
11549	sessions, that is, sessions without specifying a valid
11550	user account on the guest are not allowed due to security reasons.
11551
11552	There can be a maximum of 32 sessions at once per VM. Each session keeps
11553	track of its started guest processes, opened guest files or guest directories.
11554	To work on guest files or directories a guest session offers methods to open
11555	or create such objects (see <link to="IGuestSession::fileOpen"/> or
11556	<link to="IGuestSession::directoryOpen"/> for example).
11557
11558	When done with either of these objects, including the guest session itself,
11559	use the appropriate close() method to let the object do its cleanup work.
11560
11561	Every guest session has its own environment variable block which gets
11562	automatically applied when starting a new guest process via
11563	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
11564	To override (or unset) certain environment variables already set by the
11565	guest session, one can specify a per-process environment block when using
11566	one of the both above mentioned process creation calls.
11567
11568	Closing a session via <link to="IGuestSession::close" /> will try to close
11569	all the mentioned objects above unless these objects are still used by
11570	a client.
11571	</desc>
11572	<param name="user" type="wstring" dir="in">
11573	<desc>
11574	User name this session will be using to control the guest; has to exist
11575	and have the appropriate rights to execute programs in the VM. Must not
11576	be empty.
11577	</desc>
11578	</param>
11579	<param name="password" type="wstring" dir="in">
11580	<desc>
11581	Password of the user account to be used. Empty passwords are allowed.
11582	</desc>
11583	</param>
11584	<param name="domain" type="wstring" dir="in">
11585	<desc>
11586	Domain name of the user account to be used if the guest is part of
11587	a domain. Optional. This feature is not implemented yet.
11588	</desc>
11589	</param>
11590	<param name="sessionName" type="wstring" dir="in">
11591	<desc>
11592	The session's friendly name. Optional, can be empty.
11593	</desc>
11594	</param>
11595	<param name="guestSession" type="IGuestSession" dir="return">
11596	<desc>
11597	The newly created session object.
11598	</desc>
11599	</param>
11600	</method>
11601
11602	<method name="findSession">
11603	<desc>
11604	Finds guest sessions by their friendly name and returns an interface
11605	array with all found guest sessions.
11606	</desc>
11607	<param name="sessionName" type="wstring" dir="in">
11608	<desc>
11609	The session's friendly name to find. Wildcards like ? and * are allowed.
11610	</desc>
11611	</param>
11612	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11613	<desc>
11614	Array with all guest sessions found matching the name specified.
11615	</desc>
11616	</param>
11617	</method>
11618
11619	<method name="updateGuestAdditions">
11620	<desc>
11621	Automatically updates already installed Guest Additions in a VM.
11622
11623	At the moment only Windows guests are supported.
11624
11625	Because the VirtualBox Guest Additions drivers are not WHQL-certified
11626	yet there might be warning dialogs during the actual Guest Additions
11627	update. These need to be confirmed manually in order to continue the
11628	installation process. This applies to Windows 2000 and Windows XP guests
11629	and therefore these guests can't be updated in a fully automated fashion
11630	without user interaction. However, to start a Guest Additions update for
11631	the mentioned Windows versions anyway, the flag
11632	AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See
11633	<link to="AdditionsUpdateFlag"/> for more information.
11634
11635	<result name="VBOX_E_NOT_SUPPORTED">
11636	Guest OS is not supported for automated Guest Additions updates or the
11637	already installed Guest Additions are not ready yet.
11638	</result>
11639
11640	<result name="VBOX_E_IPRT_ERROR">
11641	Error while updating.
11642	</result>
11643
11644	</desc>
11645	<param name="source" type="wstring" dir="in">
11646	<desc>
11647	Path to the Guest Additions .ISO file to use for the upate.
11648	</desc>
11649	</param>
11650	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11651	<desc>
11652	<link to="AdditionsUpdateFlag"/> flags.
11653	</desc>
11654	</param>
11655	<param name="progress" type="IProgress" dir="return">
11656	<desc>Progress object to track the operation completion.</desc>
11657	</param>
11658	</method>
11659
11660	</interface>
11661
11662
11663	<!--
11664	// IProgress
11665	/////////////////////////////////////////////////////////////////////////
11666	-->
11667
11668	<interface
11669	name="IProgress" extends="$unknown"
11670	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11671	wsmap="managed"
11672	>
11673	<desc>
11674	The IProgress interface is used to track and control
11675	asynchronous tasks within VirtualBox.
11676
11677	An instance of this is returned every time VirtualBox starts
11678	an asynchronous task (in other words, a separate thread) which
11679	continues to run after a method call returns. For example,
11680	<link to="IConsole::saveState" />, which saves the state of
11681	a running virtual machine, can take a long time to complete.
11682	To be able to display a progress bar, a user interface such as
11683	the VirtualBox graphical user interface can use the IProgress
11684	object returned by that method.
11685
11686	Note that IProgress is a "read-only" interface in the sense
11687	that only the VirtualBox internals behind the Main API can
11688	create and manipulate progress objects, whereas client code
11689	can only use the IProgress object to monitor a task's
11690	progress and, if <link to="#cancelable" /> is @c true,
11691	cancel the task by calling <link to="#cancel" />.
11692
11693	A task represented by IProgress consists of either one or
11694	several sub-operations that run sequentially, one by one (see
11695	<link to="#operation" /> and <link to="#operationCount" />).
11696	Every operation is identified by a number (starting from 0)
11697	and has a separate description.
11698
11699	You can find the individual percentage of completion of the current
11700	operation in <link to="#operationPercent" /> and the
11701	percentage of completion of the task as a whole
11702	in <link to="#percent" />.
11703
11704	Similarly, you can wait for the completion of a particular
11705	operation via <link to="#waitForOperationCompletion" /> or
11706	for the completion of the whole task via
11707	<link to="#waitForCompletion" />.
11708	</desc>
11709
11710	<attribute name="id" type="uuid" mod="string" readonly="yes">
11711	<desc>ID of the task.</desc>
11712	</attribute>
11713
11714	<attribute name="description" type="wstring" readonly="yes">
11715	<desc>Description of the task.</desc>
11716	</attribute>
11717
11718	<attribute name="initiator" type="$unknown" readonly="yes">
11719	<desc>Initiator of the task.</desc>
11720	</attribute>
11721
11722	<attribute name="cancelable" type="boolean" readonly="yes">
11723	<desc>Whether the task can be interrupted.</desc>
11724	</attribute>
11725
11726	<attribute name="percent" type="unsigned long" readonly="yes">
11727	<desc>
11728	Current progress value of the task as a whole, in percent.
11729	This value depends on how many operations are already complete.
11730	Returns 100 if <link to="#completed" /> is @c true.
11731	</desc>
11732	</attribute>
11733
11734	<attribute name="timeRemaining" type="long" readonly="yes">
11735	<desc>
11736	Estimated remaining time until the task completes, in
11737	seconds. Returns 0 once the task has completed; returns -1
11738	if the remaining time cannot be computed, in particular if
11739	the current progress is 0.
11740
11741	Even if a value is returned, the estimate will be unreliable
11742	for low progress values. It will become more reliable as the
11743	task progresses; it is not recommended to display an ETA
11744	before at least 20% of a task have completed.
11745	</desc>
11746	</attribute>
11747
11748	<attribute name="completed" type="boolean" readonly="yes">
11749	<desc>Whether the task has been completed.</desc>
11750	</attribute>
11751
11752	<attribute name="canceled" type="boolean" readonly="yes">
11753	<desc>Whether the task has been canceled.</desc>
11754	</attribute>
11755
11756	<attribute name="resultCode" type="long" readonly="yes">
11757	<desc>
11758	Result code of the progress task.
11759	Valid only if <link to="#completed"/> is @c true.
11760	</desc>
11761	</attribute>
11762
11763	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11764	<desc>
11765	Extended information about the unsuccessful result of the
11766	progress operation. May be @c null if no extended information
11767	is available.
11768	Valid only if <link to="#completed"/> is @c true and
11769	<link to="#resultCode"/> indicates a failure.
11770	</desc>
11771	</attribute>
11772
11773	<attribute name="operationCount" type="unsigned long" readonly="yes">
11774	<desc>
11775	Number of sub-operations this task is divided into.
11776	Every task consists of at least one suboperation.
11777	</desc>
11778	</attribute>
11779
11780	<attribute name="operation" type="unsigned long" readonly="yes">
11781	<desc>Number of the sub-operation being currently executed.</desc>
11782	</attribute>
11783
11784	<attribute name="operationDescription" type="wstring" readonly="yes">
11785	<desc>
11786	Description of the sub-operation being currently executed.
11787	</desc>
11788	</attribute>
11789
11790	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11791	<desc>Progress value of the current sub-operation only, in percent.</desc>
11792	</attribute>
11793
11794	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11795	<desc>Weight value of the current sub-operation only.</desc>
11796	</attribute>
11797
11798	<attribute name="timeout" type="unsigned long">
11799	<desc>
11800	When non-zero, this specifies the number of milliseconds after which
11801	the operation will automatically be canceled. This can only be set on
11802	cancelable objects.
11803	</desc>
11804	</attribute>
11805
11806	<method name="setCurrentOperationProgress">
11807	<desc>Internal method, not to be called externally.</desc>
11808	<param name="percent" type="unsigned long" dir="in" />
11809	</method>
11810	<method name="setNextOperation">
11811	<desc>Internal method, not to be called externally.</desc>
11812	<param name="nextOperationDescription" type="wstring" dir="in" />
11813	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11814	</method>
11815
11816	<method name="waitForCompletion">
11817	<desc>
11818	Waits until the task is done (including all sub-operations)
11819	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11820
11821	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11822	thread are not processed while waiting. Neglecting event queues may
11823	have dire consequences (degrade performance, resource hogs,
11824	deadlocks, etc.), this is specially so for the main thread on
11825	platforms using XPCOM. Callers are adviced wait for short periods
11826	and service their event queues between calls, or to create a worker
11827	thread to do the waiting.
11828
11829	<result name="VBOX_E_IPRT_ERROR">
11830	Failed to wait for task completion.
11831	</result>
11832	</desc>
11833
11834	<param name="timeout" type="long" dir="in">
11835	<desc>
11836	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11837	</desc>
11838	</param>
11839	</method>
11840
11841	<method name="waitForOperationCompletion">
11842	<desc>
11843	Waits until the given operation is done with a given timeout in
11844	milliseconds; specify -1 for an indefinite wait.
11845
11846	See <link to="#waitForCompletion"> for event queue considerations.</link>
11847
11848	<result name="VBOX_E_IPRT_ERROR">
11849	Failed to wait for operation completion.
11850	</result>
11851
11852	</desc>
11853	<param name="operation" type="unsigned long" dir="in">
11854	<desc>
11855	Number of the operation to wait for.
11856	Must be less than <link to="#operationCount"/>.
11857	</desc>
11858	</param>
11859	<param name="timeout" type="long" dir="in">
11860	<desc>
11861	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11862	</desc>
11863	</param>
11864	</method>
11865
11866	<method name="waitForAsyncProgressCompletion">
11867	<desc>
11868	Waits until the other task is completed (including all
11869	sub-operations) and forward all changes from the other progress to
11870	this progress. This means sub-operation number, description, percent
11871	and so on.
11872
11873	You have to take care on setting up at least the same count on
11874	sub-operations in this progress object like there are in the other
11875	progress object.
11876
11877	If the other progress object supports cancel and this object gets any
11878	cancel request (when here enabled as well), it will be forwarded to
11879	the other progress object.
11880
11881	If there is an error in the other progress, this error isn't
11882	automatically transfered to this progress object. So you have to
11883	check any operation error within the other progress object, after
11884	this method returns.
11885	</desc>
11886
11887	<param name="pProgressAsync" type="IProgress" dir="in">
11888	<desc>
11889	The progress object of the asynchrony process.
11890	</desc>
11891	</param>
11892	</method>
11893
11894	<method name="cancel">
11895	<desc>
11896	Cancels the task.
11897	<note>
11898	If <link to="#cancelable"/> is @c false, then this method will fail.
11899	</note>
11900
11901	<result name="VBOX_E_INVALID_OBJECT_STATE">
11902	Operation cannot be canceled.
11903	</result>
11904
11905	</desc>
11906	</method>
11907
11908	</interface>
11909
11910	<!--
11911	// ISnapshot
11912	/////////////////////////////////////////////////////////////////////////
11913	-->
11914
11915	<interface
11916	name="ISnapshot" extends="$unknown"
11917	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11918	wsmap="managed"
11919	>
11920	<desc>
11921	The ISnapshot interface represents a snapshot of the virtual
11922	machine.
11923
11924	Together with the differencing media that are created
11925	when a snapshot is taken, a machine can be brought back to
11926	the exact state it was in when the snapshot was taken.
11927
11928	The ISnapshot interface has no methods, only attributes; snapshots
11929	are controlled through methods of the <link to="IConsole" /> interface
11930	which also manage the media associated with the snapshot.
11931	The following operations exist:
11932
11933	<ul>
11934	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11935	by creating new, empty differencing images for the machine's
11936	media and saving the VM settings and (if the VM is running)
11937	the current VM state in the snapshot.
11938
11939	The differencing images will then receive all data written to
11940	the machine's media, while their parent (base) images
11941	remain unmodified after the snapshot has been taken (see
11942	<link to="IMedium" /> for details about differencing images).
11943	This simplifies restoring a machine to the state of a snapshot:
11944	only the differencing images need to be deleted.
11945
11946	The current machine state is not changed by taking a snapshot
11947	except that <link to="IMachine::currentSnapshot" /> is set to
11948	the newly created snapshot, which is also added to the machine's
11949	snapshots tree.
11950	</li>
11951
11952	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11953	the state of a previous snapshot by deleting the differencing
11954	image of each of the machine's media and setting the machine's
11955	settings and state to the state that was saved in the snapshot (if any).
11956
11957	This destroys the machine's current state. After calling this,
11958	<link to="IMachine::currentSnapshot" /> points to the snapshot
11959	that was restored.
11960	</li>
11961
11962	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11963	without affecting the current machine state.
11964
11965	This does not change the current machine state, but instead frees the
11966	resources allocated when the snapshot was taken: the settings and machine
11967	state file are deleted (if any), and the snapshot's differencing image for
11968	each of the machine's media gets merged with its parent image.
11969
11970	Neither the current machine state nor other snapshots are affected
11971	by this operation, except that parent media will be modified
11972	to contain the disk data associated with the snapshot being deleted.
11973
11974	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11975	attribute is set to the current snapshot's parent or @c null if it
11976	has no parent. Otherwise the attribute is unchanged.
11977	</li>
11978	</ul>
11979
11980	Each snapshot contains a copy of virtual machine's settings (hardware
11981	configuration etc.). This copy is contained in an immutable (read-only)
11982	instance of <link to="IMachine" /> which is available from the snapshot's
11983	<link to="#machine" /> attribute. When restoring the snapshot, these
11984	settings are copied back to the original machine.
11985
11986	In addition, if the machine was running when the
11987	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11988	the current VM state is saved in the snapshot (similarly to what happens
11989	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11990	because when restoring it, the VM will be running.
11991
11992	If the machine was in <link to="MachineState_Saved">saved</link> saved,
11993	the snapshot receives a copy of the execution state file
11994	(<link to="IMachine::stateFilePath"/>).
11995
11996	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
11997	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
11998	it then contains a so-called "zero execution state", representing a
11999	machine that is powered off.
12000	</desc>
12001
12002	<attribute name="id" type="uuid" mod="string" readonly="yes">
12003	<desc>UUID of the snapshot.</desc>
12004	</attribute>
12005
12006	<attribute name="name" type="wstring">
12007	<desc>Short name of the snapshot.
12008	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12009	be called implicitly.</note>
12010	</desc>
12011	</attribute>
12012
12013	<attribute name="description" type="wstring">
12014	<desc>Optional description of the snapshot.
12015	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
12016	be called implicitly.</note>
12017	</desc>
12018	</attribute>
12019
12020	<attribute name="timeStamp" type="long long" readonly="yes">
12021	<desc>
12022	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
12023	</desc>
12024	</attribute>
12025
12026	<attribute name="online" type="boolean" readonly="yes">
12027	<desc>
12028	@c true if this snapshot is an online snapshot and @c false otherwise.
12029
12030	When this attribute is @c true, the
12031	<link to="IMachine::stateFilePath"/> attribute of the
12032	<link to="#machine"/> object associated with this snapshot
12033	will point to the saved state file. Otherwise, it will be
12034	an empty string.
12035	</desc>
12036	</attribute>
12037
12038	<attribute name="machine" type="IMachine" readonly="yes">
12039	<desc>
12040	Virtual machine this snapshot is taken on. This object
12041	stores all settings the machine had when taking this snapshot.
12042	<note>
12043	The returned machine object is immutable, i.e. no
12044	any settings can be changed.
12045	</note>
12046	</desc>
12047	</attribute>
12048
12049	<attribute name="parent" type="ISnapshot" readonly="yes">
12050	<desc>
12051	Parent snapshot (a snapshot this one is based on), or
12052	@c null if the snapshot has no parent (i.e. is the first snapshot).
12053	</desc>
12054	</attribute>
12055
12056	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
12057	<desc>
12058	Child snapshots (all snapshots having this one as a parent).
12059	By inspecting this attribute starting with a machine's root snapshot
12060	(which can be obtained by calling <link to="IMachine::findSnapshot" />
12061	with a @c null UUID), a machine's snapshots tree can be iterated over.
12062	</desc>
12063	</attribute>
12064
12065	<method name="getChildrenCount" const="yes">
12066	<desc>
12067	Returns the number of direct childrens of this snapshot.
12068	</desc>
12069	<param name="childrenCount" type="unsigned long" dir="return">
12070	<desc>
12071	</desc>
12072	</param>
12073	</method>
12074
12075	</interface>
12076
12077
12078	<!--
12079	// IMedium
12080	/////////////////////////////////////////////////////////////////////////
12081	-->
12082
12083	<enum
12084	name="MediumState"
12085	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
12086	>
12087	<desc>
12088	Virtual medium state.
12089	<see><link to="IMedium"/></see>
12090	</desc>
12091
12092	<const name="NotCreated" value="0">
12093	<desc>
12094	Associated medium storage does not exist (either was not created yet or
12095	was deleted).
12096	</desc>
12097	</const>
12098	<const name="Created" value="1">
12099	<desc>
12100	Associated storage exists and accessible; this gets set if the
12101	accessibility check performed by <link to="IMedium::refreshState" />
12102	was successful.
12103	</desc>
12104	</const>
12105	<const name="LockedRead" value="2">
12106	<desc>
12107	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
12108	no data modification is possible.
12109	</desc>
12110	</const>
12111	<const name="LockedWrite" value="3">
12112	<desc>
12113	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
12114	no concurrent data reading or modification is possible.
12115	</desc>
12116	</const>
12117	<const name="Inaccessible" value="4">
12118	<desc>
12119	Medium accessibility check (see <link to="IMedium::refreshState" />) has
12120	not yet been performed, or else, associated medium storage is not
12121	accessible. In the first case, <link to="IMedium::lastAccessError"/>
12122	is empty, in the second case, it describes the error that occurred.
12123	</desc>
12124	</const>
12125	<const name="Creating" value="5">
12126	<desc>
12127	Associated medium storage is being created.
12128	</desc>
12129	</const>
12130	<const name="Deleting" value="6">
12131	<desc>
12132	Associated medium storage is being deleted.
12133	</desc>
12134	</const>
12135	</enum>
12136
12137	<enum
12138	name="MediumType"
12139	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
12140	>
12141	<desc>
12142	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
12143	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
12144	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
12145	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
12146	</desc>
12147
12148	<const name="Normal" value="0">
12149	<desc>
12150	Normal medium (attached directly or indirectly, preserved
12151	when taking snapshots).
12152	</desc>
12153	</const>
12154	<const name="Immutable" value="1">
12155	<desc>
12156	Immutable medium (attached indirectly, changes are wiped out
12157	the next time the virtual machine is started).
12158	</desc>
12159	</const>
12160	<const name="Writethrough" value="2">
12161	<desc>
12162	Write through medium (attached directly, ignored when
12163	taking snapshots).
12164	</desc>
12165	</const>
12166	<const name="Shareable" value="3">
12167	<desc>
12168	Allow using this medium concurrently by several machines.
12169	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
12170	</desc>
12171	</const>
12172	<const name="Readonly" value="4">
12173	<desc>
12174	A readonly medium, which can of course be used by several machines.
12175	<note>Present and accepted since VirtualBox 4.0.</note>
12176	</desc>
12177	</const>
12178	<const name="MultiAttach" value="5">
12179	<desc>
12180	A medium which is indirectly attached, so that one base medium can
12181	be used for several VMs which have their own differencing medium to
12182	store their modifications. In some sense a variant of Immutable
12183	with unset AutoReset flag in each differencing medium.
12184	<note>Present and accepted since VirtualBox 4.0.</note>
12185	</desc>
12186	</const>
12187	</enum>
12188
12189	<enum
12190	name="MediumVariant"
12191	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
12192	>
12193	<desc>
12194	Virtual medium image variant. More than one flag may be set.
12195	<see><link to="IMedium"/></see>
12196	</desc>
12197
12198	<const name="Standard" value="0">
12199	<desc>
12200	No particular variant requested, results in using the backend default.
12201	</desc>
12202	</const>
12203	<const name="VmdkSplit2G" value="0x01">
12204	<desc>
12205	VMDK image split in chunks of less than 2GByte.
12206	</desc>
12207	</const>
12208	<const name="VmdkRawDisk" value="0x02">
12209	<desc>
12210	VMDK image representing a raw disk.
12211	</desc>
12212	</const>
12213	<const name="VmdkStreamOptimized" value="0x04">
12214	<desc>
12215	VMDK streamOptimized image. Special import/export format which is
12216	read-only/append-only.
12217	</desc>
12218	</const>
12219	<const name="VmdkESX" value="0x08">
12220	<desc>
12221	VMDK format variant used on ESX products.
12222	</desc>
12223	</const>
12224	<const name="Fixed" value="0x10000">
12225	<desc>
12226	Fixed image. Only allowed for base images.
12227	</desc>
12228	</const>
12229	<const name="Diff" value="0x20000">
12230	<desc>
12231	Differencing image. Only allowed for child images.
12232	</desc>
12233	</const>
12234	<const name="NoCreateDir" value="0x40000000">
12235	<desc>
12236	Special flag which suppresses automatic creation of the subdirectory.
12237	Only used when passing the medium variant as an input parameter.
12238	</desc>
12239	</const>
12240	</enum>
12241
12242	<interface
12243	name="IMediumAttachment" extends="$unknown"
12244	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
12245	wsmap="struct"
12246	>
12247	<desc>
12248	The IMediumAttachment interface links storage media to virtual machines.
12249	For each medium (<link to="IMedium"/>) which has been attached to a
12250	storage controller (<link to="IStorageController"/>) of a machine
12251	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
12252	method, one instance of IMediumAttachment is added to the machine's
12253	<link to="IMachine::mediumAttachments"/> array attribute.
12254
12255	Each medium attachment specifies the storage controller as well as a
12256	port and device number and the IMedium instance representing a virtual
12257	hard disk or floppy or DVD image.
12258
12259	For removable media (DVDs or floppies), there are two additional
12260	options. For one, the IMedium instance can be @c null to represent
12261	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
12262	secondly, the medium can be one of the pseudo-media for host drives
12263	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
12264
12265	<h3>Attaching Hard Disks</h3>
12266
12267	Hard disks are attached to virtual machines using the
12268	<link to="IMachine::attachDevice"/> method and detached using the
12269	<link to="IMachine::detachDevice"/> method. Depending on a medium's
12270	type (see <link to="IMedium::type" />), hard disks are attached either
12271	<i>directly</i> or <i>indirectly</i>.
12272
12273	When a hard disk is being attached directly, it is associated with the
12274	virtual machine and used for hard disk operations when the machine is
12275	running. When a hard disk is being attached indirectly, a new differencing
12276	hard disk linked to it is implicitly created and this differencing hard
12277	disk is associated with the machine and used for hard disk operations.
12278	This also means that if <link to="IMachine::attachDevice"/> performs
12279	a direct attachment then the same hard disk will be returned in response
12280	to the subsequent <link to="IMachine::getMedium"/> call; however if
12281	an indirect attachment is performed then
12282	<link to="IMachine::getMedium"/> will return the implicitly created
12283	differencing hard disk, not the original one passed to <link
12284	to="IMachine::attachDevice"/>. In detail:
12285
12286	<ul>
12287	<li><b>Normal base</b> hard disks that do not have children (i.e.
12288	differencing hard disks linked to them) and that are not already
12289	attached to virtual machines in snapshots are attached <b>directly</b>.
12290	Otherwise, they are attached <b>indirectly</b> because having
12291	dependent children or being part of the snapshot makes it impossible
12292	to modify hard disk contents without breaking the integrity of the
12293	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
12294	quickly determine the kind of the attachment for the given hard
12295	disk. Note that if a normal base hard disk is to be indirectly
12296	attached to a virtual machine with snapshots then a special
12297	procedure called <i>smart attachment</i> is performed (see below).</li>
12298	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
12299	they are attached <b>directly</b> if they do not have children and are
12300	not attached to virtual machines in snapshots, and <b>indirectly</b>
12301	otherwise. Note that the smart attachment procedure is never performed
12302	for differencing hard disks.</li>
12303	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
12304	they are designed to be non-writable. If an immutable hard disk is
12305	attached to a virtual machine with snapshots then a special
12306	procedure called smart attachment is performed (see below).</li>
12307	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
12308	also as designed. This also means that writethrough hard disks cannot
12309	have other hard disks linked to them at all.</li>
12310	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
12311	also as designed. This also means that shareable hard disks cannot
12312	have other hard disks linked to them at all. They behave almost
12313	like writethrough hard disks, except that shareable hard disks can
12314	be attached to several virtual machines which are running, allowing
12315	concurrent accesses. You need special cluster software running in
12316	the virtual machines to make use of such disks.</li>
12317	</ul>
12318
12319	Note that the same hard disk, regardless of its type, may be attached to
12320	more than one virtual machine at a time. In this case, the machine that is
12321	started first gains exclusive access to the hard disk and attempts to
12322	start other machines having this hard disk attached will fail until the
12323	first machine is powered down.
12324
12325	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
12326	that the given hard disk remains associated with the given machine after a
12327	successful <link to="IMachine::detachDevice"/> call until
12328	<link to="IMachine::saveSettings"/> is called to save all changes to
12329	machine settings to disk. This deferring is necessary to guarantee that
12330	the hard disk configuration may be restored at any time by a call to
12331	<link to="IMachine::discardSettings"/> before the settings
12332	are saved (committed).
12333
12334	Note that if <link to="IMachine::discardSettings"/> is called after
12335	indirectly attaching some hard disks to the machine but before a call to
12336	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
12337	all differencing hard disks implicitly created by
12338	<link to="IMachine::attachDevice"/> for these indirect attachments.
12339	Such implicitly created hard disks will also be immediately deleted when
12340	detached explicitly using the <link to="IMachine::detachDevice"/>
12341	call if it is made before <link to="IMachine::saveSettings"/>. This
12342	implicit deletion is safe because newly created differencing hard
12343	disks do not contain any user data.
12344
12345	However, keep in mind that detaching differencing hard disks that were
12346	implicitly created by <link to="IMachine::attachDevice"/>
12347	before the last <link to="IMachine::saveSettings"/> call will
12348	<b>not</b> implicitly delete them as they may already contain some data
12349	(for example, as a result of virtual machine execution). If these hard
12350	disks are no more necessary, the caller can always delete them explicitly
12351	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
12352	from this machine by the <link to="IMachine::saveSettings"/> call.
12353
12354	<h3>Smart Attachment</h3>
12355
12356	When normal base or immutable hard disks are indirectly attached to a
12357	virtual machine then some additional steps are performed to make sure the
12358	virtual machine will have the most recent "view" of the hard disk being
12359	attached. These steps include walking through the machine's snapshots
12360	starting from the current one and going through ancestors up to the first
12361	snapshot. Hard disks attached to the virtual machine in all
12362	of the encountered snapshots are checked whether they are descendants of
12363	the given normal base or immutable hard disk. The first found child (which
12364	is the differencing hard disk) will be used instead of the normal base or
12365	immutable hard disk as a parent for creating a new differencing hard disk
12366	that will be actually attached to the machine. And only if no descendants
12367	are found or if the virtual machine does not have any snapshots then the
12368	normal base or immutable hard disk will be used itself as a parent for
12369	this differencing hard disk.
12370
12371	It is easier to explain what smart attachment does using the
12372	following example:
12373	<pre>
12374	BEFORE attaching B.vdi: AFTER attaching B.vdi:
12375
12376	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
12377	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
12378	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
12379	Snapshot 4 (none) Snapshot 4 (none)
12380	CurState (none) CurState (D3->D2.vdi)
12381
12382	NOT
12383	...
12384	CurState (D3->B.vdi)
12385	</pre>
12386	The first column is the virtual machine configuration before the base hard
12387	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
12388	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
12389	mean that the hard disk that is actually attached to the machine is a
12390	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
12391	another hard disk, <tt>B.vdi</tt>.
12392
12393	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
12394	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
12395	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
12396	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
12397	it cannot be attached directly and needs an indirect attachment (i.e.
12398	implicit creation of a new differencing hard disk). Due to the smart
12399	attachment procedure, the new differencing hard disk
12400	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
12401	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
12402	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
12403	machine.
12404
12405	Note that if there is more than one descendant hard disk of the given base
12406	hard disk found in a snapshot, and there is an exact device, channel and
12407	bus match, then this exact match will be used. Otherwise, the youngest
12408	descendant will be picked up.
12409
12410	There is one more important aspect of the smart attachment procedure which
12411	is not related to snapshots at all. Before walking through the snapshots
12412	as described above, the backup copy of the current list of hard disk
12413	attachment is searched for descendants. This backup copy is created when
12414	the hard disk configuration is changed for the first time after the last
12415	<link to="IMachine::saveSettings"/> call and used by
12416	<link to="IMachine::discardSettings"/> to undo the recent hard disk
12417	changes. When such a descendant is found in this backup copy, it will be
12418	simply re-attached back, without creating a new differencing hard disk for
12419	it. This optimization is necessary to make it possible to re-attach the
12420	base or immutable hard disk to a different bus, channel or device slot
12421	without losing the contents of the differencing hard disk actually
12422	attached to the machine in place of it.
12423
12424	</desc>
12425
12426	<attribute name="medium" type="IMedium" readonly="yes">
12427	<desc>Medium object associated with this attachment; it
12428	can be @c null for removable devices.</desc>
12429	</attribute>
12430
12431	<attribute name="controller" type="wstring" readonly="yes">
12432	<desc>Name of the storage controller of this attachment; this
12433	refers to one of the controllers in <link to="IMachine::storageControllers" />
12434	by name.</desc>
12435	</attribute>
12436
12437	<attribute name="port" type="long" readonly="yes">
12438	<desc>Port number of this attachment.
12439	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12440	</desc>
12441	</attribute>
12442
12443	<attribute name="device" type="long" readonly="yes">
12444	<desc>Device slot number of this attachment.
12445	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12446	</desc>
12447	</attribute>
12448
12449	<attribute name="type" type="DeviceType" readonly="yes">
12450	<desc>Device type of this attachment.</desc>
12451	</attribute>
12452
12453	<attribute name="passthrough" type="boolean" readonly="yes">
12454	<desc>Pass I/O requests through to a device on the host.</desc>
12455	</attribute>
12456
12457	<attribute name="temporaryEject" type="boolean" readonly="yes">
12458	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12459	</attribute>
12460
12461	<attribute name="isEjected" type="boolean" readonly="yes">
12462	<desc>Signals that the removable medium has been ejected. This is not
12463	necessarily equivalent to having a @c null medium association.</desc>
12464	</attribute>
12465
12466	<attribute name="nonRotational" type="boolean" readonly="yes">
12467	<desc>Whether the associated medium is non-rotational.</desc>
12468	</attribute>
12469
12470	<attribute name="discard" type="boolean" readonly="yes">
12471	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12472	</attribute>
12473
12474	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12475	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12476	</attribute>
12477
12478	</interface>
12479
12480	<interface
12481	name="IMedium" extends="$unknown"
12482	uuid="86fd6208-4c8c-40c2-a4e3-f6b47ac6ef07"
12483	wsmap="managed"
12484	>
12485	<desc>
12486	The IMedium interface represents virtual storage for a machine's
12487	hard disks, CD/DVD or floppy drives. It will typically represent
12488	a disk image on the host, for example a VDI or VMDK file representing
12489	a virtual hard disk, or an ISO or RAW file representing virtual
12490	removable media, but can also point to a network location (e.g.
12491	for iSCSI targets).
12492
12493	Instances of IMedium are connected to virtual machines by way of medium
12494	attachments, which link the storage medium to a particular device slot
12495	of a storage controller of the virtual machine.
12496	In the VirtualBox API, virtual storage is therefore always represented
12497	by the following chain of object links:
12498
12499	<ul>
12500	<li><link to="IMachine::storageControllers"/> contains an array of
12501	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12502	these are instances of <link to="IStorageController"/>).</li>
12503	<li><link to="IMachine::mediumAttachments"/> contains an array of
12504	medium attachments (instances of <link to="IMediumAttachment"/>
12505	created by <link to="IMachine::attachDevice" />),
12506	each containing a storage controller from the above array, a
12507	port/device specification, and an instance of IMedium representing
12508	the medium storage (image file).
12509
12510	For removable media, the storage medium is optional; a medium
12511	attachment with no medium represents a CD/DVD or floppy drive
12512	with no medium inserted. By contrast, hard disk attachments
12513	will always have an IMedium object attached.</li>
12514	<li>Each IMedium in turn points to a storage unit (such as a file
12515	on the host computer or a network resource) that holds actual
12516	data. This location is represented by the <link to="#location"/>
12517	attribute.</li>
12518	</ul>
12519
12520	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12521	new hard disk media can be created with the VirtualBox API using the
12522	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12523	disks (see below) are usually implicitly created by VirtualBox as
12524	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12525	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12526	should be created with external tools and then opened from within VirtualBox.
12527
12528	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12529	drive. In that case the <link to="#id" /> attribute contains the UUID of
12530	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12531
12532	<h3>Media registries</h3>
12533
12534	When a medium has been opened or created using one of the aforementioned
12535	APIs, it becomes "known" to VirtualBox. Known media can be attached
12536	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12537	They also appear in the global
12538	<link to="IVirtualBox::hardDisks" />,
12539	<link to="IVirtualBox::DVDImages" /> and
12540	<link to="IVirtualBox::floppyImages" /> arrays.
12541
12542	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12543	in the VirtualBox.xml file, which was shared between all machines and made
12544	transporting machines and their media from one host to another difficult.
12545
12546	Starting with VirtualBox 4.0, media are only added to a registry when they are
12547	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12548	backwards compatibility, which registry a medium is added to depends on which
12549	VirtualBox version created a machine:
12550
12551	<ul>
12552	<li>If the medium has first been attached to a machine which was created by
12553	VirtualBox 4.0 or later, it is added to that machine's media registry in
12554	the machine XML settings file. This way all information about a machine's
12555	media attachments is contained in a single file and can be transported
12556	easily.</li>
12557	<li>For older media attachments (i.e. if the medium was first attached to a
12558	machine which was created with a VirtualBox version before 4.0), media
12559	continue to be registered in the global VirtualBox settings file, for
12560	backwards compatibility.</li>
12561	</ul>
12562
12563	See <link to="IVirtualBox::openMedium" /> for more information.
12564
12565	Media are removed from media registries by the <link to="IMedium::close"/>,
12566	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12567
12568	<h3>Accessibility checks</h3>
12569
12570	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12571	method is called explicitly on a medium. This is done to make the VirtualBox object
12572	ready for serving requests as fast as possible and let the end-user
12573	application decide if it needs to check media accessibility right away or not.
12574
12575	As a result, when VirtualBox starts up (e.g. the VirtualBox
12576	object gets created for the first time), all known media are in the
12577	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12578	attribute is an empty string because no actual accessibility check has
12579	been made yet.
12580
12581	After calling <link to="#refreshState" />, a medium is considered
12582	<i>accessible</i> if its storage unit can be read. In that case, the
12583	<link to="#state"/> attribute has a value of "Created". If the storage
12584	unit cannot be read (for example, because it is located on a disconnected
12585	network resource, or was accidentally deleted outside VirtualBox),
12586	the medium is considered <i>inaccessible</i>, which is indicated by the
12587	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12588	obtained by reading the <link to="#lastAccessError"/> attribute.
12589
12590	<h3>Medium types</h3>
12591
12592	There are five types of medium behavior which are stored in the
12593	<link to="#type"/> attribute (see <link to="MediumType" />) and
12594	which define the medium's behavior with attachments and snapshots.
12595
12596	All media can be also divided in two groups: <i>base</i> media and
12597	<i>differencing</i> media. A base medium contains all sectors of the
12598	medium data in its own storage and therefore can be used independently.
12599	In contrast, a differencing medium is a "delta" to some other medium and
12600	contains only those sectors which differ from that other medium, which is
12601	then called a <i>parent</i>. The differencing medium is said to be
12602	<i>linked to</i> that parent. The parent may be itself a differencing
12603	medium, thus forming a chain of linked media. The last element in that
12604	chain must always be a base medium. Note that several differencing
12605	media may be linked to the same parent medium.
12606
12607	Differencing media can be distinguished from base media by querying the
12608	<link to="#parent"/> attribute: base media do not have parents they would
12609	depend on, so the value of this attribute is always @c null for them.
12610	Using this attribute, it is possible to walk up the medium tree (from the
12611	child medium to its parent). It is also possible to walk down the tree
12612	using the <link to="#children"/> attribute.
12613
12614	Note that the type of all differencing media is "normal"; all other
12615	values are meaningless for them. Base media may be of any type.
12616
12617	<h3>Automatic composition of the file name part</h3>
12618
12619	Another extension to the <link to="IMedium::location"/> attribute is that
12620	there is a possibility to cause VirtualBox to compose a unique value for
12621	the file name part of the location using the UUID of the hard disk. This
12622	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12623	e.g. before the storage unit is created, and works as follows. You set the
12624	value of the <link to="IMedium::location"/> attribute to a location
12625	specification which only contains the path specification but not the file
12626	name part and ends with either a forward slash or a backslash character.
12627	In response, VirtualBox will generate a new UUID for the hard disk and
12628	compose the file name using the following pattern:
12629	<pre>
12630	<path>/{<uuid>}.<ext>
12631	</pre>
12632	where <tt><path></tt> is the supplied path specification,
12633	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12634	is the default extension for the storage format of this hard disk. After
12635	that, you may call any of the methods that create a new hard disk storage
12636	unit and they will use the generated UUID and file name.
12637	</desc>
12638
12639	<attribute name="id" type="uuid" mod="string" readonly="yes">
12640	<desc>
12641	UUID of the medium. For a newly created medium, this value is a randomly
12642	generated UUID.
12643
12644	<note>
12645	For media in one of MediumState_NotCreated, MediumState_Creating or
12646	MediumState_Deleting states, the value of this property is undefined
12647	and will most likely be an empty UUID.
12648	</note>
12649	</desc>
12650	</attribute>
12651
12652	<attribute name="description" type="wstring">
12653	<desc>
12654	Optional description of the medium. For a newly created medium the value
12655	of this attribute is an empty string.
12656
12657	Medium types that don't support this attribute will return E_NOTIMPL in
12658	attempt to get or set this attribute's value.
12659
12660	<note>
12661	For some storage types, reading this attribute may return an outdated
12662	(last known) value when <link to="#state"/> is <link
12663	to="MediumState_Inaccessible"/> or <link
12664	to="MediumState_LockedWrite"/> because the value of this attribute is
12665	stored within the storage unit itself. Also note that changing the
12666	attribute value is not possible in such case, as well as when the
12667	medium is the <link to="MediumState_LockedRead"/> state.
12668	</note>
12669	</desc>
12670	</attribute>
12671
12672	<attribute name="state" type="MediumState" readonly="yes">
12673	<desc>
12674	Returns the current medium state, which is the last state set by
12675	the accessibility check performed by <link to="#refreshState"/>.
12676	If that method has not yet been called on the medium, the state
12677	is "Inaccessible"; as opposed to truly inaccessible media, the
12678	value of <link to="#lastAccessError"/> will be an empty string in
12679	that case.
12680
12681	<note>As of version 3.1, this no longer performs an accessibility check
12682	automatically; call <link to="#refreshState"/> for that.
12683	</note>
12684	</desc>
12685	</attribute>
12686
12687	<attribute name="variant" type="MediumVariant" safearray="yes" readonly="yes">
12688	<desc>
12689	Returns the storage format variant information for this medium
12690	as an aaray of the flags described at <link to="MediumVariant" />.
12691	Before <link to="#refreshState"/> is called this method returns
12692	an undefined value.
12693	</desc>
12694	</attribute>
12695
12696	<attribute name="location" type="wstring">
12697	<desc>
12698	Location of the storage unit holding medium data.
12699
12700	The format of the location string is medium type specific. For medium
12701	types using regular files in a host's file system, the location
12702	string is the full file name.
12703
12704	Some medium types may support changing the storage unit location by
12705	simply changing the value of this property. If this operation is not
12706	supported, the implementation will return E_NOTIMPL in attempt to set
12707	this attribute's value.
12708
12709	When setting a value of the location attribute which is a regular file
12710	in the host's file system, the given file name may be either relative to
12711	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12712	absolute. Note that if the given location specification does not contain
12713	the file extension part then a proper default extension will be
12714	automatically appended by the implementation depending on the medium type.
12715	</desc>
12716	</attribute>
12717
12718	<attribute name="name" type="wstring" readonly="yes">
12719	<desc>
12720	Name of the storage unit holding medium data.
12721
12722	The returned string is a short version of the <link to="#location"/>
12723	attribute that is suitable for representing the medium in situations
12724	where the full location specification is too long (such as lists
12725	and comboboxes in GUI frontends). This string is also used by frontends
12726	to sort the media list alphabetically when needed.
12727
12728	For example, for locations that are regular files in the host's file
12729	system, the value of this attribute is just the file name (+ extension),
12730	without the path specification.
12731
12732	Note that as opposed to the <link to="#location"/> attribute, the name
12733	attribute will not necessary be unique for a list of media of the
12734	given type and format.
12735	</desc>
12736	</attribute>
12737
12738	<attribute name="deviceType" type="DeviceType" readonly="yes">
12739	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12740	medium.</desc>
12741	</attribute>
12742
12743	<attribute name="hostDrive" type="boolean" readonly="yes">
12744	<desc>True if this corresponds to a drive on the host.</desc>
12745	</attribute>
12746
12747	<attribute name="size" type="long long" readonly="yes">
12748	<desc>
12749	Physical size of the storage unit used to hold medium data (in bytes).
12750
12751	<note>
12752	For media whose <link to="#state"/> is <link
12753	to="MediumState_Inaccessible"/>, the value of this property is the
12754	last known size. For <link to="MediumState_NotCreated"/> media,
12755	the returned value is zero.
12756	</note>
12757	</desc>
12758	</attribute>
12759
12760	<attribute name="format" type="wstring" readonly="yes">
12761	<desc>
12762	Storage format of this medium.
12763
12764	The value of this attribute is a string that specifies a backend used
12765	to store medium data. The storage format is defined when you create a
12766	new medium or automatically detected when you open an existing medium,
12767	and cannot be changed later.
12768
12769	The list of all storage formats supported by this VirtualBox
12770	installation can be obtained using
12771	<link to="ISystemProperties::mediumFormats"/>.
12772	</desc>
12773	</attribute>
12774
12775	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12776	<desc>
12777	Storage medium format object corresponding to this medium.
12778
12779	The value of this attribute is a reference to the medium format object
12780	that specifies the backend properties used to store medium data. The
12781	storage format is defined when you create a new medium or automatically
12782	detected when you open an existing medium, and cannot be changed later.
12783
12784	<note>@c null is returned if there is no associated medium format
12785	object. This can e.g. happen for medium objects representing host
12786	drives and other special medium objects.</note>
12787	</desc>
12788	</attribute>
12789
12790	<attribute name="type" type="MediumType">
12791	<desc>
12792	Type (role) of this medium.
12793
12794	The following constraints apply when changing the value of this
12795	attribute:
12796	<ul>
12797	<li>If a medium is attached to a virtual machine (either in the
12798	current state or in one of the snapshots), its type cannot be
12799	changed.
12800	</li>
12801	<li>As long as the medium has children, its type cannot be set
12802	to <link to="MediumType_Writethrough"/>.
12803	</li>
12804	<li>The type of all differencing media is
12805	<link to="MediumType_Normal"/> and cannot be changed.
12806	</li>
12807	</ul>
12808
12809	The type of a newly created or opened medium is set to
12810	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12811	which have a type of <link to="MediumType_Writethrough"/>.
12812	</desc>
12813	</attribute>
12814
12815	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12816	<desc>
12817	Returns which medium types can selected for this medium.
12818
12819	<result name="E_NOTIMPL">
12820	This attribute is not implemented at the moment.
12821	</result>
12822	</desc>
12823	</attribute>
12824
12825	<attribute name="parent" type="IMedium" readonly="yes">
12826	<desc>
12827	Parent of this medium (the medium this medium is directly based
12828	on).
12829
12830	Only differencing media have parents. For base (non-differencing)
12831	media, @c null is returned.
12832	</desc>
12833	</attribute>
12834
12835	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12836	<desc>
12837	Children of this medium (all differencing media directly based
12838	on this medium). A @c null array is returned if this medium
12839	does not have any children.
12840	</desc>
12841	</attribute>
12842
12843	<attribute name="base" type="IMedium" readonly="yes">
12844	<desc>
12845	Base medium of this medium.
12846
12847	If this is a differencing medium, its base medium is the medium
12848	the given medium branch starts from. For all other types of media, this
12849	property returns the medium object itself (i.e. the same object this
12850	property is read on).
12851	</desc>
12852	</attribute>
12853
12854	<attribute name="readOnly" type="boolean" readonly="yes">
12855	<desc>
12856	Returns @c true if this medium is read-only and @c false otherwise.
12857
12858	A medium is considered to be read-only when its contents cannot be
12859	modified without breaking the integrity of other parties that depend on
12860	this medium such as its child media or snapshots of virtual machines
12861	where this medium is attached to these machines. If there are no
12862	children and no such snapshots then there is no dependency and the
12863	medium is not read-only.
12864
12865	The value of this attribute can be used to determine the kind of the
12866	attachment that will take place when attaching this medium to a
12867	virtual machine. If the value is @c false then the medium will
12868	be attached directly. If the value is @c true then the medium
12869	will be attached indirectly by creating a new differencing child
12870	medium for that. See the interface description for more information.
12871
12872	Note that all <link to="MediumType_Immutable">Immutable</link> media
12873	are always read-only while all
12874	<link to="MediumType_Writethrough">Writethrough</link> media are
12875	always not.
12876
12877	<note>
12878	The read-only condition represented by this attribute is related to
12879	the medium type and usage, not to the current
12880	<link to="IMedium::state">medium state</link> and not to the read-only
12881	state of the storage unit.
12882	</note>
12883	</desc>
12884	</attribute>
12885
12886	<attribute name="logicalSize" type="long long" readonly="yes">
12887	<desc>
12888	Logical size of this medium (in bytes), as reported to the
12889	guest OS running inside the virtual machine this medium is
12890	attached to. The logical size is defined when the medium is created
12891	and cannot be changed later.
12892
12893	<note>
12894	For media whose state is <link to="#state"/> is <link
12895	to="MediumState_Inaccessible"/>, the value of this property is the
12896	last known logical size. For <link to="MediumState_NotCreated"/>
12897	media, the returned value is zero.
12898	</note>
12899	</desc>
12900	</attribute>
12901
12902	<attribute name="autoReset" type="boolean">
12903	<desc>
12904	Whether this differencing medium will be automatically reset each
12905	time a virtual machine it is attached to is powered up. This
12906	attribute is automatically set to @c true for the last
12907	differencing image of an "immutable" medium (see
12908	<link to="MediumType" />).
12909
12910	See <link to="#reset"/> for more information about resetting
12911	differencing media.
12912
12913	<note>
12914	Reading this property on a base (non-differencing) medium will
12915	always @c false. Changing the value of this property in this
12916	case is not supported.
12917	</note>
12918
12919	<result name="VBOX_E_NOT_SUPPORTED">
12920	This is not a differencing medium (when changing the attribute
12921	value).
12922	</result>
12923	</desc>
12924	</attribute>
12925
12926	<attribute name="lastAccessError" type="wstring" readonly="yes">
12927	<desc>
12928	Text message that represents the result of the last accessibility
12929	check performed by <link to="#refreshState"/>.
12930
12931	An empty string is returned if the last accessibility check
12932	was successful or has not yet been called. As a result, if
12933	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12934	then <link to="#refreshState"/> has yet to be called; this is the
12935	default value of media after VirtualBox initialization.
12936	A non-empty string indicates a failure and should normally describe
12937	a reason of the failure (for example, a file read error).
12938	</desc>
12939	</attribute>
12940
12941	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12942	<desc>
12943	Array of UUIDs of all machines this medium is attached to.
12944
12945	A @c null array is returned if this medium is not attached to any
12946	machine or to any machine's snapshot.
12947
12948	<note>
12949	The returned array will include a machine even if this medium is not
12950	attached to that machine in the current state but attached to it in
12951	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12952	details.
12953	</note>
12954	</desc>
12955	</attribute>
12956
12957	<method name="setIds">
12958	<desc>
12959	Changes the UUID and parent UUID for a hard disk medium.
12960	</desc>
12961	<param name="setImageId" type="boolean" dir="in">
12962	<desc>
12963	Select whether a new image UUID is set or not.
12964	</desc>
12965	</param>
12966	<param name="imageId" type="uuid" mod="string" dir="in">
12967	<desc>
12968	New UUID for the image. If an empty string is passed, then a new
12969	UUID is automatically created, provided that @a setImageId is @c true.
12970	Specifying a zero UUID is not allowed.
12971	</desc>
12972	</param>
12973	<param name="setParentId" type="boolean" dir="in">
12974	<desc>
12975	Select whether a new parent UUID is set or not.
12976	</desc>
12977	</param>
12978	<param name="parentId" type="uuid" mod="string" dir="in">
12979	<desc>
12980	New parent UUID for the image. If an empty string is passed, then a
12981	new UUID is automatically created, provided @a setParentId is
12982	@c true. A zero UUID is valid.
12983	</desc>
12984	</param>
12985	<result name="E_INVALIDARG">
12986	Invalid parameter combination.
12987	</result>
12988	<result name="VBOX_E_NOT_SUPPORTED">
12989	Medium is not a hard disk medium.
12990	</result>
12991	</method>
12992
12993	<method name="refreshState">
12994	<desc>
12995	If the current medium state (see <link to="MediumState"/>) is one of
12996	"Created", "Inaccessible" or "LockedRead", then this performs an
12997	accessibility check on the medium and sets the value of the <link to="#state"/>
12998	attribute accordingly; that value is also returned for convenience.
12999
13000	For all other state values, this does not perform a refresh but returns
13001	the state only.
13002
13003	The refresh, if performed, may take a long time (several seconds or even
13004	minutes, depending on the storage unit location and format) because it performs an
13005	accessibility check of the storage unit. This check may cause a significant
13006	delay if the storage unit of the given medium is, for example, a file located
13007	on a network share which is not currently accessible due to connectivity
13008	problems. In that case, the call will not return until a timeout
13009	interval defined by the host OS for this operation expires. For this reason,
13010	it is recommended to never read this attribute on the main UI thread to avoid
13011	making the UI unresponsive.
13012
13013	If the last known state of the medium is "Created" and the accessibility
13014	check fails, then the state would be set to "Inaccessible", and
13015	<link to="#lastAccessError"/> may be used to get more details about the
13016	failure. If the state of the medium is "LockedRead", then it remains the
13017	same, and a non-empty value of <link to="#lastAccessError"/> will
13018	indicate a failed accessibility check in this case.
13019
13020	Note that not all medium states are applicable to all medium types.
13021	</desc>
13022	<param name="state" type="MediumState" dir="return">
13023	<desc>
13024	New medium state.
13025	</desc>
13026	</param>
13027	</method>
13028
13029	<method name="getSnapshotIds">
13030	<desc>
13031	Returns an array of UUIDs of all snapshots of the given machine where
13032	this medium is attached to.
13033
13034	If the medium is attached to the machine in the current state, then the
13035	first element in the array will always be the ID of the queried machine
13036	(i.e. the value equal to the @c machineId argument), followed by
13037	snapshot IDs (if any).
13038
13039	If the medium is not attached to the machine in the current state, then
13040	the array will contain only snapshot IDs.
13041
13042	The returned array may be @c null if this medium is not attached
13043	to the given machine at all, neither in the current state nor in one of
13044	the snapshots.
13045	</desc>
13046	<param name="machineId" type="uuid" mod="string" dir="in">
13047	<desc>
13048	UUID of the machine to query.
13049	</desc>
13050	</param>
13051	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
13052	<desc>
13053	Array of snapshot UUIDs of the given machine using this medium.
13054	</desc>
13055	</param>
13056	</method>
13057
13058	<method name="lockRead">
13059	<desc>
13060	Locks this medium for reading.
13061
13062	A read lock is shared: many clients can simultaneously lock the
13063	same medium for reading unless it is already locked for writing (see
13064	<link to="#lockWrite"/>) in which case an error is returned.
13065
13066	When the medium is locked for reading, it cannot be modified
13067	from within VirtualBox. This means that any method that changes
13068	the properties of this medium or contents of the storage unit
13069	will return an error (unless explicitly stated otherwise). That
13070	includes an attempt to start a virtual machine that wants to
13071	write to the the medium.
13072
13073	When the virtual machine is started up, it locks for reading all
13074	media it uses in read-only mode. If some medium cannot be locked
13075	for reading, the startup procedure will fail.
13076	A medium is typically locked for reading while it is used by a running
13077	virtual machine but has a depending differencing image that receives
13078	the actual write operations. This way one base medium can have
13079	multiple child differencing images which can be written to
13080	simultaneously. Read-only media such as DVD and floppy images are
13081	also locked for reading only (so they can be in use by multiple
13082	machines simultaneously).
13083
13084	A medium is also locked for reading when it is the source of a
13085	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13086
13087	The medium locked for reading must be unlocked using the <link
13088	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
13089	can be nested and must be followed by the same number of paired
13090	<link to="#unlockRead"/> calls.
13091
13092	This method sets the medium state (see <link to="#state"/>) to
13093	"LockedRead" on success. The medium's previous state must be
13094	one of "Created", "Inaccessible" or "LockedRead".
13095
13096	Locking an inaccessible medium is not an error; this method performs
13097	a logical lock that prevents modifications of this medium through
13098	the VirtualBox API, not a physical file-system lock of the underlying
13099	storage unit.
13100
13101	This method returns the current state of the medium
13102	<i>before</i> the operation.
13103
13104	<result name="VBOX_E_INVALID_OBJECT_STATE">
13105	Invalid medium state (e.g. not created, locked, inaccessible,
13106	creating, deleting).
13107	</result>
13108
13109	</desc>
13110	<param name="state" type="MediumState" dir="return">
13111	<desc>
13112	State of the medium after the operation.
13113	</desc>
13114	</param>
13115	</method>
13116
13117	<method name="unlockRead">
13118	<desc>
13119	Cancels the read lock previously set by <link to="#lockRead"/>.
13120
13121	For both success and failure, this method returns the current state
13122	of the medium <i>after</i> the operation.
13123
13124	See <link to="#lockRead"/> for more details.
13125
13126	<result name="VBOX_E_INVALID_OBJECT_STATE">
13127	Medium not locked for reading.
13128	</result>
13129
13130	</desc>
13131	<param name="state" type="MediumState" dir="return">
13132	<desc>
13133	State of the medium after the operation.
13134	</desc>
13135	</param>
13136	</method>
13137
13138	<method name="lockWrite">
13139	<desc>
13140	Locks this medium for writing.
13141
13142	A write lock, as opposed to <link to="#lockRead"/>, is
13143	exclusive: there may be only one client holding a write lock,
13144	and there may be no read locks while the write lock is held.
13145	As a result, read-locking fails if a write lock is held, and
13146	write-locking fails if either a read or another write lock is held.
13147
13148	When a medium is locked for writing, it cannot be modified
13149	from within VirtualBox, and it is not guaranteed that the values
13150	of its properties are up-to-date. Any method that changes the
13151	properties of this medium or contents of the storage unit will
13152	return an error (unless explicitly stated otherwise).
13153
13154	When a virtual machine is started up, it locks for writing all
13155	media it uses to write data to. If any medium could not be locked
13156	for writing, the startup procedure will fail. If a medium has
13157	differencing images, then while the machine is running, only
13158	the last ("leaf") differencing image is locked for writing,
13159	whereas its parents are locked for reading only.
13160
13161	A medium is also locked for writing when it is the target of a
13162	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
13163
13164	The medium locked for writing must be unlocked using the <link
13165	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
13166
13167	This method sets the medium state (see <link to="#state"/>) to
13168	"LockedWrite" on success. The medium's previous state must be
13169	either "Created" or "Inaccessible".
13170
13171	Locking an inaccessible medium is not an error; this method performs
13172	a logical lock that prevents modifications of this medium through
13173	the VirtualBox API, not a physical file-system lock of the underlying
13174	storage unit.
13175
13176	For both, success and failure, this method returns the current
13177	state of the medium <i>before</i> the operation.
13178
13179	<result name="VBOX_E_INVALID_OBJECT_STATE">
13180	Invalid medium state (e.g. not created, locked, inaccessible,
13181	creating, deleting).
13182	</result>
13183
13184	</desc>
13185	<param name="state" type="MediumState" dir="return">
13186	<desc>
13187	State of the medium after the operation.
13188	</desc>
13189	</param>
13190	</method>
13191
13192	<method name="unlockWrite">
13193	<desc>
13194	Cancels the write lock previously set by <link to="#lockWrite"/>.
13195
13196	For both success and failure, this method returns the current
13197	state of the medium <i>after</i> the operation.
13198
13199	See <link to="#lockWrite"/> for more details.
13200
13201	<result name="VBOX_E_INVALID_OBJECT_STATE">
13202	Medium not locked for writing.
13203	</result>
13204
13205	</desc>
13206	<param name="state" type="MediumState" dir="return">
13207	<desc>
13208	State of the medium after the operation.
13209	</desc>
13210	</param>
13211	</method>
13212
13213	<method name="close">
13214	<desc>
13215	Closes this medium.
13216
13217	The medium must not be attached to any known virtual machine
13218	and must not have any known child media, otherwise the
13219	operation will fail.
13220
13221	When the medium is successfully closed, it is removed from
13222	the list of registered media, but its storage unit is not
13223	deleted. In particular, this means that this medium can
13224	later be opened again using the <link to="IVirtualBox::openMedium"/>
13225	call.
13226
13227	Note that after this method successfully returns, the given medium
13228	object becomes uninitialized. This means that any attempt
13229	to call any of its methods or attributes will fail with the
13230	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
13231
13232	<result name="VBOX_E_INVALID_OBJECT_STATE">
13233	Invalid medium state (other than not created, created or
13234	inaccessible).
13235	</result>
13236	<result name="VBOX_E_OBJECT_IN_USE">
13237	Medium attached to virtual machine.
13238	</result>
13239	<result name="VBOX_E_FILE_ERROR">
13240	Settings file not accessible.
13241	</result>
13242	<result name="VBOX_E_XML_ERROR">
13243	Could not parse the settings file.
13244	</result>
13245
13246	</desc>
13247	</method>
13248
13249	<!-- property methods -->
13250
13251	<method name="getProperty" const="yes">
13252	<desc>
13253	Returns the value of the custom medium property with the given name.
13254
13255	The list of all properties supported by the given medium format can
13256	be obtained with <link to="IMediumFormat::describeProperties"/>.
13257
13258	<note>If this method returns an empty string in @a value, the requested
13259	property is supported but currently not assigned any value.</note>
13260
13261	<result name="VBOX_E_OBJECT_NOT_FOUND">
13262	Requested property does not exist (not supported by the format).
13263	</result>
13264	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13265	</desc>
13266	<param name="name" type="wstring" dir="in">
13267	<desc>Name of the property to get.</desc>
13268	</param>
13269	<param name="value" type="wstring" dir="return">
13270	<desc>Current property value.</desc>
13271	</param>
13272	</method>
13273
13274	<method name="setProperty">
13275	<desc>
13276	Sets the value of the custom medium property with the given name.
13277
13278	The list of all properties supported by the given medium format can
13279	be obtained with <link to="IMediumFormat::describeProperties"/>.
13280
13281	<note>Setting the property value to @c null or an empty string is
13282	equivalent to deleting the existing value. A default value (if it is
13283	defined for this property) will be used by the format backend in this
13284	case.</note>
13285
13286	<result name="VBOX_E_OBJECT_NOT_FOUND">
13287	Requested property does not exist (not supported by the format).
13288	</result>
13289	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13290	</desc>
13291	<param name="name" type="wstring" dir="in">
13292	<desc>Name of the property to set.</desc>
13293	</param>
13294	<param name="value" type="wstring" dir="in">
13295	<desc>Property value to set.</desc>
13296	</param>
13297	</method>
13298
13299	<method name="getProperties" const="yes">
13300	<desc>
13301	Returns values for a group of properties in one call.
13302
13303	The names of the properties to get are specified using the @a names
13304	argument which is a list of comma-separated property names or
13305	an empty string if all properties are to be returned.
13306	<note>Currently the value of this argument is ignored and the method
13307	always returns all existing properties.</note>
13308
13309	The list of all properties supported by the given medium format can
13310	be obtained with <link to="IMediumFormat::describeProperties"/>.
13311
13312	The method returns two arrays, the array of property names corresponding
13313	to the @a names argument and the current values of these properties.
13314	Both arrays have the same number of elements with each element at the
13315	given index in the first array corresponds to an element at the same
13316	index in the second array.
13317
13318	For properties that do not have assigned values, an empty string is
13319	returned at the appropriate index in the @a returnValues array.
13320
13321	</desc>
13322	<param name="names" type="wstring" dir="in">
13323	<desc>
13324	Names of properties to get.
13325	</desc>
13326	</param>
13327	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13328	<desc>Names of returned properties.</desc>
13329	</param>
13330	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13331	<desc>Values of returned properties.</desc>
13332	</param>
13333	</method>
13334
13335	<method name="setProperties">
13336	<desc>
13337	Sets values for a group of properties in one call.
13338
13339	The names of the properties to set are passed in the @a names
13340	array along with the new values for them in the @a values array. Both
13341	arrays have the same number of elements with each element at the given
13342	index in the first array corresponding to an element at the same index
13343	in the second array.
13344
13345	If there is at least one property name in @a names that is not valid,
13346	the method will fail before changing the values of any other properties
13347	from the @a names array.
13348
13349	Using this method over <link to="#setProperty"/> is preferred if you
13350	need to set several properties at once since it is more efficient.
13351
13352	The list of all properties supported by the given medium format can
13353	be obtained with <link to="IMediumFormat::describeProperties"/>.
13354
13355	Setting the property value to @c null or an empty string is equivalent
13356	to deleting the existing value. A default value (if it is defined for
13357	this property) will be used by the format backend in this case.
13358	</desc>
13359	<param name="names" type="wstring" safearray="yes" dir="in">
13360	<desc>Names of properties to set.</desc>
13361	</param>
13362	<param name="values" type="wstring" safearray="yes" dir="in">
13363	<desc>Values of properties to set.</desc>
13364	</param>
13365	</method>
13366
13367	<!-- storage methods -->
13368
13369	<method name="createBaseStorage">
13370	<desc>
13371	Starts creating a hard disk storage unit (fixed/dynamic, according
13372	to the variant flags) in in the background. The previous storage unit
13373	created for this object, if any, must first be deleted using
13374	<link to="#deleteStorage"/>, otherwise the operation will fail.
13375
13376	Before the operation starts, the medium is placed in
13377	<link to="MediumState_Creating"/> state. If the create operation
13378	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
13379	state.
13380
13381	After the returned progress object reports that the operation has
13382	successfully completed, the medium state will be set to <link
13383	to="MediumState_Created"/>, the medium will be remembered by this
13384	VirtualBox installation and may be attached to virtual machines.
13385
13386	<result name="VBOX_E_NOT_SUPPORTED">
13387	The variant of storage creation operation is not supported. See <link
13388	to="IMediumFormat::capabilities"/>.
13389	</result>
13390	</desc>
13391	<param name="logicalSize" type="long long" dir="in">
13392	<desc>Maximum logical size of the medium in bytes.</desc>
13393	</param>
13394	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13395	<desc>Exact image variant which should be created (as a combination of
13396	<link to="MediumVariant" /> flags).</desc>
13397	</param>
13398	<param name="progress" type="IProgress" dir="return">
13399	<desc>Progress object to track the operation completion.</desc>
13400	</param>
13401	</method>
13402
13403	<method name="deleteStorage">
13404	<desc>
13405	Starts deleting the storage unit of this medium.
13406
13407	The medium must not be attached to any known virtual machine and must
13408	not have any known child media, otherwise the operation will fail.
13409	It will also fail if there is no storage unit to delete or if deletion
13410	is already in progress, or if the medium is being in use (locked for
13411	read or for write) or inaccessible. Therefore, the only valid state for
13412	this operation to succeed is <link to="MediumState_Created"/>.
13413
13414	Before the operation starts, the medium is placed in
13415	<link to="MediumState_Deleting"/> state and gets removed from the list
13416	of remembered hard disks (media registry). If the delete operation
13417	fails, the medium will be remembered again and placed back to
13418	<link to="MediumState_Created"/> state.
13419
13420	After the returned progress object reports that the operation is
13421	complete, the medium state will be set to
13422	<link to="MediumState_NotCreated"/> and you will be able to use one of
13423	the storage creation methods to create it again.
13424
13425	<see><link to="#close"/></see>
13426
13427	<result name="VBOX_E_OBJECT_IN_USE">
13428	Medium is attached to a virtual machine.
13429	</result>
13430	<result name="VBOX_E_NOT_SUPPORTED">
13431	Storage deletion is not allowed because neither of storage creation
13432	operations are supported. See
13433	<link to="IMediumFormat::capabilities"/>.
13434	</result>
13435
13436	<note>
13437	If the deletion operation fails, it is not guaranteed that the storage
13438	unit still exists. You may check the <link to="IMedium::state"/> value
13439	to answer this question.
13440	</note>
13441	</desc>
13442	<param name="progress" type="IProgress" dir="return">
13443	<desc>Progress object to track the operation completion.</desc>
13444	</param>
13445	</method>
13446
13447	<!-- diff methods -->
13448
13449	<method name="createDiffStorage">
13450	<desc>
13451	Starts creating an empty differencing storage unit based on this
13452	medium in the format and at the location defined by the @a target
13453	argument.
13454
13455	The target medium must be in <link to="MediumState_NotCreated"/>
13456	state (i.e. must not have an existing storage unit). Upon successful
13457	completion, this operation will set the type of the target medium to
13458	<link to="MediumType_Normal"/> and create a storage unit necessary to
13459	represent the differencing medium data in the given format (according
13460	to the storage format of the target object).
13461
13462	After the returned progress object reports that the operation is
13463	successfully complete, the target medium gets remembered by this
13464	VirtualBox installation and may be attached to virtual machines.
13465
13466	<note>
13467	The medium will be set to <link to="MediumState_LockedRead"/>
13468	state for the duration of this operation.
13469	</note>
13470	<result name="VBOX_E_OBJECT_IN_USE">
13471	Medium not in @c NotCreated state.
13472	</result>
13473	</desc>
13474	<param name="target" type="IMedium" dir="in">
13475	<desc>Target medium.</desc>
13476	</param>
13477	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13478	<desc>Exact image variant which should be created (as a combination of
13479	<link to="MediumVariant" /> flags).</desc>
13480	</param>
13481	<param name="progress" type="IProgress" dir="return">
13482	<desc>Progress object to track the operation completion.</desc>
13483	</param>
13484	</method>
13485
13486	<method name="mergeTo">
13487	<desc>
13488	Starts merging the contents of this medium and all intermediate
13489	differencing media in the chain to the given target medium.
13490
13491	The target medium must be either a descendant of this medium or
13492	its ancestor (otherwise this method will immediately return a failure).
13493	It follows that there are two logical directions of the merge operation:
13494	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13495	ancestor (<i>backward merge</i>). Let us consider the following medium
13496	chain:
13497
13498	<pre>Base <- Diff_1 <- Diff_2</pre>
13499
13500	Here, calling this method on the <tt>Base</tt> medium object with
13501	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13502	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13503	merge. Note that in both cases the contents of the resulting medium
13504	will be the same, the only difference is the medium object that takes
13505	the result of the merge operation. In case of the forward merge in the
13506	above example, the result will be written to <tt>Diff_2</tt>; in case of
13507	the backward merge, the result will be written to <tt>Base</tt>. In
13508	other words, the result of the operation is always stored in the target
13509	medium.
13510
13511	Upon successful operation completion, the storage units of all media in
13512	the chain between this (source) medium and the target medium, including
13513	the source medium itself, will be automatically deleted and the
13514	relevant medium objects (including this medium) will become
13515	uninitialized. This means that any attempt to call any of
13516	their methods or attributes will fail with the
13517	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13518	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13519	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13520	Note that <tt>Diff_2</tt> in this case will become a base medium
13521	itself since it will no longer be based on any other medium.
13522
13523	Considering the above, all of the following conditions must be met in
13524	order for the merge operation to succeed:
13525	<ul>
13526	<li>
13527	Neither this (source) medium nor any intermediate
13528	differencing medium in the chain between it and the target
13529	medium is attached to any virtual machine.
13530	</li>
13531	<li>
13532	Neither the source medium nor the target medium is an
13533	<link to="MediumType_Immutable"/> medium.
13534	</li>
13535	<li>
13536	The part of the medium tree from the source medium to the
13537	target medium is a linear chain, i.e. all medium in this
13538	chain have exactly one child which is the next medium in this
13539	chain. The only exception from this rule is the target medium in
13540	the forward merge operation; it is allowed to have any number of
13541	child media because the merge operation will not change its
13542	logical contents (as it is seen by the guest OS or by children).
13543	</li>
13544	<li>
13545	None of the involved media are in
13546	<link to="MediumState_LockedRead"/> or
13547	<link to="MediumState_LockedWrite"/> state.
13548	</li>
13549	</ul>
13550
13551	<note>
13552	This (source) medium and all intermediates will be placed to <link
13553	to="MediumState_Deleting"/> state and the target medium will be
13554	placed to <link to="MediumState_LockedWrite"/> state and for the
13555	duration of this operation.
13556	</note>
13557	</desc>
13558	<param name="target" type="IMedium" dir="in">
13559	<desc>Target medium.</desc>
13560	</param>
13561	<param name="progress" type="IProgress" dir="return">
13562	<desc>Progress object to track the operation completion.</desc>
13563	</param>
13564	</method>
13565
13566	<!-- clone method -->
13567
13568	<method name="cloneTo">
13569	<desc>
13570	Starts creating a clone of this medium in the format and at the
13571	location defined by the @a target argument.
13572
13573	The target medium must be either in <link to="MediumState_NotCreated"/>
13574	state (i.e. must not have an existing storage unit) or in
13575	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13576	big enough to hold the data or else the copy will be partial). Upon
13577	successful completion, the cloned medium will contain exactly the
13578	same sector data as the medium being cloned, except that in the
13579	first case a new UUID for the clone will be randomly generated, and in
13580	the second case the UUID will remain unchanged.
13581
13582	The @a parent argument defines which medium will be the parent
13583	of the clone. Passing a @c null reference indicates that the clone will
13584	be a base image, i.e. completely independent. It is possible to specify
13585	an arbitrary medium for this parameter, including the parent of the
13586	medium which is being cloned. Even cloning to a child of the source
13587	medium is possible. Note that when cloning to an existing image, the
13588	@a parent argument is ignored.
13589
13590	After the returned progress object reports that the operation is
13591	successfully complete, the target medium gets remembered by this
13592	VirtualBox installation and may be attached to virtual machines.
13593
13594	<note>
13595	This medium will be placed to <link to="MediumState_LockedRead"/>
13596	state for the duration of this operation.
13597	</note>
13598	<result name="E_NOTIMPL">
13599	The specified cloning variant is not supported at the moment.
13600	</result>
13601	</desc>
13602	<param name="target" type="IMedium" dir="in">
13603	<desc>Target medium.</desc>
13604	</param>
13605	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13606	<desc>Exact image variant which should be created (as a combination of
13607	<link to="MediumVariant" /> flags).</desc>
13608	</param>
13609	<param name="parent" type="IMedium" dir="in">
13610	<desc>Parent of the cloned medium.</desc>
13611	</param>
13612	<param name="progress" type="IProgress" dir="return">
13613	<desc>Progress object to track the operation completion.</desc>
13614	</param>
13615	</method>
13616
13617	<method name="cloneToBase">
13618	<desc>
13619	Starts creating a clone of this medium in the format and at the
13620	location defined by the @a target argument.
13621
13622	The target medium must be either in <link to="MediumState_NotCreated"/>
13623	state (i.e. must not have an existing storage unit) or in
13624	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13625	big enough to hold the data or else the copy will be partial). Upon
13626	successful completion, the cloned medium will contain exactly the
13627	same sector data as the medium being cloned, except that in the
13628	first case a new UUID for the clone will be randomly generated, and in
13629	the second case the UUID will remain unchanged.
13630
13631	The @a parent argument defines which medium will be the parent
13632	of the clone. In this case the clone will be a base image, i.e.
13633	completely independent. It is possible to specify an arbitrary
13634	medium for this parameter, including the parent of the
13635	medium which is being cloned. Even cloning to a child of the source
13636	medium is possible. Note that when cloning to an existing image, the
13637	@a parent argument is ignored.
13638
13639	After the returned progress object reports that the operation is
13640	successfully complete, the target medium gets remembered by this
13641	VirtualBox installation and may be attached to virtual machines.
13642
13643	<note>
13644	This medium will be placed to <link to="MediumState_LockedRead"/>
13645	state for the duration of this operation.
13646	</note>
13647	<result name="E_NOTIMPL">
13648	The specified cloning variant is not supported at the moment.
13649	</result>
13650	</desc>
13651	<param name="target" type="IMedium" dir="in">
13652	<desc>Target medium.</desc>
13653	</param>
13654	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13655	<desc><link to="MediumVariant" /> flags).</desc>
13656	</param>
13657	<param name="progress" type="IProgress" dir="return">
13658	<desc>Progress object to track the operation completion.</desc>
13659	</param>
13660	</method>
13661
13662	<!-- other methods -->
13663
13664	<method name="compact">
13665	<desc>
13666	Starts compacting of this medium. This means that the medium is
13667	transformed into a possibly more compact storage representation.
13668	This potentially creates temporary images, which can require a
13669	substantial amount of additional disk space.
13670
13671	This medium will be placed to <link to="MediumState_LockedWrite"/>
13672	state and all its parent media (if any) will be placed to
13673	<link to="MediumState_LockedRead"/> state for the duration of this
13674	operation.
13675
13676	Please note that the results can be either returned straight away,
13677	or later as the result of the background operation via the object
13678	returned via the @a progress parameter.
13679
13680	<result name="VBOX_E_NOT_SUPPORTED">
13681	Medium format does not support compacting (but potentially
13682	needs it).
13683	</result>
13684	</desc>
13685	<param name="progress" type="IProgress" dir="return">
13686	<desc>Progress object to track the operation completion.</desc>
13687	</param>
13688	</method>
13689
13690	<method name="resize">
13691	<desc>
13692	Starts resizing this medium. This means that the nominal size of the
13693	medium is set to the new value. Both increasing and decreasing the
13694	size is possible, and there are no safety checks, since VirtualBox
13695	does not make any assumptions about the medium contents.
13696
13697	Resizing usually needs additional disk space, and possibly also
13698	some temporary disk space. Note that resize does not create a full
13699	temporary copy of the medium, so the additional disk space requirement
13700	is usually much lower than using the clone operation.
13701
13702	This medium will be placed to <link to="MediumState_LockedWrite"/>
13703	state for the duration of this operation.
13704
13705	Please note that the results can be either returned straight away,
13706	or later as the result of the background operation via the object
13707	returned via the @a progress parameter.
13708
13709	<result name="VBOX_E_NOT_SUPPORTED">
13710	Medium format does not support resizing.
13711	</result>
13712	</desc>
13713	<param name="logicalSize" type="long long" dir="in">
13714	<desc>New nominal capacity of the medium in bytes.</desc>
13715	</param>
13716	<param name="progress" type="IProgress" dir="return">
13717	<desc>Progress object to track the operation completion.</desc>
13718	</param>
13719	</method>
13720
13721	<method name="reset">
13722	<desc>
13723	Starts erasing the contents of this differencing medium.
13724
13725	This operation will reset the differencing medium to its initial
13726	state when it does not contain any sector data and any read operation is
13727	redirected to its parent medium. This automatically gets called
13728	during VM power-up for every medium whose <link to="#autoReset" />
13729	attribute is @c true.
13730
13731	The medium will be write-locked for the duration of this operation (see
13732	<link to="#lockWrite" />).
13733
13734	<result name="VBOX_E_NOT_SUPPORTED">
13735	This is not a differencing medium.
13736	</result>
13737	<result name="VBOX_E_INVALID_OBJECT_STATE">
13738	Medium is not in <link to="MediumState_Created"/> or
13739	<link to="MediumState_Inaccessible"/> state.
13740	</result>
13741	</desc>
13742	<param name="progress" type="IProgress" dir="return">
13743	<desc>Progress object to track the operation completion.</desc>
13744	</param>
13745	</method>
13746
13747	</interface>
13748
13749
13750	<!--
13751	// IMediumFormat
13752	/////////////////////////////////////////////////////////////////////////
13753	-->
13754
13755	<enum
13756	name="DataType"
13757	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13758	>
13759	<const name="Int32" value="0"/>
13760	<const name="Int8" value="1"/>
13761	<const name="String" value="2"/>
13762	</enum>
13763
13764	<enum
13765	name="DataFlags"
13766	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13767	>
13768	<const name="None" value="0x00"/>
13769	<const name="Mandatory" value="0x01"/>
13770	<const name="Expert" value="0x02"/>
13771	<const name="Array" value="0x04"/>
13772	<const name="FlagMask" value="0x07"/>
13773	</enum>
13774
13775	<enum
13776	name="MediumFormatCapabilities"
13777	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13778	>
13779	<desc>
13780	Medium format capability flags.
13781	</desc>
13782
13783	<const name="Uuid" value="0x01">
13784	<desc>
13785	Supports UUIDs as expected by VirtualBox code.
13786	</desc>
13787	</const>
13788
13789	<const name="CreateFixed" value="0x02">
13790	<desc>
13791	Supports creating fixed size images, allocating all space instantly.
13792	</desc>
13793	</const>
13794
13795	<const name="CreateDynamic" value="0x04">
13796	<desc>
13797	Supports creating dynamically growing images, allocating space on
13798	demand.
13799	</desc>
13800	</const>
13801
13802	<const name="CreateSplit2G" value="0x08">
13803	<desc>
13804	Supports creating images split in chunks of a bit less than 2 GBytes.
13805	</desc>
13806	</const>
13807
13808	<const name="Differencing" value="0x10">
13809	<desc>
13810	Supports being used as a format for differencing media (see <link
13811	to="IMedium::createDiffStorage"/>).
13812	</desc>
13813	</const>
13814
13815	<const name="Asynchronous" value="0x20">
13816	<desc>
13817	Supports asynchronous I/O operations for at least some configurations.
13818	</desc>
13819	</const>
13820
13821	<const name="File" value="0x40">
13822	<desc>
13823	The format backend operates on files (the <link to="IMedium::location"/>
13824	attribute of the medium specifies a file used to store medium
13825	data; for a list of supported file extensions see
13826	<link to="IMediumFormat::describeFileExtensions"/>).
13827	</desc>
13828	</const>
13829
13830	<const name="Properties" value="0x80">
13831	<desc>
13832	The format backend uses the property interface to configure the storage
13833	location and properties (the <link to="IMediumFormat::describeProperties"/>
13834	method is used to get access to properties supported by the given medium format).
13835	</desc>
13836	</const>
13837
13838	<const name="TcpNetworking" value="0x100">
13839	<desc>
13840	The format backend uses the TCP networking interface for network access.
13841	</desc>
13842	</const>
13843
13844	<const name="VFS" value="0x200">
13845	<desc>
13846	The format backend supports virtual filesystem functionality.
13847	</desc>
13848	</const>
13849
13850	<const name="CapabilityMask" value="0x3FF"/>
13851	</enum>
13852
13853	<interface
13854	name="IMediumFormat" extends="$unknown"
13855	uuid="6238e1cf-a17d-4ec1-8172-418bfb22b93a"
13856	wsmap="managed"
13857	>
13858	<desc>
13859	The IMediumFormat interface represents a medium format.
13860
13861	Each medium format has an associated backend which is used to handle
13862	media stored in this format. This interface provides information
13863	about the properties of the associated backend.
13864
13865	Each medium format is identified by a string represented by the
13866	<link to="#id"/> attribute. This string is used in calls like
13867	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13868	format.
13869
13870	The list of all supported medium formats can be obtained using
13871	<link to="ISystemProperties::mediumFormats"/>.
13872
13873	<see><link to="IMedium"/></see>
13874	</desc>
13875
13876	<attribute name="id" type="wstring" readonly="yes">
13877	<desc>
13878	Identifier of this format.
13879
13880	The format identifier is a non-@c null non-empty ASCII string. Note that
13881	this string is case-insensitive. This means that, for example, all of
13882	the following strings:
13883	<pre>
13884	"VDI"
13885	"vdi"
13886	"VdI"</pre>
13887	refer to the same medium format.
13888
13889	This string is used in methods of other interfaces where it is necessary
13890	to specify a medium format, such as
13891	<link to="IVirtualBox::createHardDisk"/>.
13892	</desc>
13893	</attribute>
13894
13895	<attribute name="name" type="wstring" readonly="yes">
13896	<desc>
13897	Human readable description of this format.
13898
13899	Mainly for use in file open dialogs.
13900	</desc>
13901	</attribute>
13902
13903	<attribute name="capabilities" type="MediumFormatCapabilities" safearray="yes" readonly="yes">
13904	<desc>
13905	Capabilities of the format as an array of the flags.
13906
13907	For the meaning of individual capability flags see
13908	<link to="MediumFormatCapabilities"/>.
13909	</desc>
13910	</attribute>
13911
13912	<method name="describeFileExtensions">
13913	<desc>
13914	Returns two arrays describing the supported file extensions.
13915
13916	The first array contains the supported extensions and the seconds one
13917	the type each extension supports. Both have the same size.
13918
13919	Note that some backends do not work on files, so this array may be
13920	empty.
13921
13922	<see><link to="IMediumFormat::capabilities"/></see>
13923	</desc>
13924	<param name="extensions" type="wstring" safearray="yes" dir="out">
13925	<desc>The array of supported extensions.</desc>
13926	</param>
13927	<param name="types" type="DeviceType" safearray="yes" dir="out">
13928	<desc>The array which indicates the device type for every given extension.</desc>
13929	</param>
13930	</method>
13931
13932	<method name="describeProperties" const="yes">
13933	<desc>
13934	Returns several arrays describing the properties supported by this
13935	format.
13936
13937	An element with the given index in each array describes one
13938	property. Thus, the number of elements in each returned array is the
13939	same and corresponds to the number of supported properties.
13940
13941	The returned arrays are filled in only if the
13942	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13943	All arguments must be non-@c null.
13944
13945	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13946	</desc>
13947
13948	<param name="names" type="wstring" safearray="yes" dir="out">
13949	<desc>Array of property names.</desc>
13950	</param>
13951	<param name="descriptions" type="wstring" safearray="yes" dir="out">
13952	<desc>Array of property descriptions.</desc>
13953	</param>
13954	<param name="types" type="DataType" safearray="yes" dir="out">
13955	<desc>Array of property types.</desc>
13956	</param>
13957	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13958	<desc>Array of property flags.</desc>
13959	</param>
13960	<param name="defaults" type="wstring" safearray="yes" dir="out">
13961	<desc>Array of default property values.</desc>
13962	</param>
13963	</method>
13964
13965	</interface>
13966
13967
13968	<!--
13969	// IKeyboard
13970	/////////////////////////////////////////////////////////////////////////
13971	-->
13972
13973	<interface
13974	name="IKeyboard" extends="$unknown"
13975	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13976	wsmap="managed"
13977	>
13978	<desc>
13979	The IKeyboard interface represents the virtual machine's keyboard. Used
13980	in <link to="IConsole::keyboard"/>.
13981
13982	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13983	to the virtual machine.
13984
13985	</desc>
13986	<method name="putScancode">
13987	<desc>Sends a scancode to the keyboard.
13988
13989	<result name="VBOX_E_IPRT_ERROR">
13990	Could not send scan code to virtual keyboard.
13991	</result>
13992
13993	</desc>
13994	<param name="scancode" type="long" dir="in"/>
13995	</method>
13996
13997	<method name="putScancodes">
13998	<desc>Sends an array of scancodes to the keyboard.
13999
14000	<result name="VBOX_E_IPRT_ERROR">
14001	Could not send all scan codes to virtual keyboard.
14002	</result>
14003
14004	</desc>
14005	<param name="scancodes" type="long" dir="in" safearray="yes"/>
14006	<param name="codesStored" type="unsigned long" dir="return"/>
14007	</method>
14008
14009	<method name="putCAD">
14010	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
14011	function is nothing special, it is just a convenience function
14012	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
14013
14014	<result name="VBOX_E_IPRT_ERROR">
14015	Could not send all scan codes to virtual keyboard.
14016	</result>
14017
14018	</desc>
14019	</method>
14020
14021	<attribute name="eventSource" type="IEventSource" readonly="yes">
14022	<desc>
14023	Event source for keyboard events.
14024	</desc>
14025	</attribute>
14026
14027	</interface>
14028
14029
14030	<!--
14031	// IMouse
14032	/////////////////////////////////////////////////////////////////////////
14033	-->
14034
14035	<enum
14036	name="MouseButtonState"
14037	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
14038	>
14039	<desc>
14040	Mouse button state.
14041	</desc>
14042
14043	<const name="LeftButton" value="0x01"/>
14044	<const name="RightButton" value="0x02"/>
14045	<const name="MiddleButton" value="0x04"/>
14046	<const name="WheelUp" value="0x08"/>
14047	<const name="WheelDown" value="0x10"/>
14048	<const name="XButton1" value="0x20"/>
14049	<const name="XButton2" value="0x40"/>
14050	<const name="MouseStateMask" value="0x7F"/>
14051	</enum>
14052
14053	<interface
14054	name="IMouse" extends="$unknown"
14055	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
14056	wsmap="managed"
14057	>
14058	<desc>
14059	The IMouse interface represents the virtual machine's mouse. Used in
14060	<link to="IConsole::mouse"/>.
14061
14062	Through this interface, the virtual machine's virtual mouse can be
14063	controlled.
14064	</desc>
14065
14066	<attribute name="absoluteSupported" type="boolean" readonly="yes">
14067	<desc>
14068	Whether the guest OS supports absolute mouse pointer positioning
14069	or not.
14070	<note>
14071	You can use the <link to="IMouseCapabilityChangedEvent"/>
14072	event to be instantly informed about changes of this attribute
14073	during virtual machine execution.
14074	</note>
14075	<see><link to="#putMouseEventAbsolute"/></see>
14076	</desc>
14077	</attribute>
14078
14079	<attribute name="relativeSupported" type="boolean" readonly="yes">
14080	<desc>
14081	Whether the guest OS supports relative mouse pointer positioning
14082	or not.
14083	<note>
14084	You can use the <link to="IMouseCapabilityChangedEvent"/>
14085	event to be instantly informed about changes of this attribute
14086	during virtual machine execution.
14087	</note>
14088	<see><link to="#putMouseEvent"/></see>
14089	</desc>
14090	</attribute>
14091
14092	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14093	<desc>
14094	Whether the guest OS can currently switch to drawing it's own mouse
14095	cursor on demand.
14096	<note>
14097	You can use the <link to="IMouseCapabilityChangedEvent"/>
14098	event to be instantly informed about changes of this attribute
14099	during virtual machine execution.
14100	</note>
14101	<see><link to="#putMouseEvent"/></see>
14102	</desc>
14103	</attribute>
14104
14105	<method name="putMouseEvent">
14106	<desc>
14107	Initiates a mouse event using relative pointer movements
14108	along x and y axis.
14109
14110	<result name="E_ACCESSDENIED">
14111	Console not powered up.
14112	</result>
14113	<result name="VBOX_E_IPRT_ERROR">
14114	Could not send mouse event to virtual mouse.
14115	</result>
14116
14117	</desc>
14118
14119	<param name="dx" type="long" dir="in">
14120	<desc>
14121	Amount of pixels the mouse should move to the right.
14122	Negative values move the mouse to the left.
14123	</desc>
14124	</param>
14125	<param name="dy" type="long" dir="in">
14126	<desc>
14127	Amount of pixels the mouse should move downwards.
14128	Negative values move the mouse upwards.
14129	</desc>
14130	</param>
14131	<param name="dz" type="long" dir="in">
14132	<desc>
14133	Amount of mouse wheel moves.
14134	Positive values describe clockwise wheel rotations,
14135	negative values describe counterclockwise rotations.
14136	</desc>
14137	</param>
14138	<param name="dw" type="long" dir="in">
14139	<desc>
14140	Amount of horizontal mouse wheel moves.
14141	Positive values describe a movement to the left,
14142	negative values describe a movement to the right.
14143	</desc>
14144	</param>
14145	<param name="buttonState" type="long" dir="in">
14146	<desc>
14147	The current state of mouse buttons. Every bit represents
14148	a mouse button as follows:
14149	<table>
14150	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14151	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14152	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14153	</table>
14154	A value of <tt>1</tt> means the corresponding button is pressed.
14155	otherwise it is released.
14156	</desc>
14157	</param>
14158	</method>
14159
14160	<method name="putMouseEventAbsolute">
14161	<desc>
14162	Positions the mouse pointer using absolute x and y coordinates.
14163	These coordinates are expressed in pixels and
14164	start from <tt>[1,1]</tt> which corresponds to the top left
14165	corner of the virtual display.
14166
14167	<result name="E_ACCESSDENIED">
14168	Console not powered up.
14169	</result>
14170	<result name="VBOX_E_IPRT_ERROR">
14171	Could not send mouse event to virtual mouse.
14172	</result>
14173
14174	<note>
14175	This method will have effect only if absolute mouse
14176	positioning is supported by the guest OS.
14177	</note>
14178
14179	<see><link to="#absoluteSupported"/></see>
14180	</desc>
14181
14182	<param name="x" type="long" dir="in">
14183	<desc>
14184	X coordinate of the pointer in pixels, starting from @c 1.
14185	</desc>
14186	</param>
14187	<param name="y" type="long" dir="in">
14188	<desc>
14189	Y coordinate of the pointer in pixels, starting from @c 1.
14190	</desc>
14191	</param>
14192	<param name="dz" type="long" dir="in">
14193	<desc>
14194	Amount of mouse wheel moves.
14195	Positive values describe clockwise wheel rotations,
14196	negative values describe counterclockwise rotations.
14197	</desc>
14198	</param>
14199	<param name="dw" type="long" dir="in">
14200	<desc>
14201	Amount of horizontal mouse wheel moves.
14202	Positive values describe a movement to the left,
14203	negative values describe a movement to the right.
14204	</desc>
14205	</param>
14206	<param name="buttonState" type="long" dir="in">
14207	<desc>
14208	The current state of mouse buttons. Every bit represents
14209	a mouse button as follows:
14210	<table>
14211	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
14212	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
14213	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
14214	</table>
14215	A value of @c 1 means the corresponding button is pressed.
14216	otherwise it is released.
14217	</desc>
14218	</param>
14219	</method>
14220
14221	<attribute name="eventSource" type="IEventSource" readonly="yes">
14222	<desc>
14223	Event source for mouse events.
14224	</desc>
14225	</attribute>
14226
14227	</interface>
14228
14229	<!--
14230	// IDisplay
14231	/////////////////////////////////////////////////////////////////////////
14232	-->
14233
14234	<enum
14235	name="FramebufferPixelFormat"
14236	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
14237	>
14238	<desc>
14239	Format of the video memory buffer. Constants represented by this enum can
14240	be used to test for particular values of <link
14241	to="IFramebuffer::pixelFormat"/>. See also <link
14242	to="IFramebuffer::requestResize"/>.
14243
14244	See also www.fourcc.org for more information about FOURCC pixel formats.
14245	</desc>
14246
14247	<const name="Opaque" value="0">
14248	<desc>
14249	Unknown buffer format (the user may not assume any particular format of
14250	the buffer).
14251	</desc>
14252	</const>
14253	<const name="FOURCC_RGB" value="0x32424752">
14254	<desc>
14255	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
14256	bit layout).
14257	</desc>
14258	</const>
14259	</enum>
14260
14261	<interface
14262	name="IFramebuffer" extends="$unknown"
14263	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
14264	wsmap="suppress"
14265	>
14266	<attribute name="address" type="octet" mod="ptr" readonly="yes">
14267	<desc>Address of the start byte of the frame buffer.</desc>
14268	</attribute>
14269
14270	<attribute name="width" type="unsigned long" readonly="yes">
14271	<desc>Frame buffer width, in pixels.</desc>
14272	</attribute>
14273
14274	<attribute name="height" type="unsigned long" readonly="yes">
14275	<desc>Frame buffer height, in pixels.</desc>
14276	</attribute>
14277
14278	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
14279	<desc>
14280	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
14281	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
14282	are: 8, 15, 16, 24 and 32.
14283	</desc>
14284	</attribute>
14285
14286	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
14287	<desc>
14288	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
14289	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
14290	size of the scan line must be aligned to 32 bits.
14291	</desc>
14292	</attribute>
14293
14294	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
14295	<desc>
14296	Frame buffer pixel format. It's either one of the values defined by <link
14297	to="FramebufferPixelFormat"/> or a raw FOURCC code.
14298	<note>
14299	This attribute must never return <link
14300	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
14301	<link to="#address"/> points to must be always known.
14302	</note>
14303	</desc>
14304	</attribute>
14305
14306	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
14307	<desc>
14308	Defines whether this frame buffer uses the virtual video card's memory
14309	buffer (guest VRAM) directly or not. See <link
14310	to="IFramebuffer::requestResize"/> for more information.
14311	</desc>
14312	</attribute>
14313
14314	<attribute name="heightReduction" type="unsigned long" readonly="yes">
14315	<desc>
14316	Hint from the frame buffer about how much of the standard
14317	screen height it wants to use for itself. This information is
14318	exposed to the guest through the VESA BIOS and VMMDev interface
14319	so that it can use it for determining its video mode table. It
14320	is not guaranteed that the guest respects the value.
14321	</desc>
14322	</attribute>
14323
14324	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
14325	<desc>
14326	An alpha-blended overlay which is superposed over the frame buffer.
14327	The initial purpose is to allow the display of icons providing
14328	information about the VM state, including disk activity, in front
14329	ends which do not have other means of doing that. The overlay is
14330	designed to controlled exclusively by IDisplay. It has no locking
14331	of its own, and any changes made to it are not guaranteed to be
14332	visible until the affected portion of IFramebuffer is updated. The
14333	overlay can be created lazily the first time it is requested. This
14334	attribute can also return @c null to signal that the overlay is not
14335	implemented.
14336	</desc>
14337	</attribute>
14338
14339	<attribute name="winId" type="long long" readonly="yes">
14340	<desc>
14341	Platform-dependent identifier of the window where context of this
14342	frame buffer is drawn, or zero if there's no such window.
14343	</desc>
14344	</attribute>
14345
14346	<method name="lock">
14347	<desc>
14348	Locks the frame buffer.
14349	Gets called by the IDisplay object where this frame buffer is
14350	bound to.
14351	</desc>
14352	</method>
14353
14354	<method name="unlock">
14355	<desc>
14356	Unlocks the frame buffer.
14357	Gets called by the IDisplay object where this frame buffer is
14358	bound to.
14359	</desc>
14360	</method>
14361
14362	<method name="notifyUpdate">
14363	<desc>
14364	Informs about an update.
14365	Gets called by the display object where this buffer is
14366	registered.
14367	</desc>
14368	<param name="x" type="unsigned long" dir="in"/>
14369	<param name="y" type="unsigned long" dir="in"/>
14370	<param name="width" type="unsigned long" dir="in"/>
14371	<param name="height" type="unsigned long" dir="in"/>
14372	</method>
14373
14374	<method name="requestResize">
14375	<desc>
14376	Requests a size and pixel format change.
14377
14378	There are two modes of working with the video buffer of the virtual
14379	machine. The <i>indirect</i> mode implies that the IFramebuffer
14380	implementation allocates a memory buffer for the requested display mode
14381	and provides it to the virtual machine. In <i>direct</i> mode, the
14382	IFramebuffer implementation uses the memory buffer allocated and owned
14383	by the virtual machine. This buffer represents the video memory of the
14384	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
14385	usually faster because the implementation gets a raw pointer to the
14386	guest VRAM buffer which it can directly use for visualizing the contents
14387	of the virtual display, as opposed to the indirect mode where the
14388	contents of guest VRAM are copied to the memory buffer provided by
14389	the implementation every time a display update occurs.
14390
14391	It is important to note that the direct mode is really fast only when
14392	the implementation uses the given guest VRAM buffer directly, for
14393	example, by blitting it to the window representing the virtual machine's
14394	display, which saves at least one copy operation comparing to the
14395	indirect mode. However, using the guest VRAM buffer directly is not
14396	always possible: the format and the color depth of this buffer may be
14397	not supported by the target window, or it may be unknown (opaque) as in
14398	case of text or non-linear multi-plane VGA video modes. In this case,
14399	the indirect mode (that is always available) should be used as a
14400	fallback: when the guest VRAM contents are copied to the
14401	implementation-provided memory buffer, color and format conversion is
14402	done automatically by the underlying code.
14403
14404	The @a pixelFormat parameter defines whether the direct mode is
14405	available or not. If @a pixelFormat is <link
14406	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
14407	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
14408	@a bytesPerLine parameters must be ignored and the implementation must use
14409	the indirect mode (where it provides its own buffer in one of the
14410	supported formats). In all other cases, @a pixelFormat together with
14411	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
14412	buffer pointed to by the @a VRAM parameter and the implementation is
14413	free to choose which mode to use. To indicate that this frame buffer uses
14414	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
14415	attribute must return @c true and <link to="#address"/> must
14416	return exactly the same address that is passed in the @a VRAM parameter
14417	of this method; otherwise it is assumed that the indirect strategy is
14418	chosen.
14419
14420	The @a width and @a height parameters represent the size of the
14421	requested display mode in both modes. In case of indirect mode, the
14422	provided memory buffer should be big enough to store data of the given
14423	display mode. In case of direct mode, it is guaranteed that the given
14424	@a VRAM buffer contains enough space to represent the display mode of the
14425	given size. Note that this frame buffer's <link to="#width"/> and <link
14426	to="#height"/> attributes must return exactly the same values as
14427	passed to this method after the resize is completed (see below).
14428
14429	The @a finished output parameter determines if the implementation has
14430	finished resizing the frame buffer or not. If, for some reason, the
14431	resize cannot be finished immediately during this call, @a finished
14432	must be set to @c false, and the implementation must call
14433	<link to="IDisplay::resizeCompleted"/> after it has returned from
14434	this method as soon as possible. If @a finished is @c false, the
14435	machine will not call any frame buffer methods until
14436	<link to="IDisplay::resizeCompleted"/> is called.
14437
14438	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14439	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14440	this frame buffer must return exactly the same values as specified in the
14441	parameters of this method, after the resize is completed. If the
14442	indirect mode is chosen, these attributes must return values describing
14443	the format of the implementation's own memory buffer <link
14444	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14445	value must always correlate with <link to="#pixelFormat"/>. Note that
14446	the <link to="#pixelFormat"/> attribute must never return <link
14447	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14448
14449	<note>
14450	This method is called by the IDisplay object under the
14451	<link to="#lock"/> provided by this IFramebuffer
14452	implementation. If this method returns @c false in @a finished, then
14453	this lock is not released until
14454	<link to="IDisplay::resizeCompleted"/> is called.
14455	</note>
14456	</desc>
14457	<param name="screenId" type="unsigned long" dir="in">
14458	<desc>
14459	Logical screen number. Must be used in the corresponding call to
14460	<link to="IDisplay::resizeCompleted"/> if this call is made.
14461	</desc>
14462	</param>
14463	<param name="pixelFormat" type="unsigned long" dir="in">
14464	<desc>
14465	Pixel format of the memory buffer pointed to by @a VRAM.
14466	See also <link to="FramebufferPixelFormat"/>.
14467	</desc>
14468	</param>
14469	<param name="VRAM" type="octet" mod="ptr" dir="in">
14470	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14471	</param>
14472	<param name="bitsPerPixel" type="unsigned long" dir="in">
14473	<desc>Color depth, bits per pixel.</desc>
14474	</param>
14475	<param name="bytesPerLine" type="unsigned long" dir="in">
14476	<desc>Size of one scan line, in bytes.</desc>
14477	</param>
14478	<param name="width" type="unsigned long" dir="in">
14479	<desc>Width of the guest display, in pixels.</desc>
14480	</param>
14481	<param name="height" type="unsigned long" dir="in">
14482	<desc>Height of the guest display, in pixels.</desc>
14483	</param>
14484	<param name="finished" type="boolean" dir="return">
14485	<desc>
14486	Can the VM start using the new frame buffer immediately
14487	after this method returns or it should wait for
14488	<link to="IDisplay::resizeCompleted"/>.
14489	</desc>
14490	</param>
14491	</method>
14492
14493	<method name="videoModeSupported">
14494	<desc>
14495	Returns whether the frame buffer implementation is willing to
14496	support a given video mode. In case it is not able to render
14497	the video mode (or for some reason not willing), it should
14498	return @c false. Usually this method is called when the guest
14499	asks the VMM device whether a given video mode is supported
14500	so the information returned is directly exposed to the guest.
14501	It is important that this method returns very quickly.
14502	</desc>
14503	<param name="width" type="unsigned long" dir="in"/>
14504	<param name="height" type="unsigned long" dir="in"/>
14505	<param name="bpp" type="unsigned long" dir="in"/>
14506	<param name="supported" type="boolean" dir="return"/>
14507	</method>
14508
14509	<method name="getVisibleRegion">
14510	<desc>
14511	Returns the visible region of this frame buffer.
14512
14513	If the @a rectangles parameter is @c null then the value of the
14514	@a count parameter is ignored and the number of elements necessary to
14515	describe the current visible region is returned in @a countCopied.
14516
14517	If @a rectangles is not @c null but @a count is less
14518	than the required number of elements to store region data, the method
14519	will report a failure. If @a count is equal or greater than the
14520	required number of elements, then the actual number of elements copied
14521	to the provided array will be returned in @a countCopied.
14522
14523	<note>
14524	The address of the provided array must be in the process space of
14525	this IFramebuffer object.
14526	</note>
14527	<note>
14528	Method not yet implemented.
14529	</note>
14530	</desc>
14531	<param name="rectangles" type="octet" mod="ptr" dir="in">
14532	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14533	</param>
14534	<param name="count" type="unsigned long" dir="in">
14535	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14536	</param>
14537	<param name="countCopied" type="unsigned long" dir="return">
14538	<desc>Number of elements copied to the @a rectangles array.</desc>
14539	</param>
14540	</method>
14541
14542	<method name="setVisibleRegion">
14543	<desc>
14544	Suggests a new visible region to this frame buffer. This region
14545	represents the area of the VM display which is a union of regions of
14546	all top-level windows of the guest operating system running inside the
14547	VM (if the Guest Additions for this system support this
14548	functionality). This information may be used by the frontends to
14549	implement the seamless desktop integration feature.
14550
14551	<note>
14552	The address of the provided array must be in the process space of
14553	this IFramebuffer object.
14554	</note>
14555	<note>
14556	The IFramebuffer implementation must make a copy of the provided
14557	array of rectangles.
14558	</note>
14559	<note>
14560	Method not yet implemented.
14561	</note>
14562	</desc>
14563	<param name="rectangles" type="octet" mod="ptr" dir="in">
14564	<desc>Pointer to the @c RTRECT array.</desc>
14565	</param>
14566	<param name="count" type="unsigned long" dir="in">
14567	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14568	</param>
14569	</method>
14570
14571	<method name="processVHWACommand">
14572	<desc>
14573	Posts a Video HW Acceleration Command to the frame buffer for processing.
14574	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14575	are posted from quest to the host to be processed by the host hardware.
14576
14577	<note>
14578	The address of the provided command must be in the process space of
14579	this IFramebuffer object.
14580	</note>
14581	</desc>
14582
14583	<param name="command" type="octet" mod="ptr" dir="in">
14584	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14585	</param>
14586	</method>
14587
14588	</interface>
14589
14590	<interface
14591	name="IFramebufferOverlay" extends="IFramebuffer"
14592	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14593	wsmap="suppress"
14594	>
14595	<desc>
14596	The IFramebufferOverlay interface represents an alpha blended overlay
14597	for displaying status icons above an IFramebuffer. It is always created
14598	not visible, so that it must be explicitly shown. It only covers a
14599	portion of the IFramebuffer, determined by its width, height and
14600	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14601	that order) format, and may be written to directly. Do re-read the
14602	width though, after setting it, as it may be adjusted (increased) to
14603	make it more suitable for the front end.
14604	</desc>
14605	<attribute name="x" type="unsigned long" readonly="yes">
14606	<desc>X position of the overlay, relative to the frame buffer.</desc>
14607	</attribute>
14608
14609	<attribute name="y" type="unsigned long" readonly="yes">
14610	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14611	</attribute>
14612
14613	<attribute name="visible" type="boolean">
14614	<desc>
14615	Whether the overlay is currently visible.
14616	</desc>
14617	</attribute>
14618
14619	<attribute name="alpha" type="unsigned long">
14620	<desc>
14621	The global alpha value for the overlay. This may or may not be
14622	supported by a given front end.
14623	</desc>
14624	</attribute>
14625
14626	<method name="move">
14627	<desc>
14628	Changes the overlay's position relative to the IFramebuffer.
14629	</desc>
14630	<param name="x" type="unsigned long" dir="in"/>
14631	<param name="y" type="unsigned long" dir="in"/>
14632	</method>
14633
14634	</interface>
14635
14636	<interface
14637	name="IDisplay" extends="$unknown"
14638	uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14639	wsmap="managed"
14640	>
14641	<desc>
14642	The IDisplay interface represents the virtual machine's display.
14643
14644	The object implementing this interface is contained in each
14645	<link to="IConsole::display"/> attribute and represents the visual
14646	output of the virtual machine.
14647
14648	The virtual display supports pluggable output targets represented by the
14649	IFramebuffer interface. Examples of the output target are a window on
14650	the host computer or an RDP session's display on a remote computer.
14651	</desc>
14652	<method name="getScreenResolution">
14653	<desc>Queries display width, height and color depth for given screen.</desc>
14654	<param name="screenId" type="unsigned long" dir="in"/>
14655	<param name="width" type="unsigned long" dir="out"/>
14656	<param name="height" type="unsigned long" dir="out"/>
14657	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14658	</method>
14659
14660	<method name="setFramebuffer">
14661	<desc>
14662	Sets the framebuffer for given screen.
14663	</desc>
14664	<param name="screenId" type="unsigned long" dir="in"/>
14665	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14666	</method>
14667
14668	<method name="getFramebuffer">
14669	<desc>
14670	Queries the framebuffer for given screen.
14671	</desc>
14672	<param name="screenId" type="unsigned long" dir="in"/>
14673	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14674	<param name="xOrigin" type="long" dir="out"/>
14675	<param name="yOrigin" type="long" dir="out"/>
14676	</method>
14677
14678	<method name="setVideoModeHint">
14679	<desc>
14680	Asks VirtualBox to request the given video mode from
14681	the guest. This is just a hint and it cannot be guaranteed
14682	that the requested resolution will be used. Guest Additions
14683	are required for the request to be seen by guests. The caller
14684	should issue the request and wait for a resolution change and
14685	after a timeout retry.
14686
14687	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14688	parameters means that the corresponding values should be taken from the
14689	current video mode (i.e. left unchanged).
14690
14691	If the guest OS supports multi-monitor configuration then the @a display
14692	parameter specifies the number of the guest display to send the hint to:
14693	@c 0 is the primary display, @c 1 is the first secondary and
14694	so on. If the multi-monitor configuration is not supported, @a display
14695	must be @c 0.
14696
14697	<result name="E_INVALIDARG">
14698	The @a display is not associated with any monitor.
14699	</result>
14700
14701	</desc>
14702	<param name="display" type="unsigned long" dir="in">
14703	<desc>
14704	The number of the guest display to send the hint to.
14705	</desc>
14706	</param>
14707	<param name="enabled" type="boolean" dir="in">
14708	<desc>
14709	@c True, if this guest screen is enabled,
14710	@c False otherwise.
14711	</desc>
14712	</param>
14713	<param name="changeOrigin" type="boolean" dir="in">
14714	<desc>
14715	@c True, if the origin of the guest screen should be changed,
14716	@c False otherwise.
14717	</desc>
14718	</param>
14719	<param name="originX" type="long" dir="in">
14720	<desc>
14721	The X origin of the guest screen.
14722	</desc>
14723	</param>
14724	<param name="originY" type="long" dir="in">
14725	<desc>
14726	The Y origin of the guest screen.
14727	</desc>
14728	</param>
14729	<param name="width" type="unsigned long" dir="in"/>
14730	<param name="height" type="unsigned long" dir="in"/>
14731	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14732	</method>
14733
14734	<method name="setSeamlessMode">
14735	<desc>
14736	Enables or disables seamless guest display rendering (seamless desktop
14737	integration) mode.
14738	<note>
14739	Calling this method has no effect if <link
14740	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14741	does not return @c Active.
14742	</note>
14743	</desc>
14744	<param name="enabled" type="boolean" dir="in"/>
14745	</method>
14746
14747	<method name="takeScreenShot">
14748	<desc>
14749	Takes a screen shot of the requested size and copies it to the
14750	32-bpp buffer allocated by the caller and pointed to by @a address.
14751	A pixel consists of 4 bytes in order: B, G, R, 0.
14752
14753	<note>This API can be used only locally by a VM process through the
14754	COM/XPCOM C++ API as it requires pointer support. It is not
14755	available for scripting langages, Java or any webservice clients.
14756	Unless you are writing a new VM frontend use
14757	<link to="#takeScreenShotToArray" />.
14758	</note>
14759
14760	<result name="E_NOTIMPL">
14761	Feature not implemented.
14762	</result>
14763	<result name="VBOX_E_IPRT_ERROR">
14764	Could not take a screenshot.
14765	</result>
14766
14767	</desc>
14768	<param name="screenId" type="unsigned long" dir="in"/>
14769	<param name="address" type="octet" mod="ptr" dir="in"/>
14770	<param name="width" type="unsigned long" dir="in"/>
14771	<param name="height" type="unsigned long" dir="in"/>
14772	</method>
14773
14774	<method name="takeScreenShotToArray">
14775	<desc>
14776	Takes a guest screen shot of the requested size and returns it as
14777	an array of bytes in uncompressed 32-bit RGBA format.
14778	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14779
14780	This API is slow, but could be the only option to get guest screenshot
14781	for scriptable languages not allowed to manipulate with addresses
14782	directly.
14783
14784	<result name="E_NOTIMPL">
14785	Feature not implemented.
14786	</result>
14787	<result name="VBOX_E_IPRT_ERROR">
14788	Could not take a screenshot.
14789	</result>
14790	</desc>
14791	<param name="screenId" type="unsigned long" dir="in">
14792	<desc>
14793	Monitor to take screenshot from.
14794	</desc>
14795	</param>
14796	<param name="width" type="unsigned long" dir="in">
14797	<desc>
14798	Desired image width.
14799	</desc>
14800	</param>
14801	<param name="height" type="unsigned long" dir="in">
14802	<desc>
14803	Desired image height.
14804	</desc>
14805	</param>
14806	<param name="screenData" type="octet" dir="return" safearray="yes">
14807	<desc>
14808	Array with resulting screen data.
14809	</desc>
14810	</param>
14811	</method>
14812
14813	<method name="takeScreenShotPNGToArray">
14814	<desc>
14815	Takes a guest screen shot of the requested size and returns it as
14816	PNG image in array.
14817
14818	<result name="E_NOTIMPL">
14819	Feature not implemented.
14820	</result>
14821	<result name="VBOX_E_IPRT_ERROR">
14822	Could not take a screenshot.
14823	</result>
14824	</desc>
14825	<param name="screenId" type="unsigned long" dir="in">
14826	<desc>
14827	Monitor to take the screenshot from.
14828	</desc>
14829	</param>
14830	<param name="width" type="unsigned long" dir="in">
14831	<desc>
14832	Desired image width.
14833	</desc>
14834	</param>
14835	<param name="height" type="unsigned long" dir="in">
14836	<desc>
14837	Desired image height.
14838	</desc>
14839	</param>
14840	<param name="screenData" type="octet" dir="return" safearray="yes">
14841	<desc>
14842	Array with resulting screen data.
14843	</desc>
14844	</param>
14845	</method>
14846
14847	<method name="drawToScreen">
14848	<desc>
14849	Draws a 32-bpp image of the specified size from the given buffer
14850	to the given point on the VM display.
14851
14852	<result name="E_NOTIMPL">
14853	Feature not implemented.
14854	</result>
14855	<result name="VBOX_E_IPRT_ERROR">
14856	Could not draw to screen.
14857	</result>
14858
14859	</desc>
14860	<param name="screenId" type="unsigned long" dir="in">
14861	<desc>
14862	Monitor to take the screenshot from.
14863	</desc>
14864	</param>
14865	<param name="address" type="octet" mod="ptr" dir="in">
14866	<desc>
14867	Address to store the screenshot to
14868	</desc>
14869	</param>
14870	<param name="x" type="unsigned long" dir="in">
14871	<desc>
14872	Relative to the screen top left corner.
14873	</desc>
14874	</param>
14875	<param name="y" type="unsigned long" dir="in">
14876	<desc>
14877	Relative to the screen top left corner.
14878	</desc>
14879	</param>
14880	<param name="width" type="unsigned long" dir="in">
14881	<desc>
14882	Desired image width.
14883	</desc>
14884	</param>
14885	<param name="height" type="unsigned long" dir="in">
14886	<desc>
14887	Desired image height.
14888	</desc>
14889	</param>
14890	</method>
14891
14892	<method name="invalidateAndUpdate">
14893	<desc>
14894	Does a full invalidation of the VM display and instructs the VM
14895	to update it.
14896
14897	<result name="VBOX_E_IPRT_ERROR">
14898	Could not invalidate and update screen.
14899	</result>
14900
14901	</desc>
14902	</method>
14903
14904	<method name="resizeCompleted">
14905	<desc>
14906	Signals that a framebuffer has completed the resize operation.
14907
14908	<result name="VBOX_E_NOT_SUPPORTED">
14909	Operation only valid for external frame buffers.
14910	</result>
14911
14912	</desc>
14913	<param name="screenId" type="unsigned long" dir="in"/>
14914	</method>
14915
14916	<method name="completeVHWACommand">
14917	<desc>
14918	Signals that the Video HW Acceleration command has completed.
14919	</desc>
14920
14921	<param name="command" type="octet" mod="ptr" dir="in">
14922	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14923	</param>
14924	</method>
14925
14926	<method name="viewportChanged">
14927	<desc>
14928	Signals that framebuffer window viewport has changed.
14929
14930	<result name="E_INVALIDARG">
14931	The specified viewport data is invalid.
14932	</result>
14933
14934	</desc>
14935
14936	<param name="screenId" type="unsigned long" dir="in">
14937	<desc>
14938	Monitor to take the screenshot from.
14939	</desc>
14940	</param>
14941	<param name="x" type="unsigned long" dir="in">
14942	<desc>
14943	Framebuffer x offset.
14944	</desc>
14945	</param>
14946	<param name="y" type="unsigned long" dir="in">
14947	<desc>
14948	Framebuffer y offset.
14949	</desc>
14950	</param>
14951	<param name="width" type="unsigned long" dir="in">
14952	<desc>
14953	Viewport width.
14954	</desc>
14955	</param>
14956	<param name="height" type="unsigned long" dir="in">
14957	<desc>
14958	Viewport height.
14959	</desc>
14960	</param>
14961	</method>
14962	</interface>
14963
14964	<!--
14965	// INetworkAdapter
14966	/////////////////////////////////////////////////////////////////////////
14967	-->
14968
14969	<enum
14970	name="NetworkAttachmentType"
14971	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14972	>
14973	<desc>
14974	Network attachment type.
14975	</desc>
14976
14977	<const name="Null" value="0">
14978	<desc>Null value, also means "not attached".</desc>
14979	</const>
14980	<const name="NAT" value="1"/>
14981	<const name="Bridged" value="2"/>
14982	<const name="Internal" value="3"/>
14983	<const name="HostOnly" value="4"/>
14984	<const name="Generic" value="5"/>
14985	</enum>
14986
14987	<enum
14988	name="NetworkAdapterType"
14989	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
14990	>
14991	<desc>
14992	Network adapter type.
14993	</desc>
14994
14995	<const name="Null" value="0">
14996	<desc>Null value (never used by the API).</desc>
14997	</const>
14998	<const name="Am79C970A" value="1">
14999	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
15000	</const>
15001	<const name="Am79C973" value="2">
15002	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
15003	</const>
15004	<const name="I82540EM" value="3">
15005	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
15006	</const>
15007	<const name="I82543GC" value="4">
15008	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
15009	</const>
15010	<const name="I82545EM" value="5">
15011	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
15012	</const>
15013	<const name="Virtio" value="6">
15014	<desc>Virtio network device.</desc>
15015	</const>
15016	</enum>
15017
15018	<enum
15019	name="NetworkAdapterPromiscModePolicy"
15020	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
15021	>
15022	<desc>
15023	The promiscuous mode policy of an interface.
15024	</desc>
15025
15026	<const name="Deny" value="1">
15027	<desc>Deny promiscuous mode requests.</desc>
15028	</const>
15029	<const name="AllowNetwork" value="2">
15030	<desc>
15031	Allow promicuous mode, but restrict the scope it to the internal
15032	network so that it only applies to other VMs.
15033	</desc>
15034	</const>
15035	<const name="AllowAll" value="3">
15036	<desc>
15037	Allow promicuous mode, include unrelated traffic going over the wire
15038	and internally on the host.
15039	</desc>
15040	</const>
15041	</enum>
15042
15043	<interface
15044	name="INetworkAdapter" extends="$unknown"
15045	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
15046	wsmap="managed"
15047	>
15048	<desc>
15049	Represents a virtual network adapter that is attached to a virtual machine.
15050	Each virtual machine has a fixed number of network adapter slots with one
15051	instance of this attached to each of them. Call
15052	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
15053	is attached to a given slot in a given machine.
15054
15055	Each network adapter can be in one of five attachment modes, which are
15056	represented by the <link to="NetworkAttachmentType" /> enumeration;
15057	see the <link to="#attachmentType" /> attribute.
15058	</desc>
15059
15060	<attribute name="adapterType" type="NetworkAdapterType">
15061	<desc>
15062	Type of the virtual network adapter. Depending on this value,
15063	VirtualBox will provide a different virtual network hardware
15064	to the guest.
15065	</desc>
15066	</attribute>
15067
15068	<attribute name="slot" type="unsigned long" readonly="yes">
15069	<desc>
15070	Slot number this adapter is plugged into. Corresponds to
15071	the value you pass to <link to="IMachine::getNetworkAdapter"/>
15072	to obtain this instance.
15073	</desc>
15074	</attribute>
15075
15076	<attribute name="enabled" type="boolean">
15077	<desc>
15078	Flag whether the network adapter is present in the
15079	guest system. If disabled, the virtual guest hardware will
15080	not contain this network adapter. Can only be changed when
15081	the VM is not running.
15082	</desc>
15083	</attribute>
15084
15085	<attribute name="MACAddress" type="wstring">
15086	<desc>
15087	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
15088	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
15089	</desc>
15090	</attribute>
15091
15092	<attribute name="attachmentType" type="NetworkAttachmentType">
15093	<desc>
15094	Sets/Gets network attachment type of this network adapter.
15095	</desc>
15096	</attribute>
15097
15098	<attribute name="bridgedInterface" type="wstring">
15099	<desc>
15100	Name of the network interface the VM should be bridged to.
15101	</desc>
15102	</attribute>
15103
15104	<attribute name="hostOnlyInterface" type="wstring">
15105	<desc>
15106	Name of the host only network interface the VM is attached to.
15107	</desc>
15108	</attribute>
15109
15110	<attribute name="internalNetwork" type="wstring">
15111	<desc>
15112	Name of the internal network the VM is attached to.
15113	</desc>
15114	</attribute>
15115
15116	<attribute name="NATNetwork" type="wstring">
15117	<desc>
15118	Name of the NAT network the VM is attached to.
15119	</desc>
15120	</attribute>
15121
15122	<attribute name="genericDriver" type="wstring">
15123	<desc>
15124	Name of the driver to use for the "Generic" network attachment type.
15125	</desc>
15126	</attribute>
15127
15128	<attribute name="cableConnected" type="boolean">
15129	<desc>
15130	Flag whether the adapter reports the cable as connected or not.
15131	It can be used to report offline situations to a VM.
15132	</desc>
15133	</attribute>
15134
15135	<attribute name="lineSpeed" type="unsigned long">
15136	<desc>
15137	Line speed reported by custom drivers, in units of 1 kbps.
15138	</desc>
15139	</attribute>
15140
15141	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
15142	<desc>
15143	The promiscuous mode policy of the network adapter when attached to an
15144	internal network, host only network or a bridge.
15145	</desc>
15146	</attribute>
15147
15148	<attribute name="traceEnabled" type="boolean">
15149	<desc>
15150	Flag whether network traffic from/to the network card should be traced.
15151	Can only be toggled when the VM is turned off.
15152	</desc>
15153	</attribute>
15154
15155	<attribute name="traceFile" type="wstring">
15156	<desc>
15157	Filename where a network trace will be stored. If not set, VBox-pid.pcap
15158	will be used.
15159	</desc>
15160	</attribute>
15161
15162	<attribute name="NATEngine" type="INATEngine" readonly="yes">
15163	<desc>
15164	Points to the NAT engine which handles the network address translation
15165	for this interface. This is active only when the interface actually uses
15166	NAT.
15167	</desc>
15168	</attribute>
15169
15170	<attribute name="bootPriority" type="unsigned long">
15171	<desc>
15172	Network boot priority of the adapter. Priority 1 is highest. If not set,
15173	the priority is considered to be at the lowest possible setting.
15174	</desc>
15175	</attribute>
15176
15177	<attribute name="bandwidthGroup" type="IBandwidthGroup">
15178	<desc>The bandwidth group this network adapter is assigned to.</desc>
15179	</attribute>
15180
15181	<!-- property methods -->
15182
15183	<method name="getProperty" const="yes">
15184	<desc>
15185	Returns the value of the network attachment property with the given name.
15186
15187	If the requested data @a key does not exist, this function will
15188	succeed and return an empty string in the @a value argument.
15189
15190	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15191	</desc>
15192	<param name="key" type="wstring" dir="in">
15193	<desc>Name of the property to get.</desc>
15194	</param>
15195	<param name="value" type="wstring" dir="return">
15196	<desc>Current property value.</desc>
15197	</param>
15198	</method>
15199
15200	<method name="setProperty">
15201	<desc>
15202	Sets the value of the network attachment property with the given name.
15203
15204	Setting the property value to @c null or an empty string is equivalent
15205	to deleting the existing value.
15206
15207	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
15208	</desc>
15209	<param name="key" type="wstring" dir="in">
15210	<desc>Name of the property to set.</desc>
15211	</param>
15212	<param name="value" type="wstring" dir="in">
15213	<desc>Property value to set.</desc>
15214	</param>
15215	</method>
15216
15217	<method name="getProperties" const="yes">
15218	<desc>
15219	Returns values for a group of properties in one call.
15220
15221	The names of the properties to get are specified using the @a names
15222	argument which is a list of comma-separated property names or
15223	an empty string if all properties are to be returned.
15224	<note>Currently the value of this argument is ignored and the method
15225	always returns all existing properties.</note>
15226
15227	The method returns two arrays, the array of property names corresponding
15228	to the @a names argument and the current values of these properties.
15229	Both arrays have the same number of elements with each element at the
15230	given index in the first array corresponds to an element at the same
15231	index in the second array.
15232	</desc>
15233	<param name="names" type="wstring" dir="in">
15234	<desc>
15235	Names of properties to get.
15236	</desc>
15237	</param>
15238	<param name="returnNames" type="wstring" safearray="yes" dir="out">
15239	<desc>Names of returned properties.</desc>
15240	</param>
15241	<param name="returnValues" type="wstring" safearray="yes" dir="return">
15242	<desc>Values of returned properties.</desc>
15243	</param>
15244	</method>
15245
15246	</interface>
15247
15248
15249	<!--
15250	// ISerialPort
15251	/////////////////////////////////////////////////////////////////////////
15252	-->
15253
15254	<enum
15255	name="PortMode"
15256	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
15257	>
15258	<desc>
15259	The PortMode enumeration represents possible communication modes for
15260	the virtual serial port device.
15261	</desc>
15262
15263	<const name="Disconnected" value="0">
15264	<desc>Virtual device is not attached to any real host device.</desc>
15265	</const>
15266	<const name="HostPipe" value="1">
15267	<desc>Virtual device is attached to a host pipe.</desc>
15268	</const>
15269	<const name="HostDevice" value="2">
15270	<desc>Virtual device is attached to a host device.</desc>
15271	</const>
15272	<const name="RawFile" value="3">
15273	<desc>Virtual device is attached to a raw file.</desc>
15274	</const>
15275	</enum>
15276
15277	<interface
15278	name="ISerialPort" extends="$unknown"
15279	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
15280	wsmap="managed"
15281	>
15282
15283	<desc>
15284	The ISerialPort interface represents the virtual serial port device.
15285
15286	The virtual serial port device acts like an ordinary serial port
15287	inside the virtual machine. This device communicates to the real
15288	serial port hardware in one of two modes: host pipe or host device.
15289
15290	In host pipe mode, the #path attribute specifies the path to the pipe on
15291	the host computer that represents a serial port. The #server attribute
15292	determines if this pipe is created by the virtual machine process at
15293	machine startup or it must already exist before starting machine
15294	execution.
15295
15296	In host device mode, the #path attribute specifies the name of the
15297	serial port device on the host computer.
15298
15299	There is also a third communication mode: the disconnected mode. In this
15300	mode, the guest OS running inside the virtual machine will be able to
15301	detect the serial port, but all port write operations will be discarded
15302	and all port read operations will return no data.
15303
15304	<see><link to="IMachine::getSerialPort"/></see>
15305	</desc>
15306
15307	<attribute name="slot" type="unsigned long" readonly="yes">
15308	<desc>
15309	Slot number this serial port is plugged into. Corresponds to
15310	the value you pass to <link to="IMachine::getSerialPort"/>
15311	to obtain this instance.
15312	</desc>
15313	</attribute>
15314
15315	<attribute name="enabled" type="boolean">
15316	<desc>
15317	Flag whether the serial port is enabled. If disabled,
15318	the serial port will not be reported to the guest OS.
15319	</desc>
15320	</attribute>
15321
15322	<attribute name="IOBase" type="unsigned long">
15323	<desc>Base I/O address of the serial port.</desc>
15324	</attribute>
15325
15326	<attribute name="IRQ" type="unsigned long">
15327	<desc>IRQ number of the serial port.</desc>
15328	</attribute>
15329
15330	<attribute name="hostMode" type="PortMode">
15331	<desc>
15332	How is this port connected to the host.
15333	<note>
15334	Changing this attribute may fail if the conditions for
15335	<link to="#path"/> are not met.
15336	</note>
15337	</desc>
15338	</attribute>
15339
15340	<attribute name="server" type="boolean">
15341	<desc>
15342	Flag whether this serial port acts as a server (creates a new pipe on
15343	the host) or as a client (uses the existing pipe). This attribute is
15344	used only when <link to="#hostMode"/> is PortMode_HostPipe.
15345	</desc>
15346	</attribute>
15347
15348	<attribute name="path" type="wstring">
15349	<desc>
15350	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
15351	PortMode_HostPipe, or the host serial device name when
15352	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
15353	cases, setting a @c null or empty string as the attribute's value
15354	is an error. Otherwise, the value of this property is ignored.
15355	</desc>
15356	</attribute>
15357
15358	</interface>
15359
15360	<!--
15361	// IParallelPort
15362	/////////////////////////////////////////////////////////////////////////
15363	-->
15364
15365	<interface
15366	name="IParallelPort" extends="$unknown"
15367	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
15368	wsmap="managed"
15369	>
15370
15371	<desc>
15372	The IParallelPort interface represents the virtual parallel port device.
15373
15374	The virtual parallel port device acts like an ordinary parallel port
15375	inside the virtual machine. This device communicates to the real
15376	parallel port hardware using the name of the parallel device on the host
15377	computer specified in the #path attribute.
15378
15379	Each virtual parallel port device is assigned a base I/O address and an
15380	IRQ number that will be reported to the guest operating system and used
15381	to operate the given parallel port from within the virtual machine.
15382
15383	<see><link to="IMachine::getParallelPort"/></see>
15384	</desc>
15385
15386	<attribute name="slot" type="unsigned long" readonly="yes">
15387	<desc>
15388	Slot number this parallel port is plugged into. Corresponds to
15389	the value you pass to <link to="IMachine::getParallelPort"/>
15390	to obtain this instance.
15391	</desc>
15392	</attribute>
15393
15394	<attribute name="enabled" type="boolean">
15395	<desc>
15396	Flag whether the parallel port is enabled. If disabled,
15397	the parallel port will not be reported to the guest OS.
15398	</desc>
15399	</attribute>
15400
15401	<attribute name="IOBase" type="unsigned long">
15402	<desc>Base I/O address of the parallel port.</desc>
15403	</attribute>
15404
15405	<attribute name="IRQ" type="unsigned long">
15406	<desc>IRQ number of the parallel port.</desc>
15407	</attribute>
15408
15409	<attribute name="path" type="wstring">
15410	<desc>
15411	Host parallel device name. If this parallel port is enabled, setting a
15412	@c null or an empty string as this attribute's value will result in
15413	an error.
15414	</desc>
15415	</attribute>
15416
15417	</interface>
15418
15419
15420	<!--
15421	// IMachineDebugger
15422	/////////////////////////////////////////////////////////////////////////
15423	-->
15424
15425	<interface
15426	name="IMachineDebugger" extends="$unknown"
15427	uuid="a80bb82c-37c5-4155-a524-9c1d0a1689ba"
15428	wsmap="managed"
15429	>
15430	<method name="dumpGuestCore">
15431	<desc>
15432	Takes a core dump of the guest.
15433
15434	See include/VBox/dbgfcorefmt.h for details on the file format.
15435	</desc>
15436	<param name="filename" type="wstring" dir="in">
15437	<desc>
15438	The name of the output file. The file must not exist.
15439	</desc>
15440	</param>
15441	<param name="compression" type="wstring" dir="in">
15442	<desc>
15443	Reserved for future compression method indicator.
15444	</desc>
15445	</param>
15446	</method>
15447
15448	<method name="dumpHostProcessCore">
15449	<desc>
15450	Takes a core dump of the VM process on the host.
15451
15452	This feature is not implemented in the 4.0.0 release but it may show up
15453	in a dot release.
15454	</desc>
15455	<param name="filename" type="wstring" dir="in">
15456	<desc>
15457	The name of the output file. The file must not exist.
15458	</desc>
15459	</param>
15460	<param name="compression" type="wstring" dir="in">
15461	<desc>
15462	Reserved for future compression method indicator.
15463	</desc>
15464	</param>
15465	</method>
15466
15467	<method name="info">
15468	<desc>
15469	Interfaces with the info dumpers (DBGFInfo).
15470
15471	This feature is not implemented in the 4.0.0 release but it may show up
15472	in a dot release.
15473	</desc>
15474	<param name="name" type="wstring" dir="in">
15475	<desc>
15476	The name of the info item.
15477	</desc>
15478	</param>
15479	<param name="args" type="wstring" dir="in">
15480	<desc>
15481	Arguments to the info dumper.
15482	</desc>
15483	</param>
15484	<param name="info" type="wstring" dir="return">
15485	<desc>
15486	The into string.
15487	</desc>
15488	</param>
15489	</method>
15490
15491	<method name="injectNMI">
15492	<desc>
15493	Inject an NMI into a running VT-x/AMD-V VM.
15494	</desc>
15495	</method>
15496
15497	<method name="modifyLogGroups">
15498	<desc>
15499	Modifies the group settings of the debug or release logger.
15500	</desc>
15501	<param name="settings" type="wstring" dir="in">
15502	<desc>
15503	The group settings string. See iprt/log.h for details. To target the
15504	release logger, prefix the string with "release:".
15505	</desc>
15506	</param>
15507	</method>
15508
15509	<method name="modifyLogFlags">
15510	<desc>
15511	Modifies the debug or release logger flags.
15512	</desc>
15513	<param name="settings" type="wstring" dir="in">
15514	<desc>
15515	The flags settings string. See iprt/log.h for details. To target the
15516	release logger, prefix the string with "release:".
15517	</desc>
15518	</param>
15519	</method>
15520
15521	<method name="modifyLogDestinations">
15522	<desc>
15523	Modifies the debug or release logger destinations.
15524	</desc>
15525	<param name="settings" type="wstring" dir="in">
15526	<desc>
15527	The destination settings string. See iprt/log.h for details. To target the
15528	release logger, prefix the string with "release:".
15529	</desc>
15530	</param>
15531	</method>
15532
15533	<method name="readPhysicalMemory">
15534	<desc>
15535	Reads guest physical memory, no side effects (MMIO++).
15536
15537	This feature is not implemented in the 4.0.0 release but may show up
15538	in a dot release.
15539	</desc>
15540	<param name="address" type="long long" dir="in">
15541	<desc>The guest physical address.</desc>
15542	</param>
15543	<param name="size" type="unsigned long" dir="in">
15544	<desc>The number of bytes to read.</desc>
15545	</param>
15546	<param name="bytes" type="octet" safearray="yes" dir="return">
15547	<desc>The bytes read.</desc>
15548	</param>
15549	</method>
15550
15551	<method name="writePhysicalMemory">
15552	<desc>
15553	Writes guest physical memory, access handles (MMIO++) are ignored.
15554
15555	This feature is not implemented in the 4.0.0 release but may show up
15556	in a dot release.
15557	</desc>
15558	<param name="address" type="long long" dir="in">
15559	<desc>The guest physical address.</desc>
15560	</param>
15561	<param name="size" type="unsigned long" dir="in">
15562	<desc>The number of bytes to read.</desc>
15563	</param>
15564	<param name="bytes" type="octet" safearray="yes" dir="in">
15565	<desc>The bytes to write.</desc>
15566	</param>
15567	</method>
15568
15569	<method name="readVirtualMemory">
15570	<desc>
15571	Reads guest virtual memory, no side effects (MMIO++).
15572
15573	This feature is not implemented in the 4.0.0 release but may show up
15574	in a dot release.
15575	</desc>
15576	<param name="cpuId" type="unsigned long" dir="in">
15577	<desc>The identifier of the Virtual CPU.</desc>
15578	</param>
15579	<param name="address" type="long long" dir="in">
15580	<desc>The guest virtual address.</desc>
15581	</param>
15582	<param name="size" type="unsigned long" dir="in">
15583	<desc>The number of bytes to read.</desc>
15584	</param>
15585	<param name="bytes" type="octet" safearray="yes" dir="return">
15586	<desc>The bytes read.</desc>
15587	</param>
15588	</method>
15589
15590	<method name="writeVirtualMemory">
15591	<desc>
15592	Writes guest virtual memory, access handles (MMIO++) are ignored.
15593
15594	This feature is not implemented in the 4.0.0 release but may show up
15595	in a dot release.
15596	</desc>
15597	<param name="cpuId" type="unsigned long" dir="in">
15598	<desc>The identifier of the Virtual CPU.</desc>
15599	</param>
15600	<param name="address" type="long long" dir="in">
15601	<desc>The guest virtual address.</desc>
15602	</param>
15603	<param name="size" type="unsigned long" dir="in">
15604	<desc>The number of bytes to read.</desc>
15605	</param>
15606	<param name="bytes" type="octet" safearray="yes" dir="in">
15607	<desc>The bytes to write.</desc>
15608	</param>
15609	</method>
15610
15611	<method name="detectOS">
15612	<desc>
15613	Tries to (re-)detect the guest OS kernel.
15614
15615	This feature is not implemented in the 4.0.0 release but may show up
15616	in a dot release.
15617	</desc>
15618	<param name="os" type="wstring" dir="return">
15619	<desc>
15620	The detected OS kernel on success.
15621	</desc>
15622	</param>
15623	</method>
15624
15625	<method name="getRegister">
15626	<desc>
15627	Gets one register.
15628
15629	This feature is not implemented in the 4.0.0 release but may show up
15630	in a dot release.
15631	</desc>
15632	<param name="cpuId" type="unsigned long" dir="in">
15633	<desc>The identifier of the Virtual CPU.</desc>
15634	</param>
15635	<param name="name" type="wstring" dir="in">
15636	<desc>The register name, case is ignored.</desc>
15637	</param>
15638	<param name="value" type="wstring" dir="return">
15639	<desc>
15640	The register value. This is usually a hex value (always 0x prefixed)
15641	but other format may be used for floating point registers (TBD).
15642	</desc>
15643	</param>
15644	</method>
15645
15646	<method name="getRegisters">
15647	<desc>
15648	Gets all the registers for the given CPU.
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="names" type="wstring" dir="out" safearray="yes">
15657	<desc>Array containing the lowercase register names.</desc>
15658	</param>
15659	<param name="values" type="wstring" dir="out" safearray="yes">
15660	<desc>
15661	Array paralell to the names holding the register values as if the
15662	register was returned by <link to="IMachineDebugger::getRegister"/>.
15663	</desc>
15664	</param>
15665	</method>
15666
15667	<method name="setRegister">
15668	<desc>
15669	Gets one register.
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="name" type="wstring" dir="in">
15678	<desc>The register name, case is ignored.</desc>
15679	</param>
15680	<param name="value" type="wstring" dir="in">
15681	<desc>
15682	The new register value. Hexadecimal, decimal and octal formattings
15683	are supported in addition to any special formattings returned by
15684	the getters.
15685	</desc>
15686	</param>
15687	</method>
15688
15689	<method name="setRegisters">
15690	<desc>
15691	Sets zero or more registers atomically.
15692
15693	This feature is not implemented in the 4.0.0 release but may show up
15694	in a dot release.
15695	</desc>
15696	<param name="cpuId" type="unsigned long" dir="in">
15697	<desc>The identifier of the Virtual CPU.</desc>
15698	</param>
15699	<param name="names" type="wstring" dir="in" safearray="yes">
15700	<desc>Array containing the register names, case ignored.</desc>
15701	</param>
15702	<param name="values" type="wstring" dir="in" safearray="yes">
15703	<desc>
15704	Array paralell to the names holding the register values. See
15705	<link to="IMachineDebugger::setRegister"/> for formatting
15706	guidelines.
15707	</desc>
15708	</param>
15709	</method>
15710
15711	<method name="dumpGuestStack">
15712	<desc>
15713	Produce a simple stack dump using the current guest state.
15714
15715	This feature is not implemented in the 4.0.0 release but may show up
15716	in a dot release.
15717	</desc>
15718	<param name="cpuId" type="unsigned long" dir="in">
15719	<desc>The identifier of the Virtual CPU.</desc>
15720	</param>
15721	<param name="stack" type="wstring" dir="return">
15722	<desc>String containing the formatted stack dump.</desc>
15723	</param>
15724	</method>
15725
15726	<method name="resetStats">
15727	<desc>
15728	Reset VM statistics.
15729	</desc>
15730	<param name="pattern" type="wstring" dir="in">
15731	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15732	</param>
15733	</method>
15734
15735	<method name="dumpStats">
15736	<desc>
15737	Dumps VM statistics.
15738	</desc>
15739	<param name="pattern" type="wstring" dir="in">
15740	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15741	</param>
15742	</method>
15743
15744	<method name="getStats">
15745	<desc>
15746	Get the VM statistics in a XMLish format.
15747	</desc>
15748	<param name="pattern" type="wstring" dir="in">
15749	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15750	</param>
15751	<param name="withDescriptions" type="boolean" dir="in">
15752	<desc>Whether to include the descriptions.</desc>
15753	</param>
15754	<param name="stats" type="wstring" dir="return">
15755	<desc>The XML document containing the statistics.</desc>
15756	</param>
15757	</method>
15758
15759	<attribute name="singleStep" type="boolean">
15760	<desc>Switch for enabling single-stepping.</desc>
15761	</attribute>
15762
15763	<attribute name="recompileUser" type="boolean">
15764	<desc>Switch for forcing code recompilation for user mode code.</desc>
15765	</attribute>
15766
15767	<attribute name="recompileSupervisor" type="boolean">
15768	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15769	</attribute>
15770
15771	<attribute name="PATMEnabled" type="boolean">
15772	<desc>Switch for enabling and disabling the PATM component.</desc>
15773	</attribute>
15774
15775	<attribute name="CSAMEnabled" type="boolean">
15776	<desc>Switch for enabling and disabling the CSAM component.</desc>
15777	</attribute>
15778
15779	<attribute name="logEnabled" type="boolean">
15780	<desc>Switch for enabling and disabling the debug logger.</desc>
15781	</attribute>
15782
15783	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15784	<desc>The debug logger flags.</desc>
15785	</attribute>
15786
15787	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15788	<desc>The debug logger's group settings.</desc>
15789	</attribute>
15790
15791	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15792	<desc>The debug logger's destination settings.</desc>
15793	</attribute>
15794
15795	<attribute name="logRelFlags" type="wstring" readonly="yes">
15796	<desc>The release logger flags.</desc>
15797	</attribute>
15798
15799	<attribute name="logRelGroups" type="wstring" readonly="yes">
15800	<desc>The release logger's group settings.</desc>
15801	</attribute>
15802
15803	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15804	<desc>The relase logger's destination settings.</desc>
15805	</attribute>
15806
15807	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15808	<desc>
15809	Flag indicating whether the VM is currently making use of CPU hardware
15810	virtualization extensions.
15811	</desc>
15812	</attribute>
15813
15814	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15815	<desc>
15816	Flag indicating whether the VM is currently making use of the nested paging
15817	CPU hardware virtualization extension.
15818	</desc>
15819	</attribute>
15820
15821	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15822	<desc>
15823	Flag indicating whether the VM is currently making use of the VPID
15824	VT-x extension.
15825	</desc>
15826	</attribute>
15827
15828	<attribute name="OSName" type="wstring" readonly="yes">
15829	<desc>
15830	Query the guest OS kernel name as detected by the DBGF.
15831
15832	This feature is not implemented in the 4.0.0 release but may show up
15833	in a dot release.
15834	</desc>
15835	</attribute>
15836
15837	<attribute name="OSVersion" type="wstring" readonly="yes">
15838	<desc>
15839	Query the guest OS kernel version string as detected by the DBGF.
15840
15841	This feature is not implemented in the 4.0.0 release but may show up
15842	in a dot release.
15843	</desc>
15844	</attribute>
15845
15846	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15847	<desc>
15848	Flag indicating whether the VM is currently making use of the Physical
15849	Address Extension CPU feature.
15850	</desc>
15851	</attribute>
15852
15853	<attribute name="virtualTimeRate" type="unsigned long">
15854	<desc>
15855	The rate at which the virtual time runs expressed as a percentage.
15856	The accepted range is 2% to 20000%.
15857	</desc>
15858	</attribute>
15859
15860	<attribute name="VM" type="long long" readonly="yes" wsmap="suppress">
15861	<desc>
15862	Gets the user-mode VM handle, with a reference. Must be passed to
15863	VMR3ReleaseUVM when done. This is only for internal use while we carve
15864	the details of this interface.
15865	</desc>
15866	</attribute>
15867
15868	</interface>
15869
15870	<!--
15871	// IUSBController
15872	/////////////////////////////////////////////////////////////////////////
15873	-->
15874
15875	<interface
15876	name="IUSBController" extends="$unknown"
15877	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15878	wsmap="managed"
15879	>
15880	<attribute name="enabled" type="boolean">
15881	<desc>
15882	Flag whether the USB controller is present in the
15883	guest system. If disabled, the virtual guest hardware will
15884	not contain any USB controller. Can only be changed when
15885	the VM is powered off.
15886	</desc>
15887	</attribute>
15888
15889	<attribute name="enabledEHCI" type="boolean">
15890	<desc>
15891	Flag whether the USB EHCI controller is present in the
15892	guest system. If disabled, the virtual guest hardware will
15893	not contain a USB EHCI controller. Can only be changed when
15894	the VM is powered off.
15895	</desc>
15896	</attribute>
15897
15898	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15899	<desc>
15900	Flag whether there is an USB proxy available.
15901	</desc>
15902	</attribute>
15903
15904	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15905	<desc>
15906	USB standard version which the controller implements.
15907	This is a BCD which means that the major version is in the
15908	high byte and minor version is in the low byte.
15909	</desc>
15910	</attribute>
15911
15912	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15913	<desc>
15914	List of USB device filters associated with the machine.
15915
15916	If the machine is currently running, these filters are activated
15917	every time a new (supported) USB device is attached to the host
15918	computer that was not ignored by global filters
15919	(<link to="IHost::USBDeviceFilters"/>).
15920
15921	These filters are also activated when the machine is powered up.
15922	They are run against a list of all currently available USB
15923	devices (in states
15924	<link to="USBDeviceState_Available"/>,
15925	<link to="USBDeviceState_Busy"/>,
15926	<link to="USBDeviceState_Held"/>) that were not previously
15927	ignored by global filters.
15928
15929	If at least one filter matches the USB device in question, this
15930	device is automatically captured (attached to) the virtual USB
15931	controller of this machine.
15932
15933	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15934	</desc>
15935	</attribute>
15936
15937	<method name="createDeviceFilter">
15938	<desc>
15939	Creates a new USB device filter. All attributes except
15940	the filter name are set to empty (any match),
15941	<i>active</i> is @c false (the filter is not active).
15942
15943	The created filter can then be added to the list of filters using
15944	<link to="#insertDeviceFilter"/>.
15945
15946	<result name="VBOX_E_INVALID_VM_STATE">
15947	The virtual machine is not mutable.
15948	</result>
15949
15950	<see><link to="#deviceFilters"/></see>
15951	</desc>
15952	<param name="name" type="wstring" dir="in">
15953	<desc>
15954	Filter name. See <link to="IUSBDeviceFilter::name"/>
15955	for more info.
15956	</desc>
15957	</param>
15958	<param name="filter" type="IUSBDeviceFilter" dir="return">
15959	<desc>Created filter object.</desc>
15960	</param>
15961	</method>
15962
15963	<method name="insertDeviceFilter">
15964	<desc>
15965	Inserts the given USB device to the specified position
15966	in the list of filters.
15967
15968	Positions are numbered starting from <tt>0</tt>. If the specified
15969	position is equal to or greater than the number of elements in
15970	the list, the filter is added to the end of the collection.
15971
15972	<note>
15973	Duplicates are not allowed, so an attempt to insert a
15974	filter that is already in the collection, will return an
15975	error.
15976	</note>
15977
15978	<result name="VBOX_E_INVALID_VM_STATE">
15979	Virtual machine is not mutable.
15980	</result>
15981	<result name="E_INVALIDARG">
15982	USB device filter not created within this VirtualBox instance.
15983	</result>
15984	<result name="VBOX_E_INVALID_OBJECT_STATE">
15985	USB device filter already in list.
15986	</result>
15987
15988	<see><link to="#deviceFilters"/></see>
15989	</desc>
15990	<param name="position" type="unsigned long" dir="in">
15991	<desc>Position to insert the filter to.</desc>
15992	</param>
15993	<param name="filter" type="IUSBDeviceFilter" dir="in">
15994	<desc>USB device filter to insert.</desc>
15995	</param>
15996	</method>
15997
15998	<method name="removeDeviceFilter">
15999	<desc>
16000	Removes a USB device filter from the specified position in the
16001	list of filters.
16002
16003	Positions are numbered starting from <tt>0</tt>. Specifying a
16004	position equal to or greater than the number of elements in
16005	the list will produce an error.
16006
16007	<see><link to="#deviceFilters"/></see>
16008
16009	<result name="VBOX_E_INVALID_VM_STATE">
16010	Virtual machine is not mutable.
16011	</result>
16012	<result name="E_INVALIDARG">
16013	USB device filter list empty or invalid @a position.
16014	</result>
16015
16016	</desc>
16017	<param name="position" type="unsigned long" dir="in">
16018	<desc>Position to remove the filter from.</desc>
16019	</param>
16020	<param name="filter" type="IUSBDeviceFilter" dir="return">
16021	<desc>Removed USB device filter.</desc>
16022	</param>
16023	</method>
16024
16025	</interface>
16026
16027
16028	<!--
16029	// IUSBDevice
16030	/////////////////////////////////////////////////////////////////////////
16031	-->
16032
16033	<interface
16034	name="IUSBDevice" extends="$unknown"
16035	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
16036	wsmap="managed"
16037	>
16038	<desc>
16039	The IUSBDevice interface represents a virtual USB device attached to the
16040	virtual machine.
16041
16042	A collection of objects implementing this interface is stored in the
16043	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
16044	attached to a running virtual machine's USB controller.
16045	</desc>
16046
16047	<attribute name="id" type="uuid" mod="string" readonly="yes">
16048	<desc>
16049	Unique USB device ID. This ID is built from #vendorId,
16050	#productId, #revision and #serialNumber.
16051	</desc>
16052	</attribute>
16053
16054	<attribute name="vendorId" type="unsigned short" readonly="yes">
16055	<desc>Vendor ID.</desc>
16056	</attribute>
16057
16058	<attribute name="productId" type="unsigned short" readonly="yes">
16059	<desc>Product ID.</desc>
16060	</attribute>
16061
16062	<attribute name="revision" type="unsigned short" readonly="yes">
16063	<desc>
16064	Product revision number. This is a packed BCD represented as
16065	unsigned short. The high byte is the integer part and the low
16066	byte is the decimal.
16067	</desc>
16068	</attribute>
16069
16070	<attribute name="manufacturer" type="wstring" readonly="yes">
16071	<desc>Manufacturer string.</desc>
16072	</attribute>
16073
16074	<attribute name="product" type="wstring" readonly="yes">
16075	<desc>Product string.</desc>
16076	</attribute>
16077
16078	<attribute name="serialNumber" type="wstring" readonly="yes">
16079	<desc>Serial number string.</desc>
16080	</attribute>
16081
16082	<attribute name="address" type="wstring" readonly="yes">
16083	<desc>Host specific address of the device.</desc>
16084	</attribute>
16085
16086	<attribute name="port" type="unsigned short" readonly="yes">
16087	<desc>
16088	Host USB port number the device is physically
16089	connected to.
16090	</desc>
16091	</attribute>
16092
16093	<attribute name="version" type="unsigned short" readonly="yes">
16094	<desc>
16095	The major USB version of the device - 1 or 2.
16096	</desc>
16097	</attribute>
16098
16099	<attribute name="portVersion" type="unsigned short" readonly="yes">
16100	<desc>
16101	The major USB version of the host USB port the device is
16102	physically connected to - 1 or 2. For devices not connected to
16103	anything this will have the same value as the version attribute.
16104	</desc>
16105	</attribute>
16106
16107	<attribute name="remote" type="boolean" readonly="yes">
16108	<desc>
16109	Whether the device is physically connected to a remote VRDE
16110	client or to a local host machine.
16111	</desc>
16112	</attribute>
16113
16114	</interface>
16115
16116
16117	<!--
16118	// IUSBDeviceFilter
16119	/////////////////////////////////////////////////////////////////////////
16120	-->
16121
16122	<interface
16123	name="IUSBDeviceFilter" extends="$unknown"
16124	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
16125	wsmap="managed"
16126	>
16127	<desc>
16128	The IUSBDeviceFilter interface represents an USB device filter used
16129	to perform actions on a group of USB devices.
16130
16131	This type of filters is used by running virtual machines to
16132	automatically capture selected USB devices once they are physically
16133	attached to the host computer.
16134
16135	A USB device is matched to the given device filter if and only if all
16136	attributes of the device match the corresponding attributes of the
16137	filter (that is, attributes are joined together using the logical AND
16138	operation). On the other hand, all together, filters in the list of
16139	filters carry the semantics of the logical OR operation. So if it is
16140	desirable to create a match like "this vendor id OR this product id",
16141	one needs to create two filters and specify "any match" (see below)
16142	for unused attributes.
16143
16144	All filter attributes used for matching are strings. Each string
16145	is an expression representing a set of values of the corresponding
16146	device attribute, that will match the given filter. Currently, the
16147	following filtering expressions are supported:
16148
16149	<ul>
16150	<li><i>Interval filters</i>. Used to specify valid intervals for
16151	integer device attributes (Vendor ID, Product ID and Revision).
16152	The format of the string is:
16153
16154	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
16155
16156	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
16157	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
16158	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
16159	is omitted before a dash (<tt>-</tt>), the minimum possible integer
16160	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
16161	possible integer is assumed.
16162	</li>
16163	<li><i>Boolean filters</i>. Used to specify acceptable values for
16164	boolean device attributes. The format of the string is:
16165
16166	<tt>true\|false\|yes\|no\|0\|1</tt>
16167
16168	</li>
16169	<li><i>Exact match</i>. Used to specify a single value for the given
16170	device attribute. Any string that doesn't start with <tt>int:</tt>
16171	represents the exact match. String device attributes are compared to
16172	this string including case of symbols. Integer attributes are first
16173	converted to a string (see individual filter attributes) and then
16174	compared ignoring case.
16175
16176	</li>
16177	<li><i>Any match</i>. Any value of the corresponding device attribute
16178	will match the given filter. An empty or @c null string is
16179	used to construct this type of filtering expressions.
16180
16181	</li>
16182	</ul>
16183
16184	<note>
16185	On the Windows host platform, interval filters are not currently
16186	available. Also all string filter attributes
16187	(<link to="#manufacturer"/>, <link to="#product"/>,
16188	<link to="#serialNumber"/>) are ignored, so they behave as
16189	<i>any match</i> no matter what string expression is specified.
16190	</note>
16191
16192	<see><link to="IUSBController::deviceFilters"/>,
16193	<link to="IHostUSBDeviceFilter"/></see>
16194	</desc>
16195
16196	<attribute name="name" type="wstring">
16197	<desc>
16198	Visible name for this filter.
16199	This name is used to visually distinguish one filter from another,
16200	so it can neither be @c null nor an empty string.
16201	</desc>
16202	</attribute>
16203
16204	<attribute name="active" type="boolean">
16205	<desc>Whether this filter active or has been temporarily disabled.</desc>
16206	</attribute>
16207
16208	<attribute name="vendorId" type="wstring">
16209	<desc>
16210	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
16211	The string representation for the <i>exact matching</i>
16212	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16213	(including leading zeroes).
16214	</desc>
16215	</attribute>
16216
16217	<attribute name="productId" type="wstring">
16218	<desc>
16219	<link to="IUSBDevice::productId">Product ID</link> filter.
16220	The string representation for the <i>exact matching</i>
16221	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
16222	(including leading zeroes).
16223	</desc>
16224	</attribute>
16225
16226	<attribute name="revision" type="wstring">
16227	<desc>
16228	<link to="IUSBDevice::productId">Product revision number</link>
16229	filter. The string representation for the <i>exact matching</i>
16230	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
16231	of the integer part of the revision, and <tt>F</tt> is the
16232	decimal digit of its fractional part (including leading and
16233	trailing zeros).
16234	Note that for interval filters, it's best to use the hexadecimal
16235	form, because the revision is stored as a 16 bit packed BCD value;
16236	so the expression <tt>int:0x0100-0x0199</tt> will match any
16237	revision from <tt>1.0</tt> to <tt>1.99</tt>.
16238	</desc>
16239	</attribute>
16240
16241	<attribute name="manufacturer" type="wstring">
16242	<desc>
16243	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
16244	</desc>
16245	</attribute>
16246
16247	<attribute name="product" type="wstring">
16248	<desc>
16249	<link to="IUSBDevice::product">Product</link> filter.
16250	</desc>
16251	</attribute>
16252
16253	<attribute name="serialNumber" type="wstring">
16254	<desc>
16255	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
16256	</desc>
16257	</attribute>
16258
16259	<attribute name="port" type="wstring">
16260	<desc>
16261	<link to="IUSBDevice::port">Host USB port</link> filter.
16262	</desc>
16263	</attribute>
16264
16265	<attribute name="remote" type="wstring">
16266	<desc>
16267	<link to="IUSBDevice::remote">Remote state</link> filter.
16268	<note>
16269	This filter makes sense only for machine USB filters,
16270	i.e. it is ignored by IHostUSBDeviceFilter objects.
16271	</note>
16272	</desc>
16273	</attribute>
16274
16275	<attribute name="maskedInterfaces" type="unsigned long">
16276	<desc>
16277	This is an advanced option for hiding one or more USB interfaces
16278	from the guest. The value is a bit mask where the bits that are set
16279	means the corresponding USB interface should be hidden, masked off
16280	if you like.
16281	This feature only works on Linux hosts.
16282	</desc>
16283	</attribute>
16284
16285	</interface>
16286
16287
16288	<!--
16289	// IHostUSBDevice
16290	/////////////////////////////////////////////////////////////////////////
16291	-->
16292
16293	<enum
16294	name="USBDeviceState"
16295	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
16296	>
16297	<desc>
16298	USB device state. This enumeration represents all possible states
16299	of the USB device physically attached to the host computer regarding
16300	its state on the host computer and availability to guest computers
16301	(all currently running virtual machines).
16302
16303	Once a supported USB device is attached to the host, global USB
16304	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
16305	either ignore the device, or put it to USBDeviceState_Held state, or do
16306	nothing. Unless the device is ignored by global filters, filters of all
16307	currently running guests (<link to="IUSBController::deviceFilters"/>) are
16308	activated that can put it to USBDeviceState_Captured state.
16309
16310	If the device was ignored by global filters, or didn't match
16311	any filters at all (including guest ones), it is handled by the host
16312	in a normal way. In this case, the device state is determined by
16313	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
16314	or USBDeviceState_Available, depending on the current device usage.
16315
16316	Besides auto-capturing based on filters, the device can be manually
16317	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
16318	state is USBDeviceState_Busy, USBDeviceState_Available or
16319	USBDeviceState_Held.
16320
16321	<note>
16322	Due to differences in USB stack implementations in Linux and Win32,
16323	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
16324	only to the Linux version of the product. This also means that (<link
16325	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
16326	device state is USBDeviceState_Held.
16327	</note>
16328
16329	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
16330	</desc>
16331
16332	<const name="NotSupported" value="0">
16333	<desc>
16334	Not supported by the VirtualBox server, not available to guests.
16335	</desc>
16336	</const>
16337	<const name="Unavailable" value="1">
16338	<desc>
16339	Being used by the host computer exclusively,
16340	not available to guests.
16341	</desc>
16342	</const>
16343	<const name="Busy" value="2">
16344	<desc>
16345	Being used by the host computer, potentially available to guests.
16346	</desc>
16347	</const>
16348	<const name="Available" value="3">
16349	<desc>
16350	Not used by the host computer, available to guests (the host computer
16351	can also start using the device at any time).
16352	</desc>
16353	</const>
16354	<const name="Held" value="4">
16355	<desc>
16356	Held by the VirtualBox server (ignored by the host computer),
16357	available to guests.
16358	</desc>
16359	</const>
16360	<const name="Captured" value="5">
16361	<desc>
16362	Captured by one of the guest computers, not available
16363	to anybody else.
16364	</desc>
16365	</const>
16366	</enum>
16367
16368	<interface
16369	name="IHostUSBDevice" extends="IUSBDevice"
16370	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
16371	wsmap="managed"
16372	>
16373	<desc>
16374	The IHostUSBDevice interface represents a physical USB device attached
16375	to the host computer.
16376
16377	Besides properties inherited from IUSBDevice, this interface adds the
16378	<link to="#state"/> property that holds the current state of the USB
16379	device.
16380
16381	<see><link to="IHost::USBDevices"/>,
16382	<link to="IHost::USBDeviceFilters"/></see>
16383	</desc>
16384
16385	<attribute name="state" type="USBDeviceState" readonly="yes">
16386	<desc>
16387	Current state of the device.
16388	</desc>
16389	</attribute>
16390
16391	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
16392
16393	</interface>
16394
16395
16396	<!--
16397	// IHostUSBDeviceFilter
16398	/////////////////////////////////////////////////////////////////////////
16399	-->
16400
16401	<enum
16402	name="USBDeviceFilterAction"
16403	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
16404	>
16405	<desc>
16406	Actions for host USB device filters.
16407	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
16408	</desc>
16409
16410	<const name="Null" value="0">
16411	<desc>Null value (never used by the API).</desc>
16412	</const>
16413	<const name="Ignore" value="1">
16414	<desc>Ignore the matched USB device.</desc>
16415	</const>
16416	<const name="Hold" value="2">
16417	<desc>Hold the matched USB device.</desc>
16418	</const>
16419	</enum>
16420
16421	<interface
16422	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
16423	uuid="4cc70246-d74a-400f-8222-3900489c0374"
16424	wsmap="managed"
16425	>
16426	<desc>
16427	The IHostUSBDeviceFilter interface represents a global filter for a
16428	physical USB device used by the host computer. Used indirectly in
16429	<link to="IHost::USBDeviceFilters"/>.
16430
16431	Using filters of this type, the host computer determines the initial
16432	state of the USB device after it is physically attached to the
16433	host's USB controller.
16434
16435	<note>
16436	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16437	filters, because it makes sense only for
16438	<link to="IUSBController::deviceFilters">machine USB filters</link>.
16439	</note>
16440
16441	<see><link to="IHost::USBDeviceFilters"/></see>
16442	</desc>
16443
16444	<attribute name="action" type="USBDeviceFilterAction">
16445	<desc>
16446	Action performed by the host when an attached USB device
16447	matches this filter.
16448	</desc>
16449	</attribute>
16450
16451	</interface>
16452
16453	<!--
16454	// IAudioAdapter
16455	/////////////////////////////////////////////////////////////////////////
16456	-->
16457
16458	<enum
16459	name="AudioDriverType"
16460	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16461	>
16462	<desc>
16463	Host audio driver type.
16464	</desc>
16465
16466	<const name="Null" value="0">
16467	<desc>Null value, also means "dummy audio driver".</desc>
16468	</const>
16469	<const name="WinMM" value="1">
16470	<desc>Windows multimedia (Windows hosts only).</desc>
16471	</const>
16472	<const name="OSS" value="2">
16473	<desc>Open Sound System (Linux hosts only).</desc>
16474	</const>
16475	<const name="ALSA" value="3">
16476	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16477	</const>
16478	<const name="DirectSound" value="4">
16479	<desc>DirectSound (Windows hosts only).</desc>
16480	</const>
16481	<const name="CoreAudio" value="5">
16482	<desc>CoreAudio (Mac hosts only).</desc>
16483	</const>
16484	<const name="MMPM" value="6">
16485	<desc>Reserved for historical reasons.</desc>
16486	</const>
16487	<const name="Pulse" value="7">
16488	<desc>PulseAudio (Linux hosts only).</desc>
16489	</const>
16490	<const name="SolAudio" value="8">
16491	<desc>Solaris audio (Solaris hosts only).</desc>
16492	</const>
16493	</enum>
16494
16495	<enum
16496	name="AudioControllerType"
16497	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16498	>
16499	<desc>
16500	Virtual audio controller type.
16501	</desc>
16502
16503	<const name="AC97" value="0"/>
16504	<const name="SB16" value="1"/>
16505	<const name="HDA" value="2"/>
16506	</enum>
16507
16508	<interface
16509	name="IAudioAdapter" extends="$unknown"
16510	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16511	wsmap="managed"
16512	>
16513	<desc>
16514	The IAudioAdapter interface represents the virtual audio adapter of
16515	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16516	</desc>
16517	<attribute name="enabled" type="boolean">
16518	<desc>
16519	Flag whether the audio adapter is present in the
16520	guest system. If disabled, the virtual guest hardware will
16521	not contain any audio adapter. Can only be changed when
16522	the VM is not running.
16523	</desc>
16524	</attribute>
16525	<attribute name="audioController" type="AudioControllerType">
16526	<desc>
16527	The audio hardware we emulate.
16528	</desc>
16529	</attribute>
16530	<attribute name="audioDriver" type="AudioDriverType">
16531	<desc>
16532	Audio driver the adapter is connected to. This setting
16533	can only be changed when the VM is not running.
16534	</desc>
16535	</attribute>
16536	</interface>
16537
16538	<enum
16539	name="AuthType"
16540	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16541	>
16542	<desc>
16543	VirtualBox authentication type.
16544	</desc>
16545
16546	<const name="Null" value="0">
16547	<desc>Null value, also means "no authentication".</desc>
16548	</const>
16549	<const name="External" value="1"/>
16550	<const name="Guest" value="2"/>
16551	</enum>
16552
16553	<!--
16554	// IVRDEServer
16555	/////////////////////////////////////////////////////////////////////////
16556	-->
16557
16558	<interface
16559	name="IVRDEServer" extends="$unknown"
16560	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16561	wsmap="managed"
16562	>
16563
16564	<attribute name="enabled" type="boolean">
16565	<desc>Flag if VRDE server is enabled.</desc>
16566	</attribute>
16567
16568	<attribute name="authType" type="AuthType">
16569	<desc>VRDE authentication method.</desc>
16570	</attribute>
16571
16572	<attribute name="authTimeout" type="unsigned long">
16573	<desc>Timeout for guest authentication. Milliseconds.</desc>
16574	</attribute>
16575
16576	<attribute name="allowMultiConnection" type="boolean">
16577	<desc>
16578	Flag whether multiple simultaneous connections to the VM are permitted.
16579	Note that this will be replaced by a more powerful mechanism in the future.
16580	</desc>
16581	</attribute>
16582
16583	<attribute name="reuseSingleConnection" type="boolean">
16584	<desc>
16585	Flag whether the existing connection must be dropped and a new connection
16586	must be established by the VRDE server, when a new client connects in single
16587	connection mode.
16588	</desc>
16589	</attribute>
16590
16591	<attribute name="VRDEExtPack" type="wstring">
16592	<desc>
16593	The name of Extension Pack providing VRDE for this VM. Overrides
16594	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16595	</desc>
16596	</attribute>
16597
16598	<attribute name="authLibrary" type="wstring">
16599	<desc>
16600	Library used for authentication of RDP clients by this VM. Overrides
16601	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16602	</desc>
16603	</attribute>
16604
16605	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16606	<desc>
16607	Array of names of properties, which are supported by this VRDE server.
16608	</desc>
16609	</attribute>
16610
16611	<method name="setVRDEProperty">
16612	<desc>
16613	Sets a VRDE specific property string.
16614
16615	If you pass @c null or empty string as a key @a value, the given @a key
16616	will be deleted.
16617
16618	</desc>
16619	<param name="key" type="wstring" dir="in">
16620	<desc>Name of the key to set.</desc>
16621	</param>
16622	<param name="value" type="wstring" dir="in">
16623	<desc>Value to assign to the key.</desc>
16624	</param>
16625	</method>
16626
16627	<method name="getVRDEProperty" const="yes">
16628	<desc>
16629	Returns a VRDE specific property string.
16630
16631	If the requested data @a key does not exist, this function will
16632	succeed and return an empty string in the @a value argument.
16633
16634	</desc>
16635	<param name="key" type="wstring" dir="in">
16636	<desc>Name of the key to get.</desc>
16637	</param>
16638	<param name="value" type="wstring" dir="return">
16639	<desc>Value of the requested key.</desc>
16640	</param>
16641	</method>
16642
16643	</interface>
16644
16645
16646	<!--
16647	// ISharedFolder
16648	/////////////////////////////////////////////////////////////////////////
16649	-->
16650
16651	<interface
16652	name="ISharedFolder" extends="$unknown"
16653	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16654	wsmap="struct"
16655	>
16656	<desc>
16657	The ISharedFolder interface represents a folder in the host computer's
16658	file system accessible from the guest OS running inside a virtual
16659	machine using an associated logical name.
16660
16661	There are three types of shared folders:
16662	<ul>
16663	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16664	folders available to all virtual machines.</li>
16665	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16666	VM-specific shared folders available to the given virtual machine at
16667	startup.</li>
16668	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16669	VM-specific shared folders created in the session context (for
16670	example, when the virtual machine is running) and automatically
16671	discarded when the session is closed (the VM is powered off).</li>
16672	</ul>
16673
16674	Logical names of shared folders must be unique within the given scope
16675	(global, permanent or transient). However, they do not need to be unique
16676	across scopes. In this case, the definition of the shared folder in a
16677	more specific scope takes precedence over definitions in all other
16678	scopes. The order of precedence is (more specific to more general):
16679	<ol>
16680	<li>Transient definitions</li>
16681	<li>Permanent definitions</li>
16682	<li>Global definitions</li>
16683	</ol>
16684
16685	For example, if MyMachine has a shared folder named
16686	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16687	transient shared folder named <tt>C_DRIVE</tt> (that points
16688	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16689	of <tt>C_DRIVE</tt> in the guest OS so
16690	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16691	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16692	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16693	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16694	to <tt>C:\\</tt> if it still exists.
16695
16696	Note that permanent and transient shared folders of different machines
16697	are in different name spaces, so they don't overlap and don't need to
16698	have unique logical names.
16699
16700	<note>
16701	Global shared folders are not implemented in the current version of the
16702	product.
16703	</note>
16704	</desc>
16705
16706	<attribute name="name" type="wstring" readonly="yes">
16707	<desc>Logical name of the shared folder.</desc>
16708	</attribute>
16709
16710	<attribute name="hostPath" type="wstring" readonly="yes">
16711	<desc>Full path to the shared folder in the host file system.</desc>
16712	</attribute>
16713
16714	<attribute name="accessible" type="boolean" readonly="yes">
16715	<desc>
16716	Whether the folder defined by the host path is currently
16717	accessible or not.
16718	For example, the folder can be inaccessible if it is placed
16719	on the network share that is not available by the time
16720	this property is read.
16721	</desc>
16722	</attribute>
16723
16724	<attribute name="writable" type="boolean" readonly="yes">
16725	<desc>
16726	Whether the folder defined by the host path is writable or
16727	not.
16728	</desc>
16729	</attribute>
16730
16731	<attribute name="autoMount" type="boolean" readonly="yes">
16732	<desc>
16733	Whether the folder gets automatically mounted by the guest or not.
16734	</desc>
16735	</attribute>
16736
16737	<attribute name="lastAccessError" type="wstring" readonly="yes">
16738	<desc>
16739	Text message that represents the result of the last accessibility
16740	check.
16741
16742	Accessibility checks are performed each time the <link to="#accessible"/>
16743	attribute is read. An empty string is returned if the last
16744	accessibility check was successful. A non-empty string indicates a
16745	failure and should normally describe a reason of the failure (for
16746	example, a file read error).
16747	</desc>
16748	</attribute>
16749
16750	</interface>
16751
16752	<!--
16753	// ISession
16754	/////////////////////////////////////////////////////////////////////////
16755	-->
16756
16757	<interface
16758	name="IInternalSessionControl" extends="$unknown"
16759	uuid="0ba8d8b3-204b-448e-99c2-242eaa666ea8"
16760	internal="yes"
16761	wsmap="suppress"
16762	>
16763	<method name="getPID">
16764	<desc>PID of the process that has created this Session object.
16765	</desc>
16766	<param name="pid" type="unsigned long" dir="return"/>
16767	</method>
16768
16769	<method name="getRemoteConsole">
16770	<desc>
16771	Returns the console object suitable for remote control.
16772
16773	<result name="VBOX_E_INVALID_VM_STATE">
16774	Session state prevents operation.
16775	</result>
16776	<result name="VBOX_E_INVALID_OBJECT_STATE">
16777	Session type prevents operation.
16778	</result>
16779
16780	</desc>
16781	<param name="console" type="IConsole" dir="return"/>
16782	</method>
16783
16784	<method name="assignMachine">
16785	<desc>
16786	Assigns the machine object associated with this direct-type
16787	session or informs the session that it will be a remote one
16788	(if @a machine == @c null).
16789
16790	<result name="VBOX_E_INVALID_VM_STATE">
16791	Session state prevents operation.
16792	</result>
16793	<result name="VBOX_E_INVALID_OBJECT_STATE">
16794	Session type prevents operation.
16795	</result>
16796
16797	</desc>
16798	<param name="machine" type="IMachine" dir="in"/>
16799	<param name="lockType" type="LockType" dir="in"/>
16800	</method>
16801
16802	<method name="assignRemoteMachine">
16803	<desc>
16804	Assigns the machine and the (remote) console object associated with
16805	this remote-type session.
16806
16807	<result name="VBOX_E_INVALID_VM_STATE">
16808	Session state prevents operation.
16809	</result>
16810
16811	</desc>
16812	<param name="machine" type="IMachine" dir="in"/>
16813	<param name="console" type="IConsole" dir="in"/>
16814	</method>
16815
16816	<method name="updateMachineState">
16817	<desc>
16818	Updates the machine state in the VM process.
16819	Must be called only in certain cases
16820	(see the method implementation).
16821
16822	<result name="VBOX_E_INVALID_VM_STATE">
16823	Session state prevents operation.
16824	</result>
16825	<result name="VBOX_E_INVALID_OBJECT_STATE">
16826	Session type prevents operation.
16827	</result>
16828
16829	</desc>
16830	<param name="machineState" type="MachineState" dir="in"/>
16831	</method>
16832
16833	<method name="uninitialize">
16834	<desc>
16835	Uninitializes (closes) this session. Used by VirtualBox to close
16836	the corresponding remote session when the direct session dies
16837	or gets closed.
16838
16839	<result name="VBOX_E_INVALID_VM_STATE">
16840	Session state prevents operation.
16841	</result>
16842
16843	</desc>
16844	</method>
16845
16846	<method name="onNetworkAdapterChange">
16847	<desc>
16848	Triggered when settings of a network adapter of the
16849	associated virtual machine have changed.
16850
16851	<result name="VBOX_E_INVALID_VM_STATE">
16852	Session state prevents operation.
16853	</result>
16854	<result name="VBOX_E_INVALID_OBJECT_STATE">
16855	Session type prevents operation.
16856	</result>
16857
16858	</desc>
16859	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16860	<param name="changeAdapter" type="boolean" dir="in"/>
16861	</method>
16862
16863	<method name="onSerialPortChange">
16864	<desc>
16865	Triggered when settings of a serial port of the
16866	associated virtual machine have changed.
16867
16868	<result name="VBOX_E_INVALID_VM_STATE">
16869	Session state prevents operation.
16870	</result>
16871	<result name="VBOX_E_INVALID_OBJECT_STATE">
16872	Session type prevents operation.
16873	</result>
16874
16875	</desc>
16876	<param name="serialPort" type="ISerialPort" dir="in"/>
16877	</method>
16878
16879	<method name="onParallelPortChange">
16880	<desc>
16881	Triggered when settings of a parallel port of the
16882	associated virtual machine have changed.
16883
16884	<result name="VBOX_E_INVALID_VM_STATE">
16885	Session state prevents operation.
16886	</result>
16887	<result name="VBOX_E_INVALID_OBJECT_STATE">
16888	Session type prevents operation.
16889	</result>
16890
16891	</desc>
16892	<param name="parallelPort" type="IParallelPort" dir="in"/>
16893	</method>
16894
16895	<method name="onStorageControllerChange">
16896	<desc>
16897	Triggered when settings of a storage controller of the
16898	associated virtual machine have changed.
16899
16900	<result name="VBOX_E_INVALID_VM_STATE">
16901	Session state prevents operation.
16902	</result>
16903	<result name="VBOX_E_INVALID_OBJECT_STATE">
16904	Session type prevents operation.
16905	</result>
16906
16907	</desc>
16908	</method>
16909
16910	<method name="onMediumChange">
16911	<desc>
16912	Triggered when attached media of the
16913	associated virtual machine have changed.
16914
16915	<result name="VBOX_E_INVALID_VM_STATE">
16916	Session state prevents operation.
16917	</result>
16918	<result name="VBOX_E_INVALID_OBJECT_STATE">
16919	Session type prevents operation.
16920	</result>
16921
16922	</desc>
16923
16924	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16925	<desc>The medium attachment which changed.</desc>
16926	</param>
16927	<param name="force" type="boolean" dir="in">
16928	<desc>If the medium change was forced.</desc>
16929	</param>
16930	</method>
16931
16932	<method name="onStorageDeviceChange">
16933	<desc>
16934	Triggered when attached storage devices of the
16935	associated virtual machine have changed.
16936
16937	<result name="VBOX_E_INVALID_VM_STATE">
16938	Session state prevents operation.
16939	</result>
16940	<result name="VBOX_E_INVALID_OBJECT_STATE">
16941	Session type prevents operation.
16942	</result>
16943
16944	</desc>
16945
16946	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16947	<desc>The medium attachment which changed.</desc>
16948	</param>
16949	<param name="remove" type="boolean" dir="in">
16950	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16951	</param>
16952	<param name="silent" type="boolean" dir="in">
16953	<desc>TRUE if the device is is silently reconfigured without
16954	notifying the guest about it.</desc>
16955	</param>
16956	</method>
16957
16958	<method name="onClipboardModeChange">
16959	<desc>
16960	Notification when the shared clipboard mode changes.
16961	</desc>
16962	<param name="clipboardMode" type="ClipboardMode" dir="in">
16963	<desc>The new shared clipboard mode.</desc>
16964	</param>
16965	</method>
16966
16967	<method name="onDragAndDropModeChange">
16968	<desc>
16969	Notification when the drag'n'drop mode changes.
16970	</desc>
16971	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
16972	<desc>The new mode for drag'n'drop.</desc>
16973	</param>
16974	</method>
16975
16976	<method name="onCPUChange">
16977	<desc>
16978	Notification when a CPU changes.
16979	</desc>
16980	<param name="cpu" type="unsigned long" dir="in">
16981	<desc>The CPU which changed</desc>
16982	</param>
16983	<param name="add" type="boolean" dir="in">
16984	<desc>Flag whether the CPU was added or removed</desc>
16985	</param>
16986	</method>
16987
16988	<method name="onCPUExecutionCapChange">
16989	<desc>
16990	Notification when the CPU execution cap changes.
16991	</desc>
16992	<param name="executionCap" type="unsigned long" dir="in">
16993	<desc>The new CPU execution cap value. (1-100)</desc>
16994	</param>
16995	</method>
16996
16997	<method name="onVRDEServerChange">
16998	<desc>
16999	Triggered when settings of the VRDE server object of the
17000	associated virtual machine have changed.
17001
17002	<result name="VBOX_E_INVALID_VM_STATE">
17003	Session state prevents operation.
17004	</result>
17005	<result name="VBOX_E_INVALID_OBJECT_STATE">
17006	Session type prevents operation.
17007	</result>
17008
17009	</desc>
17010	<param name="restart" type="boolean" dir="in">
17011	<desc>Flag whether the server must be restarted</desc>
17012	</param>
17013	</method>
17014
17015	<method name="onUSBControllerChange">
17016	<desc>
17017	Triggered when settings of the USB controller object of the
17018	associated virtual machine have changed.
17019
17020	<result name="VBOX_E_INVALID_VM_STATE">
17021	Session state prevents operation.
17022	</result>
17023	<result name="VBOX_E_INVALID_OBJECT_STATE">
17024	Session type prevents operation.
17025	</result>
17026
17027	</desc>
17028	</method>
17029
17030	<method name="onSharedFolderChange">
17031	<desc>
17032	Triggered when a permanent (global or machine) shared folder has been
17033	created or removed.
17034	<note>
17035	We don't pass shared folder parameters in this notification because
17036	the order in which parallel notifications are delivered is not defined,
17037	therefore it could happen that these parameters were outdated by the
17038	time of processing this notification.
17039	</note>
17040
17041	<result name="VBOX_E_INVALID_VM_STATE">
17042	Session state prevents operation.
17043	</result>
17044	<result name="VBOX_E_INVALID_OBJECT_STATE">
17045	Session type prevents operation.
17046	</result>
17047
17048	</desc>
17049	<param name="global" type="boolean" dir="in"/>
17050	</method>
17051
17052	<method name="onUSBDeviceAttach">
17053	<desc>
17054	Triggered when a request to capture a USB device (as a result
17055	of matched USB filters or direct call to
17056	<link to="IConsole::attachUSBDevice"/>) has completed.
17057	A @c null @a error object means success, otherwise it
17058	describes a failure.
17059
17060	<result name="VBOX_E_INVALID_VM_STATE">
17061	Session state prevents operation.
17062	</result>
17063	<result name="VBOX_E_INVALID_OBJECT_STATE">
17064	Session type prevents operation.
17065	</result>
17066
17067	</desc>
17068	<param name="device" type="IUSBDevice" dir="in"/>
17069	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17070	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
17071	</method>
17072
17073	<method name="onUSBDeviceDetach">
17074	<desc>
17075	Triggered when a request to release the USB device (as a result
17076	of machine termination or direct call to
17077	<link to="IConsole::detachUSBDevice"/>) has completed.
17078	A @c null @a error object means success, otherwise it
17079	describes a failure.
17080
17081	<result name="VBOX_E_INVALID_VM_STATE">
17082	Session state prevents operation.
17083	</result>
17084	<result name="VBOX_E_INVALID_OBJECT_STATE">
17085	Session type prevents operation.
17086	</result>
17087
17088	</desc>
17089	<param name="id" type="uuid" mod="string" dir="in"/>
17090	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
17091	</method>
17092
17093	<method name="onShowWindow">
17094	<desc>
17095	Called by <link to="IMachine::canShowConsoleWindow"/> and by
17096	<link to="IMachine::showConsoleWindow"/> in order to notify
17097	console listeners
17098	<link to="ICanShowWindowEvent"/>
17099	and <link to="IShowWindowEvent"/>.
17100
17101	<result name="VBOX_E_INVALID_OBJECT_STATE">
17102	Session type prevents operation.
17103	</result>
17104
17105	</desc>
17106	<param name="check" type="boolean" dir="in"/>
17107	<param name="canShow" type="boolean" dir="out"/>
17108	<param name="winId" type="long long" dir="out"/>
17109	</method>
17110
17111	<method name="onBandwidthGroupChange">
17112	<desc>
17113	Notification when one of the bandwidth groups change.
17114	</desc>
17115	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
17116	<desc>The bandwidth group which changed.</desc>
17117	</param>
17118	</method>
17119
17120	<method name="accessGuestProperty">
17121	<desc>
17122	Called by <link to="IMachine::getGuestProperty"/> and by
17123	<link to="IMachine::setGuestProperty"/> in order to read and
17124	modify guest properties.
17125
17126	<result name="VBOX_E_INVALID_VM_STATE">
17127	Machine session is not open.
17128	</result>
17129	<result name="VBOX_E_INVALID_OBJECT_STATE">
17130	Session type is not direct.
17131	</result>
17132
17133	</desc>
17134	<param name="name" type="wstring" dir="in"/>
17135	<param name="value" type="wstring" dir="in"/>
17136	<param name="flags" type="wstring" dir="in"/>
17137	<param name="isSetter" type="boolean" dir="in"/>
17138	<param name="retValue" type="wstring" dir="out"/>
17139	<param name="retTimestamp" type="long long" dir="out"/>
17140	<param name="retFlags" type="wstring" dir="out"/>
17141	</method>
17142
17143	<method name="enumerateGuestProperties" const="yes">
17144	<desc>
17145	Return a list of the guest properties matching a set of patterns along
17146	with their values, time stamps and flags.
17147
17148	<result name="VBOX_E_INVALID_VM_STATE">
17149	Machine session is not open.
17150	</result>
17151	<result name="VBOX_E_INVALID_OBJECT_STATE">
17152	Session type is not direct.
17153	</result>
17154
17155	</desc>
17156	<param name="patterns" type="wstring" dir="in">
17157	<desc>
17158	The patterns to match the properties against as a comma-separated
17159	string. If this is empty, all properties currently set will be
17160	returned.
17161	</desc>
17162	</param>
17163	<param name="keys" type="wstring" dir="out" safearray="yes">
17164	<desc>
17165	The key names of the properties returned.
17166	</desc>
17167	</param>
17168	<param name="values" type="wstring" dir="out" safearray="yes">
17169	<desc>
17170	The values of the properties returned. The array entries match the
17171	corresponding entries in the @a key array.
17172	</desc>
17173	</param>
17174	<param name="timestamps" type="long long" dir="out" safearray="yes">
17175	<desc>
17176	The time stamps of the properties returned. The array entries match
17177	the corresponding entries in the @a key array.
17178	</desc>
17179	</param>
17180	<param name="flags" type="wstring" dir="out" safearray="yes">
17181	<desc>
17182	The flags of the properties returned. The array entries match the
17183	corresponding entries in the @a key array.
17184	</desc>
17185	</param>
17186	</method>
17187
17188	<method name="onlineMergeMedium">
17189	<desc>
17190	Triggers online merging of a hard disk. Used internally when deleting
17191	a snapshot while a VM referring to the same hard disk chain is running.
17192
17193	<result name="VBOX_E_INVALID_VM_STATE">
17194	Machine session is not open.
17195	</result>
17196	<result name="VBOX_E_INVALID_OBJECT_STATE">
17197	Session type is not direct.
17198	</result>
17199
17200	</desc>
17201	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
17202	<desc>The medium attachment to identify the medium chain.</desc>
17203	</param>
17204	<param name="sourceIdx" type="unsigned long" dir="in">
17205	<desc>The index of the source image in the chain.
17206	Redundant, but drastically reduces IPC.</desc>
17207	</param>
17208	<param name="targetIdx" type="unsigned long" dir="in">
17209	<desc>The index of the target image in the chain.
17210	Redundant, but drastically reduces IPC.</desc>
17211	</param>
17212	<param name="source" type="IMedium" dir="in">
17213	<desc>Merge source medium.</desc>
17214	</param>
17215	<param name="target" type="IMedium" dir="in">
17216	<desc>Merge target medium.</desc>
17217	</param>
17218	<param name="mergeForward" type="boolean" dir="in">
17219	<desc>Merge direction.</desc>
17220	</param>
17221	<param name="parentForTarget" type="IMedium" dir="in">
17222	<desc>For forward merges: new parent for target medium.</desc>
17223	</param>
17224	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
17225	<desc>For backward merges: list of media which need their parent UUID
17226	updated.</desc>
17227	</param>
17228	<param name="progress" type="IProgress" dir="in">
17229	<desc>
17230	Progress object for this operation.
17231	</desc>
17232	</param>
17233	</method>
17234
17235	<method name="enableVMMStatistics">
17236	<desc>
17237	Enables or disables collection of VMM RAM statistics.
17238
17239	<result name="VBOX_E_INVALID_VM_STATE">
17240	Machine session is not open.
17241	</result>
17242	<result name="VBOX_E_INVALID_OBJECT_STATE">
17243	Session type is not direct.
17244	</result>
17245
17246	</desc>
17247	<param name="enable" type="boolean" dir="in">
17248	<desc>True enables statistics collection.</desc>
17249	</param>
17250	</method>
17251
17252	</interface>
17253
17254	<interface
17255	name="ISession" extends="$unknown"
17256	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
17257	wsmap="managed"
17258	>
17259	<desc>
17260	The ISession interface represents a client process and allows for locking
17261	virtual machines (represented by IMachine objects) to prevent conflicting
17262	changes to the machine.
17263
17264	Any caller wishing to manipulate a virtual machine needs to create a session
17265	object first, which lives in its own process space. Such session objects are
17266	then associated with <link to="IMachine" /> objects living in the VirtualBox
17267	server process to coordinate such changes.
17268
17269	There are two typical scenarios in which sessions are used:
17270
17271	<ul>
17272	<li>To alter machine settings or control a running virtual machine, one
17273	needs to lock a machine for a given session (client process) by calling
17274	<link to="IMachine::lockMachine"/>.
17275
17276	Whereas multiple sessions may control a running virtual machine, only
17277	one process can obtain a write lock on the machine to prevent conflicting
17278	changes. A write lock is also needed if a process wants to actually run a
17279	virtual machine in its own context, such as the VirtualBox GUI or
17280	VBoxHeadless front-ends. They must also lock a machine for their own
17281	sessions before they are allowed to power up the virtual machine.
17282
17283	As a result, no machine settings can be altered while another process is
17284	already using it, either because that process is modifying machine settings
17285	or because the machine is running.
17286	</li>
17287	<li>
17288	To start a VM using one of the existing VirtualBox front-ends (e.g. the
17289	VirtualBox GUI or VBoxHeadless), one would use
17290	<link to="IMachine::launchVMProcess"/>, which also takes a session object
17291	as its first parameter. This session then identifies the caller and lets the
17292	caller control the started machine (for example, pause machine execution or
17293	power it down) as well as be notified about machine execution state changes.
17294	</li>
17295	</ul>
17296
17297	How sessions objects are created in a client process depends on whether you use
17298	the Main API via COM or via the webservice:
17299
17300	<ul>
17301	<li>When using the COM API directly, an object of the Session class from the
17302	VirtualBox type library needs to be created. In regular COM C++ client code,
17303	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
17304	This object will then act as a local session object in further calls to open
17305	a session.
17306	</li>
17307
17308	<li>In the webservice, the session manager (IWebsessionManager) instead creates
17309	a session object automatically whenever <link to="IWebsessionManager::logon" />
17310	is called. A managed object reference to that session object can be retrieved by
17311	calling <link to="IWebsessionManager::getSessionObject" />.
17312	</li>
17313	</ul>
17314	</desc>
17315
17316	<attribute name="state" type="SessionState" readonly="yes">
17317	<desc>Current state of this session.</desc>
17318	</attribute>
17319
17320	<attribute name="type" type="SessionType" readonly="yes">
17321	<desc>
17322	Type of this session. The value of this attribute is valid only
17323	if the session currently has a machine locked (i.e. its
17324	<link to="#state" /> is Locked), otherwise an error will be returned.
17325	</desc>
17326	</attribute>
17327
17328	<attribute name="machine" type="IMachine" readonly="yes">
17329	<desc>Machine object associated with this session.</desc>
17330	</attribute>
17331
17332	<attribute name="console" type="IConsole" readonly="yes">
17333	<desc>Console object associated with this session.</desc>
17334	</attribute>
17335
17336	<method name="unlockMachine">
17337	<desc>
17338	Unlocks a machine that was previously locked for the current session.
17339
17340	Calling this method is required every time a machine has been locked
17341	for a particular session using the <link to="IMachine::launchVMProcess" />
17342	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
17343	the machine will be set to <link to="MachineState_Aborted" /> on the
17344	server, and changes made to the machine settings will be lost.
17345
17346	Generally, it is recommended to unlock all machines explicitly
17347	before terminating the application (regardless of the reason for
17348	the termination).
17349
17350	<note>
17351	Do not expect the session state (<link to="ISession::state" />
17352	to return to "Unlocked" immediately after you invoke this method,
17353	particularly if you have started a new VM process. The session
17354	state will automatically return to "Unlocked" once the VM is no
17355	longer executing, which can of course take a very long time.
17356	</note>
17357
17358	<result name="E_UNEXPECTED">
17359	Session is not locked.
17360	</result>
17361
17362	</desc>
17363	</method>
17364
17365	</interface>
17366
17367	<!--
17368	// IStorageController
17369	/////////////////////////////////////////////////////////////////////////
17370	-->
17371
17372	<enum
17373	name="StorageBus"
17374	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
17375	>
17376	<desc>
17377	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
17378	see <link to="IStorageController::bus" />.
17379	</desc>
17380	<const name="Null" value="0">
17381	<desc>@c null value. Never used by the API.</desc>
17382	</const>
17383	<const name="IDE" value="1"/>
17384	<const name="SATA" value="2"/>
17385	<const name="SCSI" value="3"/>
17386	<const name="Floppy" value="4"/>
17387	<const name="SAS" value="5"/>
17388	</enum>
17389
17390	<enum
17391	name="StorageControllerType"
17392	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
17393	>
17394	<desc>
17395	The exact variant of storage controller hardware presented
17396	to the guest; see <link to="IStorageController::controllerType" />.
17397	</desc>
17398
17399	<const name="Null" value="0">
17400	<desc>@c null value. Never used by the API.</desc>
17401	</const>
17402	<const name="LsiLogic" value="1">
17403	<desc>A SCSI controller of the LsiLogic variant.</desc>
17404	</const>
17405	<const name="BusLogic" value="2">
17406	<desc>A SCSI controller of the BusLogic variant.</desc>
17407	</const>
17408	<const name="IntelAhci" value="3">
17409	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
17410	</const>
17411	<const name="PIIX3" value="4">
17412	<desc>An IDE controller of the PIIX3 variant.</desc>
17413	</const>
17414	<const name="PIIX4" value="5">
17415	<desc>An IDE controller of the PIIX4 variant.</desc>
17416	</const>
17417	<const name="ICH6" value="6">
17418	<desc>An IDE controller of the ICH6 variant.</desc>
17419	</const>
17420	<const name="I82078" value="7">
17421	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
17422	</const>
17423	<const name="LsiLogicSas" value="8">
17424	<desc>A variant of the LsiLogic controller using SAS.</desc>
17425	</const>
17426	</enum>
17427
17428	<enum
17429	name="ChipsetType"
17430	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
17431	>
17432	<desc>
17433	Type of emulated chipset (mostly southbridge).
17434	</desc>
17435
17436	<const name="Null" value="0">
17437	<desc>@c null value. Never used by the API.</desc>
17438	</const>
17439	<const name="PIIX3" value="1">
17440	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
17441	</const>
17442	<const name="ICH9" value="2">
17443	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17444	</const>
17445	</enum>
17446
17447	<interface
17448	name="IStorageController" extends="$unknown"
17449	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17450	wsmap="managed"
17451	>
17452	<desc>
17453	Represents a storage controller that is attached to a virtual machine
17454	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17455	attached to storage controllers in a real computer, virtual drives
17456	(represented by <link to="IMediumAttachment" />) are attached to virtual
17457	storage controllers, represented by this interface.
17458
17459	As opposed to physical hardware, VirtualBox has a very generic concept
17460	of a storage controller, and for purposes of the Main API, all virtual
17461	storage is attached to virtual machines via instances of this interface.
17462	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17463	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17464	is used, certain sub-types may be available and can be selected in
17465	<link to="#controllerType" />.
17466
17467	Depending on these settings, the guest operating system might see
17468	significantly different virtual hardware.
17469	</desc>
17470
17471	<attribute name="name" type="wstring" readonly="yes">
17472	<desc>
17473	Name of the storage controller, as originally specified with
17474	<link to="IMachine::addStorageController" />. This then uniquely
17475	identifies this controller with other method calls such as
17476	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17477	</desc>
17478	</attribute>
17479
17480	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17481	<desc>
17482	Maximum number of devices which can be attached to one port.
17483	</desc>
17484	</attribute>
17485
17486	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17487	<desc>
17488	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17489	</desc>
17490	</attribute>
17491
17492	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17493	<desc>
17494	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17495	</desc>
17496	</attribute>
17497
17498	<attribute name="instance" type="unsigned long">
17499	<desc>
17500	The instance number of the device in the running VM.
17501	</desc>
17502	</attribute>
17503
17504	<attribute name="portCount" type="unsigned long">
17505	<desc>
17506	The number of currently usable ports on the controller.
17507	The minimum and maximum number of ports for one controller are
17508	stored in <link to="IStorageController::minPortCount"/>
17509	and <link to="IStorageController::maxPortCount"/>.
17510	</desc>
17511	</attribute>
17512
17513	<attribute name="bus" type="StorageBus" readonly="yes">
17514	<desc>
17515	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17516	</desc>
17517	</attribute>
17518
17519	<attribute name="controllerType" type="StorageControllerType">
17520	<desc>
17521	The exact variant of storage controller hardware presented
17522	to the guest.
17523	Depending on this value, VirtualBox will provide a different
17524	virtual storage controller hardware to the guest.
17525	For SATA, SAS and floppy controllers, only one variant is
17526	available, but for IDE and SCSI, there are several.
17527
17528	For SCSI controllers, the default type is LsiLogic.
17529	</desc>
17530	</attribute>
17531
17532	<attribute name="useHostIOCache" type="boolean">
17533	<desc>
17534	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17535	caches and use synchronous file APIs on the host. This was the only option in the API before
17536	VirtualBox 3.2 and is still the default for IDE controllers.
17537
17538	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17539	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17540	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17541	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17542	virtual machines are running at the same time to prevent I/O cache related hangs.
17543	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17544	</desc>
17545	</attribute>
17546
17547	<attribute name="bootable" type="boolean" readonly="yes">
17548	<desc>
17549	Returns whether it is possible to boot from disks attached to this controller.
17550	</desc>
17551	</attribute>
17552	</interface>
17553
17554	<if target="wsdl">
17555
17556	<!--
17557	// IManagedObjectRef
17558	/////////////////////////////////////////////////////////////////////////
17559	-->
17560
17561	<interface
17562	name="IManagedObjectRef" extends="$unknown"
17563	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17564	internal="yes"
17565	wsmap="managed"
17566	wscpp="hardcoded"
17567	>
17568	<desc>
17569	Managed object reference.
17570
17571	Only within the webservice, a managed object reference (which is really
17572	an opaque number) allows a webservice client to address an object
17573	that lives in the address space of the webservice server.
17574
17575	Behind each managed object reference, there is a COM object that lives
17576	in the webservice server's address space. The COM object is not freed
17577	until the managed object reference is released, either by an explicit
17578	call to <link to="IManagedObjectRef::release" /> or by logging off from
17579	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17580	all objects created during the webservice session.
17581
17582	Whenever a method call of the VirtualBox API returns a COM object, the
17583	webservice representation of that method will instead return a
17584	managed object reference, which can then be used to invoke methods
17585	on that object.
17586	</desc>
17587
17588	<method name="getInterfaceName">
17589	<desc>
17590	Returns the name of the interface that this managed object represents,
17591	for example, "IMachine", as a string.
17592	</desc>
17593	<param name="return" type="wstring" dir="return"/>
17594	</method>
17595
17596	<method name="release">
17597	<desc>
17598	Releases this managed object reference and frees the resources that
17599	were allocated for it in the webservice server process. After calling
17600	this method, the identifier of the reference can no longer be used.
17601	</desc>
17602	</method>
17603
17604	</interface>
17605
17606	<!--
17607	// IWebsessionManager
17608	/////////////////////////////////////////////////////////////////////////
17609	-->
17610
17611	<interface
17612	name="IWebsessionManager" extends="$unknown"
17613	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17614	internal="yes"
17615	wsmap="global"
17616	wscpp="hardcoded"
17617	>
17618	<desc>
17619	Websession manager. This provides essential services
17620	to webservice clients.
17621	</desc>
17622	<method name="logon">
17623	<desc>
17624	Logs a new client onto the webservice and returns a managed object reference to
17625	the IVirtualBox instance, which the client can then use as a basis to further
17626	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17627	interface, in one way or the other.
17628	</desc>
17629	<param name="username" type="wstring" dir="in"/>
17630	<param name="password" type="wstring" dir="in"/>
17631	<param name="return" type="IVirtualBox" dir="return"/>
17632	</method>
17633
17634	<method name="getSessionObject">
17635	<desc>
17636	Returns a managed object reference to the internal ISession object that was created
17637	for this web service session when the client logged on.
17638
17639	<see><link to="ISession"/></see>
17640	</desc>
17641	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17642	<param name="return" type="ISession" dir="return"/>
17643	</method>
17644
17645	<method name="logoff">
17646	<desc>
17647	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17648	and destroys all resources associated with the session (most importantly, all
17649	managed objects created in the server while the session was active).
17650	</desc>
17651	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17652	</method>
17653
17654	</interface>
17655
17656	</if>
17657
17658	<!--
17659	// IPerformanceCollector & friends
17660	/////////////////////////////////////////////////////////////////////////
17661	-->
17662
17663	<interface
17664	name="IPerformanceMetric" extends="$unknown"
17665	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17666	>
17667	<desc>
17668	The IPerformanceMetric interface represents parameters of the given
17669	performance metric.
17670	</desc>
17671
17672	<attribute name="metricName" type="wstring" readonly="yes">
17673	<desc>
17674	Name of the metric.
17675	</desc>
17676	</attribute>
17677
17678	<attribute name="object" type="$unknown" readonly="yes">
17679	<desc>
17680	Object this metric belongs to.
17681	</desc>
17682	</attribute>
17683
17684	<attribute name="description" type="wstring" readonly="yes">
17685	<desc>
17686	Textual description of the metric.
17687	</desc>
17688	</attribute>
17689
17690	<attribute name="period" type="unsigned long" readonly="yes">
17691	<desc>
17692	Time interval between samples, measured in seconds.
17693	</desc>
17694	</attribute>
17695
17696	<attribute name="count" type="unsigned long" readonly="yes">
17697	<desc>
17698	Number of recent samples retained by the performance collector for this
17699	metric.
17700
17701	When the collected sample count exceeds this number, older samples
17702	are discarded.
17703	</desc>
17704	</attribute>
17705
17706	<attribute name="unit" type="wstring" readonly="yes">
17707	<desc>
17708	Unit of measurement.
17709	</desc>
17710	</attribute>
17711
17712	<attribute name="minimumValue" type="long" readonly="yes">
17713	<desc>
17714	Minimum possible value of this metric.
17715	</desc>
17716	</attribute>
17717
17718	<attribute name="maximumValue" type="long" readonly="yes">
17719	<desc>
17720	Maximum possible value of this metric.
17721	</desc>
17722	</attribute>
17723	</interface>
17724
17725	<interface
17726	name="IPerformanceCollector" extends="$unknown"
17727	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17728	wsmap="managed"
17729	>
17730	<desc>
17731	The IPerformanceCollector interface represents a service that collects
17732	and stores performance metrics data.
17733
17734	Performance metrics are associated with objects of interfaces like IHost
17735	and IMachine. Each object has a distinct set of performance metrics. The
17736	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17737
17738	Metric data is collected at the specified intervals and is retained
17739	internally. The interval and the number of retained samples can be set
17740	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17741	and collection settings are not persistent, they are discarded as soon as
17742	VBoxSVC process terminates. Moreover, metric settings and data associated
17743	with a particular VM only exist while VM is running. They disappear as
17744	soon as VM shuts down. It is not possible to set up metrics for machines
17745	that are powered off. One needs to start VM first, then set up metric
17746	collection parameters.
17747
17748	Metrics are organized hierarchically, with each level separated by a
17749	slash (/) character. Generally, the scheme for metric names is like this:
17750
17751	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17752
17753	"Category/Metric" together form the base metric name. A base metric is
17754	the smallest unit for which a sampling interval and the number of
17755	retained samples can be set. Only base metrics can be enabled and
17756	disabled. All sub-metrics are collected when their base metric is
17757	collected. Collected values for any set of sub-metrics can be queried
17758	with <link to="IPerformanceCollector::queryMetricsData" />.
17759
17760	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17761	category, "Load" metric, "User" submetric, "average" aggregate. An
17762	aggregate function is computed over all retained data. Valid aggregate
17763	functions are:
17764
17765	<ul>
17766	<li>avg -- average</li>
17767	<li>min -- minimum</li>
17768	<li>max -- maximum</li>
17769	</ul>
17770
17771	When setting up metric parameters, querying metric data, enabling or
17772	disabling metrics wildcards can be used in metric names to specify a
17773	subset of metrics. For example, to select all CPU-related metrics
17774	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17775	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17776
17777	The valid names for base metrics are:
17778
17779	<ul>
17780	<li>CPU/Load</li>
17781	<li>CPU/MHz</li>
17782	<li>RAM/Usage</li>
17783	<li>RAM/VMM</li>
17784	</ul>
17785
17786	The general sequence for collecting and retrieving the metrics is:
17787	<ul>
17788	<li>
17789	Obtain an instance of IPerformanceCollector with
17790	<link to="IVirtualBox::performanceCollector" />
17791	</li>
17792	<li>
17793	Allocate and populate an array with references to objects the metrics
17794	will be collected for. Use references to IHost and IMachine objects.
17795	</li>
17796	<li>
17797	Allocate and populate an array with base metric names the data will
17798	be collected for.
17799	</li>
17800	<li>
17801	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17802	the metric data will be collected and stored.
17803	</li>
17804	<li>
17805	Wait for the data to get collected.
17806	</li>
17807	<li>
17808	Allocate and populate an array with references to objects the metric
17809	values will be queried for. You can re-use the object array used for
17810	setting base metrics.
17811	</li>
17812	<li>
17813	Allocate and populate an array with metric names the data will be
17814	collected for. Note that metric names differ from base metric names.
17815	</li>
17816	<li>
17817	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17818	that have been collected so far are returned. Note that the values
17819	are still retained internally and data collection continues.
17820	</li>
17821	</ul>
17822
17823	For an example of usage refer to the following files in VirtualBox SDK:
17824	<ul>
17825	<li>
17826	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17827	</li>
17828	<li>
17829	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17830	</li>
17831	</ul>
17832	</desc>
17833
17834	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17835	<desc>
17836	Array of unique names of metrics.
17837
17838	This array represents all metrics supported by the performance
17839	collector. Individual objects do not necessarily support all of them.
17840	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17841	list of supported metrics for a particular object.
17842	</desc>
17843	</attribute>
17844
17845	<method name="getMetrics">
17846	<desc>
17847	Returns parameters of specified metrics for a set of objects.
17848	<note>
17849	@c Null metrics array means all metrics. @c Null object array means
17850	all existing objects.
17851	</note>
17852	</desc>
17853	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17854	<desc>
17855	Metric name filter. Currently, only a comma-separated list of metrics
17856	is supported.
17857	</desc>
17858	</param>
17859	<param name="objects" type="$unknown" dir="in" safearray="yes">
17860	<desc>
17861	Set of objects to return metric parameters for.
17862	</desc>
17863	</param>
17864	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17865	<desc>
17866	Array of returned metric parameters.
17867	</desc>
17868	</param>
17869	</method>
17870
17871	<method name="setupMetrics">
17872	<desc>
17873	Sets parameters of specified base metrics for a set of objects. Returns
17874	an array of <link to="IPerformanceMetric" /> describing the metrics
17875	have been affected.
17876	<note>
17877	@c Null or empty metric name array means all metrics. @c Null or
17878	empty object array means all existing objects. If metric name array
17879	contains a single element and object array contains many, the single
17880	metric name array element is applied to each object array element to
17881	form metric/object pairs.
17882	</note>
17883	</desc>
17884	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17885	<desc>
17886	Metric name filter. Comma-separated list of metrics with wildcard
17887	support.
17888	</desc>
17889	</param>
17890	<param name="objects" type="$unknown" dir="in" safearray="yes">
17891	<desc>
17892	Set of objects to setup metric parameters for.
17893	</desc>
17894	</param>
17895	<param name="period" type="unsigned long" dir="in">
17896	<desc>
17897	Time interval in seconds between two consecutive samples of
17898	performance data.
17899	</desc>
17900	</param>
17901	<param name="count" type="unsigned long" dir="in">
17902	<desc>
17903	Number of samples to retain in performance data history. Older
17904	samples get discarded.
17905	</desc>
17906	</param>
17907	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17908	<desc>
17909	Array of metrics that have been modified by the call to this method.
17910	</desc>
17911	</param>
17912	</method>
17913
17914	<method name="enableMetrics">
17915	<desc>
17916	Turns on collecting specified base metrics. Returns an array of
17917	<link to="IPerformanceMetric" /> describing the metrics have been
17918	affected.
17919	<note>
17920	@c Null or empty metric name array means all metrics. @c Null or
17921	empty object array means all existing objects. If metric name array
17922	contains a single element and object array contains many, the single
17923	metric name array element is applied to each object array element to
17924	form metric/object pairs.
17925	</note>
17926	</desc>
17927	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17928	<desc>
17929	Metric name filter. Comma-separated list of metrics with wildcard
17930	support.
17931	</desc>
17932	</param>
17933	<param name="objects" type="$unknown" dir="in" safearray="yes">
17934	<desc>
17935	Set of objects to enable metrics for.
17936	</desc>
17937	</param>
17938	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17939	<desc>
17940	Array of metrics that have been modified by the call to this method.
17941	</desc>
17942	</param>
17943	</method>
17944
17945	<method name="disableMetrics">
17946	<desc>
17947	Turns off collecting specified base metrics. Returns an array of
17948	<link to="IPerformanceMetric" /> describing the metrics have been
17949	affected.
17950	<note>
17951	@c Null or empty metric name array means all metrics. @c Null or
17952	empty object array means all existing objects. If metric name array
17953	contains a single element and object array contains many, the single
17954	metric name array element is applied to each object array element to
17955	form metric/object pairs.
17956	</note>
17957	</desc>
17958	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17959	<desc>
17960	Metric name filter. Comma-separated list of metrics with wildcard
17961	support.
17962	</desc>
17963	</param>
17964	<param name="objects" type="$unknown" dir="in" safearray="yes">
17965	<desc>
17966	Set of objects to disable metrics for.
17967	</desc>
17968	</param>
17969	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17970	<desc>
17971	Array of metrics that have been modified by the call to this method.
17972	</desc>
17973	</param>
17974	</method>
17975
17976	<method name="queryMetricsData">
17977	<desc>
17978	Queries collected metrics data for a set of objects.
17979
17980	The data itself and related metric information are returned in seven
17981	parallel and one flattened array of arrays. Elements of
17982	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
17983	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
17984	the same index describe one set of values corresponding to a single
17985	metric.
17986
17987	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
17988	start and length of a sub-array is indicated by
17989	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
17990	value for metric <tt>metricNames[i]</tt> is at
17991	<tt>returnData[returnIndices[i]]</tt>.
17992
17993	<note>
17994	@c Null or empty metric name array means all metrics. @c Null or
17995	empty object array means all existing objects. If metric name array
17996	contains a single element and object array contains many, the single
17997	metric name array element is applied to each object array element to
17998	form metric/object pairs.
17999	</note>
18000	<note>
18001	Data collection continues behind the scenes after call to @c
18002	queryMetricsData. The return data can be seen as the snapshot of the
18003	current state at the time of @c queryMetricsData call. The internally
18004	kept metric values are not cleared by the call. This makes possible
18005	querying different subsets of metrics or aggregates with subsequent
18006	calls. If periodic querying is needed it is highly suggested to query
18007	the values with @c interval*count period to avoid confusion. This way
18008	a completely new set of data values will be provided by each query.
18009	</note>
18010	</desc>
18011	<param name="metricNames" type="wstring" dir="in" safearray="yes">
18012	<desc>
18013	Metric name filter. Comma-separated list of metrics with wildcard
18014	support.
18015	</desc>
18016	</param>
18017	<param name="objects" type="$unknown" dir="in" safearray="yes">
18018	<desc>
18019	Set of objects to query metrics for.
18020	</desc>
18021	</param>
18022	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
18023	<desc>
18024	Names of metrics returned in @c returnData.
18025	</desc>
18026	</param>
18027	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
18028	<desc>
18029	Objects associated with metrics returned in @c returnData.
18030	</desc>
18031	</param>
18032	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
18033	<desc>
18034	Units of measurement for each returned metric.
18035	</desc>
18036	</param>
18037	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
18038	<desc>
18039	Divisor that should be applied to return values in order to get
18040	floating point values. For example:
18041	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
18042	will retrieve the floating point value of i-th sample of the first
18043	metric.
18044	</desc>
18045	</param>
18046	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
18047	<desc>
18048	Sequence numbers of the first elements of value sequences of
18049	particular metrics returned in @c returnData. For aggregate metrics
18050	it is the sequence number of the sample the aggregate started
18051	calculation from.
18052	</desc>
18053	</param>
18054	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
18055	<desc>
18056	Indices of the first elements of value sequences of particular
18057	metrics returned in @c returnData.
18058	</desc>
18059	</param>
18060	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
18061	<desc>
18062	Lengths of value sequences of particular metrics.
18063	</desc>
18064	</param>
18065	<param name="returnData" type="long" dir="return" safearray="yes">
18066	<desc>
18067	Flattened array of all metric data containing sequences of values for
18068	each metric.
18069	</desc>
18070	</param>
18071	</method>
18072
18073	</interface>
18074
18075	<enum
18076	name="NATAliasMode"
18077	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
18078	>
18079	<desc></desc>
18080	<const name="AliasLog" value="0x1">
18081	<desc></desc>
18082	</const>
18083	<const name="AliasProxyOnly" value="0x02">
18084	<desc></desc>
18085	</const>
18086	<const name="AliasUseSamePorts" value="0x04">
18087	<desc></desc>
18088	</const>
18089	</enum>
18090
18091	<enum
18092	name="NATProtocol"
18093	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
18094	>
18095	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
18096	<const name="UDP" value="0">
18097	<desc>Port-forwarding uses UDP protocol.</desc>
18098	</const>
18099	<const name="TCP" value="1">
18100	<desc>Port-forwarding uses TCP protocol.</desc>
18101	</const>
18102	</enum>
18103
18104	<interface
18105	name="INATEngine" extends="$unknown"
18106	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
18107	wsmap="managed"
18108	>
18109	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
18110	allows for changing NAT behavior such as port-forwarding rules. This interface is
18111	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
18112	<attribute name="network" type="wstring">
18113	<desc>The network attribute of the NAT engine (the same value is used with built-in
18114	DHCP server to fill corresponding fields of DHCP leases).</desc>
18115	</attribute>
18116	<attribute name="hostIP" type="wstring">
18117	<desc>IP of host interface to bind all opened sockets to.
18118	<note>Changing this does not change binding of port forwarding.</note>
18119	</desc>
18120	</attribute>
18121	<attribute name="TFTPPrefix" type="wstring">
18122	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
18123	the corresponding fields of DHCP leases.</desc>
18124	</attribute>
18125	<attribute name="TFTPBootFile" type="wstring">
18126	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
18127	the corresponding fields of DHCP leases.</desc>
18128	</attribute>
18129	<attribute name="TFTPNextServer" type="wstring">
18130	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
18131	the corresponding fields of DHCP leases.
18132	<note>The preferred form is IPv4 addresses.</note>
18133	</desc>
18134	</attribute>
18135	<attribute name="aliasMode" type="unsigned long">
18136	<desc></desc>
18137	</attribute>
18138	<attribute name="DNSPassDomain" type="boolean">
18139	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
18140	</attribute>
18141	<attribute name="DNSProxy" type="boolean">
18142	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18143	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
18144	</attribute>
18145	<attribute name="DNSUseHostResolver" type="boolean">
18146	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
18147	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
18148	</attribute>
18149	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
18150	<desc>Array of NAT port-forwarding rules in string representation, in the following
18151	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
18152	</attribute>
18153	<method name="setNetworkSettings">
18154	<desc>Sets network configuration of the NAT engine.</desc>
18155	<param name="mtu" type="unsigned long" dir="in">
18156	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
18157	</param>
18158	<param name="sockSnd" type="unsigned long" dir="in">
18159	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
18160	</param>
18161	<param name="sockRcv" type="unsigned long" dir="in">
18162	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
18163	</param>
18164	<param name="TcpWndSnd" type="unsigned long" dir="in">
18165	<desc>Initial size of the NAT engine's sending TCP window in bytes when
18166	establishing a new TCP connection.</desc>
18167	</param>
18168	<param name="TcpWndRcv" type="unsigned long" dir="in">
18169	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
18170	establishing a new TCP connection.</desc>
18171	</param>
18172	</method>
18173	<method name="getNetworkSettings">
18174	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
18175	for parameter descriptions.</desc>
18176	<param name="mtu" type="unsigned long" dir="out" />
18177	<param name="sockSnd" type="unsigned long" dir="out" />
18178	<param name="sockRcv" type="unsigned long" dir="out" />
18179	<param name="TcpWndSnd" type="unsigned long" dir="out" />
18180	<param name="TcpWndRcv" type="unsigned long" dir="out" />
18181	</method>
18182	<method name="addRedirect">
18183	<desc>Adds a new NAT port-forwarding rule.</desc>
18184	<param name="name" type="wstring" dir="in">
18185	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
18186	auto-generates one using the other parameters.</desc>
18187	</param>
18188	<param name="proto" type="NATProtocol" dir="in">
18189	<desc>Protocol handled with the rule.</desc>
18190	</param>
18191	<param name="hostIP" type="wstring" dir="in">
18192	<desc>IP of the host interface to which the rule should apply. An empty ip address is
18193	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
18194	</param>
18195	<param name="hostPort" type="unsigned short" dir="in">
18196	<desc>The port number to listen on.</desc>
18197	</param>
18198	<param name="guestIP" type="wstring" dir="in">
18199	<desc>The IP address of the guest which the NAT engine will forward matching packets
18200	to. An empty IP address is acceptable, in which case the NAT engine will forward
18201	packets to the first DHCP lease (x.x.x.15).</desc>
18202	</param>
18203	<param name="guestPort" type="unsigned short" dir="in">
18204	<desc>The port number to forward.</desc>
18205	</param>
18206	</method>
18207	<method name="removeRedirect">
18208	<desc>Removes a port-forwarding rule that was previously registered.</desc>
18209	<param name="name" type="wstring" dir="in">
18210	<desc>The name of the rule to delete.</desc>
18211	</param>
18212	</method>
18213	</interface>
18214
18215	<!--
18216	// IExtPackManager
18217	/////////////////////////////////////////////////////////////////////////
18218	-->
18219
18220	<interface
18221	name="IExtPackPlugIn" extends="$unknown"
18222	uuid="58000040-e718-4746-bbce-4b86d96da461"
18223	wsmap="suppress"
18224	>
18225	<desc>
18226	Interface for keeping information about a plug-in that ships with an
18227	extension pack.
18228	</desc>
18229	<attribute name="name" type="wstring" readonly="yes">
18230	<desc>The plug-in name.</desc>
18231	</attribute>
18232	<attribute name="description" type="wstring" readonly="yes">
18233	<desc>The plug-in description.</desc>
18234	</attribute>
18235	<attribute name="frontend" type="wstring" readonly="yes">
18236	<desc>
18237	The name of the frontend or component name this plug-in plugs into.
18238	</desc>
18239	</attribute>
18240	<attribute name="modulePath" type="wstring" readonly="yes">
18241	<desc> The module path. </desc>
18242	</attribute>
18243	</interface>
18244
18245	<interface
18246	name="IExtPackBase" extends="$unknown"
18247	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
18248	wsmap="suppress"
18249	>
18250	<desc>
18251	Interface for querying information about an extension pack as well as
18252	accessing COM objects within it.
18253	</desc>
18254	<attribute name="name" type="wstring" readonly="yes">
18255	<desc>The extension pack name. This is unique.</desc>
18256	</attribute>
18257	<attribute name="description" type="wstring" readonly="yes">
18258	<desc>The extension pack description.</desc>
18259	</attribute>
18260	<attribute name="version" type="wstring" readonly="yes">
18261	<desc>
18262	The extension pack version string. This is restricted to the dotted
18263	version number and optionally a build indicator. No tree revision or
18264	tag will be included in the string as those things are available as
18265	separate properties. An optional publisher tag may be present like for
18266	<link to="IVirtualBox::version"/>.
18267
18268	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
18269	</desc>
18270	</attribute>
18271	<attribute name="revision" type="unsigned long" readonly="yes">
18272	<desc>The extension pack internal revision number.</desc>
18273	</attribute>
18274	<attribute name="edition" type="wstring" readonly="yes">
18275	<desc>
18276	Edition indicator. This is usually empty.
18277
18278	Can for instance be used to help distinguishing between two editions
18279	of the same extension pack where only the license, service contract or
18280	something differs.
18281	</desc>
18282	</attribute>
18283	<attribute name="VRDEModule" type="wstring" readonly="yes">
18284	<desc>The name of the VRDE module if the extension pack sports one.</desc>
18285	</attribute>
18286	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
18287	<desc>Plug-ins provided by this extension pack.</desc>
18288	</attribute>
18289	<attribute name="usable" type="boolean" readonly="yes">
18290	<desc>
18291	Indicates whether the extension pack is usable or not.
18292
18293	There are a number of reasons why an extension pack might be unusable,
18294	typical examples would be broken installation/file or that it is
18295	incompatible with the current VirtualBox version.
18296	</desc>
18297	</attribute>
18298	<attribute name="whyUnusable" type="wstring" readonly="yes">
18299	<desc>
18300	String indicating why the extension pack is not usable. This is an
18301	empty string if usable and always a non-empty string if not usable.
18302	</desc>
18303	</attribute>
18304	<attribute name="showLicense" type="boolean" readonly="yes">
18305	<desc>Whether to show the license before installation</desc>
18306	</attribute>
18307	<attribute name="license" type="wstring" readonly="yes">
18308	<desc>
18309	The default HTML license text for the extension pack. Same as
18310	calling <link to="#queryLicense">queryLicense</link> with
18311	preferredLocale and preferredLanguage as empty strings and format set
18312	to html.
18313	</desc>
18314	</attribute>
18315
18316	<method name="queryLicense">
18317	<desc>
18318	Full feature version of the license attribute.
18319	</desc>
18320	<param name="preferredLocale" type="wstring" dir="in">
18321	<desc>
18322	The preferred license locale. Pass an empty string to get the default
18323	license.
18324	</desc>
18325	</param>
18326	<param name="preferredLanguage" type="wstring" dir="in">
18327	<desc>
18328	The preferred license language. Pass an empty string to get the
18329	default language for the locale.
18330	</desc>
18331	</param>
18332	<param name="format" type="wstring" dir="in">
18333	<desc>
18334	The license format: html, rtf or txt. If a license is present there
18335	will always be an HTML of it, the rich text format (RTF) and plain
18336	text (txt) versions are optional. If
18337	</desc>
18338	</param>
18339	<param name="licenseText" type="wstring" dir="return">
18340	<desc>The license text.</desc>
18341	</param>
18342	</method>
18343
18344	</interface>
18345
18346	<interface
18347	name="IExtPack" extends="IExtPackBase"
18348	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
18349	wsmap="suppress"
18350	>
18351	<desc>
18352	Interface for querying information about an extension pack as well as
18353	accessing COM objects within it.
18354	</desc>
18355	<method name="queryObject">
18356	<desc>
18357	Queries the IUnknown interface to an object in the extension pack
18358	main module. This allows plug-ins and others to talk directly to an
18359	extension pack.
18360	</desc>
18361	<param name="objUuid" type="wstring" dir="in">
18362	<desc>The object ID. What exactly this is </desc>
18363	</param>
18364	<param name="returnInterface" type="$unknown" dir="return">
18365	<desc>The queried interface.</desc>
18366	</param>
18367	</method>
18368	</interface>
18369
18370	<interface
18371	name="IExtPackFile" extends="IExtPackBase"
18372	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
18373	wsmap="suppress"
18374	>
18375	<desc>
18376	Extension pack file (aka tarball, .vbox-extpack) representation returned
18377	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
18378	extension pack information with the addition of the file name.
18379	</desc>
18380	<attribute name="filePath" type="wstring" readonly="yes">
18381	<desc>
18382	The path to the extension pack file.
18383	</desc>
18384	</attribute>
18385
18386	<method name="install">
18387	<desc>
18388	Install the extension pack.
18389	</desc>
18390	<param name="replace" type="boolean" dir="in">
18391	<desc>
18392	Set this to automatically uninstall any existing extension pack with
18393	the same name as the one being installed.
18394	</desc>
18395	</param>
18396	<param name="displayInfo" type="wstring" dir="in">
18397	<desc>
18398	Platform specific display information. Reserved for future hacks.
18399	</desc>
18400	</param>
18401	<param name="progess" type="IProgress" dir="return">
18402	<desc>
18403	Progress object for the operation.
18404	</desc>
18405	</param>
18406	</method>
18407	</interface>
18408
18409	<interface
18410	name="IExtPackManager" extends="$unknown"
18411	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
18412	wsmap="suppress"
18413	>
18414	<desc>
18415	Interface for managing VirtualBox Extension Packs.
18416
18417	TODO: Describe extension packs, how they are managed and how to create
18418	one.
18419	</desc>
18420
18421	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
18422	<desc>
18423	List of the installed extension packs.
18424	</desc>
18425	</attribute>
18426
18427	<method name="find">
18428	<desc>
18429	Returns the extension pack with the specified name if found.
18430
18431	<result name="VBOX_E_OBJECT_NOT_FOUND">
18432	No extension pack matching @a name was found.
18433	</result>
18434	</desc>
18435	<param name="name" type="wstring" dir="in">
18436	<desc>The name of the extension pack to locate.</desc>
18437	</param>
18438	<param name="returnData" type="IExtPack" dir="return">
18439	<desc>The extension pack if found.</desc>
18440	</param>
18441	</method>
18442
18443	<method name="openExtPackFile">
18444	<desc>
18445	Attempts to open an extension pack file in preparation for
18446	installation.
18447	</desc>
18448	<param name="path" type="wstring" dir="in">
18449	<desc>The path of the extension pack tarball. This can optionally be
18450	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18451	</param>
18452	<param name="file" type="IExtPackFile" dir="return">
18453	<desc>The interface of the extension pack file object.</desc>
18454	</param>
18455	</method>
18456
18457	<method name="uninstall">
18458	<desc>Uninstalls an extension pack, removing all related files.</desc>
18459	<param name="name" type="wstring" dir="in">
18460	<desc>The name of the extension pack to uninstall.</desc>
18461	</param>
18462	<param name="forcedRemoval" type="boolean" dir="in">
18463	<desc>
18464	Forced removal of the extension pack. This means that the uninstall
18465	hook will not be called.
18466	</desc>
18467	</param>
18468	<param name="displayInfo" type="wstring" dir="in">
18469	<desc>
18470	Platform specific display information. Reserved for future hacks.
18471	</desc>
18472	</param>
18473	<param name="progess" type="IProgress" dir="return">
18474	<desc>
18475	Progress object for the operation.
18476	</desc>
18477	</param>
18478	</method>
18479
18480	<method name="cleanup">
18481	<desc>Cleans up failed installs and uninstalls</desc>
18482	</method>
18483
18484	<method name="queryAllPlugInsForFrontend">
18485	<desc>
18486	Gets the path to all the plug-in modules for a given frontend.
18487
18488	This is a convenience method that is intended to simplify the plug-in
18489	loading process for a frontend.
18490	</desc>
18491	<param name="frontendName" type="wstring" dir="in">
18492	<desc>The name of the frontend or component.</desc>
18493	</param>
18494	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18495	<desc>Array containing the plug-in modules (full paths).</desc>
18496	</param>
18497	</method>
18498
18499	<method name="isExtPackUsable">
18500	<desc>Check if the given extension pack is loaded and usable.</desc>
18501	<param name="name" type="wstring" dir="in">
18502	<desc>The name of the extension pack to check for.</desc>
18503	</param>
18504	<param name="usable" type="boolean" dir="return">
18505	<desc>Is the given extension pack loaded and usable.</desc>
18506	</param>
18507	</method>
18508
18509	</interface>
18510
18511	<!--
18512	// BandwidthGroupType
18513	/////////////////////////////////////////////////////////////////////////
18514	-->
18515	<enum
18516	name="BandwidthGroupType"
18517	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18518
18519	<desc>
18520	Type of a bandwidth control group.
18521	</desc>
18522
18523	<const name="Null" value="0">
18524	<desc>
18525	Null type, must be first.
18526	</desc>
18527	</const>
18528
18529	<const name="Disk" value="1">
18530	<desc>
18531	The bandwidth group controls disk I/O.
18532	</desc>
18533	</const>
18534
18535	<const name="Network" value="2">
18536	<desc>
18537	The bandwidth group controls network I/O.
18538	</desc>
18539	</const>
18540
18541	</enum>
18542
18543	<!--
18544	// IBandwidthGroup
18545	/////////////////////////////////////////////////////////////////////////
18546	-->
18547	<interface
18548	name="IBandwidthGroup" extends="$unknown"
18549	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18550	wsmap="managed"
18551	>
18552	<desc>Represents one bandwidth group.</desc>
18553
18554	<attribute name="name" type="wstring" readonly="yes">
18555	<desc>Name of the group.</desc>
18556	</attribute>
18557
18558	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18559	<desc>Type of the group.</desc>
18560	</attribute>
18561
18562	<attribute name="reference" type="unsigned long" readonly="yes">
18563	<desc>How many devices/medium attachements use this group.</desc>
18564	</attribute>
18565
18566	<attribute name="maxBytesPerSec" type="long long">
18567	<desc>The maximum number of bytes which can be transfered by all
18568	entities attached to this group during one second.</desc>
18569	</attribute>
18570
18571	</interface>
18572
18573	<!--
18574	// IBandwidthControl
18575	/////////////////////////////////////////////////////////////////////////
18576	-->
18577	<interface
18578	name="IBandwidthControl" extends="$unknown"
18579	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18580	wsmap="managed"
18581	>
18582	<desc>
18583	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18584	This includes network and disk I/O.
18585	</desc>
18586
18587	<attribute name="numGroups" type="unsigned long" readonly="yes">
18588	<desc>
18589	The current number of existing bandwidth groups managed.
18590	</desc>
18591	</attribute>
18592
18593	<method name="createBandwidthGroup">
18594	<desc>
18595	Creates a new bandwidth group.
18596	</desc>
18597
18598	<param name="name" type="wstring" dir="in">
18599	<desc>Name of the bandwidth group.</desc>
18600	</param>
18601	<param name="type" type="BandwidthGroupType" dir="in">
18602	<desc>The type of the bandwidth group (network or disk).</desc>
18603	</param>
18604	<param name="maxBytesPerSec" type="long long" dir="in">
18605	<desc>The maximum number of bytes which can be transfered by all
18606	entities attached to this group during one second.</desc>
18607	</param>
18608	</method>
18609
18610	<method name="deleteBandwidthGroup">
18611	<desc>
18612	Deletes a new bandwidth group.
18613	</desc>
18614
18615	<param name="name" type="wstring" dir="in">
18616	<desc>Name of the bandwidth group to delete.</desc>
18617	</param>
18618	</method>
18619
18620	<method name="getBandwidthGroup" const="yes">
18621	<desc>
18622	Get a bandwidth group by name.
18623	</desc>
18624
18625	<param name="name" type="wstring" dir="in">
18626	<desc>Name of the bandwidth group to get.</desc>
18627	</param>
18628	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18629	<desc>Where to store the bandwidth group on success.</desc>
18630	</param>
18631	</method>
18632
18633	<method name="getAllBandwidthGroups" const="yes">
18634	<desc>
18635	Get all managed bandwidth groups.
18636	</desc>
18637
18638	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18639	<desc>The array of managed bandwidth groups.</desc>
18640	</param>
18641	</method>
18642	</interface>
18643
18644	<!--
18645	// IVirtualBoxClient
18646	/////////////////////////////////////////////////////////////////////////
18647	-->
18648
18649	<interface
18650	name="IVirtualBoxClient" extends="$unknown"
18651	uuid="d191281f-b0cb-4d83-a8fa-0d9fd6ba234c"
18652	wsmap="suppress"
18653	>
18654	<desc>
18655	Convenience interface for client applications. Treat this as a
18656	singleton, i.e. never create more than one instance of this interface.
18657
18658	At the moment only available for clients of the local API (not usable
18659	via the webservice). Once the session logic is redesigned this might
18660	change.
18661	</desc>
18662
18663	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18664	<desc>
18665	Reference to the server-side API root object.
18666	</desc>
18667	</attribute>
18668
18669	<attribute name="session" type="ISession" readonly="yes">
18670	<desc>
18671	Create a new session object and return the reference to it.
18672	</desc>
18673	</attribute>
18674
18675	<attribute name="eventSource" type="IEventSource" readonly="yes">
18676	<desc>
18677	Event source for VirtualBoxClient events.
18678	</desc>
18679	</attribute>
18680
18681	<method name="checkMachineError">
18682	<desc>
18683	Perform error checking before using an <link to="IMachine"/> object.
18684	Generally useful before starting a VM and all other uses. If anything
18685	is not as it should be then this method will return an appropriate
18686	error.
18687	</desc>
18688
18689	<param name="machine" type="IMachine" dir="in">
18690	<desc>The machine object to check.</desc>
18691	</param>
18692	</method>
18693	</interface>
18694
18695	<!--
18696	// Events
18697	/////////////////////////////////////////////////////////////////////////
18698	-->
18699	<enum
18700	name="VBoxEventType"
18701	uuid="c51645b3-7108-4dce-b5a3-bbf5e4f69ed2"
18702	>
18703
18704	<desc>
18705	Type of an event.
18706	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18707	</desc>
18708
18709	<const name="Invalid" value="0">
18710	<desc>
18711	Invalid event, must be first.
18712	</desc>
18713	</const>
18714
18715	<const name="Any" value="1">
18716	<desc>
18717	Wildcard for all events.
18718	Events of this type are never delivered, and only used in
18719	<link to="IEventSource::registerListener"/> call to simplify registration.
18720	</desc>
18721	</const>
18722
18723	<const name="Vetoable" value="2">
18724	<desc>
18725	Wildcard for all vetoable events. Events of this type are never delivered, and only
18726	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18727	</desc>
18728	</const>
18729
18730	<const name="MachineEvent" value="3">
18731	<desc>
18732	Wildcard for all machine events. Events of this type are never delivered, and only used in
18733	<link to="IEventSource::registerListener"/> call to simplify registration.
18734	</desc>
18735	</const>
18736
18737	<const name="SnapshotEvent" value="4">
18738	<desc>
18739	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18740	<link to="IEventSource::registerListener"/> call to simplify registration.
18741	</desc>
18742	</const>
18743
18744	<const name="InputEvent" value="5">
18745	<desc>
18746	Wildcard for all input device (keyboard, mouse) events.
18747	Events of this type are never delivered, and only used in
18748	<link to="IEventSource::registerListener"/> call to simplify registration.
18749	</desc>
18750	</const>
18751
18752	<const name="LastWildcard" value="31">
18753	<desc>
18754	Last wildcard.
18755	</desc>
18756	</const>
18757
18758	<const name="OnMachineStateChanged" value="32">
18759	<desc>
18760	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18761	</desc>
18762	</const>
18763	<const name="OnMachineDataChanged" value="33">
18764	<desc>
18765	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18766	</desc>
18767	</const>
18768	<const name="OnExtraDataChanged" value="34">
18769	<desc>
18770	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18771	</desc>
18772	</const>
18773	<const name="OnExtraDataCanChange" value="35">
18774	<desc>
18775	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18776	</desc>
18777	</const>
18778	<const name="OnMediumRegistered" value="36">
18779	<desc>
18780	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18781	</desc>
18782	</const>
18783	<const name="OnMachineRegistered" value="37">
18784	<desc>
18785	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18786	</desc>
18787	</const>
18788	<const name="OnSessionStateChanged" value="38">
18789	<desc>
18790	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18791	</desc>
18792	</const>
18793	<const name="OnSnapshotTaken" value="39">
18794	<desc>
18795	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18796	</desc>
18797	</const>
18798	<const name="OnSnapshotDeleted" value="40">
18799	<desc>
18800	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18801	</desc>
18802	</const>
18803	<const name="OnSnapshotChanged" value="41">
18804	<desc>
18805	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18806	</desc>
18807	</const>
18808	<const name="OnGuestPropertyChanged" value="42">
18809	<desc>
18810	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18811	</desc>
18812	</const>
18813	<!-- Console events -->
18814	<const name="OnMousePointerShapeChanged" value="43">
18815	<desc>
18816	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18817	</desc>
18818	</const>
18819	<const name="OnMouseCapabilityChanged" value="44">
18820	<desc>
18821	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18822	</desc>
18823	</const>
18824	<const name="OnKeyboardLedsChanged" value="45">
18825	<desc>
18826	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18827	</desc>
18828	</const>
18829	<const name="OnStateChanged" value="46">
18830	<desc>
18831	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18832	</desc>
18833	</const>
18834	<const name="OnAdditionsStateChanged" value="47">
18835	<desc>
18836	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18837	</desc>
18838	</const>
18839	<const name="OnNetworkAdapterChanged" value="48">
18840	<desc>
18841	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18842	</desc>
18843	</const>
18844	<const name="OnSerialPortChanged" value="49">
18845	<desc>
18846	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18847	</desc>
18848	</const>
18849	<const name="OnParallelPortChanged" value="50">
18850	<desc>
18851	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18852	</desc>
18853	</const>
18854	<const name="OnStorageControllerChanged" value="51">
18855	<desc>
18856	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18857	</desc>
18858	</const>
18859	<const name="OnMediumChanged" value="52">
18860	<desc>
18861	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18862	</desc>
18863	</const>
18864	<const name="OnVRDEServerChanged" value="53">
18865	<desc>
18866	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18867	</desc>
18868	</const>
18869	<const name="OnUSBControllerChanged" value="54">
18870	<desc>
18871	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18872	</desc>
18873	</const>
18874	<const name="OnUSBDeviceStateChanged" value="55">
18875	<desc>
18876	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18877	</desc>
18878	</const>
18879	<const name="OnSharedFolderChanged" value="56">
18880	<desc>
18881	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18882	</desc>
18883	</const>
18884	<const name="OnRuntimeError" value="57">
18885	<desc>
18886	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18887	</desc>
18888	</const>
18889	<const name="OnCanShowWindow" value="58">
18890	<desc>
18891	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18892	</desc>
18893	</const>
18894	<const name="OnShowWindow" value="59">
18895	<desc>
18896	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18897	</desc>
18898	</const>
18899	<const name="OnCPUChanged" value="60">
18900	<desc>
18901	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18902	</desc>
18903	</const>
18904	<const name="OnVRDEServerInfoChanged" value="61">
18905	<desc>
18906	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18907	</desc>
18908	</const>
18909	<const name="OnEventSourceChanged" value="62">
18910	<desc>
18911	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18912	</desc>
18913	</const>
18914	<const name="OnCPUExecutionCapChanged" value="63">
18915	<desc>
18916	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18917	</desc>
18918	</const>
18919	<const name="OnGuestKeyboard" value="64">
18920	<desc>
18921	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18922	</desc>
18923	</const>
18924	<const name="OnGuestMouse" value="65">
18925	<desc>
18926	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18927	</desc>
18928	</const>
18929	<const name="OnNATRedirect" value="66">
18930	<desc>
18931	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18932	</desc>
18933	</const>
18934	<const name="OnHostPCIDevicePlug" value="67">
18935	<desc>
18936	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
18937	</desc>
18938	</const>
18939	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18940	<desc>
18941	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18942	</desc>
18943	</const>
18944	<const name="OnBandwidthGroupChanged" value="69">
18945	<desc>
18946	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18947	</desc>
18948	</const>
18949	<const name="OnGuestMonitorChanged" value="70">
18950	<desc>
18951	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18952	</desc>
18953	</const>
18954	<const name="OnStorageDeviceChanged" value="71">
18955	<desc>
18956	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18957	</desc>
18958	</const>
18959	<const name="OnClipboardModeChanged" value="72">
18960	<desc>
18961	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18962	</desc>
18963	</const>
18964	<const name="OnDragAndDropModeChanged" value="73">
18965	<desc>
18966	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
18967	</desc>
18968	</const>
18969	<const name="OnNATNetworkChanged" value="74">
18970	<desc>
18971	See <link to="INATNetworkChangedEvent">INATNetworkChangedEvent</link>.
18972	</desc>
18973	</const>
18974	<const name="OnNATNetworkStartStop" value="75">
18975	<desc>
18976	See <link to="INATNetworkStartStopEvent">INATNetworkStartStopEvent</link>.
18977	</desc>
18978	</const>
18979	<const name="OnNATNetworkAlter" value="76">
18980	<desc>
18981	See <link to="INATNetworkAlterEvent">INATNetworkAlterEvent</link>.
18982	</desc>
18983	</const>
18984	<const name="OnNATNetworkCreationDeletion" value="77">
18985	<desc>
18986	See <link to="INATNetworkCreationDeletionEvent">INATNetworkCreationDeletionEvent</link>.
18987	</desc>
18988	</const>
18989	<const name="OnNATNetworkSetting" value="78">
18990	<desc>
18991	See <link to="INATNetworkSettingEvent">INATNetworkSettingEvent</link>.
18992	</desc>
18993	</const>
18994	<const name="OnNATNetworkPortForward" value="79">
18995	<desc>
18996	See <link to="INATNetworkPortForwardEvent">INATNetworkPortForwardEvent</link>.
18997	</desc>
18998	</const>
18999	<const name="OnGuestSessionStateChanged" value="80">
19000	<desc>
19001	See <link to="IGuestSessionStateChangedEvent">IGuestSessionStateChangedEvent</link>.
19002	</desc>
19003	</const>
19004	<const name="OnGuestSessionRegistered" value="81">
19005	<desc>
19006	See <link to="IGuestSessionRegisteredEvent">IGuestSessionRegisteredEvent</link>.
19007	</desc>
19008	</const>
19009	<const name="OnGuestProcessRegistered" value="82">
19010	<desc>
19011	See <link to="IGuestProcessRegisteredEvent">IGuestProcessRegisteredEvent</link>.
19012	</desc>
19013	</const>
19014	<const name="OnGuestProcessStateChanged" value="83">
19015	<desc>
19016	See <link to="IGuestProcessStateChangedEvent">IGuestProcessStateChangedEvent</link>.
19017	</desc>
19018	</const>
19019	<const name="OnGuestProcessInputNotify" value="84">
19020	<desc>
19021	See <link to="IGuestProcessInputNotifyEvent">IGuestProcessInputNotifyEvent</link>.
19022	</desc>
19023	</const>
19024	<const name="OnGuestProcessOutput" value="85">
19025	<desc>
19026	See <link to="IGuestProcessOutputEvent">IGuestProcessOutputEvent</link>.
19027	</desc>
19028	</const>
19029	<const name="OnGuestFileRegistered" value="86">
19030	<desc>
19031	See <link to="IGuestFileRegisteredEvent">IGuestFileRegisteredEvent</link>.
19032	</desc>
19033	</const>
19034	<const name="OnGuestFileStateChanged" value="87">
19035	<desc>
19036	See <link to="IGuestFileStateChangedEvent">IGuestFileStateChangedEvent</link>.
19037	</desc>
19038	</const>
19039	<const name="OnGuestFileOffsetChanged" value="88">
19040	<desc>
19041	See <link to="IGuestFileOffsetChangedEvent">IGuestFileOffsetChangedEvent</link>.
19042	</desc>
19043	</const>
19044	<const name="OnGuestFileRead" value="89">
19045	<desc>
19046	See <link to="IGuestFileReadEvent">IGuestFileReadEvent</link>.
19047
19048	<note internal="yes">For performance reasons this is a separate event to
19049	not unnecessarily overflow the event queue.</note>
19050	</desc>
19051	</const>
19052	<const name="OnGuestFileWrite" value="90">
19053	<desc>
19054	See <link to="IGuestFileWriteEvent">IGuestFileWriteEvent</link>.
19055
19056	<note internal="yes">For performance reasons this is a separate event to
19057	not unnecessarily overflow the event queue.</note>
19058	</desc>
19059	</const>
19060	<!-- Last event marker -->
19061	<const name="Last" value="91">
19062	<desc>
19063	Must be last event, used for iterations and structures relying on numerical event values.
19064	</desc>
19065	</const>
19066
19067	</enum>
19068
19069	<interface
19070	name="IEventSource" extends="$unknown"
19071	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
19072	wsmap="managed"
19073	>
19074	<desc>
19075	Event source. Generally, any object which could generate events can be an event source,
19076	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
19077	an event source can work with listeners in either active or passive mode. In active mode it is up to
19078	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
19079	event source keeps track of pending events for each listener and returns available events on demand.
19080
19081	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19082	</desc>
19083
19084	<method name="createListener">
19085	<desc>
19086	Creates a new listener object, useful for passive mode.
19087	</desc>
19088	<param name="listener" type="IEventListener" dir="return"/>
19089	</method>
19090
19091	<method name="createAggregator">
19092	<desc>
19093	Creates an aggregator event source, collecting events from multiple sources.
19094	This way a single listener can listen for events coming from multiple sources,
19095	using a single blocking <link to="#getEvent"/> on the returned aggregator.
19096	</desc>
19097	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
19098	<desc>
19099	Subordinate event source this one aggregatres.
19100	</desc>
19101	</param>
19102	<param name="result" type="IEventSource" dir="return">
19103	<desc>
19104	Event source aggregating passed sources.
19105	</desc>
19106	</param>
19107	</method>
19108
19109	<method name="registerListener">
19110	<desc>
19111	Register an event listener.
19112
19113	<note>
19114	To avoid system overload, the VirtualBox server process checks if passive event
19115	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
19116	current implementation, if more than 500 pending events are detected for a passive
19117	event listener, it is forcefully unregistered by the system, and further
19118	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
19119	</note>
19120	</desc>
19121	<param name="listener" type="IEventListener" dir="in">
19122	<desc>Listener to register.</desc>
19123	</param>
19124	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
19125	<desc>
19126	Event types listener is interested in. One can use wildcards like -
19127	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
19128	than one event.
19129	</desc>
19130	</param>
19131	<param name="active" type="boolean" dir="in">
19132	<desc>
19133	Which mode this listener is operating in.
19134	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
19135	In passive mode, an internal event queue is created for this this IEventListener.
19136	For each event coming in, it is added to queues for all interested registered passive
19137	listeners. It is then up to the external code to call the listener's
19138	<link to="IEventListener::handleEvent" /> method. When done with an event, the
19139	external code must call <link to="#eventProcessed" />.
19140	</desc>
19141	</param>
19142	</method>
19143
19144	<method name="unregisterListener">
19145	<desc>
19146	Unregister an event listener. If listener is passive, and some waitable events are still
19147	in queue they are marked as processed automatically.
19148	</desc>
19149	<param name="listener" type="IEventListener" dir="in">
19150	<desc>Listener to unregister.</desc>
19151	</param>
19152	</method>
19153
19154	<method name="fireEvent">
19155	<desc>
19156	Fire an event for this source.
19157	</desc>
19158	<param name="event" type="IEvent" dir="in">
19159	<desc>Event to deliver.</desc>
19160	</param>
19161	<param name="timeout" type="long" dir="in">
19162	<desc>
19163	Maximum time to wait for event processing (if event is waitable), in ms;
19164	0 = no wait, -1 = indefinite wait.
19165	</desc>
19166	</param>
19167	<param name="result" type="boolean" dir="return">
19168	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
19169	</param>
19170	</method>
19171
19172	<method name="getEvent">
19173	<desc>
19174	Get events from this peer's event queue (for passive mode). Calling this method
19175	regularly is required for passive event listeners to avoid system overload;
19176	see <link to="IEventSource::registerListener" /> for details.
19177
19178	<result name="VBOX_E_OBJECT_NOT_FOUND">
19179	Listener is not registered, or autounregistered.
19180	</result>
19181	</desc>
19182	<param name="listener" type="IEventListener" dir="in">
19183	<desc>Which listener to get data for.</desc>
19184	</param>
19185	<param name="timeout" type="long" dir="in">
19186	<desc>
19187	Maximum time to wait for events, in ms;
19188	0 = no wait, -1 = indefinite wait.
19189	</desc>
19190	</param>
19191	<param name="event" type="IEvent" dir="return">
19192	<desc>Event retrieved, or null if none available.</desc>
19193	</param>
19194	</method>
19195
19196	<method name="eventProcessed">
19197	<desc>
19198	Must be called for waitable events after a particular listener finished its
19199	event processing. When all listeners of a particular event have called this
19200	method, the system will then call <link to="IEvent::setProcessed" />.
19201	</desc>
19202	<param name="listener" type="IEventListener" dir="in">
19203	<desc>Which listener processed event.</desc>
19204	</param>
19205	<param name="event" type="IEvent" dir="in">
19206	<desc>Which event.</desc>
19207	</param>
19208	</method>
19209
19210	</interface>
19211
19212	<interface
19213	name="IEventListener" extends="$unknown"
19214	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
19215	wsmap="managed"
19216	>
19217	<desc>
19218	Event listener. An event listener can work in either active or passive mode, depending on the way
19219	it was registered.
19220	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
19221	</desc>
19222
19223	<method name="handleEvent">
19224	<desc>
19225	Handle event callback for active listeners. It is not called for
19226	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
19227	and having received acknowledgement from all passive listeners via
19228	<link to="IEventSource::eventProcessed"/>, the event is marked as
19229	processed and <link to="IEvent::waitProcessed"/> will return
19230	immediately.
19231	</desc>
19232	<param name="event" type="IEvent" dir="in">
19233	<desc>Event available.</desc>
19234	</param>
19235	</method>
19236
19237	</interface>
19238
19239	<interface
19240	name="IEvent" extends="$unknown"
19241	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
19242	wsmap="managed"
19243	>
19244	<desc>
19245	Abstract parent interface for VirtualBox events. Actual events will typically implement
19246	a more specific interface which derives from this (see below).
19247
19248	<b>Introduction to VirtualBox events</b>
19249
19250	Generally speaking, an event (represented by this interface) signals that something
19251	happened, while an event listener (see <link to="IEventListener" />) represents an
19252	entity that is interested in certain events. In order for this to work with
19253	unidirectional protocols (i.e. web services), the concepts of passive and active
19254	listener are used.
19255
19256	Event consumers can register themselves as listeners, providing an array of
19257	events they are interested in (see <link to="IEventSource::registerListener" />).
19258	When an event triggers, the listener is notified about the event. The exact
19259	mechanism of the notification depends on whether the listener was registered as
19260	an active or passive listener:
19261
19262	<ul>
19263	<li>An active listener is very similar to a callback: it is a function invoked
19264	by the API. As opposed to the callbacks that were used in the API before
19265	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
19266	</li>
19267
19268	<li>Passive listeners are somewhat trickier to implement, but do not require
19269	a client function to be callable, which is not an option with scripting
19270	languages or web service clients. Internally the <link to="IEventSource" />
19271	implementation maintains an event queue for each passive listener, and
19272	newly arrived events are put in this queue. When the listener calls
19273	<link to="IEventSource::getEvent"/>, first element from its internal event
19274	queue is returned. When the client completes processing of an event,
19275	the <link to="IEventSource::eventProcessed" /> function must be called,
19276	acknowledging that the event was processed. It supports implementing
19277	waitable events. On passive listener unregistration, all events from its
19278	queue are auto-acknowledged.
19279	</li>
19280	</ul>
19281
19282	Waitable events are useful in situations where the event generator wants to track
19283	delivery or a party wants to wait until all listeners have completed the event. A
19284	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
19285	listeners might veto a certain action, and thus the event producer has to make
19286	sure that all listeners have processed the event and not vetoed before taking
19287	the action.
19288
19289	A given event may have both passive and active listeners at the same time.
19290
19291	<b>Using events</b>
19292
19293	Any VirtualBox object capable of producing externally visible events provides an
19294	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
19295	This event source object is notified by VirtualBox once something has happened, so
19296	consumers may register event listeners with this event source. To register a listener,
19297	an object implementing the <link to="IEventListener" /> interface must be provided.
19298	For active listeners, such an object is typically created by the consumer, while for
19299	passive listeners <link to="IEventSource::createListener" /> should be used. Please
19300	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
19301
19302	Once created, the listener must be registered to listen for the desired events
19303	(see <link to="IEventSource::registerListener" />), providing an array of
19304	<link to="VBoxEventType" /> enums. Those elements can either be the individual
19305	event IDs or wildcards matching multiple event IDs.
19306
19307	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
19308	called automatically when the event is triggered, while passive listeners have to call
19309	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
19310	an event processing loop.
19311
19312	The IEvent interface is an abstract parent interface for all such VirtualBox events
19313	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
19314	or the event processing loop is to check the <link to="#type" /> attribute of the event and
19315	then cast to the appropriate specific interface using @c QueryInterface().
19316	</desc>
19317
19318	<attribute name="type" readonly="yes" type="VBoxEventType">
19319	<desc>
19320	Event type.
19321	</desc>
19322	</attribute>
19323
19324	<attribute name="source" readonly="yes" type="IEventSource">
19325	<desc>
19326	Source of this event.
19327	</desc>
19328	</attribute>
19329
19330	<attribute name="waitable" readonly="yes" type="boolean">
19331	<desc>
19332	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
19333	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
19334	as no additional overhead associated with waitability imposed.
19335	Waitable events are needed when one need to be able to wait for particular event processed,
19336	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
19337	until all consumers confirmed events.
19338	</desc>
19339	</attribute>
19340
19341	<method name="setProcessed">
19342	<desc>
19343	Internal method called by the system when all listeners of a particular event have called
19344	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
19345	</desc>
19346	</method>
19347
19348	<method name="waitProcessed">
19349	<desc>
19350	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
19351	described semantics, for non-waitable returns true immediately.
19352	</desc>
19353	<param name="timeout" type="long" dir="in">
19354	<desc>
19355	Maximum time to wait for event processeing, in ms;
19356	0 = no wait, -1 = indefinite wait.
19357	</desc>
19358	</param>
19359	<param name="result" type="boolean" dir="return">
19360	<desc>If this event was processed before timeout.</desc>
19361	</param>
19362	</method>
19363	</interface>
19364
19365
19366	<interface
19367	name="IReusableEvent" extends="IEvent"
19368	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
19369	wsmap="managed"
19370	>
19371	<desc>Base abstract interface for all reusable events.</desc>
19372
19373	<attribute name="generation" readonly="yes" type="unsigned long">
19374	<desc>Current generation of event, incremented on reuse.</desc>
19375	</attribute>
19376
19377	<method name="reuse">
19378	<desc>
19379	Marks an event as reused, increments 'generation', fields shall no
19380	longer be considered valid.
19381	</desc>
19382	</method>
19383	</interface>
19384
19385	<interface
19386	name="IMachineEvent" extends="IEvent"
19387	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
19388	wsmap="managed" id="MachineEvent"
19389	>
19390	<desc>Base abstract interface for all machine events.</desc>
19391
19392	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
19393	<desc>ID of the machine this event relates to.</desc>
19394	</attribute>
19395
19396	</interface>
19397
19398	<interface
19399	name="IMachineStateChangedEvent" extends="IMachineEvent"
19400	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
19401	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
19402	>
19403	<desc>Machine state change event.</desc>
19404
19405	<attribute name="state" readonly="yes" type="MachineState">
19406	<desc>New execution state.</desc>
19407	</attribute>
19408	</interface>
19409
19410	<interface
19411	name="IMachineDataChangedEvent" extends="IMachineEvent"
19412	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
19413	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
19414	>
19415	<desc>
19416	Any of the settings of the given machine has changed.
19417	</desc>
19418
19419	<attribute name="temporary" readonly="yes" type="boolean">
19420	<desc>@c true if the settings change is temporary. All permanent
19421	settings changes will trigger an event, and only temporary settings
19422	changes for running VMs will trigger an event. Note: sending events
19423	for temporary changes is NOT IMPLEMENTED.</desc>
19424	</attribute>
19425	</interface>
19426
19427	<interface
19428	name="IMediumRegisteredEvent" extends="IEvent"
19429	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
19430	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
19431	>
19432	<desc>
19433	The given medium was registered or unregistered
19434	within this VirtualBox installation.
19435	</desc>
19436
19437	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
19438	<desc>ID of the medium this event relates to.</desc>
19439	</attribute>
19440
19441	<attribute name="mediumType" readonly="yes" type="DeviceType">
19442	<desc>Type of the medium this event relates to.</desc>
19443	</attribute>
19444
19445	<attribute name="registered" type="boolean" readonly="yes">
19446	<desc>
19447	If @c true, the medium was registered, otherwise it was
19448	unregistered.
19449	</desc>
19450	</attribute>
19451	</interface>
19452
19453	<interface
19454	name="IMachineRegisteredEvent" extends="IMachineEvent"
19455	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
19456	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
19457	>
19458	<desc>
19459	The given machine was registered or unregistered
19460	within this VirtualBox installation.
19461	</desc>
19462
19463	<attribute name="registered" type="boolean" readonly="yes">
19464	<desc>
19465	If @c true, the machine was registered, otherwise it was
19466	unregistered.
19467	</desc>
19468	</attribute>
19469	</interface>
19470
19471	<interface
19472	name="ISessionStateChangedEvent" extends="IMachineEvent"
19473	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
19474	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
19475	>
19476	<desc>
19477	The state of the session for the given machine was changed.
19478	<see><link to="IMachine::sessionState"/></see>
19479	</desc>
19480
19481	<attribute name="state" type="SessionState" readonly="yes">
19482	<desc>
19483	New session state.
19484	</desc>
19485	</attribute>
19486	</interface>
19487
19488	<interface
19489	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
19490	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
19491	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
19492	>
19493	<desc>
19494	Notification when a guest property has changed.
19495	</desc>
19496
19497	<attribute name="name" readonly="yes" type="wstring">
19498	<desc>
19499	The name of the property that has changed.
19500	</desc>
19501	</attribute>
19502
19503	<attribute name="value" readonly="yes" type="wstring">
19504	<desc>
19505	The new property value.
19506	</desc>
19507	</attribute>
19508
19509	<attribute name="flags" readonly="yes" type="wstring">
19510	<desc>
19511	The new property flags.
19512	</desc>
19513	</attribute>
19514
19515	</interface>
19516
19517	<interface
19518	name="ISnapshotEvent" extends="IMachineEvent"
19519	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
19520	wsmap="managed" id="SnapshotEvent"
19521	>
19522	<desc>Base interface for all snapshot events.</desc>
19523
19524	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
19525	<desc>ID of the snapshot this event relates to.</desc>
19526	</attribute>
19527
19528	</interface>
19529
19530	<interface
19531	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
19532	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
19533	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
19534	>
19535	<desc>
19536	A new snapshot of the machine has been taken.
19537	<see><link to="ISnapshot"/></see>
19538	</desc>
19539	</interface>
19540
19541	<interface
19542	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
19543	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19544	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19545	>
19546	<desc>
19547	Snapshot of the given machine has been deleted.
19548
19549	<note>
19550	This notification is delivered <b>after</b> the snapshot
19551	object has been uninitialized on the server (so that any
19552	attempt to call its methods will return an error).
19553	</note>
19554
19555	<see><link to="ISnapshot"/></see>
19556	</desc>
19557	</interface>
19558
19559	<interface
19560	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19561	uuid="07541941-8079-447a-a33e-47a69c7980db"
19562	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19563	>
19564	<desc>
19565	Snapshot properties (name and/or description) have been changed.
19566	<see><link to="ISnapshot"/></see>
19567	</desc>
19568	</interface>
19569
19570	<interface
19571	name="IMousePointerShapeChangedEvent" extends="IEvent"
19572	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19573	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19574	>
19575	<desc>
19576	Notification when the guest mouse pointer shape has
19577	changed. The new shape data is given.
19578	</desc>
19579
19580	<attribute name="visible" type="boolean" readonly="yes">
19581	<desc>
19582	Flag whether the pointer is visible.
19583	</desc>
19584	</attribute>
19585	<attribute name="alpha" type="boolean" readonly="yes">
19586	<desc>
19587	Flag whether the pointer has an alpha channel.
19588	</desc>
19589	</attribute>
19590	<attribute name="xhot" type="unsigned long" readonly="yes">
19591	<desc>
19592	The pointer hot spot X coordinate.
19593	</desc>
19594	</attribute>
19595	<attribute name="yhot" type="unsigned long" readonly="yes">
19596	<desc>
19597	The pointer hot spot Y coordinate.
19598	</desc>
19599	</attribute>
19600	<attribute name="width" type="unsigned long" readonly="yes">
19601	<desc>
19602	Width of the pointer shape in pixels.
19603	</desc>
19604	</attribute>
19605	<attribute name="height" type="unsigned long" readonly="yes">
19606	<desc>
19607	Height of the pointer shape in pixels.
19608	</desc>
19609	</attribute>
19610	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19611	<desc>
19612	Shape buffer arrays.
19613
19614	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19615	followed by a 32-bpp XOR (color) mask.
19616
19617	For pointers without alpha channel the XOR mask pixels are 32
19618	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19619	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19620
19621	An AND mask is used for pointers with alpha channel, so if the
19622	callback does not support alpha, the pointer could be
19623	displayed as a normal color pointer.
19624
19625	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19626	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19627	height</tt>. The padding bits at the end of each scanline are
19628	undefined.
19629
19630	The XOR mask follows the AND mask on the next 4-byte aligned
19631	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19632	Bytes in the gap between the AND and the XOR mask are undefined.
19633	The XOR mask scanlines have no gap between them and the size of
19634	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19635
19636	<note>
19637	If @a shape is 0, only the pointer visibility is changed.
19638	</note>
19639	</desc>
19640	</attribute>
19641	</interface>
19642
19643	<interface
19644	name="IMouseCapabilityChangedEvent" extends="IEvent"
19645	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19646	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19647	>
19648	<desc>
19649	Notification when the mouse capabilities reported by the
19650	guest have changed. The new capabilities are passed.
19651	</desc>
19652	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19653	<desc>
19654	Supports absolute coordinates.
19655	</desc>
19656	</attribute>
19657	<attribute name="supportsRelative" type="boolean" readonly="yes">
19658	<desc>
19659	Supports relative coordinates.
19660	</desc>
19661	</attribute>
19662	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19663	<desc>
19664	If host cursor is needed.
19665	</desc>
19666	</attribute>
19667	</interface>
19668
19669	<interface
19670	name="IKeyboardLedsChangedEvent" extends="IEvent"
19671	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19672	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19673	>
19674	<desc>
19675	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19676	to alter the state of the keyboard LEDs.
19677	</desc>
19678	<attribute name="numLock" type="boolean" readonly="yes">
19679	<desc>
19680	NumLock status.
19681	</desc>
19682	</attribute>
19683	<attribute name="capsLock" type="boolean" readonly="yes">
19684	<desc>
19685	CapsLock status.
19686	</desc>
19687	</attribute>
19688	<attribute name="scrollLock" type="boolean" readonly="yes">
19689	<desc>
19690	ScrollLock status.
19691	</desc>
19692	</attribute>
19693	</interface>
19694
19695	<interface
19696	name="IStateChangedEvent" extends="IEvent"
19697	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19698	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19699	>
19700	<desc>
19701	Notification when the execution state of the machine has changed.
19702	The new state is given.
19703	</desc>
19704	<attribute name="state" type="MachineState" readonly="yes">
19705	<desc>
19706	New machine state.
19707	</desc>
19708	</attribute>
19709	</interface>
19710
19711	<interface
19712	name="IAdditionsStateChangedEvent" extends="IEvent"
19713	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19714	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19715	>
19716	<desc>
19717	Notification when a Guest Additions property changes.
19718	Interested callees should query IGuest attributes to
19719	find out what has changed.
19720	</desc>
19721	</interface>
19722
19723	<interface
19724	name="INetworkAdapterChangedEvent" extends="IEvent"
19725	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19726	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19727	>
19728	<desc>
19729	Notification when a property of one of the
19730	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19731	changes. Interested callees should use INetworkAdapter methods and
19732	attributes to find out what has changed.
19733	</desc>
19734	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19735	<desc>
19736	Network adapter that is subject to change.
19737	</desc>
19738	</attribute>
19739	</interface>
19740
19741	<interface
19742	name="ISerialPortChangedEvent" extends="IEvent"
19743	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19744	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19745	>
19746	<desc>
19747	Notification when a property of one of the
19748	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19749	Interested callees should use ISerialPort methods and attributes
19750	to find out what has changed.
19751	</desc>
19752	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19753	<desc>
19754	Serial port that is subject to change.
19755	</desc>
19756	</attribute>
19757	</interface>
19758
19759	<interface
19760	name="IParallelPortChangedEvent" extends="IEvent"
19761	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19762	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19763	>
19764	<desc>
19765	Notification when a property of one of the
19766	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19767	changes. Interested callees should use ISerialPort methods and
19768	attributes to find out what has changed.
19769	</desc>
19770	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19771	<desc>
19772	Parallel port that is subject to change.
19773	</desc>
19774	</attribute>
19775	</interface>
19776
19777	<interface
19778	name="IStorageControllerChangedEvent" extends="IEvent"
19779	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19780	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19781	>
19782	<desc>
19783	Notification when a
19784	<link to="IMachine::mediumAttachments">medium attachment</link>
19785	changes.
19786	</desc>
19787	</interface>
19788
19789	<interface
19790	name="IMediumChangedEvent" extends="IEvent"
19791	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19792	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19793	>
19794	<desc>
19795	Notification when a
19796	<link to="IMachine::mediumAttachments">medium attachment</link>
19797	changes.
19798	</desc>
19799	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19800	<desc>
19801	Medium attachment that is subject to change.
19802	</desc>
19803	</attribute>
19804	</interface>
19805
19806	<interface
19807	name="IClipboardModeChangedEvent" extends="IEvent"
19808	uuid="cac21692-7997-4595-a731-3a509db604e5"
19809	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19810	>
19811	<desc>
19812	Notification when the shared clipboard mode changes.
19813	</desc>
19814	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19815	<desc>
19816	The new clipboard mode.
19817	</desc>
19818	</attribute>
19819	</interface>
19820
19821	<interface
19822	name="IDragAndDropModeChangedEvent" extends="IEvent"
19823	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19824	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19825	>
19826	<desc>
19827	Notification when the drag'n'drop mode changes.
19828	</desc>
19829	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19830	<desc>
19831	The new drag'n'drop mode.
19832	</desc>
19833	</attribute>
19834	</interface>
19835
19836	<interface
19837	name="ICPUChangedEvent" extends="IEvent"
19838	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19839	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19840	>
19841	<desc>
19842	Notification when a CPU changes.
19843	</desc>
19844	<attribute name="CPU" type="unsigned long" readonly="yes">
19845	<desc>
19846	The CPU which changed.
19847	</desc>
19848	</attribute>
19849	<attribute name="add" type="boolean" readonly="yes">
19850	<desc>
19851	Flag whether the CPU was added or removed.
19852	</desc>
19853	</attribute>
19854	</interface>
19855
19856	<interface
19857	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19858	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19859	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19860	>
19861	<desc>
19862	Notification when the CPU execution cap changes.
19863	</desc>
19864	<attribute name="executionCap" type="unsigned long" readonly="yes">
19865	<desc>
19866	The new CPU execution cap value. (1-100)
19867	</desc>
19868	</attribute>
19869	</interface>
19870
19871	<interface
19872	name="IGuestKeyboardEvent" extends="IEvent"
19873	uuid="88394258-7006-40d4-b339-472ee3801844"
19874	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19875	>
19876	<desc>
19877	Notification when guest keyboard event happens.
19878	</desc>
19879	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19880	<desc>
19881	Array of scancodes.
19882	</desc>
19883	</attribute>
19884	</interface>
19885
19886	<interface
19887	name="IGuestMouseEvent" extends="IReusableEvent"
19888	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19889	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19890	>
19891	<desc>
19892	Notification when guest mouse event happens.
19893	</desc>
19894
19895	<attribute name="absolute" type="boolean" readonly="yes">
19896	<desc>
19897	If this event is relative or absolute.
19898	</desc>
19899	</attribute>
19900
19901	<attribute name="x" type="long" readonly="yes">
19902	<desc>
19903	New X position, or X delta.
19904	</desc>
19905	</attribute>
19906
19907	<attribute name="y" type="long" readonly="yes">
19908	<desc>
19909	New Y position, or Y delta.
19910	</desc>
19911	</attribute>
19912
19913	<attribute name="z" type="long" readonly="yes">
19914	<desc>
19915	Z delta.
19916	</desc>
19917	</attribute>
19918
19919	<attribute name="w" type="long" readonly="yes">
19920	<desc>
19921	W delta.
19922	</desc>
19923	</attribute>
19924
19925	<attribute name="buttons" type="long" readonly="yes">
19926	<desc>
19927	Button state bitmask.
19928	</desc>
19929	</attribute>
19930
19931	</interface>
19932
19933	<interface
19934	name="IGuestSessionEvent" extends="IEvent"
19935	uuid="b9acd33f-647d-45ac-8fe9-f49b3183ba37"
19936	wsmap="managed"
19937	>
19938	<desc>Base abstract interface for all guest session events.</desc>
19939
19940	<attribute name="session" type="IGuestSession" readonly="yes">
19941	<desc>Guest session that is subject to change.</desc>
19942	</attribute>
19943
19944	</interface>
19945
19946	<interface
19947	name="IGuestSessionStateChangedEvent" extends="IGuestSessionEvent"
19948	uuid="9c288479-6564-451d-9574-7e7ac0b7e443"
19949	wsmap="managed" autogen="VBoxEvent" id="OnGuestSessionStateChanged"
19950	>
19951	<desc>
19952	Notification when a guest session changed its state.
19953	</desc>
19954
19955	<attribute name="id" type="unsigned long" readonly="yes">
19956	<desc>
19957	Session ID of guest session which was changed.
19958	</desc>
19959	</attribute>
19960	<attribute name="status" type="GuestSessionStatus" readonly="yes">
19961	<desc>
19962	New session status.
19963	</desc>
19964	</attribute>
19965	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
19966	<desc>
19967	Error information in case of new session status is indicating an error.
19968
19969	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
19970	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
19971	include/VBox/err.h for details.
19972	</desc>
19973	</attribute>
19974
19975	</interface>
19976
19977	<interface
19978	name="IGuestSessionRegisteredEvent" extends="IGuestSessionEvent"
19979	uuid="b79de686-eabd-4fa6-960a-f1756c99ea1c"
19980	wsmap="managed" autogen="VBoxEvent" id="OnGuestSessionRegistered"
19981	>
19982	<desc>
19983	Notification when a guest session was registered or unregistered.
19984	</desc>
19985
19986	<attribute name="registered" type="boolean" readonly="yes">
19987	<desc>
19988	If @c true, the guest session was registered, otherwise it was
19989	unregistered.
19990	</desc>
19991	</attribute>
19992
19993	</interface>
19994
19995	<interface
19996	name="IGuestProcessEvent" extends="IGuestSessionEvent"
19997	uuid="2405f0e5-6588-40a3-9b0a-68c05ba52c4b"
19998	wsmap="managed"
19999	>
20000	<desc>Base abstract interface for all guest process events.</desc>
20001
20002	<attribute name="process" type="IGuestProcess" readonly="yes">
20003	<desc>
20004	Guest process object which is related to this event.
20005	</desc>
20006	</attribute>
20007	<attribute name="pid" type="unsigned long" readonly="yes">
20008	<desc>
20009	Guest process ID (PID).
20010	</desc>
20011	</attribute>
20012
20013	</interface>
20014
20015	<interface
20016	name="IGuestProcessRegisteredEvent" extends="IGuestProcessEvent"
20017	uuid="1d89e2b3-c6ea-45b6-9d43-dc6f70cc9f02"
20018	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessRegistered"
20019	>
20020	<desc>
20021	Notification when a guest process was registered or unregistered.
20022	</desc>
20023
20024	<attribute name="registered" type="boolean" readonly="yes">
20025	<desc>
20026	If @c true, the guest process was registered, otherwise it was
20027	unregistered.
20028	</desc>
20029	</attribute>
20030
20031	</interface>
20032
20033	<interface
20034	name="IGuestProcessStateChangedEvent" extends="IGuestProcessEvent"
20035	uuid="9360d372-d4d9-4948-8e67-e0a0e603acf9"
20036	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessStateChanged"
20037	>
20038	<desc>
20039	Notification when a guest process changed its state.
20040	</desc>
20041
20042	<attribute name="status" type="ProcessStatus" readonly="yes">
20043	<desc>
20044	New guest process status.
20045	</desc>
20046	</attribute>
20047	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20048	<desc>
20049	Error information in case of new session status is indicating an error.
20050
20051	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
20052	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
20053	include/VBox/err.h for details.
20054	</desc>
20055	</attribute>
20056
20057	</interface>
20058
20059	<interface
20060	name="IGuestProcessIOEvent" extends="IGuestProcessEvent"
20061	uuid="9ea9227c-e9bb-49b3-bfc7-c5171e93ef38"
20062	wsmap="managed"
20063	>
20064	<desc>
20065	Base abstract interface for all guest process input/output (IO) events.
20066	</desc>
20067
20068	<attribute name="handle" type="unsigned long" readonly="yes">
20069	<desc>
20070	Input/output (IO) handle involved in this event. Usually 0 is stdin,
20071	1 is stdout and 2 is stderr.
20072	</desc>
20073	</attribute>
20074
20075	<attribute name="processed" type="unsigned long" readonly="yes">
20076	<desc>
20077	Processed input or output (in bytes).
20078	</desc>
20079	</attribute>
20080
20081	</interface>
20082
20083	<interface
20084	name="IGuestProcessInputNotifyEvent" extends="IGuestProcessIOEvent"
20085	uuid="0de887f2-b7db-4616-aac6-cfb94d89ba78"
20086	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessInputNotify"
20087	>
20088	<desc>
20089	Notification when a guest process' stdin became available.
20090	<note>This event is right now not implemented!</note>
20091	</desc>
20092
20093	<attribute name="status" type="ProcessInputStatus" readonly="yes">
20094	<desc>
20095	Current process input status.
20096	</desc>
20097	</attribute>
20098
20099	</interface>
20100
20101	<interface
20102	name="IGuestProcessOutputEvent" extends="IGuestProcessIOEvent"
20103	uuid="d3d5f1ee-bcb2-4905-a7ab-cc85448a742b"
20104	wsmap="managed" autogen="VBoxEvent" id="OnGuestProcessOutput"
20105	>
20106	<desc>
20107	Notification when there is guest process output available for reading.
20108	</desc>
20109
20110	<attribute name="data" type="octet" safearray="yes" readonly="yes">
20111	<desc>
20112	Actual output data.
20113	</desc>
20114	</attribute>
20115
20116	</interface>
20117
20118	<interface
20119	name="IGuestFileEvent" extends="IGuestSessionEvent"
20120	uuid="c8adb7b0-057d-4391-b928-f14b06b710c5"
20121	wsmap="managed"
20122	>
20123	<desc>Base abstract interface for all guest file events.</desc>
20124
20125	<attribute name="file" type="IGuestFile" readonly="yes">
20126	<desc>
20127	Guest file object which is related to this event.
20128	</desc>
20129	</attribute>
20130
20131	</interface>
20132
20133	<interface
20134	name="IGuestFileRegisteredEvent" extends="IGuestFileEvent"
20135	uuid="d0d93830-70a2-487e-895e-d3fc9679f7b3"
20136	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileRegistered"
20137	>
20138	<desc>
20139	Notification when a guest file was registered or unregistered.
20140	</desc>
20141
20142	<attribute name="registered" type="boolean" readonly="yes">
20143	<desc>
20144	If @c true, the guest file was registered, otherwise it was
20145	unregistered.
20146	</desc>
20147	</attribute>
20148
20149	</interface>
20150
20151	<interface
20152	name="IGuestFileStateChangedEvent" extends="IGuestFileEvent"
20153	uuid="841951c4-4df3-4ee1-bb99-91e5761c18ff"
20154	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileStateChanged"
20155	>
20156	<desc>
20157	Notification when a guest file changed its state.
20158	</desc>
20159
20160	<attribute name="status" type="FileStatus" readonly="yes">
20161	<desc>
20162	New guest file status.
20163	</desc>
20164	</attribute>
20165	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20166	<desc>
20167	Error information in case of new session status is indicating an error.
20168
20169	The attribute <link to="IVirtualBoxErrorInfo::resultDetail"/> will contain
20170	the runtime (IPRT) error code from the guest. See include/iprt/err.h and
20171	include/VBox/err.h for details.
20172	</desc>
20173	</attribute>
20174	<!-- Note: No events for reads/writes for performance reasons.
20175	See dedidcated events IGuestFileReadEvent and
20176	IGuestFileWriteEvent. -->
20177
20178	</interface>
20179
20180	<interface
20181	name="IGuestFileIOEvent" extends="IGuestFileEvent"
20182	uuid="b5191a7c-9536-4ef8-820e-3b0e17e5bbc8"
20183	wsmap="managed"
20184	>
20185	<desc>
20186	Base abstract interface for all guest file input/output (IO) events.
20187	</desc>
20188
20189	<attribute name="offset" type="long long" readonly="yes">
20190	<desc>
20191	Current offset (in bytes).
20192	</desc>
20193	</attribute>
20194	<attribute name="processed" type="unsigned long" readonly="yes">
20195	<desc>
20196	Processed input or output (in bytes).
20197	</desc>
20198	</attribute>
20199
20200	</interface>
20201
20202	<interface
20203	name="IGuestFileOffsetChangedEvent" extends="IGuestFileIOEvent"
20204	uuid="e8f79a21-1207-4179-94cf-ca250036308f"
20205	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileOffsetChanged"
20206	>
20207	<desc>
20208	Notification when a guest file changed its current offset.
20209	</desc>
20210
20211	</interface>
20212
20213	<interface
20214	name="IGuestFileReadEvent" extends="IGuestFileIOEvent"
20215	uuid="4ee3cbcb-486f-40db-9150-deee3fd24189"
20216	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileRead"
20217	>
20218	<desc>
20219	Notification when data has been read from a guest file.
20220	</desc>
20221
20222	<attribute name="data" type="octet" safearray="yes" readonly="yes">
20223	<desc>
20224	Actual data read.
20225	</desc>
20226	</attribute>
20227
20228	</interface>
20229
20230	<interface
20231	name="IGuestFileWriteEvent" extends="IGuestFileIOEvent"
20232	uuid="e062a915-3cf5-4c0a-bc90-9b8d4cc94d89"
20233	wsmap="managed" autogen="VBoxEvent" id="OnGuestFileWrite"
20234	>
20235	<desc>
20236	Notification when data has been written to a guest file.
20237	</desc>
20238
20239	</interface>
20240
20241	<interface
20242	name="IVRDEServerChangedEvent" extends="IEvent"
20243	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
20244	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
20245	>
20246	<desc>
20247	Notification when a property of the
20248	<link to="IMachine::VRDEServer">VRDE server</link> changes.
20249	Interested callees should use IVRDEServer methods and attributes to
20250	find out what has changed.
20251	</desc>
20252	</interface>
20253
20254	<interface
20255	name="IVRDEServerInfoChangedEvent" extends="IEvent"
20256	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
20257	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
20258	>
20259	<desc>
20260	Notification when the status of the VRDE server changes. Interested callees
20261	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
20262	attributes to find out what is the current status.
20263	</desc>
20264	</interface>
20265
20266	<interface
20267	name="IUSBControllerChangedEvent" extends="IEvent"
20268	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
20269	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
20270	>
20271	<desc>
20272	Notification when a property of the virtual
20273	<link to="IMachine::USBController">USB controller</link> changes.
20274	Interested callees should use IUSBController methods and attributes to
20275	find out what has changed.
20276	</desc>
20277	</interface>
20278
20279	<interface
20280	name="IUSBDeviceStateChangedEvent" extends="IEvent"
20281	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
20282	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
20283	>
20284	<desc>
20285	Notification when a USB device is attached to or detached from
20286	the virtual USB controller.
20287
20288	This notification is sent as a result of the indirect
20289	request to attach the device because it matches one of the
20290	machine USB filters, or as a result of the direct request
20291	issued by <link to="IConsole::attachUSBDevice"/> or
20292	<link to="IConsole::detachUSBDevice"/>.
20293
20294	This notification is sent in case of both a succeeded and a
20295	failed request completion. When the request succeeds, the
20296	@a error parameter is @c null, and the given device has been
20297	already added to (when @a attached is @c true) or removed from
20298	(when @a attached is @c false) the collection represented by
20299	<link to="IConsole::USBDevices"/>. On failure, the collection
20300	doesn't change and the @a error parameter represents the error
20301	message describing the failure.
20302	</desc>
20303	<attribute name="device" type="IUSBDevice" readonly="yes">
20304	<desc>
20305	Device that is subject to state change.
20306	</desc>
20307	</attribute>
20308	<attribute name="attached" type="boolean" readonly="yes">
20309	<desc>
20310	@c true if the device was attached and @c false otherwise.
20311	</desc>
20312	</attribute>
20313	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
20314	<desc>
20315	@c null on success or an error message object on failure.
20316	</desc>
20317	</attribute>
20318	</interface>
20319
20320	<interface
20321	name="ISharedFolderChangedEvent" extends="IEvent"
20322	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
20323	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
20324	>
20325	<desc>
20326	Notification when a shared folder is added or removed.
20327	The @a scope argument defines one of three scopes:
20328	<link to="IVirtualBox::sharedFolders">global shared folders</link>
20329	(<link to="Scope_Global">Global</link>),
20330	<link to="IMachine::sharedFolders">permanent shared folders</link> of
20331	the machine (<link to="Scope_Machine">Machine</link>) or <link
20332	to="IConsole::sharedFolders">transient shared folders</link> of the
20333	machine (<link to="Scope_Session">Session</link>). Interested callees
20334	should use query the corresponding collections to find out what has
20335	changed.
20336	</desc>
20337	<attribute name="scope" type="Scope" readonly="yes">
20338	<desc>
20339	Scope of the notification.
20340	</desc>
20341	</attribute>
20342	</interface>
20343
20344	<interface
20345	name="IRuntimeErrorEvent" extends="IEvent"
20346	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
20347	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
20348	>
20349	<desc>
20350	Notification when an error happens during the virtual
20351	machine execution.
20352
20353	There are three kinds of runtime errors:
20354	<ul>
20355	<li><i>fatal</i></li>
20356	<li><i>non-fatal with retry</i></li>
20357	<li><i>non-fatal warnings</i></li>
20358	</ul>
20359
20360	<b>Fatal</b> errors are indicated by the @a fatal parameter set
20361	to @c true. In case of fatal errors, the virtual machine
20362	execution is always paused before calling this notification, and
20363	the notification handler is supposed either to immediately save
20364	the virtual machine state using <link to="IConsole::saveState"/>
20365	or power it off using <link to="IConsole::powerDown"/>.
20366	Resuming the execution can lead to unpredictable results.
20367
20368	<b>Non-fatal</b> errors and warnings are indicated by the
20369	@a fatal parameter set to @c false. If the virtual machine
20370	is in the Paused state by the time the error notification is
20371	received, it means that the user can <i>try to resume</i> the machine
20372	execution after attempting to solve the problem that caused the
20373	error. In this case, the notification handler is supposed
20374	to show an appropriate message to the user (depending on the
20375	value of the @a id parameter) that offers several actions such
20376	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
20377	wants to retry, the notification handler should continue
20378	the machine execution using the <link to="IConsole::resume"/>
20379	call. If the machine execution is not Paused during this
20380	notification, then it means this notification is a <i>warning</i>
20381	(for example, about a fatal condition that can happen very soon);
20382	no immediate action is required from the user, the machine
20383	continues its normal execution.
20384
20385	Note that in either case the notification handler
20386	<b>must not</b> perform any action directly on a thread
20387	where this notification is called. Everything it is allowed to
20388	do is to post a message to another thread that will then talk
20389	to the user and take the corresponding action.
20390
20391	Currently, the following error identifiers are known:
20392	<ul>
20393	<li><tt>"HostMemoryLow"</tt></li>
20394	<li><tt>"HostAudioNotResponding"</tt></li>
20395	<li><tt>"VDIStorageFull"</tt></li>
20396	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
20397	</ul>
20398	</desc>
20399	<attribute name="fatal" type="boolean" readonly="yes">
20400	<desc>
20401	Whether the error is fatal or not.
20402	</desc>
20403	</attribute>
20404	<attribute name="id" type="wstring" readonly="yes">
20405	<desc>
20406	Error identifier.
20407	</desc>
20408	</attribute>
20409	<attribute name="message" type="wstring" readonly="yes">
20410	<desc>
20411	Optional error message.
20412	</desc>
20413	</attribute>
20414	</interface>
20415
20416
20417	<interface
20418	name="IEventSourceChangedEvent" extends="IEvent"
20419	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
20420	waitable="yes"
20421	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
20422	>
20423	<desc>
20424	Notification when an event source state changes (listener added or removed).
20425	</desc>
20426
20427	<attribute name="listener" type="IEventListener" readonly="yes">
20428	<desc>
20429	Event listener which has changed.
20430	</desc>
20431	</attribute>
20432
20433	<attribute name="add" type="boolean" readonly="yes">
20434	<desc>
20435	Flag whether listener was added or removed.
20436	</desc>
20437	</attribute>
20438	</interface>
20439
20440	<interface
20441	name="IExtraDataChangedEvent" extends="IEvent"
20442	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
20443	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
20444	>
20445	<desc>
20446	Notification when machine specific or global extra data
20447	has changed.
20448	</desc>
20449	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20450	<desc>
20451	ID of the machine this event relates to.
20452	Null for global extra data changes.
20453	</desc>
20454	</attribute>
20455	<attribute name="key" type="wstring" readonly="yes">
20456	<desc>
20457	Extra data key that has changed.
20458	</desc>
20459	</attribute>
20460	<attribute name="value" type="wstring" readonly="yes">
20461	<desc>
20462	Extra data value for the given key.
20463	</desc>
20464	</attribute>
20465	</interface>
20466
20467	<interface
20468	name="IVetoEvent" extends="IEvent"
20469	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
20470	wsmap="managed"
20471	>
20472	<desc>Base abstract interface for veto events.</desc>
20473
20474	<method name="addVeto">
20475	<desc>
20476	Adds a veto on this event.
20477	</desc>
20478	<param name="reason" type="wstring" dir="in">
20479	<desc>
20480	Reason for veto, could be null or empty string.
20481	</desc>
20482	</param>
20483	</method>
20484
20485	<method name="isVetoed">
20486	<desc>
20487	If this event was vetoed.
20488	</desc>
20489	<param name="result" type="boolean" dir="return">
20490	<desc>
20491	Reason for veto.
20492	</desc>
20493	</param>
20494	</method>
20495
20496	<method name="getVetos">
20497	<desc>
20498	Current veto reason list, if size is 0 - no veto.
20499	</desc>
20500	<param name="result" type="wstring" dir="return" safearray="yes">
20501	<desc>
20502	Array of reasons for veto provided by different event handlers.
20503	</desc>
20504	</param>
20505	</method>
20506
20507	</interface>
20508
20509	<interface
20510	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
20511	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
20512	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
20513	waitable="true"
20514	>
20515	<desc>
20516	Notification when someone tries to change extra data for
20517	either the given machine or (if @c null) global extra data.
20518	This gives the chance to veto against changes.
20519	</desc>
20520	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
20521	<desc>
20522	ID of the machine this event relates to.
20523	Null for global extra data changes.
20524	</desc>
20525	</attribute>
20526	<attribute name="key" type="wstring" readonly="yes">
20527	<desc>
20528	Extra data key that has changed.
20529	</desc>
20530	</attribute>
20531	<attribute name="value" type="wstring" readonly="yes">
20532	<desc>
20533	Extra data value for the given key.
20534	</desc>
20535	</attribute>
20536	</interface>
20537
20538	<interface
20539	name="ICanShowWindowEvent" extends="IVetoEvent"
20540	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
20541	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
20542	waitable="true"
20543	>
20544	<desc>
20545	Notification when a call to
20546	<link to="IMachine::canShowConsoleWindow"/> is made by a
20547	front-end to check if a subsequent call to
20548	<link to="IMachine::showConsoleWindow"/> can succeed.
20549
20550	The callee should give an answer appropriate to the current
20551	machine state using event veto. This answer must
20552	remain valid at least until the next
20553	<link to="IConsole::state">machine state</link> change.
20554	</desc>
20555	</interface>
20556
20557	<interface
20558	name="IShowWindowEvent" extends="IEvent"
20559	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
20560	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
20561	waitable="true"
20562	>
20563	<desc>
20564	Notification when a call to
20565	<link to="IMachine::showConsoleWindow"/>
20566	requests the console window to be activated and brought to
20567	foreground on the desktop of the host PC.
20568
20569	This notification should cause the VM console process to
20570	perform the requested action as described above. If it is
20571	impossible to do it at a time of this notification, this
20572	method should return a failure.
20573
20574	Note that many modern window managers on many platforms
20575	implement some sort of focus stealing prevention logic, so
20576	that it may be impossible to activate a window without the
20577	help of the currently active application (which is supposedly
20578	an initiator of this notification). In this case, this method
20579	must return a non-zero identifier that represents the
20580	top-level window of the VM console process. The caller, if it
20581	represents a currently active process, is responsible to use
20582	this identifier (in a platform-dependent manner) to perform
20583	actual window activation.
20584
20585	This method must set @a winId to zero if it has performed all
20586	actions necessary to complete the request and the console
20587	window is now active and in foreground, to indicate that no
20588	further action is required on the caller's side.
20589	</desc>
20590	<attribute name="winId" type="long long">
20591	<desc>
20592	Platform-dependent identifier of the top-level VM console
20593	window, or zero if this method has performed all actions
20594	necessary to implement the <i>show window</i> semantics for
20595	the given platform and/or this VirtualBox front-end.
20596	</desc>
20597	</attribute>
20598	</interface>
20599
20600	<interface
20601	name="INATRedirectEvent" extends="IMachineEvent"
20602	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
20603	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
20604	>
20605	<desc>
20606	Notification when NAT redirect rule added or removed.
20607	</desc>
20608	<attribute name="slot" type="unsigned long" readonly="yes">
20609	<desc>
20610	Adapter which NAT attached to.
20611	</desc>
20612	</attribute>
20613	<attribute name="remove" type="boolean" readonly="yes">
20614	<desc>
20615	Whether rule remove or add.
20616	</desc>
20617	</attribute>
20618	<attribute name="name" type="wstring" readonly="yes">
20619	<desc>
20620	Name of the rule.
20621	</desc>
20622	</attribute>
20623	<attribute name="proto" type="NATProtocol" readonly="yes">
20624	<desc>
20625	Protocol (TCP or UDP) of the redirect rule.
20626	</desc>
20627	</attribute>
20628	<attribute name="hostIP" type="wstring" readonly="yes">
20629	<desc>
20630	Host ip address to bind socket on.
20631	</desc>
20632	</attribute>
20633	<attribute name="hostPort" type="long" readonly="yes">
20634	<desc>
20635	Host port to bind socket on.
20636	</desc>
20637	</attribute>
20638	<attribute name="guestIP" type="wstring" readonly="yes">
20639	<desc>
20640	Guest ip address to redirect to.
20641	</desc>
20642	</attribute>
20643	<attribute name="guestPort" type="long" readonly="yes">
20644	<desc>
20645	Guest port to redirect to.
20646	</desc>
20647	</attribute>
20648	</interface>
20649
20650	<interface
20651	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
20652	waitable="yes"
20653	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
20654	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
20655	>
20656	<desc>
20657	Notification when host PCI device is plugged/unplugged. Plugging
20658	usually takes place on VM startup, unplug - when
20659	<link to="IMachine::detachHostPCIDevice"/> is called.
20660
20661	<see><link to="IMachine::detachHostPCIDevice"/></see>
20662
20663	</desc>
20664
20665	<attribute name="plugged" type="boolean" readonly="yes">
20666	<desc>
20667	If device successfully plugged or unplugged.
20668	</desc>
20669	</attribute>
20670
20671	<attribute name="success" type="boolean" readonly="yes">
20672	<desc>
20673	If operation was successful, if false - 'message' attribute
20674	may be of interest.
20675	</desc>
20676	</attribute>
20677
20678	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
20679	<desc>
20680	Attachment info for this device.
20681	</desc>
20682	</attribute>
20683
20684	<attribute name="message" type="wstring" readonly="yes">
20685	<desc>
20686	Optional error message.
20687	</desc>
20688	</attribute>
20689
20690	</interface>
20691
20692	<interface
20693	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
20694	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
20695	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
20696	>
20697	<desc>
20698	Notification when VBoxSVC becomes unavailable (due to a crash or similar
20699	unexpected circumstances) or available again.
20700	</desc>
20701
20702	<attribute name="available" type="boolean" readonly="yes">
20703	<desc>
20704	Whether VBoxSVC is available now.
20705	</desc>
20706	</attribute>
20707	</interface>
20708
20709	<interface
20710	name="IBandwidthGroupChangedEvent" extends="IEvent"
20711	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
20712	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
20713	>
20714	<desc>
20715	Notification when one of the bandwidth groups changed
20716	</desc>
20717	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
20718	<desc>
20719	The changed bandwidth group.
20720	</desc>
20721	</attribute>
20722	</interface>
20723
20724	<enum
20725	name="GuestMonitorChangedEventType"
20726	uuid="ef172985-7e36-4297-95be-e46396968d66"
20727	>
20728
20729	<desc>
20730	How the guest monitor has been changed.
20731	</desc>
20732
20733	<const name="Enabled" value="0">
20734	<desc>
20735	The guest monitor has been enabled by the guest.
20736	</desc>
20737	</const>
20738
20739	<const name="Disabled" value="1">
20740	<desc>
20741	The guest monitor has been disabled by the guest.
20742	</desc>
20743	</const>
20744
20745	<const name="NewOrigin" value="2">
20746	<desc>
20747	The guest monitor origin has changed in the guest.
20748	</desc>
20749	</const>
20750	</enum>
20751
20752	<interface
20753	name="IGuestMonitorChangedEvent" extends="IEvent"
20754	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
20755	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
20756	>
20757	<desc>
20758	Notification when the guest enables one of its monitors.
20759	</desc>
20760
20761	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
20762	<desc>
20763	What was changed for this guest monitor.
20764	</desc>
20765	</attribute>
20766
20767	<attribute name="screenId" type="unsigned long" readonly="yes">
20768	<desc>
20769	The monitor which was changed.
20770	</desc>
20771	</attribute>
20772
20773	<attribute name="originX" type="unsigned long" readonly="yes">
20774	<desc>
20775	Physical X origin relative to the primary screen.
20776	Valid for Enabled and NewOrigin.
20777	</desc>
20778	</attribute>
20779
20780	<attribute name="originY" type="unsigned long" readonly="yes">
20781	<desc>
20782	Physical Y origin relative to the primary screen.
20783	Valid for Enabled and NewOrigin.
20784	</desc>
20785	</attribute>
20786
20787	<attribute name="width" type="unsigned long" readonly="yes">
20788	<desc>
20789	Width of the screen.
20790	Valid for Enabled.
20791	</desc>
20792	</attribute>
20793
20794	<attribute name="height" type="unsigned long" readonly="yes">
20795	<desc>
20796	Height of the screen.
20797	Valid for Enabled.
20798	</desc>
20799	</attribute>
20800
20801	</interface>
20802
20803	<interface
20804	name="IStorageDeviceChangedEvent" extends="IEvent"
20805	uuid="232e9151-ae84-4b8e-b0f3-5c20c35caac9"
20806	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
20807	>
20808	<desc>
20809	Notification when a
20810	<link to="IMachine::mediumAttachments">storage device</link>
20811	is attached or removed.
20812	</desc>
20813	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
20814	<desc>
20815	Storage device that is subject to change.
20816	</desc>
20817	</attribute>
20818	<attribute name="removed" type="boolean" readonly="yes">
20819	<desc>
20820	Flag whether the device was removed or added to the VM.
20821	</desc>
20822	</attribute>
20823	<attribute name="silent" type="boolean" readonly="yes">
20824	<desc>
20825	Flag whether the guest should be notified about the change.
20826	</desc>
20827	</attribute>
20828	</interface>
20829	<interface
20830	name="INATNetworkChangedEvent" extends="IEvent"
20831	uuid="101ae042-1a29-4a19-92cf-02285773f3b5"
20832	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkChanged"
20833	>
20834	<!-- network name is common setting for all event types -->
20835	<attribute name="NetworkName" type="wstring" readonly="yes"/>
20836	</interface>
20837	<!-- base class for start/stop events -->
20838	<interface name="INATNetworkStartStopEvent" extends="INATNetworkChangedEvent"
20839	uuid="269d8f6b-fa1e-4cee-91c7-6d8496bea3c1"
20840	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkStartStop">
20841	<attribute name="startEvent" type="boolean" readonly="yes">
20842	<desc>
20843	IsStartEvent is true when NAT network is started and false on stopping.
20844	</desc>
20845	</attribute>
20846	</interface>
20847
20848	<!-- base class for modification events -->
20849	<interface name="INATNetworkAlterEvent" extends="INATNetworkChangedEvent"
20850	uuid="3f5a0822-163a-43b1-ad16-8d58b0ef6e75"
20851	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkAlter"/>
20852
20853	<interface name="INATNetworkCreationDeletionEvent" extends="INATNetworkAlterEvent"
20854	uuid="8d984a7e-b855-40b8-ab0c-44d3515b4528"
20855	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkCreationDeletion">
20856	<attribute name="creationEvent" type="boolean" readonly="yes"/>
20857	</interface>
20858	<interface name="INATNetworkSettingEvent" extends="INATNetworkAlterEvent"
20859	uuid="9db3a9e6-7f29-4aae-a627-5a282c83092c"
20860	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkSetting">
20861	<attribute name="enabled" type="boolean" readonly="yes"/>
20862	<attribute name="network" type="wstring" readonly="yes"/>
20863	<attribute name="gateway" type="wstring" readonly="yes"/>
20864	<attribute name="advertiseDefaultIPv6RouteEnabled" type="boolean" readonly="yes"/>
20865	<attribute name="needDhcpServer" type="boolean" readonly="yes"/>
20866	</interface>
20867	<interface name="INATNetworkPortForwardEvent" extends="INATNetworkAlterEvent"
20868	uuid="2514881b-23d0-430a-a7ff-7ed7f05534bc"
20869	wsmap="managed" autogen="VBoxEvent" id="OnNATNetworkPortForward">
20870	<attribute name="create" type="boolean" readonly="yes"/>
20871	<attribute name="ipv6" type="boolean" readonly="yes"/>
20872	<attribute name="name" type="wstring" readonly="yes"/>
20873	<attribute name="proto" type="NATProtocol" readonly="yes"/>
20874	<attribute name="hostIp" type="wstring" readonly="yes"/>
20875	<attribute name="hostPort" type="long" readonly="yes"/>
20876	<attribute name="guestIp" type="wstring" readonly="yes"/>
20877	<attribute name="guestPort" type="long" readonly="yes"/>
20878	</interface>
20879
20880	<module name="VBoxSVC" context="LocalServer">
20881	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
20882	namespace="virtualbox.org">
20883	<interface name="IVirtualBox" default="yes"/>
20884	</class>
20885	</module>
20886
20887	<module name="VBoxC" context="InprocServer" threadingModel="Free">
20888	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
20889	namespace="virtualbox.org">
20890	<interface name="IVirtualBoxClient" default="yes"/>
20891	</class>
20892
20893	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
20894	namespace="virtualbox.org">
20895	<interface name="ISession" default="yes"/>
20896	</class>
20897	</module>
20898
20899	</library>
20900
20901	</idl>
20902
20903	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format