VirtualBox.xidl@ 44365

Last change on this file since 44365 was 44365, checked in by vboxsync, 12 years ago
Main: change API. Interface IMedium was touched. Handling enumeration MediumVariant was changed. PR5434.
Property svn:eol-style set to `native`
File size: 724.0 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2013 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109
110	The naming of methods and attributes is very clearly defined: they all start
111	with a lowercase letter (except if they start with an acronym), and are using
112	CamelCase style otherwise. This naming only applies to the IDL description,
113	and is modified by the various language bindings (some convert the first
114	character to upper case, some not). See the SDK reference for more details
115	about how to call a method or attribute from a specific programming language.
116	</desc>
117
118	<if target="midl">
119	<cpp line="enum {"/>
120	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
121	<cpp line=" kTypeLibraryMinorVersion = 0"/>
122	<cpp line="};"/>
123	</if>
124
125	<if target="xpidl">
126	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
127	<cpp>
128	/* currently, nsISupportsImpl.h lacks the below-like macros */
129
130	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
131	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
132	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
133	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
134
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="3b2f08eb-b810-4715-bee0-bb06b9880ad2"
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="createFlags" type="wstring" dir="in">
1667	<desc>Machine creation flags, see <link to="#createMachine" /> (optional).</desc>
1668	</param>
1669	<param name="baseFolder" type="wstring" dir="in">
1670	<desc>Base machine folder (optional).</desc>
1671	</param>
1672	<param name="file" type="wstring" dir="return">
1673	<desc>Fully qualified path where the machine would be created.</desc>
1674	</param>
1675	</method>
1676
1677	<method name="createMachine">
1678	<desc>
1679	Creates a new virtual machine by creating a machine settings file at
1680	the given location.
1681
1682	VirtualBox machine settings files use a custom XML dialect. Starting
1683	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1684	and machine files can be created at arbitrary locations.
1685
1686	However, it is recommended that machines are created in the default
1687	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1688	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1689	@c null or empty string (which is recommended) for the @a settingsFile
1690	argument, <link to="#composeMachineFilename" /> is called automatically
1691	to have such a recommended name composed based on the machine name
1692	given in the @a name argument and the primary group.
1693
1694	If the resulting settings file already exists, this method will fail,
1695	unless the forceOverwrite flag is set.
1696
1697	The new machine is created unregistered, with the initial configuration
1698	set according to the specified guest OS type. A typical sequence of
1699	actions to create a new virtual machine is as follows:
1700
1701	<ol>
1702	<li>
1703	Call this method to have a new machine created. The returned machine
1704	object will be "mutable" allowing to change any machine property.
1705	</li>
1706
1707	<li>
1708	Configure the machine using the appropriate attributes and methods.
1709	</li>
1710
1711	<li>
1712	Call <link to="IMachine::saveSettings" /> to write the settings
1713	to the machine's XML settings file. The configuration of the newly
1714	created machine will not be saved to disk until this method is
1715	called.
1716	</li>
1717
1718	<li>
1719	Call <link to="#registerMachine" /> to add the machine to the list
1720	of machines known to VirtualBox.
1721	</li>
1722	</ol>
1723
1724	The specified guest OS type identifier must match an ID of one of known
1725	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1726	array.
1727
1728	<note>
1729	There is no way to change the name of the settings file or
1730	subfolder of the created machine directly.
1731	</note>
1732
1733	<result name="VBOX_E_OBJECT_NOT_FOUND">
1734	@a osTypeId is invalid.
1735	</result>
1736	<result name="VBOX_E_FILE_ERROR">
1737	Resulting settings file name is invalid or the settings file already
1738	exists or could not be created due to an I/O error.
1739	</result>
1740	<result name="E_INVALIDARG">
1741	@a name is empty or @c null.
1742	</result>
1743	</desc>
1744
1745	<param name="settingsFile" type="wstring" dir="in">
1746	<desc>Fully qualified path where the settings file should be created,
1747	empty string or @c null for a default folder and file based on the
1748	@a name argument and the primary group.
1749	(see <link to="#composeMachineFilename" />).</desc>
1750	</param>
1751	<param name="name" type="wstring" dir="in">
1752	<desc>Machine name.</desc>
1753	</param>
1754	<param name="groups" type="wstring" safearray="yes" dir="in">
1755	<desc>Array of group names. @c null or an empty array have the same
1756	meaning as an array with just the empty string or <tt>"/"</tt>, i.e.
1757	create a machine without group association.</desc>
1758	</param>
1759	<param name="osTypeId" type="wstring" dir="in">
1760	<desc>Guest OS Type ID.</desc>
1761	</param>
1762	<param name="flags" type="wstring" dir="in">
1763	<desc>
1764	Additional property parameters, passed as a comma-separated list of
1765	"name=value" type entries. The following ones are recognized:
1766	<tt>forceOverwrite=1</tt> to overwrite an existing machine settings
1767	file, <tt>UUID=<uuid></tt> to specify a machine UUID and
1768	<tt>directoryIncludesUUID=1</tt> to switch to a special VM directory
1769	naming scheme which should not be used unless necessary.
1770	</desc>
1771	</param>
1772	<param name="machine" type="IMachine" dir="return">
1773	<desc>Created machine object.</desc>
1774	</param>
1775	</method>
1776
1777	<method name="openMachine">
1778	<desc>
1779	Opens a virtual machine from the existing settings file.
1780	The opened machine remains unregistered until you call
1781	<link to="#registerMachine"/>.
1782
1783	The specified settings file name must be fully qualified.
1784	The file must exist and be a valid machine XML settings file
1785	whose contents will be used to construct the machine object.
1786
1787	<result name="VBOX_E_FILE_ERROR">
1788	Settings file name invalid, not found or sharing violation.
1789	</result>
1790	</desc>
1791	<param name="settingsFile" type="wstring" dir="in">
1792	<desc>
1793	Name of the machine settings file.
1794	</desc>
1795	</param>
1796	<param name="machine" type="IMachine" dir="return">
1797	<desc>Opened machine object.</desc>
1798	</param>
1799	<note>
1800	<link to="IMachine::settingsModified"/> will return
1801	@c false for the created machine, until any of machine settings
1802	are changed.
1803	</note>
1804	</method>
1805
1806	<method name="registerMachine">
1807	<desc>
1808
1809	Registers the machine previously created using
1810	<link to="#createMachine"/> or opened using
1811	<link to="#openMachine"/> within this VirtualBox installation. After
1812	successful method invocation, the
1813	<link to="IMachineRegisteredEvent"/> event is fired.
1814
1815	<note>
1816	This method implicitly calls <link to="IMachine::saveSettings"/>
1817	to save all current machine settings before registering it.
1818	</note>
1819
1820	<result name="VBOX_E_OBJECT_NOT_FOUND">
1821	No matching virtual machine found.
1822	</result>
1823	<result name="VBOX_E_INVALID_OBJECT_STATE">
1824	Virtual machine was not created within this VirtualBox instance.
1825	</result>
1826
1827	</desc>
1828	<param name="machine" type="IMachine" dir="in"/>
1829	</method>
1830
1831	<method name="findMachine">
1832	<desc>
1833	Attempts to find a virtual machine given its name or UUID.
1834
1835	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1836	cannot safely be determined.</note>
1837
1838	<result name="VBOX_E_OBJECT_NOT_FOUND">
1839	Could not find registered machine matching @a nameOrId.
1840	</result>
1841
1842	</desc>
1843	<param name="nameOrId" type="wstring" dir="in">
1844	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1845	</param>
1846	<param name="machine" type="IMachine" dir="return">
1847	<desc>Machine object, if found.</desc>
1848	</param>
1849	</method>
1850
1851	<method name="getMachinesByGroups">
1852	<desc>
1853	Gets all machine references which are in one of the specified groups.
1854	</desc>
1855	<param name="groups" type="wstring" dir="in" safearray="yes">
1856	<desc>What groups to match. The usual group list rules apply, i.e.
1857	passing an empty list will match VMs in the toplevel group, likewise
1858	the empty string.</desc>
1859	</param>
1860	<param name="machines" type="IMachine" dir="return" safearray="yes">
1861	<desc>All machines which matched.</desc>
1862	</param>
1863	</method>
1864
1865	<method name="getMachineStates">
1866	<desc>
1867	Gets the state of several machines in a single operation.
1868	</desc>
1869	<param name="machines" type="IMachine" dir="in" safearray="yes">
1870	<desc>Array with the machine references.</desc>
1871	</param>
1872	<param name="states" type="MachineState" dir="return" safearray="yes">
1873	<desc>Machine states, corresponding to the machines.</desc>
1874	</param>
1875	</method>
1876
1877	<method name="createAppliance">
1878	<desc>
1879	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1880	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1881	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1882	</desc>
1883	<param name="appliance" type="IAppliance" dir="return">
1884	<desc>New appliance.</desc>
1885	</param>
1886	</method>
1887
1888	<method name="createHardDisk">
1889	<desc>
1890	Creates a new base medium object that will use the given storage
1891	format and location for medium data.
1892
1893	The actual storage unit is not created by this method. In order to
1894	do it, and before you are able to attach the created medium to
1895	virtual machines, you must call one of the following methods to
1896	allocate a format-specific storage unit at the specified location:
1897	<ul>
1898	<li><link to="IMedium::createBaseStorage"/></li>
1899	<li><link to="IMedium::createDiffStorage"/></li>
1900	</ul>
1901
1902	Some medium attributes, such as <link to="IMedium::id"/>, may
1903	remain uninitialized until the medium storage unit is successfully
1904	created by one of the above methods.
1905
1906	After the storage unit is successfully created, it will be
1907	accessible through the <link to="#openMedium"/> method and can
1908	be found in the <link to="#hardDisks"/> array.
1909
1910	The list of all storage formats supported by this VirtualBox
1911	installation can be obtained using
1912	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1913	attribute is empty or @c null then the default storage format
1914	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1915	be used for creating a storage unit of the medium.
1916
1917	Note that the format of the location string is storage format specific.
1918	See <link to="IMedium::location"/> and IMedium for more details.
1919
1920	<result name="VBOX_E_OBJECT_NOT_FOUND">
1921	@a format identifier is invalid. See
1922	<link to="ISystemProperties::mediumFormats"/>.
1923	</result>
1924	<result name="VBOX_E_FILE_ERROR">
1925	@a location is a not valid file name (for file-based formats only).
1926	</result>
1927	</desc>
1928	<param name="format" type="wstring" dir="in">
1929	<desc>
1930	Identifier of the storage format to use for the new medium.
1931	</desc>
1932	</param>
1933	<param name="location" type="wstring" dir="in">
1934	<desc>
1935	Location of the storage unit for the new medium.
1936	</desc>
1937	</param>
1938	<param name="medium" type="IMedium" dir="return">
1939	<desc>Created medium object.</desc>
1940	</param>
1941	</method>
1942
1943	<method name="openMedium">
1944	<desc>
1945	Finds existing media or opens a medium from an existing storage location.
1946
1947	Once a medium has been opened, it can be passed to other VirtualBox
1948	methods, in particular to <link to="IMachine::attachDevice" />.
1949
1950	Depending on the given device type, the file at the storage location
1951	must be in one of the media formats understood by VirtualBox:
1952
1953	<ul>
1954	<li>With a "HardDisk" device type, the file must be a hard disk image
1955	in one of the formats supported by VirtualBox (see
1956	<link to="ISystemProperties::mediumFormats" />).
1957	After this method succeeds, if the medium is a base medium, it
1958	will be added to the <link to="#hardDisks"/> array attribute. </li>
1959	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1960	After this method succeeds, the medium will be added to the
1961	<link to="#DVDImages"/> array attribute.</li>
1962	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1963	After this method succeeds, the medium will be added to the
1964	<link to="#floppyImages"/> array attribute.</li>
1965	</ul>
1966
1967	After having been opened, the medium can be re-found by this method
1968	and can be attached to virtual machines. See <link to="IMedium" /> for
1969	more details.
1970
1971	The UUID of the newly opened medium will either be retrieved from the
1972	storage location, if the format supports it (e.g. for hard disk images),
1973	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1974	If for some reason you need to change the medium's UUID, use
1975	<link to="IMedium::setIds" />.
1976
1977	If a differencing hard disk medium is to be opened by this method, the
1978	operation will succeed only if its parent medium and all ancestors,
1979	if any, are already known to this VirtualBox installation (for example,
1980	were opened by this method before).
1981
1982	This method attempts to guess the storage format of the specified medium
1983	by reading medium data at the specified location.
1984
1985	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1986	the image is opened for read/write access and must have according permissions,
1987	as VirtualBox may actually write status information into the disk's metadata
1988	sections.
1989
1990	Note that write access is required for all typical hard disk usage in VirtualBox,
1991	since VirtualBox may need to write metadata such as a UUID into the image.
1992	The only exception is opening a source image temporarily for copying and
1993	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1994	again soon.
1995
1996	The format of the location string is storage format specific. See
1997	<link to="IMedium::location"/> and IMedium for more details.
1998
1999	<result name="VBOX_E_FILE_ERROR">
2000	Invalid medium storage file location or could not find the medium
2001	at the specified location.
2002	</result>
2003	<result name="VBOX_E_IPRT_ERROR">
2004	Could not get medium storage format.
2005	</result>
2006	<result name="E_INVALIDARG">
2007	Invalid medium storage format.
2008	</result>
2009	<result name="VBOX_E_INVALID_OBJECT_STATE">
2010	Medium has already been added to a media registry.
2011	</result>
2012	</desc>
2013	<param name="location" type="wstring" dir="in">
2014	<desc>
2015	Location of the storage unit that contains medium data in one of
2016	the supported storage formats.
2017	</desc>
2018	</param>
2019	<param name="deviceType" type="DeviceType" dir="in">
2020	<desc>
2021	Must be one of "HardDisk", "DVD" or "Floppy".
2022	</desc>
2023	</param>
2024	<param name="accessMode" type="AccessMode" dir="in">
2025	<desc>Whether to open the image in read/write or read-only mode. For
2026	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
2027	</param>
2028	<param name="forceNewUuid" type="boolean" dir="in">
2029	<desc>Allows the caller to request a completely new medium UUID for
2030	the image which is to be opened. Useful if one intends to open an exact
2031	copy of a previously opened image, as this would normally fail due to
2032	the duplicate UUID.</desc>
2033	</param>
2034	<param name="medium" type="IMedium" dir="return">
2035	<desc>Opened medium object.</desc>
2036	</param>
2037	</method>
2038
2039	<method name="getGuestOSType">
2040	<desc>
2041	Returns an object describing the specified guest OS type.
2042
2043	The requested guest OS type is specified using a string which is a
2044	mnemonic identifier of the guest operating system, such as
2045	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2046	particular virtual machine can be read or set using the
2047	<link to="IMachine::OSTypeId"/> attribute.
2048
2049	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2050	available guest OS type objects. Each object has an
2051	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2052	the guest OS this object describes.
2053
2054	<result name="E_INVALIDARG">
2055	@a id is not a valid Guest OS type.
2056	</result>
2057
2058	</desc>
2059	<param name="id" type="uuid" mod="string" dir="in">
2060	<desc>Guest OS type ID string.</desc>
2061	</param>
2062	<param name="type" type="IGuestOSType" dir="return">
2063	<desc>Guest OS type object.</desc>
2064	</param>
2065	</method>
2066
2067	<method name="createSharedFolder">
2068	<desc>
2069	Creates a new global shared folder by associating the given logical
2070	name with the given host path, adds it to the collection of shared
2071	folders and starts sharing it. Refer to the description of
2072	<link to="ISharedFolder"/> to read more about logical names.
2073	<note>
2074	In the current implementation, this operation is not
2075	implemented.
2076	</note>
2077	</desc>
2078	<param name="name" type="wstring" dir="in">
2079	<desc>Unique logical name of the shared folder.</desc>
2080	</param>
2081	<param name="hostPath" type="wstring" dir="in">
2082	<desc>Full path to the shared folder in the host file system.</desc>
2083	</param>
2084	<param name="writable" type="boolean" dir="in">
2085	<desc>Whether the share is writable or readonly</desc>
2086	</param>
2087	<param name="automount" type="boolean" dir="in">
2088	<desc>Whether the share gets automatically mounted by the guest
2089	or not.</desc>
2090	</param>
2091	</method>
2092
2093	<method name="removeSharedFolder">
2094	<desc>
2095	Removes the global shared folder with the given name previously
2096	created by <link to="#createSharedFolder"/> from the collection of
2097	shared folders and stops sharing it.
2098	<note>
2099	In the current implementation, this operation is not
2100	implemented.
2101	</note>
2102	</desc>
2103	<param name="name" type="wstring" dir="in">
2104	<desc>Logical name of the shared folder to remove.</desc>
2105	</param>
2106	</method>
2107
2108	<method name="getExtraDataKeys">
2109	<desc>
2110	Returns an array representing the global extra data keys which currently
2111	have values defined.
2112	</desc>
2113	<param name="value" type="wstring" dir="return" safearray="yes">
2114	<desc>Array of extra data keys.</desc>
2115	</param>
2116	</method>
2117
2118	<method name="getExtraData">
2119	<desc>
2120	Returns associated global extra data.
2121
2122	If the requested data @a key does not exist, this function will
2123	succeed and return an empty string in the @a value argument.
2124
2125	<result name="VBOX_E_FILE_ERROR">
2126	Settings file not accessible.
2127	</result>
2128	<result name="VBOX_E_XML_ERROR">
2129	Could not parse the settings file.
2130	</result>
2131
2132	</desc>
2133	<param name="key" type="wstring" dir="in">
2134	<desc>Name of the data key to get.</desc>
2135	</param>
2136	<param name="value" type="wstring" dir="return">
2137	<desc>Value of the requested data key.</desc>
2138	</param>
2139	</method>
2140
2141	<method name="setExtraData">
2142	<desc>
2143	Sets associated global extra data.
2144
2145	If you pass @c null or empty string as a key @a value, the given @a key
2146	will be deleted.
2147
2148	<note>
2149	Before performing the actual data change, this method will ask all
2150	registered event listener using the
2151	<link to="IExtraDataCanChangeEvent"/>
2152	notification for a permission. If one of the listeners refuses the
2153	new value, the change will not be performed.
2154	</note>
2155	<note>
2156	On success, the
2157	<link to="IExtraDataChangedEvent"/> notification
2158	is called to inform all registered listeners about a successful data
2159	change.
2160	</note>
2161
2162	<result name="VBOX_E_FILE_ERROR">
2163	Settings file not accessible.
2164	</result>
2165	<result name="VBOX_E_XML_ERROR">
2166	Could not parse the settings file.
2167	</result>
2168	<result name="E_ACCESSDENIED">
2169	Modification request refused.
2170	</result>
2171
2172	</desc>
2173	<param name="key" type="wstring" dir="in">
2174	<desc>Name of the data key to set.</desc>
2175	</param>
2176	<param name="value" type="wstring" dir="in">
2177	<desc>Value to assign to the key.</desc>
2178	</param>
2179	</method>
2180
2181	<method name="setSettingsSecret">
2182	<desc>
2183	Unlocks the secret data by passing the unlock password to the
2184	server. The server will cache the password for that machine.
2185
2186	<result name="VBOX_E_INVALID_VM_STATE">
2187	Virtual machine is not mutable.
2188	</result>
2189
2190	</desc>
2191	<param name="password" type="wstring" dir="in">
2192	<desc>
2193	The cipher key.
2194	</desc>
2195	</param>
2196	</method>
2197
2198	<!--method name="createDHCPServerForInterface">
2199	<desc>
2200	Creates a DHCP server settings to be used for the given interface
2201	<result name="E_INVALIDARG">
2202	Host network interface @a name already exists.
2203	</result>
2204	</desc>
2205	<param name="interface" type="IHostNetworkInterface" dir="in">
2206	<desc>Network Interface</desc>
2207	</param>
2208	<param name="server" type="IDHCPServer" dir="out">
2209	<desc>DHCP server settings</desc>
2210	</param>
2211	</method-->
2212
2213	<method name="createDHCPServer">
2214	<desc>
2215	Creates a DHCP server settings to be used for the given internal network name
2216	<result name="E_INVALIDARG">
2217	Host network interface @a name already exists.
2218	</result>
2219	</desc>
2220	<param name="name" type="wstring" dir="in">
2221	<desc>server name</desc>
2222	</param>
2223	<param name="server" type="IDHCPServer" dir="return">
2224	<desc>DHCP server settings</desc>
2225	</param>
2226	</method>
2227
2228	<method name="findDHCPServerByNetworkName">
2229	<desc>
2230	Searches a DHCP server settings to be used for the given internal network name
2231	<result name="E_INVALIDARG">
2232	Host network interface @a name already exists.
2233	</result>
2234
2235	</desc>
2236	<param name="name" type="wstring" dir="in">
2237	<desc>server name</desc>
2238	</param>
2239	<param name="server" type="IDHCPServer" dir="return">
2240	<desc>DHCP server settings</desc>
2241	</param>
2242	</method>
2243
2244	<!--method name="findDHCPServerForInterface">
2245	<desc>
2246	Searches a DHCP server settings to be used for the given interface
2247	<result name="E_INVALIDARG">
2248	Host network interface @a name already exists.
2249	</result>
2250	</desc>
2251	<param name="interface" type="IHostNetworkInterface" dir="in">
2252	<desc>Network Interface</desc>
2253	</param>
2254	<param name="server" type="IDHCPServer" dir="out">
2255	<desc>DHCP server settings</desc>
2256	</param>
2257	</method-->
2258
2259	<method name="removeDHCPServer">
2260	<desc>
2261	Removes the DHCP server settings
2262	<result name="E_INVALIDARG">
2263	Host network interface @a name already exists.
2264	</result>
2265	</desc>
2266	<param name="server" type="IDHCPServer" dir="in">
2267	<desc>DHCP server settings to be removed</desc>
2268	</param>
2269	</method>
2270
2271
2272	<method name="checkFirmwarePresent">
2273	<desc>
2274	Check if this VirtualBox installation has a firmware
2275	of the given type available, either system-wide or per-user.
2276	Optionally, this may return a hint where this firmware can be
2277	downloaded from.
2278	</desc>
2279	<param name="firmwareType" type="FirmwareType" dir="in">
2280	<desc>
2281	Type of firmware to check.
2282	</desc>
2283	</param>
2284	<param name="version" type="wstring" dir="in">
2285	<desc>Expected version number, usually empty string (presently ignored).</desc>
2286	</param>
2287
2288	<param name="url" type="wstring" dir="out">
2289	<desc>
2290	Suggested URL to download this firmware from.
2291	</desc>
2292	</param>
2293
2294	<param name="file" type="wstring" dir="out">
2295	<desc>
2296	Filename of firmware, only valid if result == TRUE.
2297	</desc>
2298	</param>
2299
2300	<param name="result" type="boolean" dir="return">
2301	<desc>If firmware of this type and version is available.</desc>
2302	</param>
2303	</method>
2304
2305	</interface>
2306
2307	<!--
2308	// IVFSExplorer
2309	/////////////////////////////////////////////////////////////////////////
2310	-->
2311
2312	<enum
2313	name="VFSType"
2314	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2315	>
2316	<desc>
2317	Virtual file systems supported by VFSExplorer.
2318	</desc>
2319
2320	<const name="File" value="1" />
2321	<const name="Cloud" value="2" />
2322	<const name="S3" value="3" />
2323	<const name="WebDav" value="4" />
2324	</enum>
2325
2326	<enum
2327	name="VFSFileType"
2328	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2329	>
2330	<desc>
2331	File types known by VFSExplorer.
2332	</desc>
2333
2334	<const name="Unknown" value="1" />
2335	<const name="Fifo" value="2" />
2336	<const name="DevChar" value="3" />
2337	<const name="Directory" value="4" />
2338	<const name="DevBlock" value="5" />
2339	<const name="File" value="6" />
2340	<const name="SymLink" value="7" />
2341	<const name="Socket" value="8" />
2342	<const name="WhiteOut" value="9" />
2343	</enum>
2344
2345	<interface
2346	name="IVFSExplorer" extends="$unknown"
2347	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2348	wsmap="managed"
2349	>
2350	<desc>
2351	The VFSExplorer interface unifies access to different file system
2352	types. This includes local file systems as well remote file systems like
2353	S3. For a list of supported types see <link to="VFSType" />.
2354	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2355	</desc>
2356
2357	<attribute name="path" type="wstring" readonly="yes">
2358	<desc>Returns the current path in the virtual file system.</desc>
2359	</attribute>
2360
2361	<attribute name="type" type="VFSType" readonly="yes">
2362	<desc>Returns the file system type which is currently in use.</desc>
2363	</attribute>
2364
2365	<method name="update">
2366	<desc>Updates the internal list of files/directories from the
2367	current directory level. Use <link to="#entryList" /> to get the full list
2368	after a call to this method.</desc>
2369
2370	<param name="aProgress" type="IProgress" dir="return">
2371	<desc>Progress object to track the operation completion.</desc>
2372	</param>
2373	</method>
2374
2375	<method name="cd">
2376	<desc>Change the current directory level.</desc>
2377
2378	<param name="aDir" type="wstring" dir="in">
2379	<desc>The name of the directory to go in.</desc>
2380	</param>
2381
2382	<param name="aProgress" type="IProgress" dir="return">
2383	<desc>Progress object to track the operation completion.</desc>
2384	</param>
2385	</method>
2386
2387	<method name="cdUp">
2388	<desc>Go one directory upwards from the current directory level.</desc>
2389
2390	<param name="aProgress" type="IProgress" dir="return">
2391	<desc>Progress object to track the operation completion.</desc>
2392	</param>
2393	</method>
2394
2395	<method name="entryList">
2396	<desc>Returns a list of files/directories after a call to <link
2397	to="#update" />. The user is responsible for keeping this internal
2398	list up do date.</desc>
2399
2400	<param name="aNames" type="wstring" safearray="yes" dir="out">
2401	<desc>The list of names for the entries.</desc>
2402	</param>
2403
2404	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2405	<desc>The list of types for the entries.</desc>
2406	</param>
2407
2408	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2409	<desc>The list of sizes (in bytes) for the entries.</desc>
2410	</param>
2411
2412	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2413	<desc>The list of file modes (in octal form) for the entries.</desc>
2414	</param>
2415	</method>
2416
2417	<method name="exists">
2418	<desc>Checks if the given file list exists in the current directory
2419	level.</desc>
2420
2421	<param name="aNames" type="wstring" safearray="yes" dir="in">
2422	<desc>The names to check.</desc>
2423	</param>
2424
2425	<param name="aExists" type="wstring" safearray="yes" dir="return">
2426	<desc>The names which exist.</desc>
2427	</param>
2428	</method>
2429
2430	<method name="remove">
2431	<desc>Deletes the given files in the current directory level.</desc>
2432
2433	<param name="aNames" type="wstring" safearray="yes" dir="in">
2434	<desc>The names to remove.</desc>
2435	</param>
2436
2437	<param name="aProgress" type="IProgress" dir="return">
2438	<desc>Progress object to track the operation completion.</desc>
2439	</param>
2440	</method>
2441
2442	</interface>
2443
2444	<enum
2445	name="ImportOptions" extends="$unknown"
2446	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2447	>
2448
2449	<desc>
2450	Import options, used with <link to="IAppliance::importMachines" />.
2451	</desc>
2452
2453	<const name="KeepAllMACs" value="1">
2454	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2455	</const>
2456	<const name="KeepNATMACs" value="2">
2457	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2458	</const>
2459
2460	</enum>
2461
2462
2463	<!--
2464	// IAppliance
2465	/////////////////////////////////////////////////////////////////////////
2466	-->
2467
2468	<interface
2469	name="IAppliance" extends="$unknown"
2470	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2471	wsmap="managed"
2472	>
2473	<desc>
2474	Represents a platform-independent appliance in OVF format. An instance of this is returned
2475	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2476	virtual machines within an appliance with VirtualBox.
2477
2478	The OVF standard suggests two different physical file formats:
2479
2480	<ol>
2481	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2482	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2483	this descriptor file references other files such as disk images, as OVF appliances typically
2484	do, those additional files must be in the same directory as the descriptor file.</li>
2485
2486	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2487	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2488	files and optionally other files.
2489
2490	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2491	be added with a later version.</li>
2492	</ol>
2493
2494	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2495	<link to="IMachine" /> involves the following sequence of API calls:
2496
2497	<ol>
2498	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2499	</li>
2500
2501	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2502	would like to import. So long as this file is syntactically valid, this will succeed
2503	and fill the appliance object with the parsed data from the OVF file.
2504	</li>
2505
2506	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2507	contents of the IAppliance attributes accordingly. These can be inspected by a
2508	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2509	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2510	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2511	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2512	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2513	The GUI can then give the user the option to confirm and/or change these suggestions.
2514	</li>
2515
2516	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2517	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2518	</li>
2519
2520	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2521	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2522	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2523	can be found in the <link to="#machines" /> array attribute.
2524	</li>
2525	</ol>
2526
2527	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2528
2529	<ol>
2530	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2531	an empty IAppliance object.
2532	</li>
2533
2534	<li>For each machine you would like to export, call <link to="IMachine::export" />
2535	with the IAppliance object you just created. Each such call creates one instance of
2536	<link to="IVirtualSystemDescription" /> inside the appliance.
2537	</li>
2538
2539	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2540	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2541	</li>
2542
2543	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2544	file written.</li>
2545	</ol>
2546
2547	</desc>
2548
2549	<attribute name="path" type="wstring" readonly="yes">
2550	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2551	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2552	<link to="#write" /> (for export).
2553	This attribute is empty until one of these methods has been called.
2554	</desc>
2555	</attribute>
2556
2557	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2558	<desc>
2559	Array of virtual disk definitions. One such description exists for each
2560	disk definition in the OVF; each string array item represents one such piece of
2561	disk information, with the information fields separated by tab (\\t) characters.
2562
2563	The caller should be prepared for additional fields being appended to
2564	this string in future versions of VirtualBox and therefore check for
2565	the number of tabs in the strings returned.
2566
2567	In the current version, the following eight fields are returned per string
2568	in the array:
2569
2570	<ol>
2571	<li>Disk ID (unique string identifier given to disk)</li>
2572
2573	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2574
2575	<li>Populated size (optional unsigned integer indicating the current size of the
2576	disk; can be approximate; -1 if unspecified)</li>
2577
2578	<li>Format (string identifying the disk format, typically
2579	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2580
2581	<li>Reference (where to find the disk image, typically a file name; if empty,
2582	then the disk should be created on import)</li>
2583
2584	<li>Image size (optional unsigned integer indicating the size of the image,
2585	which need not necessarily be the same as the values specified above, since
2586	the image may be compressed or sparse; -1 if not specified)</li>
2587
2588	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2589	presently unsupported and always -1)</li>
2590
2591	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2592	</ol>
2593	</desc>
2594	</attribute>
2595
2596	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2597	<desc> Array of virtual system descriptions. One such description is created
2598	for each virtual system (machine) found in the OVF.
2599	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2600	(for export) has been called.
2601	</desc>
2602	</attribute>
2603
2604	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2605	<desc>
2606	Contains the UUIDs of the machines created from the information in this appliances. This is only
2607	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2608	succeeded.
2609	</desc>
2610	</attribute>
2611
2612	<method name="read">
2613	<desc>
2614	Reads an OVF file into the appliance object.
2615
2616	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2617	mere fact that this method returns successfully does not mean that VirtualBox supports all
2618	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2619	</desc>
2620	<param name="file" type="wstring" dir="in">
2621	<desc>
2622	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2623	on whether the appliance is distributed as a set of files or as a single file, respectively).
2624	</desc>
2625	</param>
2626	<param name="aProgress" type="IProgress" dir="return">
2627	<desc>Progress object to track the operation completion.</desc>
2628	</param>
2629	</method>
2630
2631	<method name="interpret">
2632	<desc>
2633	Interprets the OVF data that was read when the appliance was constructed. After
2634	calling this method, one can inspect the
2635	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2636	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2637	the appliance.
2638
2639	Calling this method is the second step of importing an appliance into VirtualBox;
2640	see <link to="IAppliance" /> for an overview.
2641
2642	After calling this method, one should call <link to="#getWarnings" /> to find out
2643	if problems were encountered during the processing which might later lead to
2644	errors.
2645	</desc>
2646	</method>
2647
2648	<method name="importMachines">
2649	<desc>
2650	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2651	and other interfaces that match the information contained in the appliance as
2652	closely as possible, as represented by the import instructions in the
2653	<link to="#virtualSystemDescriptions" /> array.
2654
2655	Calling this method is the final step of importing an appliance into VirtualBox;
2656	see <link to="IAppliance" /> for an overview.
2657
2658	Since importing the appliance will most probably involve copying and converting
2659	disk images, which can take a long time, this method operates asynchronously and
2660	returns an IProgress object to allow the caller to monitor the progress.
2661
2662	After the import succeeded, the UUIDs of the IMachine instances created can be
2663	retrieved from the <link to="#machines" /> array attribute.
2664	</desc>
2665
2666	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2667	<desc>Options for the importing operation.</desc>
2668	</param>
2669
2670	<param name="aProgress" type="IProgress" dir="return">
2671	<desc>Progress object to track the operation completion.</desc>
2672	</param>
2673	</method>
2674
2675	<method name="createVFSExplorer">
2676	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2677
2678	<param name="aUri" type="wstring" dir="in">
2679	<desc>The URI describing the file system to use.</desc>
2680	</param>
2681
2682	<param name="aExplorer" type="IVFSExplorer" dir="return">
2683	<desc></desc>
2684	</param>
2685	</method>
2686
2687	<method name="write">
2688	<desc>
2689	Writes the contents of the appliance exports into a new OVF file.
2690
2691	Calling this method is the final step of exporting an appliance from VirtualBox;
2692	see <link to="IAppliance" /> for an overview.
2693
2694	Since exporting the appliance will most probably involve copying and converting
2695	disk images, which can take a long time, this method operates asynchronously and
2696	returns an IProgress object to allow the caller to monitor the progress.
2697	</desc>
2698	<param name="format" type="wstring" dir="in">
2699	<desc>
2700	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2701	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2702	</desc>
2703	</param>
2704	<param name="manifest" type="boolean" dir="in">
2705	<desc>
2706	Indicate if the optional manifest file (.mf) should be written. The manifest file
2707	is used for integrity checks prior import.
2708	</desc>
2709	</param>
2710	<param name="path" type="wstring" dir="in">
2711	<desc>
2712	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2713	on whether the appliance is distributed as a set of files or as a single file, respectively).
2714	</desc>
2715	</param>
2716	<param name="progress" type="IProgress" dir="return">
2717	<desc>Progress object to track the operation completion.</desc>
2718	</param>
2719	</method>
2720
2721	<method name="getWarnings">
2722	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2723
2724	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2725	<desc></desc>
2726	</param>
2727	</method>
2728
2729	</interface>
2730
2731	<enum
2732	name="VirtualSystemDescriptionType"
2733	uuid="303c0900-a746-4612-8c67-79003e91f459"
2734	>
2735	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2736	a configuration value.</desc>
2737
2738	<const name="Ignore" value="1" />
2739	<const name="OS" value="2" />
2740	<const name="Name" value="3" />
2741	<const name="Product" value="4" />
2742	<const name="Vendor" value="5" />
2743	<const name="Version" value="6" />
2744	<const name="ProductUrl" value="7" />
2745	<const name="VendorUrl" value="8" />
2746	<const name="Description" value="9" />
2747	<const name="License" value="10" />
2748	<const name="Miscellaneous" value="11" />
2749	<const name="CPU" value="12" />
2750	<const name="Memory" value="13" />
2751	<const name="HardDiskControllerIDE" value="14" />
2752	<const name="HardDiskControllerSATA" value="15" />
2753	<const name="HardDiskControllerSCSI" value="16" />
2754	<const name="HardDiskControllerSAS" value="17" />
2755	<const name="HardDiskImage" value="18" />
2756	<const name="Floppy" value="19" />
2757	<const name="CDROM" value="20" />
2758	<const name="NetworkAdapter" value="21" />
2759	<const name="USBController" value="22" />
2760	<const name="SoundCard" value="23" />
2761	<const name="SettingsFile" value="24">
2762	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2763	</const>
2764	</enum>
2765
2766	<enum
2767	name="VirtualSystemDescriptionValueType"
2768	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2769	>
2770	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2771	type to fetch.</desc>
2772
2773	<const name="Reference" value="1" />
2774	<const name="Original" value="2" />
2775	<const name="Auto" value="3" />
2776	<const name="ExtraConfig" value="4" />
2777
2778	</enum>
2779
2780	<interface
2781	name="IVirtualSystemDescription" extends="$unknown"
2782	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2783	wsmap="managed"
2784	>
2785
2786	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2787	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2788	<link to="IAppliance::interpret" /> has been called, that array contains information
2789	about how the virtual systems described in the OVF should best be imported into
2790	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2791	import an OVF into VirtualBox.
2792	</desc>
2793
2794	<attribute name="count" type="unsigned long" readonly="yes">
2795	<desc>Return the number of virtual system description entries.</desc>
2796	</attribute>
2797
2798	<method name="getDescription">
2799	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2800	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2801
2802	The list below identifies the value sets that are possible depending on the
2803	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2804	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2805	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2806	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2807	the @a aExtraConfigValues[] array item may also be used.
2808
2809	<ul>
2810	<li>
2811	"OS": the guest operating system type. There must be exactly one such array item on import. The
2812	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2813	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2814	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2815	</li>
2816	<li>
2817	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2818	if none is present on import, then an automatic name will be created from the operating system
2819	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2820	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2821	<link to="IMachine" /> name that does not exist yet.
2822	</li>
2823	<li>
2824	"Description": an arbitrary description.
2825	</li>
2826	<li>
2827	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2828	code to display such a license for agreement; the Main API does not enforce any such policy.
2829	</li>
2830	<li>
2831	Miscellaneous: reserved for future use.
2832	</li>
2833	<li>
2834	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2835	</li>
2836	<li>
2837	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2838	is present on import, then VirtualBox will set a meaningful default based on the operating system
2839	type.
2840	</li>
2841	<li>
2842	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2843	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2844	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2845	writes into the OVF.
2846	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2847	type can use to specify which hard disk controller a virtual disk should be connected to.
2848	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2849	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2850	its virtual machines supports four channels (primary master, primary slave, secondary master,
2851	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2852	</li>
2853	<li>
2854	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2855	has no value in @a aOvfValues[] or @a aVBoxValues[].
2856	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2857	</li>
2858	<li>
2859	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2860	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2861	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2862	whereas VirtualBox considers it a class of storage controllers of its own; see
2863	<link to="StorageControllerType" />).
2864	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2865	</li>
2866	<li>
2867	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2868	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2869
2870	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2871	a path since the image file should be in the same location as the OVF file itself), whereas the
2872	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2873	hard disk image. This means that on import the image will be copied and converted from the
2874	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2875
2876	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2877	format: "controller=<index>;channel=<c>"
2878	In this string, <index> must be an integer specifying the hard disk controller to connect
2879	the image to. That number must be the index of an array item with one of the hard disk controller
2880	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2881	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2882	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2883	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2884	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2885	</li>
2886	<li>
2887	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2888	attachment information as with "HardDiskImage" items.
2889	</li>
2890	<li>
2891	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2892	attachment information as with "HardDiskImage" items.
2893	</li>
2894	<li>
2895	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2896	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2897	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2898	</li>
2899	<li>
2900	"USBController": a USB controller. There can be at most one such item. If and only if such an
2901	item ispresent, USB support will be enabled for the new virtual machine.
2902	</li>
2903	<li>
2904	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2905	present, sound support will be enabled for the new virtual machine. Note that the virtual
2906	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2907	may be different from the virtual soundcard expected by the appliance.
2908	</li>
2909	</ul>
2910
2911	</desc>
2912
2913	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2914	<desc></desc>
2915	</param>
2916
2917	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2918	<desc></desc>
2919	</param>
2920
2921	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2922	<desc></desc>
2923	</param>
2924
2925	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2926	<desc></desc>
2927	</param>
2928
2929	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2930	<desc></desc>
2931	</param>
2932
2933	</method>
2934
2935	<method name="getDescriptionByType">
2936	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2937	should be returned.</desc>
2938
2939	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2940	<desc></desc>
2941	</param>
2942
2943	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2944	<desc></desc>
2945	</param>
2946
2947	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2948	<desc></desc>
2949	</param>
2950
2951	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2952	<desc></desc>
2953	</param>
2954
2955	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2956	<desc></desc>
2957	</param>
2958
2959	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2960	<desc></desc>
2961	</param>
2962
2963	</method>
2964
2965	<method name="getValuesByType">
2966	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2967	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2968	values.</desc>
2969
2970	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2971	<desc></desc>
2972	</param>
2973
2974	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2975	<desc></desc>
2976	</param>
2977
2978	<param name="aValues" type="wstring" dir="return" safearray="yes">
2979	<desc></desc>
2980	</param>
2981
2982	</method>
2983
2984	<method name="setFinalValues">
2985	<desc>
2986	This method allows the appliance's user to change the configuration for the virtual
2987	system descriptions. For each array item returned from <link to="#getDescription" />,
2988	you must pass in one boolean value and one configuration value.
2989
2990	Each item in the boolean array determines whether the particular configuration item
2991	should be enabled.
2992	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2993	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2994	and SoundCard.
2995
2996	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2997	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2998	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2999	for valid configuration values for the individual array item types. If the
3000	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3001	</desc>
3002
3003	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3004	<desc></desc>
3005	</param>
3006
3007	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3008	<desc></desc>
3009	</param>
3010
3011	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3012	<desc></desc>
3013	</param>
3014	</method>
3015
3016	<method name="addDescription">
3017	<desc>
3018	This method adds an additional description entry to the stack of already
3019	available descriptions for this virtual system. This is handy for writing
3020	values which aren't directly supported by VirtualBox. One example would
3021	be the License type of <link to="VirtualSystemDescriptionType" />.
3022	</desc>
3023
3024	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3025	<desc></desc>
3026	</param>
3027
3028	<param name="aVBoxValue" type="wstring" dir="in">
3029	<desc></desc>
3030	</param>
3031
3032	<param name="aExtraConfigValue" type="wstring" dir="in">
3033	<desc></desc>
3034	</param>
3035	</method>
3036	</interface>
3037
3038
3039	<!--
3040	// IMachine
3041	/////////////////////////////////////////////////////////////////////////
3042	-->
3043
3044	<interface
3045	name="IInternalMachineControl" extends="$unknown"
3046	uuid="dca36a92-703c-4649-98a4-f40c1ef0c336"
3047	internal="yes"
3048	wsmap="suppress"
3049	>
3050	<method name="setRemoveSavedStateFile">
3051	<desc>
3052	Updates the flag whether the saved state file is removed on a
3053	machine state change from Saved to PoweredOff.
3054	</desc>
3055	<param name="aRemove" type="boolean" dir="in"/>
3056	</method>
3057
3058	<method name="updateState">
3059	<desc>
3060	Updates the VM state.
3061	<note>
3062	This operation will also update the settings file with the correct
3063	information about the saved state file and delete this file from disk
3064	when appropriate.
3065	</note>
3066	</desc>
3067	<param name="state" type="MachineState" dir="in"/>
3068	</method>
3069
3070	<method name="getIPCId">
3071	<param name="id" type="wstring" dir="return"/>
3072	</method>
3073
3074	<method name="beginPowerUp">
3075	<desc>
3076	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3077	gives it the progress object that should be part of any pending
3078	<link to="IMachine::launchVMProcess"/> operations. The progress
3079	object may be called back to reflect an early cancelation, so some care
3080	have to be taken with respect to any cancelation callbacks. The console
3081	object will call <link to="IInternalMachineControl::endPowerUp"/>
3082	to signal the completion of the progress object.
3083	</desc>
3084	<param name="aProgress" type="IProgress" dir="in" />
3085	</method>
3086
3087	<method name="endPowerUp">
3088	<desc>
3089	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3090	This method may query status information from the progress object it
3091	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3092	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3093	call in order to complete that progress object.
3094	</desc>
3095	<param name="result" type="long" dir="in"/>
3096	</method>
3097
3098	<method name="beginPoweringDown">
3099	<desc>
3100	Called by the VM process to inform the server it wants to
3101	stop the VM execution and power down.
3102	</desc>
3103	<param name="progress" type="IProgress" dir="out">
3104	<desc>
3105	Progress object created by VBoxSVC to wait until
3106	the VM is powered down.
3107	</desc>
3108	</param>
3109	</method>
3110
3111	<method name="endPoweringDown">
3112	<desc>
3113	Called by the VM process to inform the server that powering
3114	down previously requested by #beginPoweringDown is either
3115	successfully finished or there was a failure.
3116
3117	<result name="VBOX_E_FILE_ERROR">
3118	Settings file not accessible.
3119	</result>
3120	<result name="VBOX_E_XML_ERROR">
3121	Could not parse the settings file.
3122	</result>
3123
3124	</desc>
3125
3126	<param name="result" type="long" dir="in">
3127	<desc>@c S_OK to indicate success.
3128	</desc>
3129	</param>
3130	<param name="errMsg" type="wstring" dir="in">
3131	<desc>@c human readable error message in case of failure.
3132	</desc>
3133	</param>
3134	</method>
3135
3136	<method name="runUSBDeviceFilters">
3137	<desc>
3138	Asks the server to run USB devices filters of the associated
3139	machine against the given USB device and tell if there is
3140	a match.
3141	<note>
3142	Intended to be used only for remote USB devices. Local
3143	ones don't require to call this method (this is done
3144	implicitly by the Host and USBProxyService).
3145	</note>
3146	</desc>
3147	<param name="device" type="IUSBDevice" dir="in"/>
3148	<param name="matched" type="boolean" dir="out"/>
3149	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3150	</method>
3151
3152	<method name="captureUSBDevice">
3153	<desc>
3154	Requests a capture of the given host USB device.
3155	When the request is completed, the VM process will
3156	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3157	notification.
3158	</desc>
3159	<param name="id" type="uuid" mod="string" dir="in"/>
3160	</method>
3161
3162	<method name="detachUSBDevice">
3163	<desc>
3164	Notification that a VM is going to detach (@a done = @c false) or has
3165	already detached (@a done = @c true) the given USB device.
3166	When the @a done = @c true request is completed, the VM process will
3167	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3168	notification.
3169	<note>
3170	In the @a done = @c true case, the server must run its own filters
3171	and filters of all VMs but this one on the detached device
3172	as if it were just attached to the host computer.
3173	</note>
3174	</desc>
3175	<param name="id" type="uuid" mod="string" dir="in"/>
3176	<param name="done" type="boolean" dir="in"/>
3177	</method>
3178
3179	<method name="autoCaptureUSBDevices">
3180	<desc>
3181	Requests a capture all matching USB devices attached to the host.
3182	When the request is completed, the VM process will
3183	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3184	notification per every captured device.
3185	</desc>
3186	</method>
3187
3188	<method name="detachAllUSBDevices">
3189	<desc>
3190	Notification that a VM that is being powered down. The done
3191	parameter indicates whether which stage of the power down
3192	we're at. When @a done = @c false the VM is announcing its
3193	intentions, while when @a done = @c true the VM is reporting
3194	what it has done.
3195	<note>
3196	In the @a done = @c true case, the server must run its own filters
3197	and filters of all VMs but this one on all detach devices as
3198	if they were just attached to the host computer.
3199	</note>
3200	</desc>
3201	<param name="done" type="boolean" dir="in"/>
3202	</method>
3203
3204	<method name="onSessionEnd">
3205	<desc>
3206	Triggered by the given session object when the session is about
3207	to close normally.
3208	</desc>
3209	<param name="session" type="ISession" dir="in">
3210	<desc>Session that is being closed</desc>
3211	</param>
3212	<param name="progress" type="IProgress" dir="return">
3213	<desc>
3214	Used to wait until the corresponding machine is actually
3215	dissociated from the given session on the server.
3216	Returned only when this session is a direct one.
3217	</desc>
3218	</param>
3219	</method>
3220
3221	<method name="beginSavingState">
3222	<desc>
3223	Called by the VM process to inform the server it wants to
3224	save the current state and stop the VM execution.
3225	</desc>
3226	<param name="progress" type="IProgress" dir="out">
3227	<desc>
3228	Progress object created by VBoxSVC to wait until
3229	the state is saved.
3230	</desc>
3231	</param>
3232	<param name="stateFilePath" type="wstring" dir="out">
3233	<desc>
3234	File path the VM process must save the execution state to.
3235	</desc>
3236	</param>
3237	</method>
3238
3239	<method name="endSavingState">
3240	<desc>
3241	Called by the VM process to inform the server that saving
3242	the state previously requested by #beginSavingState is either
3243	successfully finished or there was a failure.
3244
3245	<result name="VBOX_E_FILE_ERROR">
3246	Settings file not accessible.
3247	</result>
3248	<result name="VBOX_E_XML_ERROR">
3249	Could not parse the settings file.
3250	</result>
3251
3252	</desc>
3253
3254	<param name="result" type="long" dir="in">
3255	<desc>@c S_OK to indicate success.
3256	</desc>
3257	</param>
3258	<param name="errMsg" type="wstring" dir="in">
3259	<desc>@c human readable error message in case of failure.
3260	</desc>
3261	</param>
3262	</method>
3263
3264	<method name="adoptSavedState">
3265	<desc>
3266	Gets called by <link to="IConsole::adoptSavedState"/>.
3267	<result name="VBOX_E_FILE_ERROR">
3268	Invalid saved state file path.
3269	</result>
3270	</desc>
3271	<param name="savedStateFile" type="wstring" dir="in">
3272	<desc>Path to the saved state file to adopt.</desc>
3273	</param>
3274	</method>
3275
3276	<method name="beginTakingSnapshot">
3277	<desc>
3278	Called from the VM process to request from the server to perform the
3279	server-side actions of creating a snapshot (creating differencing images
3280	and the snapshot object).
3281
3282	<result name="VBOX_E_FILE_ERROR">
3283	Settings file not accessible.
3284	</result>
3285	<result name="VBOX_E_XML_ERROR">
3286	Could not parse the settings file.
3287	</result>
3288	</desc>
3289	<param name="initiator" type="IConsole" dir="in">
3290	<desc>The console object that initiated this call.</desc>
3291	</param>
3292	<param name="name" type="wstring" dir="in">
3293	<desc>Snapshot name.</desc>
3294	</param>
3295	<param name="description" type="wstring" dir="in">
3296	<desc>Snapshot description.</desc>
3297	</param>
3298	<param name="consoleProgress" type="IProgress" dir="in">
3299	<desc>
3300	Progress object created by the VM process tracking the
3301	snapshot's progress. This has the following sub-operations:
3302	<ul>
3303	<li>setting up (weight 1);</li>
3304	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3305	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3306	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3307	<li>finishing up (weight 1)</li>
3308	</ul>
3309	</desc>
3310	</param>
3311	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3312	<desc>
3313	Whether this is an online snapshot (i.e. the machine is running).
3314	</desc>
3315	</param>
3316	<param name="stateFilePath" type="wstring" dir="out">
3317	<desc>
3318	File path the VM process must save the execution state to.
3319	</desc>
3320	</param>
3321	</method>
3322
3323	<method name="endTakingSnapshot">
3324	<desc>
3325	Called by the VM process to inform the server that the snapshot
3326	previously requested by #beginTakingSnapshot is either
3327	successfully taken or there was a failure.
3328	</desc>
3329
3330	<param name="success" type="boolean" dir="in">
3331	<desc>@c true to indicate success and @c false otherwise</desc>
3332	</param>
3333	</method>
3334
3335	<method name="deleteSnapshot">
3336	<desc>
3337	Gets called by <link to="IConsole::deleteSnapshot"/>,
3338	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3339	<link to="IConsole::deleteSnapshotRange"/>.
3340	<result name="VBOX_E_INVALID_OBJECT_STATE">
3341	Snapshot has more than one child snapshot. Only possible if the
3342	delete operation does not delete all children or the range does
3343	not meet the linearity condition.
3344	</result>
3345	</desc>
3346	<param name="initiator" type="IConsole" dir="in">
3347	<desc>The console object that initiated this call.</desc>
3348	</param>
3349	<param name="startId" type="uuid" mod="string" dir="in">
3350	<desc>UUID of the first snapshot to delete.</desc>
3351	</param>
3352	<param name="endId" type="uuid" mod="string" dir="in">
3353	<desc>UUID of the last snapshot to delete.</desc>
3354	</param>
3355	<param name="deleteAllChildren" type="boolean" dir="in">
3356	<desc>Whether all children should be deleted.</desc>
3357	</param>
3358	<param name="machineState" type="MachineState" dir="out">
3359	<desc>New machine state after this operation is started.</desc>
3360	</param>
3361	<param name="progress" type="IProgress" dir="return">
3362	<desc>Progress object to track the operation completion.</desc>
3363	</param>
3364	</method>
3365
3366	<method name="finishOnlineMergeMedium">
3367	<desc>
3368	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3369	</desc>
3370	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3371	<desc>The medium attachment which needs to be cleaned up.</desc>
3372	</param>
3373	<param name="source" type="IMedium" dir="in">
3374	<desc>Merge source medium.</desc>
3375	</param>
3376	<param name="target" type="IMedium" dir="in">
3377	<desc>Merge target medium.</desc>
3378	</param>
3379	<param name="mergeForward" type="boolean" dir="in">
3380	<desc>Merge direction.</desc>
3381	</param>
3382	<param name="parentForTarget" type="IMedium" dir="in">
3383	<desc>For forward merges: new parent for target medium.</desc>
3384	</param>
3385	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3386	<desc>For backward merges: list of media which need their parent UUID
3387	updated.</desc>
3388	</param>
3389	</method>
3390
3391	<method name="restoreSnapshot">
3392	<desc>
3393	Gets called by <link to="IConsole::restoreSnapshot"/>.
3394	</desc>
3395	<param name="initiator" type="IConsole" dir="in">
3396	<desc>The console object that initiated this call.</desc>
3397	</param>
3398	<param name="snapshot" type="ISnapshot" dir="in">
3399	<desc>The snapshot to restore the VM state from.</desc>
3400	</param>
3401	<param name="machineState" type="MachineState" dir="out">
3402	<desc>New machine state after this operation is started.</desc>
3403	</param>
3404	<param name="progress" type="IProgress" dir="return">
3405	<desc>Progress object to track the operation completion.</desc>
3406	</param>
3407	</method>
3408
3409	<method name="pullGuestProperties">
3410	<desc>
3411	Get the list of the guest properties matching a set of patterns along
3412	with their values, time stamps and flags and give responsibility for
3413	managing properties to the console.
3414	</desc>
3415	<param name="name" type="wstring" dir="out" safearray="yes">
3416	<desc>
3417	The names of the properties returned.
3418	</desc>
3419	</param>
3420	<param name="value" type="wstring" dir="out" safearray="yes">
3421	<desc>
3422	The values of the properties returned. The array entries match the
3423	corresponding entries in the @a name array.
3424	</desc>
3425	</param>
3426	<param name="timestamp" type="long long" dir="out" safearray="yes">
3427	<desc>
3428	The time stamps of the properties returned. The array entries match
3429	the corresponding entries in the @a name array.
3430	</desc>
3431	</param>
3432	<param name="flags" type="wstring" dir="out" safearray="yes">
3433	<desc>
3434	The flags of the properties returned. The array entries match the
3435	corresponding entries in the @a name array.
3436	</desc>
3437	</param>
3438	</method>
3439
3440	<method name="pushGuestProperty">
3441	<desc>
3442	Update a single guest property in IMachine.
3443	</desc>
3444	<param name="name" type="wstring" dir="in">
3445	<desc>
3446	The name of the property to be updated.
3447	</desc>
3448	</param>
3449	<param name="value" type="wstring" dir="in">
3450	<desc>
3451	The value of the property.
3452	</desc>
3453	</param>
3454	<param name="timestamp" type="long long" dir="in">
3455	<desc>
3456	The timestamp of the property.
3457	</desc>
3458	</param>
3459	<param name="flags" type="wstring" dir="in">
3460	<desc>
3461	The flags of the property.
3462	</desc>
3463	</param>
3464	</method>
3465
3466	<method name="lockMedia">
3467	<desc>
3468	Locks all media attached to the machine for writing and parents of
3469	attached differencing media (if any) for reading. This operation is
3470	atomic so that if it fails no media is actually locked.
3471
3472	This method is intended to be called when the machine is in Starting or
3473	Restoring state. The locked media will be automatically unlocked when
3474	the machine is powered off or crashed.
3475	</desc>
3476	</method>
3477	<method name="unlockMedia">
3478	<desc>
3479	Unlocks all media previously locked using
3480	<link to="IInternalMachineControl::lockMedia"/>.
3481
3482	This method is intended to be used with teleportation so that it is
3483	possible to teleport between processes on the same machine.
3484	</desc>
3485	</method>
3486
3487	<method name="ejectMedium">
3488	<desc>
3489	Tells VBoxSVC that the guest has ejected the medium associated with
3490	the medium attachment.
3491	</desc>
3492	<param name="attachment" type="IMediumAttachment" dir="in">
3493	<desc>
3494	The medium attachment where the eject happened.
3495	</desc>
3496	</param>
3497	<param name="newAttachment" type="IMediumAttachment" dir="return">
3498	<desc>
3499	A new reference to the medium attachment, as the config change can
3500	result in the creation of a new instance.
3501	</desc>
3502	</param>
3503	</method>
3504
3505	<method name="reportVmStatistics">
3506	<desc>
3507	Passes statistics collected by VM (including guest statistics) to VBoxSVC.
3508	</desc>
3509	<param name="validStats" type="unsigned long" dir="in">
3510	<desc>
3511	Mask defining which parameters are valid. For example: 0x11 means
3512	that cpuIdle and XXX are valid. Other parameters should be ignored.
3513	</desc>
3514	</param>
3515	<param name="cpuUser" type="unsigned long" dir="in">
3516	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3517	</param>
3518	<param name="cpuKernel" type="unsigned long" dir="in">
3519	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3520	</param>
3521	<param name="cpuIdle" type="unsigned long" dir="in">
3522	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3523	</param>
3524	<param name="memTotal" type="unsigned long" dir="in">
3525	<desc>Total amount of physical guest RAM.</desc>
3526	</param>
3527	<param name="memFree" type="unsigned long" dir="in">
3528	<desc>Free amount of physical guest RAM.</desc>
3529	</param>
3530	<param name="memBalloon" type="unsigned long" dir="in">
3531	<desc>Amount of ballooned physical guest RAM.</desc>
3532	</param>
3533	<param name="memShared" type="unsigned long" dir="in">
3534	<desc>Amount of shared physical guest RAM.</desc>
3535	</param>
3536	<param name="memCache" type="unsigned long" dir="in">
3537	<desc>Total amount of guest (disk) cache memory.</desc>
3538	</param>
3539	<param name="pagedTotal" type="unsigned long" dir="in">
3540	<desc>Total amount of space in the page file.</desc>
3541	</param>
3542	<param name="memAllocTotal" type="unsigned long" dir="in">
3543	<desc>Total amount of memory allocated by the hypervisor.</desc>
3544	</param>
3545	<param name="memFreeTotal" type="unsigned long" dir="in">
3546	<desc>Total amount of free memory available in the hypervisor.</desc>
3547	</param>
3548	<param name="memBalloonTotal" type="unsigned long" dir="in">
3549	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3550	</param>
3551	<param name="memSharedTotal" type="unsigned long" dir="in">
3552	<desc>Total amount of shared memory in the hypervisor.</desc>
3553	</param>
3554	<param name="vmNetRx" type="unsigned long" dir="in">
3555	<desc>Network receive rate for VM.</desc>
3556	</param>
3557	<param name="vmNetTx" type="unsigned long" dir="in">
3558	<desc>Network transmit rate for VM.</desc>
3559	</param>
3560	</method>
3561	</interface>
3562
3563	<interface
3564	name="IBIOSSettings" extends="$unknown"
3565	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3566	wsmap="managed"
3567	>
3568	<desc>
3569	The IBIOSSettings interface represents BIOS settings of the virtual
3570	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3571	</desc>
3572	<attribute name="logoFadeIn" type="boolean">
3573	<desc>Fade in flag for BIOS logo animation.</desc>
3574	</attribute>
3575
3576	<attribute name="logoFadeOut" type="boolean">
3577	<desc>Fade out flag for BIOS logo animation.</desc>
3578	</attribute>
3579
3580	<attribute name="logoDisplayTime" type="unsigned long">
3581	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3582	</attribute>
3583
3584	<attribute name="logoImagePath" type="wstring">
3585	<desc>
3586	Local file system path for external BIOS splash image. Empty string
3587	means the default image is shown on boot.
3588	</desc>
3589	</attribute>
3590
3591	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3592	<desc>Mode of the BIOS boot device menu.</desc>
3593	</attribute>
3594
3595	<attribute name="ACPIEnabled" type="boolean">
3596	<desc>ACPI support flag.</desc>
3597	</attribute>
3598
3599	<attribute name="IOAPICEnabled" type="boolean">
3600	<desc>
3601	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3602	and support IRQs above 15.
3603	</desc>
3604	</attribute>
3605
3606	<attribute name="timeOffset" type="long long">
3607	<desc>
3608	Offset in milliseconds from the host system time. This allows for
3609	guests running with a different system date/time than the host.
3610	It is equivalent to setting the system date/time in the BIOS except
3611	it is not an absolute value but a relative one. Guest Additions
3612	time synchronization honors this offset.
3613	</desc>
3614	</attribute>
3615
3616	<attribute name="PXEDebugEnabled" type="boolean">
3617	<desc>
3618	PXE debug logging flag. If set, VirtualBox will write extensive
3619	PXE trace information to the release log.
3620	</desc>
3621	</attribute>
3622	</interface>
3623
3624	<enum
3625	name="CleanupMode"
3626	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3627	>
3628	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3629	</desc>
3630	<const name="UnregisterOnly" value="1">
3631	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3632	</const>
3633	<const name="DetachAllReturnNone" value="2">
3634	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3635	</const>
3636	<const name="DetachAllReturnHardDisksOnly" value="3">
3637	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3638	</const>
3639	<const name="Full" value="4">
3640	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3641	</const>
3642	</enum>
3643
3644	<interface
3645	name="IPCIAddress" extends="$unknown"
3646	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3647	wsmap="struct"
3648	>
3649
3650	<desc>
3651	Address on the PCI bus.
3652	</desc>
3653
3654	<attribute name="bus" type="short">
3655	<desc>
3656	Bus number.
3657	</desc>
3658	</attribute>
3659
3660	<attribute name="device" type="short">
3661	<desc>
3662	Device number.
3663	</desc>
3664	</attribute>
3665
3666	<attribute name="devFunction" type="short">
3667	<desc>
3668	Device function number.
3669	</desc>
3670	</attribute>
3671
3672	<method name="asLong">
3673	<desc>
3674	Convert PCI address into long.
3675	</desc>
3676	<param name="result" type="long" dir="return" />
3677	</method>
3678
3679	<method name="fromLong">
3680	<desc>
3681	Make PCI address from long.
3682	</desc>
3683	<param name="number" type="long" dir="in" />
3684	</method>
3685	</interface>
3686
3687	<interface
3688	name="IPCIDeviceAttachment" extends="$unknown"
3689	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3690	wsmap="struct"
3691	>
3692
3693	<desc>
3694	Information about PCI attachments.
3695	</desc>
3696
3697	<attribute name="name" type="wstring" readonly="yes">
3698	<desc>
3699	Device name.
3700	</desc>
3701	</attribute>
3702
3703	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3704	<desc>
3705	If this is physical or virtual device.
3706	</desc>
3707	</attribute>
3708
3709	<attribute name="hostAddress" type="long" readonly="yes">
3710	<desc>
3711	Address of device on the host, applicable only to host devices.
3712	</desc>
3713	</attribute>
3714
3715	<attribute name="guestAddress" type="long" readonly="yes">
3716	<desc>
3717	Address of device on the guest.
3718	</desc>
3719	</attribute>
3720
3721	</interface>
3722
3723	<enum
3724	name="CloneMode" extends="$unknown"
3725	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3726	>
3727
3728	<desc>
3729	Clone mode, used with <link to="IMachine::cloneTo" />.
3730	</desc>
3731
3732	<const name="MachineState" value="1">
3733	<desc>Clone the state of the selected machine.</desc>
3734	</const>
3735	<const name="MachineAndChildStates" value="2">
3736	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3737	</const>
3738	<const name="AllStates" value="3">
3739	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3740	</const>
3741
3742	</enum>
3743
3744	<enum
3745	name="CloneOptions" extends="$unknown"
3746	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3747	>
3748
3749	<desc>
3750	Clone options, used with <link to="IMachine::cloneTo" />.
3751	</desc>
3752
3753	<const name="Link" value="1">
3754	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3755	</const>
3756	<const name="KeepAllMACs" value="2">
3757	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3758	</const>
3759	<const name="KeepNATMACs" value="3">
3760	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3761	</const>
3762	<const name="KeepDiskNames" value="4">
3763	<desc>Don't change the disk names.</desc>
3764	</const>
3765
3766	</enum>
3767
3768	<enum
3769	name="AutostopType" extends="$unknown"
3770	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3771	>
3772
3773	<desc>
3774	Autostop types, used with <link to="IMachine::autostopType" />.
3775	</desc>
3776
3777	<const name="Disabled" value="1">
3778	<desc>Stopping the VM during system shutdown is disabled.</desc>
3779	</const>
3780	<const name="SaveState" value="2">
3781	<desc>The state of the VM will be saved when the system shuts down.</desc>
3782	</const>
3783	<const name="PowerOff" value="3">
3784	<desc>The VM is powered off when the system shuts down.</desc>
3785	</const>
3786	<const name="AcpiShutdown" value="4">
3787	<desc>An ACPI shutdown event is generated.</desc>
3788	</const>
3789
3790	</enum>
3791
3792
3793	<interface
3794	name="IMachine" extends="$unknown"
3795	uuid="22781af3-1c96-4126-9edf-67a020e0e858"
3796	wsmap="managed"
3797	>
3798	<desc>
3799	The IMachine interface represents a virtual machine, or guest, created
3800	in VirtualBox.
3801
3802	This interface is used in two contexts. First of all, a collection of
3803	objects implementing this interface is stored in the
3804	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3805	machines that are currently registered with this VirtualBox
3806	installation. Also, once a session has been opened for the given virtual
3807	machine (e.g. the virtual machine is running), the machine object
3808	associated with the open session can be queried from the session object;
3809	see <link to="ISession"/> for details.
3810
3811	The main role of this interface is to expose the settings of the virtual
3812	machine and provide methods to change various aspects of the virtual
3813	machine's configuration. For machine objects stored in the
3814	<link to="IVirtualBox::machines"/> collection, all attributes are
3815	read-only unless explicitly stated otherwise in individual attribute
3816	and method descriptions.
3817
3818	In order to change a machine setting, a session for this machine must be
3819	opened using one of the <link to="IMachine::lockMachine" /> or
3820	<link to="IMachine::launchVMProcess"/> methods. After the
3821	machine has been successfully locked for a session, a mutable machine object
3822	needs to be queried from the session object and then the desired settings
3823	changes can be applied to the returned object using IMachine attributes and
3824	methods. See the <link to="ISession"/> interface description for more
3825	information about sessions.
3826
3827	Note that IMachine does not provide methods to control virtual machine
3828	execution (such as start the machine, or power it down) -- these methods
3829	are grouped in a separate interface called <link to="IConsole" />.
3830
3831	<see><link to="ISession"/>, <link to="IConsole"/></see>
3832	</desc>
3833
3834	<attribute name="parent" type="IVirtualBox" readonly="yes">
3835	<desc>Associated parent object.</desc>
3836	</attribute>
3837
3838	<attribute name="accessible" type="boolean" readonly="yes">
3839	<desc>
3840	Whether this virtual machine is currently accessible or not.
3841
3842	A machine is always deemed accessible unless it is registered <i>and</i>
3843	its settings file cannot be read or parsed (either because the file itself
3844	is unavailable or has invalid XML contents).
3845
3846	Every time this property is read, the accessibility state of
3847	this machine is re-evaluated. If the returned value is @c false,
3848	the <link to="#accessError"/> property may be used to get the
3849	detailed error information describing the reason of
3850	inaccessibility, including XML error messages.
3851
3852	When the machine is inaccessible, only the following properties
3853	can be used on it:
3854	<ul>
3855	<li><link to="#parent"/></li>
3856	<li><link to="#id"/></li>
3857	<li><link to="#settingsFilePath"/></li>
3858	<li><link to="#accessible"/></li>
3859	<li><link to="#accessError"/></li>
3860	</ul>
3861
3862	An attempt to access any other property or method will return
3863	an error.
3864
3865	The only possible action you can perform on an inaccessible
3866	machine is to unregister it using the
3867	<link to="IMachine::unregister"/> call (or, to check
3868	for the accessibility state once more by querying this
3869	property).
3870
3871	<note>
3872	In the current implementation, once this property returns
3873	@c true, the machine will never become inaccessible
3874	later, even if its settings file cannot be successfully
3875	read/written any more (at least, until the VirtualBox
3876	server is restarted). This limitation may be removed in
3877	future releases.
3878	</note>
3879	</desc>
3880	</attribute>
3881
3882	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3883	<desc>
3884	Error information describing the reason of machine
3885	inaccessibility.
3886
3887	Reading this property is only valid after the last call to
3888	<link to="#accessible"/> returned @c false (i.e. the
3889	machine is currently inaccessible). Otherwise, a @c null
3890	IVirtualBoxErrorInfo object will be returned.
3891	</desc>
3892	</attribute>
3893
3894	<attribute name="name" type="wstring">
3895	<desc>
3896	Name of the virtual machine.
3897
3898	Besides being used for human-readable identification purposes
3899	everywhere in VirtualBox, the virtual machine name is also used
3900	as a name of the machine's settings file and as a name of the
3901	subdirectory this settings file resides in. Thus, every time you
3902	change the value of this property, the settings file will be
3903	renamed once you call <link to="#saveSettings"/> to confirm the
3904	change. The containing subdirectory will be also renamed, but
3905	only if it has exactly the same name as the settings file
3906	itself prior to changing this property (for backward compatibility
3907	with previous API releases). The above implies the following
3908	limitations:
3909	<ul>
3910	<li>The machine name cannot be empty.</li>
3911	<li>The machine name can contain only characters that are valid
3912	file name characters according to the rules of the file
3913	system used to store VirtualBox configuration.</li>
3914	<li>You cannot have two or more machines with the same name
3915	if they use the same subdirectory for storing the machine
3916	settings files.</li>
3917	<li>You cannot change the name of the machine if it is running,
3918	or if any file in the directory containing the settings file
3919	is being used by another running machine or by any other
3920	process in the host operating system at a time when
3921	<link to="#saveSettings"/> is called.
3922	</li>
3923	</ul>
3924	If any of the above limitations are hit, <link to="#saveSettings"/>
3925	will return an appropriate error message explaining the exact
3926	reason and the changes you made to this machine will not be saved.
3927
3928	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3929	file is recommended, but not enforced. (Previous versions always
3930	used a generic ".xml" extension.)
3931	</desc>
3932	</attribute>
3933
3934	<attribute name="description" type="wstring">
3935	<desc>
3936	Description of the virtual machine.
3937
3938	The description attribute can contain any text and is
3939	typically used to describe the hardware and software
3940	configuration of the virtual machine in detail (i.e. network
3941	settings, versions of the installed software and so on).
3942	</desc>
3943	</attribute>
3944
3945	<attribute name="id" type="uuid" mod="string" readonly="yes">
3946	<desc>UUID of the virtual machine.</desc>
3947	</attribute>
3948
3949	<attribute name="groups" type="wstring" safearray="yes">
3950	<desc>
3951	Array of machine group names of which this machine is a member.
3952	<tt>""</tt> and <tt>"/"</tt> are synonyms for the toplevel group. Each
3953	group is only listed once, however they are listed in no particular
3954	order and there is no guarantee that there are no gaps in the group
3955	hierarchy (i.e. <tt>"/group"</tt>,
3956	<tt>"/group/subgroup/subsubgroup"</tt> is a valid result).
3957	</desc>
3958	</attribute>
3959
3960	<attribute name="OSTypeId" type="wstring">
3961	<desc>
3962	User-defined identifier of the Guest OS type.
3963	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3964	an IGuestOSType object representing details about the given
3965	Guest OS type.
3966	<note>
3967	This value may differ from the value returned by
3968	<link to="IGuest::OSTypeId"/> if Guest Additions are
3969	installed to the guest OS.
3970	</note>
3971	</desc>
3972	</attribute>
3973
3974	<attribute name="hardwareVersion" type="wstring">
3975	<desc>Hardware version identifier. Internal use only for now.</desc>
3976	</attribute>
3977
3978	<attribute name="hardwareUUID" type="uuid" mod="string">
3979	<desc>
3980	The UUID presented to the guest via memory tables, hardware and guest
3981	properties. For most VMs this is the same as the @a id, but for VMs
3982	which have been cloned or teleported it may be the same as the source
3983	VM. The latter is because the guest shouldn't notice that it was
3984	cloned or teleported.
3985	</desc>
3986	</attribute>
3987
3988	<attribute name="CPUCount" type="unsigned long">
3989	<desc>Number of virtual CPUs in the VM.</desc>
3990	</attribute>
3991
3992	<attribute name="CPUHotPlugEnabled" type="boolean">
3993	<desc>
3994	This setting determines whether VirtualBox allows CPU
3995	hotplugging for this machine.</desc>
3996	</attribute>
3997
3998	<attribute name="CPUExecutionCap" type="unsigned long">
3999	<desc>
4000	Means to limit the number of CPU cycles a guest can use. The unit
4001	is percentage of host CPU cycles per second. The valid range
4002	is 1 - 100. 100 (the default) implies no limit.
4003	</desc>
4004	</attribute>
4005
4006	<attribute name="memorySize" type="unsigned long">
4007	<desc>System memory size in megabytes.</desc>
4008	</attribute>
4009
4010	<attribute name="memoryBalloonSize" type="unsigned long">
4011	<desc>Memory balloon size in megabytes.</desc>
4012	</attribute>
4013
4014	<attribute name="pageFusionEnabled" type="boolean">
4015	<desc>
4016	This setting determines whether VirtualBox allows page
4017	fusion for this machine (64 bits host only).
4018	</desc>
4019	</attribute>
4020
4021	<attribute name="VRAMSize" type="unsigned long">
4022	<desc>Video memory size in megabytes.</desc>
4023	</attribute>
4024
4025	<attribute name="accelerate3DEnabled" type="boolean" default="false">
4026	<desc>
4027	This setting determines whether VirtualBox allows this machine to make
4028	use of the 3D graphics support available on the host.</desc>
4029	</attribute>
4030
4031	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
4032	<desc>
4033	This setting determines whether VirtualBox allows this machine to make
4034	use of the 2D video acceleration support available on the host.</desc>
4035	</attribute>
4036
4037	<attribute name="monitorCount" type="unsigned long">
4038	<desc>
4039	Number of virtual monitors.
4040	<note>
4041	Only effective on Windows XP and later guests with
4042	Guest Additions installed.
4043	</note>
4044	</desc>
4045	</attribute>
4046
4047	<attribute name="VideoCaptureEnabled" type="boolean" default="false">
4048	<desc>
4049	This setting determines whether VirtualBox uses video recording to
4050	record VM session.</desc>
4051	</attribute>
4052
4053	<attribute name="VideoCaptureFile" type="wstring" default="Test.webm">
4054	<desc>
4055	This setting determines what filename VirtualBox uses to save
4056	the recorded content.</desc>
4057	</attribute>
4058
4059	<attribute name="VideoCaptureWidth" type="unsigned long" default="640">
4060	<desc>
4061	This setting determines what should be the horizontal resolution of
4062	recorded video.</desc>
4063	</attribute>
4064
4065	<attribute name="VideoCaptureHeight" type="unsigned long" default="480">
4066	<desc>
4067	This setting determines what should be the vertical resolution
4068	of recorded video.</desc>
4069	</attribute>
4070
4071	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
4072	<desc>Object containing all BIOS settings.</desc>
4073	</attribute>
4074
4075	<attribute name="firmwareType" type="FirmwareType">
4076	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
4077	bootstrap in this VM.</desc>
4078	</attribute>
4079
4080	<attribute name="pointingHIDType" type="PointingHIDType">
4081	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
4082	The default is typically "PS2Mouse" but can vary depending on the
4083	requirements of the guest operating system.</desc>
4084	</attribute>
4085
4086	<attribute name="keyboardHIDType" type="KeyboardHIDType">
4087	<desc>Type of keyboard HID used in this VM.
4088	The default is typically "PS2Keyboard" but can vary depending on the
4089	requirements of the guest operating system.</desc>
4090	</attribute>
4091
4092	<attribute name="HPETEnabled" type="boolean">
4093	<desc>This attribute controls if High Precision Event Timer (HPET) is
4094	enabled in this VM. Use this property if you want to provide guests
4095	with additional time source, or if guest requires HPET to function correctly.
4096	Default is false.</desc>
4097	</attribute>
4098
4099	<attribute name="chipsetType" type="ChipsetType">
4100	<desc>Chipset type used in this VM.</desc>
4101	</attribute>
4102
4103	<attribute name="snapshotFolder" type="wstring">
4104	<desc>
4105	Full path to the directory used to store snapshot data
4106	(differencing media and saved state files) of this machine.
4107
4108	The initial value of this property is
4109	<tt><</tt><link to="#settingsFilePath">
4110	path_to_settings_file</link><tt>>/<</tt>
4111	<link to="#id">machine_uuid</link>
4112	<tt>></tt>.
4113
4114	Currently, it is an error to try to change this property on
4115	a machine that has snapshots (because this would require to
4116	move possibly large files to a different location).
4117	A separate method will be available for this purpose later.
4118
4119	<note>
4120	Setting this property to @c null or to an empty string will restore
4121	the initial value.
4122	</note>
4123	<note>
4124	When setting this property, the specified path can be
4125	absolute (full path) or relative to the directory where the
4126	<link to="#settingsFilePath">machine settings file</link>
4127	is located. When reading this property, a full path is
4128	always returned.
4129	</note>
4130	<note>
4131	The specified path may not exist, it will be created
4132	when necessary.
4133	</note>
4134	</desc>
4135	</attribute>
4136
4137	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4138	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4139	</attribute>
4140
4141	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4142	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4143
4144	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4145	<desc>Array of media attached to this machine.</desc>
4146	</attribute>
4147
4148	<attribute name="USBController" type="IUSBController" readonly="yes">
4149	<desc>
4150	Associated USB controller object.
4151
4152	<note>
4153	If USB functionality is not available in the given edition of
4154	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4155	</note>
4156	</desc>
4157	</attribute>
4158
4159	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4160	<desc>Associated audio adapter, always present.</desc>
4161	</attribute>
4162
4163	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4164	<desc>Array of storage controllers attached to this machine.</desc>
4165	</attribute>
4166
4167	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4168	<desc>
4169	Full name of the file containing machine settings data.
4170	</desc>
4171	</attribute>
4172
4173	<attribute name="settingsModified" type="boolean" readonly="yes">
4174	<desc>
4175	Whether the settings of this machine have been modified
4176	(but neither yet saved nor discarded).
4177	<note>
4178	Reading this property is only valid on instances returned
4179	by <link to="ISession::machine"/> and on new machines
4180	created by <link to="IVirtualBox::createMachine"/> or opened
4181	by <link to="IVirtualBox::openMachine"/> but not
4182	yet registered, or on unregistered machines after calling
4183	<link to="IMachine::unregister"/>. For all other
4184	cases, the settings can never be modified.
4185	</note>
4186	<note>
4187	For newly created unregistered machines, the value of this
4188	property is always @c true until <link to="#saveSettings"/>
4189	is called (no matter if any machine settings have been
4190	changed after the creation or not). For opened machines
4191	the value is set to @c false (and then follows to normal rules).
4192	</note>
4193	</desc>
4194	</attribute>
4195
4196	<attribute name="sessionState" type="SessionState" readonly="yes">
4197	<desc>Current session state for this machine.</desc>
4198	</attribute>
4199
4200	<attribute name="sessionType" type="wstring" readonly="yes">
4201	<desc>
4202	Type of the session. If <link to="#sessionState"/> is
4203	Spawning or Locked, this attribute contains the
4204	same value as passed to the
4205	<link to="IMachine::launchVMProcess"/> method in the
4206	@a type parameter. If the session was used with
4207	<link to="IMachine::lockMachine" />, or if
4208	<link to="#sessionState"/> is SessionClosed, the value of this
4209	attribute is an empty string.
4210	</desc>
4211	</attribute>
4212
4213	<attribute name="sessionPID" type="unsigned long" readonly="yes">
4214	<desc>
4215	Identifier of the session process. This attribute contains the
4216	platform-dependent identifier of the process whose session was
4217	used with <link to="IMachine::lockMachine" /> call. The returned
4218	value is only valid if <link to="#sessionState"/> is Locked or
4219	Unlocking by the time this property is read.
4220	</desc>
4221	</attribute>
4222
4223	<attribute name="state" type="MachineState" readonly="yes">
4224	<desc>Current execution state of this machine.</desc>
4225	</attribute>
4226
4227	<attribute name="lastStateChange" type="long long" readonly="yes">
4228	<desc>
4229	Time stamp of the last execution state change,
4230	in milliseconds since 1970-01-01 UTC.
4231	</desc>
4232	</attribute>
4233
4234	<attribute name="stateFilePath" type="wstring" readonly="yes">
4235	<desc>
4236	Full path to the file that stores the execution state of
4237	the machine when it is in the <link to="MachineState_Saved"/> state.
4238	<note>
4239	When the machine is not in the Saved state, this attribute is
4240	an empty string.
4241	</note>
4242	</desc>
4243	</attribute>
4244
4245	<attribute name="logFolder" type="wstring" readonly="yes">
4246	<desc>
4247	Full path to the folder that stores a set of rotated log files
4248	recorded during machine execution. The most recent log file is
4249	named <tt>VBox.log</tt>, the previous log file is
4250	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4251	in the current version).
4252	</desc>
4253	</attribute>
4254
4255	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4256	<desc>
4257	Current snapshot of this machine. This is @c null if the machine
4258	currently has no snapshots. If it is not @c null, then it was
4259	set by one of <link to="IConsole::takeSnapshot" />,
4260	<link to="IConsole::deleteSnapshot" />
4261	or <link to="IConsole::restoreSnapshot" />, depending on which
4262	was called last. See <link to="ISnapshot"/> for details.
4263	</desc>
4264	</attribute>
4265
4266	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4267	<desc>
4268	Number of snapshots taken on this machine. Zero means the
4269	machine doesn't have any snapshots.
4270	</desc>
4271	</attribute>
4272
4273	<attribute name="currentStateModified" type="boolean" readonly="yes">
4274	<desc>
4275	Returns @c true if the current state of the machine is not
4276	identical to the state stored in the current snapshot.
4277
4278	The current state is identical to the current snapshot only
4279	directly after one of the following calls are made:
4280
4281	<ul>
4282	<li><link to="IConsole::restoreSnapshot"/>
4283	</li>
4284	<li><link to="IConsole::takeSnapshot"/> (issued on a
4285	"powered off" or "saved" machine, for which
4286	<link to="#settingsModified"/> returns @c false)
4287	</li>
4288	</ul>
4289
4290	The current state remains identical until one of the following
4291	happens:
4292	<ul>
4293	<li>settings of the machine are changed</li>
4294	<li>the saved state is deleted</li>
4295	<li>the current snapshot is deleted</li>
4296	<li>an attempt to execute the machine is made</li>
4297	</ul>
4298
4299	<note>
4300	For machines that don't have snapshots, this property is
4301	always @c false.
4302	</note>
4303	</desc>
4304	</attribute>
4305
4306	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4307	<desc>
4308	Collection of shared folders for this machine (permanent shared
4309	folders). These folders are shared automatically at machine startup
4310	and available only to the guest OS installed within this machine.
4311
4312	New shared folders are added to the collection using
4313	<link to="#createSharedFolder"/>. Existing shared folders can be
4314	removed using <link to="#removeSharedFolder"/>.
4315	</desc>
4316	</attribute>
4317
4318	<attribute name="clipboardMode" type="ClipboardMode">
4319	<desc>
4320	Synchronization mode between the host OS clipboard
4321	and the guest OS clipboard.
4322	</desc>
4323	</attribute>
4324
4325	<attribute name="dragAndDropMode" type="DragAndDropMode">
4326	<desc>
4327	Which mode is allowed for drag'n'drop.
4328	</desc>
4329	</attribute>
4330
4331	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4332	<desc>
4333	A comma-separated list of simple glob patterns. Changes to guest
4334	properties whose name matches one of the patterns will generate an
4335	<link to="IGuestPropertyChangedEvent"/> signal.
4336	</desc>
4337	</attribute>
4338
4339	<attribute name="teleporterEnabled" type="boolean">
4340	<desc>
4341	When set to @a true, the virtual machine becomes a target teleporter
4342	the next time it is powered on. This can only set to @a true when the
4343	VM is in the @a PoweredOff or @a Aborted state.
4344
4345	<!-- This property is automatically set to @a false when the VM is powered
4346	on. (bird: This doesn't work yet ) -->
4347	</desc>
4348	</attribute>
4349
4350	<attribute name="teleporterPort" type="unsigned long">
4351	<desc>
4352	The TCP port the target teleporter will listen for incoming
4353	teleportations on.
4354
4355	0 means the port is automatically selected upon power on. The actual
4356	value can be read from this property while the machine is waiting for
4357	incoming teleportations.
4358	</desc>
4359	</attribute>
4360
4361	<attribute name="teleporterAddress" type="wstring">
4362	<desc>
4363	The address the target teleporter will listen on. If set to an empty
4364	string, it will listen on all addresses.
4365	</desc>
4366	</attribute>
4367
4368	<attribute name="teleporterPassword" type="wstring">
4369	<desc>
4370	The password to check for on the target teleporter. This is just a
4371	very basic measure to prevent simple hacks and operators accidentally
4372	beaming a virtual machine to the wrong place.
4373
4374	Note that you SET a plain text password while reading back a HASHED
4375	password. Setting a hashed password is currently not supported.
4376	</desc>
4377	</attribute>
4378
4379	<attribute name="faultToleranceState" type="FaultToleranceState">
4380	<desc>
4381	Fault tolerance state; disabled, source or target.
4382	This property can be changed at any time. If you change it for a running
4383	VM, then the fault tolerance address and port must be set beforehand.
4384	</desc>
4385	</attribute>
4386
4387	<attribute name="faultTolerancePort" type="unsigned long">
4388	<desc>
4389	The TCP port the fault tolerance source or target will use for
4390	communication.
4391	</desc>
4392	</attribute>
4393
4394	<attribute name="faultToleranceAddress" type="wstring">
4395	<desc>
4396	The address the fault tolerance source or target.
4397	</desc>
4398	</attribute>
4399
4400	<attribute name="faultTolerancePassword" type="wstring">
4401	<desc>
4402	The password to check for on the standby VM. This is just a
4403	very basic measure to prevent simple hacks and operators accidentally
4404	choosing the wrong standby VM.
4405	</desc>
4406	</attribute>
4407
4408	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4409	<desc>
4410	The interval in ms used for syncing the state between source and target.
4411	</desc>
4412	</attribute>
4413
4414	<attribute name="RTCUseUTC" type="boolean">
4415	<desc>
4416	When set to @a true, the RTC device of the virtual machine will run
4417	in UTC time, otherwise in local time. Especially Unix guests prefer
4418	the time in UTC.
4419	</desc>
4420	</attribute>
4421
4422	<attribute name="IOCacheEnabled" type="boolean">
4423	<desc>
4424	When set to @a true, the builtin I/O cache of the virtual machine
4425	will be enabled.
4426	</desc>
4427	</attribute>
4428
4429	<attribute name="IOCacheSize" type="unsigned long">
4430	<desc>
4431	Maximum size of the I/O cache in MB.
4432	</desc>
4433	</attribute>
4434
4435	<attribute name="PCIDeviceAssignments" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
4436	<desc>Array of PCI devices assigned to this machine, to get list of all
4437	PCI devices attached to the machine use
4438	<link to="IConsole::attachedPCIDevices"/> attribute, as this attribute
4439	is intended to list only devices additional to what described in
4440	virtual hardware config. Usually, this list keeps host's physical
4441	devices assigned to the particular machine.
4442	</desc>
4443	</attribute>
4444
4445	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4446	<desc>
4447	Bandwidth control manager.
4448	</desc>
4449	</attribute>
4450
4451	<attribute name="tracingEnabled" type="boolean">
4452	<desc>
4453	Enables the tracing facility in the VMM (including PDM devices +
4454	drivers). The VMM will consume about 0.5MB of more memory when
4455	enabled and there may be some extra overhead from tracepoints that are
4456	always enabled.
4457	</desc>
4458	</attribute>
4459
4460	<attribute name="tracingConfig" type="wstring">
4461	<desc>
4462	Tracepoint configuration to apply at startup when
4463	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4464	a space separated of tracepoint group names to enable. The special
4465	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4466	more details on available tracepoint groups and such.
4467
4468	Note that on hosts supporting DTrace (or similar), a lot of the
4469	tracepoints may be implemented exclusivly as DTrace probes. So, the
4470	effect of the same config may differ between Solaris and Windows for
4471	example.
4472	</desc>
4473	</attribute>
4474
4475	<attribute name="allowTracingToAccessVM" type="boolean">
4476	<desc>
4477	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4478	structures when firing off trace points. This is especially useful
4479	with DTrace tracepoints, as it allows you to use the VMCPU or VM
4480	pointer to obtain useful information such as guest register state.
4481
4482	This is disabled by default because devices and drivers normally has no
4483	business accessing the VMCPU or VM structures, and are therefore unable
4484	to get any pointers to these.
4485	</desc>
4486	</attribute>
4487
4488	<attribute name="autostartEnabled" type="boolean">
4489	<desc>
4490	Enables autostart of the VM during system boot.
4491	</desc>
4492	</attribute>
4493
4494	<attribute name="autostartDelay" type="unsigned long">
4495	<desc>
4496	Number of seconds to wait until the VM should be started during system boot.
4497	</desc>
4498	</attribute>
4499
4500	<attribute name="autostopType" type="AutostopType">
4501	<desc>
4502	Action type to do when the system is shutting down.
4503	</desc>
4504	</attribute>
4505
4506	<method name="lockMachine">
4507	<desc>
4508	Locks the machine for the given session to enable the caller
4509	to make changes to the machine or start the VM or control
4510	VM execution.
4511
4512	There are two ways to lock a machine for such uses:
4513
4514	<ul>
4515	<li>If you want to make changes to the machine settings,
4516	you must obtain an exclusive write lock on the machine
4517	by setting @a lockType to @c Write.
4518
4519	This will only succeed if no other process has locked
4520	the machine to prevent conflicting changes. Only after
4521	an exclusive write lock has been obtained using this method, one
4522	can change all VM settings or execute the VM in the process
4523	space of the session object. (Note that the latter is only of
4524	interest if you actually want to write a new front-end for
4525	virtual machines; but this API gets called internally by
4526	the existing front-ends such as VBoxHeadless and the VirtualBox
4527	GUI to acquire a write lock on the machine that they are running.)
4528
4529	On success, write-locking the machine for a session creates
4530	a second copy of the IMachine object. It is this second object
4531	upon which changes can be made; in VirtualBox terminology, the
4532	second copy is "mutable". It is only this second, mutable machine
4533	object upon which you can call methods that change the
4534	machine state. After having called this method, you can
4535	obtain this second, mutable machine object using the
4536	<link to="ISession::machine" /> attribute.
4537	</li>
4538	<li>If you only want to check the machine state or control
4539	machine execution without actually changing machine
4540	settings (e.g. to get access to VM statistics or take
4541	a snapshot or save the machine state), then set the
4542	@a lockType argument to @c Shared.
4543
4544	If no other session has obtained a lock, you will obtain an
4545	exclusive write lock as described above. However, if another
4546	session has already obtained such a lock, then a link to that
4547	existing session will be established which allows you
4548	to control that existing session.
4549
4550	To find out which type of lock was obtained, you can
4551	inspect <link to="ISession::type" />, which will have been
4552	set to either @c WriteLock or @c Shared.
4553	</li>
4554	</ul>
4555
4556	In either case, you can get access to the <link to="IConsole" />
4557	object which controls VM execution.
4558
4559	Also in all of the above cases, one must always call
4560	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4561	the machine's state will eventually be set to "Aborted".
4562
4563	To change settings on a machine, the following sequence is typically
4564	performed:
4565
4566	<ol>
4567	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4568
4569	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4570
4571	<li>Change the settings of the machine by invoking IMachine methods.</li>
4572
4573	<li>Call <link to="IMachine::saveSettings" />.</li>
4574
4575	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4576	</ol>
4577
4578	<result name="E_UNEXPECTED">
4579	Virtual machine not registered.
4580	</result>
4581	<result name="E_ACCESSDENIED">
4582	Process not started by OpenRemoteSession.
4583	</result>
4584	<result name="VBOX_E_INVALID_OBJECT_STATE">
4585	Session already open or being opened.
4586	</result>
4587	<result name="VBOX_E_VM_ERROR">
4588	Failed to assign machine to session.
4589	</result>
4590	</desc>
4591	<param name="session" type="ISession" dir="in">
4592	<desc>
4593	Session object for which the machine will be locked.
4594	</desc>
4595	</param>
4596	<param name="lockType" type="LockType" dir="in">
4597	<desc>
4598	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4599	If set to @c Shared, then either acquire an exclusive write lock or establish
4600	a link to an existing session.
4601	</desc>
4602	</param>
4603	</method>
4604
4605	<method name="launchVMProcess">
4606	<desc>
4607	Spawns a new process that will execute the virtual machine and obtains a shared
4608	lock on the machine for the calling session.
4609
4610	If launching the VM succeeds, the new VM process will create its own session
4611	and write-lock the machine for it, preventing conflicting changes from other
4612	processes. If the machine is already locked (because it is already running or
4613	because another session has a write lock), launching the VM process will therefore
4614	fail. Reversely, future attempts to obtain a write lock will also fail while the
4615	machine is running.
4616
4617	The caller's session object remains separate from the session opened by the new
4618	VM process. It receives its own <link to="IConsole" /> object which can be used
4619	to control machine execution, but it cannot be used to change all VM settings
4620	which would be available after a <link to="#lockMachine" /> call.
4621
4622	The caller must eventually release the session's shared lock by calling
4623	<link to="ISession::unlockMachine" /> on the local session object once this call
4624	has returned. However, the session's state (see <link to="ISession::state" />)
4625	will not return to "Unlocked" until the remote session has also unlocked
4626	the machine (i.e. the machine has stopped running).
4627
4628	Launching a VM process can take some time (a new VM is started in a new process,
4629	for which memory and other resources need to be set up). Because of this,
4630	an <link to="IProgress" /> object is returned to allow the caller to wait
4631	for this asynchronous operation to be completed. Until then, the caller's
4632	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4633	and <link to="ISession::console" /> attributes cannot be accessed.
4634	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4635	similar calls to wait for completion. Completion is signalled when the VM
4636	is powered on. If launching the VM fails, error messages can be queried
4637	via the progress object, if available.
4638
4639	The progress object will have at least 2 sub-operations. The first
4640	operation covers the period up to the new VM process calls powerUp.
4641	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4642	progress object. Because <link to="IConsole::powerUp"/> may require
4643	some extra sub-operations, the <link to="IProgress::operationCount"/>
4644	may change at the completion of operation.
4645
4646	For details on the teleportation progress operation, see
4647	<link to="IConsole::powerUp"/>.
4648
4649	The @a environment argument is a string containing definitions of
4650	environment variables in the following format:
4651	<pre>
4652	NAME[=VALUE]\n
4653	NAME[=VALUE]\n
4654	...
4655	</pre>
4656	where <tt>\\n</tt> is the new line character. These environment
4657	variables will be appended to the environment of the VirtualBox server
4658	process. If an environment variable exists both in the server process
4659	and in this list, the value from this list takes precedence over the
4660	server's variable. If the value of the environment variable is
4661	omitted, this variable will be removed from the resulting environment.
4662	If the environment string is @c null or empty, the server environment
4663	is inherited by the started process as is.
4664
4665	<result name="E_UNEXPECTED">
4666	Virtual machine not registered.
4667	</result>
4668	<result name="E_INVALIDARG">
4669	Invalid session type @a type.
4670	</result>
4671	<result name="VBOX_E_OBJECT_NOT_FOUND">
4672	No machine matching @a machineId found.
4673	</result>
4674	<result name="VBOX_E_INVALID_OBJECT_STATE">
4675	Session already open or being opened.
4676	</result>
4677	<result name="VBOX_E_IPRT_ERROR">
4678	Launching process for machine failed.
4679	</result>
4680	<result name="VBOX_E_VM_ERROR">
4681	Failed to assign machine to session.
4682	</result>
4683	</desc>
4684	<param name="session" type="ISession" dir="in">
4685	<desc>
4686	Client session object to which the VM process will be connected (this
4687	must be in "Unlocked" state).
4688	</desc>
4689	</param>
4690	<param name="type" type="wstring" dir="in">
4691	<desc>
4692	Front-end to use for the new VM process. The following are currently supported:
4693	<ul>
4694	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4695	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4696	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4697	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4698	the currently running VM or session owner. In this case the
4699	@a session parameter may be @c null (if it is non-null it isn't
4700	used in any way), and the @a progress return value will be always
4701	@c null. The operation completes immediately.</li>
4702	</ul>
4703	</desc>
4704	</param>
4705	<param name="environment" type="wstring" dir="in">
4706	<desc>
4707	Environment to pass to the VM process.
4708	</desc>
4709	</param>
4710	<param name="progress" type="IProgress" dir="return">
4711	<desc>Progress object to track the operation completion.</desc>
4712	</param>
4713	</method>
4714
4715	<method name="setBootOrder">
4716	<desc>
4717	Puts the given device to the specified position in
4718	the boot order.
4719
4720	To indicate that no device is associated with the given position,
4721	<link to="DeviceType_Null"/> should be used.
4722
4723	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4724
4725	<result name="E_INVALIDARG">
4726	Boot @a position out of range.
4727	</result>
4728	<result name="E_NOTIMPL">
4729	Booting from USB @a device currently not supported.
4730	</result>
4731
4732	</desc>
4733	<param name="position" type="unsigned long" dir="in">
4734	<desc>
4735	Position in the boot order (@c 1 to the total number of
4736	devices the machine can boot from, as returned by
4737	<link to="ISystemProperties::maxBootPosition"/>).
4738	</desc>
4739	</param>
4740	<param name="device" type="DeviceType" dir="in">
4741	<desc>
4742	The type of the device used to boot at the given position.
4743	</desc>
4744	</param>
4745	</method>
4746
4747	<method name="getBootOrder" const="yes">
4748	<desc>
4749	Returns the device type that occupies the specified
4750	position in the boot order.
4751
4752	@todo [remove?]
4753	If the machine can have more than one device of the returned type
4754	(such as hard disks), then a separate method should be used to
4755	retrieve the individual device that occupies the given position.
4756
4757	If here are no devices at the given position, then
4758	<link to="DeviceType_Null"/> is returned.
4759
4760	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4761
4762	<result name="E_INVALIDARG">
4763	Boot @a position out of range.
4764	</result>
4765
4766	</desc>
4767	<param name="position" type="unsigned long" dir="in">
4768	<desc>
4769	Position in the boot order (@c 1 to the total number of
4770	devices the machine can boot from, as returned by
4771	<link to="ISystemProperties::maxBootPosition"/>).
4772	</desc>
4773	</param>
4774	<param name="device" type="DeviceType" dir="return">
4775	<desc>
4776	Device at the given position.
4777	</desc>
4778	</param>
4779	</method>
4780
4781	<method name="attachDevice">
4782	<desc>
4783	Attaches a device and optionally mounts a medium to the given storage
4784	controller (<link to="IStorageController" />, identified by @a name),
4785	at the indicated port and device.
4786
4787	This method is intended for managing storage devices in general while a
4788	machine is powered off. It can be used to attach and detach fixed
4789	and removable media. The following kind of media can be attached
4790	to a machine:
4791
4792	<ul>
4793	<li>For fixed and removable media, you can pass in a medium that was
4794	previously opened using <link to="IVirtualBox::openMedium" />.
4795	</li>
4796
4797	<li>Only for storage devices supporting removable media (such as
4798	DVDs and floppies), you can also specify a null pointer to
4799	indicate an empty drive or one of the medium objects listed
4800	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4801	arrays to indicate a host drive.
4802	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4803	to change the media while the machine is running.
4804	</li>
4805	</ul>
4806
4807	In a VM's default configuration of virtual machines, the secondary
4808	master of the IDE controller is used for a CD/DVD drive.
4809
4810	After calling this returns successfully, a new instance of
4811	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4812	attachments (see <link to="IMachine::mediumAttachments"/>).
4813
4814	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4815	information about attaching media.
4816
4817	The specified device slot must not have a device attached to it,
4818	or this method will fail.
4819
4820	<note>
4821	You cannot attach a device to a newly created machine until
4822	this machine's settings are saved to disk using
4823	<link to="#saveSettings"/>.
4824	</note>
4825	<note>
4826	If the medium is being attached indirectly, a new differencing medium
4827	will implicitly be created for it and attached instead. If the
4828	changes made to the machine settings (including this indirect
4829	attachment) are later cancelled using <link to="#discardSettings"/>,
4830	this implicitly created differencing medium will implicitly
4831	be deleted.
4832	</note>
4833
4834	<result name="E_INVALIDARG">
4835	SATA device, SATA port, IDE port or IDE slot out of range, or
4836	file or UUID not found.
4837	</result>
4838	<result name="VBOX_E_INVALID_OBJECT_STATE">
4839	Machine must be registered before media can be attached.
4840	</result>
4841	<result name="VBOX_E_INVALID_VM_STATE">
4842	Invalid machine state.
4843	</result>
4844	<result name="VBOX_E_OBJECT_IN_USE">
4845	A medium is already attached to this or another virtual machine.
4846	</result>
4847
4848	</desc>
4849	<param name="name" type="wstring" dir="in">
4850	<desc>Name of the storage controller to attach the device to.</desc>
4851	</param>
4852	<param name="controllerPort" type="long" dir="in">
4853	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4854	the primary controller and 1 specifies the secondary controller.
4855	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4856	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4857	</param>
4858	<param name="device" type="long" dir="in">
4859	<desc>Device slot in the given port to attach the device to. This is only
4860	relevant for IDE controllers, for which 0 specifies the master device and
4861	1 specifies the slave device. For all other controller types, this must
4862	be 0.</desc>
4863	</param>
4864	<param name="type" type="DeviceType" dir="in">
4865	<desc>Device type of the attached device. For media opened by
4866	<link to="IVirtualBox::openMedium" />, this must match the device type
4867	specified there.</desc>
4868	</param>
4869	<param name="medium" type="IMedium" dir="in">
4870	<desc>Medium to mount or @c null for an empty drive.</desc>
4871	</param>
4872	</method>
4873
4874	<method name="attachDeviceWithoutMedium">
4875	<desc>
4876	Attaches a device and optionally mounts a medium to the given storage
4877	controller (<link to="IStorageController" />, identified by @a name),
4878	at the indicated port and device.
4879
4880	This method is intended for managing storage devices in general while a
4881	machine is powered off. It can be used to attach and detach fixed
4882	and removable media. The following kind of media can be attached
4883	to a machine:
4884	<ul>
4885	<li>
4886	For fixed and removable media, you can pass in a medium that was
4887	previously opened using <link to="IVirtualBox::openMedium" />.
4888	</li>
4889
4890	<li>Only for storage devices supporting removable media (such as
4891	DVDs and floppies) with an empty drive or one of the medium objects listed
4892	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4893	arrays to indicate a host drive.
4894	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4895	to change the media while the machine is running.
4896	</li>
4897	</ul>
4898
4899	In a VM's default configuration of virtual machines, the secondary
4900	master of the IDE controller is used for a CD/DVD drive.
4901	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4902	attachments (see <link to="IMachine::mediumAttachments"/>).
4903
4904	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4905	information about attaching media.
4906
4907	The specified device slot must not have a device attached to it,
4908	or this method will fail.
4909	<note>
4910	You cannot attach a device to a newly created machine until
4911	this machine's settings are saved to disk using
4912	<link to="#saveSettings"/>.
4913	</note>
4914	<note>
4915	If the medium is being attached indirectly, a new differencing medium
4916	will implicitly be created for it and attached instead. If the
4917	changes made to the machine settings (including this indirect
4918	attachment) are later cancelled using <link to="#discardSettings"/>,
4919	this implicitly created differencing medium will implicitly
4920	be deleted.
4921	</note>
4922
4923	<result name="E_INVALIDARG">
4924	SATA device, SATA port, IDE port or IDE slot out of range, or
4925	file or UUID not found.
4926	</result>
4927	<result name="VBOX_E_INVALID_OBJECT_STATE">
4928	Machine must be registered before media can be attached.
4929	</result>
4930	<result name="VBOX_E_INVALID_VM_STATE">
4931	Invalid machine state.
4932	</result>
4933	<result name="VBOX_E_OBJECT_IN_USE">
4934	A medium is already attached to this or another virtual machine.
4935	</result>
4936	</desc>
4937	<param name="name" type="wstring" dir="in">
4938	<desc>Name of the storage controller to attach the device to.</desc>
4939	</param>
4940	<param name="controllerPort" type="long" dir="in">
4941	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4942	the primary controller and 1 specifies the secondary controller.
4943	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4944	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4945	</param>
4946	<param name="device" type="long" dir="in">
4947	<desc>Device slot in the given port to attach the device to. This is only
4948	relevant for IDE controllers, for which 0 specifies the master device and
4949	1 specifies the slave device. For all other controller types, this must
4950	be 0.</desc>
4951	</param>
4952	<param name="type" type="DeviceType" dir="in">
4953	<desc>Device type of the attached device. For media opened by
4954	<link to="IVirtualBox::openMedium" />, this must match the device type
4955	specified there.</desc>
4956	</param>
4957	</method>
4958
4959	<method name="detachDevice">
4960	<desc>
4961	Detaches the device attached to a device slot of the specified bus.
4962
4963	Detaching the device from the virtual machine is deferred. This means
4964	that the medium remains associated with the machine when this method
4965	returns and gets actually de-associated only after a successful
4966	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4967	for more detailed information about attaching media.
4968
4969	<note>
4970	You cannot detach a device from a running machine.
4971	</note>
4972	<note>
4973	Detaching differencing media implicitly created by <link
4974	to="#attachDevice"/> for the indirect attachment using this
4975	method will <b>not</b> implicitly delete them. The
4976	<link to="IMedium::deleteStorage"/> operation should be
4977	explicitly performed by the caller after the medium is successfully
4978	detached and the settings are saved with
4979	<link to="#saveSettings"/>, if it is the desired action.
4980	</note>
4981
4982	<result name="VBOX_E_INVALID_VM_STATE">
4983	Attempt to detach medium from a running virtual machine.
4984	</result>
4985	<result name="VBOX_E_OBJECT_NOT_FOUND">
4986	No medium attached to given slot/bus.
4987	</result>
4988	<result name="VBOX_E_NOT_SUPPORTED">
4989	Medium format does not support storage deletion (only for implicitly
4990	created differencing media, should not happen).
4991	</result>
4992
4993	</desc>
4994	<param name="name" type="wstring" dir="in">
4995	<desc>Name of the storage controller to detach the medium from.</desc>
4996	</param>
4997	<param name="controllerPort" type="long" dir="in">
4998	<desc>Port number to detach the medium from.</desc>
4999	</param>
5000	<param name="device" type="long" dir="in">
5001	<desc>Device slot number to detach the medium from.</desc>
5002	</param>
5003	</method>
5004
5005	<method name="passthroughDevice">
5006	<desc>
5007	Sets the passthrough mode of an existing DVD device. Changing the
5008	setting while the VM is running is forbidden. The setting is only used
5009	if at VM start the device is configured as a host DVD drive, in all
5010	other cases it is ignored. The device must already exist; see
5011	<link to="IMachine::attachDevice"/> for how to attach a new device.
5012
5013	The @a controllerPort and @a device parameters specify the device slot and
5014	have have the same meaning as with <link to="IMachine::attachDevice" />.
5015
5016	<result name="E_INVALIDARG">
5017	SATA device, SATA port, IDE port or IDE slot out of range.
5018	</result>
5019	<result name="VBOX_E_INVALID_OBJECT_STATE">
5020	Attempt to modify an unregistered virtual machine.
5021	</result>
5022	<result name="VBOX_E_INVALID_VM_STATE">
5023	Invalid machine state.
5024	</result>
5025
5026	</desc>
5027	<param name="name" type="wstring" dir="in">
5028	<desc>Name of the storage controller.</desc>
5029	</param>
5030	<param name="controllerPort" type="long" dir="in">
5031	<desc>Storage controller port.</desc>
5032	</param>
5033	<param name="device" type="long" dir="in">
5034	<desc>Device slot in the given port.</desc>
5035	</param>
5036	<param name="passthrough" type="boolean" dir="in">
5037	<desc>New value for the passthrough setting.</desc>
5038	</param>
5039	</method>
5040
5041	<method name="temporaryEjectDevice">
5042	<desc>
5043	Sets the behavior for guest-triggered medium eject. In some situations
5044	it is desirable that such ejects update the VM configuration, and in
5045	others the eject should keep the VM configuration. The device must
5046	already exist; see <link to="IMachine::attachDevice"/> for how to
5047	attach a new device.
5048
5049	The @a controllerPort and @a device parameters specify the device slot and
5050	have have the same meaning as with <link to="IMachine::attachDevice" />.
5051
5052	<result name="E_INVALIDARG">
5053	SATA device, SATA port, IDE port or IDE slot out of range.
5054	</result>
5055	<result name="VBOX_E_INVALID_OBJECT_STATE">
5056	Attempt to modify an unregistered virtual machine.
5057	</result>
5058	<result name="VBOX_E_INVALID_VM_STATE">
5059	Invalid machine state.
5060	</result>
5061
5062	</desc>
5063	<param name="name" type="wstring" dir="in">
5064	<desc>Name of the storage controller.</desc>
5065	</param>
5066	<param name="controllerPort" type="long" dir="in">
5067	<desc>Storage controller port.</desc>
5068	</param>
5069	<param name="device" type="long" dir="in">
5070	<desc>Device slot in the given port.</desc>
5071	</param>
5072	<param name="temporaryEject" type="boolean" dir="in">
5073	<desc>New value for the eject behavior.</desc>
5074	</param>
5075	</method>
5076
5077	<method name="nonRotationalDevice">
5078	<desc>
5079	Sets a flag in the device information which indicates that the medium
5080	is not based on rotational technology, i.e. that the access times are
5081	more or less independent of the position on the medium. This may or may
5082	not be supported by a particular drive, and is silently ignored in the
5083	latter case. At the moment only hard disks (which is a misnomer in this
5084	context) accept this setting. Changing the setting while the VM is
5085	running is forbidden. The device must already exist; see
5086	<link to="IMachine::attachDevice"/> for how to attach a new device.
5087
5088	The @a controllerPort and @a device parameters specify the device slot and
5089	have have the same meaning as with <link to="IMachine::attachDevice" />.
5090
5091	<result name="E_INVALIDARG">
5092	SATA device, SATA port, IDE port or IDE slot out of range.
5093	</result>
5094	<result name="VBOX_E_INVALID_OBJECT_STATE">
5095	Attempt to modify an unregistered virtual machine.
5096	</result>
5097	<result name="VBOX_E_INVALID_VM_STATE">
5098	Invalid machine state.
5099	</result>
5100
5101	</desc>
5102	<param name="name" type="wstring" dir="in">
5103	<desc>Name of the storage controller.</desc>
5104	</param>
5105	<param name="controllerPort" type="long" dir="in">
5106	<desc>Storage controller port.</desc>
5107	</param>
5108	<param name="device" type="long" dir="in">
5109	<desc>Device slot in the given port.</desc>
5110	</param>
5111	<param name="nonRotational" type="boolean" dir="in">
5112	<desc>New value for the non-rotational device flag.</desc>
5113	</param>
5114	</method>
5115
5116	<method name="setAutoDiscardForDevice">
5117	<desc>
5118	Sets a flag in the device information which indicates that the medium
5119	supports discarding unsused blocks (called trimming for SATA or unmap
5120	for SCSI devices) .This may or may not be supported by a particular drive,
5121	and is silently ignored in the latter case. At the moment only hard disks
5122	(which is a misnomer in this context) accept this setting. Changing the
5123	setting while the VM is running is forbidden. The device must already
5124	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
5125	device.
5126
5127	The @a controllerPort and @a device parameters specify the device slot and
5128	have have the same meaning as with <link to="IMachine::attachDevice" />.
5129
5130	<result name="E_INVALIDARG">
5131	SATA device, SATA port, SCSI port out of range.
5132	</result>
5133	<result name="VBOX_E_INVALID_OBJECT_STATE">
5134	Attempt to modify an unregistered virtual machine.
5135	</result>
5136	<result name="VBOX_E_INVALID_VM_STATE">
5137	Invalid machine state.
5138	</result>
5139
5140	</desc>
5141	<param name="name" type="wstring" dir="in">
5142	<desc>Name of the storage controller.</desc>
5143	</param>
5144	<param name="controllerPort" type="long" dir="in">
5145	<desc>Storage controller port.</desc>
5146	</param>
5147	<param name="device" type="long" dir="in">
5148	<desc>Device slot in the given port.</desc>
5149	</param>
5150	<param name="discard" type="boolean" dir="in">
5151	<desc>New value for the discard device flag.</desc>
5152	</param>
5153	</method>
5154
5155	<method name="setBandwidthGroupForDevice">
5156	<desc>
5157	Sets the bandwidth group of an existing storage device.
5158	The device must already exist; see <link to="IMachine::attachDevice"/>
5159	for how to attach a new device.
5160
5161	The @a controllerPort and @a device parameters specify the device slot and
5162	have have the same meaning as with <link to="IMachine::attachDevice" />.
5163
5164	<result name="E_INVALIDARG">
5165	SATA device, SATA port, IDE port or IDE slot out of range.
5166	</result>
5167	<result name="VBOX_E_INVALID_OBJECT_STATE">
5168	Attempt to modify an unregistered virtual machine.
5169	</result>
5170	<result name="VBOX_E_INVALID_VM_STATE">
5171	Invalid machine state.
5172	</result>
5173
5174	</desc>
5175	<param name="name" type="wstring" dir="in">
5176	<desc>Name of the storage controller.</desc>
5177	</param>
5178	<param name="controllerPort" type="long" dir="in">
5179	<desc>Storage controller port.</desc>
5180	</param>
5181	<param name="device" type="long" dir="in">
5182	<desc>Device slot in the given port.</desc>
5183	</param>
5184	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
5185	<desc>New value for the bandwidth group or @c null for no group.</desc>
5186	</param>
5187	</method>
5188
5189	<method name="setNoBandwidthGroupForDevice">
5190	<desc>
5191	Sets no bandwidth group for an existing storage device.
5192	The device must already exist; see <link to="IMachine::attachDevice"/>
5193	for how to attach a new device.
5194	The @a controllerPort and @a device parameters specify the device slot and
5195	have have the same meaning as with <link to="IMachine::attachDevice" />.
5196	<result name="E_INVALIDARG">
5197	SATA device, SATA port, IDE port or IDE slot out of range.
5198	</result>
5199	<result name="VBOX_E_INVALID_OBJECT_STATE">
5200	Attempt to modify an unregistered virtual machine.
5201	</result>
5202	<result name="VBOX_E_INVALID_VM_STATE">
5203	Invalid machine state.
5204	</result>
5205
5206	</desc>
5207	<param name="name" type="wstring" dir="in">
5208	<desc>Name of the storage controller.</desc>
5209	</param>
5210	<param name="controllerPort" type="long" dir="in">
5211	<desc>Storage controller port.</desc>
5212	</param>
5213	<param name="device" type="long" dir="in">
5214	<desc>Device slot in the given port.</desc>
5215	</param>
5216	</method>
5217
5218
5219	<method name="unmountMedium">
5220	<desc>
5221	Unmounts any currently mounted medium (<link to="IMedium" />,
5222	identified by the given UUID @a id) to the given storage controller
5223	(<link to="IStorageController" />, identified by @a name),
5224	at the indicated port and device. The device must already exist;
5225
5226	This method is intended only for managing removable media, where the
5227	device is fixed but media is changeable at runtime (such as DVDs
5228	and floppies). It cannot be used for fixed media such as hard disks.
5229
5230	The @a controllerPort and @a device parameters specify the device slot
5231	and have have the same meaning as with
5232	<link to="IMachine::attachDevice" />.
5233
5234	The specified device slot must have a medium mounted, which will be
5235	unmounted. If there is no mounted medium it will do nothing.
5236	See <link to="IMedium"/> for more detailed information about
5237	attaching/unmounting media.
5238
5239	<result name="E_INVALIDARG">
5240	SATA device, SATA port, IDE port or IDE slot out of range.
5241	</result>
5242	<result name="VBOX_E_INVALID_OBJECT_STATE">
5243	Attempt to unmount medium that is not removeable - not dvd or floppy.
5244	</result>
5245	<result name="VBOX_E_INVALID_VM_STATE">
5246	Invalid machine state.
5247	</result>
5248	<result name="VBOX_E_OBJECT_IN_USE">
5249	Medium already attached to this or another virtual machine.
5250	</result>
5251	<result name="VBOX_E_OBJECT_NOT_FOUND">
5252	Medium not attached to specified port, device, controller.
5253	</result>
5254
5255	</desc>
5256	<param name="name" type="wstring" dir="in">
5257	<desc>Name of the storage controller to unmount the medium from.</desc>
5258	</param>
5259	<param name="controllerPort" type="long" dir="in">
5260	<desc>Port to unmount the medium from.</desc>
5261	</param>
5262	<param name="device" type="long" dir="in">
5263	<desc>Device slot in the given port to unmount the medium from.</desc>
5264	</param>
5265	<param name="force" type="boolean" dir="in">
5266	<desc>Allows to force unmount of a medium which is locked by
5267	the device slot in the given port medium is attached to.</desc>
5268	</param>
5269	</method>
5270
5271	<method name="mountMedium">
5272	<desc>
5273	Mounts a medium (<link to="IMedium" />, identified
5274	by the given UUID @a id) to the given storage controller
5275	(<link to="IStorageController" />, identified by @a name),
5276	at the indicated port and device. The device must already exist;
5277	see <link to="IMachine::attachDevice"/> for how to attach a new device.
5278
5279	This method is intended only for managing removable media, where the
5280	device is fixed but media is changeable at runtime (such as DVDs
5281	and floppies). It cannot be used for fixed media such as hard disks.
5282
5283	The @a controllerPort and @a device parameters specify the device slot and
5284	have have the same meaning as with <link to="IMachine::attachDevice" />.
5285
5286	The specified device slot can have a medium mounted, which will be
5287	unmounted first. Specifying a zero UUID (or an empty string) for
5288	@a medium does just an unmount.
5289
5290	See <link to="IMedium"/> for more detailed information about
5291	attaching media.
5292
5293	<result name="E_INVALIDARG">
5294	SATA device, SATA port, IDE port or IDE slot out of range.
5295	</result>
5296	<result name="VBOX_E_INVALID_OBJECT_STATE">
5297	Attempt to attach medium to an unregistered virtual machine.
5298	</result>
5299	<result name="VBOX_E_INVALID_VM_STATE">
5300	Invalid machine state.
5301	</result>
5302	<result name="VBOX_E_OBJECT_IN_USE">
5303	Medium already attached to this or another virtual machine.
5304	</result>
5305
5306	</desc>
5307	<param name="name" type="wstring" dir="in">
5308	<desc>Name of the storage controller to attach the medium to.</desc>
5309	</param>
5310	<param name="controllerPort" type="long" dir="in">
5311	<desc>Port to attach the medium to.</desc>
5312	</param>
5313	<param name="device" type="long" dir="in">
5314	<desc>Device slot in the given port to attach the medium to.</desc>
5315	</param>
5316	<param name="medium" type="IMedium" dir="in">
5317	<desc>Medium to mount or @c null for an empty drive.</desc>
5318	</param>
5319	<param name="force" type="boolean" dir="in">
5320	<desc>Allows to force unmount/mount of a medium which is locked by
5321	the device slot in the given port to attach the medium to.</desc>
5322	</param>
5323	</method>
5324
5325	<method name="getMedium" const="yes">
5326	<desc>
5327	Returns the virtual medium attached to a device slot of the specified
5328	bus.
5329
5330	Note that if the medium was indirectly attached by
5331	<link to="#mountMedium"/> to the given device slot then this
5332	method will return not the same object as passed to the
5333	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5334	more detailed information about mounting a medium.
5335
5336	<result name="VBOX_E_OBJECT_NOT_FOUND">
5337	No medium attached to given slot/bus.
5338	</result>
5339
5340	</desc>
5341	<param name="name" type="wstring" dir="in">
5342	<desc>Name of the storage controller the medium is attached to.</desc>
5343	</param>
5344	<param name="controllerPort" type="long" dir="in">
5345	<desc>Port to query.</desc>
5346	</param>
5347	<param name="device" type="long" dir="in">
5348	<desc>Device slot in the given port to query.</desc>
5349	</param>
5350	<param name="medium" type="IMedium" dir="return">
5351	<desc>Attached medium object.</desc>
5352	</param>
5353	</method>
5354
5355	<method name="getMediumAttachmentsOfController" const="yes">
5356	<desc>
5357	Returns an array of medium attachments which are attached to the
5358	the controller with the given name.
5359
5360	<result name="VBOX_E_OBJECT_NOT_FOUND">
5361	A storage controller with given name doesn't exist.
5362	</result>
5363	</desc>
5364	<param name="name" type="wstring" dir="in"/>
5365	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5366	</method>
5367
5368	<method name="getMediumAttachment" const="yes">
5369	<desc>
5370	Returns a medium attachment which corresponds to the controller with
5371	the given name, on the given port and device slot.
5372
5373	<result name="VBOX_E_OBJECT_NOT_FOUND">
5374	No attachment exists for the given controller/port/device combination.
5375	</result>
5376	</desc>
5377	<param name="name" type="wstring" dir="in"/>
5378	<param name="controllerPort" type="long" dir="in"/>
5379	<param name="device" type="long" dir="in"/>
5380	<param name="attachment" type="IMediumAttachment" dir="return"/>
5381	</method>
5382
5383	<method name="attachHostPCIDevice">
5384	<desc>
5385	Attaches host PCI device with the given (host) PCI address to the
5386	PCI bus of the virtual machine. Please note, that this operation
5387	is two phase, as real attachment will happen when VM will start,
5388	and most information will be delivered as IHostPCIDevicePlugEvent
5389	on IVirtualBox event source.
5390
5391	<see><link to="IHostPCIDevicePlugEvent"/></see>
5392
5393	<result name="VBOX_E_INVALID_VM_STATE">
5394	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5395	</result>
5396	<result name="VBOX_E_PDM_ERROR">
5397	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5398	</result>
5399	<result name="VBOX_E_NOT_SUPPORTED">
5400	Hardware or host OS doesn't allow PCI device passthrought.
5401	</result>
5402	</desc>
5403	<param name="hostAddress" type="long" dir="in">
5404	<desc>Address of the host PCI device.</desc>
5405	</param>
5406	<param name="desiredGuestAddress" type="long" dir="in">
5407	<desc>Desired position of this device on guest PCI bus.</desc>
5408	</param>
5409	<param name="tryToUnbind" type="boolean" dir="in">
5410	<desc>If VMM shall try to unbind existing drivers from the
5411	device before attaching it to the guest.</desc>
5412	</param>
5413	</method>
5414
5415	<method name="detachHostPCIDevice">
5416	<desc>
5417	Detach host PCI device from the virtual machine.
5418	Also HostPCIDevicePlugEvent on IVirtualBox event source
5419	will be delivered. As currently we don't support hot device
5420	unplug, IHostPCIDevicePlugEvent event is delivered immediately.
5421
5422	<see><link to="IHostPCIDevicePlugEvent"/></see>
5423
5424	<result name="VBOX_E_INVALID_VM_STATE">
5425	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5426	</result>
5427	<result name="VBOX_E_OBJECT_NOT_FOUND">
5428	This host device is not attached to this machine.
5429	</result>
5430	<result name="VBOX_E_PDM_ERROR">
5431	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5432	</result>
5433	<result name="VBOX_E_NOT_SUPPORTED">
5434	Hardware or host OS doesn't allow PCI device passthrought.
5435	</result>
5436	</desc>
5437	<param name="hostAddress" type="long" dir="in">
5438	<desc>Address of the host PCI device.</desc>
5439	</param>
5440	</method>
5441
5442	<method name="getNetworkAdapter" const="yes">
5443	<desc>
5444	Returns the network adapter associated with the given slot.
5445	Slots are numbered sequentially, starting with zero. The total
5446	number of adapters per machine is defined by the
5447	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5448	so the maximum slot number is one less than that property's value.
5449
5450	<result name="E_INVALIDARG">
5451	Invalid @a slot number.
5452	</result>
5453
5454	</desc>
5455	<param name="slot" type="unsigned long" dir="in"/>
5456	<param name="adapter" type="INetworkAdapter" dir="return"/>
5457	</method>
5458
5459	<method name="addStorageController">
5460	<desc>
5461	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5462	machine and returns it as an instance of
5463	<link to="IStorageController" />.
5464
5465	@a name identifies the controller for subsequent calls such as
5466	<link to="#getStorageControllerByName" />,
5467	<link to="#getStorageControllerByInstance" />,
5468	<link to="#removeStorageController" />,
5469	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5470
5471	After the controller has been added, you can set its exact
5472	type by setting the <link to="IStorageController::controllerType" />.
5473
5474	<result name="VBOX_E_OBJECT_IN_USE">
5475	A storage controller with given name exists already.
5476	</result>
5477	<result name="E_INVALIDARG">
5478	Invalid @a controllerType.
5479	</result>
5480	</desc>
5481	<param name="name" type="wstring" dir="in"/>
5482	<param name="connectionType" type="StorageBus" dir="in"/>
5483	<param name="controller" type="IStorageController" dir="return"/>
5484	</method>
5485
5486	<method name="getStorageControllerByName" const="yes">
5487	<desc>
5488	Returns a storage controller with the given name.
5489
5490	<result name="VBOX_E_OBJECT_NOT_FOUND">
5491	A storage controller with given name doesn't exist.
5492	</result>
5493	</desc>
5494	<param name="name" type="wstring" dir="in"/>
5495	<param name="storageController" type="IStorageController" dir="return"/>
5496	</method>
5497
5498	<method name="getStorageControllerByInstance" const="yes">
5499	<desc>
5500	Returns a storage controller with the given instance number.
5501
5502	<result name="VBOX_E_OBJECT_NOT_FOUND">
5503	A storage controller with given instance number doesn't exist.
5504	</result>
5505	</desc>
5506	<param name="instance" type="unsigned long" dir="in"/>
5507	<param name="storageController" type="IStorageController" dir="return"/>
5508	</method>
5509
5510	<method name="removeStorageController">
5511	<desc>
5512	Removes a storage controller from the machine with all devices attached to it.
5513
5514	<result name="VBOX_E_OBJECT_NOT_FOUND">
5515	A storage controller with given name doesn't exist.
5516	</result>
5517	<result name="VBOX_E_NOT_SUPPORTED">
5518	Medium format does not support storage deletion (only for implicitly
5519	created differencing media, should not happen).
5520	</result>
5521	</desc>
5522	<param name="name" type="wstring" dir="in"/>
5523	</method>
5524
5525	<method name="setStorageControllerBootable">
5526	<desc>
5527	Sets the bootable flag of the storage controller with the given name.
5528
5529	<result name="VBOX_E_OBJECT_NOT_FOUND">
5530	A storage controller with given name doesn't exist.
5531	</result>
5532	<result name="VBOX_E_OBJECT_IN_USE">
5533	Another storage controller is marked as bootable already.
5534	</result>
5535	</desc>
5536	<param name="name" type="wstring" dir="in"/>
5537	<param name="bootable" type="boolean" dir="in"/>
5538	</method>
5539
5540	<method name="getSerialPort" const="yes">
5541	<desc>
5542	Returns the serial port associated with the given slot.
5543	Slots are numbered sequentially, starting with zero. The total
5544	number of serial ports per machine is defined by the
5545	<link to="ISystemProperties::serialPortCount"/> property,
5546	so the maximum slot number is one less than that property's value.
5547
5548	<result name="E_INVALIDARG">
5549	Invalid @a slot number.
5550	</result>
5551
5552	</desc>
5553	<param name="slot" type="unsigned long" dir="in"/>
5554	<param name="port" type="ISerialPort" dir="return"/>
5555	</method>
5556
5557	<method name="getParallelPort" const="yes">
5558	<desc>
5559	Returns the parallel port associated with the given slot.
5560	Slots are numbered sequentially, starting with zero. The total
5561	number of parallel ports per machine is defined by the
5562	<link to="ISystemProperties::parallelPortCount"/> property,
5563	so the maximum slot number is one less than that property's value.
5564
5565	<result name="E_INVALIDARG">
5566	Invalid @a slot number.
5567	</result>
5568
5569	</desc>
5570	<param name="slot" type="unsigned long" dir="in"/>
5571	<param name="port" type="IParallelPort" dir="return"/>
5572	</method>
5573
5574	<method name="getExtraDataKeys">
5575	<desc>
5576	Returns an array representing the machine-specific extra data keys
5577	which currently have values defined.
5578	</desc>
5579	<param name="value" type="wstring" dir="return" safearray="yes">
5580	<desc>Array of extra data keys.</desc>
5581	</param>
5582	</method>
5583
5584	<method name="getExtraData">
5585	<desc>
5586	Returns associated machine-specific extra data.
5587
5588	If the requested data @a key does not exist, this function will
5589	succeed and return an empty string in the @a value argument.
5590
5591	<result name="VBOX_E_FILE_ERROR">
5592	Settings file not accessible.
5593	</result>
5594	<result name="VBOX_E_XML_ERROR">
5595	Could not parse the settings file.
5596	</result>
5597
5598	</desc>
5599	<param name="key" type="wstring" dir="in">
5600	<desc>Name of the data key to get.</desc>
5601	</param>
5602	<param name="value" type="wstring" dir="return">
5603	<desc>Value of the requested data key.</desc>
5604	</param>
5605	</method>
5606
5607	<method name="setExtraData">
5608	<desc>
5609	Sets associated machine-specific extra data.
5610
5611	If you pass @c null or an empty string as a key @a value, the given
5612	@a key will be deleted.
5613
5614	<note>
5615	Before performing the actual data change, this method will ask all
5616	registered listeners using the
5617	<link to="IExtraDataCanChangeEvent"/>
5618	notification for a permission. If one of the listeners refuses the
5619	new value, the change will not be performed.
5620	</note>
5621	<note>
5622	On success, the
5623	<link to="IExtraDataChangedEvent"/> notification
5624	is called to inform all registered listeners about a successful data
5625	change.
5626	</note>
5627	<note>
5628	This method can be called outside the machine session and therefore
5629	it's a caller's responsibility to handle possible race conditions
5630	when several clients change the same key at the same time.
5631	</note>
5632
5633	<result name="VBOX_E_FILE_ERROR">
5634	Settings file not accessible.
5635	</result>
5636	<result name="VBOX_E_XML_ERROR">
5637	Could not parse the settings file.
5638	</result>
5639
5640	</desc>
5641	<param name="key" type="wstring" dir="in">
5642	<desc>Name of the data key to set.</desc>
5643	</param>
5644	<param name="value" type="wstring" dir="in">
5645	<desc>Value to assign to the key.</desc>
5646	</param>
5647	</method>
5648
5649	<method name="getCPUProperty" const="yes">
5650	<desc>
5651	Returns the virtual CPU boolean value of the specified property.
5652
5653	<result name="E_INVALIDARG">
5654	Invalid property.
5655	</result>
5656
5657	</desc>
5658	<param name="property" type="CPUPropertyType" dir="in">
5659	<desc>
5660	Property type to query.
5661	</desc>
5662	</param>
5663	<param name="value" type="boolean" dir="return">
5664	<desc>
5665	Property value.
5666	</desc>
5667	</param>
5668	</method>
5669
5670	<method name="setCPUProperty">
5671	<desc>
5672	Sets the virtual CPU boolean value of the specified property.
5673
5674	<result name="E_INVALIDARG">
5675	Invalid property.
5676	</result>
5677
5678	</desc>
5679	<param name="property" type="CPUPropertyType" dir="in">
5680	<desc>
5681	Property type to query.
5682	</desc>
5683	</param>
5684	<param name="value" type="boolean" dir="in">
5685	<desc>
5686	Property value.
5687	</desc>
5688	</param>
5689	</method>
5690
5691	<method name="getCPUIDLeaf" const="yes">
5692	<desc>
5693	Returns the virtual CPU cpuid information for the specified leaf.
5694
5695	Currently supported index values for cpuid:
5696	Standard CPUID leafs: 0 - 0xA
5697	Extended CPUID leafs: 0x80000000 - 0x8000000A
5698
5699	See the Intel and AMD programmer's manuals for detailed information
5700	about the cpuid instruction and its leafs.
5701	<result name="E_INVALIDARG">
5702	Invalid id.
5703	</result>
5704
5705	</desc>
5706	<param name="id" type="unsigned long" dir="in">
5707	<desc>
5708	CPUID leaf index.
5709	</desc>
5710	</param>
5711	<param name="valEax" type="unsigned long" dir="out">
5712	<desc>
5713	CPUID leaf value for register eax.
5714	</desc>
5715	</param>
5716	<param name="valEbx" type="unsigned long" dir="out">
5717	<desc>
5718	CPUID leaf value for register ebx.
5719	</desc>
5720	</param>
5721	<param name="valEcx" type="unsigned long" dir="out">
5722	<desc>
5723	CPUID leaf value for register ecx.
5724	</desc>
5725	</param>
5726	<param name="valEdx" type="unsigned long" dir="out">
5727	<desc>
5728	CPUID leaf value for register edx.
5729	</desc>
5730	</param>
5731	</method>
5732
5733	<method name="setCPUIDLeaf">
5734	<desc>
5735	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5736	are not passed unmodified. VirtualBox clears features that it doesn't support.
5737
5738	Currently supported index values for cpuid:
5739	Standard CPUID leafs: 0 - 0xA
5740	Extended CPUID leafs: 0x80000000 - 0x8000000A
5741
5742	See the Intel and AMD programmer's manuals for detailed information
5743	about the cpuid instruction and its leafs.
5744
5745	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5746	random crashes inside VMs.
5747	<result name="E_INVALIDARG">
5748	Invalid id.
5749	</result>
5750
5751	</desc>
5752	<param name="id" type="unsigned long" dir="in">
5753	<desc>
5754	CPUID leaf index.
5755	</desc>
5756	</param>
5757	<param name="valEax" type="unsigned long" dir="in">
5758	<desc>
5759	CPUID leaf value for register eax.
5760	</desc>
5761	</param>
5762	<param name="valEbx" type="unsigned long" dir="in">
5763	<desc>
5764	CPUID leaf value for register ebx.
5765	</desc>
5766	</param>
5767	<param name="valEcx" type="unsigned long" dir="in">
5768	<desc>
5769	CPUID leaf value for register ecx.
5770	</desc>
5771	</param>
5772	<param name="valEdx" type="unsigned long" dir="in">
5773	<desc>
5774	CPUID leaf value for register edx.
5775	</desc>
5776	</param>
5777	</method>
5778
5779	<method name="removeCPUIDLeaf">
5780	<desc>
5781	Removes the virtual CPU cpuid leaf for the specified index
5782
5783	<result name="E_INVALIDARG">
5784	Invalid id.
5785	</result>
5786
5787	</desc>
5788	<param name="id" type="unsigned long" dir="in">
5789	<desc>
5790	CPUID leaf index.
5791	</desc>
5792	</param>
5793	</method>
5794
5795	<method name="removeAllCPUIDLeaves">
5796	<desc>
5797	Removes all the virtual CPU cpuid leaves
5798	</desc>
5799	</method>
5800
5801	<method name="getHWVirtExProperty" const="yes">
5802	<desc>
5803	Returns the value of the specified hardware virtualization boolean property.
5804
5805	<result name="E_INVALIDARG">
5806	Invalid property.
5807	</result>
5808
5809	</desc>
5810	<param name="property" type="HWVirtExPropertyType" dir="in">
5811	<desc>
5812	Property type to query.
5813	</desc>
5814	</param>
5815	<param name="value" type="boolean" dir="return">
5816	<desc>
5817	Property value.
5818	</desc>
5819	</param>
5820	</method>
5821
5822	<method name="setHWVirtExProperty">
5823	<desc>
5824	Sets a new value for the specified hardware virtualization boolean property.
5825
5826	<result name="E_INVALIDARG">
5827	Invalid property.
5828	</result>
5829
5830	</desc>
5831	<param name="property" type="HWVirtExPropertyType" dir="in">
5832	<desc>
5833	Property type to set.
5834	</desc>
5835	</param>
5836	<param name="value" type="boolean" dir="in">
5837	<desc>
5838	New property value.
5839	</desc>
5840	</param>
5841	</method>
5842
5843	<method name="saveSettings">
5844	<desc>
5845	Saves any changes to machine settings made since the session
5846	has been opened or a new machine has been created, or since the
5847	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5848	For registered machines, new settings become visible to all
5849	other VirtualBox clients after successful invocation of this
5850	method.
5851	<note>
5852	The method sends <link to="IMachineDataChangedEvent"/>
5853	notification event after the configuration has been successfully
5854	saved (only for registered machines).
5855	</note>
5856	<note>
5857	Calling this method is only valid on instances returned
5858	by <link to="ISession::machine"/> and on new machines
5859	created by <link to="IVirtualBox::createMachine"/> but not
5860	yet registered, or on unregistered machines after calling
5861	<link to="IMachine::unregister"/>.
5862	</note>
5863
5864	<result name="VBOX_E_FILE_ERROR">
5865	Settings file not accessible.
5866	</result>
5867	<result name="VBOX_E_XML_ERROR">
5868	Could not parse the settings file.
5869	</result>
5870	<result name="E_ACCESSDENIED">
5871	Modification request refused.
5872	</result>
5873
5874	</desc>
5875	</method>
5876
5877	<method name="discardSettings">
5878	<desc>
5879	Discards any changes to the machine settings made since the session
5880	has been opened or since the last call to <link to="#saveSettings"/>
5881	or <link to="#discardSettings"/>.
5882	<note>
5883	Calling this method is only valid on instances returned
5884	by <link to="ISession::machine"/> and on new machines
5885	created by <link to="IVirtualBox::createMachine"/> or
5886	opened by <link to="IVirtualBox::openMachine"/> but not
5887	yet registered, or on unregistered machines after calling
5888	<link to="IMachine::unregister"/>.
5889	</note>
5890
5891	<result name="VBOX_E_INVALID_VM_STATE">
5892	Virtual machine is not mutable.
5893	</result>
5894
5895	</desc>
5896	</method>
5897
5898	<method name="unregister">
5899	<desc>
5900	Unregisters a machine previously registered with
5901	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5902	cleanup before the machine is unregistered.
5903
5904	This method does not delete any files. It only changes the machine configuration and
5905	the list of registered machines in the VirtualBox object. To delete the files which
5906	belonged to the machine, including the XML file of the machine itself, call
5907	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5908	from this method.
5909
5910	How thoroughly this method cleans up the machine configuration before unregistering
5911	the machine depends on the @a cleanupMode argument.
5912
5913	<ul>
5914	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5915	cleanup will be performed. The call will fail if the machine is in "Saved" state
5916	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5917	It is the responsibility of the caller to delete all such configuration in this mode.
5918	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5919	which it replaces.</li>
5920	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5921	state or if it has snapshots or media attached. All media attached to the current machine
5922	state or in snapshots will be detached. No medium objects will be returned;
5923	all of the machine's media will remain open.</li>
5924	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5925	except that all the hard disk medium objects which were detached from the machine will
5926	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5927	API for closing and deletion.</li>
5928	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5929	that all media will be returned in the array, including removable media like DVDs and
5930	floppies. This might be useful if the user wants to inspect in detail which media were
5931	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5932	in that case because users will typically want to preserve ISO and RAW image files.</li>
5933	</ul>
5934
5935	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5936	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5937	deleted with all its saved states and hard disk images, but images for removable
5938	drives (such as ISO and RAW files) will remain on disk.
5939
5940	This API does not verify whether the media files returned in the array are still
5941	attached to other machines (i.e. shared between several machines). If such a shared
5942	image is passed to <link to="#delete" /> however, closing the image will fail there
5943	and the image will be silently skipped.
5944
5945	This API may, however, move media from this machine's media registry to other media
5946	registries (see <link to="IMedium" /> for details on media registries). For machines
5947	created with VirtualBox 4.0 or later, if media from this machine's media registry
5948	are also attached to another machine (shared attachments), each such medium will be
5949	moved to another machine's registry. This is because without this machine's media
5950	registry, the other machine cannot find its media any more and would become inaccessible.
5951
5952	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5953	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5954	if media are moved to other machines' media registries.
5955
5956	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5957	is fired.
5958
5959	The call will fail if the machine is currently locked (see <link to="ISession" />).
5960
5961	<note>
5962	If the given machine is inaccessible (see <link to="#accessible"/>), it
5963	will be unregistered and fully uninitialized right afterwards. As a result,
5964	the returned machine object will be unusable and an attempt to call
5965	<b>any</b> method will return the "Object not ready" error.
5966	</note>
5967
5968	<result name="VBOX_E_INVALID_OBJECT_STATE">
5969	Machine is currently locked for a session.
5970	</result>
5971	</desc>
5972
5973	<param name="cleanupMode" type="CleanupMode" dir="in">
5974	<desc>How to clean up after the machine has been unregistered.</desc>
5975	</param>
5976	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5977	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5978	</param>
5979	</method>
5980
5981	<method name="delete">
5982	<desc>
5983	Deletes the files associated with this machine from disk. If medium objects are passed
5984	in with the @a aMedia argument, they are closed and, if closing was successful, their
5985	storage files are deleted as well. For convenience, this array of media files can be
5986	the same as the one returned from a previous <link to="#unregister" /> call.
5987
5988	This method must only be called on machines which are either write-locked (i.e. on instances
5989	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5990	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5991	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5992
5993	The following files will be deleted by this method:
5994	<ul>
5995	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5996	argument other than "UnregisterOnly", this will delete all saved state files that
5997	the machine had in use; possibly one if the machine was in "Saved" state and one
5998	for each online snapshot that the machine had.</li>
5999	<li>On each medium object passed in the @a aMedia array, this will call
6000	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
6001	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
6002	in use, e.g. because it is still attached to a second machine; in that case the
6003	storage will not be deleted.</li>
6004	<li>Finally, the machine's own XML file will be deleted.</li>
6005	</ul>
6006
6007	Since deleting large disk image files can be a time-consuming I/O operation, this
6008	method operates asynchronously and returns an IProgress object to allow the caller
6009	to monitor the progress. There will be one sub-operation for each file that is
6010	being deleted (saved state or medium storage file).
6011
6012	<note>
6013	<link to="#settingsModified"/> will return @c true after this
6014	method successfully returns.
6015	</note>
6016
6017	<result name="VBOX_E_INVALID_VM_STATE">
6018	Machine is registered but not write-locked.
6019	</result>
6020	<result name="VBOX_E_IPRT_ERROR">
6021	Could not delete the settings file.
6022	</result>
6023	</desc>
6024	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
6025	<desc>List of media to be closed and whose storage files will be deleted.</desc>
6026	</param>
6027	<param name="aProgress" type="IProgress" dir="return">
6028	<desc>Progress object to track the operation completion.</desc>
6029	</param>
6030	</method>
6031
6032	<method name="export">
6033	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
6034	steps required to export VirtualBox machines to OVF.
6035	</desc>
6036
6037	<param name="aAppliance" type="IAppliance" dir="in">
6038	<desc>Appliance to export this machine to.</desc>
6039	</param>
6040	<param name="location" type="wstring" dir="in">
6041	<desc>The target location.</desc>
6042	</param>
6043	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
6044	<desc>VirtualSystemDescription object which is created for this machine.</desc>
6045	</param>
6046	</method >
6047
6048	<method name="findSnapshot">
6049	<desc>
6050	Returns a snapshot of this machine with the given name or UUID.
6051
6052	Returns a snapshot of this machine with the given UUID.
6053	A @c null argument can be used to obtain the first snapshot
6054	taken on this machine. To traverse the whole tree of snapshots
6055	starting from the root, inspect the root snapshot's
6056	<link to="ISnapshot::children" /> attribute and recurse over those children.
6057
6058	<result name="VBOX_E_OBJECT_NOT_FOUND">
6059	Virtual machine has no snapshots or snapshot not found.
6060	</result>
6061
6062	</desc>
6063	<param name="nameOrId" type="wstring" dir="in">
6064	<desc>What to search for. Name or UUID of the snapshot to find</desc>
6065	</param>
6066	<param name="snapshot" type="ISnapshot" dir="return">
6067	<desc>Snapshot object with the given name.</desc>
6068	</param>
6069	</method>
6070
6071	<method name="createSharedFolder">
6072	<desc>
6073	Creates a new permanent shared folder by associating the given logical
6074	name with the given host path, adds it to the collection of shared
6075	folders and starts sharing it. Refer to the description of
6076	<link to="ISharedFolder"/> to read more about logical names.
6077
6078	<result name="VBOX_E_OBJECT_IN_USE">
6079	Shared folder already exists.
6080	</result>
6081	<result name="VBOX_E_FILE_ERROR">
6082	Shared folder @a hostPath not accessible.
6083	</result>
6084
6085	</desc>
6086	<param name="name" type="wstring" dir="in">
6087	<desc>Unique logical name of the shared folder.</desc>
6088	</param>
6089	<param name="hostPath" type="wstring" dir="in">
6090	<desc>Full path to the shared folder in the host file system.</desc>
6091	</param>
6092	<param name="writable" type="boolean" dir="in">
6093	<desc>Whether the share is writable or readonly.</desc>
6094	</param>
6095	<param name="automount" type="boolean" dir="in">
6096	<desc>Whether the share gets automatically mounted by the guest
6097	or not.</desc>
6098	</param>
6099	</method>
6100
6101	<method name="removeSharedFolder">
6102	<desc>
6103	Removes the permanent shared folder with the given name previously
6104	created by <link to="#createSharedFolder"/> from the collection of
6105	shared folders and stops sharing it.
6106
6107	<result name="VBOX_E_INVALID_VM_STATE">
6108	Virtual machine is not mutable.
6109	</result>
6110	<result name="VBOX_E_OBJECT_NOT_FOUND">
6111	Shared folder @a name does not exist.
6112	</result>
6113
6114	</desc>
6115	<param name="name" type="wstring" dir="in">
6116	<desc>Logical name of the shared folder to remove.</desc>
6117	</param>
6118	</method>
6119
6120	<method name="canShowConsoleWindow">
6121	<desc>
6122	Returns @c true if the VM console process can activate the
6123	console window and bring it to foreground on the desktop of
6124	the host PC.
6125	<note>
6126	This method will fail if a session for this machine is not
6127	currently open.
6128	</note>
6129
6130	<result name="VBOX_E_INVALID_VM_STATE">
6131	Machine session is not open.
6132	</result>
6133
6134	</desc>
6135	<param name="canShow" type="boolean" dir="return">
6136	<desc>
6137	@c true if the console window can be shown and @c false otherwise.
6138	</desc>
6139	</param>
6140	</method>
6141
6142	<method name="showConsoleWindow">
6143	<desc>
6144	Activates the console window and brings it to foreground on
6145	the desktop of the host PC. Many modern window managers on
6146	many platforms implement some sort of focus stealing
6147	prevention logic, so that it may be impossible to activate
6148	a window without the help of the currently active
6149	application. In this case, this method will return a non-zero
6150	identifier that represents the top-level window of the VM
6151	console process. The caller, if it represents a currently
6152	active process, is responsible to use this identifier (in a
6153	platform-dependent manner) to perform actual window
6154	activation.
6155	<note>
6156	This method will fail if a session for this machine is not
6157	currently open.
6158	</note>
6159
6160	<result name="VBOX_E_INVALID_VM_STATE">
6161	Machine session is not open.
6162	</result>
6163
6164	</desc>
6165	<param name="winId" type="long long" dir="return">
6166	<desc>
6167	Platform-dependent identifier of the top-level VM console
6168	window, or zero if this method has performed all actions
6169	necessary to implement the <i>show window</i> semantics for
6170	the given platform and/or VirtualBox front-end.
6171	</desc>
6172	</param>
6173	</method>
6174
6175	<method name="getGuestProperty" const="yes">
6176	<desc>
6177	Reads an entry from the machine's guest property store.
6178
6179	<result name="VBOX_E_INVALID_VM_STATE">
6180	Machine session is not open.
6181	</result>
6182
6183	</desc>
6184	<param name="name" type="wstring" dir="in">
6185	<desc>
6186	The name of the property to read.
6187	</desc>
6188	</param>
6189	<param name="value" type="wstring" dir="out">
6190	<desc>
6191	The value of the property. If the property does not exist then this
6192	will be empty.
6193	</desc>
6194	</param>
6195	<param name="timestamp" type="long long" dir="out">
6196	<desc>
6197	The time at which the property was last modified, as seen by the
6198	server process.
6199	</desc>
6200	</param>
6201	<param name="flags" type="wstring" dir="out">
6202	<desc>
6203	Additional property parameters, passed as a comma-separated list of
6204	"name=value" type entries.
6205	</desc>
6206	</param>
6207	</method>
6208
6209	<method name="getGuestPropertyValue" const="yes">
6210	<desc>
6211	Reads a value from the machine's guest property store.
6212
6213	<result name="VBOX_E_INVALID_VM_STATE">
6214	Machine session is not open.
6215	</result>
6216
6217	</desc>
6218	<param name="property" type="wstring" dir="in">
6219	<desc>
6220	The name of the property to read.
6221	</desc>
6222	</param>
6223	<param name="value" type="wstring" dir="return">
6224	<desc>
6225	The value of the property. If the property does not exist then this
6226	will be empty.
6227	</desc>
6228	</param>
6229	</method>
6230
6231	<method name="getGuestPropertyTimestamp" const="yes">
6232	<desc>
6233	Reads a property timestamp from the machine's guest property store.
6234
6235	<result name="VBOX_E_INVALID_VM_STATE">
6236	Machine session is not open.
6237	</result>
6238
6239	</desc>
6240	<param name="property" type="wstring" dir="in">
6241	<desc>
6242	The name of the property to read.
6243	</desc>
6244	</param>
6245	<param name="value" type="long long" dir="return">
6246	<desc>
6247	The timestamp. If the property does not exist then this will be
6248	empty.
6249	</desc>
6250	</param>
6251	</method>
6252
6253	<method name="setGuestProperty">
6254	<desc>
6255	Sets, changes or deletes an entry in the machine's guest property
6256	store.
6257
6258	<result name="E_ACCESSDENIED">
6259	Property cannot be changed.
6260	</result>
6261	<result name="E_INVALIDARG">
6262	Invalid @a flags.
6263	</result>
6264	<result name="VBOX_E_INVALID_VM_STATE">
6265	Virtual machine is not mutable or session not open.
6266	</result>
6267	<result name="VBOX_E_INVALID_OBJECT_STATE">
6268	Cannot set transient property when machine not running.
6269	</result>
6270
6271	</desc>
6272	<param name="property" type="wstring" dir="in">
6273	<desc>
6274	The name of the property to set, change or delete.
6275	</desc>
6276	</param>
6277	<param name="value" type="wstring" dir="in">
6278	<desc>
6279	The new value of the property to set, change or delete. If the
6280	property does not yet exist and value is non-empty, it will be
6281	created. If the value is @c null or empty, the property will be
6282	deleted if it exists.
6283	</desc>
6284	</param>
6285	<param name="flags" type="wstring" dir="in">
6286	<desc>
6287	Additional property parameters, passed as a comma-separated list of
6288	"name=value" type entries.
6289	</desc>
6290	</param>
6291	</method>
6292
6293	<method name="setGuestPropertyValue">
6294	<desc>
6295	Sets or changes a value in the machine's guest property
6296	store. The flags field will be left unchanged or created empty for a
6297	new property.
6298
6299	<result name="E_ACCESSDENIED">
6300	Property cannot be changed.
6301	</result>
6302	<result name="VBOX_E_INVALID_VM_STATE">
6303	Virtual machine is not mutable or session not open.
6304	</result>
6305	<result name="VBOX_E_INVALID_OBJECT_STATE">
6306	Cannot set transient property when machine not running.
6307	</result>
6308	</desc>
6309
6310	<param name="property" type="wstring" dir="in">
6311	<desc>
6312	The name of the property to set or change.
6313	</desc>
6314	</param>
6315	<param name="value" type="wstring" dir="in">
6316	<desc>
6317	The new value of the property to set or change. If the
6318	property does not yet exist and value is non-empty, it will be
6319	created.
6320	</desc>
6321	</param>
6322	</method>
6323
6324	<method name="deleteGuestProperty" const="yes">
6325	<desc>
6326	Deletes an entry from the machine's guest property store.
6327
6328	<result name="VBOX_E_INVALID_VM_STATE">
6329	Machine session is not open.
6330	</result>
6331
6332	</desc>
6333	<param name="name" type="wstring" dir="in">
6334	<desc>
6335	The name of the property to delete.
6336	</desc>
6337	</param>
6338	</method>
6339
6340	<method name="enumerateGuestProperties" const="yes">
6341	<desc>
6342	Return a list of the guest properties matching a set of patterns along
6343	with their values, time stamps and flags.
6344	</desc>
6345	<param name="patterns" type="wstring" dir="in">
6346	<desc>
6347	The patterns to match the properties against, separated by '\|'
6348	characters. If this is empty or @c null, all properties will match.
6349	</desc>
6350	</param>
6351	<param name="name" type="wstring" dir="out" safearray="yes">
6352	<desc>
6353	The names of the properties returned.
6354	</desc>
6355	</param>
6356	<param name="value" type="wstring" dir="out" safearray="yes">
6357	<desc>
6358	The values of the properties returned. The array entries match the
6359	corresponding entries in the @a name array.
6360	</desc>
6361	</param>
6362	<param name="timestamp" type="long long" dir="out" safearray="yes">
6363	<desc>
6364	The time stamps of the properties returned. The array entries match
6365	the corresponding entries in the @a name array.
6366	</desc>
6367	</param>
6368	<param name="flags" type="wstring" dir="out" safearray="yes">
6369	<desc>
6370	The flags of the properties returned. The array entries match the
6371	corresponding entries in the @a name array.
6372	</desc>
6373	</param>
6374	</method>
6375
6376	<method name="querySavedGuestScreenInfo" const="yes">
6377	<desc>
6378	Returns the guest dimensions from the saved state.
6379	</desc>
6380	<param name="screenId" type="unsigned long" dir="in">
6381	<desc>
6382	Saved guest screen to query info from.
6383	</desc>
6384	</param>
6385	<param name="originX" type="unsigned long" dir="out">
6386	<desc>
6387	The X position of the guest monitor top left corner.
6388	</desc>
6389	</param>
6390	<param name="originY" type="unsigned long" dir="out">
6391	<desc>
6392	The Y position of the guest monitor top left corner.
6393	</desc>
6394	</param>
6395	<param name="width" type="unsigned long" dir="out">
6396	<desc>
6397	Guest width at the time of the saved state was taken.
6398	</desc>
6399	</param>
6400	<param name="height" type="unsigned long" dir="out">
6401	<desc>
6402	Guest height at the time of the saved state was taken.
6403	</desc>
6404	</param>
6405	<param name="enabled" type="boolean" dir="out">
6406	<desc>
6407	Whether the monitor is enabled in the guest.
6408	</desc>
6409	</param>
6410	</method>
6411
6412	<method name="querySavedThumbnailSize">
6413	<desc>
6414	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6415	</desc>
6416	<param name="screenId" type="unsigned long" dir="in">
6417	<desc>
6418	Saved guest screen to query info from.
6419	</desc>
6420	</param>
6421	<param name="size" type="unsigned long" dir="out">
6422	<desc>
6423	Size of buffer required to store the bitmap.
6424	</desc>
6425	</param>
6426	<param name="width" type="unsigned long" dir="out">
6427	<desc>
6428	Bitmap width.
6429	</desc>
6430	</param>
6431	<param name="height" type="unsigned long" dir="out">
6432	<desc>
6433	Bitmap height.
6434	</desc>
6435	</param>
6436	</method>
6437
6438	<method name="readSavedThumbnailToArray">
6439	<desc>
6440	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6441	</desc>
6442	<param name="screenId" type="unsigned long" dir="in">
6443	<desc>
6444	Saved guest screen to read from.
6445	</desc>
6446	</param>
6447	<param name="BGR" type="boolean" dir="in">
6448	<desc>
6449	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6450	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6451	</desc>
6452	</param>
6453	<param name="width" type="unsigned long" dir="out">
6454	<desc>
6455	Bitmap width.
6456	</desc>
6457	</param>
6458	<param name="height" type="unsigned long" dir="out">
6459	<desc>
6460	Bitmap height.
6461	</desc>
6462	</param>
6463	<param name="data" type="octet" safearray="yes" dir="return">
6464	<desc>
6465	Array with resulting bitmap data.
6466	</desc>
6467	</param>
6468	</method>
6469
6470	<method name="readSavedThumbnailPNGToArray">
6471	<desc>
6472	Thumbnail in PNG format is retrieved to an array of bytes.
6473	</desc>
6474	<param name="screenId" type="unsigned long" dir="in">
6475	<desc>
6476	Saved guest screen to read from.
6477	</desc>
6478	</param>
6479	<param name="width" type="unsigned long" dir="out">
6480	<desc>
6481	Image width.
6482	</desc>
6483	</param>
6484	<param name="height" type="unsigned long" dir="out">
6485	<desc>
6486	Image height.
6487	</desc>
6488	</param>
6489	<param name="data" type="octet" dir="return" safearray="yes">
6490	<desc>
6491	Array with resulting PNG data.
6492	</desc>
6493	</param>
6494	</method>
6495
6496	<method name="querySavedScreenshotPNGSize">
6497	<desc>
6498	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6499	</desc>
6500	<param name="screenId" type="unsigned long" dir="in">
6501	<desc>
6502	Saved guest screen to query info from.
6503	</desc>
6504	</param>
6505	<param name="size" type="unsigned long" dir="out">
6506	<desc>
6507	Size of buffer required to store the PNG binary data.
6508	</desc>
6509	</param>
6510	<param name="width" type="unsigned long" dir="out">
6511	<desc>
6512	Image width.
6513	</desc>
6514	</param>
6515	<param name="height" type="unsigned long" dir="out">
6516	<desc>
6517	Image height.
6518	</desc>
6519	</param>
6520	</method>
6521
6522	<method name="readSavedScreenshotPNGToArray">
6523	<desc>
6524	Screenshot in PNG format is retrieved to an array of bytes.
6525	</desc>
6526	<param name="screenId" type="unsigned long" dir="in">
6527	<desc>
6528	Saved guest screen to read from.
6529	</desc>
6530	</param>
6531	<param name="width" type="unsigned long" dir="out">
6532	<desc>
6533	Image width.
6534	</desc>
6535	</param>
6536	<param name="height" type="unsigned long" dir="out">
6537	<desc>
6538	Image height.
6539	</desc>
6540	</param>
6541	<param name="data" type="octet" dir="return" safearray="yes">
6542	<desc>
6543	Array with resulting PNG data.
6544	</desc>
6545	</param>
6546	</method>
6547
6548	<method name="hotPlugCPU">
6549	<desc>
6550	Plugs a CPU into the machine.
6551	</desc>
6552	<param name="cpu" type="unsigned long" dir="in">
6553	<desc>
6554	The CPU id to insert.
6555	</desc>
6556	</param>
6557	</method>
6558
6559	<method name="hotUnplugCPU">
6560	<desc>
6561	Removes a CPU from the machine.
6562	</desc>
6563	<param name="cpu" type="unsigned long" dir="in">
6564	<desc>
6565	The CPU id to remove.
6566	</desc>
6567	</param>
6568	</method>
6569
6570	<method name="getCPUStatus">
6571	<desc>
6572	Returns the current status of the given CPU.
6573	</desc>
6574	<param name="cpu" type="unsigned long" dir="in">
6575	<desc>
6576	The CPU id to check for.
6577	</desc>
6578	</param>
6579	<param name="attached" type="boolean" dir="return">
6580	<desc>
6581	Status of the CPU.
6582	</desc>
6583	</param>
6584	</method>
6585
6586	<method name="queryLogFilename">
6587	<desc>
6588	Queries for the VM log file name of an given index. Returns an empty
6589	string if a log file with that index doesn't exists.
6590	</desc>
6591	<param name="idx" type="unsigned long" dir="in">
6592	<desc>
6593	Which log file name to query. 0=current log file.
6594	</desc>
6595	</param>
6596	<param name="filename" type="wstring" dir="return">
6597	<desc>
6598	On return the full path to the log file or an empty string on error.
6599	</desc>
6600	</param>
6601	</method>
6602
6603	<method name="readLog">
6604	<desc>
6605	Reads the VM log file. The chunk size is limited, so even if you
6606	ask for a big piece there might be less data returned.
6607	</desc>
6608	<param name="idx" type="unsigned long" dir="in">
6609	<desc>
6610	Which log file to read. 0=current log file.
6611	</desc>
6612	</param>
6613	<param name="offset" type="long long" dir="in">
6614	<desc>
6615	Offset in the log file.
6616	</desc>
6617	</param>
6618	<param name="size" type="long long" dir="in">
6619	<desc>
6620	Chunk size to read in the log file.
6621	</desc>
6622	</param>
6623	<param name="data" type="octet" dir="return" safearray="yes">
6624	<desc>
6625	Data read from the log file. A data size of 0 means end of file
6626	if the requested chunk size was not 0. This is the unprocessed
6627	file data, i.e. the line ending style depends on the platform of
6628	the system the server is running on.
6629	</desc>
6630	</param>
6631	</method>
6632
6633	<method name="cloneTo">
6634	<desc>
6635	Creates a clone of this machine, either as a full clone (which means
6636	creating independent copies of the hard disk media, save states and so
6637	on), or as a linked clone (which uses its own differencing media,
6638	sharing the parent media with the source machine).
6639
6640	The target machine object must have been created previously with <link
6641	to="IVirtualBox::createMachine"/>, and all the settings will be
6642	transferred except the VM name and the hardware UUID. You can set the
6643	VM name and the new hardware UUID when creating the target machine. The
6644	network MAC addresses are newly created for all newtwork adapters. You
6645	can change that behaviour with the options parameter. The operation is
6646	performed asynchronously, so the machine object will be not be usable
6647	until the @a progress object signals completion.
6648
6649	<result name="E_INVALIDARG">
6650	@a target is @c null.
6651	</result>
6652	</desc>
6653
6654	<param name="target" type="IMachine" dir="in">
6655	<desc>Target machine object.</desc>
6656	</param>
6657	<param name="mode" type="CloneMode" dir="in">
6658	<desc>Which states should be cloned.</desc>
6659	</param>
6660	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6661	<desc>Options for the cloning operation.</desc>
6662	</param>
6663	<param name="progress" type="IProgress" dir="return">
6664	<desc>Progress object to track the operation completion.</desc>
6665	</param>
6666	</method>
6667
6668	</interface>
6669
6670	<!--
6671	// IConsole
6672	/////////////////////////////////////////////////////////////////////////
6673	-->
6674
6675	<interface
6676	name="IVRDEServerInfo" extends="$unknown"
6677	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6678	wsmap="struct"
6679	>
6680	<desc>
6681	Contains information about the remote desktop (VRDE) server capabilities and status.
6682	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6683	</desc>
6684
6685	<attribute name="active" type="boolean" readonly="yes">
6686	<desc>
6687	Whether the remote desktop connection is active.
6688	</desc>
6689	</attribute>
6690
6691	<attribute name="port" type="long" readonly="yes">
6692	<desc>
6693	VRDE server port number. If this property is equal to <tt>0</tt>, then
6694	the VRDE server failed to start, usually because there are no free IP
6695	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6696	server has not yet been started.
6697	</desc>
6698	</attribute>
6699
6700	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6701	<desc>
6702	How many times a client connected.
6703	</desc>
6704	</attribute>
6705
6706	<attribute name="beginTime" type="long long" readonly="yes">
6707	<desc>
6708	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6709	</desc>
6710	</attribute>
6711
6712	<attribute name="endTime" type="long long" readonly="yes">
6713	<desc>
6714	When the last connection was terminated or the current time, if
6715	connection is still active, in milliseconds since 1970-01-01 UTC.
6716	</desc>
6717	</attribute>
6718
6719	<attribute name="bytesSent" type="long long" readonly="yes">
6720	<desc>
6721	How many bytes were sent in last or current, if still active, connection.
6722	</desc>
6723	</attribute>
6724
6725	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6726	<desc>
6727	How many bytes were sent in all connections.
6728	</desc>
6729	</attribute>
6730
6731	<attribute name="bytesReceived" type="long long" readonly="yes">
6732	<desc>
6733	How many bytes were received in last or current, if still active, connection.
6734	</desc>
6735	</attribute>
6736
6737	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6738	<desc>
6739	How many bytes were received in all connections.
6740	</desc>
6741	</attribute>
6742
6743	<attribute name="user" type="wstring" readonly="yes">
6744	<desc>
6745	Login user name supplied by the client.
6746	</desc>
6747	</attribute>
6748
6749	<attribute name="domain" type="wstring" readonly="yes">
6750	<desc>
6751	Login domain name supplied by the client.
6752	</desc>
6753	</attribute>
6754
6755	<attribute name="clientName" type="wstring" readonly="yes">
6756	<desc>
6757	The client name supplied by the client.
6758	</desc>
6759	</attribute>
6760
6761	<attribute name="clientIP" type="wstring" readonly="yes">
6762	<desc>
6763	The IP address of the client.
6764	</desc>
6765	</attribute>
6766
6767	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6768	<desc>
6769	The client software version number.
6770	</desc>
6771	</attribute>
6772
6773	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6774	<desc>
6775	Public key exchange method used when connection was established.
6776	Values: 0 - RDP4 public key exchange scheme.
6777	1 - X509 certificates were sent to client.
6778	</desc>
6779	</attribute>
6780
6781	</interface>
6782
6783	<interface
6784	name="IConsole" extends="$unknown"
6785	uuid="db7ab4ca-2a3f-4183-9243-c1208da92392"
6786	wsmap="managed"
6787	>
6788	<desc>
6789	The IConsole interface represents an interface to control virtual
6790	machine execution.
6791
6792	A console object gets created when a machine has been locked for a
6793	particular session (client process) using <link to="IMachine::lockMachine" />
6794	or <link to="IMachine::launchVMProcess"/>. The console object can
6795	then be found in the session's <link to="ISession::console" /> attribute.
6796
6797	Methods of the IConsole interface allow the caller to query the current
6798	virtual machine execution state, pause the machine or power it down, save
6799	the machine state or take a snapshot, attach and detach removable media
6800	and so on.
6801
6802	<see><link to="ISession"/></see>
6803	</desc>
6804
6805	<attribute name="machine" type="IMachine" readonly="yes">
6806	<desc>
6807	Machine object for this console session.
6808	<note>
6809	This is a convenience property, it has the same value as
6810	<link to="ISession::machine"/> of the corresponding session
6811	object.
6812	</note>
6813	</desc>
6814	</attribute>
6815
6816	<attribute name="state" type="MachineState" readonly="yes">
6817	<desc>
6818	Current execution state of the machine.
6819	<note>
6820	This property always returns the same value as the corresponding
6821	property of the IMachine object for this console session.
6822	For the process that owns (executes) the VM, this is the
6823	preferable way of querying the VM state, because no IPC
6824	calls are made.
6825	</note>
6826	</desc>
6827	</attribute>
6828
6829	<attribute name="guest" type="IGuest" readonly="yes">
6830	<desc>Guest object.</desc>
6831	</attribute>
6832
6833	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6834	<desc>
6835	Virtual keyboard object.
6836	<note>
6837	If the machine is not running, any attempt to use
6838	the returned object will result in an error.
6839	</note>
6840	</desc>
6841	</attribute>
6842
6843	<attribute name="mouse" type="IMouse" readonly="yes">
6844	<desc>
6845	Virtual mouse object.
6846	<note>
6847	If the machine is not running, any attempt to use
6848	the returned object will result in an error.
6849	</note>
6850	</desc>
6851	</attribute>
6852
6853	<attribute name="display" type="IDisplay" readonly="yes">
6854	<desc>Virtual display object.
6855	<note>
6856	If the machine is not running, any attempt to use
6857	the returned object will result in an error.
6858	</note>
6859	</desc>
6860	</attribute>
6861
6862	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6863	<desc>Debugging interface.</desc>
6864	</attribute>
6865
6866	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6867	<desc>
6868	Collection of USB devices currently attached to the virtual
6869	USB controller.
6870	<note>
6871	The collection is empty if the machine is not running.
6872	</note>
6873	</desc>
6874	</attribute>
6875
6876	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6877	<desc>
6878	List of USB devices currently attached to the remote VRDE client.
6879	Once a new device is physically attached to the remote host computer,
6880	it appears in this list and remains there until detached.
6881	</desc>
6882	</attribute>
6883
6884	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6885	<desc>
6886	Collection of shared folders for the current session. These folders
6887	are called transient shared folders because they are available to the
6888	guest OS running inside the associated virtual machine only for the
6889	duration of the session (as opposed to
6890	<link to="IMachine::sharedFolders"/> which represent permanent shared
6891	folders). When the session is closed (e.g. the machine is powered down),
6892	these folders are automatically discarded.
6893
6894	New shared folders are added to the collection using
6895	<link to="#createSharedFolder"/>. Existing shared folders can be
6896	removed using <link to="#removeSharedFolder"/>.
6897	</desc>
6898	</attribute>
6899
6900	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6901	<desc>
6902	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6903	</desc>
6904	</attribute>
6905
6906	<attribute name="eventSource" type="IEventSource" readonly="yes">
6907	<desc>
6908	Event source for console events.
6909	</desc>
6910	</attribute>
6911
6912	<attribute name="attachedPCIDevices" type="IPCIDeviceAttachment" readonly="yes" safearray="yes">
6913	<desc>Array of PCI devices attached to this machine.</desc>
6914	</attribute>
6915
6916	<attribute name="useHostClipboard" type="boolean">
6917	<desc>
6918	Whether the guest clipboard should be connected to the host one or
6919	whether it should only be allowed access to the VRDE clipboard. This
6920	setting may not affect existing guest clipboard connections which
6921	are already connected to the host clipboard.
6922	</desc>
6923	</attribute>
6924
6925	<method name="powerUp">
6926	<desc>
6927	Starts the virtual machine execution using the current machine
6928	state (that is, its current execution state, current settings and
6929	current storage devices).
6930
6931	<note>
6932	This method is only useful for front-ends that want to actually
6933	execute virtual machines in their own process (like the VirtualBox
6934	or VBoxSDL front-ends). Unless you are intending to write such a
6935	front-end, do not call this method. If you simply want to
6936	start virtual machine execution using one of the existing front-ends
6937	(for example the VirtualBox GUI or headless server), use
6938	<link to="IMachine::launchVMProcess"/> instead; these
6939	front-ends will power up the machine automatically for you.
6940	</note>
6941
6942	If the machine is powered off or aborted, the execution will
6943	start from the beginning (as if the real hardware were just
6944	powered on).
6945
6946	If the machine is in the <link to="MachineState_Saved"/> state,
6947	it will continue its execution the point where the state has
6948	been saved.
6949
6950	If the machine <link to="IMachine::teleporterEnabled"/> property is
6951	enabled on the machine being powered up, the machine will wait for an
6952	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6953	state. The returned progress object will have at least three
6954	operations where the last three are defined as: (1) powering up and
6955	starting TCP server, (2) waiting for incoming teleportations, and
6956	(3) perform teleportation. These operations will be reflected as the
6957	last three operations of the progress objected returned by
6958	<link to="IMachine::launchVMProcess"/> as well.
6959
6960	<see><link to="#saveState"/></see>
6961
6962	<result name="VBOX_E_INVALID_VM_STATE">
6963	Virtual machine already running.
6964	</result>
6965	<result name="VBOX_E_HOST_ERROR">
6966	Host interface does not exist or name not set.
6967	</result>
6968	<result name="VBOX_E_FILE_ERROR">
6969	Invalid saved state file.
6970	</result>
6971	</desc>
6972	<param name="progress" type="IProgress" dir="return">
6973	<desc>Progress object to track the operation completion.</desc>
6974	</param>
6975	</method>
6976
6977	<method name="powerUpPaused">
6978	<desc>
6979	Identical to powerUp except that the VM will enter the
6980	<link to="MachineState_Paused"/> state, instead of
6981	<link to="MachineState_Running"/>.
6982
6983	<see><link to="#powerUp"/></see>
6984	<result name="VBOX_E_INVALID_VM_STATE">
6985	Virtual machine already running.
6986	</result>
6987	<result name="VBOX_E_HOST_ERROR">
6988	Host interface does not exist or name not set.
6989	</result>
6990	<result name="VBOX_E_FILE_ERROR">
6991	Invalid saved state file.
6992	</result>
6993	</desc>
6994	<param name="progress" type="IProgress" dir="return">
6995	<desc>Progress object to track the operation completion.</desc>
6996	</param>
6997	</method>
6998
6999	<method name="powerDown">
7000	<desc>
7001	Initiates the power down procedure to stop the virtual machine
7002	execution.
7003
7004	The completion of the power down procedure is tracked using the returned
7005	IProgress object. After the operation is complete, the machine will go
7006	to the PoweredOff state.
7007	<result name="VBOX_E_INVALID_VM_STATE">
7008	Virtual machine must be Running, Paused or Stuck to be powered down.
7009	</result>
7010	</desc>
7011	<param name="progress" type="IProgress" dir="return">
7012	<desc>Progress object to track the operation completion.</desc>
7013	</param>
7014	</method>
7015
7016	<method name="reset">
7017	<desc>Resets the virtual machine.
7018	<result name="VBOX_E_INVALID_VM_STATE">
7019	Virtual machine not in Running state.
7020	</result>
7021	<result name="VBOX_E_VM_ERROR">
7022	Virtual machine error in reset operation.
7023	</result>
7024	</desc>
7025	</method>
7026
7027	<method name="pause">
7028	<desc>Pauses the virtual machine execution.
7029	<result name="VBOX_E_INVALID_VM_STATE">
7030	Virtual machine not in Running state.
7031	</result>
7032	<result name="VBOX_E_VM_ERROR">
7033	Virtual machine error in suspend operation.
7034	</result>
7035	</desc>
7036	</method>
7037
7038	<method name="resume">
7039	<desc>Resumes the virtual machine execution.
7040	<result name="VBOX_E_INVALID_VM_STATE">
7041	Virtual machine not in Paused state.
7042	</result>
7043	<result name="VBOX_E_VM_ERROR">
7044	Virtual machine error in resume operation.
7045	</result>
7046	</desc>
7047	</method>
7048
7049	<method name="powerButton">
7050	<desc>Sends the ACPI power button event to the guest.
7051	<result name="VBOX_E_INVALID_VM_STATE">
7052	Virtual machine not in Running state.
7053	</result>
7054	<result name="VBOX_E_PDM_ERROR">
7055	Controlled power off failed.
7056	</result>
7057	</desc>
7058	</method>
7059
7060	<method name="sleepButton">
7061	<desc>Sends the ACPI sleep button event to the guest.
7062	<result name="VBOX_E_INVALID_VM_STATE">
7063	Virtual machine not in Running state.
7064	</result>
7065	<result name="VBOX_E_PDM_ERROR">
7066	Sending sleep button event failed.
7067	</result>
7068	</desc>
7069	</method>
7070
7071	<method name="getPowerButtonHandled">
7072	<desc>Checks if the last power button event was handled by guest.
7073	<result name="VBOX_E_PDM_ERROR">
7074	Checking if the event was handled by the guest OS failed.
7075	</result>
7076	</desc>
7077	<param name="handled" type="boolean" dir="return"/>
7078	</method>
7079
7080	<method name="getGuestEnteredACPIMode">
7081	<desc>Checks if the guest entered the ACPI mode G0 (working) or
7082	G1 (sleeping). If this method returns @c false, the guest will
7083	most likely not respond to external ACPI events.
7084	<result name="VBOX_E_INVALID_VM_STATE">
7085	Virtual machine not in Running state.
7086	</result>
7087	</desc>
7088	<param name="entered" type="boolean" dir="return"/>
7089	</method>
7090
7091	<method name="saveState">
7092	<desc>
7093	Saves the current execution state of a running virtual machine
7094	and stops its execution.
7095
7096	After this operation completes, the machine will go to the
7097	Saved state. Next time it is powered up, this state will
7098	be restored and the machine will continue its execution from
7099	the place where it was saved.
7100
7101	This operation differs from taking a snapshot to the effect
7102	that it doesn't create new differencing media. Also, once
7103	the machine is powered up from the state saved using this method,
7104	the saved state is deleted, so it will be impossible to return
7105	to this state later.
7106
7107	<note>
7108	On success, this method implicitly calls
7109	<link to="IMachine::saveSettings"/> to save all current machine
7110	settings (including runtime changes to the DVD medium, etc.).
7111	Together with the impossibility to change any VM settings when it is
7112	in the Saved state, this guarantees adequate hardware
7113	configuration of the machine when it is restored from the saved
7114	state file.
7115	</note>
7116
7117	<note>
7118	The machine must be in the Running or Paused state, otherwise
7119	the operation will fail.
7120	</note>
7121	<result name="VBOX_E_INVALID_VM_STATE">
7122	Virtual machine state neither Running nor Paused.
7123	</result>
7124	<result name="VBOX_E_FILE_ERROR">
7125	Failed to create directory for saved state file.
7126	</result>
7127
7128	<see><link to="#takeSnapshot"/></see>
7129	</desc>
7130	<param name="progress" type="IProgress" dir="return">
7131	<desc>Progress object to track the operation completion.</desc>
7132	</param>
7133	</method>
7134
7135	<method name="adoptSavedState">
7136	<desc>
7137	Associates the given saved state file to the virtual machine.
7138
7139	On success, the machine will go to the Saved state. Next time it is
7140	powered up, it will be restored from the adopted saved state and
7141	continue execution from the place where the saved state file was
7142	created.
7143
7144	The specified saved state file path may be absolute or relative to the
7145	folder the VM normally saves the state to (usually,
7146	<link to="IMachine::snapshotFolder"/>).
7147
7148	<note>
7149	It's a caller's responsibility to make sure the given saved state
7150	file is compatible with the settings of this virtual machine that
7151	represent its virtual hardware (memory size, storage disk configuration
7152	etc.). If there is a mismatch, the behavior of the virtual machine
7153	is undefined.
7154	</note>
7155	<result name="VBOX_E_INVALID_VM_STATE">
7156	Virtual machine state neither PoweredOff nor Aborted.
7157	</result>
7158	</desc>
7159	<param name="savedStateFile" type="wstring" dir="in">
7160	<desc>Path to the saved state file to adopt.</desc>
7161	</param>
7162	</method>
7163
7164	<method name="discardSavedState">
7165	<desc>
7166	Forcibly resets the machine to "Powered Off" state if it is
7167	currently in the "Saved" state (previously created by <link to="#saveState"/>).
7168	Next time the machine is powered up, a clean boot will occur.
7169	<note>
7170	This operation is equivalent to resetting or powering off
7171	the machine without doing a proper shutdown of the guest
7172	operating system; as with resetting a running phyiscal
7173	computer, it can can lead to data loss.
7174	</note>
7175	If @a fRemoveFile is @c true, the file in the machine directory
7176	into which the machine state was saved is also deleted. If
7177	this is @c false, then the state can be recovered and later
7178	re-inserted into a machine using <link to="#adoptSavedState" />.
7179	The location of the file can be found in the
7180	<link to="IMachine::stateFilePath" /> attribute.
7181	<result name="VBOX_E_INVALID_VM_STATE">
7182	Virtual machine not in state Saved.
7183	</result>
7184	</desc>
7185	<param name="fRemoveFile" type="boolean" dir="in" >
7186	<desc>Whether to also remove the saved state file.</desc>
7187	</param>
7188	</method>
7189
7190	<method name="getDeviceActivity">
7191	<desc>
7192	Gets the current activity type of a given device or device group.
7193	<result name="E_INVALIDARG">
7194	Invalid device type.
7195	</result>
7196	</desc>
7197	<param name="type" type="DeviceType" dir="in"/>
7198	<param name="activity" type="DeviceActivity" dir="return"/>
7199	</method>
7200
7201	<method name="attachUSBDevice">
7202	<desc>
7203	Attaches a host USB device with the given UUID to the
7204	USB controller of the virtual machine.
7205
7206	The device needs to be in one of the following states:
7207	<link to="USBDeviceState_Busy"/>,
7208	<link to="USBDeviceState_Available"/> or
7209	<link to="USBDeviceState_Held"/>,
7210	otherwise an error is immediately returned.
7211
7212	When the device state is
7213	<link to="USBDeviceState_Busy">Busy</link>, an error may also
7214	be returned if the host computer refuses to release it for some reason.
7215
7216	<see><link to="IUSBController::deviceFilters"/>,
7217	<link to="USBDeviceState"/></see>
7218	<result name="VBOX_E_INVALID_VM_STATE">
7219	Virtual machine state neither Running nor Paused.
7220	</result>
7221	<result name="VBOX_E_PDM_ERROR">
7222	Virtual machine does not have a USB controller.
7223	</result>
7224	</desc>
7225	<param name="id" type="uuid" mod="string" dir="in">
7226	<desc>UUID of the host USB device to attach.</desc>
7227	</param>
7228	</method>
7229
7230	<method name="detachUSBDevice">
7231	<desc>
7232	Detaches an USB device with the given UUID from the USB controller
7233	of the virtual machine.
7234
7235	After this method succeeds, the VirtualBox server re-initiates
7236	all USB filters as if the device were just physically attached
7237	to the host, but filters of this machine are ignored to avoid
7238	a possible automatic re-attachment.
7239
7240	<see><link to="IUSBController::deviceFilters"/>,
7241	<link to="USBDeviceState"/></see>
7242
7243	<result name="VBOX_E_PDM_ERROR">
7244	Virtual machine does not have a USB controller.
7245	</result>
7246	<result name="E_INVALIDARG">
7247	USB device not attached to this virtual machine.
7248	</result>
7249	</desc>
7250	<param name="id" type="uuid" mod="string" dir="in">
7251	<desc>UUID of the USB device to detach.</desc>
7252	</param>
7253	<param name="device" type="IUSBDevice" dir="return">
7254	<desc>Detached USB device.</desc>
7255	</param>
7256	</method>
7257
7258	<method name="findUSBDeviceByAddress">
7259	<desc>
7260	Searches for a USB device with the given host address.
7261
7262	<result name="VBOX_E_OBJECT_NOT_FOUND">
7263	Given @c name does not correspond to any USB device.
7264	</result>
7265
7266	<see><link to="IUSBDevice::address"/></see>
7267	</desc>
7268	<param name="name" type="wstring" dir="in">
7269	<desc>
7270	Address of the USB device (as assigned by the host) to
7271	search for.
7272	</desc>
7273	</param>
7274	<param name="device" type="IUSBDevice" dir="return">
7275	<desc>Found USB device object.</desc>
7276	</param>
7277	</method>
7278
7279	<method name="findUSBDeviceById">
7280	<desc>
7281	Searches for a USB device with the given UUID.
7282
7283	<result name="VBOX_E_OBJECT_NOT_FOUND">
7284	Given @c id does not correspond to any USB device.
7285	</result>
7286
7287	<see><link to="IUSBDevice::id"/></see>
7288	</desc>
7289	<param name="id" type="uuid" mod="string" dir="in">
7290	<desc>UUID of the USB device to search for.</desc>
7291	</param>
7292	<param name="device" type="IUSBDevice" dir="return">
7293	<desc>Found USB device object.</desc>
7294	</param>
7295	</method>
7296
7297	<method name="createSharedFolder">
7298	<desc>
7299	Creates a transient new shared folder by associating the given logical
7300	name with the given host path, adds it to the collection of shared
7301	folders and starts sharing it. Refer to the description of
7302	<link to="ISharedFolder"/> to read more about logical names.
7303
7304	<result name="VBOX_E_INVALID_VM_STATE">
7305	Virtual machine in Saved state or currently changing state.
7306	</result>
7307	<result name="VBOX_E_FILE_ERROR">
7308	Shared folder already exists or not accessible.
7309	</result>
7310	</desc>
7311	<param name="name" type="wstring" dir="in">
7312	<desc>Unique logical name of the shared folder.</desc>
7313	</param>
7314	<param name="hostPath" type="wstring" dir="in">
7315	<desc>Full path to the shared folder in the host file system.</desc>
7316	</param>
7317	<param name="writable" type="boolean" dir="in">
7318	<desc>Whether the share is writable or readonly</desc>
7319	</param>
7320	<param name="automount" type="boolean" dir="in">
7321	<desc>Whether the share gets automatically mounted by the guest
7322	or not.</desc>
7323	</param>
7324	</method>
7325
7326	<method name="removeSharedFolder">
7327	<desc>
7328	Removes a transient shared folder with the given name previously
7329	created by <link to="#createSharedFolder"/> from the collection of
7330	shared folders and stops sharing it.
7331	<result name="VBOX_E_INVALID_VM_STATE">
7332	Virtual machine in Saved state or currently changing state.
7333	</result>
7334	<result name="VBOX_E_FILE_ERROR">
7335	Shared folder does not exists.
7336	</result>
7337	</desc>
7338	<param name="name" type="wstring" dir="in">
7339	<desc>Logical name of the shared folder to remove.</desc>
7340	</param>
7341	</method>
7342
7343	<method name="takeSnapshot">
7344	<desc>
7345	Saves the current execution state
7346	and all settings of the machine and creates differencing images
7347	for all normal (non-independent) media.
7348	See <link to="ISnapshot" /> for an introduction to snapshots.
7349
7350	This method can be called for a PoweredOff, Saved (see
7351	<link to="#saveState"/>), Running or
7352	Paused virtual machine. When the machine is PoweredOff, an
7353	offline snapshot is created. When the machine is Running a live
7354	snapshot is created, and an online snapshot is created when Paused.
7355
7356	The taken snapshot is always based on the
7357	<link to="IMachine::currentSnapshot">current snapshot</link>
7358	of the associated virtual machine and becomes a new current snapshot.
7359
7360	<note>
7361	This method implicitly calls <link to="IMachine::saveSettings"/> to
7362	save all current machine settings before taking an offline snapshot.
7363	</note>
7364
7365	<result name="VBOX_E_INVALID_VM_STATE">
7366	Virtual machine currently changing state.
7367	</result>
7368	</desc>
7369	<param name="name" type="wstring" dir="in">
7370	<desc>Short name for the snapshot.</desc>
7371	</param>
7372	<param name="description" type="wstring" dir="in">
7373	<desc>Optional description of the snapshot.</desc>
7374	</param>
7375	<param name="progress" type="IProgress" dir="return">
7376	<desc>Progress object to track the operation completion.</desc>
7377	</param>
7378	</method>
7379
7380	<method name="deleteSnapshot">
7381	<desc>
7382	Starts deleting the specified snapshot asynchronously.
7383	See <link to="ISnapshot" /> for an introduction to snapshots.
7384
7385	The execution state and settings of the associated machine stored in
7386	the snapshot will be deleted. The contents of all differencing media of
7387	this snapshot will be merged with the contents of their dependent child
7388	media to keep the medium chain valid (in other words, all changes
7389	represented by media being deleted will be propagated to their child
7390	medium). After that, this snapshot's differencing medium will be
7391	deleted. The parent of this snapshot will become a new parent for all
7392	its child snapshots.
7393
7394	If the deleted snapshot is the current one, its parent snapshot will
7395	become a new current snapshot. The current machine state is not directly
7396	affected in this case, except that currently attached differencing
7397	media based on media of the deleted snapshot will be also merged as
7398	described above.
7399
7400	If the deleted snapshot is the first or current snapshot, then the
7401	respective IMachine attributes will be adjusted. Deleting the current
7402	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7403	to make all current machine settings permanent.
7404
7405	Deleting a snapshot has the following preconditions:
7406
7407	<ul>
7408	<li>Child media of all normal media of the deleted snapshot
7409	must be accessible (see <link to="IMedium::state"/>) for this
7410	operation to succeed. If only one running VM refers to all images
7411	which participates in merging the operation can be performed while
7412	the VM is running. Otherwise all virtual machines whose media are
7413	directly or indirectly based on the media of deleted snapshot must
7414	be powered off. In any case, online snapshot deleting usually is
7415	slower than the same operation without any running VM.</li>
7416
7417	<li>You cannot delete the snapshot if a medium attached to it has
7418	more than one child medium (differencing images) because otherwise
7419	merging would be impossible. This might be the case if there is
7420	more than one child snapshot or differencing images were created
7421	for other reason (e.g. implicitly because of multiple machine
7422	attachments).</li>
7423	</ul>
7424
7425	The virtual machine's <link to="IMachine::state">state</link> is
7426	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7427	"DeletingSnapshotPaused" while this operation is in progress.
7428
7429	<note>
7430	Merging medium contents can be very time and disk space
7431	consuming, if these media are big in size and have many
7432	children. However, if the snapshot being deleted is the last
7433	(head) snapshot on the branch, the operation will be rather
7434	quick.
7435	</note>
7436	<result name="VBOX_E_INVALID_VM_STATE">
7437	The running virtual machine prevents deleting this snapshot. This
7438	happens only in very specific situations, usually snapshots can be
7439	deleted without trouble while a VM is running. The error message
7440	text explains the reason for the failure.
7441	</result>
7442	</desc>
7443	<param name="id" type="uuid" mod="string" dir="in">
7444	<desc>UUID of the snapshot to delete.</desc>
7445	</param>
7446	<param name="progress" type="IProgress" dir="return">
7447	<desc>Progress object to track the operation completion.</desc>
7448	</param>
7449	</method>
7450
7451	<method name="deleteSnapshotAndAllChildren">
7452	<desc>
7453	Starts deleting the specified snapshot and all its children
7454	asynchronously. See <link to="ISnapshot" /> for an introduction to
7455	snapshots. The conditions and many details are the same as with
7456	<link to="#deleteSnapshot"/>.
7457
7458	This operation is very fast if the snapshot subtree does not include
7459	the current state. It is still significantly faster than deleting the
7460	snapshots one by one if the current state is in the subtree and there
7461	are more than one snapshots from current state to the snapshot which
7462	marks the subtree, since it eliminates the incremental image merging.
7463
7464	<note>This API method is right now not implemented!</note>
7465
7466	<result name="VBOX_E_INVALID_VM_STATE">
7467	The running virtual machine prevents deleting this snapshot. This
7468	happens only in very specific situations, usually snapshots can be
7469	deleted without trouble while a VM is running. The error message
7470	text explains the reason for the failure.
7471	</result>
7472	<result name="E_NOTIMPL">
7473	The method is not implemented yet.
7474	</result>
7475	</desc>
7476	<param name="id" type="uuid" mod="string" dir="in">
7477	<desc>UUID of the snapshot to delete, including all its children.</desc>
7478	</param>
7479	<param name="progress" type="IProgress" dir="return">
7480	<desc>Progress object to track the operation completion.</desc>
7481	</param>
7482	</method>
7483
7484	<method name="deleteSnapshotRange">
7485	<desc>
7486	Starts deleting the specified snapshot range. This is limited to
7487	linear snapshot lists, which means there may not be any other child
7488	snapshots other than the direct sequence between the start and end
7489	snapshot. If the start and end snapshot point to the same snapshot this
7490	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7491	<link to="ISnapshot" /> for an introduction to snapshots. The
7492	conditions and many details are the same as with
7493	<link to="#deleteSnapshot"/>.
7494
7495	This operation is generally faster than deleting snapshots one by one
7496	and often also needs less extra disk space before freeing up disk space
7497	by deleting the removed disk images corresponding to the snapshot.
7498
7499	<note>This API method is right now not implemented!</note>
7500
7501	<result name="VBOX_E_INVALID_VM_STATE">
7502	The running virtual machine prevents deleting this snapshot. This
7503	happens only in very specific situations, usually snapshots can be
7504	deleted without trouble while a VM is running. The error message
7505	text explains the reason for the failure.
7506	</result>
7507	<result name="E_NOTIMPL">
7508	The method is not implemented yet.
7509	</result>
7510	</desc>
7511	<param name="startId" type="uuid" mod="string" dir="in">
7512	<desc>UUID of the first snapshot to delete.</desc>
7513	</param>
7514	<param name="endId" type="uuid" mod="string" dir="in">
7515	<desc>UUID of the last snapshot to delete.</desc>
7516	</param>
7517	<param name="progress" type="IProgress" dir="return">
7518	<desc>Progress object to track the operation completion.</desc>
7519	</param>
7520	</method>
7521
7522	<method name="restoreSnapshot">
7523	<desc>
7524	Starts resetting the machine's current state to the state contained
7525	in the given snapshot, asynchronously. All current settings of the
7526	machine will be reset and changes stored in differencing media
7527	will be lost.
7528	See <link to="ISnapshot" /> for an introduction to snapshots.
7529
7530	After this operation is successfully completed, new empty differencing
7531	media are created for all normal media of the machine.
7532
7533	If the given snapshot is an online snapshot, the machine will go to
7534	the <link to="MachineState_Saved"> saved state</link>, so that the
7535	next time it is powered on, the execution state will be restored
7536	from the state of the snapshot.
7537
7538	<note>
7539	The machine must not be running, otherwise the operation will fail.
7540	</note>
7541
7542	<note>
7543	If the machine state is <link to="MachineState_Saved">Saved</link>
7544	prior to this operation, the saved state file will be implicitly
7545	deleted (as if <link to="IConsole::discardSavedState"/> were
7546	called).
7547	</note>
7548
7549	<result name="VBOX_E_INVALID_VM_STATE">
7550	Virtual machine is running.
7551	</result>
7552	</desc>
7553	<param name="snapshot" type="ISnapshot" dir="in">
7554	<desc>The snapshot to restore the VM state from.</desc>
7555	</param>
7556	<param name="progress" type="IProgress" dir="return">
7557	<desc>Progress object to track the operation completion.</desc>
7558	</param>
7559	</method>
7560
7561	<method name="teleport">
7562	<desc>
7563	Teleport the VM to a different host machine or process.
7564
7565	TODO explain the details.
7566
7567	<result name="VBOX_E_INVALID_VM_STATE">
7568	Virtual machine not running or paused.
7569	</result>
7570	</desc>
7571	<param name="hostname" type="wstring" dir="in">
7572	<desc>The name or IP of the host to teleport to.</desc>
7573	</param>
7574	<param name="tcpport" type="unsigned long" dir="in">
7575	<desc>The TCP port to connect to (1..65535).</desc>
7576	</param>
7577	<param name="password" type="wstring" dir="in">
7578	<desc>The password.</desc>
7579	</param>
7580	<param name="maxDowntime" type="unsigned long" dir="in">
7581	<desc>
7582	The maximum allowed downtime given as milliseconds. 0 is not a valid
7583	value. Recommended value: 250 ms.
7584
7585	The higher the value is, the greater the chance for a successful
7586	teleportation. A small value may easily result in the teleportation
7587	process taking hours and eventually fail.
7588
7589	<note>
7590	The current implementation treats this a guideline, not as an
7591	absolute rule.
7592	</note>
7593	</desc>
7594	</param>
7595	<param name="progress" type="IProgress" dir="return">
7596	<desc>Progress object to track the operation completion.</desc>
7597	</param>
7598	</method>
7599
7600	</interface>
7601
7602	<!--
7603	// IHost
7604	/////////////////////////////////////////////////////////////////////////
7605	-->
7606
7607	<enum
7608	name="HostNetworkInterfaceMediumType"
7609	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7610	>
7611	<desc>
7612	Type of encapsulation. Ethernet encapsulation includes both wired and
7613	wireless Ethernet connections.
7614	<see><link to="IHostNetworkInterface"/></see>
7615	</desc>
7616
7617	<const name="Unknown" value="0">
7618	<desc>
7619	The type of interface cannot be determined.
7620	</desc>
7621	</const>
7622	<const name="Ethernet" value="1">
7623	<desc>
7624	Ethernet frame encapsulation.
7625	</desc>
7626	</const>
7627	<const name="PPP" value="2">
7628	<desc>
7629	Point-to-point protocol encapsulation.
7630	</desc>
7631	</const>
7632	<const name="SLIP" value="3">
7633	<desc>
7634	Serial line IP encapsulation.
7635	</desc>
7636	</const>
7637	</enum>
7638
7639	<enum
7640	name="HostNetworkInterfaceStatus"
7641	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7642	>
7643	<desc>
7644	Current status of the interface.
7645	<see><link to="IHostNetworkInterface"/></see>
7646	</desc>
7647
7648	<const name="Unknown" value="0">
7649	<desc>
7650	The state of interface cannot be determined.
7651	</desc>
7652	</const>
7653	<const name="Up" value="1">
7654	<desc>
7655	The interface is fully operational.
7656	</desc>
7657	</const>
7658	<const name="Down" value="2">
7659	<desc>
7660	The interface is not functioning.
7661	</desc>
7662	</const>
7663	</enum>
7664
7665	<enum
7666	name="HostNetworkInterfaceType"
7667	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7668	>
7669	<desc>
7670	Network interface type.
7671	</desc>
7672	<const name="Bridged" value="1"/>
7673	<const name="HostOnly" value="2"/>
7674	</enum>
7675
7676	<interface
7677	name="IHostNetworkInterface" extends="$unknown"
7678	uuid="87a4153d-6889-4dd6-9654-2e9ff0ae8dec"
7679	wsmap="managed"
7680	>
7681	<desc>
7682	Represents one of host's network interfaces. IP V6 address and network
7683	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7684	separated by colons.
7685	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7686	</desc>
7687	<attribute name="name" type="wstring" readonly="yes">
7688	<desc>Returns the host network interface name.</desc>
7689	</attribute>
7690
7691	<attribute name="id" type="uuid" mod="string" readonly="yes">
7692	<desc>Returns the interface UUID.</desc>
7693	</attribute>
7694
7695	<attribute name="networkName" type="wstring" readonly="yes">
7696	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7697	</attribute>
7698
7699	<attribute name="DHCPEnabled" type="boolean" readonly="yes">
7700	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7701	</attribute>
7702
7703	<attribute name="IPAddress" type="wstring" readonly="yes">
7704	<desc>Returns the IP V4 address of the interface.</desc>
7705	</attribute>
7706
7707	<attribute name="networkMask" type="wstring" readonly="yes">
7708	<desc>Returns the network mask of the interface.</desc>
7709	</attribute>
7710
7711	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7712	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7713	</attribute>
7714
7715	<attribute name="IPV6Address" type="wstring" readonly="yes">
7716	<desc>Returns the IP V6 address of the interface.</desc>
7717	</attribute>
7718
7719	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7720	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7721	</attribute>
7722
7723	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7724	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7725	</attribute>
7726
7727	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7728	<desc>Type of protocol encapsulation used.</desc>
7729	</attribute>
7730
7731	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7732	<desc>Status of the interface.</desc>
7733	</attribute>
7734
7735	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7736	<desc>specifies the host interface type.</desc>
7737	</attribute>
7738
7739	<method name="enableStaticIPConfig">
7740	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7741	<param name="IPAddress" type="wstring" dir="in">
7742	<desc>
7743	IP address.
7744	</desc>
7745	</param>
7746	<param name="networkMask" type="wstring" dir="in">
7747	<desc>
7748	network mask.
7749	</desc>
7750	</param>
7751	</method>
7752
7753	<method name="enableStaticIPConfigV6">
7754	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7755	<param name="IPV6Address" type="wstring" dir="in">
7756	<desc>
7757	IP address.
7758	</desc>
7759	</param>
7760	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7761	<desc>
7762	network mask.
7763	</desc>
7764	</param>
7765	</method>
7766
7767	<method name="enableDynamicIPConfig">
7768	<desc>enables the dynamic IP configuration.</desc>
7769	</method>
7770
7771	<method name="DHCPRediscover">
7772	<desc>refreshes the IP configuration for DHCP-enabled interface.</desc>
7773	</method>
7774
7775	</interface>
7776
7777	<interface
7778	name="IHost" extends="$unknown"
7779	uuid="30678943-32df-4830-b413-931b25ac86a0"
7780	wsmap="managed"
7781	>
7782	<desc>
7783	The IHost interface represents the physical machine that this VirtualBox
7784	installation runs on.
7785
7786	An object implementing this interface is returned by the
7787	<link to="IVirtualBox::host" /> attribute. This interface contains
7788	read-only information about the host's physical hardware (such as what
7789	processors and disks are available, what the host operating system is,
7790	and so on) and also allows for manipulating some of the host's hardware,
7791	such as global USB device filters and host interface networking.
7792
7793	</desc>
7794	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7795	<desc>List of DVD drives available on the host.</desc>
7796	</attribute>
7797
7798	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7799	<desc>List of floppy drives available on the host.</desc>
7800	</attribute>
7801
7802	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7803	<desc>
7804	List of USB devices currently attached to the host.
7805	Once a new device is physically attached to the host computer,
7806	it appears in this list and remains there until detached.
7807
7808	<note>
7809	If USB functionality is not available in the given edition of
7810	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7811	</note>
7812	</desc>
7813	</attribute>
7814
7815	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7816	<desc>
7817	List of USB device filters in action.
7818	When a new device is physically attached to the host computer,
7819	filters from this list are applied to it (in order they are stored
7820	in the list). The first matched filter will determine the
7821	<link to="IHostUSBDeviceFilter::action">action</link>
7822	performed on the device.
7823
7824	Unless the device is ignored by these filters, filters of all
7825	currently running virtual machines
7826	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7827
7828	<note>
7829	If USB functionality is not available in the given edition of
7830	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7831	</note>
7832
7833	<see><link to="IHostUSBDeviceFilter"/>,
7834	<link to="USBDeviceState"/></see>
7835	</desc>
7836	</attribute>
7837
7838	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7839	<desc>List of host network interfaces currently defined on the host.</desc>
7840	</attribute>
7841
7842	<attribute name="processorCount" type="unsigned long" readonly="yes">
7843	<desc>Number of (logical) CPUs installed in the host system.</desc>
7844	</attribute>
7845
7846	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7847	<desc>Number of (logical) CPUs online in the host system.</desc>
7848	</attribute>
7849
7850	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7851	<desc>Number of physical processor cores installed in the host system.</desc>
7852	</attribute>
7853
7854	<method name="getProcessorSpeed">
7855	<desc>Query the (approximate) maximum speed of a specified host CPU in
7856	Megahertz.
7857	</desc>
7858	<param name="cpuId" type="unsigned long" dir="in">
7859	<desc>
7860	Identifier of the CPU.
7861	</desc>
7862	</param>
7863	<param name="speed" type="unsigned long" dir="return">
7864	<desc>
7865	Speed value. 0 is returned if value is not known or @a cpuId is
7866	invalid.
7867	</desc>
7868	</param>
7869	</method>
7870
7871	<method name="getProcessorFeature">
7872	<desc>Query whether a CPU feature is supported or not.</desc>
7873	<param name="feature" type="ProcessorFeature" dir="in">
7874	<desc>
7875	CPU Feature identifier.
7876	</desc>
7877	</param>
7878	<param name="supported" type="boolean" dir="return">
7879	<desc>
7880	Feature is supported or not.
7881	</desc>
7882	</param>
7883	</method>
7884
7885	<method name="getProcessorDescription">
7886	<desc>Query the model string of a specified host CPU.
7887	</desc>
7888	<param name="cpuId" type="unsigned long" dir="in">
7889	<desc>
7890	Identifier of the CPU.
7891	<note>
7892	The current implementation might not necessarily return the
7893	description for this exact CPU.
7894	</note>
7895	</desc>
7896	</param>
7897	<param name="description" type="wstring" dir="return">
7898	<desc>
7899	Model string. An empty string is returned if value is not known or
7900	@a cpuId is invalid.
7901	</desc>
7902	</param>
7903	</method>
7904
7905	<method name="getProcessorCPUIDLeaf">
7906	<desc>
7907	Returns the CPU cpuid information for the specified leaf.
7908	</desc>
7909	<param name="cpuId" type="unsigned long" dir="in">
7910	<desc>
7911	Identifier of the CPU. The CPU most be online.
7912	<note>
7913	The current implementation might not necessarily return the
7914	description for this exact CPU.
7915	</note>
7916	</desc>
7917	</param>
7918	<param name="leaf" type="unsigned long" dir="in">
7919	<desc>
7920	CPUID leaf index (eax).
7921	</desc>
7922	</param>
7923	<param name="subLeaf" type="unsigned long" dir="in">
7924	<desc>
7925	CPUID leaf sub index (ecx). This currently only applies to cache
7926	information on Intel CPUs. Use 0 if retrieving values for
7927	<link to="IMachine::setCPUIDLeaf"/>.
7928	</desc>
7929	</param>
7930	<param name="valEax" type="unsigned long" dir="out">
7931	<desc>
7932	CPUID leaf value for register eax.
7933	</desc>
7934	</param>
7935	<param name="valEbx" type="unsigned long" dir="out">
7936	<desc>
7937	CPUID leaf value for register ebx.
7938	</desc>
7939	</param>
7940	<param name="valEcx" type="unsigned long" dir="out">
7941	<desc>
7942	CPUID leaf value for register ecx.
7943	</desc>
7944	</param>
7945	<param name="valEdx" type="unsigned long" dir="out">
7946	<desc>
7947	CPUID leaf value for register edx.
7948	</desc>
7949	</param>
7950	</method>
7951
7952	<attribute name="memorySize" type="unsigned long" readonly="yes">
7953	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7954	</attribute>
7955
7956	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7957	<desc>Available system memory in the host system.</desc>
7958	</attribute>
7959
7960	<attribute name="operatingSystem" type="wstring" readonly="yes">
7961	<desc>Name of the host system's operating system.</desc>
7962	</attribute>
7963
7964	<attribute name="OSVersion" type="wstring" readonly="yes">
7965	<desc>Host operating system's version string.</desc>
7966	</attribute>
7967
7968	<attribute name="UTCTime" type="long long" readonly="yes">
7969	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7970	</attribute>
7971
7972	<attribute name="acceleration3DAvailable" type="boolean" readonly="yes">
7973	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7974	</attribute>
7975
7976	<method name="createHostOnlyNetworkInterface">
7977	<desc>
7978	Creates a new adapter for Host Only Networking.
7979	<result name="E_INVALIDARG">
7980	Host network interface @a name already exists.
7981	</result>
7982	</desc>
7983	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7984	<desc>
7985	Created host interface object.
7986	</desc>
7987	</param>
7988	<param name="progress" type="IProgress" dir="return">
7989	<desc>
7990	Progress object to track the operation completion.
7991	</desc>
7992	</param>
7993	</method>
7994
7995	<method name="removeHostOnlyNetworkInterface">
7996	<desc>
7997	Removes the given Host Only Networking interface.
7998	<result name="VBOX_E_OBJECT_NOT_FOUND">
7999	No host network interface matching @a id found.
8000	</result>
8001	</desc>
8002	<param name="id" type="uuid" mod="string" dir="in">
8003	<desc>
8004	Adapter GUID.
8005	</desc>
8006	</param>
8007	<param name="progress" type="IProgress" dir="return">
8008	<desc>
8009	Progress object to track the operation completion.
8010	</desc>
8011	</param>
8012	</method>
8013
8014	<method name="createUSBDeviceFilter">
8015	<desc>
8016	Creates a new USB device filter. All attributes except
8017	the filter name are set to empty (any match),
8018	<i>active</i> is @c false (the filter is not active).
8019
8020	The created filter can be added to the list of filters using
8021	<link to="#insertUSBDeviceFilter"/>.
8022
8023	<see><link to="#USBDeviceFilters"/></see>
8024	</desc>
8025	<param name="name" type="wstring" dir="in">
8026	<desc>
8027	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
8028	</desc>
8029	</param>
8030	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
8031	<desc>Created filter object.</desc>
8032	</param>
8033	</method>
8034
8035	<method name="insertUSBDeviceFilter">
8036	<desc>
8037	Inserts the given USB device to the specified position
8038	in the list of filters.
8039
8040	Positions are numbered starting from @c 0. If the specified
8041	position is equal to or greater than the number of elements in
8042	the list, the filter is added at the end of the collection.
8043
8044	<note>
8045	Duplicates are not allowed, so an attempt to insert a
8046	filter already in the list is an error.
8047	</note>
8048	<note>
8049	If USB functionality is not available in the given edition of
8050	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8051	</note>
8052
8053	<see><link to="#USBDeviceFilters"/></see>
8054
8055	<result name="VBOX_E_INVALID_OBJECT_STATE">
8056	USB device filter is not created within this VirtualBox instance.
8057	</result>
8058	<result name="E_INVALIDARG">
8059	USB device filter already in list.
8060	</result>
8061
8062	</desc>
8063	<param name="position" type="unsigned long" dir="in">
8064	<desc>Position to insert the filter to.</desc>
8065	</param>
8066	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
8067	<desc>USB device filter to insert.</desc>
8068	</param>
8069	</method>
8070
8071	<method name="removeUSBDeviceFilter">
8072	<desc>
8073	Removes a USB device filter from the specified position in the
8074	list of filters.
8075
8076	Positions are numbered starting from @c 0. Specifying a
8077	position equal to or greater than the number of elements in
8078	the list will produce an error.
8079
8080	<note>
8081	If USB functionality is not available in the given edition of
8082	VirtualBox, this method will set the result code to @c E_NOTIMPL.
8083	</note>
8084
8085	<see><link to="#USBDeviceFilters"/></see>
8086
8087	<result name="E_INVALIDARG">
8088	USB device filter list empty or invalid @a position.
8089	</result>
8090
8091	</desc>
8092	<param name="position" type="unsigned long" dir="in">
8093	<desc>Position to remove the filter from.</desc>
8094	</param>
8095	</method>
8096
8097	<method name="findHostDVDDrive">
8098	<desc>
8099	Searches for a host DVD drive with the given @c name.
8100
8101	<result name="VBOX_E_OBJECT_NOT_FOUND">
8102	Given @c name does not correspond to any host drive.
8103	</result>
8104
8105	</desc>
8106	<param name="name" type="wstring" dir="in">
8107	<desc>Name of the host drive to search for</desc>
8108	</param>
8109	<param name="drive" type="IMedium" dir="return">
8110	<desc>Found host drive object</desc>
8111	</param>
8112	</method>
8113
8114	<method name="findHostFloppyDrive">
8115	<desc>
8116	Searches for a host floppy drive with the given @c name.
8117
8118	<result name="VBOX_E_OBJECT_NOT_FOUND">
8119	Given @c name does not correspond to any host floppy drive.
8120	</result>
8121
8122	</desc>
8123	<param name="name" type="wstring" dir="in">
8124	<desc>Name of the host floppy drive to search for</desc>
8125	</param>
8126	<param name="drive" type="IMedium" dir="return">
8127	<desc>Found host floppy drive object</desc>
8128	</param>
8129	</method>
8130
8131	<method name="findHostNetworkInterfaceByName">
8132	<desc>
8133	Searches through all host network interfaces for an interface with
8134	the given @c name.
8135	<note>
8136	The method returns an error if the given @c name does not
8137	correspond to any host network interface.
8138	</note>
8139	</desc>
8140	<param name="name" type="wstring" dir="in">
8141	<desc>Name of the host network interface to search for.</desc>
8142	</param>
8143	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8144	<desc>Found host network interface object.</desc>
8145	</param>
8146	</method>
8147	<method name="findHostNetworkInterfaceById">
8148	<desc>
8149	Searches through all host network interfaces for an interface with
8150	the given GUID.
8151	<note>
8152	The method returns an error if the given GUID does not
8153	correspond to any host network interface.
8154	</note>
8155	</desc>
8156	<param name="id" type="uuid" mod="string" dir="in">
8157	<desc>GUID of the host network interface to search for.</desc>
8158	</param>
8159	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
8160	<desc>Found host network interface object.</desc>
8161	</param>
8162	</method>
8163	<method name="findHostNetworkInterfacesOfType">
8164	<desc>
8165	Searches through all host network interfaces and returns a list of interfaces of the specified type
8166	</desc>
8167	<param name="type" type="HostNetworkInterfaceType" dir="in">
8168	<desc>type of the host network interfaces to search for.</desc>
8169	</param>
8170	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
8171	<desc>Found host network interface objects.</desc>
8172	</param>
8173	</method>
8174
8175	<method name="findUSBDeviceById">
8176	<desc>
8177	Searches for a USB device with the given UUID.
8178
8179	<result name="VBOX_E_OBJECT_NOT_FOUND">
8180	Given @c id does not correspond to any USB device.
8181	</result>
8182
8183	<see><link to="IUSBDevice::id"/></see>
8184	</desc>
8185	<param name="id" type="uuid" mod="string" dir="in">
8186	<desc>UUID of the USB device to search for.</desc>
8187	</param>
8188	<param name="device" type="IHostUSBDevice" dir="return">
8189	<desc>Found USB device object.</desc>
8190	</param>
8191	</method>
8192
8193	<method name="findUSBDeviceByAddress">
8194	<desc>
8195	Searches for a USB device with the given host address.
8196
8197	<result name="VBOX_E_OBJECT_NOT_FOUND">
8198	Given @c name does not correspond to any USB device.
8199	</result>
8200
8201	<see><link to="IUSBDevice::address"/></see>
8202	</desc>
8203	<param name="name" type="wstring" dir="in">
8204	<desc>
8205	Address of the USB device (as assigned by the host) to
8206	search for.
8207	</desc>
8208	</param>
8209	<param name="device" type="IHostUSBDevice" dir="return">
8210	<desc>Found USB device object.</desc>
8211	</param>
8212	</method>
8213
8214	<method name="generateMACAddress">
8215	<desc>
8216	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
8217	</desc>
8218	<param name="address" type="wstring" dir="return">
8219	<desc>New Ethernet MAC address.</desc>
8220	</param>
8221	</method>
8222
8223	</interface>
8224
8225	<!--
8226	// ISystemProperties
8227	/////////////////////////////////////////////////////////////////////////
8228	-->
8229
8230	<interface
8231	name="ISystemProperties"
8232	extends="$unknown"
8233	uuid="1d7aca29-97f0-4287-9874-a60ec4f80ea6"
8234	wsmap="managed"
8235	>
8236	<desc>
8237	The ISystemProperties interface represents global properties of the given
8238	VirtualBox installation.
8239
8240	These properties define limits and default values for various attributes
8241	and parameters. Most of the properties are read-only, but some can be
8242	changed by a user.
8243	</desc>
8244
8245	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
8246	<desc>Minimum guest system memory in Megabytes.</desc>
8247	</attribute>
8248
8249	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
8250	<desc>Maximum guest system memory in Megabytes.</desc>
8251	</attribute>
8252
8253	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
8254	<desc>Minimum guest video memory in Megabytes.</desc>
8255	</attribute>
8256
8257	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
8258	<desc>Maximum guest video memory in Megabytes.</desc>
8259	</attribute>
8260
8261	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
8262	<desc>Minimum CPU count.</desc>
8263	</attribute>
8264
8265	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
8266	<desc>Maximum CPU count.</desc>
8267	</attribute>
8268
8269	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
8270	<desc>Maximum of monitors which could be connected.</desc>
8271	</attribute>
8272
8273	<attribute name="infoVDSize" type="long long" readonly="yes">
8274	<desc>Maximum size of a virtual disk image in bytes. Informational value,
8275	does not reflect the limits of any virtual disk image format.</desc>
8276	</attribute>
8277
8278	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
8279	<desc>
8280	Maximum number of serial ports associated with every
8281	<link to="IMachine"/> instance.
8282	</desc>
8283	</attribute>
8284
8285	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
8286	<desc>
8287	Maximum number of parallel ports associated with every
8288	<link to="IMachine"/> instance.
8289	</desc>
8290	</attribute>
8291
8292	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
8293	<desc>
8294	Maximum device position in the boot order. This value corresponds
8295	to the total number of devices a machine can boot from, to make it
8296	possible to include all possible devices to the boot list.
8297	<see><link to="IMachine::setBootOrder"/></see>
8298	</desc>
8299	</attribute>
8300
8301	<attribute name="defaultMachineFolder" type="wstring">
8302	<desc>
8303	Full path to the default directory used to create new or open
8304	existing machines when a machine settings file name contains no
8305	path.
8306
8307	Starting with VirtualBox 4.0, by default, this attribute contains
8308	the full path of folder named "VirtualBox VMs" in the user's
8309	home directory, which depends on the host platform.
8310
8311	When setting this attribute, a full path must be specified.
8312	Setting this property to @c null or an empty string or the
8313	special value "Machines" (for compatibility reasons) will restore
8314	that default value.
8315
8316	If the folder specified herein does not exist, it will be created
8317	automatically as needed.
8318
8319	<see>
8320	<link to="IVirtualBox::createMachine"/>,
8321	<link to="IVirtualBox::openMachine"/>
8322	</see>
8323	</desc>
8324	</attribute>
8325
8326	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8327	<desc>
8328	List of all medium storage formats supported by this VirtualBox
8329	installation.
8330
8331	Keep in mind that the medium format identifier
8332	(<link to="IMediumFormat::id"/>) used in other API calls like
8333	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8334	medium format is a case-insensitive string. This means that, for
8335	example, all of the following strings:
8336	<pre>
8337	"VDI"
8338	"vdi"
8339	"VdI"</pre>
8340	refer to the same medium format.
8341
8342	Note that the virtual medium framework is backend-based, therefore
8343	the list of supported formats depends on what backends are currently
8344	installed.
8345
8346	<see><link to="IMediumFormat"/></see>
8347	</desc>
8348	</attribute>
8349
8350	<attribute name="defaultHardDiskFormat" type="wstring">
8351	<desc>
8352	Identifier of the default medium format used by VirtualBox.
8353
8354	The medium format set by this attribute is used by VirtualBox
8355	when the medium format was not specified explicitly. One example is
8356	<link to="IVirtualBox::createHardDisk"/> with the empty
8357	format argument. A more complex example is implicit creation of
8358	differencing media when taking a snapshot of a virtual machine:
8359	this operation will try to use a format of the parent medium first
8360	and if this format does not support differencing media the default
8361	format specified by this argument will be used.
8362
8363	The list of supported medium formats may be obtained by the
8364	<link to="#mediumFormats"/> call. Note that the default medium
8365	format must have a capability to create differencing media;
8366	otherwise operations that create media implicitly may fail
8367	unexpectedly.
8368
8369	The initial value of this property is <tt>"VDI"</tt> in the current
8370	version of the VirtualBox product, but may change in the future.
8371
8372	<note>
8373	Setting this property to @c null or empty string will restore the
8374	initial value.
8375	</note>
8376
8377	<see>
8378	<link to="#mediumFormats"/>,
8379	<link to="IMediumFormat::id"/>,
8380	<link to="IVirtualBox::createHardDisk"/>
8381	</see>
8382	</desc>
8383	</attribute>
8384
8385	<attribute name="freeDiskSpaceWarning" type="long 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 size in
8388	bytes.</desc>
8389	</attribute>
8390
8391	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8392	<desc>Issue a warning if the free disk space is below (or in some disk
8393	intensive operation is expected to go below) the given percentage.</desc>
8394	</attribute>
8395
8396	<attribute name="freeDiskSpaceError" type="long 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 size in
8399	bytes.</desc>
8400	</attribute>
8401
8402	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8403	<desc>Issue an error if the free disk space is below (or in some disk
8404	intensive operation is expected to go below) the given percentage.</desc>
8405	</attribute>
8406
8407	<attribute name="VRDEAuthLibrary" type="wstring">
8408	<desc>
8409	Library that provides authentication for Remote Desktop clients. The library
8410	is used if a virtual machine's authentication type is set to "external"
8411	in the VM RemoteDisplay configuration.
8412
8413	The system library extension (".DLL" or ".so") must be omitted.
8414	A full path can be specified; if not, then the library must reside on the
8415	system's default library path.
8416
8417	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8418	of that name in one of the default VirtualBox library directories.
8419
8420	For details about VirtualBox authentication libraries and how to implement
8421	them, please refer to the VirtualBox manual.
8422
8423	<note>
8424	Setting this property to @c null or empty string will restore the
8425	initial value.
8426	</note>
8427	</desc>
8428	</attribute>
8429
8430	<attribute name="webServiceAuthLibrary" type="wstring">
8431	<desc>
8432	Library that provides authentication for webservice clients. The library
8433	is used if a virtual machine's authentication type is set to "external"
8434	in the VM RemoteDisplay configuration and will be called from
8435	within the <link to="IWebsessionManager::logon" /> implementation.
8436
8437	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8438	there is no per-VM setting for this, as the webservice is a global
8439	resource (if it is running). Only for this setting (for the webservice),
8440	setting this value to a literal <tt>"null"</tt> string disables authentication,
8441	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8442	no matter what user name and password are supplied.
8443
8444	The initial value of this property is <tt>"VBoxAuth"</tt>,
8445	meaning that the webservice will use the same authentication
8446	library that is used by default for VRDE (again, see
8447	<link to="ISystemProperties::VRDEAuthLibrary" />).
8448	The format and calling convention of authentication libraries
8449	is the same for the webservice as it is for VRDE.
8450
8451	<note>
8452	Setting this property to @c null or empty string will restore the
8453	initial value.
8454	</note>
8455	</desc>
8456	</attribute>
8457
8458	<attribute name="defaultVRDEExtPack" type="wstring">
8459	<desc>
8460	The name of the extension pack providing the default VRDE.
8461
8462	This attribute is for choosing between multiple extension packs
8463	providing VRDE. If only one is installed, it will automatically be the
8464	default one. The attribute value can be empty if no VRDE extension
8465	pack is installed.
8466
8467	For details about VirtualBox Remote Desktop Extension and how to
8468	implement one, please refer to the VirtualBox SDK.
8469	</desc>
8470	</attribute>
8471
8472	<attribute name="logHistoryCount" type="unsigned long">
8473	<desc>
8474	This value specifies how many old release log files are kept.
8475	</desc>
8476	</attribute>
8477
8478	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8479	<desc>This value hold the default audio driver for the current
8480	system.</desc>
8481	</attribute>
8482
8483	<attribute name="autostartDatabasePath" type="wstring">
8484	<desc>
8485	The path to the autostart database. Depending on the host this might
8486	be a filesystem path or something else.
8487	</desc>
8488	</attribute>
8489
8490	<attribute name="defaultAdditionsISO" type="wstring">
8491	<desc>
8492	The path to the default Guest Additions ISO image. Can be empty if
8493	the location is not known in this installation.
8494	</desc>
8495	</attribute>
8496
8497	<method name="getMaxNetworkAdapters">
8498	<desc>
8499	Maximum total number of network adapters associated with every
8500	<link to="IMachine"/> instance.
8501	</desc>
8502
8503	<param name="chipset" type="ChipsetType" dir="in">
8504	<desc>The chipset type to get the value for.</desc>
8505	</param>
8506
8507
8508	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8509	<desc>The maximum total number of network adapters allowed.</desc>
8510	</param>
8511
8512	</method>
8513
8514	<method name="getMaxNetworkAdaptersOfType">
8515	<desc>
8516	Maximum number of network adapters of a given attachment type,
8517	associated with every <link to="IMachine"/> instance.
8518	</desc>
8519
8520	<param name="chipset" type="ChipsetType" dir="in">
8521	<desc>The chipset type to get the value for.</desc>
8522	</param>
8523
8524	<param name="type" type="NetworkAttachmentType" dir="in">
8525	<desc>Type of attachment.</desc>
8526	</param>
8527
8528	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8529	<desc>The maximum number of network adapters allowed for
8530	particular chipset and attachment type.</desc>
8531	</param>
8532
8533	</method>
8534
8535
8536	<method name="getMaxDevicesPerPortForStorageBus">
8537	<desc>Returns the maximum number of devices which can be attached to a port
8538	for the given storage bus.</desc>
8539
8540	<param name="bus" type="StorageBus" dir="in">
8541	<desc>The storage bus type to get the value for.</desc>
8542	</param>
8543
8544	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8545	<desc>The maximum number of devices which can be attached to the port for the given
8546	storage bus.</desc>
8547	</param>
8548	</method>
8549
8550	<method name="getMinPortCountForStorageBus">
8551	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8552
8553	<param name="bus" type="StorageBus" dir="in">
8554	<desc>The storage bus type to get the value for.</desc>
8555	</param>
8556
8557	<param name="minPortCount" type="unsigned long" dir="return">
8558	<desc>The minimum number of ports for the given storage bus.</desc>
8559	</param>
8560	</method>
8561
8562	<method name="getMaxPortCountForStorageBus">
8563	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8564
8565	<param name="bus" type="StorageBus" dir="in">
8566	<desc>The storage bus type to get the value for.</desc>
8567	</param>
8568
8569	<param name="maxPortCount" type="unsigned long" dir="return">
8570	<desc>The maximum number of ports for the given storage bus.</desc>
8571	</param>
8572	</method>
8573
8574	<method name="getMaxInstancesOfStorageBus">
8575	<desc>Returns the maximum number of storage bus instances which
8576	can be configured for each VM. This corresponds to the number of
8577	storage controllers one can have. Value may depend on chipset type
8578	used.</desc>
8579
8580	<param name="chipset" type="ChipsetType" dir="in">
8581	<desc>The chipset type to get the value for.</desc>
8582	</param>
8583
8584	<param name="bus" type="StorageBus" dir="in">
8585	<desc>The storage bus type to get the value for.</desc>
8586	</param>
8587
8588	<param name="maxInstances" type="unsigned long" dir="return">
8589	<desc>The maximum number of instances for the given storage bus.</desc>
8590	</param>
8591	</method>
8592
8593	<method name="getDeviceTypesForStorageBus">
8594	<desc>Returns list of all the supported device types
8595	(<link to="DeviceType"/>) for the given type of storage
8596	bus.</desc>
8597
8598	<param name="bus" type="StorageBus" dir="in">
8599	<desc>The storage bus type to get the value for.</desc>
8600	</param>
8601
8602	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8603	<desc>The list of all supported device types for the given storage bus.</desc>
8604	</param>
8605	</method>
8606
8607	<method name="getDefaultIoCacheSettingForStorageController">
8608	<desc>Returns the default I/O cache setting for the
8609	given storage controller</desc>
8610
8611	<param name="controllerType" type="StorageControllerType" dir="in">
8612	<desc>The storage controller to the setting for.</desc>
8613	</param>
8614
8615	<param name="enabled" type="boolean" dir="return">
8616	<desc>Returned flag indicating the default value</desc>
8617	</param>
8618	</method>
8619	</interface>
8620
8621	<!--
8622	// IGuest
8623	/////////////////////////////////////////////////////////////////////////
8624	-->
8625
8626	<interface
8627	name="IGuestOSType" extends="$unknown"
8628	uuid="6d968f9a-858b-4c50-bf17-241f069e94c2"
8629	wsmap="struct"
8630	>
8631	<desc>
8632	</desc>
8633
8634	<attribute name="familyId" type="wstring" readonly="yes">
8635	<desc>Guest OS family identifier string.</desc>
8636	</attribute>
8637
8638	<attribute name="familyDescription" type="wstring" readonly="yes">
8639	<desc>Human readable description of the guest OS family.</desc>
8640	</attribute>
8641
8642	<attribute name="id" type="wstring" readonly="yes">
8643	<desc>Guest OS identifier string.</desc>
8644	</attribute>
8645
8646	<attribute name="description" type="wstring" readonly="yes">
8647	<desc>Human readable description of the guest OS.</desc>
8648	</attribute>
8649
8650	<attribute name="is64Bit" type="boolean" readonly="yes">
8651	<desc>Returns @c true if the given OS is 64-bit</desc>
8652	</attribute>
8653
8654	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8655	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8656	</attribute>
8657
8658	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8659	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8660	</attribute>
8661
8662	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8663	<desc>Recommended RAM size in Megabytes.</desc>
8664	</attribute>
8665
8666	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8667	<desc>Recommended video RAM size in Megabytes.</desc>
8668	</attribute>
8669
8670	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8671	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8672	</attribute>
8673
8674	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8675	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8676	</attribute>
8677
8678	<attribute name="recommendedHDD" type="long long" readonly="yes">
8679	<desc>Recommended hard disk size in bytes.</desc>
8680	</attribute>
8681
8682	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8683	<desc>Returns recommended network adapter for this OS type.</desc>
8684	</attribute>
8685
8686	<attribute name="recommendedPAE" type="boolean" readonly="yes">
8687	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8688	</attribute>
8689
8690	<attribute name="recommendedDVDStorageController" type="StorageControllerType" readonly="yes">
8691	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8692	</attribute>
8693
8694	<attribute name="recommendedDVDStorageBus" type="StorageBus" readonly="yes">
8695	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8696	</attribute>
8697
8698	<attribute name="recommendedHDStorageController" type="StorageControllerType" readonly="yes">
8699	<desc>Recommended storage controller type for HD drives.</desc>
8700	</attribute>
8701
8702	<attribute name="recommendedHDStorageBus" type="StorageBus" readonly="yes">
8703	<desc>Recommended storage bus type for HD drives.</desc>
8704	</attribute>
8705
8706	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8707	<desc>Recommended firmware type.</desc>
8708	</attribute>
8709
8710	<attribute name="recommendedUSBHID" type="boolean" readonly="yes">
8711	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8712	</attribute>
8713
8714	<attribute name="recommendedHPET" type="boolean" readonly="yes">
8715	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8716	</attribute>
8717
8718	<attribute name="recommendedUSBTablet" type="boolean" readonly="yes">
8719	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8720	</attribute>
8721
8722	<attribute name="recommendedRTCUseUTC" type="boolean" readonly="yes">
8723	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8724	</attribute>
8725
8726	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8727	<desc>Recommended chipset type.</desc>
8728	</attribute>
8729
8730	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8731	<desc>Recommended audio type.</desc>
8732	</attribute>
8733
8734	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8735	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8736	</attribute>
8737
8738	<attribute name="recommendedUSB" type="boolean" readonly="yes">
8739	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8740	</attribute>
8741
8742	</interface>
8743
8744	<enum
8745	name="AdditionsFacilityType"
8746	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8747	>
8748	<desc>
8749	Guest Additions facility IDs.
8750	</desc>
8751
8752	<const name="None" value="0">
8753	<desc>No/invalid facility.</desc>
8754	</const>
8755	<const name="VBoxGuestDriver" value="20">
8756	<desc>VirtualBox base driver (VBoxGuest).</desc>
8757	</const>
8758	<const name="AutoLogon" value="90">
8759	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8760	</const>
8761	<const name="VBoxService" value="100">
8762	<desc>VirtualBox system service (VBoxService).</desc>
8763	</const>
8764	<const name="VBoxTrayClient" value="101">
8765	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8766	</const>
8767	<const name="Seamless" value="1000">
8768	<desc>Seamless guest desktop integration.</desc>
8769	</const>
8770	<const name="Graphics" value="1100">
8771	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8772	are not immediately acted on and guest display resizes are probably not initiated by
8773	the guest additions.
8774	</desc>
8775	</const>
8776	<const name="All" value="2147483646">
8777	<desc>All facilities selected.</desc>
8778	</const>
8779	</enum>
8780
8781	<enum
8782	name="AdditionsFacilityClass"
8783	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8784	>
8785	<desc>
8786	Guest Additions facility classes.
8787	</desc>
8788
8789	<const name="None" value="0">
8790	<desc>No/invalid class.</desc>
8791	</const>
8792	<const name="Driver" value="10">
8793	<desc>Driver.</desc>
8794	</const>
8795	<const name="Service" value="30">
8796	<desc>System service.</desc>
8797	</const>
8798	<const name="Program" value="50">
8799	<desc>Program.</desc>
8800	</const>
8801	<const name="Feature" value="100">
8802	<desc>Feature.</desc>
8803	</const>
8804	<const name="ThirdParty" value="999">
8805	<desc>Third party.</desc>
8806	</const>
8807	<const name="All" value="2147483646">
8808	<desc>All facility classes selected.</desc>
8809	</const>
8810	</enum>
8811
8812	<enum
8813	name="AdditionsFacilityStatus"
8814	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8815	>
8816	<desc>
8817	Guest Additions facility states.
8818	</desc>
8819
8820	<const name="Inactive" value="0">
8821	<desc>Facility is not active.</desc>
8822	</const>
8823	<const name="Paused" value="1">
8824	<desc>Facility has been paused.</desc>
8825	</const>
8826	<const name="PreInit" value="20">
8827	<desc>Facility is preparing to initialize.</desc>
8828	</const>
8829	<const name="Init" value="30">
8830	<desc>Facility is initializing.</desc>
8831	</const>
8832	<const name="Active" value="50">
8833	<desc>Facility is up and running.</desc>
8834	</const>
8835	<const name="Terminating" value="100">
8836	<desc>Facility is shutting down.</desc>
8837	</const>
8838	<const name="Terminated" value="101">
8839	<desc>Facility successfully shut down.</desc>
8840	</const>
8841	<const name="Failed" value="800">
8842	<desc>Facility failed to start.</desc>
8843	</const>
8844	<const name="Unknown" value="999">
8845	<desc>Facility status is unknown.</desc>
8846	</const>
8847	</enum>
8848
8849	<interface
8850	name="IAdditionsFacility" extends="$unknown"
8851	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8852	wsmap="struct"
8853	>
8854	<desc>
8855	Structure representing a Guest Additions facility.
8856	</desc>
8857
8858	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8859	<desc>The class this facility is part of.</desc>
8860	</attribute>
8861
8862	<attribute name="lastUpdated" type="long long" readonly="yes">
8863	<desc>
8864	Time stamp of the last status update,
8865	in milliseconds since 1970-01-01 UTC.
8866	</desc>
8867	</attribute>
8868
8869	<attribute name="name" type="wstring" readonly="yes">
8870	<desc>The facility's friendly name.</desc>
8871	</attribute>
8872
8873	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8874	<desc>The current status.</desc>
8875	</attribute>
8876
8877	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8878	<desc>The facility's type ID.</desc>
8879	</attribute>
8880	</interface>
8881
8882	<enum
8883	name="AdditionsRunLevelType"
8884	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8885	>
8886	<desc>
8887	Guest Additions run level type.
8888	</desc>
8889
8890	<const name="None" value="0">
8891	<desc>Guest Additions are not loaded.</desc>
8892	</const>
8893	<const name="System" value="1">
8894	<desc>Guest drivers are loaded.</desc>
8895	</const>
8896	<const name="Userland" value="2">
8897	<desc>Common components (such as application services) are loaded.</desc>
8898	</const>
8899	<const name="Desktop" value="3">
8900	<desc>Per-user desktop components are loaded.</desc>
8901	</const>
8902	</enum>
8903
8904	<enum
8905	name="AdditionsUpdateFlag"
8906	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8907	>
8908	<desc>
8909	Guest Additions update flags.
8910	</desc>
8911
8912	<const name="None" value="0">
8913	<desc>No flag set.</desc>
8914	</const>
8915	<const name="WaitForUpdateStartOnly" value="1">
8916	<desc>Starts the regular updating process and waits until the
8917	actual Guest Additions update inside the guest was started.
8918	This can be necessary due to needed interaction with the guest
8919	OS during the installation phase.</desc>
8920	</const>
8921	</enum>
8922
8923	<enum
8924	name="FileSeekType"
8925	uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
8926	>
8927	<desc>
8928	File seeking types.
8929	</desc>
8930
8931	<const name="Set" value="0">
8932	<desc>Seek from the start of the file.</desc>
8933	</const>
8934	<const name="Current" value="1">
8935	<desc>Seek from the current file position.</desc>
8936	</const>
8937	</enum>
8938
8939	<enum
8940	name="ProcessInputFlag"
8941	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8942	>
8943	<desc>
8944	Guest process input flags.
8945	</desc>
8946	<const name="None" value="0">
8947	<desc>No flag set.</desc>
8948	</const>
8949	<const name="EndOfFile" value="1">
8950	<desc>End of file (input) reached.</desc>
8951	</const>
8952	</enum>
8953
8954	<enum
8955	name="ProcessOutputFlag"
8956	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8957	>
8958	<desc>
8959	Guest process output flags for specifying which
8960	type of output to retrieve.
8961	</desc>
8962	<const name="None" value="0">
8963	<desc>No flags set. Get output from stdout.</desc>
8964	</const>
8965	<const name="StdErr" value="1">
8966	<desc>Get output from stderr.</desc>
8967	</const>
8968	</enum>
8969
8970	<enum
8971	name="ProcessWaitForFlag"
8972	uuid="23b550c7-78e1-437e-98f0-65fd9757bcd2"
8973	>
8974	<desc>
8975	Process waiting flags. Multiple flags can be combined.
8976	</desc>
8977
8978	<const name="None" value="0">
8979	<desc>No waiting flags specified. Do not use this.</desc>
8980	</const>
8981	<const name="Start" value="1">
8982	<desc>Wait for the process being started.</desc>
8983	</const>
8984	<const name="Terminate" value="2">
8985	<desc>Wait for the process being terminated.</desc>
8986	</const>
8987	<const name="StdIn" value="4">
8988	<desc>Wait for stdin becoming available.</desc>
8989	</const>
8990	<const name="StdOut" value="8">
8991	<desc>Wait for data becoming available on stdout.</desc>
8992	</const>
8993	<const name="StdErr" value="16">
8994	<desc>Wait for data becoming available on stderr.</desc>
8995	</const>
8996	</enum>
8997
8998	<enum
8999	name="ProcessWaitResult"
9000	uuid="40719cbe-f192-4fe9-a231-6697b3c8e2b4"
9001	>
9002	<desc>
9003	Process waiting results. Depending on the process waiting flags (for
9004	more information see <link to="ProcessWaitForFlag"/>) the waiting result
9005	can vary based on the processes' current status.
9006
9007	To wait for a gust process to terminate after it has been
9008	created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
9009	one would specify ProcessWaitResult_Terminate.
9010
9011	If a guest process has been started with ProcessCreateFlag_WaitForStdOut
9012	a client can wait with ProcessWaitResult_StdOut for new data to arrive on
9013	stdout; same applies for ProcessCreateFlag_WaitForStdErr and
9014	ProcessWaitResult_StdErr.
9015	</desc>
9016
9017	<const name="None" value="0">
9018	<desc>No result was returned. Not being used.</desc>
9019	</const>
9020	<const name="Start" value="1">
9021	<desc>The process has been started.</desc>
9022	</const>
9023	<const name="Terminate" value="2">
9024	<desc>The process has been terminated.</desc>
9025	</const>
9026	<const name="Status" value="3">
9027	<desc>
9028	The process has changed its status. The status then can
9029	be retrieved via <link to="IProcess::status"/>.
9030	</desc>
9031	</const>
9032	<const name="Error" value="4">
9033	<desc>Error while executing the process.</desc>
9034	</const>
9035	<const name="Timeout" value="5">
9036	<desc>
9037	The waiting operation timed out. This also will happen
9038	when no event has been occured matching the
9039	current waiting flags in a <link to="IProcess::waitFor"/> call.
9040	</desc>
9041	</const>
9042	<const name="StdIn" value="6">
9043	<desc>
9044	The process signalled that stdin became available for writing
9045	and that the process awaits input now.</desc>
9046	</const>
9047	<const name="StdOut" value="7">
9048	<desc>Data on stdout became available for reading.</desc>
9049	</const>
9050	<const name="StdErr" value="8">
9051	<desc>Data on stderr became available for reading.</desc>
9052	</const>
9053	<const name="WaitFlagNotSupported" value="9">
9054	<desc>
9055	A waiting flag specified in the <link to="IProcess::waitFor"/> call
9056	is not supported by the guest.
9057	</desc>
9058	</const>
9059	</enum>
9060
9061	<enum
9062	name="CopyFileFlag"
9063	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
9064	>
9065	<desc>
9066	File copying flags.
9067	</desc>
9068	<const name="None" value="0">
9069	<desc>No flag set.</desc>
9070	</const>
9071	<const name="Recursive" value="1">
9072	<desc>Copy directories recursively.</desc>
9073	</const>
9074	<const name="Update" value="2">
9075	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
9076	</const>
9077	<const name="FollowLinks" value="4">
9078	<desc>Follow symbolic links.</desc>
9079	</const>
9080	</enum>
9081
9082	<enum
9083	name="DirectoryCreateFlag"
9084	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
9085	>
9086	<desc>
9087	Directory creation flags.
9088	</desc>
9089	<const name="None" value="0">
9090	<desc>No flag set.</desc>
9091	</const>
9092	<const name="Parents" value="1">
9093	<desc>No error if existing, make parent directories as needed.</desc>
9094	</const>
9095	</enum>
9096
9097	<enum
9098	name="DirectoryRemoveRecFlag"
9099	uuid="455aabf0-7692-48f6-9061-f21579b65769"
9100	>
9101	<desc>
9102	Directory recursive removement flags.
9103	</desc>
9104
9105	<const name="None" value="0">
9106	<desc>No flag set.</desc>
9107	</const>
9108	<const name="ContentAndDir" value="1">
9109	<desc>Delete the content of the directory and the directory itself.</desc>
9110	</const>
9111	<const name="ContentOnly" value="2">
9112	<desc>Only delete the content of the directory, omit the directory it self.</desc>
9113	</const>
9114	</enum>
9115
9116	<enum
9117	name="PathRenameFlag"
9118	uuid="f3baa09f-c758-453d-b91c-c7787d76351d"
9119	>
9120	<desc>
9121	Path renaming flags.
9122	</desc>
9123
9124	<const name="None" value="0">
9125	<desc>No flag set.</desc>
9126	</const>
9127	<const name="NoReplace" value="1">
9128	<desc>Do not replace anything.</desc>
9129	</const>
9130	<const name="Replace" value="2">
9131	<desc>This will replace attempt any target which isn't a directory.</desc>
9132	</const>
9133	<const name="NoSymlinks" value="4">
9134	<desc>Don't allow symbolic links as part of the path.</desc>
9135	</const>
9136	</enum>
9137
9138	<enum
9139	name="ProcessCreateFlag"
9140	uuid="35192799-bfde-405d-9bea-c735ab9998e4"
9141	>
9142	<desc>
9143	Guest process execution flags.
9144	</desc>
9145
9146	<const name="None" value="0">
9147	<desc>No flag set.</desc>
9148	</const>
9149	<const name="WaitForProcessStartOnly" value="1">
9150	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
9151	process itself then uses an infinite timeout.</desc>
9152	</const>
9153	<const name="IgnoreOrphanedProcesses" value="2">
9154	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
9155	</const>
9156	<const name="Hidden" value="4">
9157	<desc>Do not show the started process according to the guest OS guidelines.</desc>
9158	</const>
9159	<const name="NoProfile" value="8">
9160	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
9161	</const>
9162	<const name="WaitForStdOut" value="16">
9163	<desc>The guest process waits until all data from stdout is read out.</desc>
9164	</const>
9165	<const name="WaitForStdErr" value="32">
9166	<desc>The guest process waits until all data from stderr is read out.</desc>
9167	</const>
9168	<const name="ExpandArguments" value="64">
9169	<desc>Expands environment variables in process arguments.</desc>
9170	</const>
9171	</enum>
9172
9173	<enum
9174	name="ProcessPriority"
9175	uuid="ee8cac50-e232-49fe-806b-d1214d9c2e49"
9176	>
9177	<desc>
9178	Process priorities.
9179	</desc>
9180
9181	<const name="Invalid" value="0">
9182	<desc>Invalid priority, do not use.</desc>
9183	</const>
9184	<const name="Default" value="1">
9185	<desc>Default process priority determined by the OS.</desc>
9186	</const>
9187	</enum>
9188
9189	<enum
9190	name="SymlinkType"
9191	uuid="37794668-f8f1-4714-98a5-6f8fa2ed0118"
9192	>
9193	<desc>
9194	Symbolic link types.
9195	</desc>
9196
9197	<const name="Unknown" value="0">
9198	<desc>It is not known what is being targeted.</desc>
9199	</const>
9200	<const name="Directory" value="1">
9201	<desc>The link targets a directory.</desc>
9202	</const>
9203	<const name="File" value="2">
9204	<desc>The link targets a file (or whatever else).</desc>
9205	</const>
9206	</enum>
9207
9208	<enum
9209	name="SymlinkReadFlag"
9210	uuid="b7fe2b9d-790e-4b25-8adf-1ca33026931f"
9211	>
9212	<desc>
9213	Symbolic link reading flags.
9214	</desc>
9215
9216	<const name="None" value="0">
9217	<desc>No flags set.</desc>
9218	</const>
9219	<const name="NoSymlinks" value="1">
9220	<desc>Don't allow symbolic links as part of the path.</desc>
9221	</const>
9222	</enum>
9223
9224	<enum
9225	name="ProcessStatus"
9226	uuid="4d52368f-5b48-4bfe-b486-acf89139b52f"
9227	>
9228	<desc>
9229	Process execution statuses.
9230	</desc>
9231	<const name="Undefined" value="0">
9232	<desc>Process is in an undefined state.</desc>
9233	</const>
9234
9235	<const name="Starting" value="10">
9236	<desc>Process is being started.</desc>
9237	</const>
9238	<const name="Started" value="100">
9239	<desc>Process has been started.</desc>
9240	</const>
9241	<const name="Paused" value="110">
9242	<desc>Process has been paused.</desc>
9243	</const>
9244	<const name="Terminating" value="480">
9245	<desc>Process is being terminated.</desc>
9246	</const>
9247	<const name="TerminatedNormally" value="500">
9248	<desc>Process terminated normally.</desc>
9249	</const>
9250	<const name="TerminatedSignal" value="510">
9251	<desc>Process terminated via signal.</desc>
9252	</const>
9253	<const name="TerminatedAbnormally" value="511">
9254	<desc>Process terminated abnormally.</desc>
9255	</const>
9256	<const name="TimedOutKilled" value="512">
9257	<desc>Process timed out and was killed.</desc>
9258	</const>
9259	<const name="TimedOutAbnormally" value="513">
9260	<desc>Process timed out and was not killed successfully.</desc>
9261	</const>
9262	<const name="Down" value="600">
9263	<desc>Service/OS is stopping, process was killed.</desc>
9264	</const>
9265	<const name="Error" value="800">
9266	<desc>Something went wrong.</desc>
9267	</const>
9268	</enum>
9269
9270	<enum
9271	name="FsObjType"
9272	uuid="a1ed437c-b3c3-4ca2-b19c-4239d658d5e8"
9273	>
9274	<desc>
9275	File system object type.
9276	</desc>
9277
9278	<const name="Undefined" value="0">
9279	<desc>Type is undefined / unknown.</desc>
9280	</const>
9281	<const name="FIFO" value="1">
9282	<desc>Named pipe.</desc>
9283	</const>
9284	<const name="DevChar" value="10">
9285	<desc>Character device.</desc>
9286	</const>
9287	<const name="DevBlock" value="11">
9288	<desc>Block device.</desc>
9289	</const>
9290	<const name="Directory" value="50">
9291	<desc>Directory.</desc>
9292	</const>
9293	<const name="File" value="80">
9294	<desc>File.</desc>
9295	</const>
9296	<const name="Symlink" value="100">
9297	<desc>Symlink.</desc>
9298	</const>
9299	<const name="Socket" value="200">
9300	<desc>Socket.</desc>
9301	</const>
9302	<const name="Whiteout" value="400">
9303	<desc>Whiteout.</desc>
9304	</const>
9305	</enum>
9306
9307	<enum
9308	name="DragAndDropAction"
9309	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
9310	>
9311	<desc>
9312	Possible actions within an Drag and Drop operation.
9313	</desc>
9314
9315	<const name="Ignore" value="0">
9316	<desc>Do nothing.</desc>
9317	</const>
9318
9319	<const name="Copy" value="1">
9320	<desc>Copy the item to the target.</desc>
9321	</const>
9322
9323	<const name="Move" value="2">
9324	<desc>Move the item to the target.</desc>
9325	</const>
9326
9327	<const name="Link" value="3">
9328	<desc>Link the item from within the target.</desc>
9329	</const>
9330	</enum>
9331
9332	<enum
9333	name="DirectoryOpenFlag"
9334	uuid="5138837a-8fd2-4194-a1b0-08f7bc3949d0"
9335	>
9336	<desc>
9337	Directory open flags.
9338	</desc>
9339	<const name="None" value="0">
9340	<desc>No flag set.</desc>
9341	</const>
9342	<const name="NoSymlinks" value="1">
9343	<desc>Don't allow symbolic links as part of the path.</desc>
9344	</const>
9345	</enum>
9346
9347	<interface
9348	name="IGuestSession" extends="$unknown"
9349	uuid="57eb82a8-822b-42c1-9d1c-5c54bc3d3250"
9350	wsmap="managed"
9351	>
9352	<desc>
9353	A guest session represents one impersonated user account on the guest, so
9354	every operation will use the same credentials specified when creating
9355	the session object via <link to="IGuest::createSession"/>.
9356
9357	There can be a maximum of 32 sessions at once per VM. Each session keeps
9358	track of its started guest processes, opened guest files or guest directories.
9359	To work on guest files or directories a guest session offers methods to open
9360	or create such objects (see <link to="IGuestSession::fileOpen"/> or
9361	<link to="IGuestSession::directoryOpen"/> for example).
9362
9363	When done with either of these objects, including the guest session itself,
9364	use the appropriate close() method to let the object do its cleanup work.
9365
9366	Every guest session has its own environment variable block which gets
9367	automatically applied when starting a new guest process via
9368	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
9369	To override (or unset) certain environment variables already set by the
9370	guest session, one can specify a per-process environment block when using
9371	one of the both above mentioned process creation calls.
9372	</desc>
9373
9374	<attribute name="user" type="wstring" readonly="yes">
9375	<desc>Returns the user name used by this session to impersonate
9376	users on the guest.
9377	</desc>
9378	</attribute>
9379
9380	<attribute name="domain" type="wstring" readonly="yes">
9381	<desc>Returns the domain name used by this session to impersonate
9382	users on the guest.
9383	</desc>
9384	</attribute>
9385
9386	<attribute name="name" type="wstring" readonly="yes">
9387	<desc>Returns the session's friendly name.</desc>
9388	</attribute>
9389
9390	<attribute name="id" type="unsigned long" readonly="yes">
9391	<desc>Returns the internal session ID.</desc>
9392	</attribute>
9393
9394	<attribute name="timeout" type="unsigned long" readonly="no">
9395	<desc>
9396	Returns the session timeout (in ms).
9397	<result name="E_NOTIMPL">
9398	The method is not implemented yet.
9399	</result>
9400	</desc>
9401	</attribute>
9402
9403	<attribute name="environment" type="wstring" safearray="yes">
9404	<desc>
9405	Returns the current session environment.
9406	</desc>
9407	</attribute>
9408
9409	<attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
9410	<desc>
9411	Returns all current guest processes.
9412	</desc>
9413	</attribute>
9414
9415	<attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
9416	<desc>
9417	Returns all currently opened guest directories.
9418	</desc>
9419	</attribute>
9420
9421	<attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
9422	<desc>
9423	Returns all currently opened guest files.
9424	</desc>
9425	</attribute>
9426
9427	<method name="close">
9428	<desc>
9429	Closes this session. All opened guest directories, files and
9430	processes which are not referenced by clients anymore will be
9431	uninitialized.
9432	</desc>
9433	</method>
9434
9435	<method name="copyFrom">
9436	<desc>
9437	Copies a file from guest to the host.
9438
9439	<result name="VBOX_E_IPRT_ERROR">
9440	Error starting the copy operation.
9441	</result>
9442	</desc>
9443	<param name="source" type="wstring" dir="in">
9444	<desc>Source file on the guest to copy to the host.</desc>
9445	</param>
9446	<param name="dest" type="wstring" dir="in">
9447	<desc>Destination file name on the host.</desc>
9448	</param>
9449	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9450	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9451	</param>
9452	<param name="progress" type="IProgress" dir="return">
9453	<desc>Progress object to track the operation completion.</desc>
9454	</param>
9455	</method>
9456
9457	<method name="copyTo">
9458	<desc>
9459	Copies a file from host to the guest.
9460
9461	<result name="VBOX_E_IPRT_ERROR">
9462	Error starting the copy operation.
9463	</result>
9464	</desc>
9465	<param name="source" type="wstring" dir="in">
9466	<desc>Source file on the host to copy to the guest.</desc>
9467	</param>
9468	<param name="dest" type="wstring" dir="in">
9469	<desc>Destination file name on the guest.</desc>
9470	</param>
9471	<param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
9472	<desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
9473	</param>
9474	<param name="progress" type="IProgress" dir="return">
9475	<desc>Progress object to track the operation completion.</desc>
9476	</param>
9477	</method>
9478
9479	<method name="directoryCreate">
9480	<desc>
9481	Create a directory on the guest.
9482
9483	<result name="VBOX_E_IPRT_ERROR">
9484	Error while creating the directory.
9485	</result>
9486	</desc>
9487	<param name="path" type="wstring" dir="in">
9488	<desc>Full path of directory to create.</desc>
9489	</param>
9490	<param name="mode" type="unsigned long" dir="in">
9491	<desc>File creation mode.</desc>
9492	</param>
9493	<param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
9494	<desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
9495	</param>
9496	</method>
9497
9498	<method name="directoryCreateTemp">
9499	<desc>
9500	Create a temporary directory on the guest.
9501
9502	<result name="VBOX_E_NOT_SUPPORTED">
9503	The operation is not possible as requested on this particular
9504	guest type.
9505	</result>
9506	<result name="E_INVALIDARG">
9507	Invalid argument. This includes an incorrectly formatted template,
9508	or a non-absolute path.
9509	</result>
9510	<result name="VBOX_E_IPRT_ERROR">
9511	The temporary directory could not be created. Possible reasons
9512	include a non-existing path or an insecure path when the secure
9513	option was requested.
9514	</result>
9515	</desc>
9516	<param name="templateName" type="wstring" dir="in">
9517	<desc>Template for the name of the directory to create. This must
9518	contain at least one 'X' character. The first group of consecutive
9519	'X' characters in the template will be replaced by a random
9520	alphanumeric string to produce a unique name.</desc>
9521	</param>
9522	<param name="mode" type="unsigned long" dir="in">
9523	<desc>The mode of the directory to create. Use 0700 unless there are
9524	reasons not to. This parameter is ignored if "secure" is specified.
9525	</desc>
9526	</param>
9527	<param name="path" type="wstring" dir="in">
9528	<desc>The absolute path to create the temporary directory in.</desc>
9529	</param>
9530	<param name="secure" type="boolean" dir="in">
9531	<desc>Whether to fail if the directory can not be securely created.
9532	Currently this means that another unprivileged user cannot
9533	manipulate the path specified or remove the temporary directory
9534	after it has been created. Also causes the mode specified to be
9535	ignored. May not be supported on all guest types.</desc>
9536	</param>
9537	<param name="directory" type="wstring" dir="return">
9538	<desc>On success this will contain the name of the directory created
9539	with full path.</desc>
9540	</param>
9541	</method>
9542
9543	<method name="directoryExists">
9544	<desc>
9545	Checks whether a directory exists on the guest or not.
9546
9547	<result name="VBOX_E_IPRT_ERROR">
9548	Error while checking existence of the directory specified.
9549	</result>
9550	</desc>
9551	<param name="path" type="wstring" dir="in">
9552	<desc>Directory to check existence for.</desc>
9553	</param>
9554	<param name="exists" type="boolean" dir="return">
9555	<desc>Returns @c true if the directory exists, @c false if not.</desc>
9556	</param>
9557	</method>
9558
9559	<method name="directoryOpen">
9560	<desc>
9561	Opens a directory and creates a <link to="IGuestDirectory"/> object that
9562	can be used for further operations.
9563
9564	<result name="VBOX_E_OBJECT_NOT_FOUND">
9565	Directory to open was not found.
9566	</result>
9567	<result name="VBOX_E_IPRT_ERROR">
9568	Error while opening the directory.
9569	</result>
9570	</desc>
9571	<param name="path" type="wstring" dir="in">
9572	<desc>Full path to file to open.</desc>
9573	</param>
9574	<param name="filter" type="wstring" dir="in">
9575	<desc>Open filter to apply. This can include wildcards like ? and *.</desc>
9576	</param>
9577	<param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
9578	<desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
9579	</param>
9580	<param name="directory" type="IGuestDirectory" dir="return">
9581	<desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
9582	</param>
9583	</method>
9584
9585	<method name="directoryQueryInfo">
9586	<desc>
9587	Queries information of a directory on the guest.
9588
9589	<result name="VBOX_E_OBJECT_NOT_FOUND">
9590	Directory to query information for was not found.
9591	</result>
9592	<result name="VBOX_E_IPRT_ERROR">
9593	Error querying information.
9594	</result>
9595	</desc>
9596	<param name="path" type="wstring" dir="in">
9597	<desc>Directory to query information for.</desc>
9598	</param>
9599	<param name="info" type="IGuestFsObjInfo" dir="return">
9600	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9601	</param>
9602	</method>
9603
9604	<method name="directoryRemove">
9605	<desc>
9606	Removes a guest directory if not empty.
9607
9608	<result name="E_NOTIMPL">
9609	The method is not implemented yet.
9610	</result>
9611	</desc>
9612	<param name="path" type="wstring" dir="in">
9613	<desc>Full path of directory to remove.</desc>
9614	</param>
9615	</method>
9616
9617	<method name="directoryRemoveRecursive">
9618	<desc>
9619	Removes a guest directory recursively.
9620
9621	<result name="E_NOTIMPL">
9622	The method is not implemented yet.
9623	</result>
9624	</desc>
9625	<param name="path" type="wstring" dir="in">
9626	<desc>Full path of directory to remove recursively.</desc>
9627	</param>
9628	<param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
9629	<desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
9630	</param>
9631	<param name="progress" type="IProgress" dir="return">
9632	<desc>Progress object to track the operation completion.</desc>
9633	</param>
9634	</method>
9635
9636	<method name="directoryRename">
9637	<desc>
9638	Renames a directory on the guest.
9639
9640	<result name="E_NOTIMPL">
9641	The method is not implemented yet.
9642	</result>
9643	</desc>
9644	<param name="source" type="wstring" dir="in">
9645	<desc>Source directory to rename.</desc>
9646	</param>
9647	<param name="dest" type="wstring" dir="in">
9648	<desc>Destination directory to rename the source to.</desc>
9649	</param>
9650	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9651	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9652	</param>
9653	</method>
9654
9655	<method name="directorySetACL">
9656	<desc>
9657	Sets the ACL (Access Control List) of a guest directory.
9658
9659	<result name="E_NOTIMPL">
9660	The method is not implemented yet.
9661	</result>
9662	</desc>
9663	<param name="path" type="wstring" dir="in">
9664	<desc>Full path of directory to set the ACL for.</desc>
9665	</param>
9666	<param name="acl" type="wstring" dir="in">
9667	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
9668	</param>
9669	</method>
9670
9671	<method name="environmentClear">
9672	<desc>
9673	Clears (deletes) all session environment variables.
9674
9675	<result name="VBOX_E_IPRT_ERROR">
9676	Error while clearing the session environment variables.
9677	</result>
9678	</desc>
9679	</method>
9680
9681	<method name="environmentGet">
9682	<desc>
9683	Gets the value of a session environment variable.
9684
9685	<result name="VBOX_E_IPRT_ERROR">
9686	Error while getting the value of the session environment variable.
9687	</result>
9688	</desc>
9689	<param name="name" type="wstring" dir="in">
9690	<desc>Name of session environment variable to get the value for.</desc>
9691	</param>
9692	<param name="value" type="wstring" dir="return">
9693	<desc>
9694	Value of the session environment variable specified. If this variable
9695	does not exist and empty value will be returned.
9696	</desc>
9697	</param>
9698	</method>
9699
9700	<method name="environmentSet">
9701	<desc>
9702	Sets a session environment variable.
9703
9704	<result name="VBOX_E_IPRT_ERROR">
9705	Error while setting the session environment variable.
9706	</result>
9707	</desc>
9708	<param name="name" type="wstring" dir="in">
9709	<desc>Name of session environment variable to set.</desc>
9710	</param>
9711	<param name="value" type="wstring" dir="in">
9712	<desc>Value to set the session environment variable to.</desc>
9713	</param>
9714	</method>
9715
9716	<method name="environmentUnset">
9717	<desc>
9718	Unsets session environment variable.
9719
9720	<result name="VBOX_E_IPRT_ERROR">
9721	Error while unsetting the session environment variable.
9722	</result>
9723	</desc>
9724	<param name="name" type="wstring" dir="in">
9725	<desc>Name of session environment variable to unset (clear).</desc>
9726	</param>
9727	</method>
9728
9729	<method name="fileCreateTemp">
9730	<desc>
9731	Creates a temporary file on the guest.
9732
9733	<result name="VBOX_E_NOT_SUPPORTED">
9734	The operation is not possible as requested on this particular
9735	guest type.
9736	</result>
9737	<result name="E_INVALIDARG">
9738	Invalid argument. This includes an incorrectly formatted template,
9739	or a non-absolute path.
9740	</result>
9741	<result name="VBOX_E_IPRT_ERROR">
9742	The temporary file could not be created. Possible reasons include
9743	a non-existing path or an insecure path when the secure
9744	option was requested.
9745	</result>
9746	</desc>
9747	<param name="templateName" type="wstring" dir="in">
9748	<desc>Template for the name of the file to create. This must contain
9749	at least one 'X' character. The first group of consecutive 'X'
9750	characters in the template will be replaced by a random
9751	alphanumeric string to produce a unique name.
9752	</desc>
9753	</param>
9754	<param name="mode" type="unsigned long" dir="in">
9755	<desc>The mode of the file to create. Use 0700 unless there are
9756	reasons not to. This parameter is ignored if "secure" is specified.
9757	</desc>
9758	</param>
9759	<param name="path" type="wstring" dir="in">
9760	<desc>The absolute path to create the temporary file in.</desc>
9761	</param>
9762	<param name="secure" type="boolean" dir="in">
9763	<desc>Whether to fail if the file can not be securely created.
9764	Currently this means that another unprivileged user cannot
9765	manipulate the path specified or remove the temporary file after
9766	it has been created. Also causes the mode specified to be ignored.
9767	May not be supported on all guest types.</desc>
9768	</param>
9769	<param name="file" type="IGuestFile" dir="return">
9770	<desc>On success this will contain an open file object for the new
9771	temporary file.
9772	</desc>
9773	</param>
9774	</method>
9775
9776	<method name="fileExists">
9777	<desc>
9778	Checks whether a file exists on the guest or not.
9779
9780	<result name="VBOX_E_IPRT_ERROR">
9781	Error while checking existence of the file specified.
9782	</result>
9783	</desc>
9784	<param name="path" type="wstring" dir="in">
9785	<desc>File to check existence for.</desc>
9786	</param>
9787	<param name="exists" type="boolean" dir="return">
9788	<desc>Returns @c true if the file exists, @c false if not.</desc>
9789	</param>
9790	</method>
9791
9792	<method name="fileRemove">
9793	<desc>
9794	Removes a single file on the guest.
9795
9796	<result name="VBOX_E_OBJECT_NOT_FOUND">
9797	File to remove was not found.
9798	</result>
9799	<result name="VBOX_E_IPRT_ERROR">
9800	Error while removing the file.
9801	</result>
9802	</desc>
9803	<param name="path" type="wstring" dir="in">
9804	<desc>Path to the file to remove.</desc>
9805	</param>
9806	</method>
9807
9808	<method name="fileOpen">
9809	<desc>
9810	Opens a file and creates a <link to="IGuestFile"/> object that
9811	can be used for further operations.
9812
9813	<result name="VBOX_E_OBJECT_NOT_FOUND">
9814	File to open was not found.
9815	</result>
9816	<result name="VBOX_E_IPRT_ERROR">
9817	Error while opening the file.
9818	</result>
9819	</desc>
9820	<param name="path" type="wstring" dir="in">
9821	<desc>Full path to file to open.</desc>
9822	</param>
9823	<param name="openMode" type="wstring" dir="in">
9824	<desc>The file open mode.</desc>
9825	</param>
9826	<param name="disposition" type="wstring" dir="in">
9827	<desc>The file disposition.</desc>
9828	</param>
9829	<param name="creationMode" type="unsigned long" dir="in">
9830	<desc>The file creation mode.</desc>
9831	</param>
9832	<param name="offset" type="long long" dir="in">
9833	<desc>The initial read/write offset.</desc>
9834	</param>
9835	<param name="file" type="IGuestFile" dir="return">
9836	<desc><link to="IGuestFile"/> object representing the opened file.</desc>
9837	</param>
9838	</method>
9839
9840	<method name="fileQueryInfo">
9841	<desc>
9842	Queries information of a file on the guest.
9843
9844	<result name="VBOX_E_OBJECT_NOT_FOUND">
9845	File to query information for was not found.
9846	</result>
9847	<result name="VBOX_E_IPRT_ERROR">
9848	Error querying information.
9849	</result>
9850	</desc>
9851	<param name="path" type="wstring" dir="in">
9852	<desc>File to query information for.</desc>
9853	</param>
9854	<param name="info" type="IGuestFsObjInfo" dir="return">
9855	<desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
9856	</param>
9857	</method>
9858
9859	<method name="fileQuerySize">
9860	<desc>
9861	Queries the size of a file on the guest.
9862
9863	<result name="VBOX_E_OBJECT_NOT_FOUND">
9864	File to rename was not found.
9865	</result>
9866	<result name="VBOX_E_IPRT_ERROR">
9867	Error querying file size.
9868	</result>
9869	</desc>
9870	<param name="path" type="wstring" dir="in">
9871	<desc>File to query the size for.</desc>
9872	</param>
9873	<param name="size" type="long long" dir="return">
9874	<desc>Queried file size.</desc>
9875	</param>
9876	</method>
9877
9878	<method name="fileRename">
9879	<desc>
9880	Renames a file on the guest.
9881
9882	<result name="E_NOTIMPL">
9883	The method is not implemented yet.
9884	</result>
9885	</desc>
9886	<param name="source" type="wstring" dir="in">
9887	<desc>Source file to rename.</desc>
9888	</param>
9889	<param name="dest" type="wstring" dir="in">
9890	<desc>Destination file to rename the source to.</desc>
9891	</param>
9892	<param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
9893	<desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
9894	</param>
9895	</method>
9896
9897	<method name="fileSetACL">
9898	<desc>
9899	Sets the ACL (Access Control List) of a file on the guest.
9900
9901	<result name="E_NOTIMPL">
9902	The method is not implemented yet.
9903	</result>
9904	</desc>
9905	<param name="file" type="wstring" dir="in">
9906	<desc>Full path of file to set the ACL for.</desc>
9907	</param>
9908	<param name="acl" type="wstring" dir="in">
9909	<desc>Actual ACL string to set. Must comply with the guest OS.</desc>
9910	</param>
9911	</method>
9912
9913	<method name="processCreate">
9914	<desc>
9915	Executes an existing program inside the guest VM.
9916
9917	<note>
9918	Starting at VirtualBox 4.2 guest process execution by default is limited
9919	to serve up to 255 guest processes at a time. If all 255 guest processes
9920	are still active and running, starting a new guest process will result in an
9921	appropriate error message.
9922
9923	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
9924	is / are set, the guest process will not exit until all data from the specified
9925	stream(s) is / are read out.
9926
9927	To raise or lower the guest process execution limit, either the guest property
9928	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9929	command line by specifying "--control-procs-max-kept" needs to be modified.
9930	A restart of the guest OS is required afterwards. To serve unlimited guest
9931	processes, a value of "0" needs to be set (not recommended).
9932	</note>
9933
9934	<result name="VBOX_E_IPRT_ERROR">
9935	Could not create process.
9936	</result>
9937	</desc>
9938	<param name="command" type="wstring" dir="in">
9939	<desc>
9940	Full path name of the command to execute on the guest; the
9941	commands has to exists in the guest VM in order to be executed.
9942	</desc>
9943	</param>
9944	<param name="arguments" type="wstring" dir="in" safearray="yes">
9945	<desc>Array of arguments passed to the execution command.</desc>
9946	</param>
9947	<param name="environment" type="wstring" dir="in" safearray="yes">
9948	<desc>
9949	Environment variables that can be set while the command is being
9950	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9951	variable just set its name ("NAME") without a value.
9952
9953	This parameter can be used to override environment variables set by
9954	the guest session, which will be applied to the newly started process
9955	in any case.
9956	</desc>
9957	</param>
9958	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
9959	<desc>
9960	Process creation flags;
9961	see <link to="ProcessCreateFlag"/> for more information.
9962	</desc>
9963	</param>
9964	<param name="timeoutMS" type="unsigned long" dir="in">
9965	<desc>
9966	Timeout (in ms) to wait for the operation to complete.
9967	Pass 0 for an infinite timeout.
9968	</desc>
9969	</param>
9970	<param name="guestProcess" type="IGuestProcess" dir="return">
9971	<desc>Guest process object of the newly created process.</desc>
9972	</param>
9973	</method>
9974
9975	<method name="processCreateEx">
9976	<desc>
9977	Executes an existing program inside the guest VM. Extended version for
9978	also setting the process priority and affinity.
9979
9980	<note>
9981	Starting at VirtualBox 4.2 guest process execution by default is limited
9982	to serve up to 255 guest processes at a time. If all 255 guest processes
9983	are still active and running, starting a new guest process will result in an
9984	appropriate error message.
9985
9986	If ProcessCreateFlag_WaitForStdOut and / or respectively ProcessCreateFlag_WaitForStdErr
9987	is / are set, the guest process will not exit until all data from the specified
9988	stream(s) is / are read out.
9989
9990	To raise or lower the guest process execution limit, either the guest property
9991	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9992	command line by specifying "--control-procs-max-kept" needs to be modified.
9993	A restart of the guest OS is required afterwards. To serve unlimited guest
9994	processes, a value of "0" needs to be set (not recommended).
9995	</note>
9996
9997	<result name="VBOX_E_IPRT_ERROR">
9998	Could not create process.
9999	</result>
10000	</desc>
10001	<param name="command" type="wstring" dir="in">
10002	<desc>
10003	Full path name of the command to execute on the guest; the
10004	commands has to exists in the guest VM in order to be executed.
10005	</desc>
10006	</param>
10007	<param name="arguments" type="wstring" dir="in" safearray="yes">
10008	<desc>Array of arguments passed to the execution command.</desc>
10009	</param>
10010	<param name="environment" type="wstring" dir="in" safearray="yes">
10011	<desc>
10012	Environment variables that can be set while the command is being
10013	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
10014	variable just set its name ("NAME") without a value.
10015
10016	This parameter can be used to override environment variables set by
10017	the guest session, which will be applied to the newly started process
10018	in any case.
10019	</desc>
10020	</param>
10021	<param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
10022	<desc>
10023	Process creation flags;
10024	see <link to="ProcessCreateFlag"/> for more information.
10025	</desc>
10026	</param>
10027	<param name="timeoutMS" type="unsigned long" dir="in">
10028	<desc>
10029	Timeout (in ms) to wait for the operation to complete.
10030	Pass 0 for an infinite timeout.
10031	</desc>
10032	</param>
10033	<param name="priority" type="ProcessPriority" dir="in">
10034	<desc>
10035	Process priority to use for execution;
10036	see see <link to="ProcessPriority"/> for more information.</desc>
10037	</param>
10038	<param name="affinity" type="long" dir="in" safearray="yes">
10039	<desc>
10040	Process affinity to use for execution. This parameter
10041	is not implemented yet.
10042	</desc>
10043	</param>
10044	<param name="guestProcess" type="IGuestProcess" dir="return">
10045	<desc>Guest process object of the newly created process.</desc>
10046	</param>
10047	</method>
10048
10049	<method name="processGet">
10050	<desc>
10051	Gets a certain guest process by its process ID (PID).
10052	</desc>
10053	<param name="pid" type="unsigned long" dir="in">
10054	<desc>Process ID (PID) to get guest process for.</desc>
10055	</param>
10056	<param name="guestProcess" type="IGuestProcess" dir="return">
10057	<desc>Guest process of specified process ID (PID).</desc>
10058	</param>
10059	</method>
10060
10061	<method name="symlinkCreate">
10062	<desc>
10063	Creates a symbolic link on the guest.
10064
10065	<result name="E_NOTIMPL">
10066	The method is not implemented yet.
10067	</result>
10068	</desc>
10069	<param name="source" type="wstring" dir="in">
10070	<desc>The name of the symbolic link.</desc>
10071	</param>
10072	<param name="target" type="wstring" dir="in">
10073	<desc>The path to the symbolic link target.</desc>
10074	</param>
10075	<param name="type" type="SymlinkType" dir="in">
10076	<desc>
10077	The symbolic link type;
10078	see <link to="SymlinkReadFlag"/> for more information.
10079	</desc>
10080	</param>
10081	</method>
10082
10083	<method name="symlinkExists">
10084	<desc>
10085	Checks whether a symbolic link exists on the guest or not.
10086
10087	<result name="E_NOTIMPL">
10088	The method is not implemented yet.
10089	</result>
10090	</desc>
10091	<param name="symlink" type="wstring" dir="in">
10092	<desc>Symbolic link to check existence for.</desc>
10093	</param>
10094	<param name="exists" type="boolean" dir="return">
10095	<desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
10096	</param>
10097	</method>
10098
10099	<method name="symlinkRead">
10100	<desc>
10101	Reads a symbolic link on the guest.
10102
10103	<result name="E_NOTIMPL">
10104	The method is not implemented yet.
10105	</result>
10106	</desc>
10107	<param name="symlink" type="wstring" dir="in">
10108	<desc>Full path to symbolic link to read.</desc>
10109	</param>
10110	<param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
10111	<desc>
10112	Read flags; see <link to="SymlinkReadFlag"/> for more information.
10113	</desc>
10114	</param>
10115	<param name="target" type="wstring" dir="return">
10116	<desc>
10117	Target of the symbolic link pointing to, if found.
10118	</desc>
10119	</param>
10120	</method>
10121
10122	<method name="symlinkRemoveDirectory">
10123	<desc>
10124	Removes a symbolic link on the guest if it's a directory.
10125
10126	<result name="E_NOTIMPL">
10127	The method is not implemented yet.
10128	</result>
10129	</desc>
10130	<param name="path" type="wstring" dir="in">
10131	<desc>Symbolic link to remove.</desc>
10132	</param>
10133	</method>
10134
10135	<method name="symlinkRemoveFile">
10136	<desc>
10137	Removes a symbolic link on the guest if it's a file.
10138
10139	<result name="E_NOTIMPL">
10140	The method is not implemented yet.
10141	</result>
10142	</desc>
10143	<param name="file" type="wstring" dir="in">
10144	<desc>Symbolic link to remove.</desc>
10145	</param>
10146	</method>
10147
10148	</interface>
10149
10150	<interface
10151	name="IProcess" extends="$unknown"
10152	uuid="08864d56-96ab-418b-adbc-5a679532aeb0"
10153	wsmap="managed"
10154	>
10155	<desc>
10156	Abstract parent interface for processes handled by VirtualBox.
10157	</desc>
10158	<attribute name="PID" type="unsigned long" readonly="yes">
10159	<desc>
10160	The process ID (PID).
10161	</desc>
10162	</attribute>
10163	<attribute name="status" type="ProcessStatus" readonly="yes">
10164	<desc>
10165	The current process status; see <link to="ProcessStatus"/>
10166	for more information.
10167	</desc>
10168	</attribute>
10169	<attribute name="exitCode" type="long" readonly="yes">
10170	<desc>
10171	The exit code. Only available when the process has been
10172	terminated normally.
10173	</desc>
10174	</attribute>
10175	<attribute name="environment" type="wstring" readonly="yes" safearray="yes">
10176	<desc>
10177	The environment block this process is using during execution.
10178	</desc>
10179	</attribute>
10180	<attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
10181	<desc>
10182	The arguments this process is using for execution.
10183	</desc>
10184	</attribute>
10185	<attribute name="executablePath" type="wstring" readonly="yes">
10186	<desc>Full path of the actual executable image.</desc>
10187	</attribute>
10188	<attribute name="name" type="wstring" readonly="yes">
10189	<desc>The friendly name of this process.</desc>
10190	</attribute>
10191
10192	<method name="waitFor">
10193	<desc>
10194	Waits for one more events to happen.
10195	</desc>
10196	<param name="waitFor" type="unsigned long" dir="in">
10197	<desc>
10198	Specifies what to wait for;
10199	see <link to="ProcessWaitForFlag"/> for more information.
10200	</desc>
10201	</param>
10202	<param name="timeoutMS" type="unsigned long" dir="in">
10203	<desc>
10204	Timeout (in ms) to wait for the operation to complete.
10205	Pass 0 for an infinite timeout.
10206	</desc>
10207	</param>
10208	<param name="reason" type="ProcessWaitResult" dir="return">
10209	<desc>
10210	The overall wait result;
10211	see <link to="ProcessWaitResult"/> for more information.
10212	</desc>
10213	</param>
10214	</method>
10215
10216	<method name="waitForArray">
10217	<desc>
10218	Waits for one more events to happen.
10219	Scriptable version of <link to="#waitFor" />.
10220	</desc>
10221	<param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
10222	<desc>
10223	Specifies what to wait for;
10224	see <link to="ProcessWaitForFlag"/> for more information.
10225	</desc>
10226	</param>
10227	<param name="timeoutMS" type="unsigned long" dir="in">
10228	<desc>
10229	Timeout (in ms) to wait for the operation to complete.
10230	Pass 0 for an infinite timeout.
10231	</desc>
10232	</param>
10233	<param name="reason" type="ProcessWaitResult" dir="return">
10234	<desc>
10235	The overall wait result;
10236	see <link to="ProcessWaitResult"/> for more information.
10237	</desc>
10238	</param>
10239	</method>
10240
10241	<method name="read">
10242	<desc>
10243	Reads data from a running process.
10244	</desc>
10245	<param name="handle" type="unsigned long" dir="in">
10246	<desc>Handle to read from. Usually 0 is stdin.</desc>
10247	</param>
10248	<param name="toRead" type="unsigned long" dir="in">
10249	<desc>Number of bytes to read.</desc>
10250	</param>
10251	<param name="timeoutMS" type="unsigned long" dir="in">
10252	<desc>
10253	Timeout (in ms) to wait for the operation to complete.
10254	Pass 0 for an infinite timeout.
10255	</desc>
10256	</param>
10257	<param name="data" type="octet" dir="return" safearray="yes">
10258	<desc>Array of data read.</desc>
10259	</param>
10260	</method>
10261
10262	<method name="write">
10263	<desc>
10264	Writes data to a running process.
10265	</desc>
10266	<param name="handle" type="unsigned long" dir="in">
10267	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10268	</param>
10269	<param name="flags" type="unsigned long" dir="in">
10270	<desc>
10271	A combination of <link to="ProcessInputFlag"/> flags.
10272	</desc>
10273	</param>
10274	<param name="data" type="octet" dir="in" safearray="yes">
10275	<desc>
10276	Array of bytes to write. The size of the array also specifies
10277	how much to write.
10278	</desc>
10279	</param>
10280	<param name="timeoutMS" type="unsigned long" dir="in">
10281	<desc>
10282	Timeout (in ms) to wait for the operation to complete.
10283	Pass 0 for an infinite timeout.
10284	</desc>
10285	</param>
10286	<param name="written" type="unsigned long" dir="return">
10287	<desc>How much bytes were written.</desc>
10288	</param>
10289	</method>
10290
10291	<method name="writeArray">
10292	<desc>
10293	Writes data to a running process.
10294	Scriptable version of <link to="#write" />.
10295	</desc>
10296	<param name="handle" type="unsigned long" dir="in">
10297	<desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
10298	</param>
10299	<param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
10300	<desc>
10301	A combination of <link to="ProcessInputFlag"/> flags.
10302	</desc>
10303	</param>
10304	<param name="data" type="octet" dir="in" safearray="yes">
10305	<desc>
10306	Array of bytes to write. The size of the array also specifies
10307	how much to write.
10308	</desc>
10309	</param>
10310	<param name="timeoutMS" type="unsigned long" dir="in">
10311	<desc>
10312	Timeout (in ms) to wait for the operation to complete.
10313	Pass 0 for an infinite timeout.
10314	</desc>
10315	</param>
10316	<param name="written" type="unsigned long" dir="return">
10317	<desc>How much bytes were written.</desc>
10318	</param>
10319	</method>
10320
10321	<method name="terminate">
10322	<desc>
10323	Terminates (kills) a running process.
10324	</desc>
10325	</method>
10326	</interface>
10327
10328	<interface
10329	name="IGuestProcess" extends="IProcess"
10330	uuid="dfa39a36-5d43-4840-a025-67ea956b3111"
10331	wsmap="managed"
10332	>
10333	<desc>
10334	Implementation of the <link to="IProcess" /> object
10335	for processes on the guest.
10336	</desc>
10337	</interface>
10338
10339	<interface
10340	name="IDirectory" extends="$unknown"
10341	uuid="1b70dd03-26d7-483a-8877-89bbb0f87b70"
10342	wsmap="managed"
10343	>
10344	<desc>
10345	Abstract parent interface for directories handled by VirtualBox.
10346	</desc>
10347
10348	<attribute name="directoryName" type="wstring" readonly="yes">
10349	<desc>
10350	Full path of directory.
10351	</desc>
10352	</attribute>
10353
10354	<attribute name="filter" type="wstring" readonly="yes">
10355	<desc>
10356	The open filter.
10357	</desc>
10358	</attribute>
10359
10360	<method name="close">
10361	<desc>
10362	Closes this directory. After closing operations like reading the next
10363	directory entry will not be possible anymore.
10364	</desc>
10365	</method>
10366
10367	<method name="read">
10368	<desc>
10369	Reads the next directory entry of this directory.
10370	<result name="VBOX_E_OBJECT_NOT_FOUND">
10371	No more directory entries to read.
10372	</result>
10373	</desc>
10374	<param name="objInfo" type="IFsObjInfo" dir="return">
10375	<desc>Object information of the current directory entry read. Also see <link to="IFsObjInfo"/>.</desc>
10376	</param>
10377	</method>
10378	</interface>
10379
10380	<interface
10381	name="IGuestDirectory" extends="IDirectory"
10382	uuid="af4a8ce0-0725-42b7-8826-46e3c7ba7357"
10383	wsmap="managed"
10384	>
10385	<desc>
10386	Implementation of the <link to="IDirectory" /> object
10387	for directories on the guest.
10388	</desc>
10389	</interface>
10390
10391	<interface
10392	name="IFile" extends="$unknown"
10393	uuid="b702a560-6139-4a8e-a892-bbf14b97bf97"
10394	wsmap="managed"
10395	>
10396	<desc>
10397	Abstract parent interface for files handled by VirtualBox.
10398	</desc>
10399	<attribute name="creationMode" type="unsigned long" readonly="yes">
10400	<desc>
10401	The creation mode.
10402	</desc>
10403	</attribute>
10404	<attribute name="disposition" type="unsigned long" readonly="yes">
10405	<desc>
10406	The disposition mode.
10407	</desc>
10408	</attribute>
10409	<attribute name="fileName" type="wstring" readonly="yes">
10410	<desc>
10411	Full path of the actual file name of this file.
10412	</desc>
10413	</attribute>
10414	<attribute name="initialSize" type="long long" readonly="yes">
10415	<desc>
10416	The initial size in bytes when opened.
10417	</desc>
10418	</attribute>
10419	<attribute name="openMode" type="unsigned long" readonly="yes">
10420	<desc>
10421	The open mode.
10422	</desc>
10423	</attribute>
10424	<attribute name="offset" type="long long" readonly="yes">
10425	<desc>
10426	Current read/write offset in bytes.
10427	</desc>
10428	</attribute>
10429
10430	<method name="close">
10431	<desc>
10432	Closes this file. After closing operations like reading data,
10433	writing data or querying information will not be possible anymore.
10434	</desc>
10435	</method>
10436
10437	<method name="queryInfo">
10438	<desc>
10439	Queries information about this file.
10440
10441	<result name="E_NOTIMPL">
10442	The method is not implemented yet.
10443	</result>
10444	</desc>
10445	<param name="objInfo" type="IFsObjInfo" dir="return">
10446	<desc>Object information of this file. Also see <link to="IFsObjInfo"/>.</desc>
10447	</param>
10448	</method>
10449
10450	<method name="read">
10451	<desc>
10452	Reads data from this file.
10453
10454	<result name="E_NOTIMPL">
10455	The method is not implemented yet.
10456	</result>
10457	</desc>
10458	<param name="toRead" type="unsigned long" dir="in">
10459	<desc>Number of bytes to read.</desc>
10460	</param>
10461	<param name="timeoutMS" type="unsigned long" dir="in">
10462	<desc>
10463	Timeout (in ms) to wait for the operation to complete.
10464	Pass 0 for an infinite timeout.
10465	</desc>
10466	</param>
10467	<param name="data" type="octet" dir="return" safearray="yes">
10468	<desc>Array of data read.</desc>
10469	</param>
10470	</method>
10471
10472	<method name="readAt">
10473	<desc>
10474	Reads data from an offset of this file.
10475
10476	<result name="E_NOTIMPL">
10477	The method is not implemented yet.
10478	</result>
10479	</desc>
10480	<param name="offset" type="long long" dir="in">
10481	<desc>Offset in bytes to start reading.</desc>
10482	</param>
10483	<param name="toRead" type="unsigned long" dir="in">
10484	<desc>Number of bytes to read.</desc>
10485	</param>
10486	<param name="timeoutMS" type="unsigned long" dir="in">
10487	<desc>
10488	Timeout (in ms) to wait for the operation to complete.
10489	Pass 0 for an infinite timeout.
10490	</desc>
10491	</param>
10492	<param name="data" type="octet" dir="return" safearray="yes">
10493	<desc>Array of data read.</desc>
10494	</param>
10495	</method>
10496
10497	<method name="seek">
10498	<desc>
10499	Changes the read and write position of this file.
10500
10501	<result name="E_NOTIMPL">
10502	The method is not implemented yet.
10503	</result>
10504	</desc>
10505	<param name="offset" type="long long" dir="in">
10506	<desc>Offset to seek.</desc>
10507	</param>
10508	<param name="whence" type="FileSeekType" dir="in">
10509	<desc>
10510	Seek mode; see <link to="FileSeekType"/> for more information.
10511	</desc>
10512	</param>
10513	</method>
10514
10515	<method name="setACL">
10516	<desc>
10517	Sets the ACL of this file.
10518
10519	<result name="E_NOTIMPL">
10520	The method is not implemented yet.
10521	</result>
10522	</desc>
10523	<param name="acl" type="wstring" dir="in">
10524	<desc>ACL string to set.</desc>
10525	</param>
10526	</method>
10527
10528	<method name="write">
10529	<desc>
10530	Writes bytes to this file.
10531	</desc>
10532	<param name="data" type="octet" dir="in" safearray="yes">
10533	<desc>
10534	Array of bytes to write. The size of the array also specifies
10535	how much to write.
10536	</desc>
10537	</param>
10538	<param name="timeoutMS" type="unsigned long" dir="in">
10539	<desc>
10540	Timeout (in ms) to wait for the operation to complete.
10541	Pass 0 for an infinite timeout.
10542	</desc>
10543	</param>
10544	<param name="written" type="unsigned long" dir="return">
10545	<desc>How much bytes were written.</desc>
10546	</param>
10547	</method>
10548
10549	<method name="writeAt">
10550	<desc>
10551	Writes bytes at a certain offset to this file.
10552
10553	<result name="E_NOTIMPL">
10554	The method is not implemented yet.
10555	</result>
10556	</desc>
10557	<param name="offset" type="long long" dir="in">
10558	<desc>Offset in bytes to start writing.</desc>
10559	</param>
10560	<param name="data" type="octet" dir="in" safearray="yes">
10561	<desc>
10562	Array of bytes to write. The size of the array also specifies
10563	how much to write.
10564	</desc>
10565	</param>
10566	<param name="timeoutMS" type="unsigned long" dir="in">
10567	<desc>
10568	Timeout (in ms) to wait for the operation to complete.
10569	Pass 0 for an infinite timeout.
10570	</desc>
10571	</param>
10572	<param name="written" type="unsigned long" dir="return">
10573	<desc>How much bytes were written.</desc>
10574	</param>
10575	</method>
10576
10577	</interface>
10578
10579	<interface
10580	name="IGuestFile" extends="IFile"
10581	uuid="60661aec-145f-4d11-b80e-8ea151598093"
10582	wsmap="managed"
10583	>
10584	<desc>
10585	Implementation of the <link to="IFile" /> object
10586	for files on the guest.
10587	</desc>
10588	</interface>
10589
10590	<interface
10591	name="IFsObjInfo" extends="$unknown"
10592	uuid="4047ba30-7006-4966-ae86-94164e5e20eb"
10593	wsmap="managed"
10594	>
10595	<desc>
10596	Abstract parent interface for VirtualBox file system object information.
10597	This can be information about a file or a directory, for example.
10598	</desc>
10599
10600	<attribute name="accessTime" type="long long" readonly="yes">
10601	<desc>
10602	Time of last access (st_atime).
10603	</desc>
10604	</attribute>
10605	<attribute name="allocatedSize" type="long long" readonly="yes">
10606	<desc>
10607	Disk allocation size (st_blocks * DEV_BSIZE).
10608	</desc>
10609	</attribute>
10610	<attribute name="birthTime" type="long long" readonly="yes">
10611	<desc>
10612	Time of file birth (st_birthtime).
10613	</desc>
10614	</attribute>
10615	<attribute name="changeTime" type="long long" readonly="yes">
10616	<desc>
10617	Time of last status change (st_ctime).
10618	</desc>
10619	</attribute>
10620	<attribute name="deviceNumber" type="unsigned long" readonly="yes">
10621	<desc>
10622	The device number of a character or block device type object (st_rdev).
10623	</desc>
10624	</attribute>
10625	<attribute name="fileAttributes" type="wstring" readonly="yes">
10626	<desc>
10627	File attributes. Not implemented yet.
10628	</desc>
10629	</attribute>
10630	<attribute name="generationId" type="unsigned long" readonly="yes">
10631	<desc>
10632	The current generation number (st_gen).
10633	</desc>
10634	</attribute>
10635	<attribute name="GID" type="unsigned long" readonly="yes">
10636	<desc>
10637	The group the filesystem object is assigned (st_gid).
10638	</desc>
10639	</attribute>
10640	<attribute name="groupName" type="wstring" readonly="yes">
10641	<desc>
10642	The group name.
10643	</desc>
10644	</attribute>
10645	<attribute name="hardLinks" type="unsigned long" readonly="yes">
10646	<desc>
10647	Number of hard links to this filesystem object (st_nlink).
10648	</desc>
10649	</attribute>
10650	<attribute name="modificationTime" type="long long" readonly="yes">
10651	<desc>
10652	Time of last data modification (st_mtime).
10653	</desc>
10654	</attribute>
10655	<attribute name="name" type="wstring" readonly="yes">
10656	<desc>
10657	The object's name.
10658	</desc>
10659	</attribute>
10660	<attribute name="nodeId" type="long long" readonly="yes">
10661	<desc>
10662	The unique identifier (within the filesystem) of this filesystem object (st_ino).
10663	</desc>
10664	</attribute>
10665	<attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
10666	<desc>
10667	The device number of the device which this filesystem object resides on (st_dev).
10668	</desc>
10669	</attribute>
10670	<attribute name="objectSize" type="long long" readonly="yes">
10671	<desc>
10672	The logical size (st_size). For normal files this is the size of the file.
10673	For symbolic links, this is the length of the path name contained in the
10674	symbolic link. For other objects this fields needs to be specified.
10675	</desc>
10676	</attribute>
10677	<attribute name="type" type="FsObjType" readonly="yes">
10678	<desc>
10679	The object type. See <link to="FsObjType" /> for more.
10680	</desc>
10681	</attribute>
10682	<attribute name="UID" type="unsigned long" readonly="yes">
10683	<desc>
10684	The user owning the filesystem object (st_uid).
10685	</desc>
10686	</attribute>
10687	<attribute name="userFlags" type="unsigned long" readonly="yes">
10688	<desc>
10689	User flags (st_flags).
10690	</desc>
10691	</attribute>
10692	<attribute name="userName" type="wstring" readonly="yes">
10693	<desc>
10694	The user name.
10695	</desc>
10696	</attribute>
10697
10698	</interface>
10699
10700	<interface
10701	name="IGuestFsObjInfo" extends="IFsObjInfo"
10702	uuid="d5cf678e-3484-4e4a-ac55-329e15462e18"
10703	wsmap="managed"
10704	>
10705	<desc>
10706	Represents the guest implementation of the
10707	<link to="IFsObjInfo" /> object.
10708	</desc>
10709	</interface>
10710
10711	<interface
10712	name="IGuest" extends="$unknown"
10713	uuid="19c32350-0618-4ede-b0c3-2b4311bf0d9b"
10714	wsmap="managed"
10715	>
10716	<desc>
10717	The IGuest interface represents information about the operating system
10718	running inside the virtual machine. Used in
10719	<link to="IConsole::guest"/>.
10720
10721	IGuest provides information about the guest operating system, whether
10722	Guest Additions are installed and other OS-specific virtual machine
10723	properties.
10724	</desc>
10725
10726	<attribute name="OSTypeId" type="wstring" readonly="yes">
10727	<desc>
10728	Identifier of the Guest OS type as reported by the Guest
10729	Additions.
10730	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
10731	an IGuestOSType object representing details about the given
10732	Guest OS type.
10733	<note>
10734	If Guest Additions are not installed, this value will be
10735	the same as <link to="IMachine::OSTypeId"/>.
10736	</note>
10737	</desc>
10738	</attribute>
10739
10740	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
10741	<desc>
10742	Current run level of the Guest Additions.
10743	</desc>
10744	</attribute>
10745
10746	<attribute name="additionsVersion" type="wstring" readonly="yes">
10747	<desc>
10748	Version of the Guest Additions in the same format as
10749	<link to="IVirtualBox::version"/>.
10750	</desc>
10751	</attribute>
10752
10753	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
10754	<desc>
10755	The internal build revision number of the additions.
10756
10757	See also <link to="IVirtualBox::revision"/>.
10758	</desc>
10759	</attribute>
10760
10761	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
10762	<desc>
10763	Array of current known facilities. Only returns facilities where a status is known,
10764	e.g. facilities with an unknown status will not be returned.
10765	</desc>
10766	</attribute>
10767
10768	<attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
10769	<desc>Returns a collection of all opened guest sessions.</desc>
10770	</attribute>
10771
10772	<attribute name="memoryBalloonSize" type="unsigned long">
10773	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
10774	</attribute>
10775
10776	<attribute name="statisticsUpdateInterval" type="unsigned long">
10777	<desc>Interval to update guest statistics in seconds.</desc>
10778	</attribute>
10779
10780	<method name="internalGetStatistics">
10781	<desc>
10782	Internal method; do not use as it might change at any time.
10783	</desc>
10784	<param name="cpuUser" type="unsigned long" dir="out">
10785	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
10786	</param>
10787	<param name="cpuKernel" type="unsigned long" dir="out">
10788	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
10789	</param>
10790	<param name="cpuIdle" type="unsigned long" dir="out">
10791	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
10792	</param>
10793	<param name="memTotal" type="unsigned long" dir="out">
10794	<desc>Total amount of physical guest RAM.</desc>
10795	</param>
10796	<param name="memFree" type="unsigned long" dir="out">
10797	<desc>Free amount of physical guest RAM.</desc>
10798	</param>
10799	<param name="memBalloon" type="unsigned long" dir="out">
10800	<desc>Amount of ballooned physical guest RAM.</desc>
10801	</param>
10802	<param name="memShared" type="unsigned long" dir="out">
10803	<desc>Amount of shared physical guest RAM.</desc>
10804	</param>
10805	<param name="memCache" type="unsigned long" dir="out">
10806	<desc>Total amount of guest (disk) cache memory.</desc>
10807	</param>
10808	<param name="pagedTotal" type="unsigned long" dir="out">
10809	<desc>Total amount of space in the page file.</desc>
10810	</param>
10811	<param name="memAllocTotal" type="unsigned long" dir="out">
10812	<desc>Total amount of memory allocated by the hypervisor.</desc>
10813	</param>
10814	<param name="memFreeTotal" type="unsigned long" dir="out">
10815	<desc>Total amount of free memory available in the hypervisor.</desc>
10816	</param>
10817	<param name="memBalloonTotal" type="unsigned long" dir="out">
10818	<desc>Total amount of memory ballooned by the hypervisor.</desc>
10819	</param>
10820	<param name="memSharedTotal" type="unsigned long" dir="out">
10821	<desc>Total amount of shared memory in the hypervisor.</desc>
10822	</param>
10823	</method>
10824
10825	<method name="getFacilityStatus">
10826	<desc>
10827	Get the current status of a Guest Additions facility.
10828	</desc>
10829	<param name="facility" type="AdditionsFacilityType" dir="in">
10830	<desc>Facility to check status for.</desc>
10831	</param>
10832	<param name="timestamp" type="long long" dir="out">
10833	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
10834	</param>
10835	<param name="status" type="AdditionsFacilityStatus" dir="return">
10836	<desc>The current (latest) facility status.</desc>
10837	</param>
10838	</method>
10839
10840	<method name="getAdditionsStatus">
10841	<desc>
10842	Retrieve the current status of a certain Guest Additions run level.
10843
10844	<result name="VBOX_E_NOT_SUPPORTED">
10845	Wrong status level specified.
10846	</result>
10847
10848	</desc>
10849	<param name="level" type="AdditionsRunLevelType" dir="in">
10850	<desc>Status level to check</desc>
10851	</param>
10852	<param name="active" type="boolean" dir="return">
10853	<desc>Flag whether the status level has been reached or not</desc>
10854	</param>
10855	</method>
10856
10857	<method name="setCredentials">
10858	<desc>
10859	Store login credentials that can be queried by guest operating
10860	systems with Additions installed. The credentials are transient
10861	to the session and the guest may also choose to erase them. Note
10862	that the caller cannot determine whether the guest operating system
10863	has queried or made use of the credentials.
10864
10865	<result name="VBOX_E_VM_ERROR">
10866	VMM device is not available.
10867	</result>
10868
10869	</desc>
10870	<param name="userName" type="wstring" dir="in">
10871	<desc>User name string, can be empty</desc>
10872	</param>
10873	<param name="password" type="wstring" dir="in">
10874	<desc>Password string, can be empty</desc>
10875	</param>
10876	<param name="domain" type="wstring" dir="in">
10877	<desc>Domain name (guest logon scheme specific), can be empty</desc>
10878	</param>
10879	<param name="allowInteractiveLogon" type="boolean" dir="in">
10880	<desc>
10881	Flag whether the guest should alternatively allow the user to
10882	interactively specify different credentials. This flag might
10883	not be supported by all versions of the Additions.
10884	</desc>
10885	</param>
10886	</method>
10887
10888	<method name="dragHGEnter">
10889	<desc>
10890	Informs the guest about a Drag and Drop enter event.
10891
10892	This is used in Host - Guest direction.
10893
10894	<result name="VBOX_E_VM_ERROR">
10895	VMM device is not available.
10896	</result>
10897
10898	</desc>
10899	<param name="screenId" type="unsigned long" dir="in">
10900	<desc>The screen id where the Drag and Drop event occured.</desc>
10901	</param>
10902	<param name="y" type="unsigned long" dir="in">
10903	<desc>y-position of the event.</desc>
10904	</param>
10905	<param name="x" type="unsigned long" dir="in">
10906	<desc>x-position of the event.</desc>
10907	</param>
10908	<param name="defaultAction" type="DragAndDropAction" dir="in">
10909	<desc>The default action to use.</desc>
10910	</param>
10911	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10912	<desc>The actions which are allowed.</desc>
10913	</param>
10914	<param name="formats" type="wstring" dir="in" safearray="yes">
10915	<desc>The supported mime types.</desc>
10916	</param>
10917	<param name="resultAction" type="DragAndDropAction" dir="return">
10918	<desc>The resulting action of this event.</desc>
10919	</param>
10920	</method>
10921
10922	<method name="dragHGMove">
10923	<desc>
10924	Informs the guest about a Drag and Drop move event.
10925
10926	This is used in Host - Guest direction.
10927
10928	<result name="VBOX_E_VM_ERROR">
10929	VMM device is not available.
10930	</result>
10931
10932	</desc>
10933	<param name="screenId" type="unsigned long" dir="in">
10934	<desc>The screen id where the Drag and Drop event occured.</desc>
10935	</param>
10936	<param name="x" type="unsigned long" dir="in">
10937	<desc>x-position of the event.</desc>
10938	</param>
10939	<param name="y" type="unsigned long" dir="in">
10940	<desc>y-position of the event.</desc>
10941	</param>
10942	<param name="defaultAction" type="DragAndDropAction" dir="in">
10943	<desc>The default action to use.</desc>
10944	</param>
10945	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10946	<desc>The actions which are allowed.</desc>
10947	</param>
10948	<param name="formats" type="wstring" dir="in" safearray="yes">
10949	<desc>The supported mime types.</desc>
10950	</param>
10951	<param name="resultAction" type="DragAndDropAction" dir="return">
10952	<desc>The resulting action of this event.</desc>
10953	</param>
10954	</method>
10955
10956	<method name="dragHGLeave">
10957	<desc>
10958	Informs the guest about a Drag and Drop leave event.
10959
10960	This is used in Host - Guest direction.
10961
10962	<result name="VBOX_E_VM_ERROR">
10963	VMM device is not available.
10964	</result>
10965
10966	</desc>
10967	<param name="screenId" type="unsigned long" dir="in">
10968	<desc>The screen id where the Drag and Drop event occured.</desc>
10969	</param>
10970	</method>
10971
10972	<method name="dragHGDrop">
10973	<desc>
10974	Informs the guest about a drop event.
10975
10976	This is used in Host - Guest direction.
10977
10978	<result name="VBOX_E_VM_ERROR">
10979	VMM device is not available.
10980	</result>
10981
10982	</desc>
10983	<param name="screenId" type="unsigned long" dir="in">
10984	<desc>The screen id where the Drag and Drop event occured.</desc>
10985	</param>
10986	<param name="x" type="unsigned long" dir="in">
10987	<desc>x-position of the event.</desc>
10988	</param>
10989	<param name="y" type="unsigned long" dir="in">
10990	<desc>y-position of the event.</desc>
10991	</param>
10992	<param name="defaultAction" type="DragAndDropAction" dir="in">
10993	<desc>The default action to use.</desc>
10994	</param>
10995	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
10996	<desc>The actions which are allowed.</desc>
10997	</param>
10998	<param name="formats" type="wstring" dir="in" safearray="yes">
10999	<desc>The supported mime types.</desc>
11000	</param>
11001	<param name="format" type="wstring" dir="out">
11002	<desc>The resulting format of this event.</desc>
11003	</param>
11004	<param name="resultAction" type="DragAndDropAction" dir="return">
11005	<desc>The resulting action of this event.</desc>
11006	</param>
11007	</method>
11008
11009	<method name="dragHGPutData">
11010	<desc>
11011	Informs the guest about a drop data event.
11012
11013	This is used in Host - Guest direction.
11014
11015	<result name="VBOX_E_VM_ERROR">
11016	VMM device is not available.
11017	</result>
11018
11019	</desc>
11020	<param name="screenId" type="unsigned long" dir="in">
11021	<desc>The screen id where the Drag and Drop event occured.</desc>
11022	</param>
11023	<param name="format" type="wstring" dir="in">
11024	<desc>The mime type the data is in.</desc>
11025	</param>
11026	<param name="data" type="octet" dir="in" safearray="yes">
11027	<desc>The actual data.</desc>
11028	</param>
11029	<param name="progress" type="IProgress" dir="return">
11030	<desc>Progress object to track the operation completion.</desc>
11031	</param>
11032	</method>
11033
11034	<method name="dragGHPending">
11035	<desc>
11036	Ask the guest if there is any Drag and Drop operation pending in the guest.
11037
11038	If no Drag and Drop operation is pending currently, Ignore is returned.
11039
11040	This is used in Guest - Host direction.
11041
11042	<result name="VBOX_E_VM_ERROR">
11043	VMM device is not available.
11044	</result>
11045
11046	</desc>
11047	<param name="screenId" type="unsigned long" dir="in">
11048	<desc>The screen id where the Drag and Drop event occured.</desc>
11049	</param>
11050	<param name="format" type="wstring" dir="out" safearray="yes">
11051	<desc>On return the supported mime types.</desc>
11052	</param>
11053	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
11054	<desc>On return the actions which are allowed.</desc>
11055	</param>
11056	<param name="defaultAction" type="DragAndDropAction" dir="return">
11057	<desc>On return the default action to use.</desc>
11058	</param>
11059	</method>
11060
11061	<method name="dragGHDropped">
11062	<desc>
11063	Informs the guest that a drop event occured for a pending Drag and Drop event.
11064
11065	This is used in Guest - Host direction.
11066
11067	<result name="VBOX_E_VM_ERROR">
11068	VMM device is not available.
11069	</result>
11070
11071	</desc>
11072
11073	<param name="format" type="wstring" dir="in">
11074	<desc>The mime type the data must be in.</desc>
11075	</param>
11076	<param name="action" type="DragAndDropAction" dir="in">
11077	<desc>The action to use.</desc>
11078	</param>
11079	<param name="progress" type="IProgress" dir="return">
11080	<desc>Progress object to track the operation completion.</desc>
11081	</param>
11082	</method>
11083
11084	<method name="dragGHGetData">
11085	<desc>
11086	Fetch the data of a previously Drag and Drop event from the guest.
11087
11088	This is used in Guest - Host direction.
11089
11090	<result name="VBOX_E_VM_ERROR">
11091	VMM device is not available.
11092	</result>
11093
11094	</desc>
11095
11096	<param name="data" type="octet" safearray="yes" dir="return">
11097	<desc>The actual data.</desc>
11098	</param>
11099	</method>
11100
11101	<method name="createSession">
11102	<desc>
11103	Creates a new guest session for controlling the guest.
11104
11105	A guest session represents one impersonated user account on the guest, so
11106	every operation will use the same credentials specified when creating
11107	the session object via <link to="IGuest::createSession"/>. Anonymous
11108	sessions, that is, sessions without specifying a valid
11109	user account on the guest are not allowed due to security reasons.
11110
11111	There can be a maximum of 32 sessions at once per VM. Each session keeps
11112	track of its started guest processes, opened guest files or guest directories.
11113	To work on guest files or directories a guest session offers methods to open
11114	or create such objects (see <link to="IGuestSession::fileOpen"/> or
11115	<link to="IGuestSession::directoryOpen"/> for example).
11116
11117	When done with either of these objects, including the guest session itself,
11118	use the appropriate close() method to let the object do its cleanup work.
11119
11120	Every guest session has its own environment variable block which gets
11121	automatically applied when starting a new guest process via
11122	<link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>.
11123	To override (or unset) certain environment variables already set by the
11124	guest session, one can specify a per-process environment block when using
11125	one of the both above mentioned process creation calls.
11126
11127	Closing a session via <link to="IGuestSession::close" /> will try to close
11128	all the mentioned objects above unless these objects are still used by
11129	a client.
11130	</desc>
11131	<param name="user" type="wstring" dir="in">
11132	<desc>
11133	User name this session will be using to control the guest; has to exist
11134	and have the appropriate rights to execute programs in the VM. Must not
11135	be empty.
11136	</desc>
11137	</param>
11138	<param name="password" type="wstring" dir="in">
11139	<desc>
11140	Password of the user account to be used. Empty passwords are allowed.
11141	</desc>
11142	</param>
11143	<param name="domain" type="wstring" dir="in">
11144	<desc>
11145	Domain name of the user account to be used if the guest is part of
11146	a domain. Optional. This feature is not implemented yet.
11147	</desc>
11148	</param>
11149	<param name="sessionName" type="wstring" dir="in">
11150	<desc>
11151	The session's friendly name. Optional, can be empty.
11152	</desc>
11153	</param>
11154	<param name="guestSession" type="IGuestSession" dir="return">
11155	<desc>
11156	The newly created session object.
11157	</desc>
11158	</param>
11159	</method>
11160
11161	<method name="findSession">
11162	<desc>
11163	Finds guest sessions by their friendly name and returns an interface
11164	array with all found guest sessions.
11165	</desc>
11166	<param name="sessionName" type="wstring" dir="in">
11167	<desc>
11168	The session's friendly name to find. Wildcards like ? and * are allowed.
11169	</desc>
11170	</param>
11171	<param name="sessions" type="IGuestSession" safearray="yes" dir="return">
11172	<desc>
11173	Array with all guest sessions found matching the name specified.
11174	</desc>
11175	</param>
11176	</method>
11177
11178	<method name="updateGuestAdditions">
11179	<desc>
11180	Automatically updates already installed Guest Additions in a VM.
11181
11182	At the moment only Windows guests are supported.
11183
11184	Because the VirtualBox Guest Additions drivers are not WHQL-certified
11185	yet there might be warning dialogs during the actual Guest Additions
11186	update. These need to be confirmed manually in order to continue the
11187	installation process. This applies to Windows 2000 and Windows XP guests
11188	and therefore these guests can't be updated in a fully automated fashion
11189	without user interaction. However, to start a Guest Additions update for
11190	the mentioned Windows versions anyway, the flag
11191	AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See
11192	<link to="AdditionsUpdateFlag"/> for more information.
11193
11194	<result name="VBOX_E_NOT_SUPPORTED">
11195	Guest OS is not supported for automated Guest Additions updates or the
11196	already installed Guest Additions are not ready yet.
11197	</result>
11198
11199	<result name="VBOX_E_IPRT_ERROR">
11200	Error while updating.
11201	</result>
11202
11203	</desc>
11204	<param name="source" type="wstring" dir="in">
11205	<desc>
11206	Path to the Guest Additions .ISO file to use for the upate.
11207	</desc>
11208	</param>
11209	<param name="flags" type="AdditionsUpdateFlag" dir="in" safearray="yes">
11210	<desc>
11211	<link to="AdditionsUpdateFlag"/> flags.
11212	</desc>
11213	</param>
11214	<param name="progress" type="IProgress" dir="return">
11215	<desc>Progress object to track the operation completion.</desc>
11216	</param>
11217	</method>
11218
11219	</interface>
11220
11221
11222	<!--
11223	// IProgress
11224	/////////////////////////////////////////////////////////////////////////
11225	-->
11226
11227	<interface
11228	name="IProgress" extends="$unknown"
11229	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
11230	wsmap="managed"
11231	>
11232	<desc>
11233	The IProgress interface is used to track and control
11234	asynchronous tasks within VirtualBox.
11235
11236	An instance of this is returned every time VirtualBox starts
11237	an asynchronous task (in other words, a separate thread) which
11238	continues to run after a method call returns. For example,
11239	<link to="IConsole::saveState" />, which saves the state of
11240	a running virtual machine, can take a long time to complete.
11241	To be able to display a progress bar, a user interface such as
11242	the VirtualBox graphical user interface can use the IProgress
11243	object returned by that method.
11244
11245	Note that IProgress is a "read-only" interface in the sense
11246	that only the VirtualBox internals behind the Main API can
11247	create and manipulate progress objects, whereas client code
11248	can only use the IProgress object to monitor a task's
11249	progress and, if <link to="#cancelable" /> is @c true,
11250	cancel the task by calling <link to="#cancel" />.
11251
11252	A task represented by IProgress consists of either one or
11253	several sub-operations that run sequentially, one by one (see
11254	<link to="#operation" /> and <link to="#operationCount" />).
11255	Every operation is identified by a number (starting from 0)
11256	and has a separate description.
11257
11258	You can find the individual percentage of completion of the current
11259	operation in <link to="#operationPercent" /> and the
11260	percentage of completion of the task as a whole
11261	in <link to="#percent" />.
11262
11263	Similarly, you can wait for the completion of a particular
11264	operation via <link to="#waitForOperationCompletion" /> or
11265	for the completion of the whole task via
11266	<link to="#waitForCompletion" />.
11267	</desc>
11268
11269	<attribute name="id" type="uuid" mod="string" readonly="yes">
11270	<desc>ID of the task.</desc>
11271	</attribute>
11272
11273	<attribute name="description" type="wstring" readonly="yes">
11274	<desc>Description of the task.</desc>
11275	</attribute>
11276
11277	<attribute name="initiator" type="$unknown" readonly="yes">
11278	<desc>Initiator of the task.</desc>
11279	</attribute>
11280
11281	<attribute name="cancelable" type="boolean" readonly="yes">
11282	<desc>Whether the task can be interrupted.</desc>
11283	</attribute>
11284
11285	<attribute name="percent" type="unsigned long" readonly="yes">
11286	<desc>
11287	Current progress value of the task as a whole, in percent.
11288	This value depends on how many operations are already complete.
11289	Returns 100 if <link to="#completed" /> is @c true.
11290	</desc>
11291	</attribute>
11292
11293	<attribute name="timeRemaining" type="long" readonly="yes">
11294	<desc>
11295	Estimated remaining time until the task completes, in
11296	seconds. Returns 0 once the task has completed; returns -1
11297	if the remaining time cannot be computed, in particular if
11298	the current progress is 0.
11299
11300	Even if a value is returned, the estimate will be unreliable
11301	for low progress values. It will become more reliable as the
11302	task progresses; it is not recommended to display an ETA
11303	before at least 20% of a task have completed.
11304	</desc>
11305	</attribute>
11306
11307	<attribute name="completed" type="boolean" readonly="yes">
11308	<desc>Whether the task has been completed.</desc>
11309	</attribute>
11310
11311	<attribute name="canceled" type="boolean" readonly="yes">
11312	<desc>Whether the task has been canceled.</desc>
11313	</attribute>
11314
11315	<attribute name="resultCode" type="long" readonly="yes">
11316	<desc>
11317	Result code of the progress task.
11318	Valid only if <link to="#completed"/> is @c true.
11319	</desc>
11320	</attribute>
11321
11322	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
11323	<desc>
11324	Extended information about the unsuccessful result of the
11325	progress operation. May be @c null if no extended information
11326	is available.
11327	Valid only if <link to="#completed"/> is @c true and
11328	<link to="#resultCode"/> indicates a failure.
11329	</desc>
11330	</attribute>
11331
11332	<attribute name="operationCount" type="unsigned long" readonly="yes">
11333	<desc>
11334	Number of sub-operations this task is divided into.
11335	Every task consists of at least one suboperation.
11336	</desc>
11337	</attribute>
11338
11339	<attribute name="operation" type="unsigned long" readonly="yes">
11340	<desc>Number of the sub-operation being currently executed.</desc>
11341	</attribute>
11342
11343	<attribute name="operationDescription" type="wstring" readonly="yes">
11344	<desc>
11345	Description of the sub-operation being currently executed.
11346	</desc>
11347	</attribute>
11348
11349	<attribute name="operationPercent" type="unsigned long" readonly="yes">
11350	<desc>Progress value of the current sub-operation only, in percent.</desc>
11351	</attribute>
11352
11353	<attribute name="operationWeight" type="unsigned long" readonly="yes">
11354	<desc>Weight value of the current sub-operation only.</desc>
11355	</attribute>
11356
11357	<attribute name="timeout" type="unsigned long">
11358	<desc>
11359	When non-zero, this specifies the number of milliseconds after which
11360	the operation will automatically be canceled. This can only be set on
11361	cancelable objects.
11362	</desc>
11363	</attribute>
11364
11365	<method name="setCurrentOperationProgress">
11366	<desc>Internal method, not to be called externally.</desc>
11367	<param name="percent" type="unsigned long" dir="in" />
11368	</method>
11369	<method name="setNextOperation">
11370	<desc>Internal method, not to be called externally.</desc>
11371	<param name="nextOperationDescription" type="wstring" dir="in" />
11372	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
11373	</method>
11374
11375	<method name="waitForCompletion">
11376	<desc>
11377	Waits until the task is done (including all sub-operations)
11378	with a given timeout in milliseconds; specify -1 for an indefinite wait.
11379
11380	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
11381	thread are not processed while waiting. Neglecting event queues may
11382	have dire consequences (degrade performance, resource hogs,
11383	deadlocks, etc.), this is specially so for the main thread on
11384	platforms using XPCOM. Callers are adviced wait for short periods
11385	and service their event queues between calls, or to create a worker
11386	thread to do the waiting.
11387
11388	<result name="VBOX_E_IPRT_ERROR">
11389	Failed to wait for task completion.
11390	</result>
11391	</desc>
11392
11393	<param name="timeout" type="long" dir="in">
11394	<desc>
11395	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11396	</desc>
11397	</param>
11398	</method>
11399
11400	<method name="waitForOperationCompletion">
11401	<desc>
11402	Waits until the given operation is done with a given timeout in
11403	milliseconds; specify -1 for an indefinite wait.
11404
11405	See <link to="#waitForCompletion"> for event queue considerations.</link>
11406
11407	<result name="VBOX_E_IPRT_ERROR">
11408	Failed to wait for operation completion.
11409	</result>
11410
11411	</desc>
11412	<param name="operation" type="unsigned long" dir="in">
11413	<desc>
11414	Number of the operation to wait for.
11415	Must be less than <link to="#operationCount"/>.
11416	</desc>
11417	</param>
11418	<param name="timeout" type="long" dir="in">
11419	<desc>
11420	Maximum time in milliseconds to wait or -1 to wait indefinitely.
11421	</desc>
11422	</param>
11423	</method>
11424
11425	<method name="waitForAsyncProgressCompletion">
11426	<desc>
11427	Waits until the other task is completed (including all
11428	sub-operations) and forward all changes from the other progress to
11429	this progress. This means sub-operation number, description, percent
11430	and so on.
11431
11432	You have to take care on setting up at least the same count on
11433	sub-operations in this progress object like there are in the other
11434	progress object.
11435
11436	If the other progress object supports cancel and this object gets any
11437	cancel request (when here enabled as well), it will be forwarded to
11438	the other progress object.
11439
11440	If there is an error in the other progress, this error isn't
11441	automatically transfered to this progress object. So you have to
11442	check any operation error within the other progress object, after
11443	this method returns.
11444	</desc>
11445
11446	<param name="pProgressAsync" type="IProgress" dir="in">
11447	<desc>
11448	The progress object of the asynchrony process.
11449	</desc>
11450	</param>
11451	</method>
11452
11453	<method name="cancel">
11454	<desc>
11455	Cancels the task.
11456	<note>
11457	If <link to="#cancelable"/> is @c false, then this method will fail.
11458	</note>
11459
11460	<result name="VBOX_E_INVALID_OBJECT_STATE">
11461	Operation cannot be canceled.
11462	</result>
11463
11464	</desc>
11465	</method>
11466
11467	</interface>
11468
11469	<!--
11470	// ISnapshot
11471	/////////////////////////////////////////////////////////////////////////
11472	-->
11473
11474	<interface
11475	name="ISnapshot" extends="$unknown"
11476	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
11477	wsmap="managed"
11478	>
11479	<desc>
11480	The ISnapshot interface represents a snapshot of the virtual
11481	machine.
11482
11483	Together with the differencing media that are created
11484	when a snapshot is taken, a machine can be brought back to
11485	the exact state it was in when the snapshot was taken.
11486
11487	The ISnapshot interface has no methods, only attributes; snapshots
11488	are controlled through methods of the <link to="IConsole" /> interface
11489	which also manage the media associated with the snapshot.
11490	The following operations exist:
11491
11492	<ul>
11493	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
11494	by creating new, empty differencing images for the machine's
11495	media and saving the VM settings and (if the VM is running)
11496	the current VM state in the snapshot.
11497
11498	The differencing images will then receive all data written to
11499	the machine's media, while their parent (base) images
11500	remain unmodified after the snapshot has been taken (see
11501	<link to="IMedium" /> for details about differencing images).
11502	This simplifies restoring a machine to the state of a snapshot:
11503	only the differencing images need to be deleted.
11504
11505	The current machine state is not changed by taking a snapshot
11506	except that <link to="IMachine::currentSnapshot" /> is set to
11507	the newly created snapshot, which is also added to the machine's
11508	snapshots tree.
11509	</li>
11510
11511	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
11512	the state of a previous snapshot by deleting the differencing
11513	image of each of the machine's media and setting the machine's
11514	settings and state to the state that was saved in the snapshot (if any).
11515
11516	This destroys the machine's current state. After calling this,
11517	<link to="IMachine::currentSnapshot" /> points to the snapshot
11518	that was restored.
11519	</li>
11520
11521	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
11522	without affecting the current machine state.
11523
11524	This does not change the current machine state, but instead frees the
11525	resources allocated when the snapshot was taken: the settings and machine
11526	state file are deleted (if any), and the snapshot's differencing image for
11527	each of the machine's media gets merged with its parent image.
11528
11529	Neither the current machine state nor other snapshots are affected
11530	by this operation, except that parent media will be modified
11531	to contain the disk data associated with the snapshot being deleted.
11532
11533	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
11534	attribute is set to the current snapshot's parent or @c null if it
11535	has no parent. Otherwise the attribute is unchanged.
11536	</li>
11537	</ul>
11538
11539	Each snapshot contains a copy of virtual machine's settings (hardware
11540	configuration etc.). This copy is contained in an immutable (read-only)
11541	instance of <link to="IMachine" /> which is available from the snapshot's
11542	<link to="#machine" /> attribute. When restoring the snapshot, these
11543	settings are copied back to the original machine.
11544
11545	In addition, if the machine was running when the
11546	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
11547	the current VM state is saved in the snapshot (similarly to what happens
11548	when a VM's state is saved). The snapshot is then said to be <i>online</i>
11549	because when restoring it, the VM will be running.
11550
11551	If the machine was in <link to="MachineState_Saved">saved</link> saved,
11552	the snapshot receives a copy of the execution state file
11553	(<link to="IMachine::stateFilePath"/>).
11554
11555	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
11556	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
11557	it then contains a so-called "zero execution state", representing a
11558	machine that is powered off.
11559	</desc>
11560
11561	<attribute name="id" type="uuid" mod="string" readonly="yes">
11562	<desc>UUID of the snapshot.</desc>
11563	</attribute>
11564
11565	<attribute name="name" type="wstring">
11566	<desc>Short name of the snapshot.
11567	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11568	be called implicitly.</note>
11569	</desc>
11570	</attribute>
11571
11572	<attribute name="description" type="wstring">
11573	<desc>Optional description of the snapshot.
11574	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
11575	be called implicitly.</note>
11576	</desc>
11577	</attribute>
11578
11579	<attribute name="timeStamp" type="long long" readonly="yes">
11580	<desc>
11581	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
11582	</desc>
11583	</attribute>
11584
11585	<attribute name="online" type="boolean" readonly="yes">
11586	<desc>
11587	@c true if this snapshot is an online snapshot and @c false otherwise.
11588
11589	When this attribute is @c true, the
11590	<link to="IMachine::stateFilePath"/> attribute of the
11591	<link to="#machine"/> object associated with this snapshot
11592	will point to the saved state file. Otherwise, it will be
11593	an empty string.
11594	</desc>
11595	</attribute>
11596
11597	<attribute name="machine" type="IMachine" readonly="yes">
11598	<desc>
11599	Virtual machine this snapshot is taken on. This object
11600	stores all settings the machine had when taking this snapshot.
11601	<note>
11602	The returned machine object is immutable, i.e. no
11603	any settings can be changed.
11604	</note>
11605	</desc>
11606	</attribute>
11607
11608	<attribute name="parent" type="ISnapshot" readonly="yes">
11609	<desc>
11610	Parent snapshot (a snapshot this one is based on), or
11611	@c null if the snapshot has no parent (i.e. is the first snapshot).
11612	</desc>
11613	</attribute>
11614
11615	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
11616	<desc>
11617	Child snapshots (all snapshots having this one as a parent).
11618	By inspecting this attribute starting with a machine's root snapshot
11619	(which can be obtained by calling <link to="IMachine::findSnapshot" />
11620	with a @c null UUID), a machine's snapshots tree can be iterated over.
11621	</desc>
11622	</attribute>
11623
11624	<method name="getChildrenCount" const="yes">
11625	<desc>
11626	Returns the number of direct childrens of this snapshot.
11627	</desc>
11628	<param name="childrenCount" type="unsigned long" dir="return">
11629	<desc>
11630	</desc>
11631	</param>
11632	</method>
11633
11634	</interface>
11635
11636
11637	<!--
11638	// IMedium
11639	/////////////////////////////////////////////////////////////////////////
11640	-->
11641
11642	<enum
11643	name="MediumState"
11644	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
11645	>
11646	<desc>
11647	Virtual medium state.
11648	<see><link to="IMedium"/></see>
11649	</desc>
11650
11651	<const name="NotCreated" value="0">
11652	<desc>
11653	Associated medium storage does not exist (either was not created yet or
11654	was deleted).
11655	</desc>
11656	</const>
11657	<const name="Created" value="1">
11658	<desc>
11659	Associated storage exists and accessible; this gets set if the
11660	accessibility check performed by <link to="IMedium::refreshState" />
11661	was successful.
11662	</desc>
11663	</const>
11664	<const name="LockedRead" value="2">
11665	<desc>
11666	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
11667	no data modification is possible.
11668	</desc>
11669	</const>
11670	<const name="LockedWrite" value="3">
11671	<desc>
11672	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
11673	no concurrent data reading or modification is possible.
11674	</desc>
11675	</const>
11676	<const name="Inaccessible" value="4">
11677	<desc>
11678	Medium accessibility check (see <link to="IMedium::refreshState" />) has
11679	not yet been performed, or else, associated medium storage is not
11680	accessible. In the first case, <link to="IMedium::lastAccessError"/>
11681	is empty, in the second case, it describes the error that occurred.
11682	</desc>
11683	</const>
11684	<const name="Creating" value="5">
11685	<desc>
11686	Associated medium storage is being created.
11687	</desc>
11688	</const>
11689	<const name="Deleting" value="6">
11690	<desc>
11691	Associated medium storage is being deleted.
11692	</desc>
11693	</const>
11694	</enum>
11695
11696	<enum
11697	name="MediumType"
11698	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
11699	>
11700	<desc>
11701	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
11702	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
11703	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
11704	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
11705	</desc>
11706
11707	<const name="Normal" value="0">
11708	<desc>
11709	Normal medium (attached directly or indirectly, preserved
11710	when taking snapshots).
11711	</desc>
11712	</const>
11713	<const name="Immutable" value="1">
11714	<desc>
11715	Immutable medium (attached indirectly, changes are wiped out
11716	the next time the virtual machine is started).
11717	</desc>
11718	</const>
11719	<const name="Writethrough" value="2">
11720	<desc>
11721	Write through medium (attached directly, ignored when
11722	taking snapshots).
11723	</desc>
11724	</const>
11725	<const name="Shareable" value="3">
11726	<desc>
11727	Allow using this medium concurrently by several machines.
11728	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
11729	</desc>
11730	</const>
11731	<const name="Readonly" value="4">
11732	<desc>
11733	A readonly medium, which can of course be used by several machines.
11734	<note>Present and accepted since VirtualBox 4.0.</note>
11735	</desc>
11736	</const>
11737	<const name="MultiAttach" value="5">
11738	<desc>
11739	A medium which is indirectly attached, so that one base medium can
11740	be used for several VMs which have their own differencing medium to
11741	store their modifications. In some sense a variant of Immutable
11742	with unset AutoReset flag in each differencing medium.
11743	<note>Present and accepted since VirtualBox 4.0.</note>
11744	</desc>
11745	</const>
11746	</enum>
11747
11748	<enum
11749	name="MediumVariant"
11750	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
11751	>
11752	<desc>
11753	Virtual medium image variant. More than one flag may be set.
11754	<see><link to="IMedium"/></see>
11755	</desc>
11756
11757	<const name="Standard" value="0">
11758	<desc>
11759	No particular variant requested, results in using the backend default.
11760	</desc>
11761	</const>
11762	<const name="VmdkSplit2G" value="0x01">
11763	<desc>
11764	VMDK image split in chunks of less than 2GByte.
11765	</desc>
11766	</const>
11767	<const name="VmdkRawDisk" value="0x02">
11768	<desc>
11769	VMDK image representing a raw disk.
11770	</desc>
11771	</const>
11772	<const name="VmdkStreamOptimized" value="0x04">
11773	<desc>
11774	VMDK streamOptimized image. Special import/export format which is
11775	read-only/append-only.
11776	</desc>
11777	</const>
11778	<const name="VmdkESX" value="0x08">
11779	<desc>
11780	VMDK format variant used on ESX products.
11781	</desc>
11782	</const>
11783	<const name="Fixed" value="0x10000">
11784	<desc>
11785	Fixed image. Only allowed for base images.
11786	</desc>
11787	</const>
11788	<const name="Diff" value="0x20000">
11789	<desc>
11790	Differencing image. Only allowed for child images.
11791	</desc>
11792	</const>
11793	<const name="NoCreateDir" value="0x40000000">
11794	<desc>
11795	Special flag which suppresses automatic creation of the subdirectory.
11796	Only used when passing the medium variant as an input parameter.
11797	</desc>
11798	</const>
11799	</enum>
11800
11801	<interface
11802	name="IMediumAttachment" extends="$unknown"
11803	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
11804	wsmap="struct"
11805	>
11806	<desc>
11807	The IMediumAttachment interface links storage media to virtual machines.
11808	For each medium (<link to="IMedium"/>) which has been attached to a
11809	storage controller (<link to="IStorageController"/>) of a machine
11810	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
11811	method, one instance of IMediumAttachment is added to the machine's
11812	<link to="IMachine::mediumAttachments"/> array attribute.
11813
11814	Each medium attachment specifies the storage controller as well as a
11815	port and device number and the IMedium instance representing a virtual
11816	hard disk or floppy or DVD image.
11817
11818	For removable media (DVDs or floppies), there are two additional
11819	options. For one, the IMedium instance can be @c null to represent
11820	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
11821	secondly, the medium can be one of the pseudo-media for host drives
11822	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
11823
11824	<h3>Attaching Hard Disks</h3>
11825
11826	Hard disks are attached to virtual machines using the
11827	<link to="IMachine::attachDevice"/> method and detached using the
11828	<link to="IMachine::detachDevice"/> method. Depending on a medium's
11829	type (see <link to="IMedium::type" />), hard disks are attached either
11830	<i>directly</i> or <i>indirectly</i>.
11831
11832	When a hard disk is being attached directly, it is associated with the
11833	virtual machine and used for hard disk operations when the machine is
11834	running. When a hard disk is being attached indirectly, a new differencing
11835	hard disk linked to it is implicitly created and this differencing hard
11836	disk is associated with the machine and used for hard disk operations.
11837	This also means that if <link to="IMachine::attachDevice"/> performs
11838	a direct attachment then the same hard disk will be returned in response
11839	to the subsequent <link to="IMachine::getMedium"/> call; however if
11840	an indirect attachment is performed then
11841	<link to="IMachine::getMedium"/> will return the implicitly created
11842	differencing hard disk, not the original one passed to <link
11843	to="IMachine::attachDevice"/>. In detail:
11844
11845	<ul>
11846	<li><b>Normal base</b> hard disks that do not have children (i.e.
11847	differencing hard disks linked to them) and that are not already
11848	attached to virtual machines in snapshots are attached <b>directly</b>.
11849	Otherwise, they are attached <b>indirectly</b> because having
11850	dependent children or being part of the snapshot makes it impossible
11851	to modify hard disk contents without breaking the integrity of the
11852	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
11853	quickly determine the kind of the attachment for the given hard
11854	disk. Note that if a normal base hard disk is to be indirectly
11855	attached to a virtual machine with snapshots then a special
11856	procedure called <i>smart attachment</i> is performed (see below).</li>
11857	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
11858	they are attached <b>directly</b> if they do not have children and are
11859	not attached to virtual machines in snapshots, and <b>indirectly</b>
11860	otherwise. Note that the smart attachment procedure is never performed
11861	for differencing hard disks.</li>
11862	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
11863	they are designed to be non-writable. If an immutable hard disk is
11864	attached to a virtual machine with snapshots then a special
11865	procedure called smart attachment is performed (see below).</li>
11866	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
11867	also as designed. This also means that writethrough hard disks cannot
11868	have other hard disks linked to them at all.</li>
11869	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
11870	also as designed. This also means that shareable hard disks cannot
11871	have other hard disks linked to them at all. They behave almost
11872	like writethrough hard disks, except that shareable hard disks can
11873	be attached to several virtual machines which are running, allowing
11874	concurrent accesses. You need special cluster software running in
11875	the virtual machines to make use of such disks.</li>
11876	</ul>
11877
11878	Note that the same hard disk, regardless of its type, may be attached to
11879	more than one virtual machine at a time. In this case, the machine that is
11880	started first gains exclusive access to the hard disk and attempts to
11881	start other machines having this hard disk attached will fail until the
11882	first machine is powered down.
11883
11884	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
11885	that the given hard disk remains associated with the given machine after a
11886	successful <link to="IMachine::detachDevice"/> call until
11887	<link to="IMachine::saveSettings"/> is called to save all changes to
11888	machine settings to disk. This deferring is necessary to guarantee that
11889	the hard disk configuration may be restored at any time by a call to
11890	<link to="IMachine::discardSettings"/> before the settings
11891	are saved (committed).
11892
11893	Note that if <link to="IMachine::discardSettings"/> is called after
11894	indirectly attaching some hard disks to the machine but before a call to
11895	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
11896	all differencing hard disks implicitly created by
11897	<link to="IMachine::attachDevice"/> for these indirect attachments.
11898	Such implicitly created hard disks will also be immediately deleted when
11899	detached explicitly using the <link to="IMachine::detachDevice"/>
11900	call if it is made before <link to="IMachine::saveSettings"/>. This
11901	implicit deletion is safe because newly created differencing hard
11902	disks do not contain any user data.
11903
11904	However, keep in mind that detaching differencing hard disks that were
11905	implicitly created by <link to="IMachine::attachDevice"/>
11906	before the last <link to="IMachine::saveSettings"/> call will
11907	<b>not</b> implicitly delete them as they may already contain some data
11908	(for example, as a result of virtual machine execution). If these hard
11909	disks are no more necessary, the caller can always delete them explicitly
11910	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
11911	from this machine by the <link to="IMachine::saveSettings"/> call.
11912
11913	<h3>Smart Attachment</h3>
11914
11915	When normal base or immutable hard disks are indirectly attached to a
11916	virtual machine then some additional steps are performed to make sure the
11917	virtual machine will have the most recent "view" of the hard disk being
11918	attached. These steps include walking through the machine's snapshots
11919	starting from the current one and going through ancestors up to the first
11920	snapshot. Hard disks attached to the virtual machine in all
11921	of the encountered snapshots are checked whether they are descendants of
11922	the given normal base or immutable hard disk. The first found child (which
11923	is the differencing hard disk) will be used instead of the normal base or
11924	immutable hard disk as a parent for creating a new differencing hard disk
11925	that will be actually attached to the machine. And only if no descendants
11926	are found or if the virtual machine does not have any snapshots then the
11927	normal base or immutable hard disk will be used itself as a parent for
11928	this differencing hard disk.
11929
11930	It is easier to explain what smart attachment does using the
11931	following example:
11932	<pre>
11933	BEFORE attaching B.vdi: AFTER attaching B.vdi:
11934
11935	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
11936	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
11937	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
11938	Snapshot 4 (none) Snapshot 4 (none)
11939	CurState (none) CurState (D3->D2.vdi)
11940
11941	NOT
11942	...
11943	CurState (D3->B.vdi)
11944	</pre>
11945	The first column is the virtual machine configuration before the base hard
11946	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
11947	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
11948	mean that the hard disk that is actually attached to the machine is a
11949	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
11950	another hard disk, <tt>B.vdi</tt>.
11951
11952	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
11953	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
11954	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
11955	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
11956	it cannot be attached directly and needs an indirect attachment (i.e.
11957	implicit creation of a new differencing hard disk). Due to the smart
11958	attachment procedure, the new differencing hard disk
11959	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
11960	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
11961	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
11962	machine.
11963
11964	Note that if there is more than one descendant hard disk of the given base
11965	hard disk found in a snapshot, and there is an exact device, channel and
11966	bus match, then this exact match will be used. Otherwise, the youngest
11967	descendant will be picked up.
11968
11969	There is one more important aspect of the smart attachment procedure which
11970	is not related to snapshots at all. Before walking through the snapshots
11971	as described above, the backup copy of the current list of hard disk
11972	attachment is searched for descendants. This backup copy is created when
11973	the hard disk configuration is changed for the first time after the last
11974	<link to="IMachine::saveSettings"/> call and used by
11975	<link to="IMachine::discardSettings"/> to undo the recent hard disk
11976	changes. When such a descendant is found in this backup copy, it will be
11977	simply re-attached back, without creating a new differencing hard disk for
11978	it. This optimization is necessary to make it possible to re-attach the
11979	base or immutable hard disk to a different bus, channel or device slot
11980	without losing the contents of the differencing hard disk actually
11981	attached to the machine in place of it.
11982
11983	</desc>
11984
11985	<attribute name="medium" type="IMedium" readonly="yes">
11986	<desc>Medium object associated with this attachment; it
11987	can be @c null for removable devices.</desc>
11988	</attribute>
11989
11990	<attribute name="controller" type="wstring" readonly="yes">
11991	<desc>Name of the storage controller of this attachment; this
11992	refers to one of the controllers in <link to="IMachine::storageControllers" />
11993	by name.</desc>
11994	</attribute>
11995
11996	<attribute name="port" type="long" readonly="yes">
11997	<desc>Port number of this attachment.
11998	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
11999	</desc>
12000	</attribute>
12001
12002	<attribute name="device" type="long" readonly="yes">
12003	<desc>Device slot number of this attachment.
12004	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
12005	</desc>
12006	</attribute>
12007
12008	<attribute name="type" type="DeviceType" readonly="yes">
12009	<desc>Device type of this attachment.</desc>
12010	</attribute>
12011
12012	<attribute name="passthrough" type="boolean" readonly="yes">
12013	<desc>Pass I/O requests through to a device on the host.</desc>
12014	</attribute>
12015
12016	<attribute name="temporaryEject" type="boolean" readonly="yes">
12017	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
12018	</attribute>
12019
12020	<attribute name="isEjected" type="boolean" readonly="yes">
12021	<desc>Signals that the removable medium has been ejected. This is not
12022	necessarily equivalent to having a @c null medium association.</desc>
12023	</attribute>
12024
12025	<attribute name="nonRotational" type="boolean" readonly="yes">
12026	<desc>Whether the associated medium is non-rotational.</desc>
12027	</attribute>
12028
12029	<attribute name="discard" type="boolean" readonly="yes">
12030	<desc>Whether the associated medium supports discarding unused blocks.</desc>
12031	</attribute>
12032
12033	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
12034	<desc>The bandwidth group this medium attachment is assigned to.</desc>
12035	</attribute>
12036
12037	</interface>
12038
12039	<interface
12040	name="IMedium" extends="$unknown"
12041	uuid="86fd6208-4c8c-40c2-a4e3-f6b47ac6ef07"
12042	wsmap="managed"
12043	>
12044	<desc>
12045	The IMedium interface represents virtual storage for a machine's
12046	hard disks, CD/DVD or floppy drives. It will typically represent
12047	a disk image on the host, for example a VDI or VMDK file representing
12048	a virtual hard disk, or an ISO or RAW file representing virtual
12049	removable media, but can also point to a network location (e.g.
12050	for iSCSI targets).
12051
12052	Instances of IMedium are connected to virtual machines by way of medium
12053	attachments, which link the storage medium to a particular device slot
12054	of a storage controller of the virtual machine.
12055	In the VirtualBox API, virtual storage is therefore always represented
12056	by the following chain of object links:
12057
12058	<ul>
12059	<li><link to="IMachine::storageControllers"/> contains an array of
12060	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
12061	these are instances of <link to="IStorageController"/>).</li>
12062	<li><link to="IMachine::mediumAttachments"/> contains an array of
12063	medium attachments (instances of <link to="IMediumAttachment"/>
12064	created by <link to="IMachine::attachDevice" />),
12065	each containing a storage controller from the above array, a
12066	port/device specification, and an instance of IMedium representing
12067	the medium storage (image file).
12068
12069	For removable media, the storage medium is optional; a medium
12070	attachment with no medium represents a CD/DVD or floppy drive
12071	with no medium inserted. By contrast, hard disk attachments
12072	will always have an IMedium object attached.</li>
12073	<li>Each IMedium in turn points to a storage unit (such as a file
12074	on the host computer or a network resource) that holds actual
12075	data. This location is represented by the <link to="#location"/>
12076	attribute.</li>
12077	</ul>
12078
12079	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
12080	new hard disk media can be created with the VirtualBox API using the
12081	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
12082	disks (see below) are usually implicitly created by VirtualBox as
12083	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
12084	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
12085	should be created with external tools and then opened from within VirtualBox.
12086
12087	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
12088	drive. In that case the <link to="#id" /> attribute contains the UUID of
12089	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
12090
12091	<h3>Media registries</h3>
12092
12093	When a medium has been opened or created using one of the aforementioned
12094	APIs, it becomes "known" to VirtualBox. Known media can be attached
12095	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
12096	They also appear in the global
12097	<link to="IVirtualBox::hardDisks" />,
12098	<link to="IVirtualBox::DVDImages" /> and
12099	<link to="IVirtualBox::floppyImages" /> arrays.
12100
12101	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
12102	in the VirtualBox.xml file, which was shared between all machines and made
12103	transporting machines and their media from one host to another difficult.
12104
12105	Starting with VirtualBox 4.0, media are only added to a registry when they are
12106	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
12107	backwards compatibility, which registry a medium is added to depends on which
12108	VirtualBox version created a machine:
12109
12110	<ul>
12111	<li>If the medium has first been attached to a machine which was created by
12112	VirtualBox 4.0 or later, it is added to that machine's media registry in
12113	the machine XML settings file. This way all information about a machine's
12114	media attachments is contained in a single file and can be transported
12115	easily.</li>
12116	<li>For older media attachments (i.e. if the medium was first attached to a
12117	machine which was created with a VirtualBox version before 4.0), media
12118	continue to be registered in the global VirtualBox settings file, for
12119	backwards compatibility.</li>
12120	</ul>
12121
12122	See <link to="IVirtualBox::openMedium" /> for more information.
12123
12124	Media are removed from media registries by the <link to="IMedium::close"/>,
12125	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
12126
12127	<h3>Accessibility checks</h3>
12128
12129	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
12130	method is called explicitly on a medium. This is done to make the VirtualBox object
12131	ready for serving requests as fast as possible and let the end-user
12132	application decide if it needs to check media accessibility right away or not.
12133
12134	As a result, when VirtualBox starts up (e.g. the VirtualBox
12135	object gets created for the first time), all known media are in the
12136	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
12137	attribute is an empty string because no actual accessibility check has
12138	been made yet.
12139
12140	After calling <link to="#refreshState" />, a medium is considered
12141	<i>accessible</i> if its storage unit can be read. In that case, the
12142	<link to="#state"/> attribute has a value of "Created". If the storage
12143	unit cannot be read (for example, because it is located on a disconnected
12144	network resource, or was accidentally deleted outside VirtualBox),
12145	the medium is considered <i>inaccessible</i>, which is indicated by the
12146	"Inaccessible" state. The exact reason why the medium is inaccessible can be
12147	obtained by reading the <link to="#lastAccessError"/> attribute.
12148
12149	<h3>Medium types</h3>
12150
12151	There are five types of medium behavior which are stored in the
12152	<link to="#type"/> attribute (see <link to="MediumType" />) and
12153	which define the medium's behavior with attachments and snapshots.
12154
12155	All media can be also divided in two groups: <i>base</i> media and
12156	<i>differencing</i> media. A base medium contains all sectors of the
12157	medium data in its own storage and therefore can be used independently.
12158	In contrast, a differencing medium is a "delta" to some other medium and
12159	contains only those sectors which differ from that other medium, which is
12160	then called a <i>parent</i>. The differencing medium is said to be
12161	<i>linked to</i> that parent. The parent may be itself a differencing
12162	medium, thus forming a chain of linked media. The last element in that
12163	chain must always be a base medium. Note that several differencing
12164	media may be linked to the same parent medium.
12165
12166	Differencing media can be distinguished from base media by querying the
12167	<link to="#parent"/> attribute: base media do not have parents they would
12168	depend on, so the value of this attribute is always @c null for them.
12169	Using this attribute, it is possible to walk up the medium tree (from the
12170	child medium to its parent). It is also possible to walk down the tree
12171	using the <link to="#children"/> attribute.
12172
12173	Note that the type of all differencing media is "normal"; all other
12174	values are meaningless for them. Base media may be of any type.
12175
12176	<h3>Automatic composition of the file name part</h3>
12177
12178	Another extension to the <link to="IMedium::location"/> attribute is that
12179	there is a possibility to cause VirtualBox to compose a unique value for
12180	the file name part of the location using the UUID of the hard disk. This
12181	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
12182	e.g. before the storage unit is created, and works as follows. You set the
12183	value of the <link to="IMedium::location"/> attribute to a location
12184	specification which only contains the path specification but not the file
12185	name part and ends with either a forward slash or a backslash character.
12186	In response, VirtualBox will generate a new UUID for the hard disk and
12187	compose the file name using the following pattern:
12188	<pre>
12189	<path>/{<uuid>}.<ext>
12190	</pre>
12191	where <tt><path></tt> is the supplied path specification,
12192	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
12193	is the default extension for the storage format of this hard disk. After
12194	that, you may call any of the methods that create a new hard disk storage
12195	unit and they will use the generated UUID and file name.
12196	</desc>
12197
12198	<attribute name="id" type="uuid" mod="string" readonly="yes">
12199	<desc>
12200	UUID of the medium. For a newly created medium, this value is a randomly
12201	generated UUID.
12202
12203	<note>
12204	For media in one of MediumState_NotCreated, MediumState_Creating or
12205	MediumState_Deleting states, the value of this property is undefined
12206	and will most likely be an empty UUID.
12207	</note>
12208	</desc>
12209	</attribute>
12210
12211	<attribute name="description" type="wstring">
12212	<desc>
12213	Optional description of the medium. For a newly created medium the value
12214	of this attribute is an empty string.
12215
12216	Medium types that don't support this attribute will return E_NOTIMPL in
12217	attempt to get or set this attribute's value.
12218
12219	<note>
12220	For some storage types, reading this attribute may return an outdated
12221	(last known) value when <link to="#state"/> is <link
12222	to="MediumState_Inaccessible"/> or <link
12223	to="MediumState_LockedWrite"/> because the value of this attribute is
12224	stored within the storage unit itself. Also note that changing the
12225	attribute value is not possible in such case, as well as when the
12226	medium is the <link to="MediumState_LockedRead"/> state.
12227	</note>
12228	</desc>
12229	</attribute>
12230
12231	<attribute name="state" type="MediumState" readonly="yes">
12232	<desc>
12233	Returns the current medium state, which is the last state set by
12234	the accessibility check performed by <link to="#refreshState"/>.
12235	If that method has not yet been called on the medium, the state
12236	is "Inaccessible"; as opposed to truly inaccessible media, the
12237	value of <link to="#lastAccessError"/> will be an empty string in
12238	that case.
12239
12240	<note>As of version 3.1, this no longer performs an accessibility check
12241	automatically; call <link to="#refreshState"/> for that.
12242	</note>
12243	</desc>
12244	</attribute>
12245
12246	<attribute name="variant" type="MediumVariant" safearray="yes" readonly="yes">
12247	<desc>
12248	Returns the storage format variant information for this medium
12249	as a combination of the flags described at <link to="MediumVariant" />.
12250	Before <link to="#refreshState"/> is called this method returns
12251	an undefined value.
12252	</desc>
12253	</attribute>
12254
12255	<attribute name="location" type="wstring">
12256	<desc>
12257	Location of the storage unit holding medium data.
12258
12259	The format of the location string is medium type specific. For medium
12260	types using regular files in a host's file system, the location
12261	string is the full file name.
12262
12263	Some medium types may support changing the storage unit location by
12264	simply changing the value of this property. If this operation is not
12265	supported, the implementation will return E_NOTIMPL in attempt to set
12266	this attribute's value.
12267
12268	When setting a value of the location attribute which is a regular file
12269	in the host's file system, the given file name may be either relative to
12270	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
12271	absolute. Note that if the given location specification does not contain
12272	the file extension part then a proper default extension will be
12273	automatically appended by the implementation depending on the medium type.
12274	</desc>
12275	</attribute>
12276
12277	<attribute name="name" type="wstring" readonly="yes">
12278	<desc>
12279	Name of the storage unit holding medium data.
12280
12281	The returned string is a short version of the <link to="#location"/>
12282	attribute that is suitable for representing the medium in situations
12283	where the full location specification is too long (such as lists
12284	and comboboxes in GUI frontends). This string is also used by frontends
12285	to sort the media list alphabetically when needed.
12286
12287	For example, for locations that are regular files in the host's file
12288	system, the value of this attribute is just the file name (+ extension),
12289	without the path specification.
12290
12291	Note that as opposed to the <link to="#location"/> attribute, the name
12292	attribute will not necessary be unique for a list of media of the
12293	given type and format.
12294	</desc>
12295	</attribute>
12296
12297	<attribute name="deviceType" type="DeviceType" readonly="yes">
12298	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
12299	medium.</desc>
12300	</attribute>
12301
12302	<attribute name="hostDrive" type="boolean" readonly="yes">
12303	<desc>True if this corresponds to a drive on the host.</desc>
12304	</attribute>
12305
12306	<attribute name="size" type="long long" readonly="yes">
12307	<desc>
12308	Physical size of the storage unit used to hold medium data (in bytes).
12309
12310	<note>
12311	For media whose <link to="#state"/> is <link
12312	to="MediumState_Inaccessible"/>, the value of this property is the
12313	last known size. For <link to="MediumState_NotCreated"/> media,
12314	the returned value is zero.
12315	</note>
12316	</desc>
12317	</attribute>
12318
12319	<attribute name="format" type="wstring" readonly="yes">
12320	<desc>
12321	Storage format of this medium.
12322
12323	The value of this attribute is a string that specifies a backend used
12324	to store medium data. The storage format is defined when you create a
12325	new medium or automatically detected when you open an existing medium,
12326	and cannot be changed later.
12327
12328	The list of all storage formats supported by this VirtualBox
12329	installation can be obtained using
12330	<link to="ISystemProperties::mediumFormats"/>.
12331	</desc>
12332	</attribute>
12333
12334	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
12335	<desc>
12336	Storage medium format object corresponding to this medium.
12337
12338	The value of this attribute is a reference to the medium format object
12339	that specifies the backend properties used to store medium data. The
12340	storage format is defined when you create a new medium or automatically
12341	detected when you open an existing medium, and cannot be changed later.
12342
12343	<note>@c null is returned if there is no associated medium format
12344	object. This can e.g. happen for medium objects representing host
12345	drives and other special medium objects.</note>
12346	</desc>
12347	</attribute>
12348
12349	<attribute name="type" type="MediumType">
12350	<desc>
12351	Type (role) of this medium.
12352
12353	The following constraints apply when changing the value of this
12354	attribute:
12355	<ul>
12356	<li>If a medium is attached to a virtual machine (either in the
12357	current state or in one of the snapshots), its type cannot be
12358	changed.
12359	</li>
12360	<li>As long as the medium has children, its type cannot be set
12361	to <link to="MediumType_Writethrough"/>.
12362	</li>
12363	<li>The type of all differencing media is
12364	<link to="MediumType_Normal"/> and cannot be changed.
12365	</li>
12366	</ul>
12367
12368	The type of a newly created or opened medium is set to
12369	<link to="MediumType_Normal"/>, except for DVD and floppy media,
12370	which have a type of <link to="MediumType_Writethrough"/>.
12371	</desc>
12372	</attribute>
12373
12374	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
12375	<desc>
12376	Returns which medium types can selected for this medium.
12377
12378	<result name="E_NOTIMPL">
12379	This attribute is not implemented at the moment.
12380	</result>
12381	</desc>
12382	</attribute>
12383
12384	<attribute name="parent" type="IMedium" readonly="yes">
12385	<desc>
12386	Parent of this medium (the medium this medium is directly based
12387	on).
12388
12389	Only differencing media have parents. For base (non-differencing)
12390	media, @c null is returned.
12391	</desc>
12392	</attribute>
12393
12394	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
12395	<desc>
12396	Children of this medium (all differencing media directly based
12397	on this medium). A @c null array is returned if this medium
12398	does not have any children.
12399	</desc>
12400	</attribute>
12401
12402	<attribute name="base" type="IMedium" readonly="yes">
12403	<desc>
12404	Base medium of this medium.
12405
12406	If this is a differencing medium, its base medium is the medium
12407	the given medium branch starts from. For all other types of media, this
12408	property returns the medium object itself (i.e. the same object this
12409	property is read on).
12410	</desc>
12411	</attribute>
12412
12413	<attribute name="readOnly" type="boolean" readonly="yes">
12414	<desc>
12415	Returns @c true if this medium is read-only and @c false otherwise.
12416
12417	A medium is considered to be read-only when its contents cannot be
12418	modified without breaking the integrity of other parties that depend on
12419	this medium such as its child media or snapshots of virtual machines
12420	where this medium is attached to these machines. If there are no
12421	children and no such snapshots then there is no dependency and the
12422	medium is not read-only.
12423
12424	The value of this attribute can be used to determine the kind of the
12425	attachment that will take place when attaching this medium to a
12426	virtual machine. If the value is @c false then the medium will
12427	be attached directly. If the value is @c true then the medium
12428	will be attached indirectly by creating a new differencing child
12429	medium for that. See the interface description for more information.
12430
12431	Note that all <link to="MediumType_Immutable">Immutable</link> media
12432	are always read-only while all
12433	<link to="MediumType_Writethrough">Writethrough</link> media are
12434	always not.
12435
12436	<note>
12437	The read-only condition represented by this attribute is related to
12438	the medium type and usage, not to the current
12439	<link to="IMedium::state">medium state</link> and not to the read-only
12440	state of the storage unit.
12441	</note>
12442	</desc>
12443	</attribute>
12444
12445	<attribute name="logicalSize" type="long long" readonly="yes">
12446	<desc>
12447	Logical size of this medium (in bytes), as reported to the
12448	guest OS running inside the virtual machine this medium is
12449	attached to. The logical size is defined when the medium is created
12450	and cannot be changed later.
12451
12452	<note>
12453	Reading this property on a differencing medium will return the size
12454	of its <link to="#base"/> medium.
12455	</note>
12456	<note>
12457	For media whose state is <link to="#state"/> is <link
12458	to="MediumState_Inaccessible"/>, the value of this property is the
12459	last known logical size. For <link to="MediumState_NotCreated"/>
12460	media, the returned value is zero.
12461	</note>
12462	</desc>
12463	</attribute>
12464
12465	<attribute name="autoReset" type="boolean">
12466	<desc>
12467	Whether this differencing medium will be automatically reset each
12468	time a virtual machine it is attached to is powered up. This
12469	attribute is automatically set to @c true for the last
12470	differencing image of an "immutable" medium (see
12471	<link to="MediumType" />).
12472
12473	See <link to="#reset"/> for more information about resetting
12474	differencing media.
12475
12476	<note>
12477	Reading this property on a base (non-differencing) medium will
12478	always @c false. Changing the value of this property in this
12479	case is not supported.
12480	</note>
12481
12482	<result name="VBOX_E_NOT_SUPPORTED">
12483	This is not a differencing medium (when changing the attribute
12484	value).
12485	</result>
12486	</desc>
12487	</attribute>
12488
12489	<attribute name="lastAccessError" type="wstring" readonly="yes">
12490	<desc>
12491	Text message that represents the result of the last accessibility
12492	check performed by <link to="#refreshState"/>.
12493
12494	An empty string is returned if the last accessibility check
12495	was successful or has not yet been called. As a result, if
12496	<link to="#state" /> is "Inaccessible" and this attribute is empty,
12497	then <link to="#refreshState"/> has yet to be called; this is the
12498	default value of media after VirtualBox initialization.
12499	A non-empty string indicates a failure and should normally describe
12500	a reason of the failure (for example, a file read error).
12501	</desc>
12502	</attribute>
12503
12504	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
12505	<desc>
12506	Array of UUIDs of all machines this medium is attached to.
12507
12508	A @c null array is returned if this medium is not attached to any
12509	machine or to any machine's snapshot.
12510
12511	<note>
12512	The returned array will include a machine even if this medium is not
12513	attached to that machine in the current state but attached to it in
12514	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
12515	details.
12516	</note>
12517	</desc>
12518	</attribute>
12519
12520	<method name="setIds">
12521	<desc>
12522	Changes the UUID and parent UUID for a hard disk medium.
12523	</desc>
12524	<param name="setImageId" type="boolean" dir="in">
12525	<desc>
12526	Select whether a new image UUID is set or not.
12527	</desc>
12528	</param>
12529	<param name="imageId" type="uuid" mod="string" dir="in">
12530	<desc>
12531	New UUID for the image. If an empty string is passed, then a new
12532	UUID is automatically created, provided that @a setImageId is @c true.
12533	Specifying a zero UUID is not allowed.
12534	</desc>
12535	</param>
12536	<param name="setParentId" type="boolean" dir="in">
12537	<desc>
12538	Select whether a new parent UUID is set or not.
12539	</desc>
12540	</param>
12541	<param name="parentId" type="uuid" mod="string" dir="in">
12542	<desc>
12543	New parent UUID for the image. If an empty string is passed, then a
12544	new UUID is automatically created, provided @a setParentId is
12545	@c true. A zero UUID is valid.
12546	</desc>
12547	</param>
12548	<result name="E_INVALIDARG">
12549	Invalid parameter combination.
12550	</result>
12551	<result name="VBOX_E_NOT_SUPPORTED">
12552	Medium is not a hard disk medium.
12553	</result>
12554	</method>
12555
12556	<method name="refreshState">
12557	<desc>
12558	If the current medium state (see <link to="MediumState"/>) is one of
12559	"Created", "Inaccessible" or "LockedRead", then this performs an
12560	accessibility check on the medium and sets the value of the <link to="#state"/>
12561	attribute accordingly; that value is also returned for convenience.
12562
12563	For all other state values, this does not perform a refresh but returns
12564	the state only.
12565
12566	The refresh, if performed, may take a long time (several seconds or even
12567	minutes, depending on the storage unit location and format) because it performs an
12568	accessibility check of the storage unit. This check may cause a significant
12569	delay if the storage unit of the given medium is, for example, a file located
12570	on a network share which is not currently accessible due to connectivity
12571	problems. In that case, the call will not return until a timeout
12572	interval defined by the host OS for this operation expires. For this reason,
12573	it is recommended to never read this attribute on the main UI thread to avoid
12574	making the UI unresponsive.
12575
12576	If the last known state of the medium is "Created" and the accessibility
12577	check fails, then the state would be set to "Inaccessible", and
12578	<link to="#lastAccessError"/> may be used to get more details about the
12579	failure. If the state of the medium is "LockedRead", then it remains the
12580	same, and a non-empty value of <link to="#lastAccessError"/> will
12581	indicate a failed accessibility check in this case.
12582
12583	Note that not all medium states are applicable to all medium types.
12584	</desc>
12585	<param name="state" type="MediumState" dir="return">
12586	<desc>
12587	New medium state.
12588	</desc>
12589	</param>
12590	</method>
12591
12592	<method name="getSnapshotIds">
12593	<desc>
12594	Returns an array of UUIDs of all snapshots of the given machine where
12595	this medium is attached to.
12596
12597	If the medium is attached to the machine in the current state, then the
12598	first element in the array will always be the ID of the queried machine
12599	(i.e. the value equal to the @c machineId argument), followed by
12600	snapshot IDs (if any).
12601
12602	If the medium is not attached to the machine in the current state, then
12603	the array will contain only snapshot IDs.
12604
12605	The returned array may be @c null if this medium is not attached
12606	to the given machine at all, neither in the current state nor in one of
12607	the snapshots.
12608	</desc>
12609	<param name="machineId" type="uuid" mod="string" dir="in">
12610	<desc>
12611	UUID of the machine to query.
12612	</desc>
12613	</param>
12614	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
12615	<desc>
12616	Array of snapshot UUIDs of the given machine using this medium.
12617	</desc>
12618	</param>
12619	</method>
12620
12621	<method name="lockRead">
12622	<desc>
12623	Locks this medium for reading.
12624
12625	A read lock is shared: many clients can simultaneously lock the
12626	same medium for reading unless it is already locked for writing (see
12627	<link to="#lockWrite"/>) in which case an error is returned.
12628
12629	When the medium is locked for reading, it cannot be modified
12630	from within VirtualBox. This means that any method that changes
12631	the properties of this medium or contents of the storage unit
12632	will return an error (unless explicitly stated otherwise). That
12633	includes an attempt to start a virtual machine that wants to
12634	write to the the medium.
12635
12636	When the virtual machine is started up, it locks for reading all
12637	media it uses in read-only mode. If some medium cannot be locked
12638	for reading, the startup procedure will fail.
12639	A medium is typically locked for reading while it is used by a running
12640	virtual machine but has a depending differencing image that receives
12641	the actual write operations. This way one base medium can have
12642	multiple child differencing images which can be written to
12643	simultaneously. Read-only media such as DVD and floppy images are
12644	also locked for reading only (so they can be in use by multiple
12645	machines simultaneously).
12646
12647	A medium is also locked for reading when it is the source of a
12648	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12649
12650	The medium locked for reading must be unlocked using the <link
12651	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
12652	can be nested and must be followed by the same number of paired
12653	<link to="#unlockRead"/> calls.
12654
12655	This method sets the medium state (see <link to="#state"/>) to
12656	"LockedRead" on success. The medium's previous state must be
12657	one of "Created", "Inaccessible" or "LockedRead".
12658
12659	Locking an inaccessible medium is not an error; this method performs
12660	a logical lock that prevents modifications of this medium through
12661	the VirtualBox API, not a physical file-system lock of the underlying
12662	storage unit.
12663
12664	This method returns the current state of the medium
12665	<i>before</i> the operation.
12666
12667	<result name="VBOX_E_INVALID_OBJECT_STATE">
12668	Invalid medium state (e.g. not created, locked, inaccessible,
12669	creating, deleting).
12670	</result>
12671
12672	</desc>
12673	<param name="state" type="MediumState" dir="return">
12674	<desc>
12675	State of the medium after the operation.
12676	</desc>
12677	</param>
12678	</method>
12679
12680	<method name="unlockRead">
12681	<desc>
12682	Cancels the read lock previously set by <link to="#lockRead"/>.
12683
12684	For both success and failure, this method returns the current state
12685	of the medium <i>after</i> the operation.
12686
12687	See <link to="#lockRead"/> for more details.
12688
12689	<result name="VBOX_E_INVALID_OBJECT_STATE">
12690	Medium not locked for reading.
12691	</result>
12692
12693	</desc>
12694	<param name="state" type="MediumState" dir="return">
12695	<desc>
12696	State of the medium after the operation.
12697	</desc>
12698	</param>
12699	</method>
12700
12701	<method name="lockWrite">
12702	<desc>
12703	Locks this medium for writing.
12704
12705	A write lock, as opposed to <link to="#lockRead"/>, is
12706	exclusive: there may be only one client holding a write lock,
12707	and there may be no read locks while the write lock is held.
12708	As a result, read-locking fails if a write lock is held, and
12709	write-locking fails if either a read or another write lock is held.
12710
12711	When a medium is locked for writing, it cannot be modified
12712	from within VirtualBox, and it is not guaranteed that the values
12713	of its properties are up-to-date. Any method that changes the
12714	properties of this medium or contents of the storage unit will
12715	return an error (unless explicitly stated otherwise).
12716
12717	When a virtual machine is started up, it locks for writing all
12718	media it uses to write data to. If any medium could not be locked
12719	for writing, the startup procedure will fail. If a medium has
12720	differencing images, then while the machine is running, only
12721	the last ("leaf") differencing image is locked for writing,
12722	whereas its parents are locked for reading only.
12723
12724	A medium is also locked for writing when it is the target of a
12725	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
12726
12727	The medium locked for writing must be unlocked using the <link
12728	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
12729
12730	This method sets the medium state (see <link to="#state"/>) to
12731	"LockedWrite" on success. The medium's previous state must be
12732	either "Created" or "Inaccessible".
12733
12734	Locking an inaccessible medium is not an error; this method performs
12735	a logical lock that prevents modifications of this medium through
12736	the VirtualBox API, not a physical file-system lock of the underlying
12737	storage unit.
12738
12739	For both, success and failure, this method returns the current
12740	state of the medium <i>before</i> the operation.
12741
12742	<result name="VBOX_E_INVALID_OBJECT_STATE">
12743	Invalid medium state (e.g. not created, locked, inaccessible,
12744	creating, deleting).
12745	</result>
12746
12747	</desc>
12748	<param name="state" type="MediumState" dir="return">
12749	<desc>
12750	State of the medium after the operation.
12751	</desc>
12752	</param>
12753	</method>
12754
12755	<method name="unlockWrite">
12756	<desc>
12757	Cancels the write lock previously set by <link to="#lockWrite"/>.
12758
12759	For both success and failure, this method returns the current
12760	state of the medium <i>after</i> the operation.
12761
12762	See <link to="#lockWrite"/> for more details.
12763
12764	<result name="VBOX_E_INVALID_OBJECT_STATE">
12765	Medium not locked for writing.
12766	</result>
12767
12768	</desc>
12769	<param name="state" type="MediumState" dir="return">
12770	<desc>
12771	State of the medium after the operation.
12772	</desc>
12773	</param>
12774	</method>
12775
12776	<method name="close">
12777	<desc>
12778	Closes this medium.
12779
12780	The medium must not be attached to any known virtual machine
12781	and must not have any known child media, otherwise the
12782	operation will fail.
12783
12784	When the medium is successfully closed, it is removed from
12785	the list of registered media, but its storage unit is not
12786	deleted. In particular, this means that this medium can
12787	later be opened again using the <link to="IVirtualBox::openMedium"/>
12788	call.
12789
12790	Note that after this method successfully returns, the given medium
12791	object becomes uninitialized. This means that any attempt
12792	to call any of its methods or attributes will fail with the
12793	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
12794
12795	<result name="VBOX_E_INVALID_OBJECT_STATE">
12796	Invalid medium state (other than not created, created or
12797	inaccessible).
12798	</result>
12799	<result name="VBOX_E_OBJECT_IN_USE">
12800	Medium attached to virtual machine.
12801	</result>
12802	<result name="VBOX_E_FILE_ERROR">
12803	Settings file not accessible.
12804	</result>
12805	<result name="VBOX_E_XML_ERROR">
12806	Could not parse the settings file.
12807	</result>
12808
12809	</desc>
12810	</method>
12811
12812	<!-- property methods -->
12813
12814	<method name="getProperty" const="yes">
12815	<desc>
12816	Returns the value of the custom medium property with the given name.
12817
12818	The list of all properties supported by the given medium format can
12819	be obtained with <link to="IMediumFormat::describeProperties"/>.
12820
12821	<note>If this method returns an empty string in @a value, the requested
12822	property is supported but currently not assigned any value.</note>
12823
12824	<result name="VBOX_E_OBJECT_NOT_FOUND">
12825	Requested property does not exist (not supported by the format).
12826	</result>
12827	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12828	</desc>
12829	<param name="name" type="wstring" dir="in">
12830	<desc>Name of the property to get.</desc>
12831	</param>
12832	<param name="value" type="wstring" dir="return">
12833	<desc>Current property value.</desc>
12834	</param>
12835	</method>
12836
12837	<method name="setProperty">
12838	<desc>
12839	Sets the value of the custom medium property with the given name.
12840
12841	The list of all properties supported by the given medium format can
12842	be obtained with <link to="IMediumFormat::describeProperties"/>.
12843
12844	<note>Setting the property value to @c null or an empty string is
12845	equivalent to deleting the existing value. A default value (if it is
12846	defined for this property) will be used by the format backend in this
12847	case.</note>
12848
12849	<result name="VBOX_E_OBJECT_NOT_FOUND">
12850	Requested property does not exist (not supported by the format).
12851	</result>
12852	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12853	</desc>
12854	<param name="name" type="wstring" dir="in">
12855	<desc>Name of the property to set.</desc>
12856	</param>
12857	<param name="value" type="wstring" dir="in">
12858	<desc>Property value to set.</desc>
12859	</param>
12860	</method>
12861
12862	<method name="getProperties" const="yes">
12863	<desc>
12864	Returns values for a group of properties in one call.
12865
12866	The names of the properties to get are specified using the @a names
12867	argument which is a list of comma-separated property names or
12868	an empty string if all properties are to be returned.
12869	<note>Currently the value of this argument is ignored and the method
12870	always returns all existing properties.</note>
12871
12872	The list of all properties supported by the given medium format can
12873	be obtained with <link to="IMediumFormat::describeProperties"/>.
12874
12875	The method returns two arrays, the array of property names corresponding
12876	to the @a names argument and the current values of these properties.
12877	Both arrays have the same number of elements with each element at the
12878	given index in the first array corresponds to an element at the same
12879	index in the second array.
12880
12881	For properties that do not have assigned values, an empty string is
12882	returned at the appropriate index in the @a returnValues array.
12883
12884	</desc>
12885	<param name="names" type="wstring" dir="in">
12886	<desc>
12887	Names of properties to get.
12888	</desc>
12889	</param>
12890	<param name="returnNames" type="wstring" safearray="yes" dir="out">
12891	<desc>Names of returned properties.</desc>
12892	</param>
12893	<param name="returnValues" type="wstring" safearray="yes" dir="return">
12894	<desc>Values of returned properties.</desc>
12895	</param>
12896	</method>
12897
12898	<method name="setProperties">
12899	<desc>
12900	Sets values for a group of properties in one call.
12901
12902	The names of the properties to set are passed in the @a names
12903	array along with the new values for them in the @a values array. Both
12904	arrays have the same number of elements with each element at the given
12905	index in the first array corresponding to an element at the same index
12906	in the second array.
12907
12908	If there is at least one property name in @a names that is not valid,
12909	the method will fail before changing the values of any other properties
12910	from the @a names array.
12911
12912	Using this method over <link to="#setProperty"/> is preferred if you
12913	need to set several properties at once since it is more efficient.
12914
12915	The list of all properties supported by the given medium format can
12916	be obtained with <link to="IMediumFormat::describeProperties"/>.
12917
12918	Setting the property value to @c null or an empty string is equivalent
12919	to deleting the existing value. A default value (if it is defined for
12920	this property) will be used by the format backend in this case.
12921	</desc>
12922	<param name="names" type="wstring" safearray="yes" dir="in">
12923	<desc>Names of properties to set.</desc>
12924	</param>
12925	<param name="values" type="wstring" safearray="yes" dir="in">
12926	<desc>Values of properties to set.</desc>
12927	</param>
12928	</method>
12929
12930	<!-- storage methods -->
12931
12932	<method name="createBaseStorage">
12933	<desc>
12934	Starts creating a hard disk storage unit (fixed/dynamic, according
12935	to the variant flags) in in the background. The previous storage unit
12936	created for this object, if any, must first be deleted using
12937	<link to="#deleteStorage"/>, otherwise the operation will fail.
12938
12939	Before the operation starts, the medium is placed in
12940	<link to="MediumState_Creating"/> state. If the create operation
12941	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
12942	state.
12943
12944	After the returned progress object reports that the operation has
12945	successfully completed, the medium state will be set to <link
12946	to="MediumState_Created"/>, the medium will be remembered by this
12947	VirtualBox installation and may be attached to virtual machines.
12948
12949	<result name="VBOX_E_NOT_SUPPORTED">
12950	The variant of storage creation operation is not supported. See <link
12951	to="IMediumFormat::capabilities"/>.
12952	</result>
12953	</desc>
12954	<param name="logicalSize" type="long long" dir="in">
12955	<desc>Maximum logical size of the medium in bytes.</desc>
12956	</param>
12957	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
12958	<desc>Exact image variant which should be created (as a combination of
12959	<link to="MediumVariant" /> flags).</desc>
12960	</param>
12961	<param name="progress" type="IProgress" dir="return">
12962	<desc>Progress object to track the operation completion.</desc>
12963	</param>
12964	</method>
12965
12966	<method name="deleteStorage">
12967	<desc>
12968	Starts deleting the storage unit of this medium.
12969
12970	The medium must not be attached to any known virtual machine and must
12971	not have any known child media, otherwise the operation will fail.
12972	It will also fail if there is no storage unit to delete or if deletion
12973	is already in progress, or if the medium is being in use (locked for
12974	read or for write) or inaccessible. Therefore, the only valid state for
12975	this operation to succeed is <link to="MediumState_Created"/>.
12976
12977	Before the operation starts, the medium is placed in
12978	<link to="MediumState_Deleting"/> state and gets removed from the list
12979	of remembered hard disks (media registry). If the delete operation
12980	fails, the medium will be remembered again and placed back to
12981	<link to="MediumState_Created"/> state.
12982
12983	After the returned progress object reports that the operation is
12984	complete, the medium state will be set to
12985	<link to="MediumState_NotCreated"/> and you will be able to use one of
12986	the storage creation methods to create it again.
12987
12988	<see><link to="#close"/></see>
12989
12990	<result name="VBOX_E_OBJECT_IN_USE">
12991	Medium is attached to a virtual machine.
12992	</result>
12993	<result name="VBOX_E_NOT_SUPPORTED">
12994	Storage deletion is not allowed because neither of storage creation
12995	operations are supported. See
12996	<link to="IMediumFormat::capabilities"/>.
12997	</result>
12998
12999	<note>
13000	If the deletion operation fails, it is not guaranteed that the storage
13001	unit still exists. You may check the <link to="IMedium::state"/> value
13002	to answer this question.
13003	</note>
13004	</desc>
13005	<param name="progress" type="IProgress" dir="return">
13006	<desc>Progress object to track the operation completion.</desc>
13007	</param>
13008	</method>
13009
13010	<!-- diff methods -->
13011
13012	<method name="createDiffStorage">
13013	<desc>
13014	Starts creating an empty differencing storage unit based on this
13015	medium in the format and at the location defined by the @a target
13016	argument.
13017
13018	The target medium must be in <link to="MediumState_NotCreated"/>
13019	state (i.e. must not have an existing storage unit). Upon successful
13020	completion, this operation will set the type of the target medium to
13021	<link to="MediumType_Normal"/> and create a storage unit necessary to
13022	represent the differencing medium data in the given format (according
13023	to the storage format of the target object).
13024
13025	After the returned progress object reports that the operation is
13026	successfully complete, the target medium gets remembered by this
13027	VirtualBox installation and may be attached to virtual machines.
13028
13029	<note>
13030	The medium will be set to <link to="MediumState_LockedRead"/>
13031	state for the duration of this operation.
13032	</note>
13033	<result name="VBOX_E_OBJECT_IN_USE">
13034	Medium not in @c NotCreated state.
13035	</result>
13036	</desc>
13037	<param name="target" type="IMedium" dir="in">
13038	<desc>Target medium.</desc>
13039	</param>
13040	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13041	<desc>Exact image variant which should be created (as a combination of
13042	<link to="MediumVariant" /> flags).</desc>
13043	</param>
13044	<param name="progress" type="IProgress" dir="return">
13045	<desc>Progress object to track the operation completion.</desc>
13046	</param>
13047	</method>
13048
13049	<method name="mergeTo">
13050	<desc>
13051	Starts merging the contents of this medium and all intermediate
13052	differencing media in the chain to the given target medium.
13053
13054	The target medium must be either a descendant of this medium or
13055	its ancestor (otherwise this method will immediately return a failure).
13056	It follows that there are two logical directions of the merge operation:
13057	from ancestor to descendant (<i>forward merge</i>) and from descendant to
13058	ancestor (<i>backward merge</i>). Let us consider the following medium
13059	chain:
13060
13061	<pre>Base <- Diff_1 <- Diff_2</pre>
13062
13063	Here, calling this method on the <tt>Base</tt> medium object with
13064	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
13065	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
13066	merge. Note that in both cases the contents of the resulting medium
13067	will be the same, the only difference is the medium object that takes
13068	the result of the merge operation. In case of the forward merge in the
13069	above example, the result will be written to <tt>Diff_2</tt>; in case of
13070	the backward merge, the result will be written to <tt>Base</tt>. In
13071	other words, the result of the operation is always stored in the target
13072	medium.
13073
13074	Upon successful operation completion, the storage units of all media in
13075	the chain between this (source) medium and the target medium, including
13076	the source medium itself, will be automatically deleted and the
13077	relevant medium objects (including this medium) will become
13078	uninitialized. This means that any attempt to call any of
13079	their methods or attributes will fail with the
13080	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
13081	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
13082	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
13083	Note that <tt>Diff_2</tt> in this case will become a base medium
13084	itself since it will no longer be based on any other medium.
13085
13086	Considering the above, all of the following conditions must be met in
13087	order for the merge operation to succeed:
13088	<ul>
13089	<li>
13090	Neither this (source) medium nor any intermediate
13091	differencing medium in the chain between it and the target
13092	medium is attached to any virtual machine.
13093	</li>
13094	<li>
13095	Neither the source medium nor the target medium is an
13096	<link to="MediumType_Immutable"/> medium.
13097	</li>
13098	<li>
13099	The part of the medium tree from the source medium to the
13100	target medium is a linear chain, i.e. all medium in this
13101	chain have exactly one child which is the next medium in this
13102	chain. The only exception from this rule is the target medium in
13103	the forward merge operation; it is allowed to have any number of
13104	child media because the merge operation will not change its
13105	logical contents (as it is seen by the guest OS or by children).
13106	</li>
13107	<li>
13108	None of the involved media are in
13109	<link to="MediumState_LockedRead"/> or
13110	<link to="MediumState_LockedWrite"/> state.
13111	</li>
13112	</ul>
13113
13114	<note>
13115	This (source) medium and all intermediates will be placed to <link
13116	to="MediumState_Deleting"/> state and the target medium will be
13117	placed to <link to="MediumState_LockedWrite"/> state and for the
13118	duration of this operation.
13119	</note>
13120	</desc>
13121	<param name="target" type="IMedium" dir="in">
13122	<desc>Target medium.</desc>
13123	</param>
13124	<param name="progress" type="IProgress" dir="return">
13125	<desc>Progress object to track the operation completion.</desc>
13126	</param>
13127	</method>
13128
13129	<!-- clone method -->
13130
13131	<method name="cloneTo">
13132	<desc>
13133	Starts creating a clone of this medium in the format and at the
13134	location defined by the @a target argument.
13135
13136	The target medium must be either in <link to="MediumState_NotCreated"/>
13137	state (i.e. must not have an existing storage unit) or in
13138	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13139	big enough to hold the data or else the copy will be partial). Upon
13140	successful completion, the cloned medium will contain exactly the
13141	same sector data as the medium being cloned, except that in the
13142	first case a new UUID for the clone will be randomly generated, and in
13143	the second case the UUID will remain unchanged.
13144
13145	The @a parent argument defines which medium will be the parent
13146	of the clone. Passing a @c null reference indicates that the clone will
13147	be a base image, i.e. completely independent. It is possible to specify
13148	an arbitrary medium for this parameter, including the parent of the
13149	medium which is being cloned. Even cloning to a child of the source
13150	medium is possible. Note that when cloning to an existing image, the
13151	@a parent argument is ignored.
13152
13153	After the returned progress object reports that the operation is
13154	successfully complete, the target medium gets remembered by this
13155	VirtualBox installation and may be attached to virtual machines.
13156
13157	<note>
13158	This medium will be placed to <link to="MediumState_LockedRead"/>
13159	state for the duration of this operation.
13160	</note>
13161	<result name="E_NOTIMPL">
13162	The specified cloning variant is not supported at the moment.
13163	</result>
13164	</desc>
13165	<param name="target" type="IMedium" dir="in">
13166	<desc>Target medium.</desc>
13167	</param>
13168	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13169	<desc>Exact image variant which should be created (as a combination of
13170	<link to="MediumVariant" /> flags).</desc>
13171	</param>
13172	<param name="parent" type="IMedium" dir="in">
13173	<desc>Parent of the cloned medium.</desc>
13174	</param>
13175	<param name="progress" type="IProgress" dir="return">
13176	<desc>Progress object to track the operation completion.</desc>
13177	</param>
13178	</method>
13179
13180	<method name="cloneToBase">
13181	<desc>
13182	Starts creating a clone of this medium in the format and at the
13183	location defined by the @a target argument.
13184
13185	The target medium must be either in <link to="MediumState_NotCreated"/>
13186	state (i.e. must not have an existing storage unit) or in
13187	<link to="MediumState_Created"/> state (i.e. created and not locked, and
13188	big enough to hold the data or else the copy will be partial). Upon
13189	successful completion, the cloned medium will contain exactly the
13190	same sector data as the medium being cloned, except that in the
13191	first case a new UUID for the clone will be randomly generated, and in
13192	the second case the UUID will remain unchanged.
13193
13194	The @a parent argument defines which medium will be the parent
13195	of the clone. In this case the clone will be a base image, i.e.
13196	completely independent. It is possible to specify an arbitrary
13197	medium for this parameter, including the parent of the
13198	medium which is being cloned. Even cloning to a child of the source
13199	medium is possible. Note that when cloning to an existing image, the
13200	@a parent argument is ignored.
13201
13202	After the returned progress object reports that the operation is
13203	successfully complete, the target medium gets remembered by this
13204	VirtualBox installation and may be attached to virtual machines.
13205
13206	<note>
13207	This medium will be placed to <link to="MediumState_LockedRead"/>
13208	state for the duration of this operation.
13209	</note>
13210	<result name="E_NOTIMPL">
13211	The specified cloning variant is not supported at the moment.
13212	</result>
13213	</desc>
13214	<param name="target" type="IMedium" dir="in">
13215	<desc>Target medium.</desc>
13216	</param>
13217	<param name="variant" type="MediumVariant" safearray="yes" dir="in">
13218	<desc><link to="MediumVariant" /> flags).</desc>
13219	</param>
13220	<param name="progress" type="IProgress" dir="return">
13221	<desc>Progress object to track the operation completion.</desc>
13222	</param>
13223	</method>
13224
13225	<!-- other methods -->
13226
13227	<method name="compact">
13228	<desc>
13229	Starts compacting of this medium. This means that the medium is
13230	transformed into a possibly more compact storage representation.
13231	This potentially creates temporary images, which can require a
13232	substantial amount of additional disk space.
13233
13234	This medium will be placed to <link to="MediumState_LockedWrite"/>
13235	state and all its parent media (if any) will be placed to
13236	<link to="MediumState_LockedRead"/> state for the duration of this
13237	operation.
13238
13239	Please note that the results can be either returned straight away,
13240	or later as the result of the background operation via the object
13241	returned via the @a progress parameter.
13242
13243	<result name="VBOX_E_NOT_SUPPORTED">
13244	Medium format does not support compacting (but potentially
13245	needs it).
13246	</result>
13247	</desc>
13248	<param name="progress" type="IProgress" dir="return">
13249	<desc>Progress object to track the operation completion.</desc>
13250	</param>
13251	</method>
13252
13253	<method name="resize">
13254	<desc>
13255	Starts resizing this medium. This means that the nominal size of the
13256	medium is set to the new value. Both increasing and decreasing the
13257	size is possible, and there are no safety checks, since VirtualBox
13258	does not make any assumptions about the medium contents.
13259
13260	Resizing usually needs additional disk space, and possibly also
13261	some temporary disk space. Note that resize does not create a full
13262	temporary copy of the medium, so the additional disk space requirement
13263	is usually much lower than using the clone operation.
13264
13265	This medium will be placed to <link to="MediumState_LockedWrite"/>
13266	state for the duration of this operation.
13267
13268	Please note that the results can be either returned straight away,
13269	or later as the result of the background operation via the object
13270	returned via the @a progress parameter.
13271
13272	<result name="VBOX_E_NOT_SUPPORTED">
13273	Medium format does not support resizing.
13274	</result>
13275	</desc>
13276	<param name="logicalSize" type="long long" dir="in">
13277	<desc>New nominal capacity of the medium in bytes.</desc>
13278	</param>
13279	<param name="progress" type="IProgress" dir="return">
13280	<desc>Progress object to track the operation completion.</desc>
13281	</param>
13282	</method>
13283
13284	<method name="reset">
13285	<desc>
13286	Starts erasing the contents of this differencing medium.
13287
13288	This operation will reset the differencing medium to its initial
13289	state when it does not contain any sector data and any read operation is
13290	redirected to its parent medium. This automatically gets called
13291	during VM power-up for every medium whose <link to="#autoReset" />
13292	attribute is @c true.
13293
13294	The medium will be write-locked for the duration of this operation (see
13295	<link to="#lockWrite" />).
13296
13297	<result name="VBOX_E_NOT_SUPPORTED">
13298	This is not a differencing medium.
13299	</result>
13300	<result name="VBOX_E_INVALID_OBJECT_STATE">
13301	Medium is not in <link to="MediumState_Created"/> or
13302	<link to="MediumState_Inaccessible"/> state.
13303	</result>
13304	</desc>
13305	<param name="progress" type="IProgress" dir="return">
13306	<desc>Progress object to track the operation completion.</desc>
13307	</param>
13308	</method>
13309
13310	</interface>
13311
13312
13313	<!--
13314	// IMediumFormat
13315	/////////////////////////////////////////////////////////////////////////
13316	-->
13317
13318	<enum
13319	name="DataType"
13320	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
13321	>
13322	<const name="Int32" value="0"/>
13323	<const name="Int8" value="1"/>
13324	<const name="String" value="2"/>
13325	</enum>
13326
13327	<enum
13328	name="DataFlags"
13329	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
13330	>
13331	<const name="None" value="0x00"/>
13332	<const name="Mandatory" value="0x01"/>
13333	<const name="Expert" value="0x02"/>
13334	<const name="Array" value="0x04"/>
13335	<const name="FlagMask" value="0x07"/>
13336	</enum>
13337
13338	<enum
13339	name="MediumFormatCapabilities"
13340	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
13341	>
13342	<desc>
13343	Medium format capability flags.
13344	</desc>
13345
13346	<const name="Uuid" value="0x01">
13347	<desc>
13348	Supports UUIDs as expected by VirtualBox code.
13349	</desc>
13350	</const>
13351
13352	<const name="CreateFixed" value="0x02">
13353	<desc>
13354	Supports creating fixed size images, allocating all space instantly.
13355	</desc>
13356	</const>
13357
13358	<const name="CreateDynamic" value="0x04">
13359	<desc>
13360	Supports creating dynamically growing images, allocating space on
13361	demand.
13362	</desc>
13363	</const>
13364
13365	<const name="CreateSplit2G" value="0x08">
13366	<desc>
13367	Supports creating images split in chunks of a bit less than 2 GBytes.
13368	</desc>
13369	</const>
13370
13371	<const name="Differencing" value="0x10">
13372	<desc>
13373	Supports being used as a format for differencing media (see <link
13374	to="IMedium::createDiffStorage"/>).
13375	</desc>
13376	</const>
13377
13378	<const name="Asynchronous" value="0x20">
13379	<desc>
13380	Supports asynchronous I/O operations for at least some configurations.
13381	</desc>
13382	</const>
13383
13384	<const name="File" value="0x40">
13385	<desc>
13386	The format backend operates on files (the <link to="IMedium::location"/>
13387	attribute of the medium specifies a file used to store medium
13388	data; for a list of supported file extensions see
13389	<link to="IMediumFormat::describeFileExtensions"/>).
13390	</desc>
13391	</const>
13392
13393	<const name="Properties" value="0x80">
13394	<desc>
13395	The format backend uses the property interface to configure the storage
13396	location and properties (the <link to="IMediumFormat::describeProperties"/>
13397	method is used to get access to properties supported by the given medium format).
13398	</desc>
13399	</const>
13400
13401	<const name="TcpNetworking" value="0x100">
13402	<desc>
13403	The format backend uses the TCP networking interface for network access.
13404	</desc>
13405	</const>
13406
13407	<const name="VFS" value="0x200">
13408	<desc>
13409	The format backend supports virtual filesystem functionality.
13410	</desc>
13411	</const>
13412
13413	<const name="CapabilityMask" value="0x3FF"/>
13414	</enum>
13415
13416	<interface
13417	name="IMediumFormat" extends="$unknown"
13418	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
13419	wsmap="managed"
13420	>
13421	<desc>
13422	The IMediumFormat interface represents a medium format.
13423
13424	Each medium format has an associated backend which is used to handle
13425	media stored in this format. This interface provides information
13426	about the properties of the associated backend.
13427
13428	Each medium format is identified by a string represented by the
13429	<link to="#id"/> attribute. This string is used in calls like
13430	<link to="IVirtualBox::createHardDisk"/> to specify the desired
13431	format.
13432
13433	The list of all supported medium formats can be obtained using
13434	<link to="ISystemProperties::mediumFormats"/>.
13435
13436	<see><link to="IMedium"/></see>
13437	</desc>
13438
13439	<attribute name="id" type="wstring" readonly="yes">
13440	<desc>
13441	Identifier of this format.
13442
13443	The format identifier is a non-@c null non-empty ASCII string. Note that
13444	this string is case-insensitive. This means that, for example, all of
13445	the following strings:
13446	<pre>
13447	"VDI"
13448	"vdi"
13449	"VdI"</pre>
13450	refer to the same medium format.
13451
13452	This string is used in methods of other interfaces where it is necessary
13453	to specify a medium format, such as
13454	<link to="IVirtualBox::createHardDisk"/>.
13455	</desc>
13456	</attribute>
13457
13458	<attribute name="name" type="wstring" readonly="yes">
13459	<desc>
13460	Human readable description of this format.
13461
13462	Mainly for use in file open dialogs.
13463	</desc>
13464	</attribute>
13465
13466	<attribute name="capabilities" type="unsigned long" readonly="yes">
13467	<desc>
13468	Capabilities of the format as a set of bit flags.
13469
13470	For the meaning of individual capability flags see
13471	<link to="MediumFormatCapabilities"/>.
13472	</desc>
13473	</attribute>
13474
13475	<method name="describeFileExtensions">
13476	<desc>
13477	Returns two arrays describing the supported file extensions.
13478
13479	The first array contains the supported extensions and the seconds one
13480	the type each extension supports. Both have the same size.
13481
13482	Note that some backends do not work on files, so this array may be
13483	empty.
13484
13485	<see><link to="IMediumFormat::capabilities"/></see>
13486	</desc>
13487	<param name="extensions" type="wstring" safearray="yes" dir="out">
13488	<desc>The array of supported extensions.</desc>
13489	</param>
13490	<param name="type" type="DeviceType" safearray="yes" dir="out">
13491	<desc>The array which indicates the device type for every given extension.</desc>
13492	</param>
13493	</method>
13494
13495	<method name="describeProperties" const="yes">
13496	<desc>
13497	Returns several arrays describing the properties supported by this
13498	format.
13499
13500	An element with the given index in each array describes one
13501	property. Thus, the number of elements in each returned array is the
13502	same and corresponds to the number of supported properties.
13503
13504	The returned arrays are filled in only if the
13505	<link to="MediumFormatCapabilities_Properties"/> flag is set.
13506	All arguments must be non-@c null.
13507
13508	<see><link to="DataType"/>, <link to="DataFlags"/></see>
13509	</desc>
13510
13511	<param name="names" type="wstring" safearray="yes" dir="out">
13512	<desc>Array of property names.</desc>
13513	</param>
13514	<param name="description" type="wstring" safearray="yes" dir="out">
13515	<desc>Array of property descriptions.</desc>
13516	</param>
13517	<param name="types" type="DataType" safearray="yes" dir="out">
13518	<desc>Array of property types.</desc>
13519	</param>
13520	<param name="flags" type="unsigned long" safearray="yes" dir="out">
13521	<desc>Array of property flags.</desc>
13522	</param>
13523	<param name="defaults" type="wstring" safearray="yes" dir="out">
13524	<desc>Array of default property values.</desc>
13525	</param>
13526	</method>
13527
13528	</interface>
13529
13530
13531	<!--
13532	// IKeyboard
13533	/////////////////////////////////////////////////////////////////////////
13534	-->
13535
13536	<interface
13537	name="IKeyboard" extends="$unknown"
13538	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
13539	wsmap="managed"
13540	>
13541	<desc>
13542	The IKeyboard interface represents the virtual machine's keyboard. Used
13543	in <link to="IConsole::keyboard"/>.
13544
13545	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
13546	to the virtual machine.
13547
13548	</desc>
13549	<method name="putScancode">
13550	<desc>Sends a scancode to the keyboard.
13551
13552	<result name="VBOX_E_IPRT_ERROR">
13553	Could not send scan code to virtual keyboard.
13554	</result>
13555
13556	</desc>
13557	<param name="scancode" type="long" dir="in"/>
13558	</method>
13559
13560	<method name="putScancodes">
13561	<desc>Sends an array of scancodes to the keyboard.
13562
13563	<result name="VBOX_E_IPRT_ERROR">
13564	Could not send all scan codes to virtual keyboard.
13565	</result>
13566
13567	</desc>
13568	<param name="scancodes" type="long" dir="in" safearray="yes"/>
13569	<param name="codesStored" type="unsigned long" dir="return"/>
13570	</method>
13571
13572	<method name="putCAD">
13573	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
13574	function is nothing special, it is just a convenience function
13575	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
13576
13577	<result name="VBOX_E_IPRT_ERROR">
13578	Could not send all scan codes to virtual keyboard.
13579	</result>
13580
13581	</desc>
13582	</method>
13583
13584	<attribute name="eventSource" type="IEventSource" readonly="yes">
13585	<desc>
13586	Event source for keyboard events.
13587	</desc>
13588	</attribute>
13589
13590	</interface>
13591
13592
13593	<!--
13594	// IMouse
13595	/////////////////////////////////////////////////////////////////////////
13596	-->
13597
13598	<enum
13599	name="MouseButtonState"
13600	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
13601	>
13602	<desc>
13603	Mouse button state.
13604	</desc>
13605
13606	<const name="LeftButton" value="0x01"/>
13607	<const name="RightButton" value="0x02"/>
13608	<const name="MiddleButton" value="0x04"/>
13609	<const name="WheelUp" value="0x08"/>
13610	<const name="WheelDown" value="0x10"/>
13611	<const name="XButton1" value="0x20"/>
13612	<const name="XButton2" value="0x40"/>
13613	<const name="MouseStateMask" value="0x7F"/>
13614	</enum>
13615
13616	<interface
13617	name="IMouse" extends="$unknown"
13618	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
13619	wsmap="managed"
13620	>
13621	<desc>
13622	The IMouse interface represents the virtual machine's mouse. Used in
13623	<link to="IConsole::mouse"/>.
13624
13625	Through this interface, the virtual machine's virtual mouse can be
13626	controlled.
13627	</desc>
13628
13629	<attribute name="absoluteSupported" type="boolean" readonly="yes">
13630	<desc>
13631	Whether the guest OS supports absolute mouse pointer positioning
13632	or not.
13633	<note>
13634	You can use the <link to="IMouseCapabilityChangedEvent"/>
13635	event to be instantly informed about changes of this attribute
13636	during virtual machine execution.
13637	</note>
13638	<see><link to="#putMouseEventAbsolute"/></see>
13639	</desc>
13640	</attribute>
13641
13642	<attribute name="relativeSupported" type="boolean" readonly="yes">
13643	<desc>
13644	Whether the guest OS supports relative mouse pointer positioning
13645	or not.
13646	<note>
13647	You can use the <link to="IMouseCapabilityChangedEvent"/>
13648	event to be instantly informed about changes of this attribute
13649	during virtual machine execution.
13650	</note>
13651	<see><link to="#putMouseEvent"/></see>
13652	</desc>
13653	</attribute>
13654
13655	<attribute name="needsHostCursor" type="boolean" readonly="yes">
13656	<desc>
13657	Whether the guest OS can currently switch to drawing it's own mouse
13658	cursor on demand.
13659	<note>
13660	You can use the <link to="IMouseCapabilityChangedEvent"/>
13661	event to be instantly informed about changes of this attribute
13662	during virtual machine execution.
13663	</note>
13664	<see><link to="#putMouseEvent"/></see>
13665	</desc>
13666	</attribute>
13667
13668	<method name="putMouseEvent">
13669	<desc>
13670	Initiates a mouse event using relative pointer movements
13671	along x and y axis.
13672
13673	<result name="E_ACCESSDENIED">
13674	Console not powered up.
13675	</result>
13676	<result name="VBOX_E_IPRT_ERROR">
13677	Could not send mouse event to virtual mouse.
13678	</result>
13679
13680	</desc>
13681
13682	<param name="dx" type="long" dir="in">
13683	<desc>
13684	Amount of pixels the mouse should move to the right.
13685	Negative values move the mouse to the left.
13686	</desc>
13687	</param>
13688	<param name="dy" type="long" dir="in">
13689	<desc>
13690	Amount of pixels the mouse should move downwards.
13691	Negative values move the mouse upwards.
13692	</desc>
13693	</param>
13694	<param name="dz" type="long" dir="in">
13695	<desc>
13696	Amount of mouse wheel moves.
13697	Positive values describe clockwise wheel rotations,
13698	negative values describe counterclockwise rotations.
13699	</desc>
13700	</param>
13701	<param name="dw" type="long" dir="in">
13702	<desc>
13703	Amount of horizontal mouse wheel moves.
13704	Positive values describe a movement to the left,
13705	negative values describe a movement to the right.
13706	</desc>
13707	</param>
13708	<param name="buttonState" type="long" dir="in">
13709	<desc>
13710	The current state of mouse buttons. Every bit represents
13711	a mouse button as follows:
13712	<table>
13713	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
13714	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
13715	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
13716	</table>
13717	A value of <tt>1</tt> means the corresponding button is pressed.
13718	otherwise it is released.
13719	</desc>
13720	</param>
13721	</method>
13722
13723	<method name="putMouseEventAbsolute">
13724	<desc>
13725	Positions the mouse pointer using absolute x and y coordinates.
13726	These coordinates are expressed in pixels and
13727	start from <tt>[1,1]</tt> which corresponds to the top left
13728	corner of the virtual display.
13729
13730	<result name="E_ACCESSDENIED">
13731	Console not powered up.
13732	</result>
13733	<result name="VBOX_E_IPRT_ERROR">
13734	Could not send mouse event to virtual mouse.
13735	</result>
13736
13737	<note>
13738	This method will have effect only if absolute mouse
13739	positioning is supported by the guest OS.
13740	</note>
13741
13742	<see><link to="#absoluteSupported"/></see>
13743	</desc>
13744
13745	<param name="x" type="long" dir="in">
13746	<desc>
13747	X coordinate of the pointer in pixels, starting from @c 1.
13748	</desc>
13749	</param>
13750	<param name="y" type="long" dir="in">
13751	<desc>
13752	Y coordinate of the pointer in pixels, starting from @c 1.
13753	</desc>
13754	</param>
13755	<param name="dz" type="long" dir="in">
13756	<desc>
13757	Amount of mouse wheel moves.
13758	Positive values describe clockwise wheel rotations,
13759	negative values describe counterclockwise rotations.
13760	</desc>
13761	</param>
13762	<param name="dw" type="long" dir="in">
13763	<desc>
13764	Amount of horizontal mouse wheel moves.
13765	Positive values describe a movement to the left,
13766	negative values describe a movement to the right.
13767	</desc>
13768	</param>
13769	<param name="buttonState" type="long" dir="in">
13770	<desc>
13771	The current state of mouse buttons. Every bit represents
13772	a mouse button as follows:
13773	<table>
13774	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
13775	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
13776	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
13777	</table>
13778	A value of @c 1 means the corresponding button is pressed.
13779	otherwise it is released.
13780	</desc>
13781	</param>
13782	</method>
13783
13784	<attribute name="eventSource" type="IEventSource" readonly="yes">
13785	<desc>
13786	Event source for mouse events.
13787	</desc>
13788	</attribute>
13789
13790	</interface>
13791
13792	<!--
13793	// IDisplay
13794	/////////////////////////////////////////////////////////////////////////
13795	-->
13796
13797	<enum
13798	name="FramebufferPixelFormat"
13799	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
13800	>
13801	<desc>
13802	Format of the video memory buffer. Constants represented by this enum can
13803	be used to test for particular values of <link
13804	to="IFramebuffer::pixelFormat"/>. See also <link
13805	to="IFramebuffer::requestResize"/>.
13806
13807	See also www.fourcc.org for more information about FOURCC pixel formats.
13808	</desc>
13809
13810	<const name="Opaque" value="0">
13811	<desc>
13812	Unknown buffer format (the user may not assume any particular format of
13813	the buffer).
13814	</desc>
13815	</const>
13816	<const name="FOURCC_RGB" value="0x32424752">
13817	<desc>
13818	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
13819	bit layout).
13820	</desc>
13821	</const>
13822	</enum>
13823
13824	<interface
13825	name="IFramebuffer" extends="$unknown"
13826	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
13827	wsmap="suppress"
13828	>
13829	<attribute name="address" type="octet" mod="ptr" readonly="yes">
13830	<desc>Address of the start byte of the frame buffer.</desc>
13831	</attribute>
13832
13833	<attribute name="width" type="unsigned long" readonly="yes">
13834	<desc>Frame buffer width, in pixels.</desc>
13835	</attribute>
13836
13837	<attribute name="height" type="unsigned long" readonly="yes">
13838	<desc>Frame buffer height, in pixels.</desc>
13839	</attribute>
13840
13841	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
13842	<desc>
13843	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
13844	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
13845	are: 8, 15, 16, 24 and 32.
13846	</desc>
13847	</attribute>
13848
13849	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
13850	<desc>
13851	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
13852	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
13853	size of the scan line must be aligned to 32 bits.
13854	</desc>
13855	</attribute>
13856
13857	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
13858	<desc>
13859	Frame buffer pixel format. It's either one of the values defined by <link
13860	to="FramebufferPixelFormat"/> or a raw FOURCC code.
13861	<note>
13862	This attribute must never return <link
13863	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
13864	<link to="#address"/> points to must be always known.
13865	</note>
13866	</desc>
13867	</attribute>
13868
13869	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
13870	<desc>
13871	Defines whether this frame buffer uses the virtual video card's memory
13872	buffer (guest VRAM) directly or not. See <link
13873	to="IFramebuffer::requestResize"/> for more information.
13874	</desc>
13875	</attribute>
13876
13877	<attribute name="heightReduction" type="unsigned long" readonly="yes">
13878	<desc>
13879	Hint from the frame buffer about how much of the standard
13880	screen height it wants to use for itself. This information is
13881	exposed to the guest through the VESA BIOS and VMMDev interface
13882	so that it can use it for determining its video mode table. It
13883	is not guaranteed that the guest respects the value.
13884	</desc>
13885	</attribute>
13886
13887	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
13888	<desc>
13889	An alpha-blended overlay which is superposed over the frame buffer.
13890	The initial purpose is to allow the display of icons providing
13891	information about the VM state, including disk activity, in front
13892	ends which do not have other means of doing that. The overlay is
13893	designed to controlled exclusively by IDisplay. It has no locking
13894	of its own, and any changes made to it are not guaranteed to be
13895	visible until the affected portion of IFramebuffer is updated. The
13896	overlay can be created lazily the first time it is requested. This
13897	attribute can also return @c null to signal that the overlay is not
13898	implemented.
13899	</desc>
13900	</attribute>
13901
13902	<attribute name="winId" type="long long" readonly="yes">
13903	<desc>
13904	Platform-dependent identifier of the window where context of this
13905	frame buffer is drawn, or zero if there's no such window.
13906	</desc>
13907	</attribute>
13908
13909	<method name="lock">
13910	<desc>
13911	Locks the frame buffer.
13912	Gets called by the IDisplay object where this frame buffer is
13913	bound to.
13914	</desc>
13915	</method>
13916
13917	<method name="unlock">
13918	<desc>
13919	Unlocks the frame buffer.
13920	Gets called by the IDisplay object where this frame buffer is
13921	bound to.
13922	</desc>
13923	</method>
13924
13925	<method name="notifyUpdate">
13926	<desc>
13927	Informs about an update.
13928	Gets called by the display object where this buffer is
13929	registered.
13930	</desc>
13931	<param name="x" type="unsigned long" dir="in"/>
13932	<param name="y" type="unsigned long" dir="in"/>
13933	<param name="width" type="unsigned long" dir="in"/>
13934	<param name="height" type="unsigned long" dir="in"/>
13935	</method>
13936
13937	<method name="requestResize">
13938	<desc>
13939	Requests a size and pixel format change.
13940
13941	There are two modes of working with the video buffer of the virtual
13942	machine. The <i>indirect</i> mode implies that the IFramebuffer
13943	implementation allocates a memory buffer for the requested display mode
13944	and provides it to the virtual machine. In <i>direct</i> mode, the
13945	IFramebuffer implementation uses the memory buffer allocated and owned
13946	by the virtual machine. This buffer represents the video memory of the
13947	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
13948	usually faster because the implementation gets a raw pointer to the
13949	guest VRAM buffer which it can directly use for visualizing the contents
13950	of the virtual display, as opposed to the indirect mode where the
13951	contents of guest VRAM are copied to the memory buffer provided by
13952	the implementation every time a display update occurs.
13953
13954	It is important to note that the direct mode is really fast only when
13955	the implementation uses the given guest VRAM buffer directly, for
13956	example, by blitting it to the window representing the virtual machine's
13957	display, which saves at least one copy operation comparing to the
13958	indirect mode. However, using the guest VRAM buffer directly is not
13959	always possible: the format and the color depth of this buffer may be
13960	not supported by the target window, or it may be unknown (opaque) as in
13961	case of text or non-linear multi-plane VGA video modes. In this case,
13962	the indirect mode (that is always available) should be used as a
13963	fallback: when the guest VRAM contents are copied to the
13964	implementation-provided memory buffer, color and format conversion is
13965	done automatically by the underlying code.
13966
13967	The @a pixelFormat parameter defines whether the direct mode is
13968	available or not. If @a pixelFormat is <link
13969	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
13970	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
13971	@a bytesPerLine parameters must be ignored and the implementation must use
13972	the indirect mode (where it provides its own buffer in one of the
13973	supported formats). In all other cases, @a pixelFormat together with
13974	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
13975	buffer pointed to by the @a VRAM parameter and the implementation is
13976	free to choose which mode to use. To indicate that this frame buffer uses
13977	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
13978	attribute must return @c true and <link to="#address"/> must
13979	return exactly the same address that is passed in the @a VRAM parameter
13980	of this method; otherwise it is assumed that the indirect strategy is
13981	chosen.
13982
13983	The @a width and @a height parameters represent the size of the
13984	requested display mode in both modes. In case of indirect mode, the
13985	provided memory buffer should be big enough to store data of the given
13986	display mode. In case of direct mode, it is guaranteed that the given
13987	@a VRAM buffer contains enough space to represent the display mode of the
13988	given size. Note that this frame buffer's <link to="#width"/> and <link
13989	to="#height"/> attributes must return exactly the same values as
13990	passed to this method after the resize is completed (see below).
13991
13992	The @a finished output parameter determines if the implementation has
13993	finished resizing the frame buffer or not. If, for some reason, the
13994	resize cannot be finished immediately during this call, @a finished
13995	must be set to @c false, and the implementation must call
13996	<link to="IDisplay::resizeCompleted"/> after it has returned from
13997	this method as soon as possible. If @a finished is @c false, the
13998	machine will not call any frame buffer methods until
13999	<link to="IDisplay::resizeCompleted"/> is called.
14000
14001	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
14002	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
14003	this frame buffer must return exactly the same values as specified in the
14004	parameters of this method, after the resize is completed. If the
14005	indirect mode is chosen, these attributes must return values describing
14006	the format of the implementation's own memory buffer <link
14007	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
14008	value must always correlate with <link to="#pixelFormat"/>. Note that
14009	the <link to="#pixelFormat"/> attribute must never return <link
14010	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
14011
14012	<note>
14013	This method is called by the IDisplay object under the
14014	<link to="#lock"/> provided by this IFramebuffer
14015	implementation. If this method returns @c false in @a finished, then
14016	this lock is not released until
14017	<link to="IDisplay::resizeCompleted"/> is called.
14018	</note>
14019	</desc>
14020	<param name="screenId" type="unsigned long" dir="in">
14021	<desc>
14022	Logical screen number. Must be used in the corresponding call to
14023	<link to="IDisplay::resizeCompleted"/> if this call is made.
14024	</desc>
14025	</param>
14026	<param name="pixelFormat" type="unsigned long" dir="in">
14027	<desc>
14028	Pixel format of the memory buffer pointed to by @a VRAM.
14029	See also <link to="FramebufferPixelFormat"/>.
14030	</desc>
14031	</param>
14032	<param name="VRAM" type="octet" mod="ptr" dir="in">
14033	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
14034	</param>
14035	<param name="bitsPerPixel" type="unsigned long" dir="in">
14036	<desc>Color depth, bits per pixel.</desc>
14037	</param>
14038	<param name="bytesPerLine" type="unsigned long" dir="in">
14039	<desc>Size of one scan line, in bytes.</desc>
14040	</param>
14041	<param name="width" type="unsigned long" dir="in">
14042	<desc>Width of the guest display, in pixels.</desc>
14043	</param>
14044	<param name="height" type="unsigned long" dir="in">
14045	<desc>Height of the guest display, in pixels.</desc>
14046	</param>
14047	<param name="finished" type="boolean" dir="return">
14048	<desc>
14049	Can the VM start using the new frame buffer immediately
14050	after this method returns or it should wait for
14051	<link to="IDisplay::resizeCompleted"/>.
14052	</desc>
14053	</param>
14054	</method>
14055
14056	<method name="videoModeSupported">
14057	<desc>
14058	Returns whether the frame buffer implementation is willing to
14059	support a given video mode. In case it is not able to render
14060	the video mode (or for some reason not willing), it should
14061	return @c false. Usually this method is called when the guest
14062	asks the VMM device whether a given video mode is supported
14063	so the information returned is directly exposed to the guest.
14064	It is important that this method returns very quickly.
14065	</desc>
14066	<param name="width" type="unsigned long" dir="in"/>
14067	<param name="height" type="unsigned long" dir="in"/>
14068	<param name="bpp" type="unsigned long" dir="in"/>
14069	<param name="supported" type="boolean" dir="return"/>
14070	</method>
14071
14072	<method name="getVisibleRegion">
14073	<desc>
14074	Returns the visible region of this frame buffer.
14075
14076	If the @a rectangles parameter is @c null then the value of the
14077	@a count parameter is ignored and the number of elements necessary to
14078	describe the current visible region is returned in @a countCopied.
14079
14080	If @a rectangles is not @c null but @a count is less
14081	than the required number of elements to store region data, the method
14082	will report a failure. If @a count is equal or greater than the
14083	required number of elements, then the actual number of elements copied
14084	to the provided array will be returned in @a countCopied.
14085
14086	<note>
14087	The address of the provided array must be in the process space of
14088	this IFramebuffer object.
14089	</note>
14090	<note>
14091	Method not yet implemented.
14092	</note>
14093	</desc>
14094	<param name="rectangles" type="octet" mod="ptr" dir="in">
14095	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
14096	</param>
14097	<param name="count" type="unsigned long" dir="in">
14098	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14099	</param>
14100	<param name="countCopied" type="unsigned long" dir="return">
14101	<desc>Number of elements copied to the @a rectangles array.</desc>
14102	</param>
14103	</method>
14104
14105	<method name="setVisibleRegion">
14106	<desc>
14107	Suggests a new visible region to this frame buffer. This region
14108	represents the area of the VM display which is a union of regions of
14109	all top-level windows of the guest operating system running inside the
14110	VM (if the Guest Additions for this system support this
14111	functionality). This information may be used by the frontends to
14112	implement the seamless desktop integration feature.
14113
14114	<note>
14115	The address of the provided array must be in the process space of
14116	this IFramebuffer object.
14117	</note>
14118	<note>
14119	The IFramebuffer implementation must make a copy of the provided
14120	array of rectangles.
14121	</note>
14122	<note>
14123	Method not yet implemented.
14124	</note>
14125	</desc>
14126	<param name="rectangles" type="octet" mod="ptr" dir="in">
14127	<desc>Pointer to the @c RTRECT array.</desc>
14128	</param>
14129	<param name="count" type="unsigned long" dir="in">
14130	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
14131	</param>
14132	</method>
14133
14134	<method name="processVHWACommand">
14135	<desc>
14136	Posts a Video HW Acceleration Command to the frame buffer for processing.
14137	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
14138	are posted from quest to the host to be processed by the host hardware.
14139
14140	<note>
14141	The address of the provided command must be in the process space of
14142	this IFramebuffer object.
14143	</note>
14144	</desc>
14145
14146	<param name="command" type="octet" mod="ptr" dir="in">
14147	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
14148	</param>
14149	</method>
14150
14151	</interface>
14152
14153	<interface
14154	name="IFramebufferOverlay" extends="IFramebuffer"
14155	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
14156	wsmap="suppress"
14157	>
14158	<desc>
14159	The IFramebufferOverlay interface represents an alpha blended overlay
14160	for displaying status icons above an IFramebuffer. It is always created
14161	not visible, so that it must be explicitly shown. It only covers a
14162	portion of the IFramebuffer, determined by its width, height and
14163	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
14164	that order) format, and may be written to directly. Do re-read the
14165	width though, after setting it, as it may be adjusted (increased) to
14166	make it more suitable for the front end.
14167	</desc>
14168	<attribute name="x" type="unsigned long" readonly="yes">
14169	<desc>X position of the overlay, relative to the frame buffer.</desc>
14170	</attribute>
14171
14172	<attribute name="y" type="unsigned long" readonly="yes">
14173	<desc>Y position of the overlay, relative to the frame buffer.</desc>
14174	</attribute>
14175
14176	<attribute name="visible" type="boolean" readonly="no">
14177	<desc>
14178	Whether the overlay is currently visible.
14179	</desc>
14180	</attribute>
14181
14182	<attribute name="alpha" type="unsigned long" readonly="no">
14183	<desc>
14184	The global alpha value for the overlay. This may or may not be
14185	supported by a given front end.
14186	</desc>
14187	</attribute>
14188
14189	<method name="move">
14190	<desc>
14191	Changes the overlay's position relative to the IFramebuffer.
14192	</desc>
14193	<param name="x" type="unsigned long" dir="in"/>
14194	<param name="y" type="unsigned long" dir="in"/>
14195	</method>
14196
14197	</interface>
14198
14199	<interface
14200	name="IDisplay" extends="$unknown"
14201	uuid="b83ee395-8679-40ca-8d60-1a0cbe724930"
14202	wsmap="managed"
14203	>
14204	<desc>
14205	The IDisplay interface represents the virtual machine's display.
14206
14207	The object implementing this interface is contained in each
14208	<link to="IConsole::display"/> attribute and represents the visual
14209	output of the virtual machine.
14210
14211	The virtual display supports pluggable output targets represented by the
14212	IFramebuffer interface. Examples of the output target are a window on
14213	the host computer or an RDP session's display on a remote computer.
14214	</desc>
14215	<method name="getScreenResolution">
14216	<desc>Queries display width, height and color depth for given screen.</desc>
14217	<param name="screenId" type="unsigned long" dir="in"/>
14218	<param name="width" type="unsigned long" dir="out"/>
14219	<param name="height" type="unsigned long" dir="out"/>
14220	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
14221	</method>
14222
14223	<method name="setFramebuffer">
14224	<desc>
14225	Sets the framebuffer for given screen.
14226	</desc>
14227	<param name="screenId" type="unsigned long" dir="in"/>
14228	<param name="framebuffer" type="IFramebuffer" dir="in"/>
14229	</method>
14230
14231	<method name="getFramebuffer">
14232	<desc>
14233	Queries the framebuffer for given screen.
14234	</desc>
14235	<param name="screenId" type="unsigned long" dir="in"/>
14236	<param name="framebuffer" type="IFramebuffer" dir="out"/>
14237	<param name="xOrigin" type="long" dir="out"/>
14238	<param name="yOrigin" type="long" dir="out"/>
14239	</method>
14240
14241	<method name="setVideoModeHint">
14242	<desc>
14243	Asks VirtualBox to request the given video mode from
14244	the guest. This is just a hint and it cannot be guaranteed
14245	that the requested resolution will be used. Guest Additions
14246	are required for the request to be seen by guests. The caller
14247	should issue the request and wait for a resolution change and
14248	after a timeout retry.
14249
14250	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
14251	parameters means that the corresponding values should be taken from the
14252	current video mode (i.e. left unchanged).
14253
14254	If the guest OS supports multi-monitor configuration then the @a display
14255	parameter specifies the number of the guest display to send the hint to:
14256	@c 0 is the primary display, @c 1 is the first secondary and
14257	so on. If the multi-monitor configuration is not supported, @a display
14258	must be @c 0.
14259
14260	<result name="E_INVALIDARG">
14261	The @a display is not associated with any monitor.
14262	</result>
14263
14264	</desc>
14265	<param name="display" type="unsigned long" dir="in">
14266	<desc>
14267	The number of the guest display to send the hint to.
14268	</desc>
14269	</param>
14270	<param name="enabled" type="boolean" dir="in">
14271	<desc>
14272	@c True, if this guest screen is enabled,
14273	@c False otherwise.
14274	</desc>
14275	</param>
14276	<param name="changeOrigin" type="boolean" dir="in">
14277	<desc>
14278	@c True, if the origin of the guest screen should be changed,
14279	@c False otherwise.
14280	</desc>
14281	</param>
14282	<param name="originX" type="long" dir="in">
14283	<desc>
14284	The X origin of the guest screen.
14285	</desc>
14286	</param>
14287	<param name="originY" type="long" dir="in">
14288	<desc>
14289	The Y origin of the guest screen.
14290	</desc>
14291	</param>
14292	<param name="width" type="unsigned long" dir="in"/>
14293	<param name="height" type="unsigned long" dir="in"/>
14294	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
14295	</method>
14296
14297	<method name="setSeamlessMode">
14298	<desc>
14299	Enables or disables seamless guest display rendering (seamless desktop
14300	integration) mode.
14301	<note>
14302	Calling this method has no effect if <link
14303	to="IGuest::getFacilityStatus"/> with facility @c Seamless
14304	does not return @c Active.
14305	</note>
14306	</desc>
14307	<param name="enabled" type="boolean" dir="in"/>
14308	</method>
14309
14310	<method name="takeScreenShot">
14311	<desc>
14312	Takes a screen shot of the requested size and copies it to the
14313	32-bpp buffer allocated by the caller and pointed to by @a address.
14314	A pixel consists of 4 bytes in order: B, G, R, 0.
14315
14316	<note>This API can be used only locally by a VM process through the
14317	COM/XPCOM C++ API as it requires pointer support. It is not
14318	available for scripting langages, Java or any webservice clients.
14319	Unless you are writing a new VM frontend use
14320	<link to="#takeScreenShotToArray" />.
14321	</note>
14322
14323	<result name="E_NOTIMPL">
14324	Feature not implemented.
14325	</result>
14326	<result name="VBOX_E_IPRT_ERROR">
14327	Could not take a screenshot.
14328	</result>
14329
14330	</desc>
14331	<param name="screenId" type="unsigned long" dir="in"/>
14332	<param name="address" type="octet" mod="ptr" dir="in"/>
14333	<param name="width" type="unsigned long" dir="in"/>
14334	<param name="height" type="unsigned long" dir="in"/>
14335	</method>
14336
14337	<method name="takeScreenShotToArray">
14338	<desc>
14339	Takes a guest screen shot of the requested size and returns it as
14340	an array of bytes in uncompressed 32-bit RGBA format.
14341	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
14342
14343	This API is slow, but could be the only option to get guest screenshot
14344	for scriptable languages not allowed to manipulate with addresses
14345	directly.
14346
14347	<result name="E_NOTIMPL">
14348	Feature not implemented.
14349	</result>
14350	<result name="VBOX_E_IPRT_ERROR">
14351	Could not take a screenshot.
14352	</result>
14353	</desc>
14354	<param name="screenId" type="unsigned long" dir="in">
14355	<desc>
14356	Monitor to take screenshot from.
14357	</desc>
14358	</param>
14359	<param name="width" type="unsigned long" dir="in">
14360	<desc>
14361	Desired image width.
14362	</desc>
14363	</param>
14364	<param name="height" type="unsigned long" dir="in">
14365	<desc>
14366	Desired image height.
14367	</desc>
14368	</param>
14369	<param name="screenData" type="octet" dir="return" safearray="yes">
14370	<desc>
14371	Array with resulting screen data.
14372	</desc>
14373	</param>
14374	</method>
14375
14376	<method name="takeScreenShotPNGToArray">
14377	<desc>
14378	Takes a guest screen shot of the requested size and returns it as
14379	PNG image in array.
14380
14381	<result name="E_NOTIMPL">
14382	Feature not implemented.
14383	</result>
14384	<result name="VBOX_E_IPRT_ERROR">
14385	Could not take a screenshot.
14386	</result>
14387	</desc>
14388	<param name="screenId" type="unsigned long" dir="in">
14389	<desc>
14390	Monitor to take the screenshot from.
14391	</desc>
14392	</param>
14393	<param name="width" type="unsigned long" dir="in">
14394	<desc>
14395	Desired image width.
14396	</desc>
14397	</param>
14398	<param name="height" type="unsigned long" dir="in">
14399	<desc>
14400	Desired image height.
14401	</desc>
14402	</param>
14403	<param name="screenData" type="octet" dir="return" safearray="yes">
14404	<desc>
14405	Array with resulting screen data.
14406	</desc>
14407	</param>
14408	</method>
14409
14410	<method name="drawToScreen">
14411	<desc>
14412	Draws a 32-bpp image of the specified size from the given buffer
14413	to the given point on the VM display.
14414
14415	<result name="E_NOTIMPL">
14416	Feature not implemented.
14417	</result>
14418	<result name="VBOX_E_IPRT_ERROR">
14419	Could not draw to screen.
14420	</result>
14421
14422	</desc>
14423	<param name="screenId" type="unsigned long" dir="in">
14424	<desc>
14425	Monitor to take the screenshot from.
14426	</desc>
14427	</param>
14428	<param name="address" type="octet" mod="ptr" dir="in">
14429	<desc>
14430	Address to store the screenshot to
14431	</desc>
14432	</param>
14433	<param name="x" type="unsigned long" dir="in">
14434	<desc>
14435	Relative to the screen top left corner.
14436	</desc>
14437	</param>
14438	<param name="y" type="unsigned long" dir="in">
14439	<desc>
14440	Relative to the screen top left corner.
14441	</desc>
14442	</param>
14443	<param name="width" type="unsigned long" dir="in">
14444	<desc>
14445	Desired image width.
14446	</desc>
14447	</param>
14448	<param name="height" type="unsigned long" dir="in">
14449	<desc>
14450	Desired image height.
14451	</desc>
14452	</param>
14453	</method>
14454
14455	<method name="invalidateAndUpdate">
14456	<desc>
14457	Does a full invalidation of the VM display and instructs the VM
14458	to update it.
14459
14460	<result name="VBOX_E_IPRT_ERROR">
14461	Could not invalidate and update screen.
14462	</result>
14463
14464	</desc>
14465	</method>
14466
14467	<method name="resizeCompleted">
14468	<desc>
14469	Signals that a framebuffer has completed the resize operation.
14470
14471	<result name="VBOX_E_NOT_SUPPORTED">
14472	Operation only valid for external frame buffers.
14473	</result>
14474
14475	</desc>
14476	<param name="screenId" type="unsigned long" dir="in"/>
14477	</method>
14478
14479	<method name="completeVHWACommand">
14480	<desc>
14481	Signals that the Video HW Acceleration command has completed.
14482	</desc>
14483
14484	<param name="command" type="octet" mod="ptr" dir="in">
14485	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
14486	</param>
14487	</method>
14488
14489	<method name="viewportChanged">
14490	<desc>
14491	Signals that framebuffer window viewport has changed.
14492
14493	<result name="E_INVALIDARG">
14494	The specified viewport data is invalid.
14495	</result>
14496
14497	</desc>
14498
14499	<param name="screenId" type="unsigned long" dir="in">
14500	<desc>
14501	Monitor to take the screenshot from.
14502	</desc>
14503	</param>
14504	<param name="x" type="unsigned long" dir="in">
14505	<desc>
14506	Framebuffer x offset.
14507	</desc>
14508	</param>
14509	<param name="y" type="unsigned long" dir="in">
14510	<desc>
14511	Framebuffer y offset.
14512	</desc>
14513	</param>
14514	<param name="width" type="unsigned long" dir="in">
14515	<desc>
14516	Viewport width.
14517	</desc>
14518	</param>
14519	<param name="height" type="unsigned long" dir="in">
14520	<desc>
14521	Viewport height.
14522	</desc>
14523	</param>
14524	</method>
14525	</interface>
14526
14527	<!--
14528	// INetworkAdapter
14529	/////////////////////////////////////////////////////////////////////////
14530	-->
14531
14532	<enum
14533	name="NetworkAttachmentType"
14534	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
14535	>
14536	<desc>
14537	Network attachment type.
14538	</desc>
14539
14540	<const name="Null" value="0">
14541	<desc>Null value, also means "not attached".</desc>
14542	</const>
14543	<const name="NAT" value="1"/>
14544	<const name="Bridged" value="2"/>
14545	<const name="Internal" value="3"/>
14546	<const name="HostOnly" value="4"/>
14547	<const name="Generic" value="5"/>
14548	</enum>
14549
14550	<enum
14551	name="NetworkAdapterType"
14552	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
14553	>
14554	<desc>
14555	Network adapter type.
14556	</desc>
14557
14558	<const name="Null" value="0">
14559	<desc>Null value (never used by the API).</desc>
14560	</const>
14561	<const name="Am79C970A" value="1">
14562	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
14563	</const>
14564	<const name="Am79C973" value="2">
14565	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
14566	</const>
14567	<const name="I82540EM" value="3">
14568	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
14569	</const>
14570	<const name="I82543GC" value="4">
14571	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
14572	</const>
14573	<const name="I82545EM" value="5">
14574	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
14575	</const>
14576	<const name="Virtio" value="6">
14577	<desc>Virtio network device.</desc>
14578	</const>
14579	</enum>
14580
14581	<enum
14582	name="NetworkAdapterPromiscModePolicy"
14583	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
14584	>
14585	<desc>
14586	The promiscuous mode policy of an interface.
14587	</desc>
14588
14589	<const name="Deny" value="1">
14590	<desc>Deny promiscuous mode requests.</desc>
14591	</const>
14592	<const name="AllowNetwork" value="2">
14593	<desc>
14594	Allow promicuous mode, but restrict the scope it to the internal
14595	network so that it only applies to other VMs.
14596	</desc>
14597	</const>
14598	<const name="AllowAll" value="3">
14599	<desc>
14600	Allow promicuous mode, include unrelated traffic going over the wire
14601	and internally on the host.
14602	</desc>
14603	</const>
14604	</enum>
14605
14606	<interface
14607	name="INetworkAdapter" extends="$unknown"
14608	uuid="efa0f965-63c7-4c60-afdf-b1cc9943b9c0"
14609	wsmap="managed"
14610	>
14611	<desc>
14612	Represents a virtual network adapter that is attached to a virtual machine.
14613	Each virtual machine has a fixed number of network adapter slots with one
14614	instance of this attached to each of them. Call
14615	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
14616	is attached to a given slot in a given machine.
14617
14618	Each network adapter can be in one of five attachment modes, which are
14619	represented by the <link to="NetworkAttachmentType" /> enumeration;
14620	see the <link to="#attachmentType" /> attribute.
14621	</desc>
14622
14623	<attribute name="adapterType" type="NetworkAdapterType">
14624	<desc>
14625	Type of the virtual network adapter. Depending on this value,
14626	VirtualBox will provide a different virtual network hardware
14627	to the guest.
14628	</desc>
14629	</attribute>
14630
14631	<attribute name="slot" type="unsigned long" readonly="yes">
14632	<desc>
14633	Slot number this adapter is plugged into. Corresponds to
14634	the value you pass to <link to="IMachine::getNetworkAdapter"/>
14635	to obtain this instance.
14636	</desc>
14637	</attribute>
14638
14639	<attribute name="enabled" type="boolean">
14640	<desc>
14641	Flag whether the network adapter is present in the
14642	guest system. If disabled, the virtual guest hardware will
14643	not contain this network adapter. Can only be changed when
14644	the VM is not running.
14645	</desc>
14646	</attribute>
14647
14648	<attribute name="MACAddress" type="wstring">
14649	<desc>
14650	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
14651	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
14652	</desc>
14653	</attribute>
14654
14655	<attribute name="attachmentType" type="NetworkAttachmentType">
14656	<desc>
14657	Sets/Gets network attachment type of this network adapter.
14658	</desc>
14659	</attribute>
14660
14661	<attribute name="bridgedInterface" type="wstring">
14662	<desc>
14663	Name of the network interface the VM should be bridged to.
14664	</desc>
14665	</attribute>
14666
14667	<attribute name="hostOnlyInterface" type="wstring">
14668	<desc>
14669	Name of the host only network interface the VM is attached to.
14670	</desc>
14671	</attribute>
14672
14673	<attribute name="internalNetwork" type="wstring">
14674	<desc>
14675	Name of the internal network the VM is attached to.
14676	</desc>
14677	</attribute>
14678
14679	<attribute name="NATNetwork" type="wstring">
14680	<desc>
14681	Name of the NAT network the VM is attached to.
14682	</desc>
14683	</attribute>
14684
14685	<attribute name="genericDriver" type="wstring">
14686	<desc>
14687	Name of the driver to use for the "Generic" network attachment type.
14688	</desc>
14689	</attribute>
14690
14691	<attribute name="cableConnected" type="boolean">
14692	<desc>
14693	Flag whether the adapter reports the cable as connected or not.
14694	It can be used to report offline situations to a VM.
14695	</desc>
14696	</attribute>
14697
14698	<attribute name="lineSpeed" type="unsigned long">
14699	<desc>
14700	Line speed reported by custom drivers, in units of 1 kbps.
14701	</desc>
14702	</attribute>
14703
14704	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
14705	<desc>
14706	The promiscuous mode policy of the network adapter when attached to an
14707	internal network, host only network or a bridge.
14708	</desc>
14709	</attribute>
14710
14711	<attribute name="traceEnabled" type="boolean">
14712	<desc>
14713	Flag whether network traffic from/to the network card should be traced.
14714	Can only be toggled when the VM is turned off.
14715	</desc>
14716	</attribute>
14717
14718	<attribute name="traceFile" type="wstring">
14719	<desc>
14720	Filename where a network trace will be stored. If not set, VBox-pid.pcap
14721	will be used.
14722	</desc>
14723	</attribute>
14724
14725	<attribute name="NATEngine" type="INATEngine" readonly="yes">
14726	<desc>
14727	Points to the NAT engine which handles the network address translation
14728	for this interface. This is active only when the interface actually uses
14729	NAT.
14730	</desc>
14731	</attribute>
14732
14733	<attribute name="bootPriority" type="unsigned long">
14734	<desc>
14735	Network boot priority of the adapter. Priority 1 is highest. If not set,
14736	the priority is considered to be at the lowest possible setting.
14737	</desc>
14738	</attribute>
14739
14740	<attribute name="bandwidthGroup" type="IBandwidthGroup">
14741	<desc>The bandwidth group this network adapter is assigned to.</desc>
14742	</attribute>
14743
14744	<!-- property methods -->
14745
14746	<method name="getProperty" const="yes">
14747	<desc>
14748	Returns the value of the network attachment property with the given name.
14749
14750	If the requested data @a key does not exist, this function will
14751	succeed and return an empty string in the @a value argument.
14752
14753	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
14754	</desc>
14755	<param name="key" type="wstring" dir="in">
14756	<desc>Name of the property to get.</desc>
14757	</param>
14758	<param name="value" type="wstring" dir="return">
14759	<desc>Current property value.</desc>
14760	</param>
14761	</method>
14762
14763	<method name="setProperty">
14764	<desc>
14765	Sets the value of the network attachment property with the given name.
14766
14767	Setting the property value to @c null or an empty string is equivalent
14768	to deleting the existing value.
14769
14770	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
14771	</desc>
14772	<param name="key" type="wstring" dir="in">
14773	<desc>Name of the property to set.</desc>
14774	</param>
14775	<param name="value" type="wstring" dir="in">
14776	<desc>Property value to set.</desc>
14777	</param>
14778	</method>
14779
14780	<method name="getProperties" const="yes">
14781	<desc>
14782	Returns values for a group of properties in one call.
14783
14784	The names of the properties to get are specified using the @a names
14785	argument which is a list of comma-separated property names or
14786	an empty string if all properties are to be returned.
14787	<note>Currently the value of this argument is ignored and the method
14788	always returns all existing properties.</note>
14789
14790	The method returns two arrays, the array of property names corresponding
14791	to the @a names argument and the current values of these properties.
14792	Both arrays have the same number of elements with each element at the
14793	given index in the first array corresponds to an element at the same
14794	index in the second array.
14795	</desc>
14796	<param name="names" type="wstring" dir="in">
14797	<desc>
14798	Names of properties to get.
14799	</desc>
14800	</param>
14801	<param name="returnNames" type="wstring" safearray="yes" dir="out">
14802	<desc>Names of returned properties.</desc>
14803	</param>
14804	<param name="returnValues" type="wstring" safearray="yes" dir="return">
14805	<desc>Values of returned properties.</desc>
14806	</param>
14807	</method>
14808
14809	</interface>
14810
14811
14812	<!--
14813	// ISerialPort
14814	/////////////////////////////////////////////////////////////////////////
14815	-->
14816
14817	<enum
14818	name="PortMode"
14819	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
14820	>
14821	<desc>
14822	The PortMode enumeration represents possible communication modes for
14823	the virtual serial port device.
14824	</desc>
14825
14826	<const name="Disconnected" value="0">
14827	<desc>Virtual device is not attached to any real host device.</desc>
14828	</const>
14829	<const name="HostPipe" value="1">
14830	<desc>Virtual device is attached to a host pipe.</desc>
14831	</const>
14832	<const name="HostDevice" value="2">
14833	<desc>Virtual device is attached to a host device.</desc>
14834	</const>
14835	<const name="RawFile" value="3">
14836	<desc>Virtual device is attached to a raw file.</desc>
14837	</const>
14838	</enum>
14839
14840	<interface
14841	name="ISerialPort" extends="$unknown"
14842	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
14843	wsmap="managed"
14844	>
14845
14846	<desc>
14847	The ISerialPort interface represents the virtual serial port device.
14848
14849	The virtual serial port device acts like an ordinary serial port
14850	inside the virtual machine. This device communicates to the real
14851	serial port hardware in one of two modes: host pipe or host device.
14852
14853	In host pipe mode, the #path attribute specifies the path to the pipe on
14854	the host computer that represents a serial port. The #server attribute
14855	determines if this pipe is created by the virtual machine process at
14856	machine startup or it must already exist before starting machine
14857	execution.
14858
14859	In host device mode, the #path attribute specifies the name of the
14860	serial port device on the host computer.
14861
14862	There is also a third communication mode: the disconnected mode. In this
14863	mode, the guest OS running inside the virtual machine will be able to
14864	detect the serial port, but all port write operations will be discarded
14865	and all port read operations will return no data.
14866
14867	<see><link to="IMachine::getSerialPort"/></see>
14868	</desc>
14869
14870	<attribute name="slot" type="unsigned long" readonly="yes">
14871	<desc>
14872	Slot number this serial port is plugged into. Corresponds to
14873	the value you pass to <link to="IMachine::getSerialPort"/>
14874	to obtain this instance.
14875	</desc>
14876	</attribute>
14877
14878	<attribute name="enabled" type="boolean">
14879	<desc>
14880	Flag whether the serial port is enabled. If disabled,
14881	the serial port will not be reported to the guest OS.
14882	</desc>
14883	</attribute>
14884
14885	<attribute name="IOBase" type="unsigned long">
14886	<desc>Base I/O address of the serial port.</desc>
14887	</attribute>
14888
14889	<attribute name="IRQ" type="unsigned long">
14890	<desc>IRQ number of the serial port.</desc>
14891	</attribute>
14892
14893	<attribute name="hostMode" type="PortMode">
14894	<desc>
14895	How is this port connected to the host.
14896	<note>
14897	Changing this attribute may fail if the conditions for
14898	<link to="#path"/> are not met.
14899	</note>
14900	</desc>
14901	</attribute>
14902
14903	<attribute name="server" type="boolean">
14904	<desc>
14905	Flag whether this serial port acts as a server (creates a new pipe on
14906	the host) or as a client (uses the existing pipe). This attribute is
14907	used only when <link to="#hostMode"/> is PortMode_HostPipe.
14908	</desc>
14909	</attribute>
14910
14911	<attribute name="path" type="wstring">
14912	<desc>
14913	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
14914	PortMode_HostPipe, or the host serial device name when
14915	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
14916	cases, setting a @c null or empty string as the attribute's value
14917	is an error. Otherwise, the value of this property is ignored.
14918	</desc>
14919	</attribute>
14920
14921	</interface>
14922
14923	<!--
14924	// IParallelPort
14925	/////////////////////////////////////////////////////////////////////////
14926	-->
14927
14928	<interface
14929	name="IParallelPort" extends="$unknown"
14930	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
14931	wsmap="managed"
14932	>
14933
14934	<desc>
14935	The IParallelPort interface represents the virtual parallel port device.
14936
14937	The virtual parallel port device acts like an ordinary parallel port
14938	inside the virtual machine. This device communicates to the real
14939	parallel port hardware using the name of the parallel device on the host
14940	computer specified in the #path attribute.
14941
14942	Each virtual parallel port device is assigned a base I/O address and an
14943	IRQ number that will be reported to the guest operating system and used
14944	to operate the given parallel port from within the virtual machine.
14945
14946	<see><link to="IMachine::getParallelPort"/></see>
14947	</desc>
14948
14949	<attribute name="slot" type="unsigned long" readonly="yes">
14950	<desc>
14951	Slot number this parallel port is plugged into. Corresponds to
14952	the value you pass to <link to="IMachine::getParallelPort"/>
14953	to obtain this instance.
14954	</desc>
14955	</attribute>
14956
14957	<attribute name="enabled" type="boolean">
14958	<desc>
14959	Flag whether the parallel port is enabled. If disabled,
14960	the parallel port will not be reported to the guest OS.
14961	</desc>
14962	</attribute>
14963
14964	<attribute name="IOBase" type="unsigned long">
14965	<desc>Base I/O address of the parallel port.</desc>
14966	</attribute>
14967
14968	<attribute name="IRQ" type="unsigned long">
14969	<desc>IRQ number of the parallel port.</desc>
14970	</attribute>
14971
14972	<attribute name="path" type="wstring">
14973	<desc>
14974	Host parallel device name. If this parallel port is enabled, setting a
14975	@c null or an empty string as this attribute's value will result in
14976	an error.
14977	</desc>
14978	</attribute>
14979
14980	</interface>
14981
14982
14983	<!--
14984	// IMachineDebugger
14985	/////////////////////////////////////////////////////////////////////////
14986	-->
14987
14988	<interface
14989	name="IMachineDebugger" extends="$unknown"
14990	uuid="a80bb82c-37c5-4155-a524-9c1d0a1689ba"
14991	wsmap="managed"
14992	>
14993	<method name="dumpGuestCore">
14994	<desc>
14995	Takes a core dump of the guest.
14996
14997	See include/VBox/dbgfcorefmt.h for details on the file format.
14998	</desc>
14999	<param name="filename" type="wstring" dir="in">
15000	<desc>
15001	The name of the output file. The file must not exist.
15002	</desc>
15003	</param>
15004	<param name="compression" type="wstring" dir="in">
15005	<desc>
15006	Reserved for future compression method indicator.
15007	</desc>
15008	</param>
15009	</method>
15010
15011	<method name="dumpHostProcessCore">
15012	<desc>
15013	Takes a core dump of the VM process on the host.
15014
15015	This feature is not implemented in the 4.0.0 release but it may show up
15016	in a dot release.
15017	</desc>
15018	<param name="filename" type="wstring" dir="in">
15019	<desc>
15020	The name of the output file. The file must not exist.
15021	</desc>
15022	</param>
15023	<param name="compression" type="wstring" dir="in">
15024	<desc>
15025	Reserved for future compression method indicator.
15026	</desc>
15027	</param>
15028	</method>
15029
15030	<method name="info">
15031	<desc>
15032	Interfaces with the info dumpers (DBGFInfo).
15033
15034	This feature is not implemented in the 4.0.0 release but it may show up
15035	in a dot release.
15036	</desc>
15037	<param name="name" type="wstring" dir="in">
15038	<desc>
15039	The name of the info item.
15040	</desc>
15041	</param>
15042	<param name="args" type="wstring" dir="in">
15043	<desc>
15044	Arguments to the info dumper.
15045	</desc>
15046	</param>
15047	<param name="info" type="wstring" dir="return">
15048	<desc>
15049	The into string.
15050	</desc>
15051	</param>
15052	</method>
15053
15054	<method name="injectNMI">
15055	<desc>
15056	Inject an NMI into a running VT-x/AMD-V VM.
15057	</desc>
15058	</method>
15059
15060	<method name="modifyLogGroups">
15061	<desc>
15062	Modifies the group settings of the debug or release logger.
15063	</desc>
15064	<param name="settings" type="wstring" dir="in">
15065	<desc>
15066	The group settings string. See iprt/log.h for details. To target the
15067	release logger, prefix the string with "release:".
15068	</desc>
15069	</param>
15070	</method>
15071
15072	<method name="modifyLogFlags">
15073	<desc>
15074	Modifies the debug or release logger flags.
15075	</desc>
15076	<param name="settings" type="wstring" dir="in">
15077	<desc>
15078	The flags settings string. See iprt/log.h for details. To target the
15079	release logger, prefix the string with "release:".
15080	</desc>
15081	</param>
15082	</method>
15083
15084	<method name="modifyLogDestinations">
15085	<desc>
15086	Modifies the debug or release logger destinations.
15087	</desc>
15088	<param name="settings" type="wstring" dir="in">
15089	<desc>
15090	The destination settings string. See iprt/log.h for details. To target the
15091	release logger, prefix the string with "release:".
15092	</desc>
15093	</param>
15094	</method>
15095
15096	<method name="readPhysicalMemory">
15097	<desc>
15098	Reads guest physical memory, no side effects (MMIO++).
15099
15100	This feature is not implemented in the 4.0.0 release but may show up
15101	in a dot release.
15102	</desc>
15103	<param name="address" type="long long" dir="in">
15104	<desc>The guest physical address.</desc>
15105	</param>
15106	<param name="size" type="unsigned long" dir="in">
15107	<desc>The number of bytes to read.</desc>
15108	</param>
15109	<param name="bytes" type="octet" safearray="yes" dir="return">
15110	<desc>The bytes read.</desc>
15111	</param>
15112	</method>
15113
15114	<method name="writePhysicalMemory">
15115	<desc>
15116	Writes guest physical memory, access handles (MMIO++) are ignored.
15117
15118	This feature is not implemented in the 4.0.0 release but may show up
15119	in a dot release.
15120	</desc>
15121	<param name="address" type="long long" dir="in">
15122	<desc>The guest physical address.</desc>
15123	</param>
15124	<param name="size" type="unsigned long" dir="in">
15125	<desc>The number of bytes to read.</desc>
15126	</param>
15127	<param name="bytes" type="octet" safearray="yes" dir="in">
15128	<desc>The bytes to write.</desc>
15129	</param>
15130	</method>
15131
15132	<method name="readVirtualMemory">
15133	<desc>
15134	Reads guest virtual memory, no side effects (MMIO++).
15135
15136	This feature is not implemented in the 4.0.0 release but may show up
15137	in a dot release.
15138	</desc>
15139	<param name="cpuId" type="unsigned long" dir="in">
15140	<desc>The identifier of the Virtual CPU.</desc>
15141	</param>
15142	<param name="address" type="long long" dir="in">
15143	<desc>The guest virtual address.</desc>
15144	</param>
15145	<param name="size" type="unsigned long" dir="in">
15146	<desc>The number of bytes to read.</desc>
15147	</param>
15148	<param name="bytes" type="octet" safearray="yes" dir="return">
15149	<desc>The bytes read.</desc>
15150	</param>
15151	</method>
15152
15153	<method name="writeVirtualMemory">
15154	<desc>
15155	Writes guest virtual memory, access handles (MMIO++) are ignored.
15156
15157	This feature is not implemented in the 4.0.0 release but may show up
15158	in a dot release.
15159	</desc>
15160	<param name="cpuId" type="unsigned long" dir="in">
15161	<desc>The identifier of the Virtual CPU.</desc>
15162	</param>
15163	<param name="address" type="long long" dir="in">
15164	<desc>The guest virtual address.</desc>
15165	</param>
15166	<param name="size" type="unsigned long" dir="in">
15167	<desc>The number of bytes to read.</desc>
15168	</param>
15169	<param name="bytes" type="octet" safearray="yes" dir="in">
15170	<desc>The bytes to write.</desc>
15171	</param>
15172	</method>
15173
15174	<method name="detectOS">
15175	<desc>
15176	Tries to (re-)detect the guest OS kernel.
15177
15178	This feature is not implemented in the 4.0.0 release but may show up
15179	in a dot release.
15180	</desc>
15181	<param name="os" type="wstring" dir="return">
15182	<desc>
15183	The detected OS kernel on success.
15184	</desc>
15185	</param>
15186	</method>
15187
15188	<method name="getRegister">
15189	<desc>
15190	Gets one register.
15191
15192	This feature is not implemented in the 4.0.0 release but may show up
15193	in a dot release.
15194	</desc>
15195	<param name="cpuId" type="unsigned long" dir="in">
15196	<desc>The identifier of the Virtual CPU.</desc>
15197	</param>
15198	<param name="name" type="wstring" dir="in">
15199	<desc>The register name, case is ignored.</desc>
15200	</param>
15201	<param name="value" type="wstring" dir="return">
15202	<desc>
15203	The register value. This is usually a hex value (always 0x prefixed)
15204	but other format may be used for floating point registers (TBD).
15205	</desc>
15206	</param>
15207	</method>
15208
15209	<method name="getRegisters">
15210	<desc>
15211	Gets all the registers for the given CPU.
15212
15213	This feature is not implemented in the 4.0.0 release but may show up
15214	in a dot release.
15215	</desc>
15216	<param name="cpuId" type="unsigned long" dir="in">
15217	<desc>The identifier of the Virtual CPU.</desc>
15218	</param>
15219	<param name="names" type="wstring" dir="out" safearray="yes">
15220	<desc>Array containing the lowercase register names.</desc>
15221	</param>
15222	<param name="values" type="wstring" dir="out" safearray="yes">
15223	<desc>
15224	Array paralell to the names holding the register values as if the
15225	register was returned by <link to="IMachineDebugger::getRegister"/>.
15226	</desc>
15227	</param>
15228	</method>
15229
15230	<method name="setRegister">
15231	<desc>
15232	Gets one register.
15233
15234	This feature is not implemented in the 4.0.0 release but may show up
15235	in a dot release.
15236	</desc>
15237	<param name="cpuId" type="unsigned long" dir="in">
15238	<desc>The identifier of the Virtual CPU.</desc>
15239	</param>
15240	<param name="name" type="wstring" dir="in">
15241	<desc>The register name, case is ignored.</desc>
15242	</param>
15243	<param name="value" type="wstring" dir="in">
15244	<desc>
15245	The new register value. Hexadecimal, decimal and octal formattings
15246	are supported in addition to any special formattings returned by
15247	the getters.
15248	</desc>
15249	</param>
15250	</method>
15251
15252	<method name="setRegisters">
15253	<desc>
15254	Sets zero or more registers atomically.
15255
15256	This feature is not implemented in the 4.0.0 release but may show up
15257	in a dot release.
15258	</desc>
15259	<param name="cpuId" type="unsigned long" dir="in">
15260	<desc>The identifier of the Virtual CPU.</desc>
15261	</param>
15262	<param name="names" type="wstring" dir="in" safearray="yes">
15263	<desc>Array containing the register names, case ignored.</desc>
15264	</param>
15265	<param name="values" type="wstring" dir="in" safearray="yes">
15266	<desc>
15267	Array paralell to the names holding the register values. See
15268	<link to="IMachineDebugger::setRegister"/> for formatting
15269	guidelines.
15270	</desc>
15271	</param>
15272	</method>
15273
15274	<method name="dumpGuestStack">
15275	<desc>
15276	Produce a simple stack dump using the current guest state.
15277
15278	This feature is not implemented in the 4.0.0 release but may show up
15279	in a dot release.
15280	</desc>
15281	<param name="cpuId" type="unsigned long" dir="in">
15282	<desc>The identifier of the Virtual CPU.</desc>
15283	</param>
15284	<param name="stack" type="wstring" dir="return">
15285	<desc>String containing the formatted stack dump.</desc>
15286	</param>
15287	</method>
15288
15289	<method name="resetStats">
15290	<desc>
15291	Reset VM statistics.
15292	</desc>
15293	<param name="pattern" type="wstring" dir="in">
15294	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15295	</param>
15296	</method>
15297
15298	<method name="dumpStats">
15299	<desc>
15300	Dumps VM statistics.
15301	</desc>
15302	<param name="pattern" type="wstring" dir="in">
15303	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15304	</param>
15305	</method>
15306
15307	<method name="getStats">
15308	<desc>
15309	Get the VM statistics in a XMLish format.
15310	</desc>
15311	<param name="pattern" type="wstring" dir="in">
15312	<desc>The selection pattern. A bit similar to filename globbing.</desc>
15313	</param>
15314	<param name="withDescriptions" type="boolean" dir="in">
15315	<desc>Whether to include the descriptions.</desc>
15316	</param>
15317	<param name="stats" type="wstring" dir="return">
15318	<desc>The XML document containing the statistics.</desc>
15319	</param>
15320	</method>
15321
15322	<attribute name="singleStep" type="boolean">
15323	<desc>Switch for enabling single-stepping.</desc>
15324	</attribute>
15325
15326	<attribute name="recompileUser" type="boolean">
15327	<desc>Switch for forcing code recompilation for user mode code.</desc>
15328	</attribute>
15329
15330	<attribute name="recompileSupervisor" type="boolean">
15331	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
15332	</attribute>
15333
15334	<attribute name="PATMEnabled" type="boolean">
15335	<desc>Switch for enabling and disabling the PATM component.</desc>
15336	</attribute>
15337
15338	<attribute name="CSAMEnabled" type="boolean">
15339	<desc>Switch for enabling and disabling the CSAM component.</desc>
15340	</attribute>
15341
15342	<attribute name="logEnabled" type="boolean">
15343	<desc>Switch for enabling and disabling the debug logger.</desc>
15344	</attribute>
15345
15346	<attribute name="logDbgFlags" type="wstring" readonly="yes">
15347	<desc>The debug logger flags.</desc>
15348	</attribute>
15349
15350	<attribute name="logDbgGroups" type="wstring" readonly="yes">
15351	<desc>The debug logger's group settings.</desc>
15352	</attribute>
15353
15354	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
15355	<desc>The debug logger's destination settings.</desc>
15356	</attribute>
15357
15358	<attribute name="logRelFlags" type="wstring" readonly="yes">
15359	<desc>The release logger flags.</desc>
15360	</attribute>
15361
15362	<attribute name="logRelGroups" type="wstring" readonly="yes">
15363	<desc>The release logger's group settings.</desc>
15364	</attribute>
15365
15366	<attribute name="logRelDestinations" type="wstring" readonly="yes">
15367	<desc>The relase logger's destination settings.</desc>
15368	</attribute>
15369
15370	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
15371	<desc>
15372	Flag indicating whether the VM is currently making use of CPU hardware
15373	virtualization extensions.
15374	</desc>
15375	</attribute>
15376
15377	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
15378	<desc>
15379	Flag indicating whether the VM is currently making use of the nested paging
15380	CPU hardware virtualization extension.
15381	</desc>
15382	</attribute>
15383
15384	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
15385	<desc>
15386	Flag indicating whether the VM is currently making use of the VPID
15387	VT-x extension.
15388	</desc>
15389	</attribute>
15390
15391	<attribute name="OSName" type="wstring" readonly="yes">
15392	<desc>
15393	Query the guest OS kernel name as detected by the DBGF.
15394
15395	This feature is not implemented in the 4.0.0 release but may show up
15396	in a dot release.
15397	</desc>
15398	</attribute>
15399
15400	<attribute name="OSVersion" type="wstring" readonly="yes">
15401	<desc>
15402	Query the guest OS kernel version string as detected by the DBGF.
15403
15404	This feature is not implemented in the 4.0.0 release but may show up
15405	in a dot release.
15406	</desc>
15407	</attribute>
15408
15409	<attribute name="PAEEnabled" type="boolean" readonly="yes">
15410	<desc>
15411	Flag indicating whether the VM is currently making use of the Physical
15412	Address Extension CPU feature.
15413	</desc>
15414	</attribute>
15415
15416	<attribute name="virtualTimeRate" type="unsigned long">
15417	<desc>
15418	The rate at which the virtual time runs expressed as a percentage.
15419	The accepted range is 2% to 20000%.
15420	</desc>
15421	</attribute>
15422
15423	<attribute name="VM" type="long long" readonly="yes" wsmap="suppress">
15424	<desc>
15425	Gets the user-mode VM handle, with a reference. Must be passed to
15426	VMR3ReleaseUVM when done. This is only for internal use while we carve
15427	the details of this interface.
15428	</desc>
15429	</attribute>
15430
15431	</interface>
15432
15433	<!--
15434	// IUSBController
15435	/////////////////////////////////////////////////////////////////////////
15436	-->
15437
15438	<interface
15439	name="IUSBController" extends="$unknown"
15440	uuid="01e6f13a-0580-452f-a40f-74e32a5e4921"
15441	wsmap="managed"
15442	>
15443	<attribute name="enabled" type="boolean">
15444	<desc>
15445	Flag whether the USB controller is present in the
15446	guest system. If disabled, the virtual guest hardware will
15447	not contain any USB controller. Can only be changed when
15448	the VM is powered off.
15449	</desc>
15450	</attribute>
15451
15452	<attribute name="enabledEHCI" type="boolean">
15453	<desc>
15454	Flag whether the USB EHCI controller is present in the
15455	guest system. If disabled, the virtual guest hardware will
15456	not contain a USB EHCI controller. Can only be changed when
15457	the VM is powered off.
15458	</desc>
15459	</attribute>
15460
15461	<attribute name="proxyAvailable" type="boolean" readonly="yes">
15462	<desc>
15463	Flag whether there is an USB proxy available.
15464	</desc>
15465	</attribute>
15466
15467	<attribute name="USBStandard" type="unsigned short" readonly="yes">
15468	<desc>
15469	USB standard version which the controller implements.
15470	This is a BCD which means that the major version is in the
15471	high byte and minor version is in the low byte.
15472	</desc>
15473	</attribute>
15474
15475	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
15476	<desc>
15477	List of USB device filters associated with the machine.
15478
15479	If the machine is currently running, these filters are activated
15480	every time a new (supported) USB device is attached to the host
15481	computer that was not ignored by global filters
15482	(<link to="IHost::USBDeviceFilters"/>).
15483
15484	These filters are also activated when the machine is powered up.
15485	They are run against a list of all currently available USB
15486	devices (in states
15487	<link to="USBDeviceState_Available"/>,
15488	<link to="USBDeviceState_Busy"/>,
15489	<link to="USBDeviceState_Held"/>) that were not previously
15490	ignored by global filters.
15491
15492	If at least one filter matches the USB device in question, this
15493	device is automatically captured (attached to) the virtual USB
15494	controller of this machine.
15495
15496	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
15497	</desc>
15498	</attribute>
15499
15500	<method name="createDeviceFilter">
15501	<desc>
15502	Creates a new USB device filter. All attributes except
15503	the filter name are set to empty (any match),
15504	<i>active</i> is @c false (the filter is not active).
15505
15506	The created filter can then be added to the list of filters using
15507	<link to="#insertDeviceFilter"/>.
15508
15509	<result name="VBOX_E_INVALID_VM_STATE">
15510	The virtual machine is not mutable.
15511	</result>
15512
15513	<see><link to="#deviceFilters"/></see>
15514	</desc>
15515	<param name="name" type="wstring" dir="in">
15516	<desc>
15517	Filter name. See <link to="IUSBDeviceFilter::name"/>
15518	for more info.
15519	</desc>
15520	</param>
15521	<param name="filter" type="IUSBDeviceFilter" dir="return">
15522	<desc>Created filter object.</desc>
15523	</param>
15524	</method>
15525
15526	<method name="insertDeviceFilter">
15527	<desc>
15528	Inserts the given USB device to the specified position
15529	in the list of filters.
15530
15531	Positions are numbered starting from <tt>0</tt>. If the specified
15532	position is equal to or greater than the number of elements in
15533	the list, the filter is added to the end of the collection.
15534
15535	<note>
15536	Duplicates are not allowed, so an attempt to insert a
15537	filter that is already in the collection, will return an
15538	error.
15539	</note>
15540
15541	<result name="VBOX_E_INVALID_VM_STATE">
15542	Virtual machine is not mutable.
15543	</result>
15544	<result name="E_INVALIDARG">
15545	USB device filter not created within this VirtualBox instance.
15546	</result>
15547	<result name="VBOX_E_INVALID_OBJECT_STATE">
15548	USB device filter already in list.
15549	</result>
15550
15551	<see><link to="#deviceFilters"/></see>
15552	</desc>
15553	<param name="position" type="unsigned long" dir="in">
15554	<desc>Position to insert the filter to.</desc>
15555	</param>
15556	<param name="filter" type="IUSBDeviceFilter" dir="in">
15557	<desc>USB device filter to insert.</desc>
15558	</param>
15559	</method>
15560
15561	<method name="removeDeviceFilter">
15562	<desc>
15563	Removes a USB device filter from the specified position in the
15564	list of filters.
15565
15566	Positions are numbered starting from <tt>0</tt>. Specifying a
15567	position equal to or greater than the number of elements in
15568	the list will produce an error.
15569
15570	<see><link to="#deviceFilters"/></see>
15571
15572	<result name="VBOX_E_INVALID_VM_STATE">
15573	Virtual machine is not mutable.
15574	</result>
15575	<result name="E_INVALIDARG">
15576	USB device filter list empty or invalid @a position.
15577	</result>
15578
15579	</desc>
15580	<param name="position" type="unsigned long" dir="in">
15581	<desc>Position to remove the filter from.</desc>
15582	</param>
15583	<param name="filter" type="IUSBDeviceFilter" dir="return">
15584	<desc>Removed USB device filter.</desc>
15585	</param>
15586	</method>
15587
15588	</interface>
15589
15590
15591	<!--
15592	// IUSBDevice
15593	/////////////////////////////////////////////////////////////////////////
15594	-->
15595
15596	<interface
15597	name="IUSBDevice" extends="$unknown"
15598	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
15599	wsmap="managed"
15600	>
15601	<desc>
15602	The IUSBDevice interface represents a virtual USB device attached to the
15603	virtual machine.
15604
15605	A collection of objects implementing this interface is stored in the
15606	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
15607	attached to a running virtual machine's USB controller.
15608	</desc>
15609
15610	<attribute name="id" type="uuid" mod="string" readonly="yes">
15611	<desc>
15612	Unique USB device ID. This ID is built from #vendorId,
15613	#productId, #revision and #serialNumber.
15614	</desc>
15615	</attribute>
15616
15617	<attribute name="vendorId" type="unsigned short" readonly="yes">
15618	<desc>Vendor ID.</desc>
15619	</attribute>
15620
15621	<attribute name="productId" type="unsigned short" readonly="yes">
15622	<desc>Product ID.</desc>
15623	</attribute>
15624
15625	<attribute name="revision" type="unsigned short" readonly="yes">
15626	<desc>
15627	Product revision number. This is a packed BCD represented as
15628	unsigned short. The high byte is the integer part and the low
15629	byte is the decimal.
15630	</desc>
15631	</attribute>
15632
15633	<attribute name="manufacturer" type="wstring" readonly="yes">
15634	<desc>Manufacturer string.</desc>
15635	</attribute>
15636
15637	<attribute name="product" type="wstring" readonly="yes">
15638	<desc>Product string.</desc>
15639	</attribute>
15640
15641	<attribute name="serialNumber" type="wstring" readonly="yes">
15642	<desc>Serial number string.</desc>
15643	</attribute>
15644
15645	<attribute name="address" type="wstring" readonly="yes">
15646	<desc>Host specific address of the device.</desc>
15647	</attribute>
15648
15649	<attribute name="port" type="unsigned short" readonly="yes">
15650	<desc>
15651	Host USB port number the device is physically
15652	connected to.
15653	</desc>
15654	</attribute>
15655
15656	<attribute name="version" type="unsigned short" readonly="yes">
15657	<desc>
15658	The major USB version of the device - 1 or 2.
15659	</desc>
15660	</attribute>
15661
15662	<attribute name="portVersion" type="unsigned short" readonly="yes">
15663	<desc>
15664	The major USB version of the host USB port the device is
15665	physically connected to - 1 or 2. For devices not connected to
15666	anything this will have the same value as the version attribute.
15667	</desc>
15668	</attribute>
15669
15670	<attribute name="remote" type="boolean" readonly="yes">
15671	<desc>
15672	Whether the device is physically connected to a remote VRDE
15673	client or to a local host machine.
15674	</desc>
15675	</attribute>
15676
15677	</interface>
15678
15679
15680	<!--
15681	// IUSBDeviceFilter
15682	/////////////////////////////////////////////////////////////////////////
15683	-->
15684
15685	<interface
15686	name="IUSBDeviceFilter" extends="$unknown"
15687	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
15688	wsmap="managed"
15689	>
15690	<desc>
15691	The IUSBDeviceFilter interface represents an USB device filter used
15692	to perform actions on a group of USB devices.
15693
15694	This type of filters is used by running virtual machines to
15695	automatically capture selected USB devices once they are physically
15696	attached to the host computer.
15697
15698	A USB device is matched to the given device filter if and only if all
15699	attributes of the device match the corresponding attributes of the
15700	filter (that is, attributes are joined together using the logical AND
15701	operation). On the other hand, all together, filters in the list of
15702	filters carry the semantics of the logical OR operation. So if it is
15703	desirable to create a match like "this vendor id OR this product id",
15704	one needs to create two filters and specify "any match" (see below)
15705	for unused attributes.
15706
15707	All filter attributes used for matching are strings. Each string
15708	is an expression representing a set of values of the corresponding
15709	device attribute, that will match the given filter. Currently, the
15710	following filtering expressions are supported:
15711
15712	<ul>
15713	<li><i>Interval filters</i>. Used to specify valid intervals for
15714	integer device attributes (Vendor ID, Product ID and Revision).
15715	The format of the string is:
15716
15717	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
15718
15719	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
15720	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
15721	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
15722	is omitted before a dash (<tt>-</tt>), the minimum possible integer
15723	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
15724	possible integer is assumed.
15725	</li>
15726	<li><i>Boolean filters</i>. Used to specify acceptable values for
15727	boolean device attributes. The format of the string is:
15728
15729	<tt>true\|false\|yes\|no\|0\|1</tt>
15730
15731	</li>
15732	<li><i>Exact match</i>. Used to specify a single value for the given
15733	device attribute. Any string that doesn't start with <tt>int:</tt>
15734	represents the exact match. String device attributes are compared to
15735	this string including case of symbols. Integer attributes are first
15736	converted to a string (see individual filter attributes) and then
15737	compared ignoring case.
15738
15739	</li>
15740	<li><i>Any match</i>. Any value of the corresponding device attribute
15741	will match the given filter. An empty or @c null string is
15742	used to construct this type of filtering expressions.
15743
15744	</li>
15745	</ul>
15746
15747	<note>
15748	On the Windows host platform, interval filters are not currently
15749	available. Also all string filter attributes
15750	(<link to="#manufacturer"/>, <link to="#product"/>,
15751	<link to="#serialNumber"/>) are ignored, so they behave as
15752	<i>any match</i> no matter what string expression is specified.
15753	</note>
15754
15755	<see><link to="IUSBController::deviceFilters"/>,
15756	<link to="IHostUSBDeviceFilter"/></see>
15757	</desc>
15758
15759	<attribute name="name" type="wstring">
15760	<desc>
15761	Visible name for this filter.
15762	This name is used to visually distinguish one filter from another,
15763	so it can neither be @c null nor an empty string.
15764	</desc>
15765	</attribute>
15766
15767	<attribute name="active" type="boolean">
15768	<desc>Whether this filter active or has been temporarily disabled.</desc>
15769	</attribute>
15770
15771	<attribute name="vendorId" type="wstring">
15772	<desc>
15773	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
15774	The string representation for the <i>exact matching</i>
15775	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
15776	(including leading zeroes).
15777	</desc>
15778	</attribute>
15779
15780	<attribute name="productId" type="wstring">
15781	<desc>
15782	<link to="IUSBDevice::productId">Product ID</link> filter.
15783	The string representation for the <i>exact matching</i>
15784	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
15785	(including leading zeroes).
15786	</desc>
15787	</attribute>
15788
15789	<attribute name="revision" type="wstring">
15790	<desc>
15791	<link to="IUSBDevice::productId">Product revision number</link>
15792	filter. The string representation for the <i>exact matching</i>
15793	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
15794	of the integer part of the revision, and <tt>F</tt> is the
15795	decimal digit of its fractional part (including leading and
15796	trailing zeros).
15797	Note that for interval filters, it's best to use the hexadecimal
15798	form, because the revision is stored as a 16 bit packed BCD value;
15799	so the expression <tt>int:0x0100-0x0199</tt> will match any
15800	revision from <tt>1.0</tt> to <tt>1.99</tt>.
15801	</desc>
15802	</attribute>
15803
15804	<attribute name="manufacturer" type="wstring">
15805	<desc>
15806	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
15807	</desc>
15808	</attribute>
15809
15810	<attribute name="product" type="wstring">
15811	<desc>
15812	<link to="IUSBDevice::product">Product</link> filter.
15813	</desc>
15814	</attribute>
15815
15816	<attribute name="serialNumber" type="wstring">
15817	<desc>
15818	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
15819	</desc>
15820	</attribute>
15821
15822	<attribute name="port" type="wstring">
15823	<desc>
15824	<link to="IUSBDevice::port">Host USB port</link> filter.
15825	</desc>
15826	</attribute>
15827
15828	<attribute name="remote" type="wstring">
15829	<desc>
15830	<link to="IUSBDevice::remote">Remote state</link> filter.
15831	<note>
15832	This filter makes sense only for machine USB filters,
15833	i.e. it is ignored by IHostUSBDeviceFilter objects.
15834	</note>
15835	</desc>
15836	</attribute>
15837
15838	<attribute name="maskedInterfaces" type="unsigned long">
15839	<desc>
15840	This is an advanced option for hiding one or more USB interfaces
15841	from the guest. The value is a bit mask where the bits that are set
15842	means the corresponding USB interface should be hidden, masked off
15843	if you like.
15844	This feature only works on Linux hosts.
15845	</desc>
15846	</attribute>
15847
15848	</interface>
15849
15850
15851	<!--
15852	// IHostUSBDevice
15853	/////////////////////////////////////////////////////////////////////////
15854	-->
15855
15856	<enum
15857	name="USBDeviceState"
15858	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
15859	>
15860	<desc>
15861	USB device state. This enumeration represents all possible states
15862	of the USB device physically attached to the host computer regarding
15863	its state on the host computer and availability to guest computers
15864	(all currently running virtual machines).
15865
15866	Once a supported USB device is attached to the host, global USB
15867	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
15868	either ignore the device, or put it to USBDeviceState_Held state, or do
15869	nothing. Unless the device is ignored by global filters, filters of all
15870	currently running guests (<link to="IUSBController::deviceFilters"/>) are
15871	activated that can put it to USBDeviceState_Captured state.
15872
15873	If the device was ignored by global filters, or didn't match
15874	any filters at all (including guest ones), it is handled by the host
15875	in a normal way. In this case, the device state is determined by
15876	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
15877	or USBDeviceState_Available, depending on the current device usage.
15878
15879	Besides auto-capturing based on filters, the device can be manually
15880	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
15881	state is USBDeviceState_Busy, USBDeviceState_Available or
15882	USBDeviceState_Held.
15883
15884	<note>
15885	Due to differences in USB stack implementations in Linux and Win32,
15886	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
15887	only to the Linux version of the product. This also means that (<link
15888	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
15889	device state is USBDeviceState_Held.
15890	</note>
15891
15892	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
15893	</desc>
15894
15895	<const name="NotSupported" value="0">
15896	<desc>
15897	Not supported by the VirtualBox server, not available to guests.
15898	</desc>
15899	</const>
15900	<const name="Unavailable" value="1">
15901	<desc>
15902	Being used by the host computer exclusively,
15903	not available to guests.
15904	</desc>
15905	</const>
15906	<const name="Busy" value="2">
15907	<desc>
15908	Being used by the host computer, potentially available to guests.
15909	</desc>
15910	</const>
15911	<const name="Available" value="3">
15912	<desc>
15913	Not used by the host computer, available to guests (the host computer
15914	can also start using the device at any time).
15915	</desc>
15916	</const>
15917	<const name="Held" value="4">
15918	<desc>
15919	Held by the VirtualBox server (ignored by the host computer),
15920	available to guests.
15921	</desc>
15922	</const>
15923	<const name="Captured" value="5">
15924	<desc>
15925	Captured by one of the guest computers, not available
15926	to anybody else.
15927	</desc>
15928	</const>
15929	</enum>
15930
15931	<interface
15932	name="IHostUSBDevice" extends="IUSBDevice"
15933	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
15934	wsmap="managed"
15935	>
15936	<desc>
15937	The IHostUSBDevice interface represents a physical USB device attached
15938	to the host computer.
15939
15940	Besides properties inherited from IUSBDevice, this interface adds the
15941	<link to="#state"/> property that holds the current state of the USB
15942	device.
15943
15944	<see><link to="IHost::USBDevices"/>,
15945	<link to="IHost::USBDeviceFilters"/></see>
15946	</desc>
15947
15948	<attribute name="state" type="USBDeviceState" readonly="yes">
15949	<desc>
15950	Current state of the device.
15951	</desc>
15952	</attribute>
15953
15954	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
15955
15956	</interface>
15957
15958
15959	<!--
15960	// IHostUSBDeviceFilter
15961	/////////////////////////////////////////////////////////////////////////
15962	-->
15963
15964	<enum
15965	name="USBDeviceFilterAction"
15966	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
15967	>
15968	<desc>
15969	Actions for host USB device filters.
15970	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
15971	</desc>
15972
15973	<const name="Null" value="0">
15974	<desc>Null value (never used by the API).</desc>
15975	</const>
15976	<const name="Ignore" value="1">
15977	<desc>Ignore the matched USB device.</desc>
15978	</const>
15979	<const name="Hold" value="2">
15980	<desc>Hold the matched USB device.</desc>
15981	</const>
15982	</enum>
15983
15984	<interface
15985	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
15986	uuid="4cc70246-d74a-400f-8222-3900489c0374"
15987	wsmap="managed"
15988	>
15989	<desc>
15990	The IHostUSBDeviceFilter interface represents a global filter for a
15991	physical USB device used by the host computer. Used indirectly in
15992	<link to="IHost::USBDeviceFilters"/>.
15993
15994	Using filters of this type, the host computer determines the initial
15995	state of the USB device after it is physically attached to the
15996	host's USB controller.
15997
15998	<note>
15999	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
16000	filters, because it makes sense only for
16001	<link to="IUSBController::deviceFilters">machine USB filters</link>.
16002	</note>
16003
16004	<see><link to="IHost::USBDeviceFilters"/></see>
16005	</desc>
16006
16007	<attribute name="action" type="USBDeviceFilterAction">
16008	<desc>
16009	Action performed by the host when an attached USB device
16010	matches this filter.
16011	</desc>
16012	</attribute>
16013
16014	</interface>
16015
16016	<!--
16017	// IAudioAdapter
16018	/////////////////////////////////////////////////////////////////////////
16019	-->
16020
16021	<enum
16022	name="AudioDriverType"
16023	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
16024	>
16025	<desc>
16026	Host audio driver type.
16027	</desc>
16028
16029	<const name="Null" value="0">
16030	<desc>Null value, also means "dummy audio driver".</desc>
16031	</const>
16032	<const name="WinMM" value="1">
16033	<desc>Windows multimedia (Windows hosts only).</desc>
16034	</const>
16035	<const name="OSS" value="2">
16036	<desc>Open Sound System (Linux hosts only).</desc>
16037	</const>
16038	<const name="ALSA" value="3">
16039	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
16040	</const>
16041	<const name="DirectSound" value="4">
16042	<desc>DirectSound (Windows hosts only).</desc>
16043	</const>
16044	<const name="CoreAudio" value="5">
16045	<desc>CoreAudio (Mac hosts only).</desc>
16046	</const>
16047	<const name="MMPM" value="6">
16048	<desc>Reserved for historical reasons.</desc>
16049	</const>
16050	<const name="Pulse" value="7">
16051	<desc>PulseAudio (Linux hosts only).</desc>
16052	</const>
16053	<const name="SolAudio" value="8">
16054	<desc>Solaris audio (Solaris hosts only).</desc>
16055	</const>
16056	</enum>
16057
16058	<enum
16059	name="AudioControllerType"
16060	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
16061	>
16062	<desc>
16063	Virtual audio controller type.
16064	</desc>
16065
16066	<const name="AC97" value="0"/>
16067	<const name="SB16" value="1"/>
16068	<const name="HDA" value="2"/>
16069	</enum>
16070
16071	<interface
16072	name="IAudioAdapter" extends="$unknown"
16073	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
16074	wsmap="managed"
16075	>
16076	<desc>
16077	The IAudioAdapter interface represents the virtual audio adapter of
16078	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
16079	</desc>
16080	<attribute name="enabled" type="boolean">
16081	<desc>
16082	Flag whether the audio adapter is present in the
16083	guest system. If disabled, the virtual guest hardware will
16084	not contain any audio adapter. Can only be changed when
16085	the VM is not running.
16086	</desc>
16087	</attribute>
16088	<attribute name="audioController" type="AudioControllerType">
16089	<desc>
16090	The audio hardware we emulate.
16091	</desc>
16092	</attribute>
16093	<attribute name="audioDriver" type="AudioDriverType">
16094	<desc>
16095	Audio driver the adapter is connected to. This setting
16096	can only be changed when the VM is not running.
16097	</desc>
16098	</attribute>
16099	</interface>
16100
16101	<enum
16102	name="AuthType"
16103	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
16104	>
16105	<desc>
16106	VirtualBox authentication type.
16107	</desc>
16108
16109	<const name="Null" value="0">
16110	<desc>Null value, also means "no authentication".</desc>
16111	</const>
16112	<const name="External" value="1"/>
16113	<const name="Guest" value="2"/>
16114	</enum>
16115
16116	<!--
16117	// IVRDEServer
16118	/////////////////////////////////////////////////////////////////////////
16119	-->
16120
16121	<interface
16122	name="IVRDEServer" extends="$unknown"
16123	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
16124	wsmap="managed"
16125	>
16126	<attribute name="enabled" type="boolean">
16127	<desc>VRDE server status.</desc>
16128	</attribute>
16129
16130	<attribute name="authType" type="AuthType">
16131	<desc>VRDE authentication method.</desc>
16132	</attribute>
16133
16134	<attribute name="authTimeout" type="unsigned long">
16135	<desc>Timeout for guest authentication. Milliseconds.</desc>
16136	</attribute>
16137
16138	<attribute name="allowMultiConnection" type="boolean">
16139	<desc>
16140	Flag whether multiple simultaneous connections to the VM are permitted.
16141	Note that this will be replaced by a more powerful mechanism in the future.
16142	</desc>
16143	</attribute>
16144
16145	<attribute name="reuseSingleConnection" type="boolean">
16146	<desc>
16147	Flag whether the existing connection must be dropped and a new connection
16148	must be established by the VRDE server, when a new client connects in single
16149	connection mode.
16150	</desc>
16151	</attribute>
16152
16153	<attribute name="VRDEExtPack" type="wstring">
16154	<desc>
16155	The name of Extension Pack providing VRDE for this VM. Overrides
16156	<link to="ISystemProperties::defaultVRDEExtPack"/>.
16157	</desc>
16158	</attribute>
16159
16160	<attribute name="authLibrary" type="wstring">
16161	<desc>
16162	Library used for authentication of RDP clients by this VM. Overrides
16163	<link to="ISystemProperties::VRDEAuthLibrary"/>.
16164	</desc>
16165	</attribute>
16166
16167	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
16168	<desc>
16169	Array of names of properties, which are supported by this VRDE server.
16170	</desc>
16171	</attribute>
16172
16173	<method name="setVRDEProperty">
16174	<desc>
16175	Sets a VRDE specific property string.
16176
16177	If you pass @c null or empty string as a key @a value, the given @a key
16178	will be deleted.
16179
16180	</desc>
16181	<param name="key" type="wstring" dir="in">
16182	<desc>Name of the key to set.</desc>
16183	</param>
16184	<param name="value" type="wstring" dir="in">
16185	<desc>Value to assign to the key.</desc>
16186	</param>
16187	</method>
16188
16189	<method name="getVRDEProperty" const="yes">
16190	<desc>
16191	Returns a VRDE specific property string.
16192
16193	If the requested data @a key does not exist, this function will
16194	succeed and return an empty string in the @a value argument.
16195
16196	</desc>
16197	<param name="key" type="wstring" dir="in">
16198	<desc>Name of the key to get.</desc>
16199	</param>
16200	<param name="value" type="wstring" dir="return">
16201	<desc>Value of the requested key.</desc>
16202	</param>
16203	</method>
16204
16205	</interface>
16206
16207
16208	<!--
16209	// ISharedFolder
16210	/////////////////////////////////////////////////////////////////////////
16211	-->
16212
16213	<interface
16214	name="ISharedFolder" extends="$unknown"
16215	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
16216	wsmap="struct"
16217	>
16218	<desc>
16219	The ISharedFolder interface represents a folder in the host computer's
16220	file system accessible from the guest OS running inside a virtual
16221	machine using an associated logical name.
16222
16223	There are three types of shared folders:
16224	<ul>
16225	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
16226	folders available to all virtual machines.</li>
16227	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
16228	VM-specific shared folders available to the given virtual machine at
16229	startup.</li>
16230	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
16231	VM-specific shared folders created in the session context (for
16232	example, when the virtual machine is running) and automatically
16233	discarded when the session is closed (the VM is powered off).</li>
16234	</ul>
16235
16236	Logical names of shared folders must be unique within the given scope
16237	(global, permanent or transient). However, they do not need to be unique
16238	across scopes. In this case, the definition of the shared folder in a
16239	more specific scope takes precedence over definitions in all other
16240	scopes. The order of precedence is (more specific to more general):
16241	<ol>
16242	<li>Transient definitions</li>
16243	<li>Permanent definitions</li>
16244	<li>Global definitions</li>
16245	</ol>
16246
16247	For example, if MyMachine has a shared folder named
16248	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
16249	transient shared folder named <tt>C_DRIVE</tt> (that points
16250	to <tt>C:\\\\WINDOWS</tt>) will change the definition
16251	of <tt>C_DRIVE</tt> in the guest OS so
16252	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
16253	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
16254	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
16255	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
16256	to <tt>C:\\</tt> if it still exists.
16257
16258	Note that permanent and transient shared folders of different machines
16259	are in different name spaces, so they don't overlap and don't need to
16260	have unique logical names.
16261
16262	<note>
16263	Global shared folders are not implemented in the current version of the
16264	product.
16265	</note>
16266	</desc>
16267
16268	<attribute name="name" type="wstring" readonly="yes">
16269	<desc>Logical name of the shared folder.</desc>
16270	</attribute>
16271
16272	<attribute name="hostPath" type="wstring" readonly="yes">
16273	<desc>Full path to the shared folder in the host file system.</desc>
16274	</attribute>
16275
16276	<attribute name="accessible" type="boolean" readonly="yes">
16277	<desc>
16278	Whether the folder defined by the host path is currently
16279	accessible or not.
16280	For example, the folder can be inaccessible if it is placed
16281	on the network share that is not available by the time
16282	this property is read.
16283	</desc>
16284	</attribute>
16285
16286	<attribute name="writable" type="boolean" readonly="yes">
16287	<desc>
16288	Whether the folder defined by the host path is writable or
16289	not.
16290	</desc>
16291	</attribute>
16292
16293	<attribute name="autoMount" type="boolean" readonly="yes">
16294	<desc>
16295	Whether the folder gets automatically mounted by the guest or not.
16296	</desc>
16297	</attribute>
16298
16299	<attribute name="lastAccessError" type="wstring" readonly="yes">
16300	<desc>
16301	Text message that represents the result of the last accessibility
16302	check.
16303
16304	Accessibility checks are performed each time the <link to="#accessible"/>
16305	attribute is read. An empty string is returned if the last
16306	accessibility check was successful. A non-empty string indicates a
16307	failure and should normally describe a reason of the failure (for
16308	example, a file read error).
16309	</desc>
16310	</attribute>
16311
16312	</interface>
16313
16314	<!--
16315	// ISession
16316	/////////////////////////////////////////////////////////////////////////
16317	-->
16318
16319	<interface
16320	name="IInternalSessionControl" extends="$unknown"
16321	uuid="3e83963a-1c3b-400d-8c5f-f2d077b0a597"
16322	internal="yes"
16323	wsmap="suppress"
16324	>
16325	<method name="getPID">
16326	<desc>PID of the process that has created this Session object.
16327	</desc>
16328	<param name="pid" type="unsigned long" dir="return"/>
16329	</method>
16330
16331	<method name="getRemoteConsole">
16332	<desc>
16333	Returns the console object suitable for remote control.
16334
16335	<result name="VBOX_E_INVALID_VM_STATE">
16336	Session state prevents operation.
16337	</result>
16338	<result name="VBOX_E_INVALID_OBJECT_STATE">
16339	Session type prevents operation.
16340	</result>
16341
16342	</desc>
16343	<param name="console" type="IConsole" dir="return"/>
16344	</method>
16345
16346	<method name="assignMachine">
16347	<desc>
16348	Assigns the machine object associated with this direct-type
16349	session or informs the session that it will be a remote one
16350	(if @a machine == @c null).
16351
16352	<result name="VBOX_E_INVALID_VM_STATE">
16353	Session state prevents operation.
16354	</result>
16355	<result name="VBOX_E_INVALID_OBJECT_STATE">
16356	Session type prevents operation.
16357	</result>
16358
16359	</desc>
16360	<param name="machine" type="IMachine" dir="in"/>
16361	<param name="lockType" type="LockType" dir="in"/>
16362	</method>
16363
16364	<method name="assignRemoteMachine">
16365	<desc>
16366	Assigns the machine and the (remote) console object associated with
16367	this remote-type session.
16368
16369	<result name="VBOX_E_INVALID_VM_STATE">
16370	Session state prevents operation.
16371	</result>
16372
16373	</desc>
16374	<param name="machine" type="IMachine" dir="in"/>
16375	<param name="console" type="IConsole" dir="in"/>
16376	</method>
16377
16378	<method name="updateMachineState">
16379	<desc>
16380	Updates the machine state in the VM process.
16381	Must be called only in certain cases
16382	(see the method implementation).
16383
16384	<result name="VBOX_E_INVALID_VM_STATE">
16385	Session state prevents operation.
16386	</result>
16387	<result name="VBOX_E_INVALID_OBJECT_STATE">
16388	Session type prevents operation.
16389	</result>
16390
16391	</desc>
16392	<param name="aMachineState" type="MachineState" dir="in"/>
16393	</method>
16394
16395	<method name="uninitialize">
16396	<desc>
16397	Uninitializes (closes) this session. Used by VirtualBox to close
16398	the corresponding remote session when the direct session dies
16399	or gets closed.
16400
16401	<result name="VBOX_E_INVALID_VM_STATE">
16402	Session state prevents operation.
16403	</result>
16404
16405	</desc>
16406	</method>
16407
16408	<method name="onNetworkAdapterChange">
16409	<desc>
16410	Triggered when settings of a network adapter of the
16411	associated virtual machine have changed.
16412
16413	<result name="VBOX_E_INVALID_VM_STATE">
16414	Session state prevents operation.
16415	</result>
16416	<result name="VBOX_E_INVALID_OBJECT_STATE">
16417	Session type prevents operation.
16418	</result>
16419
16420	</desc>
16421	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
16422	<param name="changeAdapter" type="boolean" dir="in"/>
16423	</method>
16424
16425	<method name="onSerialPortChange">
16426	<desc>
16427	Triggered when settings of a serial port of the
16428	associated virtual machine have changed.
16429
16430	<result name="VBOX_E_INVALID_VM_STATE">
16431	Session state prevents operation.
16432	</result>
16433	<result name="VBOX_E_INVALID_OBJECT_STATE">
16434	Session type prevents operation.
16435	</result>
16436
16437	</desc>
16438	<param name="serialPort" type="ISerialPort" dir="in"/>
16439	</method>
16440
16441	<method name="onParallelPortChange">
16442	<desc>
16443	Triggered when settings of a parallel port of the
16444	associated virtual machine have changed.
16445
16446	<result name="VBOX_E_INVALID_VM_STATE">
16447	Session state prevents operation.
16448	</result>
16449	<result name="VBOX_E_INVALID_OBJECT_STATE">
16450	Session type prevents operation.
16451	</result>
16452
16453	</desc>
16454	<param name="parallelPort" type="IParallelPort" dir="in"/>
16455	</method>
16456
16457	<method name="onStorageControllerChange">
16458	<desc>
16459	Triggered when settings of a storage controller of the
16460	associated virtual machine have changed.
16461
16462	<result name="VBOX_E_INVALID_VM_STATE">
16463	Session state prevents operation.
16464	</result>
16465	<result name="VBOX_E_INVALID_OBJECT_STATE">
16466	Session type prevents operation.
16467	</result>
16468
16469	</desc>
16470	</method>
16471
16472	<method name="onMediumChange">
16473	<desc>
16474	Triggered when attached media of the
16475	associated virtual machine have changed.
16476
16477	<result name="VBOX_E_INVALID_VM_STATE">
16478	Session state prevents operation.
16479	</result>
16480	<result name="VBOX_E_INVALID_OBJECT_STATE">
16481	Session type prevents operation.
16482	</result>
16483
16484	</desc>
16485
16486	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16487	<desc>The medium attachment which changed.</desc>
16488	</param>
16489	<param name="force" type="boolean" dir="in">
16490	<desc>If the medium change was forced.</desc>
16491	</param>
16492	</method>
16493
16494	<method name="onStorageDeviceChange">
16495	<desc>
16496	Triggered when attached storage devices of the
16497	associated virtual machine have changed.
16498
16499	<result name="VBOX_E_INVALID_VM_STATE">
16500	Session state prevents operation.
16501	</result>
16502	<result name="VBOX_E_INVALID_OBJECT_STATE">
16503	Session type prevents operation.
16504	</result>
16505
16506	</desc>
16507
16508	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16509	<desc>The medium attachment which changed.</desc>
16510	</param>
16511	<param name="remove" type="boolean" dir="in">
16512	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
16513	</param>
16514	</method>
16515
16516	<method name="onClipboardModeChange">
16517	<desc>
16518	Notification when the shared clipboard mode changes.
16519	</desc>
16520	<param name="clipboardMode" type="ClipboardMode" dir="in">
16521	<desc>The new shared clipboard mode.</desc>
16522	</param>
16523	</method>
16524
16525	<method name="onDragAndDropModeChange">
16526	<desc>
16527	Notification when the drag'n'drop mode changes.
16528	</desc>
16529	<param name="dragAndDropMode" type="DragAndDropMode" dir="in">
16530	<desc>The new mode for drag'n'drop.</desc>
16531	</param>
16532	</method>
16533
16534	<method name="onCPUChange">
16535	<desc>
16536	Notification when a CPU changes.
16537	</desc>
16538	<param name="cpu" type="unsigned long" dir="in">
16539	<desc>The CPU which changed</desc>
16540	</param>
16541	<param name="add" type="boolean" dir="in">
16542	<desc>Flag whether the CPU was added or removed</desc>
16543	</param>
16544	</method>
16545
16546	<method name="onCPUExecutionCapChange">
16547	<desc>
16548	Notification when the CPU execution cap changes.
16549	</desc>
16550	<param name="executionCap" type="unsigned long" dir="in">
16551	<desc>The new CPU execution cap value. (1-100)</desc>
16552	</param>
16553	</method>
16554
16555	<method name="onVRDEServerChange">
16556	<desc>
16557	Triggered when settings of the VRDE server object of the
16558	associated virtual machine have changed.
16559
16560	<result name="VBOX_E_INVALID_VM_STATE">
16561	Session state prevents operation.
16562	</result>
16563	<result name="VBOX_E_INVALID_OBJECT_STATE">
16564	Session type prevents operation.
16565	</result>
16566
16567	</desc>
16568	<param name="restart" type="boolean" dir="in">
16569	<desc>Flag whether the server must be restarted</desc>
16570	</param>
16571	</method>
16572
16573	<method name="onUSBControllerChange">
16574	<desc>
16575	Triggered when settings of the USB controller object of the
16576	associated virtual machine have changed.
16577
16578	<result name="VBOX_E_INVALID_VM_STATE">
16579	Session state prevents operation.
16580	</result>
16581	<result name="VBOX_E_INVALID_OBJECT_STATE">
16582	Session type prevents operation.
16583	</result>
16584
16585	</desc>
16586	</method>
16587
16588	<method name="onSharedFolderChange">
16589	<desc>
16590	Triggered when a permanent (global or machine) shared folder has been
16591	created or removed.
16592	<note>
16593	We don't pass shared folder parameters in this notification because
16594	the order in which parallel notifications are delivered is not defined,
16595	therefore it could happen that these parameters were outdated by the
16596	time of processing this notification.
16597	</note>
16598
16599	<result name="VBOX_E_INVALID_VM_STATE">
16600	Session state prevents operation.
16601	</result>
16602	<result name="VBOX_E_INVALID_OBJECT_STATE">
16603	Session type prevents operation.
16604	</result>
16605
16606	</desc>
16607	<param name="global" type="boolean" dir="in"/>
16608	</method>
16609
16610	<method name="onUSBDeviceAttach">
16611	<desc>
16612	Triggered when a request to capture a USB device (as a result
16613	of matched USB filters or direct call to
16614	<link to="IConsole::attachUSBDevice"/>) has completed.
16615	A @c null @a error object means success, otherwise it
16616	describes a failure.
16617
16618	<result name="VBOX_E_INVALID_VM_STATE">
16619	Session state prevents operation.
16620	</result>
16621	<result name="VBOX_E_INVALID_OBJECT_STATE">
16622	Session type prevents operation.
16623	</result>
16624
16625	</desc>
16626	<param name="device" type="IUSBDevice" dir="in"/>
16627	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16628	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
16629	</method>
16630
16631	<method name="onUSBDeviceDetach">
16632	<desc>
16633	Triggered when a request to release the USB device (as a result
16634	of machine termination or direct call to
16635	<link to="IConsole::detachUSBDevice"/>) has completed.
16636	A @c null @a error object means success, otherwise it
16637	describes a failure.
16638
16639	<result name="VBOX_E_INVALID_VM_STATE">
16640	Session state prevents operation.
16641	</result>
16642	<result name="VBOX_E_INVALID_OBJECT_STATE">
16643	Session type prevents operation.
16644	</result>
16645
16646	</desc>
16647	<param name="id" type="uuid" mod="string" dir="in"/>
16648	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
16649	</method>
16650
16651	<method name="onShowWindow">
16652	<desc>
16653	Called by <link to="IMachine::canShowConsoleWindow"/> and by
16654	<link to="IMachine::showConsoleWindow"/> in order to notify
16655	console listeners
16656	<link to="ICanShowWindowEvent"/>
16657	and <link to="IShowWindowEvent"/>.
16658
16659	<result name="VBOX_E_INVALID_OBJECT_STATE">
16660	Session type prevents operation.
16661	</result>
16662
16663	</desc>
16664	<param name="check" type="boolean" dir="in"/>
16665	<param name="canShow" type="boolean" dir="out"/>
16666	<param name="winId" type="long long" dir="out"/>
16667	</method>
16668
16669	<method name="onBandwidthGroupChange">
16670	<desc>
16671	Notification when one of the bandwidth groups change.
16672	</desc>
16673	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
16674	<desc>The bandwidth group which changed.</desc>
16675	</param>
16676	</method>
16677
16678	<method name="accessGuestProperty">
16679	<desc>
16680	Called by <link to="IMachine::getGuestProperty"/> and by
16681	<link to="IMachine::setGuestProperty"/> in order to read and
16682	modify guest properties.
16683
16684	<result name="VBOX_E_INVALID_VM_STATE">
16685	Machine session is not open.
16686	</result>
16687	<result name="VBOX_E_INVALID_OBJECT_STATE">
16688	Session type is not direct.
16689	</result>
16690
16691	</desc>
16692	<param name="name" type="wstring" dir="in"/>
16693	<param name="value" type="wstring" dir="in"/>
16694	<param name="flags" type="wstring" dir="in"/>
16695	<param name="isSetter" type="boolean" dir="in"/>
16696	<param name="retValue" type="wstring" dir="out"/>
16697	<param name="retTimestamp" type="long long" dir="out"/>
16698	<param name="retFlags" type="wstring" dir="out"/>
16699	</method>
16700
16701	<method name="enumerateGuestProperties" const="yes">
16702	<desc>
16703	Return a list of the guest properties matching a set of patterns along
16704	with their values, time stamps and flags.
16705
16706	<result name="VBOX_E_INVALID_VM_STATE">
16707	Machine session is not open.
16708	</result>
16709	<result name="VBOX_E_INVALID_OBJECT_STATE">
16710	Session type is not direct.
16711	</result>
16712
16713	</desc>
16714	<param name="patterns" type="wstring" dir="in">
16715	<desc>
16716	The patterns to match the properties against as a comma-separated
16717	string. If this is empty, all properties currently set will be
16718	returned.
16719	</desc>
16720	</param>
16721	<param name="key" type="wstring" dir="out" safearray="yes">
16722	<desc>
16723	The key names of the properties returned.
16724	</desc>
16725	</param>
16726	<param name="value" type="wstring" dir="out" safearray="yes">
16727	<desc>
16728	The values of the properties returned. The array entries match the
16729	corresponding entries in the @a key array.
16730	</desc>
16731	</param>
16732	<param name="timestamp" type="long long" dir="out" safearray="yes">
16733	<desc>
16734	The time stamps of the properties returned. The array entries match
16735	the corresponding entries in the @a key array.
16736	</desc>
16737	</param>
16738	<param name="flags" type="wstring" dir="out" safearray="yes">
16739	<desc>
16740	The flags of the properties returned. The array entries match the
16741	corresponding entries in the @a key array.
16742	</desc>
16743	</param>
16744	</method>
16745
16746	<method name="onlineMergeMedium">
16747	<desc>
16748	Triggers online merging of a hard disk. Used internally when deleting
16749	a snapshot while a VM referring to the same hard disk chain is running.
16750
16751	<result name="VBOX_E_INVALID_VM_STATE">
16752	Machine session is not open.
16753	</result>
16754	<result name="VBOX_E_INVALID_OBJECT_STATE">
16755	Session type is not direct.
16756	</result>
16757
16758	</desc>
16759	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
16760	<desc>The medium attachment to identify the medium chain.</desc>
16761	</param>
16762	<param name="sourceIdx" type="unsigned long" dir="in">
16763	<desc>The index of the source image in the chain.
16764	Redundant, but drastically reduces IPC.</desc>
16765	</param>
16766	<param name="targetIdx" type="unsigned long" dir="in">
16767	<desc>The index of the target image in the chain.
16768	Redundant, but drastically reduces IPC.</desc>
16769	</param>
16770	<param name="source" type="IMedium" dir="in">
16771	<desc>Merge source medium.</desc>
16772	</param>
16773	<param name="target" type="IMedium" dir="in">
16774	<desc>Merge target medium.</desc>
16775	</param>
16776	<param name="mergeForward" type="boolean" dir="in">
16777	<desc>Merge direction.</desc>
16778	</param>
16779	<param name="parentForTarget" type="IMedium" dir="in">
16780	<desc>For forward merges: new parent for target medium.</desc>
16781	</param>
16782	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
16783	<desc>For backward merges: list of media which need their parent UUID
16784	updated.</desc>
16785	</param>
16786	<param name="progress" type="IProgress" dir="in">
16787	<desc>
16788	Progress object for this operation.
16789	</desc>
16790	</param>
16791	</method>
16792
16793	<method name="enableVMMStatistics">
16794	<desc>
16795	Enables or disables collection of VMM RAM statistics.
16796
16797	<result name="VBOX_E_INVALID_VM_STATE">
16798	Machine session is not open.
16799	</result>
16800	<result name="VBOX_E_INVALID_OBJECT_STATE">
16801	Session type is not direct.
16802	</result>
16803
16804	</desc>
16805	<param name="enable" type="boolean" dir="in">
16806	<desc>True enables statistics collection.</desc>
16807	</param>
16808	</method>
16809
16810	</interface>
16811
16812	<interface
16813	name="ISession" extends="$unknown"
16814	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
16815	wsmap="managed"
16816	>
16817	<desc>
16818	The ISession interface represents a client process and allows for locking
16819	virtual machines (represented by IMachine objects) to prevent conflicting
16820	changes to the machine.
16821
16822	Any caller wishing to manipulate a virtual machine needs to create a session
16823	object first, which lives in its own process space. Such session objects are
16824	then associated with <link to="IMachine" /> objects living in the VirtualBox
16825	server process to coordinate such changes.
16826
16827	There are two typical scenarios in which sessions are used:
16828
16829	<ul>
16830	<li>To alter machine settings or control a running virtual machine, one
16831	needs to lock a machine for a given session (client process) by calling
16832	<link to="IMachine::lockMachine"/>.
16833
16834	Whereas multiple sessions may control a running virtual machine, only
16835	one process can obtain a write lock on the machine to prevent conflicting
16836	changes. A write lock is also needed if a process wants to actually run a
16837	virtual machine in its own context, such as the VirtualBox GUI or
16838	VBoxHeadless front-ends. They must also lock a machine for their own
16839	sessions before they are allowed to power up the virtual machine.
16840
16841	As a result, no machine settings can be altered while another process is
16842	already using it, either because that process is modifying machine settings
16843	or because the machine is running.
16844	</li>
16845	<li>
16846	To start a VM using one of the existing VirtualBox front-ends (e.g. the
16847	VirtualBox GUI or VBoxHeadless), one would use
16848	<link to="IMachine::launchVMProcess"/>, which also takes a session object
16849	as its first parameter. This session then identifies the caller and lets the
16850	caller control the started machine (for example, pause machine execution or
16851	power it down) as well as be notified about machine execution state changes.
16852	</li>
16853	</ul>
16854
16855	How sessions objects are created in a client process depends on whether you use
16856	the Main API via COM or via the webservice:
16857
16858	<ul>
16859	<li>When using the COM API directly, an object of the Session class from the
16860	VirtualBox type library needs to be created. In regular COM C++ client code,
16861	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
16862	This object will then act as a local session object in further calls to open
16863	a session.
16864	</li>
16865
16866	<li>In the webservice, the session manager (IWebsessionManager) instead creates
16867	a session object automatically whenever <link to="IWebsessionManager::logon" />
16868	is called. A managed object reference to that session object can be retrieved by
16869	calling <link to="IWebsessionManager::getSessionObject" />.
16870	</li>
16871	</ul>
16872	</desc>
16873
16874	<attribute name="state" type="SessionState" readonly="yes">
16875	<desc>Current state of this session.</desc>
16876	</attribute>
16877
16878	<attribute name="type" type="SessionType" readonly="yes">
16879	<desc>
16880	Type of this session. The value of this attribute is valid only
16881	if the session currently has a machine locked (i.e. its
16882	<link to="#state" /> is Locked), otherwise an error will be returned.
16883	</desc>
16884	</attribute>
16885
16886	<attribute name="machine" type="IMachine" readonly="yes">
16887	<desc>Machine object associated with this session.</desc>
16888	</attribute>
16889
16890	<attribute name="console" type="IConsole" readonly="yes">
16891	<desc>Console object associated with this session.</desc>
16892	</attribute>
16893
16894	<method name="unlockMachine">
16895	<desc>
16896	Unlocks a machine that was previously locked for the current session.
16897
16898	Calling this method is required every time a machine has been locked
16899	for a particular session using the <link to="IMachine::launchVMProcess" />
16900	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
16901	the machine will be set to <link to="MachineState_Aborted" /> on the
16902	server, and changes made to the machine settings will be lost.
16903
16904	Generally, it is recommended to unlock all machines explicitly
16905	before terminating the application (regardless of the reason for
16906	the termination).
16907
16908	<note>
16909	Do not expect the session state (<link to="ISession::state" />
16910	to return to "Unlocked" immediately after you invoke this method,
16911	particularly if you have started a new VM process. The session
16912	state will automatically return to "Unlocked" once the VM is no
16913	longer executing, which can of course take a very long time.
16914	</note>
16915
16916	<result name="E_UNEXPECTED">
16917	Session is not locked.
16918	</result>
16919
16920	</desc>
16921	</method>
16922
16923	</interface>
16924
16925	<!--
16926	// IStorageController
16927	/////////////////////////////////////////////////////////////////////////
16928	-->
16929
16930	<enum
16931	name="StorageBus"
16932	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
16933	>
16934	<desc>
16935	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
16936	see <link to="IStorageController::bus" />.
16937	</desc>
16938	<const name="Null" value="0">
16939	<desc>@c null value. Never used by the API.</desc>
16940	</const>
16941	<const name="IDE" value="1"/>
16942	<const name="SATA" value="2"/>
16943	<const name="SCSI" value="3"/>
16944	<const name="Floppy" value="4"/>
16945	<const name="SAS" value="5"/>
16946	</enum>
16947
16948	<enum
16949	name="StorageControllerType"
16950	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
16951	>
16952	<desc>
16953	The exact variant of storage controller hardware presented
16954	to the guest; see <link to="IStorageController::controllerType" />.
16955	</desc>
16956
16957	<const name="Null" value="0">
16958	<desc>@c null value. Never used by the API.</desc>
16959	</const>
16960	<const name="LsiLogic" value="1">
16961	<desc>A SCSI controller of the LsiLogic variant.</desc>
16962	</const>
16963	<const name="BusLogic" value="2">
16964	<desc>A SCSI controller of the BusLogic variant.</desc>
16965	</const>
16966	<const name="IntelAhci" value="3">
16967	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
16968	</const>
16969	<const name="PIIX3" value="4">
16970	<desc>An IDE controller of the PIIX3 variant.</desc>
16971	</const>
16972	<const name="PIIX4" value="5">
16973	<desc>An IDE controller of the PIIX4 variant.</desc>
16974	</const>
16975	<const name="ICH6" value="6">
16976	<desc>An IDE controller of the ICH6 variant.</desc>
16977	</const>
16978	<const name="I82078" value="7">
16979	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
16980	</const>
16981	<const name="LsiLogicSas" value="8">
16982	<desc>A variant of the LsiLogic controller using SAS.</desc>
16983	</const>
16984	</enum>
16985
16986	<enum
16987	name="ChipsetType"
16988	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
16989	>
16990	<desc>
16991	Type of emulated chipset (mostly southbridge).
16992	</desc>
16993
16994	<const name="Null" value="0">
16995	<desc>@c null value. Never used by the API.</desc>
16996	</const>
16997	<const name="PIIX3" value="1">
16998	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
16999	</const>
17000	<const name="ICH9" value="2">
17001	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
17002	</const>
17003	</enum>
17004
17005	<interface
17006	name="IStorageController" extends="$unknown"
17007	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
17008	wsmap="managed"
17009	>
17010	<desc>
17011	Represents a storage controller that is attached to a virtual machine
17012	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
17013	attached to storage controllers in a real computer, virtual drives
17014	(represented by <link to="IMediumAttachment" />) are attached to virtual
17015	storage controllers, represented by this interface.
17016
17017	As opposed to physical hardware, VirtualBox has a very generic concept
17018	of a storage controller, and for purposes of the Main API, all virtual
17019	storage is attached to virtual machines via instances of this interface.
17020	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
17021	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
17022	is used, certain sub-types may be available and can be selected in
17023	<link to="#controllerType" />.
17024
17025	Depending on these settings, the guest operating system might see
17026	significantly different virtual hardware.
17027	</desc>
17028
17029	<attribute name="name" type="wstring" readonly="yes">
17030	<desc>
17031	Name of the storage controller, as originally specified with
17032	<link to="IMachine::addStorageController" />. This then uniquely
17033	identifies this controller with other method calls such as
17034	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
17035	</desc>
17036	</attribute>
17037
17038	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
17039	<desc>
17040	Maximum number of devices which can be attached to one port.
17041	</desc>
17042	</attribute>
17043
17044	<attribute name="minPortCount" type="unsigned long" readonly="yes">
17045	<desc>
17046	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
17047	</desc>
17048	</attribute>
17049
17050	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
17051	<desc>
17052	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
17053	</desc>
17054	</attribute>
17055
17056	<attribute name="instance" type="unsigned long">
17057	<desc>
17058	The instance number of the device in the running VM.
17059	</desc>
17060	</attribute>
17061
17062	<attribute name="portCount" type="unsigned long">
17063	<desc>
17064	The number of currently usable ports on the controller.
17065	The minimum and maximum number of ports for one controller are
17066	stored in <link to="IStorageController::minPortCount"/>
17067	and <link to="IStorageController::maxPortCount"/>.
17068	</desc>
17069	</attribute>
17070
17071	<attribute name="bus" type="StorageBus" readonly="yes">
17072	<desc>
17073	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
17074	</desc>
17075	</attribute>
17076
17077	<attribute name="controllerType" type="StorageControllerType">
17078	<desc>
17079	The exact variant of storage controller hardware presented
17080	to the guest.
17081	Depending on this value, VirtualBox will provide a different
17082	virtual storage controller hardware to the guest.
17083	For SATA, SAS and floppy controllers, only one variant is
17084	available, but for IDE and SCSI, there are several.
17085
17086	For SCSI controllers, the default type is LsiLogic.
17087	</desc>
17088	</attribute>
17089
17090	<attribute name="useHostIOCache" type="boolean">
17091	<desc>
17092	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
17093	caches and use synchronous file APIs on the host. This was the only option in the API before
17094	VirtualBox 3.2 and is still the default for IDE controllers.
17095
17096	If false, the host I/O cache will be disabled for image files attached to this storage controller.
17097	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
17098	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
17099	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
17100	virtual machines are running at the same time to prevent I/O cache related hangs.
17101	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
17102	</desc>
17103	</attribute>
17104
17105	<attribute name="bootable" type="boolean" readonly="yes">
17106	<desc>
17107	Returns whether it is possible to boot from disks attached to this controller.
17108	</desc>
17109	</attribute>
17110	</interface>
17111
17112	<if target="wsdl">
17113
17114	<!--
17115	// IManagedObjectRef
17116	/////////////////////////////////////////////////////////////////////////
17117	-->
17118
17119	<interface
17120	name="IManagedObjectRef" extends="$unknown"
17121	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
17122	internal="yes"
17123	wsmap="managed"
17124	wscpp="hardcoded"
17125	>
17126	<desc>
17127	Managed object reference.
17128
17129	Only within the webservice, a managed object reference (which is really
17130	an opaque number) allows a webservice client to address an object
17131	that lives in the address space of the webservice server.
17132
17133	Behind each managed object reference, there is a COM object that lives
17134	in the webservice server's address space. The COM object is not freed
17135	until the managed object reference is released, either by an explicit
17136	call to <link to="IManagedObjectRef::release" /> or by logging off from
17137	the webservice (<link to="IWebsessionManager::logoff" />), which releases
17138	all objects created during the webservice session.
17139
17140	Whenever a method call of the VirtualBox API returns a COM object, the
17141	webservice representation of that method will instead return a
17142	managed object reference, which can then be used to invoke methods
17143	on that object.
17144	</desc>
17145
17146	<method name="getInterfaceName">
17147	<desc>
17148	Returns the name of the interface that this managed object represents,
17149	for example, "IMachine", as a string.
17150	</desc>
17151	<param name="return" type="wstring" dir="return"/>
17152	</method>
17153
17154	<method name="release">
17155	<desc>
17156	Releases this managed object reference and frees the resources that
17157	were allocated for it in the webservice server process. After calling
17158	this method, the identifier of the reference can no longer be used.
17159	</desc>
17160	</method>
17161
17162	</interface>
17163
17164	<!--
17165	// IWebsessionManager
17166	/////////////////////////////////////////////////////////////////////////
17167	-->
17168
17169	<interface
17170	name="IWebsessionManager" extends="$unknown"
17171	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
17172	internal="yes"
17173	wsmap="global"
17174	wscpp="hardcoded"
17175	>
17176	<desc>
17177	Websession manager. This provides essential services
17178	to webservice clients.
17179	</desc>
17180	<method name="logon">
17181	<desc>
17182	Logs a new client onto the webservice and returns a managed object reference to
17183	the IVirtualBox instance, which the client can then use as a basis to further
17184	queries, since all calls to the VirtualBox API are based on the IVirtualBox
17185	interface, in one way or the other.
17186	</desc>
17187	<param name="username" type="wstring" dir="in"/>
17188	<param name="password" type="wstring" dir="in"/>
17189	<param name="return" type="IVirtualBox" dir="return"/>
17190	</method>
17191
17192	<method name="getSessionObject">
17193	<desc>
17194	Returns a managed object reference to the internal ISession object that was created
17195	for this web service session when the client logged on.
17196
17197	<see><link to="ISession"/></see>
17198	</desc>
17199	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17200	<param name="return" type="ISession" dir="return"/>
17201	</method>
17202
17203	<method name="logoff">
17204	<desc>
17205	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
17206	and destroys all resources associated with the session (most importantly, all
17207	managed objects created in the server while the session was active).
17208	</desc>
17209	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
17210	</method>
17211
17212	</interface>
17213
17214	</if>
17215
17216	<!--
17217	// IPerformanceCollector & friends
17218	/////////////////////////////////////////////////////////////////////////
17219	-->
17220
17221	<interface
17222	name="IPerformanceMetric" extends="$unknown"
17223	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
17224	>
17225	<desc>
17226	The IPerformanceMetric interface represents parameters of the given
17227	performance metric.
17228	</desc>
17229
17230	<attribute name="metricName" type="wstring" readonly="yes">
17231	<desc>
17232	Name of the metric.
17233	</desc>
17234	</attribute>
17235
17236	<attribute name="object" type="$unknown" readonly="yes">
17237	<desc>
17238	Object this metric belongs to.
17239	</desc>
17240	</attribute>
17241
17242	<attribute name="description" type="wstring" readonly="yes">
17243	<desc>
17244	Textual description of the metric.
17245	</desc>
17246	</attribute>
17247
17248	<attribute name="period" type="unsigned long" readonly="yes">
17249	<desc>
17250	Time interval between samples, measured in seconds.
17251	</desc>
17252	</attribute>
17253
17254	<attribute name="count" type="unsigned long" readonly="yes">
17255	<desc>
17256	Number of recent samples retained by the performance collector for this
17257	metric.
17258
17259	When the collected sample count exceeds this number, older samples
17260	are discarded.
17261	</desc>
17262	</attribute>
17263
17264	<attribute name="unit" type="wstring" readonly="yes">
17265	<desc>
17266	Unit of measurement.
17267	</desc>
17268	</attribute>
17269
17270	<attribute name="minimumValue" type="long" readonly="yes">
17271	<desc>
17272	Minimum possible value of this metric.
17273	</desc>
17274	</attribute>
17275
17276	<attribute name="maximumValue" type="long" readonly="yes">
17277	<desc>
17278	Maximum possible value of this metric.
17279	</desc>
17280	</attribute>
17281	</interface>
17282
17283	<interface
17284	name="IPerformanceCollector" extends="$unknown"
17285	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
17286	wsmap="managed"
17287	>
17288	<desc>
17289	The IPerformanceCollector interface represents a service that collects
17290	and stores performance metrics data.
17291
17292	Performance metrics are associated with objects of interfaces like IHost
17293	and IMachine. Each object has a distinct set of performance metrics. The
17294	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
17295
17296	Metric data is collected at the specified intervals and is retained
17297	internally. The interval and the number of retained samples can be set
17298	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
17299	and collection settings are not persistent, they are discarded as soon as
17300	VBoxSVC process terminates. Moreover, metric settings and data associated
17301	with a particular VM only exist while VM is running. They disappear as
17302	soon as VM shuts down. It is not possible to set up metrics for machines
17303	that are powered off. One needs to start VM first, then set up metric
17304	collection parameters.
17305
17306	Metrics are organized hierarchically, with each level separated by a
17307	slash (/) character. Generally, the scheme for metric names is like this:
17308
17309	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
17310
17311	"Category/Metric" together form the base metric name. A base metric is
17312	the smallest unit for which a sampling interval and the number of
17313	retained samples can be set. Only base metrics can be enabled and
17314	disabled. All sub-metrics are collected when their base metric is
17315	collected. Collected values for any set of sub-metrics can be queried
17316	with <link to="IPerformanceCollector::queryMetricsData" />.
17317
17318	For example "CPU/Load/User:avg" metric name stands for the "CPU"
17319	category, "Load" metric, "User" submetric, "average" aggregate. An
17320	aggregate function is computed over all retained data. Valid aggregate
17321	functions are:
17322
17323	<ul>
17324	<li>avg -- average</li>
17325	<li>min -- minimum</li>
17326	<li>max -- maximum</li>
17327	</ul>
17328
17329	When setting up metric parameters, querying metric data, enabling or
17330	disabling metrics wildcards can be used in metric names to specify a
17331	subset of metrics. For example, to select all CPU-related metrics
17332	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
17333	so on. To query metric values without aggregates <tt>*:</tt> can be used.
17334
17335	The valid names for base metrics are:
17336
17337	<ul>
17338	<li>CPU/Load</li>
17339	<li>CPU/MHz</li>
17340	<li>RAM/Usage</li>
17341	<li>RAM/VMM</li>
17342	</ul>
17343
17344	The general sequence for collecting and retrieving the metrics is:
17345	<ul>
17346	<li>
17347	Obtain an instance of IPerformanceCollector with
17348	<link to="IVirtualBox::performanceCollector" />
17349	</li>
17350	<li>
17351	Allocate and populate an array with references to objects the metrics
17352	will be collected for. Use references to IHost and IMachine objects.
17353	</li>
17354	<li>
17355	Allocate and populate an array with base metric names the data will
17356	be collected for.
17357	</li>
17358	<li>
17359	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
17360	the metric data will be collected and stored.
17361	</li>
17362	<li>
17363	Wait for the data to get collected.
17364	</li>
17365	<li>
17366	Allocate and populate an array with references to objects the metric
17367	values will be queried for. You can re-use the object array used for
17368	setting base metrics.
17369	</li>
17370	<li>
17371	Allocate and populate an array with metric names the data will be
17372	collected for. Note that metric names differ from base metric names.
17373	</li>
17374	<li>
17375	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
17376	that have been collected so far are returned. Note that the values
17377	are still retained internally and data collection continues.
17378	</li>
17379	</ul>
17380
17381	For an example of usage refer to the following files in VirtualBox SDK:
17382	<ul>
17383	<li>
17384	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
17385	</li>
17386	<li>
17387	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
17388	</li>
17389	</ul>
17390	</desc>
17391
17392	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
17393	<desc>
17394	Array of unique names of metrics.
17395
17396	This array represents all metrics supported by the performance
17397	collector. Individual objects do not necessarily support all of them.
17398	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
17399	list of supported metrics for a particular object.
17400	</desc>
17401	</attribute>
17402
17403	<method name="getMetrics">
17404	<desc>
17405	Returns parameters of specified metrics for a set of objects.
17406	<note>
17407	@c Null metrics array means all metrics. @c Null object array means
17408	all existing objects.
17409	</note>
17410	</desc>
17411	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17412	<desc>
17413	Metric name filter. Currently, only a comma-separated list of metrics
17414	is supported.
17415	</desc>
17416	</param>
17417	<param name="objects" type="$unknown" dir="in" safearray="yes">
17418	<desc>
17419	Set of objects to return metric parameters for.
17420	</desc>
17421	</param>
17422	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
17423	<desc>
17424	Array of returned metric parameters.
17425	</desc>
17426	</param>
17427	</method>
17428
17429	<method name="setupMetrics">
17430	<desc>
17431	Sets parameters of specified base metrics for a set of objects. Returns
17432	an array of <link to="IPerformanceMetric" /> describing the metrics
17433	have been affected.
17434	<note>
17435	@c Null or empty metric name array means all metrics. @c Null or
17436	empty object array means all existing objects. If metric name array
17437	contains a single element and object array contains many, the single
17438	metric name array element is applied to each object array element to
17439	form metric/object pairs.
17440	</note>
17441	</desc>
17442	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17443	<desc>
17444	Metric name filter. Comma-separated list of metrics with wildcard
17445	support.
17446	</desc>
17447	</param>
17448	<param name="objects" type="$unknown" dir="in" safearray="yes">
17449	<desc>
17450	Set of objects to setup metric parameters for.
17451	</desc>
17452	</param>
17453	<param name="period" type="unsigned long" dir="in">
17454	<desc>
17455	Time interval in seconds between two consecutive samples of
17456	performance data.
17457	</desc>
17458	</param>
17459	<param name="count" type="unsigned long" dir="in">
17460	<desc>
17461	Number of samples to retain in performance data history. Older
17462	samples get discarded.
17463	</desc>
17464	</param>
17465	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17466	<desc>
17467	Array of metrics that have been modified by the call to this method.
17468	</desc>
17469	</param>
17470	</method>
17471
17472	<method name="enableMetrics">
17473	<desc>
17474	Turns on collecting specified base metrics. Returns an array of
17475	<link to="IPerformanceMetric" /> describing the metrics have been
17476	affected.
17477	<note>
17478	@c Null or empty metric name array means all metrics. @c Null or
17479	empty object array means all existing objects. If metric name array
17480	contains a single element and object array contains many, the single
17481	metric name array element is applied to each object array element to
17482	form metric/object pairs.
17483	</note>
17484	</desc>
17485	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17486	<desc>
17487	Metric name filter. Comma-separated list of metrics with wildcard
17488	support.
17489	</desc>
17490	</param>
17491	<param name="objects" type="$unknown" dir="in" safearray="yes">
17492	<desc>
17493	Set of objects to enable metrics for.
17494	</desc>
17495	</param>
17496	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17497	<desc>
17498	Array of metrics that have been modified by the call to this method.
17499	</desc>
17500	</param>
17501	</method>
17502
17503	<method name="disableMetrics">
17504	<desc>
17505	Turns off collecting specified base metrics. Returns an array of
17506	<link to="IPerformanceMetric" /> describing the metrics have been
17507	affected.
17508	<note>
17509	@c Null or empty metric name array means all metrics. @c Null or
17510	empty object array means all existing objects. If metric name array
17511	contains a single element and object array contains many, the single
17512	metric name array element is applied to each object array element to
17513	form metric/object pairs.
17514	</note>
17515	</desc>
17516	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17517	<desc>
17518	Metric name filter. Comma-separated list of metrics with wildcard
17519	support.
17520	</desc>
17521	</param>
17522	<param name="objects" type="$unknown" dir="in" safearray="yes">
17523	<desc>
17524	Set of objects to disable metrics for.
17525	</desc>
17526	</param>
17527	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
17528	<desc>
17529	Array of metrics that have been modified by the call to this method.
17530	</desc>
17531	</param>
17532	</method>
17533
17534	<method name="queryMetricsData">
17535	<desc>
17536	Queries collected metrics data for a set of objects.
17537
17538	The data itself and related metric information are returned in seven
17539	parallel and one flattened array of arrays. Elements of
17540	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
17541	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
17542	the same index describe one set of values corresponding to a single
17543	metric.
17544
17545	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
17546	start and length of a sub-array is indicated by
17547	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
17548	value for metric <tt>metricNames[i]</tt> is at
17549	<tt>returnData[returnIndices[i]]</tt>.
17550
17551	<note>
17552	@c Null or empty metric name array means all metrics. @c Null or
17553	empty object array means all existing objects. If metric name array
17554	contains a single element and object array contains many, the single
17555	metric name array element is applied to each object array element to
17556	form metric/object pairs.
17557	</note>
17558	<note>
17559	Data collection continues behind the scenes after call to @c
17560	queryMetricsData. The return data can be seen as the snapshot of the
17561	current state at the time of @c queryMetricsData call. The internally
17562	kept metric values are not cleared by the call. This makes possible
17563	querying different subsets of metrics or aggregates with subsequent
17564	calls. If periodic querying is needed it is highly suggested to query
17565	the values with @c interval*count period to avoid confusion. This way
17566	a completely new set of data values will be provided by each query.
17567	</note>
17568	</desc>
17569	<param name="metricNames" type="wstring" dir="in" safearray="yes">
17570	<desc>
17571	Metric name filter. Comma-separated list of metrics with wildcard
17572	support.
17573	</desc>
17574	</param>
17575	<param name="objects" type="$unknown" dir="in" safearray="yes">
17576	<desc>
17577	Set of objects to query metrics for.
17578	</desc>
17579	</param>
17580	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
17581	<desc>
17582	Names of metrics returned in @c returnData.
17583	</desc>
17584	</param>
17585	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
17586	<desc>
17587	Objects associated with metrics returned in @c returnData.
17588	</desc>
17589	</param>
17590	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
17591	<desc>
17592	Units of measurement for each returned metric.
17593	</desc>
17594	</param>
17595	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
17596	<desc>
17597	Divisor that should be applied to return values in order to get
17598	floating point values. For example:
17599	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
17600	will retrieve the floating point value of i-th sample of the first
17601	metric.
17602	</desc>
17603	</param>
17604	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
17605	<desc>
17606	Sequence numbers of the first elements of value sequences of
17607	particular metrics returned in @c returnData. For aggregate metrics
17608	it is the sequence number of the sample the aggregate started
17609	calculation from.
17610	</desc>
17611	</param>
17612	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
17613	<desc>
17614	Indices of the first elements of value sequences of particular
17615	metrics returned in @c returnData.
17616	</desc>
17617	</param>
17618	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
17619	<desc>
17620	Lengths of value sequences of particular metrics.
17621	</desc>
17622	</param>
17623	<param name="returnData" type="long" dir="return" safearray="yes">
17624	<desc>
17625	Flattened array of all metric data containing sequences of values for
17626	each metric.
17627	</desc>
17628	</param>
17629	</method>
17630
17631	</interface>
17632
17633	<enum
17634	name="NATAliasMode"
17635	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
17636	>
17637	<desc></desc>
17638	<const name="AliasLog" value="0x1">
17639	<desc></desc>
17640	</const>
17641	<const name="AliasProxyOnly" value="0x02">
17642	<desc></desc>
17643	</const>
17644	<const name="AliasUseSamePorts" value="0x04">
17645	<desc></desc>
17646	</const>
17647	</enum>
17648
17649	<enum
17650	name="NATProtocol"
17651	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
17652	>
17653	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
17654	<const name="UDP" value="0">
17655	<desc>Port-forwarding uses UDP protocol.</desc>
17656	</const>
17657	<const name="TCP" value="1">
17658	<desc>Port-forwarding uses TCP protocol.</desc>
17659	</const>
17660	</enum>
17661
17662	<interface
17663	name="INATEngine" extends="$unknown"
17664	uuid="26451b99-3b2d-4dcb-8e4b-d63654218175"
17665	wsmap="managed"
17666	>
17667	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
17668	allows for changing NAT behavior such as port-forwarding rules. This interface is
17669	used in the <link to="INetworkAdapter::NATEngine" /> attribute.</desc>
17670	<attribute name="network" type="wstring">
17671	<desc>The network attribute of the NAT engine (the same value is used with built-in
17672	DHCP server to fill corresponding fields of DHCP leases).</desc>
17673	</attribute>
17674	<attribute name="hostIP" type="wstring">
17675	<desc>IP of host interface to bind all opened sockets to.
17676	<note>Changing this does not change binding of port forwarding.</note>
17677	</desc>
17678	</attribute>
17679	<attribute name="TFTPPrefix" type="wstring">
17680	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
17681	the corresponding fields of DHCP leases.</desc>
17682	</attribute>
17683	<attribute name="TFTPBootFile" type="wstring">
17684	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
17685	the corresponding fields of DHCP leases.</desc>
17686	</attribute>
17687	<attribute name="TFTPNextServer" type="wstring">
17688	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
17689	the corresponding fields of DHCP leases.
17690	<note>The preferred form is IPv4 addresses.</note>
17691	</desc>
17692	</attribute>
17693	<attribute name="aliasMode" type="unsigned long">
17694	<desc></desc>
17695	</attribute>
17696	<attribute name="DNSPassDomain" type="boolean">
17697	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
17698	</attribute>
17699	<attribute name="DNSProxy" type="boolean">
17700	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
17701	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
17702	</attribute>
17703	<attribute name="DNSUseHostResolver" type="boolean">
17704	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
17705	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
17706	</attribute>
17707	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
17708	<desc>Array of NAT port-forwarding rules in string representation, in the following
17709	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
17710	</attribute>
17711	<method name="setNetworkSettings">
17712	<desc>Sets network configuration of the NAT engine.</desc>
17713	<param name="mtu" type="unsigned long" dir="in">
17714	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
17715	</param>
17716	<param name="sockSnd" type="unsigned long" dir="in">
17717	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
17718	</param>
17719	<param name="sockRcv" type="unsigned long" dir="in">
17720	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
17721	</param>
17722	<param name="TcpWndSnd" type="unsigned long" dir="in">
17723	<desc>Initial size of the NAT engine's sending TCP window in bytes when
17724	establishing a new TCP connection.</desc>
17725	</param>
17726	<param name="TcpWndRcv" type="unsigned long" dir="in">
17727	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
17728	establishing a new TCP connection.</desc>
17729	</param>
17730	</method>
17731	<method name="getNetworkSettings">
17732	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
17733	for parameter descriptions.</desc>
17734	<param name="mtu" type="unsigned long" dir="out" />
17735	<param name="sockSnd" type="unsigned long" dir="out" />
17736	<param name="sockRcv" type="unsigned long" dir="out" />
17737	<param name="TcpWndSnd" type="unsigned long" dir="out" />
17738	<param name="TcpWndRcv" type="unsigned long" dir="out" />
17739	</method>
17740	<method name="addRedirect">
17741	<desc>Adds a new NAT port-forwarding rule.</desc>
17742	<param name="name" type="wstring" dir="in">
17743	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
17744	auto-generates one using the other parameters.</desc>
17745	</param>
17746	<param name="proto" type="NATProtocol" dir="in">
17747	<desc>Protocol handled with the rule.</desc>
17748	</param>
17749	<param name="hostIP" type="wstring" dir="in">
17750	<desc>IP of the host interface to which the rule should apply. An empty ip address is
17751	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
17752	</param>
17753	<param name="hostPort" type="unsigned short" dir="in">
17754	<desc>The port number to listen on.</desc>
17755	</param>
17756	<param name="guestIP" type="wstring" dir="in">
17757	<desc>The IP address of the guest which the NAT engine will forward matching packets
17758	to. An empty IP address is acceptable, in which case the NAT engine will forward
17759	packets to the first DHCP lease (x.x.x.15).</desc>
17760	</param>
17761	<param name="guestPort" type="unsigned short" dir="in">
17762	<desc>The port number to forward.</desc>
17763	</param>
17764	</method>
17765	<method name="removeRedirect">
17766	<desc>Removes a port-forwarding rule that was previously registered.</desc>
17767	<param name="name" type="wstring" dir="in">
17768	<desc>The name of the rule to delete.</desc>
17769	</param>
17770	</method>
17771	</interface>
17772
17773	<!--
17774	// IExtPackManager
17775	/////////////////////////////////////////////////////////////////////////
17776	-->
17777
17778	<interface
17779	name="IExtPackPlugIn" extends="$unknown"
17780	uuid="58000040-e718-4746-bbce-4b86d96da461"
17781	wsmap="suppress"
17782	>
17783	<desc>
17784	Interface for keeping information about a plug-in that ships with an
17785	extension pack.
17786	</desc>
17787	<attribute name="name" type="wstring" readonly="yes">
17788	<desc>The plug-in name.</desc>
17789	</attribute>
17790	<attribute name="description" type="wstring" readonly="yes">
17791	<desc>The plug-in description.</desc>
17792	</attribute>
17793	<attribute name="frontend" type="wstring" readonly="yes">
17794	<desc>
17795	The name of the frontend or component name this plug-in plugs into.
17796	</desc>
17797	</attribute>
17798	<attribute name="modulePath" type="wstring" readonly="yes">
17799	<desc> The module path. </desc>
17800	</attribute>
17801	</interface>
17802
17803	<interface
17804	name="IExtPackBase" extends="$unknown"
17805	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
17806	wsmap="suppress"
17807	>
17808	<desc>
17809	Interface for querying information about an extension pack as well as
17810	accessing COM objects within it.
17811	</desc>
17812	<attribute name="name" type="wstring" readonly="yes">
17813	<desc>The extension pack name. This is unique.</desc>
17814	</attribute>
17815	<attribute name="description" type="wstring" readonly="yes">
17816	<desc>The extension pack description.</desc>
17817	</attribute>
17818	<attribute name="version" type="wstring" readonly="yes">
17819	<desc>
17820	The extension pack version string. This is restricted to the dotted
17821	version number and optionally a build indicator. No tree revision or
17822	tag will be included in the string as those things are available as
17823	separate properties. An optional publisher tag may be present like for
17824	<link to="IVirtualBox::version"/>.
17825
17826	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
17827	</desc>
17828	</attribute>
17829	<attribute name="revision" type="unsigned long" readonly="yes">
17830	<desc>The extension pack internal revision number.</desc>
17831	</attribute>
17832	<attribute name="edition" type="wstring" readonly="yes">
17833	<desc>
17834	Edition indicator. This is usually empty.
17835
17836	Can for instance be used to help distinguishing between two editions
17837	of the same extension pack where only the license, service contract or
17838	something differs.
17839	</desc>
17840	</attribute>
17841	<attribute name="VRDEModule" type="wstring" readonly="yes">
17842	<desc>The name of the VRDE module if the extension pack sports one.</desc>
17843	</attribute>
17844	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
17845	<desc>Plug-ins provided by this extension pack.</desc>
17846	</attribute>
17847	<attribute name="usable" type="boolean" readonly="yes">
17848	<desc>
17849	Indicates whether the extension pack is usable or not.
17850
17851	There are a number of reasons why an extension pack might be unusable,
17852	typical examples would be broken installation/file or that it is
17853	incompatible with the current VirtualBox version.
17854	</desc>
17855	</attribute>
17856	<attribute name="whyUnusable" type="wstring" readonly="yes">
17857	<desc>
17858	String indicating why the extension pack is not usable. This is an
17859	empty string if usable and always a non-empty string if not usable.
17860	</desc>
17861	</attribute>
17862	<attribute name="showLicense" type="boolean" readonly="yes">
17863	<desc>Whether to show the license before installation</desc>
17864	</attribute>
17865	<attribute name="license" type="wstring" readonly="yes">
17866	<desc>
17867	The default HTML license text for the extension pack. Same as
17868	calling <link to="#queryLicense">queryLicense</link> with
17869	preferredLocale and preferredLanguage as empty strings and format set
17870	to html.
17871	</desc>
17872	</attribute>
17873
17874	<method name="queryLicense">
17875	<desc>
17876	Full feature version of the license attribute.
17877	</desc>
17878	<param name="preferredLocale" type="wstring" dir="in">
17879	<desc>
17880	The preferred license locale. Pass an empty string to get the default
17881	license.
17882	</desc>
17883	</param>
17884	<param name="preferredLanguage" type="wstring" dir="in">
17885	<desc>
17886	The preferred license language. Pass an empty string to get the
17887	default language for the locale.
17888	</desc>
17889	</param>
17890	<param name="format" type="wstring" dir="in">
17891	<desc>
17892	The license format: html, rtf or txt. If a license is present there
17893	will always be an HTML of it, the rich text format (RTF) and plain
17894	text (txt) versions are optional. If
17895	</desc>
17896	</param>
17897	<param name="licenseText" type="wstring" dir="return">
17898	<desc>The license text.</desc>
17899	</param>
17900	</method>
17901
17902	</interface>
17903
17904	<interface
17905	name="IExtPack" extends="IExtPackBase"
17906	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
17907	wsmap="suppress"
17908	>
17909	<desc>
17910	Interface for querying information about an extension pack as well as
17911	accessing COM objects within it.
17912	</desc>
17913	<method name="queryObject">
17914	<desc>
17915	Queries the IUnknown interface to an object in the extension pack
17916	main module. This allows plug-ins and others to talk directly to an
17917	extension pack.
17918	</desc>
17919	<param name="objUuid" type="wstring" dir="in">
17920	<desc>The object ID. What exactly this is </desc>
17921	</param>
17922	<param name="returnInterface" type="$unknown" dir="return">
17923	<desc>The queried interface.</desc>
17924	</param>
17925	</method>
17926	</interface>
17927
17928	<interface
17929	name="IExtPackFile" extends="IExtPackBase"
17930	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
17931	wsmap="suppress"
17932	>
17933	<desc>
17934	Extension pack file (aka tarball, .vbox-extpack) representation returned
17935	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
17936	extension pack information with the addition of the file name.
17937	</desc>
17938	<attribute name="filePath" type="wstring" readonly="yes">
17939	<desc>
17940	The path to the extension pack file.
17941	</desc>
17942	</attribute>
17943
17944	<method name="install">
17945	<desc>
17946	Install the extension pack.
17947	</desc>
17948	<param name="replace" type="boolean" dir="in">
17949	<desc>
17950	Set this to automatically uninstall any existing extension pack with
17951	the same name as the one being installed.
17952	</desc>
17953	</param>
17954	<param name="displayInfo" type="wstring" dir="in">
17955	<desc>
17956	Platform specific display information. Reserved for future hacks.
17957	</desc>
17958	</param>
17959	<param name="progess" type="IProgress" dir="return">
17960	<desc>
17961	Progress object for the operation.
17962	</desc>
17963	</param>
17964	</method>
17965	</interface>
17966
17967	<interface
17968	name="IExtPackManager" extends="$unknown"
17969	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
17970	wsmap="suppress"
17971	>
17972	<desc>
17973	Interface for managing VirtualBox Extension Packs.
17974
17975	TODO: Describe extension packs, how they are managed and how to create
17976	one.
17977	</desc>
17978
17979	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
17980	<desc>
17981	List of the installed extension packs.
17982	</desc>
17983	</attribute>
17984
17985	<method name="find">
17986	<desc>
17987	Returns the extension pack with the specified name if found.
17988
17989	<result name="VBOX_E_OBJECT_NOT_FOUND">
17990	No extension pack matching @a name was found.
17991	</result>
17992	</desc>
17993	<param name="name" type="wstring" dir="in">
17994	<desc>The name of the extension pack to locate.</desc>
17995	</param>
17996	<param name="returnData" type="IExtPack" dir="return">
17997	<desc>The extension pack if found.</desc>
17998	</param>
17999	</method>
18000
18001	<method name="openExtPackFile">
18002	<desc>
18003	Attempts to open an extension pack file in preparation for
18004	installation.
18005	</desc>
18006	<param name="path" type="wstring" dir="in">
18007	<desc>The path of the extension pack tarball. This can optionally be
18008	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
18009	</param>
18010	<param name="file" type="IExtPackFile" dir="return">
18011	<desc>The interface of the extension pack file object.</desc>
18012	</param>
18013	</method>
18014
18015	<method name="uninstall">
18016	<desc>Uninstalls an extension pack, removing all related files.</desc>
18017	<param name="name" type="wstring" dir="in">
18018	<desc>The name of the extension pack to uninstall.</desc>
18019	</param>
18020	<param name="forcedRemoval" type="boolean" dir="in">
18021	<desc>
18022	Forced removal of the extension pack. This means that the uninstall
18023	hook will not be called.
18024	</desc>
18025	</param>
18026	<param name="displayInfo" type="wstring" dir="in">
18027	<desc>
18028	Platform specific display information. Reserved for future hacks.
18029	</desc>
18030	</param>
18031	<param name="progess" type="IProgress" dir="return">
18032	<desc>
18033	Progress object for the operation.
18034	</desc>
18035	</param>
18036	</method>
18037
18038	<method name="cleanup">
18039	<desc>Cleans up failed installs and uninstalls</desc>
18040	</method>
18041
18042	<method name="queryAllPlugInsForFrontend">
18043	<desc>
18044	Gets the path to all the plug-in modules for a given frontend.
18045
18046	This is a convenience method that is intended to simplify the plug-in
18047	loading process for a frontend.
18048	</desc>
18049	<param name="frontendName" type="wstring" dir="in">
18050	<desc>The name of the frontend or component.</desc>
18051	</param>
18052	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
18053	<desc>Array containing the plug-in modules (full paths).</desc>
18054	</param>
18055	</method>
18056
18057	<method name="isExtPackUsable">
18058	<desc>Check if the given extension pack is loaded and usable.</desc>
18059	<param name="name" type="wstring" dir="in">
18060	<desc>The name of the extension pack to check for.</desc>
18061	</param>
18062	<param name="usable" type="boolean" dir="return">
18063	<desc>Is the given extension pack loaded and usable.</desc>
18064	</param>
18065	</method>
18066
18067	</interface>
18068
18069	<!--
18070	// BandwidthGroupType
18071	/////////////////////////////////////////////////////////////////////////
18072	-->
18073	<enum
18074	name="BandwidthGroupType"
18075	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
18076
18077	<desc>
18078	Type of a bandwidth control group.
18079	</desc>
18080
18081	<const name="Null" value="0">
18082	<desc>
18083	Null type, must be first.
18084	</desc>
18085	</const>
18086
18087	<const name="Disk" value="1">
18088	<desc>
18089	The bandwidth group controls disk I/O.
18090	</desc>
18091	</const>
18092
18093	<const name="Network" value="2">
18094	<desc>
18095	The bandwidth group controls network I/O.
18096	</desc>
18097	</const>
18098
18099	</enum>
18100
18101	<!--
18102	// IBandwidthGroup
18103	/////////////////////////////////////////////////////////////////////////
18104	-->
18105	<interface
18106	name="IBandwidthGroup" extends="$unknown"
18107	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
18108	wsmap="managed"
18109	>
18110	<desc>Represents one bandwidth group.</desc>
18111
18112	<attribute name="name" type="wstring" readonly="yes">
18113	<desc>Name of the group.</desc>
18114	</attribute>
18115
18116	<attribute name="type" type="BandwidthGroupType" readonly="yes">
18117	<desc>Type of the group.</desc>
18118	</attribute>
18119
18120	<attribute name="reference" type="unsigned long" readonly="yes">
18121	<desc>How many devices/medium attachements use this group.</desc>
18122	</attribute>
18123
18124	<attribute name="maxBytesPerSec" type="long long">
18125	<desc>The maximum number of bytes which can be transfered by all
18126	entities attached to this group during one second.</desc>
18127	</attribute>
18128
18129	</interface>
18130
18131	<!--
18132	// IBandwidthControl
18133	/////////////////////////////////////////////////////////////////////////
18134	-->
18135	<interface
18136	name="IBandwidthControl" extends="$unknown"
18137	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
18138	wsmap="managed"
18139	>
18140	<desc>
18141	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
18142	This includes network and disk I/O.
18143	</desc>
18144
18145	<attribute name="numGroups" type="unsigned long" readonly="yes">
18146	<desc>
18147	The current number of existing bandwidth groups managed.
18148	</desc>
18149	</attribute>
18150
18151	<method name="createBandwidthGroup">
18152	<desc>
18153	Creates a new bandwidth group.
18154	</desc>
18155
18156	<param name="name" type="wstring" dir="in">
18157	<desc>Name of the bandwidth group.</desc>
18158	</param>
18159	<param name="type" type="BandwidthGroupType" dir="in">
18160	<desc>The type of the bandwidth group (network or disk).</desc>
18161	</param>
18162	<param name="maxBytesPerSec" type="long long" dir="in">
18163	<desc>The maximum number of bytes which can be transfered by all
18164	entities attached to this group during one second.</desc>
18165	</param>
18166	</method>
18167
18168	<method name="deleteBandwidthGroup">
18169	<desc>
18170	Deletes a new bandwidth group.
18171	</desc>
18172
18173	<param name="name" type="wstring" dir="in">
18174	<desc>Name of the bandwidth group to delete.</desc>
18175	</param>
18176	</method>
18177
18178	<method name="getBandwidthGroup" const="yes">
18179	<desc>
18180	Get a bandwidth group by name.
18181	</desc>
18182
18183	<param name="name" type="wstring" dir="in">
18184	<desc>Name of the bandwidth group to get.</desc>
18185	</param>
18186	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
18187	<desc>Where to store the bandwidth group on success.</desc>
18188	</param>
18189	</method>
18190
18191	<method name="getAllBandwidthGroups" const="yes">
18192	<desc>
18193	Get all managed bandwidth groups.
18194	</desc>
18195
18196	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
18197	<desc>The array of managed bandwidth groups.</desc>
18198	</param>
18199	</method>
18200	</interface>
18201
18202	<!--
18203	// IVirtualBoxClient
18204	/////////////////////////////////////////////////////////////////////////
18205	-->
18206
18207	<interface
18208	name="IVirtualBoxClient" extends="$unknown"
18209	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
18210	wsmap="suppress"
18211	>
18212	<desc>
18213	Convenience interface for client applications. Treat this as a
18214	singleton, i.e. never create more than one instance of this interface.
18215
18216	At the moment only available for clients of the local API (not usable
18217	via the webservice). Once the session logic is redesigned this might
18218	change.
18219	</desc>
18220
18221	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
18222	<desc>
18223	Reference to the server-side API root object.
18224	</desc>
18225	</attribute>
18226
18227	<attribute name="session" type="ISession" readonly="yes">
18228	<desc>
18229	Create a new session object and return the reference to it.
18230	</desc>
18231	</attribute>
18232
18233	<attribute name="eventSource" type="IEventSource" readonly="yes">
18234	<desc>
18235	Event source for VirtualBoxClient events.
18236	</desc>
18237	</attribute>
18238
18239	</interface>
18240
18241	<!--
18242	// Events
18243	/////////////////////////////////////////////////////////////////////////
18244	-->
18245	<enum
18246	name="VBoxEventType"
18247	uuid="0d67e79e-b7b1-4919-aab3-b36866075515"
18248	>
18249
18250	<desc>
18251	Type of an event.
18252	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18253	</desc>
18254
18255	<const name="Invalid" value="0">
18256	<desc>
18257	Invalid event, must be first.
18258	</desc>
18259	</const>
18260
18261	<const name="Any" value="1">
18262	<desc>
18263	Wildcard for all events.
18264	Events of this type are never delivered, and only used in
18265	<link to="IEventSource::registerListener"/> call to simplify registration.
18266	</desc>
18267	</const>
18268
18269	<const name="Vetoable" value="2">
18270	<desc>
18271	Wildcard for all vetoable events. Events of this type are never delivered, and only
18272	used in <link to="IEventSource::registerListener"/> call to simplify registration.
18273	</desc>
18274	</const>
18275
18276	<const name="MachineEvent" value="3">
18277	<desc>
18278	Wildcard for all machine events. Events of this type are never delivered, and only used in
18279	<link to="IEventSource::registerListener"/> call to simplify registration.
18280	</desc>
18281	</const>
18282
18283	<const name="SnapshotEvent" value="4">
18284	<desc>
18285	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
18286	<link to="IEventSource::registerListener"/> call to simplify registration.
18287	</desc>
18288	</const>
18289
18290	<const name="InputEvent" value="5">
18291	<desc>
18292	Wildcard for all input device (keyboard, mouse) events.
18293	Events of this type are never delivered, and only used in
18294	<link to="IEventSource::registerListener"/> call to simplify registration.
18295	</desc>
18296	</const>
18297
18298	<const name="LastWildcard" value="31">
18299	<desc>
18300	Last wildcard.
18301	</desc>
18302	</const>
18303
18304	<const name="OnMachineStateChanged" value="32">
18305	<desc>
18306	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
18307	</desc>
18308	</const>
18309	<const name="OnMachineDataChanged" value="33">
18310	<desc>
18311	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
18312	</desc>
18313	</const>
18314	<const name="OnExtraDataChanged" value="34">
18315	<desc>
18316	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
18317	</desc>
18318	</const>
18319	<const name="OnExtraDataCanChange" value="35">
18320	<desc>
18321	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
18322	</desc>
18323	</const>
18324	<const name="OnMediumRegistered" value="36">
18325	<desc>
18326	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
18327	</desc>
18328	</const>
18329	<const name="OnMachineRegistered" value="37">
18330	<desc>
18331	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
18332	</desc>
18333	</const>
18334	<const name="OnSessionStateChanged" value="38">
18335	<desc>
18336	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
18337	</desc>
18338	</const>
18339	<const name="OnSnapshotTaken" value="39">
18340	<desc>
18341	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
18342	</desc>
18343	</const>
18344	<const name="OnSnapshotDeleted" value="40">
18345	<desc>
18346	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
18347	</desc>
18348	</const>
18349	<const name="OnSnapshotChanged" value="41">
18350	<desc>
18351	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
18352	</desc>
18353	</const>
18354	<const name="OnGuestPropertyChanged" value="42">
18355	<desc>
18356	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
18357	</desc>
18358	</const>
18359	<!-- Console events -->
18360	<const name="OnMousePointerShapeChanged" value="43">
18361	<desc>
18362	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
18363	</desc>
18364	</const>
18365	<const name="OnMouseCapabilityChanged" value="44">
18366	<desc>
18367	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
18368	</desc>
18369	</const>
18370	<const name="OnKeyboardLedsChanged" value="45">
18371	<desc>
18372	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
18373	</desc>
18374	</const>
18375	<const name="OnStateChanged" value="46">
18376	<desc>
18377	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
18378	</desc>
18379	</const>
18380	<const name="OnAdditionsStateChanged" value="47">
18381	<desc>
18382	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
18383	</desc>
18384	</const>
18385	<const name="OnNetworkAdapterChanged" value="48">
18386	<desc>
18387	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
18388	</desc>
18389	</const>
18390	<const name="OnSerialPortChanged" value="49">
18391	<desc>
18392	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
18393	</desc>
18394	</const>
18395	<const name="OnParallelPortChanged" value="50">
18396	<desc>
18397	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
18398	</desc>
18399	</const>
18400	<const name="OnStorageControllerChanged" value="51">
18401	<desc>
18402	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
18403	</desc>
18404	</const>
18405	<const name="OnMediumChanged" value="52">
18406	<desc>
18407	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
18408	</desc>
18409	</const>
18410	<const name="OnVRDEServerChanged" value="53">
18411	<desc>
18412	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
18413	</desc>
18414	</const>
18415	<const name="OnUSBControllerChanged" value="54">
18416	<desc>
18417	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
18418	</desc>
18419	</const>
18420	<const name="OnUSBDeviceStateChanged" value="55">
18421	<desc>
18422	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
18423	</desc>
18424	</const>
18425	<const name="OnSharedFolderChanged" value="56">
18426	<desc>
18427	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
18428	</desc>
18429	</const>
18430	<const name="OnRuntimeError" value="57">
18431	<desc>
18432	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
18433	</desc>
18434	</const>
18435	<const name="OnCanShowWindow" value="58">
18436	<desc>
18437	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
18438	</desc>
18439	</const>
18440	<const name="OnShowWindow" value="59">
18441	<desc>
18442	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
18443	</desc>
18444	</const>
18445	<const name="OnCPUChanged" value="60">
18446	<desc>
18447	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
18448	</desc>
18449	</const>
18450	<const name="OnVRDEServerInfoChanged" value="61">
18451	<desc>
18452	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
18453	</desc>
18454	</const>
18455	<const name="OnEventSourceChanged" value="62">
18456	<desc>
18457	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
18458	</desc>
18459	</const>
18460	<const name="OnCPUExecutionCapChanged" value="63">
18461	<desc>
18462	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
18463	</desc>
18464	</const>
18465	<const name="OnGuestKeyboard" value="64">
18466	<desc>
18467	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
18468	</desc>
18469	</const>
18470	<const name="OnGuestMouse" value="65">
18471	<desc>
18472	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
18473	</desc>
18474	</const>
18475	<const name="OnNATRedirect" value="66">
18476	<desc>
18477	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
18478	</desc>
18479	</const>
18480	<const name="OnHostPCIDevicePlug" value="67">
18481	<desc>
18482	See <link to="IHostPCIDevicePlugEvent">IHostPCIDevicePlugEvent</link>.
18483	</desc>
18484	</const>
18485	<const name="OnVBoxSVCAvailabilityChanged" value="68">
18486	<desc>
18487	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
18488	</desc>
18489	</const>
18490	<const name="OnBandwidthGroupChanged" value="69">
18491	<desc>
18492	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
18493	</desc>
18494	</const>
18495	<const name="OnGuestMonitorChanged" value="70">
18496	<desc>
18497	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
18498	</desc>
18499	</const>
18500	<const name="OnStorageDeviceChanged" value="71">
18501	<desc>
18502	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
18503	</desc>
18504	</const>
18505	<const name="OnClipboardModeChanged" value="72">
18506	<desc>
18507	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
18508	</desc>
18509	</const>
18510	<const name="OnDragAndDropModeChanged" value="73">
18511	<desc>
18512	See <link to="IDragAndDropModeChangedEvent">IDragAndDropModeChangedEvent</link>.
18513	</desc>
18514	</const>
18515
18516	<!-- Last event marker -->
18517	<const name="Last" value="74">
18518	<desc>
18519	Must be last event, used for iterations and structures relying on numerical event values.
18520	</desc>
18521	</const>
18522
18523	</enum>
18524
18525	<interface
18526	name="IEventSource" extends="$unknown"
18527	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
18528	wsmap="managed"
18529	>
18530	<desc>
18531	Event source. Generally, any object which could generate events can be an event source,
18532	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
18533	an event source can work with listeners in either active or passive mode. In active mode it is up to
18534	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
18535	event source keeps track of pending events for each listener and returns available events on demand.
18536
18537	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18538	</desc>
18539
18540	<method name="createListener">
18541	<desc>
18542	Creates a new listener object, useful for passive mode.
18543	</desc>
18544	<param name="listener" type="IEventListener" dir="return"/>
18545	</method>
18546
18547	<method name="createAggregator">
18548	<desc>
18549	Creates an aggregator event source, collecting events from multiple sources.
18550	This way a single listener can listen for events coming from multiple sources,
18551	using a single blocking <link to="#getEvent"/> on the returned aggregator.
18552	</desc>
18553	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
18554	<desc>
18555	Subordinate event source this one aggregatres.
18556	</desc>
18557	</param>
18558	<param name="result" type="IEventSource" dir="return">
18559	<desc>
18560	Event source aggregating passed sources.
18561	</desc>
18562	</param>
18563	</method>
18564
18565	<method name="registerListener">
18566	<desc>
18567	Register an event listener.
18568
18569	<note>
18570	To avoid system overload, the VirtualBox server process checks if passive event
18571	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
18572	current implementation, if more than 500 pending events are detected for a passive
18573	event listener, it is forcefully unregistered by the system, and further
18574	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
18575	</note>
18576	</desc>
18577	<param name="listener" type="IEventListener" dir="in">
18578	<desc>Listener to register.</desc>
18579	</param>
18580	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
18581	<desc>
18582	Event types listener is interested in. One can use wildcards like -
18583	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
18584	than one event.
18585	</desc>
18586	</param>
18587	<param name="active" type="boolean" dir="in">
18588	<desc>
18589	Which mode this listener is operating in.
18590	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
18591	In passive mode, an internal event queue is created for this this IEventListener.
18592	For each event coming in, it is added to queues for all interested registered passive
18593	listeners. It is then up to the external code to call the listener's
18594	<link to="IEventListener::handleEvent" /> method. When done with an event, the
18595	external code must call <link to="#eventProcessed" />.
18596	</desc>
18597	</param>
18598	</method>
18599
18600	<method name="unregisterListener">
18601	<desc>
18602	Unregister an event listener. If listener is passive, and some waitable events are still
18603	in queue they are marked as processed automatically.
18604	</desc>
18605	<param name="listener" type="IEventListener" dir="in">
18606	<desc>Listener to unregister.</desc>
18607	</param>
18608	</method>
18609
18610	<method name="fireEvent">
18611	<desc>
18612	Fire an event for this source.
18613	</desc>
18614	<param name="event" type="IEvent" dir="in">
18615	<desc>Event to deliver.</desc>
18616	</param>
18617	<param name="timeout" type="long" dir="in">
18618	<desc>
18619	Maximum time to wait for event processing (if event is waitable), in ms;
18620	0 = no wait, -1 = indefinite wait.
18621	</desc>
18622	</param>
18623	<param name="result" type="boolean" dir="return">
18624	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
18625	</param>
18626	</method>
18627
18628	<method name="getEvent">
18629	<desc>
18630	Get events from this peer's event queue (for passive mode). Calling this method
18631	regularly is required for passive event listeners to avoid system overload;
18632	see <link to="IEventSource::registerListener" /> for details.
18633
18634	<result name="VBOX_E_OBJECT_NOT_FOUND">
18635	Listener is not registered, or autounregistered.
18636	</result>
18637	</desc>
18638	<param name="listener" type="IEventListener" dir="in">
18639	<desc>Which listener to get data for.</desc>
18640	</param>
18641	<param name="timeout" type="long" dir="in">
18642	<desc>
18643	Maximum time to wait for events, in ms;
18644	0 = no wait, -1 = indefinite wait.
18645	</desc>
18646	</param>
18647	<param name="event" type="IEvent" dir="return">
18648	<desc>Event retrieved, or null if none available.</desc>
18649	</param>
18650	</method>
18651
18652	<method name="eventProcessed">
18653	<desc>
18654	Must be called for waitable events after a particular listener finished its
18655	event processing. When all listeners of a particular event have called this
18656	method, the system will then call <link to="IEvent::setProcessed" />.
18657	</desc>
18658	<param name="listener" type="IEventListener" dir="in">
18659	<desc>Which listener processed event.</desc>
18660	</param>
18661	<param name="event" type="IEvent" dir="in">
18662	<desc>Which event.</desc>
18663	</param>
18664	</method>
18665
18666	</interface>
18667
18668	<interface
18669	name="IEventListener" extends="$unknown"
18670	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
18671	wsmap="managed"
18672	>
18673	<desc>
18674	Event listener. An event listener can work in either active or passive mode, depending on the way
18675	it was registered.
18676	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
18677	</desc>
18678
18679	<method name="handleEvent">
18680	<desc>
18681	Handle event callback for active listeners. It is not called for
18682	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
18683	and having received acknowledgement from all passive listeners via
18684	<link to="IEventSource::eventProcessed"/>, the event is marked as
18685	processed and <link to="IEvent::waitProcessed"/> will return
18686	immediately.
18687	</desc>
18688	<param name="event" type="IEvent" dir="in">
18689	<desc>Event available.</desc>
18690	</param>
18691	</method>
18692
18693	</interface>
18694
18695	<interface
18696	name="IEvent" extends="$unknown"
18697	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
18698	wsmap="managed"
18699	>
18700	<desc>
18701	Abstract parent interface for VirtualBox events. Actual events will typically implement
18702	a more specific interface which derives from this (see below).
18703
18704	<b>Introduction to VirtualBox events</b>
18705
18706	Generally speaking, an event (represented by this interface) signals that something
18707	happened, while an event listener (see <link to="IEventListener" />) represents an
18708	entity that is interested in certain events. In order for this to work with
18709	unidirectional protocols (i.e. web services), the concepts of passive and active
18710	listener are used.
18711
18712	Event consumers can register themselves as listeners, providing an array of
18713	events they are interested in (see <link to="IEventSource::registerListener" />).
18714	When an event triggers, the listener is notified about the event. The exact
18715	mechanism of the notification depends on whether the listener was registered as
18716	an active or passive listener:
18717
18718	<ul>
18719	<li>An active listener is very similar to a callback: it is a function invoked
18720	by the API. As opposed to the callbacks that were used in the API before
18721	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
18722	</li>
18723
18724	<li>Passive listeners are somewhat trickier to implement, but do not require
18725	a client function to be callable, which is not an option with scripting
18726	languages or web service clients. Internally the <link to="IEventSource" />
18727	implementation maintains an event queue for each passive listener, and
18728	newly arrived events are put in this queue. When the listener calls
18729	<link to="IEventSource::getEvent"/>, first element from its internal event
18730	queue is returned. When the client completes processing of an event,
18731	the <link to="IEventSource::eventProcessed" /> function must be called,
18732	acknowledging that the event was processed. It supports implementing
18733	waitable events. On passive listener unregistration, all events from its
18734	queue are auto-acknowledged.
18735	</li>
18736	</ul>
18737
18738	Waitable events are useful in situations where the event generator wants to track
18739	delivery or a party wants to wait until all listeners have completed the event. A
18740	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
18741	listeners might veto a certain action, and thus the event producer has to make
18742	sure that all listeners have processed the event and not vetoed before taking
18743	the action.
18744
18745	A given event may have both passive and active listeners at the same time.
18746
18747	<b>Using events</b>
18748
18749	Any VirtualBox object capable of producing externally visible events provides an
18750	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
18751	This event source object is notified by VirtualBox once something has happened, so
18752	consumers may register event listeners with this event source. To register a listener,
18753	an object implementing the <link to="IEventListener" /> interface must be provided.
18754	For active listeners, such an object is typically created by the consumer, while for
18755	passive listeners <link to="IEventSource::createListener" /> should be used. Please
18756	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
18757
18758	Once created, the listener must be registered to listen for the desired events
18759	(see <link to="IEventSource::registerListener" />), providing an array of
18760	<link to="VBoxEventType" /> enums. Those elements can either be the individual
18761	event IDs or wildcards matching multiple event IDs.
18762
18763	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
18764	called automatically when the event is triggered, while passive listeners have to call
18765	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
18766	an event processing loop.
18767
18768	The IEvent interface is an abstract parent interface for all such VirtualBox events
18769	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
18770	or the event processing loop is to check the <link to="#type" /> attribute of the event and
18771	then cast to the appropriate specific interface using @c QueryInterface().
18772	</desc>
18773
18774	<attribute name="type" readonly="yes" type="VBoxEventType">
18775	<desc>
18776	Event type.
18777	</desc>
18778	</attribute>
18779
18780	<attribute name="source" readonly="yes" type="IEventSource">
18781	<desc>
18782	Source of this event.
18783	</desc>
18784	</attribute>
18785
18786	<attribute name="waitable" readonly="yes" type="boolean">
18787	<desc>
18788	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
18789	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
18790	as no additional overhead associated with waitability imposed.
18791	Waitable events are needed when one need to be able to wait for particular event processed,
18792	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
18793	until all consumers confirmed events.
18794	</desc>
18795	</attribute>
18796
18797	<method name="setProcessed">
18798	<desc>
18799	Internal method called by the system when all listeners of a particular event have called
18800	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
18801	</desc>
18802	</method>
18803
18804	<method name="waitProcessed">
18805	<desc>
18806	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
18807	described semantics, for non-waitable returns true immediately.
18808	</desc>
18809	<param name="timeout" type="long" dir="in">
18810	<desc>
18811	Maximum time to wait for event processeing, in ms;
18812	0 = no wait, -1 = indefinite wait.
18813	</desc>
18814	</param>
18815	<param name="result" type="boolean" dir="return">
18816	<desc>If this event was processed before timeout.</desc>
18817	</param>
18818	</method>
18819	</interface>
18820
18821
18822	<interface
18823	name="IReusableEvent" extends="IEvent"
18824	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
18825	wsmap="managed"
18826	>
18827	<desc>Base abstract interface for all reusable events.</desc>
18828
18829	<attribute name="generation" readonly="yes" type="unsigned long">
18830	<desc>Current generation of event, incremented on reuse.</desc>
18831	</attribute>
18832
18833	<method name="reuse">
18834	<desc>
18835	Marks an event as reused, increments 'generation', fields shall no
18836	longer be considered valid.
18837	</desc>
18838	</method>
18839	</interface>
18840
18841	<interface
18842	name="IMachineEvent" extends="IEvent"
18843	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
18844	wsmap="managed" id="MachineEvent"
18845	>
18846	<desc>Base abstract interface for all machine events.</desc>
18847
18848	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
18849	<desc>ID of the machine this event relates to.</desc>
18850	</attribute>
18851
18852	</interface>
18853
18854	<interface
18855	name="IMachineStateChangedEvent" extends="IMachineEvent"
18856	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
18857	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
18858	>
18859	<desc>Machine state change event.</desc>
18860
18861	<attribute name="state" readonly="yes" type="MachineState">
18862	<desc>New execution state.</desc>
18863	</attribute>
18864	</interface>
18865
18866	<interface
18867	name="IMachineDataChangedEvent" extends="IMachineEvent"
18868	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
18869	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
18870	>
18871	<desc>
18872	Any of the settings of the given machine has changed.
18873	</desc>
18874
18875	<attribute name="temporary" readonly="yes" type="boolean">
18876	<desc>@c true if the settings change is temporary. All permanent
18877	settings changes will trigger an event, and only temporary settings
18878	changes for running VMs will trigger an event. Note: sending events
18879	for temporary changes is NOT IMPLEMENTED.</desc>
18880	</attribute>
18881	</interface>
18882
18883	<interface
18884	name="IMediumRegisteredEvent" extends="IEvent"
18885	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
18886	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
18887	>
18888	<desc>
18889	The given medium was registered or unregistered
18890	within this VirtualBox installation.
18891	</desc>
18892
18893	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
18894	<desc>ID of the medium this event relates to.</desc>
18895	</attribute>
18896
18897	<attribute name="mediumType" readonly="yes" type="DeviceType">
18898	<desc>Type of the medium this event relates to.</desc>
18899	</attribute>
18900
18901	<attribute name="registered" type="boolean" readonly="yes">
18902	<desc>
18903	If @c true, the medium was registered, otherwise it was
18904	unregistered.
18905	</desc>
18906	</attribute>
18907	</interface>
18908
18909	<interface
18910	name="IMachineRegisteredEvent" extends="IMachineEvent"
18911	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
18912	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
18913	>
18914	<desc>
18915	The given machine was registered or unregistered
18916	within this VirtualBox installation.
18917	</desc>
18918
18919	<attribute name="registered" type="boolean" readonly="yes">
18920	<desc>
18921	If @c true, the machine was registered, otherwise it was
18922	unregistered.
18923	</desc>
18924	</attribute>
18925	</interface>
18926
18927	<interface
18928	name="ISessionStateChangedEvent" extends="IMachineEvent"
18929	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
18930	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
18931	>
18932	<desc>
18933	The state of the session for the given machine was changed.
18934	<see><link to="IMachine::sessionState"/></see>
18935	</desc>
18936
18937	<attribute name="state" type="SessionState" readonly="yes">
18938	<desc>
18939	New session state.
18940	</desc>
18941	</attribute>
18942	</interface>
18943
18944	<interface
18945	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
18946	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
18947	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
18948	>
18949	<desc>
18950	Notification when a guest property has changed.
18951	</desc>
18952
18953	<attribute name="name" readonly="yes" type="wstring">
18954	<desc>
18955	The name of the property that has changed.
18956	</desc>
18957	</attribute>
18958
18959	<attribute name="value" readonly="yes" type="wstring">
18960	<desc>
18961	The new property value.
18962	</desc>
18963	</attribute>
18964
18965	<attribute name="flags" readonly="yes" type="wstring">
18966	<desc>
18967	The new property flags.
18968	</desc>
18969	</attribute>
18970
18971	</interface>
18972
18973	<interface
18974	name="ISnapshotEvent" extends="IMachineEvent"
18975	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
18976	wsmap="managed" id="SnapshotEvent"
18977	>
18978	<desc>Base interface for all snapshot events.</desc>
18979
18980	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
18981	<desc>ID of the snapshot this event relates to.</desc>
18982	</attribute>
18983
18984	</interface>
18985
18986	<interface
18987	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
18988	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
18989	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
18990	>
18991	<desc>
18992	A new snapshot of the machine has been taken.
18993	<see><link to="ISnapshot"/></see>
18994	</desc>
18995	</interface>
18996
18997	<interface
18998	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
18999	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
19000	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
19001	>
19002	<desc>
19003	Snapshot of the given machine has been deleted.
19004
19005	<note>
19006	This notification is delivered <b>after</b> the snapshot
19007	object has been uninitialized on the server (so that any
19008	attempt to call its methods will return an error).
19009	</note>
19010
19011	<see><link to="ISnapshot"/></see>
19012	</desc>
19013	</interface>
19014
19015	<interface
19016	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
19017	uuid="07541941-8079-447a-a33e-47a69c7980db"
19018	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
19019	>
19020	<desc>
19021	Snapshot properties (name and/or description) have been changed.
19022	<see><link to="ISnapshot"/></see>
19023	</desc>
19024	</interface>
19025
19026	<interface
19027	name="IMousePointerShapeChangedEvent" extends="IEvent"
19028	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
19029	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
19030	>
19031	<desc>
19032	Notification when the guest mouse pointer shape has
19033	changed. The new shape data is given.
19034	</desc>
19035
19036	<attribute name="visible" type="boolean" readonly="yes">
19037	<desc>
19038	Flag whether the pointer is visible.
19039	</desc>
19040	</attribute>
19041	<attribute name="alpha" type="boolean" readonly="yes">
19042	<desc>
19043	Flag whether the pointer has an alpha channel.
19044	</desc>
19045	</attribute>
19046	<attribute name="xhot" type="unsigned long" readonly="yes">
19047	<desc>
19048	The pointer hot spot X coordinate.
19049	</desc>
19050	</attribute>
19051	<attribute name="yhot" type="unsigned long" readonly="yes">
19052	<desc>
19053	The pointer hot spot Y coordinate.
19054	</desc>
19055	</attribute>
19056	<attribute name="width" type="unsigned long" readonly="yes">
19057	<desc>
19058	Width of the pointer shape in pixels.
19059	</desc>
19060	</attribute>
19061	<attribute name="height" type="unsigned long" readonly="yes">
19062	<desc>
19063	Height of the pointer shape in pixels.
19064	</desc>
19065	</attribute>
19066	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
19067	<desc>
19068	Shape buffer arrays.
19069
19070	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
19071	followed by a 32-bpp XOR (color) mask.
19072
19073	For pointers without alpha channel the XOR mask pixels are 32
19074	bit values: (lsb)BGR0(msb). For pointers with alpha channel
19075	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
19076
19077	An AND mask is used for pointers with alpha channel, so if the
19078	callback does not support alpha, the pointer could be
19079	displayed as a normal color pointer.
19080
19081	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
19082	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
19083	height</tt>. The padding bits at the end of each scanline are
19084	undefined.
19085
19086	The XOR mask follows the AND mask on the next 4-byte aligned
19087	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
19088	Bytes in the gap between the AND and the XOR mask are undefined.
19089	The XOR mask scanlines have no gap between them and the size of
19090	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
19091
19092	<note>
19093	If @a shape is 0, only the pointer visibility is changed.
19094	</note>
19095	</desc>
19096	</attribute>
19097	</interface>
19098
19099	<interface
19100	name="IMouseCapabilityChangedEvent" extends="IEvent"
19101	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
19102	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
19103	>
19104	<desc>
19105	Notification when the mouse capabilities reported by the
19106	guest have changed. The new capabilities are passed.
19107	</desc>
19108	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
19109	<desc>
19110	Supports absolute coordinates.
19111	</desc>
19112	</attribute>
19113	<attribute name="supportsRelative" type="boolean" readonly="yes">
19114	<desc>
19115	Supports relative coordinates.
19116	</desc>
19117	</attribute>
19118	<attribute name="needsHostCursor" type="boolean" readonly="yes">
19119	<desc>
19120	If host cursor is needed.
19121	</desc>
19122	</attribute>
19123	</interface>
19124
19125	<interface
19126	name="IKeyboardLedsChangedEvent" extends="IEvent"
19127	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
19128	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
19129	>
19130	<desc>
19131	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
19132	to alter the state of the keyboard LEDs.
19133	</desc>
19134	<attribute name="numLock" type="boolean" readonly="yes">
19135	<desc>
19136	NumLock status.
19137	</desc>
19138	</attribute>
19139	<attribute name="capsLock" type="boolean" readonly="yes">
19140	<desc>
19141	CapsLock status.
19142	</desc>
19143	</attribute>
19144	<attribute name="scrollLock" type="boolean" readonly="yes">
19145	<desc>
19146	ScrollLock status.
19147	</desc>
19148	</attribute>
19149	</interface>
19150
19151	<interface
19152	name="IStateChangedEvent" extends="IEvent"
19153	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
19154	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
19155	>
19156	<desc>
19157	Notification when the execution state of the machine has changed.
19158	The new state is given.
19159	</desc>
19160	<attribute name="state" type="MachineState" readonly="yes">
19161	<desc>
19162	New machine state.
19163	</desc>
19164	</attribute>
19165	</interface>
19166
19167	<interface
19168	name="IAdditionsStateChangedEvent" extends="IEvent"
19169	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
19170	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
19171	>
19172	<desc>
19173	Notification when a Guest Additions property changes.
19174	Interested callees should query IGuest attributes to
19175	find out what has changed.
19176	</desc>
19177	</interface>
19178
19179	<interface
19180	name="INetworkAdapterChangedEvent" extends="IEvent"
19181	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
19182	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
19183	>
19184	<desc>
19185	Notification when a property of one of the
19186	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
19187	changes. Interested callees should use INetworkAdapter methods and
19188	attributes to find out what has changed.
19189	</desc>
19190	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
19191	<desc>
19192	Network adapter that is subject to change.
19193	</desc>
19194	</attribute>
19195	</interface>
19196
19197	<interface
19198	name="ISerialPortChangedEvent" extends="IEvent"
19199	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
19200	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
19201	>
19202	<desc>
19203	Notification when a property of one of the
19204	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
19205	Interested callees should use ISerialPort methods and attributes
19206	to find out what has changed.
19207	</desc>
19208	<attribute name="serialPort" type="ISerialPort" readonly="yes">
19209	<desc>
19210	Serial port that is subject to change.
19211	</desc>
19212	</attribute>
19213	</interface>
19214
19215	<interface
19216	name="IParallelPortChangedEvent" extends="IEvent"
19217	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
19218	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
19219	>
19220	<desc>
19221	Notification when a property of one of the
19222	virtual <link to="IMachine::getParallelPort">parallel ports</link>
19223	changes. Interested callees should use ISerialPort methods and
19224	attributes to find out what has changed.
19225	</desc>
19226	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
19227	<desc>
19228	Parallel port that is subject to change.
19229	</desc>
19230	</attribute>
19231	</interface>
19232
19233	<interface
19234	name="IStorageControllerChangedEvent" extends="IEvent"
19235	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
19236	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
19237	>
19238	<desc>
19239	Notification when a
19240	<link to="IMachine::mediumAttachments">medium attachment</link>
19241	changes.
19242	</desc>
19243	</interface>
19244
19245	<interface
19246	name="IMediumChangedEvent" extends="IEvent"
19247	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
19248	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
19249	>
19250	<desc>
19251	Notification when a
19252	<link to="IMachine::mediumAttachments">medium attachment</link>
19253	changes.
19254	</desc>
19255	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
19256	<desc>
19257	Medium attachment that is subject to change.
19258	</desc>
19259	</attribute>
19260	</interface>
19261
19262	<interface
19263	name="IClipboardModeChangedEvent" extends="IEvent"
19264	uuid="cac21692-7997-4595-a731-3a509db604e5"
19265	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
19266	>
19267	<desc>
19268	Notification when the shared clipboard mode changes.
19269	</desc>
19270	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
19271	<desc>
19272	The new clipboard mode.
19273	</desc>
19274	</attribute>
19275	</interface>
19276
19277	<interface
19278	name="IDragAndDropModeChangedEvent" extends="IEvent"
19279	uuid="e90b8850-ac8e-4dff-8059-4100ae2c3c3d"
19280	wsmap="managed" autogen="VBoxEvent" id="OnDragAndDropModeChanged"
19281	>
19282	<desc>
19283	Notification when the drag'n'drop mode changes.
19284	</desc>
19285	<attribute name="dragAndDropMode" type="DragAndDropMode" readonly="yes">
19286	<desc>
19287	The new drag'n'drop mode.
19288	</desc>
19289	</attribute>
19290	</interface>
19291
19292	<interface
19293	name="ICPUChangedEvent" extends="IEvent"
19294	uuid="4da2dec7-71b2-4817-9a64-4ed12c17388e"
19295	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
19296	>
19297	<desc>
19298	Notification when a CPU changes.
19299	</desc>
19300	<attribute name="CPU" type="unsigned long" readonly="yes">
19301	<desc>
19302	The CPU which changed.
19303	</desc>
19304	</attribute>
19305	<attribute name="add" type="boolean" readonly="yes">
19306	<desc>
19307	Flag whether the CPU was added or removed.
19308	</desc>
19309	</attribute>
19310	</interface>
19311
19312	<interface
19313	name="ICPUExecutionCapChangedEvent" extends="IEvent"
19314	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
19315	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
19316	>
19317	<desc>
19318	Notification when the CPU execution cap changes.
19319	</desc>
19320	<attribute name="executionCap" type="unsigned long" readonly="yes">
19321	<desc>
19322	The new CPU execution cap value. (1-100)
19323	</desc>
19324	</attribute>
19325	</interface>
19326
19327	<interface
19328	name="IGuestKeyboardEvent" extends="IEvent"
19329	uuid="88394258-7006-40d4-b339-472ee3801844"
19330	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
19331	>
19332	<desc>
19333	Notification when guest keyboard event happens.
19334	</desc>
19335	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
19336	<desc>
19337	Array of scancodes.
19338	</desc>
19339	</attribute>
19340	</interface>
19341
19342	<interface
19343	name="IGuestMouseEvent" extends="IReusableEvent"
19344	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
19345	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
19346	>
19347	<desc>
19348	Notification when guest mouse event happens.
19349	</desc>
19350
19351	<attribute name="absolute" type="boolean" readonly="yes">
19352	<desc>
19353	If this event is relative or absolute.
19354	</desc>
19355	</attribute>
19356
19357	<attribute name="x" type="long" readonly="yes">
19358	<desc>
19359	New X position, or X delta.
19360	</desc>
19361	</attribute>
19362
19363	<attribute name="y" type="long" readonly="yes">
19364	<desc>
19365	New Y position, or Y delta.
19366	</desc>
19367	</attribute>
19368
19369	<attribute name="z" type="long" readonly="yes">
19370	<desc>
19371	Z delta.
19372	</desc>
19373	</attribute>
19374
19375	<attribute name="w" type="long" readonly="yes">
19376	<desc>
19377	W delta.
19378	</desc>
19379	</attribute>
19380
19381	<attribute name="buttons" type="long" readonly="yes">
19382	<desc>
19383	Button state bitmask.
19384	</desc>
19385	</attribute>
19386
19387	</interface>
19388
19389
19390	<interface
19391	name="IVRDEServerChangedEvent" extends="IEvent"
19392	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
19393	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
19394	>
19395	<desc>
19396	Notification when a property of the
19397	<link to="IMachine::VRDEServer">VRDE server</link> changes.
19398	Interested callees should use IVRDEServer methods and attributes to
19399	find out what has changed.
19400	</desc>
19401	</interface>
19402
19403	<interface
19404	name="IVRDEServerInfoChangedEvent" extends="IEvent"
19405	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
19406	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
19407	>
19408	<desc>
19409	Notification when the status of the VRDE server changes. Interested callees
19410	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
19411	attributes to find out what is the current status.
19412	</desc>
19413	</interface>
19414
19415	<interface
19416	name="IUSBControllerChangedEvent" extends="IEvent"
19417	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
19418	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
19419	>
19420	<desc>
19421	Notification when a property of the virtual
19422	<link to="IMachine::USBController">USB controller</link> changes.
19423	Interested callees should use IUSBController methods and attributes to
19424	find out what has changed.
19425	</desc>
19426	</interface>
19427
19428	<interface
19429	name="IUSBDeviceStateChangedEvent" extends="IEvent"
19430	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
19431	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
19432	>
19433	<desc>
19434	Notification when a USB device is attached to or detached from
19435	the virtual USB controller.
19436
19437	This notification is sent as a result of the indirect
19438	request to attach the device because it matches one of the
19439	machine USB filters, or as a result of the direct request
19440	issued by <link to="IConsole::attachUSBDevice"/> or
19441	<link to="IConsole::detachUSBDevice"/>.
19442
19443	This notification is sent in case of both a succeeded and a
19444	failed request completion. When the request succeeds, the
19445	@a error parameter is @c null, and the given device has been
19446	already added to (when @a attached is @c true) or removed from
19447	(when @a attached is @c false) the collection represented by
19448	<link to="IConsole::USBDevices"/>. On failure, the collection
19449	doesn't change and the @a error parameter represents the error
19450	message describing the failure.
19451	</desc>
19452	<attribute name="device" type="IUSBDevice" readonly="yes">
19453	<desc>
19454	Device that is subject to state change.
19455	</desc>
19456	</attribute>
19457	<attribute name="attached" type="boolean" readonly="yes">
19458	<desc>
19459	@c true if the device was attached and @c false otherwise.
19460	</desc>
19461	</attribute>
19462	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
19463	<desc>
19464	@c null on success or an error message object on failure.
19465	</desc>
19466	</attribute>
19467	</interface>
19468
19469	<interface
19470	name="ISharedFolderChangedEvent" extends="IEvent"
19471	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
19472	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
19473	>
19474	<desc>
19475	Notification when a shared folder is added or removed.
19476	The @a scope argument defines one of three scopes:
19477	<link to="IVirtualBox::sharedFolders">global shared folders</link>
19478	(<link to="Scope_Global">Global</link>),
19479	<link to="IMachine::sharedFolders">permanent shared folders</link> of
19480	the machine (<link to="Scope_Machine">Machine</link>) or <link
19481	to="IConsole::sharedFolders">transient shared folders</link> of the
19482	machine (<link to="Scope_Session">Session</link>). Interested callees
19483	should use query the corresponding collections to find out what has
19484	changed.
19485	</desc>
19486	<attribute name="scope" type="Scope" readonly="yes">
19487	<desc>
19488	Scope of the notification.
19489	</desc>
19490	</attribute>
19491	</interface>
19492
19493	<interface
19494	name="IRuntimeErrorEvent" extends="IEvent"
19495	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
19496	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
19497	>
19498	<desc>
19499	Notification when an error happens during the virtual
19500	machine execution.
19501
19502	There are three kinds of runtime errors:
19503	<ul>
19504	<li><i>fatal</i></li>
19505	<li><i>non-fatal with retry</i></li>
19506	<li><i>non-fatal warnings</i></li>
19507	</ul>
19508
19509	<b>Fatal</b> errors are indicated by the @a fatal parameter set
19510	to @c true. In case of fatal errors, the virtual machine
19511	execution is always paused before calling this notification, and
19512	the notification handler is supposed either to immediately save
19513	the virtual machine state using <link to="IConsole::saveState"/>
19514	or power it off using <link to="IConsole::powerDown"/>.
19515	Resuming the execution can lead to unpredictable results.
19516
19517	<b>Non-fatal</b> errors and warnings are indicated by the
19518	@a fatal parameter set to @c false. If the virtual machine
19519	is in the Paused state by the time the error notification is
19520	received, it means that the user can <i>try to resume</i> the machine
19521	execution after attempting to solve the problem that caused the
19522	error. In this case, the notification handler is supposed
19523	to show an appropriate message to the user (depending on the
19524	value of the @a id parameter) that offers several actions such
19525	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
19526	wants to retry, the notification handler should continue
19527	the machine execution using the <link to="IConsole::resume"/>
19528	call. If the machine execution is not Paused during this
19529	notification, then it means this notification is a <i>warning</i>
19530	(for example, about a fatal condition that can happen very soon);
19531	no immediate action is required from the user, the machine
19532	continues its normal execution.
19533
19534	Note that in either case the notification handler
19535	<b>must not</b> perform any action directly on a thread
19536	where this notification is called. Everything it is allowed to
19537	do is to post a message to another thread that will then talk
19538	to the user and take the corresponding action.
19539
19540	Currently, the following error identifiers are known:
19541	<ul>
19542	<li><tt>"HostMemoryLow"</tt></li>
19543	<li><tt>"HostAudioNotResponding"</tt></li>
19544	<li><tt>"VDIStorageFull"</tt></li>
19545	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
19546	</ul>
19547	</desc>
19548	<attribute name="fatal" type="boolean" readonly="yes">
19549	<desc>
19550	Whether the error is fatal or not.
19551	</desc>
19552	</attribute>
19553	<attribute name="id" type="wstring" readonly="yes">
19554	<desc>
19555	Error identifier.
19556	</desc>
19557	</attribute>
19558	<attribute name="message" type="wstring" readonly="yes">
19559	<desc>
19560	Optional error message.
19561	</desc>
19562	</attribute>
19563	</interface>
19564
19565
19566	<interface
19567	name="IEventSourceChangedEvent" extends="IEvent"
19568	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
19569	waitable="yes"
19570	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
19571	>
19572	<desc>
19573	Notification when an event source state changes (listener added or removed).
19574	</desc>
19575
19576	<attribute name="listener" type="IEventListener" readonly="yes">
19577	<desc>
19578	Event listener which has changed.
19579	</desc>
19580	</attribute>
19581
19582	<attribute name="add" type="boolean" readonly="yes">
19583	<desc>
19584	Flag whether listener was added or removed.
19585	</desc>
19586	</attribute>
19587	</interface>
19588
19589	<interface
19590	name="IExtraDataChangedEvent" extends="IEvent"
19591	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
19592	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
19593	>
19594	<desc>
19595	Notification when machine specific or global extra data
19596	has changed.
19597	</desc>
19598	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19599	<desc>
19600	ID of the machine this event relates to.
19601	Null for global extra data changes.
19602	</desc>
19603	</attribute>
19604	<attribute name="key" type="wstring" readonly="yes">
19605	<desc>
19606	Extra data key that has changed.
19607	</desc>
19608	</attribute>
19609	<attribute name="value" type="wstring" readonly="yes">
19610	<desc>
19611	Extra data value for the given key.
19612	</desc>
19613	</attribute>
19614	</interface>
19615
19616	<interface
19617	name="IVetoEvent" extends="IEvent"
19618	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
19619	wsmap="managed"
19620	>
19621	<desc>Base abstract interface for veto events.</desc>
19622
19623	<method name="addVeto">
19624	<desc>
19625	Adds a veto on this event.
19626	</desc>
19627	<param name="reason" type="wstring" dir="in">
19628	<desc>
19629	Reason for veto, could be null or empty string.
19630	</desc>
19631	</param>
19632	</method>
19633
19634	<method name="isVetoed">
19635	<desc>
19636	If this event was vetoed.
19637	</desc>
19638	<param name="result" type="boolean" dir="return">
19639	<desc>
19640	Reason for veto.
19641	</desc>
19642	</param>
19643	</method>
19644
19645	<method name="getVetos">
19646	<desc>
19647	Current veto reason list, if size is 0 - no veto.
19648	</desc>
19649	<param name="result" type="wstring" dir="return" safearray="yes">
19650	<desc>
19651	Array of reasons for veto provided by different event handlers.
19652	</desc>
19653	</param>
19654	</method>
19655
19656	</interface>
19657
19658	<interface
19659	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
19660	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
19661	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
19662	waitable="true"
19663	>
19664	<desc>
19665	Notification when someone tries to change extra data for
19666	either the given machine or (if @c null) global extra data.
19667	This gives the chance to veto against changes.
19668	</desc>
19669	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
19670	<desc>
19671	ID of the machine this event relates to.
19672	Null for global extra data changes.
19673	</desc>
19674	</attribute>
19675	<attribute name="key" type="wstring" readonly="yes">
19676	<desc>
19677	Extra data key that has changed.
19678	</desc>
19679	</attribute>
19680	<attribute name="value" type="wstring" readonly="yes">
19681	<desc>
19682	Extra data value for the given key.
19683	</desc>
19684	</attribute>
19685	</interface>
19686
19687	<interface
19688	name="ICanShowWindowEvent" extends="IVetoEvent"
19689	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
19690	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
19691	waitable="true"
19692	>
19693	<desc>
19694	Notification when a call to
19695	<link to="IMachine::canShowConsoleWindow"/> is made by a
19696	front-end to check if a subsequent call to
19697	<link to="IMachine::showConsoleWindow"/> can succeed.
19698
19699	The callee should give an answer appropriate to the current
19700	machine state using event veto. This answer must
19701	remain valid at least until the next
19702	<link to="IConsole::state">machine state</link> change.
19703	</desc>
19704	</interface>
19705
19706	<interface
19707	name="IShowWindowEvent" extends="IEvent"
19708	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
19709	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
19710	waitable="true"
19711	>
19712	<desc>
19713	Notification when a call to
19714	<link to="IMachine::showConsoleWindow"/>
19715	requests the console window to be activated and brought to
19716	foreground on the desktop of the host PC.
19717
19718	This notification should cause the VM console process to
19719	perform the requested action as described above. If it is
19720	impossible to do it at a time of this notification, this
19721	method should return a failure.
19722
19723	Note that many modern window managers on many platforms
19724	implement some sort of focus stealing prevention logic, so
19725	that it may be impossible to activate a window without the
19726	help of the currently active application (which is supposedly
19727	an initiator of this notification). In this case, this method
19728	must return a non-zero identifier that represents the
19729	top-level window of the VM console process. The caller, if it
19730	represents a currently active process, is responsible to use
19731	this identifier (in a platform-dependent manner) to perform
19732	actual window activation.
19733
19734	This method must set @a winId to zero if it has performed all
19735	actions necessary to complete the request and the console
19736	window is now active and in foreground, to indicate that no
19737	further action is required on the caller's side.
19738	</desc>
19739	<attribute name="winId" type="long long">
19740	<desc>
19741	Platform-dependent identifier of the top-level VM console
19742	window, or zero if this method has performed all actions
19743	necessary to implement the <i>show window</i> semantics for
19744	the given platform and/or this VirtualBox front-end.
19745	</desc>
19746	</attribute>
19747	</interface>
19748
19749	<interface
19750	name="INATRedirectEvent" extends="IMachineEvent"
19751	uuid="24eef068-c380-4510-bc7c-19314a7352f1"
19752	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
19753	>
19754	<desc>
19755	Notification when NAT redirect rule added or removed.
19756	</desc>
19757	<attribute name="slot" type="unsigned long" readonly="yes">
19758	<desc>
19759	Adapter which NAT attached to.
19760	</desc>
19761	</attribute>
19762	<attribute name="remove" type="boolean" readonly="yes">
19763	<desc>
19764	Whether rule remove or add.
19765	</desc>
19766	</attribute>
19767	<attribute name="name" type="wstring" readonly="yes">
19768	<desc>
19769	Name of the rule.
19770	</desc>
19771	</attribute>
19772	<attribute name="proto" type="NATProtocol" readonly="yes">
19773	<desc>
19774	Protocol (TCP or UDP) of the redirect rule.
19775	</desc>
19776	</attribute>
19777	<attribute name="hostIP" type="wstring" readonly="yes">
19778	<desc>
19779	Host ip address to bind socket on.
19780	</desc>
19781	</attribute>
19782	<attribute name="hostPort" type="long" readonly="yes">
19783	<desc>
19784	Host port to bind socket on.
19785	</desc>
19786	</attribute>
19787	<attribute name="guestIP" type="wstring" readonly="yes">
19788	<desc>
19789	Guest ip address to redirect to.
19790	</desc>
19791	</attribute>
19792	<attribute name="guestPort" type="long" readonly="yes">
19793	<desc>
19794	Guest port to redirect to.
19795	</desc>
19796	</attribute>
19797	</interface>
19798
19799	<interface
19800	name="IHostPCIDevicePlugEvent" extends="IMachineEvent"
19801	waitable="yes"
19802	uuid="a0bad6df-d612-47d3-89d4-db3992533948"
19803	wsmap="managed" autogen="VBoxEvent" id="OnHostPCIDevicePlug"
19804	>
19805	<desc>
19806	Notification when host PCI device is plugged/unplugged. Plugging
19807	usually takes place on VM startup, unplug - when
19808	<link to="IMachine::detachHostPCIDevice"/> is called.
19809
19810	<see><link to="IMachine::detachHostPCIDevice"/></see>
19811
19812	</desc>
19813
19814	<attribute name="plugged" type="boolean" readonly="yes">
19815	<desc>
19816	If device successfully plugged or unplugged.
19817	</desc>
19818	</attribute>
19819
19820	<attribute name="success" type="boolean" readonly="yes">
19821	<desc>
19822	If operation was successful, if false - 'message' attribute
19823	may be of interest.
19824	</desc>
19825	</attribute>
19826
19827	<attribute name="attachment" type="IPCIDeviceAttachment" readonly="yes">
19828	<desc>
19829	Attachment info for this device.
19830	</desc>
19831	</attribute>
19832
19833	<attribute name="message" type="wstring" readonly="yes">
19834	<desc>
19835	Optional error message.
19836	</desc>
19837	</attribute>
19838
19839	</interface>
19840
19841	<interface
19842	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
19843	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
19844	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
19845	>
19846	<desc>
19847	Notification when VBoxSVC becomes unavailable (due to a crash or similar
19848	unexpected circumstances) or available again.
19849	</desc>
19850
19851	<attribute name="available" type="boolean" readonly="yes">
19852	<desc>
19853	Whether VBoxSVC is available now.
19854	</desc>
19855	</attribute>
19856	</interface>
19857
19858	<interface
19859	name="IBandwidthGroupChangedEvent" extends="IEvent"
19860	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
19861	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
19862	>
19863	<desc>
19864	Notification when one of the bandwidth groups changed
19865	</desc>
19866	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
19867	<desc>
19868	The changed bandwidth group.
19869	</desc>
19870	</attribute>
19871	</interface>
19872
19873	<enum
19874	name="GuestMonitorChangedEventType"
19875	uuid="ef172985-7e36-4297-95be-e46396968d66"
19876	>
19877
19878	<desc>
19879	How the guest monitor has been changed.
19880	</desc>
19881
19882	<const name="Enabled" value="0">
19883	<desc>
19884	The guest monitor has been enabled by the guest.
19885	</desc>
19886	</const>
19887
19888	<const name="Disabled" value="1">
19889	<desc>
19890	The guest monitor has been disabled by the guest.
19891	</desc>
19892	</const>
19893
19894	<const name="NewOrigin" value="2">
19895	<desc>
19896	The guest monitor origin has changed in the guest.
19897	</desc>
19898	</const>
19899	</enum>
19900
19901	<interface
19902	name="IGuestMonitorChangedEvent" extends="IEvent"
19903	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
19904	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
19905	>
19906	<desc>
19907	Notification when the guest enables one of its monitors.
19908	</desc>
19909
19910	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
19911	<desc>
19912	What was changed for this guest monitor.
19913	</desc>
19914	</attribute>
19915
19916	<attribute name="screenId" type="unsigned long" readonly="yes">
19917	<desc>
19918	The monitor which was changed.
19919	</desc>
19920	</attribute>
19921
19922	<attribute name="originX" type="unsigned long" readonly="yes">
19923	<desc>
19924	Physical X origin relative to the primary screen.
19925	Valid for Enabled and NewOrigin.
19926	</desc>
19927	</attribute>
19928
19929	<attribute name="originY" type="unsigned long" readonly="yes">
19930	<desc>
19931	Physical Y origin relative to the primary screen.
19932	Valid for Enabled and NewOrigin.
19933	</desc>
19934	</attribute>
19935
19936	<attribute name="width" type="unsigned long" readonly="yes">
19937	<desc>
19938	Width of the screen.
19939	Valid for Enabled.
19940	</desc>
19941	</attribute>
19942
19943	<attribute name="height" type="unsigned long" readonly="yes">
19944	<desc>
19945	Height of the screen.
19946	Valid for Enabled.
19947	</desc>
19948	</attribute>
19949
19950	</interface>
19951
19952	<interface
19953	name="IStorageDeviceChangedEvent" extends="IEvent"
19954	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
19955	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
19956	>
19957	<desc>
19958	Notification when a
19959	<link to="IMachine::mediumAttachments">storage device</link>
19960	is attached or removed.
19961	</desc>
19962	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
19963	<desc>
19964	Storage device that is subject to change.
19965	</desc>
19966	</attribute>
19967	<attribute name="removed" type="boolean" readonly="yes">
19968	<desc>
19969	Flag whether the device was removed or added to the VM.
19970	</desc>
19971	</attribute>
19972	</interface>
19973
19974	<module name="VBoxSVC" context="LocalServer">
19975	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
19976	namespace="virtualbox.org">
19977	<interface name="IVirtualBox" default="yes"/>
19978	</class>
19979	</module>
19980
19981	<module name="VBoxC" context="InprocServer" threadingModel="Free">
19982	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
19983	namespace="virtualbox.org">
19984	<interface name="IVirtualBoxClient" default="yes"/>
19985	</class>
19986
19987	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
19988	namespace="virtualbox.org">
19989	<interface name="ISession" default="yes"/>
19990	</class>
19991	</module>
19992
19993	</library>
19994
19995	</idl>
19996
19997	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format