VirtualBox.xidl@ 43036

Last change on this file since 43036 was 43036, checked in by vboxsync, 12 years ago
Main/GuestCtrl: Reduce number of maximum guest sessions at once to 32 in favor of having up to 2048 objects (processes, files, ...) per session.
Property svn:eol-style set to `native`
File size: 722.7 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2012 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109
110	The naming of methods and attributes is very clearly defined: they all start
111	with a lowercase letter (except if they start with an acronym), and are using
112	CamelCase style otherwise. This naming only applies to the IDL description,
113	and is modified by the various language bindings (some convert the first
114	character to upper case, some not). See the SDK reference for more details
115	about how to call a method or attribute from a specific programming language.
116	</desc>
117
118	<if target="midl">
119	<cpp line="enum {"/>
120	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
121	<cpp line=" kTypeLibraryMinorVersion = 0"/>
122	<cpp line="};"/>
123	</if>
124
125	<if target="xpidl">
126	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
127	<cpp>
128	/* currently, nsISupportsImpl.h lacks the below-like macros */
129
130	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
131	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
132	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
133	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
134
135
136	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
137	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
138	NS_IMPL_THREADSAFE_ADDREF(_class) \
139	NS_IMPL_THREADSAFE_RELEASE(_class) \
140	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
141	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
142	#endif
143
144	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
145	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
146	NS_IMPL_THREADSAFE_ADDREF(_class) \
147	NS_IMPL_THREADSAFE_RELEASE(_class) \
148	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
149	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
150	#endif
151
152	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
153	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
154	NS_IMPL_THREADSAFE_ADDREF(_class) \
155	NS_IMPL_THREADSAFE_RELEASE(_class) \
156	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
157	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
158	#endif
159
160	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
161	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
162	NS_IMPL_THREADSAFE_ADDREF(_class) \
163	NS_IMPL_THREADSAFE_RELEASE(_class) \
164	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
165	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
166	#endif
167
168	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
169	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
170	NS_INTERFACE_MAP_BEGIN(_class) \
171	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
172	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
173	NS_IMPL_QUERY_CLASSINFO(_class) \
174	NS_INTERFACE_MAP_END
175	#endif
176
177	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
178	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
179	_i2, _ic2) \
180	NS_INTERFACE_MAP_BEGIN(_class) \
181	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
182	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
183	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
184	NS_IMPL_QUERY_CLASSINFO(_class) \
185	NS_INTERFACE_MAP_END
186	#endif
187
188	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
189	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
190	_i2, _ic2, _i3, _ic3) \
191	NS_INTERFACE_MAP_BEGIN(_class) \
192	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
193	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
194	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
195	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
196	NS_IMPL_QUERY_CLASSINFO(_class) \
197	NS_INTERFACE_MAP_END
198	#endif
199
200	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
201	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
202	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
203
204	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
205	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
206	NS_IMPL_THREADSAFE_ADDREF(_class) \
207	NS_IMPL_THREADSAFE_RELEASE(_class) \
208	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
209	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
210	#endif
211
212	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
213	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
214	_i2, _ic2) \
215	NS_IMPL_THREADSAFE_ADDREF(_class) \
216	NS_IMPL_THREADSAFE_RELEASE(_class) \
217	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
218	_i2, _ic2) \
219	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
220	#endif
221
222	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
223	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
224	_i2, _ic2, _i3, _ic3) \
225	NS_IMPL_THREADSAFE_ADDREF(_class) \
226	NS_IMPL_THREADSAFE_RELEASE(_class) \
227	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
228	_i2, _ic2, _i3, _ic3) \
229	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
230	#endif
231
232	</cpp>
233	</if>
234
235	<library
236	name="VirtualBox"
237	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
238	version="1.3"
239	desc="VirtualBox Type Library"
240	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
241	supportsErrorInfo="yes"
242	>
243
244
245	<!--
246	// COM result codes for VirtualBox
247	/////////////////////////////////////////////////////////////////////////
248	-->
249
250	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
251	<desc>
252	This section describes all VirtualBox-specific COM result codes that may
253	be returned by methods of VirtualBox COM interfaces in addition to
254	standard COM result codes.
255
256	Note that along with the result code, every VirtualBox method returns
257	extended error information through the IVirtualBoxErrorInfo interface on
258	failure. This interface is a preferred way to present the error to the end
259	user because it contains a human readable description of the error. Raw
260	result codes, both standard and described in this section, are intended to
261	be used by programs to analyze the reason of a failure and select an
262	appropriate course of action without involving the end user (for example,
263	retry the operation later or make a different call).
264
265	The standard COM result codes that may originate from our methods include:
266
267	<table>
268	<tr><td>E_INVALIDARG</td>
269	<td>
270	Returned when the value of the method's argument is not within the range
271	of valid values. This should not be confused with situations when the
272	value is within the range but simply doesn't suit the current object
273	state and there is a possibility that it will be accepted later (in such
274	cases VirtualBox-specific codes are returned, for example,
275	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
276	</td>
277	</tr>
278	<tr><td>E_POINTER</td>
279	<td>
280	Returned if a memory pointer for the output argument is invalid (for
281	example, @c null). When pointers representing input arguments (such
282	as strings) are invalid, E_INVALIDARG is returned.
283	</td>
284	</tr>
285	<tr><td>E_ACCESSDENIED</td>
286	<td>
287	Returned when the called object is not ready. Since the lifetime of a
288	public COM object cannot be fully controlled by the implementation,
289	VirtualBox maintains the readiness state for all objects it creates and
290	returns this code in response to any method call on the object that was
291	deactivated by VirtualBox and is not functioning any more.
292	</td>
293	</tr>
294	<tr><td>E_OUTOFMEMORY</td>
295	<td>
296	Returned when a memory allocation operation fails.
297	</td>
298	</tr>
299	</table>
300	</desc>
301	</descGroup>
302
303	<!--
304	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
305	everything in <result>/<desc> after (and including) the first dot, so express
306	the matter of the error code in the first sentence and keep it short.
307	-->
308
309	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
310	<desc>
311	Object corresponding to the supplied arguments does not exist.
312	</desc>
313	</result>
314
315	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
316	<desc>
317	Current virtual machine state prevents the operation.
318	</desc>
319	</result>
320
321	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
322	<desc>
323	Virtual machine error occurred attempting the operation.
324	</desc>
325	</result>
326
327	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
328	<desc>
329	File not accessible or erroneous file contents.
330	</desc>
331	</result>
332
333	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
334	<desc>
335	Runtime subsystem error.
336	</desc>
337	</result>
338
339	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
340	<desc>
341	Pluggable Device Manager error.
342	</desc>
343	</result>
344
345	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
346	<desc>
347	Current object state prohibits operation.
348	</desc>
349	</result>
350
351	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
352	<desc>
353	Host operating system related error.
354	</desc>
355	</result>
356
357	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
358	<desc>
359	Requested operation is not supported.
360	</desc>
361	</result>
362
363	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
364	<desc>
365	Invalid XML found.
366	</desc>
367	</result>
368
369	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
370	<desc>
371	Current session state prohibits operation.
372	</desc>
373	</result>
374
375	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
376	<desc>
377	Object being in use prohibits operation.
378	</desc>
379	</result>
380
381	<!--
382	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
383	everything in <result>/<desc> after (and including) the first dot, so express
384	the matter of the error code in the first sentence and keep it short.
385	-->
386
387	<descGroup/>
388
389	<!--
390	// all common enums
391	/////////////////////////////////////////////////////////////////////////
392	-->
393
394	<enum
395	name="SettingsVersion"
396	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
397	>
398	<desc>
399	Settings version of VirtualBox settings files. This is written to
400	the "version" attribute of the root "VirtualBox" element in the settings
401	file XML and indicates which VirtualBox version wrote the file.
402	</desc>
403
404	<const name="Null" value="0">
405	<desc>Null value, indicates invalid version.</desc>
406	</const>
407	<const name="v1_0" value="1">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_1" value="2">
411	<desc>Legacy settings version, not currently supported.</desc>
412	</const>
413	<const name="v1_2" value="3">
414	<desc>Legacy settings version, not currently supported.</desc>
415	</const>
416	<const name="v1_3pre" value="4">
417	<desc>Legacy settings version, not currently supported.</desc>
418	</const>
419	<const name="v1_3" value="5">
420	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
421	<!--
422	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
423	-->
424	</const>
425	<const name="v1_4" value="6">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
429	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
430	-->
431	</const>
432	<const name="v1_5" value="7">
433	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
434	<!--
435	2008-09-04: 2.0.0 released
436	2008-11-20: settings version 1.5 introduced
437	2008-12-17: 2.1.0 released
438	Machine changes:
439	guest OS identifiers changed;
440	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
441	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
442	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
443	-->
444	</const>
445	<const name="v1_6" value="8">
446	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
447	<!--
448	2008-12-17: 2.1.0 released
449	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
450	2009-04-08: 2.2.0 released
451	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
452	-->
453	</const>
454	<const name="v1_7" value="9">
455	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
456	<!--
457	2008-12-17: 2.1.0 released
458	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
459	2009-04-08: 2.2.0 released
460	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
461	Machine changes: HardDiskAttachments is now StorageControllers (done)
462	-->
463	</const>
464	<const name="v1_8" value="10">
465	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
466	<!--
467	Machine additions: Display/@accelerate2DVideo (done)
468	-->
469	</const>
470	<const name="v1_9" value="11">
471	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
472	<!--
473	The big storage controller / DVD / Floppy rework (done)
474	-->
475	</const>
476	<const name="v1_10" value="12">
477	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
478	<!--
479	Machine changes: RTC localOrUTC (done)
480	CPU hot-plug support
481	-->
482	</const>
483	<const name="v1_11" value="13">
484	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
485	<!--
486	Machine changes: HD Audio controller, per-machine disk registries,
487	/@format attribute for DVD and floppy images.
488	-->
489	</const>
490	<const name="v1_12" value="14">
491	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
492	<!--
493	Machine changes: raw PCI device attachment;
494	NetworkAdapter changes: bandwidth group.
495	-->
496	</const>
497	<const name="v1_13" value="15">
498	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
499	<!--
500	Machine changes: tracing config, groups, autostart;
501	NetworkAdapter changes: unit for bandwidth group limits.
502	-->
503	</const>
504
505	<const name="Future" value="99999">
506	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
507	</const>
508	</enum>
509
510	<enum
511	name="AccessMode"
512	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
513	>
514	<desc>
515	Access mode for opening files.
516	</desc>
517
518	<const name="ReadOnly" value="1"/>
519	<const name="ReadWrite" value="2"/>
520	</enum>
521
522	<enum
523	name="MachineState"
524	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
525	>
526	<desc>
527	Virtual machine execution state.
528
529	This enumeration represents possible values of the <link
530	to="IMachine::state"/> attribute.
531
532	Below is the basic virtual machine state diagram. It shows how the state
533	changes during virtual machine execution. The text in square braces shows
534	a method of the IConsole interface that performs the given state
535	transition.
536
537	<pre>
538	+---------[powerDown()] <- Stuck <--[failure]-+
539	V \|
540	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
541	\| \| \| \| V \|
542	\| Aborted -----+ +--> Running --[pause()]--> Paused
543	\| \| ^ \| ^ \|
544	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
545	\| ^ \| \| \| \|
546	\| \| +-----------------------------------------+-\|-------------------+ +
547	\| \| \| \| \|
548	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
549	\| \| \| \|
550	\| +-------- Saving <--------[saveState()]<----------+---------------------+
551	\| \| \|
552	+-------------- Stopping -------[powerDown()]<----------+---------------------+
553	</pre>
554
555	Note that states to the right from PoweredOff, Aborted and Saved in the
556	above diagram are called <i>online VM states</i>. These states
557	represent the virtual machine which is being executed in a dedicated
558	process (usually with a GUI window attached to it where you can see the
559	activity of the virtual machine and interact with it). There are two
560	special pseudo-states, FirstOnline and LastOnline, that can be used in
561	relational expressions to detect if the given machine state is online or
562	not:
563
564	<pre>
565	if (machine.GetState() >= MachineState_FirstOnline &&
566	machine.GetState() <= MachineState_LastOnline)
567	{
568	...the machine is being executed...
569	}
570	</pre>
571
572	When the virtual machine is in one of the online VM states (that is, being
573	executed), only a few machine settings can be modified. Methods working
574	with such settings contain an explicit note about that. An attempt to
575	change any other setting or perform a modifying operation during this time
576	will result in the @c VBOX_E_INVALID_VM_STATE error.
577
578	All online states except Running, Paused and Stuck are transitional: they
579	represent temporary conditions of the virtual machine that will last as
580	long as the operation that initiated such a condition.
581
582	The Stuck state is a special case. It means that execution of the machine
583	has reached the "Guru Meditation" condition. This condition indicates an
584	internal VMM (virtual machine manager) failure which may happen as a
585	result of either an unhandled low-level virtual hardware exception or one
586	of the recompiler exceptions (such as the <i>too-many-traps</i>
587	condition).
588
589	Note also that any online VM state may transit to the Aborted state. This
590	happens if the process that is executing the virtual machine terminates
591	unexpectedly (for example, crashes). Other than that, the Aborted state is
592	equivalent to PoweredOff.
593
594	There are also a few additional state diagrams that do not deal with
595	virtual machine execution and therefore are shown separately. The states
596	shown on these diagrams are called <i>offline VM states</i> (this includes
597	PoweredOff, Aborted and Saved too).
598
599	The first diagram shows what happens when a lengthy setup operation is
600	being executed (such as <link to="IMachine::attachDevice"/>).
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| \| \|
607	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
608	\| \|
609	+-> Saved -------+
610	</pre>
611
612	The next two diagrams demonstrate the process of taking a snapshot of a
613	powered off virtual machine, restoring the state to that as of a snapshot
614	or deleting a snapshot, respectively.
615
616	<pre>
617	+----------------------------------(same state as before the call)------+
618	\| \|
619	+-> PoweredOff --+ \|
620	\| +-->[takeSnapshot()] -------------------> Saving ------+
621	+-> Aborted -----+
622
623	+-> PoweredOff --+
624	\| \|
625	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
626	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
627	+-> Saved -------+ \|
628	\| \|
629	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
630	</pre>
631
632	Note that the Saving state is present in both the offline state group and
633	online state group. Currently, the only way to determine what group is
634	assumed in a particular case is to remember the previous machine state: if
635	it was Running or Paused, then Saving is an online state, otherwise it is
636	an offline state. This inconsistency may be removed in one of the future
637	versions of VirtualBox by adding a new state.
638
639	<note internal="yes">
640	For whoever decides to touch this enum: In order to keep the
641	comparisons involving FirstOnline and LastOnline pseudo-states valid,
642	the numeric values of these states must be correspondingly updated if
643	needed: for any online VM state, the condition
644	<tt>FirstOnline <= state <= LastOnline</tt> must be
645	@c true. The same relates to transient states for which
646	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
647	@c true.
648	</note>
649	</desc>
650
651	<const name="Null" value="0">
652	<desc>Null value (never used by the API).</desc>
653	</const>
654	<const name="PoweredOff" value="1">
655	<desc>
656	The machine is not running and has no saved execution state; it has
657	either never been started or been shut down successfully.
658	</desc>
659	</const>
660	<const name="Saved" value="2">
661	<desc>
662	The machine is not currently running, but the execution state of the machine
663	has been saved to an external file when it was running, from where
664	it can be resumed.
665	</desc>
666	</const>
667	<const name="Teleported" value="3">
668	<desc>
669	The machine was teleported to a different host (or process) and then
670	powered off. Take care when powering it on again may corrupt resources
671	it shares with the teleportation target (e.g. disk and network).
672	</desc>
673	</const>
674	<const name="Aborted" value="4">
675	<desc>
676	The process running the machine has terminated abnormally. This may
677	indicate a crash of the VM process in host execution context, or
678	the VM process has been terminated externally.
679	</desc>
680	</const>
681	<const name="Running" value="5">
682	<desc>
683	The machine is currently being executed.
684	<note internal="yes">
685	For whoever decides to touch this enum: In order to keep the
686	comparisons in the old source code valid, this state must immediately
687	precede the Paused state.
688	TODO: Lift this spectacularly wonderful restriction.
689	</note>
690	</desc>
691	</const>
692	<const name="Paused" value="6">
693	<desc>
694	Execution of the machine has been paused.
695	<note internal="yes">
696	For whoever decides to touch this enum: In order to keep the
697	comparisons in the old source code valid, this state must immediately
698	follow the Running state.
699	TODO: Lift this spectacularly wonderful restriction.
700	</note>
701	</desc>
702	</const>
703	<const name="Stuck" value="7">
704	<desc>
705	Execution of the machine has reached the "Guru Meditation"
706	condition. This indicates a severe error in the hypervisor itself.
707	<note internal="yes">
708	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
709	"Guru", perhaps? Or are there some other VMM states that are
710	intended to be lumped in here as well?
711	</note>
712	</desc>
713	</const>
714	<const name="Teleporting" value="8">
715	<desc>
716	The machine is about to be teleported to a different host or process.
717	It is possible to pause a machine in this state, but it will go to the
718	@c TeleportingPausedVM state and it will not be
719	possible to resume it again unless the teleportation fails.
720	</desc>
721	</const>
722	<const name="LiveSnapshotting" value="9">
723	<desc>
724	A live snapshot is being taken. The machine is running normally, but
725	some of the runtime configuration options are inaccessible. Also, if
726	paused while in this state it will transition to
727	@c Saving and it will not be resume the
728	execution until the snapshot operation has completed.
729	</desc>
730	</const>
731	<const name="Starting" value="10">
732	<desc>
733	Machine is being started after powering it on from a
734	zero execution state.
735	</desc>
736	</const>
737	<const name="Stopping" value="11">
738	<desc>
739	Machine is being normally stopped powering it off, or after the guest OS
740	has initiated a shutdown sequence.
741	</desc>
742	</const>
743	<const name="Saving" value="12">
744	<desc>
745	Machine is saving its execution state to a file, or an online
746	snapshot of the machine is being taken.
747	</desc>
748	</const>
749	<const name="Restoring" value="13">
750	<desc>
751	Execution state of the machine is being restored from a file
752	after powering it on from the saved execution state.
753	</desc>
754	</const>
755	<const name="TeleportingPausedVM" value="14">
756	<desc>
757	The machine is being teleported to another host or process, but it is
758	not running. This is the paused variant of the
759	@c state.
760	</desc>
761	</const>
762	<const name="TeleportingIn" value="15">
763	<desc>
764	Teleporting the machine state in from another host or process.
765	</desc>
766	</const>
767	<const name="FaultTolerantSyncing" value="16">
768	<desc>
769	The machine is being synced with a fault tolerant VM running elsewhere.
770	</desc>
771	</const>
772	<const name="DeletingSnapshotOnline" value="17">
773	<desc>
774	Like @c DeletingSnapshot, but the merging of media is ongoing in
775	the background while the machine is running.
776	</desc>
777	</const>
778	<const name="DeletingSnapshotPaused" value="18">
779	<desc>
780	Like @c DeletingSnapshotOnline, but the machine was paused when the
781	merging of differencing media was started.
782	</desc>
783	</const>
784	<const name="RestoringSnapshot" value="19">
785	<desc>
786	A machine snapshot is being restored; this typically does not take long.
787	</desc>
788	</const>
789	<const name="DeletingSnapshot" value="20">
790	<desc>
791	A machine snapshot is being deleted; this can take a long time since this
792	may require merging differencing media. This value indicates that the
793	machine is not running while the snapshot is being deleted.
794	</desc>
795	</const>
796	<const name="SettingUp" value="21">
797	<desc>
798	Lengthy setup operation is in progress.
799	</desc>
800	</const>
801
802	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
803	<desc>
804	Pseudo-state: first online state (for use in relational expressions).
805	</desc>
806	</const>
807	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
808	<desc>
809	Pseudo-state: last online state (for use in relational expressions).
810	</desc>
811	</const>
812
813	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
814	<desc>
815	Pseudo-state: first transient state (for use in relational expressions).
816	</desc>
817	</const>
818	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
819	<desc>
820	Pseudo-state: last transient state (for use in relational expressions).
821	</desc>
822	</const>
823
824	</enum>
825
826	<enum
827	name="SessionState"
828	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
829	>
830	<desc>
831	Session state. This enumeration represents possible values of
832	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
833	attributes.
834	</desc>
835
836	<const name="Null" value="0">
837	<desc>Null value (never used by the API).</desc>
838	</const>
839	<const name="Unlocked" value="1">
840	<desc>
841	In <link to="IMachine::sessionState"/>, this means that the machine
842	is not locked for any sessions.
843
844	In <link to="ISession::state"/>, this means that no machine is
845	currently locked for this session.
846	</desc>
847	</const>
848	<const name="Locked" value="2">
849	<desc>
850	In <link to="IMachine::sessionState"/>, this means that the machine
851	is currently locked for a session, whose process identifier can
852	then be found in the <link to="IMachine::sessionPID" /> attribute.
853
854	In <link to="ISession::state"/>, this means that a machine is
855	currently locked for this session, and the mutable machine object
856	can be found in the <link to="ISession::machine"/> attribute
857	(see <link to="IMachine::lockMachine" /> for details).
858	</desc>
859	</const>
860	<const name="Spawning" value="3">
861	<desc>
862	A new process is being spawned for the machine as a result of
863	<link to="IMachine::launchVMProcess"/> call. This state also occurs
864	as a short transient state during an <link to="IMachine::lockMachine"/>
865	call.
866	</desc>
867	</const>
868	<const name="Unlocking" value="4">
869	<desc>
870	The session is being unlocked.
871	</desc>
872	</const>
873	</enum>
874
875	<enum
876	name="CPUPropertyType"
877	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
878	>
879	<desc>
880	Virtual CPU property type. This enumeration represents possible values of the
881	IMachine get- and setCPUProperty methods.
882	</desc>
883	<const name="Null" value="0">
884	<desc>Null value (never used by the API).</desc>
885	</const>
886	<const name="PAE" value="1">
887	<desc>
888	This setting determines whether VirtualBox will expose the Physical Address
889	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
890	is not available, it will not be reported.
891	</desc>
892	</const>
893	<const name="Synthetic" value="2">
894	<desc>
895	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
896	teleporting between host systems that differ significantly.
897	</desc>
898	</const>
899	</enum>
900
901
902	<enum
903	name="HWVirtExPropertyType"
904	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
905	>
906	<desc>
907	Hardware virtualization property type. This enumeration represents possible values
908	for the <link to="IMachine::getHWVirtExProperty"/> and
909	<link to="IMachine::setHWVirtExProperty"/> methods.
910	</desc>
911	<const name="Null" value="0">
912	<desc>Null value (never used by the API).</desc>
913	</const>
914	<const name="Enabled" value="1">
915	<desc>
916	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
917	such extensions are not available, they will not be used.
918	</desc>
919	</const>
920	<const name="Exclusive" value="2">
921	<desc>
922	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
923	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
924	feature of the host. To share these with other hypervisors, you must disable this property.
925	</desc>
926	</const>
927	<const name="VPID" value="3">
928	<desc>
929	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
930	</desc>
931	</const>
932	<const name="NestedPaging" value="4">
933	<desc>
934	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
935	</desc>
936	</const>
937	<const name="LargePages" value="5">
938	<desc>
939	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
940	</desc>
941	</const>
942	<const name="Force" value="6">
943	<desc>
944	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
945	not set, there will be an automatic fallback to software virtualization.
946	</desc>
947	</const>
948	</enum>
949
950	<enum
951	name="FaultToleranceState"
952	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
953	>
954	<desc>
955	Used with <link to="IMachine::faultToleranceState" />.
956	</desc>
957	<const name="Inactive" value="1">
958	<desc>No fault tolerance enabled.</desc>
959	</const>
960	<const name="Master" value="2">
961	<desc>Fault tolerant master VM.</desc>
962	</const>
963	<const name="Standby" value="3">
964	<desc>Fault tolerant standby VM.</desc>
965	</const>
966	</enum>
967
968	<enum
969	name="LockType"
970	uuid="168a6a8e-12fd-4878-a1f9-38a750a56089"
971	>
972	<desc>
973	Used with <link to="IMachine::lockMachine" />.
974	</desc>
975	<const name="Write" value="2">
976	<desc>Lock the machine for writing.</desc>
977	</const>
978	<const name="Shared" value="1">
979	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
980	</const>
981	<const name="VM" value="3">
982	<desc>Lock the machine for writing, and create objects necessary for
983	running a VM in this process.</desc>
984	</const>
985	</enum>
986
987	<enum
988	name="SessionType"
989	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
990	>
991	<desc>
992	Session type. This enumeration represents possible values of the
993	<link to="ISession::type"/> attribute.
994	</desc>
995
996	<const name="Null" value="0">
997	<desc>Null value (never used by the API).</desc>
998	</const>
999	<const name="WriteLock" value="1">
1000	<desc>
1001	Session has acquired an exclusive write lock on a machine
1002	using <link to="IMachine::lockMachine"/>.
1003	</desc>
1004	</const>
1005	<const name="Remote" value="2">
1006	<desc>
1007	Session has launched a VM process using
1008	<link to="IMachine::launchVMProcess"/>
1009	</desc>
1010	</const>
1011	<const name="Shared" value="3">
1012	<desc>
1013	Session has obtained a link to another session using
1014	<link to="IMachine::lockMachine"/>
1015	</desc>
1016	</const>
1017	</enum>
1018
1019	<enum
1020	name="DeviceType"
1021	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1022	>
1023	<desc>
1024	Device type.
1025	</desc>
1026	<const name="Null" value="0">
1027	<desc>
1028	Null value, may also mean "no device" (not allowed for
1029	<link to="IConsole::getDeviceActivity"/>).
1030	</desc>
1031	</const>
1032	<const name="Floppy" value="1">
1033	<desc>Floppy device.</desc>
1034	</const>
1035	<const name="DVD" value="2">
1036	<desc>CD/DVD-ROM device.</desc>
1037	</const>
1038	<const name="HardDisk" value="3">
1039	<desc>Hard disk device.</desc>
1040	</const>
1041	<const name="Network" value="4">
1042	<desc>Network device.</desc>
1043	</const>
1044	<const name="USB" value="5">
1045	<desc>USB device.</desc>
1046	</const>
1047	<const name="SharedFolder" value="6">
1048	<desc>Shared folder device.</desc>
1049	</const>
1050	</enum>
1051
1052	<enum
1053	name="DeviceActivity"
1054	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1055	>
1056	<desc>
1057	Device activity for <link to="IConsole::getDeviceActivity"/>.
1058	</desc>
1059
1060	<const name="Null" value="0"/>
1061	<const name="Idle" value="1"/>
1062	<const name="Reading" value="2"/>
1063	<const name="Writing" value="3"/>
1064	</enum>
1065
1066	<enum
1067	name="ClipboardMode"
1068	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1069	>
1070	<desc>
1071	Host-Guest clipboard interchange mode.
1072	</desc>
1073
1074	<const name="Disabled" value="0"/>
1075	<const name="HostToGuest" value="1"/>
1076	<const name="GuestToHost" value="2"/>
1077	<const name="Bidirectional" value="3"/>
1078	</enum>
1079
1080	<enum
1081	name="DragAndDropMode"
1082	uuid="b618ea0e-b6fb-4f8d-97f7-5e237e49b547"
1083	>
1084	<desc>
1085	Drag'n'Drop interchange mode.
1086	</desc>
1087
1088	<const name="Disabled" value="0"/>
1089	<const name="HostToGuest" value="1"/>
1090	<const name="GuestToHost" value="2"/>
1091	<const name="Bidirectional" value="3"/>
1092	</enum>
1093
1094	<enum
1095	name="Scope"
1096	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1097	>
1098	<desc>
1099	Scope of the operation.
1100
1101	A generic enumeration used in various methods to define the action or
1102	argument scope.
1103	</desc>
1104
1105	<const name="Global" value="0"/>
1106	<const name="Machine" value="1"/>
1107	<const name="Session" value="2"/>
1108	</enum>
1109
1110	<enum
1111	name="BIOSBootMenuMode"
1112	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1113	>
1114	<desc>
1115	BIOS boot menu mode.
1116	</desc>
1117
1118	<const name="Disabled" value="0"/>
1119	<const name="MenuOnly" value="1"/>
1120	<const name="MessageAndMenu" value="2"/>
1121	</enum>
1122
1123	<enum
1124	name="ProcessorFeature"
1125	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1126	>
1127	<desc>
1128	CPU features.
1129	</desc>
1130
1131	<const name="HWVirtEx" value="0"/>
1132	<const name="PAE" value="1"/>
1133	<const name="LongMode" value="2"/>
1134	<const name="NestedPaging" value="3"/>
1135	</enum>
1136
1137	<enum
1138	name="FirmwareType"
1139	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1140	>
1141	<desc>
1142	Firmware type.
1143	</desc>
1144	<const name="BIOS" value="1">
1145	<desc>BIOS Firmware.</desc>
1146	</const>
1147	<const name="EFI" value="2">
1148	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1149	</const>
1150	<const name="EFI32" value="3">
1151	<desc>Efi firmware, 32-bit.</desc>
1152	</const>
1153	<const name="EFI64" value="4">
1154	<desc>Efi firmware, 64-bit.</desc>
1155	</const>
1156	<const name="EFIDUAL" value="5">
1157	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1158	</const>
1159	</enum>
1160
1161	<enum
1162	name="PointingHIDType"
1163	uuid="e44b2f7b-72ba-44fb-9e53-2186014f0d17"
1164	>
1165	<desc>
1166	Type of pointing device used in a virtual machine.
1167	</desc>
1168	<const name="None" value="1">
1169	<desc>No mouse.</desc>
1170	</const>
1171	<const name="PS2Mouse" value="2">
1172	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1173	</const>
1174	<const name="USBMouse" value="3">
1175	<desc>USB mouse (relative pointer).</desc>
1176	</const>
1177	<const name="USBTablet" value="4">
1178	<desc>USB tablet (absolute pointer).</desc>
1179	</const>
1180	<const name="ComboMouse" value="5">
1181	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1182	Using of such device can have negative performance implications. </desc>
1183	</const>
1184	</enum>
1185
1186	<enum
1187	name="KeyboardHIDType"
1188	uuid="383e43d7-5c7c-4ec8-9cb8-eda1bccd6699"
1189	>
1190	<desc>
1191	Type of keyboard device used in a virtual machine.
1192	</desc>
1193	<const name="None" value="1">
1194	<desc>No keyboard.</desc>
1195	</const>
1196	<const name="PS2Keyboard" value="2">
1197	<desc>PS/2 keyboard.</desc>
1198	</const>
1199	<const name="USBKeyboard" value="3">
1200	<desc>USB keyboard.</desc>
1201	</const>
1202	<const name="ComboKeyboard" value="4">
1203	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1204	Using of such device can have negative performance implications. </desc>
1205	</const>
1206	</enum>
1207
1208	<!--
1209	// IVirtualBoxErrorInfo
1210	/////////////////////////////////////////////////////////////////////////
1211	-->
1212
1213	<interface
1214	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1215	uuid="f91e6e91-49e1-4fd2-b21e-269003350d06"
1216	supportsErrorInfo="no"
1217	wsmap="managed"
1218	>
1219	<desc>
1220	The IVirtualBoxErrorInfo interface represents extended error information.
1221
1222	Extended error information can be set by VirtualBox components after
1223	unsuccessful or partially successful method invocation. This information
1224	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1225	and then shown to the client in addition to the plain 32-bit result code.
1226
1227	In MS COM, this interface extends the IErrorInfo interface,
1228	in XPCOM, it extends the nsIException interface. In both cases,
1229	it provides a set of common attributes to retrieve error
1230	information.
1231
1232	Sometimes invocation of some component's method may involve methods of
1233	other components that may also fail (independently of this method's
1234	failure), or a series of non-fatal errors may precede a fatal error that
1235	causes method failure. In cases like that, it may be desirable to preserve
1236	information about all errors happened during method invocation and deliver
1237	it to the caller. The <link to="#next"/> attribute is intended
1238	specifically for this purpose and allows to represent a chain of errors
1239	through a single IVirtualBoxErrorInfo object set after method invocation.
1240
1241	<note>errors are stored to a chain in the reverse order, i.e. the
1242	initial error object you query right after method invocation is the last
1243	error set by the callee, the object it points to in the @a next attribute
1244	is the previous error and so on, up to the first error (which is the last
1245	in the chain).</note>
1246	</desc>
1247
1248	<attribute name="resultCode" type="long" readonly="yes">
1249	<desc>
1250	Result code of the error.
1251	Usually, it will be the same as the result code returned
1252	by the method that provided this error information, but not
1253	always. For example, on Win32, CoCreateInstance() will most
1254	likely return E_NOINTERFACE upon unsuccessful component
1255	instantiation attempt, but not the value the component factory
1256	returned. Value is typed 'long', not 'result',
1257	to make interface usable from scripting languages.
1258	<note>
1259	In MS COM, there is no equivalent.
1260	In XPCOM, it is the same as nsIException::result.
1261	</note>
1262	</desc>
1263	</attribute>
1264
1265	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1266	<desc>
1267	UUID of the interface that defined the error.
1268	<note>
1269	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1270	data type.
1271	In XPCOM, there is no equivalent.
1272	</note>
1273	</desc>
1274	</attribute>
1275
1276	<attribute name="component" type="wstring" readonly="yes">
1277	<desc>
1278	Name of the component that generated the error.
1279	<note>
1280	In MS COM, it is the same as IErrorInfo::GetSource.
1281	In XPCOM, there is no equivalent.
1282	</note>
1283	</desc>
1284	</attribute>
1285
1286	<attribute name="text" type="wstring" readonly="yes">
1287	<desc>
1288	Text description of the error.
1289	<note>
1290	In MS COM, it is the same as IErrorInfo::GetDescription.
1291	In XPCOM, it is the same as nsIException::message.
1292	</note>
1293	</desc>
1294	</attribute>
1295
1296	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1297	<desc>
1298	Next error object if there is any, or @c null otherwise.
1299	<note>
1300	In MS COM, there is no equivalent.
1301	In XPCOM, it is the same as nsIException::inner.
1302	</note>
1303	</desc>
1304	</attribute>
1305
1306	</interface>
1307
1308	<!--
1309	// IVirtualBox
1310	/////////////////////////////////////////////////////////////////////////
1311	-->
1312
1313	<interface
1314	name="IDHCPServer" extends="$unknown"
1315	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1316	wsmap="managed"
1317	>
1318	<desc>
1319	The IDHCPServer interface represents the vbox DHCP server configuration.
1320
1321	To enumerate all the DHCP servers on the host, use the
1322	<link to="IVirtualBox::DHCPServers"/> attribute.
1323	</desc>
1324
1325	<attribute name="enabled" type="boolean">
1326	<desc>
1327	specifies if the DHCP server is enabled
1328	</desc>
1329	</attribute>
1330
1331	<attribute name="IPAddress" type="wstring" readonly="yes">
1332	<desc>
1333	specifies server IP
1334	</desc>
1335	</attribute>
1336
1337	<attribute name="networkMask" type="wstring" readonly="yes">
1338	<desc>
1339	specifies server network mask
1340	</desc>
1341	</attribute>
1342
1343	<attribute name="networkName" type="wstring" readonly="yes">
1344	<desc>
1345	specifies internal network name the server is used for
1346	</desc>
1347	</attribute>
1348
1349	<attribute name="lowerIP" type="wstring" readonly="yes">
1350	<desc>
1351	specifies from IP address in server address range
1352	</desc>
1353	</attribute>
1354
1355	<attribute name="upperIP" type="wstring" readonly="yes">
1356	<desc>
1357	specifies to IP address in server address range
1358	</desc>
1359	</attribute>
1360
1361	<method name="setConfiguration">
1362	<desc>
1363	configures the server
1364	<result name="E_INVALIDARG">
1365	invalid configuration supplied
1366	</result>
1367	</desc>
1368	<param name="IPAddress" type="wstring" dir="in">
1369	<desc>
1370	server IP address
1371	</desc>
1372	</param>
1373	<param name="networkMask" type="wstring" dir="in">
1374	<desc>
1375	server network mask
1376	</desc>
1377	</param>
1378	<param name="FromIPAddress" type="wstring" dir="in">
1379	<desc>
1380	server From IP address for address range
1381	</desc>
1382	</param>
1383	<param name="ToIPAddress" type="wstring" dir="in">
1384	<desc>
1385	server To IP address for address range
1386	</desc>
1387	</param>
1388	</method>
1389
1390	<method name="start">
1391	<desc>
1392	Starts DHCP server process.
1393	<result name="E_FAIL">
1394	Failed to start the process.
1395	</result>
1396	</desc>
1397	<param name="networkName" type="wstring" dir="in">
1398	<desc>
1399	Name of internal network DHCP server should attach to.
1400	</desc>
1401	</param>
1402	<param name="trunkName" type="wstring" dir="in">
1403	<desc>
1404	Name of internal network trunk.
1405	</desc>
1406	</param>
1407	<param name="trunkType" type="wstring" dir="in">
1408	<desc>
1409	Type of internal network trunk.
1410	</desc>
1411	</param>
1412	</method>
1413
1414	<method name="stop">
1415	<desc>
1416	Stops DHCP server process.
1417	<result name="E_FAIL">
1418	Failed to stop the process.
1419	</result>
1420	</desc>
1421	</method>
1422	</interface>
1423
1424	<interface
1425	name="IVirtualBox" extends="$unknown"
1426	uuid="5c8814a1-2a35-402d-8680-68e5cb4e72aa"
1427	wsmap="managed"
1428	>
1429	<desc>
1430	The IVirtualBox interface represents the main interface exposed by the
1431	product that provides virtual machine management.
1432
1433	An instance of IVirtualBox is required for the product to do anything
1434	useful. Even though the interface does not expose this, internally,
1435	IVirtualBox is implemented as a singleton and actually lives in the
1436	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1437	IVirtualBox can track the state of all virtual machines on a particular
1438	host, regardless of which frontend started them.
1439
1440	To enumerate all the virtual machines on the host, use the
1441	<link to="IVirtualBox::machines"/> attribute.
1442	</desc>
1443
1444	<attribute name="version" type="wstring" readonly="yes">
1445	<desc>
1446	A string representing the version number of the product. The
1447	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1448	last number represents the build number and will frequently change.
1449
1450	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1451	in prerelease builds. Non-Oracle builds may (/shall) also have a
1452	publisher tag, at the end. The publisher tag starts with an underscore
1453	just like the prerelease build type tag.
1454	</desc>
1455	</attribute>
1456
1457	<attribute name="versionNormalized" type="wstring" readonly="yes">
1458	<desc>
1459	A string representing the version number of the product,
1460	without the publisher information (but still with other tags).
1461	See <link to="#version" />.
1462	</desc>
1463	</attribute>
1464
1465	<attribute name="revision" type="unsigned long" readonly="yes">
1466	<desc>
1467	The internal build revision number of the product.
1468	</desc>
1469	</attribute>
1470
1471	<attribute name="packageType" type="wstring" readonly="yes">
1472	<desc>
1473	A string representing the package type of this product. The
1474	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1475	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1476	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1477	this.
1478	</desc>
1479	</attribute>
1480
1481	<attribute name="APIVersion" type="wstring" readonly="yes">
1482	<desc>
1483	A string representing the VirtualBox API version number. The format is
1484	2 integer numbers divided by an underscore (e.g. 1_0). After the
1485	first public release of packages with a particular API version the
1486	API will not be changed in an incompatible way. Note that this
1487	guarantee does not apply to development builds, and also there is no
1488	guarantee that this version is identical to the first two integer
1489	numbers of the package version.
1490	</desc>
1491	</attribute>
1492
1493	<attribute name="homeFolder" type="wstring" readonly="yes">
1494	<desc>
1495	Full path to the directory where the global settings file,
1496	<tt>VirtualBox.xml</tt>, is stored.
1497
1498	In this version of VirtualBox, the value of this property is
1499	always <tt><user_dir>/.VirtualBox</tt> (where
1500	<tt><user_dir></tt> is the path to the user directory,
1501	as determined by the host OS), and cannot be changed.
1502
1503	This path is also used as the base to resolve relative paths in
1504	places where relative paths are allowed (unless otherwise
1505	expressly indicated).
1506	</desc>
1507	</attribute>
1508
1509	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1510	<desc>
1511	Full name of the global settings file.
1512	The value of this property corresponds to the value of
1513	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="host" type="IHost" readonly="yes">
1518	<desc>Associated host object.</desc>
1519	</attribute>
1520
1521	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1522	<desc>Associated system information object.</desc>
1523	</attribute>
1524
1525	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1526	<desc>
1527	Array of machine objects registered within this VirtualBox instance.
1528	</desc>
1529	</attribute>
1530
1531	<attribute name="machineGroups" type="wstring" readonly="yes" safearray="yes">
1532	<desc>
1533	Array of all machine group names which are used by the machines which
1534	are accessible. Each group is only listed once, however they are listed
1535	in no particular order and there is no guarantee that there are no gaps
1536	in the group hierarchy (i.e. <tt>"/"</tt>, <tt>"/group/subgroup"</tt>
1537	is a valid result).
1538	</desc>
1539	</attribute>
1540
1541	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1542	<desc>
1543	Array of medium objects known to this VirtualBox installation.
1544
1545	This array contains only base media. All differencing
1546	media of the given base medium can be enumerated using
1547	<link to="IMedium::children"/>.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1552	<desc>
1553	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1558	<desc>
1559	Array of floppy image objects currently in use by this VirtualBox instance.
1560	</desc>
1561	</attribute>
1562
1563	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1564
1565	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1566
1567	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1568	<desc>
1569	Collection of global shared folders. Global shared folders are
1570	available to all virtual machines.
1571
1572	New shared folders are added to the collection using
1573	<link to="#createSharedFolder"/>. Existing shared folders can be
1574	removed using <link to="#removeSharedFolder"/>.
1575
1576	<note>
1577	In the current version of the product, global shared folders are not
1578	implemented and therefore this collection is always empty.
1579	</note>
1580	</desc>
1581	</attribute>
1582
1583	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1584	<desc>
1585	Associated performance collector object.
1586	</desc>
1587	</attribute>
1588
1589	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1590	<desc>
1591	DHCP servers.
1592	</desc>
1593	</attribute>
1594
1595	<attribute name="eventSource" type="IEventSource" readonly="yes">
1596	<desc>
1597	Event source for VirtualBox events.
1598	</desc>
1599	</attribute>
1600
1601	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1602	<desc>
1603	The extension pack manager.
1604	</desc>
1605	</attribute>
1606
1607
1608	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1609	<desc>
1610	Names of all internal networks.
1611	</desc>
1612	</attribute>
1613
1614	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1615	<desc>
1616	Names of all generic network drivers.
1617	</desc>
1618	</attribute>
1619
1620	<method name="composeMachineFilename">
1621	<desc>
1622	Returns a recommended full path of the settings file name for a new virtual
1623	machine.
1624
1625	This API serves two purposes:
1626
1627	<ul>
1628	<li>It gets called by <link to="#createMachine" /> if @c null or
1629	empty string (which is recommended) is specified for the
1630	@a settingsFile argument there, which means that API should use
1631	a recommended default file name.</li>
1632
1633	<li>It can be called manually by a client software before creating a machine,
1634	e.g. if that client wants to pre-create the machine directory to create
1635	virtual hard disks in that directory together with the new machine
1636	settings file. In that case, the file name should be stripped from the
1637	full settings file path returned by this function to obtain the
1638	machine directory.</li>
1639	</ul>
1640
1641	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1642	details about the machine name.
1643
1644	@a groupName defines which additional subdirectory levels should be
1645	included. It must be either a valid group name or @c null or empty
1646	string which designates that the machine will not be related to a
1647	machine group.
1648
1649	If @a baseFolder is a @c null or empty string (which is recommended), the
1650	default machine settings folder
1651	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1652	a base folder for the created machine, resulting in a file name like
1653	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1654	will be used.
1655
1656	This method does not access the host disks. In particular, it does not check
1657	for whether a machine with this name already exists.
1658	</desc>
1659	<param name="name" type="wstring" dir="in">
1660	<desc>Suggested machine name.</desc>
1661	</param>
1662	<param name="group" type="wstring" dir="in">
1663	<desc>Machine group name for the new machine or machine group. It is
1664	used to determine the right subdirectory.</desc>
1665	</param>
1666	<param name="baseFolder" type="wstring" dir="in">
1667	<desc>Base machine folder (optional).</desc>
1668	</param>
1669	<param name="file" type="wstring" dir="return">
1670	<desc>Fully qualified path where the machine would be created.</desc>
1671	</param>
1672	</method>
1673
1674	<method name="createMachine">
1675	<desc>
1676	Creates a new virtual machine by creating a machine settings file at
1677	the given location.
1678
1679	VirtualBox machine settings files use a custom XML dialect. Starting
1680	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1681	and machine files can be created at arbitrary locations.
1682
1683	However, it is recommended that machines are created in the default
1684	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1685	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1686	@c null or empty string (which is recommended) for the @a settingsFile
1687	argument, <link to="#composeMachineFilename" /> is called automatically
1688	to have such a recommended name composed based on the machine name
1689	given in the @a name argument and the primary group.
1690
1691	If the resulting settings file already exists, this method will fail,
1692	unless @a forceOverwrite is set.
1693
1694	The new machine is created unregistered, with the initial configuration
1695	set according to the specified guest OS type. A typical sequence of
1696	actions to create a new virtual machine is as follows:
1697
1698	<ol>
1699	<li>
1700	Call this method to have a new machine created. The returned machine
1701	object will be "mutable" allowing to change any machine property.
1702	</li>
1703
1704	<li>
1705	Configure the machine using the appropriate attributes and methods.
1706	</li>
1707
1708	<li>
1709	Call <link to="IMachine::saveSettings" /> to write the settings
1710	to the machine's XML settings file. The configuration of the newly
1711	created machine will not be saved to disk until this method is
1712	called.
1713	</li>
1714
1715	<li>
1716	Call <link to="#registerMachine" /> to add the machine to the list
1717	of machines known to VirtualBox.
1718	</li>
1719	</ol>
1720
1721	The specified guest OS type identifier must match an ID of one of known
1722	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1723	array.
1724
1725	Optionally, you may specify an UUID of to assign to the created machine.
1726	However, this is not recommended and you should normally pass an empty
1727	(@c null) UUID to this method so that a new UUID will be automatically
1728	generated for every created machine. You can use UUID
1729	00000000-0000-0000-0000-000000000000 as @c null value.
1730
1731	<note>
1732	There is no way to change the name of the settings file or
1733	subfolder of the created machine directly.
1734	</note>
1735
1736	<result name="VBOX_E_OBJECT_NOT_FOUND">
1737	@a osTypeId is invalid.
1738	</result>
1739	<result name="VBOX_E_FILE_ERROR">
1740	Resulting settings file name is invalid or the settings file already
1741	exists or could not be created due to an I/O error.
1742	</result>
1743	<result name="E_INVALIDARG">
1744	@a name is empty or @c null.
1745	</result>
1746	</desc>
1747
1748	<param name="settingsFile" type="wstring" dir="in">
1749	<desc>Fully qualified path where the settings file should be created,
1750	empty string or @c null for a default folder and file based on the
1751	@a name argument and the primary group.
1752	(see <link to="#composeMachineFilename" />).</desc>
1753	</param>
1754	<param name="name" type="wstring" dir="in">
1755	<desc>Machine name.</desc>
1756	</param>
1757	<param name="groups" type="wstring" safearray="yes" dir="in">
1758	<desc>Array of group names. @c null or an empty array have the same
1759	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1760	create a machine without group association.</desc>
1761	</param>
1762	<param name="osTypeId" type="wstring" dir="in">
1763	<desc>Guest OS Type ID.</desc>
1764	</param>
1765	<param name="id" type="uuid" mod="string" dir="in">
1766	<desc>Machine UUID (optional).</desc>
1767	</param>
1768	<param name="forceOverwrite" type="boolean" dir="in">
1769	<desc>If true, an existing machine settings file will be overwritten.</desc>
1770	</param>
1771	<param name="machine" type="IMachine" dir="return">
1772	<desc>Created machine object.</desc>
1773	</param>
1774	</method>
1775
1776	<method name="openMachine">
1777	<desc>
1778	Opens a virtual machine from the existing settings file.
1779	The opened machine remains unregistered until you call
1780	<link to="#registerMachine"/>.
1781
1782	The specified settings file name must be fully qualified.
1783	The file must exist and be a valid machine XML settings file
1784	whose contents will be used to construct the machine object.
1785
1786	<result name="VBOX_E_FILE_ERROR">
1787	Settings file name invalid, not found or sharing violation.
1788	</result>
1789	</desc>
1790	<param name="settingsFile" type="wstring" dir="in">
1791	<desc>
1792	Name of the machine settings file.
1793	</desc>
1794	</param>
1795	<param name="machine" type="IMachine" dir="return">
1796	<desc>Opened machine object.</desc>
1797	</param>
1798	<note>
1799	<link to="IMachine::settingsModified"/> will return
1800	@c false for the created machine, until any of machine settings
1801	are changed.
1802	</note>
1803	</method>
1804
1805	<method name="registerMachine">
1806	<desc>
1807
1808	Registers the machine previously created using
1809	<link to="#createMachine"/> or opened using
1810	<link to="#openMachine"/> within this VirtualBox installation. After
1811	successful method invocation, the
1812	<link to="IMachineRegisteredEvent"/> event is fired.
1813
1814	<note>
1815	This method implicitly calls <link to="IMachine::saveSettings"/>
1816	to save all current machine settings before registering it.
1817	</note>
1818
1819	<result name="VBOX_E_OBJECT_NOT_FOUND">
1820	No matching virtual machine found.
1821	</result>
1822	<result name="VBOX_E_INVALID_OBJECT_STATE">
1823	Virtual machine was not created within this VirtualBox instance.
1824	</result>
1825
1826	</desc>
1827	<param name="machine" type="IMachine" dir="in"/>
1828	</method>
1829
1830	<method name="findMachine">
1831	<desc>
1832	Attempts to find a virtual machine given its name or UUID.
1833
1834	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1835	cannot safely be determined.</note>
1836
1837	<result name="VBOX_E_OBJECT_NOT_FOUND">
1838	Could not find registered machine matching @a nameOrId.
1839	</result>
1840
1841	</desc>
1842	<param name="nameOrId" type="wstring" dir="in">
1843	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1844	</param>
1845	<param name="machine" type="IMachine" dir="return">
1846	<desc>Machine object, if found.</desc>
1847	</param>
1848	</method>
1849
1850	<method name="getMachinesByGroups">
1851	<desc>
1852	Gets all machine references which are in one of the specified groups.
1853	</desc>
1854	<param name="groups" type="wstring" dir="in" safearray="yes">
1855	<desc>What groups to match. The usual group list rules apply, i.e.
1856	passing an empty list will match VMs in the toplevel group, likewise
1857	the empty string.</desc>
1858	</param>
1859	<param name="machines" type="IMachine" dir="return" safearray="yes">
1860	<desc>All machines which matched.</desc>
1861	</param>
1862	</method>
1863
1864	<method name="getMachineStates">
1865	<desc>
1866	Gets the state of several machines in a single operation.
1867	</desc>
1868	<param name="machines" type="IMachine" dir="in" safearray="yes">
1869	<desc>Array with the machine references.</desc>
1870	</param>
1871	<param name="states" type="MachineState" dir="return" safearray="yes">
1872	<desc>Machine states, corresponding to the machines.</desc>
1873	</param>
1874	</method>
1875
1876	<method name="createAppliance">
1877	<desc>
1878	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1879	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1880	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1881	</desc>
1882	<param name="appliance" type="IAppliance" dir="return">
1883	<desc>New appliance.</desc>
1884	</param>
1885	</method>
1886
1887	<method name="createHardDisk">
1888	<desc>
1889	Creates a new base medium object that will use the given storage
1890	format and location for medium data.
1891
1892	The actual storage unit is not created by this method. In order to
1893	do it, and before you are able to attach the created medium to
1894	virtual machines, you must call one of the following methods to
1895	allocate a format-specific storage unit at the specified location:
1896	<ul>
1897	<li><link to="IMedium::createBaseStorage"/></li>
1898	<li><link to="IMedium::createDiffStorage"/></li>
1899	</ul>
1900
1901	Some medium attributes, such as <link to="IMedium::id"/>, may
1902	remain uninitialized until the medium storage unit is successfully
1903	created by one of the above methods.
1904
1905	After the storage unit is successfully created, it will be
1906	accessible through the <link to="#openMedium"/> method and can
1907	be found in the <link to="#hardDisks"/> array.
1908
1909	The list of all storage formats supported by this VirtualBox
1910	installation can be obtained using
1911	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1912	attribute is empty or @c null then the default storage format
1913	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1914	be used for creating a storage unit of the medium.
1915
1916	Note that the format of the location string is storage format specific.
1917	See <link to="IMedium::location"/> and IMedium for more details.
1918
1919	<result name="VBOX_E_OBJECT_NOT_FOUND">
1920	@a format identifier is invalid. See
1921	<link to="ISystemProperties::mediumFormats"/>.
1922	</result>
1923	<result name="VBOX_E_FILE_ERROR">
1924	@a location is a not valid file name (for file-based formats only).
1925	</result>
1926	</desc>
1927	<param name="format" type="wstring" dir="in">
1928	<desc>
1929	Identifier of the storage format to use for the new medium.
1930	</desc>
1931	</param>
1932	<param name="location" type="wstring" dir="in">
1933	<desc>
1934	Location of the storage unit for the new medium.
1935	</desc>
1936	</param>
1937	<param name="medium" type="IMedium" dir="return">
1938	<desc>Created medium object.</desc>
1939	</param>
1940	</method>
1941
1942	<method name="openMedium">
1943	<desc>
1944	Finds existing media or opens a medium from an existing storage location.
1945
1946	Once a medium has been opened, it can be passed to other VirtualBox
1947	methods, in particular to <link to="IMachine::attachDevice" />.
1948
1949	Depending on the given device type, the file at the storage location
1950	must be in one of the media formats understood by VirtualBox:
1951
1952	<ul>
1953	<li>With a "HardDisk" device type, the file must be a hard disk image
1954	in one of the formats supported by VirtualBox (see
1955	<link to="ISystemProperties::mediumFormats" />).
1956	After this method succeeds, if the medium is a base medium, it
1957	will be added to the <link to="#hardDisks"/> array attribute. </li>
1958	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1959	After this method succeeds, the medium will be added to the
1960	<link to="#DVDImages"/> array attribute.</li>
1961	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1962	After this method succeeds, the medium will be added to the
1963	<link to="#floppyImages"/> array attribute.</li>
1964	</ul>
1965
1966	After having been opened, the medium can be re-found by this method
1967	and can be attached to virtual machines. See <link to="IMedium" /> for
1968	more details.
1969
1970	The UUID of the newly opened medium will either be retrieved from the
1971	storage location, if the format supports it (e.g. for hard disk images),
1972	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1973	If for some reason you need to change the medium's UUID, use
1974	<link to="IMedium::setIds" />.
1975
1976	If a differencing hard disk medium is to be opened by this method, the
1977	operation will succeed only if its parent medium and all ancestors,
1978	if any, are already known to this VirtualBox installation (for example,
1979	were opened by this method before).
1980
1981	This method attempts to guess the storage format of the specified medium
1982	by reading medium data at the specified location.
1983
1984	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1985	the image is opened for read/write access and must have according permissions,
1986	as VirtualBox may actually write status information into the disk's metadata
1987	sections.
1988
1989	Note that write access is required for all typical hard disk usage in VirtualBox,
1990	since VirtualBox may need to write metadata such as a UUID into the image.
1991	The only exception is opening a source image temporarily for copying and
1992	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1993	again soon.
1994
1995	The format of the location string is storage format specific. See
1996	<link to="IMedium::location"/> and IMedium for more details.
1997
1998	<result name="VBOX_E_FILE_ERROR">
1999	Invalid medium storage file location or could not find the medium
2000	at the specified location.
2001	</result>
2002	<result name="VBOX_E_IPRT_ERROR">
2003	Could not get medium storage format.
2004	</result>
2005	<result name="E_INVALIDARG">
2006	Invalid medium storage format.
2007	</result>
2008	<result name="VBOX_E_INVALID_OBJECT_STATE">
2009	Medium has already been added to a media registry.
2010	</result>
2011	</desc>
2012	<param name="location" type="wstring" dir="in">
2013	<desc>
2014	Location of the storage unit that contains medium data in one of
2015	the supported storage formats.
2016	</desc>
2017	</param>
2018	<param name="deviceType" type="DeviceType" dir="in">
2019	<desc>
2020	Must be one of "HardDisk", "DVD" or "Floppy".
2021	</desc>
2022	</param>
2023	<param name="accessMode" type="AccessMode" dir="in">
2024	<desc>Whether to open the image in read/write or read-only mode. For
2025	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2026	</param>
2027	<param name="forceNewUuid" type="boolean" dir="in">
2028	<desc>Allows the caller to request a completely new medium UUID for
2029	the image which is to be opened. Useful if one intends to open an exact
2030	copy of a previously opened image, as this would normally fail due to
2031	the duplicate UUID.</desc>
2032	</param>
2033	<param name="medium" type="IMedium" dir="return">
2034	<desc>Opened medium object.</desc>
2035	</param>
2036	</method>
2037
2038	<method name="getGuestOSType">
2039	<desc>
2040	Returns an object describing the specified guest OS type.
2041
2042	The requested guest OS type is specified using a string which is a
2043	mnemonic identifier of the guest operating system, such as
2044	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2045	particular virtual machine can be read or set using the
2046	<link to="IMachine::OSTypeId"/> attribute.
2047
2048	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2049	available guest OS type objects. Each object has an
2050	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2051	the guest OS this object describes.
2052
2053	<result name="E_INVALIDARG">
2054	@a id is not a valid Guest OS type.
2055	</result>
2056
2057	</desc>
2058	<param name="id" type="uuid" mod="string" dir="in">
2059	<desc>Guest OS type ID string.</desc>
2060	</param>
2061	<param name="type" type="IGuestOSType" dir="return">
2062	<desc>Guest OS type object.</desc>
2063	</param>
2064	</method>
2065
2066	<method name="createSharedFolder">
2067	<desc>
2068	Creates a new global shared folder by associating the given logical
2069	name with the given host path, adds it to the collection of shared
2070	folders and starts sharing it. Refer to the description of
2071	<link to="ISharedFolder"/> to read more about logical names.
2072	<note>
2073	In the current implementation, this operation is not
2074	implemented.
2075	</note>
2076	</desc>
2077	<param name="name" type="wstring" dir="in">
2078	<desc>Unique logical name of the shared folder.</desc>
2079	</param>
2080	<param name="hostPath" type="wstring" dir="in">
2081	<desc>Full path to the shared folder in the host file system.</desc>
2082	</param>
2083	<param name="writable" type="boolean" dir="in">
2084	<desc>Whether the share is writable or readonly</desc>
2085	</param>
2086	<param name="automount" type="boolean" dir="in">
2087	<desc>Whether the share gets automatically mounted by the guest
2088	or not.</desc>
2089	</param>
2090	</method>
2091
2092	<method name="removeSharedFolder">
2093	<desc>
2094	Removes the global shared folder with the given name previously
2095	created by <link to="#createSharedFolder"/> from the collection of
2096	shared folders and stops sharing it.
2097	<note>
2098	In the current implementation, this operation is not
2099	implemented.
2100	</note>
2101	</desc>
2102	<param name="name" type="wstring" dir="in">
2103	<desc>Logical name of the shared folder to remove.</desc>
2104	</param>
2105	</method>
2106
2107	<method name="getExtraDataKeys">
2108	<desc>
2109	Returns an array representing the global extra data keys which currently
2110	have values defined.
2111	</desc>
2112	<param name="value" type="wstring" dir="return" safearray="yes">
2113	<desc>Array of extra data keys.</desc>
2114	</param>
2115	</method>
2116
2117	<method name="getExtraData">
2118	<desc>
2119	Returns associated global extra data.
2120
2121	If the requested data @a key does not exist, this function will
2122	succeed and return an empty string in the @a value argument.
2123
2124	<result name="VBOX_E_FILE_ERROR">
2125	Settings file not accessible.
2126	</result>
2127	<result name="VBOX_E_XML_ERROR">
2128	Could not parse the settings file.
2129	</result>
2130
2131	</desc>
2132	<param name="key" type="wstring" dir="in">
2133	<desc>Name of the data key to get.</desc>
2134	</param>
2135	<param name="value" type="wstring" dir="return">
2136	<desc>Value of the requested data key.</desc>
2137	</param>
2138	</method>
2139
2140	<method name="setExtraData">
2141	<desc>
2142	Sets associated global extra data.
2143
2144	If you pass @c null or empty string as a key @a value, the given @a key
2145	will be deleted.
2146
2147	<note>
2148	Before performing the actual data change, this method will ask all
2149	registered event listener using the
2150	<link to="IExtraDataCanChangeEvent"/>
2151	notification for a permission. If one of the listeners refuses the
2152	new value, the change will not be performed.
2153	</note>
2154	<note>
2155	On success, the
2156	<link to="IExtraDataChangedEvent"/> notification
2157	is called to inform all registered listeners about a successful data
2158	change.
2159	</note>
2160
2161	<result name="VBOX_E_FILE_ERROR">
2162	Settings file not accessible.
2163	</result>
2164	<result name="VBOX_E_XML_ERROR">
2165	Could not parse the settings file.
2166	</result>
2167	<result name="E_ACCESSDENIED">
2168	Modification request refused.
2169	</result>
2170
2171	</desc>
2172	<param name="key" type="wstring" dir="in">
2173	<desc>Name of the data key to set.</desc>
2174	</param>
2175	<param name="value" type="wstring" dir="in">
2176	<desc>Value to assign to the key.</desc>
2177	</param>
2178	</method>
2179
2180	<method name="setSettingsSecret">
2181	<desc>
2182	Unlocks the secret data by passing the unlock password to the
2183	server. The server will cache the password for that machine.
2184
2185	<result name="VBOX_E_INVALID_VM_STATE">
2186	Virtual machine is not mutable.
2187	</result>
2188
2189	</desc>
2190	<param name="password" type="wstring" dir="in">
2191	<desc>
2192	The cipher key.
2193	</desc>
2194	</param>
2195	</method>
2196
2197	<!--method name="createDHCPServerForInterface">
2198	<desc>
2199	Creates a DHCP server settings to be used for the given interface
2200	<result name="E_INVALIDARG">
2201	Host network interface @a name already exists.
2202	</result>
2203	</desc>
2204	<param name="interface" type="IHostNetworkInterface" dir="in">
2205	<desc>Network Interface</desc>
2206	</param>
2207	<param name="server" type="IDHCPServer" dir="out">
2208	<desc>DHCP server settings</desc>
2209	</param>
2210	</method-->
2211
2212	<method name="createDHCPServer">
2213	<desc>
2214	Creates a DHCP server settings to be used for the given internal network name
2215	<result name="E_INVALIDARG">
2216	Host network interface @a name already exists.
2217	</result>
2218	</desc>
2219	<param name="name" type="wstring" dir="in">
2220	<desc>server name</desc>
2221	</param>
2222	<param name="server" type="IDHCPServer" dir="return">
2223	<desc>DHCP server settings</desc>
2224	</param>
2225	</method>
2226
2227	<method name="findDHCPServerByNetworkName">
2228	<desc>
2229	Searches a DHCP server settings to be used for the given internal network name
2230	<result name="E_INVALIDARG">
2231	Host network interface @a name already exists.
2232	</result>
2233
2234	</desc>
2235	<param name="name" type="wstring" dir="in">
2236	<desc>server name</desc>
2237	</param>
2238	<param name="server" type="IDHCPServer" dir="return">
2239	<desc>DHCP server settings</desc>
2240	</param>
2241	</method>
2242
2243	<!--method name="findDHCPServerForInterface">
2244	<desc>
2245	Searches a DHCP server settings to be used for the given interface
2246	<result name="E_INVALIDARG">
2247	Host network interface @a name already exists.
2248	</result>
2249	</desc>
2250	<param name="interface" type="IHostNetworkInterface" dir="in">
2251	<desc>Network Interface</desc>
2252	</param>
2253	<param name="server" type="IDHCPServer" dir="out">
2254	<desc>DHCP server settings</desc>
2255	</param>
2256	</method-->
2257
2258	<method name="removeDHCPServer">
2259	<desc>
2260	Removes the DHCP server settings
2261	<result name="E_INVALIDARG">
2262	Host network interface @a name already exists.
2263	</result>
2264	</desc>
2265	<param name="server" type="IDHCPServer" dir="in">
2266	<desc>DHCP server settings to be removed</desc>
2267	</param>
2268	</method>
2269
2270
2271	<method name="checkFirmwarePresent">
2272	<desc>
2273	Check if this VirtualBox installation has a firmware
2274	of the given type available, either system-wide or per-user.
2275	Optionally, this may return a hint where this firmware can be
2276	downloaded from.
2277	</desc>
2278	<param name="firmwareType" type="FirmwareType" dir="in">
2279	<desc>
2280	Type of firmware to check.
2281	</desc>
2282	</param>
2283	<param name="version" type="wstring" dir="in">
2284	<desc>Expected version number, usually empty string (presently ignored).</desc>
2285	</param>
2286
2287	<param name="url" type="wstring" dir="out">
2288	<desc>
2289	Suggested URL to download this firmware from.
2290	</desc>
2291	</param>
2292
2293	<param name="file" type="wstring" dir="out">
2294	<desc>
2295	Filename of firmware, only valid if result == TRUE.
2296	</desc>
2297	</param>
2298
2299	<param name="result" type="boolean" dir="return">
2300	<desc>If firmware of this type and version is available.</desc>
2301	</param>
2302	</method>
2303
2304	</interface>
2305
2306	<!--
2307	// IVFSExplorer
2308	/////////////////////////////////////////////////////////////////////////
2309	-->
2310
2311	<enum
2312	name="VFSType"
2313	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2314	>
2315	<desc>
2316	Virtual file systems supported by VFSExplorer.
2317	</desc>
2318
2319	<const name="File" value="1" />
2320	<const name="Cloud" value="2" />
2321	<const name="S3" value="3" />
2322	<const name="WebDav" value="4" />
2323	</enum>
2324
2325	<enum
2326	name="VFSFileType"
2327	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2328	>
2329	<desc>
2330	File types known by VFSExplorer.
2331	</desc>
2332
2333	<const name="Unknown" value="1" />
2334	<const name="Fifo" value="2" />
2335	<const name="DevChar" value="3" />
2336	<const name="Directory" value="4" />
2337	<const name="DevBlock" value="5" />
2338	<const name="File" value="6" />
2339	<const name="SymLink" value="7" />
2340	<const name="Socket" value="8" />
2341	<const name="WhiteOut" value="9" />
2342	</enum>
2343
2344	<interface
2345	name="IVFSExplorer" extends="$unknown"
2346	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2347	wsmap="managed"
2348	>
2349	<desc>
2350	The VFSExplorer interface unifies access to different file system
2351	types. This includes local file systems as well remote file systems like
2352	S3. For a list of supported types see <link to="VFSType" />.
2353	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2354	</desc>
2355
2356	<attribute name="path" type="wstring" readonly="yes">
2357	<desc>Returns the current path in the virtual file system.</desc>
2358	</attribute>
2359
2360	<attribute name="type" type="VFSType" readonly="yes">
2361	<desc>Returns the file system type which is currently in use.</desc>
2362	</attribute>
2363
2364	<method name="update">
2365	<desc>Updates the internal list of files/directories from the
2366	current directory level. Use <link to="#entryList" /> to get the full list
2367	after a call to this method.</desc>
2368
2369	<param name="aProgress" type="IProgress" dir="return">
2370	<desc>Progress object to track the operation completion.</desc>
2371	</param>
2372	</method>
2373
2374	<method name="cd">
2375	<desc>Change the current directory level.</desc>
2376
2377	<param name="aDir" type="wstring" dir="in">
2378	<desc>The name of the directory to go in.</desc>
2379	</param>
2380
2381	<param name="aProgress" type="IProgress" dir="return">
2382	<desc>Progress object to track the operation completion.</desc>
2383	</param>
2384	</method>
2385
2386	<method name="cdUp">
2387	<desc>Go one directory upwards from the current directory level.</desc>
2388
2389	<param name="aProgress" type="IProgress" dir="return">
2390	<desc>Progress object to track the operation completion.</desc>
2391	</param>
2392	</method>
2393
2394	<method name="entryList">
2395	<desc>Returns a list of files/directories after a call to <link
2396	to="#update" />. The user is responsible for keeping this internal
2397	list up do date.</desc>
2398
2399	<param name="aNames" type="wstring" safearray="yes" dir="out">
2400	<desc>The list of names for the entries.</desc>
2401	</param>
2402
2403	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2404	<desc>The list of types for the entries.</desc>
2405	</param>
2406
2407	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2408	<desc>The list of sizes (in bytes) for the entries.</desc>
2409	</param>
2410
2411	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2412	<desc>The list of file modes (in octal form) for the entries.</desc>
2413	</param>
2414	</method>
2415
2416	<method name="exists">
2417	<desc>Checks if the given file list exists in the current directory
2418	level.</desc>
2419
2420	<param name="aNames" type="wstring" safearray="yes" dir="in">
2421	<desc>The names to check.</desc>
2422	</param>
2423
2424	<param name="aExists" type="wstring" safearray="yes" dir="return">
2425	<desc>The names which exist.</desc>
2426	</param>
2427	</method>
2428
2429	<method name="remove">
2430	<desc>Deletes the given files in the current directory level.</desc>
2431
2432	<param name="aNames" type="wstring" safearray="yes" dir="in">
2433	<desc>The names to remove.</desc>
2434	</param>
2435
2436	<param name="aProgress" type="IProgress" dir="return">
2437	<desc>Progress object to track the operation completion.</desc>
2438	</param>
2439	</method>
2440
2441	</interface>
2442
2443	<enum
2444	name="ImportOptions" extends="$unknown"
2445	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2446	>
2447
2448	<desc>
2449	Import options, used with <link to="IAppliance::importMachines" />.
2450	</desc>
2451
2452	<const name="KeepAllMACs" value="1">
2453	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2454	</const>
2455	<const name="KeepNATMACs" value="2">
2456	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2457	</const>
2458
2459	</enum>
2460
2461
2462	<!--
2463	// IAppliance
2464	/////////////////////////////////////////////////////////////////////////
2465	-->
2466
2467	<interface
2468	name="IAppliance" extends="$unknown"
2469	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2470	wsmap="managed"
2471	>
2472	<desc>
2473	Represents a platform-independent appliance in OVF format. An instance of this is returned
2474	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2475	virtual machines within an appliance with VirtualBox.
2476
2477	The OVF standard suggests two different physical file formats:
2478
2479	<ol>
2480	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2481	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2482	this descriptor file references other files such as disk images, as OVF appliances typically
2483	do, those additional files must be in the same directory as the descriptor file.</li>
2484
2485	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2486	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2487	files and optionally other files.
2488
2489	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2490	be added with a later version.</li>
2491	</ol>
2492
2493	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2494	<link to="IMachine" /> involves the following sequence of API calls:
2495
2496	<ol>
2497	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2498	</li>
2499
2500	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2501	would like to import. So long as this file is syntactically valid, this will succeed
2502	and fill the appliance object with the parsed data from the OVF file.
2503	</li>
2504
2505	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2506	contents of the IAppliance attributes accordingly. These can be inspected by a
2507	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2508	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2509	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2510	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2511	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2512	The GUI can then give the user the option to confirm and/or change these suggestions.
2513	</li>
2514
2515	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2516	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2517	</li>
2518
2519	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2520	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2521	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2522	can be found in the <link to="#machines" /> array attribute.
2523	</li>
2524	</ol>
2525
2526	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2527
2528	<ol>
2529	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2530	an empty IAppliance object.
2531	</li>
2532
2533	<li>For each machine you would like to export, call <link to="IMachine::export" />
2534	with the IAppliance object you just created. Each such call creates one instance of
2535	<link to="IVirtualSystemDescription" /> inside the appliance.
2536	</li>
2537
2538	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2539	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2540	</li>
2541
2542	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2543	file written.</li>
2544	</ol>
2545
2546	</desc>
2547
2548	<attribute name="path" type="wstring" readonly="yes">
2549	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2550	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2551	<link to="#write" /> (for export).
2552	This attribute is empty until one of these methods has been called.
2553	</desc>
2554	</attribute>
2555
2556	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2557	<desc>
2558	Array of virtual disk definitions. One such description exists for each
2559	disk definition in the OVF; each string array item represents one such piece of
2560	disk information, with the information fields separated by tab (\\t) characters.
2561
2562	The caller should be prepared for additional fields being appended to
2563	this string in future versions of VirtualBox and therefore check for
2564	the number of tabs in the strings returned.
2565
2566	In the current version, the following eight fields are returned per string
2567	in the array:
2568
2569	<ol>
2570	<li>Disk ID (unique string identifier given to disk)</li>
2571
2572	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2573
2574	<li>Populated size (optional unsigned integer indicating the current size of the
2575	disk; can be approximate; -1 if unspecified)</li>
2576
2577	<li>Format (string identifying the disk format, typically
2578	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2579
2580	<li>Reference (where to find the disk image, typically a file name; if empty,
2581	then the disk should be created on import)</li>
2582
2583	<li>Image size (optional unsigned integer indicating the size of the image,
2584	which need not necessarily be the same as the values specified above, since
2585	the image may be compressed or sparse; -1 if not specified)</li>
2586
2587	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2588	presently unsupported and always -1)</li>
2589
2590	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2591	</ol>
2592	</desc>
2593	</attribute>
2594
2595	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2596	<desc> Array of virtual system descriptions. One such description is created
2597	for each virtual system (machine) found in the OVF.
2598	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2599	(for export) has been called.
2600	</desc>
2601	</attribute>
2602
2603	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2604	<desc>
2605	Contains the UUIDs of the machines created from the information in this appliances. This is only
2606	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2607	succeeded.
2608	</desc>
2609	</attribute>
2610
2611	<method name="read">
2612	<desc>
2613	Reads an OVF file into the appliance object.
2614
2615	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2616	mere fact that this method returns successfully does not mean that VirtualBox supports all
2617	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2618	</desc>
2619	<param name="file" type="wstring" dir="in">
2620	<desc>
2621	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2622	on whether the appliance is distributed as a set of files or as a single file, respectively).
2623	</desc>
2624	</param>
2625	<param name="aProgress" type="IProgress" dir="return">
2626	<desc>Progress object to track the operation completion.</desc>
2627	</param>
2628	</method>
2629
2630	<method name="interpret">
2631	<desc>
2632	Interprets the OVF data that was read when the appliance was constructed. After
2633	calling this method, one can inspect the
2634	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2635	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2636	the appliance.
2637
2638	Calling this method is the second step of importing an appliance into VirtualBox;
2639	see <link to="IAppliance" /> for an overview.
2640
2641	After calling this method, one should call <link to="#getWarnings" /> to find out
2642	if problems were encountered during the processing which might later lead to
2643	errors.
2644	</desc>
2645	</method>
2646
2647	<method name="importMachines">
2648	<desc>
2649	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2650	and other interfaces that match the information contained in the appliance as
2651	closely as possible, as represented by the import instructions in the
2652	<link to="#virtualSystemDescriptions" /> array.
2653
2654	Calling this method is the final step of importing an appliance into VirtualBox;
2655	see <link to="IAppliance" /> for an overview.
2656
2657	Since importing the appliance will most probably involve copying and converting
2658	disk images, which can take a long time, this method operates asynchronously and
2659	returns an IProgress object to allow the caller to monitor the progress.
2660
2661	After the import succeeded, the UUIDs of the IMachine instances created can be
2662	retrieved from the <link to="#machines" /> array attribute.
2663	</desc>
2664
2665	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2666	<desc>Options for the importing operation.</desc>
2667	</param>
2668
2669	<param name="aProgress" type="IProgress" dir="return">
2670	<desc>Progress object to track the operation completion.</desc>
2671	</param>
2672	</method>
2673
2674	<method name="createVFSExplorer">
2675	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2676
2677	<param name="aUri" type="wstring" dir="in">
2678	<desc>The URI describing the file system to use.</desc>
2679	</param>
2680
2681	<param name="aExplorer" type="IVFSExplorer" dir="return">
2682	<desc></desc>
2683	</param>
2684	</method>
2685
2686	<method name="write">
2687	<desc>
2688	Writes the contents of the appliance exports into a new OVF file.
2689
2690	Calling this method is the final step of exporting an appliance from VirtualBox;
2691	see <link to="IAppliance" /> for an overview.
2692
2693	Since exporting the appliance will most probably involve copying and converting
2694	disk images, which can take a long time, this method operates asynchronously and
2695	returns an IProgress object to allow the caller to monitor the progress.
2696	</desc>
2697	<param name="format" type="wstring" dir="in">
2698	<desc>
2699	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2700	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2701	</desc>
2702	</param>
2703	<param name="manifest" type="boolean" dir="in">
2704	<desc>
2705	Indicate if the optional manifest file (.mf) should be written. The manifest file
2706	is used for integrity checks prior import.
2707	</desc>
2708	</param>
2709	<param name="path" type="wstring" dir="in">
2710	<desc>
2711	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2712	on whether the appliance is distributed as a set of files or as a single file, respectively).
2713	</desc>
2714	</param>
2715	<param name="progress" type="IProgress" dir="return">
2716	<desc>Progress object to track the operation completion.</desc>
2717	</param>
2718	</method>
2719
2720	<method name="getWarnings">
2721	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2722
2723	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2724	<desc></desc>
2725	</param>
2726	</method>
2727
2728	</interface>
2729
2730	<enum
2731	name="VirtualSystemDescriptionType"
2732	uuid="303c0900-a746-4612-8c67-79003e91f459"
2733	>
2734	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2735	a configuration value.</desc>
2736
2737	<const name="Ignore" value="1" />
2738	<const name="OS" value="2" />
2739	<const name="Name" value="3" />
2740	<const name="Product" value="4" />
2741	<const name="Vendor" value="5" />
2742	<const name="Version" value="6" />
2743	<const name="ProductUrl" value="7" />
2744	<const name="VendorUrl" value="8" />
2745	<const name="Description" value="9" />
2746	<const name="License" value="10" />
2747	<const name="Miscellaneous" value="11" />
2748	<const name="CPU" value="12" />
2749	<const name="Memory" value="13" />
2750	<const name="HardDiskControllerIDE" value="14" />
2751	<const name="HardDiskControllerSATA" value="15" />
2752	<const name="HardDiskControllerSCSI" value="16" />
2753	<const name="HardDiskControllerSAS" value="17" />
2754	<const name="HardDiskImage" value="18" />
2755	<const name="Floppy" value="19" />
2756	<const name="CDROM" value="20" />
2757	<const name="NetworkAdapter" value="21" />
2758	<const name="USBController" value="22" />
2759	<const name="SoundCard" value="23" />
2760	<const name="SettingsFile" value="24">
2761	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2762	</const>
2763	</enum>
2764
2765	<enum
2766	name="VirtualSystemDescriptionValueType"
2767	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2768	>
2769	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2770	type to fetch.</desc>
2771
2772	<const name="Reference" value="1" />
2773	<const name="Original" value="2" />
2774	<const name="Auto" value="3" />
2775	<const name="ExtraConfig" value="4" />
2776
2777	</enum>
2778
2779	<interface
2780	name="IVirtualSystemDescription" extends="$unknown"
2781	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2782	wsmap="managed"
2783	>
2784
2785	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2786	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2787	<link to="IAppliance::interpret" /> has been called, that array contains information
2788	about how the virtual systems described in the OVF should best be imported into
2789	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2790	import an OVF into VirtualBox.
2791	</desc>
2792
2793	<attribute name="count" type="unsigned long" readonly="yes">
2794	<desc>Return the number of virtual system description entries.</desc>
2795	</attribute>
2796
2797	<method name="getDescription">
2798	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2799	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2800
2801	The list below identifies the value sets that are possible depending on the
2802	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2803	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2804	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2805	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2806	the @a aExtraConfigValues[] array item may also be used.
2807
2808	<ul>
2809	<li>
2810	"OS": the guest operating system type. There must be exactly one such array item on import. The
2811	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2812	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2813	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2814	</li>
2815	<li>
2816	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2817	if none is present on import, then an automatic name will be created from the operating system
2818	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2819	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2820	<link to="IMachine" /> name that does not exist yet.
2821	</li>
2822	<li>
2823	"Description": an arbitrary description.
2824	</li>
2825	<li>
2826	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2827	code to display such a license for agreement; the Main API does not enforce any such policy.
2828	</li>
2829	<li>
2830	Miscellaneous: reserved for future use.
2831	</li>
2832	<li>
2833	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2834	</li>
2835	<li>
2836	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2837	is present on import, then VirtualBox will set a meaningful default based on the operating system
2838	type.
2839	</li>
2840	<li>
2841	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2842	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2843	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2844	writes into the OVF.
2845	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2846	type can use to specify which hard disk controller a virtual disk should be connected to.
2847	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2848	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2849	its virtual machines supports four channels (primary master, primary slave, secondary master,
2850	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2851	</li>
2852	<li>
2853	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2854	has no value in @a aOvfValues[] or @a aVBoxValues[].
2855	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2856	</li>
2857	<li>
2858	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2859	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2860	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2861	whereas VirtualBox considers it a class of storage controllers of its own; see
2862	<link to="StorageControllerType" />).
2863	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2864	</li>
2865	<li>
2866	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2867	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2868
2869	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2870	a path since the image file should be in the same location as the OVF file itself), whereas the
2871	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2872	hard disk image. This means that on import the image will be copied and converted from the
2873	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2874
2875	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2876	format: "controller=<index>;channel=<c>"
2877	In this string, <index> must be an integer specifying the hard disk controller to connect
2878	the image to. That number must be the index of an array item with one of the hard disk controller
2879	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2880	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2881	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2882	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2883	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2884	</li>
2885	<li>
2886	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2887	attachment information as with "HardDiskImage" items.
2888	</li>
2889	<li>
2890	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2891	attachment information as with "HardDiskImage" items.
2892	</li>
2893	<li>
2894	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2895	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2896	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2897	</li>
2898	<li>
2899	"USBController": a USB controller. There can be at most one such item. If and only if such an
2900	item ispresent, USB support will be enabled for the new virtual machine.
2901	</li>
2902	<li>
2903	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2904	present, sound support will be enabled for the new virtual machine. Note that the virtual
2905	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2906	may be different from the virtual soundcard expected by the appliance.
2907	</li>
2908	</ul>
2909
2910	</desc>
2911
2912	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2913	<desc></desc>
2914	</param>
2915
2916	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2917	<desc></desc>
2918	</param>
2919
2920	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2921	<desc></desc>
2922	</param>
2923
2924	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2925	<desc></desc>
2926	</param>
2927
2928	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2929	<desc></desc>
2930	</param>
2931
2932	</method>
2933
2934	<method name="getDescriptionByType">
2935	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2936	should be returned.</desc>
2937
2938	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2939	<desc></desc>
2940	</param>
2941
2942	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2943	<desc></desc>
2944	</param>
2945
2946	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2947	<desc></desc>
2948	</param>
2949
2950	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2951	<desc></desc>
2952	</param>
2953
2954	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2955	<desc></desc>
2956	</param>
2957
2958	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2959	<desc></desc>
2960	</param>
2961
2962	</method>
2963
2964	<method name="getValuesByType">
2965	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2966	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2967	values.</desc>
2968
2969	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2970	<desc></desc>
2971	</param>
2972
2973	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2974	<desc></desc>
2975	</param>
2976
2977	<param name="aValues" type="wstring" dir="return" safearray="yes">
2978	<desc></desc>
2979	</param>
2980
2981	</method>
2982
2983	<method name="setFinalValues">
2984	<desc>
2985	This method allows the appliance's user to change the configuration for the virtual
2986	system descriptions. For each array item returned from <link to="#getDescription" />,
2987	you must pass in one boolean value and one configuration value.
2988
2989	Each item in the boolean array determines whether the particular configuration item
2990	should be enabled.
2991	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2992	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2993	and SoundCard.
2994
2995	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2996	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2997	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2998	for valid configuration values for the individual array item types. If the
2999	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3000	</desc>
3001
3002	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3003	<desc></desc>
3004	</param>
3005
3006	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3007	<desc></desc>
3008	</param>
3009
3010	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3011	<desc></desc>
3012	</param>
3013	</method>
3014
3015	<method name="addDescription">
3016	<desc>
3017	This method adds an additional description entry to the stack of already
3018	available descriptions for this virtual system. This is handy for writing
3019	values which aren't directly supported by VirtualBox. One example would
3020	be the License type of <link to="VirtualSystemDescriptionType" />.
3021	</desc>
3022
3023	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3024	<desc></desc>
3025	</param>
3026
3027	<param name="aVBoxValue" type="wstring" dir="in">
3028	<desc></desc>
3029	</param>
3030
3031	<param name="aExtraConfigValue" type="wstring" dir="in">
3032	<desc></desc>
3033	</param>
3034	</method>
3035	</interface>
3036
3037
3038	<!--
3039	// IMachine
3040	/////////////////////////////////////////////////////////////////////////
3041	-->
3042
3043	<interface
3044	name="IInternalMachineControl" extends="$unknown"
3045	uuid="ec824977-e43f-479c-81c9-ac6cae1423a5"
3046	internal="yes"
3047	wsmap="suppress"
3048	>
3049	<method name="setRemoveSavedStateFile">
3050	<desc>
3051	Updates the flag whether the saved state file is removed on a
3052	machine state change from Saved to PoweredOff.
3053	</desc>
3054	<param name="aRemove" type="boolean" dir="in"/>
3055	</method>
3056
3057	<method name="updateState">
3058	<desc>
3059	Updates the VM state.
3060	<note>
3061	This operation will also update the settings file with the correct
3062	information about the saved state file and delete this file from disk
3063	when appropriate.
3064	</note>
3065	</desc>
3066	<param name="state" type="MachineState" dir="in"/>
3067	</method>
3068
3069	<method name="getIPCId">
3070	<param name="id" type="wstring" dir="return"/>
3071	</method>
3072
3073	<method name="beginPowerUp">
3074	<desc>
3075	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3076	gives it the progress object that should be part of any pending
3077	<link to="IMachine::launchVMProcess"/> operations. The progress
3078	object may be called back to reflect an early cancelation, so some care
3079	have to be taken with respect to any cancelation callbacks. The console
3080	object will call <link to="IInternalMachineControl::endPowerUp"/>
3081	to signal the completion of the progress object.
3082	</desc>
3083	<param name="aProgress" type="IProgress" dir="in" />
3084	</method>
3085
3086	<method name="endPowerUp">
3087	<desc>
3088	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3089	This method may query status information from the progress object it
3090	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3091	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3092	call in order to complete that progress object.
3093	</desc>
3094	<param name="result" type="long" dir="in"/>
3095	</method>
3096
3097	<method name="beginPoweringDown">
3098	<desc>
3099	Called by the VM process to inform the server it wants to
3100	stop the VM execution and power down.
3101	</desc>
3102	<param name="progress" type="IProgress" dir="out">
3103	<desc>
3104	Progress object created by VBoxSVC to wait until
3105	the VM is powered down.
3106	</desc>
3107	</param>
3108	</method>
3109
3110	<method name="endPoweringDown">
3111	<desc>
3112	Called by the VM process to inform the server that powering
3113	down previously requested by #beginPoweringDown is either
3114	successfully finished or there was a failure.
3115
3116	<result name="VBOX_E_FILE_ERROR">
3117	Settings file not accessible.
3118	</result>
3119	<result name="VBOX_E_XML_ERROR">
3120	Could not parse the settings file.
3121	</result>
3122
3123	</desc>
3124
3125	<param name="result" type="long" dir="in">
3126	<desc>@c S_OK to indicate success.
3127	</desc>
3128	</param>
3129	<param name="errMsg" type="wstring" dir="in">
3130	<desc>@c human readable error message in case of failure.
3131	</desc>
3132	</param>
3133	</method>
3134
3135	<method name="runUSBDeviceFilters">
3136	<desc>
3137	Asks the server to run USB devices filters of the associated
3138	machine against the given USB device and tell if there is
3139	a match.
3140	<note>
3141	Intended to be used only for remote USB devices. Local
3142	ones don't require to call this method (this is done
3143	implicitly by the Host and USBProxyService).
3144	</note>
3145	</desc>
3146	<param name="device" type="IUSBDevice" dir="in"/>
3147	<param name="matched" type="boolean" dir="out"/>
3148	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3149	</method>
3150
3151	<method name="captureUSBDevice">
3152	<desc>
3153	Requests a capture of the given host USB device.
3154	When the request is completed, the VM process will
3155	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3156	notification.
3157	</desc>
3158	<param name="id" type="uuid" mod="string" dir="in"/>
3159	</method>
3160
3161	<method name="detachUSBDevice">
3162	<desc>
3163	Notification that a VM is going to detach (@a done = @c false) or has
3164	already detached (@a done = @c true) the given USB device.
3165	When the @a done = @c true request is completed, the VM process will
3166	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3167	notification.
3168	<note>
3169	In the @a done = @c true case, the server must run its own filters
3170	and filters of all VMs but this one on the detached device
3171	as if it were just attached to the host computer.
3172	</note>
3173	</desc>
3174	<param name="id" type="uuid" mod="string" dir="in"/>
3175	<param name="done" type="boolean" dir="in"/>
3176	</method>
3177
3178	<method name="autoCaptureUSBDevices">
3179	<desc>
3180	Requests a capture all matching USB devices attached to the host.
3181	When the request is completed, the VM process will
3182	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3183	notification per every captured device.
3184	</desc>
3185	</method>
3186
3187	<method name="detachAllUSBDevices">
3188	<desc>
3189	Notification that a VM that is being powered down. The done
3190	parameter indicates whether which stage of the power down
3191	we're at. When @a done = @c false the VM is announcing its
3192	intentions, while when @a done = @c true the VM is reporting
3193	what it has done.
3194	<note>
3195	In the @a done = @c true case, the server must run its own filters
3196	and filters of all VMs but this one on all detach devices as
3197	if they were just attached to the host computer.
3198	</note>
3199	</desc>
3200	<param name="done" type="boolean" dir="in"/>
3201	</method>
3202
3203	<method name="onSessionEnd">
3204	<desc>
3205	Triggered by the given session object when the session is about
3206	to close normally.
3207	</desc>
3208	<param name="session" type="ISession" dir="in">
3209	<desc>Session that is being closed</desc>
3210	</param>
3211	<param name="progress" type="IProgress" dir="return">
3212	<desc>
3213	Used to wait until the corresponding machine is actually
3214	dissociated from the given session on the server.
3215	Returned only when this session is a direct one.
3216	</desc>
3217	</param>
3218	</method>
3219
3220	<method name="beginSavingState">
3221	<desc>
3222	Called by the VM process to inform the server it wants to
3223	save the current state and stop the VM execution.
3224	</desc>
3225	<param name="progress" type="IProgress" dir="out">
3226	<desc>
3227	Progress object created by VBoxSVC to wait until
3228	the state is saved.
3229	</desc>
3230	</param>
3231	<param name="stateFilePath" type="wstring" dir="out">
3232	<desc>
3233	File path the VM process must save the execution state to.
3234	</desc>
3235	</param>
3236	</method>
3237
3238	<method name="endSavingState">
3239	<desc>
3240	Called by the VM process to inform the server that saving
3241	the state previously requested by #beginSavingState is either
3242	successfully finished or there was a failure.
3243
3244	<result name="VBOX_E_FILE_ERROR">
3245	Settings file not accessible.
3246	</result>
3247	<result name="VBOX_E_XML_ERROR">
3248	Could not parse the settings file.
3249	</result>
3250
3251	</desc>
3252
3253	<param name="result" type="long" dir="in">
3254	<desc>@c S_OK to indicate success.
3255	</desc>
3256	</param>
3257	<param name="errMsg" type="wstring" dir="in">
3258	<desc>@c human readable error message in case of failure.
3259	</desc>
3260	</param>
3261	</method>
3262
3263	<method name="adoptSavedState">
3264	<desc>
3265	Gets called by <link to="IConsole::adoptSavedState"/>.
3266	<result name="VBOX_E_FILE_ERROR">
3267	Invalid saved state file path.
3268	</result>
3269	</desc>
3270	<param name="savedStateFile" type="wstring" dir="in">
3271	<desc>Path to the saved state file to adopt.</desc>
3272	</param>
3273	</method>
3274
3275	<method name="beginTakingSnapshot">
3276	<desc>
3277	Called from the VM process to request from the server to perform the
3278	server-side actions of creating a snapshot (creating differencing images
3279	and the snapshot object).
3280
3281	<result name="VBOX_E_FILE_ERROR">
3282	Settings file not accessible.
3283	</result>
3284	<result name="VBOX_E_XML_ERROR">
3285	Could not parse the settings file.
3286	</result>
3287	</desc>
3288	<param name="initiator" type="IConsole" dir="in">
3289	<desc>The console object that initiated this call.</desc>
3290	</param>
3291	<param name="name" type="wstring" dir="in">
3292	<desc>Snapshot name.</desc>
3293	</param>
3294	<param name="description" type="wstring" dir="in">
3295	<desc>Snapshot description.</desc>
3296	</param>
3297	<param name="consoleProgress" type="IProgress" dir="in">
3298	<desc>
3299	Progress object created by the VM process tracking the
3300	snapshot's progress. This has the following sub-operations:
3301	<ul>
3302	<li>setting up (weight 1);</li>
3303	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3304	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3305	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3306	<li>finishing up (weight 1)</li>
3307	</ul>
3308	</desc>
3309	</param>
3310	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3311	<desc>
3312	Whether this is an online snapshot (i.e. the machine is running).
3313	</desc>
3314	</param>
3315	<param name="stateFilePath" type="wstring" dir="out">
3316	<desc>
3317	File path the VM process must save the execution state to.
3318	</desc>
3319	</param>
3320	</method>
3321
3322	<method name="endTakingSnapshot">
3323	<desc>
3324	Called by the VM process to inform the server that the snapshot
3325	previously requested by #beginTakingSnapshot is either
3326	successfully taken or there was a failure.
3327	</desc>
3328
3329	<param name="success" type="boolean" dir="in">
3330	<desc>@c true to indicate success and @c false otherwise</desc>
3331	</param>
3332	</method>
3333
3334	<method name="deleteSnapshot">
3335	<desc>
3336	Gets called by <link to="IConsole::deleteSnapshot"/>,
3337	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3338	<link to="IConsole::deleteSnapshotRange"/>.
3339	<result name="VBOX_E_INVALID_OBJECT_STATE">
3340	Snapshot has more than one child snapshot. Only possible if the
3341	delete operation does not delete all children or the range does
3342	not meet the linearity condition.
3343	</result>
3344	</desc>
3345	<param name="initiator" type="IConsole" dir="in">
3346	<desc>The console object that initiated this call.</desc>
3347	</param>
3348	<param name="startId" type="uuid" mod="string" dir="in">
3349	<desc>UUID of the first snapshot to delete.</desc>
3350	</param>
3351	<param name="endId" type="uuid" mod="string" dir="in">
3352	<desc>UUID of the last snapshot to delete.</desc>
3353	</param>
3354	<param name="deleteAllChildren" type="boolean" dir="in">
3355	<desc>Whether all children should be deleted.</desc>
3356	</param>
3357	<param name="machineState" type="MachineState" dir="out">
3358	<desc>New machine state after this operation is started.</desc>
3359	</param>
3360	<param name="progress" type="IProgress" dir="return">
3361	<desc>Progress object to track the operation completion.</desc>
3362	</param>
3363	</method>
3364
3365	<method name="finishOnlineMergeMedium">
3366	<desc>
3367	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3368	</desc>
3369	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3370	<desc>The medium attachment which needs to be cleaned up.</desc>
3371	</param>
3372	<param name="source" type="IMedium" dir="in">
3373	<desc>Merge source medium.</desc>
3374	</param>
3375	<param name="target" type="IMedium" dir="in">
3376	<desc>Merge target medium.</desc>
3377	</param>
3378	<param name="mergeForward" type="boolean" dir="in">
3379	<desc>Merge direction.</desc>
3380	</param>
3381	<param name="parentForTarget" type="IMedium" dir="in">
3382	<desc>For forward merges: new parent for target medium.</desc>
3383	</param>
3384	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3385	<desc>For backward merges: list of media which need their parent UUID
3386	updated.</desc>
3387	</param>
3388	</method>
3389
3390	<method name="restoreSnapshot">
3391	<desc>
3392	Gets called by <link to="IConsole::restoreSnapshot"/>.
3393	</desc>
3394	<param name="initiator" type="IConsole" dir="in">
3395	<desc>The console object that initiated this call.</desc>
3396	</param>
3397	<param name="snapshot" type="ISnapshot" dir="in">
3398	<desc>The snapshot to restore the VM state from.</desc>
3399	</param>
3400	<param name="machineState" type="MachineState" dir="out">
3401	<desc>New machine state after this operation is started.</desc>
3402	</param>
3403	<param name="progress" type="IProgress" dir="return">
3404	<desc>Progress object to track the operation completion.</desc>
3405	</param>
3406	</method>
3407
3408	<method name="pullGuestProperties">
3409	<desc>
3410	Get the list of the guest properties matching a set of patterns along
3411	with their values, time stamps and flags and give responsibility for
3412	managing properties to the console.
3413	</desc>
3414	<param name="name" type="wstring" dir="out" safearray="yes">
3415	<desc>
3416	The names of the properties returned.
3417	</desc>
3418	</param>
3419	<param name="value" type="wstring" dir="out" safearray="yes">
3420	<desc>
3421	The values of the properties returned. The array entries match the
3422	corresponding entries in the @a name array.
3423	</desc>
3424	</param>
3425	<param name="timestamp" type="long long" dir="out" safearray="yes">
3426	<desc>
3427	The time stamps of the properties returned. The array entries match
3428	the corresponding entries in the @a name array.
3429	</desc>
3430	</param>
3431	<param name="flags" type="wstring" dir="out" safearray="yes">
3432	<desc>
3433	The flags of the properties returned. The array entries match the
3434	corresponding entries in the @a name array.
3435	</desc>
3436	</param>
3437	</method>
3438
3439	<method name="pushGuestProperty">
3440	<desc>
3441	Update a single guest property in IMachine.
3442	</desc>
3443	<param name="name" type="wstring" dir="in">
3444	<desc>
3445	The name of the property to be updated.
3446	</desc>
3447	</param>
3448	<param name="value" type="wstring" dir="in">
3449	<desc>
3450	The value of the property.
3451	</desc>
3452	</param>
3453	<param name="timestamp" type="long long" dir="in">
3454	<desc>
3455	The timestamp of the property.
3456	</desc>
3457	</param>
3458	<param name="flags" type="wstring" dir="in">
3459	<desc>
3460	The flags of the property.
3461	</desc>
3462	</param>
3463	</method>
3464
3465	<method name="lockMedia">
3466	<desc>
3467	Locks all media attached to the machine for writing and parents of
3468	attached differencing media (if any) for reading. This operation is
3469	atomic so that if it fails no media is actually locked.
3470
3471	This method is intended to be called when the machine is in Starting or
3472	Restoring state. The locked media will be automatically unlocked when
3473	the machine is powered off or crashed.
3474	</desc>
3475	</method>
3476	<method name="unlockMedia">
3477	<desc>
3478	Unlocks all media previously locked using
3479	<link to="IInternalMachineControl::lockMedia"/>.
3480
3481	This method is intended to be used with teleportation so that it is
3482	possible to teleport between processes on the same machine.
3483	</desc>
3484	</method>
3485
3486	<method name="ejectMedium">
3487	<desc>
3488	Tells VBoxSVC that the guest has ejected the medium associated with
3489	the medium attachment.
3490	</desc>
3491	<param name="attachment" type="IMediumAttachment" dir="in">
3492	<desc>
3493	The medium attachment where the eject happened.
3494	</desc>
3495	</param>
3496	<param name="newAttachment" type="IMediumAttachment" dir="return">
3497	<desc>
3498	A new reference to the medium attachment, as the config change can
3499	result in the creation of a new instance.
3500	</desc>
3501	</param>
3502	</method>
3503
3504	<method name="reportGuestStatistics">
3505	<desc>
3506	Passes collected guest statistics to VBoxSVC.
3507	</desc>
3508	<param name="validStats" type="unsigned long" dir="in">
3509	<desc>
3510	Mask defining which parameters are valid. For example: 0x11 means
3511	that cpuIdle and XXX are valid. Other parameters should be ignored.
3512	</desc>
3513	</param>
3514	<param name="cpuUser" type="unsigned long" dir="in">
3515	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3516	</param>
3517	<param name="cpuKernel" type="unsigned long" dir="in">
3518	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3519	</param>
3520	<param name="cpuIdle" type="unsigned long" dir="in">
3521	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3522	</param>
3523	<param name="memTotal" type="unsigned long" dir="in">
3524	<desc>Total amount of physical guest RAM.</desc>
3525	</param>
3526	<param name="memFree" type="unsigned long" dir="in">
3527	<desc>Free amount of physical guest RAM.</desc>
3528	</param>
3529	<param name="memBalloon" type="unsigned long" dir="in">
3530	<desc>Amount of ballooned physical guest RAM.</desc>
3531	</param>
3532	<param name="memShared" type="unsigned long" dir="in">
3533	<desc>Amount of shared physical guest RAM.</desc>
3534	</param>
3535	<param name="memCache" type="unsigned long" dir="in">
3536	<desc>Total amount of guest (disk) cache memory.</desc>
3537	</param>
3538	<param name="pagedTotal" type="unsigned long" dir="in">
3539	<desc>Total amount of space in the page file.</desc>
3540	</param>
3541	<param name="memAllocTotal" type="unsigned long" dir="in">
3542	<desc>Total amount of memory allocated by the hypervisor.</desc>
3543	</param>
3544	<param name="memFreeTotal" type="unsigned long" dir="in">
3545	<desc>Total amount of free memory available in the hypervisor.</desc>
3546	</param>
3547	<param name="memBalloonTotal" type="unsigned long" dir="in">
3548	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3549	</param>
3550	<param name="memSharedTotal" type="unsigned long" dir="in">
3551	<desc>Total amount of shared memory in the hypervisor.</desc>
3552	</param>
3553	</method>
3554	</interface>
3555
3556	<interface
3557	name="IBIOSSettings" extends="$unknown"
3558	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3559	wsmap="managed"
3560	>
3561	<desc>
3562	The IBIOSSettings interface represents BIOS settings of the virtual
3563	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3564	</desc>
3565	<attribute name="logoFadeIn" type="boolean">
3566	<desc>Fade in flag for BIOS logo animation.</desc>
3567	</attribute>
3568
3569	<attribute name="logoFadeOut" type="boolean">
3570	<desc>Fade out flag for BIOS logo animation.</desc>
3571	</attribute>
3572
3573	<attribute name="logoDisplayTime" type="unsigned long">
3574	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3575	</attribute>
3576
3577	<attribute name="logoImagePath" type="wstring">
3578	<desc>
3579	Local file system path for external BIOS splash image. Empty string
3580	means the default image is shown on boot.
3581	</desc>
3582	</attribute>
3583
3584	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3585	<desc>Mode of the BIOS boot device menu.</desc>
3586	</attribute>
3587
3588	<attribute name="ACPIEnabled" type="boolean">
3589	<desc>ACPI support flag.</desc>
3590	</attribute>
3591
3592	<attribute name="IOAPICEnabled" type="boolean">
3593	<desc>
3594	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3595	and support IRQs above 15.
3596	</desc>
3597	</attribute>
3598
3599	<attribute name="timeOffset" type="long long">
3600	<desc>
3601	Offset in milliseconds from the host system time. This allows for
3602	guests running with a different system date/time than the host.
3603	It is equivalent to setting the system date/time in the BIOS except
3604	it is not an absolute value but a relative one. Guest Additions
3605	time synchronization honors this offset.
3606	</desc>
3607	</attribute>
3608
3609	<attribute name="PXEDebugEnabled" type="boolean">
3610	<desc>
3611	PXE debug logging flag. If set, VirtualBox will write extensive
3612	PXE trace information to the release log.
3613	</desc>
3614	</attribute>
3615	</interface>
3616
3617	<enum
3618	name="CleanupMode"
3619	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3620	>
3621	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3622	</desc>
3623	<const name="UnregisterOnly" value="1">
3624	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3625	</const>
3626	<const name="DetachAllReturnNone" value="2">
3627	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3628	</const>
3629	<const name="DetachAllReturnHardDisksOnly" value="3">
3630	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3631	</const>
3632	<const name="Full" value="4">
3633	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3634	</const>
3635	</enum>
3636
3637	<interface
3638	name="IPCIAddress" extends="$unknown"
3639	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3640	wsmap="struct"
3641	>
3642
3643	<desc>
3644	Address on the PCI bus.
3645	</desc>
3646
3647	<attribute name="bus" type="short">
3648	<desc>
3649	Bus number.
3650	</desc>
3651	</attribute>
3652
3653	<attribute name="device" type="short">
3654	<desc>
3655	Device number.
3656	</desc>
3657	</attribute>
3658
3659	<attribute name="devFunction" type="short">
3660	<desc>
3661	Device function number.
3662	</desc>
3663	</attribute>
3664
3665	<method name="asLong">
3666	<desc>
3667	Convert PCI address into long.
3668	</desc>
3669	<param name="result" type="long" dir="return" />
3670	</method>
3671
3672	<method name="fromLong">
3673	<desc>
3674	Make PCI address from long.
3675	</desc>
3676	<param name="number" type="long" dir="in" />
3677	</method>
3678	</interface>
3679
3680	<interface
3681	name="IPCIDeviceAttachment" extends="$unknown"
3682	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3683	wsmap="struct"
3684	>
3685
3686	<desc>
3687	Information about PCI attachments.
3688	</desc>
3689
3690	<attribute name="name" type="wstring" readonly="yes">
3691	<desc>
3692	Device name.
3693	</desc>
3694	</attribute>
3695
3696	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3697	<desc>
3698	If this is physical or virtual device.
3699	</desc>
3700	</attribute>
3701
3702	<attribute name="hostAddress" type="long" readonly="yes">
3703	<desc>
3704	Address of device on the host, applicable only to host devices.
3705	</desc>
3706	</attribute>
3707
3708	<attribute name="guestAddress" type="long" readonly="yes">
3709	<desc>
3710	Address of device on the guest.
3711	</desc>
3712	</attribute>
3713
3714	</interface>
3715
3716	<enum
3717	name="CloneMode" extends="$unknown"
3718	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3719	>
3720
3721	<desc>
3722	Clone mode, used with <link to="IMachine::cloneTo" />.
3723	</desc>
3724
3725	<const name="MachineState" value="1">
3726	<desc>Clone the state of the selected machine.</desc>
3727	</const>
3728	<const name="MachineAndChildStates" value="2">
3729	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3730	</const>
3731	<const name="AllStates" value="3">
3732	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3733	</const>
3734
3735	</enum>
3736
3737	<enum
3738	name="CloneOptions" extends="$unknown"
3739	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3740	>
3741
3742	<desc>
3743	Clone options, used with <link to="IMachine::cloneTo" />.
3744	</desc>
3745
3746	<const name="Link" value="1">
3747	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3748	</const>
3749	<const name="KeepAllMACs" value="2">
3750	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3751	</const>
3752	<const name="KeepNATMACs" value="3">
3753	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3754	</const>
3755	<const name="KeepDiskNames" value="4">
3756	<desc>Don't change the disk names.</desc>
3757	</const>
3758
3759	</enum>
3760
3761	<enum
3762	name="AutostopType" extends="$unknown"
3763	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3764	>
3765
3766	<desc>
3767	Autostop types, used with <link to="IMachine::autostopType" />.
3768	</desc>
3769
3770	<const name="Disabled" value="1">
3771	<desc>Stopping the VM during system shutdown is disabled.</desc>
3772	</const>
3773	<const name="SaveState" value="2">
3774	<desc>The state of the VM will be saved when the system shuts down.</desc>
3775	</const>
3776	<const name="PowerOff" value="3">
3777	<desc>The VM is powered off when the system shuts down.</desc>
3778	</const>
3779	<const name="AcpiShutdown" value="4">
3780	<desc>An ACPI shutdown event is generated.</desc>
3781	</const>
3782
3783	</enum>
3784
3785
3786	<interface
3787	name="IMachine" extends="$unknown"
3788	uuid="22781af3-1c96-4126-9edf-67a020e0e858"
3789	wsmap="managed"
3790	>
3791	<desc>
3792	The IMachine interface represents a virtual machine, or guest, created
3793	in VirtualBox.
3794
3795	This interface is used in two contexts. First of all, a collection of
3796	objects implementing this interface is stored in the
3797	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3798	machines that are currently registered with this VirtualBox
3799	installation. Also, once a session has been opened for the given virtual
3800	machine (e.g. the virtual machine is running), the machine object
3801	associated with the open session can be queried from the session object;
3802	see <link to="ISession"/> for details.
3803
3804	The main role of this interface is to expose the settings of the virtual
3805	machine and provide methods to change various aspects of the virtual
3806	machine's configuration. For machine objects stored in the
3807	<link to="IVirtualBox::machines"/> collection, all attributes are
3808	read-only unless explicitly stated otherwise in individual attribute
3809	and method descriptions.
3810
3811	In order to change a machine setting, a session for this machine must be
3812	opened using one of the <link to="IMachine::lockMachine" /> or
3813	<link to="IMachine::launchVMProcess"/> methods. After the
3814	machine has been successfully locked for a session, a mutable machine object
3815	needs to be queried from the session object and then the desired settings
3816	changes can be applied to the returned object using IMachine attributes and
3817	methods. See the <link to="ISession"/> interface description for more
3818	information about sessions.
3819
3820	Note that IMachine does not provide methods to control virtual machine
3821	execution (such as start the machine, or power it down) -- these methods
3822	are grouped in a separate interface called <link to="IConsole" />.
3823
3824	<see><link to="ISession"/>, <link to="IConsole"/></see>
3825	</desc>
3826
3827	<attribute name="parent" type="IVirtualBox" readonly="yes">
3828	<desc>Associated parent object.</desc>
3829	</attribute>
3830
3831	<attribute name="accessible" type="boolean" readonly="yes">
3832	<desc>
3833	Whether this virtual machine is currently accessible or not.
3834
3835	A machine is always deemed accessible unless it is registered <i>and</i>
3836	its settings file cannot be read or parsed (either because the file itself
3837	is unavailable or has invalid XML contents).
3838
3839	Every time this property is read, the accessibility state of
3840	this machine is re-evaluated. If the returned value is @c false,
3841	the <link to="#accessError"/> property may be used to get the
3842	detailed error information describing the reason of
3843	inaccessibility, including XML error messages.
3844
3845	When the machine is inaccessible, only the following properties
3846	can be used on it:
3847	<ul>
3848	<li><link to="#parent"/></li>
3849	<li><link to="#id"/></li>
3850	<li><link to="#settingsFilePath"/></li>
3851	<li><link to="#accessible"/></li>
3852	<li><link to="#accessError"/></li>
3853	</ul>
3854
3855	An attempt to access any other property or method will return
3856	an error.
3857
3858	The only possible action you can perform on an inaccessible
3859	machine is to unregister it using the
3860	<link to="IMachine::unregister"/> call (or, to check
3861	for the accessibility state once more by querying this
3862	property).
3863
3864	<note>
3865	In the current implementation, once this property returns
3866	@c true, the machine will never become inaccessible
3867	later, even if its settings file cannot be successfully
3868	read/written any more (at least, until the VirtualBox
3869	server is restarted). This limitation may be removed in
3870	future releases.
3871	</note>
3872	</desc>
3873	</attribute>
3874
3875	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3876	<desc>
3877	Error information describing the reason of machine
3878	inaccessibility.
3879
3880	Reading this property is only valid after the last call to
3881	<link to="#accessible"/> returned @c false (i.e. the
3882	machine is currently inaccessible). Otherwise, a @c null
3883	IVirtualBoxErrorInfo object will be returned.
3884	</desc>
3885	</attribute>
3886
3887	<attribute name="name" type="wstring">
3888	<desc>
3889	Name of the virtual machine.
3890
3891	Besides being used for human-readable identification purposes
3892	everywhere in VirtualBox, the virtual machine name is also used
3893	as a name of the machine's settings file and as a name of the
3894	subdirectory this settings file resides in. Thus, every time you
3895	change the value of this property, the settings file will be
3896	renamed once you call <link to="#saveSettings"/> to confirm the
3897	change. The containing subdirectory will be also renamed, but
3898	only if it has exactly the same name as the settings file
3899	itself prior to changing this property (for backward compatibility
3900	with previous API releases). The above implies the following
3901	limitations:
3902	<ul>
3903	<li>The machine name cannot be empty.</li>
3904	<li>The machine name can contain only characters that are valid
3905	file name characters according to the rules of the file
3906	system used to store VirtualBox configuration.</li>
3907	<li>You cannot have two or more machines with the same name
3908	if they use the same subdirectory for storing the machine
3909	settings files.</li>
3910	<li>You cannot change the name of the machine if it is running,
3911	or if any file in the directory containing the settings file
3912	is being used by another running machine or by any other
3913	process in the host operating system at a time when
3914	<link to="#saveSettings"/> is called.
3915	</li>
3916	</ul>
3917	If any of the above limitations are hit, <link to="#saveSettings"/>
3918	will return an appropriate error message explaining the exact
3919	reason and the changes you made to this machine will not be saved.
3920
3921	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3922	file is recommended, but not enforced. (Previous versions always
3923	used a generic ".xml" extension.)
3924	</desc>
3925	</attribute>
3926
3927	<attribute name="description" type="wstring">
3928	<desc>
3929	Description of the virtual machine.
3930
3931	The description attribute can contain any text and is
3932	typically used to describe the hardware and software
3933	configuration of the virtual machine in detail (i.e. network
3934	settings, versions of the installed software and so on).
3935	</desc>
3936	</attribute>
3937
3938	<attribute name="id" type="uuid" mod="string" readonly="yes">
3939	<desc>UUID of the virtual machine.</desc>
3940	</attribute>
3941
3942	<attribute name="groups" type="wstring" safearray="yes">
3943	<desc>
3944	Array of machine group names of which this machine is a member.
3945	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
3946	group is only listed once, however they are listed in no particular
3947	order and there is no guarantee that there are no gaps in the group
3948	hierarchy (i.e. <tt>"/group"</tt>,
3949	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
3950	</desc>
3951	</attribute>
3952
3953	<attribute name="OSTypeId" type="wstring">
3954	<desc>
3955	User-defined identifier of the Guest OS type.
3956	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3957	an IGuestOSType object representing details about the given
3958	Guest OS type.
3959	<note>
3960	This value may differ from the value returned by
3961	<link to="IGuest::OSTypeId"/> if Guest Additions are
3962	installed to the guest OS.
3963	</note>
3964	</desc>
3965	</attribute>
3966
3967	<attribute name="hardwareVersion" type="wstring">
3968	<desc>Hardware version identifier. Internal use only for now.</desc>
3969	</attribute>
3970
3971	<attribute name="hardwareUUID" type="uuid" mod="string">
3972	<desc>
3973	The UUID presented to the guest via memory tables, hardware and guest
3974	properties. For most VMs this is the same as the @a id, but for VMs
3975	which have been cloned or teleported it may be the same as the source
3976	VM. The latter is because the guest shouldn't notice that it was
3977	cloned or teleported.
3978	</desc>
3979	</attribute>
3980
3981	<attribute name="CPUCount" type="unsigned long">
3982	<desc>Number of virtual CPUs in the VM.</desc>
3983	</attribute>
3984
3985	<attribute name="CPUHotPlugEnabled" type="boolean">
3986	<desc>
3987	This setting determines whether VirtualBox allows CPU
3988	hotplugging for this machine.</desc>
3989	</attribute>
3990
3991	<attribute name="CPUExecutionCap" type="unsigned long">
3992	<desc>
3993	Means to limit the number of CPU cycles a guest can use. The unit
3994	is percentage of host CPU cycles per second. The valid range
3995	is 1 - 100. 100 (the default) implies no limit.
3996	</desc>
3997	</attribute>
3998
3999	<attribute name="memorySize" type="unsigned long">
4000	<desc>System memory size in megabytes.</desc>
4001	</attribute>
4002
4003	<attribute name="memoryBalloonSize" type="unsigned long">
4004	<desc>Memory balloon size in megabytes.</desc>
4005	</attribute>
4006
4007	<attribute name="pageFusionEnabled" type="boolean">
4008	<desc>
4009	This setting determines whether VirtualBox allows page
4010	fusion for this machine (64 bits host only).
4011	</desc>
4012	</attribute>
4013
4014	<attribute name="VRAMSize" type="unsigned long">
4015	<desc>Video memory size in megabytes.</desc>
4016	</attribute>
4017
4018	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4019	<desc>
4020	This setting determines whether VirtualBox allows this machine to make
4021	use of the 3D graphics support available on the host.</desc>
4022	</attribute>
4023
4024	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4025	<desc>
4026	This setting determines whether VirtualBox allows this machine to make
4027	use of the 2D video acceleration support available on the host.</desc>
4028	</attribute>
4029
4030	<attribute name="monitorCount" type="unsigned long">
4031	<desc>
4032	Number of virtual monitors.
4033	<note>
4034	Only effective on Windows XP and later guests with
4035	Guest Additions installed.
4036	</note>
4037	</desc>
4038	</attribute>
4039
4040	<attribute name="VideoCaptureEnabled" type="boolean" default="false">
4041	<desc>
4042	This setting determines whether VirtualBox uses video recording to
4043	record VM session.</desc>
4044	</attribute>
4045
4046	<attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
4047	<desc>
4048	This setting determines what filename VirtualBox uses to save
4049	the recorded content.</desc>
4050	</attribute>
4051
4052	<attribute name="VideoCaptureWidth" type="unsigned long" default="640">
4053	<desc>
4054	This setting determines what should be the horizontal resolution of
4055	recorded video.</desc>
4056	</attribute>
4057
4058	<attribute name="VideoCaptureHeight" type="unsigned long" default="480">
4059	<desc>
4060	This setting determines what should be the vertical resolution
4061	of recorded video.</desc>
4062	</attribute>
4063
4064	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4065	<desc>Object containing all BIOS settings.</desc>
4066	</attribute>
4067
4068	<attribute name="firmwareType" type="FirmwareType">
4069	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4070	bootstrap in this VM.</desc>
4071	</attribute>
4072
4073	<attribute name="pointingHIDType" type="PointingHIDType">
4074	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4075	The default is typically "PS2Mouse" but can vary depending on the
4076	requirements of the guest operating system.</desc>
4077	</attribute>
4078
4079	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4080	<desc>Type of keyboard HID used in this VM.
4081	The default is typically "PS2Keyboard" but can vary depending on the
4082	requirements of the guest operating system.</desc>
4083	</attribute>
4084
4085	<attribute name="HPETEnabled" type="boolean">
4086	<desc>This attribute controls if High Precision Event Timer (HPET) is
4087	enabled in this VM. Use this property if you want to provide guests
4088	with additional time source, or if guest requires HPET to function correctly.
4089	Default is false.</desc>
4090	</attribute>
4091
4092	<attribute name="chipsetType" type="ChipsetType">
4093	<desc>Chipset type used in this VM.</desc>
4094	</attribute>
4095
4096	<attribute name="snapshotFolder" type="wstring">
4097	<desc>
4098	Full path to the directory used to store snapshot data
4099	(differencing media and saved state files) of this machine.
4100
4101	The initial value of this property is
4102	<tt><</tt><link to="#settingsFilePath">
4103	path_to_settings_file</link><tt>>/<</tt>
4104	<link to="#id">machine_uuid</link>
4105	<tt>></tt>.
4106
4107	Currently, it is an error to try to change this property on
4108	a machine that has snapshots (because this would require to
4109	move possibly large files to a different location).
4110	A separate method will be available for this purpose later.
4111
4112	<note>
4113	Setting this property to @c null or to an empty string will restore
4114	the initial value.
4115	</note>
4116	<note>
4117	When setting this property, the specified path can be
4118	absolute (full path) or relative to the directory where the
4119	<link to="#settingsFilePath">machine settings file</link>
4120	is located. When reading this property, a full path is
4121	always returned.
4122	</note>
4123	<note>
4124	The specified path may not exist, it will be created
4125	when necessary.
4126	</note>
4127	</desc>
4128	</attribute>
4129
4130	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4131	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4132	</attribute>
4133
4134	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4135	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4136
4137	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4138	<desc>Array of media attached to this machine.</desc>
4139	</attribute>
4140
4141	<attribute name="USBController" type="IUSBController" readonly="yes">
4142	<desc>
4143	Associated USB controller object.
4144
4145	<note>
4146	If USB functionality is not available in the given edition of
4147	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4148	</note>
4149	</desc>
4150	</attribute>
4151
4152	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4153	<desc>Associated audio adapter, always present.</desc>
4154	</attribute>
4155
4156	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4157	<desc>Array of storage controllers attached to this machine.</desc>
4158	</attribute>
4159
4160	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4161	<desc>
4162	Full name of the file containing machine settings data.
4163	</desc>
4164	</attribute>
4165
4166	<attribute name="settingsModified" type="boolean" readonly="yes">
4167	<desc>
4168	Whether the settings of this machine have been modified
4169	(but neither yet saved nor discarded).
4170	<note>
4171	Reading this property is only valid on instances returned
4172	by <link to="ISession::machine"/> and on new machines
4173	created by <link to="IVirtualBox::createMachine"/> or opened
4174	by <link to="IVirtualBox::openMachine"/> but not
4175	yet registered, or on unregistered machines after calling
4176	<link to="IMachine::unregister"/>. For all other
4177	cases, the settings can never be modified.
4178	</note>
4179	<note>
4180	For newly created unregistered machines, the value of this
4181	property is always @c true until <link to="#saveSettings"/>
4182	is called (no matter if any machine settings have been
4183	changed after the creation or not). For opened machines
4184	the value is set to @c false (and then follows to normal rules).
4185	</note>
4186	</desc>
4187	</attribute>
4188
4189	<attribute name="sessionState" type="SessionState" readonly="yes">
4190	<desc>Current session state for this machine.</desc>
4191	</attribute>
4192
4193	<attribute name="sessionType" type="wstring" readonly="yes">
4194	<desc>
4195	Type of the session. If <link to="#sessionState"/> is
4196	Spawning or Locked, this attribute contains the
4197	same value as passed to the
4198	<link to="IMachine::launchVMProcess"/> method in the
4199	@a type parameter. If the session was used with
4200	<link to="IMachine::lockMachine" />, or if
4201	<link to="#sessionState"/> is SessionClosed, the value of this
4202	attribute is an empty string.
4203	</desc>
4204	</attribute>
4205
4206	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4207	<desc>
4208	Identifier of the session process. This attribute contains the
4209	platform-dependent identifier of the process whose session was
4210	used with <link to="IMachine::lockMachine" /> call. The returned
4211	value is only valid if <link to="#sessionState"/> is Locked or
4212	Unlocking by the time this property is read.
4213	</desc>
4214	</attribute>
4215
4216	<attribute name="state" type="MachineState" readonly="yes">
4217	<desc>Current execution state of this machine.</desc>
4218	</attribute>
4219
4220	<attribute name="lastStateChange" type="long long" readonly="yes">
4221	<desc>
4222	Time stamp of the last execution state change,
4223	in milliseconds since 1970-01-01 UTC.
4224	</desc>
4225	</attribute>
4226
4227	<attribute name="stateFilePath" type="wstring" readonly="yes">
4228	<desc>
4229	Full path to the file that stores the execution state of
4230	the machine when it is in the <link to="MachineState_Saved"/> state.
4231	<note>
4232	When the machine is not in the Saved state, this attribute is
4233	an empty string.
4234	</note>
4235	</desc>
4236	</attribute>
4237
4238	<attribute name="logFolder" type="wstring" readonly="yes">
4239	<desc>
4240	Full path to the folder that stores a set of rotated log files
4241	recorded during machine execution. The most recent log file is
4242	named <tt>VBox.log</tt>, the previous log file is
4243	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4244	in the current version).
4245	</desc>
4246	</attribute>
4247
4248	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4249	<desc>
4250	Current snapshot of this machine. This is @c null if the machine
4251	currently has no snapshots. If it is not @c null, then it was
4252	set by one of <link to="IConsole::takeSnapshot" />,
4253	<link to="IConsole::deleteSnapshot" />
4254	or <link to="IConsole::restoreSnapshot" />, depending on which
4255	was called last. See <link to="ISnapshot"/> for details.
4256	</desc>
4257	</attribute>
4258
4259	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4260	<desc>
4261	Number of snapshots taken on this machine. Zero means the
4262	machine doesn't have any snapshots.
4263	</desc>
4264	</attribute>
4265
4266	<attribute name="currentStateModified" type="boolean" readonly="yes">
4267	<desc>
4268	Returns @c true if the current state of the machine is not
4269	identical to the state stored in the current snapshot.
4270
4271	The current state is identical to the current snapshot only
4272	directly after one of the following calls are made:
4273
4274	<ul>
4275	<li><link to="IConsole::restoreSnapshot"/>
4276	</li>
4277	<li><link to="IConsole::takeSnapshot"/> (issued on a
4278	"powered off" or "saved" machine, for which
4279	<link to="#settingsModified"/> returns @c false)
4280	</li>
4281	</ul>
4282
4283	The current state remains identical until one of the following
4284	happens:
4285	<ul>
4286	<li>settings of the machine are changed</li>
4287	<li>the saved state is deleted</li>
4288	<li>the current snapshot is deleted</li>
4289	<li>an attempt to execute the machine is made</li>
4290	</ul>
4291
4292	<note>
4293	For machines that don't have snapshots, this property is
4294	always @c false.
4295	</note>
4296	</desc>
4297	</attribute>
4298
4299	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4300	<desc>
4301	Collection of shared folders for this machine (permanent shared
4302	folders). These folders are shared automatically at machine startup
4303	and available only to the guest OS installed within this machine.
4304
4305	New shared folders are added to the collection using
4306	<link to="#createSharedFolder"/>. Existing shared folders can be
4307	removed using <link to="#removeSharedFolder"/>.
4308	</desc>
4309	</attribute>
4310
4311	<attribute name="clipboardMode" type="ClipboardMode">
4312	<desc>
4313	Synchronization mode between the host OS clipboard
4314	and the guest OS clipboard.
4315	</desc>
4316	</attribute>
4317
4318	<attribute name="dragAndDropMode" type="DragAndDropMode">
4319	<desc>
4320	Which mode is allowed for drag'n'drop.
4321	</desc>
4322	</attribute>
4323
4324	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4325	<desc>
4326	A comma-separated list of simple glob patterns. Changes to guest
4327	properties whose name matches one of the patterns will generate an
4328	<link to="IGuestPropertyChangedEvent"/> signal.
4329	</desc>
4330	</attribute>
4331
4332	<attribute name="teleporterEnabled" type="boolean">
4333	<desc>
4334	When set to @a true, the virtual machine becomes a target teleporter
4335	the next time it is powered on. This can only set to @a true when the
4336	VM is in the @a PoweredOff or @a Aborted state.
4337
4338	<!-- This property is automatically set to @a false when the VM is powered
4339	on. (bird: This doesn't work yet ) -->
4340	</desc>
4341	</attribute>
4342
4343	<attribute name="teleporterPort" type="unsigned long">
4344	<desc>
4345	The TCP port the target teleporter will listen for incoming
4346	teleportations on.
4347
4348	0 means the port is automatically selected upon power on. The actual
4349	value can be read from this property while the machine is waiting for
4350	incoming teleportations.
4351	</desc>
4352	</attribute>
4353
4354	<attribute name="teleporterAddress" type="wstring">
4355	<desc>
4356	The address the target teleporter will listen on. If set to an empty
4357	string, it will listen on all addresses.
4358	</desc>
4359	</attribute>
4360
4361	<attribute name="teleporterPassword" type="wstring">
4362	<desc>
4363	The password to check for on the target teleporter. This is just a
4364	very basic measure to prevent simple hacks and operators accidentally
4365	beaming a virtual machine to the wrong place.
4366
4367	Note that you SET a plain text password while reading back a HASHED
4368	password. Setting a hashed password is currently not supported.
4369	</desc>
4370	</attribute>
4371
4372	<attribute name="faultToleranceState" type="FaultToleranceState">
4373	<desc>
4374	Fault tolerance state; disabled, source or target.
4375	This property can be changed at any time. If you change it for a running
4376	VM, then the fault tolerance address and port must be set beforehand.
4377	</desc>
4378	</attribute>
4379
4380	<attribute name="faultTolerancePort" type="unsigned long">
4381	<desc>
4382	The TCP port the fault tolerance source or target will use for
4383	communication.
4384	</desc>
4385	</attribute>
4386
4387	<attribute name="faultToleranceAddress" type="wstring">
4388	<desc>
4389	The address the fault tolerance source or target.
4390	</desc>
4391	</attribute>
4392
4393	<attribute name="faultTolerancePassword" type="wstring">
4394	<desc>
4395	The password to check for on the standby VM. This is just a
4396	very basic measure to prevent simple hacks and operators accidentally
4397	choosing the wrong standby VM.
4398	</desc>
4399	</attribute>
4400
4401	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4402	<desc>
4403	The interval in ms used for syncing the state between source and target.
4404	</desc>
4405	</attribute>
4406
4407	<attribute name="RTCUseUTC" type="boolean">
4408	<desc>
4409	When set to @a true, the RTC device of the virtual machine will run
4410	in UTC time, otherwise in local time. Especially Unix guests prefer
4411	the time in UTC.
4412	</desc>
4413	</attribute>
4414
4415	<attribute name="IOCacheEnabled" type="boolean">
4416	<desc>
4417	When set to @a true, the builtin I/O cache of the virtual machine
4418	will be enabled.
4419	</desc>
4420	</attribute>
4421
4422	<attribute name="IOCacheSize" type="unsigned long">
4423	<desc>
4424	Maximum size of the I/O cache in MB.
4425	</desc>
4426	</attribute>
4427
4428	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4429	<desc>Array of PCI devices assigned to this machine, to get list of all
4430	PCI devices attached to the machine use
4431	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4432	is intended to list only devices additional to what described in
4433	virtual hardware config. Usually, this list keeps host's physical
4434	devices assigned to the particular machine.
4435	</desc>
4436	</attribute>
4437
4438	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4439	<desc>
4440	Bandwidth control manager.
4441	</desc>
4442	</attribute>
4443
4444	<attribute name="tracingEnabled" type="boolean">
4445	<desc>
4446	Enables the tracing facility in the VMM (including PDM devices +
4447	drivers). The VMM will consume about 0.5MB of more memory when
4448	enabled and there may be some extra overhead from tracepoints that are
4449	always enabled.
4450	</desc>
4451	</attribute>
4452
4453	<attribute name="tracingConfig" type="wstring">
4454	<desc>
4455	Tracepoint configuration to apply at startup when
4456	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4457	a space separated of tracepoint group names to enable. The special
4458	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4459	more details on available tracepoint groups and such.
4460
4461	Note that on hosts supporting DTrace (or similar), a lot of the
4462	tracepoints may be implemented exclusivly as DTrace probes. So, the
4463	effect of the same config may differ between Solaris and Windows for
4464	example.
4465	</desc>
4466	</attribute>
4467
4468	<attribute name="allowTracingToAccessVM" type="boolean">
4469	<desc>
4470	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4471	structures when firing off trace points. This is especially useful
4472	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4473	pointer to obtain useful information such as guest register state.
4474
4475	This is disabled by default because devices and drivers normally has no
4476	business accessing the VMCPU or VM structures, and are therefore unable
4477	to get any pointers to these.
4478	</desc>
4479	</attribute>
4480
4481	<attribute name="autostartEnabled" type="boolean">
4482	<desc>
4483	Enables autostart of the VM during system boot.
4484	</desc>
4485	</attribute>
4486
4487	<attribute name="autostartDelay" type="unsigned long">
4488	<desc>
4489	Number of seconds to wait until the VM should be started during system boot.
4490	</desc>
4491	</attribute>
4492
4493	<attribute name="autostopType" type="AutostopType">
4494	<desc>
4495	Action type to do when the system is shutting down.
4496	</desc>
4497	</attribute>
4498
4499	<method name="lockMachine">
4500	<desc>
4501	Locks the machine for the given session to enable the caller
4502	to make changes to the machine or start the VM or control
4503	VM execution.
4504
4505	There are two ways to lock a machine for such uses:
4506
4507	<ul>
4508	<li>If you want to make changes to the machine settings,
4509	you must obtain an exclusive write lock on the machine
4510	by setting @a lockType to @c Write.
4511
4512	This will only succeed if no other process has locked
4513	the machine to prevent conflicting changes. Only after
4514	an exclusive write lock has been obtained using this method, one
4515	can change all VM settings or execute the VM in the process
4516	space of the session object. (Note that the latter is only of
4517	interest if you actually want to write a new front-end for
4518	virtual machines; but this API gets called internally by
4519	the existing front-ends such as VBoxHeadless and the VirtualBox
4520	GUI to acquire a write lock on the machine that they are running.)
4521
4522	On success, write-locking the machine for a session creates
4523	a second copy of the IMachine object. It is this second object
4524	upon which changes can be made; in VirtualBox terminology, the
4525	second copy is "mutable". It is only this second, mutable machine
4526	object upon which you can call methods that change the
4527	machine state. After having called this method, you can
4528	obtain this second, mutable machine object using the
4529	<link to="ISession::machine" /> attribute.
4530	</li>
4531	<li>If you only want to check the machine state or control
4532	machine execution without actually changing machine
4533	settings (e.g. to get access to VM statistics or take
4534	a snapshot or save the machine state), then set the
4535	@a lockType argument to @c Shared.
4536
4537	If no other session has obtained a lock, you will obtain an
4538	exclusive write lock as described above. However, if another
4539	session has already obtained such a lock, then a link to that
4540	existing session will be established which allows you
4541	to control that existing session.
4542
4543	To find out which type of lock was obtained, you can
4544	inspect <link to="ISession::type" />, which will have been
4545	set to either @c WriteLock or @c Shared.
4546	</li>
4547	</ul>
4548
4549	In either case, you can get access to the <link to="IConsole" />
4550	object which controls VM execution.
4551
4552	Also in all of the above cases, one must always call
4553	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4554	the machine's state will eventually be set to "Aborted".
4555
4556	To change settings on a machine, the following sequence is typically
4557	performed:
4558
4559	<ol>
4560	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4561
4562	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4563
4564	<li>Change the settings of the machine by invoking IMachine methods.</li>
4565
4566	<li>Call <link to="IMachine::saveSettings" />.</li>
4567
4568	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4569	</ol>
4570
4571	<result name="E_UNEXPECTED">
4572	Virtual machine not registered.
4573	</result>
4574	<result name="E_ACCESSDENIED">
4575	Process not started by OpenRemoteSession.
4576	</result>
4577	<result name="VBOX_E_INVALID_OBJECT_STATE">
4578	Session already open or being opened.
4579	</result>
4580	<result name="VBOX_E_VM_ERROR">
4581	Failed to assign machine to session.
4582	</result>
4583	</desc>
4584	<param name="session" type="ISession" dir="in">
4585	<desc>
4586	Session object for which the machine will be locked.
4587	</desc>
4588	</param>
4589	<param name="lockType" type="LockType" dir="in">
4590	<desc>
4591	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4592	If set to @c Shared, then either acquire an exclusive write lock or establish
4593	a link to an existing session.
4594	</desc>
4595	</param>
4596	</method>
4597
4598	<method name="launchVMProcess">
4599	<desc>
4600	Spawns a new process that will execute the virtual machine and obtains a shared
4601	lock on the machine for the calling session.
4602
4603	If launching the VM succeeds, the new VM process will create its own session
4604	and write-lock the machine for it, preventing conflicting changes from other
4605	processes. If the machine is already locked (because it is already running or
4606	because another session has a write lock), launching the VM process will therefore
4607	fail. Reversely, future attempts to obtain a write lock will also fail while the
4608	machine is running.
4609
4610	The caller's session object remains separate from the session opened by the new
4611	VM process. It receives its own <link to="IConsole" /> object which can be used
4612	to control machine execution, but it cannot be used to change all VM settings
4613	which would be available after a <link to="#lockMachine" /> call.
4614
4615	The caller must eventually release the session's shared lock by calling
4616	<link to="ISession::unlockMachine" /> on the local session object once this call
4617	has returned. However, the session's state (see <link to="ISession::state" />)
4618	will not return to "Unlocked" until the remote session has also unlocked
4619	the machine (i.e. the machine has stopped running).
4620
4621	Launching a VM process can take some time (a new VM is started in a new process,
4622	for which memory and other resources need to be set up). Because of this,
4623	an <link to="IProgress" /> object is returned to allow the caller to wait
4624	for this asynchronous operation to be completed. Until then, the caller's
4625	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4626	and <link to="ISession::console" /> attributes cannot be accessed.
4627	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4628	similar calls to wait for completion. Completion is signalled when the VM
4629	is powered on. If launching the VM fails, error messages can be queried
4630	via the progress object, if available.
4631
4632	The progress object will have at least 2 sub-operations. The first
4633	operation covers the period up to the new VM process calls powerUp.
4634	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4635	progress object. Because <link to="IConsole::powerUp"/> may require
4636	some extra sub-operations, the <link to="IProgress::operationCount"/>
4637	may change at the completion of operation.
4638
4639	For details on the teleportation progress operation, see
4640	<link to="IConsole::powerUp"/>.
4641
4642	The @a environment argument is a string containing definitions of
4643	environment variables in the following format:
4644	<pre>
4645	NAME[=VALUE]\n
4646	NAME[=VALUE]\n
4647	...
4648	</pre>
4649	where <tt>\\n</tt> is the new line character. These environment
4650	variables will be appended to the environment of the VirtualBox server
4651	process. If an environment variable exists both in the server process
4652	and in this list, the value from this list takes precedence over the
4653	server's variable. If the value of the environment variable is
4654	omitted, this variable will be removed from the resulting environment.
4655	If the environment string is @c null or empty, the server environment
4656	is inherited by the started process as is.
4657
4658	<result name="E_UNEXPECTED">
4659	Virtual machine not registered.
4660	</result>
4661	<result name="E_INVALIDARG">
4662	Invalid session type @a type.
4663	</result>
4664	<result name="VBOX_E_OBJECT_NOT_FOUND">
4665	No machine matching @a machineId found.
4666	</result>
4667	<result name="VBOX_E_INVALID_OBJECT_STATE">
4668	Session already open or being opened.
4669	</result>
4670	<result name="VBOX_E_IPRT_ERROR">
4671	Launching process for machine failed.
4672	</result>
4673	<result name="VBOX_E_VM_ERROR">
4674	Failed to assign machine to session.
4675	</result>
4676	</desc>
4677	<param name="session" type="ISession" dir="in">
4678	<desc>
4679	Client session object to which the VM process will be connected (this
4680	must be in "Unlocked" state).
4681	</desc>
4682	</param>
4683	<param name="type" type="wstring" dir="in">
4684	<desc>
4685	Front-end to use for the new VM process. The following are currently supported:
4686	<ul>
4687	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4688	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4689	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4690	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4691	the currently running VM or session owner. In this case the
4692	@a session parameter may be @c null (if it is non-null it isn't
4693	used in any way), and the @a progress return value will be always
4694	@c null. The operation completes immediately.</li>
4695	</ul>
4696	</desc>
4697	</param>
4698	<param name="environment" type="wstring" dir="in">
4699	<desc>
4700	Environment to pass to the VM process.
4701	</desc>
4702	</param>
4703	<param name="progress" type="IProgress" dir="return">
4704	<desc>Progress object to track the operation completion.</desc>
4705	</param>
4706	</method>
4707
4708	<method name="setBootOrder">
4709	<desc>
4710	Puts the given device to the specified position in
4711	the boot order.
4712
4713	To indicate that no device is associated with the given position,
4714	<link to="DeviceType_Null"/> should be used.
4715
4716	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4717
4718	<result name="E_INVALIDARG">
4719	Boot @a position out of range.
4720	</result>
4721	<result name="E_NOTIMPL">
4722	Booting from USB @a device currently not supported.
4723	</result>
4724
4725	</desc>
4726	<param name="position" type="unsigned long" dir="in">
4727	<desc>
4728	Position in the boot order (@c 1 to the total number of
4729	devices the machine can boot from, as returned by
4730	<link to="ISystemProperties::maxBootPosition"/>).
4731	</desc>
4732	</param>
4733	<param name="device" type="DeviceType" dir="in">
4734	<desc>
4735	The type of the device used to boot at the given position.
4736	</desc>
4737	</param>
4738	</method>
4739
4740	<method name="getBootOrder" const="yes">
4741	<desc>
4742	Returns the device type that occupies the specified
4743	position in the boot order.
4744
4745	@todo [remove?]
4746	If the machine can have more than one device of the returned type
4747	(such as hard disks), then a separate method should be used to
4748	retrieve the individual device that occupies the given position.
4749
4750	If here are no devices at the given position, then
4751	<link to="DeviceType_Null"/> is returned.
4752
4753	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4754
4755	<result name="E_INVALIDARG">
4756	Boot @a position out of range.
4757	</result>
4758
4759	</desc>
4760	<param name="position" type="unsigned long" dir="in">
4761	<desc>
4762	Position in the boot order (@c 1 to the total number of
4763	devices the machine can boot from, as returned by
4764	<link to="ISystemProperties::maxBootPosition"/>).
4765	</desc>
4766	</param>
4767	<param name="device" type="DeviceType" dir="return">
4768	<desc>
4769	Device at the given position.
4770	</desc>
4771	</param>
4772	</method>
4773
4774	<method name="attachDevice">
4775	<desc>
4776	Attaches a device and optionally mounts a medium to the given storage
4777	controller (<link to="IStorageController" />, identified by @a name),
4778	at the indicated port and device.
4779
4780	This method is intended for managing storage devices in general while a
4781	machine is powered off. It can be used to attach and detach fixed
4782	and removable media. The following kind of media can be attached
4783	to a machine:
4784
4785	<ul>
4786	<li>For fixed and removable media, you can pass in a medium that was
4787	previously opened using <link to="IVirtualBox::openMedium" />.
4788	</li>
4789
4790	<li>Only for storage devices supporting removable media (such as
4791	DVDs and floppies), you can also specify a null pointer to
4792	indicate an empty drive or one of the medium objects listed
4793	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4794	arrays to indicate a host drive.
4795	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4796	to change the media while the machine is running.
4797	</li>
4798	</ul>
4799
4800	In a VM's default configuration of virtual machines, the secondary
4801	master of the IDE controller is used for a CD/DVD drive.
4802
4803	After calling this returns successfully, a new instance of
4804	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4805	attachments (see <link to="IMachine::mediumAttachments"/>).
4806
4807	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4808	information about attaching media.
4809
4810	The specified device slot must not have a device attached to it,
4811	or this method will fail.
4812
4813	<note>
4814	You cannot attach a device to a newly created machine until
4815	this machine's settings are saved to disk using
4816	<link to="#saveSettings"/>.
4817	</note>
4818	<note>
4819	If the medium is being attached indirectly, a new differencing medium
4820	will implicitly be created for it and attached instead. If the
4821	changes made to the machine settings (including this indirect
4822	attachment) are later cancelled using <link to="#discardSettings"/>,
4823	this implicitly created differencing medium will implicitly
4824	be deleted.
4825	</note>
4826
4827	<result name="E_INVALIDARG">
4828	SATA device, SATA port, IDE port or IDE slot out of range, or
4829	file or UUID not found.
4830	</result>
4831	<result name="VBOX_E_INVALID_OBJECT_STATE">
4832	Machine must be registered before media can be attached.
4833	</result>
4834	<result name="VBOX_E_INVALID_VM_STATE">
4835	Invalid machine state.
4836	</result>
4837	<result name="VBOX_E_OBJECT_IN_USE">
4838	A medium is already attached to this or another virtual machine.
4839	</result>
4840
4841	</desc>
4842	<param name="name" type="wstring" dir="in">
4843	<desc>Name of the storage controller to attach the device to.</desc>
4844	</param>
4845	<param name="controllerPort" type="long" dir="in">
4846	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4847	the primary controller and 1 specifies the secondary controller.
4848	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4849	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4850	</param>
4851	<param name="device" type="long" dir="in">
4852	<desc>Device slot in the given port to attach the device to. This is only
4853	relevant for IDE controllers, for which 0 specifies the master device and
4854	1 specifies the slave device. For all other controller types, this must
4855	be 0.</desc>
4856	</param>
4857	<param name="type" type="DeviceType" dir="in">
4858	<desc>Device type of the attached device. For media opened by
4859	<link to="IVirtualBox::openMedium" />, this must match the device type
4860	specified there.</desc>
4861	</param>
4862	<param name="medium" type="IMedium" dir="in">
4863	<desc>Medium to mount or @c null for an empty drive.</desc>
4864	</param>
4865	</method>
4866
4867	<method name="attachDeviceWithoutMedium">
4868	<desc>
4869	Attaches a device and optionally mounts a medium to the given storage
4870	controller (<link to="IStorageController" />, identified by @a name),
4871	at the indicated port and device.
4872
4873	This method is intended for managing storage devices in general while a
4874	machine is powered off. It can be used to attach and detach fixed
4875	and removable media. The following kind of media can be attached
4876	to a machine:
4877	<ul>
4878	<li>
4879	For fixed and removable media, you can pass in a medium that was
4880	previously opened using <link to="IVirtualBox::openMedium" />.
4881	</li>
4882
4883	<li>Only for storage devices supporting removable media (such as
4884	DVDs and floppies) with an empty drive or one of the medium objects listed
4885	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4886	arrays to indicate a host drive.
4887	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4888	to change the media while the machine is running.
4889	</li>
4890	</ul>
4891
4892	In a VM's default configuration of virtual machines, the secondary
4893	master of the IDE controller is used for a CD/DVD drive.
4894	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4895	attachments (see <link to="IMachine::mediumAttachments"/>).
4896
4897	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4898	information about attaching media.
4899
4900	The specified device slot must not have a device attached to it,
4901	or this method will fail.
4902	<note>
4903	You cannot attach a device to a newly created machine until
4904	this machine's settings are saved to disk using
4905	<link to="#saveSettings"/>.
4906	</note>
4907	<note>
4908	If the medium is being attached indirectly, a new differencing medium
4909	will implicitly be created for it and attached instead. If the
4910	changes made to the machine settings (including this indirect
4911	attachment) are later cancelled using <link to="#discardSettings"/>,
4912	this implicitly created differencing medium will implicitly
4913	be deleted.
4914	</note>
4915
4916	<result name="E_INVALIDARG">
4917	SATA device, SATA port, IDE port or IDE slot out of range, or
4918	file or UUID not found.
4919	</result>
4920	<result name="VBOX_E_INVALID_OBJECT_STATE">
4921	Machine must be registered before media can be attached.
4922	</result>
4923	<result name="VBOX_E_INVALID_VM_STATE">
4924	Invalid machine state.
4925	</result>
4926	<result name="VBOX_E_OBJECT_IN_USE">
4927	A medium is already attached to this or another virtual machine.
4928	</result>
4929	</desc>
4930	<param name="name" type="wstring" dir="in">
4931	<desc>Name of the storage controller to attach the device to.</desc>
4932	</param>
4933	<param name="controllerPort" type="long" dir="in">
4934	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4935	the primary controller and 1 specifies the secondary controller.
4936	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4937	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4938	</param>
4939	<param name="device" type="long" dir="in">
4940	<desc>Device slot in the given port to attach the device to. This is only
4941	relevant for IDE controllers, for which 0 specifies the master device and
4942	1 specifies the slave device. For all other controller types, this must
4943	be 0.</desc>
4944	</param>
4945	<param name="type" type="DeviceType" dir="in">
4946	<desc>Device type of the attached device. For media opened by
4947	<link to="IVirtualBox::openMedium" />, this must match the device type
4948	specified there.</desc>
4949	</param>
4950	</method>
4951
4952	<method name="detachDevice">
4953	<desc>
4954	Detaches the device attached to a device slot of the specified bus.
4955
4956	Detaching the device from the virtual machine is deferred. This means
4957	that the medium remains associated with the machine when this method
4958	returns and gets actually de-associated only after a successful
4959	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4960	for more detailed information about attaching media.
4961
4962	<note>
4963	You cannot detach a device from a running machine.
4964	</note>
4965	<note>
4966	Detaching differencing media implicitly created by <link
4967	to="#attachDevice"/> for the indirect attachment using this
4968	method will <b>not</b> implicitly delete them. The
4969	<link to="IMedium::deleteStorage"/> operation should be
4970	explicitly performed by the caller after the medium is successfully
4971	detached and the settings are saved with
4972	<link to="#saveSettings"/>, if it is the desired action.
4973	</note>
4974
4975	<result name="VBOX_E_INVALID_VM_STATE">
4976	Attempt to detach medium from a running virtual machine.
4977	</result>
4978	<result name="VBOX_E_OBJECT_NOT_FOUND">
4979	No medium attached to given slot/bus.
4980	</result>
4981	<result name="VBOX_E_NOT_SUPPORTED">
4982	Medium format does not support storage deletion (only for implicitly
4983	created differencing media, should not happen).
4984	</result>
4985
4986	</desc>
4987	<param name="name" type="wstring" dir="in">
4988	<desc>Name of the storage controller to detach the medium from.</desc>
4989	</param>
4990	<param name="controllerPort" type="long" dir="in">
4991	<desc>Port number to detach the medium from.</desc>
4992	</param>
4993	<param name="device" type="long" dir="in">
4994	<desc>Device slot number to detach the medium from.</desc>
4995	</param>
4996	</method>
4997
4998	<method name="passthroughDevice">
4999	<desc>
5000	Sets the passthrough mode of an existing DVD device. Changing the
5001	setting while the VM is running is forbidden. The setting is only used
5002	if at VM start the device is configured as a host DVD drive, in all
5003	other cases it is ignored. The device must already exist; see
5004	<link to="IMachine::attachDevice"/> for how to attach a new device.
5005
5006	The @a controllerPort and @a device parameters specify the device slot and
5007	have have the same meaning as with <link to="IMachine::attachDevice" />.
5008
5009	<result name="E_INVALIDARG">
5010	SATA device, SATA port, IDE port or IDE slot out of range.
5011	</result>
5012	<result name="VBOX_E_INVALID_OBJECT_STATE">
5013	Attempt to modify an unregistered virtual machine.
5014	</result>
5015	<result name="VBOX_E_INVALID_VM_STATE">
5016	Invalid machine state.
5017	</result>
5018
5019	</desc>
5020	<param name="name" type="wstring" dir="in">
5021	<desc>Name of the storage controller.</desc>
5022	</param>
5023	<param name="controllerPort" type="long" dir="in">
5024	<desc>Storage controller port.</desc>
5025	</param>
5026	<param name="device" type="long" dir="in">
5027	<desc>Device slot in the given port.</desc>
5028	</param>
5029	<param name="passthrough" type="boolean" dir="in">
5030	<desc>New value for the passthrough setting.</desc>
5031	</param>
5032	</method>
5033
5034	<method name="temporaryEjectDevice">
5035	<desc>
5036	Sets the behavior for guest-triggered medium eject. In some situations
5037	it is desirable that such ejects update the VM configuration, and in
5038	others the eject should keep the VM configuration. The device must
5039	already exist; see <link to="IMachine::attachDevice"/> for how to
5040	attach a new device.
5041
5042	The @a controllerPort and @a device parameters specify the device slot and
5043	have have the same meaning as with <link to="IMachine::attachDevice" />.
5044
5045	<result name="E_INVALIDARG">
5046	SATA device, SATA port, IDE port or IDE slot out of range.
5047	</result>
5048	<result name="VBOX_E_INVALID_OBJECT_STATE">
5049	Attempt to modify an unregistered virtual machine.
5050	</result>
5051	<result name="VBOX_E_INVALID_VM_STATE">
5052	Invalid machine state.
5053	</result>
5054
5055	</desc>
5056	<param name="name" type="wstring" dir="in">
5057	<desc>Name of the storage controller.</desc>
5058	</param>
5059	<param name="controllerPort" type="long" dir="in">
5060	<desc>Storage controller port.</desc>
5061	</param>
5062	<param name="device" type="long" dir="in">
5063	<desc>Device slot in the given port.</desc>
5064	</param>
5065	<param name="temporaryEject" type="boolean" dir="in">
5066	<desc>New value for the eject behavior.</desc>
5067	</param>
5068	</method>
5069
5070	<method name="nonRotationalDevice">
5071	<desc>
5072	Sets a flag in the device information which indicates that the medium
5073	is not based on rotational technology, i.e. that the access times are
5074	more or less independent of the position on the medium. This may or may
5075	not be supported by a particular drive, and is silently ignored in the
5076	latter case. At the moment only hard disks (which is a misnomer in this
5077	context) accept this setting. Changing the setting while the VM is
5078	running is forbidden. The device must already exist; see
5079	<link to="IMachine::attachDevice"/> for how to attach a new device.
5080
5081	The @a controllerPort and @a device parameters specify the device slot and
5082	have have the same meaning as with <link to="IMachine::attachDevice" />.
5083
5084	<result name="E_INVALIDARG">
5085	SATA device, SATA port, IDE port or IDE slot out of range.
5086	</result>
5087	<result name="VBOX_E_INVALID_OBJECT_STATE">
5088	Attempt to modify an unregistered virtual machine.
5089	</result>
5090	<result name="VBOX_E_INVALID_VM_STATE">
5091	Invalid machine state.
5092	</result>
5093
5094	</desc>
5095	<param name="name" type="wstring" dir="in">
5096	<desc>Name of the storage controller.</desc>
5097	</param>
5098	<param name="controllerPort" type="long" dir="in">
5099	<desc>Storage controller port.</desc>
5100	</param>
5101	<param name="device" type="long" dir="in">
5102	<desc>Device slot in the given port.</desc>
5103	</param>
5104	<param name="nonRotational" type="boolean" dir="in">
5105	<desc>New value for the non-rotational device flag.</desc>
5106	</param>
5107	</method>
5108
5109	<method name="setAutoDiscardForDevice">
5110	<desc>
5111	Sets a flag in the device information which indicates that the medium
5112	supports discarding unsused blocks (called trimming for SATA or unmap
5113	for SCSI devices) .This may or may not be supported by a particular drive,
5114	and is silently ignored in the latter case. At the moment only hard disks
5115	(which is a misnomer in this context) accept this setting. Changing the
5116	setting while the VM is running is forbidden. The device must already
5117	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5118	device.
5119
5120	The @a controllerPort and @a device parameters specify the device slot and
5121	have have the same meaning as with <link to="IMachine::attachDevice" />.
5122
5123	<result name="E_INVALIDARG">
5124	SATA device, SATA port, SCSI port out of range.
5125	</result>
5126	<result name="VBOX_E_INVALID_OBJECT_STATE">
5127	Attempt to modify an unregistered virtual machine.
5128	</result>
5129	<result name="VBOX_E_INVALID_VM_STATE">
5130	Invalid machine state.
5131	</result>
5132
5133	</desc>
5134	<param name="name" type="wstring" dir="in">
5135	<desc>Name of the storage controller.</desc>
5136	</param>
5137	<param name="controllerPort" type="long" dir="in">
5138	<desc>Storage controller port.</desc>
5139	</param>
5140	<param name="device" type="long" dir="in">
5141	<desc>Device slot in the given port.</desc>
5142	</param>
5143	<param name="discard" type="boolean" dir="in">
5144	<desc>New value for the discard device flag.</desc>
5145	</param>
5146	</method>
5147
5148	<method name="setBandwidthGroupForDevice">
5149	<desc>
5150	Sets the bandwidth group of an existing storage device.
5151	The device must already exist; see <link to="IMachine::attachDevice"/>
5152	for how to attach a new device.
5153
5154	The @a controllerPort and @a device parameters specify the device slot and
5155	have have the same meaning as with <link to="IMachine::attachDevice" />.
5156
5157	<result name="E_INVALIDARG">
5158	SATA device, SATA port, IDE port or IDE slot out of range.
5159	</result>
5160	<result name="VBOX_E_INVALID_OBJECT_STATE">
5161	Attempt to modify an unregistered virtual machine.
5162	</result>
5163	<result name="VBOX_E_INVALID_VM_STATE">
5164	Invalid machine state.
5165	</result>
5166
5167	</desc>
5168	<param name="name" type="wstring" dir="in">
5169	<desc>Name of the storage controller.</desc>
5170	</param>
5171	<param name="controllerPort" type="long" dir="in">
5172	<desc>Storage controller port.</desc>
5173	</param>
5174	<param name="device" type="long" dir="in">
5175	<desc>Device slot in the given port.</desc>
5176	</param>
5177	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5178	<desc>New value for the bandwidth group or @c null for no group.</desc>
5179	</param>
5180	</method>
5181
5182	<method name="setNoBandwidthGroupForDevice">
5183	<desc>
5184	Sets no bandwidth group for an existing storage device.
5185	The device must already exist; see <link to="IMachine::attachDevice"/>
5186	for how to attach a new device.
5187	The @a controllerPort and @a device parameters specify the device slot and
5188	have have the same meaning as with <link to="IMachine::attachDevice" />.
5189	<result name="E_INVALIDARG">
5190	SATA device, SATA port, IDE port or IDE slot out of range.
5191	</result>
5192	<result name="VBOX_E_INVALID_OBJECT_STATE">
5193	Attempt to modify an unregistered virtual machine.
5194	</result>
5195	<result name="VBOX_E_INVALID_VM_STATE">
5196	Invalid machine state.
5197	</result>
5198
5199	</desc>
5200	<param name="name" type="wstring" dir="in">
5201	<desc>Name of the storage controller.</desc>
5202	</param>
5203	<param name="controllerPort" type="long" dir="in">
5204	<desc>Storage controller port.</desc>
5205	</param>
5206	<param name="device" type="long" dir="in">
5207	<desc>Device slot in the given port.</desc>
5208	</param>
5209	</method>
5210
5211
5212	<method name="unmountMedium">
5213	<desc>
5214	Unmounts any currently mounted medium (<link to="IMedium" />,
5215	identified by the given UUID @a id) to the given storage controller
5216	(<link to="IStorageController" />, identified by @a name),
5217	at the indicated port and device. The device must already exist;
5218
5219	This method is intended only for managing removable media, where the
5220	device is fixed but media is changeable at runtime (such as DVDs
5221	and floppies). It cannot be used for fixed media such as hard disks.
5222
5223	The @a controllerPort and @a device parameters specify the device slot
5224	and have have the same meaning as with
5225	<link to="IMachine::attachDevice" />.
5226
5227	The specified device slot must have a medium mounted, which will be
5228	unmounted. If there is no mounted medium it will do nothing.
5229	See <link to="IMedium"/> for more detailed information about
5230	attaching/unmounting media.
5231
5232	<result name="E_INVALIDARG">
5233	SATA device, SATA port, IDE port or IDE slot out of range.
5234	</result>
5235	<result name="VBOX_E_INVALID_OBJECT_STATE">
5236	Attempt to unmount medium that is not removeable - not dvd or floppy.
5237	</result>
5238	<result name="VBOX_E_INVALID_VM_STATE">
5239	Invalid machine state.
5240	</result>
5241	<result name="VBOX_E_OBJECT_IN_USE">
5242	Medium already attached to this or another virtual machine.
5243	</result>
5244	<result name="VBOX_E_OBJECT_NOT_FOUND">
5245	Medium not attached to specified port, device, controller.
5246	</result>
5247
5248	</desc>
5249	<param name="name" type="wstring" dir="in">
5250	<desc>Name of the storage controller to unmount the medium from.</desc>
5251	</param>
5252	<param name="controllerPort" type="long" dir="in">
5253	<desc>Port to unmount the medium from.</desc>
5254	</param>
5255	<param name="device" type="long" dir="in">
5256	<desc>Device slot in the given port to unmount the medium from.</desc>
5257	</param>
5258	<param name="force" type="boolean" dir="in">
5259	<desc>Allows to force unmount of a medium which is locked by
5260	the device slot in the given port medium is attached to.</desc>
5261	</param>
5262	</method>
5263
5264	<method name="mountMedium">
5265	<desc>
5266	Mounts a medium (<link to="IMedium" />, identified
5267	by the given UUID @a id) to the given storage controller
5268	(<link to="IStorageController" />, identified by @a name),
5269	at the indicated port and device. The device must already exist;
5270	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5271
5272	This method is intended only for managing removable media, where the
5273	device is fixed but media is changeable at runtime (such as DVDs
5274	and floppies). It cannot be used for fixed media such as hard disks.
5275
5276	The @a controllerPort and @a device parameters specify the device slot and
5277	have have the same meaning as with <link to="IMachine::attachDevice" />.
5278
5279	The specified device slot can have a medium mounted, which will be
5280	unmounted first. Specifying a zero UUID (or an empty string) for
5281	@a medium does just an unmount.
5282
5283	See <link to="IMedium"/> for more detailed information about
5284	attaching media.
5285
5286	<result name="E_INVALIDARG">
5287	SATA device, SATA port, IDE port or IDE slot out of range.
5288	</result>
5289	<result name="VBOX_E_INVALID_OBJECT_STATE">
5290	Attempt to attach medium to an unregistered virtual machine.
5291	</result>
5292	<result name="VBOX_E_INVALID_VM_STATE">
5293	Invalid machine state.
5294	</result>
5295	<result name="VBOX_E_OBJECT_IN_USE">
5296	Medium already attached to this or another virtual machine.
5297	</result>
5298
5299	</desc>
5300	<param name="name" type="wstring" dir="in">
5301	<desc>Name of the storage controller to attach the medium to.</desc>
5302	</param>
5303	<param name="controllerPort" type="long" dir="in">
5304	<desc>Port to attach the medium to.</desc>
5305	</param>
5306	<param name="device" type="long" dir="in">
5307	<desc>Device slot in the given port to attach the medium to.</desc>
5308	</param>
5309	<param name="medium" type="IMedium" dir="in">
5310	<desc>Medium to mount or @c null for an empty drive.</desc>
5311	</param>
5312	<param name="force" type="boolean" dir="in">
5313	<desc>Allows to force unmount/mount of a medium which is locked by
5314	the device slot in the given port to attach the medium to.</desc>
5315	</param>
5316	</method>
5317
5318	<method name="getMedium" const="yes">
5319	<desc>
5320	Returns the virtual medium attached to a device slot of the specified
5321	bus.
5322
5323	Note that if the medium was indirectly attached by
5324	<link to="#mountMedium"/> to the given device slot then this
5325	method will return not the same object as passed to the
5326	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5327	more detailed information about mounting a medium.
5328
5329	<result name="VBOX_E_OBJECT_NOT_FOUND">
5330	No medium attached to given slot/bus.
5331	</result>
5332
5333	</desc>
5334	<param name="name" type="wstring" dir="in">
5335	<desc>Name of the storage controller the medium is attached to.</desc>
5336	</param>
5337	<param name="controllerPort" type="long" dir="in">
5338	<desc>Port to query.</desc>
5339	</param>
5340	<param name="device" type="long" dir="in">
5341	<desc>Device slot in the given port to query.</desc>
5342	</param>
5343	<param name="medium" type="IMedium" dir="return">
5344	<desc>Attached medium object.</desc>
5345	</param>
5346	</method>
5347
5348	<method name="getMediumAttachmentsOfController" const="yes">
5349	<desc>
5350	Returns an array of medium attachments which are attached to the
5351	the controller with the given name.
5352
5353	<result name="VBOX_E_OBJECT_NOT_FOUND">
5354	A storage controller with given name doesn't exist.
5355	</result>
5356	</desc>
5357	<param name="name" type="wstring" dir="in"/>
5358	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5359	</method>
5360
5361	<method name="getMediumAttachment" const="yes">
5362	<desc>
5363	Returns a medium attachment which corresponds to the controller with
5364	the given name, on the given port and device slot.
5365
5366	<result name="VBOX_E_OBJECT_NOT_FOUND">
5367	No attachment exists for the given controller/port/device combination.
5368	</result>
5369	</desc>
5370	<param name="name" type="wstring" dir="in"/>
5371	<param name="controllerPort" type="long" dir="in"/>
5372	<param name="device" type="long" dir="in"/>
5373	<param name="attachment" type="IMediumAttachment" dir="return"/>
5374	</method>
5375
5376	<method name="attachHostPCIDevice">
5377	<desc>
5378	Attaches host PCI device with the given (host) PCI address to the
5379	PCI bus of the virtual machine. Please note, that this operation
5380	is two phase, as real attachment will happen when VM will start,
5381	and most information will be delivered as IHostPCIDevicePlugEvent
5382	on IVirtualBox event source.
5383
5384	<see><link to="IHostPCIDevicePlugEvent"/></see>
5385
5386	<result name="VBOX_E_INVALID_VM_STATE">
5387	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5388	</result>
5389	<result name="VBOX_E_PDM_ERROR">
5390	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5391	</result>
5392	<result name="VBOX_E_NOT_SUPPORTED">
5393	Hardware or host OS doesn't allow PCI device passthrought.
5394	</result>
5395	</desc>
5396	<param name="hostAddress" type="long" dir="in">
5397	<desc>Address of the host PCI device.</desc>
5398	</param>
5399	<param name="desiredGuestAddress" type="long" dir="in">
5400	<desc>Desired position of this device on guest PCI bus.</desc>
5401	</param>
5402	<param name="tryToUnbind" type="boolean" dir="in">
5403	<desc>If VMM shall try to unbind existing drivers from the
5404	device before attaching it to the guest.</desc>
5405	</param>
5406	</method>
5407
5408	<method name="detachHostPCIDevice">
5409	<desc>
5410	Detach host PCI device from the virtual machine.
5411	Also HostPCIDevicePlugEvent on IVirtualBox event source
5412	will be delivered. As currently we don't support hot device
5413	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5414
5415	<see><link to="IHostPCIDevicePlugEvent"/></see>
5416
5417	<result name="VBOX_E_INVALID_VM_STATE">
5418	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5419	</result>
5420	<result name="VBOX_E_OBJECT_NOT_FOUND">
5421	This host device is not attached to this machine.
5422	</result>
5423	<result name="VBOX_E_PDM_ERROR">
5424	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5425	</result>
5426	<result name="VBOX_E_NOT_SUPPORTED">
5427	Hardware or host OS doesn't allow PCI device passthrought.
5428	</result>
5429	</desc>
5430	<param name="hostAddress" type="long" dir="in">
5431	<desc>Address of the host PCI device.</desc>
5432	</param>
5433	</method>
5434
5435	<method name="getNetworkAdapter" const="yes">
5436	<desc>
5437	Returns the network adapter associated with the given slot.
5438	Slots are numbered sequentially, starting with zero. The total
5439	number of adapters per machine is defined by the
5440	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5441	so the maximum slot number is one less than that property's value.
5442
5443	<result name="E_INVALIDARG">
5444	Invalid @a slot number.
5445	</result>
5446
5447	</desc>
5448	<param name="slot" type="unsigned long" dir="in"/>
5449	<param name="adapter" type="INetworkAdapter" dir="return"/>
5450	</method>
5451
5452	<method name="addStorageController">
5453	<desc>
5454	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5455	machine and returns it as an instance of
5456	<link to="IStorageController" />.
5457
5458	@a name identifies the controller for subsequent calls such as
5459	<link to="#getStorageControllerByName" />,
5460	<link to="#getStorageControllerByInstance" />,
5461	<link to="#removeStorageController" />,
5462	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5463
5464	After the controller has been added, you can set its exact
5465	type by setting the <link to="IStorageController::controllerType" />.
5466
5467	<result name="VBOX_E_OBJECT_IN_USE">
5468	A storage controller with given name exists already.
5469	</result>
5470	<result name="E_INVALIDARG">
5471	Invalid @a controllerType.
5472	</result>
5473	</desc>
5474	<param name="name" type="wstring" dir="in"/>
5475	<param name="connectionType" type="StorageBus" dir="in"/>
5476	<param name="controller" type="IStorageController" dir="return"/>
5477	</method>
5478
5479	<method name="getStorageControllerByName" const="yes">
5480	<desc>
5481	Returns a storage controller with the given name.
5482
5483	<result name="VBOX_E_OBJECT_NOT_FOUND">
5484	A storage controller with given name doesn't exist.
5485	</result>
5486	</desc>
5487	<param name="name" type="wstring" dir="in"/>
5488	<param name="storageController" type="IStorageController" dir="return"/>
5489	</method>
5490
5491	<method name="getStorageControllerByInstance" const="yes">
5492	<desc>
5493	Returns a storage controller with the given instance number.
5494
5495	<result name="VBOX_E_OBJECT_NOT_FOUND">
5496	A storage controller with given instance number doesn't exist.
5497	</result>
5498	</desc>
5499	<param name="instance" type="unsigned long" dir="in"/>
5500	<param name="storageController" type="IStorageController" dir="return"/>
5501	</method>
5502
5503	<method name="removeStorageController">
5504	<desc>
5505	Removes a storage controller from the machine with all devices attached to it.
5506
5507	<result name="VBOX_E_OBJECT_NOT_FOUND">
5508	A storage controller with given name doesn't exist.
5509	</result>
5510	<result name="VBOX_E_NOT_SUPPORTED">
5511	Medium format does not support storage deletion (only for implicitly
5512	created differencing media, should not happen).
5513	</result>
5514	</desc>
5515	<param name="name" type="wstring" dir="in"/>
5516	</method>
5517
5518	<method name="setStorageControllerBootable">
5519	<desc>
5520	Sets the bootable flag of the storage controller with the given name.
5521
5522	<result name="VBOX_E_OBJECT_NOT_FOUND">
5523	A storage controller with given name doesn't exist.
5524	</result>
5525	<result name="VBOX_E_OBJECT_IN_USE">
5526	Another storage controller is marked as bootable already.
5527	</result>
5528	</desc>
5529	<param name="name" type="wstring" dir="in"/>
5530	<param name="bootable" type="boolean" dir="in"/>
5531	</method>
5532
5533	<method name="getSerialPort" const="yes">
5534	<desc>
5535	Returns the serial port associated with the given slot.
5536	Slots are numbered sequentially, starting with zero. The total
5537	number of serial ports per machine is defined by the
5538	<link to="ISystemProperties::serialPortCount"/> property,
5539	so the maximum slot number is one less than that property's value.
5540
5541	<result name="E_INVALIDARG">
5542	Invalid @a slot number.
5543	</result>
5544
5545	</desc>
5546	<param name="slot" type="unsigned long" dir="in"/>
5547	<param name="port" type="ISerialPort" dir="return"/>
5548	</method>
5549
5550	<method name="getParallelPort" const="yes">
5551	<desc>
5552	Returns the parallel port associated with the given slot.
5553	Slots are numbered sequentially, starting with zero. The total
5554	number of parallel ports per machine is defined by the
5555	<link to="ISystemProperties::parallelPortCount"/> property,
5556	so the maximum slot number is one less than that property's value.
5557
5558	<result name="E_INVALIDARG">
5559	Invalid @a slot number.
5560	</result>
5561
5562	</desc>
5563	<param name="slot" type="unsigned long" dir="in"/>
5564	<param name="port" type="IParallelPort" dir="return"/>
5565	</method>
5566
5567	<method name="getExtraDataKeys">
5568	<desc>
5569	Returns an array representing the machine-specific extra data keys
5570	which currently have values defined.
5571	</desc>
5572	<param name="value" type="wstring" dir="return" safearray="yes">
5573	<desc>Array of extra data keys.</desc>
5574	</param>
5575	</method>
5576
5577	<method name="getExtraData">
5578	<desc>
5579	Returns associated machine-specific extra data.
5580
5581	If the requested data @a key does not exist, this function will
5582	succeed and return an empty string in the @a value argument.
5583
5584	<result name="VBOX_E_FILE_ERROR">
5585	Settings file not accessible.
5586	</result>
5587	<result name="VBOX_E_XML_ERROR">
5588	Could not parse the settings file.
5589	</result>
5590
5591	</desc>
5592	<param name="key" type="wstring" dir="in">
5593	<desc>Name of the data key to get.</desc>
5594	</param>
5595	<param name="value" type="wstring" dir="return">
5596	<desc>Value of the requested data key.</desc>
5597	</param>
5598	</method>
5599
5600	<method name="setExtraData">
5601	<desc>
5602	Sets associated machine-specific extra data.
5603
5604	If you pass @c null or an empty string as a key @a value, the given
5605	@a key will be deleted.
5606
5607	<note>
5608	Before performing the actual data change, this method will ask all
5609	registered listeners using the
5610	<link to="IExtraDataCanChangeEvent"/>
5611	notification for a permission. If one of the listeners refuses the
5612	new value, the change will not be performed.
5613	</note>
5614	<note>
5615	On success, the
5616	<link to="IExtraDataChangedEvent"/> notification
5617	is called to inform all registered listeners about a successful data
5618	change.
5619	</note>
5620	<note>
5621	This method can be called outside the machine session and therefore
5622	it's a caller's responsibility to handle possible race conditions
5623	when several clients change the same key at the same time.
5624	</note>
5625
5626	<result name="VBOX_E_FILE_ERROR">
5627	Settings file not accessible.
5628	</result>
5629	<result name="VBOX_E_XML_ERROR">
5630	Could not parse the settings file.
5631	</result>
5632
5633	</desc>
5634	<param name="key" type="wstring" dir="in">
5635	<desc>Name of the data key to set.</desc>
5636	</param>
5637	<param name="value" type="wstring" dir="in">
5638	<desc>Value to assign to the key.</desc>
5639	</param>
5640	</method>
5641
5642	<method name="getCPUProperty" const="yes">
5643	<desc>
5644	Returns the virtual CPU boolean value of the specified property.
5645
5646	<result name="E_INVALIDARG">
5647	Invalid property.
5648	</result>
5649
5650	</desc>
5651	<param name="property" type="CPUPropertyType" dir="in">
5652	<desc>
5653	Property type to query.
5654	</desc>
5655	</param>
5656	<param name="value" type="boolean" dir="return">
5657	<desc>
5658	Property value.
5659	</desc>
5660	</param>
5661	</method>
5662
5663	<method name="setCPUProperty">
5664	<desc>
5665	Sets the virtual CPU boolean value of the specified property.
5666
5667	<result name="E_INVALIDARG">
5668	Invalid property.
5669	</result>
5670
5671	</desc>
5672	<param name="property" type="CPUPropertyType" dir="in">
5673	<desc>
5674	Property type to query.
5675	</desc>
5676	</param>
5677	<param name="value" type="boolean" dir="in">
5678	<desc>
5679	Property value.
5680	</desc>
5681	</param>
5682	</method>
5683
5684	<method name="getCPUIDLeaf" const="yes">
5685	<desc>
5686	Returns the virtual CPU cpuid information for the specified leaf.
5687
5688	Currently supported index values for cpuid:
5689	Standard CPUID leafs: 0 - 0xA
5690	Extended CPUID leafs: 0x80000000 - 0x8000000A
5691
5692	See the Intel and AMD programmer's manuals for detailed information
5693	about the cpuid instruction and its leafs.
5694	<result name="E_INVALIDARG">
5695	Invalid id.
5696	</result>
5697
5698	</desc>
5699	<param name="id" type="unsigned long" dir="in">
5700	<desc>
5701	CPUID leaf index.
5702	</desc>
5703	</param>
5704	<param name="valEax" type="unsigned long" dir="out">
5705	<desc>
5706	CPUID leaf value for register eax.
5707	</desc>
5708	</param>
5709	<param name="valEbx" type="unsigned long" dir="out">
5710	<desc>
5711	CPUID leaf value for register ebx.
5712	</desc>
5713	</param>
5714	<param name="valEcx" type="unsigned long" dir="out">
5715	<desc>
5716	CPUID leaf value for register ecx.
5717	</desc>
5718	</param>
5719	<param name="valEdx" type="unsigned long" dir="out">
5720	<desc>
5721	CPUID leaf value for register edx.
5722	</desc>
5723	</param>
5724	</method>
5725
5726	<method name="setCPUIDLeaf">
5727	<desc>
5728	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5729	are not passed unmodified. VirtualBox clears features that it doesn't support.
5730
5731	Currently supported index values for cpuid:
5732	Standard CPUID leafs: 0 - 0xA
5733	Extended CPUID leafs: 0x80000000 - 0x8000000A
5734
5735	See the Intel and AMD programmer's manuals for detailed information
5736	about the cpuid instruction and its leafs.
5737
5738	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5739	random crashes inside VMs.
5740	<result name="E_INVALIDARG">
5741	Invalid id.
5742	</result>
5743
5744	</desc>
5745	<param name="id" type="unsigned long" dir="in">
5746	<desc>
5747	CPUID leaf index.
5748	</desc>
5749	</param>
5750	<param name="valEax" type="unsigned long" dir="in">
5751	<desc>
5752	CPUID leaf value for register eax.
5753	</desc>
5754	</param>
5755	<param name="valEbx" type="unsigned long" dir="in">
5756	<desc>
5757	CPUID leaf value for register ebx.
5758	</desc>
5759	</param>
5760	<param name="valEcx" type="unsigned long" dir="in">
5761	<desc>
5762	CPUID leaf value for register ecx.
5763	</desc>
5764	</param>
5765	<param name="valEdx" type="unsigned long" dir="in">
5766	<desc>
5767	CPUID leaf value for register edx.
5768	</desc>
5769	</param>
5770	</method>
5771
5772	<method name="removeCPUIDLeaf">
5773	<desc>
5774	Removes the virtual CPU cpuid leaf for the specified index
5775
5776	<result name="E_INVALIDARG">
5777	Invalid id.
5778	</result>
5779
5780	</desc>
5781	<param name="id" type="unsigned long" dir="in">
5782	<desc>
5783	CPUID leaf index.
5784	</desc>
5785	</param>
5786	</method>
5787
5788	<method name="removeAllCPUIDLeaves">
5789	<desc>
5790	Removes all the virtual CPU cpuid leaves
5791	</desc>
5792	</method>
5793
5794	<method name="getHWVirtExProperty" const="yes">
5795	<desc>
5796	Returns the value of the specified hardware virtualization boolean property.
5797
5798	<result name="E_INVALIDARG">
5799	Invalid property.
5800	</result>
5801
5802	</desc>
5803	<param name="property" type="HWVirtExPropertyType" dir="in">
5804	<desc>
5805	Property type to query.
5806	</desc>
5807	</param>
5808	<param name="value" type="boolean" dir="return">
5809	<desc>
5810	Property value.
5811	</desc>
5812	</param>
5813	</method>
5814
5815	<method name="setHWVirtExProperty">
5816	<desc>
5817	Sets a new value for the specified hardware virtualization boolean property.
5818
5819	<result name="E_INVALIDARG">
5820	Invalid property.
5821	</result>
5822
5823	</desc>
5824	<param name="property" type="HWVirtExPropertyType" dir="in">
5825	<desc>
5826	Property type to set.
5827	</desc>
5828	</param>
5829	<param name="value" type="boolean" dir="in">
5830	<desc>
5831	New property value.
5832	</desc>
5833	</param>
5834	</method>
5835
5836	<method name="saveSettings">
5837	<desc>
5838	Saves any changes to machine settings made since the session
5839	has been opened or a new machine has been created, or since the
5840	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5841	For registered machines, new settings become visible to all
5842	other VirtualBox clients after successful invocation of this
5843	method.
5844	<note>
5845	The method sends <link to="IMachineDataChangedEvent"/>
5846	notification event after the configuration has been successfully
5847	saved (only for registered machines).
5848	</note>
5849	<note>
5850	Calling this method is only valid on instances returned
5851	by <link to="ISession::machine"/> and on new machines
5852	created by <link to="IVirtualBox::createMachine"/> but not
5853	yet registered, or on unregistered machines after calling
5854	<link to="IMachine::unregister"/>.
5855	</note>
5856
5857	<result name="VBOX_E_FILE_ERROR">
5858	Settings file not accessible.
5859	</result>
5860	<result name="VBOX_E_XML_ERROR">
5861	Could not parse the settings file.
5862	</result>
5863	<result name="E_ACCESSDENIED">
5864	Modification request refused.
5865	</result>
5866
5867	</desc>
5868	</method>
5869
5870	<method name="discardSettings">
5871	<desc>
5872	Discards any changes to the machine settings made since the session
5873	has been opened or since the last call to <link to="#saveSettings"/>
5874	or <link to="#discardSettings"/>.
5875	<note>
5876	Calling this method is only valid on instances returned
5877	by <link to="ISession::machine"/> and on new machines
5878	created by <link to="IVirtualBox::createMachine"/> or
5879	opened by <link to="IVirtualBox::openMachine"/> but not
5880	yet registered, or on unregistered machines after calling
5881	<link to="IMachine::unregister"/>.
5882	</note>
5883
5884	<result name="VBOX_E_INVALID_VM_STATE">
5885	Virtual machine is not mutable.
5886	</result>
5887
5888	</desc>
5889	</method>
5890
5891	<method name="unregister">
5892	<desc>
5893	Unregisters a machine previously registered with
5894	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5895	cleanup before the machine is unregistered.
5896
5897	This method does not delete any files. It only changes the machine configuration and
5898	the list of registered machines in the VirtualBox object. To delete the files which
5899	belonged to the machine, including the XML file of the machine itself, call
5900	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5901	from this method.
5902
5903	How thoroughly this method cleans up the machine configuration before unregistering
5904	the machine depends on the @a cleanupMode argument.
5905
5906	<ul>
5907	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5908	cleanup will be performed. The call will fail if the machine is in "Saved" state
5909	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5910	It is the responsibility of the caller to delete all such configuration in this mode.
5911	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5912	which it replaces.</li>
5913	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5914	state or if it has snapshots or media attached. All media attached to the current machine
5915	state or in snapshots will be detached. No medium objects will be returned;
5916	all of the machine's media will remain open.</li>
5917	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5918	except that all the hard disk medium objects which were detached from the machine will
5919	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5920	API for closing and deletion.</li>
5921	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5922	that all media will be returned in the array, including removable media like DVDs and
5923	floppies. This might be useful if the user wants to inspect in detail which media were
5924	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5925	in that case because users will typically want to preserve ISO and RAW image files.</li>
5926	</ul>
5927
5928	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5929	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5930	deleted with all its saved states and hard disk images, but images for removable
5931	drives (such as ISO and RAW files) will remain on disk.
5932
5933	This API does not verify whether the media files returned in the array are still
5934	attached to other machines (i.e. shared between several machines). If such a shared
5935	image is passed to <link to="#delete" /> however, closing the image will fail there
5936	and the image will be silently skipped.
5937
5938	This API may, however, move media from this machine's media registry to other media
5939	registries (see <link to="IMedium" /> for details on media registries). For machines
5940	created with VirtualBox 4.0 or later, if media from this machine's media registry
5941	are also attached to another machine (shared attachments), each such medium will be
5942	moved to another machine's registry. This is because without this machine's media
5943	registry, the other machine cannot find its media any more and would become inaccessible.
5944
5945	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5946	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5947	if media are moved to other machines' media registries.
5948
5949	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5950	is fired.
5951
5952	The call will fail if the machine is currently locked (see <link to="ISession" />).
5953
5954	<note>
5955	If the given machine is inaccessible (see <link to="#accessible"/>), it
5956	will be unregistered and fully uninitialized right afterwards. As a result,
5957	the returned machine object will be unusable and an attempt to call
5958	<b>any</b> method will return the "Object not ready" error.
5959	</note>
5960
5961	<result name="VBOX_E_INVALID_OBJECT_STATE">
5962	Machine is currently locked for a session.
5963	</result>
5964	</desc>
5965
5966	<param name="cleanupMode" type="CleanupMode" dir="in">
5967	<desc>How to clean up after the machine has been unregistered.</desc>
5968	</param>
5969	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5970	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5971	</param>
5972	</method>
5973
5974	<method name="delete">
5975	<desc>
5976	Deletes the files associated with this machine from disk. If medium objects are passed
5977	in with the @a aMedia argument, they are closed and, if closing was successful, their
5978	storage files are deleted as well. For convenience, this array of media files can be
5979	the same as the one returned from a previous <link to="#unregister" /> call.
5980
5981	This method must only be called on machines which are either write-locked (i.e. on instances
5982	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5983	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5984	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5985
5986	The following files will be deleted by this method:
5987	<ul>
5988	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5989	argument other than "UnregisterOnly", this will delete all saved state files that
5990	the machine had in use; possibly one if the machine was in "Saved" state and one
5991	for each online snapshot that the machine had.</li>
5992	<li>On each medium object passed in the @a aMedia array, this will call
5993	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5994	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5995	in use, e.g. because it is still attached to a second machine; in that case the
5996	storage will not be deleted.</li>
5997	<li>Finally, the machine's own XML file will be deleted.</li>
5998	</ul>
5999
6000	Since deleting large disk image files can be a time-consuming I/O operation, this
6001	method operates asynchronously and returns an IProgress object to allow the caller
6002	to monitor the progress. There will be one sub-operation for each file that is
6003	being deleted (saved state or medium storage file).
6004
6005	<note>
6006	<link to="#settingsModified"/> will return @c true after this
6007	method successfully returns.
6008	</note>
6009
6010	<result name="VBOX_E_INVALID_VM_STATE">
6011	Machine is registered but not write-locked.
6012	</result>
6013	<result name="VBOX_E_IPRT_ERROR">
6014	Could not delete the settings file.
6015	</result>
6016	</desc>
6017	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
6018	<desc>List of media to be closed and whose storage files will be deleted.</desc>
6019	</param>
6020	<param name="aProgress" type="IProgress" dir="return">
6021	<desc>Progress object to track the operation completion.</desc>
6022	</param>
6023	</method>
6024
6025	<method name="export">
6026	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6027	steps required to export VirtualBox machines to OVF.
6028	</desc>
6029
6030	<param name="aAppliance" type="IAppliance" dir="in">
6031	<desc>Appliance to export this machine to.</desc>
6032	</param>
6033	<param name="location" type="wstring" dir="in">
6034	<desc>The target location.</desc>
6035	</param>
6036	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
6037	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6038	</param>
6039	</method >
6040
6041	<method name="findSnapshot">
6042	<desc>
6043	Returns a snapshot of this machine with the given name or UUID.
6044
6045	Returns a snapshot of this machine with the given UUID.
6046	A @c null argument can be used to obtain the first snapshot
6047	taken on this machine. To traverse the whole tree of snapshots
6048	starting from the root, inspect the root snapshot's
6049	<link to="ISnapshot::children" /> attribute and recurse over those children.
6050
6051	<result name="VBOX_E_OBJECT_NOT_FOUND">
6052	Virtual machine has no snapshots or snapshot not found.
6053	</result>
6054
6055	</desc>
6056	<param name="nameOrId" type="wstring" dir="in">
6057	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6058	</param>
6059	<param name="snapshot" type="ISnapshot" dir="return">
6060	<desc>Snapshot object with the given name.</desc>
6061	</param>
6062	</method>
6063
6064	<method name="createSharedFolder">
6065	<desc>
6066	Creates a new permanent shared folder by associating the given logical
6067	name with the given host path, adds it to the collection of shared
6068	folders and starts sharing it. Refer to the description of
6069	<link to="ISharedFolder"/> to read more about logical names.
6070
6071	<result name="VBOX_E_OBJECT_IN_USE">
6072	Shared folder already exists.
6073	</result>
6074	<result name="VBOX_E_FILE_ERROR">
6075	Shared folder @a hostPath not accessible.
6076	</result>
6077
6078	</desc>
6079	<param name="name" type="wstring" dir="in">
6080	<desc>Unique logical name of the shared folder.</desc>
6081	</param>
6082	<param name="hostPath" type="wstring" dir="in">
6083	<desc>Full path to the shared folder in the host file system.</desc>
6084	</param>
6085	<param name="writable" type="boolean" dir="in">
6086	<desc>Whether the share is writable or readonly.</desc>
6087	</param>
6088	<param name="automount" type="boolean" dir="in">
6089	<desc>Whether the share gets automatically mounted by the guest
6090	or not.</desc>
6091	</param>
6092	</method>
6093
6094	<method name="removeSharedFolder">
6095	<desc>
6096	Removes the permanent shared folder with the given name previously
6097	created by <link to="#createSharedFolder"/> from the collection of
6098	shared folders and stops sharing it.
6099
6100	<result name="VBOX_E_INVALID_VM_STATE">
6101	Virtual machine is not mutable.
6102	</result>
6103	<result name="VBOX_E_OBJECT_NOT_FOUND">
6104	Shared folder @a name does not exist.
6105	</result>
6106
6107	</desc>
6108	<param name="name" type="wstring" dir="in">
6109	<desc>Logical name of the shared folder to remove.</desc>
6110	</param>
6111	</method>
6112
6113	<method name="canShowConsoleWindow">
6114	<desc>
6115	Returns @c true if the VM console process can activate the
6116	console window and bring it to foreground on the desktop of
6117	the host PC.
6118	<note>
6119	This method will fail if a session for this machine is not
6120	currently open.
6121	</note>
6122
6123	<result name="VBOX_E_INVALID_VM_STATE">
6124	Machine session is not open.
6125	</result>
6126
6127	</desc>
6128	<param name="canShow" type="boolean" dir="return">
6129	<desc>
6130	@c true if the console window can be shown and @c false otherwise.
6131	</desc>
6132	</param>
6133	</method>
6134
6135	<method name="showConsoleWindow">
6136	<desc>
6137	Activates the console window and brings it to foreground on
6138	the desktop of the host PC. Many modern window managers on
6139	many platforms implement some sort of focus stealing
6140	prevention logic, so that it may be impossible to activate
6141	a window without the help of the currently active
6142	application. In this case, this method will return a non-zero
6143	identifier that represents the top-level window of the VM
6144	console process. The caller, if it represents a currently
6145	active process, is responsible to use this identifier (in a
6146	platform-dependent manner) to perform actual window
6147	activation.
6148	<note>
6149	This method will fail if a session for this machine is not
6150	currently open.
6151	</note>
6152
6153	<result name="VBOX_E_INVALID_VM_STATE">
6154	Machine session is not open.
6155	</result>
6156
6157	</desc>
6158	<param name="winId" type="long long" dir="return">
6159	<desc>
6160	Platform-dependent identifier of the top-level VM console
6161	window, or zero if this method has performed all actions
6162	necessary to implement the <i>show window</i> semantics for
6163	the given platform and/or VirtualBox front-end.
6164	</desc>
6165	</param>
6166	</method>
6167
6168	<method name="getGuestProperty" const="yes">
6169	<desc>
6170	Reads an entry from the machine's guest property store.
6171
6172	<result name="VBOX_E_INVALID_VM_STATE">
6173	Machine session is not open.
6174	</result>
6175
6176	</desc>
6177	<param name="name" type="wstring" dir="in">
6178	<desc>
6179	The name of the property to read.
6180	</desc>
6181	</param>
6182	<param name="value" type="wstring" dir="out">
6183	<desc>
6184	The value of the property. If the property does not exist then this
6185	will be empty.
6186	</desc>
6187	</param>
6188	<param name="timestamp" type="long long" dir="out">
6189	<desc>
6190	The time at which the property was last modified, as seen by the
6191	server process.
6192	</desc>
6193	</param>
6194	<param name="flags" type="wstring" dir="out">
6195	<desc>
6196	Additional property parameters, passed as a comma-separated list of
6197	"name=value" type entries.
6198	</desc>
6199	</param>
6200	</method>
6201
6202	<method name="getGuestPropertyValue" const="yes">
6203	<desc>
6204	Reads a value from the machine's guest property store.
6205
6206	<result name="VBOX_E_INVALID_VM_STATE">
6207	Machine session is not open.
6208	</result>
6209
6210	</desc>
6211	<param name="property" type="wstring" dir="in">
6212	<desc>
6213	The name of the property to read.
6214	</desc>
6215	</param>
6216	<param name="value" type="wstring" dir="return">
6217	<desc>
6218	The value of the property. If the property does not exist then this
6219	will be empty.
6220	</desc>
6221	</param>
6222	</method>
6223
6224	<method name="getGuestPropertyTimestamp" const="yes">
6225	<desc>
6226	Reads a property timestamp from the machine's guest property store.
6227
6228	<result name="VBOX_E_INVALID_VM_STATE">
6229	Machine session is not open.
6230	</result>
6231
6232	</desc>
6233	<param name="property" type="wstring" dir="in">
6234	<desc>
6235	The name of the property to read.
6236	</desc>
6237	</param>
6238	<param name="value" type="long long" dir="return">
6239	<desc>
6240	The timestamp. If the property does not exist then this will be
6241	empty.
6242	</desc>
6243	</param>
6244	</method>
6245
6246	<method name="setGuestProperty">
6247	<desc>
6248	Sets, changes or deletes an entry in the machine's guest property
6249	store.
6250
6251	<result name="E_ACCESSDENIED">
6252	Property cannot be changed.
6253	</result>
6254	<result name="E_INVALIDARG">
6255	Invalid @a flags.
6256	</result>
6257	<result name="VBOX_E_INVALID_VM_STATE">
6258	Virtual machine is not mutable or session not open.
6259	</result>
6260	<result name="VBOX_E_INVALID_OBJECT_STATE">
6261	Cannot set transient property when machine not running.
6262	</result>
6263
6264	</desc>
6265	<param name="property" type="wstring" dir="in">
6266	<desc>
6267	The name of the property to set, change or delete.
6268	</desc>
6269	</param>
6270	<param name="value" type="wstring" dir="in">
6271	<desc>
6272	The new value of the property to set, change or delete. If the
6273	property does not yet exist and value is non-empty, it will be
6274	created. If the value is @c null or empty, the property will be
6275	deleted if it exists.
6276	</desc>
6277	</param>
6278	<param name="flags" type="wstring" dir="in">
6279	<desc>
6280	Additional property parameters, passed as a comma-separated list of
6281	"name=value" type entries.
6282	</desc>
6283	</param>
6284	</method>
6285
6286	<method name="setGuestPropertyValue">
6287	<desc>
6288	Sets, changes or deletes a value in the machine's guest property
6289	store. The flags field will be left unchanged or created empty for a
6290	new property.
6291
6292	<result name="E_ACCESSDENIED">
6293	Property cannot be changed.
6294	</result>
6295	<result name="VBOX_E_INVALID_VM_STATE">
6296	Virtual machine is not mutable or session not open.
6297	</result>
6298	<result name="VBOX_E_INVALID_OBJECT_STATE">
6299	Cannot set transient property when machine not running.
6300	</result>
6301	</desc>
6302
6303	<param name="property" type="wstring" dir="in">
6304	<desc>
6305	The name of the property to set, change or delete.
6306	</desc>
6307	</param>
6308	<param name="value" type="wstring" dir="in">
6309	<desc>
6310	The new value of the property to set, change or delete. If the
6311	property does not yet exist and value is non-empty, it will be
6312	created. If the value is @c null or empty, the property will be
6313	deleted if it exists.
6314	</desc>
6315	</param>
6316	</method>
6317
6318	<method name="deleteGuestProperty" const="yes">
6319	<desc>
6320	Deletes an entry from the machine's guest property store.
6321
6322	<result name="VBOX_E_INVALID_VM_STATE">
6323	Machine session is not open.
6324	</result>
6325
6326	</desc>
6327	<param name="name" type="wstring" dir="in">
6328	<desc>
6329	The name of the property to delete.
6330	</desc>
6331	</param>
6332	</method>
6333
6334	<method name="enumerateGuestProperties" const="yes">
6335	<desc>
6336	Return a list of the guest properties matching a set of patterns along
6337	with their values, time stamps and flags.
6338	</desc>
6339	<param name="patterns" type="wstring" dir="in">
6340	<desc>
6341	The patterns to match the properties against, separated by '\|'
6342	characters. If this is empty or @c null, all properties will match.
6343	</desc>
6344	</param>
6345	<param name="name" type="wstring" dir="out" safearray="yes">
6346	<desc>
6347	The names of the properties returned.
6348	</desc>
6349	</param>
6350	<param name="value" type="wstring" dir="out" safearray="yes">
6351	<desc>
6352	The values of the properties returned. The array entries match the
6353	corresponding entries in the @a name array.
6354	</desc>
6355	</param>
6356	<param name="timestamp" type="long long" dir="out" safearray="yes">
6357	<desc>
6358	The time stamps of the properties returned. The array entries match
6359	the corresponding entries in the @a name array.
6360	</desc>
6361	</param>
6362	<param name="flags" type="wstring" dir="out" safearray="yes">
6363	<desc>
6364	The flags of the properties returned. The array entries match the
6365	corresponding entries in the @a name array.
6366	</desc>
6367	</param>
6368	</method>
6369
6370	<method name="querySavedGuestScreenInfo" const="yes">
6371	<desc>
6372	Returns the guest dimensions from the saved state.
6373	</desc>
6374	<param name="screenId" type="unsigned long" dir="in">
6375	<desc>
6376	Saved guest screen to query info from.
6377	</desc>
6378	</param>
6379	<param name="originX" type="unsigned long" dir="out">
6380	<desc>
6381	The X position of the guest monitor top left corner.
6382	</desc>
6383	</param>
6384	<param name="originY" type="unsigned long" dir="out">
6385	<desc>
6386	The Y position of the guest monitor top left corner.
6387	</desc>
6388	</param>
6389	<param name="width" type="unsigned long" dir="out">
6390	<desc>
6391	Guest width at the time of the saved state was taken.
6392	</desc>
6393	</param>
6394	<param name="height" type="unsigned long" dir="out">
6395	<desc>
6396	Guest height at the time of the saved state was taken.
6397	</desc>
6398	</param>
6399	<param name="enabled" type="boolean" dir="out">
6400	<desc>
6401	Whether the monitor is enabled in the guest.
6402	</desc>
6403	</param>
6404	</method>
6405
6406	<method name="querySavedThumbnailSize">
6407	<desc>
6408	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6409	</desc>
6410	<param name="screenId" type="unsigned long" dir="in">
6411	<desc>
6412	Saved guest screen to query info from.
6413	</desc>
6414	</param>
6415	<param name="size" type="unsigned long" dir="out">
6416	<desc>
6417	Size of buffer required to store the bitmap.
6418	</desc>
6419	</param>
6420	<param name="width" type="unsigned long" dir="out">
6421	<desc>
6422	Bitmap width.
6423	</desc>
6424	</param>
6425	<param name="height" type="unsigned long" dir="out">
6426	<desc>
6427	Bitmap height.
6428	</desc>
6429	</param>
6430	</method>
6431
6432	<method name="readSavedThumbnailToArray">
6433	<desc>
6434	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6435	</desc>
6436	<param name="screenId" type="unsigned long" dir="in">
6437	<desc>
6438	Saved guest screen to read from.
6439	</desc>
6440	</param>
6441	<param name="BGR" type="boolean" dir="in">
6442	<desc>
6443	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6444	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6445	</desc>
6446	</param>
6447	<param name="width" type="unsigned long" dir="out">
6448	<desc>
6449	Bitmap width.
6450	</desc>
6451	</param>
6452	<param name="height" type="unsigned long" dir="out">
6453	<desc>
6454	Bitmap height.
6455	</desc>
6456	</param>
6457	<param name="data" type="octet" safearray="yes" dir="return">
6458	<desc>
6459	Array with resulting bitmap data.
6460	</desc>
6461	</param>
6462	</method>
6463
6464	<method name="readSavedThumbnailPNGToArray">
6465	<desc>
6466	Thumbnail in PNG format is retrieved to an array of bytes.
6467	</desc>
6468	<param name="screenId" type="unsigned long" dir="in">
6469	<desc>
6470	Saved guest screen to read from.
6471	</desc>
6472	</param>
6473	<param name="width" type="unsigned long" dir="out">
6474	<desc>
6475	Image width.
6476	</desc>
6477	</param>
6478	<param name="height" type="unsigned long" dir="out">
6479	<desc>
6480	Image height.
6481	</desc>
6482	</param>
6483	<param name="data" type="octet" dir="return" safearray="yes">
6484	<desc>
6485	Array with resulting PNG data.
6486	</desc>
6487	</param>
6488	</method>
6489
6490	<method name="querySavedScreenshotPNGSize">
6491	<desc>
6492	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6493	</desc>
6494	<param name="screenId" type="unsigned long" dir="in">
6495	<desc>
6496	Saved guest screen to query info from.
6497	</desc>
6498	</param>
6499	<param name="size" type="unsigned long" dir="out">
6500	<desc>
6501	Size of buffer required to store the PNG binary data.
6502	</desc>
6503	</param>
6504	<param name="width" type="unsigned long" dir="out">
6505	<desc>
6506	Image width.
6507	</desc>
6508	</param>
6509	<param name="height" type="unsigned long" dir="out">
6510	<desc>
6511	Image height.
6512	</desc>
6513	</param>
6514	</method>
6515
6516	<method name="readSavedScreenshotPNGToArray">
6517	<desc>
6518	Screenshot in PNG format is retrieved to an array of bytes.
6519	</desc>
6520	<param name="screenId" type="unsigned long" dir="in">
6521	<desc>
6522	Saved guest screen to read from.
6523	</desc>
6524	</param>
6525	<param name="width" type="unsigned long" dir="out">
6526	<desc>
6527	Image width.
6528	</desc>
6529	</param>
6530	<param name="height" type="unsigned long" dir="out">
6531	<desc>
6532	Image height.
6533	</desc>
6534	</param>
6535	<param name="data" type="octet" dir="return" safearray="yes">
6536	<desc>
6537	Array with resulting PNG data.
6538	</desc>
6539	</param>
6540	</method>
6541
6542	<method name="hotPlugCPU">
6543	<desc>
6544	Plugs a CPU into the machine.
6545	</desc>
6546	<param name="cpu" type="unsigned long" dir="in">
6547	<desc>
6548	The CPU id to insert.
6549	</desc>
6550	</param>
6551	</method>
6552
6553	<method name="hotUnplugCPU">
6554	<desc>
6555	Removes a CPU from the machine.
6556	</desc>
6557	<param name="cpu" type="unsigned long" dir="in">
6558	<desc>
6559	The CPU id to remove.
6560	</desc>
6561	</param>
6562	</method>
6563
6564	<method name="getCPUStatus">
6565	<desc>
6566	Returns the current status of the given CPU.
6567	</desc>
6568	<param name="cpu" type="unsigned long" dir="in">
6569	<desc>
6570	The CPU id to check for.
6571	</desc>
6572	</param>
6573	<param name="attached" type="boolean" dir="return">
6574	<desc>
6575	Status of the CPU.
6576	</desc>
6577	</param>
6578	</method>
6579
6580	<method name="queryLogFilename">
6581	<desc>
6582	Queries for the VM log file name of an given index. Returns an empty
6583	string if a log file with that index doesn't exists.
6584	</desc>
6585	<param name="idx" type="unsigned long" dir="in">
6586	<desc>
6587	Which log file name to query. 0=current log file.
6588	</desc>
6589	</param>
6590	<param name="filename" type="wstring" dir="return">
6591	<desc>
6592	On return the full path to the log file or an empty string on error.
6593	</desc>
6594	</param>
6595	</method>
6596
6597	<method name="readLog">
6598	<desc>
6599	Reads the VM log file. The chunk size is limited, so even if you
6600	ask for a big piece there might be less data returned.
6601	</desc>
6602	<param name="idx" type="unsigned long" dir="in">
6603	<desc>
6604	Which log file to read. 0=current log file.
6605	</desc>
6606	</param>
6607	<param name="offset" type="long long" dir="in">
6608	<desc>
6609	Offset in the log file.
6610	</desc>
6611	</param>
6612	<param name="size" type="long long" dir="in">
6613	<desc>
6614	Chunk size to read in the log file.
6615	</desc>
6616	</param>
6617	<param name="data" type="octet" dir="return" safearray="yes">
6618	<desc>
6619	Data read from the log file. A data size of 0 means end of file
6620	if the requested chunk size was not 0. This is the unprocessed
6621	file data, i.e. the line ending style depends on the platform of
6622	the system the server is running on.
6623	</desc>
6624	</param>
6625	</method>
6626
6627	<method name="cloneTo">
6628	<desc>
6629	Creates a clone of this machine, either as a full clone (which means
6630	creating independent copies of the hard disk media, save states and so
6631	on), or as a linked clone (which uses its own differencing media,
6632	sharing the parent media with the source machine).
6633
6634	The target machine object must have been created previously with <link
6635	to="IVirtualBox::createMachine"/>, and all the settings will be
6636	transferred except the VM name and the hardware UUID. You can set the
6637	VM name and the new hardware UUID when creating the target machine. The
6638	network MAC addresses are newly created for all newtwork adapters. You
6639	can change that behaviour with the options parameter. The operation is
6640	performed asynchronously, so the machine object will be not be usable
6641	until the @a progress object signals completion.
6642
6643	<result name="E_INVALIDARG">
6644	@a target is @c null.
6645	</result>
6646	</desc>
6647
6648	<param name="target" type="IMachine" dir="in">
6649	<desc>Target machine object.</desc>
6650	</param>
6651	<param name="mode" type="CloneMode" dir="in">
6652	<desc>Which states should be cloned.</desc>
6653	</param>
6654	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6655	<desc>Options for the cloning operation.</desc>
6656	</param>
6657	<param name="progress" type="IProgress" dir="return">
6658	<desc>Progress object to track the operation completion.</desc>
6659	</param>
6660	</method>
6661
6662	</interface>
6663
6664	<!--
6665	// IConsole
6666	/////////////////////////////////////////////////////////////////////////
6667	-->
6668
6669	<interface
6670	name="IVRDEServerInfo" extends="$unknown"
6671	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6672	wsmap="struct"
6673	>
6674	<desc>
6675	Contains information about the remote desktop (VRDE) server capabilities and status.
6676	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6677	</desc>
6678
6679	<attribute name="active" type="boolean" readonly="yes">
6680	<desc>
6681	Whether the remote desktop connection is active.
6682	</desc>
6683	</attribute>
6684
6685	<attribute name="port" type="long" readonly="yes">
6686	<desc>
6687	VRDE server port number. If this property is equal to <tt>0</tt>, then
6688	the VRDE server failed to start, usually because there are no free IP
6689	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6690	server has not yet been started.
6691	</desc>
6692	</attribute>
6693
6694	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6695	<desc>
6696	How many times a client connected.
6697	</desc>
6698	</attribute>
6699
6700	<attribute name="beginTime" type="long long" readonly="yes">
6701	<desc>
6702	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6703	</desc>
6704	</attribute>
6705
6706	<attribute name="endTime" type="long long" readonly="yes">
6707	<desc>
6708	When the last connection was terminated or the current time, if
6709	connection is still active, in milliseconds since 1970-01-01 UTC.
6710	</desc>
6711	</attribute>
6712
6713	<attribute name="bytesSent" type="long long" readonly="yes">
6714	<desc>
6715	How many bytes were sent in last or current, if still active, connection.
6716	</desc>
6717	</attribute>
6718
6719	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6720	<desc>
6721	How many bytes were sent in all connections.
6722	</desc>
6723	</attribute>
6724
6725	<attribute name="bytesReceived" type="long long" readonly="yes">
6726	<desc>
6727	How many bytes were received in last or current, if still active, connection.
6728	</desc>
6729	</attribute>
6730
6731	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6732	<desc>
6733	How many bytes were received in all connections.
6734	</desc>
6735	</attribute>
6736
6737	<attribute name="user" type="wstring" readonly="yes">
6738	<desc>
6739	Login user name supplied by the client.
6740	</desc>
6741	</attribute>
6742
6743	<attribute name="domain" type="wstring" readonly="yes">
6744	<desc>
6745	Login domain name supplied by the client.
6746	</desc>
6747	</attribute>
6748
6749	<attribute name="clientName" type="wstring" readonly="yes">
6750	<desc>
6751	The client name supplied by the client.
6752	</desc>
6753	</attribute>
6754
6755	<attribute name="clientIP" type="wstring" readonly="yes">
6756	<desc>
6757	The IP address of the client.
6758	</desc>
6759	</attribute>
6760
6761	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6762	<desc>
6763	The client software version number.
6764	</desc>
6765	</attribute>
6766
6767	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6768	<desc>
6769	Public key exchange method used when connection was established.
6770	Values: 0 - RDP4 public key exchange scheme.
6771	1 - X509 certificates were sent to client.
6772	</desc>
6773	</attribute>
6774
6775	</interface>
6776
6777	<interface
6778	name="IConsole" extends="$unknown"
6779	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6780	wsmap="managed"
6781	>
6782	<desc>
6783	The IConsole interface represents an interface to control virtual
6784	machine execution.
6785
6786	A console object gets created when a machine has been locked for a
6787	particular session (client process) using <link to="IMachine::lockMachine" />
6788	or <link to="IMachine::launchVMProcess"/>. The console object can
6789	then be found in the session's <link to="ISession::console" /> attribute.
6790
6791	Methods of the IConsole interface allow the caller to query the current
6792	virtual machine execution state, pause the machine or power it down, save
6793	the machine state or take a snapshot, attach and detach removable media
6794	and so on.
6795
6796	<see><link to="ISession"/></see>
6797	</desc>
6798
6799	<attribute name="machine" type="IMachine" readonly="yes">
6800	<desc>
6801	Machine object for this console session.
6802	<note>
6803	This is a convenience property, it has the same value as
6804	<link to="ISession::machine"/> of the corresponding session
6805	object.
6806	</note>
6807	</desc>
6808	</attribute>
6809
6810	<attribute name="state" type="MachineState" readonly="yes">
6811	<desc>
6812	Current execution state of the machine.
6813	<note>
6814	This property always returns the same value as the corresponding
6815	property of the IMachine object for this console session.
6816	For the process that owns (executes) the VM, this is the
6817	preferable way of querying the VM state, because no IPC
6818	calls are made.
6819	</note>
6820	</desc>
6821	</attribute>
6822
6823	<attribute name="guest" type="IGuest" readonly="yes">
6824	<desc>Guest object.</desc>
6825	</attribute>
6826
6827	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6828	<desc>
6829	Virtual keyboard object.
6830	<note>
6831	If the machine is not running, any attempt to use
6832	the returned object will result in an error.
6833	</note>
6834	</desc>
6835	</attribute>
6836
6837	<attribute name="mouse" type="IMouse" readonly="yes">
6838	<desc>
6839	Virtual mouse object.
6840	<note>
6841	If the machine is not running, any attempt to use
6842	the returned object will result in an error.
6843	</note>
6844	</desc>
6845	</attribute>
6846
6847	<attribute name="display" type="IDisplay" readonly="yes">
6848	<desc>Virtual display object.
6849	<note>
6850	If the machine is not running, any attempt to use
6851	the returned object will result in an error.
6852	</note>
6853	</desc>
6854	</attribute>
6855
6856	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6857	<desc>Debugging interface.</desc>
6858	</attribute>
6859
6860	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6861	<desc>
6862	Collection of USB devices currently attached to the virtual
6863	USB controller.
6864	<note>
6865	The collection is empty if the machine is not running.
6866	</note>
6867	</desc>
6868	</attribute>
6869
6870	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6871	<desc>
6872	List of USB devices currently attached to the remote VRDE client.
6873	Once a new device is physically attached to the remote host computer,
6874	it appears in this list and remains there until detached.
6875	</desc>
6876	</attribute>
6877
6878	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6879	<desc>
6880	Collection of shared folders for the current session. These folders
6881	are called transient shared folders because they are available to the
6882	guest OS running inside the associated virtual machine only for the
6883	duration of the session (as opposed to
6884	<link to="IMachine::sharedFolders"/> which represent permanent shared
6885	folders). When the session is closed (e.g. the machine is powered down),
6886	these folders are automatically discarded.
6887
6888	New shared folders are added to the collection using
6889	<link to="#createSharedFolder"/>. Existing shared folders can be
6890	removed using <link to="#removeSharedFolder"/>.
6891	</desc>
6892	</attribute>
6893
6894	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6895	<desc>
6896	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6897	</desc>
6898	</attribute>
6899
6900	<attribute name="eventSource" type="IEventSource" readonly="yes">
6901	<desc>
6902	Event source for console events.
6903	</desc>
6904	</attribute>
6905
6906	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
6907	<desc>Array of PCI devices attached to this machine.</desc>
6908	</attribute>
6909
6910	<attribute name="useHostClipboard" type="boolean">
6911	<desc>
6912	Whether the guest clipboard should be connected to the host one or
6913	whether it should only be allowed access to the VRDE clipboard. This
6914	setting may not affect existing guest clipboard connections which
6915	are already connected to the host clipboard.
6916	</desc>
6917	</attribute>
6918
6919	<method name="powerUp">
6920	<desc>
6921	Starts the virtual machine execution using the current machine
6922	state (that is, its current execution state, current settings and
6923	current storage devices).
6924
6925	<note>
6926	This method is only useful for front-ends that want to actually
6927	execute virtual machines in their own process (like the VirtualBox
6928	or VBoxSDL front-ends). Unless you are intending to write such a
6929	front-end, do not call this method. If you simply want to
6930	start virtual machine execution using one of the existing front-ends
6931	(for example the VirtualBox GUI or headless server), use
6932	<link to="IMachine::launchVMProcess"/> instead; these
6933	front-ends will power up the machine automatically for you.
6934	</note>
6935
6936	If the machine is powered off or aborted, the execution will
6937	start from the beginning (as if the real hardware were just
6938	powered on).
6939
6940	If the machine is in the <link to="MachineState_Saved"/> state,
6941	it will continue its execution the point where the state has
6942	been saved.
6943
6944	If the machine <link to="IMachine::teleporterEnabled"/> property is
6945	enabled on the machine being powered up, the machine will wait for an
6946	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6947	state. The returned progress object will have at least three
6948	operations where the last three are defined as: (1) powering up and
6949	starting TCP server, (2) waiting for incoming teleportations, and
6950	(3) perform teleportation. These operations will be reflected as the
6951	last three operations of the progress objected returned by
6952	<link to="IMachine::launchVMProcess"/> as well.
6953
6954	<see><link to="#saveState"/></see>
6955
6956	<result name="VBOX_E_INVALID_VM_STATE">
6957	Virtual machine already running.
6958	</result>
6959	<result name="VBOX_E_HOST_ERROR">
6960	Host interface does not exist or name not set.
6961	</result>
6962	<result name="VBOX_E_FILE_ERROR">
6963	Invalid saved state file.
6964	</result>
6965	</desc>
6966	<param name="progress" type="IProgress" dir="return">
6967	<desc>Progress object to track the operation completion.</desc>
6968	</param>
6969	</method>
6970
6971	<method name="powerUpPaused">
6972	<desc>
6973	Identical to powerUp except that the VM will enter the
6974	<link to="MachineState_Paused"/> state, instead of
6975	<link to="MachineState_Running"/>.
6976
6977	<see><link to="#powerUp"/></see>
6978	<result name="VBOX_E_INVALID_VM_STATE">
6979	Virtual machine already running.
6980	</result>
6981	<result name="VBOX_E_HOST_ERROR">
6982	Host interface does not exist or name not set.
6983	</result>
6984	<result name="VBOX_E_FILE_ERROR">
6985	Invalid saved state file.
6986	</result>
6987	</desc>
6988	<param name="progress" type="IProgress" dir="return">
6989	<desc>Progress object to track the operation completion.</desc>
6990	</param>
6991	</method>
6992
6993	<method name="powerDown">
6994	<desc>
6995	Initiates the power down procedure to stop the virtual machine
6996	execution.
6997
6998	The completion of the power down procedure is tracked using the returned
6999	IProgress object. After the operation is complete, the machine will go
7000	to the PoweredOff state.
7001	<result name="VBOX_E_INVALID_VM_STATE">
7002	Virtual machine must be Running, Paused or Stuck to be powered down.
7003	</result>
7004	</desc>
7005	<param name="progress" type="IProgress" dir="return">
7006	<desc>Progress object to track the operation completion.</desc>
7007	</param>
7008	</method>
7009
7010	<method name="reset">
7011	<desc>Resets the virtual machine.
7012	<result name="VBOX_E_INVALID_VM_STATE">
7013	Virtual machine not in Running state.
7014	</result>
7015	<result name="VBOX_E_VM_ERROR">
7016	Virtual machine error in reset operation.
7017	</result>
7018	</desc>
7019	</method>
7020
7021	<method name="pause">
7022	<desc>Pauses the virtual machine execution.
7023	<result name="VBOX_E_INVALID_VM_STATE">
7024	Virtual machine not in Running state.
7025	</result>
7026	<result name="VBOX_E_VM_ERROR">
7027	Virtual machine error in suspend operation.
7028	</result>
7029	</desc>
7030	</method>
7031
7032	<method name="resume">
7033	<desc>Resumes the virtual machine execution.
7034	<result name="VBOX_E_INVALID_VM_STATE">
7035	Virtual machine not in Paused state.
7036	</result>
7037	<result name="VBOX_E_VM_ERROR">
7038	Virtual machine error in resume operation.
7039	</result>
7040	</desc>
7041	</method>
7042
7043	<method name="powerButton">
7044	<desc>Sends the ACPI power button event to the guest.
7045	<result name="VBOX_E_INVALID_VM_STATE">
7046	Virtual machine not in Running state.
7047	</result>
7048	<result name="VBOX_E_PDM_ERROR">
7049	Controlled power off failed.
7050	</result>
7051	</desc>
7052	</method>
7053
7054	<method name="sleepButton">
7055	<desc>Sends the ACPI sleep button event to the guest.
7056	<result name="VBOX_E_INVALID_VM_STATE">
7057	Virtual machine not in Running state.
7058	</result>
7059	<result name="VBOX_E_PDM_ERROR">
7060	Sending sleep button event failed.
7061	</result>
7062	</desc>
7063	</method>
7064
7065	<method name="getPowerButtonHandled">
7066	<desc>Checks if the last power button event was handled by guest.
7067	<result name="VBOX_E_PDM_ERROR">
7068	Checking if the event was handled by the guest OS failed.
7069	</result>
7070	</desc>
7071	<param name="handled" type="boolean" dir="return"/>
7072	</method>
7073
7074	<method name="getGuestEnteredACPIMode">
7075	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7076	G1 (sleeping). If this method returns @c false, the guest will
7077	most likely not respond to external ACPI events.
7078	<result name="VBOX_E_INVALID_VM_STATE">
7079	Virtual machine not in Running state.
7080	</result>
7081	</desc>
7082	<param name="entered" type="boolean" dir="return"/>
7083	</method>
7084
7085	<method name="saveState">
7086	<desc>
7087	Saves the current execution state of a running virtual machine
7088	and stops its execution.
7089
7090	After this operation completes, the machine will go to the
7091	Saved state. Next time it is powered up, this state will
7092	be restored and the machine will continue its execution from
7093	the place where it was saved.
7094
7095	This operation differs from taking a snapshot to the effect
7096	that it doesn't create new differencing media. Also, once
7097	the machine is powered up from the state saved using this method,
7098	the saved state is deleted, so it will be impossible to return
7099	to this state later.
7100
7101	<note>
7102	On success, this method implicitly calls
7103	<link to="IMachine::saveSettings"/> to save all current machine
7104	settings (including runtime changes to the DVD medium, etc.).
7105	Together with the impossibility to change any VM settings when it is
7106	in the Saved state, this guarantees adequate hardware
7107	configuration of the machine when it is restored from the saved
7108	state file.
7109	</note>
7110
7111	<note>
7112	The machine must be in the Running or Paused state, otherwise
7113	the operation will fail.
7114	</note>
7115	<result name="VBOX_E_INVALID_VM_STATE">
7116	Virtual machine state neither Running nor Paused.
7117	</result>
7118	<result name="VBOX_E_FILE_ERROR">
7119	Failed to create directory for saved state file.
7120	</result>
7121
7122	<see><link to="#takeSnapshot"/></see>
7123	</desc>
7124	<param name="progress" type="IProgress" dir="return">
7125	<desc>Progress object to track the operation completion.</desc>
7126	</param>
7127	</method>
7128
7129	<method name="adoptSavedState">
7130	<desc>
7131	Associates the given saved state file to the virtual machine.
7132
7133	On success, the machine will go to the Saved state. Next time it is
7134	powered up, it will be restored from the adopted saved state and
7135	continue execution from the place where the saved state file was
7136	created.
7137
7138	The specified saved state file path may be absolute or relative to the
7139	folder the VM normally saves the state to (usually,
7140	<link to="IMachine::snapshotFolder"/>).
7141
7142	<note>
7143	It's a caller's responsibility to make sure the given saved state
7144	file is compatible with the settings of this virtual machine that
7145	represent its virtual hardware (memory size, storage disk configuration
7146	etc.). If there is a mismatch, the behavior of the virtual machine
7147	is undefined.
7148	</note>
7149	<result name="VBOX_E_INVALID_VM_STATE">
7150	Virtual machine state neither PoweredOff nor Aborted.
7151	</result>
7152	</desc>
7153	<param name="savedStateFile" type="wstring" dir="in">
7154	<desc>Path to the saved state file to adopt.</desc>
7155	</param>
7156	</method>
7157
7158	<method name="discardSavedState">
7159	<desc>
7160	Forcibly resets the machine to "Powered Off" state if it is
7161	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7162	Next time the machine is powered up, a clean boot will occur.
7163	<note>
7164	This operation is equivalent to resetting or powering off
7165	the machine without doing a proper shutdown of the guest
7166	operating system; as with resetting a running phyiscal
7167	computer, it can can lead to data loss.
7168	</note>
7169	If @a fRemoveFile is @c true, the file in the machine directory
7170	into which the machine state was saved is also deleted. If
7171	this is @c false, then the state can be recovered and later
7172	re-inserted into a machine using <link to="#adoptSavedState" />.
7173	The location of the file can be found in the
7174	<link to="IMachine::stateFilePath" /> attribute.
7175	<result name="VBOX_E_INVALID_VM_STATE">
7176	Virtual machine not in state Saved.
7177	</result>
7178	</desc>
7179	<param name="fRemoveFile" type="boolean" dir="in" >
7180	<desc>Whether to also remove the saved state file.</desc>
7181	</param>
7182	</method>
7183
7184	<method name="getDeviceActivity">
7185	<desc>
7186	Gets the current activity type of a given device or device group.
7187	<result name="E_INVALIDARG">
7188	Invalid device type.
7189	</result>
7190	</desc>
7191	<param name="type" type="DeviceType" dir="in"/>
7192	<param name="activity" type="DeviceActivity" dir="return"/>
7193	</method>
7194
7195	<method name="attachUSBDevice">
7196	<desc>
7197	Attaches a host USB device with the given UUID to the
7198	USB controller of the virtual machine.
7199
7200	The device needs to be in one of the following states:
7201	<link to="USBDeviceState_Busy"/>,
7202	<link to="USBDeviceState_Available"/> or
7203	<link to="USBDeviceState_Held"/>,
7204	otherwise an error is immediately returned.
7205
7206	When the device state is
7207	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7208	be returned if the host computer refuses to release it for some reason.
7209
7210	<see><link to="IUSBController::deviceFilters"/>,
7211	<link to="USBDeviceState"/></see>
7212	<result name="VBOX_E_INVALID_VM_STATE">
7213	Virtual machine state neither Running nor Paused.
7214	</result>
7215	<result name="VBOX_E_PDM_ERROR">
7216	Virtual machine does not have a USB controller.
7217	</result>
7218	</desc>
7219	<param name="id" type="uuid" mod="string" dir="in">
7220	<desc>UUID of the host USB device to attach.</desc>
7221	</param>
7222	</method>
7223
7224	<method name="detachUSBDevice">
7225	<desc>
7226	Detaches an USB device with the given UUID from the USB controller
7227	of the virtual machine.
7228
7229	After this method succeeds, the VirtualBox server re-initiates
7230	all USB filters as if the device were just physically attached
7231	to the host, but filters of this machine are ignored to avoid
7232	a possible automatic re-attachment.
7233
7234	<see><link to="IUSBController::deviceFilters"/>,
7235	<link to="USBDeviceState"/></see>
7236
7237	<result name="VBOX_E_PDM_ERROR">
7238	Virtual machine does not have a USB controller.
7239	</result>
7240	<result name="E_INVALIDARG">
7241	USB device not attached to this virtual machine.
7242	</result>
7243	</desc>
7244	<param name="id" type="uuid" mod="string" dir="in">
7245	<desc>UUID of the USB device to detach.</desc>
7246	</param>
7247	<param name="device" type="IUSBDevice" dir="return">
7248	<desc>Detached USB device.</desc>
7249	</param>
7250	</method>
7251
7252	<method name="findUSBDeviceByAddress">
7253	<desc>
7254	Searches for a USB device with the given host address.
7255
7256	<result name="VBOX_E_OBJECT_NOT_FOUND">
7257	Given @c name does not correspond to any USB device.
7258	</result>
7259
7260	<see><link to="IUSBDevice::address"/></see>
7261	</desc>
7262	<param name="name" type="wstring" dir="in">
7263	<desc>
7264	Address of the USB device (as assigned by the host) to
7265	search for.
7266	</desc>
7267	</param>
7268	<param name="device" type="IUSBDevice" dir="return">
7269	<desc>Found USB device object.</desc>
7270	</param>
7271	</method>
7272
7273	<method name="findUSBDeviceById">
7274	<desc>
7275	Searches for a USB device with the given UUID.
7276
7277	<result name="VBOX_E_OBJECT_NOT_FOUND">
7278	Given @c id does not correspond to any USB device.
7279	</result>
7280
7281	<see><link to="IUSBDevice::id"/></see>
7282	</desc>
7283	<param name="id" type="uuid" mod="string" dir="in">
7284	<desc>UUID of the USB device to search for.</desc>
7285	</param>
7286	<param name="device" type="IUSBDevice" dir="return">
7287	<desc>Found USB device object.</desc>
7288	</param>
7289	</method>
7290
7291	<method name="createSharedFolder">
7292	<desc>
7293	Creates a transient new shared folder by associating the given logical
7294	name with the given host path, adds it to the collection of shared
7295	folders and starts sharing it. Refer to the description of
7296	<link to="ISharedFolder"/> to read more about logical names.
7297
7298	<result name="VBOX_E_INVALID_VM_STATE">
7299	Virtual machine in Saved state or currently changing state.
7300	</result>
7301	<result name="VBOX_E_FILE_ERROR">
7302	Shared folder already exists or not accessible.
7303	</result>
7304	</desc>
7305	<param name="name" type="wstring" dir="in">
7306	<desc>Unique logical name of the shared folder.</desc>
7307	</param>
7308	<param name="hostPath" type="wstring" dir="in">
7309	<desc>Full path to the shared folder in the host file system.</desc>
7310	</param>
7311	<param name="writable" type="boolean" dir="in">
7312	<desc>Whether the share is writable or readonly</desc>
7313	</param>
7314	<param name="automount" type="boolean" dir="in">
7315	<desc>Whether the share gets automatically mounted by the guest
7316	or not.</desc>
7317	</param>
7318	</method>
7319
7320	<method name="removeSharedFolder">
7321	<desc>
7322	Removes a transient shared folder with the given name previously
7323	created by <link to="#createSharedFolder"/> from the collection of
7324	shared folders and stops sharing it.
7325	<result name="VBOX_E_INVALID_VM_STATE">
7326	Virtual machine in Saved state or currently changing state.
7327	</result>
7328	<result name="VBOX_E_FILE_ERROR">
7329	Shared folder does not exists.
7330	</result>
7331	</desc>
7332	<param name="name" type="wstring" dir="in">
7333	<desc>Logical name of the shared folder to remove.</desc>
7334	</param>
7335	</method>
7336
7337	<method name="takeSnapshot">
7338	<desc>
7339	Saves the current execution state
7340	and all settings of the machine and creates differencing images
7341	for all normal (non-independent) media.
7342	See <link to="ISnapshot" /> for an introduction to snapshots.
7343
7344	This method can be called for a PoweredOff, Saved (see
7345	<link to="#saveState"/>), Running or
7346	Paused virtual machine. When the machine is PoweredOff, an
7347	offline snapshot is created. When the machine is Running a live
7348	snapshot is created, and an online snapshot is created when Paused.
7349
7350	The taken snapshot is always based on the
7351	<link to="IMachine::currentSnapshot">current snapshot</link>
7352	of the associated virtual machine and becomes a new current snapshot.
7353
7354	<note>
7355	This method implicitly calls <link to="IMachine::saveSettings"/> to
7356	save all current machine settings before taking an offline snapshot.
7357	</note>
7358
7359	<result name="VBOX_E_INVALID_VM_STATE">
7360	Virtual machine currently changing state.
7361	</result>
7362	</desc>
7363	<param name="name" type="wstring" dir="in">
7364	<desc>Short name for the snapshot.</desc>
7365	</param>
7366	<param name="description" type="wstring" dir="in">
7367	<desc>Optional description of the snapshot.</desc>
7368	</param>
7369	<param name="progress" type="IProgress" dir="return">
7370	<desc>Progress object to track the operation completion.</desc>
7371	</param>
7372	</method>
7373
7374	<method name="deleteSnapshot">
7375	<desc>
7376	Starts deleting the specified snapshot asynchronously.
7377	See <link to="ISnapshot" /> for an introduction to snapshots.
7378
7379	The execution state and settings of the associated machine stored in
7380	the snapshot will be deleted. The contents of all differencing media of
7381	this snapshot will be merged with the contents of their dependent child
7382	media to keep the medium chain valid (in other words, all changes
7383	represented by media being deleted will be propagated to their child
7384	medium). After that, this snapshot's differencing medium will be
7385	deleted. The parent of this snapshot will become a new parent for all
7386	its child snapshots.
7387
7388	If the deleted snapshot is the current one, its parent snapshot will
7389	become a new current snapshot. The current machine state is not directly
7390	affected in this case, except that currently attached differencing
7391	media based on media of the deleted snapshot will be also merged as
7392	described above.
7393
7394	If the deleted snapshot is the first or current snapshot, then the
7395	respective IMachine attributes will be adjusted. Deleting the current
7396	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7397	to make all current machine settings permanent.
7398
7399	Deleting a snapshot has the following preconditions:
7400
7401	<ul>
7402	<li>Child media of all normal media of the deleted snapshot
7403	must be accessible (see <link to="IMedium::state"/>) for this
7404	operation to succeed. If only one running VM refers to all images
7405	which participates in merging the operation can be performed while
7406	the VM is running. Otherwise all virtual machines whose media are
7407	directly or indirectly based on the media of deleted snapshot must
7408	be powered off. In any case, online snapshot deleting usually is
7409	slower than the same operation without any running VM.</li>
7410
7411	<li>You cannot delete the snapshot if a medium attached to it has
7412	more than one child medium (differencing images) because otherwise
7413	merging would be impossible. This might be the case if there is
7414	more than one child snapshot or differencing images were created
7415	for other reason (e.g. implicitly because of multiple machine
7416	attachments).</li>
7417	</ul>
7418
7419	The virtual machine's <link to="IMachine::state">state</link> is
7420	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7421	"DeletingSnapshotPaused" while this operation is in progress.
7422
7423	<note>
7424	Merging medium contents can be very time and disk space
7425	consuming, if these media are big in size and have many
7426	children. However, if the snapshot being deleted is the last
7427	(head) snapshot on the branch, the operation will be rather
7428	quick.
7429	</note>
7430	<result name="VBOX_E_INVALID_VM_STATE">
7431	The running virtual machine prevents deleting this snapshot. This
7432	happens only in very specific situations, usually snapshots can be
7433	deleted without trouble while a VM is running. The error message
7434	text explains the reason for the failure.
7435	</result>
7436	</desc>
7437	<param name="id" type="uuid" mod="string" dir="in">
7438	<desc>UUID of the snapshot to delete.</desc>
7439	</param>
7440	<param name="progress" type="IProgress" dir="return">
7441	<desc>Progress object to track the operation completion.</desc>
7442	</param>
7443	</method>
7444
7445	<method name="deleteSnapshotAndAllChildren">
7446	<desc>
7447	Starts deleting the specified snapshot and all its children
7448	asynchronously. See <link to="ISnapshot" /> for an introduction to
7449	snapshots. The conditions and many details are the same as with
7450	<link to="#deleteSnapshot"/>.
7451
7452	This operation is very fast if the snapshot subtree does not include
7453	the current state. It is still significantly faster than deleting the
7454	snapshots one by one if the current state is in the subtree and there
7455	are more than one snapshots from current state to the snapshot which
7456	marks the subtree, since it eliminates the incremental image merging.
7457
7458	<note>This API method is right now not implemented!</note>
7459
7460	<result name="VBOX_E_INVALID_VM_STATE">
7461	The running virtual machine prevents deleting this snapshot. This
7462	happens only in very specific situations, usually snapshots can be
7463	deleted without trouble while a VM is running. The error message
7464	text explains the reason for the failure.
7465	</result>
7466	<result name="E_NOTIMPL">
7467	The method is not implemented yet.
7468	</result>
7469	</desc>
7470	<param name="id" type="uuid" mod="string" dir="in">
7471	<desc>UUID of the snapshot to delete, including all its children.</desc>
7472	</param>
7473	<param name="progress" type="IProgress" dir="return">
7474	<desc>Progress object to track the operation completion.</desc>
7475	</param>
7476	</method>
7477
7478	<method name="deleteSnapshotRange">
7479	<desc>
7480	Starts deleting the specified snapshot range. This is limited to
7481	linear snapshot lists, which means there may not be any other child
7482	snapshots other than the direct sequence between the start and end
7483	snapshot. If the start and end snapshot point to the same snapshot this
7484	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7485	<link to="ISnapshot" /> for an introduction to snapshots. The
7486	conditions and many details are the same as with
7487	<link to="#deleteSnapshot"/>.
7488
7489	This operation is generally faster than deleting snapshots one by one
7490	and often also needs less extra disk space before freeing up disk space
7491	by deleting the removed disk images corresponding to the snapshot.
7492
7493	<note>This API method is right now not implemented!</note>
7494
7495	<result name="VBOX_E_INVALID_VM_STATE">
7496	The running virtual machine prevents deleting this snapshot. This
7497	happens only in very specific situations, usually snapshots can be
7498	deleted without trouble while a VM is running. The error message
7499	text explains the reason for the failure.
7500	</result>
7501	<result name="E_NOTIMPL">
7502	The method is not implemented yet.
7503	</result>
7504	</desc>
7505	<param name="startId" type="uuid" mod="string" dir="in">
7506	<desc>UUID of the first snapshot to delete.</desc>
7507	</param>
7508	<param name="endId" type="uuid" mod="string" dir="in">
7509	<desc>UUID of the last snapshot to delete.</desc>
7510	</param>
7511	<param name="progress" type="IProgress" dir="return">
7512	<desc>Progress object to track the operation completion.</desc>
7513	</param>
7514	</method>
7515
7516	<method name="restoreSnapshot">
7517	<desc>
7518	Starts resetting the machine's current state to the state contained
7519	in the given snapshot, asynchronously. All current settings of the
7520	machine will be reset and changes stored in differencing media
7521	will be lost.
7522	See <link to="ISnapshot" /> for an introduction to snapshots.
7523
7524	After this operation is successfully completed, new empty differencing
7525	media are created for all normal media of the machine.
7526
7527	If the given snapshot is an online snapshot, the machine will go to
7528	the <link to="MachineState_Saved"> saved state</link>, so that the
7529	next time it is powered on, the execution state will be restored
7530	from the state of the snapshot.
7531
7532	<note>
7533	The machine must not be running, otherwise the operation will fail.
7534	</note>
7535
7536	<note>
7537	If the machine state is <link to="MachineState_Saved">Saved</link>
7538	prior to this operation, the saved state file will be implicitly
7539	deleted (as if <link to="IConsole::discardSavedState"/> were
7540	called).
7541	</note>
7542
7543	<result name="VBOX_E_INVALID_VM_STATE">
7544	Virtual machine is running.
7545	</result>
7546	</desc>
7547	<param name="snapshot" type="ISnapshot" dir="in">
7548	<desc>The snapshot to restore the VM state from.</desc>
7549	</param>
7550	<param name="progress" type="IProgress" dir="return">
7551	<desc>Progress object to track the operation completion.</desc>
7552	</param>
7553	</method>
7554
7555	<method name="teleport">
7556	<desc>
7557	Teleport the VM to a different host machine or process.
7558
7559	TODO explain the details.
7560
7561	<result name="VBOX_E_INVALID_VM_STATE">
7562	Virtual machine not running or paused.
7563	</result>
7564	</desc>
7565	<param name="hostname" type="wstring" dir="in">
7566	<desc>The name or IP of the host to teleport to.</desc>
7567	</param>
7568	<param name="tcpport" type="unsigned long" dir="in">
7569	<desc>The TCP port to connect to (1..65535).</desc>
7570	</param>
7571	<param name="password" type="wstring" dir="in">
7572	<desc>The password.</desc>
7573	</param>
7574	<param name="maxDowntime" type="unsigned long" dir="in">
7575	<desc>
7576	The maximum allowed downtime given as milliseconds. 0 is not a valid
7577	value. Recommended value: 250 ms.
7578
7579	The higher the value is, the greater the chance for a successful
7580	teleportation. A small value may easily result in the teleportation
7581	process taking hours and eventually fail.
7582
7583	<note>
7584	The current implementation treats this a guideline, not as an
7585	absolute rule.
7586	</note>
7587	</desc>
7588	</param>
7589	<param name="progress" type="IProgress" dir="return">
7590	<desc>Progress object to track the operation completion.</desc>
7591	</param>
7592	</method>
7593
7594	</interface>
7595
7596	<!--
7597	// IHost
7598	/////////////////////////////////////////////////////////////////////////
7599	-->
7600
7601	<enum
7602	name="HostNetworkInterfaceMediumType"
7603	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7604	>
7605	<desc>
7606	Type of encapsulation. Ethernet encapsulation includes both wired and
7607	wireless Ethernet connections.
7608	<see><link to="IHostNetworkInterface"/></see>
7609	</desc>
7610
7611	<const name="Unknown" value="0">
7612	<desc>
7613	The type of interface cannot be determined.
7614	</desc>
7615	</const>
7616	<const name="Ethernet" value="1">
7617	<desc>
7618	Ethernet frame encapsulation.
7619	</desc>
7620	</const>
7621	<const name="PPP" value="2">
7622	<desc>
7623	Point-to-point protocol encapsulation.
7624	</desc>
7625	</const>
7626	<const name="SLIP" value="3">
7627	<desc>
7628	Serial line IP encapsulation.
7629	</desc>
7630	</const>
7631	</enum>
7632
7633	<enum
7634	name="HostNetworkInterfaceStatus"
7635	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7636	>
7637	<desc>
7638	Current status of the interface.
7639	<see><link to="IHostNetworkInterface"/></see>
7640	</desc>
7641
7642	<const name="Unknown" value="0">
7643	<desc>
7644	The state of interface cannot be determined.
7645	</desc>
7646	</const>
7647	<const name="Up" value="1">
7648	<desc>
7649	The interface is fully operational.
7650	</desc>
7651	</const>
7652	<const name="Down" value="2">
7653	<desc>
7654	The interface is not functioning.
7655	</desc>
7656	</const>
7657	</enum>
7658
7659	<enum
7660	name="HostNetworkInterfaceType"
7661	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7662	>
7663	<desc>
7664	Network interface type.
7665	</desc>
7666	<const name="Bridged" value="1"/>
7667	<const name="HostOnly" value="2"/>
7668	</enum>
7669
7670	<interface
7671	name="IHostNetworkInterface" extends="$unknown"
7672	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7673	wsmap="managed"
7674	>
7675	<desc>
7676	Represents one of host's network interfaces. IP V6 address and network
7677	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7678	separated by colons.
7679	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7680	</desc>
7681	<attribute name="name" type="wstring" readonly="yes">
7682	<desc>Returns the host network interface name.</desc>
7683	</attribute>
7684
7685	<attribute name="id" type="uuid" mod="string" readonly="yes">
7686	<desc>Returns the interface UUID.</desc>
7687	</attribute>
7688
7689	<attribute name="networkName" type="wstring" readonly="yes">
7690	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7691	</attribute>
7692
7693	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7694	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7695	</attribute>
7696
7697	<attribute name="IPAddress" type="wstring" readonly="yes">
7698	<desc>Returns the IP V4 address of the interface.</desc>
7699	</attribute>
7700
7701	<attribute name="networkMask" type="wstring" readonly="yes">
7702	<desc>Returns the network mask of the interface.</desc>
7703	</attribute>
7704
7705	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7706	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7707	</attribute>
7708
7709	<attribute name="IPV6Address" type="wstring" readonly="yes">
7710	<desc>Returns the IP V6 address of the interface.</desc>
7711	</attribute>
7712
7713	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7714	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7715	</attribute>
7716
7717	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7718	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7719	</attribute>
7720
7721	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7722	<desc>Type of protocol encapsulation used.</desc>
7723	</attribute>
7724
7725	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7726	<desc>Status of the interface.</desc>
7727	</attribute>
7728
7729	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7730	<desc>specifies the host interface type.</desc>
7731	</attribute>
7732
7733	<method name="enableStaticIPConfig">
7734	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7735	<param name="IPAddress" type="wstring" dir="in">
7736	<desc>
7737	IP address.
7738	</desc>
7739	</param>
7740	<param name="networkMask" type="wstring" dir="in">
7741	<desc>
7742	network mask.
7743	</desc>
7744	</param>
7745	</method>
7746
7747	<method name="enableStaticIPConfigV6">
7748	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7749	<param name="IPV6Address" type="wstring" dir="in">
7750	<desc>
7751	IP address.
7752	</desc>
7753	</param>
7754	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7755	<desc>
7756	network mask.
7757	</desc>
7758	</param>
7759	</method>
7760
7761	<method name="enableDynamicIPConfig">
7762	<desc>enables the dynamic IP configuration.</desc>
7763	</method>
7764
7765	<method name="DHCPRediscover">
7766	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7767	</method>
7768
7769	</interface>
7770
7771	<interface
7772	name="IHost" extends="$unknown"
7773	uuid="30678943-32df-4830-b413-931b25ac86a0"
7774	wsmap="managed"
7775	>
7776	<desc>
7777	The IHost interface represents the physical machine that this VirtualBox
7778	installation runs on.
7779
7780	An object implementing this interface is returned by the
7781	<link to="IVirtualBox::host" /> attribute. This interface contains
7782	read-only information about the host's physical hardware (such as what
7783	processors and disks are available, what the host operating system is,
7784	and so on) and also allows for manipulating some of the host's hardware,
7785	such as global USB device filters and host interface networking.
7786
7787	</desc>
7788	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7789	<desc>List of DVD drives available on the host.</desc>
7790	</attribute>
7791
7792	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7793	<desc>List of floppy drives available on the host.</desc>
7794	</attribute>
7795
7796	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7797	<desc>
7798	List of USB devices currently attached to the host.
7799	Once a new device is physically attached to the host computer,
7800	it appears in this list and remains there until detached.
7801
7802	<note>
7803	If USB functionality is not available in the given edition of
7804	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7805	</note>
7806	</desc>
7807	</attribute>
7808
7809	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7810	<desc>
7811	List of USB device filters in action.
7812	When a new device is physically attached to the host computer,
7813	filters from this list are applied to it (in order they are stored
7814	in the list). The first matched filter will determine the
7815	<link to="IHostUSBDeviceFilter::action">action</link>
7816	performed on the device.
7817
7818	Unless the device is ignored by these filters, filters of all
7819	currently running virtual machines
7820	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7821
7822	<note>
7823	If USB functionality is not available in the given edition of
7824	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7825	</note>
7826
7827	<see><link to="IHostUSBDeviceFilter"/>,
7828	<link to="USBDeviceState"/></see>
7829	</desc>
7830	</attribute>
7831
7832	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7833	<desc>List of host network interfaces currently defined on the host.</desc>
7834	</attribute>
7835
7836	<attribute name="processorCount" type="unsigned long" readonly="yes">
7837	<desc>Number of (logical) CPUs installed in the host system.</desc>
7838	</attribute>
7839
7840	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7841	<desc>Number of (logical) CPUs online in the host system.</desc>
7842	</attribute>
7843
7844	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7845	<desc>Number of physical processor cores installed in the host system.</desc>
7846	</attribute>
7847
7848	<method name="getProcessorSpeed">
7849	<desc>Query the (approximate) maximum speed of a specified host CPU in
7850	Megahertz.
7851	</desc>
7852	<param name="cpuId" type="unsigned long" dir="in">
7853	<desc>
7854	Identifier of the CPU.
7855	</desc>
7856	</param>
7857	<param name="speed" type="unsigned long" dir="return">
7858	<desc>
7859	Speed value. 0 is returned if value is not known or @a cpuId is
7860	invalid.
7861	</desc>
7862	</param>
7863	</method>
7864
7865	<method name="getProcessorFeature">
7866	<desc>Query whether a CPU feature is supported or not.</desc>
7867	<param name="feature" type="ProcessorFeature" dir="in">
7868	<desc>
7869	CPU Feature identifier.
7870	</desc>
7871	</param>
7872	<param name="supported" type="boolean" dir="return">
7873	<desc>
7874	Feature is supported or not.
7875	</desc>
7876	</param>
7877	</method>
7878
7879	<method name="getProcessorDescription">
7880	<desc>Query the model string of a specified host CPU.
7881	</desc>
7882	<param name="cpuId" type="unsigned long" dir="in">
7883	<desc>
7884	Identifier of the CPU.
7885	<note>
7886	The current implementation might not necessarily return the
7887	description for this exact CPU.
7888	</note>
7889	</desc>
7890	</param>
7891	<param name="description" type="wstring" dir="return">
7892	<desc>
7893	Model string. An empty string is returned if value is not known or
7894	@a cpuId is invalid.
7895	</desc>
7896	</param>
7897	</method>
7898
7899	<method name="getProcessorCPUIDLeaf">
7900	<desc>
7901	Returns the CPU cpuid information for the specified leaf.
7902	</desc>
7903	<param name="cpuId" type="unsigned long" dir="in">
7904	<desc>
7905	Identifier of the CPU. The CPU most be online.
7906	<note>
7907	The current implementation might not necessarily return the
7908	description for this exact CPU.
7909	</note>
7910	</desc>
7911	</param>
7912	<param name="leaf" type="unsigned long" dir="in">
7913	<desc>
7914	CPUID leaf index (eax).
7915	</desc>
7916	</param>
7917	<param name="subLeaf" type="unsigned long" dir="in">
7918	<desc>
7919	CPUID leaf sub index (ecx). This currently only applies to cache
7920	information on Intel CPUs. Use 0 if retrieving values for
7921	<link to="IMachine::setCPUIDLeaf"/>.
7922	</desc>
7923	</param>
7924	<param name="valEax" type="unsigned long" dir="out">
7925	<desc>
7926	CPUID leaf value for register eax.
7927	</desc>
7928	</param>
7929	<param name="valEbx" type="unsigned long" dir="out">
7930	<desc>
7931	CPUID leaf value for register ebx.
7932	</desc>
7933	</param>
7934	<param name="valEcx" type="unsigned long" dir="out">
7935	<desc>
7936	CPUID leaf value for register ecx.
7937	</desc>
7938	</param>
7939	<param name="valEdx" type="unsigned long" dir="out">
7940	<desc>
7941	CPUID leaf value for register edx.
7942	</desc>
7943	</param>
7944	</method>
7945
7946	<attribute name="memorySize" type="unsigned long" readonly="yes">
7947	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7948	</attribute>
7949
7950	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7951	<desc>Available system memory in the host system.</desc>
7952	</attribute>
7953
7954	<attribute name="operatingSystem" type="wstring" readonly="yes">
7955	<desc>Name of the host system's operating system.</desc>
7956	</attribute>
7957
7958	<attribute name="OSVersion" type="wstring" readonly="yes">
7959	<desc>Host operating system's version string.</desc>
7960	</attribute>
7961
7962	<attribute name="UTCTime" type="long long" readonly="yes">
7963	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7964	</attribute>
7965
7966	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
7967	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7968	</attribute>
7969
7970	<method name="createHostOnlyNetworkInterface">
7971	<desc>
7972	Creates a new adapter for Host Only Networking.
7973	<result name="E_INVALIDARG">
7974	Host network interface @a name already exists.
7975	</result>
7976	</desc>
7977	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7978	<desc>
7979	Created host interface object.
7980	</desc>
7981	</param>
7982	<param name="progress" type="IProgress" dir="return">
7983	<desc>
7984	Progress object to track the operation completion.
7985	</desc>
7986	</param>
7987	</method>
7988
7989	<method name="removeHostOnlyNetworkInterface">
7990	<desc>
7991	Removes the given Host Only Networking interface.
7992	<result name="VBOX_E_OBJECT_NOT_FOUND">
7993	No host network interface matching @a id found.
7994	</result>
7995	</desc>
7996	<param name="id" type="uuid" mod="string" dir="in">
7997	<desc>
7998	Adapter GUID.
7999	</desc>
8000	</param>
8001	<param name="progress" type="IProgress" dir="return">
8002	<desc>
8003	Progress object to track the operation completion.
8004	</desc>
8005	</param>
8006	</method>
8007
8008	<method name="createUSBDeviceFilter">
8009	<desc>
8010	Creates a new USB device filter. All attributes except
8011	the filter name are set to empty (any match),
8012	<i>active</i> is @c false (the filter is not active).
8013
8014	The created filter can be added to the list of filters using
8015	<link to="#insertUSBDeviceFilter"/>.
8016
8017	<see><link to="#USBDeviceFilters"/></see>
8018	</desc>
8019	<param name="name" type="wstring" dir="in">
8020	<desc>
8021	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8022	</desc>
8023	</param>
8024	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8025	<desc>Created filter object.</desc>
8026	</param>
8027	</method>
8028
8029	<method name="insertUSBDeviceFilter">
8030	<desc>
8031	Inserts the given USB device to the specified position
8032	in the list of filters.
8033
8034	Positions are numbered starting from @c 0. If the specified
8035	position is equal to or greater than the number of elements in
8036	the list, the filter is added at the end of the collection.
8037
8038	<note>
8039	Duplicates are not allowed, so an attempt to insert a
8040	filter already in the list is an error.
8041	</note>
8042	<note>
8043	If USB functionality is not available in the given edition of
8044	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8045	</note>
8046
8047	<see><link to="#USBDeviceFilters"/></see>
8048
8049	<result name="VBOX_E_INVALID_OBJECT_STATE">
8050	USB device filter is not created within this VirtualBox instance.
8051	</result>
8052	<result name="E_INVALIDARG">
8053	USB device filter already in list.
8054	</result>
8055
8056	</desc>
8057	<param name="position" type="unsigned long" dir="in">
8058	<desc>Position to insert the filter to.</desc>
8059	</param>
8060	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8061	<desc>USB device filter to insert.</desc>
8062	</param>
8063	</method>
8064
8065	<method name="removeUSBDeviceFilter">
8066	<desc>
8067	Removes a USB device filter from the specified position in the
8068	list of filters.
8069
8070	Positions are numbered starting from @c 0. Specifying a
8071	position equal to or greater than the number of elements in
8072	the list will produce an error.
8073
8074	<note>
8075	If USB functionality is not available in the given edition of
8076	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8077	</note>
8078
8079	<see><link to="#USBDeviceFilters"/></see>
8080
8081	<result name="E_INVALIDARG">
8082	USB device filter list empty or invalid @a position.
8083	</result>
8084
8085	</desc>
8086	<param name="position" type="unsigned long" dir="in">
8087	<desc>Position to remove the filter from.</desc>
8088	</param>
8089	</method>
8090
8091	<method name="findHostDVDDrive">
8092	<desc>
8093	Searches for a host DVD drive with the given @c name.
8094
8095	<result name="VBOX_E_OBJECT_NOT_FOUND">
8096	Given @c name does not correspond to any host drive.
8097	</result>
8098
8099	</desc>
8100	<param name="name" type="wstring" dir="in">
8101	<desc>Name of the host drive to search for</desc>
8102	</param>
8103	<param name="drive" type="IMedium" dir="return">
8104	<desc>Found host drive object</desc>
8105	</param>
8106	</method>
8107
8108	<method name="findHostFloppyDrive">
8109	<desc>
8110	Searches for a host floppy drive with the given @c name.
8111
8112	<result name="VBOX_E_OBJECT_NOT_FOUND">
8113	Given @c name does not correspond to any host floppy drive.
8114	</result>
8115
8116	</desc>
8117	<param name="name" type="wstring" dir="in">
8118	<desc>Name of the host floppy drive to search for</desc>
8119	</param>
8120	<param name="drive" type="IMedium" dir="return">
8121	<desc>Found host floppy drive object</desc>
8122	</param>
8123	</method>
8124
8125	<method name="findHostNetworkInterfaceByName">
8126	<desc>
8127	Searches through all host network interfaces for an interface with
8128	the given @c name.
8129	<note>
8130	The method returns an error if the given @c name does not
8131	correspond to any host network interface.
8132	</note>
8133	</desc>
8134	<param name="name" type="wstring" dir="in">
8135	<desc>Name of the host network interface to search for.</desc>
8136	</param>
8137	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8138	<desc>Found host network interface object.</desc>
8139	</param>
8140	</method>
8141	<method name="findHostNetworkInterfaceById">
8142	<desc>
8143	Searches through all host network interfaces for an interface with
8144	the given GUID.
8145	<note>
8146	The method returns an error if the given GUID does not
8147	correspond to any host network interface.
8148	</note>
8149	</desc>
8150	<param name="id" type="uuid" mod="string" dir="in">
8151	<desc>GUID of the host network interface to search for.</desc>
8152	</param>
8153	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8154	<desc>Found host network interface object.</desc>
8155	</param>
8156	</method>
8157	<method name="findHostNetworkInterfacesOfType">
8158	<desc>
8159	Searches through all host network interfaces and returns a list of interfaces of the specified type
8160	</desc>
8161	<param name="type" type="HostNetworkInterfaceType" dir="in">
8162	<desc>type of the host network interfaces to search for.</desc>
8163	</param>
8164	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8165	<desc>Found host network interface objects.</desc>
8166	</param>
8167	</method>
8168
8169	<method name="findUSBDeviceById">
8170	<desc>
8171	Searches for a USB device with the given UUID.
8172
8173	<result name="VBOX_E_OBJECT_NOT_FOUND">
8174	Given @c id does not correspond to any USB device.
8175	</result>
8176
8177	<see><link to="IUSBDevice::id"/></see>
8178	</desc>
8179	<param name="id" type="uuid" mod="string" dir="in">
8180	<desc>UUID of the USB device to search for.</desc>
8181	</param>
8182	<param name="device" type="IHostUSBDevice" dir="return">
8183	<desc>Found USB device object.</desc>
8184	</param>
8185	</method>
8186
8187	<method name="findUSBDeviceByAddress">
8188	<desc>
8189	Searches for a USB device with the given host address.
8190
8191	<result name="VBOX_E_OBJECT_NOT_FOUND">
8192	Given @c name does not correspond to any USB device.
8193	</result>
8194
8195	<see><link to="IUSBDevice::address"/></see>
8196	</desc>
8197	<param name="name" type="wstring" dir="in">
8198	<desc>
8199	Address of the USB device (as assigned by the host) to
8200	search for.
8201	</desc>
8202	</param>
8203	<param name="device" type="IHostUSBDevice" dir="return">
8204	<desc>Found USB device object.</desc>
8205	</param>
8206	</method>
8207
8208	<method name="generateMACAddress">
8209	<desc>
8210	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8211	</desc>
8212	<param name="address" type="wstring" dir="return">
8213	<desc>New Ethernet MAC address.</desc>
8214	</param>
8215	</method>
8216
8217	</interface>
8218
8219	<!--
8220	// ISystemProperties
8221	/////////////////////////////////////////////////////////////////////////
8222	-->
8223
8224	<interface
8225	name="ISystemProperties"
8226	extends="$unknown"
8227	uuid="1d7aca29-97f0-4287-9874-a60ec4f80ea6"
8228	wsmap="managed"
8229	>
8230	<desc>
8231	The ISystemProperties interface represents global properties of the given
8232	VirtualBox installation.
8233
8234	These properties define limits and default values for various attributes
8235	and parameters. Most of the properties are read-only, but some can be
8236	changed by a user.
8237	</desc>
8238
8239	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8240	<desc>Minimum guest system memory in Megabytes.</desc>
8241	</attribute>
8242
8243	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8244	<desc>Maximum guest system memory in Megabytes.</desc>
8245	</attribute>
8246
8247	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8248	<desc>Minimum guest video memory in Megabytes.</desc>
8249	</attribute>
8250
8251	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8252	<desc>Maximum guest video memory in Megabytes.</desc>
8253	</attribute>
8254
8255	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8256	<desc>Minimum CPU count.</desc>
8257	</attribute>
8258
8259	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8260	<desc>Maximum CPU count.</desc>
8261	</attribute>
8262
8263	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8264	<desc>Maximum of monitors which could be connected.</desc>
8265	</attribute>
8266
8267	<attribute name="infoVDSize" type="long long" readonly="yes">
8268	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8269	does not reflect the limits of any virtual disk image format.</desc>
8270	</attribute>
8271
8272	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8273	<desc>
8274	Maximum number of serial ports associated with every
8275	<link to="IMachine"/> instance.
8276	</desc>
8277	</attribute>
8278
8279	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8280	<desc>
8281	Maximum number of parallel ports associated with every
8282	<link to="IMachine"/> instance.
8283	</desc>
8284	</attribute>
8285
8286	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8287	<desc>
8288	Maximum device position in the boot order. This value corresponds
8289	to the total number of devices a machine can boot from, to make it
8290	possible to include all possible devices to the boot list.
8291	<see><link to="IMachine::setBootOrder"/></see>
8292	</desc>
8293	</attribute>
8294
8295	<attribute name="defaultMachineFolder" type="wstring">
8296	<desc>
8297	Full path to the default directory used to create new or open
8298	existing machines when a machine settings file name contains no
8299	path.
8300
8301	Starting with VirtualBox 4.0, by default, this attribute contains
8302	the full path of folder named "VirtualBox VMs" in the user's
8303	home directory, which depends on the host platform.
8304
8305	When setting this attribute, a full path must be specified.
8306	Setting this property to @c null or an empty string or the
8307	special value "Machines" (for compatibility reasons) will restore
8308	that default value.
8309
8310	If the folder specified herein does not exist, it will be created
8311	automatically as needed.
8312
8313	<see>
8314	<link to="IVirtualBox::createMachine"/>,
8315	<link to="IVirtualBox::openMachine"/>
8316	</see>
8317	</desc>
8318	</attribute>
8319
8320	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8321	<desc>
8322	List of all medium storage formats supported by this VirtualBox
8323	installation.
8324
8325	Keep in mind that the medium format identifier
8326	(<link to="IMediumFormat::id"/>) used in other API calls like
8327	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8328	medium format is a case-insensitive string. This means that, for
8329	example, all of the following strings:
8330	<pre>
8331	"VDI"
8332	"vdi"
8333	"VdI"</pre>
8334	refer to the same medium format.
8335
8336	Note that the virtual medium framework is backend-based, therefore
8337	the list of supported formats depends on what backends are currently
8338	installed.
8339
8340	<see><link to="IMediumFormat"/></see>
8341	</desc>
8342	</attribute>
8343
8344	<attribute name="defaultHardDiskFormat" type="wstring">
8345	<desc>
8346	Identifier of the default medium format used by VirtualBox.
8347
8348	The medium format set by this attribute is used by VirtualBox
8349	when the medium format was not specified explicitly. One example is
8350	<link to="IVirtualBox::createHardDisk"/> with the empty
8351	format argument. A more complex example is implicit creation of
8352	differencing media when taking a snapshot of a virtual machine:
8353	this operation will try to use a format of the parent medium first
8354	and if this format does not support differencing media the default
8355	format specified by this argument will be used.
8356
8357	The list of supported medium formats may be obtained by the
8358	<link to="#mediumFormats"/> call. Note that the default medium
8359	format must have a capability to create differencing media;
8360	otherwise operations that create media implicitly may fail
8361	unexpectedly.
8362
8363	The initial value of this property is <tt>"VDI"</tt> in the current
8364	version of the VirtualBox product, but may change in the future.
8365
8366	<note>
8367	Setting this property to @c null or empty string will restore the
8368	initial value.
8369	</note>
8370
8371	<see>
8372	<link to="#mediumFormats"/>,
8373	<link to="IMediumFormat::id"/>,
8374	<link to="IVirtualBox::createHardDisk"/>
8375	</see>
8376	</desc>
8377	</attribute>
8378
8379	<attribute name="freeDiskSpaceWarning" type="long long">
8380	<desc>Issue a warning if the free disk space is below (or in some disk
8381	intensive operation is expected to go below) the given size in
8382	bytes.</desc>
8383	</attribute>
8384
8385	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8386	<desc>Issue a warning if the free disk space is below (or in some disk
8387	intensive operation is expected to go below) the given percentage.</desc>
8388	</attribute>
8389
8390	<attribute name="freeDiskSpaceError" type="long long">
8391	<desc>Issue an error if the free disk space is below (or in some disk
8392	intensive operation is expected to go below) the given size in
8393	bytes.</desc>
8394	</attribute>
8395
8396	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8397	<desc>Issue an error if the free disk space is below (or in some disk
8398	intensive operation is expected to go below) the given percentage.</desc>
8399	</attribute>
8400
8401	<attribute name="VRDEAuthLibrary" type="wstring">
8402	<desc>
8403	Library that provides authentication for Remote Desktop clients. The library
8404	is used if a virtual machine's authentication type is set to "external"
8405	in the VM RemoteDisplay configuration.
8406
8407	The system library extension (".DLL" or ".so") must be omitted.
8408	A full path can be specified; if not, then the library must reside on the
8409	system's default library path.
8410
8411	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8412	of that name in one of the default VirtualBox library directories.
8413
8414	For details about VirtualBox authentication libraries and how to implement
8415	them, please refer to the VirtualBox manual.
8416
8417	<note>
8418	Setting this property to @c null or empty string will restore the
8419	initial value.
8420	</note>
8421	</desc>
8422	</attribute>
8423
8424	<attribute name="webServiceAuthLibrary" type="wstring">
8425	<desc>
8426	Library that provides authentication for webservice clients. The library
8427	is used if a virtual machine's authentication type is set to "external"
8428	in the VM RemoteDisplay configuration and will be called from
8429	within the <link to="IWebsessionManager::logon" /> implementation.
8430
8431	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8432	there is no per-VM setting for this, as the webservice is a global
8433	resource (if it is running). Only for this setting (for the webservice),
8434	setting this value to a literal <tt>"null"</tt> string disables authentication,
8435	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8436	no matter what user name and password are supplied.
8437
8438	The initial value of this property is <tt>"VBoxAuth"</tt>,
8439	meaning that the webservice will use the same authentication
8440	library that is used by default for VRDE (again, see
8441	<link to="ISystemProperties::VRDEAuthLibrary" />).
8442	The format and calling convention of authentication libraries
8443	is the same for the webservice as it is for VRDE.
8444
8445	<note>
8446	Setting this property to @c null or empty string will restore the
8447	initial value.
8448	</note>
8449	</desc>
8450	</attribute>
8451
8452	<attribute name="defaultVRDEExtPack" type="wstring">
8453	<desc>
8454	The name of the extension pack providing the default VRDE.
8455
8456	This attribute is for choosing between multiple extension packs
8457	providing VRDE. If only one is installed, it will automatically be the
8458	default one. The attribute value can be empty if no VRDE extension
8459	pack is installed.
8460
8461	For details about VirtualBox Remote Desktop Extension and how to
8462	implement one, please refer to the VirtualBox SDK.
8463	</desc>
8464	</attribute>
8465
8466	<attribute name="logHistoryCount" type="unsigned long">
8467	<desc>
8468	This value specifies how many old release log files are kept.
8469	</desc>
8470	</attribute>
8471
8472	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8473	<desc>This value hold the default audio driver for the current
8474	system.</desc>
8475	</attribute>
8476
8477	<attribute name="autostartDatabasePath" type="wstring">
8478	<desc>
8479	The path to the autostart database. Depending on the host this might
8480	be a filesystem path or something else.
8481	</desc>
8482	</attribute>
8483
8484	<attribute name="defaultAdditionsISO" type="wstring">
8485	<desc>
8486	The path to the default Guest Additions ISO image. Can be empty if
8487	the location is not known in this installation.
8488	</desc>
8489	</attribute>
8490
8491	<method name="getMaxNetworkAdapters">
8492	<desc>
8493	Maximum total number of network adapters associated with every
8494	<link to="IMachine"/> instance.
8495	</desc>
8496
8497	<param name="chipset" type="ChipsetType" dir="in">
8498	<desc>The chipset type to get the value for.</desc>
8499	</param>
8500
8501
8502	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8503	<desc>The maximum total number of network adapters allowed.</desc>
8504	</param>
8505
8506	</method>
8507
8508	<method name="getMaxNetworkAdaptersOfType">
8509	<desc>
8510	Maximum number of network adapters of a given attachment type,
8511	associated with every <link to="IMachine"/> instance.
8512	</desc>
8513
8514	<param name="chipset" type="ChipsetType" dir="in">
8515	<desc>The chipset type to get the value for.</desc>
8516	</param>
8517
8518	<param name="type" type="NetworkAttachmentType" dir="in">
8519	<desc>Type of attachment.</desc>
8520	</param>
8521
8522	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8523	<desc>The maximum number of network adapters allowed for
8524	particular chipset and attachment type.</desc>
8525	</param>
8526
8527	</method>
8528
8529
8530	<method name="getMaxDevicesPerPortForStorageBus">
8531	<desc>Returns the maximum number of devices which can be attached to a port
8532	for the given storage bus.</desc>
8533
8534	<param name="bus" type="StorageBus" dir="in">
8535	<desc>The storage bus type to get the value for.</desc>
8536	</param>
8537
8538	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8539	<desc>The maximum number of devices which can be attached to the port for the given
8540	storage bus.</desc>
8541	</param>
8542	</method>
8543
8544	<method name="getMinPortCountForStorageBus">
8545	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8546
8547	<param name="bus" type="StorageBus" dir="in">
8548	<desc>The storage bus type to get the value for.</desc>
8549	</param>
8550
8551	<param name="minPortCount" type="unsigned long" dir="return">
8552	<desc>The minimum number of ports for the given storage bus.</desc>
8553	</param>
8554	</method>
8555
8556	<method name="getMaxPortCountForStorageBus">
8557	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8558
8559	<param name="bus" type="StorageBus" dir="in">
8560	<desc>The storage bus type to get the value for.</desc>
8561	</param>
8562
8563	<param name="maxPortCount" type="unsigned long" dir="return">
8564	<desc>The maximum number of ports for the given storage bus.</desc>
8565	</param>
8566	</method>
8567
8568	<method name="getMaxInstancesOfStorageBus">
8569	<desc>Returns the maximum number of storage bus instances which
8570	can be configured for each VM. This corresponds to the number of
8571	storage controllers one can have. Value may depend on chipset type
8572	used.</desc>
8573
8574	<param name="chipset" type="ChipsetType" dir="in">
8575	<desc>The chipset type to get the value for.</desc>
8576	</param>
8577
8578	<param name="bus" type="StorageBus" dir="in">
8579	<desc>The storage bus type to get the value for.</desc>
8580	</param>
8581
8582	<param name="maxInstances" type="unsigned long" dir="return">
8583	<desc>The maximum number of instances for the given storage bus.</desc>
8584	</param>
8585	</method>
8586
8587	<method name="getDeviceTypesForStorageBus">
8588	<desc>Returns list of all the supported device types
8589	(<link to="DeviceType"/>) for the given type of storage
8590	bus.</desc>
8591
8592	<param name="bus" type="StorageBus" dir="in">
8593	<desc>The storage bus type to get the value for.</desc>
8594	</param>
8595
8596	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8597	<desc>The list of all supported device types for the given storage bus.</desc>
8598	</param>
8599	</method>
8600
8601	<method name="getDefaultIoCacheSettingForStorageController">
8602	<desc>Returns the default I/O cache setting for the
8603	given storage controller</desc>
8604
8605	<param name="controllerType" type="StorageControllerType" dir="in">
8606	<desc>The storage controller to the setting for.</desc>
8607	</param>
8608
8609	<param name="enabled" type="boolean" dir="return">
8610	<desc>Returned flag indicating the default value</desc>
8611	</param>
8612	</method>
8613	</interface>
8614
8615	<!--
8616	// IGuest
8617	/////////////////////////////////////////////////////////////////////////
8618	-->
8619
8620	<interface
8621	name="IGuestOSType" extends="$unknown"
8622	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8623	wsmap="struct"
8624	>
8625	<desc>
8626	</desc>
8627
8628	<attribute name="familyId" type="wstring" readonly="yes">
8629	<desc>Guest OS family identifier string.</desc>
8630	</attribute>
8631
8632	<attribute name="familyDescription" type="wstring" readonly="yes">
8633	<desc>Human readable description of the guest OS family.</desc>
8634	</attribute>
8635
8636	<attribute name="id" type="wstring" readonly="yes">
8637	<desc>Guest OS identifier string.</desc>
8638	</attribute>
8639
8640	<attribute name="description" type="wstring" readonly="yes">
8641	<desc>Human readable description of the guest OS.</desc>
8642	</attribute>
8643
8644	<attribute name="is64Bit" type="boolean" readonly="yes">
8645	<desc>Returns @c true if the given OS is 64-bit</desc>
8646	</attribute>
8647
8648	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8649	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8650	</attribute>
8651
8652	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8653	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8654	</attribute>
8655
8656	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8657	<desc>Recommended RAM size in Megabytes.</desc>
8658	</attribute>
8659
8660	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8661	<desc>Recommended video RAM size in Megabytes.</desc>
8662	</attribute>
8663
8664	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8665	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8666	</attribute>
8667
8668	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8669	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8670	</attribute>
8671
8672	<attribute name="recommendedHDD" type="long long" readonly="yes">
8673	<desc>Recommended hard disk size in bytes.</desc>
8674	</attribute>
8675
8676	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8677	<desc>Returns recommended network adapter for this OS type.</desc>
8678	</attribute>
8679
8680	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8681	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8682	</attribute>
8683
8684	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8685	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8686	</attribute>
8687
8688	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8689	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8690	</attribute>
8691
8692	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8693	<desc>Recommended storage controller type for HD drives.</desc>
8694	</attribute>
8695
8696	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8697	<desc>Recommended storage bus type for HD drives.</desc>
8698	</attribute>
8699
8700	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8701	<desc>Recommended firmware type.</desc>
8702	</attribute>
8703
8704	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8705	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8706	</attribute>
8707
8708	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8709	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8710	</attribute>
8711
8712	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8713	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8714	</attribute>
8715
8716	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8717	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8718	</attribute>
8719
8720	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8721	<desc>Recommended chipset type.</desc>
8722	</attribute>
8723
8724	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8725	<desc>Recommended audio type.</desc>
8726	</attribute>
8727
8728	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8729	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8730	</attribute>
8731
8732	<attribute name="recommendedUSB" type="boolean" readonly="yes">
8733	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8734	</attribute>
8735
8736	</interface>
8737
8738	<enum
8739	name="AdditionsFacilityType"
8740	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8741	>
8742	<desc>
8743	Guest Additions facility IDs.
8744	</desc>
8745
8746	<const name="None" value="0">
8747	<desc>No/invalid facility.</desc>
8748	</const>
8749	<const name="VBoxGuestDriver" value="20">
8750	<desc>VirtualBox base driver (VBoxGuest).</desc>
8751	</const>
8752	<const name="AutoLogon" value="90">
8753	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8754	</const>
8755	<const name="VBoxService" value="100">
8756	<desc>VirtualBox system service (VBoxService).</desc>
8757	</const>
8758	<const name="VBoxTrayClient" value="101">
8759	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8760	</const>
8761	<const name="Seamless" value="1000">
8762	<desc>Seamless guest desktop integration.</desc>
8763	</const>
8764	<const name="Graphics" value="1100">
8765	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8766	are not immediately acted on and guest display resizes are probably not initiated by
8767	the guest additions.
8768	</desc>
8769	</const>
8770	<const name="All" value="2147483646">
8771	<desc>All facilities selected.</desc>
8772	</const>
8773	</enum>
8774
8775	<enum
8776	name="AdditionsFacilityClass"
8777	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8778	>
8779	<desc>
8780	Guest Additions facility classes.
8781	</desc>
8782
8783	<const name="None" value="0">
8784	<desc>No/invalid class.</desc>
8785	</const>
8786	<const name="Driver" value="10">
8787	<desc>Driver.</desc>
8788	</const>
8789	<const name="Service" value="30">
8790	<desc>System service.</desc>
8791	</const>
8792	<const name="Program" value="50">
8793	<desc>Program.</desc>
8794	</const>
8795	<const name="Feature" value="100">
8796	<desc>Feature.</desc>
8797	</const>
8798	<const name="ThirdParty" value="999">
8799	<desc>Third party.</desc>
8800	</const>
8801	<const name="All" value="2147483646">
8802	<desc>All facility classes selected.</desc>
8803	</const>
8804	</enum>
8805
8806	<enum
8807	name="AdditionsFacilityStatus"
8808	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8809	>
8810	<desc>
8811	Guest Additions facility states.
8812	</desc>
8813
8814	<const name="Inactive" value="0">
8815	<desc>Facility is not active.</desc>
8816	</const>
8817	<const name="Paused" value="1">
8818	<desc>Facility has been paused.</desc>
8819	</const>
8820	<const name="PreInit" value="20">
8821	<desc>Facility is preparing to initialize.</desc>
8822	</const>
8823	<const name="Init" value="30">
8824	<desc>Facility is initializing.</desc>
8825	</const>
8826	<const name="Active" value="50">
8827	<desc>Facility is up and running.</desc>
8828	</const>
8829	<const name="Terminating" value="100">
8830	<desc>Facility is shutting down.</desc>
8831	</const>
8832	<const name="Terminated" value="101">
8833	<desc>Facility successfully shut down.</desc>
8834	</const>
8835	<const name="Failed" value="800">
8836	<desc>Facility failed to start.</desc>
8837	</const>
8838	<const name="Unknown" value="999">
8839	<desc>Facility status is unknown.</desc>
8840	</const>
8841	</enum>
8842
8843	<interface
8844	name="IAdditionsFacility" extends="$unknown"
8845	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8846	wsmap="struct"
8847	>
8848	<desc>
8849	Structure representing a Guest Additions facility.
8850	</desc>
8851
8852	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8853	<desc>The class this facility is part of.</desc>
8854	</attribute>
8855
8856	<attribute name="lastUpdated" type="long long" readonly="yes">
8857	<desc>
8858	Time stamp of the last status update,
8859	in milliseconds since 1970-01-01 UTC.
8860	</desc>
8861	</attribute>
8862
8863	<attribute name="name" type="wstring" readonly="yes">
8864	<desc>The facility's friendly name.</desc>
8865	</attribute>
8866
8867	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8868	<desc>The current status.</desc>
8869	</attribute>
8870
8871	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8872	<desc>The facility's type ID.</desc>
8873	</attribute>
8874	</interface>
8875
8876	<enum
8877	name="AdditionsRunLevelType"
8878	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8879	>
8880	<desc>
8881	Guest Additions run level type.
8882	</desc>
8883
8884	<const name="None" value="0">
8885	<desc>Guest Additions are not loaded.</desc>
8886	</const>
8887	<const name="System" value="1">
8888	<desc>Guest drivers are loaded.</desc>
8889	</const>
8890	<const name="Userland" value="2">
8891	<desc>Common components (such as application services) are loaded.</desc>
8892	</const>
8893	<const name="Desktop" value="3">
8894	<desc>Per-user desktop components are loaded.</desc>
8895	</const>
8896	</enum>
8897
8898	<enum
8899	name="AdditionsUpdateFlag"
8900	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8901	>
8902	<desc>
8903	Guest Additions update flags.
8904	</desc>
8905
8906	<const name="None" value="0">
8907	<desc>No flag set.</desc>
8908	</const>
8909	<const name="WaitForUpdateStartOnly" value="1">
8910	<desc>Only wait for the update process being started and do not
8911	wait while peforming the actual update.</desc>
8912	</const>
8913	</enum>
8914
8915	<enum
8916	name="FileSeekType"
8917	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
8918	>
8919	<desc>
8920	File seeking types.
8921	</desc>
8922
8923	<const name="Set" value="0">
8924	<desc>Seek from the start of the file.</desc>
8925	</const>
8926	<const name="Current" value="1">
8927	<desc>Seek from the current file position.</desc>
8928	</const>
8929	</enum>
8930
8931	<enum
8932	name="ProcessInputFlag"
8933	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8934	>
8935	<desc>
8936	Guest process input flags.
8937	</desc>
8938	<const name="None" value="0">
8939	<desc>No flag set.</desc>
8940	</const>
8941	<const name="EndOfFile" value="1">
8942	<desc>End of file (input) reached.</desc>
8943	</const>
8944	</enum>
8945
8946	<enum
8947	name="ProcessOutputFlag"
8948	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8949	>
8950	<desc>
8951	Guest process output flags for specifying which
8952	type of output to retrieve.
8953	</desc>
8954	<const name="None" value="0">
8955	<desc>No flags set. Get output from stdout.</desc>
8956	</const>
8957	<const name="StdErr" value="1">
8958	<desc>Get output from stderr.</desc>
8959	</const>
8960	</enum>
8961
8962	<enum
8963	name="ProcessWaitForFlag"
8964	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
8965	>
8966	<desc>
8967	Process waiting flags. Multiple flags can be combined.
8968	</desc>
8969
8970	<const name="None" value="0">
8971	<desc>No waiting flags specified. Do not use this.</desc>
8972	</const>
8973	<const name="Start" value="1">
8974	<desc>Wait for the process being started.</desc>
8975	</const>
8976	<const name="Terminate" value="2">
8977	<desc>Wait for the process being terminated.</desc>
8978	</const>
8979	<const name="StdIn" value="4">
8980	<desc>Wait for stdin becoming available.</desc>
8981	</const>
8982	<const name="StdOut" value="8">
8983	<desc>Wait for data becoming available on stdout.</desc>
8984	</const>
8985	<const name="StdErr" value="16">
8986	<desc>Wait for data becoming available on stderr.</desc>
8987	</const>
8988	</enum>
8989
8990	<enum
8991	name="ProcessWaitResult"
8992	uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
8993	>
8994	<desc>
8995	Process waiting results. Depending on the process waiting flags (for
8996	more information see <link to="ProcessWaitForFlag"/>) the waiting result
8997	can vary based on the processes' current status.
8998
8999	To wait for a gust process to terminate after it has been
9000	created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9001	one would specify ProcessWaitResult_Terminate.
9002
9003	If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9004	a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9005	stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9006	ProcessWaitResult_StdErr.
9007	</desc>
9008
9009	<const name="None" value="0">
9010	<desc>No result was returned. Not being used.</desc>
9011	</const>
9012	<const name="Start" value="1">
9013	<desc>The process has been started.</desc>
9014	</const>
9015	<const name="Terminate" value="2">
9016	<desc>The process has been terminated.</desc>
9017	</const>
9018	<const name="Status" value="3">
9019	<desc>
9020	The process has changed its status. The status then can
9021	be retrieved via <link to="IProcess::status"/>.
9022	</desc>
9023	</const>
9024	<const name="Error" value="4">
9025	<desc>Error while executing the process.</desc>
9026	</const>
9027	<const name="Timeout" value="5">
9028	<desc>
9029	The waiting operation timed out. This also will happen
9030	when no event has been occured matching the specified the
9031	current waiting flags in the <link to="IProcess::waitFor"/> call.
9032	</desc>
9033	</const>
9034	<const name="StdIn" value="6">
9035	<desc>
9036	The process signalled that stdin became available for writing
9037	and that the process awaits input now.</desc>
9038	</const>
9039	<const name="StdOut" value="7">
9040	<desc>Data on stdout became available for reading.</desc>
9041	</const>
9042	<const name="StdErr" value="8">
9043	<desc>Data on stderr became available for reading.</desc>
9044	</const>
9045	<const name="WaitFlagNotSupported" value="9">
9046	<desc>
9047	A waiting flag specified in the <link to="IProcess::waitFor"/> call
9048	is not supported by the guest.
9049	</desc>
9050	</const>
9051	</enum>
9052
9053	<enum
9054	name="CopyFileFlag"
9055	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9056	>
9057	<desc>
9058	File copying flags.
9059	</desc>
9060	<const name="None" value="0">
9061	<desc>No flag set.</desc>
9062	</const>
9063	<const name="Recursive" value="1">
9064	<desc>Copy directories recursively.</desc>
9065	</const>
9066	<const name="Update" value="2">
9067	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9068	</const>
9069	<const name="FollowLinks" value="4">
9070	<desc>Follow symbolic links.</desc>
9071	</const>
9072	</enum>
9073
9074	<enum
9075	name="DirectoryCreateFlag"
9076	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9077	>
9078	<desc>
9079	Directory creation flags.
9080	</desc>
9081	<const name="None" value="0">
9082	<desc>No flag set.</desc>
9083	</const>
9084	<const name="Parents" value="1">
9085	<desc>No error if existing, make parent directories as needed.</desc>
9086	</const>
9087	</enum>
9088
9089	<enum
9090	name="DirectoryRemoveRecFlag"
9091	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9092	>
9093	<desc>
9094	Directory recursive removement flags.
9095	</desc>
9096
9097	<const name="None" value="0">
9098	<desc>No flag set.</desc>
9099	</const>
9100	<const name="ContentAndDir" value="1">
9101	<desc>Delete the content of the directory and the directory itself.</desc>
9102	</const>
9103	<const name="ContentOnly" value="2">
9104	<desc>Only delete the content of the directory, omit the directory it self.</desc>
9105	</const>
9106	</enum>
9107
9108	<enum
9109	name="PathRenameFlag"
9110	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9111	>
9112	<desc>
9113	Path renaming flags.
9114	</desc>
9115
9116	<const name="None" value="0">
9117	<desc>No flag set.</desc>
9118	</const>
9119	<const name="NoReplace" value="1">
9120	<desc>Do not replace anything.</desc>
9121	</const>
9122	<const name="Replace" value="2">
9123	<desc>This will replace attempt any target which isn't a directory.</desc>
9124	</const>
9125	<const name="NoSymlinks" value="4">
9126	<desc>Don't allow symbolic links as part of the path.</desc>
9127	</const>
9128	</enum>
9129
9130	<enum
9131	name="ProcessCreateFlag"
9132	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9133	>
9134	<desc>
9135	Guest process execution flags.
9136	</desc>
9137
9138	<const name="None" value="0">
9139	<desc>No flag set.</desc>
9140	</const>
9141	<const name="WaitForProcessStartOnly" value="1">
9142	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9143	process itself then uses an infinite timeout.</desc>
9144	</const>
9145	<const name="IgnoreOrphanedProcesses" value="2">
9146	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9147	</const>
9148	<const name="Hidden" value="4">
9149	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9150	</const>
9151	<const name="NoProfile" value="8">
9152	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9153	</const>
9154	<const name="WaitForStdOut" value="16">
9155	<desc>The guest process waits until all data from stdout is read out.</desc>
9156	</const>
9157	<const name="WaitForStdErr" value="32">
9158	<desc>The guest process waits until all data from stderr is read out.</desc>
9159	</const>
9160	<const name="ExpandArguments" value="64">
9161	<desc>Expands environment variables in process arguments.</desc>
9162	</const>
9163	</enum>
9164
9165	<enum
9166	name="ProcessPriority"
9167	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9168	>
9169	<desc>
9170	Process priorities.
9171	</desc>
9172
9173	<const name="Invalid" value="0">
9174	<desc>Invalid priority, do not use.</desc>
9175	</const>
9176	<const name="Default" value="1">
9177	<desc>Default process priority determined by the OS.</desc>
9178	</const>
9179	</enum>
9180
9181	<enum
9182	name="SymlinkType"
9183	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9184	>
9185	<desc>
9186	Symbolic link types.
9187	</desc>
9188
9189	<const name="Unknown" value="0">
9190	<desc>It is not known what is being targeted.</desc>
9191	</const>
9192	<const name="Directory" value="1">
9193	<desc>The link targets a directory.</desc>
9194	</const>
9195	<const name="File" value="2">
9196	<desc>The link targets a file (or whatever else).</desc>
9197	</const>
9198	</enum>
9199
9200	<enum
9201	name="SymlinkReadFlag"
9202	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9203	>
9204	<desc>
9205	Symbolic link reading flags.
9206	</desc>
9207
9208	<const name="None" value="0">
9209	<desc>No flags set.</desc>
9210	</const>
9211	<const name="NoSymlinks" value="1">
9212	<desc>Don't allow symbolic links as part of the path.</desc>
9213	</const>
9214	</enum>
9215
9216	<enum
9217	name="ProcessStatus"
9218	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9219	>
9220	<desc>
9221	Process execution statuses.
9222	</desc>
9223	<const name="Undefined" value="0">
9224	<desc>Process is in an undefined state.</desc>
9225	</const>
9226
9227	<const name="Starting" value="10">
9228	<desc>Process is being started.</desc>
9229	</const>
9230	<const name="Started" value="100">
9231	<desc>Process has been started.</desc>
9232	</const>
9233	<const name="Paused" value="110">
9234	<desc>Process has been paused.</desc>
9235	</const>
9236	<const name="Terminating" value="480">
9237	<desc>Process is being terminated.</desc>
9238	</const>
9239	<const name="TerminatedNormally" value="500">
9240	<desc>Process terminated normally.</desc>
9241	</const>
9242	<const name="TerminatedSignal" value="510">
9243	<desc>Process terminated via signal.</desc>
9244	</const>
9245	<const name="TerminatedAbnormally" value="511">
9246	<desc>Process terminated abnormally.</desc>
9247	</const>
9248	<const name="TimedOutKilled" value="512">
9249	<desc>Process timed out and was killed.</desc>
9250	</const>
9251	<const name="TimedOutAbnormally" value="513">
9252	<desc>Process timed out and was not killed successfully.</desc>
9253	</const>
9254	<const name="Down" value="600">
9255	<desc>Service/OS is stopping, process was killed.</desc>
9256	</const>
9257	<const name="Error" value="800">
9258	<desc>Something went wrong.</desc>
9259	</const>
9260	</enum>
9261
9262	<enum
9263	name="FsObjType"
9264	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9265	>
9266	<desc>
9267	File system object type.
9268	</desc>
9269
9270	<const name="Undefined" value="0">
9271	<desc>Type is undefined / unknown.</desc>
9272	</const>
9273	<const name="FIFO" value="1">
9274	<desc>Named pipe.</desc>
9275	</const>
9276	<const name="DevChar" value="10">
9277	<desc>Character device.</desc>
9278	</const>
9279	<const name="DevBlock" value="11">
9280	<desc>Block device.</desc>
9281	</const>
9282	<const name="Directory" value="50">
9283	<desc>Directory.</desc>
9284	</const>
9285	<const name="File" value="80">
9286	<desc>File.</desc>
9287	</const>
9288	<const name="Symlink" value="100">
9289	<desc>Symlink.</desc>
9290	</const>
9291	<const name="Socket" value="200">
9292	<desc>Socket.</desc>
9293	</const>
9294	<const name="Whiteout" value="400">
9295	<desc>Whiteout.</desc>
9296	</const>
9297	</enum>
9298
9299	<enum
9300	name="DragAndDropAction"
9301	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9302	>
9303	<desc>
9304	Possible actions within an Drag and Drop operation.
9305	</desc>
9306
9307	<const name="Ignore" value="0">
9308	<desc>Do nothing.</desc>
9309	</const>
9310
9311	<const name="Copy" value="1">
9312	<desc>Copy the item to the target.</desc>
9313	</const>
9314
9315	<const name="Move" value="2">
9316	<desc>Move the item to the target.</desc>
9317	</const>
9318
9319	<const name="Link" value="3">
9320	<desc>Link the item from within the target.</desc>
9321	</const>
9322	</enum>
9323
9324	<enum
9325	name="DirectoryOpenFlag"
9326	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9327	>
9328	<desc>
9329	Directory open flags.
9330	</desc>
9331	<const name="None" value="0">
9332	<desc>No flag set.</desc>
9333	</const>
9334	<const name="NoSymlinks" value="1">
9335	<desc>Don't allow symbolic links as part of the path.</desc>
9336	</const>
9337	</enum>
9338
9339	<interface
9340	name="IGuestSession" extends="$unknown"
9341	uuid="57eb82a8-822b-42c1-9d1c-5c54bc3d3250"
9342	wsmap="managed"
9343	>
9344	<desc>
9345	A guest session represents one impersonated user account on the guest, so
9346	every operation will use the same credentials specified when creating
9347	the session object via <link to="IGuest::createSession"/>.
9348
9349	There can be a maximum of 32 sessions at once per VM. Each session keeps
9350	track of its started guest processes, opened guest files or guest directories.
9351	To work on guest files or directories a guest session offers methods to open
9352	or create such objects (see <link to="IGuestSession::fileOpen"/> or
9353	<link to="IGuestSession::directoryOpen"/> for example).
9354
9355	When done with either of these objects, including the guest session itself,
9356	use the appropriate close() method to let the object do its cleanup work.
9357
9358	Every guest session has its own environment variable block which gets
9359	automatically applied when starting a new guest process via
9360	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9361	To override (or unset) certain environment variables already set by the
9362	guest session, one can specify a per-process environment block when using
9363	one of the both above mentioned process creation calls.
9364	</desc>
9365
9366	<attribute name="user" type="wstring" readonly="yes">
9367	<desc>Returns the user name used by this session to impersonate
9368	users on the guest.
9369	</desc>
9370	</attribute>
9371
9372	<attribute name="domain" type="wstring" readonly="yes">
9373	<desc>Returns the domain name used by this session to impersonate
9374	users on the guest.
9375	</desc>
9376	</attribute>
9377
9378	<attribute name="name" type="wstring" readonly="yes">
9379	<desc>Returns the session's friendly name.</desc>
9380	</attribute>
9381
9382	<attribute name="id" type="unsigned long" readonly="yes">
9383	<desc>Returns the internal session ID.</desc>
9384	</attribute>
9385
9386	<attribute name="timeout" type="unsigned long" readonly="no">
9387	<desc>
9388	Returns the session timeout (in ms).
9389	<result name="E_NOTIMPL">
9390	The method is not implemented yet.
9391	</result>
9392	</desc>
9393	</attribute>
9394
9395	<attribute name="environment" type="wstring" safearray="yes">
9396	<desc>
9397	Returns the current session environment.
9398	</desc>
9399	</attribute>
9400
9401	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9402	<desc>
9403	Returns all current guest processes.
9404	</desc>
9405	</attribute>
9406
9407	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9408	<desc>
9409	Returns all currently opened guest directories.
9410	</desc>
9411	</attribute>
9412
9413	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9414	<desc>
9415	Returns all currently opened guest files.
9416	</desc>
9417	</attribute>
9418
9419	<method name="close">
9420	<desc>
9421	Closes this session. All opened guest directories, files and
9422	processes which are not referenced by clients anymore will be
9423	uninitialized.
9424	</desc>
9425	</method>
9426
9427	<method name="copyFrom">
9428	<desc>
9429	Copies a file from guest to the host.
9430
9431	<result name="VBOX_E_IPRT_ERROR">
9432	Error starting the copy operation.
9433	</result>
9434	</desc>
9435	<param name="source" type="wstring" dir="in">
9436	<desc>Source file on the guest to copy to the host.</desc>
9437	</param>
9438	<param name="dest" type="wstring" dir="in">
9439	<desc>Destination file name on the host.</desc>
9440	</param>
9441	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9442	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9443	</param>
9444	<param name="progress" type="IProgress" dir="return">
9445	<desc>Progress object to track the operation completion.</desc>
9446	</param>
9447	</method>
9448
9449	<method name="copyTo">
9450	<desc>
9451	Copies a file from host to the guest.
9452
9453	<result name="VBOX_E_IPRT_ERROR">
9454	Error starting the copy operation.
9455	</result>
9456	</desc>
9457	<param name="source" type="wstring" dir="in">
9458	<desc>Source file on the host to copy to the guest.</desc>
9459	</param>
9460	<param name="dest" type="wstring" dir="in">
9461	<desc>Destination file name on the guest.</desc>
9462	</param>
9463	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9464	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9465	</param>
9466	<param name="progress" type="IProgress" dir="return">
9467	<desc>Progress object to track the operation completion.</desc>
9468	</param>
9469	</method>
9470
9471	<method name="directoryCreate">
9472	<desc>
9473	Create a directory on the guest.
9474
9475	<result name="VBOX_E_IPRT_ERROR">
9476	Error while creating the directory.
9477	</result>
9478	</desc>
9479	<param name="path" type="wstring" dir="in">
9480	<desc>Full path of directory to create.</desc>
9481	</param>
9482	<param name="mode" type="unsigned long" dir="in">
9483	<desc>File creation mode.</desc>
9484	</param>
9485	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9486	<desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9487	</param>
9488	</method>
9489
9490	<method name="directoryCreateTemp">
9491	<desc>
9492	Create a temporary directory on the guest.
9493
9494	<result name="VBOX_E_NOT_SUPPORTED">
9495	The operation is not possible as requested on this particular
9496	guest type.
9497	</result>
9498	<result name="E_INVALIDARG">
9499	Invalid argument. This includes an incorrectly formatted template,
9500	or a non-absolute path.
9501	</result>
9502	<result name="VBOX_E_IPRT_ERROR">
9503	The temporary directory could not be created. Possible reasons
9504	include a non-existing path or an insecure path when the secure
9505	option was requested.
9506	</result>
9507	</desc>
9508	<param name="templateName" type="wstring" dir="in">
9509	<desc>Template for the name of the directory to create. This must
9510	contain at least one 'X' character. The first group of consecutive
9511	'X' characters in the template will be replaced by a random
9512	alphanumeric string to produce a unique name.</desc>
9513	</param>
9514	<param name="mode" type="unsigned long" dir="in">
9515	<desc>The mode of the directory to create. Use 0700 unless there are
9516	reasons not to. This parameter is ignored if "secure" is specified.
9517	</desc>
9518	</param>
9519	<param name="path" type="wstring" dir="in">
9520	<desc>The absolute path to create the temporary directory in.</desc>
9521	</param>
9522	<param name="secure" type="boolean" dir="in">
9523	<desc>Whether to fail if the directory can not be securely created.
9524	Currently this means that another unprivileged user cannot
9525	manipulate the path specified or remove the temporary directory
9526	after it has been created. Also causes the mode specified to be
9527	ignored. May not be supported on all guest types.</desc>
9528	</param>
9529	<param name="directory" type="wstring" dir="return">
9530	<desc>On success this will contain the name of the directory created
9531	with full path.</desc>
9532	</param>
9533	</method>
9534
9535	<method name="directoryExists">
9536	<desc>
9537	Checks whether a directory exists on the guest or not.
9538
9539	<result name="VBOX_E_IPRT_ERROR">
9540	Error while checking existence of the directory specified.
9541	</result>
9542	</desc>
9543	<param name="path" type="wstring" dir="in">
9544	<desc>Directory to check existence for.</desc>
9545	</param>
9546	<param name="exists" type="boolean" dir="return">
9547	<desc>Returns @c true if the directory exists, @c false if not.</desc>
9548	</param>
9549	</method>
9550
9551	<method name="directoryOpen">
9552	<desc>
9553	Opens a directory and creates a <link to="IGuestDirectory"/> object that
9554	can be used for further operations.
9555
9556	<result name="VBOX_E_OBJECT_NOT_FOUND">
9557	Directory to open was not found.
9558	</result>
9559	<result name="VBOX_E_IPRT_ERROR">
9560	Error while opening the directory.
9561	</result>
9562	</desc>
9563	<param name="path" type="wstring" dir="in">
9564	<desc>Full path to file to open.</desc>
9565	</param>
9566	<param name="filter" type="wstring" dir="in">
9567	<desc>Open filter to apply. This can include wildcards like ? and *.</desc>
9568	</param>
9569	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9570	<desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
9571	</param>
9572	<param name="directory" type="IGuestDirectory" dir="return">
9573	<desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
9574	</param>
9575	</method>
9576
9577	<method name="directoryQueryInfo">
9578	<desc>
9579	Queries information of a directory on the guest.
9580
9581	<result name="VBOX_E_OBJECT_NOT_FOUND">
9582	Directory to query information for was not found.
9583	</result>
9584	<result name="VBOX_E_IPRT_ERROR">
9585	Error querying information.
9586	</result>
9587	</desc>
9588	<param name="path" type="wstring" dir="in">
9589	<desc>Directory to query information for.</desc>
9590	</param>
9591	<param name="info" type="IGuestFsObjInfo" dir="return">
9592	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9593	</param>
9594	</method>
9595
9596	<method name="directoryRemove">
9597	<desc>
9598	Removes a guest directory if not empty.
9599
9600	<result name="E_NOTIMPL">
9601	The method is not implemented yet.
9602	</result>
9603	</desc>
9604	<param name="path" type="wstring" dir="in">
9605	<desc>Full path of directory to remove.</desc>
9606	</param>
9607	</method>
9608
9609	<method name="directoryRemoveRecursive">
9610	<desc>
9611	Removes a guest directory recursively.
9612
9613	<result name="E_NOTIMPL">
9614	The method is not implemented yet.
9615	</result>
9616	</desc>
9617	<param name="path" type="wstring" dir="in">
9618	<desc>Full path of directory to remove recursively.</desc>
9619	</param>
9620	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
9621	<desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
9622	</param>
9623	<param name="progress" type="IProgress" dir="return">
9624	<desc>Progress object to track the operation completion.</desc>
9625	</param>
9626	</method>
9627
9628	<method name="directoryRename">
9629	<desc>
9630	Renames a directory on the guest.
9631
9632	<result name="E_NOTIMPL">
9633	The method is not implemented yet.
9634	</result>
9635	</desc>
9636	<param name="source" type="wstring" dir="in">
9637	<desc>Source directory to rename.</desc>
9638	</param>
9639	<param name="dest" type="wstring" dir="in">
9640	<desc>Destination directory to rename the source to.</desc>
9641	</param>
9642	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9643	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9644	</param>
9645	</method>
9646
9647	<method name="directorySetACL">
9648	<desc>
9649	Sets the ACL (Access Control List) of a guest directory.
9650
9651	<result name="E_NOTIMPL">
9652	The method is not implemented yet.
9653	</result>
9654	</desc>
9655	<param name="path" type="wstring" dir="in">
9656	<desc>Full path of directory to set the ACL for.</desc>
9657	</param>
9658	<param name="acl" type="wstring" dir="in">
9659	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
9660	</param>
9661	</method>
9662
9663	<method name="environmentClear">
9664	<desc>
9665	Clears (deletes) all session environment variables.
9666
9667	<result name="VBOX_E_IPRT_ERROR">
9668	Error while clearing the session environment variables.
9669	</result>
9670	</desc>
9671	</method>
9672
9673	<method name="environmentGet">
9674	<desc>
9675	Gets the value of a session environment variable.
9676
9677	<result name="VBOX_E_IPRT_ERROR">
9678	Error while getting the value of the session environment variable.
9679	</result>
9680	</desc>
9681	<param name="name" type="wstring" dir="in">
9682	<desc>Name of session environment variable to get the value for.</desc>
9683	</param>
9684	<param name="value" type="wstring" dir="return">
9685	<desc>
9686	Value of the session environment variable specified. If this variable
9687	does not exist and empty value will be returned.
9688	</desc>
9689	</param>
9690	</method>
9691
9692	<method name="environmentSet">
9693	<desc>
9694	Sets a session environment variable.
9695
9696	<result name="VBOX_E_IPRT_ERROR">
9697	Error while setting the session environment variable.
9698	</result>
9699	</desc>
9700	<param name="name" type="wstring" dir="in">
9701	<desc>Name of session environment variable to set.</desc>
9702	</param>
9703	<param name="value" type="wstring" dir="in">
9704	<desc>Value to set the session environment variable to.</desc>
9705	</param>
9706	</method>
9707
9708	<method name="environmentUnset">
9709	<desc>
9710	Unsets session environment variable.
9711
9712	<result name="VBOX_E_IPRT_ERROR">
9713	Error while unsetting the session environment variable.
9714	</result>
9715	</desc>
9716	<param name="name" type="wstring" dir="in">
9717	<desc>Name of session environment variable to unset (clear).</desc>
9718	</param>
9719	</method>
9720
9721	<method name="fileCreateTemp">
9722	<desc>
9723	Creates a temporary file on the guest.
9724
9725	<result name="VBOX_E_NOT_SUPPORTED">
9726	The operation is not possible as requested on this particular
9727	guest type.
9728	</result>
9729	<result name="E_INVALIDARG">
9730	Invalid argument. This includes an incorrectly formatted template,
9731	or a non-absolute path.
9732	</result>
9733	<result name="VBOX_E_IPRT_ERROR">
9734	The temporary file could not be created. Possible reasons include
9735	a non-existing path or an insecure path when the secure
9736	option was requested.
9737	</result>
9738	</desc>
9739	<param name="templateName" type="wstring" dir="in">
9740	<desc>Template for the name of the file to create. This must contain
9741	at least one 'X' character. The first group of consecutive 'X'
9742	characters in the template will be replaced by a random
9743	alphanumeric string to produce a unique name.
9744	</desc>
9745	</param>
9746	<param name="mode" type="unsigned long" dir="in">
9747	<desc>The mode of the file to create. Use 0700 unless there are
9748	reasons not to. This parameter is ignored if "secure" is specified.
9749	</desc>
9750	</param>
9751	<param name="path" type="wstring" dir="in">
9752	<desc>The absolute path to create the temporary file in.</desc>
9753	</param>
9754	<param name="secure" type="boolean" dir="in">
9755	<desc>Whether to fail if the file can not be securely created.
9756	Currently this means that another unprivileged user cannot
9757	manipulate the path specified or remove the temporary file after
9758	it has been created. Also causes the mode specified to be ignored.
9759	May not be supported on all guest types.</desc>
9760	</param>
9761	<param name="file" type="IGuestFile" dir="return">
9762	<desc>On success this will contain an open file object for the new
9763	temporary file.
9764	</desc>
9765	</param>
9766	</method>
9767
9768	<method name="fileExists">
9769	<desc>
9770	Checks whether a file exists on the guest or not.
9771
9772	<result name="VBOX_E_IPRT_ERROR">
9773	Error while checking existence of the file specified.
9774	</result>
9775	</desc>
9776	<param name="path" type="wstring" dir="in">
9777	<desc>File to check existence for.</desc>
9778	</param>
9779	<param name="exists" type="boolean" dir="return">
9780	<desc>Returns @c true if the file exists, @c false if not.</desc>
9781	</param>
9782	</method>
9783
9784	<method name="fileRemove">
9785	<desc>
9786	Removes a single file on the guest.
9787
9788	<result name="VBOX_E_OBJECT_NOT_FOUND">
9789	File to remove was not found.
9790	</result>
9791	<result name="VBOX_E_IPRT_ERROR">
9792	Error while removing the file.
9793	</result>
9794	</desc>
9795	<param name="path" type="wstring" dir="in">
9796	<desc>Path to the file to remove.</desc>
9797	</param>
9798	</method>
9799
9800	<method name="fileOpen">
9801	<desc>
9802	Opens a file and creates a <link to="IGuestFile"/> object that
9803	can be used for further operations.
9804
9805	<result name="VBOX_E_OBJECT_NOT_FOUND">
9806	File to open was not found.
9807	</result>
9808	<result name="VBOX_E_IPRT_ERROR">
9809	Error while opening the file.
9810	</result>
9811	</desc>
9812	<param name="path" type="wstring" dir="in">
9813	<desc>Full path to file to open.</desc>
9814	</param>
9815	<param name="openMode" type="wstring" dir="in">
9816	<desc>The file open mode.</desc>
9817	</param>
9818	<param name="disposition" type="wstring" dir="in">
9819	<desc>The file disposition.</desc>
9820	</param>
9821	<param name="creationMode" type="unsigned long" dir="in">
9822	<desc>The file creation mode.</desc>
9823	</param>
9824	<param name="offset" type="long long" dir="in">
9825	<desc>The initial read/write offset.</desc>
9826	</param>
9827	<param name="file" type="IGuestFile" dir="return">
9828	<desc><link to="IGuestFile"/> object representing the opened file.</desc>
9829	</param>
9830	</method>
9831
9832	<method name="fileQueryInfo">
9833	<desc>
9834	Queries information of a file on the guest.
9835
9836	<result name="VBOX_E_OBJECT_NOT_FOUND">
9837	File to query information for was not found.
9838	</result>
9839	<result name="VBOX_E_IPRT_ERROR">
9840	Error querying information.
9841	</result>
9842	</desc>
9843	<param name="path" type="wstring" dir="in">
9844	<desc>File to query information for.</desc>
9845	</param>
9846	<param name="info" type="IGuestFsObjInfo" dir="return">
9847	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9848	</param>
9849	</method>
9850
9851	<method name="fileQuerySize">
9852	<desc>
9853	Queries the size of a file on the guest.
9854
9855	<result name="VBOX_E_OBJECT_NOT_FOUND">
9856	File to rename was not found.
9857	</result>
9858	<result name="VBOX_E_IPRT_ERROR">
9859	Error querying file size.
9860	</result>
9861	</desc>
9862	<param name="path" type="wstring" dir="in">
9863	<desc>File to query the size for.</desc>
9864	</param>
9865	<param name="size" type="long long" dir="return">
9866	<desc>Queried file size.</desc>
9867	</param>
9868	</method>
9869
9870	<method name="fileRename">
9871	<desc>
9872	Renames a file on the guest.
9873
9874	<result name="E_NOTIMPL">
9875	The method is not implemented yet.
9876	</result>
9877	</desc>
9878	<param name="source" type="wstring" dir="in">
9879	<desc>Source file to rename.</desc>
9880	</param>
9881	<param name="dest" type="wstring" dir="in">
9882	<desc>Destination file to rename the source to.</desc>
9883	</param>
9884	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9885	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9886	</param>
9887	</method>
9888
9889	<method name="fileSetACL">
9890	<desc>
9891	Sets the ACL (Access Control List) of a file on the guest.
9892
9893	<result name="E_NOTIMPL">
9894	The method is not implemented yet.
9895	</result>
9896	</desc>
9897	<param name="file" type="wstring" dir="in">
9898	<desc>Full path of file to set the ACL for.</desc>
9899	</param>
9900	<param name="acl" type="wstring" dir="in">
9901	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
9902	</param>
9903	</method>
9904
9905	<method name="processCreate">
9906	<desc>
9907	Executes an existing program inside the guest VM.
9908
9909	<note>
9910	Starting at VirtualBox 4.2 guest process execution by default is limited
9911	to serve up to 255 guest processes at a time. If all 255 guest processes
9912	are still active and running, starting a new guest process will result in an
9913	appropriate error message.
9914
9915	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
9916	is / are set, the guest process will not exit until all data from the specified
9917	stream(s) is / are read out.
9918
9919	To raise or lower the guest process execution limit, either the guest property
9920	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9921	command line by specifying "--control-procs-max-kept" needs to be modified.
9922	A restart of the guest OS is required afterwards. To serve unlimited guest
9923	processes, a value of "0" needs to be set (not recommended).
9924	</note>
9925
9926	<result name="VBOX_E_IPRT_ERROR">
9927	Could not create process.
9928	</result>
9929	</desc>
9930	<param name="command" type="wstring" dir="in">
9931	<desc>
9932	Full path name of the command to execute on the guest; the
9933	commands has to exists in the guest VM in order to be executed.
9934	</desc>
9935	</param>
9936	<param name="arguments" type="wstring" dir="in" safearray="yes">
9937	<desc>Array of arguments passed to the execution command.</desc>
9938	</param>
9939	<param name="environment" type="wstring" dir="in" safearray="yes">
9940	<desc>
9941	Environment variables that can be set while the command is being
9942	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9943	variable just set its name ("NAME") without a value.
9944
9945	This parameter can be used to override environment variables set by
9946	the guest session, which will be applied to the newly started process
9947	in any case.
9948	</desc>
9949	</param>
9950	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
9951	<desc>
9952	Process creation flags;
9953	see <link to="ProcessCreateFlag"/> for more information.
9954	</desc>
9955	</param>
9956	<param name="timeoutMS" type="unsigned long" dir="in">
9957	<desc>
9958	Timeout (in ms) to wait for the operation to complete.
9959	Pass 0 for an infinite timeout.
9960	</desc>
9961	</param>
9962	<param name="guestProcess" type="IGuestProcess" dir="return">
9963	<desc>Guest process object of the newly created process.</desc>
9964	</param>
9965	</method>
9966
9967	<method name="processCreateEx">
9968	<desc>
9969	Executes an existing program inside the guest VM. Extended version for
9970	also setting the process priority and affinity.
9971
9972	<note>
9973	Starting at VirtualBox 4.2 guest process execution by default is limited
9974	to serve up to 255 guest processes at a time. If all 255 guest processes
9975	are still active and running, starting a new guest process will result in an
9976	appropriate error message.
9977
9978	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
9979	is / are set, the guest process will not exit until all data from the specified
9980	stream(s) is / are read out.
9981
9982	To raise or lower the guest process execution limit, either the guest property
9983	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9984	command line by specifying "--control-procs-max-kept" needs to be modified.
9985	A restart of the guest OS is required afterwards. To serve unlimited guest
9986	processes, a value of "0" needs to be set (not recommended).
9987	</note>
9988
9989	<result name="VBOX_E_IPRT_ERROR">
9990	Could not create process.
9991	</result>
9992	</desc>
9993	<param name="command" type="wstring" dir="in">
9994	<desc>
9995	Full path name of the command to execute on the guest; the
9996	commands has to exists in the guest VM in order to be executed.
9997	</desc>
9998	</param>
9999	<param name="arguments" type="wstring" dir="in" safearray="yes">
10000	<desc>Array of arguments passed to the execution command.</desc>
10001	</param>
10002	<param name="environment" type="wstring" dir="in" safearray="yes">
10003	<desc>
10004	Environment variables that can be set while the command is being
10005	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10006	variable just set its name ("NAME") without a value.
10007
10008	This parameter can be used to override environment variables set by
10009	the guest session, which will be applied to the newly started process
10010	in any case.
10011	</desc>
10012	</param>
10013	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10014	<desc>
10015	Process creation flags;
10016	see <link to="ProcessCreateFlag"/> for more information.
10017	</desc>
10018	</param>
10019	<param name="timeoutMS" type="unsigned long" dir="in">
10020	<desc>
10021	Timeout (in ms) to wait for the operation to complete.
10022	Pass 0 for an infinite timeout.
10023	</desc>
10024	</param>
10025	<param name="priority" type="ProcessPriority" dir="in">
10026	<desc>
10027	Process priority to use for execution;
10028	see see <link to="ProcessPriority"/> for more information.</desc>
10029	</param>
10030	<param name="affinity" type="long" dir="in" safearray="yes">
10031	<desc>
10032	Process affinity to use for execution. This parameter
10033	is not implemented yet.
10034	</desc>
10035	</param>
10036	<param name="guestProcess" type="IGuestProcess" dir="return">
10037	<desc>Guest process object of the newly created process.</desc>
10038	</param>
10039	</method>
10040
10041	<method name="processGet">
10042	<desc>
10043	Gets a certain guest process by its process ID (PID).
10044	</desc>
10045	<param name="pid" type="unsigned long" dir="in">
10046	<desc>Process ID (PID) to get guest process for.</desc>
10047	</param>
10048	<param name="guestProcess" type="IGuestProcess" dir="return">
10049	<desc>Guest process of specified process ID (PID).</desc>
10050	</param>
10051	</method>
10052
10053	<method name="symlinkCreate">
10054	<desc>
10055	Creates a symbolic link on the guest.
10056
10057	<result name="E_NOTIMPL">
10058	The method is not implemented yet.
10059	</result>
10060	</desc>
10061	<param name="source" type="wstring" dir="in">
10062	<desc>The name of the symbolic link.</desc>
10063	</param>
10064	<param name="target" type="wstring" dir="in">
10065	<desc>The path to the symbolic link target.</desc>
10066	</param>
10067	<param name="type" type="SymlinkType" dir="in">
10068	<desc>
10069	The symbolic link type;
10070	see <link to="SymlinkReadFlag"/> for more information.
10071	</desc>
10072	</param>
10073	</method>
10074
10075	<method name="symlinkExists">
10076	<desc>
10077	Checks whether a symbolic link exists on the guest or not.
10078
10079	<result name="E_NOTIMPL">
10080	The method is not implemented yet.
10081	</result>
10082	</desc>
10083	<param name="symlink" type="wstring" dir="in">
10084	<desc>Symbolic link to check existence for.</desc>
10085	</param>
10086	<param name="exists" type="boolean" dir="return">
10087	<desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10088	</param>
10089	</method>
10090
10091	<method name="symlinkRead">
10092	<desc>
10093	Reads a symbolic link on the guest.
10094
10095	<result name="E_NOTIMPL">
10096	The method is not implemented yet.
10097	</result>
10098	</desc>
10099	<param name="symlink" type="wstring" dir="in">
10100	<desc>Full path to symbolic link to read.</desc>
10101	</param>
10102	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10103	<desc>
10104	Read flags; see <link to="SymlinkReadFlag"/> for more information.
10105	</desc>
10106	</param>
10107	<param name="target" type="wstring" dir="return">
10108	<desc>
10109	Target of the symbolic link pointing to, if found.
10110	</desc>
10111	</param>
10112	</method>
10113
10114	<method name="symlinkRemoveDirectory">
10115	<desc>
10116	Removes a symbolic link on the guest if it's a directory.
10117
10118	<result name="E_NOTIMPL">
10119	The method is not implemented yet.
10120	</result>
10121	</desc>
10122	<param name="path" type="wstring" dir="in">
10123	<desc>Symbolic link to remove.</desc>
10124	</param>
10125	</method>
10126
10127	<method name="symlinkRemoveFile">
10128	<desc>
10129	Removes a symbolic link on the guest if it's a file.
10130
10131	<result name="E_NOTIMPL">
10132	The method is not implemented yet.
10133	</result>
10134	</desc>
10135	<param name="file" type="wstring" dir="in">
10136	<desc>Symbolic link to remove.</desc>
10137	</param>
10138	</method>
10139
10140	</interface>
10141
10142	<interface
10143	name="IProcess" extends="$unknown"
10144	uuid="08864d56-96ab-418b-adbc-5a679532aeb0"
10145	wsmap="managed"
10146	>
10147	<desc>
10148	Abstract parent interface for processes handled by VirtualBox.
10149	</desc>
10150	<attribute name="PID" type="unsigned long" readonly="yes">
10151	<desc>
10152	The process ID (PID).
10153	</desc>
10154	</attribute>
10155	<attribute name="status" type="ProcessStatus" readonly="yes">
10156	<desc>
10157	The current process status; see <link to="ProcessStatus"/>
10158	for more information.
10159	</desc>
10160	</attribute>
10161	<attribute name="exitCode" type="long" readonly="yes">
10162	<desc>
10163	The exit code. Only available when the process has been
10164	terminated normally.
10165	</desc>
10166	</attribute>
10167	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10168	<desc>
10169	The environment block this process is using during execution.
10170	</desc>
10171	</attribute>
10172	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10173	<desc>
10174	The arguments this process is using for execution.
10175	</desc>
10176	</attribute>
10177	<attribute name="executablePath" type="wstring" readonly="yes">
10178	<desc>Full path of the actual executable image.</desc>
10179	</attribute>
10180	<attribute name="name" type="wstring" readonly="yes">
10181	<desc>The friendly name of this process.</desc>
10182	</attribute>
10183
10184	<method name="waitFor">
10185	<desc>
10186	Waits for one more events to happen.
10187	</desc>
10188	<param name="waitFor" type="unsigned long" dir="in">
10189	<desc>
10190	Specifies what to wait for;
10191	see <link to="ProcessWaitForFlag"/> for more information.
10192	</desc>
10193	</param>
10194	<param name="timeoutMS" type="unsigned long" dir="in">
10195	<desc>
10196	Timeout (in ms) to wait for the operation to complete.
10197	Pass 0 for an infinite timeout.
10198	</desc>
10199	</param>
10200	<param name="reason" type="ProcessWaitResult" dir="return">
10201	<desc>
10202	The overall wait result;
10203	see <link to="ProcessWaitResult"/> for more information.
10204	</desc>
10205	</param>
10206	</method>
10207
10208	<method name="waitForArray">
10209	<desc>
10210	Waits for one more events to happen.
10211	Scriptable version of <link to="#waitFor" />.
10212	</desc>
10213	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10214	<desc>
10215	Specifies what to wait for;
10216	see <link to="ProcessWaitForFlag"/> for more information.
10217	</desc>
10218	</param>
10219	<param name="timeoutMS" type="unsigned long" dir="in">
10220	<desc>
10221	Timeout (in ms) to wait for the operation to complete.
10222	Pass 0 for an infinite timeout.
10223	</desc>
10224	</param>
10225	<param name="reason" type="ProcessWaitResult" dir="return">
10226	<desc>
10227	The overall wait result;
10228	see <link to="ProcessWaitResult"/> for more information.
10229	</desc>
10230	</param>
10231	</method>
10232
10233	<method name="read">
10234	<desc>
10235	Reads data from a running process.
10236	</desc>
10237	<param name="handle" type="unsigned long" dir="in">
10238	<desc>Handle to read from. Usually 0 is stdin.</desc>
10239	</param>
10240	<param name="toRead" type="unsigned long" dir="in">
10241	<desc>Number of bytes to read.</desc>
10242	</param>
10243	<param name="timeoutMS" type="unsigned long" dir="in">
10244	<desc>
10245	Timeout (in ms) to wait for the operation to complete.
10246	Pass 0 for an infinite timeout.
10247	</desc>
10248	</param>
10249	<param name="data" type="octet" dir="return" safearray="yes">
10250	<desc>Array of data read.</desc>
10251	</param>
10252	</method>
10253
10254	<method name="write">
10255	<desc>
10256	Writes data to a running process.
10257	</desc>
10258	<param name="handle" type="unsigned long" dir="in">
10259	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10260	</param>
10261	<param name="flags" type="unsigned long" dir="in">
10262	<desc>
10263	A combination of <link to="ProcessInputFlag"/> flags.
10264	</desc>
10265	</param>
10266	<param name="data" type="octet" dir="in" safearray="yes">
10267	<desc>
10268	Array of bytes to write. The size of the array also specifies
10269	how much to write.
10270	</desc>
10271	</param>
10272	<param name="timeoutMS" type="unsigned long" dir="in">
10273	<desc>
10274	Timeout (in ms) to wait for the operation to complete.
10275	Pass 0 for an infinite timeout.
10276	</desc>
10277	</param>
10278	<param name="written" type="unsigned long" dir="return">
10279	<desc>How much bytes were written.</desc>
10280	</param>
10281	</method>
10282
10283	<method name="writeArray">
10284	<desc>
10285	Writes data to a running process.
10286	Scriptable version of <link to="#write" />.
10287	</desc>
10288	<param name="handle" type="unsigned long" dir="in">
10289	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10290	</param>
10291	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10292	<desc>
10293	A combination of <link to="ProcessInputFlag"/> flags.
10294	</desc>
10295	</param>
10296	<param name="data" type="octet" dir="in" safearray="yes">
10297	<desc>
10298	Array of bytes to write. The size of the array also specifies
10299	how much to write.
10300	</desc>
10301	</param>
10302	<param name="timeoutMS" type="unsigned long" dir="in">
10303	<desc>
10304	Timeout (in ms) to wait for the operation to complete.
10305	Pass 0 for an infinite timeout.
10306	</desc>
10307	</param>
10308	<param name="written" type="unsigned long" dir="return">
10309	<desc>How much bytes were written.</desc>
10310	</param>
10311	</method>
10312
10313	<method name="terminate">
10314	<desc>
10315	Terminates (kills) a running process.
10316	</desc>
10317	</method>
10318	</interface>
10319
10320	<interface
10321	name="IGuestProcess" extends="IProcess"
10322	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10323	wsmap="managed"
10324	>
10325	<desc>
10326	Implementation of the <link to="IProcess" /> object
10327	for processes on the guest.
10328	</desc>
10329	</interface>
10330
10331	<interface
10332	name="IDirectory" extends="$unknown"
10333	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10334	wsmap="managed"
10335	>
10336	<desc>
10337	Abstract parent interface for directories handled by VirtualBox.
10338	</desc>
10339
10340	<attribute name="directoryName" type="wstring" readonly="yes">
10341	<desc>
10342	Full path of directory.
10343	</desc>
10344	</attribute>
10345
10346	<attribute name="filter" type="wstring" readonly="yes">
10347	<desc>
10348	The open filter.
10349	</desc>
10350	</attribute>
10351
10352	<method name="close">
10353	<desc>
10354	Closes this directory. After closing operations like reading the next
10355	directory entry will not be possible anymore.
10356	</desc>
10357	</method>
10358
10359	<method name="read">
10360	<desc>
10361	Reads the next directory entry of this directory.
10362	<result name="VBOX_E_OBJECT_NOT_FOUND">
10363	No more directory entries to read.
10364	</result>
10365	</desc>
10366	<param name="objInfo" type="IFsObjInfo" dir="return">
10367	<desc>Object information of the current directory entry read. Also see <link to="IFsObjInfo"/>.</desc>
10368	</param>
10369	</method>
10370	</interface>
10371
10372	<interface
10373	name="IGuestDirectory" extends="IDirectory"
10374	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10375	wsmap="managed"
10376	>
10377	<desc>
10378	Implementation of the <link to="IDirectory" /> object
10379	for directories on the guest.
10380	</desc>
10381	</interface>
10382
10383	<interface
10384	name="IFile" extends="$unknown"
10385	uuid="b702a560-6139-4a8e-a892-bbf14b97bf97"
10386	wsmap="managed"
10387	>
10388	<desc>
10389	Abstract parent interface for files handled by VirtualBox.
10390	</desc>
10391	<attribute name="creationMode" type="unsigned long" readonly="yes">
10392	<desc>
10393	The creation mode.
10394	</desc>
10395	</attribute>
10396	<attribute name="disposition" type="unsigned long" readonly="yes">
10397	<desc>
10398	The disposition mode.
10399	</desc>
10400	</attribute>
10401	<attribute name="fileName" type="wstring" readonly="yes">
10402	<desc>
10403	Full path of the actual file name of this file.
10404	</desc>
10405	</attribute>
10406	<attribute name="initialSize" type="long long" readonly="yes">
10407	<desc>
10408	The initial size in bytes when opened.
10409	</desc>
10410	</attribute>
10411	<attribute name="openMode" type="unsigned long" readonly="yes">
10412	<desc>
10413	The open mode.
10414	</desc>
10415	</attribute>
10416	<attribute name="offset" type="long long" readonly="yes">
10417	<desc>
10418	Current read/write offset in bytes.
10419	</desc>
10420	</attribute>
10421
10422	<method name="close">
10423	<desc>
10424	Closes this file. After closing operations like reading data,
10425	writing data or querying information will not be possible anymore.
10426	</desc>
10427	</method>
10428
10429	<method name="queryInfo">
10430	<desc>
10431	Queries information about this file.
10432
10433	<result name="E_NOTIMPL">
10434	The method is not implemented yet.
10435	</result>
10436	</desc>
10437	<param name="objInfo" type="IFsObjInfo" dir="return">
10438	<desc>Object information of this file. Also see <link to="IFsObjInfo"/>.</desc>
10439	</param>
10440	</method>
10441
10442	<method name="read">
10443	<desc>
10444	Reads data from this file.
10445
10446	<result name="E_NOTIMPL">
10447	The method is not implemented yet.
10448	</result>
10449	</desc>
10450	<param name="toRead" type="unsigned long" dir="in">
10451	<desc>Number of bytes to read.</desc>
10452	</param>
10453	<param name="timeoutMS" type="unsigned long" dir="in">
10454	<desc>
10455	Timeout (in ms) to wait for the operation to complete.
10456	Pass 0 for an infinite timeout.
10457	</desc>
10458	</param>
10459	<param name="data" type="octet" dir="return" safearray="yes">
10460	<desc>Array of data read.</desc>
10461	</param>
10462	</method>
10463
10464	<method name="readAt">
10465	<desc>
10466	Reads data from an offset of this file.
10467
10468	<result name="E_NOTIMPL">
10469	The method is not implemented yet.
10470	</result>
10471	</desc>
10472	<param name="offset" type="long long" dir="in">
10473	<desc>Offset in bytes to start reading.</desc>
10474	</param>
10475	<param name="toRead" type="unsigned long" dir="in">
10476	<desc>Number of bytes to read.</desc>
10477	</param>
10478	<param name="timeoutMS" type="unsigned long" dir="in">
10479	<desc>
10480	Timeout (in ms) to wait for the operation to complete.
10481	Pass 0 for an infinite timeout.
10482	</desc>
10483	</param>
10484	<param name="data" type="octet" dir="return" safearray="yes">
10485	<desc>Array of data read.</desc>
10486	</param>
10487	</method>
10488
10489	<method name="seek">
10490	<desc>
10491	Changes the read and write position of this file.
10492
10493	<result name="E_NOTIMPL">
10494	The method is not implemented yet.
10495	</result>
10496	</desc>
10497	<param name="offset" type="long long" dir="in">
10498	<desc>Offset to seek.</desc>
10499	</param>
10500	<param name="whence" type="FileSeekType" dir="in">
10501	<desc>
10502	Seek mode; see <link to="FileSeekType"/> for more information.
10503	</desc>
10504	</param>
10505	</method>
10506
10507	<method name="setACL">
10508	<desc>
10509	Sets the ACL of this file.
10510
10511	<result name="E_NOTIMPL">
10512	The method is not implemented yet.
10513	</result>
10514	</desc>
10515	<param name="acl" type="wstring" dir="in">
10516	<desc>ACL string to set.</desc>
10517	</param>
10518	</method>
10519
10520	<method name="write">
10521	<desc>
10522	Writes bytes to this file.
10523	</desc>
10524	<param name="data" type="octet" dir="in" safearray="yes">
10525	<desc>
10526	Array of bytes to write. The size of the array also specifies
10527	how much to write.
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="written" type="unsigned long" dir="return">
10537	<desc>How much bytes were written.</desc>
10538	</param>
10539	</method>
10540
10541	<method name="writeAt">
10542	<desc>
10543	Writes bytes at a certain offset to this file.
10544
10545	<result name="E_NOTIMPL">
10546	The method is not implemented yet.
10547	</result>
10548	</desc>
10549	<param name="offset" type="long long" dir="in">
10550	<desc>Offset in bytes to start writing.</desc>
10551	</param>
10552	<param name="data" type="octet" dir="in" safearray="yes">
10553	<desc>
10554	Array of bytes to write. The size of the array also specifies
10555	how much to write.
10556	</desc>
10557	</param>
10558	<param name="timeoutMS" type="unsigned long" dir="in">
10559	<desc>
10560	Timeout (in ms) to wait for the operation to complete.
10561	Pass 0 for an infinite timeout.
10562	</desc>
10563	</param>
10564	<param name="written" type="unsigned long" dir="return">
10565	<desc>How much bytes were written.</desc>
10566	</param>
10567	</method>
10568
10569	</interface>
10570
10571	<interface
10572	name="IGuestFile" extends="IFile"
10573	uuid="60661aec-145f-4d11-b80e-8ea151598093"
10574	wsmap="managed"
10575	>
10576	<desc>
10577	Implementation of the <link to="IFile" /> object
10578	for files on the guest.
10579	</desc>
10580	</interface>
10581
10582	<interface
10583	name="IFsObjInfo" extends="$unknown"
10584	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
10585	wsmap="managed"
10586	>
10587	<desc>
10588	Abstract parent interface for VirtualBox file system object information.
10589	This can be information about a file or a directory, for example.
10590	</desc>
10591
10592	<attribute name="accessTime" type="long long" readonly="yes">
10593	<desc>
10594	Time of last access (st_atime).
10595	</desc>
10596	</attribute>
10597	<attribute name="allocatedSize" type="long long" readonly="yes">
10598	<desc>
10599	Disk allocation size (st_blocks * DEV_BSIZE).
10600	</desc>
10601	</attribute>
10602	<attribute name="birthTime" type="long long" readonly="yes">
10603	<desc>
10604	Time of file birth (st_birthtime).
10605	</desc>
10606	</attribute>
10607	<attribute name="changeTime" type="long long" readonly="yes">
10608	<desc>
10609	Time of last status change (st_ctime).
10610	</desc>
10611	</attribute>
10612	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
10613	<desc>
10614	The device number of a character or block device type object (st_rdev).
10615	</desc>
10616	</attribute>
10617	<attribute name="fileAttributes" type="wstring" readonly="yes">
10618	<desc>
10619	File attributes. Not implemented yet.
10620	</desc>
10621	</attribute>
10622	<attribute name="generationId" type="unsigned long" readonly="yes">
10623	<desc>
10624	The current generation number (st_gen).
10625	</desc>
10626	</attribute>
10627	<attribute name="GID" type="unsigned long" readonly="yes">
10628	<desc>
10629	The group the filesystem object is assigned (st_gid).
10630	</desc>
10631	</attribute>
10632	<attribute name="groupName" type="wstring" readonly="yes">
10633	<desc>
10634	The group name.
10635	</desc>
10636	</attribute>
10637	<attribute name="hardLinks" type="unsigned long" readonly="yes">
10638	<desc>
10639	Number of hard links to this filesystem object (st_nlink).
10640	</desc>
10641	</attribute>
10642	<attribute name="modificationTime" type="long long" readonly="yes">
10643	<desc>
10644	Time of last data modification (st_mtime).
10645	</desc>
10646	</attribute>
10647	<attribute name="name" type="wstring" readonly="yes">
10648	<desc>
10649	The object's name.
10650	</desc>
10651	</attribute>
10652	<attribute name="nodeId" type="long long" readonly="yes">
10653	<desc>
10654	The unique identifier (within the filesystem) of this filesystem object (st_ino).
10655	</desc>
10656	</attribute>
10657	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
10658	<desc>
10659	The device number of the device which this filesystem object resides on (st_dev).
10660	</desc>
10661	</attribute>
10662	<attribute name="objectSize" type="long long" readonly="yes">
10663	<desc>
10664	The logical size (st_size). For normal files this is the size of the file.
10665	For symbolic links, this is the length of the path name contained in the
10666	symbolic link. For other objects this fields needs to be specified.
10667	</desc>
10668	</attribute>
10669	<attribute name="type" type="FsObjType" readonly="yes">
10670	<desc>
10671	The object type. See <link to="FsObjType" /> for more.
10672	</desc>
10673	</attribute>
10674	<attribute name="UID" type="unsigned long" readonly="yes">
10675	<desc>
10676	The user owning the filesystem object (st_uid).
10677	</desc>
10678	</attribute>
10679	<attribute name="userFlags" type="unsigned long" readonly="yes">
10680	<desc>
10681	User flags (st_flags).
10682	</desc>
10683	</attribute>
10684	<attribute name="userName" type="wstring" readonly="yes">
10685	<desc>
10686	The user name.
10687	</desc>
10688	</attribute>
10689
10690	</interface>
10691
10692	<interface
10693	name="IGuestFsObjInfo" extends="IFsObjInfo"
10694	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
10695	wsmap="managed"
10696	>
10697	<desc>
10698	Represents the guest implementation of the
10699	<link to="IFsObjInfo" /> object.
10700	</desc>
10701	</interface>
10702
10703	<interface
10704	name="IGuest" extends="$unknown"
10705	uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
10706	wsmap="managed"
10707	>
10708	<desc>
10709	The IGuest interface represents information about the operating system
10710	running inside the virtual machine. Used in
10711	<link to="IConsole::guest"/>.
10712
10713	IGuest provides information about the guest operating system, whether
10714	Guest Additions are installed and other OS-specific virtual machine
10715	properties.
10716	</desc>
10717
10718	<attribute name="OSTypeId" type="wstring" readonly="yes">
10719	<desc>
10720	Identifier of the Guest OS type as reported by the Guest
10721	Additions.
10722	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
10723	an IGuestOSType object representing details about the given
10724	Guest OS type.
10725	<note>
10726	If Guest Additions are not installed, this value will be
10727	the same as <link to="IMachine::OSTypeId"/>.
10728	</note>
10729	</desc>
10730	</attribute>
10731
10732	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
10733	<desc>
10734	Current run level of the Guest Additions.
10735	</desc>
10736	</attribute>
10737
10738	<attribute name="additionsVersion" type="wstring" readonly="yes">
10739	<desc>
10740	Version of the Guest Additions in the same format as
10741	<link to="IVirtualBox::version"/>.
10742	</desc>
10743	</attribute>
10744
10745	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
10746	<desc>
10747	The internal build revision number of the additions.
10748
10749	See also <link to="IVirtualBox::revision"/>.
10750	</desc>
10751	</attribute>
10752
10753	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
10754	<desc>
10755	Array of current known facilities. Only returns facilities where a status is known,
10756	e.g. facilities with an unknown status will not be returned.
10757	</desc>
10758	</attribute>
10759
10760	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
10761	<desc>Returns a collection of all opened guest sessions.</desc>
10762	</attribute>
10763
10764	<attribute name="memoryBalloonSize" type="unsigned long">
10765	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
10766	</attribute>
10767
10768	<attribute name="statisticsUpdateInterval" type="unsigned long">
10769	<desc>Interval to update guest statistics in seconds.</desc>
10770	</attribute>
10771
10772	<method name="internalGetStatistics">
10773	<desc>
10774	Internal method; do not use as it might change at any time.
10775	</desc>
10776	<param name="cpuUser" type="unsigned long" dir="out">
10777	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
10778	</param>
10779	<param name="cpuKernel" type="unsigned long" dir="out">
10780	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
10781	</param>
10782	<param name="cpuIdle" type="unsigned long" dir="out">
10783	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
10784	</param>
10785	<param name="memTotal" type="unsigned long" dir="out">
10786	<desc>Total amount of physical guest RAM.</desc>
10787	</param>
10788	<param name="memFree" type="unsigned long" dir="out">
10789	<desc>Free amount of physical guest RAM.</desc>
10790	</param>
10791	<param name="memBalloon" type="unsigned long" dir="out">
10792	<desc>Amount of ballooned physical guest RAM.</desc>
10793	</param>
10794	<param name="memShared" type="unsigned long" dir="out">
10795	<desc>Amount of shared physical guest RAM.</desc>
10796	</param>
10797	<param name="memCache" type="unsigned long" dir="out">
10798	<desc>Total amount of guest (disk) cache memory.</desc>
10799	</param>
10800	<param name="pagedTotal" type="unsigned long" dir="out">
10801	<desc>Total amount of space in the page file.</desc>
10802	</param>
10803	<param name="memAllocTotal" type="unsigned long" dir="out">
10804	<desc>Total amount of memory allocated by the hypervisor.</desc>
10805	</param>
10806	<param name="memFreeTotal" type="unsigned long" dir="out">
10807	<desc>Total amount of free memory available in the hypervisor.</desc>
10808	</param>
10809	<param name="memBalloonTotal" type="unsigned long" dir="out">
10810	<desc>Total amount of memory ballooned by the hypervisor.</desc>
10811	</param>
10812	<param name="memSharedTotal" type="unsigned long" dir="out">
10813	<desc>Total amount of shared memory in the hypervisor.</desc>
10814	</param>
10815	</method>
10816
10817	<method name="getFacilityStatus">
10818	<desc>
10819	Get the current status of a Guest Additions facility.
10820	</desc>
10821	<param name="facility" type="AdditionsFacilityType" dir="in">
10822	<desc>Facility to check status for.</desc>
10823	</param>
10824	<param name="timestamp" type="long long" dir="out">
10825	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
10826	</param>
10827	<param name="status" type="AdditionsFacilityStatus" dir="return">
10828	<desc>The current (latest) facility status.</desc>
10829	</param>
10830	</method>
10831
10832	<method name="getAdditionsStatus">
10833	<desc>
10834	Retrieve the current status of a certain Guest Additions run level.
10835
10836	<result name="VBOX_E_NOT_SUPPORTED">
10837	Wrong status level specified.
10838	</result>
10839
10840	</desc>
10841	<param name="level" type="AdditionsRunLevelType" dir="in">
10842	<desc>Status level to check</desc>
10843	</param>
10844	<param name="active" type="boolean" dir="return">
10845	<desc>Flag whether the status level has been reached or not</desc>
10846	</param>
10847	</method>
10848
10849	<method name="setCredentials">
10850	<desc>
10851	Store login credentials that can be queried by guest operating
10852	systems with Additions installed. The credentials are transient
10853	to the session and the guest may also choose to erase them. Note
10854	that the caller cannot determine whether the guest operating system
10855	has queried or made use of the credentials.
10856
10857	<result name="VBOX_E_VM_ERROR">
10858	VMM device is not available.
10859	</result>
10860
10861	</desc>
10862	<param name="userName" type="wstring" dir="in">
10863	<desc>User name string, can be empty</desc>
10864	</param>
10865	<param name="password" type="wstring" dir="in">
10866	<desc>Password string, can be empty</desc>
10867	</param>
10868	<param name="domain" type="wstring" dir="in">
10869	<desc>Domain name (guest logon scheme specific), can be empty</desc>
10870	</param>
10871	<param name="allowInteractiveLogon" type="boolean" dir="in">
10872	<desc>
10873	Flag whether the guest should alternatively allow the user to
10874	interactively specify different credentials. This flag might
10875	not be supported by all versions of the Additions.
10876	</desc>
10877	</param>
10878	</method>
10879
10880	<method name="dragHGEnter">
10881	<desc>
10882	Informs the guest about a Drag and Drop enter event.
10883
10884	This is used in Host - Guest direction.
10885
10886	<result name="VBOX_E_VM_ERROR">
10887	VMM device is not available.
10888	</result>
10889
10890	</desc>
10891	<param name="screenId" type="unsigned long" dir="in">
10892	<desc>The screen id where the Drag and Drop event occured.</desc>
10893	</param>
10894	<param name="y" type="unsigned long" dir="in">
10895	<desc>y-position of the event.</desc>
10896	</param>
10897	<param name="x" type="unsigned long" dir="in">
10898	<desc>x-position of the event.</desc>
10899	</param>
10900	<param name="defaultAction" type="DragAndDropAction" dir="in">
10901	<desc>The default action to use.</desc>
10902	</param>
10903	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10904	<desc>The actions which are allowed.</desc>
10905	</param>
10906	<param name="formats" type="wstring" dir="in" safearray="yes">
10907	<desc>The supported mime types.</desc>
10908	</param>
10909	<param name="resultAction" type="DragAndDropAction" dir="return">
10910	<desc>The resulting action of this event.</desc>
10911	</param>
10912	</method>
10913
10914	<method name="dragHGMove">
10915	<desc>
10916	Informs the guest about a Drag and Drop move event.
10917
10918	This is used in Host - Guest direction.
10919
10920	<result name="VBOX_E_VM_ERROR">
10921	VMM device is not available.
10922	</result>
10923
10924	</desc>
10925	<param name="screenId" type="unsigned long" dir="in">
10926	<desc>The screen id where the Drag and Drop event occured.</desc>
10927	</param>
10928	<param name="x" type="unsigned long" dir="in">
10929	<desc>x-position of the event.</desc>
10930	</param>
10931	<param name="y" type="unsigned long" dir="in">
10932	<desc>y-position of the event.</desc>
10933	</param>
10934	<param name="defaultAction" type="DragAndDropAction" dir="in">
10935	<desc>The default action to use.</desc>
10936	</param>
10937	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10938	<desc>The actions which are allowed.</desc>
10939	</param>
10940	<param name="formats" type="wstring" dir="in" safearray="yes">
10941	<desc>The supported mime types.</desc>
10942	</param>
10943	<param name="resultAction" type="DragAndDropAction" dir="return">
10944	<desc>The resulting action of this event.</desc>
10945	</param>
10946	</method>
10947
10948	<method name="dragHGLeave">
10949	<desc>
10950	Informs the guest about a Drag and Drop leave event.
10951
10952	This is used in Host - Guest direction.
10953
10954	<result name="VBOX_E_VM_ERROR">
10955	VMM device is not available.
10956	</result>
10957
10958	</desc>
10959	<param name="screenId" type="unsigned long" dir="in">
10960	<desc>The screen id where the Drag and Drop event occured.</desc>
10961	</param>
10962	</method>
10963
10964	<method name="dragHGDrop">
10965	<desc>
10966	Informs the guest about a drop event.
10967
10968	This is used in Host - Guest direction.
10969
10970	<result name="VBOX_E_VM_ERROR">
10971	VMM device is not available.
10972	</result>
10973
10974	</desc>
10975	<param name="screenId" type="unsigned long" dir="in">
10976	<desc>The screen id where the Drag and Drop event occured.</desc>
10977	</param>
10978	<param name="x" type="unsigned long" dir="in">
10979	<desc>x-position of the event.</desc>
10980	</param>
10981	<param name="y" type="unsigned long" dir="in">
10982	<desc>y-position of the event.</desc>
10983	</param>
10984	<param name="defaultAction" type="DragAndDropAction" dir="in">
10985	<desc>The default action to use.</desc>
10986	</param>
10987	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10988	<desc>The actions which are allowed.</desc>
10989	</param>
10990	<param name="formats" type="wstring" dir="in" safearray="yes">
10991	<desc>The supported mime types.</desc>
10992	</param>
10993	<param name="format" type="wstring" dir="out">
10994	<desc>The resulting format of this event.</desc>
10995	</param>
10996	<param name="resultAction" type="DragAndDropAction" dir="return">
10997	<desc>The resulting action of this event.</desc>
10998	</param>
10999	</method>
11000
11001	<method name="dragHGPutData">
11002	<desc>
11003	Informs the guest about a drop data event.
11004
11005	This is used in Host - Guest direction.
11006
11007	<result name="VBOX_E_VM_ERROR">
11008	VMM device is not available.
11009	</result>
11010
11011	</desc>
11012	<param name="screenId" type="unsigned long" dir="in">
11013	<desc>The screen id where the Drag and Drop event occured.</desc>
11014	</param>
11015	<param name="format" type="wstring" dir="in">
11016	<desc>The mime type the data is in.</desc>
11017	</param>
11018	<param name="data" type="octet" dir="in" safearray="yes">
11019	<desc>The actual data.</desc>
11020	</param>
11021	<param name="progress" type="IProgress" dir="return">
11022	<desc>Progress object to track the operation completion.</desc>
11023	</param>
11024	</method>
11025
11026	<method name="dragGHPending">
11027	<desc>
11028	Ask the guest if there is any Drag and Drop operation pending in the guest.
11029
11030	If no Drag and Drop operation is pending currently, Ignore is returned.
11031
11032	This is used in Guest - Host direction.
11033
11034	<result name="VBOX_E_VM_ERROR">
11035	VMM device is not available.
11036	</result>
11037
11038	</desc>
11039	<param name="screenId" type="unsigned long" dir="in">
11040	<desc>The screen id where the Drag and Drop event occured.</desc>
11041	</param>
11042	<param name="format" type="wstring" dir="out" safearray="yes">
11043	<desc>On return the supported mime types.</desc>
11044	</param>
11045	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11046	<desc>On return the actions which are allowed.</desc>
11047	</param>
11048	<param name="defaultAction" type="DragAndDropAction" dir="return">
11049	<desc>On return the default action to use.</desc>
11050	</param>
11051	</method>
11052
11053	<method name="dragGHDropped">
11054	<desc>
11055	Informs the guest that a drop event occured for a pending Drag and Drop event.
11056
11057	This is used in Guest - Host direction.
11058
11059	<result name="VBOX_E_VM_ERROR">
11060	VMM device is not available.
11061	</result>
11062
11063	</desc>
11064
11065	<param name="format" type="wstring" dir="in">
11066	<desc>The mime type the data must be in.</desc>
11067	</param>
11068	<param name="action" type="DragAndDropAction" dir="in">
11069	<desc>The action to use.</desc>
11070	</param>
11071	<param name="progress" type="IProgress" dir="return">
11072	<desc>Progress object to track the operation completion.</desc>
11073	</param>
11074	</method>
11075
11076	<method name="dragGHGetData">
11077	<desc>
11078	Fetch the data of a previously Drag and Drop event from the guest.
11079
11080	This is used in Guest - Host direction.
11081
11082	<result name="VBOX_E_VM_ERROR">
11083	VMM device is not available.
11084	</result>
11085
11086	</desc>
11087
11088	<param name="data" type="octet" safearray="yes" dir="return">
11089	<desc>The actual data.</desc>
11090	</param>
11091	</method>
11092
11093	<method name="createSession">
11094	<desc>
11095	Creates a new guest session for controlling the guest.
11096
11097	A guest session represents one impersonated user account on the guest, so
11098	every operation will use the same credentials specified when creating
11099	the session object via <link to="IGuest::createSession"/>. Anonymous
11100	sessions, that is, sessions without specifying a valid
11101	user account on the guest are not allowed due to security reasons.
11102
11103	There can be a maximum of 32 sessions at once per VM. Each session keeps
11104	track of its started guest processes, opened guest files or guest directories.
11105	To work on guest files or directories a guest session offers methods to open
11106	or create such objects (see <link to="IGuestSession::fileOpen"/> or
11107	<link to="IGuestSession::directoryOpen"/> for example).
11108
11109	When done with either of these objects, including the guest session itself,
11110	use the appropriate close() method to let the object do its cleanup work.
11111
11112	Every guest session has its own environment variable block which gets
11113	automatically applied when starting a new guest process via
11114	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
11115	To override (or unset) certain environment variables already set by the
11116	guest session, one can specify a per-process environment block when using
11117	one of the both above mentioned process creation calls.
11118
11119	Closing a session via <link to="IGuestSession::close" /> will try to close
11120	all the mentioned objects above unless these objects are still used by
11121	a client.
11122	</desc>
11123	<param name="user" type="wstring" dir="in">
11124	<desc>
11125	User name this session will be using to control the guest; has to exist
11126	and have the appropriate rights to execute programs in the VM. Must not
11127	be empty.
11128	</desc>
11129	</param>
11130	<param name="password" type="wstring" dir="in">
11131	<desc>
11132	Password of the user account to be used. Empty passwords are allowed.
11133	</desc>
11134	</param>
11135	<param name="domain" type="wstring" dir="in">
11136	<desc>
11137	Domain name of the user account to be used if the guest is part of
11138	a domain. Optional. This feature is not implemented yet.
11139	</desc>
11140	</param>
11141	<param name="sessionName" type="wstring" dir="in">
11142	<desc>
11143	The session's friendly name. Optional, can be empty.
11144	</desc>
11145	</param>
11146	<param name="guestSession" type="IGuestSession" dir="return">
11147	<desc>
11148	The newly created session object.
11149	</desc>
11150	</param>
11151	</method>
11152
11153	<method name="findSession">
11154	<desc>
11155	Finds guest sessions by their friendly name and returns an interface
11156	array with all found guest sessions.
11157	</desc>
11158	<param name="sessionName" type="wstring" dir="in">
11159	<desc>
11160	The session's friendly name to find. Wildcards like ? and * are allowed.
11161	</desc>
11162	</param>
11163	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11164	<desc>
11165	Array with all guest sessions found matching the name specified.
11166	</desc>
11167	</param>
11168	</method>
11169
11170	<method name="updateGuestAdditions">
11171	<desc>
11172	Updates already installed Guest Additions in a VM
11173	(Windows guests only).
11174
11175	<result name="VBOX_E_IPRT_ERROR">
11176	Error while updating.
11177	</result>
11178
11179	</desc>
11180	<param name="source" type="wstring" dir="in">
11181	<desc>
11182	Path to the Guest Additions .ISO file to use for the upate.
11183	</desc>
11184	</param>
11185	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11186	<desc>
11187	<link to="AdditionsUpdateFlag"/> flags.
11188	</desc>
11189	</param>
11190	<param name="progress" type="IProgress" dir="return">
11191	<desc>Progress object to track the operation completion.</desc>
11192	</param>
11193	</method>
11194
11195	</interface>
11196
11197
11198	<!--
11199	// IProgress
11200	/////////////////////////////////////////////////////////////////////////
11201	-->
11202
11203	<interface
11204	name="IProgress" extends="$unknown"
11205	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11206	wsmap="managed"
11207	>
11208	<desc>
11209	The IProgress interface is used to track and control
11210	asynchronous tasks within VirtualBox.
11211
11212	An instance of this is returned every time VirtualBox starts
11213	an asynchronous task (in other words, a separate thread) which
11214	continues to run after a method call returns. For example,
11215	<link to="IConsole::saveState" />, which saves the state of
11216	a running virtual machine, can take a long time to complete.
11217	To be able to display a progress bar, a user interface such as
11218	the VirtualBox graphical user interface can use the IProgress
11219	object returned by that method.
11220
11221	Note that IProgress is a "read-only" interface in the sense
11222	that only the VirtualBox internals behind the Main API can
11223	create and manipulate progress objects, whereas client code
11224	can only use the IProgress object to monitor a task's
11225	progress and, if <link to="#cancelable" /> is @c true,
11226	cancel the task by calling <link to="#cancel" />.
11227
11228	A task represented by IProgress consists of either one or
11229	several sub-operations that run sequentially, one by one (see
11230	<link to="#operation" /> and <link to="#operationCount" />).
11231	Every operation is identified by a number (starting from 0)
11232	and has a separate description.
11233
11234	You can find the individual percentage of completion of the current
11235	operation in <link to="#operationPercent" /> and the
11236	percentage of completion of the task as a whole
11237	in <link to="#percent" />.
11238
11239	Similarly, you can wait for the completion of a particular
11240	operation via <link to="#waitForOperationCompletion" /> or
11241	for the completion of the whole task via
11242	<link to="#waitForCompletion" />.
11243	</desc>
11244
11245	<attribute name="id" type="uuid" mod="string" readonly="yes">
11246	<desc>ID of the task.</desc>
11247	</attribute>
11248
11249	<attribute name="description" type="wstring" readonly="yes">
11250	<desc>Description of the task.</desc>
11251	</attribute>
11252
11253	<attribute name="initiator" type="$unknown" readonly="yes">
11254	<desc>Initiator of the task.</desc>
11255	</attribute>
11256
11257	<attribute name="cancelable" type="boolean" readonly="yes">
11258	<desc>Whether the task can be interrupted.</desc>
11259	</attribute>
11260
11261	<attribute name="percent" type="unsigned long" readonly="yes">
11262	<desc>
11263	Current progress value of the task as a whole, in percent.
11264	This value depends on how many operations are already complete.
11265	Returns 100 if <link to="#completed" /> is @c true.
11266	</desc>
11267	</attribute>
11268
11269	<attribute name="timeRemaining" type="long" readonly="yes">
11270	<desc>
11271	Estimated remaining time until the task completes, in
11272	seconds. Returns 0 once the task has completed; returns -1
11273	if the remaining time cannot be computed, in particular if
11274	the current progress is 0.
11275
11276	Even if a value is returned, the estimate will be unreliable
11277	for low progress values. It will become more reliable as the
11278	task progresses; it is not recommended to display an ETA
11279	before at least 20% of a task have completed.
11280	</desc>
11281	</attribute>
11282
11283	<attribute name="completed" type="boolean" readonly="yes">
11284	<desc>Whether the task has been completed.</desc>
11285	</attribute>
11286
11287	<attribute name="canceled" type="boolean" readonly="yes">
11288	<desc>Whether the task has been canceled.</desc>
11289	</attribute>
11290
11291	<attribute name="resultCode" type="long" readonly="yes">
11292	<desc>
11293	Result code of the progress task.
11294	Valid only if <link to="#completed"/> is @c true.
11295	</desc>
11296	</attribute>
11297
11298	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11299	<desc>
11300	Extended information about the unsuccessful result of the
11301	progress operation. May be @c null if no extended information
11302	is available.
11303	Valid only if <link to="#completed"/> is @c true and
11304	<link to="#resultCode"/> indicates a failure.
11305	</desc>
11306	</attribute>
11307
11308	<attribute name="operationCount" type="unsigned long" readonly="yes">
11309	<desc>
11310	Number of sub-operations this task is divided into.
11311	Every task consists of at least one suboperation.
11312	</desc>
11313	</attribute>
11314
11315	<attribute name="operation" type="unsigned long" readonly="yes">
11316	<desc>Number of the sub-operation being currently executed.</desc>
11317	</attribute>
11318
11319	<attribute name="operationDescription" type="wstring" readonly="yes">
11320	<desc>
11321	Description of the sub-operation being currently executed.
11322	</desc>
11323	</attribute>
11324
11325	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11326	<desc>Progress value of the current sub-operation only, in percent.</desc>
11327	</attribute>
11328
11329	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11330	<desc>Weight value of the current sub-operation only.</desc>
11331	</attribute>
11332
11333	<attribute name="timeout" type="unsigned long">
11334	<desc>
11335	When non-zero, this specifies the number of milliseconds after which
11336	the operation will automatically be canceled. This can only be set on
11337	cancelable objects.
11338	</desc>
11339	</attribute>
11340
11341	<method name="setCurrentOperationProgress">
11342	<desc>Internal method, not to be called externally.</desc>
11343	<param name="percent" type="unsigned long" dir="in" />
11344	</method>
11345	<method name="setNextOperation">
11346	<desc>Internal method, not to be called externally.</desc>
11347	<param name="nextOperationDescription" type="wstring" dir="in" />
11348	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11349	</method>
11350
11351	<method name="waitForCompletion">
11352	<desc>
11353	Waits until the task is done (including all sub-operations)
11354	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11355
11356	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11357	thread are not processed while waiting. Neglecting event queues may
11358	have dire consequences (degrade performance, resource hogs,
11359	deadlocks, etc.), this is specially so for the main thread on
11360	platforms using XPCOM. Callers are adviced wait for short periods
11361	and service their event queues between calls, or to create a worker
11362	thread to do the waiting.
11363
11364	<result name="VBOX_E_IPRT_ERROR">
11365	Failed to wait for task completion.
11366	</result>
11367	</desc>
11368
11369	<param name="timeout" type="long" dir="in">
11370	<desc>
11371	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11372	</desc>
11373	</param>
11374	</method>
11375
11376	<method name="waitForOperationCompletion">
11377	<desc>
11378	Waits until the given operation is done with a given timeout in
11379	milliseconds; specify -1 for an indefinite wait.
11380
11381	See <link to="#waitForCompletion"> for event queue considerations.</link>
11382
11383	<result name="VBOX_E_IPRT_ERROR">
11384	Failed to wait for operation completion.
11385	</result>
11386
11387	</desc>
11388	<param name="operation" type="unsigned long" dir="in">
11389	<desc>
11390	Number of the operation to wait for.
11391	Must be less than <link to="#operationCount"/>.
11392	</desc>
11393	</param>
11394	<param name="timeout" type="long" dir="in">
11395	<desc>
11396	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11397	</desc>
11398	</param>
11399	</method>
11400
11401	<method name="waitForAsyncProgressCompletion">
11402	<desc>
11403	Waits until the other task is completed (including all
11404	sub-operations) and forward all changes from the other progress to
11405	this progress. This means sub-operation number, description, percent
11406	and so on.
11407
11408	You have to take care on setting up at least the same count on
11409	sub-operations in this progress object like there are in the other
11410	progress object.
11411
11412	If the other progress object supports cancel and this object gets any
11413	cancel request (when here enabled as well), it will be forwarded to
11414	the other progress object.
11415
11416	If there is an error in the other progress, this error isn't
11417	automatically transfered to this progress object. So you have to
11418	check any operation error within the other progress object, after
11419	this method returns.
11420	</desc>
11421
11422	<param name="pProgressAsync" type="IProgress" dir="in">
11423	<desc>
11424	The progress object of the asynchrony process.
11425	</desc>
11426	</param>
11427	</method>
11428
11429	<method name="cancel">
11430	<desc>
11431	Cancels the task.
11432	<note>
11433	If <link to="#cancelable"/> is @c false, then this method will fail.
11434	</note>
11435
11436	<result name="VBOX_E_INVALID_OBJECT_STATE">
11437	Operation cannot be canceled.
11438	</result>
11439
11440	</desc>
11441	</method>
11442
11443	</interface>
11444
11445	<!--
11446	// ISnapshot
11447	/////////////////////////////////////////////////////////////////////////
11448	-->
11449
11450	<interface
11451	name="ISnapshot" extends="$unknown"
11452	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11453	wsmap="managed"
11454	>
11455	<desc>
11456	The ISnapshot interface represents a snapshot of the virtual
11457	machine.
11458
11459	Together with the differencing media that are created
11460	when a snapshot is taken, a machine can be brought back to
11461	the exact state it was in when the snapshot was taken.
11462
11463	The ISnapshot interface has no methods, only attributes; snapshots
11464	are controlled through methods of the <link to="IConsole" /> interface
11465	which also manage the media associated with the snapshot.
11466	The following operations exist:
11467
11468	<ul>
11469	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11470	by creating new, empty differencing images for the machine's
11471	media and saving the VM settings and (if the VM is running)
11472	the current VM state in the snapshot.
11473
11474	The differencing images will then receive all data written to
11475	the machine's media, while their parent (base) images
11476	remain unmodified after the snapshot has been taken (see
11477	<link to="IMedium" /> for details about differencing images).
11478	This simplifies restoring a machine to the state of a snapshot:
11479	only the differencing images need to be deleted.
11480
11481	The current machine state is not changed by taking a snapshot
11482	except that <link to="IMachine::currentSnapshot" /> is set to
11483	the newly created snapshot, which is also added to the machine's
11484	snapshots tree.
11485	</li>
11486
11487	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11488	the state of a previous snapshot by deleting the differencing
11489	image of each of the machine's media and setting the machine's
11490	settings and state to the state that was saved in the snapshot (if any).
11491
11492	This destroys the machine's current state. After calling this,
11493	<link to="IMachine::currentSnapshot" /> points to the snapshot
11494	that was restored.
11495	</li>
11496
11497	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11498	without affecting the current machine state.
11499
11500	This does not change the current machine state, but instead frees the
11501	resources allocated when the snapshot was taken: the settings and machine
11502	state file are deleted (if any), and the snapshot's differencing image for
11503	each of the machine's media gets merged with its parent image.
11504
11505	Neither the current machine state nor other snapshots are affected
11506	by this operation, except that parent media will be modified
11507	to contain the disk data associated with the snapshot being deleted.
11508
11509	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11510	attribute is set to the current snapshot's parent or @c null if it
11511	has no parent. Otherwise the attribute is unchanged.
11512	</li>
11513	</ul>
11514
11515	Each snapshot contains a copy of virtual machine's settings (hardware
11516	configuration etc.). This copy is contained in an immutable (read-only)
11517	instance of <link to="IMachine" /> which is available from the snapshot's
11518	<link to="#machine" /> attribute. When restoring the snapshot, these
11519	settings are copied back to the original machine.
11520
11521	In addition, if the machine was running when the
11522	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11523	the current VM state is saved in the snapshot (similarly to what happens
11524	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11525	because when restoring it, the VM will be running.
11526
11527	If the machine was in <link to="MachineState_Saved">saved</link> saved,
11528	the snapshot receives a copy of the execution state file
11529	(<link to="IMachine::stateFilePath"/>).
11530
11531	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
11532	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
11533	it then contains a so-called "zero execution state", representing a
11534	machine that is powered off.
11535	</desc>
11536
11537	<attribute name="id" type="uuid" mod="string" readonly="yes">
11538	<desc>UUID of the snapshot.</desc>
11539	</attribute>
11540
11541	<attribute name="name" type="wstring">
11542	<desc>Short name of the snapshot.
11543	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11544	be called implicitly.</note>
11545	</desc>
11546	</attribute>
11547
11548	<attribute name="description" type="wstring">
11549	<desc>Optional description of the snapshot.
11550	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11551	be called implicitly.</note>
11552	</desc>
11553	</attribute>
11554
11555	<attribute name="timeStamp" type="long long" readonly="yes">
11556	<desc>
11557	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
11558	</desc>
11559	</attribute>
11560
11561	<attribute name="online" type="boolean" readonly="yes">
11562	<desc>
11563	@c true if this snapshot is an online snapshot and @c false otherwise.
11564
11565	When this attribute is @c true, the
11566	<link to="IMachine::stateFilePath"/> attribute of the
11567	<link to="#machine"/> object associated with this snapshot
11568	will point to the saved state file. Otherwise, it will be
11569	an empty string.
11570	</desc>
11571	</attribute>
11572
11573	<attribute name="machine" type="IMachine" readonly="yes">
11574	<desc>
11575	Virtual machine this snapshot is taken on. This object
11576	stores all settings the machine had when taking this snapshot.
11577	<note>
11578	The returned machine object is immutable, i.e. no
11579	any settings can be changed.
11580	</note>
11581	</desc>
11582	</attribute>
11583
11584	<attribute name="parent" type="ISnapshot" readonly="yes">
11585	<desc>
11586	Parent snapshot (a snapshot this one is based on), or
11587	@c null if the snapshot has no parent (i.e. is the first snapshot).
11588	</desc>
11589	</attribute>
11590
11591	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
11592	<desc>
11593	Child snapshots (all snapshots having this one as a parent).
11594	By inspecting this attribute starting with a machine's root snapshot
11595	(which can be obtained by calling <link to="IMachine::findSnapshot" />
11596	with a @c null UUID), a machine's snapshots tree can be iterated over.
11597	</desc>
11598	</attribute>
11599
11600	<method name="getChildrenCount" const="yes">
11601	<desc>
11602	Returns the number of direct childrens of this snapshot.
11603	</desc>
11604	<param name="childrenCount" type="unsigned long" dir="return">
11605	<desc>
11606	</desc>
11607	</param>
11608	</method>
11609
11610	</interface>
11611
11612
11613	<!--
11614	// IMedium
11615	/////////////////////////////////////////////////////////////////////////
11616	-->
11617
11618	<enum
11619	name="MediumState"
11620	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
11621	>
11622	<desc>
11623	Virtual medium state.
11624	<see><link to="IMedium"/></see>
11625	</desc>
11626
11627	<const name="NotCreated" value="0">
11628	<desc>
11629	Associated medium storage does not exist (either was not created yet or
11630	was deleted).
11631	</desc>
11632	</const>
11633	<const name="Created" value="1">
11634	<desc>
11635	Associated storage exists and accessible; this gets set if the
11636	accessibility check performed by <link to="IMedium::refreshState" />
11637	was successful.
11638	</desc>
11639	</const>
11640	<const name="LockedRead" value="2">
11641	<desc>
11642	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
11643	no data modification is possible.
11644	</desc>
11645	</const>
11646	<const name="LockedWrite" value="3">
11647	<desc>
11648	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
11649	no concurrent data reading or modification is possible.
11650	</desc>
11651	</const>
11652	<const name="Inaccessible" value="4">
11653	<desc>
11654	Medium accessibility check (see <link to="IMedium::refreshState" />) has
11655	not yet been performed, or else, associated medium storage is not
11656	accessible. In the first case, <link to="IMedium::lastAccessError"/>
11657	is empty, in the second case, it describes the error that occurred.
11658	</desc>
11659	</const>
11660	<const name="Creating" value="5">
11661	<desc>
11662	Associated medium storage is being created.
11663	</desc>
11664	</const>
11665	<const name="Deleting" value="6">
11666	<desc>
11667	Associated medium storage is being deleted.
11668	</desc>
11669	</const>
11670	</enum>
11671
11672	<enum
11673	name="MediumType"
11674	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
11675	>
11676	<desc>
11677	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
11678	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
11679	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
11680	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
11681	</desc>
11682
11683	<const name="Normal" value="0">
11684	<desc>
11685	Normal medium (attached directly or indirectly, preserved
11686	when taking snapshots).
11687	</desc>
11688	</const>
11689	<const name="Immutable" value="1">
11690	<desc>
11691	Immutable medium (attached indirectly, changes are wiped out
11692	the next time the virtual machine is started).
11693	</desc>
11694	</const>
11695	<const name="Writethrough" value="2">
11696	<desc>
11697	Write through medium (attached directly, ignored when
11698	taking snapshots).
11699	</desc>
11700	</const>
11701	<const name="Shareable" value="3">
11702	<desc>
11703	Allow using this medium concurrently by several machines.
11704	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
11705	</desc>
11706	</const>
11707	<const name="Readonly" value="4">
11708	<desc>
11709	A readonly medium, which can of course be used by several machines.
11710	<note>Present and accepted since VirtualBox 4.0.</note>
11711	</desc>
11712	</const>
11713	<const name="MultiAttach" value="5">
11714	<desc>
11715	A medium which is indirectly attached, so that one base medium can
11716	be used for several VMs which have their own differencing medium to
11717	store their modifications. In some sense a variant of Immutable
11718	with unset AutoReset flag in each differencing medium.
11719	<note>Present and accepted since VirtualBox 4.0.</note>
11720	</desc>
11721	</const>
11722	</enum>
11723
11724	<enum
11725	name="MediumVariant"
11726	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
11727	>
11728	<desc>
11729	Virtual medium image variant. More than one flag may be set.
11730	<see><link to="IMedium"/></see>
11731	</desc>
11732
11733	<const name="Standard" value="0">
11734	<desc>
11735	No particular variant requested, results in using the backend default.
11736	</desc>
11737	</const>
11738	<const name="VmdkSplit2G" value="0x01">
11739	<desc>
11740	VMDK image split in chunks of less than 2GByte.
11741	</desc>
11742	</const>
11743	<const name="VmdkRawDisk" value="0x02">
11744	<desc>
11745	VMDK image representing a raw disk.
11746	</desc>
11747	</const>
11748	<const name="VmdkStreamOptimized" value="0x04">
11749	<desc>
11750	VMDK streamOptimized image. Special import/export format which is
11751	read-only/append-only.
11752	</desc>
11753	</const>
11754	<const name="VmdkESX" value="0x08">
11755	<desc>
11756	VMDK format variant used on ESX products.
11757	</desc>
11758	</const>
11759	<const name="Fixed" value="0x10000">
11760	<desc>
11761	Fixed image. Only allowed for base images.
11762	</desc>
11763	</const>
11764	<const name="Diff" value="0x20000">
11765	<desc>
11766	Differencing image. Only allowed for child images.
11767	</desc>
11768	</const>
11769	<const name="NoCreateDir" value="0x40000000">
11770	<desc>
11771	Special flag which suppresses automatic creation of the subdirectory.
11772	Only used when passing the medium variant as an input parameter.
11773	</desc>
11774	</const>
11775	</enum>
11776
11777	<interface
11778	name="IMediumAttachment" extends="$unknown"
11779	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
11780	wsmap="struct"
11781	>
11782	<desc>
11783	The IMediumAttachment interface links storage media to virtual machines.
11784	For each medium (<link to="IMedium"/>) which has been attached to a
11785	storage controller (<link to="IStorageController"/>) of a machine
11786	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
11787	method, one instance of IMediumAttachment is added to the machine's
11788	<link to="IMachine::mediumAttachments"/> array attribute.
11789
11790	Each medium attachment specifies the storage controller as well as a
11791	port and device number and the IMedium instance representing a virtual
11792	hard disk or floppy or DVD image.
11793
11794	For removable media (DVDs or floppies), there are two additional
11795	options. For one, the IMedium instance can be @c null to represent
11796	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
11797	secondly, the medium can be one of the pseudo-media for host drives
11798	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
11799
11800	<h3>Attaching Hard Disks</h3>
11801
11802	Hard disks are attached to virtual machines using the
11803	<link to="IMachine::attachDevice"/> method and detached using the
11804	<link to="IMachine::detachDevice"/> method. Depending on a medium's
11805	type (see <link to="IMedium::type" />), hard disks are attached either
11806	<i>directly</i> or <i>indirectly</i>.
11807
11808	When a hard disk is being attached directly, it is associated with the
11809	virtual machine and used for hard disk operations when the machine is
11810	running. When a hard disk is being attached indirectly, a new differencing
11811	hard disk linked to it is implicitly created and this differencing hard
11812	disk is associated with the machine and used for hard disk operations.
11813	This also means that if <link to="IMachine::attachDevice"/> performs
11814	a direct attachment then the same hard disk will be returned in response
11815	to the subsequent <link to="IMachine::getMedium"/> call; however if
11816	an indirect attachment is performed then
11817	<link to="IMachine::getMedium"/> will return the implicitly created
11818	differencing hard disk, not the original one passed to <link
11819	to="IMachine::attachDevice"/>. In detail:
11820
11821	<ul>
11822	<li><b>Normal base</b> hard disks that do not have children (i.e.
11823	differencing hard disks linked to them) and that are not already
11824	attached to virtual machines in snapshots are attached <b>directly</b>.
11825	Otherwise, they are attached <b>indirectly</b> because having
11826	dependent children or being part of the snapshot makes it impossible
11827	to modify hard disk contents without breaking the integrity of the
11828	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
11829	quickly determine the kind of the attachment for the given hard
11830	disk. Note that if a normal base hard disk is to be indirectly
11831	attached to a virtual machine with snapshots then a special
11832	procedure called <i>smart attachment</i> is performed (see below).</li>
11833	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
11834	they are attached <b>directly</b> if they do not have children and are
11835	not attached to virtual machines in snapshots, and <b>indirectly</b>
11836	otherwise. Note that the smart attachment procedure is never performed
11837	for differencing hard disks.</li>
11838	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
11839	they are designed to be non-writable. If an immutable hard disk is
11840	attached to a virtual machine with snapshots then a special
11841	procedure called smart attachment is performed (see below).</li>
11842	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
11843	also as designed. This also means that writethrough hard disks cannot
11844	have other hard disks linked to them at all.</li>
11845	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
11846	also as designed. This also means that shareable hard disks cannot
11847	have other hard disks linked to them at all. They behave almost
11848	like writethrough hard disks, except that shareable hard disks can
11849	be attached to several virtual machines which are running, allowing
11850	concurrent accesses. You need special cluster software running in
11851	the virtual machines to make use of such disks.</li>
11852	</ul>
11853
11854	Note that the same hard disk, regardless of its type, may be attached to
11855	more than one virtual machine at a time. In this case, the machine that is
11856	started first gains exclusive access to the hard disk and attempts to
11857	start other machines having this hard disk attached will fail until the
11858	first machine is powered down.
11859
11860	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
11861	that the given hard disk remains associated with the given machine after a
11862	successful <link to="IMachine::detachDevice"/> call until
11863	<link to="IMachine::saveSettings"/> is called to save all changes to
11864	machine settings to disk. This deferring is necessary to guarantee that
11865	the hard disk configuration may be restored at any time by a call to
11866	<link to="IMachine::discardSettings"/> before the settings
11867	are saved (committed).
11868
11869	Note that if <link to="IMachine::discardSettings"/> is called after
11870	indirectly attaching some hard disks to the machine but before a call to
11871	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
11872	all differencing hard disks implicitly created by
11873	<link to="IMachine::attachDevice"/> for these indirect attachments.
11874	Such implicitly created hard disks will also be immediately deleted when
11875	detached explicitly using the <link to="IMachine::detachDevice"/>
11876	call if it is made before <link to="IMachine::saveSettings"/>. This
11877	implicit deletion is safe because newly created differencing hard
11878	disks do not contain any user data.
11879
11880	However, keep in mind that detaching differencing hard disks that were
11881	implicitly created by <link to="IMachine::attachDevice"/>
11882	before the last <link to="IMachine::saveSettings"/> call will
11883	<b>not</b> implicitly delete them as they may already contain some data
11884	(for example, as a result of virtual machine execution). If these hard
11885	disks are no more necessary, the caller can always delete them explicitly
11886	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
11887	from this machine by the <link to="IMachine::saveSettings"/> call.
11888
11889	<h3>Smart Attachment</h3>
11890
11891	When normal base or immutable hard disks are indirectly attached to a
11892	virtual machine then some additional steps are performed to make sure the
11893	virtual machine will have the most recent "view" of the hard disk being
11894	attached. These steps include walking through the machine's snapshots
11895	starting from the current one and going through ancestors up to the first
11896	snapshot. Hard disks attached to the virtual machine in all
11897	of the encountered snapshots are checked whether they are descendants of
11898	the given normal base or immutable hard disk. The first found child (which
11899	is the differencing hard disk) will be used instead of the normal base or
11900	immutable hard disk as a parent for creating a new differencing hard disk
11901	that will be actually attached to the machine. And only if no descendants
11902	are found or if the virtual machine does not have any snapshots then the
11903	normal base or immutable hard disk will be used itself as a parent for
11904	this differencing hard disk.
11905
11906	It is easier to explain what smart attachment does using the
11907	following example:
11908	<pre>
11909	BEFORE attaching B.vdi: AFTER attaching B.vdi:
11910
11911	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
11912	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
11913	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
11914	Snapshot 4 (none) Snapshot 4 (none)
11915	CurState (none) CurState (D3->D2.vdi)
11916
11917	NOT
11918	...
11919	CurState (D3->B.vdi)
11920	</pre>
11921	The first column is the virtual machine configuration before the base hard
11922	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
11923	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
11924	mean that the hard disk that is actually attached to the machine is a
11925	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
11926	another hard disk, <tt>B.vdi</tt>.
11927
11928	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
11929	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
11930	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
11931	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
11932	it cannot be attached directly and needs an indirect attachment (i.e.
11933	implicit creation of a new differencing hard disk). Due to the smart
11934	attachment procedure, the new differencing hard disk
11935	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
11936	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
11937	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
11938	machine.
11939
11940	Note that if there is more than one descendant hard disk of the given base
11941	hard disk found in a snapshot, and there is an exact device, channel and
11942	bus match, then this exact match will be used. Otherwise, the youngest
11943	descendant will be picked up.
11944
11945	There is one more important aspect of the smart attachment procedure which
11946	is not related to snapshots at all. Before walking through the snapshots
11947	as described above, the backup copy of the current list of hard disk
11948	attachment is searched for descendants. This backup copy is created when
11949	the hard disk configuration is changed for the first time after the last
11950	<link to="IMachine::saveSettings"/> call and used by
11951	<link to="IMachine::discardSettings"/> to undo the recent hard disk
11952	changes. When such a descendant is found in this backup copy, it will be
11953	simply re-attached back, without creating a new differencing hard disk for
11954	it. This optimization is necessary to make it possible to re-attach the
11955	base or immutable hard disk to a different bus, channel or device slot
11956	without losing the contents of the differencing hard disk actually
11957	attached to the machine in place of it.
11958
11959	</desc>
11960
11961	<attribute name="medium" type="IMedium" readonly="yes">
11962	<desc>Medium object associated with this attachment; it
11963	can be @c null for removable devices.</desc>
11964	</attribute>
11965
11966	<attribute name="controller" type="wstring" readonly="yes">
11967	<desc>Name of the storage controller of this attachment; this
11968	refers to one of the controllers in <link to="IMachine::storageControllers" />
11969	by name.</desc>
11970	</attribute>
11971
11972	<attribute name="port" type="long" readonly="yes">
11973	<desc>Port number of this attachment.
11974	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
11975	</desc>
11976	</attribute>
11977
11978	<attribute name="device" type="long" readonly="yes">
11979	<desc>Device slot number of this attachment.
11980	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
11981	</desc>
11982	</attribute>
11983
11984	<attribute name="type" type="DeviceType" readonly="yes">
11985	<desc>Device type of this attachment.</desc>
11986	</attribute>
11987
11988	<attribute name="passthrough" type="boolean" readonly="yes">
11989	<desc>Pass I/O requests through to a device on the host.</desc>
11990	</attribute>
11991
11992	<attribute name="temporaryEject" type="boolean" readonly="yes">
11993	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
11994	</attribute>
11995
11996	<attribute name="isEjected" type="boolean" readonly="yes">
11997	<desc>Signals that the removable medium has been ejected. This is not
11998	necessarily equivalent to having a @c null medium association.</desc>
11999	</attribute>
12000
12001	<attribute name="nonRotational" type="boolean" readonly="yes">
12002	<desc>Whether the associated medium is non-rotational.</desc>
12003	</attribute>
12004
12005	<attribute name="discard" type="boolean" readonly="yes">
12006	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12007	</attribute>
12008
12009	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12010	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12011	</attribute>
12012
12013	</interface>
12014
12015	<interface
12016	name="IMedium" extends="$unknown"
12017	uuid="29989373-b111-4654-8493-2e1176cba890"
12018	wsmap="managed"
12019	>
12020	<desc>
12021	The IMedium interface represents virtual storage for a machine's
12022	hard disks, CD/DVD or floppy drives. It will typically represent
12023	a disk image on the host, for example a VDI or VMDK file representing
12024	a virtual hard disk, or an ISO or RAW file representing virtual
12025	removable media, but can also point to a network location (e.g.
12026	for iSCSI targets).
12027
12028	Instances of IMedium are connected to virtual machines by way of medium
12029	attachments, which link the storage medium to a particular device slot
12030	of a storage controller of the virtual machine.
12031	In the VirtualBox API, virtual storage is therefore always represented
12032	by the following chain of object links:
12033
12034	<ul>
12035	<li><link to="IMachine::storageControllers"/> contains an array of
12036	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12037	these are instances of <link to="IStorageController"/>).</li>
12038	<li><link to="IMachine::mediumAttachments"/> contains an array of
12039	medium attachments (instances of <link to="IMediumAttachment"/>
12040	created by <link to="IMachine::attachDevice" />),
12041	each containing a storage controller from the above array, a
12042	port/device specification, and an instance of IMedium representing
12043	the medium storage (image file).
12044
12045	For removable media, the storage medium is optional; a medium
12046	attachment with no medium represents a CD/DVD or floppy drive
12047	with no medium inserted. By contrast, hard disk attachments
12048	will always have an IMedium object attached.</li>
12049	<li>Each IMedium in turn points to a storage unit (such as a file
12050	on the host computer or a network resource) that holds actual
12051	data. This location is represented by the <link to="#location"/>
12052	attribute.</li>
12053	</ul>
12054
12055	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12056	new hard disk media can be created with the VirtualBox API using the
12057	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12058	disks (see below) are usually implicitly created by VirtualBox as
12059	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12060	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12061	should be created with external tools and then opened from within VirtualBox.
12062
12063	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12064	drive. In that case the <link to="#id" /> attribute contains the UUID of
12065	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12066
12067	<h3>Media registries</h3>
12068
12069	When a medium has been opened or created using one of the aforementioned
12070	APIs, it becomes "known" to VirtualBox. Known media can be attached
12071	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12072	They also appear in the global
12073	<link to="IVirtualBox::hardDisks" />,
12074	<link to="IVirtualBox::DVDImages" /> and
12075	<link to="IVirtualBox::floppyImages" /> arrays.
12076
12077	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12078	in the VirtualBox.xml file, which was shared between all machines and made
12079	transporting machines and their media from one host to another difficult.
12080
12081	Starting with VirtualBox 4.0, media are only added to a registry when they are
12082	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12083	backwards compatibility, which registry a medium is added to depends on which
12084	VirtualBox version created a machine:
12085
12086	<ul>
12087	<li>If the medium has first been attached to a machine which was created by
12088	VirtualBox 4.0 or later, it is added to that machine's media registry in
12089	the machine XML settings file. This way all information about a machine's
12090	media attachments is contained in a single file and can be transported
12091	easily.</li>
12092	<li>For older media attachments (i.e. if the medium was first attached to a
12093	machine which was created with a VirtualBox version before 4.0), media
12094	continue to be registered in the global VirtualBox settings file, for
12095	backwards compatibility.</li>
12096	</ul>
12097
12098	See <link to="IVirtualBox::openMedium" /> for more information.
12099
12100	Media are removed from media registries by the <link to="IMedium::close"/>,
12101	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12102
12103	<h3>Accessibility checks</h3>
12104
12105	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12106	method is called explicitly on a medium. This is done to make the VirtualBox object
12107	ready for serving requests as fast as possible and let the end-user
12108	application decide if it needs to check media accessibility right away or not.
12109
12110	As a result, when VirtualBox starts up (e.g. the VirtualBox
12111	object gets created for the first time), all known media are in the
12112	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12113	attribute is an empty string because no actual accessibility check has
12114	been made yet.
12115
12116	After calling <link to="#refreshState" />, a medium is considered
12117	<i>accessible</i> if its storage unit can be read. In that case, the
12118	<link to="#state"/> attribute has a value of "Created". If the storage
12119	unit cannot be read (for example, because it is located on a disconnected
12120	network resource, or was accidentally deleted outside VirtualBox),
12121	the medium is considered <i>inaccessible</i>, which is indicated by the
12122	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12123	obtained by reading the <link to="#lastAccessError"/> attribute.
12124
12125	<h3>Medium types</h3>
12126
12127	There are five types of medium behavior which are stored in the
12128	<link to="#type"/> attribute (see <link to="MediumType" />) and
12129	which define the medium's behavior with attachments and snapshots.
12130
12131	All media can be also divided in two groups: <i>base</i> media and
12132	<i>differencing</i> media. A base medium contains all sectors of the
12133	medium data in its own storage and therefore can be used independently.
12134	In contrast, a differencing medium is a "delta" to some other medium and
12135	contains only those sectors which differ from that other medium, which is
12136	then called a <i>parent</i>. The differencing medium is said to be
12137	<i>linked to</i> that parent. The parent may be itself a differencing
12138	medium, thus forming a chain of linked media. The last element in that
12139	chain must always be a base medium. Note that several differencing
12140	media may be linked to the same parent medium.
12141
12142	Differencing media can be distinguished from base media by querying the
12143	<link to="#parent"/> attribute: base media do not have parents they would
12144	depend on, so the value of this attribute is always @c null for them.
12145	Using this attribute, it is possible to walk up the medium tree (from the
12146	child medium to its parent). It is also possible to walk down the tree
12147	using the <link to="#children"/> attribute.
12148
12149	Note that the type of all differencing media is "normal"; all other
12150	values are meaningless for them. Base media may be of any type.
12151
12152	<h3>Automatic composition of the file name part</h3>
12153
12154	Another extension to the <link to="IMedium::location"/> attribute is that
12155	there is a possibility to cause VirtualBox to compose a unique value for
12156	the file name part of the location using the UUID of the hard disk. This
12157	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12158	e.g. before the storage unit is created, and works as follows. You set the
12159	value of the <link to="IMedium::location"/> attribute to a location
12160	specification which only contains the path specification but not the file
12161	name part and ends with either a forward slash or a backslash character.
12162	In response, VirtualBox will generate a new UUID for the hard disk and
12163	compose the file name using the following pattern:
12164	<pre>
12165	<path>/{<uuid>}.<ext>
12166	</pre>
12167	where <tt><path></tt> is the supplied path specification,
12168	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12169	is the default extension for the storage format of this hard disk. After
12170	that, you may call any of the methods that create a new hard disk storage
12171	unit and they will use the generated UUID and file name.
12172	</desc>
12173
12174	<attribute name="id" type="uuid" mod="string" readonly="yes">
12175	<desc>
12176	UUID of the medium. For a newly created medium, this value is a randomly
12177	generated UUID.
12178
12179	<note>
12180	For media in one of MediumState_NotCreated, MediumState_Creating or
12181	MediumState_Deleting states, the value of this property is undefined
12182	and will most likely be an empty UUID.
12183	</note>
12184	</desc>
12185	</attribute>
12186
12187	<attribute name="description" type="wstring">
12188	<desc>
12189	Optional description of the medium. For a newly created medium the value
12190	of this attribute is an empty string.
12191
12192	Medium types that don't support this attribute will return E_NOTIMPL in
12193	attempt to get or set this attribute's value.
12194
12195	<note>
12196	For some storage types, reading this attribute may return an outdated
12197	(last known) value when <link to="#state"/> is <link
12198	to="MediumState_Inaccessible"/> or <link
12199	to="MediumState_LockedWrite"/> because the value of this attribute is
12200	stored within the storage unit itself. Also note that changing the
12201	attribute value is not possible in such case, as well as when the
12202	medium is the <link to="MediumState_LockedRead"/> state.
12203	</note>
12204	</desc>
12205	</attribute>
12206
12207	<attribute name="state" type="MediumState" readonly="yes">
12208	<desc>
12209	Returns the current medium state, which is the last state set by
12210	the accessibility check performed by <link to="#refreshState"/>.
12211	If that method has not yet been called on the medium, the state
12212	is "Inaccessible"; as opposed to truly inaccessible media, the
12213	value of <link to="#lastAccessError"/> will be an empty string in
12214	that case.
12215
12216	<note>As of version 3.1, this no longer performs an accessibility check
12217	automatically; call <link to="#refreshState"/> for that.
12218	</note>
12219	</desc>
12220	</attribute>
12221
12222	<attribute name="variant" type="unsigned long" readonly="yes">
12223	<desc>
12224	Returns the storage format variant information for this medium
12225	as a combination of the flags described at <link to="MediumVariant" />.
12226	Before <link to="#refreshState"/> is called this method returns
12227	an undefined value.
12228	</desc>
12229	</attribute>
12230
12231	<attribute name="location" type="wstring">
12232	<desc>
12233	Location of the storage unit holding medium data.
12234
12235	The format of the location string is medium type specific. For medium
12236	types using regular files in a host's file system, the location
12237	string is the full file name.
12238
12239	Some medium types may support changing the storage unit location by
12240	simply changing the value of this property. If this operation is not
12241	supported, the implementation will return E_NOTIMPL in attempt to set
12242	this attribute's value.
12243
12244	When setting a value of the location attribute which is a regular file
12245	in the host's file system, the given file name may be either relative to
12246	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12247	absolute. Note that if the given location specification does not contain
12248	the file extension part then a proper default extension will be
12249	automatically appended by the implementation depending on the medium type.
12250	</desc>
12251	</attribute>
12252
12253	<attribute name="name" type="wstring" readonly="yes">
12254	<desc>
12255	Name of the storage unit holding medium data.
12256
12257	The returned string is a short version of the <link to="#location"/>
12258	attribute that is suitable for representing the medium in situations
12259	where the full location specification is too long (such as lists
12260	and comboboxes in GUI frontends). This string is also used by frontends
12261	to sort the media list alphabetically when needed.
12262
12263	For example, for locations that are regular files in the host's file
12264	system, the value of this attribute is just the file name (+ extension),
12265	without the path specification.
12266
12267	Note that as opposed to the <link to="#location"/> attribute, the name
12268	attribute will not necessary be unique for a list of media of the
12269	given type and format.
12270	</desc>
12271	</attribute>
12272
12273	<attribute name="deviceType" type="DeviceType" readonly="yes">
12274	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12275	medium.</desc>
12276	</attribute>
12277
12278	<attribute name="hostDrive" type="boolean" readonly="yes">
12279	<desc>True if this corresponds to a drive on the host.</desc>
12280	</attribute>
12281
12282	<attribute name="size" type="long long" readonly="yes">
12283	<desc>
12284	Physical size of the storage unit used to hold medium data (in bytes).
12285
12286	<note>
12287	For media whose <link to="#state"/> is <link
12288	to="MediumState_Inaccessible"/>, the value of this property is the
12289	last known size. For <link to="MediumState_NotCreated"/> media,
12290	the returned value is zero.
12291	</note>
12292	</desc>
12293	</attribute>
12294
12295	<attribute name="format" type="wstring" readonly="yes">
12296	<desc>
12297	Storage format of this medium.
12298
12299	The value of this attribute is a string that specifies a backend used
12300	to store medium data. The storage format is defined when you create a
12301	new medium or automatically detected when you open an existing medium,
12302	and cannot be changed later.
12303
12304	The list of all storage formats supported by this VirtualBox
12305	installation can be obtained using
12306	<link to="ISystemProperties::mediumFormats"/>.
12307	</desc>
12308	</attribute>
12309
12310	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12311	<desc>
12312	Storage medium format object corresponding to this medium.
12313
12314	The value of this attribute is a reference to the medium format object
12315	that specifies the backend properties used to store medium data. The
12316	storage format is defined when you create a new medium or automatically
12317	detected when you open an existing medium, and cannot be changed later.
12318
12319	<note>@c null is returned if there is no associated medium format
12320	object. This can e.g. happen for medium objects representing host
12321	drives and other special medium objects.</note>
12322	</desc>
12323	</attribute>
12324
12325	<attribute name="type" type="MediumType">
12326	<desc>
12327	Type (role) of this medium.
12328
12329	The following constraints apply when changing the value of this
12330	attribute:
12331	<ul>
12332	<li>If a medium is attached to a virtual machine (either in the
12333	current state or in one of the snapshots), its type cannot be
12334	changed.
12335	</li>
12336	<li>As long as the medium has children, its type cannot be set
12337	to <link to="MediumType_Writethrough"/>.
12338	</li>
12339	<li>The type of all differencing media is
12340	<link to="MediumType_Normal"/> and cannot be changed.
12341	</li>
12342	</ul>
12343
12344	The type of a newly created or opened medium is set to
12345	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12346	which have a type of <link to="MediumType_Writethrough"/>.
12347	</desc>
12348	</attribute>
12349
12350	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12351	<desc>
12352	Returns which medium types can selected for this medium.
12353
12354	<result name="E_NOTIMPL">
12355	This attribute is not implemented at the moment.
12356	</result>
12357	</desc>
12358	</attribute>
12359
12360	<attribute name="parent" type="IMedium" readonly="yes">
12361	<desc>
12362	Parent of this medium (the medium this medium is directly based
12363	on).
12364
12365	Only differencing media have parents. For base (non-differencing)
12366	media, @c null is returned.
12367	</desc>
12368	</attribute>
12369
12370	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12371	<desc>
12372	Children of this medium (all differencing media directly based
12373	on this medium). A @c null array is returned if this medium
12374	does not have any children.
12375	</desc>
12376	</attribute>
12377
12378	<attribute name="base" type="IMedium" readonly="yes">
12379	<desc>
12380	Base medium of this medium.
12381
12382	If this is a differencing medium, its base medium is the medium
12383	the given medium branch starts from. For all other types of media, this
12384	property returns the medium object itself (i.e. the same object this
12385	property is read on).
12386	</desc>
12387	</attribute>
12388
12389	<attribute name="readOnly" type="boolean" readonly="yes">
12390	<desc>
12391	Returns @c true if this medium is read-only and @c false otherwise.
12392
12393	A medium is considered to be read-only when its contents cannot be
12394	modified without breaking the integrity of other parties that depend on
12395	this medium such as its child media or snapshots of virtual machines
12396	where this medium is attached to these machines. If there are no
12397	children and no such snapshots then there is no dependency and the
12398	medium is not read-only.
12399
12400	The value of this attribute can be used to determine the kind of the
12401	attachment that will take place when attaching this medium to a
12402	virtual machine. If the value is @c false then the medium will
12403	be attached directly. If the value is @c true then the medium
12404	will be attached indirectly by creating a new differencing child
12405	medium for that. See the interface description for more information.
12406
12407	Note that all <link to="MediumType_Immutable">Immutable</link> media
12408	are always read-only while all
12409	<link to="MediumType_Writethrough">Writethrough</link> media are
12410	always not.
12411
12412	<note>
12413	The read-only condition represented by this attribute is related to
12414	the medium type and usage, not to the current
12415	<link to="IMedium::state">medium state</link> and not to the read-only
12416	state of the storage unit.
12417	</note>
12418	</desc>
12419	</attribute>
12420
12421	<attribute name="logicalSize" type="long long" readonly="yes">
12422	<desc>
12423	Logical size of this medium (in bytes), as reported to the
12424	guest OS running inside the virtual machine this medium is
12425	attached to. The logical size is defined when the medium is created
12426	and cannot be changed later.
12427
12428	<note>
12429	Reading this property on a differencing medium will return the size
12430	of its <link to="#base"/> medium.
12431	</note>
12432	<note>
12433	For media whose state is <link to="#state"/> is <link
12434	to="MediumState_Inaccessible"/>, the value of this property is the
12435	last known logical size. For <link to="MediumState_NotCreated"/>
12436	media, the returned value is zero.
12437	</note>
12438	</desc>
12439	</attribute>
12440
12441	<attribute name="autoReset" type="boolean">
12442	<desc>
12443	Whether this differencing medium will be automatically reset each
12444	time a virtual machine it is attached to is powered up. This
12445	attribute is automatically set to @c true for the last
12446	differencing image of an "immutable" medium (see
12447	<link to="MediumType" />).
12448
12449	See <link to="#reset"/> for more information about resetting
12450	differencing media.
12451
12452	<note>
12453	Reading this property on a base (non-differencing) medium will
12454	always @c false. Changing the value of this property in this
12455	case is not supported.
12456	</note>
12457
12458	<result name="VBOX_E_NOT_SUPPORTED">
12459	This is not a differencing medium (when changing the attribute
12460	value).
12461	</result>
12462	</desc>
12463	</attribute>
12464
12465	<attribute name="lastAccessError" type="wstring" readonly="yes">
12466	<desc>
12467	Text message that represents the result of the last accessibility
12468	check performed by <link to="#refreshState"/>.
12469
12470	An empty string is returned if the last accessibility check
12471	was successful or has not yet been called. As a result, if
12472	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12473	then <link to="#refreshState"/> has yet to be called; this is the
12474	default value of media after VirtualBox initialization.
12475	A non-empty string indicates a failure and should normally describe
12476	a reason of the failure (for example, a file read error).
12477	</desc>
12478	</attribute>
12479
12480	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12481	<desc>
12482	Array of UUIDs of all machines this medium is attached to.
12483
12484	A @c null array is returned if this medium is not attached to any
12485	machine or to any machine's snapshot.
12486
12487	<note>
12488	The returned array will include a machine even if this medium is not
12489	attached to that machine in the current state but attached to it in
12490	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12491	details.
12492	</note>
12493	</desc>
12494	</attribute>
12495
12496	<method name="setIds">
12497	<desc>
12498	Changes the UUID and parent UUID for a hard disk medium.
12499	</desc>
12500	<param name="setImageId" type="boolean" dir="in">
12501	<desc>
12502	Select whether a new image UUID is set or not.
12503	</desc>
12504	</param>
12505	<param name="imageId" type="uuid" mod="string" dir="in">
12506	<desc>
12507	New UUID for the image. If an empty string is passed, then a new
12508	UUID is automatically created, provided that @a setImageId is @c true.
12509	Specifying a zero UUID is not allowed.
12510	</desc>
12511	</param>
12512	<param name="setParentId" type="boolean" dir="in">
12513	<desc>
12514	Select whether a new parent UUID is set or not.
12515	</desc>
12516	</param>
12517	<param name="parentId" type="uuid" mod="string" dir="in">
12518	<desc>
12519	New parent UUID for the image. If an empty string is passed, then a
12520	new UUID is automatically created, provided @a setParentId is
12521	@c true. A zero UUID is valid.
12522	</desc>
12523	</param>
12524	<result name="E_INVALIDARG">
12525	Invalid parameter combination.
12526	</result>
12527	<result name="VBOX_E_NOT_SUPPORTED">
12528	Medium is not a hard disk medium.
12529	</result>
12530	</method>
12531
12532	<method name="refreshState">
12533	<desc>
12534	If the current medium state (see <link to="MediumState"/>) is one of
12535	"Created", "Inaccessible" or "LockedRead", then this performs an
12536	accessibility check on the medium and sets the value of the <link to="#state"/>
12537	attribute accordingly; that value is also returned for convenience.
12538
12539	For all other state values, this does not perform a refresh but returns
12540	the state only.
12541
12542	The refresh, if performed, may take a long time (several seconds or even
12543	minutes, depending on the storage unit location and format) because it performs an
12544	accessibility check of the storage unit. This check may cause a significant
12545	delay if the storage unit of the given medium is, for example, a file located
12546	on a network share which is not currently accessible due to connectivity
12547	problems. In that case, the call will not return until a timeout
12548	interval defined by the host OS for this operation expires. For this reason,
12549	it is recommended to never read this attribute on the main UI thread to avoid
12550	making the UI unresponsive.
12551
12552	If the last known state of the medium is "Created" and the accessibility
12553	check fails, then the state would be set to "Inaccessible", and
12554	<link to="#lastAccessError"/> may be used to get more details about the
12555	failure. If the state of the medium is "LockedRead", then it remains the
12556	same, and a non-empty value of <link to="#lastAccessError"/> will
12557	indicate a failed accessibility check in this case.
12558
12559	Note that not all medium states are applicable to all medium types.
12560	</desc>
12561	<param name="state" type="MediumState" dir="return">
12562	<desc>
12563	New medium state.
12564	</desc>
12565	</param>
12566	</method>
12567
12568	<method name="getSnapshotIds">
12569	<desc>
12570	Returns an array of UUIDs of all snapshots of the given machine where
12571	this medium is attached to.
12572
12573	If the medium is attached to the machine in the current state, then the
12574	first element in the array will always be the ID of the queried machine
12575	(i.e. the value equal to the @c machineId argument), followed by
12576	snapshot IDs (if any).
12577
12578	If the medium is not attached to the machine in the current state, then
12579	the array will contain only snapshot IDs.
12580
12581	The returned array may be @c null if this medium is not attached
12582	to the given machine at all, neither in the current state nor in one of
12583	the snapshots.
12584	</desc>
12585	<param name="machineId" type="uuid" mod="string" dir="in">
12586	<desc>
12587	UUID of the machine to query.
12588	</desc>
12589	</param>
12590	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
12591	<desc>
12592	Array of snapshot UUIDs of the given machine using this medium.
12593	</desc>
12594	</param>
12595	</method>
12596
12597	<method name="lockRead">
12598	<desc>
12599	Locks this medium for reading.
12600
12601	A read lock is shared: many clients can simultaneously lock the
12602	same medium for reading unless it is already locked for writing (see
12603	<link to="#lockWrite"/>) in which case an error is returned.
12604
12605	When the medium is locked for reading, it cannot be modified
12606	from within VirtualBox. This means that any method that changes
12607	the properties of this medium or contents of the storage unit
12608	will return an error (unless explicitly stated otherwise). That
12609	includes an attempt to start a virtual machine that wants to
12610	write to the the medium.
12611
12612	When the virtual machine is started up, it locks for reading all
12613	media it uses in read-only mode. If some medium cannot be locked
12614	for reading, the startup procedure will fail.
12615	A medium is typically locked for reading while it is used by a running
12616	virtual machine but has a depending differencing image that receives
12617	the actual write operations. This way one base medium can have
12618	multiple child differencing images which can be written to
12619	simultaneously. Read-only media such as DVD and floppy images are
12620	also locked for reading only (so they can be in use by multiple
12621	machines simultaneously).
12622
12623	A medium is also locked for reading when it is the source of a
12624	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12625
12626	The medium locked for reading must be unlocked using the <link
12627	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
12628	can be nested and must be followed by the same number of paired
12629	<link to="#unlockRead"/> calls.
12630
12631	This method sets the medium state (see <link to="#state"/>) to
12632	"LockedRead" on success. The medium's previous state must be
12633	one of "Created", "Inaccessible" or "LockedRead".
12634
12635	Locking an inaccessible medium is not an error; this method performs
12636	a logical lock that prevents modifications of this medium through
12637	the VirtualBox API, not a physical file-system lock of the underlying
12638	storage unit.
12639
12640	This method returns the current state of the medium
12641	<i>before</i> the operation.
12642
12643	<result name="VBOX_E_INVALID_OBJECT_STATE">
12644	Invalid medium state (e.g. not created, locked, inaccessible,
12645	creating, deleting).
12646	</result>
12647
12648	</desc>
12649	<param name="state" type="MediumState" dir="return">
12650	<desc>
12651	State of the medium after the operation.
12652	</desc>
12653	</param>
12654	</method>
12655
12656	<method name="unlockRead">
12657	<desc>
12658	Cancels the read lock previously set by <link to="#lockRead"/>.
12659
12660	For both success and failure, this method returns the current state
12661	of the medium <i>after</i> the operation.
12662
12663	See <link to="#lockRead"/> for more details.
12664
12665	<result name="VBOX_E_INVALID_OBJECT_STATE">
12666	Medium not locked for reading.
12667	</result>
12668
12669	</desc>
12670	<param name="state" type="MediumState" dir="return">
12671	<desc>
12672	State of the medium after the operation.
12673	</desc>
12674	</param>
12675	</method>
12676
12677	<method name="lockWrite">
12678	<desc>
12679	Locks this medium for writing.
12680
12681	A write lock, as opposed to <link to="#lockRead"/>, is
12682	exclusive: there may be only one client holding a write lock,
12683	and there may be no read locks while the write lock is held.
12684	As a result, read-locking fails if a write lock is held, and
12685	write-locking fails if either a read or another write lock is held.
12686
12687	When a medium is locked for writing, it cannot be modified
12688	from within VirtualBox, and it is not guaranteed that the values
12689	of its properties are up-to-date. Any method that changes the
12690	properties of this medium or contents of the storage unit will
12691	return an error (unless explicitly stated otherwise).
12692
12693	When a virtual machine is started up, it locks for writing all
12694	media it uses to write data to. If any medium could not be locked
12695	for writing, the startup procedure will fail. If a medium has
12696	differencing images, then while the machine is running, only
12697	the last ("leaf") differencing image is locked for writing,
12698	whereas its parents are locked for reading only.
12699
12700	A medium is also locked for writing when it is the target of a
12701	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12702
12703	The medium locked for writing must be unlocked using the <link
12704	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
12705
12706	This method sets the medium state (see <link to="#state"/>) to
12707	"LockedWrite" on success. The medium's previous state must be
12708	either "Created" or "Inaccessible".
12709
12710	Locking an inaccessible medium is not an error; this method performs
12711	a logical lock that prevents modifications of this medium through
12712	the VirtualBox API, not a physical file-system lock of the underlying
12713	storage unit.
12714
12715	For both, success and failure, this method returns the current
12716	state of the medium <i>before</i> the operation.
12717
12718	<result name="VBOX_E_INVALID_OBJECT_STATE">
12719	Invalid medium state (e.g. not created, locked, inaccessible,
12720	creating, deleting).
12721	</result>
12722
12723	</desc>
12724	<param name="state" type="MediumState" dir="return">
12725	<desc>
12726	State of the medium after the operation.
12727	</desc>
12728	</param>
12729	</method>
12730
12731	<method name="unlockWrite">
12732	<desc>
12733	Cancels the write lock previously set by <link to="#lockWrite"/>.
12734
12735	For both success and failure, this method returns the current
12736	state of the medium <i>after</i> the operation.
12737
12738	See <link to="#lockWrite"/> for more details.
12739
12740	<result name="VBOX_E_INVALID_OBJECT_STATE">
12741	Medium not locked for writing.
12742	</result>
12743
12744	</desc>
12745	<param name="state" type="MediumState" dir="return">
12746	<desc>
12747	State of the medium after the operation.
12748	</desc>
12749	</param>
12750	</method>
12751
12752	<method name="close">
12753	<desc>
12754	Closes this medium.
12755
12756	The medium must not be attached to any known virtual machine
12757	and must not have any known child media, otherwise the
12758	operation will fail.
12759
12760	When the medium is successfully closed, it is removed from
12761	the list of registered media, but its storage unit is not
12762	deleted. In particular, this means that this medium can
12763	later be opened again using the <link to="IVirtualBox::openMedium"/>
12764	call.
12765
12766	Note that after this method successfully returns, the given medium
12767	object becomes uninitialized. This means that any attempt
12768	to call any of its methods or attributes will fail with the
12769	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
12770
12771	<result name="VBOX_E_INVALID_OBJECT_STATE">
12772	Invalid medium state (other than not created, created or
12773	inaccessible).
12774	</result>
12775	<result name="VBOX_E_OBJECT_IN_USE">
12776	Medium attached to virtual machine.
12777	</result>
12778	<result name="VBOX_E_FILE_ERROR">
12779	Settings file not accessible.
12780	</result>
12781	<result name="VBOX_E_XML_ERROR">
12782	Could not parse the settings file.
12783	</result>
12784
12785	</desc>
12786	</method>
12787
12788	<!-- property methods -->
12789
12790	<method name="getProperty" const="yes">
12791	<desc>
12792	Returns the value of the custom medium property with the given name.
12793
12794	The list of all properties supported by the given medium format can
12795	be obtained with <link to="IMediumFormat::describeProperties"/>.
12796
12797	<note>If this method returns an empty string in @a value, the requested
12798	property is supported but currently not assigned any value.</note>
12799
12800	<result name="VBOX_E_OBJECT_NOT_FOUND">
12801	Requested property does not exist (not supported by the format).
12802	</result>
12803	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12804	</desc>
12805	<param name="name" type="wstring" dir="in">
12806	<desc>Name of the property to get.</desc>
12807	</param>
12808	<param name="value" type="wstring" dir="return">
12809	<desc>Current property value.</desc>
12810	</param>
12811	</method>
12812
12813	<method name="setProperty">
12814	<desc>
12815	Sets the value of the custom medium property with the given name.
12816
12817	The list of all properties supported by the given medium format can
12818	be obtained with <link to="IMediumFormat::describeProperties"/>.
12819
12820	<note>Setting the property value to @c null or an empty string is
12821	equivalent to deleting the existing value. A default value (if it is
12822	defined for this property) will be used by the format backend in this
12823	case.</note>
12824
12825	<result name="VBOX_E_OBJECT_NOT_FOUND">
12826	Requested property does not exist (not supported by the format).
12827	</result>
12828	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12829	</desc>
12830	<param name="name" type="wstring" dir="in">
12831	<desc>Name of the property to set.</desc>
12832	</param>
12833	<param name="value" type="wstring" dir="in">
12834	<desc>Property value to set.</desc>
12835	</param>
12836	</method>
12837
12838	<method name="getProperties" const="yes">
12839	<desc>
12840	Returns values for a group of properties in one call.
12841
12842	The names of the properties to get are specified using the @a names
12843	argument which is a list of comma-separated property names or
12844	an empty string if all properties are to be returned.
12845	<note>Currently the value of this argument is ignored and the method
12846	always returns all existing properties.</note>
12847
12848	The list of all properties supported by the given medium format can
12849	be obtained with <link to="IMediumFormat::describeProperties"/>.
12850
12851	The method returns two arrays, the array of property names corresponding
12852	to the @a names argument and the current values of these properties.
12853	Both arrays have the same number of elements with each element at the
12854	given index in the first array corresponds to an element at the same
12855	index in the second array.
12856
12857	For properties that do not have assigned values, an empty string is
12858	returned at the appropriate index in the @a returnValues array.
12859
12860	</desc>
12861	<param name="names" type="wstring" dir="in">
12862	<desc>
12863	Names of properties to get.
12864	</desc>
12865	</param>
12866	<param name="returnNames" type="wstring" safearray="yes" dir="out">
12867	<desc>Names of returned properties.</desc>
12868	</param>
12869	<param name="returnValues" type="wstring" safearray="yes" dir="return">
12870	<desc>Values of returned properties.</desc>
12871	</param>
12872	</method>
12873
12874	<method name="setProperties">
12875	<desc>
12876	Sets values for a group of properties in one call.
12877
12878	The names of the properties to set are passed in the @a names
12879	array along with the new values for them in the @a values array. Both
12880	arrays have the same number of elements with each element at the given
12881	index in the first array corresponding to an element at the same index
12882	in the second array.
12883
12884	If there is at least one property name in @a names that is not valid,
12885	the method will fail before changing the values of any other properties
12886	from the @a names array.
12887
12888	Using this method over <link to="#setProperty"/> is preferred if you
12889	need to set several properties at once since it is more efficient.
12890
12891	The list of all properties supported by the given medium format can
12892	be obtained with <link to="IMediumFormat::describeProperties"/>.
12893
12894	Setting the property value to @c null or an empty string is equivalent
12895	to deleting the existing value. A default value (if it is defined for
12896	this property) will be used by the format backend in this case.
12897	</desc>
12898	<param name="names" type="wstring" safearray="yes" dir="in">
12899	<desc>Names of properties to set.</desc>
12900	</param>
12901	<param name="values" type="wstring" safearray="yes" dir="in">
12902	<desc>Values of properties to set.</desc>
12903	</param>
12904	</method>
12905
12906	<!-- storage methods -->
12907
12908	<method name="createBaseStorage">
12909	<desc>
12910	Starts creating a hard disk storage unit (fixed/dynamic, according
12911	to the variant flags) in in the background. The previous storage unit
12912	created for this object, if any, must first be deleted using
12913	<link to="#deleteStorage"/>, otherwise the operation will fail.
12914
12915	Before the operation starts, the medium is placed in
12916	<link to="MediumState_Creating"/> state. If the create operation
12917	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
12918	state.
12919
12920	After the returned progress object reports that the operation has
12921	successfully completed, the medium state will be set to <link
12922	to="MediumState_Created"/>, the medium will be remembered by this
12923	VirtualBox installation and may be attached to virtual machines.
12924
12925	<result name="VBOX_E_NOT_SUPPORTED">
12926	The variant of storage creation operation is not supported. See <link
12927	to="IMediumFormat::capabilities"/>.
12928	</result>
12929	</desc>
12930	<param name="logicalSize" type="long long" dir="in">
12931	<desc>Maximum logical size of the medium in bytes.</desc>
12932	</param>
12933	<param name="variant" type="unsigned long" dir="in">
12934	<desc>Exact image variant which should be created (as a combination of
12935	<link to="MediumVariant" /> flags).</desc>
12936	</param>
12937	<param name="progress" type="IProgress" dir="return">
12938	<desc>Progress object to track the operation completion.</desc>
12939	</param>
12940	</method>
12941
12942	<method name="deleteStorage">
12943	<desc>
12944	Starts deleting the storage unit of this medium.
12945
12946	The medium must not be attached to any known virtual machine and must
12947	not have any known child media, otherwise the operation will fail.
12948	It will also fail if there is no storage unit to delete or if deletion
12949	is already in progress, or if the medium is being in use (locked for
12950	read or for write) or inaccessible. Therefore, the only valid state for
12951	this operation to succeed is <link to="MediumState_Created"/>.
12952
12953	Before the operation starts, the medium is placed in
12954	<link to="MediumState_Deleting"/> state and gets removed from the list
12955	of remembered hard disks (media registry). If the delete operation
12956	fails, the medium will be remembered again and placed back to
12957	<link to="MediumState_Created"/> state.
12958
12959	After the returned progress object reports that the operation is
12960	complete, the medium state will be set to
12961	<link to="MediumState_NotCreated"/> and you will be able to use one of
12962	the storage creation methods to create it again.
12963
12964	<see><link to="#close"/></see>
12965
12966	<result name="VBOX_E_OBJECT_IN_USE">
12967	Medium is attached to a virtual machine.
12968	</result>
12969	<result name="VBOX_E_NOT_SUPPORTED">
12970	Storage deletion is not allowed because neither of storage creation
12971	operations are supported. See
12972	<link to="IMediumFormat::capabilities"/>.
12973	</result>
12974
12975	<note>
12976	If the deletion operation fails, it is not guaranteed that the storage
12977	unit still exists. You may check the <link to="IMedium::state"/> value
12978	to answer this question.
12979	</note>
12980	</desc>
12981	<param name="progress" type="IProgress" dir="return">
12982	<desc>Progress object to track the operation completion.</desc>
12983	</param>
12984	</method>
12985
12986	<!-- diff methods -->
12987
12988	<method name="createDiffStorage">
12989	<desc>
12990	Starts creating an empty differencing storage unit based on this
12991	medium in the format and at the location defined by the @a target
12992	argument.
12993
12994	The target medium must be in <link to="MediumState_NotCreated"/>
12995	state (i.e. must not have an existing storage unit). Upon successful
12996	completion, this operation will set the type of the target medium to
12997	<link to="MediumType_Normal"/> and create a storage unit necessary to
12998	represent the differencing medium data in the given format (according
12999	to the storage format of the target object).
13000
13001	After the returned progress object reports that the operation is
13002	successfully complete, the target medium gets remembered by this
13003	VirtualBox installation and may be attached to virtual machines.
13004
13005	<note>
13006	The medium will be set to <link to="MediumState_LockedRead"/>
13007	state for the duration of this operation.
13008	</note>
13009	<result name="VBOX_E_OBJECT_IN_USE">
13010	Medium not in @c NotCreated state.
13011	</result>
13012	</desc>
13013	<param name="target" type="IMedium" dir="in">
13014	<desc>Target medium.</desc>
13015	</param>
13016	<param name="variant" type="unsigned long" dir="in">
13017	<desc>Exact image variant which should be created (as a combination of
13018	<link to="MediumVariant" /> flags).</desc>
13019	</param>
13020	<param name="progress" type="IProgress" dir="return">
13021	<desc>Progress object to track the operation completion.</desc>
13022	</param>
13023	</method>
13024
13025	<method name="mergeTo">
13026	<desc>
13027	Starts merging the contents of this medium and all intermediate
13028	differencing media in the chain to the given target medium.
13029
13030	The target medium must be either a descendant of this medium or
13031	its ancestor (otherwise this method will immediately return a failure).
13032	It follows that there are two logical directions of the merge operation:
13033	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13034	ancestor (<i>backward merge</i>). Let us consider the following medium
13035	chain:
13036
13037	<pre>Base <- Diff_1 <- Diff_2</pre>
13038
13039	Here, calling this method on the <tt>Base</tt> medium object with
13040	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13041	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13042	merge. Note that in both cases the contents of the resulting medium
13043	will be the same, the only difference is the medium object that takes
13044	the result of the merge operation. In case of the forward merge in the
13045	above example, the result will be written to <tt>Diff_2</tt>; in case of
13046	the backward merge, the result will be written to <tt>Base</tt>. In
13047	other words, the result of the operation is always stored in the target
13048	medium.
13049
13050	Upon successful operation completion, the storage units of all media in
13051	the chain between this (source) medium and the target medium, including
13052	the source medium itself, will be automatically deleted and the
13053	relevant medium objects (including this medium) will become
13054	uninitialized. This means that any attempt to call any of
13055	their methods or attributes will fail with the
13056	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13057	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13058	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13059	Note that <tt>Diff_2</tt> in this case will become a base medium
13060	itself since it will no longer be based on any other medium.
13061
13062	Considering the above, all of the following conditions must be met in
13063	order for the merge operation to succeed:
13064	<ul>
13065	<li>
13066	Neither this (source) medium nor any intermediate
13067	differencing medium in the chain between it and the target
13068	medium is attached to any virtual machine.
13069	</li>
13070	<li>
13071	Neither the source medium nor the target medium is an
13072	<link to="MediumType_Immutable"/> medium.
13073	</li>
13074	<li>
13075	The part of the medium tree from the source medium to the
13076	target medium is a linear chain, i.e. all medium in this
13077	chain have exactly one child which is the next medium in this
13078	chain. The only exception from this rule is the target medium in
13079	the forward merge operation; it is allowed to have any number of
13080	child media because the merge operation will not change its
13081	logical contents (as it is seen by the guest OS or by children).
13082	</li>
13083	<li>
13084	None of the involved media are in
13085	<link to="MediumState_LockedRead"/> or
13086	<link to="MediumState_LockedWrite"/> state.
13087	</li>
13088	</ul>
13089
13090	<note>
13091	This (source) medium and all intermediates will be placed to <link
13092	to="MediumState_Deleting"/> state and the target medium will be
13093	placed to <link to="MediumState_LockedWrite"/> state and for the
13094	duration of this operation.
13095	</note>
13096	</desc>
13097	<param name="target" type="IMedium" dir="in">
13098	<desc>Target medium.</desc>
13099	</param>
13100	<param name="progress" type="IProgress" dir="return">
13101	<desc>Progress object to track the operation completion.</desc>
13102	</param>
13103	</method>
13104
13105	<!-- clone method -->
13106
13107	<method name="cloneTo">
13108	<desc>
13109	Starts creating a clone of this medium in the format and at the
13110	location defined by the @a target argument.
13111
13112	The target medium must be either in <link to="MediumState_NotCreated"/>
13113	state (i.e. must not have an existing storage unit) or in
13114	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13115	big enough to hold the data or else the copy will be partial). Upon
13116	successful completion, the cloned medium will contain exactly the
13117	same sector data as the medium being cloned, except that in the
13118	first case a new UUID for the clone will be randomly generated, and in
13119	the second case the UUID will remain unchanged.
13120
13121	The @a parent argument defines which medium will be the parent
13122	of the clone. Passing a @c null reference indicates that the clone will
13123	be a base image, i.e. completely independent. It is possible to specify
13124	an arbitrary medium for this parameter, including the parent of the
13125	medium which is being cloned. Even cloning to a child of the source
13126	medium is possible. Note that when cloning to an existing image, the
13127	@a parent argument is ignored.
13128
13129	After the returned progress object reports that the operation is
13130	successfully complete, the target medium gets remembered by this
13131	VirtualBox installation and may be attached to virtual machines.
13132
13133	<note>
13134	This medium will be placed to <link to="MediumState_LockedRead"/>
13135	state for the duration of this operation.
13136	</note>
13137	<result name="E_NOTIMPL">
13138	The specified cloning variant is not supported at the moment.
13139	</result>
13140	</desc>
13141	<param name="target" type="IMedium" dir="in">
13142	<desc>Target medium.</desc>
13143	</param>
13144	<param name="variant" type="unsigned long" dir="in">
13145	<desc>Exact image variant which should be created (as a combination of
13146	<link to="MediumVariant" /> flags).</desc>
13147	</param>
13148	<param name="parent" type="IMedium" dir="in">
13149	<desc>Parent of the cloned medium.</desc>
13150	</param>
13151	<param name="progress" type="IProgress" dir="return">
13152	<desc>Progress object to track the operation completion.</desc>
13153	</param>
13154	</method>
13155
13156	<method name="cloneToBase">
13157	<desc>
13158	Starts creating a clone of this medium in the format and at the
13159	location defined by the @a target argument.
13160
13161	The target medium must be either in <link to="MediumState_NotCreated"/>
13162	state (i.e. must not have an existing storage unit) or in
13163	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13164	big enough to hold the data or else the copy will be partial). Upon
13165	successful completion, the cloned medium will contain exactly the
13166	same sector data as the medium being cloned, except that in the
13167	first case a new UUID for the clone will be randomly generated, and in
13168	the second case the UUID will remain unchanged.
13169
13170	The @a parent argument defines which medium will be the parent
13171	of the clone. In this case the clone will be a base image, i.e.
13172	completely independent. It is possible to specify an arbitrary
13173	medium for this parameter, including the parent of the
13174	medium which is being cloned. Even cloning to a child of the source
13175	medium is possible. Note that when cloning to an existing image, the
13176	@a parent argument is ignored.
13177
13178	After the returned progress object reports that the operation is
13179	successfully complete, the target medium gets remembered by this
13180	VirtualBox installation and may be attached to virtual machines.
13181
13182	<note>
13183	This medium will be placed to <link to="MediumState_LockedRead"/>
13184	state for the duration of this operation.
13185	</note>
13186	<result name="E_NOTIMPL">
13187	The specified cloning variant is not supported at the moment.
13188	</result>
13189	</desc>
13190	<param name="target" type="IMedium" dir="in">
13191	<desc>Target medium.</desc>
13192	</param>
13193	<param name="variant" type="unsigned long" dir="in">
13194	<desc>Exact image variant which should be created (as a combination of
13195	<link to="MediumVariant" /> flags).</desc>
13196	</param>
13197	<param name="progress" type="IProgress" dir="return">
13198	<desc>Progress object to track the operation completion.</desc>
13199	</param>
13200	</method>
13201
13202	<!-- other methods -->
13203
13204	<method name="compact">
13205	<desc>
13206	Starts compacting of this medium. This means that the medium is
13207	transformed into a possibly more compact storage representation.
13208	This potentially creates temporary images, which can require a
13209	substantial amount of additional disk space.
13210
13211	This medium will be placed to <link to="MediumState_LockedWrite"/>
13212	state and all its parent media (if any) will be placed to
13213	<link to="MediumState_LockedRead"/> state for the duration of this
13214	operation.
13215
13216	Please note that the results can be either returned straight away,
13217	or later as the result of the background operation via the object
13218	returned via the @a progress parameter.
13219
13220	<result name="VBOX_E_NOT_SUPPORTED">
13221	Medium format does not support compacting (but potentially
13222	needs it).
13223	</result>
13224	</desc>
13225	<param name="progress" type="IProgress" dir="return">
13226	<desc>Progress object to track the operation completion.</desc>
13227	</param>
13228	</method>
13229
13230	<method name="resize">
13231	<desc>
13232	Starts resizing this medium. This means that the nominal size of the
13233	medium is set to the new value. Both increasing and decreasing the
13234	size is possible, and there are no safety checks, since VirtualBox
13235	does not make any assumptions about the medium contents.
13236
13237	Resizing usually needs additional disk space, and possibly also
13238	some temporary disk space. Note that resize does not create a full
13239	temporary copy of the medium, so the additional disk space requirement
13240	is usually much lower than using the clone operation.
13241
13242	This medium will be placed to <link to="MediumState_LockedWrite"/>
13243	state for the duration of this operation.
13244
13245	Please note that the results can be either returned straight away,
13246	or later as the result of the background operation via the object
13247	returned via the @a progress parameter.
13248
13249	<result name="VBOX_E_NOT_SUPPORTED">
13250	Medium format does not support resizing.
13251	</result>
13252	</desc>
13253	<param name="logicalSize" type="long long" dir="in">
13254	<desc>New nominal capacity of the medium in bytes.</desc>
13255	</param>
13256	<param name="progress" type="IProgress" dir="return">
13257	<desc>Progress object to track the operation completion.</desc>
13258	</param>
13259	</method>
13260
13261	<method name="reset">
13262	<desc>
13263	Starts erasing the contents of this differencing medium.
13264
13265	This operation will reset the differencing medium to its initial
13266	state when it does not contain any sector data and any read operation is
13267	redirected to its parent medium. This automatically gets called
13268	during VM power-up for every medium whose <link to="#autoReset" />
13269	attribute is @c true.
13270
13271	The medium will be write-locked for the duration of this operation (see
13272	<link to="#lockWrite" />).
13273
13274	<result name="VBOX_E_NOT_SUPPORTED">
13275	This is not a differencing medium.
13276	</result>
13277	<result name="VBOX_E_INVALID_OBJECT_STATE">
13278	Medium is not in <link to="MediumState_Created"/> or
13279	<link to="MediumState_Inaccessible"/> state.
13280	</result>
13281	</desc>
13282	<param name="progress" type="IProgress" dir="return">
13283	<desc>Progress object to track the operation completion.</desc>
13284	</param>
13285	</method>
13286
13287	</interface>
13288
13289
13290	<!--
13291	// IMediumFormat
13292	/////////////////////////////////////////////////////////////////////////
13293	-->
13294
13295	<enum
13296	name="DataType"
13297	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13298	>
13299	<const name="Int32" value="0"/>
13300	<const name="Int8" value="1"/>
13301	<const name="String" value="2"/>
13302	</enum>
13303
13304	<enum
13305	name="DataFlags"
13306	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13307	>
13308	<const name="None" value="0x00"/>
13309	<const name="Mandatory" value="0x01"/>
13310	<const name="Expert" value="0x02"/>
13311	<const name="Array" value="0x04"/>
13312	<const name="FlagMask" value="0x07"/>
13313	</enum>
13314
13315	<enum
13316	name="MediumFormatCapabilities"
13317	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13318	>
13319	<desc>
13320	Medium format capability flags.
13321	</desc>
13322
13323	<const name="Uuid" value="0x01">
13324	<desc>
13325	Supports UUIDs as expected by VirtualBox code.
13326	</desc>
13327	</const>
13328
13329	<const name="CreateFixed" value="0x02">
13330	<desc>
13331	Supports creating fixed size images, allocating all space instantly.
13332	</desc>
13333	</const>
13334
13335	<const name="CreateDynamic" value="0x04">
13336	<desc>
13337	Supports creating dynamically growing images, allocating space on
13338	demand.
13339	</desc>
13340	</const>
13341
13342	<const name="CreateSplit2G" value="0x08">
13343	<desc>
13344	Supports creating images split in chunks of a bit less than 2 GBytes.
13345	</desc>
13346	</const>
13347
13348	<const name="Differencing" value="0x10">
13349	<desc>
13350	Supports being used as a format for differencing media (see <link
13351	to="IMedium::createDiffStorage"/>).
13352	</desc>
13353	</const>
13354
13355	<const name="Asynchronous" value="0x20">
13356	<desc>
13357	Supports asynchronous I/O operations for at least some configurations.
13358	</desc>
13359	</const>
13360
13361	<const name="File" value="0x40">
13362	<desc>
13363	The format backend operates on files (the <link to="IMedium::location"/>
13364	attribute of the medium specifies a file used to store medium
13365	data; for a list of supported file extensions see
13366	<link to="IMediumFormat::describeFileExtensions"/>).
13367	</desc>
13368	</const>
13369
13370	<const name="Properties" value="0x80">
13371	<desc>
13372	The format backend uses the property interface to configure the storage
13373	location and properties (the <link to="IMediumFormat::describeProperties"/>
13374	method is used to get access to properties supported by the given medium format).
13375	</desc>
13376	</const>
13377
13378	<const name="TcpNetworking" value="0x100">
13379	<desc>
13380	The format backend uses the TCP networking interface for network access.
13381	</desc>
13382	</const>
13383
13384	<const name="VFS" value="0x200">
13385	<desc>
13386	The format backend supports virtual filesystem functionality.
13387	</desc>
13388	</const>
13389
13390	<const name="CapabilityMask" value="0x3FF"/>
13391	</enum>
13392
13393	<interface
13394	name="IMediumFormat" extends="$unknown"
13395	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
13396	wsmap="managed"
13397	>
13398	<desc>
13399	The IMediumFormat interface represents a medium format.
13400
13401	Each medium format has an associated backend which is used to handle
13402	media stored in this format. This interface provides information
13403	about the properties of the associated backend.
13404
13405	Each medium format is identified by a string represented by the
13406	<link to="#id"/> attribute. This string is used in calls like
13407	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13408	format.
13409
13410	The list of all supported medium formats can be obtained using
13411	<link to="ISystemProperties::mediumFormats"/>.
13412
13413	<see><link to="IMedium"/></see>
13414	</desc>
13415
13416	<attribute name="id" type="wstring" readonly="yes">
13417	<desc>
13418	Identifier of this format.
13419
13420	The format identifier is a non-@c null non-empty ASCII string. Note that
13421	this string is case-insensitive. This means that, for example, all of
13422	the following strings:
13423	<pre>
13424	"VDI"
13425	"vdi"
13426	"VdI"</pre>
13427	refer to the same medium format.
13428
13429	This string is used in methods of other interfaces where it is necessary
13430	to specify a medium format, such as
13431	<link to="IVirtualBox::createHardDisk"/>.
13432	</desc>
13433	</attribute>
13434
13435	<attribute name="name" type="wstring" readonly="yes">
13436	<desc>
13437	Human readable description of this format.
13438
13439	Mainly for use in file open dialogs.
13440	</desc>
13441	</attribute>
13442
13443	<attribute name="capabilities" type="unsigned long" readonly="yes">
13444	<desc>
13445	Capabilities of the format as a set of bit flags.
13446
13447	For the meaning of individual capability flags see
13448	<link to="MediumFormatCapabilities"/>.
13449	</desc>
13450	</attribute>
13451
13452	<method name="describeFileExtensions">
13453	<desc>
13454	Returns two arrays describing the supported file extensions.
13455
13456	The first array contains the supported extensions and the seconds one
13457	the type each extension supports. Both have the same size.
13458
13459	Note that some backends do not work on files, so this array may be
13460	empty.
13461
13462	<see><link to="IMediumFormat::capabilities"/></see>
13463	</desc>
13464	<param name="extensions" type="wstring" safearray="yes" dir="out">
13465	<desc>The array of supported extensions.</desc>
13466	</param>
13467	<param name="type" type="DeviceType" safearray="yes" dir="out">
13468	<desc>The array which indicates the device type for every given extension.</desc>
13469	</param>
13470	</method>
13471
13472	<method name="describeProperties" const="yes">
13473	<desc>
13474	Returns several arrays describing the properties supported by this
13475	format.
13476
13477	An element with the given index in each array describes one
13478	property. Thus, the number of elements in each returned array is the
13479	same and corresponds to the number of supported properties.
13480
13481	The returned arrays are filled in only if the
13482	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13483	All arguments must be non-@c null.
13484
13485	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13486	</desc>
13487
13488	<param name="names" type="wstring" safearray="yes" dir="out">
13489	<desc>Array of property names.</desc>
13490	</param>
13491	<param name="description" type="wstring" safearray="yes" dir="out">
13492	<desc>Array of property descriptions.</desc>
13493	</param>
13494	<param name="types" type="DataType" safearray="yes" dir="out">
13495	<desc>Array of property types.</desc>
13496	</param>
13497	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13498	<desc>Array of property flags.</desc>
13499	</param>
13500	<param name="defaults" type="wstring" safearray="yes" dir="out">
13501	<desc>Array of default property values.</desc>
13502	</param>
13503	</method>
13504
13505	</interface>
13506
13507
13508	<!--
13509	// IKeyboard
13510	/////////////////////////////////////////////////////////////////////////
13511	-->
13512
13513	<interface
13514	name="IKeyboard" extends="$unknown"
13515	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13516	wsmap="managed"
13517	>
13518	<desc>
13519	The IKeyboard interface represents the virtual machine's keyboard. Used
13520	in <link to="IConsole::keyboard"/>.
13521
13522	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13523	to the virtual machine.
13524
13525	</desc>
13526	<method name="putScancode">
13527	<desc>Sends a scancode to the keyboard.
13528
13529	<result name="VBOX_E_IPRT_ERROR">
13530	Could not send scan code to virtual keyboard.
13531	</result>
13532
13533	</desc>
13534	<param name="scancode" type="long" dir="in"/>
13535	</method>
13536
13537	<method name="putScancodes">
13538	<desc>Sends an array of scancodes to the keyboard.
13539
13540	<result name="VBOX_E_IPRT_ERROR">
13541	Could not send all scan codes to virtual keyboard.
13542	</result>
13543
13544	</desc>
13545	<param name="scancodes" type="long" dir="in" safearray="yes"/>
13546	<param name="codesStored" type="unsigned long" dir="return"/>
13547	</method>
13548
13549	<method name="putCAD">
13550	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
13551	function is nothing special, it is just a convenience function
13552	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
13553
13554	<result name="VBOX_E_IPRT_ERROR">
13555	Could not send all scan codes to virtual keyboard.
13556	</result>
13557
13558	</desc>
13559	</method>
13560
13561	<attribute name="eventSource" type="IEventSource" readonly="yes">
13562	<desc>
13563	Event source for keyboard events.
13564	</desc>
13565	</attribute>
13566
13567	</interface>
13568
13569
13570	<!--
13571	// IMouse
13572	/////////////////////////////////////////////////////////////////////////
13573	-->
13574
13575	<enum
13576	name="MouseButtonState"
13577	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
13578	>
13579	<desc>
13580	Mouse button state.
13581	</desc>
13582
13583	<const name="LeftButton" value="0x01"/>
13584	<const name="RightButton" value="0x02"/>
13585	<const name="MiddleButton" value="0x04"/>
13586	<const name="WheelUp" value="0x08"/>
13587	<const name="WheelDown" value="0x10"/>
13588	<const name="XButton1" value="0x20"/>
13589	<const name="XButton2" value="0x40"/>
13590	<const name="MouseStateMask" value="0x7F"/>
13591	</enum>
13592
13593	<interface
13594	name="IMouse" extends="$unknown"
13595	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
13596	wsmap="managed"
13597	>
13598	<desc>
13599	The IMouse interface represents the virtual machine's mouse. Used in
13600	<link to="IConsole::mouse"/>.
13601
13602	Through this interface, the virtual machine's virtual mouse can be
13603	controlled.
13604	</desc>
13605
13606	<attribute name="absoluteSupported" type="boolean" readonly="yes">
13607	<desc>
13608	Whether the guest OS supports absolute mouse pointer positioning
13609	or not.
13610	<note>
13611	You can use the <link to="IMouseCapabilityChangedEvent"/>
13612	event to be instantly informed about changes of this attribute
13613	during virtual machine execution.
13614	</note>
13615	<see><link to="#putMouseEventAbsolute"/></see>
13616	</desc>
13617	</attribute>
13618
13619	<attribute name="relativeSupported" type="boolean" readonly="yes">
13620	<desc>
13621	Whether the guest OS supports relative mouse pointer positioning
13622	or not.
13623	<note>
13624	You can use the <link to="IMouseCapabilityChangedEvent"/>
13625	event to be instantly informed about changes of this attribute
13626	during virtual machine execution.
13627	</note>
13628	<see><link to="#putMouseEvent"/></see>
13629	</desc>
13630	</attribute>
13631
13632	<attribute name="needsHostCursor" type="boolean" readonly="yes">
13633	<desc>
13634	Whether the guest OS can currently switch to drawing it's own mouse
13635	cursor on demand.
13636	<note>
13637	You can use the <link to="IMouseCapabilityChangedEvent"/>
13638	event to be instantly informed about changes of this attribute
13639	during virtual machine execution.
13640	</note>
13641	<see><link to="#putMouseEvent"/></see>
13642	</desc>
13643	</attribute>
13644
13645	<method name="putMouseEvent">
13646	<desc>
13647	Initiates a mouse event using relative pointer movements
13648	along x and y axis.
13649
13650	<result name="E_ACCESSDENIED">
13651	Console not powered up.
13652	</result>
13653	<result name="VBOX_E_IPRT_ERROR">
13654	Could not send mouse event to virtual mouse.
13655	</result>
13656
13657	</desc>
13658
13659	<param name="dx" type="long" dir="in">
13660	<desc>
13661	Amount of pixels the mouse should move to the right.
13662	Negative values move the mouse to the left.
13663	</desc>
13664	</param>
13665	<param name="dy" type="long" dir="in">
13666	<desc>
13667	Amount of pixels the mouse should move downwards.
13668	Negative values move the mouse upwards.
13669	</desc>
13670	</param>
13671	<param name="dz" type="long" dir="in">
13672	<desc>
13673	Amount of mouse wheel moves.
13674	Positive values describe clockwise wheel rotations,
13675	negative values describe counterclockwise rotations.
13676	</desc>
13677	</param>
13678	<param name="dw" type="long" dir="in">
13679	<desc>
13680	Amount of horizontal mouse wheel moves.
13681	Positive values describe a movement to the left,
13682	negative values describe a movement to the right.
13683	</desc>
13684	</param>
13685	<param name="buttonState" type="long" dir="in">
13686	<desc>
13687	The current state of mouse buttons. Every bit represents
13688	a mouse button as follows:
13689	<table>
13690	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
13691	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
13692	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
13693	</table>
13694	A value of <tt>1</tt> means the corresponding button is pressed.
13695	otherwise it is released.
13696	</desc>
13697	</param>
13698	</method>
13699
13700	<method name="putMouseEventAbsolute">
13701	<desc>
13702	Positions the mouse pointer using absolute x and y coordinates.
13703	These coordinates are expressed in pixels and
13704	start from <tt>[1,1]</tt> which corresponds to the top left
13705	corner of the virtual display.
13706
13707	<result name="E_ACCESSDENIED">
13708	Console not powered up.
13709	</result>
13710	<result name="VBOX_E_IPRT_ERROR">
13711	Could not send mouse event to virtual mouse.
13712	</result>
13713
13714	<note>
13715	This method will have effect only if absolute mouse
13716	positioning is supported by the guest OS.
13717	</note>
13718
13719	<see><link to="#absoluteSupported"/></see>
13720	</desc>
13721
13722	<param name="x" type="long" dir="in">
13723	<desc>
13724	X coordinate of the pointer in pixels, starting from @c 1.
13725	</desc>
13726	</param>
13727	<param name="y" type="long" dir="in">
13728	<desc>
13729	Y coordinate of the pointer in pixels, starting from @c 1.
13730	</desc>
13731	</param>
13732	<param name="dz" type="long" dir="in">
13733	<desc>
13734	Amount of mouse wheel moves.
13735	Positive values describe clockwise wheel rotations,
13736	negative values describe counterclockwise rotations.
13737	</desc>
13738	</param>
13739	<param name="dw" type="long" dir="in">
13740	<desc>
13741	Amount of horizontal mouse wheel moves.
13742	Positive values describe a movement to the left,
13743	negative values describe a movement to the right.
13744	</desc>
13745	</param>
13746	<param name="buttonState" type="long" dir="in">
13747	<desc>
13748	The current state of mouse buttons. Every bit represents
13749	a mouse button as follows:
13750	<table>
13751	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
13752	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
13753	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
13754	</table>
13755	A value of @c 1 means the corresponding button is pressed.
13756	otherwise it is released.
13757	</desc>
13758	</param>
13759	</method>
13760
13761	<attribute name="eventSource" type="IEventSource" readonly="yes">
13762	<desc>
13763	Event source for mouse events.
13764	</desc>
13765	</attribute>
13766
13767	</interface>
13768
13769	<!--
13770	// IDisplay
13771	/////////////////////////////////////////////////////////////////////////
13772	-->
13773
13774	<enum
13775	name="FramebufferPixelFormat"
13776	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
13777	>
13778	<desc>
13779	Format of the video memory buffer. Constants represented by this enum can
13780	be used to test for particular values of <link
13781	to="IFramebuffer::pixelFormat"/>. See also <link
13782	to="IFramebuffer::requestResize"/>.
13783
13784	See also www.fourcc.org for more information about FOURCC pixel formats.
13785	</desc>
13786
13787	<const name="Opaque" value="0">
13788	<desc>
13789	Unknown buffer format (the user may not assume any particular format of
13790	the buffer).
13791	</desc>
13792	</const>
13793	<const name="FOURCC_RGB" value="0x32424752">
13794	<desc>
13795	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
13796	bit layout).
13797	</desc>
13798	</const>
13799	</enum>
13800
13801	<interface
13802	name="IFramebuffer" extends="$unknown"
13803	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
13804	wsmap="suppress"
13805	>
13806	<attribute name="address" type="octet" mod="ptr" readonly="yes">
13807	<desc>Address of the start byte of the frame buffer.</desc>
13808	</attribute>
13809
13810	<attribute name="width" type="unsigned long" readonly="yes">
13811	<desc>Frame buffer width, in pixels.</desc>
13812	</attribute>
13813
13814	<attribute name="height" type="unsigned long" readonly="yes">
13815	<desc>Frame buffer height, in pixels.</desc>
13816	</attribute>
13817
13818	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
13819	<desc>
13820	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
13821	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
13822	are: 8, 15, 16, 24 and 32.
13823	</desc>
13824	</attribute>
13825
13826	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
13827	<desc>
13828	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
13829	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
13830	size of the scan line must be aligned to 32 bits.
13831	</desc>
13832	</attribute>
13833
13834	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
13835	<desc>
13836	Frame buffer pixel format. It's either one of the values defined by <link
13837	to="FramebufferPixelFormat"/> or a raw FOURCC code.
13838	<note>
13839	This attribute must never return <link
13840	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
13841	<link to="#address"/> points to must be always known.
13842	</note>
13843	</desc>
13844	</attribute>
13845
13846	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
13847	<desc>
13848	Defines whether this frame buffer uses the virtual video card's memory
13849	buffer (guest VRAM) directly or not. See <link
13850	to="IFramebuffer::requestResize"/> for more information.
13851	</desc>
13852	</attribute>
13853
13854	<attribute name="heightReduction" type="unsigned long" readonly="yes">
13855	<desc>
13856	Hint from the frame buffer about how much of the standard
13857	screen height it wants to use for itself. This information is
13858	exposed to the guest through the VESA BIOS and VMMDev interface
13859	so that it can use it for determining its video mode table. It
13860	is not guaranteed that the guest respects the value.
13861	</desc>
13862	</attribute>
13863
13864	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
13865	<desc>
13866	An alpha-blended overlay which is superposed over the frame buffer.
13867	The initial purpose is to allow the display of icons providing
13868	information about the VM state, including disk activity, in front
13869	ends which do not have other means of doing that. The overlay is
13870	designed to controlled exclusively by IDisplay. It has no locking
13871	of its own, and any changes made to it are not guaranteed to be
13872	visible until the affected portion of IFramebuffer is updated. The
13873	overlay can be created lazily the first time it is requested. This
13874	attribute can also return @c null to signal that the overlay is not
13875	implemented.
13876	</desc>
13877	</attribute>
13878
13879	<attribute name="winId" type="long long" readonly="yes">
13880	<desc>
13881	Platform-dependent identifier of the window where context of this
13882	frame buffer is drawn, or zero if there's no such window.
13883	</desc>
13884	</attribute>
13885
13886	<method name="lock">
13887	<desc>
13888	Locks the frame buffer.
13889	Gets called by the IDisplay object where this frame buffer is
13890	bound to.
13891	</desc>
13892	</method>
13893
13894	<method name="unlock">
13895	<desc>
13896	Unlocks the frame buffer.
13897	Gets called by the IDisplay object where this frame buffer is
13898	bound to.
13899	</desc>
13900	</method>
13901
13902	<method name="notifyUpdate">
13903	<desc>
13904	Informs about an update.
13905	Gets called by the display object where this buffer is
13906	registered.
13907	</desc>
13908	<param name="x" type="unsigned long" dir="in"/>
13909	<param name="y" type="unsigned long" dir="in"/>
13910	<param name="width" type="unsigned long" dir="in"/>
13911	<param name="height" type="unsigned long" dir="in"/>
13912	</method>
13913
13914	<method name="requestResize">
13915	<desc>
13916	Requests a size and pixel format change.
13917
13918	There are two modes of working with the video buffer of the virtual
13919	machine. The <i>indirect</i> mode implies that the IFramebuffer
13920	implementation allocates a memory buffer for the requested display mode
13921	and provides it to the virtual machine. In <i>direct</i> mode, the
13922	IFramebuffer implementation uses the memory buffer allocated and owned
13923	by the virtual machine. This buffer represents the video memory of the
13924	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
13925	usually faster because the implementation gets a raw pointer to the
13926	guest VRAM buffer which it can directly use for visualizing the contents
13927	of the virtual display, as opposed to the indirect mode where the
13928	contents of guest VRAM are copied to the memory buffer provided by
13929	the implementation every time a display update occurs.
13930
13931	It is important to note that the direct mode is really fast only when
13932	the implementation uses the given guest VRAM buffer directly, for
13933	example, by blitting it to the window representing the virtual machine's
13934	display, which saves at least one copy operation comparing to the
13935	indirect mode. However, using the guest VRAM buffer directly is not
13936	always possible: the format and the color depth of this buffer may be
13937	not supported by the target window, or it may be unknown (opaque) as in
13938	case of text or non-linear multi-plane VGA video modes. In this case,
13939	the indirect mode (that is always available) should be used as a
13940	fallback: when the guest VRAM contents are copied to the
13941	implementation-provided memory buffer, color and format conversion is
13942	done automatically by the underlying code.
13943
13944	The @a pixelFormat parameter defines whether the direct mode is
13945	available or not. If @a pixelFormat is <link
13946	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
13947	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
13948	@a bytesPerLine parameters must be ignored and the implementation must use
13949	the indirect mode (where it provides its own buffer in one of the
13950	supported formats). In all other cases, @a pixelFormat together with
13951	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
13952	buffer pointed to by the @a VRAM parameter and the implementation is
13953	free to choose which mode to use. To indicate that this frame buffer uses
13954	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
13955	attribute must return @c true and <link to="#address"/> must
13956	return exactly the same address that is passed in the @a VRAM parameter
13957	of this method; otherwise it is assumed that the indirect strategy is
13958	chosen.
13959
13960	The @a width and @a height parameters represent the size of the
13961	requested display mode in both modes. In case of indirect mode, the
13962	provided memory buffer should be big enough to store data of the given
13963	display mode. In case of direct mode, it is guaranteed that the given
13964	@a VRAM buffer contains enough space to represent the display mode of the
13965	given size. Note that this frame buffer's <link to="#width"/> and <link
13966	to="#height"/> attributes must return exactly the same values as
13967	passed to this method after the resize is completed (see below).
13968
13969	The @a finished output parameter determines if the implementation has
13970	finished resizing the frame buffer or not. If, for some reason, the
13971	resize cannot be finished immediately during this call, @a finished
13972	must be set to @c false, and the implementation must call
13973	<link to="IDisplay::resizeCompleted"/> after it has returned from
13974	this method as soon as possible. If @a finished is @c false, the
13975	machine will not call any frame buffer methods until
13976	<link to="IDisplay::resizeCompleted"/> is called.
13977
13978	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
13979	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
13980	this frame buffer must return exactly the same values as specified in the
13981	parameters of this method, after the resize is completed. If the
13982	indirect mode is chosen, these attributes must return values describing
13983	the format of the implementation's own memory buffer <link
13984	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
13985	value must always correlate with <link to="#pixelFormat"/>. Note that
13986	the <link to="#pixelFormat"/> attribute must never return <link
13987	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
13988
13989	<note>
13990	This method is called by the IDisplay object under the
13991	<link to="#lock"/> provided by this IFramebuffer
13992	implementation. If this method returns @c false in @a finished, then
13993	this lock is not released until
13994	<link to="IDisplay::resizeCompleted"/> is called.
13995	</note>
13996	</desc>
13997	<param name="screenId" type="unsigned long" dir="in">
13998	<desc>
13999	Logical screen number. Must be used in the corresponding call to
14000	<link to="IDisplay::resizeCompleted"/> if this call is made.
14001	</desc>
14002	</param>
14003	<param name="pixelFormat" type="unsigned long" dir="in">
14004	<desc>
14005	Pixel format of the memory buffer pointed to by @a VRAM.
14006	See also <link to="FramebufferPixelFormat"/>.
14007	</desc>
14008	</param>
14009	<param name="VRAM" type="octet" mod="ptr" dir="in">
14010	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14011	</param>
14012	<param name="bitsPerPixel" type="unsigned long" dir="in">
14013	<desc>Color depth, bits per pixel.</desc>
14014	</param>
14015	<param name="bytesPerLine" type="unsigned long" dir="in">
14016	<desc>Size of one scan line, in bytes.</desc>
14017	</param>
14018	<param name="width" type="unsigned long" dir="in">
14019	<desc>Width of the guest display, in pixels.</desc>
14020	</param>
14021	<param name="height" type="unsigned long" dir="in">
14022	<desc>Height of the guest display, in pixels.</desc>
14023	</param>
14024	<param name="finished" type="boolean" dir="return">
14025	<desc>
14026	Can the VM start using the new frame buffer immediately
14027	after this method returns or it should wait for
14028	<link to="IDisplay::resizeCompleted"/>.
14029	</desc>
14030	</param>
14031	</method>
14032
14033	<method name="videoModeSupported">
14034	<desc>
14035	Returns whether the frame buffer implementation is willing to
14036	support a given video mode. In case it is not able to render
14037	the video mode (or for some reason not willing), it should
14038	return @c false. Usually this method is called when the guest
14039	asks the VMM device whether a given video mode is supported
14040	so the information returned is directly exposed to the guest.
14041	It is important that this method returns very quickly.
14042	</desc>
14043	<param name="width" type="unsigned long" dir="in"/>
14044	<param name="height" type="unsigned long" dir="in"/>
14045	<param name="bpp" type="unsigned long" dir="in"/>
14046	<param name="supported" type="boolean" dir="return"/>
14047	</method>
14048
14049	<method name="getVisibleRegion">
14050	<desc>
14051	Returns the visible region of this frame buffer.
14052
14053	If the @a rectangles parameter is @c null then the value of the
14054	@a count parameter is ignored and the number of elements necessary to
14055	describe the current visible region is returned in @a countCopied.
14056
14057	If @a rectangles is not @c null but @a count is less
14058	than the required number of elements to store region data, the method
14059	will report a failure. If @a count is equal or greater than the
14060	required number of elements, then the actual number of elements copied
14061	to the provided array will be returned in @a countCopied.
14062
14063	<note>
14064	The address of the provided array must be in the process space of
14065	this IFramebuffer object.
14066	</note>
14067	<note>
14068	Method not yet implemented.
14069	</note>
14070	</desc>
14071	<param name="rectangles" type="octet" mod="ptr" dir="in">
14072	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14073	</param>
14074	<param name="count" type="unsigned long" dir="in">
14075	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14076	</param>
14077	<param name="countCopied" type="unsigned long" dir="return">
14078	<desc>Number of elements copied to the @a rectangles array.</desc>
14079	</param>
14080	</method>
14081
14082	<method name="setVisibleRegion">
14083	<desc>
14084	Suggests a new visible region to this frame buffer. This region
14085	represents the area of the VM display which is a union of regions of
14086	all top-level windows of the guest operating system running inside the
14087	VM (if the Guest Additions for this system support this
14088	functionality). This information may be used by the frontends to
14089	implement the seamless desktop integration feature.
14090
14091	<note>
14092	The address of the provided array must be in the process space of
14093	this IFramebuffer object.
14094	</note>
14095	<note>
14096	The IFramebuffer implementation must make a copy of the provided
14097	array of rectangles.
14098	</note>
14099	<note>
14100	Method not yet implemented.
14101	</note>
14102	</desc>
14103	<param name="rectangles" type="octet" mod="ptr" dir="in">
14104	<desc>Pointer to the @c RTRECT array.</desc>
14105	</param>
14106	<param name="count" type="unsigned long" dir="in">
14107	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14108	</param>
14109	</method>
14110
14111	<method name="processVHWACommand">
14112	<desc>
14113	Posts a Video HW Acceleration Command to the frame buffer for processing.
14114	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14115	are posted from quest to the host to be processed by the host hardware.
14116
14117	<note>
14118	The address of the provided command must be in the process space of
14119	this IFramebuffer object.
14120	</note>
14121	</desc>
14122
14123	<param name="command" type="octet" mod="ptr" dir="in">
14124	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14125	</param>
14126	</method>
14127
14128	</interface>
14129
14130	<interface
14131	name="IFramebufferOverlay" extends="IFramebuffer"
14132	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14133	wsmap="suppress"
14134	>
14135	<desc>
14136	The IFramebufferOverlay interface represents an alpha blended overlay
14137	for displaying status icons above an IFramebuffer. It is always created
14138	not visible, so that it must be explicitly shown. It only covers a
14139	portion of the IFramebuffer, determined by its width, height and
14140	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14141	that order) format, and may be written to directly. Do re-read the
14142	width though, after setting it, as it may be adjusted (increased) to
14143	make it more suitable for the front end.
14144	</desc>
14145	<attribute name="x" type="unsigned long" readonly="yes">
14146	<desc>X position of the overlay, relative to the frame buffer.</desc>
14147	</attribute>
14148
14149	<attribute name="y" type="unsigned long" readonly="yes">
14150	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14151	</attribute>
14152
14153	<attribute name="visible" type="boolean" readonly="no">
14154	<desc>
14155	Whether the overlay is currently visible.
14156	</desc>
14157	</attribute>
14158
14159	<attribute name="alpha" type="unsigned long" readonly="no">
14160	<desc>
14161	The global alpha value for the overlay. This may or may not be
14162	supported by a given front end.
14163	</desc>
14164	</attribute>
14165
14166	<method name="move">
14167	<desc>
14168	Changes the overlay's position relative to the IFramebuffer.
14169	</desc>
14170	<param name="x" type="unsigned long" dir="in"/>
14171	<param name="y" type="unsigned long" dir="in"/>
14172	</method>
14173
14174	</interface>
14175
14176	<interface
14177	name="IDisplay" extends="$unknown"
14178	uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14179	wsmap="managed"
14180	>
14181	<desc>
14182	The IDisplay interface represents the virtual machine's display.
14183
14184	The object implementing this interface is contained in each
14185	<link to="IConsole::display"/> attribute and represents the visual
14186	output of the virtual machine.
14187
14188	The virtual display supports pluggable output targets represented by the
14189	IFramebuffer interface. Examples of the output target are a window on
14190	the host computer or an RDP session's display on a remote computer.
14191	</desc>
14192	<method name="getScreenResolution">
14193	<desc>Queries display width, height and color depth for given screen.</desc>
14194	<param name="screenId" type="unsigned long" dir="in"/>
14195	<param name="width" type="unsigned long" dir="out"/>
14196	<param name="height" type="unsigned long" dir="out"/>
14197	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14198	</method>
14199
14200	<method name="setFramebuffer">
14201	<desc>
14202	Sets the framebuffer for given screen.
14203	</desc>
14204	<param name="screenId" type="unsigned long" dir="in"/>
14205	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14206	</method>
14207
14208	<method name="getFramebuffer">
14209	<desc>
14210	Queries the framebuffer for given screen.
14211	</desc>
14212	<param name="screenId" type="unsigned long" dir="in"/>
14213	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14214	<param name="xOrigin" type="long" dir="out"/>
14215	<param name="yOrigin" type="long" dir="out"/>
14216	</method>
14217
14218	<method name="setVideoModeHint">
14219	<desc>
14220	Asks VirtualBox to request the given video mode from
14221	the guest. This is just a hint and it cannot be guaranteed
14222	that the requested resolution will be used. Guest Additions
14223	are required for the request to be seen by guests. The caller
14224	should issue the request and wait for a resolution change and
14225	after a timeout retry.
14226
14227	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14228	parameters means that the corresponding values should be taken from the
14229	current video mode (i.e. left unchanged).
14230
14231	If the guest OS supports multi-monitor configuration then the @a display
14232	parameter specifies the number of the guest display to send the hint to:
14233	@c 0 is the primary display, @c 1 is the first secondary and
14234	so on. If the multi-monitor configuration is not supported, @a display
14235	must be @c 0.
14236
14237	<result name="E_INVALIDARG">
14238	The @a display is not associated with any monitor.
14239	</result>
14240
14241	</desc>
14242	<param name="display" type="unsigned long" dir="in">
14243	<desc>
14244	The number of the guest display to send the hint to.
14245	</desc>
14246	</param>
14247	<param name="enabled" type="boolean" dir="in">
14248	<desc>
14249	@c True, if this guest screen is enabled,
14250	@c False otherwise.
14251	</desc>
14252	</param>
14253	<param name="changeOrigin" type="boolean" dir="in">
14254	<desc>
14255	@c True, if the origin of the guest screen should be changed,
14256	@c False otherwise.
14257	</desc>
14258	</param>
14259	<param name="originX" type="long" dir="in">
14260	<desc>
14261	The X origin of the guest screen.
14262	</desc>
14263	</param>
14264	<param name="originY" type="long" dir="in">
14265	<desc>
14266	The Y origin of the guest screen.
14267	</desc>
14268	</param>
14269	<param name="width" type="unsigned long" dir="in"/>
14270	<param name="height" type="unsigned long" dir="in"/>
14271	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14272	</method>
14273
14274	<method name="setSeamlessMode">
14275	<desc>
14276	Enables or disables seamless guest display rendering (seamless desktop
14277	integration) mode.
14278	<note>
14279	Calling this method has no effect if <link
14280	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14281	does not return @c Active.
14282	</note>
14283	</desc>
14284	<param name="enabled" type="boolean" dir="in"/>
14285	</method>
14286
14287	<method name="takeScreenShot">
14288	<desc>
14289	Takes a screen shot of the requested size and copies it to the
14290	32-bpp buffer allocated by the caller and pointed to by @a address.
14291	A pixel consists of 4 bytes in order: B, G, R, 0.
14292
14293	<note>This API can be used only locally by a VM process through the
14294	COM/XPCOM C++ API as it requires pointer support. It is not
14295	available for scripting langages, Java or any webservice clients.
14296	Unless you are writing a new VM frontend use
14297	<link to="#takeScreenShotToArray" />.
14298	</note>
14299
14300	<result name="E_NOTIMPL">
14301	Feature not implemented.
14302	</result>
14303	<result name="VBOX_E_IPRT_ERROR">
14304	Could not take a screenshot.
14305	</result>
14306
14307	</desc>
14308	<param name="screenId" type="unsigned long" dir="in"/>
14309	<param name="address" type="octet" mod="ptr" dir="in"/>
14310	<param name="width" type="unsigned long" dir="in"/>
14311	<param name="height" type="unsigned long" dir="in"/>
14312	</method>
14313
14314	<method name="takeScreenShotToArray">
14315	<desc>
14316	Takes a guest screen shot of the requested size and returns it as
14317	an array of bytes in uncompressed 32-bit RGBA format.
14318	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14319
14320	This API is slow, but could be the only option to get guest screenshot
14321	for scriptable languages not allowed to manipulate with addresses
14322	directly.
14323
14324	<result name="E_NOTIMPL">
14325	Feature not implemented.
14326	</result>
14327	<result name="VBOX_E_IPRT_ERROR">
14328	Could not take a screenshot.
14329	</result>
14330	</desc>
14331	<param name="screenId" type="unsigned long" dir="in">
14332	<desc>
14333	Monitor to take screenshot from.
14334	</desc>
14335	</param>
14336	<param name="width" type="unsigned long" dir="in">
14337	<desc>
14338	Desired image width.
14339	</desc>
14340	</param>
14341	<param name="height" type="unsigned long" dir="in">
14342	<desc>
14343	Desired image height.
14344	</desc>
14345	</param>
14346	<param name="screenData" type="octet" dir="return" safearray="yes">
14347	<desc>
14348	Array with resulting screen data.
14349	</desc>
14350	</param>
14351	</method>
14352
14353	<method name="takeScreenShotPNGToArray">
14354	<desc>
14355	Takes a guest screen shot of the requested size and returns it as
14356	PNG image in array.
14357
14358	<result name="E_NOTIMPL">
14359	Feature not implemented.
14360	</result>
14361	<result name="VBOX_E_IPRT_ERROR">
14362	Could not take a screenshot.
14363	</result>
14364	</desc>
14365	<param name="screenId" type="unsigned long" dir="in">
14366	<desc>
14367	Monitor to take the screenshot from.
14368	</desc>
14369	</param>
14370	<param name="width" type="unsigned long" dir="in">
14371	<desc>
14372	Desired image width.
14373	</desc>
14374	</param>
14375	<param name="height" type="unsigned long" dir="in">
14376	<desc>
14377	Desired image height.
14378	</desc>
14379	</param>
14380	<param name="screenData" type="octet" dir="return" safearray="yes">
14381	<desc>
14382	Array with resulting screen data.
14383	</desc>
14384	</param>
14385	</method>
14386
14387	<method name="drawToScreen">
14388	<desc>
14389	Draws a 32-bpp image of the specified size from the given buffer
14390	to the given point on the VM display.
14391
14392	<result name="E_NOTIMPL">
14393	Feature not implemented.
14394	</result>
14395	<result name="VBOX_E_IPRT_ERROR">
14396	Could not draw to screen.
14397	</result>
14398
14399	</desc>
14400	<param name="screenId" type="unsigned long" dir="in">
14401	<desc>
14402	Monitor to take the screenshot from.
14403	</desc>
14404	</param>
14405	<param name="address" type="octet" mod="ptr" dir="in">
14406	<desc>
14407	Address to store the screenshot to
14408	</desc>
14409	</param>
14410	<param name="x" type="unsigned long" dir="in">
14411	<desc>
14412	Relative to the screen top left corner.
14413	</desc>
14414	</param>
14415	<param name="y" type="unsigned long" dir="in">
14416	<desc>
14417	Relative to the screen top left corner.
14418	</desc>
14419	</param>
14420	<param name="width" type="unsigned long" dir="in">
14421	<desc>
14422	Desired image width.
14423	</desc>
14424	</param>
14425	<param name="height" type="unsigned long" dir="in">
14426	<desc>
14427	Desired image height.
14428	</desc>
14429	</param>
14430	</method>
14431
14432	<method name="invalidateAndUpdate">
14433	<desc>
14434	Does a full invalidation of the VM display and instructs the VM
14435	to update it.
14436
14437	<result name="VBOX_E_IPRT_ERROR">
14438	Could not invalidate and update screen.
14439	</result>
14440
14441	</desc>
14442	</method>
14443
14444	<method name="resizeCompleted">
14445	<desc>
14446	Signals that a framebuffer has completed the resize operation.
14447
14448	<result name="VBOX_E_NOT_SUPPORTED">
14449	Operation only valid for external frame buffers.
14450	</result>
14451
14452	</desc>
14453	<param name="screenId" type="unsigned long" dir="in"/>
14454	</method>
14455
14456	<method name="completeVHWACommand">
14457	<desc>
14458	Signals that the Video HW Acceleration command has completed.
14459	</desc>
14460
14461	<param name="command" type="octet" mod="ptr" dir="in">
14462	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14463	</param>
14464	</method>
14465
14466	<method name="viewportChanged">
14467	<desc>
14468	Signals that framebuffer window viewport has changed.
14469
14470	<result name="E_INVALIDARG">
14471	The specified viewport data is invalid.
14472	</result>
14473
14474	</desc>
14475
14476	<param name="screenId" type="unsigned long" dir="in">
14477	<desc>
14478	Monitor to take the screenshot from.
14479	</desc>
14480	</param>
14481	<param name="x" type="unsigned long" dir="in">
14482	<desc>
14483	Framebuffer x offset.
14484	</desc>
14485	</param>
14486	<param name="y" type="unsigned long" dir="in">
14487	<desc>
14488	Framebuffer y offset.
14489	</desc>
14490	</param>
14491	<param name="width" type="unsigned long" dir="in">
14492	<desc>
14493	Viewport width.
14494	</desc>
14495	</param>
14496	<param name="height" type="unsigned long" dir="in">
14497	<desc>
14498	Viewport height.
14499	</desc>
14500	</param>
14501	</method>
14502	</interface>
14503
14504	<!--
14505	// INetworkAdapter
14506	/////////////////////////////////////////////////////////////////////////
14507	-->
14508
14509	<enum
14510	name="NetworkAttachmentType"
14511	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14512	>
14513	<desc>
14514	Network attachment type.
14515	</desc>
14516
14517	<const name="Null" value="0">
14518	<desc>Null value, also means "not attached".</desc>
14519	</const>
14520	<const name="NAT" value="1"/>
14521	<const name="Bridged" value="2"/>
14522	<const name="Internal" value="3"/>
14523	<const name="HostOnly" value="4"/>
14524	<const name="Generic" value="5"/>
14525	</enum>
14526
14527	<enum
14528	name="NetworkAdapterType"
14529	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
14530	>
14531	<desc>
14532	Network adapter type.
14533	</desc>
14534
14535	<const name="Null" value="0">
14536	<desc>Null value (never used by the API).</desc>
14537	</const>
14538	<const name="Am79C970A" value="1">
14539	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
14540	</const>
14541	<const name="Am79C973" value="2">
14542	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
14543	</const>
14544	<const name="I82540EM" value="3">
14545	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
14546	</const>
14547	<const name="I82543GC" value="4">
14548	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
14549	</const>
14550	<const name="I82545EM" value="5">
14551	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
14552	</const>
14553	<const name="Virtio" value="6">
14554	<desc>Virtio network device.</desc>
14555	</const>
14556	</enum>
14557
14558	<enum
14559	name="NetworkAdapterPromiscModePolicy"
14560	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
14561	>
14562	<desc>
14563	The promiscuous mode policy of an interface.
14564	</desc>
14565
14566	<const name="Deny" value="1">
14567	<desc>Deny promiscuous mode requests.</desc>
14568	</const>
14569	<const name="AllowNetwork" value="2">
14570	<desc>
14571	Allow promicuous mode, but restrict the scope it to the internal
14572	network so that it only applies to other VMs.
14573	</desc>
14574	</const>
14575	<const name="AllowAll" value="3">
14576	<desc>
14577	Allow promicuous mode, include unrelated traffic going over the wire
14578	and internally on the host.
14579	</desc>
14580	</const>
14581	</enum>
14582
14583	<interface
14584	name="INetworkAdapter" extends="$unknown"
14585	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
14586	wsmap="managed"
14587	>
14588	<desc>
14589	Represents a virtual network adapter that is attached to a virtual machine.
14590	Each virtual machine has a fixed number of network adapter slots with one
14591	instance of this attached to each of them. Call
14592	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
14593	is attached to a given slot in a given machine.
14594
14595	Each network adapter can be in one of five attachment modes, which are
14596	represented by the <link to="NetworkAttachmentType" /> enumeration;
14597	see the <link to="#attachmentType" /> attribute.
14598	</desc>
14599
14600	<attribute name="adapterType" type="NetworkAdapterType">
14601	<desc>
14602	Type of the virtual network adapter. Depending on this value,
14603	VirtualBox will provide a different virtual network hardware
14604	to the guest.
14605	</desc>
14606	</attribute>
14607
14608	<attribute name="slot" type="unsigned long" readonly="yes">
14609	<desc>
14610	Slot number this adapter is plugged into. Corresponds to
14611	the value you pass to <link to="IMachine::getNetworkAdapter"/>
14612	to obtain this instance.
14613	</desc>
14614	</attribute>
14615
14616	<attribute name="enabled" type="boolean">
14617	<desc>
14618	Flag whether the network adapter is present in the
14619	guest system. If disabled, the virtual guest hardware will
14620	not contain this network adapter. Can only be changed when
14621	the VM is not running.
14622	</desc>
14623	</attribute>
14624
14625	<attribute name="MACAddress" type="wstring">
14626	<desc>
14627	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
14628	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
14629	</desc>
14630	</attribute>
14631
14632	<attribute name="attachmentType" type="NetworkAttachmentType">
14633	<desc>
14634	Sets/Gets network attachment type of this network adapter.
14635	</desc>
14636	</attribute>
14637
14638	<attribute name="bridgedInterface" type="wstring">
14639	<desc>
14640	Name of the network interface the VM should be bridged to.
14641	</desc>
14642	</attribute>
14643
14644	<attribute name="hostOnlyInterface" type="wstring">
14645	<desc>
14646	Name of the host only network interface the VM is attached to.
14647	</desc>
14648	</attribute>
14649
14650	<attribute name="internalNetwork" type="wstring">
14651	<desc>
14652	Name of the internal network the VM is attached to.
14653	</desc>
14654	</attribute>
14655
14656	<attribute name="NATNetwork" type="wstring">
14657	<desc>
14658	Name of the NAT network the VM is attached to.
14659	</desc>
14660	</attribute>
14661
14662	<attribute name="genericDriver" type="wstring">
14663	<desc>
14664	Name of the driver to use for the "Generic" network attachment type.
14665	</desc>
14666	</attribute>
14667
14668	<attribute name="cableConnected" type="boolean">
14669	<desc>
14670	Flag whether the adapter reports the cable as connected or not.
14671	It can be used to report offline situations to a VM.
14672	</desc>
14673	</attribute>
14674
14675	<attribute name="lineSpeed" type="unsigned long">
14676	<desc>
14677	Line speed reported by custom drivers, in units of 1 kbps.
14678	</desc>
14679	</attribute>
14680
14681	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
14682	<desc>
14683	The promiscuous mode policy of the network adapter when attached to an
14684	internal network, host only network or a bridge.
14685	</desc>
14686	</attribute>
14687
14688	<attribute name="traceEnabled" type="boolean">
14689	<desc>
14690	Flag whether network traffic from/to the network card should be traced.
14691	Can only be toggled when the VM is turned off.
14692	</desc>
14693	</attribute>
14694
14695	<attribute name="traceFile" type="wstring">
14696	<desc>
14697	Filename where a network trace will be stored. If not set, VBox-pid.pcap
14698	will be used.
14699	</desc>
14700	</attribute>
14701
14702	<attribute name="NATEngine" type="INATEngine" readonly="yes">
14703	<desc>
14704	Points to the NAT engine which handles the network address translation
14705	for this interface. This is active only when the interface actually uses
14706	NAT.
14707	</desc>
14708	</attribute>
14709
14710	<attribute name="bootPriority" type="unsigned long">
14711	<desc>
14712	Network boot priority of the adapter. Priority 1 is highest. If not set,
14713	the priority is considered to be at the lowest possible setting.
14714	</desc>
14715	</attribute>
14716
14717	<attribute name="bandwidthGroup" type="IBandwidthGroup">
14718	<desc>The bandwidth group this network adapter is assigned to.</desc>
14719	</attribute>
14720
14721	<!-- property methods -->
14722
14723	<method name="getProperty" const="yes">
14724	<desc>
14725	Returns the value of the network attachment property with the given name.
14726
14727	If the requested data @a key does not exist, this function will
14728	succeed and return an empty string in the @a value argument.
14729
14730	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
14731	</desc>
14732	<param name="key" type="wstring" dir="in">
14733	<desc>Name of the property to get.</desc>
14734	</param>
14735	<param name="value" type="wstring" dir="return">
14736	<desc>Current property value.</desc>
14737	</param>
14738	</method>
14739
14740	<method name="setProperty">
14741	<desc>
14742	Sets the value of the network attachment property with the given name.
14743
14744	Setting the property value to @c null or an empty string is equivalent
14745	to deleting the existing value.
14746
14747	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
14748	</desc>
14749	<param name="key" type="wstring" dir="in">
14750	<desc>Name of the property to set.</desc>
14751	</param>
14752	<param name="value" type="wstring" dir="in">
14753	<desc>Property value to set.</desc>
14754	</param>
14755	</method>
14756
14757	<method name="getProperties" const="yes">
14758	<desc>
14759	Returns values for a group of properties in one call.
14760
14761	The names of the properties to get are specified using the @a names
14762	argument which is a list of comma-separated property names or
14763	an empty string if all properties are to be returned.
14764	<note>Currently the value of this argument is ignored and the method
14765	always returns all existing properties.</note>
14766
14767	The method returns two arrays, the array of property names corresponding
14768	to the @a names argument and the current values of these properties.
14769	Both arrays have the same number of elements with each element at the
14770	given index in the first array corresponds to an element at the same
14771	index in the second array.
14772	</desc>
14773	<param name="names" type="wstring" dir="in">
14774	<desc>
14775	Names of properties to get.
14776	</desc>
14777	</param>
14778	<param name="returnNames" type="wstring" safearray="yes" dir="out">
14779	<desc>Names of returned properties.</desc>
14780	</param>
14781	<param name="returnValues" type="wstring" safearray="yes" dir="return">
14782	<desc>Values of returned properties.</desc>
14783	</param>
14784	</method>
14785
14786	</interface>
14787
14788
14789	<!--
14790	// ISerialPort
14791	/////////////////////////////////////////////////////////////////////////
14792	-->
14793
14794	<enum
14795	name="PortMode"
14796	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
14797	>
14798	<desc>
14799	The PortMode enumeration represents possible communication modes for
14800	the virtual serial port device.
14801	</desc>
14802
14803	<const name="Disconnected" value="0">
14804	<desc>Virtual device is not attached to any real host device.</desc>
14805	</const>
14806	<const name="HostPipe" value="1">
14807	<desc>Virtual device is attached to a host pipe.</desc>
14808	</const>
14809	<const name="HostDevice" value="2">
14810	<desc>Virtual device is attached to a host device.</desc>
14811	</const>
14812	<const name="RawFile" value="3">
14813	<desc>Virtual device is attached to a raw file.</desc>
14814	</const>
14815	</enum>
14816
14817	<interface
14818	name="ISerialPort" extends="$unknown"
14819	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
14820	wsmap="managed"
14821	>
14822
14823	<desc>
14824	The ISerialPort interface represents the virtual serial port device.
14825
14826	The virtual serial port device acts like an ordinary serial port
14827	inside the virtual machine. This device communicates to the real
14828	serial port hardware in one of two modes: host pipe or host device.
14829
14830	In host pipe mode, the #path attribute specifies the path to the pipe on
14831	the host computer that represents a serial port. The #server attribute
14832	determines if this pipe is created by the virtual machine process at
14833	machine startup or it must already exist before starting machine
14834	execution.
14835
14836	In host device mode, the #path attribute specifies the name of the
14837	serial port device on the host computer.
14838
14839	There is also a third communication mode: the disconnected mode. In this
14840	mode, the guest OS running inside the virtual machine will be able to
14841	detect the serial port, but all port write operations will be discarded
14842	and all port read operations will return no data.
14843
14844	<see><link to="IMachine::getSerialPort"/></see>
14845	</desc>
14846
14847	<attribute name="slot" type="unsigned long" readonly="yes">
14848	<desc>
14849	Slot number this serial port is plugged into. Corresponds to
14850	the value you pass to <link to="IMachine::getSerialPort"/>
14851	to obtain this instance.
14852	</desc>
14853	</attribute>
14854
14855	<attribute name="enabled" type="boolean">
14856	<desc>
14857	Flag whether the serial port is enabled. If disabled,
14858	the serial port will not be reported to the guest OS.
14859	</desc>
14860	</attribute>
14861
14862	<attribute name="IOBase" type="unsigned long">
14863	<desc>Base I/O address of the serial port.</desc>
14864	</attribute>
14865
14866	<attribute name="IRQ" type="unsigned long">
14867	<desc>IRQ number of the serial port.</desc>
14868	</attribute>
14869
14870	<attribute name="hostMode" type="PortMode">
14871	<desc>
14872	How is this port connected to the host.
14873	<note>
14874	Changing this attribute may fail if the conditions for
14875	<link to="#path"/> are not met.
14876	</note>
14877	</desc>
14878	</attribute>
14879
14880	<attribute name="server" type="boolean">
14881	<desc>
14882	Flag whether this serial port acts as a server (creates a new pipe on
14883	the host) or as a client (uses the existing pipe). This attribute is
14884	used only when <link to="#hostMode"/> is PortMode_HostPipe.
14885	</desc>
14886	</attribute>
14887
14888	<attribute name="path" type="wstring">
14889	<desc>
14890	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
14891	PortMode_HostPipe, or the host serial device name when
14892	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
14893	cases, setting a @c null or empty string as the attribute's value
14894	is an error. Otherwise, the value of this property is ignored.
14895	</desc>
14896	</attribute>
14897
14898	</interface>
14899
14900	<!--
14901	// IParallelPort
14902	/////////////////////////////////////////////////////////////////////////
14903	-->
14904
14905	<interface
14906	name="IParallelPort" extends="$unknown"
14907	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
14908	wsmap="managed"
14909	>
14910
14911	<desc>
14912	The IParallelPort interface represents the virtual parallel port device.
14913
14914	The virtual parallel port device acts like an ordinary parallel port
14915	inside the virtual machine. This device communicates to the real
14916	parallel port hardware using the name of the parallel device on the host
14917	computer specified in the #path attribute.
14918
14919	Each virtual parallel port device is assigned a base I/O address and an
14920	IRQ number that will be reported to the guest operating system and used
14921	to operate the given parallel port from within the virtual machine.
14922
14923	<see><link to="IMachine::getParallelPort"/></see>
14924	</desc>
14925
14926	<attribute name="slot" type="unsigned long" readonly="yes">
14927	<desc>
14928	Slot number this parallel port is plugged into. Corresponds to
14929	the value you pass to <link to="IMachine::getParallelPort"/>
14930	to obtain this instance.
14931	</desc>
14932	</attribute>
14933
14934	<attribute name="enabled" type="boolean">
14935	<desc>
14936	Flag whether the parallel port is enabled. If disabled,
14937	the parallel port will not be reported to the guest OS.
14938	</desc>
14939	</attribute>
14940
14941	<attribute name="IOBase" type="unsigned long">
14942	<desc>Base I/O address of the parallel port.</desc>
14943	</attribute>
14944
14945	<attribute name="IRQ" type="unsigned long">
14946	<desc>IRQ number of the parallel port.</desc>
14947	</attribute>
14948
14949	<attribute name="path" type="wstring">
14950	<desc>
14951	Host parallel device name. If this parallel port is enabled, setting a
14952	@c null or an empty string as this attribute's value will result in
14953	an error.
14954	</desc>
14955	</attribute>
14956
14957	</interface>
14958
14959
14960	<!--
14961	// IMachineDebugger
14962	/////////////////////////////////////////////////////////////////////////
14963	-->
14964
14965	<interface
14966	name="IMachineDebugger" extends="$unknown"
14967	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
14968	wsmap="suppress"
14969	>
14970	<method name="dumpGuestCore">
14971	<desc>
14972	Takes a core dump of the guest.
14973
14974	See include/VBox/dbgfcorefmt.h for details on the file format.
14975	</desc>
14976	<param name="filename" type="wstring" dir="in">
14977	<desc>
14978	The name of the output file. The file must not exist.
14979	</desc>
14980	</param>
14981	<param name="compression" type="wstring" dir="in">
14982	<desc>
14983	Reserved for future compression method indicator.
14984	</desc>
14985	</param>
14986	</method>
14987
14988	<method name="dumpHostProcessCore">
14989	<desc>
14990	Takes a core dump of the VM process on the host.
14991
14992	This feature is not implemented in the 4.0.0 release but it may show up
14993	in a dot release.
14994	</desc>
14995	<param name="filename" type="wstring" dir="in">
14996	<desc>
14997	The name of the output file. The file must not exist.
14998	</desc>
14999	</param>
15000	<param name="compression" type="wstring" dir="in">
15001	<desc>
15002	Reserved for future compression method indicator.
15003	</desc>
15004	</param>
15005	</method>
15006
15007	<method name="info">
15008	<desc>
15009	Interfaces with the info dumpers (DBGFInfo).
15010
15011	This feature is not implemented in the 4.0.0 release but it may show up
15012	in a dot release.
15013	</desc>
15014	<param name="name" type="wstring" dir="in">
15015	<desc>
15016	The name of the info item.
15017	</desc>
15018	</param>
15019	<param name="args" type="wstring" dir="in">
15020	<desc>
15021	Arguments to the info dumper.
15022	</desc>
15023	</param>
15024	<param name="info" type="wstring" dir="return">
15025	<desc>
15026	The into string.
15027	</desc>
15028	</param>
15029	</method>
15030
15031	<method name="injectNMI">
15032	<desc>
15033	Inject an NMI into a running VT-x/AMD-V VM.
15034	</desc>
15035	</method>
15036
15037	<method name="modifyLogGroups">
15038	<desc>
15039	Modifies the group settings of the debug or release logger.
15040	</desc>
15041	<param name="settings" type="wstring" dir="in">
15042	<desc>
15043	The group settings string. See iprt/log.h for details. To target the
15044	release logger, prefix the string with "release:".
15045	</desc>
15046	</param>
15047	</method>
15048
15049	<method name="modifyLogFlags">
15050	<desc>
15051	Modifies the debug or release logger flags.
15052	</desc>
15053	<param name="settings" type="wstring" dir="in">
15054	<desc>
15055	The flags settings string. See iprt/log.h for details. To target the
15056	release logger, prefix the string with "release:".
15057	</desc>
15058	</param>
15059	</method>
15060
15061	<method name="modifyLogDestinations">
15062	<desc>
15063	Modifies the debug or release logger destinations.
15064	</desc>
15065	<param name="settings" type="wstring" dir="in">
15066	<desc>
15067	The destination settings string. See iprt/log.h for details. To target the
15068	release logger, prefix the string with "release:".
15069	</desc>
15070	</param>
15071	</method>
15072
15073	<method name="readPhysicalMemory">
15074	<desc>
15075	Reads guest physical memory, no side effects (MMIO++).
15076
15077	This feature is not implemented in the 4.0.0 release but may show up
15078	in a dot release.
15079	</desc>
15080	<param name="address" type="long long" dir="in">
15081	<desc>The guest physical address.</desc>
15082	</param>
15083	<param name="size" type="unsigned long" dir="in">
15084	<desc>The number of bytes to read.</desc>
15085	</param>
15086	<param name="bytes" type="octet" safearray="yes" dir="return">
15087	<desc>The bytes read.</desc>
15088	</param>
15089	</method>
15090
15091	<method name="writePhysicalMemory">
15092	<desc>
15093	Writes guest physical memory, access handles (MMIO++) are ignored.
15094
15095	This feature is not implemented in the 4.0.0 release but may show up
15096	in a dot release.
15097	</desc>
15098	<param name="address" type="long long" dir="in">
15099	<desc>The guest physical address.</desc>
15100	</param>
15101	<param name="size" type="unsigned long" dir="in">
15102	<desc>The number of bytes to read.</desc>
15103	</param>
15104	<param name="bytes" type="octet" safearray="yes" dir="in">
15105	<desc>The bytes to write.</desc>
15106	</param>
15107	</method>
15108
15109	<method name="readVirtualMemory">
15110	<desc>
15111	Reads guest virtual memory, no side effects (MMIO++).
15112
15113	This feature is not implemented in the 4.0.0 release but may show up
15114	in a dot release.
15115	</desc>
15116	<param name="cpuId" type="unsigned long" dir="in">
15117	<desc>The identifier of the Virtual CPU.</desc>
15118	</param>
15119	<param name="address" type="long long" dir="in">
15120	<desc>The guest virtual address.</desc>
15121	</param>
15122	<param name="size" type="unsigned long" dir="in">
15123	<desc>The number of bytes to read.</desc>
15124	</param>
15125	<param name="bytes" type="octet" safearray="yes" dir="return">
15126	<desc>The bytes read.</desc>
15127	</param>
15128	</method>
15129
15130	<method name="writeVirtualMemory">
15131	<desc>
15132	Writes guest virtual memory, access handles (MMIO++) are ignored.
15133
15134	This feature is not implemented in the 4.0.0 release but may show up
15135	in a dot release.
15136	</desc>
15137	<param name="cpuId" type="unsigned long" dir="in">
15138	<desc>The identifier of the Virtual CPU.</desc>
15139	</param>
15140	<param name="address" type="long long" dir="in">
15141	<desc>The guest virtual address.</desc>
15142	</param>
15143	<param name="size" type="unsigned long" dir="in">
15144	<desc>The number of bytes to read.</desc>
15145	</param>
15146	<param name="bytes" type="octet" safearray="yes" dir="in">
15147	<desc>The bytes to write.</desc>
15148	</param>
15149	</method>
15150
15151	<method name="detectOS">
15152	<desc>
15153	Tries to (re-)detect the guest OS kernel.
15154
15155	This feature is not implemented in the 4.0.0 release but may show up
15156	in a dot release.
15157	</desc>
15158	<param name="os" type="wstring" dir="return">
15159	<desc>
15160	The detected OS kernel on success.
15161	</desc>
15162	</param>
15163	</method>
15164
15165	<method name="getRegister">
15166	<desc>
15167	Gets one register.
15168
15169	This feature is not implemented in the 4.0.0 release but may show up
15170	in a dot release.
15171	</desc>
15172	<param name="cpuId" type="unsigned long" dir="in">
15173	<desc>The identifier of the Virtual CPU.</desc>
15174	</param>
15175	<param name="name" type="wstring" dir="in">
15176	<desc>The register name, case is ignored.</desc>
15177	</param>
15178	<param name="value" type="wstring" dir="return">
15179	<desc>
15180	The register value. This is usually a hex value (always 0x prefixed)
15181	but other format may be used for floating point registers (TBD).
15182	</desc>
15183	</param>
15184	</method>
15185
15186	<method name="getRegisters">
15187	<desc>
15188	Gets all the registers for the given CPU.
15189
15190	This feature is not implemented in the 4.0.0 release but may show up
15191	in a dot release.
15192	</desc>
15193	<param name="cpuId" type="unsigned long" dir="in">
15194	<desc>The identifier of the Virtual CPU.</desc>
15195	</param>
15196	<param name="names" type="wstring" dir="out" safearray="yes">
15197	<desc>Array containing the lowercase register names.</desc>
15198	</param>
15199	<param name="values" type="wstring" dir="out" safearray="yes">
15200	<desc>
15201	Array paralell to the names holding the register values as if the
15202	register was returned by <link to="IMachineDebugger::getRegister"/>.
15203	</desc>
15204	</param>
15205	</method>
15206
15207	<method name="setRegister">
15208	<desc>
15209	Gets one register.
15210
15211	This feature is not implemented in the 4.0.0 release but may show up
15212	in a dot release.
15213	</desc>
15214	<param name="cpuId" type="unsigned long" dir="in">
15215	<desc>The identifier of the Virtual CPU.</desc>
15216	</param>
15217	<param name="name" type="wstring" dir="in">
15218	<desc>The register name, case is ignored.</desc>
15219	</param>
15220	<param name="value" type="wstring" dir="in">
15221	<desc>
15222	The new register value. Hexadecimal, decimal and octal formattings
15223	are supported in addition to any special formattings returned by
15224	the getters.
15225	</desc>
15226	</param>
15227	</method>
15228
15229	<method name="setRegisters">
15230	<desc>
15231	Sets zero or more registers atomically.
15232
15233	This feature is not implemented in the 4.0.0 release but may show up
15234	in a dot release.
15235	</desc>
15236	<param name="cpuId" type="unsigned long" dir="in">
15237	<desc>The identifier of the Virtual CPU.</desc>
15238	</param>
15239	<param name="names" type="wstring" dir="in" safearray="yes">
15240	<desc>Array containing the register names, case ignored.</desc>
15241	</param>
15242	<param name="values" type="wstring" dir="in" safearray="yes">
15243	<desc>
15244	Array paralell to the names holding the register values. See
15245	<link to="IMachineDebugger::setRegister"/> for formatting
15246	guidelines.
15247	</desc>
15248	</param>
15249	</method>
15250
15251	<method name="dumpGuestStack">
15252	<desc>
15253	Produce a simple stack dump using the current guest state.
15254
15255	This feature is not implemented in the 4.0.0 release but may show up
15256	in a dot release.
15257	</desc>
15258	<param name="cpuId" type="unsigned long" dir="in">
15259	<desc>The identifier of the Virtual CPU.</desc>
15260	</param>
15261	<param name="stack" type="wstring" dir="return">
15262	<desc>String containing the formatted stack dump.</desc>
15263	</param>
15264	</method>
15265
15266	<method name="resetStats">
15267	<desc>
15268	Reset VM statistics.
15269	</desc>
15270	<param name="pattern" type="wstring" dir="in">
15271	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15272	</param>
15273	</method>
15274
15275	<method name="dumpStats">
15276	<desc>
15277	Dumps VM statistics.
15278	</desc>
15279	<param name="pattern" type="wstring" dir="in">
15280	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15281	</param>
15282	</method>
15283
15284	<method name="getStats">
15285	<desc>
15286	Get the VM statistics in a XMLish format.
15287	</desc>
15288	<param name="pattern" type="wstring" dir="in">
15289	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15290	</param>
15291	<param name="withDescriptions" type="boolean" dir="in">
15292	<desc>Whether to include the descriptions.</desc>
15293	</param>
15294	<param name="stats" type="wstring" dir="out">
15295	<desc>The XML document containing the statistics.</desc>
15296	</param>
15297	</method>
15298
15299	<attribute name="singleStep" type="boolean">
15300	<desc>Switch for enabling single-stepping.</desc>
15301	</attribute>
15302
15303	<attribute name="recompileUser" type="boolean">
15304	<desc>Switch for forcing code recompilation for user mode code.</desc>
15305	</attribute>
15306
15307	<attribute name="recompileSupervisor" type="boolean">
15308	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15309	</attribute>
15310
15311	<attribute name="PATMEnabled" type="boolean">
15312	<desc>Switch for enabling and disabling the PATM component.</desc>
15313	</attribute>
15314
15315	<attribute name="CSAMEnabled" type="boolean">
15316	<desc>Switch for enabling and disabling the CSAM component.</desc>
15317	</attribute>
15318
15319	<attribute name="logEnabled" type="boolean">
15320	<desc>Switch for enabling and disabling the debug logger.</desc>
15321	</attribute>
15322
15323	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15324	<desc>The debug logger flags.</desc>
15325	</attribute>
15326
15327	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15328	<desc>The debug logger's group settings.</desc>
15329	</attribute>
15330
15331	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15332	<desc>The debug logger's destination settings.</desc>
15333	</attribute>
15334
15335	<attribute name="logRelFlags" type="wstring" readonly="yes">
15336	<desc>The release logger flags.</desc>
15337	</attribute>
15338
15339	<attribute name="logRelGroups" type="wstring" readonly="yes">
15340	<desc>The release logger's group settings.</desc>
15341	</attribute>
15342
15343	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15344	<desc>The relase logger's destination settings.</desc>
15345	</attribute>
15346
15347	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15348	<desc>
15349	Flag indicating whether the VM is currently making use of CPU hardware
15350	virtualization extensions.
15351	</desc>
15352	</attribute>
15353
15354	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15355	<desc>
15356	Flag indicating whether the VM is currently making use of the nested paging
15357	CPU hardware virtualization extension.
15358	</desc>
15359	</attribute>
15360
15361	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15362	<desc>
15363	Flag indicating whether the VM is currently making use of the VPID
15364	VT-x extension.
15365	</desc>
15366	</attribute>
15367
15368	<attribute name="OSName" type="wstring" readonly="yes">
15369	<desc>
15370	Query the guest OS kernel name as detected by the DBGF.
15371
15372	This feature is not implemented in the 4.0.0 release but may show up
15373	in a dot release.
15374	</desc>
15375	</attribute>
15376
15377	<attribute name="OSVersion" type="wstring" readonly="yes">
15378	<desc>
15379	Query the guest OS kernel version string as detected by the DBGF.
15380
15381	This feature is not implemented in the 4.0.0 release but may show up
15382	in a dot release.
15383	</desc>
15384	</attribute>
15385
15386	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15387	<desc>
15388	Flag indicating whether the VM is currently making use of the Physical
15389	Address Extension CPU feature.
15390	</desc>
15391	</attribute>
15392
15393	<attribute name="virtualTimeRate" type="unsigned long">
15394	<desc>
15395	The rate at which the virtual time runs expressed as a percentage.
15396	The accepted range is 2% to 20000%.
15397	</desc>
15398	</attribute>
15399
15400	<attribute name="VM" type="long long" readonly="yes">
15401	<desc>
15402	Gets the VM handle. This is only for internal use while
15403	we carve the details of this interface.
15404	</desc>
15405	</attribute>
15406
15407	</interface>
15408
15409	<!--
15410	// IUSBController
15411	/////////////////////////////////////////////////////////////////////////
15412	-->
15413
15414	<interface
15415	name="IUSBController" extends="$unknown"
15416	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15417	wsmap="managed"
15418	>
15419	<attribute name="enabled" type="boolean">
15420	<desc>
15421	Flag whether the USB controller is present in the
15422	guest system. If disabled, the virtual guest hardware will
15423	not contain any USB controller. Can only be changed when
15424	the VM is powered off.
15425	</desc>
15426	</attribute>
15427
15428	<attribute name="enabledEHCI" type="boolean">
15429	<desc>
15430	Flag whether the USB EHCI controller is present in the
15431	guest system. If disabled, the virtual guest hardware will
15432	not contain a USB EHCI controller. Can only be changed when
15433	the VM is powered off.
15434	</desc>
15435	</attribute>
15436
15437	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15438	<desc>
15439	Flag whether there is an USB proxy available.
15440	</desc>
15441	</attribute>
15442
15443	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15444	<desc>
15445	USB standard version which the controller implements.
15446	This is a BCD which means that the major version is in the
15447	high byte and minor version is in the low byte.
15448	</desc>
15449	</attribute>
15450
15451	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15452	<desc>
15453	List of USB device filters associated with the machine.
15454
15455	If the machine is currently running, these filters are activated
15456	every time a new (supported) USB device is attached to the host
15457	computer that was not ignored by global filters
15458	(<link to="IHost::USBDeviceFilters"/>).
15459
15460	These filters are also activated when the machine is powered up.
15461	They are run against a list of all currently available USB
15462	devices (in states
15463	<link to="USBDeviceState_Available"/>,
15464	<link to="USBDeviceState_Busy"/>,
15465	<link to="USBDeviceState_Held"/>) that were not previously
15466	ignored by global filters.
15467
15468	If at least one filter matches the USB device in question, this
15469	device is automatically captured (attached to) the virtual USB
15470	controller of this machine.
15471
15472	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15473	</desc>
15474	</attribute>
15475
15476	<method name="createDeviceFilter">
15477	<desc>
15478	Creates a new USB device filter. All attributes except
15479	the filter name are set to empty (any match),
15480	<i>active</i> is @c false (the filter is not active).
15481
15482	The created filter can then be added to the list of filters using
15483	<link to="#insertDeviceFilter"/>.
15484
15485	<result name="VBOX_E_INVALID_VM_STATE">
15486	The virtual machine is not mutable.
15487	</result>
15488
15489	<see><link to="#deviceFilters"/></see>
15490	</desc>
15491	<param name="name" type="wstring" dir="in">
15492	<desc>
15493	Filter name. See <link to="IUSBDeviceFilter::name"/>
15494	for more info.
15495	</desc>
15496	</param>
15497	<param name="filter" type="IUSBDeviceFilter" dir="return">
15498	<desc>Created filter object.</desc>
15499	</param>
15500	</method>
15501
15502	<method name="insertDeviceFilter">
15503	<desc>
15504	Inserts the given USB device to the specified position
15505	in the list of filters.
15506
15507	Positions are numbered starting from <tt>0</tt>. If the specified
15508	position is equal to or greater than the number of elements in
15509	the list, the filter is added to the end of the collection.
15510
15511	<note>
15512	Duplicates are not allowed, so an attempt to insert a
15513	filter that is already in the collection, will return an
15514	error.
15515	</note>
15516
15517	<result name="VBOX_E_INVALID_VM_STATE">
15518	Virtual machine is not mutable.
15519	</result>
15520	<result name="E_INVALIDARG">
15521	USB device filter not created within this VirtualBox instance.
15522	</result>
15523	<result name="VBOX_E_INVALID_OBJECT_STATE">
15524	USB device filter already in list.
15525	</result>
15526
15527	<see><link to="#deviceFilters"/></see>
15528	</desc>
15529	<param name="position" type="unsigned long" dir="in">
15530	<desc>Position to insert the filter to.</desc>
15531	</param>
15532	<param name="filter" type="IUSBDeviceFilter" dir="in">
15533	<desc>USB device filter to insert.</desc>
15534	</param>
15535	</method>
15536
15537	<method name="removeDeviceFilter">
15538	<desc>
15539	Removes a USB device filter from the specified position in the
15540	list of filters.
15541
15542	Positions are numbered starting from <tt>0</tt>. Specifying a
15543	position equal to or greater than the number of elements in
15544	the list will produce an error.
15545
15546	<see><link to="#deviceFilters"/></see>
15547
15548	<result name="VBOX_E_INVALID_VM_STATE">
15549	Virtual machine is not mutable.
15550	</result>
15551	<result name="E_INVALIDARG">
15552	USB device filter list empty or invalid @a position.
15553	</result>
15554
15555	</desc>
15556	<param name="position" type="unsigned long" dir="in">
15557	<desc>Position to remove the filter from.</desc>
15558	</param>
15559	<param name="filter" type="IUSBDeviceFilter" dir="return">
15560	<desc>Removed USB device filter.</desc>
15561	</param>
15562	</method>
15563
15564	</interface>
15565
15566
15567	<!--
15568	// IUSBDevice
15569	/////////////////////////////////////////////////////////////////////////
15570	-->
15571
15572	<interface
15573	name="IUSBDevice" extends="$unknown"
15574	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
15575	wsmap="managed"
15576	>
15577	<desc>
15578	The IUSBDevice interface represents a virtual USB device attached to the
15579	virtual machine.
15580
15581	A collection of objects implementing this interface is stored in the
15582	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
15583	attached to a running virtual machine's USB controller.
15584	</desc>
15585
15586	<attribute name="id" type="uuid" mod="string" readonly="yes">
15587	<desc>
15588	Unique USB device ID. This ID is built from #vendorId,
15589	#productId, #revision and #serialNumber.
15590	</desc>
15591	</attribute>
15592
15593	<attribute name="vendorId" type="unsigned short" readonly="yes">
15594	<desc>Vendor ID.</desc>
15595	</attribute>
15596
15597	<attribute name="productId" type="unsigned short" readonly="yes">
15598	<desc>Product ID.</desc>
15599	</attribute>
15600
15601	<attribute name="revision" type="unsigned short" readonly="yes">
15602	<desc>
15603	Product revision number. This is a packed BCD represented as
15604	unsigned short. The high byte is the integer part and the low
15605	byte is the decimal.
15606	</desc>
15607	</attribute>
15608
15609	<attribute name="manufacturer" type="wstring" readonly="yes">
15610	<desc>Manufacturer string.</desc>
15611	</attribute>
15612
15613	<attribute name="product" type="wstring" readonly="yes">
15614	<desc>Product string.</desc>
15615	</attribute>
15616
15617	<attribute name="serialNumber" type="wstring" readonly="yes">
15618	<desc>Serial number string.</desc>
15619	</attribute>
15620
15621	<attribute name="address" type="wstring" readonly="yes">
15622	<desc>Host specific address of the device.</desc>
15623	</attribute>
15624
15625	<attribute name="port" type="unsigned short" readonly="yes">
15626	<desc>
15627	Host USB port number the device is physically
15628	connected to.
15629	</desc>
15630	</attribute>
15631
15632	<attribute name="version" type="unsigned short" readonly="yes">
15633	<desc>
15634	The major USB version of the device - 1 or 2.
15635	</desc>
15636	</attribute>
15637
15638	<attribute name="portVersion" type="unsigned short" readonly="yes">
15639	<desc>
15640	The major USB version of the host USB port the device is
15641	physically connected to - 1 or 2. For devices not connected to
15642	anything this will have the same value as the version attribute.
15643	</desc>
15644	</attribute>
15645
15646	<attribute name="remote" type="boolean" readonly="yes">
15647	<desc>
15648	Whether the device is physically connected to a remote VRDE
15649	client or to a local host machine.
15650	</desc>
15651	</attribute>
15652
15653	</interface>
15654
15655
15656	<!--
15657	// IUSBDeviceFilter
15658	/////////////////////////////////////////////////////////////////////////
15659	-->
15660
15661	<interface
15662	name="IUSBDeviceFilter" extends="$unknown"
15663	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
15664	wsmap="managed"
15665	>
15666	<desc>
15667	The IUSBDeviceFilter interface represents an USB device filter used
15668	to perform actions on a group of USB devices.
15669
15670	This type of filters is used by running virtual machines to
15671	automatically capture selected USB devices once they are physically
15672	attached to the host computer.
15673
15674	A USB device is matched to the given device filter if and only if all
15675	attributes of the device match the corresponding attributes of the
15676	filter (that is, attributes are joined together using the logical AND
15677	operation). On the other hand, all together, filters in the list of
15678	filters carry the semantics of the logical OR operation. So if it is
15679	desirable to create a match like "this vendor id OR this product id",
15680	one needs to create two filters and specify "any match" (see below)
15681	for unused attributes.
15682
15683	All filter attributes used for matching are strings. Each string
15684	is an expression representing a set of values of the corresponding
15685	device attribute, that will match the given filter. Currently, the
15686	following filtering expressions are supported:
15687
15688	<ul>
15689	<li><i>Interval filters</i>. Used to specify valid intervals for
15690	integer device attributes (Vendor ID, Product ID and Revision).
15691	The format of the string is:
15692
15693	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
15694
15695	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
15696	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
15697	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
15698	is omitted before a dash (<tt>-</tt>), the minimum possible integer
15699	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
15700	possible integer is assumed.
15701	</li>
15702	<li><i>Boolean filters</i>. Used to specify acceptable values for
15703	boolean device attributes. The format of the string is:
15704
15705	<tt>true\|false\|yes\|no\|0\|1</tt>
15706
15707	</li>
15708	<li><i>Exact match</i>. Used to specify a single value for the given
15709	device attribute. Any string that doesn't start with <tt>int:</tt>
15710	represents the exact match. String device attributes are compared to
15711	this string including case of symbols. Integer attributes are first
15712	converted to a string (see individual filter attributes) and then
15713	compared ignoring case.
15714
15715	</li>
15716	<li><i>Any match</i>. Any value of the corresponding device attribute
15717	will match the given filter. An empty or @c null string is
15718	used to construct this type of filtering expressions.
15719
15720	</li>
15721	</ul>
15722
15723	<note>
15724	On the Windows host platform, interval filters are not currently
15725	available. Also all string filter attributes
15726	(<link to="#manufacturer"/>, <link to="#product"/>,
15727	<link to="#serialNumber"/>) are ignored, so they behave as
15728	<i>any match</i> no matter what string expression is specified.
15729	</note>
15730
15731	<see><link to="IUSBController::deviceFilters"/>,
15732	<link to="IHostUSBDeviceFilter"/></see>
15733	</desc>
15734
15735	<attribute name="name" type="wstring">
15736	<desc>
15737	Visible name for this filter.
15738	This name is used to visually distinguish one filter from another,
15739	so it can neither be @c null nor an empty string.
15740	</desc>
15741	</attribute>
15742
15743	<attribute name="active" type="boolean">
15744	<desc>Whether this filter active or has been temporarily disabled.</desc>
15745	</attribute>
15746
15747	<attribute name="vendorId" type="wstring">
15748	<desc>
15749	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
15750	The string representation for the <i>exact matching</i>
15751	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
15752	(including leading zeroes).
15753	</desc>
15754	</attribute>
15755
15756	<attribute name="productId" type="wstring">
15757	<desc>
15758	<link to="IUSBDevice::productId">Product ID</link> filter.
15759	The string representation for the <i>exact matching</i>
15760	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
15761	(including leading zeroes).
15762	</desc>
15763	</attribute>
15764
15765	<attribute name="revision" type="wstring">
15766	<desc>
15767	<link to="IUSBDevice::productId">Product revision number</link>
15768	filter. The string representation for the <i>exact matching</i>
15769	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
15770	of the integer part of the revision, and <tt>F</tt> is the
15771	decimal digit of its fractional part (including leading and
15772	trailing zeros).
15773	Note that for interval filters, it's best to use the hexadecimal
15774	form, because the revision is stored as a 16 bit packed BCD value;
15775	so the expression <tt>int:0x0100-0x0199</tt> will match any
15776	revision from <tt>1.0</tt> to <tt>1.99</tt>.
15777	</desc>
15778	</attribute>
15779
15780	<attribute name="manufacturer" type="wstring">
15781	<desc>
15782	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
15783	</desc>
15784	</attribute>
15785
15786	<attribute name="product" type="wstring">
15787	<desc>
15788	<link to="IUSBDevice::product">Product</link> filter.
15789	</desc>
15790	</attribute>
15791
15792	<attribute name="serialNumber" type="wstring">
15793	<desc>
15794	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
15795	</desc>
15796	</attribute>
15797
15798	<attribute name="port" type="wstring">
15799	<desc>
15800	<link to="IUSBDevice::port">Host USB port</link> filter.
15801	</desc>
15802	</attribute>
15803
15804	<attribute name="remote" type="wstring">
15805	<desc>
15806	<link to="IUSBDevice::remote">Remote state</link> filter.
15807	<note>
15808	This filter makes sense only for machine USB filters,
15809	i.e. it is ignored by IHostUSBDeviceFilter objects.
15810	</note>
15811	</desc>
15812	</attribute>
15813
15814	<attribute name="maskedInterfaces" type="unsigned long">
15815	<desc>
15816	This is an advanced option for hiding one or more USB interfaces
15817	from the guest. The value is a bit mask where the bits that are set
15818	means the corresponding USB interface should be hidden, masked off
15819	if you like.
15820	This feature only works on Linux hosts.
15821	</desc>
15822	</attribute>
15823
15824	</interface>
15825
15826
15827	<!--
15828	// IHostUSBDevice
15829	/////////////////////////////////////////////////////////////////////////
15830	-->
15831
15832	<enum
15833	name="USBDeviceState"
15834	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
15835	>
15836	<desc>
15837	USB device state. This enumeration represents all possible states
15838	of the USB device physically attached to the host computer regarding
15839	its state on the host computer and availability to guest computers
15840	(all currently running virtual machines).
15841
15842	Once a supported USB device is attached to the host, global USB
15843	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
15844	either ignore the device, or put it to USBDeviceState_Held state, or do
15845	nothing. Unless the device is ignored by global filters, filters of all
15846	currently running guests (<link to="IUSBController::deviceFilters"/>) are
15847	activated that can put it to USBDeviceState_Captured state.
15848
15849	If the device was ignored by global filters, or didn't match
15850	any filters at all (including guest ones), it is handled by the host
15851	in a normal way. In this case, the device state is determined by
15852	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
15853	or USBDeviceState_Available, depending on the current device usage.
15854
15855	Besides auto-capturing based on filters, the device can be manually
15856	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
15857	state is USBDeviceState_Busy, USBDeviceState_Available or
15858	USBDeviceState_Held.
15859
15860	<note>
15861	Due to differences in USB stack implementations in Linux and Win32,
15862	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
15863	only to the Linux version of the product. This also means that (<link
15864	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
15865	device state is USBDeviceState_Held.
15866	</note>
15867
15868	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
15869	</desc>
15870
15871	<const name="NotSupported" value="0">
15872	<desc>
15873	Not supported by the VirtualBox server, not available to guests.
15874	</desc>
15875	</const>
15876	<const name="Unavailable" value="1">
15877	<desc>
15878	Being used by the host computer exclusively,
15879	not available to guests.
15880	</desc>
15881	</const>
15882	<const name="Busy" value="2">
15883	<desc>
15884	Being used by the host computer, potentially available to guests.
15885	</desc>
15886	</const>
15887	<const name="Available" value="3">
15888	<desc>
15889	Not used by the host computer, available to guests (the host computer
15890	can also start using the device at any time).
15891	</desc>
15892	</const>
15893	<const name="Held" value="4">
15894	<desc>
15895	Held by the VirtualBox server (ignored by the host computer),
15896	available to guests.
15897	</desc>
15898	</const>
15899	<const name="Captured" value="5">
15900	<desc>
15901	Captured by one of the guest computers, not available
15902	to anybody else.
15903	</desc>
15904	</const>
15905	</enum>
15906
15907	<interface
15908	name="IHostUSBDevice" extends="IUSBDevice"
15909	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
15910	wsmap="managed"
15911	>
15912	<desc>
15913	The IHostUSBDevice interface represents a physical USB device attached
15914	to the host computer.
15915
15916	Besides properties inherited from IUSBDevice, this interface adds the
15917	<link to="#state"/> property that holds the current state of the USB
15918	device.
15919
15920	<see><link to="IHost::USBDevices"/>,
15921	<link to="IHost::USBDeviceFilters"/></see>
15922	</desc>
15923
15924	<attribute name="state" type="USBDeviceState" readonly="yes">
15925	<desc>
15926	Current state of the device.
15927	</desc>
15928	</attribute>
15929
15930	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
15931
15932	</interface>
15933
15934
15935	<!--
15936	// IHostUSBDeviceFilter
15937	/////////////////////////////////////////////////////////////////////////
15938	-->
15939
15940	<enum
15941	name="USBDeviceFilterAction"
15942	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
15943	>
15944	<desc>
15945	Actions for host USB device filters.
15946	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
15947	</desc>
15948
15949	<const name="Null" value="0">
15950	<desc>Null value (never used by the API).</desc>
15951	</const>
15952	<const name="Ignore" value="1">
15953	<desc>Ignore the matched USB device.</desc>
15954	</const>
15955	<const name="Hold" value="2">
15956	<desc>Hold the matched USB device.</desc>
15957	</const>
15958	</enum>
15959
15960	<interface
15961	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
15962	uuid="4cc70246-d74a-400f-8222-3900489c0374"
15963	wsmap="managed"
15964	>
15965	<desc>
15966	The IHostUSBDeviceFilter interface represents a global filter for a
15967	physical USB device used by the host computer. Used indirectly in
15968	<link to="IHost::USBDeviceFilters"/>.
15969
15970	Using filters of this type, the host computer determines the initial
15971	state of the USB device after it is physically attached to the
15972	host's USB controller.
15973
15974	<note>
15975	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
15976	filters, because it makes sense only for
15977	<link to="IUSBController::deviceFilters">machine USB filters</link>.
15978	</note>
15979
15980	<see><link to="IHost::USBDeviceFilters"/></see>
15981	</desc>
15982
15983	<attribute name="action" type="USBDeviceFilterAction">
15984	<desc>
15985	Action performed by the host when an attached USB device
15986	matches this filter.
15987	</desc>
15988	</attribute>
15989
15990	</interface>
15991
15992	<!--
15993	// IAudioAdapter
15994	/////////////////////////////////////////////////////////////////////////
15995	-->
15996
15997	<enum
15998	name="AudioDriverType"
15999	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16000	>
16001	<desc>
16002	Host audio driver type.
16003	</desc>
16004
16005	<const name="Null" value="0">
16006	<desc>Null value, also means "dummy audio driver".</desc>
16007	</const>
16008	<const name="WinMM" value="1">
16009	<desc>Windows multimedia (Windows hosts only).</desc>
16010	</const>
16011	<const name="OSS" value="2">
16012	<desc>Open Sound System (Linux hosts only).</desc>
16013	</const>
16014	<const name="ALSA" value="3">
16015	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16016	</const>
16017	<const name="DirectSound" value="4">
16018	<desc>DirectSound (Windows hosts only).</desc>
16019	</const>
16020	<const name="CoreAudio" value="5">
16021	<desc>CoreAudio (Mac hosts only).</desc>
16022	</const>
16023	<const name="MMPM" value="6">
16024	<desc>Reserved for historical reasons.</desc>
16025	</const>
16026	<const name="Pulse" value="7">
16027	<desc>PulseAudio (Linux hosts only).</desc>
16028	</const>
16029	<const name="SolAudio" value="8">
16030	<desc>Solaris audio (Solaris hosts only).</desc>
16031	</const>
16032	</enum>
16033
16034	<enum
16035	name="AudioControllerType"
16036	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16037	>
16038	<desc>
16039	Virtual audio controller type.
16040	</desc>
16041
16042	<const name="AC97" value="0"/>
16043	<const name="SB16" value="1"/>
16044	<const name="HDA" value="2"/>
16045	</enum>
16046
16047	<interface
16048	name="IAudioAdapter" extends="$unknown"
16049	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16050	wsmap="managed"
16051	>
16052	<desc>
16053	The IAudioAdapter interface represents the virtual audio adapter of
16054	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16055	</desc>
16056	<attribute name="enabled" type="boolean">
16057	<desc>
16058	Flag whether the audio adapter is present in the
16059	guest system. If disabled, the virtual guest hardware will
16060	not contain any audio adapter. Can only be changed when
16061	the VM is not running.
16062	</desc>
16063	</attribute>
16064	<attribute name="audioController" type="AudioControllerType">
16065	<desc>
16066	The audio hardware we emulate.
16067	</desc>
16068	</attribute>
16069	<attribute name="audioDriver" type="AudioDriverType">
16070	<desc>
16071	Audio driver the adapter is connected to. This setting
16072	can only be changed when the VM is not running.
16073	</desc>
16074	</attribute>
16075	</interface>
16076
16077	<enum
16078	name="AuthType"
16079	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16080	>
16081	<desc>
16082	VirtualBox authentication type.
16083	</desc>
16084
16085	<const name="Null" value="0">
16086	<desc>Null value, also means "no authentication".</desc>
16087	</const>
16088	<const name="External" value="1"/>
16089	<const name="Guest" value="2"/>
16090	</enum>
16091
16092	<!--
16093	// IVRDEServer
16094	/////////////////////////////////////////////////////////////////////////
16095	-->
16096
16097	<interface
16098	name="IVRDEServer" extends="$unknown"
16099	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16100	wsmap="managed"
16101	>
16102	<attribute name="enabled" type="boolean">
16103	<desc>VRDE server status.</desc>
16104	</attribute>
16105
16106	<attribute name="authType" type="AuthType">
16107	<desc>VRDE authentication method.</desc>
16108	</attribute>
16109
16110	<attribute name="authTimeout" type="unsigned long">
16111	<desc>Timeout for guest authentication. Milliseconds.</desc>
16112	</attribute>
16113
16114	<attribute name="allowMultiConnection" type="boolean">
16115	<desc>
16116	Flag whether multiple simultaneous connections to the VM are permitted.
16117	Note that this will be replaced by a more powerful mechanism in the future.
16118	</desc>
16119	</attribute>
16120
16121	<attribute name="reuseSingleConnection" type="boolean">
16122	<desc>
16123	Flag whether the existing connection must be dropped and a new connection
16124	must be established by the VRDE server, when a new client connects in single
16125	connection mode.
16126	</desc>
16127	</attribute>
16128
16129	<attribute name="VRDEExtPack" type="wstring">
16130	<desc>
16131	The name of Extension Pack providing VRDE for this VM. Overrides
16132	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16133	</desc>
16134	</attribute>
16135
16136	<attribute name="authLibrary" type="wstring">
16137	<desc>
16138	Library used for authentication of RDP clients by this VM. Overrides
16139	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16140	</desc>
16141	</attribute>
16142
16143	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16144	<desc>
16145	Array of names of properties, which are supported by this VRDE server.
16146	</desc>
16147	</attribute>
16148
16149	<method name="setVRDEProperty">
16150	<desc>
16151	Sets a VRDE specific property string.
16152
16153	If you pass @c null or empty string as a key @a value, the given @a key
16154	will be deleted.
16155
16156	</desc>
16157	<param name="key" type="wstring" dir="in">
16158	<desc>Name of the key to set.</desc>
16159	</param>
16160	<param name="value" type="wstring" dir="in">
16161	<desc>Value to assign to the key.</desc>
16162	</param>
16163	</method>
16164
16165	<method name="getVRDEProperty" const="yes">
16166	<desc>
16167	Returns a VRDE specific property string.
16168
16169	If the requested data @a key does not exist, this function will
16170	succeed and return an empty string in the @a value argument.
16171
16172	</desc>
16173	<param name="key" type="wstring" dir="in">
16174	<desc>Name of the key to get.</desc>
16175	</param>
16176	<param name="value" type="wstring" dir="return">
16177	<desc>Value of the requested key.</desc>
16178	</param>
16179	</method>
16180
16181	</interface>
16182
16183
16184	<!--
16185	// ISharedFolder
16186	/////////////////////////////////////////////////////////////////////////
16187	-->
16188
16189	<interface
16190	name="ISharedFolder" extends="$unknown"
16191	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16192	wsmap="struct"
16193	>
16194	<desc>
16195	The ISharedFolder interface represents a folder in the host computer's
16196	file system accessible from the guest OS running inside a virtual
16197	machine using an associated logical name.
16198
16199	There are three types of shared folders:
16200	<ul>
16201	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16202	folders available to all virtual machines.</li>
16203	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16204	VM-specific shared folders available to the given virtual machine at
16205	startup.</li>
16206	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16207	VM-specific shared folders created in the session context (for
16208	example, when the virtual machine is running) and automatically
16209	discarded when the session is closed (the VM is powered off).</li>
16210	</ul>
16211
16212	Logical names of shared folders must be unique within the given scope
16213	(global, permanent or transient). However, they do not need to be unique
16214	across scopes. In this case, the definition of the shared folder in a
16215	more specific scope takes precedence over definitions in all other
16216	scopes. The order of precedence is (more specific to more general):
16217	<ol>
16218	<li>Transient definitions</li>
16219	<li>Permanent definitions</li>
16220	<li>Global definitions</li>
16221	</ol>
16222
16223	For example, if MyMachine has a shared folder named
16224	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16225	transient shared folder named <tt>C_DRIVE</tt> (that points
16226	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16227	of <tt>C_DRIVE</tt> in the guest OS so
16228	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16229	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16230	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16231	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16232	to <tt>C:\\</tt> if it still exists.
16233
16234	Note that permanent and transient shared folders of different machines
16235	are in different name spaces, so they don't overlap and don't need to
16236	have unique logical names.
16237
16238	<note>
16239	Global shared folders are not implemented in the current version of the
16240	product.
16241	</note>
16242	</desc>
16243
16244	<attribute name="name" type="wstring" readonly="yes">
16245	<desc>Logical name of the shared folder.</desc>
16246	</attribute>
16247
16248	<attribute name="hostPath" type="wstring" readonly="yes">
16249	<desc>Full path to the shared folder in the host file system.</desc>
16250	</attribute>
16251
16252	<attribute name="accessible" type="boolean" readonly="yes">
16253	<desc>
16254	Whether the folder defined by the host path is currently
16255	accessible or not.
16256	For example, the folder can be inaccessible if it is placed
16257	on the network share that is not available by the time
16258	this property is read.
16259	</desc>
16260	</attribute>
16261
16262	<attribute name="writable" type="boolean" readonly="yes">
16263	<desc>
16264	Whether the folder defined by the host path is writable or
16265	not.
16266	</desc>
16267	</attribute>
16268
16269	<attribute name="autoMount" type="boolean" readonly="yes">
16270	<desc>
16271	Whether the folder gets automatically mounted by the guest or not.
16272	</desc>
16273	</attribute>
16274
16275	<attribute name="lastAccessError" type="wstring" readonly="yes">
16276	<desc>
16277	Text message that represents the result of the last accessibility
16278	check.
16279
16280	Accessibility checks are performed each time the <link to="#accessible"/>
16281	attribute is read. An empty string is returned if the last
16282	accessibility check was successful. A non-empty string indicates a
16283	failure and should normally describe a reason of the failure (for
16284	example, a file read error).
16285	</desc>
16286	</attribute>
16287
16288	</interface>
16289
16290	<!--
16291	// ISession
16292	/////////////////////////////////////////////////////////////////////////
16293	-->
16294
16295	<interface
16296	name="IInternalSessionControl" extends="$unknown"
16297	uuid="3e83963a-1c3b-400d-8c5f-f2d077b0a597"
16298	internal="yes"
16299	wsmap="suppress"
16300	>
16301	<method name="getPID">
16302	<desc>PID of the process that has created this Session object.
16303	</desc>
16304	<param name="pid" type="unsigned long" dir="return"/>
16305	</method>
16306
16307	<method name="getRemoteConsole">
16308	<desc>
16309	Returns the console object suitable for remote control.
16310
16311	<result name="VBOX_E_INVALID_VM_STATE">
16312	Session state prevents operation.
16313	</result>
16314	<result name="VBOX_E_INVALID_OBJECT_STATE">
16315	Session type prevents operation.
16316	</result>
16317
16318	</desc>
16319	<param name="console" type="IConsole" dir="return"/>
16320	</method>
16321
16322	<method name="assignMachine">
16323	<desc>
16324	Assigns the machine object associated with this direct-type
16325	session or informs the session that it will be a remote one
16326	(if @a machine == @c null).
16327
16328	<result name="VBOX_E_INVALID_VM_STATE">
16329	Session state prevents operation.
16330	</result>
16331	<result name="VBOX_E_INVALID_OBJECT_STATE">
16332	Session type prevents operation.
16333	</result>
16334
16335	</desc>
16336	<param name="machine" type="IMachine" dir="in"/>
16337	<param name="lockType" type="LockType" dir="in"/>
16338	</method>
16339
16340	<method name="assignRemoteMachine">
16341	<desc>
16342	Assigns the machine and the (remote) console object associated with
16343	this remote-type session.
16344
16345	<result name="VBOX_E_INVALID_VM_STATE">
16346	Session state prevents operation.
16347	</result>
16348
16349	</desc>
16350	<param name="machine" type="IMachine" dir="in"/>
16351	<param name="console" type="IConsole" dir="in"/>
16352	</method>
16353
16354	<method name="updateMachineState">
16355	<desc>
16356	Updates the machine state in the VM process.
16357	Must be called only in certain cases
16358	(see the method implementation).
16359
16360	<result name="VBOX_E_INVALID_VM_STATE">
16361	Session state prevents operation.
16362	</result>
16363	<result name="VBOX_E_INVALID_OBJECT_STATE">
16364	Session type prevents operation.
16365	</result>
16366
16367	</desc>
16368	<param name="aMachineState" type="MachineState" dir="in"/>
16369	</method>
16370
16371	<method name="uninitialize">
16372	<desc>
16373	Uninitializes (closes) this session. Used by VirtualBox to close
16374	the corresponding remote session when the direct session dies
16375	or gets closed.
16376
16377	<result name="VBOX_E_INVALID_VM_STATE">
16378	Session state prevents operation.
16379	</result>
16380
16381	</desc>
16382	</method>
16383
16384	<method name="onNetworkAdapterChange">
16385	<desc>
16386	Triggered when settings of a network adapter of the
16387	associated virtual machine have changed.
16388
16389	<result name="VBOX_E_INVALID_VM_STATE">
16390	Session state prevents operation.
16391	</result>
16392	<result name="VBOX_E_INVALID_OBJECT_STATE">
16393	Session type prevents operation.
16394	</result>
16395
16396	</desc>
16397	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16398	<param name="changeAdapter" type="boolean" dir="in"/>
16399	</method>
16400
16401	<method name="onSerialPortChange">
16402	<desc>
16403	Triggered when settings of a serial port of the
16404	associated virtual machine have changed.
16405
16406	<result name="VBOX_E_INVALID_VM_STATE">
16407	Session state prevents operation.
16408	</result>
16409	<result name="VBOX_E_INVALID_OBJECT_STATE">
16410	Session type prevents operation.
16411	</result>
16412
16413	</desc>
16414	<param name="serialPort" type="ISerialPort" dir="in"/>
16415	</method>
16416
16417	<method name="onParallelPortChange">
16418	<desc>
16419	Triggered when settings of a parallel port of the
16420	associated virtual machine have changed.
16421
16422	<result name="VBOX_E_INVALID_VM_STATE">
16423	Session state prevents operation.
16424	</result>
16425	<result name="VBOX_E_INVALID_OBJECT_STATE">
16426	Session type prevents operation.
16427	</result>
16428
16429	</desc>
16430	<param name="parallelPort" type="IParallelPort" dir="in"/>
16431	</method>
16432
16433	<method name="onStorageControllerChange">
16434	<desc>
16435	Triggered when settings of a storage controller of the
16436	associated virtual machine have changed.
16437
16438	<result name="VBOX_E_INVALID_VM_STATE">
16439	Session state prevents operation.
16440	</result>
16441	<result name="VBOX_E_INVALID_OBJECT_STATE">
16442	Session type prevents operation.
16443	</result>
16444
16445	</desc>
16446	</method>
16447
16448	<method name="onMediumChange">
16449	<desc>
16450	Triggered when attached media of the
16451	associated virtual machine have changed.
16452
16453	<result name="VBOX_E_INVALID_VM_STATE">
16454	Session state prevents operation.
16455	</result>
16456	<result name="VBOX_E_INVALID_OBJECT_STATE">
16457	Session type prevents operation.
16458	</result>
16459
16460	</desc>
16461
16462	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16463	<desc>The medium attachment which changed.</desc>
16464	</param>
16465	<param name="force" type="boolean" dir="in">
16466	<desc>If the medium change was forced.</desc>
16467	</param>
16468	</method>
16469
16470	<method name="onStorageDeviceChange">
16471	<desc>
16472	Triggered when attached storage devices of the
16473	associated virtual machine have changed.
16474
16475	<result name="VBOX_E_INVALID_VM_STATE">
16476	Session state prevents operation.
16477	</result>
16478	<result name="VBOX_E_INVALID_OBJECT_STATE">
16479	Session type prevents operation.
16480	</result>
16481
16482	</desc>
16483
16484	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16485	<desc>The medium attachment which changed.</desc>
16486	</param>
16487	<param name="remove" type="boolean" dir="in">
16488	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16489	</param>
16490	</method>
16491
16492	<method name="onClipboardModeChange">
16493	<desc>
16494	Notification when the shared clipboard mode changes.
16495	</desc>
16496	<param name="clipboardMode" type="ClipboardMode" dir="in">
16497	<desc>The new shared clipboard mode.</desc>
16498	</param>
16499	</method>
16500
16501	<method name="onDragAndDropModeChange">
16502	<desc>
16503	Notification when the drag'n'drop mode changes.
16504	</desc>
16505	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
16506	<desc>The new mode for drag'n'drop.</desc>
16507	</param>
16508	</method>
16509
16510	<method name="onCPUChange">
16511	<desc>
16512	Notification when a CPU changes.
16513	</desc>
16514	<param name="cpu" type="unsigned long" dir="in">
16515	<desc>The CPU which changed</desc>
16516	</param>
16517	<param name="add" type="boolean" dir="in">
16518	<desc>Flag whether the CPU was added or removed</desc>
16519	</param>
16520	</method>
16521
16522	<method name="onCPUExecutionCapChange">
16523	<desc>
16524	Notification when the CPU execution cap changes.
16525	</desc>
16526	<param name="executionCap" type="unsigned long" dir="in">
16527	<desc>The new CPU execution cap value. (1-100)</desc>
16528	</param>
16529	</method>
16530
16531	<method name="onVRDEServerChange">
16532	<desc>
16533	Triggered when settings of the VRDE server object of the
16534	associated virtual machine have changed.
16535
16536	<result name="VBOX_E_INVALID_VM_STATE">
16537	Session state prevents operation.
16538	</result>
16539	<result name="VBOX_E_INVALID_OBJECT_STATE">
16540	Session type prevents operation.
16541	</result>
16542
16543	</desc>
16544	<param name="restart" type="boolean" dir="in">
16545	<desc>Flag whether the server must be restarted</desc>
16546	</param>
16547	</method>
16548
16549	<method name="onUSBControllerChange">
16550	<desc>
16551	Triggered when settings of the USB controller object of the
16552	associated virtual machine have changed.
16553
16554	<result name="VBOX_E_INVALID_VM_STATE">
16555	Session state prevents operation.
16556	</result>
16557	<result name="VBOX_E_INVALID_OBJECT_STATE">
16558	Session type prevents operation.
16559	</result>
16560
16561	</desc>
16562	</method>
16563
16564	<method name="onSharedFolderChange">
16565	<desc>
16566	Triggered when a permanent (global or machine) shared folder has been
16567	created or removed.
16568	<note>
16569	We don't pass shared folder parameters in this notification because
16570	the order in which parallel notifications are delivered is not defined,
16571	therefore it could happen that these parameters were outdated by the
16572	time of processing this notification.
16573	</note>
16574
16575	<result name="VBOX_E_INVALID_VM_STATE">
16576	Session state prevents operation.
16577	</result>
16578	<result name="VBOX_E_INVALID_OBJECT_STATE">
16579	Session type prevents operation.
16580	</result>
16581
16582	</desc>
16583	<param name="global" type="boolean" dir="in"/>
16584	</method>
16585
16586	<method name="onUSBDeviceAttach">
16587	<desc>
16588	Triggered when a request to capture a USB device (as a result
16589	of matched USB filters or direct call to
16590	<link to="IConsole::attachUSBDevice"/>) has completed.
16591	A @c null @a error object means success, otherwise it
16592	describes a failure.
16593
16594	<result name="VBOX_E_INVALID_VM_STATE">
16595	Session state prevents operation.
16596	</result>
16597	<result name="VBOX_E_INVALID_OBJECT_STATE">
16598	Session type prevents operation.
16599	</result>
16600
16601	</desc>
16602	<param name="device" type="IUSBDevice" dir="in"/>
16603	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16604	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
16605	</method>
16606
16607	<method name="onUSBDeviceDetach">
16608	<desc>
16609	Triggered when a request to release the USB device (as a result
16610	of machine termination or direct call to
16611	<link to="IConsole::detachUSBDevice"/>) has completed.
16612	A @c null @a error object means success, otherwise it
16613	describes a failure.
16614
16615	<result name="VBOX_E_INVALID_VM_STATE">
16616	Session state prevents operation.
16617	</result>
16618	<result name="VBOX_E_INVALID_OBJECT_STATE">
16619	Session type prevents operation.
16620	</result>
16621
16622	</desc>
16623	<param name="id" type="uuid" mod="string" dir="in"/>
16624	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16625	</method>
16626
16627	<method name="onShowWindow">
16628	<desc>
16629	Called by <link to="IMachine::canShowConsoleWindow"/> and by
16630	<link to="IMachine::showConsoleWindow"/> in order to notify
16631	console listeners
16632	<link to="ICanShowWindowEvent"/>
16633	and <link to="IShowWindowEvent"/>.
16634
16635	<result name="VBOX_E_INVALID_OBJECT_STATE">
16636	Session type prevents operation.
16637	</result>
16638
16639	</desc>
16640	<param name="check" type="boolean" dir="in"/>
16641	<param name="canShow" type="boolean" dir="out"/>
16642	<param name="winId" type="long long" dir="out"/>
16643	</method>
16644
16645	<method name="onBandwidthGroupChange">
16646	<desc>
16647	Notification when one of the bandwidth groups change.
16648	</desc>
16649	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
16650	<desc>The bandwidth group which changed.</desc>
16651	</param>
16652	</method>
16653
16654	<method name="accessGuestProperty">
16655	<desc>
16656	Called by <link to="IMachine::getGuestProperty"/> and by
16657	<link to="IMachine::setGuestProperty"/> in order to read and
16658	modify guest properties.
16659
16660	<result name="VBOX_E_INVALID_VM_STATE">
16661	Machine session is not open.
16662	</result>
16663	<result name="VBOX_E_INVALID_OBJECT_STATE">
16664	Session type is not direct.
16665	</result>
16666
16667	</desc>
16668	<param name="name" type="wstring" dir="in"/>
16669	<param name="value" type="wstring" dir="in"/>
16670	<param name="flags" type="wstring" dir="in"/>
16671	<param name="isSetter" type="boolean" dir="in"/>
16672	<param name="retValue" type="wstring" dir="out"/>
16673	<param name="retTimestamp" type="long long" dir="out"/>
16674	<param name="retFlags" type="wstring" dir="out"/>
16675	</method>
16676
16677	<method name="enumerateGuestProperties" const="yes">
16678	<desc>
16679	Return a list of the guest properties matching a set of patterns along
16680	with their values, time stamps and flags.
16681
16682	<result name="VBOX_E_INVALID_VM_STATE">
16683	Machine session is not open.
16684	</result>
16685	<result name="VBOX_E_INVALID_OBJECT_STATE">
16686	Session type is not direct.
16687	</result>
16688
16689	</desc>
16690	<param name="patterns" type="wstring" dir="in">
16691	<desc>
16692	The patterns to match the properties against as a comma-separated
16693	string. If this is empty, all properties currently set will be
16694	returned.
16695	</desc>
16696	</param>
16697	<param name="key" type="wstring" dir="out" safearray="yes">
16698	<desc>
16699	The key names of the properties returned.
16700	</desc>
16701	</param>
16702	<param name="value" type="wstring" dir="out" safearray="yes">
16703	<desc>
16704	The values of the properties returned. The array entries match the
16705	corresponding entries in the @a key array.
16706	</desc>
16707	</param>
16708	<param name="timestamp" type="long long" dir="out" safearray="yes">
16709	<desc>
16710	The time stamps of the properties returned. The array entries match
16711	the corresponding entries in the @a key array.
16712	</desc>
16713	</param>
16714	<param name="flags" type="wstring" dir="out" safearray="yes">
16715	<desc>
16716	The flags of the properties returned. The array entries match the
16717	corresponding entries in the @a key array.
16718	</desc>
16719	</param>
16720	</method>
16721
16722	<method name="onlineMergeMedium">
16723	<desc>
16724	Triggers online merging of a hard disk. Used internally when deleting
16725	a snapshot while a VM referring to the same hard disk chain is running.
16726
16727	<result name="VBOX_E_INVALID_VM_STATE">
16728	Machine session is not open.
16729	</result>
16730	<result name="VBOX_E_INVALID_OBJECT_STATE">
16731	Session type is not direct.
16732	</result>
16733
16734	</desc>
16735	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16736	<desc>The medium attachment to identify the medium chain.</desc>
16737	</param>
16738	<param name="sourceIdx" type="unsigned long" dir="in">
16739	<desc>The index of the source image in the chain.
16740	Redundant, but drastically reduces IPC.</desc>
16741	</param>
16742	<param name="targetIdx" type="unsigned long" dir="in">
16743	<desc>The index of the target image in the chain.
16744	Redundant, but drastically reduces IPC.</desc>
16745	</param>
16746	<param name="source" type="IMedium" dir="in">
16747	<desc>Merge source medium.</desc>
16748	</param>
16749	<param name="target" type="IMedium" dir="in">
16750	<desc>Merge target medium.</desc>
16751	</param>
16752	<param name="mergeForward" type="boolean" dir="in">
16753	<desc>Merge direction.</desc>
16754	</param>
16755	<param name="parentForTarget" type="IMedium" dir="in">
16756	<desc>For forward merges: new parent for target medium.</desc>
16757	</param>
16758	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
16759	<desc>For backward merges: list of media which need their parent UUID
16760	updated.</desc>
16761	</param>
16762	<param name="progress" type="IProgress" dir="in">
16763	<desc>
16764	Progress object for this operation.
16765	</desc>
16766	</param>
16767	</method>
16768
16769	<method name="enableVMMStatistics">
16770	<desc>
16771	Enables or disables collection of VMM RAM statistics.
16772
16773	<result name="VBOX_E_INVALID_VM_STATE">
16774	Machine session is not open.
16775	</result>
16776	<result name="VBOX_E_INVALID_OBJECT_STATE">
16777	Session type is not direct.
16778	</result>
16779
16780	</desc>
16781	<param name="enable" type="boolean" dir="in">
16782	<desc>True enables statistics collection.</desc>
16783	</param>
16784	</method>
16785
16786	</interface>
16787
16788	<interface
16789	name="ISession" extends="$unknown"
16790	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
16791	wsmap="managed"
16792	>
16793	<desc>
16794	The ISession interface represents a client process and allows for locking
16795	virtual machines (represented by IMachine objects) to prevent conflicting
16796	changes to the machine.
16797
16798	Any caller wishing to manipulate a virtual machine needs to create a session
16799	object first, which lives in its own process space. Such session objects are
16800	then associated with <link to="IMachine" /> objects living in the VirtualBox
16801	server process to coordinate such changes.
16802
16803	There are two typical scenarios in which sessions are used:
16804
16805	<ul>
16806	<li>To alter machine settings or control a running virtual machine, one
16807	needs to lock a machine for a given session (client process) by calling
16808	<link to="IMachine::lockMachine"/>.
16809
16810	Whereas multiple sessions may control a running virtual machine, only
16811	one process can obtain a write lock on the machine to prevent conflicting
16812	changes. A write lock is also needed if a process wants to actually run a
16813	virtual machine in its own context, such as the VirtualBox GUI or
16814	VBoxHeadless front-ends. They must also lock a machine for their own
16815	sessions before they are allowed to power up the virtual machine.
16816
16817	As a result, no machine settings can be altered while another process is
16818	already using it, either because that process is modifying machine settings
16819	or because the machine is running.
16820	</li>
16821	<li>
16822	To start a VM using one of the existing VirtualBox front-ends (e.g. the
16823	VirtualBox GUI or VBoxHeadless), one would use
16824	<link to="IMachine::launchVMProcess"/>, which also takes a session object
16825	as its first parameter. This session then identifies the caller and lets the
16826	caller control the started machine (for example, pause machine execution or
16827	power it down) as well as be notified about machine execution state changes.
16828	</li>
16829	</ul>
16830
16831	How sessions objects are created in a client process depends on whether you use
16832	the Main API via COM or via the webservice:
16833
16834	<ul>
16835	<li>When using the COM API directly, an object of the Session class from the
16836	VirtualBox type library needs to be created. In regular COM C++ client code,
16837	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
16838	This object will then act as a local session object in further calls to open
16839	a session.
16840	</li>
16841
16842	<li>In the webservice, the session manager (IWebsessionManager) instead creates
16843	a session object automatically whenever <link to="IWebsessionManager::logon" />
16844	is called. A managed object reference to that session object can be retrieved by
16845	calling <link to="IWebsessionManager::getSessionObject" />.
16846	</li>
16847	</ul>
16848	</desc>
16849
16850	<attribute name="state" type="SessionState" readonly="yes">
16851	<desc>Current state of this session.</desc>
16852	</attribute>
16853
16854	<attribute name="type" type="SessionType" readonly="yes">
16855	<desc>
16856	Type of this session. The value of this attribute is valid only
16857	if the session currently has a machine locked (i.e. its
16858	<link to="#state" /> is Locked), otherwise an error will be returned.
16859	</desc>
16860	</attribute>
16861
16862	<attribute name="machine" type="IMachine" readonly="yes">
16863	<desc>Machine object associated with this session.</desc>
16864	</attribute>
16865
16866	<attribute name="console" type="IConsole" readonly="yes">
16867	<desc>Console object associated with this session.</desc>
16868	</attribute>
16869
16870	<method name="unlockMachine">
16871	<desc>
16872	Unlocks a machine that was previously locked for the current session.
16873
16874	Calling this method is required every time a machine has been locked
16875	for a particular session using the <link to="IMachine::launchVMProcess" />
16876	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
16877	the machine will be set to <link to="MachineState_Aborted" /> on the
16878	server, and changes made to the machine settings will be lost.
16879
16880	Generally, it is recommended to unlock all machines explicitly
16881	before terminating the application (regardless of the reason for
16882	the termination).
16883
16884	<note>
16885	Do not expect the session state (<link to="ISession::state" />
16886	to return to "Unlocked" immediately after you invoke this method,
16887	particularly if you have started a new VM process. The session
16888	state will automatically return to "Unlocked" once the VM is no
16889	longer executing, which can of course take a very long time.
16890	</note>
16891
16892	<result name="E_UNEXPECTED">
16893	Session is not locked.
16894	</result>
16895
16896	</desc>
16897	</method>
16898
16899	</interface>
16900
16901	<!--
16902	// IStorageController
16903	/////////////////////////////////////////////////////////////////////////
16904	-->
16905
16906	<enum
16907	name="StorageBus"
16908	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
16909	>
16910	<desc>
16911	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
16912	see <link to="IStorageController::bus" />.
16913	</desc>
16914	<const name="Null" value="0">
16915	<desc>@c null value. Never used by the API.</desc>
16916	</const>
16917	<const name="IDE" value="1"/>
16918	<const name="SATA" value="2"/>
16919	<const name="SCSI" value="3"/>
16920	<const name="Floppy" value="4"/>
16921	<const name="SAS" value="5"/>
16922	</enum>
16923
16924	<enum
16925	name="StorageControllerType"
16926	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
16927	>
16928	<desc>
16929	The exact variant of storage controller hardware presented
16930	to the guest; see <link to="IStorageController::controllerType" />.
16931	</desc>
16932
16933	<const name="Null" value="0">
16934	<desc>@c null value. Never used by the API.</desc>
16935	</const>
16936	<const name="LsiLogic" value="1">
16937	<desc>A SCSI controller of the LsiLogic variant.</desc>
16938	</const>
16939	<const name="BusLogic" value="2">
16940	<desc>A SCSI controller of the BusLogic variant.</desc>
16941	</const>
16942	<const name="IntelAhci" value="3">
16943	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
16944	</const>
16945	<const name="PIIX3" value="4">
16946	<desc>An IDE controller of the PIIX3 variant.</desc>
16947	</const>
16948	<const name="PIIX4" value="5">
16949	<desc>An IDE controller of the PIIX4 variant.</desc>
16950	</const>
16951	<const name="ICH6" value="6">
16952	<desc>An IDE controller of the ICH6 variant.</desc>
16953	</const>
16954	<const name="I82078" value="7">
16955	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
16956	</const>
16957	<const name="LsiLogicSas" value="8">
16958	<desc>A variant of the LsiLogic controller using SAS.</desc>
16959	</const>
16960	</enum>
16961
16962	<enum
16963	name="ChipsetType"
16964	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
16965	>
16966	<desc>
16967	Type of emulated chipset (mostly southbridge).
16968	</desc>
16969
16970	<const name="Null" value="0">
16971	<desc>@c null value. Never used by the API.</desc>
16972	</const>
16973	<const name="PIIX3" value="1">
16974	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
16975	</const>
16976	<const name="ICH9" value="2">
16977	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
16978	</const>
16979	</enum>
16980
16981	<interface
16982	name="IStorageController" extends="$unknown"
16983	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
16984	wsmap="managed"
16985	>
16986	<desc>
16987	Represents a storage controller that is attached to a virtual machine
16988	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
16989	attached to storage controllers in a real computer, virtual drives
16990	(represented by <link to="IMediumAttachment" />) are attached to virtual
16991	storage controllers, represented by this interface.
16992
16993	As opposed to physical hardware, VirtualBox has a very generic concept
16994	of a storage controller, and for purposes of the Main API, all virtual
16995	storage is attached to virtual machines via instances of this interface.
16996	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
16997	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
16998	is used, certain sub-types may be available and can be selected in
16999	<link to="#controllerType" />.
17000
17001	Depending on these settings, the guest operating system might see
17002	significantly different virtual hardware.
17003	</desc>
17004
17005	<attribute name="name" type="wstring" readonly="yes">
17006	<desc>
17007	Name of the storage controller, as originally specified with
17008	<link to="IMachine::addStorageController" />. This then uniquely
17009	identifies this controller with other method calls such as
17010	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17011	</desc>
17012	</attribute>
17013
17014	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17015	<desc>
17016	Maximum number of devices which can be attached to one port.
17017	</desc>
17018	</attribute>
17019
17020	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17021	<desc>
17022	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17023	</desc>
17024	</attribute>
17025
17026	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17027	<desc>
17028	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17029	</desc>
17030	</attribute>
17031
17032	<attribute name="instance" type="unsigned long">
17033	<desc>
17034	The instance number of the device in the running VM.
17035	</desc>
17036	</attribute>
17037
17038	<attribute name="portCount" type="unsigned long">
17039	<desc>
17040	The number of currently usable ports on the controller.
17041	The minimum and maximum number of ports for one controller are
17042	stored in <link to="IStorageController::minPortCount"/>
17043	and <link to="IStorageController::maxPortCount"/>.
17044	</desc>
17045	</attribute>
17046
17047	<attribute name="bus" type="StorageBus" readonly="yes">
17048	<desc>
17049	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17050	</desc>
17051	</attribute>
17052
17053	<attribute name="controllerType" type="StorageControllerType">
17054	<desc>
17055	The exact variant of storage controller hardware presented
17056	to the guest.
17057	Depending on this value, VirtualBox will provide a different
17058	virtual storage controller hardware to the guest.
17059	For SATA, SAS and floppy controllers, only one variant is
17060	available, but for IDE and SCSI, there are several.
17061
17062	For SCSI controllers, the default type is LsiLogic.
17063	</desc>
17064	</attribute>
17065
17066	<attribute name="useHostIOCache" type="boolean">
17067	<desc>
17068	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17069	caches and use synchronous file APIs on the host. This was the only option in the API before
17070	VirtualBox 3.2 and is still the default for IDE controllers.
17071
17072	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17073	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17074	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17075	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17076	virtual machines are running at the same time to prevent I/O cache related hangs.
17077	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17078	</desc>
17079	</attribute>
17080
17081	<attribute name="bootable" type="boolean" readonly="yes">
17082	<desc>
17083	Returns whether it is possible to boot from disks attached to this controller.
17084	</desc>
17085	</attribute>
17086	</interface>
17087
17088	<if target="wsdl">
17089
17090	<!--
17091	// IManagedObjectRef
17092	/////////////////////////////////////////////////////////////////////////
17093	-->
17094
17095	<interface
17096	name="IManagedObjectRef" extends="$unknown"
17097	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17098	internal="yes"
17099	wsmap="managed"
17100	wscpp="hardcoded"
17101	>
17102	<desc>
17103	Managed object reference.
17104
17105	Only within the webservice, a managed object reference (which is really
17106	an opaque number) allows a webservice client to address an object
17107	that lives in the address space of the webservice server.
17108
17109	Behind each managed object reference, there is a COM object that lives
17110	in the webservice server's address space. The COM object is not freed
17111	until the managed object reference is released, either by an explicit
17112	call to <link to="IManagedObjectRef::release" /> or by logging off from
17113	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17114	all objects created during the webservice session.
17115
17116	Whenever a method call of the VirtualBox API returns a COM object, the
17117	webservice representation of that method will instead return a
17118	managed object reference, which can then be used to invoke methods
17119	on that object.
17120	</desc>
17121
17122	<method name="getInterfaceName">
17123	<desc>
17124	Returns the name of the interface that this managed object represents,
17125	for example, "IMachine", as a string.
17126	</desc>
17127	<param name="return" type="wstring" dir="return"/>
17128	</method>
17129
17130	<method name="release">
17131	<desc>
17132	Releases this managed object reference and frees the resources that
17133	were allocated for it in the webservice server process. After calling
17134	this method, the identifier of the reference can no longer be used.
17135	</desc>
17136	</method>
17137
17138	</interface>
17139
17140	<!--
17141	// IWebsessionManager
17142	/////////////////////////////////////////////////////////////////////////
17143	-->
17144
17145	<interface
17146	name="IWebsessionManager" extends="$unknown"
17147	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17148	internal="yes"
17149	wsmap="global"
17150	wscpp="hardcoded"
17151	>
17152	<desc>
17153	Websession manager. This provides essential services
17154	to webservice clients.
17155	</desc>
17156	<method name="logon">
17157	<desc>
17158	Logs a new client onto the webservice and returns a managed object reference to
17159	the IVirtualBox instance, which the client can then use as a basis to further
17160	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17161	interface, in one way or the other.
17162	</desc>
17163	<param name="username" type="wstring" dir="in"/>
17164	<param name="password" type="wstring" dir="in"/>
17165	<param name="return" type="IVirtualBox" dir="return"/>
17166	</method>
17167
17168	<method name="getSessionObject">
17169	<desc>
17170	Returns a managed object reference to the internal ISession object that was created
17171	for this web service session when the client logged on.
17172
17173	<see><link to="ISession"/></see>
17174	</desc>
17175	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17176	<param name="return" type="ISession" dir="return"/>
17177	</method>
17178
17179	<method name="logoff">
17180	<desc>
17181	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17182	and destroys all resources associated with the session (most importantly, all
17183	managed objects created in the server while the session was active).
17184	</desc>
17185	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17186	</method>
17187
17188	</interface>
17189
17190	</if>
17191
17192	<!--
17193	// IPerformanceCollector & friends
17194	/////////////////////////////////////////////////////////////////////////
17195	-->
17196
17197	<interface
17198	name="IPerformanceMetric" extends="$unknown"
17199	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17200	>
17201	<desc>
17202	The IPerformanceMetric interface represents parameters of the given
17203	performance metric.
17204	</desc>
17205
17206	<attribute name="metricName" type="wstring" readonly="yes">
17207	<desc>
17208	Name of the metric.
17209	</desc>
17210	</attribute>
17211
17212	<attribute name="object" type="$unknown" readonly="yes">
17213	<desc>
17214	Object this metric belongs to.
17215	</desc>
17216	</attribute>
17217
17218	<attribute name="description" type="wstring" readonly="yes">
17219	<desc>
17220	Textual description of the metric.
17221	</desc>
17222	</attribute>
17223
17224	<attribute name="period" type="unsigned long" readonly="yes">
17225	<desc>
17226	Time interval between samples, measured in seconds.
17227	</desc>
17228	</attribute>
17229
17230	<attribute name="count" type="unsigned long" readonly="yes">
17231	<desc>
17232	Number of recent samples retained by the performance collector for this
17233	metric.
17234
17235	When the collected sample count exceeds this number, older samples
17236	are discarded.
17237	</desc>
17238	</attribute>
17239
17240	<attribute name="unit" type="wstring" readonly="yes">
17241	<desc>
17242	Unit of measurement.
17243	</desc>
17244	</attribute>
17245
17246	<attribute name="minimumValue" type="long" readonly="yes">
17247	<desc>
17248	Minimum possible value of this metric.
17249	</desc>
17250	</attribute>
17251
17252	<attribute name="maximumValue" type="long" readonly="yes">
17253	<desc>
17254	Maximum possible value of this metric.
17255	</desc>
17256	</attribute>
17257	</interface>
17258
17259	<interface
17260	name="IPerformanceCollector" extends="$unknown"
17261	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17262	wsmap="managed"
17263	>
17264	<desc>
17265	The IPerformanceCollector interface represents a service that collects
17266	and stores performance metrics data.
17267
17268	Performance metrics are associated with objects of interfaces like IHost
17269	and IMachine. Each object has a distinct set of performance metrics. The
17270	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17271
17272	Metric data is collected at the specified intervals and is retained
17273	internally. The interval and the number of retained samples can be set
17274	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17275	and collection settings are not persistent, they are discarded as soon as
17276	VBoxSVC process terminates. Moreover, metric settings and data associated
17277	with a particular VM only exist while VM is running. They disappear as
17278	soon as VM shuts down. It is not possible to set up metrics for machines
17279	that are powered off. One needs to start VM first, then set up metric
17280	collection parameters.
17281
17282	Metrics are organized hierarchically, with each level separated by a
17283	slash (/) character. Generally, the scheme for metric names is like this:
17284
17285	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17286
17287	"Category/Metric" together form the base metric name. A base metric is
17288	the smallest unit for which a sampling interval and the number of
17289	retained samples can be set. Only base metrics can be enabled and
17290	disabled. All sub-metrics are collected when their base metric is
17291	collected. Collected values for any set of sub-metrics can be queried
17292	with <link to="IPerformanceCollector::queryMetricsData" />.
17293
17294	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17295	category, "Load" metric, "User" submetric, "average" aggregate. An
17296	aggregate function is computed over all retained data. Valid aggregate
17297	functions are:
17298
17299	<ul>
17300	<li>avg -- average</li>
17301	<li>min -- minimum</li>
17302	<li>max -- maximum</li>
17303	</ul>
17304
17305	When setting up metric parameters, querying metric data, enabling or
17306	disabling metrics wildcards can be used in metric names to specify a
17307	subset of metrics. For example, to select all CPU-related metrics
17308	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17309	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17310
17311	The valid names for base metrics are:
17312
17313	<ul>
17314	<li>CPU/Load</li>
17315	<li>CPU/MHz</li>
17316	<li>RAM/Usage</li>
17317	<li>RAM/VMM</li>
17318	</ul>
17319
17320	The general sequence for collecting and retrieving the metrics is:
17321	<ul>
17322	<li>
17323	Obtain an instance of IPerformanceCollector with
17324	<link to="IVirtualBox::performanceCollector" />
17325	</li>
17326	<li>
17327	Allocate and populate an array with references to objects the metrics
17328	will be collected for. Use references to IHost and IMachine objects.
17329	</li>
17330	<li>
17331	Allocate and populate an array with base metric names the data will
17332	be collected for.
17333	</li>
17334	<li>
17335	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17336	the metric data will be collected and stored.
17337	</li>
17338	<li>
17339	Wait for the data to get collected.
17340	</li>
17341	<li>
17342	Allocate and populate an array with references to objects the metric
17343	values will be queried for. You can re-use the object array used for
17344	setting base metrics.
17345	</li>
17346	<li>
17347	Allocate and populate an array with metric names the data will be
17348	collected for. Note that metric names differ from base metric names.
17349	</li>
17350	<li>
17351	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17352	that have been collected so far are returned. Note that the values
17353	are still retained internally and data collection continues.
17354	</li>
17355	</ul>
17356
17357	For an example of usage refer to the following files in VirtualBox SDK:
17358	<ul>
17359	<li>
17360	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17361	</li>
17362	<li>
17363	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17364	</li>
17365	</ul>
17366	</desc>
17367
17368	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17369	<desc>
17370	Array of unique names of metrics.
17371
17372	This array represents all metrics supported by the performance
17373	collector. Individual objects do not necessarily support all of them.
17374	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17375	list of supported metrics for a particular object.
17376	</desc>
17377	</attribute>
17378
17379	<method name="getMetrics">
17380	<desc>
17381	Returns parameters of specified metrics for a set of objects.
17382	<note>
17383	@c Null metrics array means all metrics. @c Null object array means
17384	all existing objects.
17385	</note>
17386	</desc>
17387	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17388	<desc>
17389	Metric name filter. Currently, only a comma-separated list of metrics
17390	is supported.
17391	</desc>
17392	</param>
17393	<param name="objects" type="$unknown" dir="in" safearray="yes">
17394	<desc>
17395	Set of objects to return metric parameters for.
17396	</desc>
17397	</param>
17398	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17399	<desc>
17400	Array of returned metric parameters.
17401	</desc>
17402	</param>
17403	</method>
17404
17405	<method name="setupMetrics">
17406	<desc>
17407	Sets parameters of specified base metrics for a set of objects. Returns
17408	an array of <link to="IPerformanceMetric" /> describing the metrics
17409	have been affected.
17410	<note>
17411	@c Null or empty metric name array means all metrics. @c Null or
17412	empty object array means all existing objects. If metric name array
17413	contains a single element and object array contains many, the single
17414	metric name array element is applied to each object array element to
17415	form metric/object pairs.
17416	</note>
17417	</desc>
17418	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17419	<desc>
17420	Metric name filter. Comma-separated list of metrics with wildcard
17421	support.
17422	</desc>
17423	</param>
17424	<param name="objects" type="$unknown" dir="in" safearray="yes">
17425	<desc>
17426	Set of objects to setup metric parameters for.
17427	</desc>
17428	</param>
17429	<param name="period" type="unsigned long" dir="in">
17430	<desc>
17431	Time interval in seconds between two consecutive samples of
17432	performance data.
17433	</desc>
17434	</param>
17435	<param name="count" type="unsigned long" dir="in">
17436	<desc>
17437	Number of samples to retain in performance data history. Older
17438	samples get discarded.
17439	</desc>
17440	</param>
17441	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17442	<desc>
17443	Array of metrics that have been modified by the call to this method.
17444	</desc>
17445	</param>
17446	</method>
17447
17448	<method name="enableMetrics">
17449	<desc>
17450	Turns on collecting specified base metrics. Returns an array of
17451	<link to="IPerformanceMetric" /> describing the metrics have been
17452	affected.
17453	<note>
17454	@c Null or empty metric name array means all metrics. @c Null or
17455	empty object array means all existing objects. If metric name array
17456	contains a single element and object array contains many, the single
17457	metric name array element is applied to each object array element to
17458	form metric/object pairs.
17459	</note>
17460	</desc>
17461	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17462	<desc>
17463	Metric name filter. Comma-separated list of metrics with wildcard
17464	support.
17465	</desc>
17466	</param>
17467	<param name="objects" type="$unknown" dir="in" safearray="yes">
17468	<desc>
17469	Set of objects to enable metrics for.
17470	</desc>
17471	</param>
17472	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17473	<desc>
17474	Array of metrics that have been modified by the call to this method.
17475	</desc>
17476	</param>
17477	</method>
17478
17479	<method name="disableMetrics">
17480	<desc>
17481	Turns off collecting specified base metrics. Returns an array of
17482	<link to="IPerformanceMetric" /> describing the metrics have been
17483	affected.
17484	<note>
17485	@c Null or empty metric name array means all metrics. @c Null or
17486	empty object array means all existing objects. If metric name array
17487	contains a single element and object array contains many, the single
17488	metric name array element is applied to each object array element to
17489	form metric/object pairs.
17490	</note>
17491	</desc>
17492	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17493	<desc>
17494	Metric name filter. Comma-separated list of metrics with wildcard
17495	support.
17496	</desc>
17497	</param>
17498	<param name="objects" type="$unknown" dir="in" safearray="yes">
17499	<desc>
17500	Set of objects to disable metrics for.
17501	</desc>
17502	</param>
17503	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17504	<desc>
17505	Array of metrics that have been modified by the call to this method.
17506	</desc>
17507	</param>
17508	</method>
17509
17510	<method name="queryMetricsData">
17511	<desc>
17512	Queries collected metrics data for a set of objects.
17513
17514	The data itself and related metric information are returned in seven
17515	parallel and one flattened array of arrays. Elements of
17516	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
17517	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
17518	the same index describe one set of values corresponding to a single
17519	metric.
17520
17521	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
17522	start and length of a sub-array is indicated by
17523	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
17524	value for metric <tt>metricNames[i]</tt> is at
17525	<tt>returnData[returnIndices[i]]</tt>.
17526
17527	<note>
17528	@c Null or empty metric name array means all metrics. @c Null or
17529	empty object array means all existing objects. If metric name array
17530	contains a single element and object array contains many, the single
17531	metric name array element is applied to each object array element to
17532	form metric/object pairs.
17533	</note>
17534	<note>
17535	Data collection continues behind the scenes after call to @c
17536	queryMetricsData. The return data can be seen as the snapshot of the
17537	current state at the time of @c queryMetricsData call. The internally
17538	kept metric values are not cleared by the call. This makes possible
17539	querying different subsets of metrics or aggregates with subsequent
17540	calls. If periodic querying is needed it is highly suggested to query
17541	the values with @c interval*count period to avoid confusion. This way
17542	a completely new set of data values will be provided by each query.
17543	</note>
17544	</desc>
17545	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17546	<desc>
17547	Metric name filter. Comma-separated list of metrics with wildcard
17548	support.
17549	</desc>
17550	</param>
17551	<param name="objects" type="$unknown" dir="in" safearray="yes">
17552	<desc>
17553	Set of objects to query metrics for.
17554	</desc>
17555	</param>
17556	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
17557	<desc>
17558	Names of metrics returned in @c returnData.
17559	</desc>
17560	</param>
17561	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
17562	<desc>
17563	Objects associated with metrics returned in @c returnData.
17564	</desc>
17565	</param>
17566	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
17567	<desc>
17568	Units of measurement for each returned metric.
17569	</desc>
17570	</param>
17571	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
17572	<desc>
17573	Divisor that should be applied to return values in order to get
17574	floating point values. For example:
17575	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
17576	will retrieve the floating point value of i-th sample of the first
17577	metric.
17578	</desc>
17579	</param>
17580	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
17581	<desc>
17582	Sequence numbers of the first elements of value sequences of
17583	particular metrics returned in @c returnData. For aggregate metrics
17584	it is the sequence number of the sample the aggregate started
17585	calculation from.
17586	</desc>
17587	</param>
17588	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
17589	<desc>
17590	Indices of the first elements of value sequences of particular
17591	metrics returned in @c returnData.
17592	</desc>
17593	</param>
17594	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
17595	<desc>
17596	Lengths of value sequences of particular metrics.
17597	</desc>
17598	</param>
17599	<param name="returnData" type="long" dir="return" safearray="yes">
17600	<desc>
17601	Flattened array of all metric data containing sequences of values for
17602	each metric.
17603	</desc>
17604	</param>
17605	</method>
17606
17607	</interface>
17608
17609	<enum
17610	name="NATAliasMode"
17611	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
17612	>
17613	<desc></desc>
17614	<const name="AliasLog" value="0x1">
17615	<desc></desc>
17616	</const>
17617	<const name="AliasProxyOnly" value="0x02">
17618	<desc></desc>
17619	</const>
17620	<const name="AliasUseSamePorts" value="0x04">
17621	<desc></desc>
17622	</const>
17623	</enum>
17624
17625	<enum
17626	name="NATProtocol"
17627	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
17628	>
17629	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
17630	<const name="UDP" value="0">
17631	<desc>Port-forwarding uses UDP protocol.</desc>
17632	</const>
17633	<const name="TCP" value="1">
17634	<desc>Port-forwarding uses TCP protocol.</desc>
17635	</const>
17636	</enum>
17637
17638	<interface
17639	name="INATEngine" extends="$unknown"
17640	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
17641	wsmap="managed"
17642	>
17643	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
17644	allows for changing NAT behavior such as port-forwarding rules. This interface is
17645	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
17646	<attribute name="network" type="wstring">
17647	<desc>The network attribute of the NAT engine (the same value is used with built-in
17648	DHCP server to fill corresponding fields of DHCP leases).</desc>
17649	</attribute>
17650	<attribute name="hostIP" type="wstring">
17651	<desc>IP of host interface to bind all opened sockets to.
17652	<note>Changing this does not change binding of port forwarding.</note>
17653	</desc>
17654	</attribute>
17655	<attribute name="TFTPPrefix" type="wstring">
17656	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
17657	the corresponding fields of DHCP leases.</desc>
17658	</attribute>
17659	<attribute name="TFTPBootFile" type="wstring">
17660	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
17661	the corresponding fields of DHCP leases.</desc>
17662	</attribute>
17663	<attribute name="TFTPNextServer" type="wstring">
17664	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
17665	the corresponding fields of DHCP leases.
17666	<note>The preferred form is IPv4 addresses.</note>
17667	</desc>
17668	</attribute>
17669	<attribute name="aliasMode" type="unsigned long">
17670	<desc></desc>
17671	</attribute>
17672	<attribute name="DNSPassDomain" type="boolean">
17673	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
17674	</attribute>
17675	<attribute name="DNSProxy" type="boolean">
17676	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
17677	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
17678	</attribute>
17679	<attribute name="DNSUseHostResolver" type="boolean">
17680	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
17681	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
17682	</attribute>
17683	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
17684	<desc>Array of NAT port-forwarding rules in string representation, in the following
17685	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
17686	</attribute>
17687	<method name="setNetworkSettings">
17688	<desc>Sets network configuration of the NAT engine.</desc>
17689	<param name="mtu" type="unsigned long" dir="in">
17690	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
17691	</param>
17692	<param name="sockSnd" type="unsigned long" dir="in">
17693	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
17694	</param>
17695	<param name="sockRcv" type="unsigned long" dir="in">
17696	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
17697	</param>
17698	<param name="TcpWndSnd" type="unsigned long" dir="in">
17699	<desc>Initial size of the NAT engine's sending TCP window in bytes when
17700	establishing a new TCP connection.</desc>
17701	</param>
17702	<param name="TcpWndRcv" type="unsigned long" dir="in">
17703	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
17704	establishing a new TCP connection.</desc>
17705	</param>
17706	</method>
17707	<method name="getNetworkSettings">
17708	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
17709	for parameter descriptions.</desc>
17710	<param name="mtu" type="unsigned long" dir="out" />
17711	<param name="sockSnd" type="unsigned long" dir="out" />
17712	<param name="sockRcv" type="unsigned long" dir="out" />
17713	<param name="TcpWndSnd" type="unsigned long" dir="out" />
17714	<param name="TcpWndRcv" type="unsigned long" dir="out" />
17715	</method>
17716	<method name="addRedirect">
17717	<desc>Adds a new NAT port-forwarding rule.</desc>
17718	<param name="name" type="wstring" dir="in">
17719	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
17720	auto-generates one using the other parameters.</desc>
17721	</param>
17722	<param name="proto" type="NATProtocol" dir="in">
17723	<desc>Protocol handled with the rule.</desc>
17724	</param>
17725	<param name="hostIP" type="wstring" dir="in">
17726	<desc>IP of the host interface to which the rule should apply. An empty ip address is
17727	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
17728	</param>
17729	<param name="hostPort" type="unsigned short" dir="in">
17730	<desc>The port number to listen on.</desc>
17731	</param>
17732	<param name="guestIP" type="wstring" dir="in">
17733	<desc>The IP address of the guest which the NAT engine will forward matching packets
17734	to. An empty IP address is acceptable, in which case the NAT engine will forward
17735	packets to the first DHCP lease (x.x.x.15).</desc>
17736	</param>
17737	<param name="guestPort" type="unsigned short" dir="in">
17738	<desc>The port number to forward.</desc>
17739	</param>
17740	</method>
17741	<method name="removeRedirect">
17742	<desc>Removes a port-forwarding rule that was previously registered.</desc>
17743	<param name="name" type="wstring" dir="in">
17744	<desc>The name of the rule to delete.</desc>
17745	</param>
17746	</method>
17747	</interface>
17748
17749	<!--
17750	// IExtPackManager
17751	/////////////////////////////////////////////////////////////////////////
17752	-->
17753
17754	<interface
17755	name="IExtPackPlugIn" extends="$unknown"
17756	uuid="58000040-e718-4746-bbce-4b86d96da461"
17757	wsmap="suppress"
17758	>
17759	<desc>
17760	Interface for keeping information about a plug-in that ships with an
17761	extension pack.
17762	</desc>
17763	<attribute name="name" type="wstring" readonly="yes">
17764	<desc>The plug-in name.</desc>
17765	</attribute>
17766	<attribute name="description" type="wstring" readonly="yes">
17767	<desc>The plug-in description.</desc>
17768	</attribute>
17769	<attribute name="frontend" type="wstring" readonly="yes">
17770	<desc>
17771	The name of the frontend or component name this plug-in plugs into.
17772	</desc>
17773	</attribute>
17774	<attribute name="modulePath" type="wstring" readonly="yes">
17775	<desc> The module path. </desc>
17776	</attribute>
17777	</interface>
17778
17779	<interface
17780	name="IExtPackBase" extends="$unknown"
17781	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
17782	wsmap="suppress"
17783	>
17784	<desc>
17785	Interface for querying information about an extension pack as well as
17786	accessing COM objects within it.
17787	</desc>
17788	<attribute name="name" type="wstring" readonly="yes">
17789	<desc>The extension pack name. This is unique.</desc>
17790	</attribute>
17791	<attribute name="description" type="wstring" readonly="yes">
17792	<desc>The extension pack description.</desc>
17793	</attribute>
17794	<attribute name="version" type="wstring" readonly="yes">
17795	<desc>
17796	The extension pack version string. This is restricted to the dotted
17797	version number and optionally a build indicator. No tree revision or
17798	tag will be included in the string as those things are available as
17799	separate properties. An optional publisher tag may be present like for
17800	<link to="IVirtualBox::version"/>.
17801
17802	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
17803	</desc>
17804	</attribute>
17805	<attribute name="revision" type="unsigned long" readonly="yes">
17806	<desc>The extension pack internal revision number.</desc>
17807	</attribute>
17808	<attribute name="edition" type="wstring" readonly="yes">
17809	<desc>
17810	Edition indicator. This is usually empty.
17811
17812	Can for instance be used to help distinguishing between two editions
17813	of the same extension pack where only the license, service contract or
17814	something differs.
17815	</desc>
17816	</attribute>
17817	<attribute name="VRDEModule" type="wstring" readonly="yes">
17818	<desc>The name of the VRDE module if the extension pack sports one.</desc>
17819	</attribute>
17820	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
17821	<desc>Plug-ins provided by this extension pack.</desc>
17822	</attribute>
17823	<attribute name="usable" type="boolean" readonly="yes">
17824	<desc>
17825	Indicates whether the extension pack is usable or not.
17826
17827	There are a number of reasons why an extension pack might be unusable,
17828	typical examples would be broken installation/file or that it is
17829	incompatible with the current VirtualBox version.
17830	</desc>
17831	</attribute>
17832	<attribute name="whyUnusable" type="wstring" readonly="yes">
17833	<desc>
17834	String indicating why the extension pack is not usable. This is an
17835	empty string if usable and always a non-empty string if not usable.
17836	</desc>
17837	</attribute>
17838	<attribute name="showLicense" type="boolean" readonly="yes">
17839	<desc>Whether to show the license before installation</desc>
17840	</attribute>
17841	<attribute name="license" type="wstring" readonly="yes">
17842	<desc>
17843	The default HTML license text for the extension pack. Same as
17844	calling <link to="#queryLicense">queryLicense</link> with
17845	preferredLocale and preferredLanguage as empty strings and format set
17846	to html.
17847	</desc>
17848	</attribute>
17849
17850	<method name="queryLicense">
17851	<desc>
17852	Full feature version of the license attribute.
17853	</desc>
17854	<param name="preferredLocale" type="wstring" dir="in">
17855	<desc>
17856	The preferred license locale. Pass an empty string to get the default
17857	license.
17858	</desc>
17859	</param>
17860	<param name="preferredLanguage" type="wstring" dir="in">
17861	<desc>
17862	The preferred license language. Pass an empty string to get the
17863	default language for the locale.
17864	</desc>
17865	</param>
17866	<param name="format" type="wstring" dir="in">
17867	<desc>
17868	The license format: html, rtf or txt. If a license is present there
17869	will always be an HTML of it, the rich text format (RTF) and plain
17870	text (txt) versions are optional. If
17871	</desc>
17872	</param>
17873	<param name="licenseText" type="wstring" dir="return">
17874	<desc>The license text.</desc>
17875	</param>
17876	</method>
17877
17878	</interface>
17879
17880	<interface
17881	name="IExtPack" extends="IExtPackBase"
17882	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
17883	wsmap="suppress"
17884	>
17885	<desc>
17886	Interface for querying information about an extension pack as well as
17887	accessing COM objects within it.
17888	</desc>
17889	<method name="queryObject">
17890	<desc>
17891	Queries the IUnknown interface to an object in the extension pack
17892	main module. This allows plug-ins and others to talk directly to an
17893	extension pack.
17894	</desc>
17895	<param name="objUuid" type="wstring" dir="in">
17896	<desc>The object ID. What exactly this is </desc>
17897	</param>
17898	<param name="returnInterface" type="$unknown" dir="return">
17899	<desc>The queried interface.</desc>
17900	</param>
17901	</method>
17902	</interface>
17903
17904	<interface
17905	name="IExtPackFile" extends="IExtPackBase"
17906	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
17907	wsmap="suppress"
17908	>
17909	<desc>
17910	Extension pack file (aka tarball, .vbox-extpack) representation returned
17911	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
17912	extension pack information with the addition of the file name.
17913	</desc>
17914	<attribute name="filePath" type="wstring" readonly="yes">
17915	<desc>
17916	The path to the extension pack file.
17917	</desc>
17918	</attribute>
17919
17920	<method name="install">
17921	<desc>
17922	Install the extension pack.
17923	</desc>
17924	<param name="replace" type="boolean" dir="in">
17925	<desc>
17926	Set this to automatically uninstall any existing extension pack with
17927	the same name as the one being installed.
17928	</desc>
17929	</param>
17930	<param name="displayInfo" type="wstring" dir="in">
17931	<desc>
17932	Platform specific display information. Reserved for future hacks.
17933	</desc>
17934	</param>
17935	<param name="progess" type="IProgress" dir="return">
17936	<desc>
17937	Progress object for the operation.
17938	</desc>
17939	</param>
17940	</method>
17941	</interface>
17942
17943	<interface
17944	name="IExtPackManager" extends="$unknown"
17945	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
17946	wsmap="suppress"
17947	>
17948	<desc>
17949	Interface for managing VirtualBox Extension Packs.
17950
17951	TODO: Describe extension packs, how they are managed and how to create
17952	one.
17953	</desc>
17954
17955	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
17956	<desc>
17957	List of the installed extension packs.
17958	</desc>
17959	</attribute>
17960
17961	<method name="find">
17962	<desc>
17963	Returns the extension pack with the specified name if found.
17964
17965	<result name="VBOX_E_OBJECT_NOT_FOUND">
17966	No extension pack matching @a name was found.
17967	</result>
17968	</desc>
17969	<param name="name" type="wstring" dir="in">
17970	<desc>The name of the extension pack to locate.</desc>
17971	</param>
17972	<param name="returnData" type="IExtPack" dir="return">
17973	<desc>The extension pack if found.</desc>
17974	</param>
17975	</method>
17976
17977	<method name="openExtPackFile">
17978	<desc>
17979	Attempts to open an extension pack file in preparation for
17980	installation.
17981	</desc>
17982	<param name="path" type="wstring" dir="in">
17983	<desc>The path of the extension pack tarball. This can optionally be
17984	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
17985	</param>
17986	<param name="file" type="IExtPackFile" dir="return">
17987	<desc>The interface of the extension pack file object.</desc>
17988	</param>
17989	</method>
17990
17991	<method name="uninstall">
17992	<desc>Uninstalls an extension pack, removing all related files.</desc>
17993	<param name="name" type="wstring" dir="in">
17994	<desc>The name of the extension pack to uninstall.</desc>
17995	</param>
17996	<param name="forcedRemoval" type="boolean" dir="in">
17997	<desc>
17998	Forced removal of the extension pack. This means that the uninstall
17999	hook will not be called.
18000	</desc>
18001	</param>
18002	<param name="displayInfo" type="wstring" dir="in">
18003	<desc>
18004	Platform specific display information. Reserved for future hacks.
18005	</desc>
18006	</param>
18007	<param name="progess" type="IProgress" dir="return">
18008	<desc>
18009	Progress object for the operation.
18010	</desc>
18011	</param>
18012	</method>
18013
18014	<method name="cleanup">
18015	<desc>Cleans up failed installs and uninstalls</desc>
18016	</method>
18017
18018	<method name="queryAllPlugInsForFrontend">
18019	<desc>
18020	Gets the path to all the plug-in modules for a given frontend.
18021
18022	This is a convenience method that is intended to simplify the plug-in
18023	loading process for a frontend.
18024	</desc>
18025	<param name="frontendName" type="wstring" dir="in">
18026	<desc>The name of the frontend or component.</desc>
18027	</param>
18028	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18029	<desc>Array containing the plug-in modules (full paths).</desc>
18030	</param>
18031	</method>
18032
18033	<method name="isExtPackUsable">
18034	<desc>Check if the given extension pack is loaded and usable.</desc>
18035	<param name="name" type="wstring" dir="in">
18036	<desc>The name of the extension pack to check for.</desc>
18037	</param>
18038	<param name="usable" type="boolean" dir="return">
18039	<desc>Is the given extension pack loaded and usable.</desc>
18040	</param>
18041	</method>
18042
18043	</interface>
18044
18045	<!--
18046	// BandwidthGroupType
18047	/////////////////////////////////////////////////////////////////////////
18048	-->
18049	<enum
18050	name="BandwidthGroupType"
18051	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18052
18053	<desc>
18054	Type of a bandwidth control group.
18055	</desc>
18056
18057	<const name="Null" value="0">
18058	<desc>
18059	Null type, must be first.
18060	</desc>
18061	</const>
18062
18063	<const name="Disk" value="1">
18064	<desc>
18065	The bandwidth group controls disk I/O.
18066	</desc>
18067	</const>
18068
18069	<const name="Network" value="2">
18070	<desc>
18071	The bandwidth group controls network I/O.
18072	</desc>
18073	</const>
18074
18075	</enum>
18076
18077	<!--
18078	// IBandwidthGroup
18079	/////////////////////////////////////////////////////////////////////////
18080	-->
18081	<interface
18082	name="IBandwidthGroup" extends="$unknown"
18083	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18084	wsmap="managed"
18085	>
18086	<desc>Represents one bandwidth group.</desc>
18087
18088	<attribute name="name" type="wstring" readonly="yes">
18089	<desc>Name of the group.</desc>
18090	</attribute>
18091
18092	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18093	<desc>Type of the group.</desc>
18094	</attribute>
18095
18096	<attribute name="reference" type="unsigned long" readonly="yes">
18097	<desc>How many devices/medium attachements use this group.</desc>
18098	</attribute>
18099
18100	<attribute name="maxBytesPerSec" type="long long">
18101	<desc>The maximum number of bytes which can be transfered by all
18102	entities attached to this group during one second.</desc>
18103	</attribute>
18104
18105	</interface>
18106
18107	<!--
18108	// IBandwidthControl
18109	/////////////////////////////////////////////////////////////////////////
18110	-->
18111	<interface
18112	name="IBandwidthControl" extends="$unknown"
18113	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18114	wsmap="managed"
18115	>
18116	<desc>
18117	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18118	This includes network and disk I/O.
18119	</desc>
18120
18121	<attribute name="numGroups" type="unsigned long" readonly="yes">
18122	<desc>
18123	The current number of existing bandwidth groups managed.
18124	</desc>
18125	</attribute>
18126
18127	<method name="createBandwidthGroup">
18128	<desc>
18129	Creates a new bandwidth group.
18130	</desc>
18131
18132	<param name="name" type="wstring" dir="in">
18133	<desc>Name of the bandwidth group.</desc>
18134	</param>
18135	<param name="type" type="BandwidthGroupType" dir="in">
18136	<desc>The type of the bandwidth group (network or disk).</desc>
18137	</param>
18138	<param name="maxBytesPerSec" type="long long" dir="in">
18139	<desc>The maximum number of bytes which can be transfered by all
18140	entities attached to this group during one second.</desc>
18141	</param>
18142	</method>
18143
18144	<method name="deleteBandwidthGroup">
18145	<desc>
18146	Deletes a new bandwidth group.
18147	</desc>
18148
18149	<param name="name" type="wstring" dir="in">
18150	<desc>Name of the bandwidth group to delete.</desc>
18151	</param>
18152	</method>
18153
18154	<method name="getBandwidthGroup" const="yes">
18155	<desc>
18156	Get a bandwidth group by name.
18157	</desc>
18158
18159	<param name="name" type="wstring" dir="in">
18160	<desc>Name of the bandwidth group to get.</desc>
18161	</param>
18162	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18163	<desc>Where to store the bandwidth group on success.</desc>
18164	</param>
18165	</method>
18166
18167	<method name="getAllBandwidthGroups" const="yes">
18168	<desc>
18169	Get all managed bandwidth groups.
18170	</desc>
18171
18172	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18173	<desc>The array of managed bandwidth groups.</desc>
18174	</param>
18175	</method>
18176	</interface>
18177
18178	<!--
18179	// IVirtualBoxClient
18180	/////////////////////////////////////////////////////////////////////////
18181	-->
18182
18183	<interface
18184	name="IVirtualBoxClient" extends="$unknown"
18185	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
18186	wsmap="suppress"
18187	>
18188	<desc>
18189	Convenience interface for client applications. Treat this as a
18190	singleton, i.e. never create more than one instance of this interface.
18191
18192	At the moment only available for clients of the local API (not usable
18193	via the webservice). Once the session logic is redesigned this might
18194	change.
18195	</desc>
18196
18197	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18198	<desc>
18199	Reference to the server-side API root object.
18200	</desc>
18201	</attribute>
18202
18203	<attribute name="session" type="ISession" readonly="yes">
18204	<desc>
18205	Create a new session object and return the reference to it.
18206	</desc>
18207	</attribute>
18208
18209	<attribute name="eventSource" type="IEventSource" readonly="yes">
18210	<desc>
18211	Event source for VirtualBoxClient events.
18212	</desc>
18213	</attribute>
18214
18215	</interface>
18216
18217	<!--
18218	// Events
18219	/////////////////////////////////////////////////////////////////////////
18220	-->
18221	<enum
18222	name="VBoxEventType"
18223	uuid="0d67e79e-b7b1-4919-aab3-b36866075515"
18224	>
18225
18226	<desc>
18227	Type of an event.
18228	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18229	</desc>
18230
18231	<const name="Invalid" value="0">
18232	<desc>
18233	Invalid event, must be first.
18234	</desc>
18235	</const>
18236
18237	<const name="Any" value="1">
18238	<desc>
18239	Wildcard for all events.
18240	Events of this type are never delivered, and only used in
18241	<link to="IEventSource::registerListener"/> call to simplify registration.
18242	</desc>
18243	</const>
18244
18245	<const name="Vetoable" value="2">
18246	<desc>
18247	Wildcard for all vetoable events. Events of this type are never delivered, and only
18248	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18249	</desc>
18250	</const>
18251
18252	<const name="MachineEvent" value="3">
18253	<desc>
18254	Wildcard for all machine events. Events of this type are never delivered, and only used in
18255	<link to="IEventSource::registerListener"/> call to simplify registration.
18256	</desc>
18257	</const>
18258
18259	<const name="SnapshotEvent" value="4">
18260	<desc>
18261	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18262	<link to="IEventSource::registerListener"/> call to simplify registration.
18263	</desc>
18264	</const>
18265
18266	<const name="InputEvent" value="5">
18267	<desc>
18268	Wildcard for all input device (keyboard, mouse) events.
18269	Events of this type are never delivered, and only used in
18270	<link to="IEventSource::registerListener"/> call to simplify registration.
18271	</desc>
18272	</const>
18273
18274	<const name="LastWildcard" value="31">
18275	<desc>
18276	Last wildcard.
18277	</desc>
18278	</const>
18279
18280	<const name="OnMachineStateChanged" value="32">
18281	<desc>
18282	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18283	</desc>
18284	</const>
18285	<const name="OnMachineDataChanged" value="33">
18286	<desc>
18287	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18288	</desc>
18289	</const>
18290	<const name="OnExtraDataChanged" value="34">
18291	<desc>
18292	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18293	</desc>
18294	</const>
18295	<const name="OnExtraDataCanChange" value="35">
18296	<desc>
18297	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18298	</desc>
18299	</const>
18300	<const name="OnMediumRegistered" value="36">
18301	<desc>
18302	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18303	</desc>
18304	</const>
18305	<const name="OnMachineRegistered" value="37">
18306	<desc>
18307	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18308	</desc>
18309	</const>
18310	<const name="OnSessionStateChanged" value="38">
18311	<desc>
18312	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18313	</desc>
18314	</const>
18315	<const name="OnSnapshotTaken" value="39">
18316	<desc>
18317	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18318	</desc>
18319	</const>
18320	<const name="OnSnapshotDeleted" value="40">
18321	<desc>
18322	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18323	</desc>
18324	</const>
18325	<const name="OnSnapshotChanged" value="41">
18326	<desc>
18327	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18328	</desc>
18329	</const>
18330	<const name="OnGuestPropertyChanged" value="42">
18331	<desc>
18332	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18333	</desc>
18334	</const>
18335	<!-- Console events -->
18336	<const name="OnMousePointerShapeChanged" value="43">
18337	<desc>
18338	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18339	</desc>
18340	</const>
18341	<const name="OnMouseCapabilityChanged" value="44">
18342	<desc>
18343	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18344	</desc>
18345	</const>
18346	<const name="OnKeyboardLedsChanged" value="45">
18347	<desc>
18348	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18349	</desc>
18350	</const>
18351	<const name="OnStateChanged" value="46">
18352	<desc>
18353	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18354	</desc>
18355	</const>
18356	<const name="OnAdditionsStateChanged" value="47">
18357	<desc>
18358	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18359	</desc>
18360	</const>
18361	<const name="OnNetworkAdapterChanged" value="48">
18362	<desc>
18363	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18364	</desc>
18365	</const>
18366	<const name="OnSerialPortChanged" value="49">
18367	<desc>
18368	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18369	</desc>
18370	</const>
18371	<const name="OnParallelPortChanged" value="50">
18372	<desc>
18373	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18374	</desc>
18375	</const>
18376	<const name="OnStorageControllerChanged" value="51">
18377	<desc>
18378	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18379	</desc>
18380	</const>
18381	<const name="OnMediumChanged" value="52">
18382	<desc>
18383	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18384	</desc>
18385	</const>
18386	<const name="OnVRDEServerChanged" value="53">
18387	<desc>
18388	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18389	</desc>
18390	</const>
18391	<const name="OnUSBControllerChanged" value="54">
18392	<desc>
18393	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18394	</desc>
18395	</const>
18396	<const name="OnUSBDeviceStateChanged" value="55">
18397	<desc>
18398	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18399	</desc>
18400	</const>
18401	<const name="OnSharedFolderChanged" value="56">
18402	<desc>
18403	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18404	</desc>
18405	</const>
18406	<const name="OnRuntimeError" value="57">
18407	<desc>
18408	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18409	</desc>
18410	</const>
18411	<const name="OnCanShowWindow" value="58">
18412	<desc>
18413	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18414	</desc>
18415	</const>
18416	<const name="OnShowWindow" value="59">
18417	<desc>
18418	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18419	</desc>
18420	</const>
18421	<const name="OnCPUChanged" value="60">
18422	<desc>
18423	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18424	</desc>
18425	</const>
18426	<const name="OnVRDEServerInfoChanged" value="61">
18427	<desc>
18428	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18429	</desc>
18430	</const>
18431	<const name="OnEventSourceChanged" value="62">
18432	<desc>
18433	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18434	</desc>
18435	</const>
18436	<const name="OnCPUExecutionCapChanged" value="63">
18437	<desc>
18438	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18439	</desc>
18440	</const>
18441	<const name="OnGuestKeyboard" value="64">
18442	<desc>
18443	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18444	</desc>
18445	</const>
18446	<const name="OnGuestMouse" value="65">
18447	<desc>
18448	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18449	</desc>
18450	</const>
18451	<const name="OnNATRedirect" value="66">
18452	<desc>
18453	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18454	</desc>
18455	</const>
18456	<const name="OnHostPCIDevicePlug" value="67">
18457	<desc>
18458	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
18459	</desc>
18460	</const>
18461	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18462	<desc>
18463	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18464	</desc>
18465	</const>
18466	<const name="OnBandwidthGroupChanged" value="69">
18467	<desc>
18468	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18469	</desc>
18470	</const>
18471	<const name="OnGuestMonitorChanged" value="70">
18472	<desc>
18473	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18474	</desc>
18475	</const>
18476	<const name="OnStorageDeviceChanged" value="71">
18477	<desc>
18478	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18479	</desc>
18480	</const>
18481	<const name="OnClipboardModeChanged" value="72">
18482	<desc>
18483	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18484	</desc>
18485	</const>
18486	<const name="OnDragAndDropModeChanged" value="73">
18487	<desc>
18488	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
18489	</desc>
18490	</const>
18491
18492	<!-- Last event marker -->
18493	<const name="Last" value="74">
18494	<desc>
18495	Must be last event, used for iterations and structures relying on numerical event values.
18496	</desc>
18497	</const>
18498
18499	</enum>
18500
18501	<interface
18502	name="IEventSource" extends="$unknown"
18503	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
18504	wsmap="managed"
18505	>
18506	<desc>
18507	Event source. Generally, any object which could generate events can be an event source,
18508	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
18509	an event source can work with listeners in either active or passive mode. In active mode it is up to
18510	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
18511	event source keeps track of pending events for each listener and returns available events on demand.
18512
18513	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18514	</desc>
18515
18516	<method name="createListener">
18517	<desc>
18518	Creates a new listener object, useful for passive mode.
18519	</desc>
18520	<param name="listener" type="IEventListener" dir="return"/>
18521	</method>
18522
18523	<method name="createAggregator">
18524	<desc>
18525	Creates an aggregator event source, collecting events from multiple sources.
18526	This way a single listener can listen for events coming from multiple sources,
18527	using a single blocking <link to="#getEvent"/> on the returned aggregator.
18528	</desc>
18529	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
18530	<desc>
18531	Subordinate event source this one aggregatres.
18532	</desc>
18533	</param>
18534	<param name="result" type="IEventSource" dir="return">
18535	<desc>
18536	Event source aggregating passed sources.
18537	</desc>
18538	</param>
18539	</method>
18540
18541	<method name="registerListener">
18542	<desc>
18543	Register an event listener.
18544
18545	<note>
18546	To avoid system overload, the VirtualBox server process checks if passive event
18547	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
18548	current implementation, if more than 500 pending events are detected for a passive
18549	event listener, it is forcefully unregistered by the system, and further
18550	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
18551	</note>
18552	</desc>
18553	<param name="listener" type="IEventListener" dir="in">
18554	<desc>Listener to register.</desc>
18555	</param>
18556	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
18557	<desc>
18558	Event types listener is interested in. One can use wildcards like -
18559	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
18560	than one event.
18561	</desc>
18562	</param>
18563	<param name="active" type="boolean" dir="in">
18564	<desc>
18565	Which mode this listener is operating in.
18566	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
18567	In passive mode, an internal event queue is created for this this IEventListener.
18568	For each event coming in, it is added to queues for all interested registered passive
18569	listeners. It is then up to the external code to call the listener's
18570	<link to="IEventListener::handleEvent" /> method. When done with an event, the
18571	external code must call <link to="#eventProcessed" />.
18572	</desc>
18573	</param>
18574	</method>
18575
18576	<method name="unregisterListener">
18577	<desc>
18578	Unregister an event listener. If listener is passive, and some waitable events are still
18579	in queue they are marked as processed automatically.
18580	</desc>
18581	<param name="listener" type="IEventListener" dir="in">
18582	<desc>Listener to unregister.</desc>
18583	</param>
18584	</method>
18585
18586	<method name="fireEvent">
18587	<desc>
18588	Fire an event for this source.
18589	</desc>
18590	<param name="event" type="IEvent" dir="in">
18591	<desc>Event to deliver.</desc>
18592	</param>
18593	<param name="timeout" type="long" dir="in">
18594	<desc>
18595	Maximum time to wait for event processing (if event is waitable), in ms;
18596	0 = no wait, -1 = indefinite wait.
18597	</desc>
18598	</param>
18599	<param name="result" type="boolean" dir="return">
18600	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
18601	</param>
18602	</method>
18603
18604	<method name="getEvent">
18605	<desc>
18606	Get events from this peer's event queue (for passive mode). Calling this method
18607	regularly is required for passive event listeners to avoid system overload;
18608	see <link to="IEventSource::registerListener" /> for details.
18609
18610	<result name="VBOX_E_OBJECT_NOT_FOUND">
18611	Listener is not registered, or autounregistered.
18612	</result>
18613	</desc>
18614	<param name="listener" type="IEventListener" dir="in">
18615	<desc>Which listener to get data for.</desc>
18616	</param>
18617	<param name="timeout" type="long" dir="in">
18618	<desc>
18619	Maximum time to wait for events, in ms;
18620	0 = no wait, -1 = indefinite wait.
18621	</desc>
18622	</param>
18623	<param name="event" type="IEvent" dir="return">
18624	<desc>Event retrieved, or null if none available.</desc>
18625	</param>
18626	</method>
18627
18628	<method name="eventProcessed">
18629	<desc>
18630	Must be called for waitable events after a particular listener finished its
18631	event processing. When all listeners of a particular event have called this
18632	method, the system will then call <link to="IEvent::setProcessed" />.
18633	</desc>
18634	<param name="listener" type="IEventListener" dir="in">
18635	<desc>Which listener processed event.</desc>
18636	</param>
18637	<param name="event" type="IEvent" dir="in">
18638	<desc>Which event.</desc>
18639	</param>
18640	</method>
18641
18642	</interface>
18643
18644	<interface
18645	name="IEventListener" extends="$unknown"
18646	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
18647	wsmap="managed"
18648	>
18649	<desc>
18650	Event listener. An event listener can work in either active or passive mode, depending on the way
18651	it was registered.
18652	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18653	</desc>
18654
18655	<method name="handleEvent">
18656	<desc>
18657	Handle event callback for active listeners. It is not called for
18658	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
18659	and having received acknowledgement from all passive listeners via
18660	<link to="IEventSource::eventProcessed"/>, the event is marked as
18661	processed and <link to="IEvent::waitProcessed"/> will return
18662	immediately.
18663	</desc>
18664	<param name="event" type="IEvent" dir="in">
18665	<desc>Event available.</desc>
18666	</param>
18667	</method>
18668
18669	</interface>
18670
18671	<interface
18672	name="IEvent" extends="$unknown"
18673	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
18674	wsmap="managed"
18675	>
18676	<desc>
18677	Abstract parent interface for VirtualBox events. Actual events will typically implement
18678	a more specific interface which derives from this (see below).
18679
18680	<b>Introduction to VirtualBox events</b>
18681
18682	Generally speaking, an event (represented by this interface) signals that something
18683	happened, while an event listener (see <link to="IEventListener" />) represents an
18684	entity that is interested in certain events. In order for this to work with
18685	unidirectional protocols (i.e. web services), the concepts of passive and active
18686	listener are used.
18687
18688	Event consumers can register themselves as listeners, providing an array of
18689	events they are interested in (see <link to="IEventSource::registerListener" />).
18690	When an event triggers, the listener is notified about the event. The exact
18691	mechanism of the notification depends on whether the listener was registered as
18692	an active or passive listener:
18693
18694	<ul>
18695	<li>An active listener is very similar to a callback: it is a function invoked
18696	by the API. As opposed to the callbacks that were used in the API before
18697	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
18698	</li>
18699
18700	<li>Passive listeners are somewhat trickier to implement, but do not require
18701	a client function to be callable, which is not an option with scripting
18702	languages or web service clients. Internally the <link to="IEventSource" />
18703	implementation maintains an event queue for each passive listener, and
18704	newly arrived events are put in this queue. When the listener calls
18705	<link to="IEventSource::getEvent"/>, first element from its internal event
18706	queue is returned. When the client completes processing of an event,
18707	the <link to="IEventSource::eventProcessed" /> function must be called,
18708	acknowledging that the event was processed. It supports implementing
18709	waitable events. On passive listener unregistration, all events from its
18710	queue are auto-acknowledged.
18711	</li>
18712	</ul>
18713
18714	Waitable events are useful in situations where the event generator wants to track
18715	delivery or a party wants to wait until all listeners have completed the event. A
18716	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
18717	listeners might veto a certain action, and thus the event producer has to make
18718	sure that all listeners have processed the event and not vetoed before taking
18719	the action.
18720
18721	A given event may have both passive and active listeners at the same time.
18722
18723	<b>Using events</b>
18724
18725	Any VirtualBox object capable of producing externally visible events provides an
18726	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
18727	This event source object is notified by VirtualBox once something has happened, so
18728	consumers may register event listeners with this event source. To register a listener,
18729	an object implementing the <link to="IEventListener" /> interface must be provided.
18730	For active listeners, such an object is typically created by the consumer, while for
18731	passive listeners <link to="IEventSource::createListener" /> should be used. Please
18732	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
18733
18734	Once created, the listener must be registered to listen for the desired events
18735	(see <link to="IEventSource::registerListener" />), providing an array of
18736	<link to="VBoxEventType" /> enums. Those elements can either be the individual
18737	event IDs or wildcards matching multiple event IDs.
18738
18739	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
18740	called automatically when the event is triggered, while passive listeners have to call
18741	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
18742	an event processing loop.
18743
18744	The IEvent interface is an abstract parent interface for all such VirtualBox events
18745	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
18746	or the event processing loop is to check the <link to="#type" /> attribute of the event and
18747	then cast to the appropriate specific interface using @c QueryInterface().
18748	</desc>
18749
18750	<attribute name="type" readonly="yes" type="VBoxEventType">
18751	<desc>
18752	Event type.
18753	</desc>
18754	</attribute>
18755
18756	<attribute name="source" readonly="yes" type="IEventSource">
18757	<desc>
18758	Source of this event.
18759	</desc>
18760	</attribute>
18761
18762	<attribute name="waitable" readonly="yes" type="boolean">
18763	<desc>
18764	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
18765	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
18766	as no additional overhead associated with waitability imposed.
18767	Waitable events are needed when one need to be able to wait for particular event processed,
18768	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
18769	until all consumers confirmed events.
18770	</desc>
18771	</attribute>
18772
18773	<method name="setProcessed">
18774	<desc>
18775	Internal method called by the system when all listeners of a particular event have called
18776	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
18777	</desc>
18778	</method>
18779
18780	<method name="waitProcessed">
18781	<desc>
18782	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
18783	described semantics, for non-waitable returns true immediately.
18784	</desc>
18785	<param name="timeout" type="long" dir="in">
18786	<desc>
18787	Maximum time to wait for event processeing, in ms;
18788	0 = no wait, -1 = indefinite wait.
18789	</desc>
18790	</param>
18791	<param name="result" type="boolean" dir="return">
18792	<desc>If this event was processed before timeout.</desc>
18793	</param>
18794	</method>
18795	</interface>
18796
18797
18798	<interface
18799	name="IReusableEvent" extends="IEvent"
18800	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
18801	wsmap="managed"
18802	>
18803	<desc>Base abstract interface for all reusable events.</desc>
18804
18805	<attribute name="generation" readonly="yes" type="unsigned long">
18806	<desc>Current generation of event, incremented on reuse.</desc>
18807	</attribute>
18808
18809	<method name="reuse">
18810	<desc>
18811	Marks an event as reused, increments 'generation', fields shall no
18812	longer be considered valid.
18813	</desc>
18814	</method>
18815	</interface>
18816
18817	<interface
18818	name="IMachineEvent" extends="IEvent"
18819	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
18820	wsmap="managed" id="MachineEvent"
18821	>
18822	<desc>Base abstract interface for all machine events.</desc>
18823
18824	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
18825	<desc>ID of the machine this event relates to.</desc>
18826	</attribute>
18827
18828	</interface>
18829
18830	<interface
18831	name="IMachineStateChangedEvent" extends="IMachineEvent"
18832	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
18833	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
18834	>
18835	<desc>Machine state change event.</desc>
18836
18837	<attribute name="state" readonly="yes" type="MachineState">
18838	<desc>New execution state.</desc>
18839	</attribute>
18840	</interface>
18841
18842	<interface
18843	name="IMachineDataChangedEvent" extends="IMachineEvent"
18844	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
18845	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
18846	>
18847	<desc>
18848	Any of the settings of the given machine has changed.
18849	</desc>
18850
18851	<attribute name="temporary" readonly="yes" type="boolean">
18852	<desc>@c true if the settings change is temporary. All permanent
18853	settings changes will trigger an event, and only temporary settings
18854	changes for running VMs will trigger an event. Note: sending events
18855	for temporary changes is NOT IMPLEMENTED.</desc>
18856	</attribute>
18857	</interface>
18858
18859	<interface
18860	name="IMediumRegisteredEvent" extends="IEvent"
18861	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
18862	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
18863	>
18864	<desc>
18865	The given medium was registered or unregistered
18866	within this VirtualBox installation.
18867	</desc>
18868
18869	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
18870	<desc>ID of the medium this event relates to.</desc>
18871	</attribute>
18872
18873	<attribute name="mediumType" readonly="yes" type="DeviceType">
18874	<desc>Type of the medium this event relates to.</desc>
18875	</attribute>
18876
18877	<attribute name="registered" type="boolean" readonly="yes">
18878	<desc>
18879	If @c true, the medium was registered, otherwise it was
18880	unregistered.
18881	</desc>
18882	</attribute>
18883	</interface>
18884
18885	<interface
18886	name="IMachineRegisteredEvent" extends="IMachineEvent"
18887	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
18888	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
18889	>
18890	<desc>
18891	The given machine was registered or unregistered
18892	within this VirtualBox installation.
18893	</desc>
18894
18895	<attribute name="registered" type="boolean" readonly="yes">
18896	<desc>
18897	If @c true, the machine was registered, otherwise it was
18898	unregistered.
18899	</desc>
18900	</attribute>
18901	</interface>
18902
18903	<interface
18904	name="ISessionStateChangedEvent" extends="IMachineEvent"
18905	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
18906	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
18907	>
18908	<desc>
18909	The state of the session for the given machine was changed.
18910	<see><link to="IMachine::sessionState"/></see>
18911	</desc>
18912
18913	<attribute name="state" type="SessionState" readonly="yes">
18914	<desc>
18915	New session state.
18916	</desc>
18917	</attribute>
18918	</interface>
18919
18920	<interface
18921	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
18922	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
18923	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
18924	>
18925	<desc>
18926	Notification when a guest property has changed.
18927	</desc>
18928
18929	<attribute name="name" readonly="yes" type="wstring">
18930	<desc>
18931	The name of the property that has changed.
18932	</desc>
18933	</attribute>
18934
18935	<attribute name="value" readonly="yes" type="wstring">
18936	<desc>
18937	The new property value.
18938	</desc>
18939	</attribute>
18940
18941	<attribute name="flags" readonly="yes" type="wstring">
18942	<desc>
18943	The new property flags.
18944	</desc>
18945	</attribute>
18946
18947	</interface>
18948
18949	<interface
18950	name="ISnapshotEvent" extends="IMachineEvent"
18951	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
18952	wsmap="managed" id="SnapshotEvent"
18953	>
18954	<desc>Base interface for all snapshot events.</desc>
18955
18956	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
18957	<desc>ID of the snapshot this event relates to.</desc>
18958	</attribute>
18959
18960	</interface>
18961
18962	<interface
18963	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
18964	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
18965	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
18966	>
18967	<desc>
18968	A new snapshot of the machine has been taken.
18969	<see><link to="ISnapshot"/></see>
18970	</desc>
18971	</interface>
18972
18973	<interface
18974	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
18975	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
18976	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
18977	>
18978	<desc>
18979	Snapshot of the given machine has been deleted.
18980
18981	<note>
18982	This notification is delivered <b>after</b> the snapshot
18983	object has been uninitialized on the server (so that any
18984	attempt to call its methods will return an error).
18985	</note>
18986
18987	<see><link to="ISnapshot"/></see>
18988	</desc>
18989	</interface>
18990
18991	<interface
18992	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
18993	uuid="07541941-8079-447a-a33e-47a69c7980db"
18994	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
18995	>
18996	<desc>
18997	Snapshot properties (name and/or description) have been changed.
18998	<see><link to="ISnapshot"/></see>
18999	</desc>
19000	</interface>
19001
19002	<interface
19003	name="IMousePointerShapeChangedEvent" extends="IEvent"
19004	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19005	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19006	>
19007	<desc>
19008	Notification when the guest mouse pointer shape has
19009	changed. The new shape data is given.
19010	</desc>
19011
19012	<attribute name="visible" type="boolean" readonly="yes">
19013	<desc>
19014	Flag whether the pointer is visible.
19015	</desc>
19016	</attribute>
19017	<attribute name="alpha" type="boolean" readonly="yes">
19018	<desc>
19019	Flag whether the pointer has an alpha channel.
19020	</desc>
19021	</attribute>
19022	<attribute name="xhot" type="unsigned long" readonly="yes">
19023	<desc>
19024	The pointer hot spot X coordinate.
19025	</desc>
19026	</attribute>
19027	<attribute name="yhot" type="unsigned long" readonly="yes">
19028	<desc>
19029	The pointer hot spot Y coordinate.
19030	</desc>
19031	</attribute>
19032	<attribute name="width" type="unsigned long" readonly="yes">
19033	<desc>
19034	Width of the pointer shape in pixels.
19035	</desc>
19036	</attribute>
19037	<attribute name="height" type="unsigned long" readonly="yes">
19038	<desc>
19039	Height of the pointer shape in pixels.
19040	</desc>
19041	</attribute>
19042	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19043	<desc>
19044	Shape buffer arrays.
19045
19046	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19047	followed by a 32-bpp XOR (color) mask.
19048
19049	For pointers without alpha channel the XOR mask pixels are 32
19050	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19051	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19052
19053	An AND mask is used for pointers with alpha channel, so if the
19054	callback does not support alpha, the pointer could be
19055	displayed as a normal color pointer.
19056
19057	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19058	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19059	height</tt>. The padding bits at the end of each scanline are
19060	undefined.
19061
19062	The XOR mask follows the AND mask on the next 4-byte aligned
19063	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19064	Bytes in the gap between the AND and the XOR mask are undefined.
19065	The XOR mask scanlines have no gap between them and the size of
19066	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19067
19068	<note>
19069	If @a shape is 0, only the pointer visibility is changed.
19070	</note>
19071	</desc>
19072	</attribute>
19073	</interface>
19074
19075	<interface
19076	name="IMouseCapabilityChangedEvent" extends="IEvent"
19077	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19078	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19079	>
19080	<desc>
19081	Notification when the mouse capabilities reported by the
19082	guest have changed. The new capabilities are passed.
19083	</desc>
19084	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19085	<desc>
19086	Supports absolute coordinates.
19087	</desc>
19088	</attribute>
19089	<attribute name="supportsRelative" type="boolean" readonly="yes">
19090	<desc>
19091	Supports relative coordinates.
19092	</desc>
19093	</attribute>
19094	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19095	<desc>
19096	If host cursor is needed.
19097	</desc>
19098	</attribute>
19099	</interface>
19100
19101	<interface
19102	name="IKeyboardLedsChangedEvent" extends="IEvent"
19103	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19104	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19105	>
19106	<desc>
19107	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19108	to alter the state of the keyboard LEDs.
19109	</desc>
19110	<attribute name="numLock" type="boolean" readonly="yes">
19111	<desc>
19112	NumLock status.
19113	</desc>
19114	</attribute>
19115	<attribute name="capsLock" type="boolean" readonly="yes">
19116	<desc>
19117	CapsLock status.
19118	</desc>
19119	</attribute>
19120	<attribute name="scrollLock" type="boolean" readonly="yes">
19121	<desc>
19122	ScrollLock status.
19123	</desc>
19124	</attribute>
19125	</interface>
19126
19127	<interface
19128	name="IStateChangedEvent" extends="IEvent"
19129	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19130	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19131	>
19132	<desc>
19133	Notification when the execution state of the machine has changed.
19134	The new state is given.
19135	</desc>
19136	<attribute name="state" type="MachineState" readonly="yes">
19137	<desc>
19138	New machine state.
19139	</desc>
19140	</attribute>
19141	</interface>
19142
19143	<interface
19144	name="IAdditionsStateChangedEvent" extends="IEvent"
19145	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19146	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19147	>
19148	<desc>
19149	Notification when a Guest Additions property changes.
19150	Interested callees should query IGuest attributes to
19151	find out what has changed.
19152	</desc>
19153	</interface>
19154
19155	<interface
19156	name="INetworkAdapterChangedEvent" extends="IEvent"
19157	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19158	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19159	>
19160	<desc>
19161	Notification when a property of one of the
19162	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19163	changes. Interested callees should use INetworkAdapter methods and
19164	attributes to find out what has changed.
19165	</desc>
19166	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19167	<desc>
19168	Network adapter that is subject to change.
19169	</desc>
19170	</attribute>
19171	</interface>
19172
19173	<interface
19174	name="ISerialPortChangedEvent" extends="IEvent"
19175	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19176	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19177	>
19178	<desc>
19179	Notification when a property of one of the
19180	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19181	Interested callees should use ISerialPort methods and attributes
19182	to find out what has changed.
19183	</desc>
19184	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19185	<desc>
19186	Serial port that is subject to change.
19187	</desc>
19188	</attribute>
19189	</interface>
19190
19191	<interface
19192	name="IParallelPortChangedEvent" extends="IEvent"
19193	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19194	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19195	>
19196	<desc>
19197	Notification when a property of one of the
19198	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19199	changes. Interested callees should use ISerialPort methods and
19200	attributes to find out what has changed.
19201	</desc>
19202	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19203	<desc>
19204	Parallel port that is subject to change.
19205	</desc>
19206	</attribute>
19207	</interface>
19208
19209	<interface
19210	name="IStorageControllerChangedEvent" extends="IEvent"
19211	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19212	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19213	>
19214	<desc>
19215	Notification when a
19216	<link to="IMachine::mediumAttachments">medium attachment</link>
19217	changes.
19218	</desc>
19219	</interface>
19220
19221	<interface
19222	name="IMediumChangedEvent" extends="IEvent"
19223	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19224	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19225	>
19226	<desc>
19227	Notification when a
19228	<link to="IMachine::mediumAttachments">medium attachment</link>
19229	changes.
19230	</desc>
19231	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19232	<desc>
19233	Medium attachment that is subject to change.
19234	</desc>
19235	</attribute>
19236	</interface>
19237
19238	<interface
19239	name="IClipboardModeChangedEvent" extends="IEvent"
19240	uuid="cac21692-7997-4595-a731-3a509db604e5"
19241	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19242	>
19243	<desc>
19244	Notification when the shared clipboard mode changes.
19245	</desc>
19246	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19247	<desc>
19248	The new clipboard mode.
19249	</desc>
19250	</attribute>
19251	</interface>
19252
19253	<interface
19254	name="IDragAndDropModeChangedEvent" extends="IEvent"
19255	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19256	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19257	>
19258	<desc>
19259	Notification when the drag'n'drop mode changes.
19260	</desc>
19261	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19262	<desc>
19263	The new drag'n'drop mode.
19264	</desc>
19265	</attribute>
19266	</interface>
19267
19268	<interface
19269	name="ICPUChangedEvent" extends="IEvent"
19270	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19271	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19272	>
19273	<desc>
19274	Notification when a CPU changes.
19275	</desc>
19276	<attribute name="CPU" type="unsigned long" readonly="yes">
19277	<desc>
19278	The CPU which changed.
19279	</desc>
19280	</attribute>
19281	<attribute name="add" type="boolean" readonly="yes">
19282	<desc>
19283	Flag whether the CPU was added or removed.
19284	</desc>
19285	</attribute>
19286	</interface>
19287
19288	<interface
19289	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19290	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19291	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19292	>
19293	<desc>
19294	Notification when the CPU execution cap changes.
19295	</desc>
19296	<attribute name="executionCap" type="unsigned long" readonly="yes">
19297	<desc>
19298	The new CPU execution cap value. (1-100)
19299	</desc>
19300	</attribute>
19301	</interface>
19302
19303	<interface
19304	name="IGuestKeyboardEvent" extends="IEvent"
19305	uuid="88394258-7006-40d4-b339-472ee3801844"
19306	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19307	>
19308	<desc>
19309	Notification when guest keyboard event happens.
19310	</desc>
19311	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19312	<desc>
19313	Array of scancodes.
19314	</desc>
19315	</attribute>
19316	</interface>
19317
19318	<interface
19319	name="IGuestMouseEvent" extends="IReusableEvent"
19320	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19321	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19322	>
19323	<desc>
19324	Notification when guest mouse event happens.
19325	</desc>
19326
19327	<attribute name="absolute" type="boolean" readonly="yes">
19328	<desc>
19329	If this event is relative or absolute.
19330	</desc>
19331	</attribute>
19332
19333	<attribute name="x" type="long" readonly="yes">
19334	<desc>
19335	New X position, or X delta.
19336	</desc>
19337	</attribute>
19338
19339	<attribute name="y" type="long" readonly="yes">
19340	<desc>
19341	New Y position, or Y delta.
19342	</desc>
19343	</attribute>
19344
19345	<attribute name="z" type="long" readonly="yes">
19346	<desc>
19347	Z delta.
19348	</desc>
19349	</attribute>
19350
19351	<attribute name="w" type="long" readonly="yes">
19352	<desc>
19353	W delta.
19354	</desc>
19355	</attribute>
19356
19357	<attribute name="buttons" type="long" readonly="yes">
19358	<desc>
19359	Button state bitmask.
19360	</desc>
19361	</attribute>
19362
19363	</interface>
19364
19365
19366	<interface
19367	name="IVRDEServerChangedEvent" extends="IEvent"
19368	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
19369	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
19370	>
19371	<desc>
19372	Notification when a property of the
19373	<link to="IMachine::VRDEServer">VRDE server</link> changes.
19374	Interested callees should use IVRDEServer methods and attributes to
19375	find out what has changed.
19376	</desc>
19377	</interface>
19378
19379	<interface
19380	name="IVRDEServerInfoChangedEvent" extends="IEvent"
19381	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
19382	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
19383	>
19384	<desc>
19385	Notification when the status of the VRDE server changes. Interested callees
19386	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
19387	attributes to find out what is the current status.
19388	</desc>
19389	</interface>
19390
19391	<interface
19392	name="IUSBControllerChangedEvent" extends="IEvent"
19393	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
19394	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
19395	>
19396	<desc>
19397	Notification when a property of the virtual
19398	<link to="IMachine::USBController">USB controller</link> changes.
19399	Interested callees should use IUSBController methods and attributes to
19400	find out what has changed.
19401	</desc>
19402	</interface>
19403
19404	<interface
19405	name="IUSBDeviceStateChangedEvent" extends="IEvent"
19406	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
19407	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
19408	>
19409	<desc>
19410	Notification when a USB device is attached to or detached from
19411	the virtual USB controller.
19412
19413	This notification is sent as a result of the indirect
19414	request to attach the device because it matches one of the
19415	machine USB filters, or as a result of the direct request
19416	issued by <link to="IConsole::attachUSBDevice"/> or
19417	<link to="IConsole::detachUSBDevice"/>.
19418
19419	This notification is sent in case of both a succeeded and a
19420	failed request completion. When the request succeeds, the
19421	@a error parameter is @c null, and the given device has been
19422	already added to (when @a attached is @c true) or removed from
19423	(when @a attached is @c false) the collection represented by
19424	<link to="IConsole::USBDevices"/>. On failure, the collection
19425	doesn't change and the @a error parameter represents the error
19426	message describing the failure.
19427	</desc>
19428	<attribute name="device" type="IUSBDevice" readonly="yes">
19429	<desc>
19430	Device that is subject to state change.
19431	</desc>
19432	</attribute>
19433	<attribute name="attached" type="boolean" readonly="yes">
19434	<desc>
19435	@c true if the device was attached and @c false otherwise.
19436	</desc>
19437	</attribute>
19438	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
19439	<desc>
19440	@c null on success or an error message object on failure.
19441	</desc>
19442	</attribute>
19443	</interface>
19444
19445	<interface
19446	name="ISharedFolderChangedEvent" extends="IEvent"
19447	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
19448	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
19449	>
19450	<desc>
19451	Notification when a shared folder is added or removed.
19452	The @a scope argument defines one of three scopes:
19453	<link to="IVirtualBox::sharedFolders">global shared folders</link>
19454	(<link to="Scope_Global">Global</link>),
19455	<link to="IMachine::sharedFolders">permanent shared folders</link> of
19456	the machine (<link to="Scope_Machine">Machine</link>) or <link
19457	to="IConsole::sharedFolders">transient shared folders</link> of the
19458	machine (<link to="Scope_Session">Session</link>). Interested callees
19459	should use query the corresponding collections to find out what has
19460	changed.
19461	</desc>
19462	<attribute name="scope" type="Scope" readonly="yes">
19463	<desc>
19464	Scope of the notification.
19465	</desc>
19466	</attribute>
19467	</interface>
19468
19469	<interface
19470	name="IRuntimeErrorEvent" extends="IEvent"
19471	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
19472	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
19473	>
19474	<desc>
19475	Notification when an error happens during the virtual
19476	machine execution.
19477
19478	There are three kinds of runtime errors:
19479	<ul>
19480	<li><i>fatal</i></li>
19481	<li><i>non-fatal with retry</i></li>
19482	<li><i>non-fatal warnings</i></li>
19483	</ul>
19484
19485	<b>Fatal</b> errors are indicated by the @a fatal parameter set
19486	to @c true. In case of fatal errors, the virtual machine
19487	execution is always paused before calling this notification, and
19488	the notification handler is supposed either to immediately save
19489	the virtual machine state using <link to="IConsole::saveState"/>
19490	or power it off using <link to="IConsole::powerDown"/>.
19491	Resuming the execution can lead to unpredictable results.
19492
19493	<b>Non-fatal</b> errors and warnings are indicated by the
19494	@a fatal parameter set to @c false. If the virtual machine
19495	is in the Paused state by the time the error notification is
19496	received, it means that the user can <i>try to resume</i> the machine
19497	execution after attempting to solve the problem that caused the
19498	error. In this case, the notification handler is supposed
19499	to show an appropriate message to the user (depending on the
19500	value of the @a id parameter) that offers several actions such
19501	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
19502	wants to retry, the notification handler should continue
19503	the machine execution using the <link to="IConsole::resume"/>
19504	call. If the machine execution is not Paused during this
19505	notification, then it means this notification is a <i>warning</i>
19506	(for example, about a fatal condition that can happen very soon);
19507	no immediate action is required from the user, the machine
19508	continues its normal execution.
19509
19510	Note that in either case the notification handler
19511	<b>must not</b> perform any action directly on a thread
19512	where this notification is called. Everything it is allowed to
19513	do is to post a message to another thread that will then talk
19514	to the user and take the corresponding action.
19515
19516	Currently, the following error identifiers are known:
19517	<ul>
19518	<li><tt>"HostMemoryLow"</tt></li>
19519	<li><tt>"HostAudioNotResponding"</tt></li>
19520	<li><tt>"VDIStorageFull"</tt></li>
19521	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
19522	</ul>
19523	</desc>
19524	<attribute name="fatal" type="boolean" readonly="yes">
19525	<desc>
19526	Whether the error is fatal or not.
19527	</desc>
19528	</attribute>
19529	<attribute name="id" type="wstring" readonly="yes">
19530	<desc>
19531	Error identifier.
19532	</desc>
19533	</attribute>
19534	<attribute name="message" type="wstring" readonly="yes">
19535	<desc>
19536	Optional error message.
19537	</desc>
19538	</attribute>
19539	</interface>
19540
19541
19542	<interface
19543	name="IEventSourceChangedEvent" extends="IEvent"
19544	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
19545	waitable="yes"
19546	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
19547	>
19548	<desc>
19549	Notification when an event source state changes (listener added or removed).
19550	</desc>
19551
19552	<attribute name="listener" type="IEventListener" readonly="yes">
19553	<desc>
19554	Event listener which has changed.
19555	</desc>
19556	</attribute>
19557
19558	<attribute name="add" type="boolean" readonly="yes">
19559	<desc>
19560	Flag whether listener was added or removed.
19561	</desc>
19562	</attribute>
19563	</interface>
19564
19565	<interface
19566	name="IExtraDataChangedEvent" extends="IEvent"
19567	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
19568	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
19569	>
19570	<desc>
19571	Notification when machine specific or global extra data
19572	has changed.
19573	</desc>
19574	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19575	<desc>
19576	ID of the machine this event relates to.
19577	Null for global extra data changes.
19578	</desc>
19579	</attribute>
19580	<attribute name="key" type="wstring" readonly="yes">
19581	<desc>
19582	Extra data key that has changed.
19583	</desc>
19584	</attribute>
19585	<attribute name="value" type="wstring" readonly="yes">
19586	<desc>
19587	Extra data value for the given key.
19588	</desc>
19589	</attribute>
19590	</interface>
19591
19592	<interface
19593	name="IVetoEvent" extends="IEvent"
19594	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
19595	wsmap="managed"
19596	>
19597	<desc>Base abstract interface for veto events.</desc>
19598
19599	<method name="addVeto">
19600	<desc>
19601	Adds a veto on this event.
19602	</desc>
19603	<param name="reason" type="wstring" dir="in">
19604	<desc>
19605	Reason for veto, could be null or empty string.
19606	</desc>
19607	</param>
19608	</method>
19609
19610	<method name="isVetoed">
19611	<desc>
19612	If this event was vetoed.
19613	</desc>
19614	<param name="result" type="boolean" dir="return">
19615	<desc>
19616	Reason for veto.
19617	</desc>
19618	</param>
19619	</method>
19620
19621	<method name="getVetos">
19622	<desc>
19623	Current veto reason list, if size is 0 - no veto.
19624	</desc>
19625	<param name="result" type="wstring" dir="return" safearray="yes">
19626	<desc>
19627	Array of reasons for veto provided by different event handlers.
19628	</desc>
19629	</param>
19630	</method>
19631
19632	</interface>
19633
19634	<interface
19635	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
19636	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
19637	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
19638	waitable="true"
19639	>
19640	<desc>
19641	Notification when someone tries to change extra data for
19642	either the given machine or (if @c null) global extra data.
19643	This gives the chance to veto against changes.
19644	</desc>
19645	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19646	<desc>
19647	ID of the machine this event relates to.
19648	Null for global extra data changes.
19649	</desc>
19650	</attribute>
19651	<attribute name="key" type="wstring" readonly="yes">
19652	<desc>
19653	Extra data key that has changed.
19654	</desc>
19655	</attribute>
19656	<attribute name="value" type="wstring" readonly="yes">
19657	<desc>
19658	Extra data value for the given key.
19659	</desc>
19660	</attribute>
19661	</interface>
19662
19663	<interface
19664	name="ICanShowWindowEvent" extends="IVetoEvent"
19665	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
19666	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
19667	waitable="true"
19668	>
19669	<desc>
19670	Notification when a call to
19671	<link to="IMachine::canShowConsoleWindow"/> is made by a
19672	front-end to check if a subsequent call to
19673	<link to="IMachine::showConsoleWindow"/> can succeed.
19674
19675	The callee should give an answer appropriate to the current
19676	machine state using event veto. This answer must
19677	remain valid at least until the next
19678	<link to="IConsole::state">machine state</link> change.
19679	</desc>
19680	</interface>
19681
19682	<interface
19683	name="IShowWindowEvent" extends="IEvent"
19684	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
19685	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
19686	waitable="true"
19687	>
19688	<desc>
19689	Notification when a call to
19690	<link to="IMachine::showConsoleWindow"/>
19691	requests the console window to be activated and brought to
19692	foreground on the desktop of the host PC.
19693
19694	This notification should cause the VM console process to
19695	perform the requested action as described above. If it is
19696	impossible to do it at a time of this notification, this
19697	method should return a failure.
19698
19699	Note that many modern window managers on many platforms
19700	implement some sort of focus stealing prevention logic, so
19701	that it may be impossible to activate a window without the
19702	help of the currently active application (which is supposedly
19703	an initiator of this notification). In this case, this method
19704	must return a non-zero identifier that represents the
19705	top-level window of the VM console process. The caller, if it
19706	represents a currently active process, is responsible to use
19707	this identifier (in a platform-dependent manner) to perform
19708	actual window activation.
19709
19710	This method must set @a winId to zero if it has performed all
19711	actions necessary to complete the request and the console
19712	window is now active and in foreground, to indicate that no
19713	further action is required on the caller's side.
19714	</desc>
19715	<attribute name="winId" type="long long">
19716	<desc>
19717	Platform-dependent identifier of the top-level VM console
19718	window, or zero if this method has performed all actions
19719	necessary to implement the <i>show window</i> semantics for
19720	the given platform and/or this VirtualBox front-end.
19721	</desc>
19722	</attribute>
19723	</interface>
19724
19725	<interface
19726	name="INATRedirectEvent" extends="IMachineEvent"
19727	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
19728	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
19729	>
19730	<desc>
19731	Notification when NAT redirect rule added or removed.
19732	</desc>
19733	<attribute name="slot" type="unsigned long" readonly="yes">
19734	<desc>
19735	Adapter which NAT attached to.
19736	</desc>
19737	</attribute>
19738	<attribute name="remove" type="boolean" readonly="yes">
19739	<desc>
19740	Whether rule remove or add.
19741	</desc>
19742	</attribute>
19743	<attribute name="name" type="wstring" readonly="yes">
19744	<desc>
19745	Name of the rule.
19746	</desc>
19747	</attribute>
19748	<attribute name="proto" type="NATProtocol" readonly="yes">
19749	<desc>
19750	Protocol (TCP or UDP) of the redirect rule.
19751	</desc>
19752	</attribute>
19753	<attribute name="hostIP" type="wstring" readonly="yes">
19754	<desc>
19755	Host ip address to bind socket on.
19756	</desc>
19757	</attribute>
19758	<attribute name="hostPort" type="long" readonly="yes">
19759	<desc>
19760	Host port to bind socket on.
19761	</desc>
19762	</attribute>
19763	<attribute name="guestIP" type="wstring" readonly="yes">
19764	<desc>
19765	Guest ip address to redirect to.
19766	</desc>
19767	</attribute>
19768	<attribute name="guestPort" type="long" readonly="yes">
19769	<desc>
19770	Guest port to redirect to.
19771	</desc>
19772	</attribute>
19773	</interface>
19774
19775	<interface
19776	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
19777	waitable="yes"
19778	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
19779	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
19780	>
19781	<desc>
19782	Notification when host PCI device is plugged/unplugged. Plugging
19783	usually takes place on VM startup, unplug - when
19784	<link to="IMachine::detachHostPCIDevice"/> is called.
19785
19786	<see><link to="IMachine::detachHostPCIDevice"/></see>
19787
19788	</desc>
19789
19790	<attribute name="plugged" type="boolean" readonly="yes">
19791	<desc>
19792	If device successfully plugged or unplugged.
19793	</desc>
19794	</attribute>
19795
19796	<attribute name="success" type="boolean" readonly="yes">
19797	<desc>
19798	If operation was successful, if false - 'message' attribute
19799	may be of interest.
19800	</desc>
19801	</attribute>
19802
19803	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
19804	<desc>
19805	Attachment info for this device.
19806	</desc>
19807	</attribute>
19808
19809	<attribute name="message" type="wstring" readonly="yes">
19810	<desc>
19811	Optional error message.
19812	</desc>
19813	</attribute>
19814
19815	</interface>
19816
19817	<interface
19818	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
19819	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
19820	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
19821	>
19822	<desc>
19823	Notification when VBoxSVC becomes unavailable (due to a crash or similar
19824	unexpected circumstances) or available again.
19825	</desc>
19826
19827	<attribute name="available" type="boolean" readonly="yes">
19828	<desc>
19829	Whether VBoxSVC is available now.
19830	</desc>
19831	</attribute>
19832	</interface>
19833
19834	<interface
19835	name="IBandwidthGroupChangedEvent" extends="IEvent"
19836	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
19837	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
19838	>
19839	<desc>
19840	Notification when one of the bandwidth groups changed
19841	</desc>
19842	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
19843	<desc>
19844	The changed bandwidth group.
19845	</desc>
19846	</attribute>
19847	</interface>
19848
19849	<enum
19850	name="GuestMonitorChangedEventType"
19851	uuid="ef172985-7e36-4297-95be-e46396968d66"
19852	>
19853
19854	<desc>
19855	How the guest monitor has been changed.
19856	</desc>
19857
19858	<const name="Enabled" value="0">
19859	<desc>
19860	The guest monitor has been enabled by the guest.
19861	</desc>
19862	</const>
19863
19864	<const name="Disabled" value="1">
19865	<desc>
19866	The guest monitor has been disabled by the guest.
19867	</desc>
19868	</const>
19869
19870	<const name="NewOrigin" value="2">
19871	<desc>
19872	The guest monitor origin has changed in the guest.
19873	</desc>
19874	</const>
19875	</enum>
19876
19877	<interface
19878	name="IGuestMonitorChangedEvent" extends="IEvent"
19879	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
19880	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
19881	>
19882	<desc>
19883	Notification when the guest enables one of its monitors.
19884	</desc>
19885
19886	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
19887	<desc>
19888	What was changed for this guest monitor.
19889	</desc>
19890	</attribute>
19891
19892	<attribute name="screenId" type="unsigned long" readonly="yes">
19893	<desc>
19894	The monitor which was changed.
19895	</desc>
19896	</attribute>
19897
19898	<attribute name="originX" type="unsigned long" readonly="yes">
19899	<desc>
19900	Physical X origin relative to the primary screen.
19901	Valid for Enabled and NewOrigin.
19902	</desc>
19903	</attribute>
19904
19905	<attribute name="originY" type="unsigned long" readonly="yes">
19906	<desc>
19907	Physical Y origin relative to the primary screen.
19908	Valid for Enabled and NewOrigin.
19909	</desc>
19910	</attribute>
19911
19912	<attribute name="width" type="unsigned long" readonly="yes">
19913	<desc>
19914	Width of the screen.
19915	Valid for Enabled.
19916	</desc>
19917	</attribute>
19918
19919	<attribute name="height" type="unsigned long" readonly="yes">
19920	<desc>
19921	Height of the screen.
19922	Valid for Enabled.
19923	</desc>
19924	</attribute>
19925
19926	</interface>
19927
19928	<interface
19929	name="IStorageDeviceChangedEvent" extends="IEvent"
19930	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
19931	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
19932	>
19933	<desc>
19934	Notification when a
19935	<link to="IMachine::mediumAttachments">storage device</link>
19936	is attached or removed.
19937	</desc>
19938	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
19939	<desc>
19940	Storage device that is subject to change.
19941	</desc>
19942	</attribute>
19943	<attribute name="removed" type="boolean" readonly="yes">
19944	<desc>
19945	Flag whether the device was removed or added to the VM.
19946	</desc>
19947	</attribute>
19948	</interface>
19949
19950	<module name="VBoxSVC" context="LocalServer">
19951	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
19952	namespace="virtualbox.org">
19953	<interface name="IVirtualBox" default="yes"/>
19954	</class>
19955	</module>
19956
19957	<module name="VBoxC" context="InprocServer" threadingModel="Free">
19958	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
19959	namespace="virtualbox.org">
19960	<interface name="IVirtualBoxClient" default="yes"/>
19961	</class>
19962
19963	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
19964	namespace="virtualbox.org">
19965	<interface name="ISession" default="yes"/>
19966	</class>
19967	</module>
19968
19969	</library>
19970
19971	</idl>
19972
19973	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format