VirtualBox.xidl@ 31312

Last change on this file since 31312 was 31287, checked in by vboxsync, 15 years ago
Initial API changes for resource control (storage/network/cpu)
Property svn:eol-style set to `native`
File size: 555.0 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2010 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	the VBoxManage command-line interface and the VBoxVRDP server) 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	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). Note that when pointers representing input
275	arguments (such as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum name="SettingsVersion"
388	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
389	>
390	<desc>Settings version of VirtualBox settings files. This is written to
391	the "version" attribute of the root "VirtualBox" element in the settings
392	file XML and indicates which VirtualBox version wrote the file.
393	</desc>
394
395	<const name="Null" value="0">
396	<desc>Null value, indicates invalid version.</desc>
397	</const>
398	<const name="v1_0" value="1">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_1" value="2">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_2" value="3">
405	<desc>Legacy settings version, not currently supported.</desc>
406	</const>
407	<const name="v1_3pre" value="4">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_3" value="5">
411	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
412	<!--
413	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
414	-->
415	</const>
416	<const name="v1_4" value="6">
417	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
418	<!--
419	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
420	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
421	-->
422	</const>
423	<const name="v1_5" value="7">
424	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
425	<!-- 2008-09-04: 2.0.0 released
426	2008-11-20: settings version 1.5 introduced
427	2008-12-17: 2.1.0 released
428	Machine changes:
429	guest OS identifiers changed;
430	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
431	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
432	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
433	-->
434	</const>
435	<const name="v1_6" value="8">
436	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
437	<!-- 2008-12-17: 2.1.0 released
438	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
439	2009-04-08: 2.2.0 released
440	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
441	-->
442	</const>
443	<const name="v1_7" value="9">
444	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
445	<!-- 2008-12-17: 2.1.0 released
446	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
447	2009-04-08: 2.2.0 released
448	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
449	Machine changes: HardDiskAttachments is now StorageControllers (done)
450	-->
451	</const>
452	<const name="v1_8" value="10">
453	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
454	<!-- Machine additions: Display/@accelerate2DVideo (done)
455	-->
456	</const>
457	<const name="v1_9" value="11">
458	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
459	<!-- The big storage controller / DVD / Floppy rework (done)
460	-->
461	</const>
462	<const name="v1_10" value="12">
463	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
464	<!-- Machine changes: RTC localOrUTC (done)
465	CPU hot-plug support
466	-->
467	</const>
468	<const name="v1_11" value="13">
469	<desc>Settings version "1.11", written by VirtualBox 3.3.x.</desc>
470	<!-- Machine changes: HD Audio controller
471	-->
472	</const>
473	<const name="Future" value="99999">
474	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
475	</const>
476	</enum>
477
478	<enum
479	name="AccessMode"
480	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
481	>
482	<desc>
483	Access mode for opening files.
484	</desc>
485
486	<const name="ReadOnly" value="1"/>
487	<const name="ReadWrite" value="2"/>
488	</enum>
489
490	<enum
491	name="MachineState"
492	uuid="e998d075-543a-41fc-8aa9-5ca3e92393fd"
493	>
494	<desc>
495	Virtual machine execution state.
496
497	This enumeration represents possible values of the <link
498	to="IMachine::state"/> attribute.
499
500	Below is the basic virtual machine state diagram. It shows how the state
501	changes during virtual machine execution. The text in square braces shows
502	a method of the IConsole interface that performs the given state
503	transition.
504
505	<pre>
506	+---------[powerDown()] <- Stuck <--[failure]-+
507	V \|
508	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
509	\| \| \| \| V \|
510	\| Aborted -----+ +--> Running --[pause()]--> Paused
511	\| \| ^ \| ^ \|
512	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
513	\| ^ \| \| \| \|
514	\| \| +-----------------------------------------+-\|-------------------+ +
515	\| \| \| \| \|
516	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
517	\| \| \| \|
518	\| +-------- Saving <--------[saveState()]<----------+---------------------+
519	\| \| \|
520	+-------------- Stopping -------[powerDown()]<----------+---------------------+
521	</pre>
522
523	Note that states to the right from PoweredOff, Aborted and Saved in the
524	above diagram are called <i>online VM states</i>. These states
525	represent the virtual machine which is being executed in a dedicated
526	process (usually with a GUI window attached to it where you can see the
527	activity of the virtual machine and interact with it). There are two
528	special pseudo-states, FirstOnline and LastOnline, that can be used in
529	relational expressions to detect if the given machine state is online or
530	not:
531
532	<pre>
533	if (machine.GetState() >= MachineState_FirstOnline &&
534	machine.GetState() <= MachineState_LastOnline)
535	{
536	...the machine is being executed...
537	}
538	</pre>
539
540	When the virtual machine is in one of the online VM states (that is, being
541	executed), only a few machine settings can be modified. Methods working
542	with such settings contain an explicit note about that. An attempt to
543	change any oter setting or perform a modifying operation during this time
544	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
545
546	All online states except Running, Paused and Stuck are transitional: they
547	represent temporary conditions of the virtual machine that will last as
548	long as the operation that initiated such a condition.
549
550	The Stuck state is a special case. It means that execution of the machine
551	has reached the "Guru Meditation" condition. This condition indicates an
552	internal VMM (virtual machine manager) failure which may happen as a
553	result of either an unhandled low-level virtual hardware exception or one
554	of the recompiler exceptions (such as the <i>too-many-traps</i>
555	condition).
556
557	Note also that any online VM state may transit to the Aborted state. This
558	happens if the process that is executing the virtual machine terminates
559	unexpectedly (for example, crashes). Other than that, the Aborted state is
560	equivalent to PoweredOff.
561
562	There are also a few additional state diagrams that do not deal with
563	virtual machine execution and therefore are shown separately. The states
564	shown on these diagrams are called <i>offline VM states</i> (this includes
565	PoweredOff, Aborted and Saved too).
566
567	The first diagram shows what happens when a lengthy setup operation is
568	being executed (such as <link to="IMachine::attachDevice"/>).
569
570	<pre>
571	+----------------------------------(same state as before the call)------+
572	\| \|
573	+-> PoweredOff --+ \|
574	\| \| \|
575	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
576	\| \|
577	+-> Saved -------+
578	</pre>
579
580	The next two diagrams demonstrate the process of taking a snapshot of a
581	powered off virtual machine, restoring the state to that as of a snapshot
582	or deleting a snapshot, respectively.
583
584	<pre>
585	+----------------------------------(same state as before the call)------+
586	\| \|
587	+-> PoweredOff --+ \|
588	\| +-->[takeSnapshot()] -------------------> Saving ------+
589	+-> Aborted -----+
590
591	+-> PoweredOff --+
592	\| \|
593	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
594	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
595	+-> Saved -------+ \|
596	\| \|
597	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
598	</pre>
599
600	Note that the Saving state is present in both the offline state group and
601	online state group. Currently, the only way to determine what group is
602	assumed in a particular case is to remember the previous machine state: if
603	it was Running or Paused, then Saving is an online state, otherwise it is
604	an offline state. This inconsistency may be removed in one of the future
605	versions of VirtualBox by adding a new state.
606
607	<note internal="yes">
608	For whoever decides to touch this enum: In order to keep the
609	comparisons involving FirstOnline and LastOnline pseudo-states valid,
610	the numeric values of these states must be correspondingly updated if
611	needed: for any online VM state, the condition
612	<tt>FirstOnline <= state <= LastOnline</tt> must be
613	@c true. The same relates to transient states for which
614	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
615	@c true.
616	</note>
617	</desc>
618
619	<const name="Null" value="0">
620	<desc>Null value (never used by the API).</desc>
621	</const>
622	<const name="PoweredOff" value="1">
623	<desc>
624	The machine is not running and has no saved execution state; it has
625	either never been started or been shut down successfully.
626	</desc>
627	</const>
628	<const name="Saved" value="2">
629	<desc>
630	The machine is not currently running, but the execution state of the machine
631	has been saved to an external file when it was running, from where
632	it can be resumed.
633	</desc>
634	</const>
635	<const name="Teleported" value="3">
636	<desc>
637	The machine was teleported to a different host (or process) and then
638	powered off. Take care when powering it on again may corrupt resources
639	it shares with the teleportation target (e.g. disk and network).
640	</desc>
641	</const>
642	<const name="Aborted" value="4">
643	<desc>
644	The process running the machine has terminated abnormally. This may
645	indicate a crash of the VM process in host execution context, or
646	the VM process has been terminated externally.
647	</desc>
648	</const>
649	<const name="Running" value="5">
650	<desc>
651	The machine is currently being executed.
652	<note internal="yes">
653	For whoever decides to touch this enum: In order to keep the
654	comparisons in the old source code valid, this state must immediately
655	precede the Paused state.
656	TODO: Lift this spectacularly wonderful restriction.
657	</note>
658	</desc>
659	</const>
660	<const name="Paused" value="6">
661	<desc>
662	Execution of the machine has been paused.
663	<note internal="yes">
664	For whoever decides to touch this enum: In order to keep the
665	comparisons in the old source code valid, this state must immediately
666	follow the Running state.
667	TODO: Lift this spectacularly wonderful restriction.
668	</note>
669	</desc>
670	</const>
671	<const name="Stuck" value="7">
672	<desc>
673	Execution of the machine has reached the "Guru Meditation"
674	condition. This indicates a severe error in the hypervisor itself.
675	<note internal="yes">
676	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
677	"Guru", perhaps? Or are there some other VMM states that are
678	intended to be lumped in here as well?
679	</note>
680	</desc>
681	</const>
682	<const name="Teleporting" value="8">
683	<desc>
684	The machine is about to be teleported to a different host or process.
685	It is possible to pause a machine in this state, but it will go to the
686	@c TeleportingPausedVM state and it will not be
687	possible to resume it again unless the teleportation fails.
688	</desc>
689	</const>
690	<const name="LiveSnapshotting" value="9">
691	<desc>
692	A live snapshot is being taken. The machine is running normally, but
693	some of the runtime configuration options are inaccessible. Also, if
694	paused while in this state it will transition to
695	@c Saving and it will not be resume the
696	execution until the snapshot operation has completed.
697	</desc>
698	</const>
699	<const name="Starting" value="10">
700	<desc>
701	Machine is being started after powering it on from a
702	zero execution state.
703	</desc>
704	</const>
705	<const name="Stopping" value="11">
706	<desc>
707	Machine is being normally stopped powering it off, or after the guest OS
708	has initiated a shutdown sequence.
709	</desc>
710	</const>
711	<const name="Saving" value="12">
712	<desc>
713	Machine is saving its execution state to a file, or an online
714	snapshot of the machine is being taken.
715	</desc>
716	</const>
717	<const name="Restoring" value="13">
718	<desc>
719	Execution state of the machine is being restored from a file
720	after powering it on from the saved execution state.
721	</desc>
722	</const>
723	<const name="TeleportingPausedVM" value="14">
724	<desc>
725	The machine is being teleported to another host or process, but it is
726	not running. This is the paused variant of the
727	@c state.
728	</desc>
729	</const>
730	<const name="TeleportingIn" value="15">
731	<desc>
732	Teleporting the machine state in from another host or process.
733	</desc>
734	</const>
735	<const name="DeletingSnapshotOnline" value="16">
736	<desc>
737	Like @c DeletingSnapshot, but the merging of media is ongoing in
738	the background while the machine is running.
739	</desc>
740	</const>
741	<const name="DeletingSnapshotPaused" value="17">
742	<desc>
743	Like @c DeletingSnapshotOnline, but the machine was paused when the
744	merging of differencing media was started.
745	</desc>
746	</const>
747	<const name="RestoringSnapshot" value="18">
748	<desc>
749	A machine snapshot is being restored; this typically does not take long.
750	</desc>
751	</const>
752	<const name="DeletingSnapshot" value="19">
753	<desc>
754	A machine snapshot is being deleted; this can take a long time since this
755	may require merging differencing media. This value indicates that the
756	machine is not running while the snapshot is being deleted.
757	</desc>
758	</const>
759	<const name="SettingUp" value="20">
760	<desc>
761	Lengthy setup operation is in progress.
762	</desc>
763	</const>
764
765	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
766	<desc>
767	Pseudo-state: first online state (for use in relational expressions).
768	</desc>
769	</const>
770	<const name="LastOnline" value="17" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
771	<desc>
772	Pseudo-state: last online state (for use in relational expressions).
773	</desc>
774	</const>
775
776	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
777	<desc>
778	Pseudo-state: first transient state (for use in relational expressions).
779	</desc>
780	</const>
781	<const name="LastTransient" value="20" wsmap="suppress"> <!-- SettingUp -->
782	<desc>
783	Pseudo-state: last transient state (for use in relational expressions).
784	</desc>
785	</const>
786
787	</enum>
788
789	<enum
790	name="SessionState"
791	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
792	>
793	<desc>
794	Session state. This enumeration represents possible values of
795	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
796	attributes.
797	</desc>
798
799	<const name="Null" value="0">
800	<desc>Null value (never used by the API).</desc>
801	</const>
802	<const name="Unlocked" value="1">
803	<desc>
804	In <link to="IMachine::sessionState"/>, this means that the machine
805	is not locked for any sessions.
806
807	In <link to="ISession::state"/>, this means that no machine is
808	currently locked for this session.
809	</desc>
810	</const>
811	<const name="Locked" value="2">
812	<desc>
813	In <link to="IMachine::sessionState"/>, this means that the machine
814	is currently locked for a session, whose process identifier can
815	then be found in the <link to="IMachine::sessionPid" /> attribute.
816
817	In <link to="ISession::state"/>, this means that a machine is
818	currently locked for this session, and the mutable machine object
819	can be found in the <link to="ISession::machine"/> attribute
820	(see <link to="IMachine::lockMachine" /> for details).
821	</desc>
822	</const>
823	<const name="Spawning" value="3">
824	<desc>
825	A new process is being spawned for the machine as a result of
826	<link to="IMachine::launchVMProcess"/> call. This state also occurs
827	as a short transient state during an <link to="IMachine::lockMachine"/>
828	call.
829	</desc>
830	</const>
831	<const name="Unlocking" value="4">
832	<desc>
833	The session is being unlocked.
834	</desc>
835	</const>
836	</enum>
837
838	<enum
839	name="CPUPropertyType"
840	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
841	>
842	<desc>
843	Virtual CPU property type. This enumeration represents possible values of the
844	IMachine get- and setCPUProperty methods.
845	</desc>
846	<const name="Null" value="0">
847	<desc>Null value (never used by the API).</desc>
848	</const>
849	<const name="PAE" value="1">
850	<desc>
851	This setting determines whether VirtualBox will expose the Physical Address
852	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
853	is not available, it will not be reported.
854	</desc>
855	</const>
856	<const name="Synthetic" value="2">
857	<desc>
858	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
859	teleporting between host systems that differ significantly.
860	</desc>
861	</const>
862	</enum>
863
864
865	<enum
866	name="HWVirtExPropertyType"
867	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
868	>
869	<desc>
870	Hardware virtualization property type. This enumeration represents possible values
871	for the <link to="IMachine::getHWVirtExProperty"/> and
872	<link to="IMachine::setHWVirtExProperty"/> methods.
873	</desc>
874	<const name="Null" value="0">
875	<desc>Null value (never used by the API).</desc>
876	</const>
877	<const name="Enabled" value="1">
878	<desc>
879	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
880	such extensions are not available, they will not be used.
881	</desc>
882	</const>
883	<const name="Exclusive" value="2">
884	<desc>
885	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
886	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
887	feature of the host. To share these with other hypervisors, you must disable this property.
888	</desc>
889	</const>
890	<const name="VPID" value="3">
891	<desc>
892	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
893	</desc>
894	</const>
895	<const name="NestedPaging" value="4">
896	<desc>
897	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
898	</desc>
899	</const>
900	<const name="LargePages" value="5">
901	<desc>
902	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
903	</desc>
904	</const>
905	</enum>
906
907	<enum
908	name="LockType"
909	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
910	>
911	<desc>
912	Used with <link to="IMachine::lockMachine" />.
913	</desc>
914	<const name="Write" value="2">
915	<desc>Lock the machine for writing.</desc>
916	</const>
917	<const name="Shared" value="1">
918	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
919	</const>
920	</enum>
921
922	<enum
923	name="SessionType"
924	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
925	>
926	<desc>
927	Session type. This enumeration represents possible values of the
928	<link to="ISession::type"/> attribute.
929	</desc>
930
931	<const name="Null" value="0">
932	<desc>Null value (never used by the API).</desc>
933	</const>
934	<const name="WriteLock" value="1">
935	<desc>
936	Session has acquired an exclusive write lock on a machine
937	using <link to="IMachine::lockMachine"/>.
938	</desc>
939	</const>
940	<const name="Remote" value="2">
941	<desc>
942	Session has launched a VM process using
943	<link to="IMachine::launchVMProcess"/>
944	</desc>
945	</const>
946	<const name="Shared" value="3">
947	<desc>
948	Session has obtained a link to another session using
949	<link to="IMachine::lockMachine"/>
950	</desc>
951	</const>
952	</enum>
953
954	<enum
955	name="DeviceType"
956	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
957	>
958	<desc>
959	Device type.
960	</desc>
961	<const name="Null" value="0">
962	<desc>
963	Null value, may also mean "no device" (not allowed for
964	<link to="IConsole::getDeviceActivity"/>).
965	</desc>
966	</const>
967	<const name="Floppy" value="1">
968	<desc>Floppy device.</desc>
969	</const>
970	<const name="DVD" value="2">
971	<desc>CD/DVD-ROM device.</desc>
972	</const>
973	<const name="HardDisk" value="3">
974	<desc>Hard disk device.</desc>
975	</const>
976	<const name="Network" value="4">
977	<desc>Network device.</desc>
978	</const>
979	<const name="USB" value="5">
980	<desc>USB device.</desc>
981	</const>
982	<const name="SharedFolder" value="6">
983	<desc>Shared folder device.</desc>
984	</const>
985	</enum>
986
987	<enum
988	name="DeviceActivity"
989	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
990	>
991	<desc>
992	Device activity for <link to="IConsole::getDeviceActivity"/>.
993	</desc>
994
995	<const name="Null" value="0"/>
996	<const name="Idle" value="1"/>
997	<const name="Reading" value="2"/>
998	<const name="Writing" value="3"/>
999	</enum>
1000
1001	<enum
1002	name="ClipboardMode"
1003	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1004	>
1005	<desc>
1006	Host-Guest clipboard interchange mode.
1007	</desc>
1008
1009	<const name="Disabled" value="0"/>
1010	<const name="HostToGuest" value="1"/>
1011	<const name="GuestToHost" value="2"/>
1012	<const name="Bidirectional" value="3"/>
1013	</enum>
1014
1015	<enum
1016	name="Scope"
1017	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1018	>
1019	<desc>
1020	Scope of the operation.
1021
1022	A generic enumeration used in various methods to define the action or
1023	argument scope.
1024	</desc>
1025
1026	<const name="Global" value="0"/>
1027	<const name="Machine" value="1"/>
1028	<const name="Session" value="2"/>
1029	</enum>
1030
1031	<enum
1032	name="BIOSBootMenuMode"
1033	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1034	>
1035	<desc>
1036	BIOS boot menu mode.
1037	</desc>
1038
1039	<const name="Disabled" value="0"/>
1040	<const name="MenuOnly" value="1"/>
1041	<const name="MessageAndMenu" value="2"/>
1042	</enum>
1043
1044	<enum
1045	name="ProcessorFeature"
1046	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1047	>
1048	<desc>
1049	CPU features.
1050	</desc>
1051
1052	<const name="HWVirtEx" value="0"/>
1053	<const name="PAE" value="1"/>
1054	<const name="LongMode" value="2"/>
1055	<const name="NestedPaging" value="3"/>
1056	</enum>
1057
1058	<enum
1059	name="FirmwareType"
1060	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1061	>
1062	<desc>
1063	Firmware type.
1064	</desc>
1065	<const name="BIOS" value="1">
1066	<desc>BIOS Firmware.</desc>
1067	</const>
1068	<const name="EFI" value="2">
1069	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1070	</const>
1071	<const name="EFI32" value="3">
1072	<desc>Efi firmware, 32-bit.</desc>
1073	</const>
1074	<const name="EFI64" value="4">
1075	<desc>Efi firmware, 64-bit.</desc>
1076	</const>
1077	<const name="EFIDUAL" value="5">
1078	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1079	</const>
1080	</enum>
1081
1082	<enum
1083	name="PointingHidType"
1084	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1085	>
1086	<desc>
1087	Type of pointing device used in a virtual machine.
1088	</desc>
1089	<const name="None" value="1">
1090	<desc>No mouse.</desc>
1091	</const>
1092	<const name="PS2Mouse" value="2">
1093	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1094	</const>
1095	<const name="USBMouse" value="3">
1096	<desc>USB mouse (relative pointer).</desc>
1097	</const>
1098	<const name="USBTablet" value="4">
1099	<desc>USB tablet (absolute pointer).</desc>
1100	</const>
1101	<const name="ComboMouse" value="5">
1102	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1103	Using of such device can have negative performance implications. </desc>
1104	</const>
1105	</enum>
1106
1107	<enum
1108	name="KeyboardHidType"
1109	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1110	>
1111	<desc>
1112	Type of keyboard device used in a virtual machine.
1113	</desc>
1114	<const name="None" value="1">
1115	<desc>No keyboard.</desc>
1116	</const>
1117	<const name="PS2Keyboard" value="2">
1118	<desc>PS/2 keyboard.</desc>
1119	</const>
1120	<const name="USBKeyboard" value="3">
1121	<desc>USB keyboard.</desc>
1122	</const>
1123	<const name="ComboKeyboard" value="4">
1124	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1125	Using of such device can have negative performance implications. </desc>
1126	</const>
1127	</enum>
1128
1129	<!--
1130	// IVirtualBoxErrorInfo
1131	/////////////////////////////////////////////////////////////////////////
1132	-->
1133
1134	<interface
1135	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1136	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1137	supportsErrorInfo="no"
1138	wsmap="managed"
1139	>
1140	<desc>
1141	The IVirtualBoxErrorInfo interface represents extended error information.
1142
1143	Extended error information can be set by VirtualBox components after
1144	unsuccessful or partially successful method invocation. This information
1145	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1146	and then shown to the client in addition to the plain 32-bit result code.
1147
1148	In MS COM, this interface extends the IErrorInfo interface,
1149	in XPCOM, it extends the nsIException interface. In both cases,
1150	it provides a set of common attributes to retrieve error
1151	information.
1152
1153	Sometimes invocation of some component's method may involve methods of
1154	other components that may also fail (independently of this method's
1155	failure), or a series of non-fatal errors may precede a fatal error that
1156	causes method failure. In cases like that, it may be desirable to preserve
1157	information about all errors happened during method invocation and deliver
1158	it to the caller. The <link to="#next"/> attribute is intended
1159	specifically for this purpose and allows to represent a chain of errors
1160	through a single IVirtualBoxErrorInfo object set after method invocation.
1161
1162	Note that errors are stored to a chain in the reverse order, i.e. the
1163	initial error object you query right after method invocation is the last
1164	error set by the callee, the object it points to in the @a next attribute
1165	is the previous error and so on, up to the first error (which is the last
1166	in the chain).
1167	</desc>
1168
1169	<attribute name="resultCode" type="long" readonly="yes">
1170	<desc>
1171	Result code of the error.
1172	Usually, it will be the same as the result code returned
1173	by the method that provided this error information, but not
1174	always. For example, on Win32, CoCreateInstance() will most
1175	likely return E_NOINTERFACE upon unsuccessful component
1176	instantiation attempt, but not the value the component factory
1177	returned. Value is typed 'long', not 'result',
1178	to make interface usable from scripting languages.
1179	<note>
1180	In MS COM, there is no equivalent.
1181	In XPCOM, it is the same as nsIException::result.
1182	</note>
1183	</desc>
1184	</attribute>
1185
1186	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1187	<desc>
1188	UUID of the interface that defined the error.
1189	<note>
1190	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1191	data type.
1192	In XPCOM, there is no equivalent.
1193	</note>
1194	</desc>
1195	</attribute>
1196
1197	<attribute name="component" type="wstring" readonly="yes">
1198	<desc>
1199	Name of the component that generated the error.
1200	<note>
1201	In MS COM, it is the same as IErrorInfo::GetSource.
1202	In XPCOM, there is no equivalent.
1203	</note>
1204	</desc>
1205	</attribute>
1206
1207	<attribute name="text" type="wstring" readonly="yes">
1208	<desc>
1209	Text description of the error.
1210	<note>
1211	In MS COM, it is the same as IErrorInfo::GetDescription.
1212	In XPCOM, it is the same as nsIException::message.
1213	</note>
1214	</desc>
1215	</attribute>
1216
1217	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1218	<desc>
1219	Next error object if there is any, or @c null otherwise.
1220	<note>
1221	In MS COM, there is no equivalent.
1222	In XPCOM, it is the same as nsIException::inner.
1223	</note>
1224	</desc>
1225	</attribute>
1226
1227	</interface>
1228
1229	<!--
1230	// IVirtualBox
1231	/////////////////////////////////////////////////////////////////////////
1232	-->
1233
1234	<interface
1235	name="IDHCPServer" extends="$unknown"
1236	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1237	wsmap="managed"
1238	>
1239	<desc>
1240	The IDHCPServer interface represents the vbox dhcp server configuration.
1241
1242	To enumerate all the dhcp servers on the host, use the
1243	<link to="IVirtualBox::DHCPServers"/> attribute.
1244	</desc>
1245
1246	<attribute name="enabled" type="boolean">
1247	<desc>
1248	specifies if the dhcp server is enabled
1249	</desc>
1250	</attribute>
1251
1252	<attribute name="IPAddress" type="wstring" readonly="yes">
1253	<desc>
1254	specifies server IP
1255	</desc>
1256	</attribute>
1257
1258	<attribute name="networkMask" type="wstring" readonly="yes">
1259	<desc>
1260	specifies server network mask
1261	</desc>
1262	</attribute>
1263
1264	<attribute name="networkName" type="wstring" readonly="yes">
1265	<desc>
1266	specifies internal network name the server is used for
1267	</desc>
1268	</attribute>
1269
1270	<attribute name="lowerIP" type="wstring" readonly="yes">
1271	<desc>
1272	specifies from IP adrres in server address range
1273	</desc>
1274	</attribute>
1275
1276	<attribute name="upperIP" type="wstring" readonly="yes">
1277	<desc>
1278	specifies to IP adrres in server address range
1279	</desc>
1280	</attribute>
1281
1282	<method name="setConfiguration">
1283	<desc>
1284	configures the server
1285	<result name="E_INVALIDARG">
1286	invalid configuration supplied
1287	</result>
1288	</desc>
1289	<param name="IPAddress" type="wstring" dir="in">
1290	<desc>
1291	server IP address
1292	</desc>
1293	</param>
1294	<param name="networkMask" type="wstring" dir="in">
1295	<desc>
1296	server network mask
1297	</desc>
1298	</param>
1299	<param name="FromIPAddress" type="wstring" dir="in">
1300	<desc>
1301	server From IP address for address range
1302	</desc>
1303	</param>
1304	<param name="ToIPAddress" type="wstring" dir="in">
1305	<desc>
1306	server To IP address for address range
1307	</desc>
1308	</param>
1309	</method>
1310
1311	<method name="start">
1312	<desc>
1313	Starts DHCP server process.
1314	<result name="E_FAIL">
1315	Failed to start the process.
1316	</result>
1317	</desc>
1318	<param name="networkName" type="wstring" dir="in">
1319	<desc>
1320	Name of internal network DHCP server should attach to.
1321	</desc>
1322	</param>
1323	<param name="trunkName" type="wstring" dir="in">
1324	<desc>
1325	Name of internal network trunk.
1326	</desc>
1327	</param>
1328	<param name="trunkType" type="wstring" dir="in">
1329	<desc>
1330	Type of internal network trunk.
1331	</desc>
1332	</param>
1333	</method>
1334
1335	<method name="stop">
1336	<desc>
1337	Stops DHCP server process.
1338	<result name="E_FAIL">
1339	Failed to stop the process.
1340	</result>
1341	</desc>
1342	</method>
1343	</interface>
1344
1345	<interface
1346	name="IVirtualBox" extends="$unknown"
1347	uuid="ec6cc7e7-06a2-4c5d-8993-1e3619c53817"
1348	wsmap="managed"
1349	>
1350	<desc>
1351	The IVirtualBox interface represents the main interface exposed by the
1352	product that provides virtual machine management.
1353
1354	An instance of IVirtualBox is required for the product to do anything
1355	useful. Even though the interface does not expose this, internally,
1356	IVirtualBox is implemented as a singleton and actually lives in the
1357	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1358	IVirtualBox can track the state of all virtual machines on a particular
1359	host, regardless of which frontend started them.
1360
1361	To enumerate all the virtual machines on the host, use the
1362	<link to="IVirtualBox::machines"/> attribute.
1363	</desc>
1364
1365	<attribute name="version" type="wstring" readonly="yes">
1366	<desc>
1367	A string representing the version number of the product. The
1368	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1369	last number represents the build number and will frequently change.
1370	</desc>
1371	</attribute>
1372
1373	<attribute name="revision" type="unsigned long" readonly="yes">
1374	<desc>
1375	The internal build revision number of the product.
1376	</desc>
1377	</attribute>
1378
1379	<attribute name="packageType" type="wstring" readonly="yes">
1380	<desc>
1381	A string representing the package type of this product. The
1382	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1383	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1384	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1385	this.
1386	</desc>
1387	</attribute>
1388
1389	<attribute name="homeFolder" type="wstring" readonly="yes">
1390	<desc>
1391	Full path to the directory where the global settings file,
1392	<tt>VirtualBox.xml</tt>, is stored.
1393
1394	In this version of VirtualBox, the value of this property is
1395	always <tt><user_dir>/.VirtualBox</tt> (where
1396	<tt><user_dir></tt> is the path to the user directory,
1397	as determined by the host OS), and cannot be changed.
1398
1399	This path is also used as the base to resolve relative paths in
1400	places where relative paths are allowed (unless otherwise
1401	expressly indicated).
1402	</desc>
1403	</attribute>
1404
1405	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1406	<desc>
1407	Full name of the global settings file.
1408	The value of this property corresponds to the value of
1409	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1410	</desc>
1411	</attribute>
1412
1413	<attribute name="host" type="IHost" readonly="yes">
1414	<desc>Associated host object.</desc>
1415	</attribute>
1416
1417	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1418	<desc>Associated system information object.</desc>
1419	</attribute>
1420
1421	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1422	<desc>
1423	Array of machine objects registered within this VirtualBox instance.
1424	</desc>
1425	</attribute>
1426
1427	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1428	<desc>
1429	Array of medium objects known to this VirtualBox installation.
1430
1431	This array contains only base media. All differencing
1432	media of the given base medium can be enumerated using
1433	<link to="IMedium::children"/>.
1434	</desc>
1435	</attribute>
1436
1437	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1438	<desc>
1439	Array of CD/DVD image objects registered with this VirtualBox instance.
1440	</desc>
1441	</attribute>
1442
1443	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1444	<desc>
1445	Array of floppy image objects registered with this VirtualBox instance.
1446	</desc>
1447	</attribute>
1448
1449	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1450
1451	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1452
1453	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1454	<desc>
1455	Collection of global shared folders. Global shared folders are
1456	available to all virtual machines.
1457
1458	New shared folders are added to the collection using
1459	<link to="#createSharedFolder"/>. Existing shared folders can be
1460	removed using <link to="#removeSharedFolder"/>.
1461
1462	<note>
1463	In the current version of the product, global shared folders are not
1464	implemented and therefore this collection is always empty.
1465	</note>
1466	</desc>
1467	</attribute>
1468
1469	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1470	<desc>
1471	Associated performance collector object.
1472	</desc>
1473	</attribute>
1474
1475	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1476	<desc>
1477	dhcp server settings.
1478	</desc>
1479	</attribute>
1480
1481	<attribute name="eventSource" type="IEventSource" readonly="yes">
1482	<desc>
1483	Event source for VirtualBox events.
1484	</desc>
1485	</attribute>
1486
1487
1488	<method name="createMachine">
1489	<desc>
1490	Creates a new virtual machine.
1491
1492	The new machine is created unregistered, with the initial configuration
1493	set according to the specified guest OS type. A typical sequence of
1494	actions to create a new virtual machine is as follows:
1495
1496	<ol>
1497	<li>
1498	Call this method to have a new machine created. The returned machine
1499	object will be "mutable" allowing to change any machine property.
1500	</li>
1501
1502	<li>
1503	Configure the machine using the appropriate attributes and methods.
1504	</li>
1505
1506	<li>
1507	Call <link to="IMachine::saveSettings" /> to write the settings
1508	to the machine's XML settings file. The configuration of the newly
1509	created machine will not be saved to disk until this method is
1510	called.
1511	</li>
1512
1513	<li>
1514	Call <link to="#registerMachine" /> to add the machine to the list
1515	of machines known to VirtualBox.
1516	</li>
1517	</ol>
1518
1519	You should specify valid name for the newly created machine when calling
1520	this method. See the <link to="IMachine::name"/> attribute description
1521	for more details about the machine name.
1522
1523	The specified guest OS type identifier must match an ID of one of known
1524	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1525	array.
1526
1527	Every machine has a <i>settings file</i> that is used to store
1528	the machine configuration. This file is stored in a directory called the
1529	<i>machine settings subfolder</i>. Both the settings subfolder and file
1530	will have a name that corresponds to the name of the virtual machine.
1531	You can specify where to create the machine setting subfolder using the
1532	@a baseFolder argument. The base folder can be absolute (full path) or
1533	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1534	directory</link>.
1535
1536	If @a baseFolder is a @c null or empty string (which is recommended), the
1537	<link to="ISystemProperties::defaultMachineFolder">default machine
1538	settings folder</link> will be used as a base folder for the created
1539	machine. Otherwise the given base folder will be used. In either case,
1540	the full path to the resulting settings file has the following
1541	structure:
1542	<pre>
1543	<base_folder>/<machine_name>/<machine_name>.xml
1544	</pre>
1545
1546	Note that if the resulting settings file already exists, this method
1547	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1548
1549	Optionally, you may specify an UUID of to assign to the created machine.
1550	However, this is not recommended and you should normally pass an empty
1551	(@c null) UUID to this method so that a new UUID will be automatically
1552	generated for every created machine. You can use UUID
1553	00000000-0000-0000-0000-000000000000 as @c null value.
1554
1555	<note>
1556	There is no way to change the name of the settings file or
1557	subfolder of the created machine directly.
1558	</note>
1559
1560	<result name="VBOX_E_OBJECT_NOT_FOUND">
1561	@a osTypeId is invalid.
1562	</result>
1563	<result name="VBOX_E_FILE_ERROR">
1564	Resulting settings file name is invalid or the settings file already
1565	exists or could not be created due to an I/O error.
1566	</result>
1567	<result name="E_INVALIDARG">
1568	@a name is empty or @c null.
1569	</result>
1570	</desc>
1571
1572	<param name="name" type="wstring" dir="in">
1573	<desc>Machine name.</desc>
1574	</param>
1575	<param name="osTypeId" type="wstring" dir="in">
1576	<desc>Guest OS Type ID.</desc>
1577	</param>
1578	<param name="baseFolder" type="wstring" dir="in">
1579	<desc>Base machine folder (optional).</desc>
1580	</param>
1581	<param name="id" type="uuid" mod="string" dir="in">
1582	<desc>Machine UUID (optional).</desc>
1583	</param>
1584	<param name="override" type="boolean" dir="in">
1585	<desc>Create the VM even if there are conflicting files.</desc>
1586	</param>
1587	<param name="machine" type="IMachine" dir="return">
1588	<desc>Created machine object.</desc>
1589	</param>
1590	</method>
1591
1592	<method name="createLegacyMachine">
1593	<desc>
1594	Creates a new virtual machine in "legacy" mode, using the specified
1595	settings file to store machine settings.
1596
1597	As opposed to machines created by <link to="#createMachine"/>,
1598	the settings file of the machine created in "legacy" mode is not
1599	automatically renamed when the machine name is changed -- it will always
1600	remain the same as specified in this method call.
1601
1602	The specified settings file name can be absolute (full path) or relative
1603	to the <link to="IVirtualBox::homeFolder">VirtualBox home
1604	directory</link>. If the file name doesn't contain an extension, the
1605	default extension (.xml) will be appended.
1606
1607	Note that the configuration of the newly created machine is not
1608	saved to disk (and therefore no settings file is created)
1609	until <link to="IMachine::saveSettings"/> is called. If the
1610	specified settings file already exists, this method
1611	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1612
1613	See <link to="#createMachine"/> for more information.
1614
1615	@deprecated This method may be removed later. Use <link
1616	to="IVirtualBox::createMachine"/> instead.
1617
1618	<note>
1619	There is no way to change the name of the settings file
1620	of the machine created in "legacy" mode.
1621	</note>
1622
1623	<result name="VBOX_E_OBJECT_NOT_FOUND">
1624	@a osTypeId is invalid.
1625	</result>
1626	<result name="VBOX_E_FILE_ERROR">
1627	@a settingsFile is invalid or the settings file already exists or
1628	could not be created due to an I/O error.
1629	</result>
1630	<result name="E_INVALIDARG">
1631	@a name or @a settingsFile is empty or @c null.
1632	</result>
1633	</desc>
1634
1635	<param name="name" type="wstring" dir="in">
1636	<desc>Machine name.</desc>
1637	</param>
1638	<param name="osTypeId" type="wstring" dir="in">
1639	<desc>Machine OS Type ID.</desc>
1640	</param>
1641	<param name="settingsFile" type="wstring" dir="in">
1642	<desc>Name of the machine settings file.</desc>
1643	</param>
1644	<param name="id" type="uuid" mod="string" dir="in">
1645	<desc>Machine UUID (optional).</desc>
1646	</param>
1647	<param name="machine" type="IMachine" dir="return">
1648	<desc>Created machine object.</desc>
1649	</param>
1650	</method>
1651
1652	<method name="openMachine">
1653	<desc>
1654	Opens a virtual machine from the existing settings file.
1655	The opened machine remains unregistered until you call
1656	<link to="#registerMachine"/>.
1657
1658	The specified settings file name can be absolute
1659	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1660	VirtualBox home directory</link>. This file must exist
1661	and must be a valid machine settings file whose contents
1662	will be used to construct the machine object.
1663
1664	@deprecated Will be removed soon.
1665	<result name="VBOX_E_FILE_ERROR">
1666	Settings file name invalid, not found or sharing violation.
1667	</result>
1668	</desc>
1669	<param name="settingsFile" type="wstring" dir="in">
1670	<desc>
1671	Name of the machine settings file.
1672	</desc>
1673	</param>
1674	<param name="machine" type="IMachine" dir="return">
1675	<desc>Opened machine object.</desc>
1676	</param>
1677	<note>
1678	<link to="IMachine::settingsModified"/> will return
1679	@c false for the created machine, until any of machine settings
1680	are changed.
1681	</note>
1682	</method>
1683
1684	<method name="registerMachine">
1685	<desc>
1686
1687	Registers the machine previously created using
1688	<link to="#createMachine"/> or opened using
1689	<link to="#openMachine"/> within this VirtualBox installation. After
1690	successful method invocation, the
1691	<link to="IMachineRegisteredEvent"/> event is fired.
1692
1693	<note>
1694	This method implicitly calls <link to="IMachine::saveSettings"/>
1695	to save all current machine settings before registering it.
1696	</note>
1697
1698	<result name="VBOX_E_OBJECT_NOT_FOUND">
1699	No matching virtual machine found.
1700	</result>
1701	<result name="VBOX_E_INVALID_OBJECT_STATE">
1702	Virtual machine was not created within this VirtualBox instance.
1703	</result>
1704
1705	</desc>
1706	<param name="machine" type="IMachine" dir="in"/>
1707	</method>
1708
1709	<method name="getMachine">
1710	<desc>
1711	Attempts to find a virtual machine given its UUID.
1712	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1713	instead.
1714
1715	<result name="VBOX_E_OBJECT_NOT_FOUND">
1716	Could not find registered machine matching @a id.
1717	</result>
1718
1719	</desc>
1720	<param name="id" type="uuid" mod="string" dir="in"/>
1721	<param name="machine" type="IMachine" dir="return"/>
1722	</method>
1723
1724	<method name="findMachine">
1725	<desc>
1726	Attempts to find a virtual machine given its name.
1727	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1728	instead.
1729
1730	<result name="VBOX_E_OBJECT_NOT_FOUND">
1731	Could not find registered machine matching @a name.
1732	</result>
1733
1734	</desc>
1735	<param name="name" type="wstring" dir="in"/>
1736	<param name="machine" type="IMachine" dir="return"/>
1737	</method>
1738
1739	<method name="createAppliance">
1740	<desc>
1741	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1742	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1743	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1744	</desc>
1745	<param name="appliance" type="IAppliance" dir="return">
1746	<desc>New appliance.</desc>
1747	</param>
1748	</method>
1749
1750	<method name="createHardDisk">
1751	<desc>
1752	Creates a new base medium object that will use the given storage
1753	format and location for medium data.
1754
1755	Note that the actual storage unit is not created by this method. In
1756	order to do it, and before you are able to attach the created medium
1757	to virtual machines, you must call one of the following methods to
1758	allocate a format-specific storage unit at the specified location:
1759	<ul>
1760	<li><link to="IMedium::createBaseStorage"/></li>
1761	<li><link to="IMedium::createDiffStorage"/></li>
1762	</ul>
1763
1764	Some medium attributes, such as <link to="IMedium::id"/>, may
1765	remain uninitialized until the medium storage unit is successfully
1766	created by one of the above methods.
1767
1768	After the storage unit is successfully created, the medium gets
1769	remembered by this VirtualBox installation and will be accessible
1770	through <link to="#getHardDisk"/> and <link to="#findHardDisk"/>
1771	methods. Remembered base medium are also returned as part of
1772	the <link to="#hardDisks"/> array. See IMedium for more details.
1773
1774	The list of all storage formats supported by this VirtualBox
1775	installation can be obtained using
1776	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1777	attribute is empty or @c null then the default storage format
1778	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1779	be used for creating a storage unit of the medium.
1780
1781	Note that the format of the location string is storage format specific.
1782	See <link to="IMedium::location"/>, IMedium and
1783	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1784
1785	<result name="VBOX_E_OBJECT_NOT_FOUND">
1786	@a format identifier is invalid. See
1787	<link to="ISystemProperties::mediumFormats"/>.
1788	</result>
1789	<result name="VBOX_E_FILE_ERROR">
1790	@a location is a not valid file name (for file-based formats only).
1791	</result>
1792	</desc>
1793	<param name="format" type="wstring" dir="in">
1794	<desc>
1795	Identifier of the storage format to use for the new medium.
1796	</desc>
1797	</param>
1798	<param name="location" type="wstring" dir="in">
1799	<desc>
1800	Location of the storage unit for the new medium.
1801	</desc>
1802	</param>
1803	<param name="medium" type="IMedium" dir="return">
1804	<desc>Created medium object.</desc>
1805	</param>
1806	</method>
1807
1808	<method name="openHardDisk">
1809	<desc>
1810	Opens a medium from an existing location, optionally replacing
1811	the image UUID and/or parent UUID.
1812
1813	After the medium is successfully opened by this method, it gets
1814	remembered by (known to) this VirtualBox installation and will be
1815	accessible through <link to="#getHardDisk"/> and
1816	<link to="#findHardDisk"/> methods. Remembered base media
1817	are also returned as part of the <link to="#hardDisks"/> array and can
1818	be attached to virtual machines. See IMedium for more details.
1819
1820	If a differencing medium is to be opened by this method, the
1821	operation will succeed only if its parent medium and all ancestors,
1822	if any, are already known to this VirtualBox installation (for example,
1823	were opened by this method before).
1824
1825	This method tries to guess the storage format of the specified medium
1826	by reading medium data at the specified location.
1827
1828	If @a accessMode is ReadWrite (which it should be), the image is opened
1829	for read/write access and must have according permissions, as VirtualBox
1830	may actually write status information into the disk's metadata sections.
1831
1832	Note that write access is required for all typical image usage in VirtualBox,
1833	since VirtualBox may need to write metadata such as a UUID into the image.
1834	The only exception is opening a source image temporarily for copying and
1835	cloning when the image will quickly be closed again.
1836
1837	Note that the format of the location string is storage format specific.
1838	See <link to="IMedium::location"/>, IMedium and
1839	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1840
1841	<result name="VBOX_E_FILE_ERROR">
1842	Invalid medium storage file location or could not find the medium
1843	at the specified location.
1844	</result>
1845	<result name="VBOX_E_IPRT_ERROR">
1846	Could not get medium storage format.
1847	</result>
1848	<result name="E_INVALIDARG">
1849	Invalid medium storage format.
1850	</result>
1851
1852	</desc>
1853	<param name="location" type="wstring" dir="in">
1854	<desc>
1855	Location of the storage unit that contains medium data in one of
1856	the supported storage formats.
1857	</desc>
1858	</param>
1859	<param name="accessMode" type="AccessMode" dir="in">
1860	<desc>
1861	Determines whether to open the image in read/write or read-only mode.
1862	</desc>
1863	</param>
1864	<param name="setImageId" type="boolean" dir="in">
1865	<desc>
1866	Select whether a new image UUID is set or not.
1867	</desc>
1868	</param>
1869	<param name="imageId" type="uuid" mod="string" dir="in">
1870	<desc>
1871	New UUID for the image. If an empty string is passed, then a new
1872	UUID is automatically created. Specifying a zero UUIDs is not valid.
1873	</desc>
1874	</param>
1875	<param name="setParentId" type="boolean" dir="in">
1876	<desc>
1877	Select whether a new parent UUID is set or not.
1878	</desc>
1879	</param>
1880	<param name="parentId" type="uuid" mod="string" dir="in">
1881	<desc>
1882	New parent UUID for the image. If an empty string is passed, then a
1883	new UUID is automatically created, provided @a setParentId is
1884	@c true. A zero UUID is valid.
1885	</desc>
1886	</param>
1887	<param name="medium" type="IMedium" dir="return">
1888	<desc>Opened medium object.</desc>
1889	</param>
1890	</method>
1891
1892	<method name="getHardDisk" const="yes">
1893	<desc>
1894	Returns a medium with the given UUID.
1895
1896	The medium with the given UUID must be known to this VirtualBox
1897	installation, i.e. it must be previously created by
1898	<link to="#createHardDisk"/> or opened by <link
1899	to="#openHardDisk"/>, or attached to some known virtual machine.
1900
1901	<result name="VBOX_E_OBJECT_NOT_FOUND">
1902	No medium object matching @a id found.
1903	</result>
1904
1905	</desc>
1906	<param name="id" type="uuid" mod="string" dir="in">
1907	<desc>UUID of the medium to look for.</desc>
1908	</param>
1909	<param name="medium" type="IMedium" dir="return">
1910	<desc>Found medium object.</desc>
1911	</param>
1912	</method>
1913
1914	<method name="findHardDisk">
1915	<desc>
1916	Returns a medium that uses the given location to store medium data.
1917
1918	The given medium must be known to this VirtualBox installation, i.e.
1919	it must be previously created by
1920	<link to="#createHardDisk"/> or opened by <link
1921	to="#openHardDisk"/>, or attached to some known virtual machine.
1922
1923	The search is done by comparing the value of the @a location argument to
1924	the <link to="IMedium::location"/> attribute of each known medium.
1925
1926	For locations represented by file names in the host's file system, the
1927	requested location can be a path relative to the
1928	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
1929	only a file name without any path is given, the
1930	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
1931	folder</link> will be prepended to the file name before searching. Note
1932	that on case sensitive file systems, a case sensitive comparison is
1933	performed, otherwise the case of symbols in the file path is ignored.
1934
1935	<result name="VBOX_E_OBJECT_NOT_FOUND">
1936	No medium object matching @a location found.
1937	</result>
1938
1939	</desc>
1940	<param name="location" type="wstring" dir="in">
1941	<desc>Location string to search for.</desc>
1942	</param>
1943	<param name="medium" type="IMedium" dir="return">
1944	<desc>Found medium object.</desc>
1945	</param>
1946	</method>
1947
1948	<method name="openDVDImage">
1949	<desc>
1950	Opens a CD/DVD image contained in the specified file of the supported
1951	format and assigns it the given UUID.
1952
1953	After the image is successfully opened by this method, it gets
1954	remembered by (known to) this VirtualBox installation and will be
1955	accessible through <link to="#getDVDImage"/> and
1956	<link to="#findDVDImage"/> methods. Remembered images are also
1957	returned as part of the <link to="#DVDImages"/> array and can be mounted
1958	to virtual machines. See IMedium for more details.
1959
1960	See <link to="IMedium::location"/> to get more details about the format
1961	of the location string.
1962
1963	<note>
1964	Currently only ISO 9960 CD/DVD images are supported by VirtualBox.
1965	</note>
1966
1967	<result name="VBOX_E_FILE_ERROR">
1968	Invalid CD/DVD image file location or could not find the CD/DVD
1969	image at the specified location.
1970	</result>
1971	<result name="VBOX_E_INVALID_OBJECT_STATE">
1972	CD/DVD image already exists in the media registry.
1973	</result>
1974
1975	</desc>
1976	<param name="location" type="wstring" dir="in">
1977	<desc>
1978	Full path to the file that contains a valid CD/DVD image.
1979	</desc>
1980	</param>
1981	<param name="id" type="uuid" mod="string" dir="in">
1982	<desc>
1983	UUID to assign to the given image within this VirtualBox installation.
1984	If an empty (@c null) UUID is specified, the system will randomly
1985	generate a new UUID.
1986	</desc>
1987	</param>
1988	<param name="image" type="IMedium" dir="return">
1989	<desc>Opened CD/DVD image object.</desc>
1990	</param>
1991	</method>
1992
1993	<method name="getDVDImage">
1994	<desc>
1995	Returns a CD/DVD image with the given UUID.
1996
1997	The image with the given UUID must be known to this VirtualBox
1998	installation, i.e. it must be previously opened by <link
1999	to="#openDVDImage"/>, or mounted to some known virtual machine.
2000
2001	<result name="VBOX_E_OBJECT_NOT_FOUND">
2002	No matching DVD image found in the media registry.
2003	</result>
2004
2005	</desc>
2006	<param name="id" type="uuid" mod="string" dir="in">
2007	<desc>UUID of the image to look for.</desc>
2008	</param>
2009	<param name="image" type="IMedium" dir="return">
2010	<desc>Found CD/DVD image object.</desc>
2011	</param>
2012	</method>
2013
2014	<method name="findDVDImage">
2015	<desc>
2016	Returns a CD/DVD image with the given image location.
2017
2018	The image with the given UUID must be known to this VirtualBox
2019	installation, i.e. it must be previously opened by <link
2020	to="#openDVDImage"/>, or mounted to some known virtual machine.
2021
2022	The search is done by comparing the value of the @a location argument to
2023	the <link to="IMedium::location"/> attribute of each known CD/DVD image.
2024
2025	The requested location can be a path relative to the
2026	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2027	only a file name without any path is given, the
2028	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2029	folder</link> will be prepended to the file name before searching. Note
2030	that on case sensitive file systems, a case sensitive comparison is
2031	performed, otherwise the case in the file path is ignored.
2032
2033	<result name="VBOX_E_FILE_ERROR">
2034	Invalid image file location.
2035	</result>
2036	<result name="VBOX_E_OBJECT_NOT_FOUND">
2037	No matching DVD image found in the media registry.
2038	</result>
2039
2040	</desc>
2041	<param name="location" type="wstring" dir="in">
2042	<desc>CD/DVD image file path to look for.</desc>
2043	</param>
2044	<param name="image" type="IMedium" dir="return">
2045	<desc>Found CD/DVD image object.</desc>
2046	</param>
2047	</method>
2048
2049	<method name="openFloppyImage">
2050	<desc>
2051	Opens a floppy image contained in the specified file of the supported
2052	format and assigns it the given UUID.
2053
2054	After the image is successfully opened by this method, it gets
2055	remembered by (known to) this VirtualBox installation and will be
2056	accessible through <link to="#getFloppyImage"/> and
2057	<link to="#findFloppyImage"/> methods. Remembered images are also
2058	returned as part of the <link to="#floppyImages"/> array and can be
2059	mounted to virtual machines. See IMedium for more details.
2060
2061	See <link to="IMedium::location"/> to get more details about the format
2062	of the location string.
2063
2064	<result name="VBOX_E_FILE_ERROR">
2065	Invalid floppy image file location or could not find the floppy
2066	image at the specified location.
2067	</result>
2068	<result name="VBOX_E_INVALID_OBJECT_STATE">
2069	Floppy image already exists in the media registry.
2070	</result>
2071
2072	<note>
2073	Currently, only raw floppy images are supported by VirtualBox.
2074	</note>
2075	</desc>
2076	<param name="location" type="wstring" dir="in">
2077	<desc>
2078	Full path to the file that contains a valid floppy image.
2079	</desc>
2080	</param>
2081	<param name="id" type="uuid" mod="string" dir="in">
2082	<desc>
2083	UUID to assign to the given image file within this VirtualBox
2084	installation. If an empty (@c null) UUID is specified, the system will
2085	randomly generate a new UUID.
2086	</desc>
2087	</param>
2088	<param name="image" type="IMedium" dir="return">
2089	<desc>Opened floppy image object.</desc>
2090	</param>
2091	</method>
2092
2093	<method name="getFloppyImage">
2094	<desc>
2095	Returns a floppy image with the given UUID.
2096
2097	The image with the given UUID must be known to this VirtualBox
2098	installation, i.e. it must be previously opened by <link
2099	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2100
2101	<result name="VBOX_E_OBJECT_NOT_FOUND">
2102	No matching floppy image found in the media registry.
2103	</result>
2104
2105	</desc>
2106	<param name="id" type="uuid" mod="string" dir="in">
2107	<desc>UUID of the image to look for.</desc>
2108	</param>
2109	<param name="image" type="IMedium" dir="return">
2110	<desc>Found floppy image object.</desc>
2111	</param>
2112	</method>
2113
2114	<method name="findFloppyImage">
2115	<desc>
2116	Returns a floppy image with the given image location.
2117
2118	The image with the given UUID must be known to this VirtualBox
2119	installation, i.e. it must be previously opened by <link
2120	to="#openFloppyImage"/>, or mounted to some known virtual machine.
2121
2122	The search is done by comparing the value of the @a location argument to
2123	the <link to="IMedium::location"/> attribute of each known floppy image.
2124
2125	The requested location can be a path relative to the
2126	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
2127	only a file name without any path is given, the
2128	<link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
2129	folder</link> will be prepended to the file name before searching. Note
2130	that on case sensitive file systems, a case sensitive comparison is
2131	performed, otherwise the case of symbols in the file path is ignored.
2132
2133	<result name="VBOX_E_FILE_ERROR">
2134	Invalid image file location.
2135	</result>
2136	<result name="VBOX_E_OBJECT_NOT_FOUND">
2137	No matching floppy image found in the media registry.
2138	</result>
2139
2140	</desc>
2141	<param name="location" type="wstring" dir="in">
2142	<desc>Floppy image file path to look for.</desc>
2143	</param>
2144	<param name="image" type="IMedium" dir="return">
2145	<desc>Found floppy image object.</desc>
2146	</param>
2147	</method>
2148
2149	<method name="getGuestOSType">
2150	<desc>
2151	Returns an object describing the specified guest OS type.
2152
2153	The requested guest OS type is specified using a string which is a
2154	mnemonic identifier of the guest operating system, such as
2155	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2156	particular virtual machine can be read or set using the
2157	<link to="IMachine::OSTypeId"/> attribute.
2158
2159	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2160	available guest OS type objects. Each object has an
2161	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2162	the guest OS this object describes.
2163
2164	<result name="E_INVALIDARG">
2165	@a id is not a valid Guest OS type.
2166	</result>
2167
2168	</desc>
2169	<param name="id" type="uuid" mod="string" dir="in">
2170	<desc>Guest OS type ID string.</desc>
2171	</param>
2172	<param name="type" type="IGuestOSType" dir="return">
2173	<desc>Guest OS type object.</desc>
2174	</param>
2175	</method>
2176
2177	<method name="createSharedFolder">
2178	<desc>
2179	Creates a new global shared folder by associating the given logical
2180	name with the given host path, adds it to the collection of shared
2181	folders and starts sharing it. Refer to the description of
2182	<link to="ISharedFolder"/> to read more about logical names.
2183	<note>
2184	In the current implementation, this operation is not
2185	implemented.
2186	</note>
2187	</desc>
2188	<param name="name" type="wstring" dir="in">
2189	<desc>Unique logical name of the shared folder.</desc>
2190	</param>
2191	<param name="hostPath" type="wstring" dir="in">
2192	<desc>Full path to the shared folder in the host file system.</desc>
2193	</param>
2194	<param name="writable" type="boolean" dir="in">
2195	<desc>Whether the share is writable or readonly</desc>
2196	</param>
2197	<param name="automount" type="boolean" dir="in">
2198	<desc>Whether the share gets automatically mounted by the guest
2199	or not.</desc>
2200	</param>
2201	</method>
2202
2203	<method name="removeSharedFolder">
2204	<desc>
2205	Removes the global shared folder with the given name previously
2206	created by <link to="#createSharedFolder"/> from the collection of
2207	shared folders and stops sharing it.
2208	<note>
2209	In the current implementation, this operation is not
2210	implemented.
2211	</note>
2212	</desc>
2213	<param name="name" type="wstring" dir="in">
2214	<desc>Logical name of the shared folder to remove.</desc>
2215	</param>
2216	</method>
2217
2218	<method name="getExtraDataKeys">
2219	<desc>
2220	Returns an array representing the global extra data keys which currently
2221	have values defined.
2222	</desc>
2223	<param name="value" type="wstring" dir="return" safearray="yes">
2224	<desc>Array of extra data keys.</desc>
2225	</param>
2226	</method>
2227
2228	<method name="getExtraData">
2229	<desc>
2230	Returns associated global extra data.
2231
2232	If the requested data @a key does not exist, this function will
2233	succeed and return an empty string in the @a value argument.
2234
2235	<result name="VBOX_E_FILE_ERROR">
2236	Settings file not accessible.
2237	</result>
2238	<result name="VBOX_E_XML_ERROR">
2239	Could not parse the settings file.
2240	</result>
2241
2242	</desc>
2243	<param name="key" type="wstring" dir="in">
2244	<desc>Name of the data key to get.</desc>
2245	</param>
2246	<param name="value" type="wstring" dir="return">
2247	<desc>Value of the requested data key.</desc>
2248	</param>
2249	</method>
2250
2251	<method name="setExtraData">
2252	<desc>
2253	Sets associated global extra data.
2254
2255	If you pass @c null or empty string as a key @a value, the given @a key
2256	will be deleted.
2257
2258	<note>
2259	Before performing the actual data change, this method will ask all
2260	registered event listener using the
2261	<link to="IExtraDataCanChangeEvent"/>
2262	notification for a permission. If one of the listeners refuses the
2263	new value, the change will not be performed.
2264	</note>
2265	<note>
2266	On success, the
2267	<link to="IExtraDataChangedEvent"/> notification
2268	is called to inform all registered listeners about a successful data
2269	change.
2270	</note>
2271
2272	<result name="VBOX_E_FILE_ERROR">
2273	Settings file not accessible.
2274	</result>
2275	<result name="VBOX_E_XML_ERROR">
2276	Could not parse the settings file.
2277	</result>
2278	<result name="E_ACCESSDENIED">
2279	Modification request refused.
2280	</result>
2281
2282	</desc>
2283	<param name="key" type="wstring" dir="in">
2284	<desc>Name of the data key to set.</desc>
2285	</param>
2286	<param name="value" type="wstring" dir="in">
2287	<desc>Value to assign to the key.</desc>
2288	</param>
2289	</method>
2290
2291	<method name="waitForPropertyChange">
2292	<desc>
2293	Blocks the caller until any of the properties represented by the
2294	@a what argument changes the value or until the given timeout interval
2295	expires.
2296
2297	The @a what argument is a comma separated list of property masks that
2298	describe properties the caller is interested in. The property mask is
2299	a string in the following format:
2300
2301	<pre>
2302	[[group.]subgroup.]name
2303	</pre>
2304
2305	where @c name is the property name and @c group, @c subgroup are zero
2306	or more property group specifiers. Each element (group or name) in
2307	the property mask may be either a Latin string or an asterisk symbol
2308	(@c "*") which is used to match any string for the given element. A
2309	property mask that doesn't contain asterisk symbols represents a
2310	single fully qualified property name.
2311
2312	Groups in the fully qualified property name go from more generic (the
2313	left-most part) to more specific (the right-most part). The first
2314	element is usually a name of the object the property belongs to. The
2315	second element may be either a property name, or a child object name,
2316	or an index if the preceding element names an object which is one of
2317	many objects of the same type. This way, property names form a
2318	hierarchy of properties. Here are some examples of property names:
2319
2320	<table>
2321	<tr>
2322	<td><tt>VirtualBox.version</tt></td>
2323	<td><link to="IVirtualBox::version"/> property</td>
2324	</tr>
2325	<tr>
2326	<td><tt>Machine.<UUID>.name</tt></td>
2327	<td><link to="IMachine::name"/> property of the machine with the
2328	given UUID</td>
2329	</tr>
2330	</table>
2331
2332	Most property names directly correspond to the properties of objects
2333	(components) provided by the VirtualBox library and may be used to
2334	track changes to these properties. However, there may be
2335	pseudo-property names that don't correspond to any existing object's
2336	property directly, as well as there may be object properties that
2337	don't have a corresponding property name that is understood by this
2338	method, and therefore changes to such properties cannot be
2339	tracked. See individual object's property descriptions to get a
2340	fully qualified property name that can be used with this method (if
2341	any).
2342
2343	There is a special property mask @c "*" (i.e. a string consisting of a
2344	single asterisk symbol) that can be used to match all properties.
2345	Below are more examples of property masks:
2346
2347	<table>
2348	<tr>
2349	<td><tt>VirtualBox.*</tt></td>
2350	<td>Track all properties of the VirtualBox object</td>
2351	</tr>
2352	<tr>
2353	<td><tt>Machine.*.name</tt></td>
2354	<td>Track changes to the <link to="IMachine::name"/> property of
2355	all registered virtual machines</td>
2356	</tr>
2357	</table>
2358
2359	<note>
2360	This function is not implemented in the current version of the
2361	product.
2362	</note>
2363	</desc>
2364	<param name="what" type="wstring" dir="in">
2365	<desc>Comma separated list of property masks.</desc>
2366	</param>
2367	<param name="timeout" type="unsigned long" dir="in">
2368	<desc>
2369	Wait timeout in milliseconds.
2370	Specify -1 for an indefinite wait.
2371	</desc>
2372	</param>
2373	<param name="changed" type="wstring" dir="out">
2374	<desc>
2375	Comma separated list of properties that have been changed and caused
2376	this method to return to the caller.
2377	</desc>
2378	</param>
2379	<param name="values" type="wstring" dir="out">
2380	<desc>Reserved, not currently used.</desc>
2381	</param>
2382	</method>
2383
2384	<!--method name="createDHCPServerForInterface">
2385	<desc>
2386	Creates a dhcp server settings to be used for the given interface
2387	<result name="E_INVALIDARG">
2388	Host network interface @a name already exists.
2389	</result>
2390	</desc>
2391	<param name="interface" type="IHostNetworkInterface" dir="in">
2392	<desc>Network Interface</desc>
2393	</param>
2394	<param name="server" type="IDHCPServer" dir="out">
2395	<desc>Dhcp server settings</desc>
2396	</param>
2397	</method-->
2398
2399	<method name="createDHCPServer">
2400	<desc>
2401	Creates a dhcp server settings to be used for the given internal network name
2402	<result name="E_INVALIDARG">
2403	Host network interface @a name already exists.
2404	</result>
2405	</desc>
2406	<param name="name" type="wstring" dir="in">
2407	<desc>server name</desc>
2408	</param>
2409	<param name="server" type="IDHCPServer" dir="return">
2410	<desc>Dhcp server settings</desc>
2411	</param>
2412	</method>
2413
2414	<method name="findDHCPServerByNetworkName">
2415	<desc>
2416	Searches a dhcp server settings to be used for the given internal network name
2417	<result name="E_INVALIDARG">
2418	Host network interface @a name already exists.
2419	</result>
2420
2421	</desc>
2422	<param name="name" type="wstring" dir="in">
2423	<desc>server name</desc>
2424	</param>
2425	<param name="server" type="IDHCPServer" dir="return">
2426	<desc>Dhcp server settings</desc>
2427	</param>
2428	</method>
2429
2430	<!--method name="findDHCPServerForInterface">
2431	<desc>
2432	Searches a dhcp server settings to be used for the given interface
2433	<result name="E_INVALIDARG">
2434	Host network interface @a name already exists.
2435	</result>
2436	</desc>
2437	<param name="interface" type="IHostNetworkInterface" dir="in">
2438	<desc>Network Interface</desc>
2439	</param>
2440	<param name="server" type="IDHCPServer" dir="out">
2441	<desc>Dhcp server settings</desc>
2442	</param>
2443	</method-->
2444
2445	<method name="removeDHCPServer">
2446	<desc>
2447	Removes the dhcp server settings
2448	<result name="E_INVALIDARG">
2449	Host network interface @a name already exists.
2450	</result>
2451	</desc>
2452	<param name="server" type="IDHCPServer" dir="in">
2453	<desc>Dhcp server settings to be removed</desc>
2454	</param>
2455	</method>
2456
2457
2458	<method name="checkFirmwarePresent">
2459	<desc>
2460	Check if this VirtualBox installation has a firmware
2461	of the given type available, either system-wide or per-user.
2462	Optionally, this may return a hint where this firmware can be
2463	downloaded from.
2464	</desc>
2465	<param name="firmwareType" type="FirmwareType" dir="in">
2466	<desc>
2467	Type of firmware to check.
2468	</desc>
2469	</param>
2470	<param name="version" type="wstring" dir="in">
2471	<desc>Expected version number, usually empty string (presently ignored).</desc>
2472	</param>
2473
2474	<param name="url" type="wstring" dir="out">
2475	<desc>
2476	Suggested URL to download this firmware from.
2477	</desc>
2478	</param>
2479
2480	<param name="file" type="wstring" dir="out">
2481	<desc>
2482	Filename of firmware, only valid if result == TRUE.
2483	</desc>
2484	</param>
2485
2486	<param name="result" type="boolean" dir="return">
2487	<desc>If firmware of this type and version is available.</desc>
2488	</param>
2489	</method>
2490
2491	</interface>
2492
2493	<!--
2494	// IVFSExplorer
2495	/////////////////////////////////////////////////////////////////////////
2496	-->
2497
2498	<enum
2499	name="VFSType"
2500	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2501	>
2502	<desc>
2503	Virtual file systems supported by VFSExplorer.
2504	</desc>
2505
2506	<const name="File" value="1" />
2507	<const name="Cloud" value="2" />
2508	<const name="S3" value="3" />
2509	<const name="WebDav" value="4" />
2510	</enum>
2511
2512	<enum
2513	name="VFSFileType"
2514	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2515	>
2516	<desc>
2517	File types known by VFSExplorer.
2518	</desc>
2519
2520	<const name="Unknown" value="1" />
2521	<const name="Fifo" value="2" />
2522	<const name="DevChar" value="3" />
2523	<const name="Directory" value="4" />
2524	<const name="DevBlock" value="5" />
2525	<const name="File" value="6" />
2526	<const name="SymLink" value="7" />
2527	<const name="Socket" value="8" />
2528	<const name="WhiteOut" value="9" />
2529	</enum>
2530
2531	<interface
2532	name="IVFSExplorer" extends="$unknown"
2533	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
2534	wsmap="managed"
2535	>
2536	<desc>
2537	The VFSExplorer interface unifies access to different file system
2538	types. This includes local file systems as well remote file systems like
2539	S3. For a list of supported types see <link to="VFSType" />.
2540	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2541	</desc>
2542
2543	<attribute name="path" type="wstring" readonly="yes">
2544	<desc>Returns the current path in the virtual file system.</desc>
2545	</attribute>
2546
2547	<attribute name="type" type="VFSType" readonly="yes">
2548	<desc>Returns the file system type which is currently in use.</desc>
2549	</attribute>
2550
2551	<method name="update">
2552	<desc>Updates the internal list of files/directories from the
2553	current directory level. Use <link to="#entryList" /> to get the full list
2554	after a call to this method.</desc>
2555
2556	<param name="aProgress" type="IProgress" dir="return">
2557	<desc>Progress object to track the operation completion.</desc>
2558	</param>
2559	</method>
2560
2561	<method name="cd">
2562	<desc>Change the current directory level.</desc>
2563
2564	<param name="aDir" type="wstring" dir="in">
2565	<desc>The name of the directory to go in.</desc>
2566	</param>
2567
2568	<param name="aProgress" type="IProgress" dir="return">
2569	<desc>Progress object to track the operation completion.</desc>
2570	</param>
2571	</method>
2572
2573	<method name="cdUp">
2574	<desc>Go one directory upwards from the current directory level.</desc>
2575
2576	<param name="aProgress" type="IProgress" dir="return">
2577	<desc>Progress object to track the operation completion.</desc>
2578	</param>
2579	</method>
2580
2581	<method name="entryList">
2582	<desc>Returns a list of files/directories after a call to <link
2583	to="#update" />. The user is responsible for keeping this internal
2584	list up do date.</desc>
2585
2586	<param name="aNames" type="wstring" safearray="yes" dir="out">
2587	<desc>The list of names for the entries.</desc>
2588	</param>
2589
2590	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2591	<desc>The list of types for the entries.</desc>
2592	</param>
2593	</method>
2594
2595	<method name="exists">
2596	<desc>Checks if the given file list exists in the current directory
2597	level.</desc>
2598
2599	<param name="aNames" type="wstring" safearray="yes" dir="in">
2600	<desc>The names to check.</desc>
2601	</param>
2602
2603	<param name="aExists" type="wstring" safearray="yes" dir="return">
2604	<desc>The names which exist.</desc>
2605	</param>
2606	</method>
2607
2608	<method name="remove">
2609	<desc>Deletes the given files in the current directory level.</desc>
2610
2611	<param name="aNames" type="wstring" safearray="yes" dir="in">
2612	<desc>The names to remove.</desc>
2613	</param>
2614
2615	<param name="aProgress" type="IProgress" dir="return">
2616	<desc>Progress object to track the operation completion.</desc>
2617	</param>
2618	</method>
2619
2620	</interface>
2621
2622	<!--
2623	// IAppliance
2624	/////////////////////////////////////////////////////////////////////////
2625	-->
2626
2627	<interface
2628	name="IAppliance" extends="$unknown"
2629	uuid="fb61a4fc-57e7-48d6-859b-71f37d484cf2"
2630	wsmap="managed"
2631	>
2632	<desc>
2633	Represents a platform-independent appliance in OVF format. An instance of this is returned
2634	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2635	virtual machines within an appliance with VirtualBox.
2636
2637	The OVF standard suggests two different physical file formats:
2638
2639	<ol>
2640	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2641	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2642	this descriptor file references other files such as disk images, as OVF appliances typically
2643	do, those additional files must be in the same directory as the descriptor file.</li>
2644
2645	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2646	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2647	files and optionally other files.
2648
2649	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2650	be added with a later version.</li>
2651	</ol>
2652
2653	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2654	<link to="IMachine" /> involves the following sequence of API calls:
2655
2656	<ol>
2657	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2658	</li>
2659
2660	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2661	would like to import. So long as this file is syntactically valid, this will succeed
2662	and fill the appliance object with the parsed data from the OVF file.
2663	</li>
2664
2665	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2666	contents of the IAppliance attributes accordingly. These can be inspected by a
2667	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2668	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2669	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2670	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2671	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2672	The GUI can then give the user the option to confirm and/or change these suggestions.
2673	</li>
2674
2675	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2676	virtual system (machine) to override the suggestions made by the interpret() routine.
2677	</li>
2678
2679	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2680	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2681	virtual system descriptions. After this call suceeded, the UUIDs of the machines created
2682	can be found in the <link to="#machines" /> array attribute.
2683	</li>
2684	</ol>
2685
2686	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2687
2688	<ol>
2689	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2690	an empty IAppliance object.
2691	</li>
2692
2693	<li>For each machine you would like to export, call <link to="IMachine::export" />
2694	with the IAppliance object you just created. Each such call creates one instance of
2695	<link to="IVirtualSystemDescription" /> inside the appliance.
2696	</li>
2697
2698	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2699	virtual system (machine) to override the suggestions made by the export() routine.
2700	</li>
2701
2702	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2703	file written.</li>
2704	</ol>
2705
2706	</desc>
2707
2708	<attribute name="path" type="wstring" readonly="yes">
2709	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2710	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2711	<link to="#write" /> (for export).
2712	This attribute is empty until one of these methods has been called.
2713	</desc>
2714	</attribute>
2715
2716	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2717	<desc>
2718	Array of virtual disk definitions. One such description exists for each
2719	disk definition in the OVF; each string array item represents one such piece of
2720	disk information, with the information fields separated by tab (\t) characters.
2721
2722	The caller should be prepared for additional fields being appended to
2723	this string in future versions of VirtualBox and therefore check for
2724	the number of tabs in the strings returned.
2725
2726	In the current version, the following eight fields are returned per string
2727	in the array:
2728
2729	<ol>
2730	<li>Disk ID (unique string identifier given to disk)</li>
2731
2732	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2733
2734	<li>Populated size (optional unsigned integer indicating the current size of the
2735	disk; can be approximate; -1 if unspecified)</li>
2736
2737	<li>Format (string identifying the disk format, typically
2738	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2739
2740	<li>Reference (where to find the disk image, typically a file name; if empty,
2741	then the disk should be created on import)</li>
2742
2743	<li>Image size (optional unsigned integer indicating the size of the image,
2744	which need not necessarily be the same as the values specified above, since
2745	the image may be compressed or sparse; -1 if not specified)</li>
2746
2747	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2748	presently unsupported and always -1)</li>
2749
2750	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2751	</ol>
2752	</desc>
2753	</attribute>
2754
2755	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2756	<desc> Array of virtual system descriptions. One such description is created
2757	for each virtual system (machine) found in the OVF.
2758	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2759	(for export) has been called.
2760	</desc>
2761	</attribute>
2762
2763	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2764	<desc>
2765	Contains the UUIDs of the machines created from the information in this appliances. This is only
2766	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2767	succeeded.
2768	</desc>
2769	</attribute>
2770
2771	<method name="read">
2772	<desc>
2773	Reads an OVF file into the appliance object.
2774
2775	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2776	mere fact that this method returns successfully does not mean that VirtualBox supports all
2777	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2778	</desc>
2779	<param name="file" type="wstring" dir="in">
2780	<desc>
2781	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2782	on whether the appliance is distributed as a set of files or as a single file, respectively).
2783	</desc>
2784	</param>
2785	<param name="aProgress" type="IProgress" dir="return">
2786	<desc></desc>
2787	</param>
2788	</method>
2789
2790	<method name="interpret">
2791	<desc>
2792	Interprets the OVF data that was read when the appliance was constructed. After
2793	calling this method, one can inspect the
2794	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2795	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2796	the appliance.
2797
2798	Calling this method is the second step of importing an appliance into VirtualBox;
2799	see <link to="IAppliance" /> for an overview.
2800
2801	After calling this method, one should call <link to="#getWarnings" /> to find out
2802	if problems were encountered during the processing which might later lead to
2803	errors.
2804	</desc>
2805	</method>
2806
2807	<method name="importMachines">
2808	<desc>
2809	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2810	and other interfaces that match the information contained in the appliance as
2811	closely as possible, as represented by the import instructions in the
2812	<link to="#virtualSystemDescriptions" /> array.
2813
2814	Calling this method is the final step of importing an appliance into VirtualBox;
2815	see <link to="IAppliance" /> for an overview.
2816
2817	Since importing the appliance will most probably involve copying and converting
2818	disk images, which can take a long time, this method operates asynchronously and
2819	returns an IProgress object to allow the caller to monitor the progress.
2820
2821	After the import succeeded, the UUIDs of the IMachine instances created can be
2822	retrieved from the <link to="#machines" /> array attribute.
2823	</desc>
2824
2825	<param name="aProgress" type="IProgress" dir="return">
2826	<desc></desc>
2827	</param>
2828	</method>
2829
2830	<method name="createVFSExplorer">
2831	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2832
2833	<param name="aUri" type="wstring" dir="in">
2834	<desc>The URI describing the file system to use.</desc>
2835	</param>
2836
2837	<param name="aExplorer" type="IVFSExplorer" dir="return">
2838	<desc></desc>
2839	</param>
2840	</method>
2841
2842	<method name="write">
2843	<desc>
2844	Writes the contents of the appliance exports into a new OVF file.
2845
2846	Calling this method is the final step of exporting an appliance from VirtualBox;
2847	see <link to="IAppliance" /> for an overview.
2848
2849	Since exporting the appliance will most probably involve copying and converting
2850	disk images, which can take a long time, this method operates asynchronously and
2851	returns an IProgress object to allow the caller to monitor the progress.
2852	</desc>
2853	<param name="format" type="wstring" dir="in">
2854	<desc>
2855	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2856	future versions of VirtualBox may support additional formats.
2857	</desc>
2858	</param>
2859	<param name="path" type="wstring" dir="in">
2860	<desc>
2861	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2862	on whether the appliance is distributed as a set of files or as a single file, respectively).
2863	</desc>
2864	</param>
2865	<param name="aProgress" type="IProgress" dir="return">
2866	<desc>Progress object to track the operation completion.</desc>
2867	</param>
2868	</method>
2869
2870	<method name="getWarnings">
2871	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
2872
2873	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2874	<desc></desc>
2875	</param>
2876	</method>
2877
2878	</interface>
2879
2880	<enum
2881	name="VirtualSystemDescriptionType"
2882	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2883	>
2884	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2885	a configuration value.</desc>
2886
2887	<const name="Ignore" value="1" />
2888	<const name="OS" value="2" />
2889	<const name="Name" value="3" />
2890	<const name="Product" value="4" />
2891	<const name="Vendor" value="5" />
2892	<const name="Version" value="6" />
2893	<const name="ProductUrl" value="7" />
2894	<const name="VendorUrl" value="8" />
2895	<const name="Description" value="9" />
2896	<const name="License" value="10" />
2897	<const name="Miscellaneous" value="11" />
2898	<const name="CPU" value="12" />
2899	<const name="Memory" value="13" />
2900	<const name="HardDiskControllerIDE" value="14" />
2901	<const name="HardDiskControllerSATA" value="15" />
2902	<const name="HardDiskControllerSCSI" value="16" />
2903	<const name="HardDiskControllerSAS" value="17" />
2904	<const name="HardDiskImage" value="18" />
2905	<const name="Floppy" value="19" />
2906	<const name="CDROM" value="20" />
2907	<const name="NetworkAdapter" value="21" />
2908	<const name="USBController" value="22" />
2909	<const name="SoundCard" value="23" />
2910
2911	</enum>
2912
2913	<enum
2914	name="VirtualSystemDescriptionValueType"
2915	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2916	>
2917	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2918	type to fetch.</desc>
2919
2920	<const name="Reference" value="1" />
2921	<const name="Original" value="2" />
2922	<const name="Auto" value="3" />
2923	<const name="ExtraConfig" value="4" />
2924
2925	</enum>
2926
2927	<interface
2928	name="IVirtualSystemDescription" extends="$unknown"
2929	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2930	wsmap="managed"
2931	>
2932
2933	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2934	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2935	<link to="IAppliance::interpret" /> has been called, that array contains information
2936	about how the virtual systems described in the OVF should best be imported into
2937	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2938	import an OVF into VirtualBox.
2939	</desc>
2940
2941	<attribute name="count" type="unsigned long" readonly="yes">
2942	<desc>Return the number of virtual system description entries.</desc>
2943	</attribute>
2944
2945	<method name="getDescription">
2946	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2947	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2948
2949	The list below identifies the value sets that are possible depending on the
2950	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2951	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2952	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2953	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2954	the @a aExtraConfigValues[] array item may also be used.
2955
2956	<ul>
2957	<li>
2958	"OS": the guest operating system type. There must be exactly one such array item on import. The
2959	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2960	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2961	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2962	</li>
2963	<li>
2964	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2965	if none is present on import, then an automatic name will be created from the operating system
2966	type. The correponding item im @a aOvfValues[] will contain the suggested virtual machine name
2967	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2968	<link to="IMachine" /> name that does not exist yet.
2969	</li>
2970	<li>
2971	"Description": an arbitrary description.
2972	</li>
2973	<li>
2974	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2975	code to display such a license for agreement; the Main API does not enforce any such policy.
2976	</li>
2977	<li>
2978	Miscellaneous: reserved for future use.
2979	</li>
2980	<li>
2981	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2982	</li>
2983	<li>
2984	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2985	is present on import, then VirtualBox will set a meaningful default based on the operating system
2986	type.
2987	</li>
2988	<li>
2989	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2990	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2991	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2992	writes into the OVF.
2993	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2994	type can use to specify which hard disk controller a virtual disk should be connected to.
2995	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2996	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2997	its virtual machines supports four channels (primary master, primary slave, secondary master,
2998	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2999	</li>
3000	<li>
3001	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
3002	has no value in @a aOvfValues[] or @a aVBoxValues[].
3003	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3004	</li>
3005	<li>
3006	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
3007	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
3008	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
3009	whereas VirtualBox considers it a class of storage controllers of its own; see
3010	<link to="StorageControllerType" />).
3011	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
3012	</li>
3013	<li>
3014	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
3015	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
3016
3017	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
3018	a path since the image file should be in the same location as the OVF file itself), whereas the
3019	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
3020	hard disk image. This means that on import the image will be copied and converted from the
3021	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
3022	On import, the target image will also be registered with VirtualBox.
3023
3024	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
3025	format: "controller=<index>;channel=<c>"
3026	In this string, <index> must be an integer specifying the hard disk controller to connect
3027	the image to. That number must be the index of an array item with one of the hard disk controller
3028	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
3029	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
3030	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
3031	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
3032	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
3033	</li>
3034	<li>
3035	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
3036	attachment information as with "HardDiskImage" items.
3037	</li>
3038	<li>
3039	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
3040	attachment information as with "HardDiskImage" items.
3041	</li>
3042	<li>
3043	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
3044	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
3045	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
3046	</li>
3047	<li>
3048	"USBController": a USB controller. There can be at most one such item. If and only if such an
3049	item ispresent, USB support will be enabled for the new virtual machine.
3050	</li>
3051	<li>
3052	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
3053	present, sound support will be enabled for the new virtual machine. Note that the virtual
3054	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
3055	may be different from the virtual soundcard expected by the appliance.
3056	</li>
3057	</ul>
3058
3059	</desc>
3060
3061	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3062	<desc></desc>
3063	</param>
3064
3065	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3066	<desc></desc>
3067	</param>
3068
3069	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3070	<desc></desc>
3071	</param>
3072
3073	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3074	<desc></desc>
3075	</param>
3076
3077	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3078	<desc></desc>
3079	</param>
3080
3081	</method>
3082
3083	<method name="getDescriptionByType">
3084	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
3085	should be returned.</desc>
3086
3087	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3088	<desc></desc>
3089	</param>
3090
3091	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
3092	<desc></desc>
3093	</param>
3094
3095	<param name="aRefs" type="wstring" dir="out" safearray="yes">
3096	<desc></desc>
3097	</param>
3098
3099	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
3100	<desc></desc>
3101	</param>
3102
3103	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
3104	<desc></desc>
3105	</param>
3106
3107	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
3108	<desc></desc>
3109	</param>
3110
3111	</method>
3112
3113	<method name="getValuesByType">
3114	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
3115	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
3116	values.</desc>
3117
3118	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3119	<desc></desc>
3120	</param>
3121
3122	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
3123	<desc></desc>
3124	</param>
3125
3126	<param name="aValues" type="wstring" dir="return" safearray="yes">
3127	<desc></desc>
3128	</param>
3129
3130	</method>
3131
3132	<method name="setFinalValues">
3133	<desc>
3134	This method allows the appliance's user to change the configuration for the virtual
3135	system descriptions. For each array item returned from <link to="#getDescription" />,
3136	you must pass in one boolean value and one configuration value.
3137
3138	Each item in the boolean array determines whether the particular configuration item
3139	should be enabled.
3140	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
3141	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
3142	and SoundCard.
3143
3144	For the "vbox" and "extra configuration" values, if you pass in the same arrays
3145	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
3146	the configuration remains unchanged. Please see the documentation for getDescription()
3147	for valid configuration values for the individual array item types. If the
3148	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
3149	</desc>
3150
3151	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
3152	<desc></desc>
3153	</param>
3154
3155	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
3156	<desc></desc>
3157	</param>
3158
3159	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
3160	<desc></desc>
3161	</param>
3162	</method>
3163
3164	<method name="addDescription">
3165	<desc>
3166	This method adds an additional description entry to the stack of already
3167	available descriptions for this virtual system. This is handy for writing
3168	values which aren't directly supported by VirtualBox. One example would
3169	be the License type of <link to="VirtualSystemDescriptionType" />.
3170	</desc>
3171
3172	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
3173	<desc></desc>
3174	</param>
3175
3176	<param name="aVBoxValue" type="wstring" dir="in">
3177	<desc></desc>
3178	</param>
3179
3180	<param name="aExtraConfigValue" type="wstring" dir="in">
3181	<desc></desc>
3182	</param>
3183	</method>
3184	</interface>
3185
3186
3187	<!--
3188	// IMachine
3189	/////////////////////////////////////////////////////////////////////////
3190	-->
3191
3192	<interface
3193	name="IInternalMachineControl" extends="$unknown"
3194	uuid="e2da8b1a-2ad1-490e-b29e-c33a144791b6"
3195	internal="yes"
3196	wsmap="suppress"
3197	>
3198	<method name="updateState">
3199	<desc>
3200	Updates the VM state.
3201	<note>
3202	This operation will also update the settings file with
3203	the correct information about the saved state file
3204	and delete this file from disk when appropriate.
3205	</note>
3206	</desc>
3207	<param name="state" type="MachineState" dir="in"/>
3208	</method>
3209
3210	<method name="getIPCId">
3211	<param name="id" type="wstring" dir="return"/>
3212	</method>
3213
3214	<method name="beginPowerUp">
3215	<desc>
3216	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3217	gives it the progress object that should be part of any pending
3218	<link to="IMachine::launchVMProcess"/> operations. The progress
3219	object may be called back to reflect an early cancelation, so some care
3220	have to be taken with respect to any cancelation callbacks. The console
3221	object will call <link to="IInternalMachineControl::endPowerUp"/>
3222	to signal the completion of the progress object.
3223	</desc>
3224	<param name="progress" type="IProgress" dir="in"/>
3225	</method>
3226
3227	<method name="endPowerUp">
3228	<desc>
3229	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3230	This method may query status information from the progress object it
3231	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3232	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3233	call in order to complete that progress object.
3234	</desc>
3235	<param name="result" type="long" dir="in"/>
3236	</method>
3237
3238	<method name="runUSBDeviceFilters">
3239	<desc>
3240	Asks the server to run USB devices filters of the associated
3241	machine against the given USB device and tell if there is
3242	a match.
3243	<note>
3244	Intended to be used only for remote USB devices. Local
3245	ones don't require to call this method (this is done
3246	implicitly by the Host and USBProxyService).
3247	</note>
3248	</desc>
3249	<param name="device" type="IUSBDevice" dir="in"/>
3250	<param name="matched" type="boolean" dir="out"/>
3251	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3252	</method>
3253
3254	<method name="captureUSBDevice">
3255	<desc>
3256	Requests a capture of the given host USB device.
3257	When the request is completed, the VM process will
3258	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3259	notification.
3260	</desc>
3261	<param name="id" type="uuid" mod="string" dir="in"/>
3262	</method>
3263
3264	<method name="detachUSBDevice">
3265	<desc>
3266	Notification that a VM is going to detach (@a done = @c false) or has
3267	already detached (@a done = @c true) the given USB device.
3268	When the @a done = @c true request is completed, the VM process will
3269	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3270	notification.
3271	<note>
3272	In the @a done = @c true case, the server must run its own filters
3273	and filters of all VMs but this one on the detached device
3274	as if it were just attached to the host computer.
3275	</note>
3276	</desc>
3277	<param name="id" type="uuid" mod="string" dir="in"/>
3278	<param name="done" type="boolean" dir="in"/>
3279	</method>
3280
3281	<method name="autoCaptureUSBDevices">
3282	<desc>
3283	Requests a capture all matching USB devices attached to the host.
3284	When the request is completed, the VM process will
3285	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3286	notification per every captured device.
3287	</desc>
3288	</method>
3289
3290	<method name="detachAllUSBDevices">
3291	<desc>
3292	Notification that a VM that is being powered down. The done
3293	parameter indicates whether which stage of the power down
3294	we're at. When @a done = @c false the VM is announcing its
3295	intentions, while when @a done = @c true the VM is reporting
3296	what it has done.
3297	<note>
3298	In the @a done = @c true case, the server must run its own filters
3299	and filters of all VMs but this one on all detach devices as
3300	if they were just attached to the host computer.
3301	</note>
3302	</desc>
3303	<param name="done" type="boolean" dir="in"/>
3304	</method>
3305
3306	<method name="onSessionEnd">
3307	<desc>
3308	Triggered by the given session object when the session is about
3309	to close normally.
3310	</desc>
3311	<param name="session" type="ISession" dir="in">
3312	<desc>Session that is being closed</desc>
3313	</param>
3314	<param name="progress" type="IProgress" dir="return">
3315	<desc>
3316	Used to wait until the corresponding machine is actually
3317	dissociated from the given session on the server.
3318	Returned only when this session is a direct one.
3319	</desc>
3320	</param>
3321	</method>
3322
3323	<method name="beginSavingState">
3324	<desc>
3325	Called by the VM process to inform the server it wants to
3326	save the current state and stop the VM execution.
3327	</desc>
3328	<param name="progress" type="IProgress" dir="in">
3329	<desc>
3330	Progress object created by the VM process to wait until
3331	the state is saved.
3332	</desc>
3333	</param>
3334	<param name="stateFilePath" type="wstring" dir="out">
3335	<desc>
3336	File path the VM process must save the execution state to.
3337	</desc>
3338	</param>
3339	</method>
3340
3341	<method name="endSavingState">
3342	<desc>
3343	Called by the VM process to inform the server that saving
3344	the state previously requested by #beginSavingState is either
3345	successfully finished or there was a failure.
3346
3347	<result name="VBOX_E_FILE_ERROR">
3348	Settings file not accessible.
3349	</result>
3350	<result name="VBOX_E_XML_ERROR">
3351	Could not parse the settings file.
3352	</result>
3353
3354	</desc>
3355
3356	<param name="success" type="boolean" dir="in">
3357	<desc>@c true to indicate success and @c false otherwise.
3358	</desc>
3359	</param>
3360	</method>
3361
3362	<method name="adoptSavedState">
3363	<desc>
3364	Gets called by IConsole::adoptSavedState.
3365	<result name="VBOX_E_FILE_ERROR">
3366	Invalid saved state file path.
3367	</result>
3368	</desc>
3369	<param name="savedStateFile" type="wstring" dir="in">
3370	<desc>Path to the saved state file to adopt.</desc>
3371	</param>
3372	</method>
3373
3374	<method name="beginTakingSnapshot">
3375	<desc>
3376	Called from the VM process to request from the server to perform the
3377	server-side actions of creating a snapshot (creating differencing images
3378	and the snapshot object).
3379
3380	<result name="VBOX_E_FILE_ERROR">
3381	Settings file not accessible.
3382	</result>
3383	<result name="VBOX_E_XML_ERROR">
3384	Could not parse the settings file.
3385	</result>
3386	</desc>
3387	<param name="initiator" type="IConsole" dir="in">
3388	<desc>The console object that initiated this call.</desc>
3389	</param>
3390	<param name="name" type="wstring" dir="in">
3391	<desc>Snapshot name.</desc>
3392	</param>
3393	<param name="description" type="wstring" dir="in">
3394	<desc>Snapshot description.</desc>
3395	</param>
3396	<param name="consoleProgress" type="IProgress" dir="in">
3397	<desc>
3398	Progress object created by the VM process tracking the
3399	snapshot's progress. This has the following sub-operations:
3400	<ul>
3401	<li>setting up (weight 1);</li>
3402	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3403	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3404	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3405	<li>finishing up (weight 1)</li>
3406	</ul>
3407	</desc>
3408	</param>
3409	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3410	<desc>
3411	Whether this is an online snapshot (i.e. the machine is running).
3412	</desc>
3413	</param>
3414	<param name="stateFilePath" type="wstring" dir="out">
3415	<desc>
3416	File path the VM process must save the execution state to.
3417	</desc>
3418	</param>
3419	</method>
3420
3421	<method name="endTakingSnapshot">
3422	<desc>
3423	Called by the VM process to inform the server that the snapshot
3424	previously requested by #beginTakingSnapshot is either
3425	successfully taken or there was a failure.
3426	</desc>
3427
3428	<param name="success" type="boolean" dir="in">
3429	<desc>@c true to indicate success and @c false otherwise</desc>
3430	</param>
3431	</method>
3432
3433	<method name="deleteSnapshot">
3434	<desc>
3435	Gets called by IConsole::deleteSnapshot.
3436	<result name="VBOX_E_INVALID_OBJECT_STATE">
3437	Snapshot has more than one child snapshot.
3438	</result>
3439	</desc>
3440	<param name="initiator" type="IConsole" dir="in">
3441	<desc>The console object that initiated this call.</desc>
3442	</param>
3443	<param name="id" type="uuid" mod="string" dir="in">
3444	<desc>UUID of the snapshot to delete.</desc>
3445	</param>
3446	<param name="machineState" type="MachineState" dir="out">
3447	<desc>New machine state after this operation is started.</desc>
3448	</param>
3449	<param name="progress" type="IProgress" dir="return">
3450	<desc>Progress object to track the operation completion.</desc>
3451	</param>
3452	</method>
3453
3454	<method name="finishOnlineMergeMedium">
3455	<desc>
3456	Gets called by IConsole::onlineMergeMedium.
3457	</desc>
3458	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3459	<desc>The medium attachment which needs to be cleaned up.</desc>
3460	</param>
3461	<param name="source" type="IMedium" dir="in">
3462	<desc>Merge source medium.</desc>
3463	</param>
3464	<param name="target" type="IMedium" dir="in">
3465	<desc>Merge target medium.</desc>
3466	</param>
3467	<param name="mergeForward" type="boolean" dir="in">
3468	<desc>Merge direction.</desc>
3469	</param>
3470	<param name="parentForTarget" type="IMedium" dir="in">
3471	<desc>For forward merges: new parent for target medium.</desc>
3472	</param>
3473	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3474	<desc>For backward merges: list of media which need their parent UUID
3475	updated.</desc>
3476	</param>
3477	</method>
3478
3479	<method name="restoreSnapshot">
3480	<desc>
3481	Gets called by IConsole::RestoreSnapshot.
3482	</desc>
3483	<param name="initiator" type="IConsole" dir="in">
3484	<desc>The console object that initiated this call.</desc>
3485	</param>
3486	<param name="snapshot" type="ISnapshot" dir="in">
3487	<desc>The snapshot to restore the VM state from.</desc>
3488	</param>
3489	<param name="machineState" type="MachineState" dir="out">
3490	<desc>New machine state after this operation is started.</desc>
3491	</param>
3492	<param name="progress" type="IProgress" dir="return">
3493	<desc>Progress object to track the operation completion.</desc>
3494	</param>
3495	</method>
3496
3497	<method name="pullGuestProperties">
3498	<desc>
3499	Get the list of the guest properties matching a set of patterns along
3500	with their values, time stamps and flags and give responsibility for
3501	managing properties to the console.
3502	</desc>
3503	<param name="name" type="wstring" dir="out" safearray="yes">
3504	<desc>
3505	The names of the properties returned.
3506	</desc>
3507	</param>
3508	<param name="value" type="wstring" dir="out" safearray="yes">
3509	<desc>
3510	The values of the properties returned. The array entries match the
3511	corresponding entries in the @a name array.
3512	</desc>
3513	</param>
3514	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
3515	<desc>
3516	The time stamps of the properties returned. The array entries match
3517	the corresponding entries in the @a name array.
3518	</desc>
3519	</param>
3520	<param name="flags" type="wstring" dir="out" safearray="yes">
3521	<desc>
3522	The flags of the properties returned. The array entries match the
3523	corresponding entries in the @a name array.
3524	</desc>
3525	</param>
3526	</method>
3527
3528	<method name="pushGuestProperty">
3529	<desc>
3530	Update a single guest property in IMachine.
3531	</desc>
3532	<param name="name" type="wstring" dir="in">
3533	<desc>
3534	The name of the property to be updated.
3535	</desc>
3536	</param>
3537	<param name="value" type="wstring" dir="in">
3538	<desc>
3539	The value of the property.
3540	</desc>
3541	</param>
3542	<param name="timestamp" type="unsigned long long" dir="in">
3543	<desc>
3544	The timestamp of the property.
3545	</desc>
3546	</param>
3547	<param name="flags" type="wstring" dir="in">
3548	<desc>
3549	The flags of the property.
3550	</desc>
3551	</param>
3552	</method>
3553
3554	<method name="lockMedia">
3555	<desc>
3556	Locks all media attached to the machine for writing and parents of
3557	attached differencing media (if any) for reading. This operation is
3558	atomic so that if it fails no media is actually locked.
3559
3560	This method is intended to be called when the machine is in Starting or
3561	Restoring state. The locked media will be automatically unlocked when
3562	the machine is powered off or crashed.
3563	</desc>
3564	</method>
3565	<method name="unlockMedia">
3566	<desc>
3567	Unlocks all media previously locked using
3568	<link to="IInternalMachineControl::lockMedia"/>.
3569
3570	This method is intended to be used with teleportation so that it is
3571	possible to teleport between processes on the same machine.
3572	</desc>
3573	</method>
3574	</interface>
3575
3576	<interface
3577	name="IBIOSSettings" extends="$unknown"
3578	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3579	wsmap="managed"
3580	>
3581	<desc>
3582	The IBIOSSettings interface represents BIOS settings of the virtual
3583	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3584	</desc>
3585	<attribute name="logoFadeIn" type="boolean">
3586	<desc>Fade in flag for BIOS logo animation.</desc>
3587	</attribute>
3588
3589	<attribute name="logoFadeOut" type="boolean">
3590	<desc>Fade out flag for BIOS logo animation.</desc>
3591	</attribute>
3592
3593	<attribute name="logoDisplayTime" type="unsigned long">
3594	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3595	</attribute>
3596
3597	<attribute name="logoImagePath" type="wstring">
3598	<desc>
3599	Local file system path for external BIOS splash image. Empty string
3600	means the default image is shown on boot.
3601	</desc>
3602	</attribute>
3603
3604	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3605	<desc>Mode of the BIOS boot device menu.</desc>
3606	</attribute>
3607
3608	<attribute name="ACPIEnabled" type="boolean">
3609	<desc>ACPI support flag.</desc>
3610	</attribute>
3611
3612	<attribute name="IOAPICEnabled" type="boolean">
3613	<desc>
3614	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3615	and support IRQs above 15.
3616	</desc>
3617	</attribute>
3618
3619	<attribute name="timeOffset" type="long long">
3620	<desc>
3621	Offset in milliseconds from the host system time. This allows for
3622	guests running with a different system date/time than the host.
3623	It is equivalent to setting the system date/time in the BIOS except
3624	it is not an absolute value but a relative one. Guest Additions
3625	time synchronization honors this offset.
3626	</desc>
3627	</attribute>
3628
3629	<attribute name="PXEDebugEnabled" type="boolean">
3630	<desc>
3631	PXE debug logging flag. If set, VirtualBox will write extensive
3632	PXE trace information to the release log.
3633	</desc>
3634	</attribute>
3635
3636	</interface>
3637
3638	<interface
3639	name="IMachine" extends="$unknown"
3640	uuid="e2d8679e-b144-41d9-9dfa-bbe2fd0ab2d1"
3641	wsmap="managed"
3642	>
3643	<desc>
3644	The IMachine interface represents a virtual machine, or guest, created
3645	in VirtualBox.
3646
3647	This interface is used in two contexts. First of all, a collection of
3648	objects implementing this interface is stored in the
3649	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3650	machines that are currently registered with this VirtualBox
3651	installation. Also, once a session has been opened for the given virtual
3652	machine (e.g. the virtual machine is running), the machine object
3653	associated with the open session can be queried from the session object;
3654	see <link to="ISession"/> for details.
3655
3656	The main role of this interface is to expose the settings of the virtual
3657	machine and provide methods to change various aspects of the virtual
3658	machine's configuration. For machine objects stored in the
3659	<link to="IVirtualBox::machines"/> collection, all attributes are
3660	read-only unless explicitly stated otherwise in individual attribute
3661	and method descriptions.
3662
3663	In order to change a machine setting, a session for this machine must be
3664	opened using one of the <link to="IMachine::lockMachine" /> or
3665	<link to="IMachine::launchVMProcess"/> methods. After the
3666	machine has been successfully locked for a session, a mutable machine object
3667	needs to be queried from the session object and then the desired settings
3668	changes can be applied to the returned object using IMachine attributes and
3669	methods. See the <link to="ISession"/> interface description for more
3670	information about sessions.
3671
3672	Note that IMachine does not provide methods to control virtual machine
3673	execution (such as start the machine, or power it down) -- these methods
3674	are grouped in a separate interface called <link to="IConsole" />.
3675
3676	<see>ISession, IConsole</see>
3677	</desc>
3678
3679	<attribute name="parent" type="IVirtualBox" readonly="yes">
3680	<desc>Associated parent object.</desc>
3681	</attribute>
3682
3683	<attribute name="accessible" type="boolean" readonly="yes">
3684	<desc>
3685	Whether this virtual machine is currently accessible or not.
3686
3687	A machine is always deemed accessible unless it is registered <i>and</i>
3688	its settings file cannot be read or parsed (either because the file itself
3689	is unavailable or has invalid XML contents).
3690
3691	Every time this property is read, the accessibility state of
3692	this machine is re-evaluated. If the returned value is @c false,
3693	the <link to="#accessError"/> property may be used to get the
3694	detailed error information describing the reason of
3695	inaccessibility, including XML error messages.
3696
3697	When the machine is inaccessible, only the following properties
3698	can be used on it:
3699	<ul>
3700	<li><link to="#parent"/></li>
3701	<li><link to="#id"/></li>
3702	<li><link to="#settingsFilePath"/></li>
3703	<li><link to="#accessible"/></li>
3704	<li><link to="#accessError"/></li>
3705	</ul>
3706
3707	An attempt to access any other property or method will return
3708	an error.
3709
3710	The only possible action you can perform on an inaccessible
3711	machine is to unregister it using the
3712	<link to="IMachine::unregister"/> call (or, to check
3713	for the accessibility state once more by querying this
3714	property).
3715
3716	<note>
3717	In the current implementation, once this property returns
3718	@c true, the machine will never become inaccessible
3719	later, even if its settings file cannot be successfully
3720	read/written any more (at least, until the VirtualBox
3721	server is restarted). This limitation may be removed in
3722	future releases.
3723	</note>
3724	</desc>
3725	</attribute>
3726
3727	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3728	<desc>
3729	Error information describing the reason of machine
3730	inaccessibility.
3731
3732	Reading this property is only valid after the last call to
3733	<link to="#accessible"/> returned @c false (i.e. the
3734	machine is currently unaccessible). Otherwise, a @c null
3735	IVirtualBoxErrorInfo object will be returned.
3736	</desc>
3737	</attribute>
3738
3739	<attribute name="name" type="wstring">
3740	<desc>
3741	Name of the virtual machine.
3742
3743	Besides being used for human-readable identification purposes
3744	everywhere in VirtualBox, the virtual machine name is also used
3745	as a name of the machine's settings file and as a name of the
3746	subdirectory this settings file resides in. Thus, every time you
3747	change the value of this property, the settings file will be
3748	renamed once you call <link to="#saveSettings"/> to confirm the
3749	change. The containing subdirectory will be also renamed, but
3750	only if it has exactly the same name as the settings file
3751	itself prior to changing this property (for backward compatibility
3752	with previous API releases). The above implies the following
3753	limitations:
3754	<ul>
3755	<li>The machine name cannot be empty.</li>
3756	<li>The machine name can contain only characters that are valid
3757	file name characters according to the rules of the file
3758	system used to store VirtualBox configuration.</li>
3759	<li>You cannot have two or more machines with the same name
3760	if they use the same subdirectory for storing the machine
3761	settings files.</li>
3762	<li>You cannot change the name of the machine if it is running,
3763	or if any file in the directory containing the settings file
3764	is being used by another running machine or by any other
3765	process in the host operating system at a time when
3766	<link to="#saveSettings"/> is called.
3767	</li>
3768	</ul>
3769	If any of the above limitations are hit, <link to="#saveSettings"/>
3770	will return an appropriate error message explaining the exact
3771	reason and the changes you made to this machine will not be
3772	saved.
3773	<note>
3774	For "legacy" machines created using the
3775	<link to="IVirtualBox::createLegacyMachine"/> call,
3776	the above naming limitations do not apply because the
3777	machine name does not affect the settings file name.
3778	The settings file name remains the same as it was specified
3779	during machine creation and never changes.
3780	</note>
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="description" type="wstring">
3785	<desc>
3786	Description of the virtual machine.
3787
3788	The description attribute can contain any text and is
3789	typically used to describe the hardware and software
3790	configuration of the virtual machine in detail (i.e. network
3791	settings, versions of the installed software and so on).
3792	</desc>
3793	</attribute>
3794
3795	<attribute name="id" type="uuid" mod="string" readonly="yes">
3796	<desc>UUID of the virtual machine.</desc>
3797	</attribute>
3798
3799	<attribute name="OSTypeId" type="wstring">
3800	<desc>
3801	User-defined identifier of the Guest OS type.
3802	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3803	an IGuestOSType object representing details about the given
3804	Guest OS type.
3805	<note>
3806	This value may differ from the value returned by
3807	<link to="IGuest::OSTypeId"/> if Guest Additions are
3808	installed to the guest OS.
3809	</note>
3810	</desc>
3811	</attribute>
3812
3813	<attribute name="HardwareVersion" type="wstring">
3814	<desc>Hardware version identifier. Internal use only for now.</desc>
3815	</attribute>
3816
3817	<attribute name="hardwareUUID" type="uuid" mod="string">
3818	<desc>
3819	The UUID presented to the guest via memory tables, hardware and guest
3820	properties. For most VMs this is the same as the @a id, but for VMs
3821	which have been cloned or teleported it may be the same as the source
3822	VM. This latter is because the guest shouldn't notice that it was
3823	cloned or teleported.
3824	</desc>
3825	</attribute>
3826
3827	<attribute name="CPUCount" type="unsigned long">
3828	<desc>Number of virtual CPUs in the VM.</desc>
3829	</attribute>
3830
3831	<attribute name="CPUHotPlugEnabled" type="boolean">
3832	<desc>
3833	This setting determines whether VirtualBox allows CPU
3834	hotplugging for this machine.</desc>
3835	</attribute>
3836
3837	<attribute name="CPUPriority" type="unsigned long">
3838	<desc>
3839	Priority of the virtual CPUs. Means to limit the number of CPU cycles
3840	a guest can use. The unit is percentage of host CPU cycles per second.
3841	The valid range is 1 - 100. 100 (the default) implies no limit.
3842	</desc>
3843	</attribute>
3844
3845	<attribute name="memorySize" type="unsigned long">
3846	<desc>System memory size in megabytes.</desc>
3847	</attribute>
3848
3849	<attribute name="memoryBalloonSize" type="unsigned long">
3850	<desc>Memory balloon size in megabytes.</desc>
3851	</attribute>
3852
3853	<attribute name="PageFusionEnabled" type="boolean">
3854	<desc>
3855	This setting determines whether VirtualBox allows page
3856	fusion for this machine (64 bits host only).
3857	</desc>
3858	</attribute>
3859
3860	<attribute name="VRAMSize" type="unsigned long">
3861	<desc>Video memory size in megabytes.</desc>
3862	</attribute>
3863
3864	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3865	<desc>
3866	This setting determines whether VirtualBox allows this machine to make
3867	use of the 3D graphics support available on the host.</desc>
3868	</attribute>
3869
3870	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3871	<desc>
3872	This setting determines whether VirtualBox allows this machine to make
3873	use of the 2D video acceleration support available on the host.</desc>
3874	</attribute>
3875
3876	<attribute name="monitorCount" type="unsigned long">
3877	<desc>
3878	Number of virtual monitors.
3879	<note>
3880	Only effective on Windows XP and later guests with
3881	Guest Additions installed.
3882	</note>
3883	</desc>
3884	</attribute>
3885
3886	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3887	<desc>Object containing all BIOS settings.</desc>
3888	</attribute>
3889
3890	<attribute name="firmwareType" type="FirmwareType">
3891	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3892	bootstrap in this VM.</desc>
3893	</attribute>
3894
3895	<attribute name="pointingHidType" type="PointingHidType">
3896	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3897	The default is typically "PS2Mouse" but can vary depending on the
3898	requirements of the guest operating system.</desc>
3899	</attribute>
3900
3901	<attribute name="keyboardHidType" type="KeyboardHidType">
3902	<desc>Type of keyboard HID used in this VM.
3903	The default is typically "PS2Keyboard" but can vary depending on the
3904	requirements of the guest operating system.</desc>
3905	</attribute>
3906
3907	<attribute name="hpetEnabled" type="boolean">
3908	<desc>This attribute controls if High Precision Event Timer (HPET) is
3909	enabled in this VM. Use this property if you want to provide guests
3910	with additional time source, or if guest requires HPET to function correctly.
3911	Default is false.</desc>
3912	</attribute>
3913
3914	<attribute name="snapshotFolder" type="wstring">
3915	<desc>
3916	Full path to the directory used to store snapshot data
3917	(differencing media and saved state files) of this machine.
3918
3919	The initial value of this property is
3920	<tt><</tt><link to="#settingsFilePath">
3921	path_to_settings_file</link><tt>>/<</tt>
3922	<link to="#id">machine_uuid</link>
3923	<tt>></tt>.
3924
3925	Currently, it is an error to try to change this property on
3926	a machine that has snapshots (because this would require to
3927	move possibly large files to a different location).
3928	A separate method will be available for this purpose later.
3929
3930	<note>
3931	Setting this property to @c null or to an empty string will restore
3932	the initial value.
3933	</note>
3934	<note>
3935	When setting this property, the specified path can be
3936	absolute (full path) or relative to the directory where the
3937	<link to="#settingsFilePath">machine settings file</link>
3938	is located. When reading this property, a full path is
3939	always returned.
3940	</note>
3941	<note>
3942	The specified path may not exist, it will be created
3943	when necessary.
3944	</note>
3945	</desc>
3946	</attribute>
3947
3948	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
3949	<desc>VRDP server object.</desc>
3950	</attribute>
3951
3952	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3953	<desc>Array of media attached to this machine.</desc>
3954	</attribute>
3955
3956	<attribute name="USBController" type="IUSBController" readonly="yes">
3957	<desc>
3958	Associated USB controller object.
3959
3960	<note>
3961	If USB functionality is not available in the given edition of
3962	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3963	</note>
3964	</desc>
3965	</attribute>
3966
3967	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3968	<desc>Associated audio adapter, always present.</desc>
3969	</attribute>
3970
3971	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3972	<desc>Array of storage controllers attached to this machine.</desc>
3973	</attribute>
3974
3975	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3976	<desc>
3977	Full name of the file containing machine settings data.
3978	</desc>
3979	</attribute>
3980
3981	<attribute name="settingsModified" type="boolean" readonly="yes">
3982	<desc>
3983	Whether the settings of this machine have been modified
3984	(but neither yet saved nor discarded).
3985	<note>
3986	Reading this property is only valid on instances returned
3987	by <link to="ISession::machine"/> and on new machines
3988	created by <link to="IVirtualBox::createMachine"/> or opened
3989	by <link to="IVirtualBox::openMachine"/> but not
3990	yet registered, or on unregistered machines after calling
3991	<link to="IMachine::unregister"/>. For all other
3992	cases, the settings can never be modified.
3993	</note>
3994	<note>
3995	For newly created unregistered machines, the value of this
3996	property is always @c true until <link to="#saveSettings"/>
3997	is called (no matter if any machine settings have been
3998	changed after the creation or not). For opened machines
3999	the value is set to @c false (and then follows to normal rules).
4000	</note>
4001	</desc>
4002	</attribute>
4003
4004	<attribute name="sessionState" type="SessionState" readonly="yes">
4005	<desc>Current session state for this machine.</desc>
4006	</attribute>
4007
4008	<attribute name="sessionType" type="wstring" readonly="yes">
4009	<desc>
4010	Type of the session. If <link to="#sessionState"/> is
4011	Spawning or Locked, this attribute contains the
4012	same value as passed to the
4013	<link to="IMachine::launchVMProcess"/> method in the
4014	@a type parameter. If the session was used with
4015	<link to="IMachine::lockMachine" />, or if
4016	<link to="#sessionState"/> is SessionClosed, the value of this
4017	attribute is an empty string.
4018	</desc>
4019	</attribute>
4020
4021	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4022	<desc>
4023	Identifier of the session process. This attribute contains the
4024	platform-dependent identifier of the process whose session was
4025	used with <link to="IMachine::lockMachine" /> call. The returned
4026	value is only valid if <link to="#sessionState"/> is Locked or
4027	Unlocking by the time this property is read.
4028	</desc>
4029	</attribute>
4030
4031	<attribute name="state" type="MachineState" readonly="yes">
4032	<desc>Current execution state of this machine.</desc>
4033	</attribute>
4034
4035	<attribute name="lastStateChange" type="long long" readonly="yes">
4036	<desc>
4037	Time stamp of the last execution state change,
4038	in milliseconds since 1970-01-01 UTC.
4039	</desc>
4040	</attribute>
4041
4042	<attribute name="stateFilePath" type="wstring" readonly="yes">
4043	<desc>
4044	Full path to the file that stores the execution state of
4045	the machine when it is in the <link to="MachineState_Saved"/> state.
4046	<note>
4047	When the machine is not in the Saved state, this attribute is
4048	an empty string.
4049	</note>
4050	</desc>
4051	</attribute>
4052
4053	<attribute name="logFolder" type="wstring" readonly="yes">
4054	<desc>
4055	Full path to the folder that stores a set of rotated log files
4056	recorded during machine execution. The most recent log file is
4057	named <tt>VBox.log</tt>, the previous log file is
4058	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4059	in the current version).
4060	</desc>
4061	</attribute>
4062
4063	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4064	<desc>
4065	Current snapshot of this machine. This is @c null if the machine
4066	currently has no snapshots. If it is not @c null, then it was
4067	set by one of <link to="IConsole::takeSnapshot" />,
4068	<link to="IConsole::deleteSnapshot" />
4069	or <link to="IConsole::restoreSnapshot" />, depending on which
4070	was called last. See <link to="ISnapshot"/> for details.
4071	</desc>
4072	</attribute>
4073
4074	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4075	<desc>
4076	Number of snapshots taken on this machine. Zero means the
4077	machine doesn't have any snapshots.
4078	</desc>
4079	</attribute>
4080
4081	<attribute name="currentStateModified" type="boolean" readonly="yes">
4082	<desc>
4083	Returns @c true if the current state of the machine is not
4084	identical to the state stored in the current snapshot.
4085
4086	The current state is identical to the current snapshot only
4087	directly after one of the following calls are made:
4088
4089	<ul>
4090	<li><link to="IConsole::restoreSnapshot"/>
4091	</li>
4092	<li><link to="IConsole::takeSnapshot"/> (issued on a
4093	"powered off" or "saved" machine, for which
4094	<link to="#settingsModified"/> returns @c false)
4095	</li>
4096	<li><link to="IMachine::setCurrentSnapshot"/>
4097	</li>
4098	</ul>
4099
4100	The current state remains identical until one of the following
4101	happens:
4102	<ul>
4103	<li>settings of the machine are changed</li>
4104	<li>the saved state is deleted</li>
4105	<li>the current snapshot is deleted</li>
4106	<li>an attempt to execute the machine is made</li>
4107	</ul>
4108
4109	<note>
4110	For machines that don't have snapshots, this property is
4111	always @c false.
4112	</note>
4113	</desc>
4114	</attribute>
4115
4116	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4117	<desc>
4118	Collection of shared folders for this machine (permanent shared
4119	folders). These folders are shared automatically at machine startup
4120	and available only to the guest OS installed within this machine.
4121
4122	New shared folders are added to the collection using
4123	<link to="#createSharedFolder"/>. Existing shared folders can be
4124	removed using <link to="#removeSharedFolder"/>.
4125	</desc>
4126	</attribute>
4127
4128	<attribute name="clipboardMode" type="ClipboardMode">
4129	<desc>
4130	Synchronization mode between the host OS clipboard
4131	and the guest OS clipboard.
4132	</desc>
4133	</attribute>
4134
4135	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4136	<desc>
4137	A comma-separated list of simple glob patterns. Changes to guest
4138	properties whose name matches one of the patterns will generate an
4139	<link to="IGuestPropertyChangedEvent"/> signal.
4140	</desc>
4141	</attribute>
4142
4143	<attribute name="teleporterEnabled" type="boolean">
4144	<desc>
4145	When set to @a true, the virtual machine becomes a target teleporter
4146	the next time it is powered on. This can only set to @a true when the
4147	VM is in the @a PoweredOff or @a Aborted state.
4148
4149	<!-- This property is automatically set to @a false when the VM is powered
4150	on. (bird: This doesn't work yet ) -->
4151	</desc>
4152	</attribute>
4153
4154	<attribute name="teleporterPort" type="unsigned long">
4155	<desc>
4156	The TCP port the target teleporter will listen for incoming
4157	teleportations on.
4158
4159	0 means the port is automatically selected upon power on. The actual
4160	value can be read from this property while the machine is waiting for
4161	incoming teleportations.
4162	</desc>
4163	</attribute>
4164
4165	<attribute name="teleporterAddress" type="wstring">
4166	<desc>
4167	The address the target teleporter will listen on. If set to an empty
4168	string, it will listen on all addresses.
4169	</desc>
4170	</attribute>
4171
4172	<attribute name="teleporterPassword" type="wstring">
4173	<desc>
4174	The password the to check for on the target teleporter. This is just a
4175	very basic measure to prevent simple hacks and operators accidentally
4176	beaming a virtual machine to the wrong place.
4177	</desc>
4178	</attribute>
4179
4180	<attribute name="RTCUseUTC" type="boolean">
4181	<desc>
4182	When set to @a true, the RTC device of the virtual machine will run
4183	in UTC time, otherwise in local time. Especially Unix guests prefer
4184	the time in UTC.
4185	</desc>
4186	</attribute>
4187
4188	<attribute name="ioCacheEnabled" type="boolean">
4189	<desc>
4190	When set to @a true, the builtin I/O cache of the virtual machine
4191	will be enabled.
4192	</desc>
4193	</attribute>
4194
4195	<attribute name="ioCacheSize" type="unsigned long">
4196	<desc>
4197	Maximum size of the I/O cache in MB.
4198	</desc>
4199	</attribute>
4200
4201	<method name="lockMachine">
4202	<desc>
4203	Locks the machine for the given session to enable the caller
4204	to make changes to the machine or start the VM or control
4205	VM execution.
4206
4207	There are two ways to lock a machine for such uses:
4208
4209	<ul>
4210	<li>If you want to make changes to the machine settings,
4211	you must obtain an exclusive write lock on the machine
4212	by setting @a lockType to @c Write.
4213
4214	This will only succeed if no other process has locked
4215	the machine to prevent conflicting changes. Only after
4216	an exclusive write lock has been obtained using this method, one
4217	can change all VM settings or execute the VM in the process
4218	space of the session object. (Note that the latter is only of
4219	interest if you actually want to write a new front-end for
4220	virtual machines; but this API gets called internally by
4221	the existing front-ends such as VBoxHeadless and the VirtualBox
4222	GUI to acquire a write lock on the machine that they are running.)
4223
4224	On success, write-locking the machine for a session creates
4225	a second copy of the IMachine object. It is this second object
4226	upon which changes can be made; in VirtualBox terminology, the
4227	second copy is "mutable". It is only this second, mutable machine
4228	object upon which you can call methods that change the
4229	machine state. After having called this method, you can
4230	obtain this second, mutable machine object using the
4231	<link to="ISession::machine" /> attribute.
4232	</li>
4233	<li>If you only want to check the machine state or control
4234	machine execution without actually changing machine
4235	settings (e.g. to get access to VM statistics or take
4236	a snapshot or save the machine state), then set the
4237	@a lockType argument to @c Shared.
4238
4239	If no other session has obtained a lock, you will obtain an
4240	exclusive write lock as described above. However, if another
4241	session has already obtained such a lock, then a link to that
4242	existing session will be established which allows you
4243	to control that existing session.
4244
4245	To find out which type of lock was obtained, you can
4246	inspect <link to="ISession::type" />, which will have been
4247	set to either @c WriteLock or @c Shared.
4248	</li>
4249	</ul>
4250
4251	In either case, you can get access to the <link to="IConsole" />
4252	object which controls VM execution.
4253
4254	Also in all of the above cases, one must always call
4255	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4256	the machine's state will eventually be set to "Aborted".
4257
4258	To change settings on a machine, the following sequence is typically
4259	performed:
4260
4261	<ol>
4262	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4263
4264	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4265
4266	<li>Change the settings of the machine by invoking IMachine methods.</li>
4267
4268	<li>Call <link to="IMachine::saveSettings" />.</li>
4269
4270	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4271	</ol>
4272
4273	<result name="E_UNEXPECTED">
4274	Virtual machine not registered.
4275	</result>
4276	<result name="E_ACCESSDENIED">
4277	Process not started by OpenRemoteSession.
4278	</result>
4279	<result name="VBOX_E_INVALID_OBJECT_STATE">
4280	Session already open or being opened.
4281	</result>
4282	<result name="VBOX_E_VM_ERROR">
4283	Failed to assign machine to session.
4284	</result>
4285	</desc>
4286	<param name="session" type="ISession" dir="in">
4287	<desc>
4288	Session object for which the machine will be locked.
4289	</desc>
4290	</param>
4291	<param name="lockType" type="LockType" dir="in">
4292	<desc>
4293	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4294	If set to @c Shared, then either acquire an exclusive write lock or establish
4295	a link to an existing session.
4296	</desc>
4297	</param>
4298	</method>
4299
4300	<method name="launchVMProcess">
4301	<desc>
4302	Spawns a new process that will execute the virtual machine and obtains a shared
4303	lock on the machine for the calling session.
4304
4305	If launching the VM succeeds, the new VM process will create its own session
4306	and write-lock the machine for it, preventing conflicting changes from other
4307	processes. If the machine is already locked (because it is already running or
4308	because another session has a write lock), launching the VM process will therefore
4309	fail. Reversely, future attempts to obtain a write lock will also fail while the
4310	machine is running.
4311
4312	The caller's session object remains separate from the session opened by the new
4313	VM process. It receives its own <link to="IConsole" /> object which can be used
4314	to control machine execution, but it cannot be used to change all VM settings
4315	which would be available after a <link to="#lockMachine" /> call.
4316
4317	The caller must eventually release the session's shared lock by calling
4318	<link to="ISession::unlockMachine" /> on the local session object once this call
4319	has returned. However, the session's state (see <link to="ISession::state" />)
4320	will not return to "Unlocked" until the remote session has also unlocked
4321	the machine (i.e. the machine has stopped running).
4322
4323	Lauching a VM process can take some time (a new VM is started in a new process,
4324	for which memory and other resources need to be set up). Because of this,
4325	an <link to="IProgress" /> object is returned to allow the caller to wait
4326	for this asynchronous operation to be completed. Until then, the caller's
4327	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4328	and <link to="ISession::console" /> attributes cannot be accessed.
4329	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4330	similar calls to wait for completion. Completion is signalled when the VM
4331	is powered on. If launching the VM fails, error messages can be queried
4332	via the progress object, if available.
4333
4334	The progress object will have at least 2 sub-operations. The first
4335	operation covers the period up to the new VM process calls powerUp.
4336	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4337	progress object. Because <link to="IConsole::powerUp"/> may require
4338	some extra sub-operations, the <link to="IProgress::operationCount"/>
4339	may change at the completion of operation.
4340
4341	For details on the teleportation progress operation, see
4342	<link to="IConsole::powerUp"/>.
4343
4344	The @a environment argument is a string containing definitions of
4345	environment variables in the following format:
4346	@code
4347	NAME[=VALUE]\n
4348	NAME[=VALUE]\n
4349	...
4350	@endcode
4351	where <tt>\\n</tt> is the new line character. These environment
4352	variables will be appended to the environment of the VirtualBox server
4353	process. If an environment variable exists both in the server process
4354	and in this list, the value from this list takes precedence over the
4355	server's variable. If the value of the environment variable is
4356	omitted, this variable will be removed from the resulting environment.
4357	If the environment string is @c null or empty, the server environment
4358	is inherited by the started process as is.
4359
4360	<result name="E_UNEXPECTED">
4361	Virtual machine not registered.
4362	</result>
4363	<result name="E_INVALIDARG">
4364	Invalid session type @a type.
4365	</result>
4366	<result name="VBOX_E_OBJECT_NOT_FOUND">
4367	No machine matching @a machineId found.
4368	</result>
4369	<result name="VBOX_E_INVALID_OBJECT_STATE">
4370	Session already open or being opened.
4371	</result>
4372	<result name="VBOX_E_IPRT_ERROR">
4373	Launching process for machine failed.
4374	</result>
4375	<result name="VBOX_E_VM_ERROR">
4376	Failed to assign machine to session.
4377	</result>
4378	</desc>
4379	<param name="session" type="ISession" dir="in">
4380	<desc>
4381	Client session object to which the VM process will be connected (this
4382	must be in "Unlocked" state).
4383	</desc>
4384	</param>
4385	<param name="type" type="wstring" dir="in">
4386	<desc>
4387	Front-end to use for the new VM process. The following are currently supported:
4388	<ul>
4389	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4390	<li><tt>"vrdp"</tt>: VBoxHeadless (VRDP Server) front-end</li>
4391	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4392	</ul>
4393	</desc>
4394	</param>
4395	<param name="environment" type="wstring" dir="in">
4396	<desc>
4397	Environment to pass to the VM process.
4398	</desc>
4399	</param>
4400	<param name="progress" type="IProgress" dir="return">
4401	<desc>Progress object to track the operation completion.</desc>
4402	</param>
4403	</method>
4404
4405	<method name="setBootOrder">
4406	<desc>
4407	Puts the given device to the specified position in
4408	the boot order.
4409
4410	To indicate that no device is associated with the given position,
4411	<link to="DeviceType_Null"/> should be used.
4412
4413	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4414
4415	<result name="E_INVALIDARG">
4416	Boot @a position out of range.
4417	</result>
4418	<result name="E_NOTIMPL">
4419	Booting from USB @a device currently not supported.
4420	</result>
4421
4422	</desc>
4423	<param name="position" type="unsigned long" dir="in">
4424	<desc>
4425	Position in the boot order (@c 1 to the total number of
4426	devices the machine can boot from, as returned by
4427	<link to="ISystemProperties::maxBootPosition"/>).
4428	</desc>
4429	</param>
4430	<param name="device" type="DeviceType" dir="in">
4431	<desc>
4432	The type of the device used to boot at the given position.
4433	</desc>
4434	</param>
4435	</method>
4436
4437	<method name="getBootOrder" const="yes">
4438	<desc>
4439	Returns the device type that occupies the specified
4440	position in the boot order.
4441
4442	@todo [remove?]
4443	If the machine can have more than one device of the returned type
4444	(such as hard disks), then a separate method should be used to
4445	retrieve the individual device that occupies the given position.
4446
4447	If here are no devices at the given position, then
4448	<link to="DeviceType_Null"/> is returned.
4449
4450	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4451
4452	<result name="E_INVALIDARG">
4453	Boot @a position out of range.
4454	</result>
4455
4456	</desc>
4457	<param name="position" type="unsigned long" dir="in">
4458	<desc>
4459	Position in the boot order (@c 1 to the total number of
4460	devices the machine can boot from, as returned by
4461	<link to="ISystemProperties::maxBootPosition"/>).
4462	</desc>
4463	</param>
4464	<param name="device" type="DeviceType" dir="return">
4465	<desc>
4466	Device at the given position.
4467	</desc>
4468	</param>
4469	</method>
4470
4471	<method name="attachDevice">
4472	<desc>
4473	Attaches a device and optionally mounts a medium to the given storage
4474	controller (<link to="IStorageController" />, identified by @a name),
4475	at the indicated port and device.
4476
4477	This method is intended for managing storage devices in general (it works
4478	for both fixed and removable media) while a machine is powered off.
4479	In a VM's default configuration of virtual machines, the secondary
4480	master of the IDE controller is used for a CD/DVD drive.
4481
4482	For fixed media such as hard disks, the given medium identifier cannot
4483	be a zero UUID.
4484
4485	For storage devices supporting removable media (such as DVDs and floppies),
4486	you can also use <link to="IMachine::mountMedium"/> for changing the media
4487	while the machine is running. For those devices, you can also specify
4488	a zero UUID to indicate an empty drive or the UUID of a host drive;
4489	see <link to="IMediumAttachment" /> for details.
4490
4491	After calling this returns successfully, a new instance of
4492	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4493	attachments (see <link to="IMachine::mediumAttachments"/>).
4494
4495	The specified device slot must not have a device attached to it,
4496	or this method will fail.
4497
4498	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4499	information about attaching media.
4500
4501	<note>
4502	You cannot attach a device to a running machine. Also, you cannot
4503	attach a device to a newly created machine until this machine's
4504	settings are saved to disk using <link to="#saveSettings"/>.
4505	</note>
4506	<note>
4507	If the medium is being attached indirectly, a new differencing medium
4508	will implicitly be created for it and attached instead. If the
4509	changes made to the machine settings (including this indirect
4510	attachment) are later cancelled using <link to="#discardSettings"/>,
4511	this implicitly created differencing medium will implicitly
4512	be deleted.
4513	</note>
4514
4515	<result name="E_INVALIDARG">
4516	SATA device, SATA port, IDE port or IDE slot out of range.
4517	</result>
4518	<result name="VBOX_E_INVALID_OBJECT_STATE">
4519	Machine must be registered before media can be attached.
4520	</result>
4521	<result name="VBOX_E_INVALID_VM_STATE">
4522	Invalid machine state.
4523	</result>
4524	<result name="VBOX_E_OBJECT_IN_USE">
4525	A medium is already attached to this or another virtual machine.
4526	</result>
4527
4528	</desc>
4529	<param name="name" type="wstring" dir="in">
4530	<desc>Name of the storage controller to attach the device to.</desc>
4531	</param>
4532	<param name="controllerPort" type="long" dir="in">
4533	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4534	the primary controller and 1 specifies the secondary controller.
4535	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4536	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4537	</param>
4538	<param name="device" type="long" dir="in">
4539	<desc>Device slot in the given port to attach the device to. This is only
4540	relevant for IDE controllers, for which 0 specifies the master device and
4541	1 specifies the slave device. For all other controller types, this must
4542	be 0.</desc>
4543	</param>
4544	<param name="type" type="DeviceType" dir="in">
4545	<desc>Device type of the attached device.</desc>
4546	</param>
4547	<param name="id" type="uuid" mod="string" dir="in">
4548	<desc>UUID of the medium to mount. Can be a zero UUID or the UUID of
4549	a host drive for removeable media; see <link to="IMediumAttachment" />
4550	for details.</desc>
4551	</param>
4552	</method>
4553
4554	<method name="detachDevice">
4555	<desc>
4556	Detaches the device attached to a device slot of the specified bus.
4557
4558	Detaching the device from the virtual machine is deferred. This means
4559	that the medium remains associated with the machine when this method
4560	returns and gets actually de-associated only after a successful
4561	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4562	for more detailed information about attaching media.
4563
4564	<note>
4565	You cannot detach a device from a running machine.
4566	</note>
4567	<note>
4568	Detaching differencing media implicitly created by <link
4569	to="#attachDevice"/> for the indirect attachment using this
4570	method will <b>not</b> implicitly delete them. The
4571	<link to="IMedium::deleteStorage"/> operation should be
4572	explicitly performed by the caller after the medium is successfully
4573	detached and the settings are saved with
4574	<link to="#saveSettings"/>, if it is the desired action.
4575	</note>
4576
4577	<result name="VBOX_E_INVALID_VM_STATE">
4578	Attempt to detach medium from a running virtual machine.
4579	</result>
4580	<result name="VBOX_E_OBJECT_NOT_FOUND">
4581	No medium attached to given slot/bus.
4582	</result>
4583	<result name="VBOX_E_NOT_SUPPORTED">
4584	Medium format does not support storage deletion.
4585	</result>
4586
4587	</desc>
4588	<param name="name" type="wstring" dir="in">
4589	<desc>Name of the storage controller to detach the medium from.</desc>
4590	</param>
4591	<param name="controllerPort" type="long" dir="in">
4592	<desc>Port number to detach the medium from.</desc>
4593	</param>
4594	<param name="device" type="long" dir="in">
4595	<desc>Device slot number to detach the medium from.</desc>
4596	</param>
4597	</method>
4598
4599	<method name="passthroughDevice">
4600	<desc>
4601	Sets the passthrough mode of an existing DVD device. Changing the
4602	setting while the VM is running is forbidden. The setting is only used
4603	if at VM start the device is configured as a host DVD drive, in all
4604	other cases it is ignored. The device must already exist; see
4605	<link to="IMachine::attachDevice"/> for how to attach a new device.
4606
4607	The @a controllerPort and @a device parameters specify the device slot and
4608	have have the same meaning as with <link to="IMachine::attachDevice" />.
4609
4610	<result name="E_INVALIDARG">
4611	SATA device, SATA port, IDE port or IDE slot out of range.
4612	</result>
4613	<result name="VBOX_E_INVALID_OBJECT_STATE">
4614	Attempt to modify an unregistered virtual machine.
4615	</result>
4616	<result name="VBOX_E_INVALID_VM_STATE">
4617	Invalid machine state.
4618	</result>
4619
4620	</desc>
4621	<param name="name" type="wstring" dir="in">
4622	<desc>Name of the storage controller.</desc>
4623	</param>
4624	<param name="controllerPort" type="long" dir="in">
4625	<desc>Storage controller port.</desc>
4626	</param>
4627	<param name="device" type="long" dir="in">
4628	<desc>Device slot in the given port.</desc>
4629	</param>
4630	<param name="passthrough" type="boolean" dir="in">
4631	<desc>New value for the passthrough setting.</desc>
4632	</param>
4633	</method>
4634
4635	<method name="mountMedium">
4636	<desc>
4637	Mounts a medium (<link to="IMedium" />, identified
4638	by the given UUID @a id) to the given storage controller
4639	(<link to="IStorageController" />, identified by @a name),
4640	at the indicated port and device. The device must already exist;
4641	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4642
4643	This method is intended only for managing removable media, where the
4644	device is fixed but media is changeable at runtime (such as DVDs
4645	and floppies). It cannot be used for fixed media such as hard disks.
4646
4647	The @a controllerPort and @a device parameters specify the device slot and
4648	have have the same meaning as with <link to="IMachine::attachDevice" />.
4649
4650	The specified device slot can have a medium mounted, which will be
4651	unmounted first. Specifying a zero UUID (or an empty string) for
4652	@a medium does just an unmount.
4653
4654	See <link to="IMedium"/> for more detailed information about
4655	attaching media.
4656
4657	<result name="E_INVALIDARG">
4658	SATA device, SATA port, IDE port or IDE slot out of range.
4659	</result>
4660	<result name="VBOX_E_INVALID_OBJECT_STATE">
4661	Attempt to attach medium to an unregistered virtual machine.
4662	</result>
4663	<result name="VBOX_E_INVALID_VM_STATE">
4664	Invalid machine state.
4665	</result>
4666	<result name="VBOX_E_OBJECT_IN_USE">
4667	Medium already attached to this or another virtual machine.
4668	</result>
4669
4670	</desc>
4671	<param name="name" type="wstring" dir="in">
4672	<desc>Name of the storage controller to attach the medium to.</desc>
4673	</param>
4674	<param name="controllerPort" type="long" dir="in">
4675	<desc>Port to attach the medium to.</desc>
4676	</param>
4677	<param name="device" type="long" dir="in">
4678	<desc>Device slot in the given port to attach the medium to.</desc>
4679	</param>
4680	<param name="medium" type="uuid" mod="string" dir="in">
4681	<desc>UUID of the medium to attach. A zero UUID means unmount the
4682	currently mounted medium.</desc>
4683	</param>
4684	<param name="force" type="boolean" dir="in">
4685	<desc>Allows to force unmount/mount of a medium which is locked by
4686	theDevice slot in the given port to attach the medium to.</desc>
4687	</param>
4688	</method>
4689
4690	<method name="getMedium" const="yes">
4691	<desc>
4692	Returns the virtual medium attached to a device slot of the specified
4693	bus.
4694
4695	Note that if the medium was indirectly attached by
4696	<link to="#mountMedium"/> to the given device slot then this
4697	method will return not the same object as passed to the
4698	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4699	more detailed information about mounting a medium.
4700
4701	<result name="VBOX_E_OBJECT_NOT_FOUND">
4702	No medium attached to given slot/bus.
4703	</result>
4704
4705	</desc>
4706	<param name="name" type="wstring" dir="in">
4707	<desc>Name of the storage controller the medium is attached to.</desc>
4708	</param>
4709	<param name="controllerPort" type="long" dir="in">
4710	<desc>Port to query.</desc>
4711	</param>
4712	<param name="device" type="long" dir="in">
4713	<desc>Device slot in the given port to query.</desc>
4714	</param>
4715	<param name="medium" type="IMedium" dir="return">
4716	<desc>Attached medium object.</desc>
4717	</param>
4718	</method>
4719
4720	<method name="getMediumAttachmentsOfController" const="yes">
4721	<desc>
4722	Returns an array of medium attachments which are attached to the
4723	the controller with the given name.
4724
4725	<result name="VBOX_E_OBJECT_NOT_FOUND">
4726	A storage controller with given name doesn't exist.
4727	</result>
4728	</desc>
4729	<param name="name" type="wstring" dir="in"/>
4730	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4731	</method>
4732
4733	<method name="getMediumAttachment" const="yes">
4734	<desc>
4735	Returns a medium attachment which corresponds to the controller with
4736	the given name, on the given port and device slot.
4737
4738	<result name="VBOX_E_OBJECT_NOT_FOUND">
4739	No attachment exists for the given controller/port/device combination.
4740	</result>
4741	</desc>
4742	<param name="name" type="wstring" dir="in"/>
4743	<param name="controllerPort" type="long" dir="in"/>
4744	<param name="device" type="long" dir="in"/>
4745	<param name="attachment" type="IMediumAttachment" dir="return"/>
4746	</method>
4747
4748	<method name="getNetworkAdapter" const="yes">
4749	<desc>
4750	Returns the network adapter associated with the given slot.
4751	Slots are numbered sequentially, starting with zero. The total
4752	number of adapters per machine is defined by the
4753	<link to="ISystemProperties::networkAdapterCount"/> property,
4754	so the maximum slot number is one less than that property's value.
4755
4756	<result name="E_INVALIDARG">
4757	Invalid @a slot number.
4758	</result>
4759
4760	</desc>
4761	<param name="slot" type="unsigned long" dir="in"/>
4762	<param name="adapter" type="INetworkAdapter" dir="return"/>
4763	</method>
4764
4765	<method name="addStorageController">
4766	<desc>
4767	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4768	machine and returns it as an instance of
4769	<link to="IStorageController" />.
4770
4771	@a name identifies the controller for subsequent calls such as
4772	<link to="#getStorageControllerByName" />,
4773	<link to="#getStorageControllerByInstance" />,
4774	<link to="#removeStorageController" />,
4775	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4776
4777	After the controller has been added, you can set its exact
4778	type by setting the <link to="IStorageController::controllerType" />.
4779
4780	<result name="VBOX_E_OBJECT_IN_USE">
4781	A storage controller with given name exists already.
4782	</result>
4783	<result name="E_INVALIDARG">
4784	Invalid @a controllerType.
4785	</result>
4786	</desc>
4787	<param name="name" type="wstring" dir="in"/>
4788	<param name="connectionType" type="StorageBus" dir="in"/>
4789	<param name="controller" type="IStorageController" dir="return"/>
4790	</method>
4791
4792	<method name="getStorageControllerByName" const="yes">
4793	<desc>
4794	Returns a storage controller with the given name.
4795
4796	<result name="VBOX_E_OBJECT_NOT_FOUND">
4797	A storage controller with given name doesn't exist.
4798	</result>
4799	</desc>
4800	<param name="name" type="wstring" dir="in"/>
4801	<param name="storageController" type="IStorageController" dir="return"/>
4802	</method>
4803
4804	<method name="getStorageControllerByInstance" const="yes">
4805	<desc>
4806	Returns a storage controller with the given instance number.
4807
4808	<result name="VBOX_E_OBJECT_NOT_FOUND">
4809	A storage controller with given instance number doesn't exist.
4810	</result>
4811	</desc>
4812	<param name="instance" type="unsigned long" dir="in"/>
4813	<param name="storageController" type="IStorageController" dir="return"/>
4814	</method>
4815
4816	<method name="removeStorageController">
4817	<desc>
4818	Removes a storage controller from the machine.
4819
4820	<result name="VBOX_E_OBJECT_NOT_FOUND">
4821	A storage controller with given name doesn't exist.
4822	</result>
4823	</desc>
4824	<param name="name" type="wstring" dir="in"/>
4825	</method>
4826
4827	<method name="getSerialPort" const="yes">
4828	<desc>
4829	Returns the serial port associated with the given slot.
4830	Slots are numbered sequentially, starting with zero. The total
4831	number of serial ports per machine is defined by the
4832	<link to="ISystemProperties::serialPortCount"/> property,
4833	so the maximum slot number is one less than that property's value.
4834
4835	<result name="E_INVALIDARG">
4836	Invalid @a slot number.
4837	</result>
4838
4839	</desc>
4840	<param name="slot" type="unsigned long" dir="in"/>
4841	<param name="port" type="ISerialPort" dir="return"/>
4842	</method>
4843
4844	<method name="getParallelPort" const="yes">
4845	<desc>
4846	Returns the parallel port associated with the given slot.
4847	Slots are numbered sequentially, starting with zero. The total
4848	number of parallel ports per machine is defined by the
4849	<link to="ISystemProperties::parallelPortCount"/> property,
4850	so the maximum slot number is one less than that property's value.
4851
4852	<result name="E_INVALIDARG">
4853	Invalid @a slot number.
4854	</result>
4855
4856	</desc>
4857	<param name="slot" type="unsigned long" dir="in"/>
4858	<param name="port" type="IParallelPort" dir="return"/>
4859	</method>
4860
4861	<method name="getExtraDataKeys">
4862	<desc>
4863	Returns an array representing the machine-specific extra data keys
4864	which currently have values defined.
4865	</desc>
4866	<param name="value" type="wstring" dir="return" safearray="yes">
4867	<desc>Array of extra data keys.</desc>
4868	</param>
4869	</method>
4870
4871	<method name="getExtraData">
4872	<desc>
4873	Returns associated machine-specific extra data.
4874
4875	If the requested data @a key does not exist, this function will
4876	succeed and return an empty string in the @a value argument.
4877
4878	<result name="VBOX_E_FILE_ERROR">
4879	Settings file not accessible.
4880	</result>
4881	<result name="VBOX_E_XML_ERROR">
4882	Could not parse the settings file.
4883	</result>
4884
4885	</desc>
4886	<param name="key" type="wstring" dir="in">
4887	<desc>Name of the data key to get.</desc>
4888	</param>
4889	<param name="value" type="wstring" dir="return">
4890	<desc>Value of the requested data key.</desc>
4891	</param>
4892	</method>
4893
4894	<method name="setExtraData">
4895	<desc>
4896	Sets associated machine-specific extra data.
4897
4898	If you pass @c null or an empty string as a key @a value, the given
4899	@a key will be deleted.
4900
4901	<note>
4902	Before performing the actual data change, this method will ask all
4903	registered listeners using the
4904	<link to="IExtraDataCanChangeEvent"/>
4905	notification for a permission. If one of the listeners refuses the
4906	new value, the change will not be performed.
4907	</note>
4908	<note>
4909	On success, the
4910	<link to="IExtraDataChangedEvent"/> notification
4911	is called to inform all registered listeners about a successful data
4912	change.
4913	</note>
4914	<note>
4915	This method can be called outside the machine session and therefore
4916	it's a caller's responsibility to handle possible race conditions
4917	when several clients change the same key at the same time.
4918	</note>
4919
4920	<result name="VBOX_E_FILE_ERROR">
4921	Settings file not accessible.
4922	</result>
4923	<result name="VBOX_E_XML_ERROR">
4924	Could not parse the settings file.
4925	</result>
4926
4927	</desc>
4928	<param name="key" type="wstring" dir="in">
4929	<desc>Name of the data key to set.</desc>
4930	</param>
4931	<param name="value" type="wstring" dir="in">
4932	<desc>Value to assign to the key.</desc>
4933	</param>
4934	</method>
4935
4936	<method name="getCPUProperty" const="yes">
4937	<desc>
4938	Returns the virtual CPU boolean value of the specified property.
4939
4940	<result name="E_INVALIDARG">
4941	Invalid property.
4942	</result>
4943
4944	</desc>
4945	<param name="property" type="CPUPropertyType" dir="in">
4946	<desc>
4947	Property type to query.
4948	</desc>
4949	</param>
4950	<param name="value" type="boolean" dir="return">
4951	<desc>
4952	Property value.
4953	</desc>
4954	</param>
4955	</method>
4956
4957	<method name="setCPUProperty">
4958	<desc>
4959	Sets the virtual CPU boolean value of the specified property.
4960
4961	<result name="E_INVALIDARG">
4962	Invalid property.
4963	</result>
4964
4965	</desc>
4966	<param name="property" type="CPUPropertyType" dir="in">
4967	<desc>
4968	Property type to query.
4969	</desc>
4970	</param>
4971	<param name="value" type="boolean" dir="in">
4972	<desc>
4973	Property value.
4974	</desc>
4975	</param>
4976	</method>
4977
4978	<method name="getCPUIDLeaf" const="yes">
4979	<desc>
4980	Returns the virtual CPU cpuid information for the specified leaf.
4981
4982	Currently supported index values for cpuid:
4983	Standard CPUID leafs: 0 - 0xA
4984	Extended CPUID leafs: 0x80000000 - 0x8000000A
4985
4986	See the Intel and AMD programmer's manuals for detailed information
4987	about the cpuid instruction and its leafs.
4988	<result name="E_INVALIDARG">
4989	Invalid id.
4990	</result>
4991
4992	</desc>
4993	<param name="id" type="unsigned long" dir="in">
4994	<desc>
4995	CPUID leaf index.
4996	</desc>
4997	</param>
4998	<param name="valEax" type="unsigned long" dir="out">
4999	<desc>
5000	CPUID leaf value for register eax.
5001	</desc>
5002	</param>
5003	<param name="valEbx" type="unsigned long" dir="out">
5004	<desc>
5005	CPUID leaf value for register ebx.
5006	</desc>
5007	</param>
5008	<param name="valEcx" type="unsigned long" dir="out">
5009	<desc>
5010	CPUID leaf value for register ecx.
5011	</desc>
5012	</param>
5013	<param name="valEdx" type="unsigned long" dir="out">
5014	<desc>
5015	CPUID leaf value for register edx.
5016	</desc>
5017	</param>
5018	</method>
5019
5020	<method name="setCPUIDLeaf">
5021	<desc>
5022	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5023	are not passed unmodified. VirtualBox clears features that it doesn't support.
5024
5025	Currently supported index values for cpuid:
5026	Standard CPUID leafs: 0 - 0xA
5027	Extended CPUID leafs: 0x80000000 - 0x8000000A
5028
5029	See the Intel and AMD programmer's manuals for detailed information
5030	about the cpuid instruction and its leafs.
5031
5032	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5033	random crashes inside VMs.
5034	<result name="E_INVALIDARG">
5035	Invalid id.
5036	</result>
5037
5038	</desc>
5039	<param name="id" type="unsigned long" dir="in">
5040	<desc>
5041	CPUID leaf index.
5042	</desc>
5043	</param>
5044	<param name="valEax" type="unsigned long" dir="in">
5045	<desc>
5046	CPUID leaf value for register eax.
5047	</desc>
5048	</param>
5049	<param name="valEbx" type="unsigned long" dir="in">
5050	<desc>
5051	CPUID leaf value for register ebx.
5052	</desc>
5053	</param>
5054	<param name="valEcx" type="unsigned long" dir="in">
5055	<desc>
5056	CPUID leaf value for register ecx.
5057	</desc>
5058	</param>
5059	<param name="valEdx" type="unsigned long" dir="in">
5060	<desc>
5061	CPUID leaf value for register edx.
5062	</desc>
5063	</param>
5064	</method>
5065
5066	<method name="removeCPUIDLeaf">
5067	<desc>
5068	Removes the virtual CPU cpuid leaf for the specified index
5069
5070	<result name="E_INVALIDARG">
5071	Invalid id.
5072	</result>
5073
5074	</desc>
5075	<param name="id" type="unsigned long" dir="in">
5076	<desc>
5077	CPUID leaf index.
5078	</desc>
5079	</param>
5080	</method>
5081
5082	<method name="removeAllCPUIDLeaves">
5083	<desc>
5084	Removes all the virtual CPU cpuid leaves
5085	</desc>
5086	</method>
5087
5088	<method name="getHWVirtExProperty" const="yes">
5089	<desc>
5090	Returns the value of the specified hardware virtualization boolean property.
5091
5092	<result name="E_INVALIDARG">
5093	Invalid property.
5094	</result>
5095
5096	</desc>
5097	<param name="property" type="HWVirtExPropertyType" dir="in">
5098	<desc>
5099	Property type to query.
5100	</desc>
5101	</param>
5102	<param name="value" type="boolean" dir="return">
5103	<desc>
5104	Property value.
5105	</desc>
5106	</param>
5107	</method>
5108
5109	<method name="setHWVirtExProperty">
5110	<desc>
5111	Sets a new value for the specified hardware virtualization boolean property.
5112
5113	<result name="E_INVALIDARG">
5114	Invalid property.
5115	</result>
5116
5117	</desc>
5118	<param name="property" type="HWVirtExPropertyType" dir="in">
5119	<desc>
5120	Property type to set.
5121	</desc>
5122	</param>
5123	<param name="value" type="boolean" dir="in">
5124	<desc>
5125	New property value.
5126	</desc>
5127	</param>
5128	</method>
5129
5130	<method name="saveSettings">
5131	<desc>
5132	Saves any changes to machine settings made since the session
5133	has been opened or a new machine has been created, or since the
5134	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5135	For registered machines, new settings become visible to all
5136	other VirtualBox clients after successful invocation of this
5137	method.
5138	<note>
5139	The method sends <link to="IMachineDataChangedEvent"/>
5140	notification event after the configuration has been successfully
5141	saved (only for registered machines).
5142	</note>
5143	<note>
5144	Calling this method is only valid on instances returned
5145	by <link to="ISession::machine"/> and on new machines
5146	created by <link to="IVirtualBox::createMachine"/> but not
5147	yet registered, or on unregistered machines after calling
5148	<link to="IMachine::unregister"/>.
5149	</note>
5150
5151	<result name="VBOX_E_FILE_ERROR">
5152	Settings file not accessible.
5153	</result>
5154	<result name="VBOX_E_XML_ERROR">
5155	Could not parse the settings file.
5156	</result>
5157	<result name="E_ACCESSDENIED">
5158	Modification request refused.
5159	</result>
5160
5161	</desc>
5162	</method>
5163
5164	<method name="discardSettings">
5165	<desc>
5166	Discards any changes to the machine settings made since the session
5167	has been opened or since the last call to <link to="#saveSettings"/>
5168	or <link to="#discardSettings"/>.
5169	<note>
5170	Calling this method is only valid on instances returned
5171	by <link to="ISession::machine"/> and on new machines
5172	created by <link to="IVirtualBox::createMachine"/> or
5173	opened by <link to="IVirtualBox::openMachine"/> but not
5174	yet registered, or on unregistered machines after calling
5175	<link to="IMachine::unregister"/>.
5176	</note>
5177
5178	<result name="VBOX_E_INVALID_VM_STATE">
5179	Virtual machine is not mutable.
5180	</result>
5181
5182	</desc>
5183	</method>
5184
5185	<method name="unregister">
5186	<desc>
5187	Unregisters the machine, which must have been previously registered using
5188	<link to="IVirtualBox::registerMachine"/>.
5189
5190	This method will succeed even if the machine currently has media attachments or
5191	is in the <link to="MachineState::Saved">Saved</link> state. In those cases,
5192	the caller receives the names of all files that have been made obsolete by the
5193	call in the @a aFiles array parameter. This list will consist of the saved
5194	state file and all storage files by media that were detached from the machine.
5195
5196	<note>
5197	The @a fAutoCleanup parameter is temporary to avoid substantial changes to the
5198	frontends in SVN trunk.It will go away before the 3.3 release and
5199	always be true then. If fAutoCleanup is false, the API currently behaves like
5200	the old VirtualBox::UnregisterMachine API. Cleaning up snapshots does not work
5201	yet, so the method will still fail if the machine has snapshots.
5202	</note>
5203
5204	The settings XML file of the machine object itself will not be included in that
5205	list; call <link to="#delete" /> for that.
5206
5207	The call will fail if the machine is currently locked (see <link to="ISession" />).
5208	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5209	before unregistering it.
5210
5211	After successful method invocation,
5212	the <link to="IMachineRegisteredEvent"/> event is fired.
5213
5214	<note>
5215	If the given machine is inaccessible (see <link to="#accessible"/>), it
5216	will be unregistered and fully uninitialized right afterwards. As a result,
5217	the returned machine object will be unusable and an attempt to call
5218	<b>any</b> method will return the "Object not ready" error.
5219	</note>
5220
5221	<result name="VBOX_E_INVALID_OBJECT_STATE">
5222	Machine has snapshot or is locked.
5223	</result>
5224	</desc>
5225
5226	<param name="fAutoCleanup" type="boolean" dir="in">
5227	<desc>If true, the method will automatically detach all media from the
5228	machine and its snapshots, call <link to="IMedium::close" /> on each
5229	medium, and the paths of all media files involved will be reported to
5230	the caller in the @a aFiles array so the caller can then delete the
5231	image files.
5232	If false, the method will fail if media attachments are present.
5233	</desc>
5234	</param>
5235	<param name="aFiles" type="wstring" safearray="yes" dir="return">
5236	<desc>
5237	List of all files detached from medium attachments of the machine, if
5238	@a fCloseMedia is true.
5239	</desc>
5240	</param>
5241	</method>
5242
5243	<method name="delete">
5244	<desc>
5245	Deletes the settings (machine XML) file of this machine from disk. The machine
5246	must not be registered in order for this operation to succeed.
5247	<note>
5248	<link to="#settingsModified"/> will return @c true after this
5249	method successfully returns.
5250	</note>
5251	<note>
5252	Calling this method is only valid on instances returned
5253	by <link to="ISession::machine"/> and on new machines
5254	created by <link to="IVirtualBox::createMachine"/> or
5255	opened by <link to="IVirtualBox::openMachine"/> but not
5256	yet registered, or on unregistered machines after calling
5257	<link to="IMachine::unregister"/>.
5258	</note>
5259	<note>
5260	The deleted machine settings file can be restored (saved again)
5261	by calling <link to="#saveSettings"/>.
5262	</note>
5263
5264	<result name="VBOX_E_INVALID_VM_STATE">
5265	Cannot delete settings of a registered machine or
5266	machine not mutable.
5267	</result>
5268	<result name="VBOX_E_IPRT_ERROR">
5269	Could not delete the settings file.
5270	</result>
5271
5272	</desc>
5273	</method>
5274
5275	<method name="export">
5276	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5277	steps required to export VirtualBox machines to OVF.
5278	</desc>
5279
5280	<param name="aAppliance" type="IAppliance" dir="in">
5281	<desc>Appliance to export this machine to.</desc>
5282	</param>
5283	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5284	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5285	</param>
5286	</method >
5287
5288	<method name="getSnapshot">
5289	<desc>
5290	Returns a snapshot of this machine with the given UUID.
5291	A @c null UUID can be used to obtain the first snapshot
5292	taken on this machine. This is useful if you want to traverse
5293	the whole tree of snapshots starting from the root.
5294
5295	<result name="VBOX_E_OBJECT_NOT_FOUND">
5296	Virtual machine has no snapshots or snapshot not found.
5297	</result>
5298
5299	</desc>
5300	<param name="id" type="uuid" mod="string" dir="in">
5301	<desc>UUID of the snapshot to get</desc>
5302	</param>
5303	<param name="snapshot" type="ISnapshot" dir="return">
5304	<desc>Snapshot object with the given UUID.</desc>
5305	</param>
5306	</method>
5307
5308	<method name="findSnapshot">
5309	<desc>
5310	Returns a snapshot of this machine with the given name.
5311
5312	<result name="VBOX_E_OBJECT_NOT_FOUND">
5313	Virtual machine has no snapshots or snapshot not found.
5314	</result>
5315
5316	</desc>
5317	<param name="name" type="wstring" dir="in">
5318	<desc>Name of the snapshot to find</desc>
5319	</param>
5320	<param name="snapshot" type="ISnapshot" dir="return">
5321	<desc>Snapshot object with the given name.</desc>
5322	</param>
5323	</method>
5324
5325	<method name="setCurrentSnapshot">
5326	<desc>
5327	Sets the current snapshot of this machine.
5328	<note>
5329	In the current implementation, this operation is not
5330	implemented.
5331	</note>
5332	</desc>
5333	<param name="id" type="uuid" mod="string" dir="in">
5334	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5335	</param>
5336	</method>
5337
5338	<method name="createSharedFolder">
5339	<desc>
5340	Creates a new permanent shared folder by associating the given logical
5341	name with the given host path, adds it to the collection of shared
5342	folders and starts sharing it. Refer to the description of
5343	<link to="ISharedFolder"/> to read more about logical names.
5344
5345	<result name="VBOX_E_OBJECT_IN_USE">
5346	Shared folder already exists.
5347	</result>
5348	<result name="VBOX_E_FILE_ERROR">
5349	Shared folder @a hostPath not accessible.
5350	</result>
5351
5352	</desc>
5353	<param name="name" type="wstring" dir="in">
5354	<desc>Unique logical name of the shared folder.</desc>
5355	</param>
5356	<param name="hostPath" type="wstring" dir="in">
5357	<desc>Full path to the shared folder in the host file system.</desc>
5358	</param>
5359	<param name="writable" type="boolean" dir="in">
5360	<desc>Whether the share is writable or readonly.</desc>
5361	</param>
5362	<param name="automount" type="boolean" dir="in">
5363	<desc>Whether the share gets automatically mounted by the guest
5364	or not.</desc>
5365	</param>
5366	</method>
5367
5368	<method name="removeSharedFolder">
5369	<desc>
5370	Removes the permanent shared folder with the given name previously
5371	created by <link to="#createSharedFolder"/> from the collection of
5372	shared folders and stops sharing it.
5373
5374	<result name="VBOX_E_INVALID_VM_STATE">
5375	Virtual machine is not mutable.
5376	</result>
5377	<result name="VBOX_E_OBJECT_NOT_FOUND">
5378	Shared folder @a name does not exist.
5379	</result>
5380
5381	</desc>
5382	<param name="name" type="wstring" dir="in">
5383	<desc>Logical name of the shared folder to remove.</desc>
5384	</param>
5385	</method>
5386
5387	<method name="canShowConsoleWindow">
5388	<desc>
5389	Returns @c true if the VM console process can activate the
5390	console window and bring it to foreground on the desktop of
5391	the host PC.
5392	<note>
5393	This method will fail if a session for this machine is not
5394	currently open.
5395	</note>
5396
5397	<result name="VBOX_E_INVALID_VM_STATE">
5398	Machine session is not open.
5399	</result>
5400
5401	</desc>
5402	<param name="canShow" type="boolean" dir="return">
5403	<desc>
5404	@c true if the console window can be shown and @c false otherwise.
5405	</desc>
5406	</param>
5407	</method>
5408
5409	<method name="showConsoleWindow">
5410	<desc>
5411	Activates the console window and brings it to foreground on
5412	the desktop of the host PC. Many modern window managers on
5413	many platforms implement some sort of focus stealing
5414	prevention logic, so that it may be impossible to activate
5415	a window without the help of the currently active
5416	application. In this case, this method will return a non-zero
5417	identifier that represents the top-level window of the VM
5418	console process. The caller, if it represents a currently
5419	active process, is responsible to use this identifier (in a
5420	platform-dependent manner) to perform actual window
5421	activation.
5422	<note>
5423	This method will fail if a session for this machine is not
5424	currently open.
5425	</note>
5426
5427	<result name="VBOX_E_INVALID_VM_STATE">
5428	Machine session is not open.
5429	</result>
5430
5431	</desc>
5432	<param name="winId" type="unsigned long long" dir="return">
5433	<desc>
5434	Platform-dependent identifier of the top-level VM console
5435	window, or zero if this method has performed all actions
5436	necessary to implement the <i>show window</i> semantics for
5437	the given platform and/or VirtualBox front-end.
5438	</desc>
5439	</param>
5440	</method>
5441
5442	<method name="getGuestProperty" const="yes">
5443	<desc>
5444	Reads an entry from the machine's guest property store.
5445
5446	<result name="VBOX_E_INVALID_VM_STATE">
5447	Machine session is not open.
5448	</result>
5449
5450	</desc>
5451	<param name="name" type="wstring" dir="in">
5452	<desc>
5453	The name of the property to read.
5454	</desc>
5455	</param>
5456	<param name="value" type="wstring" dir="out">
5457	<desc>
5458	The value of the property. If the property does not exist then this
5459	will be empty.
5460	</desc>
5461	</param>
5462	<param name="timestamp" type="unsigned long long" dir="out">
5463	<desc>
5464	The time at which the property was last modified, as seen by the
5465	server process.
5466	</desc>
5467	</param>
5468	<param name="flags" type="wstring" dir="out">
5469	<desc>
5470	Additional property parameters, passed as a comma-separated list of
5471	"name=value" type entries.
5472	</desc>
5473	</param>
5474	</method>
5475
5476	<method name="getGuestPropertyValue" const="yes">
5477	<desc>
5478	Reads a value from the machine's guest property store.
5479
5480	<result name="VBOX_E_INVALID_VM_STATE">
5481	Machine session is not open.
5482	</result>
5483
5484	</desc>
5485	<param name="property" type="wstring" dir="in">
5486	<desc>
5487	The name of the property to read.
5488	</desc>
5489	</param>
5490	<param name="value" type="wstring" dir="return">
5491	<desc>
5492	The value of the property. If the property does not exist then this
5493	will be empty.
5494	</desc>
5495	</param>
5496	</method>
5497
5498	<method name="getGuestPropertyTimestamp" const="yes">
5499	<desc>
5500	Reads a property timestamp from the machine's guest property store.
5501
5502	<result name="VBOX_E_INVALID_VM_STATE">
5503	Machine session is not open.
5504	</result>
5505
5506	</desc>
5507	<param name="property" type="wstring" dir="in">
5508	<desc>
5509	The name of the property to read.
5510	</desc>
5511	</param>
5512	<param name="value" type="unsigned long long" dir="return">
5513	<desc>
5514	The timestamp. If the property does not exist then this will be
5515	empty.
5516	</desc>
5517	</param>
5518	</method>
5519
5520	<method name="setGuestProperty">
5521	<desc>
5522	Sets, changes or deletes an entry in the machine's guest property
5523	store.
5524
5525	<result name="E_ACCESSDENIED">
5526	Property cannot be changed.
5527	</result>
5528	<result name="E_INVALIDARG">
5529	Invalid @a flags.
5530	</result>
5531	<result name="VBOX_E_INVALID_VM_STATE">
5532	Virtual machine is not mutable or session not open.
5533	</result>
5534	<result name="VBOX_E_INVALID_OBJECT_STATE">
5535	Cannot set transient property when machine not running.
5536	</result>
5537
5538	</desc>
5539	<param name="property" type="wstring" dir="in">
5540	<desc>
5541	The name of the property to set, change or delete.
5542	</desc>
5543	</param>
5544	<param name="value" type="wstring" dir="in">
5545	<desc>
5546	The new value of the property to set, change or delete. If the
5547	property does not yet exist and value is non-empty, it will be
5548	created. If the value is @c null or empty, the property will be
5549	deleted if it exists.
5550	</desc>
5551	</param>
5552	<param name="flags" type="wstring" dir="in">
5553	<desc>
5554	Additional property parameters, passed as a comma-separated list of
5555	"name=value" type entries.
5556	</desc>
5557	</param>
5558	</method>
5559
5560	<method name="setGuestPropertyValue">
5561	<desc>
5562	Sets, changes or deletes a value in the machine's guest property
5563	store. The flags field will be left unchanged or created empty for a
5564	new property.
5565
5566	<result name="E_ACCESSDENIED">
5567	Property cannot be changed.
5568	</result>
5569	<result name="VBOX_E_INVALID_VM_STATE">
5570	Virtual machine is not mutable or session not open.
5571	</result>
5572	<result name="VBOX_E_INVALID_OBJECT_STATE">
5573	Cannot set transient property when machine not running.
5574	</result>
5575	</desc>
5576
5577	<param name="property" type="wstring" dir="in">
5578	<desc>
5579	The name of the property to set, change or delete.
5580	</desc>
5581	</param>
5582	<param name="value" type="wstring" dir="in">
5583	<desc>
5584	The new value of the property to set, change or delete. If the
5585	property does not yet exist and value is non-empty, it will be
5586	created. If the value is @c null or empty, the property will be
5587	deleted if it exists.
5588	</desc>
5589	</param>
5590	</method>
5591
5592	<method name="enumerateGuestProperties">
5593	<desc>
5594	Return a list of the guest properties matching a set of patterns along
5595	with their values, time stamps and flags.
5596	</desc>
5597	<param name="patterns" type="wstring" dir="in">
5598	<desc>
5599	The patterns to match the properties against, separated by '\|'
5600	characters. If this is empty or @c null, all properties will match.
5601	</desc>
5602	</param>
5603	<param name="name" type="wstring" dir="out" safearray="yes">
5604	<desc>
5605	The names of the properties returned.
5606	</desc>
5607	</param>
5608	<param name="value" type="wstring" dir="out" safearray="yes">
5609	<desc>
5610	The values of the properties returned. The array entries match the
5611	corresponding entries in the @a name array.
5612	</desc>
5613	</param>
5614	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
5615	<desc>
5616	The time stamps of the properties returned. The array entries match
5617	the corresponding entries in the @a name array.
5618	</desc>
5619	</param>
5620	<param name="flags" type="wstring" dir="out" safearray="yes">
5621	<desc>
5622	The flags of the properties returned. The array entries match the
5623	corresponding entries in the @a name array.
5624	</desc>
5625	</param>
5626	</method>
5627
5628	<method name="querySavedThumbnailSize">
5629	<desc>
5630	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5631	</desc>
5632	<param name="screenId" type="unsigned long" dir="in">
5633	<desc>
5634	Saved guest screen to query info from.
5635	</desc>
5636	</param>
5637	<param name="size" type="unsigned long" dir="out">
5638	<desc>
5639	Size of buffer required to store the bitmap.
5640	</desc>
5641	</param>
5642	<param name="width" type="unsigned long" dir="out">
5643	<desc>
5644	Bitmap width.
5645	</desc>
5646	</param>
5647	<param name="height" type="unsigned long" dir="out">
5648	<desc>
5649	Bitmap height.
5650	</desc>
5651	</param>
5652	</method>
5653
5654	<method name="readSavedThumbnailToArray">
5655	<desc>
5656	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5657	</desc>
5658	<param name="screenId" type="unsigned long" dir="in">
5659	<desc>
5660	Saved guest screen to read from.
5661	</desc>
5662	</param>
5663	<param name="BGR" type="boolean" dir="in">
5664	<desc>
5665	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5666	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5667	</desc>
5668	</param>
5669	<param name="width" type="unsigned long" dir="out">
5670	<desc>
5671	Bitmap width.
5672	</desc>
5673	</param>
5674	<param name="height" type="unsigned long" dir="out">
5675	<desc>
5676	Bitmap height.
5677	</desc>
5678	</param>
5679	<param name="data" type="octet" dir="return" safearray="yes">
5680	<desc>
5681	Array with resulting bitmap data.
5682	</desc>
5683	</param>
5684	</method>
5685
5686	<method name="querySavedScreenshotPNGSize">
5687	<desc>
5688	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5689	</desc>
5690	<param name="screenId" type="unsigned long" dir="in">
5691	<desc>
5692	Saved guest screen to query info from.
5693	</desc>
5694	</param>
5695	<param name="size" type="unsigned long" dir="out">
5696	<desc>
5697	Size of buffer required to store the PNG binary data.
5698	</desc>
5699	</param>
5700	<param name="width" type="unsigned long" dir="out">
5701	<desc>
5702	Image width.
5703	</desc>
5704	</param>
5705	<param name="height" type="unsigned long" dir="out">
5706	<desc>
5707	Image height.
5708	</desc>
5709	</param>
5710	</method>
5711
5712	<method name="readSavedScreenshotPNGToArray">
5713	<desc>
5714	Screenshot in PNG format is retrieved to an array of bytes.
5715	</desc>
5716	<param name="screenId" type="unsigned long" dir="in">
5717	<desc>
5718	Saved guest screen to read from.
5719	</desc>
5720	</param>
5721	<param name="width" type="unsigned long" dir="out">
5722	<desc>
5723	Image width.
5724	</desc>
5725	</param>
5726	<param name="height" type="unsigned long" dir="out">
5727	<desc>
5728	Image height.
5729	</desc>
5730	</param>
5731	<param name="data" type="octet" dir="return" safearray="yes">
5732	<desc>
5733	Array with resulting PNG data.
5734	</desc>
5735	</param>
5736	</method>
5737
5738	<method name="hotPlugCPU">
5739	<desc>
5740	Plugs a CPU into the machine.
5741	</desc>
5742	<param name="cpu" type="unsigned long" dir="in">
5743	<desc>
5744	The CPU id to insert.
5745	</desc>
5746	</param>
5747	</method>
5748
5749	<method name="hotUnplugCPU">
5750	<desc>
5751	Removes a CPU from the machine.
5752	</desc>
5753	<param name="cpu" type="unsigned long" dir="in">
5754	<desc>
5755	The CPU id to remove.
5756	</desc>
5757	</param>
5758	</method>
5759
5760	<method name="getCPUStatus">
5761	<desc>
5762	Returns the current status of the given CPU.
5763	</desc>
5764	<param name="cpu" type="unsigned long" dir="in">
5765	<desc>
5766	The CPU id to check for.
5767	</desc>
5768	</param>
5769	<param name="attached" type="boolean" dir="return">
5770	<desc>
5771	Status of the CPU.
5772	</desc>
5773	</param>
5774	</method>
5775
5776	<method name="queryLogFilename">
5777	<desc>
5778	Queries for the VM log file name of an given index. Returns an empty
5779	string if a log file with that index doesn't exists.
5780	</desc>
5781	<param name="idx" type="unsigned long" dir="in">
5782	<desc>
5783	Which log file name to query. 0=current log file.
5784	</desc>
5785	</param>
5786	<param name="filename" type="wstring" dir="return">
5787	<desc>
5788	On return the full path to the log file or an empty string on error.
5789	</desc>
5790	</param>
5791	</method>
5792
5793	<method name="readLog">
5794	<desc>
5795	Reads the VM log file. The chunk size is limited, so even if you
5796	ask for a big piece there might be less data returned.
5797	</desc>
5798	<param name="idx" type="unsigned long" dir="in">
5799	<desc>
5800	Which log file to read. 0=current log file.
5801	</desc>
5802	</param>
5803	<param name="offset" type="unsigned long long" dir="in">
5804	<desc>
5805	Offset in the log file.
5806	</desc>
5807	</param>
5808	<param name="size" type="unsigned long long" dir="in">
5809	<desc>
5810	Chunk size to read in the log file.
5811	</desc>
5812	</param>
5813	<param name="data" type="octet" dir="return" safearray="yes">
5814	<desc>
5815	Data read from the log file. A data size of 0 means end of file
5816	if the requested chunk size was not 0. This is the unprocessed
5817	file data, i.e. the line ending style depends on the platform of
5818	the system the server is running on.
5819	</desc>
5820	</param>
5821	</method>
5822	</interface>
5823
5824	<!--
5825	// IConsole
5826	/////////////////////////////////////////////////////////////////////////
5827	-->
5828
5829	<interface
5830	name="IRemoteDisplayInfo" extends="$unknown"
5831	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
5832	wsmap="struct"
5833	>
5834	<desc>
5835	Contains information about the remote display (VRDP) capabilities and status.
5836	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
5837	</desc>
5838
5839	<attribute name="active" type="boolean" readonly="yes">
5840	<desc>
5841	Whether the remote display connection is active.
5842	</desc>
5843	</attribute>
5844
5845	<attribute name="port" type="long" readonly="yes">
5846	<desc>
5847	VRDP server port number. If this property is equal to <tt>0</tt>, then
5848	the VRDP server failed to start, usually because there are no free TCP
5849	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
5850	server has not yet been started.
5851	</desc>
5852	</attribute>
5853
5854	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5855	<desc>
5856	How many times a client connected.
5857	</desc>
5858	</attribute>
5859
5860	<attribute name="beginTime" type="long long" readonly="yes">
5861	<desc>
5862	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5863	</desc>
5864	</attribute>
5865
5866	<attribute name="endTime" type="long long" readonly="yes">
5867	<desc>
5868	When the last connection was terminated or the current time, if
5869	connection is still active, in milliseconds since 1970-01-01 UTC.
5870	</desc>
5871	</attribute>
5872
5873	<attribute name="bytesSent" type="unsigned long long" readonly="yes">
5874	<desc>
5875	How many bytes were sent in last or current, if still active, connection.
5876	</desc>
5877	</attribute>
5878
5879	<attribute name="bytesSentTotal" type="unsigned long long" readonly="yes">
5880	<desc>
5881	How many bytes were sent in all connections.
5882	</desc>
5883	</attribute>
5884
5885	<attribute name="bytesReceived" type="unsigned long long" readonly="yes">
5886	<desc>
5887	How many bytes were received in last or current, if still active, connection.
5888	</desc>
5889	</attribute>
5890
5891	<attribute name="bytesReceivedTotal" type="unsigned long long" readonly="yes">
5892	<desc>
5893	How many bytes were received in all connections.
5894	</desc>
5895	</attribute>
5896
5897	<attribute name="user" type="wstring" readonly="yes">
5898	<desc>
5899	Login user name supplied by the client.
5900	</desc>
5901	</attribute>
5902
5903	<attribute name="domain" type="wstring" readonly="yes">
5904	<desc>
5905	Login domain name supplied by the client.
5906	</desc>
5907	</attribute>
5908
5909	<attribute name="clientName" type="wstring" readonly="yes">
5910	<desc>
5911	The client name supplied by the client.
5912	</desc>
5913	</attribute>
5914
5915	<attribute name="clientIP" type="wstring" readonly="yes">
5916	<desc>
5917	The IP address of the client.
5918	</desc>
5919	</attribute>
5920
5921	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5922	<desc>
5923	The client software version number.
5924	</desc>
5925	</attribute>
5926
5927	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5928	<desc>
5929	Public key exchange method used when connection was established.
5930	Values: 0 - RDP4 public key exchange scheme.
5931	1 - X509 certificates were sent to client.
5932	</desc>
5933	</attribute>
5934
5935	</interface>
5936
5937	<interface
5938	name="IConsole" extends="$unknown"
5939	uuid="03cb7897-ea17-4e6c-81ae-4bd90be2fde2"
5940	wsmap="managed"
5941	>
5942	<desc>
5943	The IConsole interface represents an interface to control virtual
5944	machine execution.
5945
5946	A console object gets created when a machine has been locked for a
5947	particular session (client process) using <link to="IMachine::lockMachine" />
5948	or <link to="IMachine::launchVMProcess"/>. The console object can
5949	then be found in the session's <link to="ISession::console" /> attribute.
5950
5951	Methods of the IConsole interface allow the caller to query the current
5952	virtual machine execution state, pause the machine or power it down, save
5953	the machine state or take a snapshot, attach and detach removable media
5954	and so on.
5955
5956	<see>ISession</see>
5957	</desc>
5958
5959	<attribute name="machine" type="IMachine" readonly="yes">
5960	<desc>
5961	Machine object this console is sessioned with.
5962	<note>
5963	This is a convenience property, it has the same value as
5964	<link to="ISession::machine"/> of the corresponding session
5965	object.
5966	</note>
5967	</desc>
5968	</attribute>
5969
5970	<attribute name="state" type="MachineState" readonly="yes">
5971	<desc>
5972	Current execution state of the machine.
5973	<note>
5974	This property always returns the same value as the corresponding
5975	property of the IMachine object this console is sessioned with.
5976	For the process that owns (executes) the VM, this is the
5977	preferable way of querying the VM state, because no IPC
5978	calls are made.
5979	</note>
5980	</desc>
5981	</attribute>
5982
5983	<attribute name="guest" type="IGuest" readonly="yes">
5984	<desc>Guest object.</desc>
5985	</attribute>
5986
5987	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5988	<desc>
5989	Virtual keyboard object.
5990	<note>
5991	If the machine is not running, any attempt to use
5992	the returned object will result in an error.
5993	</note>
5994	</desc>
5995	</attribute>
5996
5997	<attribute name="mouse" type="IMouse" readonly="yes">
5998	<desc>
5999	Virtual mouse object.
6000	<note>
6001	If the machine is not running, any attempt to use
6002	the returned object will result in an error.
6003	</note>
6004	</desc>
6005	</attribute>
6006
6007	<attribute name="display" type="IDisplay" readonly="yes">
6008	<desc>Virtual display object.
6009	<note>
6010	If the machine is not running, any attempt to use
6011	the returned object will result in an error.
6012	</note>
6013	</desc>
6014	</attribute>
6015
6016	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6017	<desc>Debugging interface.</desc>
6018	</attribute>
6019
6020	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6021	<desc>
6022	Collection of USB devices currently attached to the virtual
6023	USB controller.
6024	<note>
6025	The collection is empty if the machine is not running.
6026	</note>
6027	</desc>
6028	</attribute>
6029
6030	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6031	<desc>
6032	List of USB devices currently attached to the remote VRDP client.
6033	Once a new device is physically attached to the remote host computer,
6034	it appears in this list and remains there until detached.
6035	</desc>
6036	</attribute>
6037
6038	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6039	<desc>
6040	Collection of shared folders for the current session. These folders
6041	are called transient shared folders because they are available to the
6042	guest OS running inside the associated virtual machine only for the
6043	duration of the session (as opposed to
6044	<link to="IMachine::sharedFolders"/> which represent permanent shared
6045	folders). When the session is closed (e.g. the machine is powered down),
6046	these folders are automatically discarded.
6047
6048	New shared folders are added to the collection using
6049	<link to="#createSharedFolder"/>. Existing shared folders can be
6050	removed using <link to="#removeSharedFolder"/>.
6051	</desc>
6052	</attribute>
6053
6054	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
6055	<desc>
6056	Interface that provides information on Remote Display (VRDP) connection.
6057	</desc>
6058	</attribute>
6059
6060	<attribute name="eventSource" type="IEventSource" readonly="yes">
6061	<desc>
6062	Event source for console events.
6063	</desc>
6064	</attribute>
6065
6066	<method name="powerUp">
6067	<desc>
6068	Starts the virtual machine execution using the current machine
6069	state (that is, its current execution state, current settings and
6070	current storage devices).
6071
6072	<note>
6073	This method is only useful for front-ends that want to actually
6074	execute virtual machines in their own process (like the VirtualBox
6075	or VBoxSDL front-ends). Unless you are intending to write such a
6076	front-end, do not call this method. If you simply want to
6077	start virtual machine execution using one of the existing front-ends
6078	(for example the VirtualBox GUI or headless server), use
6079	<link to="IMachine::launchVMProcess"/> instead; these
6080	front-ends will power up the machine automatically for you.
6081	</note>
6082
6083	If the machine is powered off or aborted, the execution will
6084	start from the beginning (as if the real hardware were just
6085	powered on).
6086
6087	If the machine is in the <link to="MachineState_Saved"/> state,
6088	it will continue its execution the point where the state has
6089	been saved.
6090
6091	If the machine <link to="IMachine::teleporterEnabled"/> property is
6092	enabled on the machine being powered up, the machine will wait for an
6093	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6094	state. The returned progress object will have at least three
6095	operations where the last three are defined as: (1) powering up and
6096	starting TCP server, (2) waiting for incoming teleportations, and
6097	(3) perform teleportation. These operations will be reflected as the
6098	last three operations of the progress objected returned by
6099	<link to="IMachine::launchVMProcess"/> as well.
6100
6101	<see>#saveState</see>
6102
6103	<result name="VBOX_E_INVALID_VM_STATE">
6104	Virtual machine already running.
6105	</result>
6106	<result name="VBOX_E_HOST_ERROR">
6107	Host interface does not exist or name not set.
6108	</result>
6109	<result name="VBOX_E_FILE_ERROR">
6110	Invalid saved state file.
6111	</result>
6112	</desc>
6113	<param name="progress" type="IProgress" dir="return">
6114	<desc>Progress object to track the operation completion.</desc>
6115	</param>
6116	</method>
6117
6118	<method name="powerUpPaused">
6119	<desc>
6120	Identical to powerUp except that the VM will enter the
6121	<link to="MachineState_Paused"/> state, instead of
6122	<link to="MachineState_Running"/>.
6123
6124	<see>#powerUp</see>
6125	<result name="VBOX_E_INVALID_VM_STATE">
6126	Virtual machine already running.
6127	</result>
6128	<result name="VBOX_E_HOST_ERROR">
6129	Host interface does not exist or name not set.
6130	</result>
6131	<result name="VBOX_E_FILE_ERROR">
6132	Invalid saved state file.
6133	</result>
6134	</desc>
6135	<param name="progress" type="IProgress" dir="return">
6136	<desc>Progress object to track the operation completion.</desc>
6137	</param>
6138	</method>
6139
6140	<method name="powerDown">
6141	<desc>
6142	Initiates the power down procedure to stop the virtual machine
6143	execution.
6144
6145	The completion of the power down procedure is tracked using the returned
6146	IProgress object. After the operation is complete, the machine will go
6147	to the PoweredOff state.
6148	<result name="VBOX_E_INVALID_VM_STATE">
6149	Virtual machine must be Running, Paused or Stuck to be powered down.
6150	</result>
6151	</desc>
6152	<param name="progress" type="IProgress" dir="return">
6153	<desc>Progress object to track the operation completion.</desc>
6154	</param>
6155	</method>
6156
6157	<method name="reset">
6158	<desc>Resets the virtual machine.
6159	<result name="VBOX_E_INVALID_VM_STATE">
6160	Virtual machine not in Running state.
6161	</result>
6162	<result name="VBOX_E_VM_ERROR">
6163	Virtual machine error in reset operation.
6164	</result>
6165	</desc>
6166	</method>
6167
6168	<method name="pause">
6169	<desc>Pauses the virtual machine execution.
6170	<result name="VBOX_E_INVALID_VM_STATE">
6171	Virtual machine not in Running state.
6172	</result>
6173	<result name="VBOX_E_VM_ERROR">
6174	Virtual machine error in suspend operation.
6175	</result>
6176	</desc>
6177	</method>
6178
6179	<method name="resume">
6180	<desc>Resumes the virtual machine execution.
6181	<result name="VBOX_E_INVALID_VM_STATE">
6182	Virtual machine not in Paused state.
6183	</result>
6184	<result name="VBOX_E_VM_ERROR">
6185	Virtual machine error in resume operation.
6186	</result>
6187	</desc>
6188	</method>
6189
6190	<method name="powerButton">
6191	<desc>Sends the ACPI power button event to the guest.
6192	<result name="VBOX_E_INVALID_VM_STATE">
6193	Virtual machine not in Running state.
6194	</result>
6195	<result name="VBOX_E_PDM_ERROR">
6196	Controlled power off failed.
6197	</result>
6198	</desc>
6199	</method>
6200
6201	<method name="sleepButton">
6202	<desc>Sends the ACPI sleep button event to the guest.
6203	<result name="VBOX_E_INVALID_VM_STATE">
6204	Virtual machine not in Running state.
6205	</result>
6206	<result name="VBOX_E_PDM_ERROR">
6207	Sending sleep button event failed.
6208	</result>
6209	</desc>
6210	</method>
6211
6212	<method name="getPowerButtonHandled">
6213	<desc>Checks if the last power button event was handled by guest.
6214	<result name="VBOX_E_PDM_ERROR">
6215	Checking if the event was handled by the guest OS failed.
6216	</result>
6217	</desc>
6218	<param name="handled" type="boolean" dir="return"/>
6219	</method>
6220
6221	<method name="getGuestEnteredACPIMode">
6222	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6223	G1 (sleeping). If this method returns @c false, the guest will
6224	most likely not respond to external ACPI events.
6225	<result name="VBOX_E_INVALID_VM_STATE">
6226	Virtual machine not in Running state.
6227	</result>
6228	</desc>
6229	<param name="entered" type="boolean" dir="return"/>
6230	</method>
6231
6232	<method name="saveState">
6233	<desc>
6234	Saves the current execution state of a running virtual machine
6235	and stops its execution.
6236
6237	After this operation completes, the machine will go to the
6238	Saved state. Next time it is powered up, this state will
6239	be restored and the machine will continue its execution from
6240	the place where it was saved.
6241
6242	This operation differs from taking a snapshot to the effect
6243	that it doesn't create new differencing media. Also, once
6244	the machine is powered up from the state saved using this method,
6245	the saved state is deleted, so it will be impossible to return
6246	to this state later.
6247
6248	<note>
6249	On success, this method implicitly calls
6250	<link to="IMachine::saveSettings"/> to save all current machine
6251	settings (including runtime changes to the DVD medium, etc.).
6252	Together with the impossibility to change any VM settings when it is
6253	in the Saved state, this guarantees adequate hardware
6254	configuration of the machine when it is restored from the saved
6255	state file.
6256	</note>
6257
6258	<note>
6259	The machine must be in the Running or Paused state, otherwise
6260	the operation will fail.
6261	</note>
6262	<result name="VBOX_E_INVALID_VM_STATE">
6263	Virtual machine state neither Running nor Paused.
6264	</result>
6265	<result name="VBOX_E_FILE_ERROR">
6266	Failed to create directory for saved state file.
6267	</result>
6268
6269	<see><link to="#takeSnapshot"/></see>
6270	</desc>
6271	<param name="progress" type="IProgress" dir="return">
6272	<desc>Progress object to track the operation completion.</desc>
6273	</param>
6274	</method>
6275
6276	<method name="adoptSavedState">
6277	<desc>
6278	Associates the given saved state file to the virtual machine.
6279
6280	On success, the machine will go to the Saved state. Next time it is
6281	powered up, it will be restored from the adopted saved state and
6282	continue execution from the place where the saved state file was
6283	created.
6284
6285	The specified saved state file path may be absolute or relative to the
6286	folder the VM normally saves the state to (usually,
6287	<link to="IMachine::snapshotFolder"/>).
6288
6289	<note>
6290	It's a caller's responsibility to make sure the given saved state
6291	file is compatible with the settings of this virtual machine that
6292	represent its virtual hardware (memory size, storage disk configuration
6293	etc.). If there is a mismatch, the behavior of the virtual machine
6294	is undefined.
6295	</note>
6296	<result name="VBOX_E_INVALID_VM_STATE">
6297	Virtual machine state neither PoweredOff nor Aborted.
6298	</result>
6299	</desc>
6300	<param name="savedStateFile" type="wstring" dir="in">
6301	<desc>Path to the saved state file to adopt.</desc>
6302	</param>
6303	</method>
6304
6305	<method name="discardSavedState">
6306	<desc>
6307	Forcibly resets the machine to "Powered Off" state if it is
6308	currently in the "Saved" state (previously created by <link to="#saveState"/>)
6309	and deletes the file into which the machine state was saved.
6310	Next time the machine is powered up, a clean boot will occur.
6311	<note>
6312	This operation is equivalent to resetting or powering off
6313	the machine without doing a proper shutdown of the guest
6314	operating system; as with resetting a running phyiscal
6315	computer, it can can lead to data loss.
6316	</note>
6317	<result name="VBOX_E_INVALID_VM_STATE">
6318	Virtual machine not in state Saved.
6319	</result>
6320	</desc>
6321	</method>
6322
6323	<method name="getDeviceActivity">
6324	<desc>
6325	Gets the current activity type of a given device or device group.
6326	<result name="E_INVALIDARG">
6327	Invalid device type.
6328	</result>
6329	</desc>
6330	<param name="type" type="DeviceType" dir="in"/>
6331	<param name="activity" type="DeviceActivity" dir="return"/>
6332	</method>
6333
6334	<method name="attachUSBDevice">
6335	<desc>
6336	Attaches a host USB device with the given UUID to the
6337	USB controller of the virtual machine.
6338
6339	The device needs to be in one of the following states:
6340	<link to="USBDeviceState_Busy"/>,
6341	<link to="USBDeviceState_Available"/> or
6342	<link to="USBDeviceState_Held"/>,
6343	otherwise an error is immediately returned.
6344
6345	When the device state is
6346	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6347	be returned if the host computer refuses to release it for some reason.
6348
6349	<see>IUSBController::deviceFilters, USBDeviceState</see>
6350	<result name="VBOX_E_INVALID_VM_STATE">
6351	Virtual machine state neither Running nor Paused.
6352	</result>
6353	<result name="VBOX_E_PDM_ERROR">
6354	Virtual machine does not have a USB controller.
6355	</result>
6356	</desc>
6357	<param name="id" type="uuid" mod="string" dir="in">
6358	<desc>UUID of the host USB device to attach.</desc>
6359	</param>
6360	</method>
6361
6362	<method name="detachUSBDevice">
6363	<desc>
6364	Detaches an USB device with the given UUID from the USB controller
6365	of the virtual machine.
6366
6367	After this method succeeds, the VirtualBox server re-initiates
6368	all USB filters as if the device were just physically attached
6369	to the host, but filters of this machine are ignored to avoid
6370	a possible automatic re-attachment.
6371
6372	<see>IUSBController::deviceFilters, USBDeviceState</see>
6373
6374	<result name="VBOX_E_PDM_ERROR">
6375	Virtual machine does not have a USB controller.
6376	</result>
6377	<result name="E_INVALIDARG">
6378	USB device not attached to this virtual machine.
6379	</result>
6380	</desc>
6381	<param name="id" type="uuid" mod="string" dir="in">
6382	<desc>UUID of the USB device to detach.</desc>
6383	</param>
6384	<param name="device" type="IUSBDevice" dir="return">
6385	<desc>Detached USB device.</desc>
6386	</param>
6387	</method>
6388
6389	<method name="findUSBDeviceByAddress">
6390	<desc>
6391	Searches for a USB device with the given host address.
6392
6393	<result name="VBOX_E_OBJECT_NOT_FOUND">
6394	Given @c name does not correspond to any USB device.
6395	</result>
6396
6397	<see>IUSBDevice::address</see>
6398	</desc>
6399	<param name="name" type="wstring" dir="in">
6400	<desc>
6401	Address of the USB device (as assigned by the host) to
6402	search for.
6403	</desc>
6404	</param>
6405	<param name="device" type="IUSBDevice" dir="return">
6406	<desc>Found USB device object.</desc>
6407	</param>
6408	</method>
6409
6410	<method name="findUSBDeviceById">
6411	<desc>
6412	Searches for a USB device with the given UUID.
6413
6414	<result name="VBOX_E_OBJECT_NOT_FOUND">
6415	Given @c id does not correspond to any USB device.
6416	</result>
6417
6418	<see>IUSBDevice::id</see>
6419	</desc>
6420	<param name="id" type="uuid" mod="string" dir="in">
6421	<desc>UUID of the USB device to search for.</desc>
6422	</param>
6423	<param name="device" type="IUSBDevice" dir="return">
6424	<desc>Found USB device object.</desc>
6425	</param>
6426	</method>
6427
6428	<method name="createSharedFolder">
6429	<desc>
6430	Creates a transient new shared folder by associating the given logical
6431	name with the given host path, adds it to the collection of shared
6432	folders and starts sharing it. Refer to the description of
6433	<link to="ISharedFolder"/> to read more about logical names.
6434
6435	<result name="VBOX_E_INVALID_VM_STATE">
6436	Virtual machine in Saved state or currently changing state.
6437	</result>
6438	<result name="VBOX_E_FILE_ERROR">
6439	Shared folder already exists or not accessible.
6440	</result>
6441	</desc>
6442	<param name="name" type="wstring" dir="in">
6443	<desc>Unique logical name of the shared folder.</desc>
6444	</param>
6445	<param name="hostPath" type="wstring" dir="in">
6446	<desc>Full path to the shared folder in the host file system.</desc>
6447	</param>
6448	<param name="writable" type="boolean" dir="in">
6449	<desc>Whether the share is writable or readonly</desc>
6450	</param>
6451	<param name="automount" type="boolean" dir="in">
6452	<desc>Whether the share gets automatically mounted by the guest
6453	or not.</desc>
6454	</param>
6455	</method>
6456
6457	<method name="removeSharedFolder">
6458	<desc>
6459	Removes a transient shared folder with the given name previously
6460	created by <link to="#createSharedFolder"/> from the collection of
6461	shared folders and stops sharing it.
6462	<result name="VBOX_E_INVALID_VM_STATE">
6463	Virtual machine in Saved state or currently changing state.
6464	</result>
6465	<result name="VBOX_E_FILE_ERROR">
6466	Shared folder does not exists.
6467	</result>
6468	</desc>
6469	<param name="name" type="wstring" dir="in">
6470	<desc>Logical name of the shared folder to remove.</desc>
6471	</param>
6472	</method>
6473
6474	<method name="takeSnapshot">
6475	<desc>
6476	Saves the current execution state
6477	and all settings of the machine and creates differencing images
6478	for all normal (non-independent) media.
6479	See <link to="ISnapshot" /> for an introduction to snapshots.
6480
6481	This method can be called for a PoweredOff, Saved (see
6482	<link to="#saveState"/>), Running or
6483	Paused virtual machine. When the machine is PoweredOff, an
6484	offline snapshot is created. When the machine is Running a live
6485	snapshot is created, and an online snapshot is is created when Paused.
6486
6487	The taken snapshot is always based on the
6488	<link to="IMachine::currentSnapshot">current snapshot</link>
6489	of the associated virtual machine and becomes a new current snapshot.
6490
6491	<note>
6492	This method implicitly calls <link to="IMachine::saveSettings"/> to
6493	save all current machine settings before taking an offline snapshot.
6494	</note>
6495
6496	<result name="VBOX_E_INVALID_VM_STATE">
6497	Virtual machine currently changing state.
6498	</result>
6499	</desc>
6500	<param name="name" type="wstring" dir="in">
6501	<desc>Short name for the snapshot.</desc>
6502	</param>
6503	<param name="description" type="wstring" dir="in">
6504	<desc>Optional description of the snapshot.</desc>
6505	</param>
6506	<param name="progress" type="IProgress" dir="return">
6507	<desc>Progress object to track the operation completion.</desc>
6508	</param>
6509	</method>
6510
6511	<method name="deleteSnapshot">
6512	<desc>
6513	Starts deleting the specified snapshot asynchronously.
6514	See <link to="ISnapshot" /> for an introduction to snapshots.
6515
6516	The execution state and settings of the associated machine stored in
6517	the snapshot will be deleted. The contents of all differencing media of
6518	this snapshot will be merged with the contents of their dependent child
6519	media to keep the medium chain valid (in other words, all changes
6520	represented by media being deleted will be propagated to their child
6521	medium). After that, this snapshot's differencing medium will be
6522	deleted. The parent of this snapshot will become a new parent for all
6523	its child snapshots.
6524
6525	If the deleted snapshot is the current one, its parent snapshot will
6526	become a new current snapshot. The current machine state is not directly
6527	affected in this case, except that currently attached differencing
6528	media based on media of the deleted snapshot will be also merged as
6529	described above.
6530
6531	If the deleted snapshot is the first or current snapshot, then the
6532	respective IMachine attributes will be adjusted. Deleting the current
6533	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6534	to make all current machine settings permanent.
6535
6536	Deleting a snapshot has the following preconditions:
6537
6538	<ul>
6539	<li>Child media of all normal media of the deleted snapshot
6540	must be accessible (see <link to="IMedium::state"/>) for this
6541	operation to succeed. In particular, this means that all virtual
6542	machines, whose media are directly or indirectly based on the
6543	media of deleted snapshot, must be powered off.</li>
6544
6545	<li>You cannot delete the snapshot if a medium attached to it has
6546	more than once child medium (differencing images) because otherwise
6547	merging would be impossible. This might be the case if there is
6548	more than one child snapshot or differencing images were created
6549	for other reason (e.g. implicitly because of multiple machine
6550	attachments).</li>
6551	</ul>
6552
6553
6554	The virtual machine's <link to="IMachine::state">state</link> is
6555	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6556	"DeletingSnapshotPaused" while this operation is in progress.
6557
6558	<note>
6559	Merging medium contents can be very time and disk space
6560	consuming, if these media are big in size and have many
6561	children. However, if the snapshot being deleted is the last
6562	(head) snapshot on the branch, the operation will be rather
6563	quick.
6564	</note>
6565	<result name="VBOX_E_INVALID_VM_STATE">
6566	The running virtual machine prevents deleting this snapshot. This
6567	happens only in very specific situations, usually snapshots can be
6568	deleted without trouble while a VM is running. The error message
6569	text explains the reason for the failure.
6570	</result>
6571	</desc>
6572	<param name="id" type="uuid" mod="string" dir="in">
6573	<desc>UUID of the snapshot to delete.</desc>
6574	</param>
6575	<param name="progress" type="IProgress" dir="return">
6576	<desc>Progress object to track the operation completion.</desc>
6577	</param>
6578	</method>
6579
6580	<method name="restoreSnapshot">
6581	<desc>
6582	Starts resetting the machine's current state to the state contained
6583	in the given snapshot, asynchronously. All current settings of the
6584	machine will be reset and changes stored in differencing media
6585	will be lost.
6586	See <link to="ISnapshot" /> for an introduction to snapshots.
6587
6588	After this operation is successfully completed, new empty differencing
6589	media are created for all normal media of the machine.
6590
6591	If the given snapshot is an online snapshot, the machine will go to
6592	the <link to="MachineState_Saved"> saved state</link>, so that the
6593	next time it is powered on, the execution state will be restored
6594	from the state of the snapshot.
6595
6596	<note>
6597	The machine must not be running, otherwise the operation will fail.
6598	</note>
6599
6600	<note>
6601	If the machine state is <link to="MachineState_Saved">Saved</link>
6602	prior to this operation, the saved state file will be implicitly
6603	deleted (as if <link to="IConsole::discardSavedState"/> were
6604	called).
6605	</note>
6606
6607	<result name="VBOX_E_INVALID_VM_STATE">
6608	Virtual machine is running.
6609	</result>
6610	</desc>
6611	<param name="snapshot" type="ISnapshot" dir="in">
6612	<desc>The snapshot to restore the VM state from.</desc>
6613	</param>
6614	<param name="progress" type="IProgress" dir="return">
6615	<desc>Progress object to track the operation completion.</desc>
6616	</param>
6617	</method>
6618
6619	<method name="teleport">
6620	<desc>
6621	Teleport the VM to a different host machine or process.
6622
6623	TODO explain the details.
6624
6625	<result name="VBOX_E_INVALID_VM_STATE">
6626	Virtual machine not running or paused.
6627	</result>
6628	</desc>
6629	<param name="hostname" type="wstring" dir="in">
6630	<desc>The name or IP of the host to teleport to.</desc>
6631	</param>
6632	<param name="tcpport" type="unsigned long" dir="in">
6633	<desc>The TCP port to connect to (1..65535).</desc>
6634	</param>
6635	<param name="password" type="wstring" dir="in">
6636	<desc>The password.</desc>
6637	</param>
6638	<param name="maxDowntime" type="unsigned long" dir="in">
6639	<desc>
6640	The maximum allowed downtime given as milliseconds. 0 is not a valid
6641	value. Recommended value: 250 ms.
6642
6643	The higher the value is, the greater the chance for a successful
6644	teleportation. A small value may easily result in the teleportation
6645	process taking hours and eventually fail.
6646
6647	<note>
6648	The current implementation treats this a guideline, not as an
6649	absolute rule.
6650	</note>
6651	</desc>
6652	</param>
6653	<param name="progress" type="IProgress" dir="return">
6654	<desc>Progress object to track the operation completion.</desc>
6655	</param>
6656	</method>
6657
6658	</interface>
6659
6660	<!--
6661	// IHost
6662	/////////////////////////////////////////////////////////////////////////
6663	-->
6664
6665	<enum
6666	name="HostNetworkInterfaceMediumType"
6667	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6668	>
6669	<desc>
6670	Type of encapsulation. Ethernet encapsulation includes both wired and
6671	wireless Ethernet connections.
6672	<see>IHostNetworkInterface</see>
6673	</desc>
6674
6675	<const name="Unknown" value="0">
6676	<desc>
6677	The type of interface cannot be determined.
6678	</desc>
6679	</const>
6680	<const name="Ethernet" value="1">
6681	<desc>
6682	Ethernet frame encapsulation.
6683	</desc>
6684	</const>
6685	<const name="PPP" value="2">
6686	<desc>
6687	Point-to-point protocol encapsulation.
6688	</desc>
6689	</const>
6690	<const name="SLIP" value="3">
6691	<desc>
6692	Serial line IP encapsulation.
6693	</desc>
6694	</const>
6695	</enum>
6696
6697	<enum
6698	name="HostNetworkInterfaceStatus"
6699	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6700	>
6701	<desc>
6702	Current status of the interface.
6703	<see>IHostNetworkInterface</see>
6704	</desc>
6705
6706	<const name="Unknown" value="0">
6707	<desc>
6708	The state of interface cannot be determined.
6709	</desc>
6710	</const>
6711	<const name="Up" value="1">
6712	<desc>
6713	The interface is fully operational.
6714	</desc>
6715	</const>
6716	<const name="Down" value="2">
6717	<desc>
6718	The interface is not functioning.
6719	</desc>
6720	</const>
6721	</enum>
6722
6723	<enum
6724	name="HostNetworkInterfaceType"
6725	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6726	>
6727	<desc>
6728	Network interface type.
6729	</desc>
6730	<const name="Bridged" value="1"/>
6731	<const name="HostOnly" value="2"/>
6732	</enum>
6733
6734	<interface
6735	name="IHostNetworkInterface" extends="$unknown"
6736	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6737	wsmap="managed"
6738	>
6739	<desc>
6740	Represents one of host's network interfaces. IP V6 address and network
6741	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6742	separated by colons.
6743	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6744	</desc>
6745	<attribute name="name" type="wstring" readonly="yes">
6746	<desc>Returns the host network interface name.</desc>
6747	</attribute>
6748
6749	<attribute name="id" type="uuid" mod="string" readonly="yes">
6750	<desc>Returns the interface UUID.</desc>
6751	</attribute>
6752
6753	<attribute name="networkName" type="wstring" readonly="yes">
6754	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6755	</attribute>
6756
6757	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6758	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6759	</attribute>
6760
6761	<attribute name="IPAddress" type="wstring" readonly="yes">
6762	<desc>Returns the IP V4 address of the interface.</desc>
6763	</attribute>
6764
6765	<attribute name="networkMask" type="wstring" readonly="yes">
6766	<desc>Returns the network mask of the interface.</desc>
6767	</attribute>
6768
6769	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6770	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6771	</attribute>
6772
6773	<attribute name="IPV6Address" type="wstring" readonly="yes">
6774	<desc>Returns the IP V6 address of the interface.</desc>
6775	</attribute>
6776
6777	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6778	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6779	</attribute>
6780
6781	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6782	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6783	</attribute>
6784
6785	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6786	<desc>Type of protocol encapsulation used.</desc>
6787	</attribute>
6788
6789	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6790	<desc>Status of the interface.</desc>
6791	</attribute>
6792
6793	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6794	<desc>specifies the host interface type.</desc>
6795	</attribute>
6796
6797	<method name="enableStaticIpConfig">
6798	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6799	<param name="IPAddress" type="wstring" dir="in">
6800	<desc>
6801	IP address.
6802	</desc>
6803	</param>
6804	<param name="networkMask" type="wstring" dir="in">
6805	<desc>
6806	network mask.
6807	</desc>
6808	</param>
6809	</method>
6810
6811	<method name="enableStaticIpConfigV6">
6812	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6813	<param name="IPV6Address" type="wstring" dir="in">
6814	<desc>
6815	IP address.
6816	</desc>
6817	</param>
6818	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6819	<desc>
6820	network mask.
6821	</desc>
6822	</param>
6823	</method>
6824
6825	<method name="enableDynamicIpConfig">
6826	<desc>enables the dynamic IP configuration.</desc>
6827	</method>
6828
6829	<method name="dhcpRediscover">
6830	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6831	</method>
6832
6833	</interface>
6834
6835	<interface
6836	name="IHost" extends="$unknown"
6837	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6838	wsmap="managed"
6839	>
6840	<desc>
6841	The IHost interface represents the physical machine that this VirtualBox
6842	installation runs on.
6843
6844	An object implementing this interface is returned by the
6845	<link to="IVirtualBox::host" /> attribute. This interface contains
6846	read-only information about the host's physical hardware (such as what
6847	processors and disks are available, what the host operating system is,
6848	and so on) and also allows for manipulating some of the host's hardware,
6849	such as global USB device filters and host interface networking.
6850
6851	</desc>
6852	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6853	<desc>List of DVD drives available on the host.</desc>
6854	</attribute>
6855
6856	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6857	<desc>List of floppy drives available on the host.</desc>
6858	</attribute>
6859
6860	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6861	<desc>
6862	List of USB devices currently attached to the host.
6863	Once a new device is physically attached to the host computer,
6864	it appears in this list and remains there until detached.
6865
6866	<note>
6867	If USB functionality is not available in the given edition of
6868	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6869	</note>
6870	</desc>
6871	</attribute>
6872
6873	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6874	<desc>
6875	List of USB device filters in action.
6876	When a new device is physically attached to the host computer,
6877	filters from this list are applied to it (in order they are stored
6878	in the list). The first matched filter will determine the
6879	<link to="IHostUSBDeviceFilter::action">action</link>
6880	performed on the device.
6881
6882	Unless the device is ignored by these filters, filters of all
6883	currently running virtual machines
6884	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6885
6886	<note>
6887	If USB functionality is not available in the given edition of
6888	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6889	</note>
6890
6891	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6892	</desc>
6893	</attribute>
6894
6895	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6896	<desc>List of host network interfaces currently defined on the host.</desc>
6897	</attribute>
6898
6899	<attribute name="processorCount" type="unsigned long" readonly="yes">
6900	<desc>Number of (logical) CPUs installed in the host system.</desc>
6901	</attribute>
6902
6903	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6904	<desc>Number of (logical) CPUs online in the host system.</desc>
6905	</attribute>
6906
6907	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6908	<desc>Number of physical processor cores installed in the host system.</desc>
6909	</attribute>
6910
6911	<method name="getProcessorSpeed">
6912	<desc>Query the (approximate) maximum speed of a specified host CPU in
6913	Megahertz.
6914	</desc>
6915	<param name="cpuId" type="unsigned long" dir="in">
6916	<desc>
6917	Identifier of the CPU.
6918	</desc>
6919	</param>
6920	<param name="speed" type="unsigned long" dir="return">
6921	<desc>
6922	Speed value. 0 is returned if value is not known or @a cpuId is
6923	invalid.
6924	</desc>
6925	</param>
6926	</method>
6927
6928	<method name="getProcessorFeature">
6929	<desc>Query whether a CPU feature is supported or not.</desc>
6930	<param name="feature" type="ProcessorFeature" dir="in">
6931	<desc>
6932	CPU Feature identifier.
6933	</desc>
6934	</param>
6935	<param name="supported" type="boolean" dir="return">
6936	<desc>
6937	Feature is supported or not.
6938	</desc>
6939	</param>
6940	</method>
6941
6942	<method name="getProcessorDescription">
6943	<desc>Query the model string of a specified host CPU.
6944	</desc>
6945	<param name="cpuId" type="unsigned long" dir="in">
6946	<desc>
6947	Identifier of the CPU.
6948	<note>
6949	The current implementation might not necessarily return the
6950	description for this exact CPU.
6951	</note>
6952	</desc>
6953	</param>
6954	<param name="description" type="wstring" dir="return">
6955	<desc>
6956	Model string. An empty string is returned if value is not known or
6957	@a cpuId is invalid.
6958	</desc>
6959	</param>
6960	</method>
6961
6962	<method name="getProcessorCPUIDLeaf">
6963	<desc>
6964	Returns the CPU cpuid information for the specified leaf.
6965	</desc>
6966	<param name="cpuId" type="unsigned long" dir="in">
6967	<desc>
6968	Identifier of the CPU. The CPU most be online.
6969	<note>
6970	The current implementation might not necessarily return the
6971	description for this exact CPU.
6972	</note>
6973	</desc>
6974	</param>
6975	<param name="leaf" type="unsigned long" dir="in">
6976	<desc>
6977	CPUID leaf index (eax).
6978	</desc>
6979	</param>
6980	<param name="subLeaf" type="unsigned long" dir="in">
6981	<desc>
6982	CPUID leaf sub index (ecx). This currently only applies to cache
6983	information on Intel CPUs. Use 0 if retriving values for
6984	<link to="IMachine::setCPUIDLeaf"/>.
6985	</desc>
6986	</param>
6987	<param name="valEax" type="unsigned long" dir="out">
6988	<desc>
6989	CPUID leaf value for register eax.
6990	</desc>
6991	</param>
6992	<param name="valEbx" type="unsigned long" dir="out">
6993	<desc>
6994	CPUID leaf value for register ebx.
6995	</desc>
6996	</param>
6997	<param name="valEcx" type="unsigned long" dir="out">
6998	<desc>
6999	CPUID leaf value for register ecx.
7000	</desc>
7001	</param>
7002	<param name="valEdx" type="unsigned long" dir="out">
7003	<desc>
7004	CPUID leaf value for register edx.
7005	</desc>
7006	</param>
7007	</method>
7008
7009	<attribute name="memorySize" type="unsigned long" readonly="yes">
7010	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7011	</attribute>
7012
7013	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7014	<desc>Available system memory in the host system.</desc>
7015	</attribute>
7016
7017	<attribute name="operatingSystem" type="wstring" readonly="yes">
7018	<desc>Name of the host system's operating system.</desc>
7019	</attribute>
7020
7021	<attribute name="OSVersion" type="wstring" readonly="yes">
7022	<desc>Host operating system's version string.</desc>
7023	</attribute>
7024
7025	<attribute name="UTCTime" type="long long" readonly="yes">
7026	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7027	</attribute>
7028
7029	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7030	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7031	</attribute>
7032
7033	<method name="createHostOnlyNetworkInterface">
7034	<desc>
7035	Creates a new adapter for Host Only Networking.
7036	<result name="E_INVALIDARG">
7037	Host network interface @a name already exists.
7038	</result>
7039	</desc>
7040	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7041	<desc>
7042	Created host interface object.
7043	</desc>
7044	</param>
7045	<param name="progress" type="IProgress" dir="return">
7046	<desc>
7047	Progress object to track the operation completion.
7048	</desc>
7049	</param>
7050	</method>
7051
7052	<method name="removeHostOnlyNetworkInterface">
7053	<desc>
7054	Removes the given Host Only Networking interface.
7055	<result name="VBOX_E_OBJECT_NOT_FOUND">
7056	No host network interface matching @a id found.
7057	</result>
7058	</desc>
7059	<param name="id" type="uuid" mod="string" dir="in">
7060	<desc>
7061	Adapter GUID.
7062	</desc>
7063	</param>
7064	<param name="progress" type="IProgress" dir="return">
7065	<desc>
7066	Progress object to track the operation completion.
7067	</desc>
7068	</param>
7069	</method>
7070
7071	<method name="createUSBDeviceFilter">
7072	<desc>
7073	Creates a new USB device filter. All attributes except
7074	the filter name are set to empty (any match),
7075	<i>active</i> is @c false (the filter is not active).
7076
7077	The created filter can be added to the list of filters using
7078	<link to="#insertUSBDeviceFilter"/>.
7079
7080	<see>#USBDeviceFilters</see>
7081	</desc>
7082	<param name="name" type="wstring" dir="in">
7083	<desc>
7084	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7085	</desc>
7086	</param>
7087	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7088	<desc>Created filter object.</desc>
7089	</param>
7090	</method>
7091
7092	<method name="insertUSBDeviceFilter">
7093	<desc>
7094	Inserts the given USB device to the specified position
7095	in the list of filters.
7096
7097	Positions are numbered starting from @c 0. If the specified
7098	position is equal to or greater than the number of elements in
7099	the list, the filter is added at the end of the collection.
7100
7101	<note>
7102	Duplicates are not allowed, so an attempt to insert a
7103	filter already in the list is an error.
7104	</note>
7105	<note>
7106	If USB functionality is not available in the given edition of
7107	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7108	</note>
7109
7110	<see>#USBDeviceFilters</see>
7111
7112	<result name="VBOX_E_INVALID_OBJECT_STATE">
7113	USB device filter is not created within this VirtualBox instance.
7114	</result>
7115	<result name="E_INVALIDARG">
7116	USB device filter already in list.
7117	</result>
7118
7119	</desc>
7120	<param name="position" type="unsigned long" dir="in">
7121	<desc>Position to insert the filter to.</desc>
7122	</param>
7123	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7124	<desc>USB device filter to insert.</desc>
7125	</param>
7126	</method>
7127
7128	<method name="removeUSBDeviceFilter">
7129	<desc>
7130	Removes a USB device filter from the specified position in the
7131	list of filters.
7132
7133	Positions are numbered starting from @c 0. Specifying a
7134	position equal to or greater than the number of elements in
7135	the list will produce an error.
7136
7137	<note>
7138	If USB functionality is not available in the given edition of
7139	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7140	</note>
7141
7142	<see>#USBDeviceFilters</see>
7143
7144	<result name="E_INVALIDARG">
7145	USB device filter list empty or invalid @a position.
7146	</result>
7147
7148	</desc>
7149	<param name="position" type="unsigned long" dir="in">
7150	<desc>Position to remove the filter from.</desc>
7151	</param>
7152	</method>
7153
7154	<method name="findHostDVDDrive">
7155	<desc>
7156	Searches for a host DVD drive with the given @c name.
7157
7158	<result name="VBOX_E_OBJECT_NOT_FOUND">
7159	Given @c name does not correspond to any host drive.
7160	</result>
7161
7162	</desc>
7163	<param name="name" type="wstring" dir="in">
7164	<desc>Name of the host drive to search for</desc>
7165	</param>
7166	<param name="drive" type="IMedium" dir="return">
7167	<desc>Found host drive object</desc>
7168	</param>
7169	</method>
7170
7171	<method name="findHostFloppyDrive">
7172	<desc>
7173	Searches for a host floppy drive with the given @c name.
7174
7175	<result name="VBOX_E_OBJECT_NOT_FOUND">
7176	Given @c name does not correspond to any host floppy drive.
7177	</result>
7178
7179	</desc>
7180	<param name="name" type="wstring" dir="in">
7181	<desc>Name of the host floppy drive to search for</desc>
7182	</param>
7183	<param name="drive" type="IMedium" dir="return">
7184	<desc>Found host floppy drive object</desc>
7185	</param>
7186	</method>
7187
7188	<method name="findHostNetworkInterfaceByName">
7189	<desc>
7190	Searches through all host network interfaces for an interface with
7191	the given @c name.
7192	<note>
7193	The method returns an error if the given @c name does not
7194	correspond to any host network interface.
7195	</note>
7196	</desc>
7197	<param name="name" type="wstring" dir="in">
7198	<desc>Name of the host network interface to search for.</desc>
7199	</param>
7200	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7201	<desc>Found host network interface object.</desc>
7202	</param>
7203	</method>
7204	<method name="findHostNetworkInterfaceById">
7205	<desc>
7206	Searches through all host network interfaces for an interface with
7207	the given GUID.
7208	<note>
7209	The method returns an error if the given GUID does not
7210	correspond to any host network interface.
7211	</note>
7212	</desc>
7213	<param name="id" type="uuid" mod="string" dir="in">
7214	<desc>GUID of the host network interface to search for.</desc>
7215	</param>
7216	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7217	<desc>Found host network interface object.</desc>
7218	</param>
7219	</method>
7220	<method name="findHostNetworkInterfacesOfType">
7221	<desc>
7222	Searches through all host network interfaces and returns a list of interfaces of the specified type
7223	</desc>
7224	<param name="type" type="HostNetworkInterfaceType" dir="in">
7225	<desc>type of the host network interfaces to search for.</desc>
7226	</param>
7227	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7228	<desc>Found host network interface objects.</desc>
7229	</param>
7230	</method>
7231
7232	<method name="findUSBDeviceById">
7233	<desc>
7234	Searches for a USB device with the given UUID.
7235
7236	<result name="VBOX_E_OBJECT_NOT_FOUND">
7237	Given @c id does not correspond to any USB device.
7238	</result>
7239
7240	<see>IHostUSBDevice::id</see>
7241	</desc>
7242	<param name="id" type="uuid" mod="string" dir="in">
7243	<desc>UUID of the USB device to search for.</desc>
7244	</param>
7245	<param name="device" type="IHostUSBDevice" dir="return">
7246	<desc>Found USB device object.</desc>
7247	</param>
7248	</method>
7249
7250	<method name="findUSBDeviceByAddress">
7251	<desc>
7252	Searches for a USB device with the given host address.
7253
7254	<result name="VBOX_E_OBJECT_NOT_FOUND">
7255	Given @c name does not correspond to any USB device.
7256	</result>
7257
7258	<see>IHostUSBDevice::address</see>
7259	</desc>
7260	<param name="name" type="wstring" dir="in">
7261	<desc>
7262	Address of the USB device (as assigned by the host) to
7263	search for.
7264	</desc>
7265	</param>
7266	<param name="device" type="IHostUSBDevice" dir="return">
7267	<desc>Found USB device object.</desc>
7268	</param>
7269	</method>
7270
7271	</interface>
7272
7273	<!--
7274	// ISystemProperties
7275	/////////////////////////////////////////////////////////////////////////
7276	-->
7277
7278	<interface
7279	name="ISystemProperties"
7280	extends="$unknown"
7281	uuid="07c3ffd8-8f59-49cc-b608-53a332e85cc3"
7282	wsmap="managed"
7283	>
7284	<desc>
7285	The ISystemProperties interface represents global properties of the given
7286	VirtualBox installation.
7287
7288	These properties define limits and default values for various attributes
7289	and parameters. Most of the properties are read-only, but some can be
7290	changed by a user.
7291	</desc>
7292
7293	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7294	<desc>Minimum guest system memory in Megabytes.</desc>
7295	</attribute>
7296
7297	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7298	<desc>Maximum guest system memory in Megabytes.</desc>
7299	</attribute>
7300
7301	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7302	<desc>Minimum guest video memory in Megabytes.</desc>
7303	</attribute>
7304
7305	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7306	<desc>Maximum guest video memory in Megabytes.</desc>
7307	</attribute>
7308
7309	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7310	<desc>Minimum CPU count.</desc>
7311	</attribute>
7312
7313	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7314	<desc>Maximum CPU count.</desc>
7315	</attribute>
7316
7317	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7318	<desc>Maximum of monitors which could be connected.</desc>
7319	</attribute>
7320
7321	<attribute name="maxVDISize" type="unsigned long long" readonly="yes">
7322	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7323	</attribute>
7324
7325	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7326	<desc>
7327	Number of network adapters associated with every
7328	<link to="IMachine"/> instance.
7329	</desc>
7330	</attribute>
7331
7332	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7333	<desc>
7334	Number of serial ports associated with every
7335	<link to="IMachine"/> instance.
7336	</desc>
7337	</attribute>
7338
7339	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7340	<desc>
7341	Number of parallel ports associated with every
7342	<link to="IMachine"/> instance.
7343	</desc>
7344	</attribute>
7345
7346	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7347	<desc>
7348	Maximum device position in the boot order. This value corresponds
7349	to the total number of devices a machine can boot from, to make it
7350	possible to include all possible devices to the boot list.
7351	<see><link to="IMachine::setBootOrder"/></see>
7352	</desc>
7353	</attribute>
7354
7355	<attribute name="defaultMachineFolder" type="wstring">
7356	<desc>
7357	Full path to the default directory used to create new or open
7358	existing machines when a settings file name contains no
7359	path.
7360
7361	The initial value of this property is
7362	<tt><</tt><link to="IVirtualBox::homeFolder">
7363	VirtualBox_home</link><tt>>/Machines</tt>.
7364
7365	<note>
7366	Setting this property to @c null or an empty string will restore the
7367	initial value.
7368	</note>
7369	<note>
7370	When settings this property, the specified path can be
7371	absolute (full path) or relative
7372	to the <link to="IVirtualBox::homeFolder">
7373	VirtualBox home directory</link>.
7374	When reading this property, a full path is
7375	always returned.
7376	</note>
7377	<note>
7378	The specified path may not exist, it will be created
7379	when necessary.
7380	</note>
7381
7382	<see>
7383	<link to="IVirtualBox::createMachine"/>,
7384	<link to="IVirtualBox::openMachine"/>
7385	</see>
7386	</desc>
7387	</attribute>
7388
7389	<attribute name="defaultHardDiskFolder" type="wstring">
7390	<desc>
7391	Full path to the default directory used to create new or open existing
7392	virtual disks.
7393
7394	This path is used when the storage unit of a hard disk is a regular file
7395	in the host's file system and only a file name that contains no path is
7396	given.
7397
7398	The initial value of this property is
7399	<tt><</tt>
7400	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7401	<tt>>/HardDisks</tt>.
7402
7403	<note>
7404	Setting this property to @c null or empty string will restore the
7405	initial value.
7406	</note>
7407	<note>
7408	When settings this property, the specified path can be relative
7409	to the
7410	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7411	absolute. When reading this property, a full path is
7412	always returned.
7413	</note>
7414	<note>
7415	The specified path may not exist, it will be created
7416	when necessary.
7417	</note>
7418
7419	<see>
7420	IMedium,
7421	<link to="IVirtualBox::createHardDisk"/>,
7422	<link to="IVirtualBox::openHardDisk"/>,
7423	<link to="IMedium::location"/>
7424	</see>
7425	</desc>
7426	</attribute>
7427
7428	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7429	<desc>
7430	List of all medium storage formats supported by this VirtualBox
7431	installation.
7432
7433	Keep in mind that the medium format identifier
7434	(<link to="IMediumFormat::id"/>) used in other API calls like
7435	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7436	medium format is a case-insensitive string. This means that, for
7437	example, all of the following strings:
7438	<pre>
7439	"VDI"
7440	"vdi"
7441	"VdI"</pre>
7442	refer to the same medium format.
7443
7444	Note that the virtual medium framework is backend-based, therefore
7445	the list of supported formats depends on what backends are currently
7446	installed.
7447
7448	<see>
7449	<link to="IMediumFormat"/>,
7450	</see>
7451	</desc>
7452	</attribute>
7453
7454	<attribute name="defaultHardDiskFormat" type="wstring">
7455	<desc>
7456	Identifier of the default medium format used by VirtualBox.
7457
7458	The medium format set by this attribute is used by VirtualBox
7459	when the medium format was not specified explicitly. One example is
7460	<link to="IVirtualBox::createHardDisk"/> with the empty
7461	format argument. A more complex example is implicit creation of
7462	differencing media when taking a snapshot of a virtual machine:
7463	this operation will try to use a format of the parent medium first
7464	and if this format does not support differencing media the default
7465	format specified by this argument will be used.
7466
7467	The list of supported medium formats may be obtained by the
7468	<link to="#mediumFormats"/> call. Note that the default medium
7469	format must have a capability to create differencing media;
7470	otherwise operations that create media implicitly may fail
7471	unexpectedly.
7472
7473	The initial value of this property is <tt>"VDI"</tt> in the current
7474	version of the VirtualBox product, but may change in the future.
7475
7476	<note>
7477	Setting this property to @c null or empty string will restore the
7478	initial value.
7479	</note>
7480
7481	<see>
7482	<link to="#mediumFormats"/>,
7483	<link to="IMediumFormat::id"/>,
7484	<link to="IVirtualBox::createHardDisk"/>
7485	</see>
7486	</desc>
7487	</attribute>
7488
7489	<attribute name="freeDiskSpaceWarning" type="unsigned long long">
7490	<desc>Issue a warning if the free disk space is below (or in some disk
7491	intensive operation is expected to go below) the given size in
7492	Megabytes.</desc>
7493	</attribute>
7494
7495	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7496	<desc>Issue a warning if the free disk space is below (or in some disk
7497	intensive operation is expected to go below) the given percentage.</desc>
7498	</attribute>
7499
7500	<attribute name="freeDiskSpaceError" type="unsigned long long">
7501	<desc>Issue an error if the free disk space is below (or in some disk
7502	intensive operation is expected to go below) the given size in
7503	Megabytes.</desc>
7504	</attribute>
7505
7506	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7507	<desc>Issue an error if the free disk space is below (or in some disk
7508	intensive operation is expected to go below) the given percentage.</desc>
7509	</attribute>
7510
7511	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7512	<desc>
7513	Library that provides authentication for VRDP clients. The library
7514	is used if a virtual machine's authentication type is set to "external"
7515	in the VM RemoteDisplay configuration.
7516
7517	The system library extension (".DLL" or ".so") must be omitted.
7518	A full path can be specified; if not, then the library must reside on the
7519	system's default library path.
7520
7521	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7522	of that name in one of the default VirtualBox library directories.
7523
7524	For details about VirtualBox authentication libraries and how to implement
7525	them, please refer to the VirtualBox manual.
7526
7527	<note>
7528	Setting this property to @c null or empty string will restore the
7529	initial value.
7530	</note>
7531	</desc>
7532	</attribute>
7533
7534	<attribute name="webServiceAuthLibrary" type="wstring">
7535	<desc>
7536	Library that provides authentication for webservice clients. The library
7537	is used if a virtual machine's authentication type is set to "external"
7538	in the VM RemoteDisplay configuration and will be called from
7539	within the <link to="IWebsessionManager::logon" /> implementation.
7540
7541	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7542	there is no per-VM setting for this, as the webservice is a global
7543	resource (if it is running). Only for this setting (for the webservice),
7544	setting this value to a literal <tt>"null"</tt> string disables authentication,
7545	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7546	no matter what user name and password are supplied.
7547
7548	The initial value of this property is <tt>"VRDPAuth"</tt>,
7549	meaning that the webservice will use the same authentication
7550	library that is used by default for VBoxVRDP (again, see
7551	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7552	The format and calling convention of authentication libraries
7553	is the same for the webservice as it is for VBoxVRDP.
7554
7555	<note>
7556	Setting this property to @c null or empty string will restore the
7557	initial value.
7558	</note>
7559	</desc>
7560	</attribute>
7561
7562	<attribute name="LogHistoryCount" type="unsigned long">
7563	<desc>
7564	This value specifies how many old release log files are kept.
7565	</desc>
7566	</attribute>
7567
7568	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7569	<desc>This value hold the default audio driver for the current
7570	system.</desc>
7571	</attribute>
7572
7573	<method name="getMaxDevicesPerPortForStorageBus">
7574	<desc>Returns the maximum number of devices which can be attached to a port
7575	for the given storage bus.</desc>
7576
7577	<param name="bus" type="StorageBus" dir="in">
7578	<desc>The storage bus type to get the value for.</desc>
7579	</param>
7580
7581	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7582	<desc>The maximum number of devices which can eb attached to the port for the given
7583	storage bus.</desc>
7584	</param>
7585	</method>
7586
7587	<method name="getMinPortCountForStorageBus">
7588	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7589
7590	<param name="bus" type="StorageBus" dir="in">
7591	<desc>The storage bus type to get the value for.</desc>
7592	</param>
7593
7594	<param name="minPortCount" type="unsigned long" dir="return">
7595	<desc>The minimum number of ports for the given storage bus.</desc>
7596	</param>
7597	</method>
7598
7599	<method name="getMaxPortCountForStorageBus">
7600	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7601
7602	<param name="bus" type="StorageBus" dir="in">
7603	<desc>The storage bus type to get the value for.</desc>
7604	</param>
7605
7606	<param name="maxPortCount" type="unsigned long" dir="return">
7607	<desc>The maximum number of ports for the given storage bus.</desc>
7608	</param>
7609	</method>
7610
7611	<method name="getMaxInstancesOfStorageBus">
7612	<desc>Returns the maximum number of storage bus instances which
7613	can be configured for each VM. This corresponds to the number of
7614	storage controllers one can have.</desc>
7615
7616	<param name="bus" type="StorageBus" dir="in">
7617	<desc>The storage bus type to get the value for.</desc>
7618	</param>
7619
7620	<param name="maxInstances" type="unsigned long" dir="return">
7621	<desc>The maximum number of instances for the given storage bus.</desc>
7622	</param>
7623	</method>
7624
7625	<method name="getDeviceTypesForStorageBus">
7626	<desc>Returns list of all the supported device types
7627	(<link to="DeviceType"/>) for the given type of storage
7628	bus.</desc>
7629
7630	<param name="bus" type="StorageBus" dir="in">
7631	<desc>The storage bus type to get the value for.</desc>
7632	</param>
7633
7634	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7635	<desc>The list of all supported device types for the given storage bus.</desc>
7636	</param>
7637	</method>
7638	</interface>
7639
7640	<!--
7641	// IGuest
7642	/////////////////////////////////////////////////////////////////////////
7643	-->
7644
7645	<interface
7646	name="IGuestOSType" extends="$unknown"
7647	uuid="e3f6727e-a09b-41ea-a824-864a176472f3"
7648	wsmap="struct"
7649	>
7650	<desc>
7651	</desc>
7652
7653	<attribute name="familyId" type="wstring" readonly="yes">
7654	<desc>Guest OS family identifier string.</desc>
7655	</attribute>
7656
7657	<attribute name="familyDescription" type="wstring" readonly="yes">
7658	<desc>Human readable description of the guest OS family.</desc>
7659	</attribute>
7660
7661	<attribute name="id" type="wstring" readonly="yes">
7662	<desc>Guest OS identifier string.</desc>
7663	</attribute>
7664
7665	<attribute name="description" type="wstring" readonly="yes">
7666	<desc>Human readable description of the guest OS.</desc>
7667	</attribute>
7668
7669	<attribute name="is64Bit" type="boolean" readonly="yes">
7670	<desc>Returns @c true if the given OS is 64-bit</desc>
7671	</attribute>
7672
7673	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7674	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7675	</attribute>
7676
7677	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7678	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7679	</attribute>
7680
7681	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7682	<desc>Recommended RAM size in Megabytes.</desc>
7683	</attribute>
7684
7685	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7686	<desc>Recommended video RAM size in Megabytes.</desc>
7687	</attribute>
7688
7689	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
7690	<desc>Recommended hard disk size in Megabytes.</desc>
7691	</attribute>
7692
7693	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7694	<desc>Returns recommended network adapter for this OS type.</desc>
7695	</attribute>
7696
7697	<attribute name="recommendedPae" type="boolean" readonly="yes">
7698	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7699	</attribute>
7700
7701	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7702	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7703	</attribute>
7704
7705	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7706	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7707	</attribute>
7708
7709	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7710	<desc>Recommended storage controller type for HD drives.</desc>
7711	</attribute>
7712
7713	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7714	<desc>Recommended storage bus type for HD drives.</desc>
7715	</attribute>
7716
7717	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7718	<desc>Recommended firmware type.</desc>
7719	</attribute>
7720
7721	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7722	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7723	</attribute>
7724
7725	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7726	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7727	</attribute>
7728
7729	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7730	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7731	</attribute>
7732
7733	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7734	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7735	</attribute>
7736
7737	</interface>
7738
7739	<interface
7740	name="IGuest" extends="$unknown"
7741	uuid="d915dff1-ed38-495a-91f1-ab6c53932468"
7742	wsmap="managed"
7743	>
7744	<desc>
7745	The IGuest interface represents information about the operating system
7746	running inside the virtual machine. Used in
7747	<link to="IConsole::guest"/>.
7748
7749	IGuest provides information about the guest operating system, whether
7750	Guest Additions are installed and other OS-specific virtual machine
7751	properties.
7752	</desc>
7753
7754	<attribute name="OSTypeId" type="wstring" readonly="yes">
7755	<desc>
7756	Identifier of the Guest OS type as reported by the Guest
7757	Additions.
7758	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7759	an IGuestOSType object representing details about the given
7760	Guest OS type.
7761	<note>
7762	If Guest Additions are not installed, this value will be
7763	the same as <link to="IMachine::OSTypeId"/>.
7764	</note>
7765	</desc>
7766	</attribute>
7767
7768	<attribute name="additionsActive" type="boolean" readonly="yes">
7769	<desc>
7770	Flag whether the Guest Additions are installed and active
7771	in which case their version will be returned by the
7772	<link to="#additionsVersion"/> property.
7773	</desc>
7774	</attribute>
7775
7776	<attribute name="additionsVersion" type="wstring" readonly="yes">
7777	<desc>
7778	Version of the Guest Additions including the revision (3 decimal numbers
7779	separated by dots + revision number) installed on the guest or empty
7780	when the Additions are not installed.
7781	</desc>
7782	</attribute>
7783
7784	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7785	<desc>
7786	Flag whether seamless guest display rendering (seamless desktop
7787	integration) is supported.
7788	</desc>
7789	</attribute>
7790
7791	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7792	<desc>
7793	Flag whether the guest is in graphics mode. If it is not, then
7794	seamless rendering will not work, resize hints are not immediately
7795	acted on and guest display resizes are probably not initiated by
7796	the guest additions.
7797	</desc>
7798	</attribute>
7799
7800	<attribute name="memoryBalloonSize" type="unsigned long">
7801	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7802	</attribute>
7803
7804	<attribute name="pageFusionEnabled" type="boolean">
7805	<desc>Flag whether page fusion is enabled or not.</desc>
7806	</attribute>
7807
7808	<attribute name="statisticsUpdateInterval" type="unsigned long">
7809	<desc>Interval to update guest statistics in seconds.</desc>
7810	</attribute>
7811
7812	<method name="internalGetStatistics">
7813	<desc>
7814	Internal method; do not use as it might change at any time
7815	</desc>
7816	<param name="cpuUser" type="unsigned long" dir="out">
7817	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7818	</param>
7819	<param name="cpuKernel" type="unsigned long" dir="out">
7820	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7821	</param>
7822	<param name="cpuIdle" type="unsigned long" dir="out">
7823	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7824	</param>
7825	<param name="memTotal" type="unsigned long" dir="out">
7826	<desc>Total amount of physical guest RAM</desc>
7827	</param>
7828	<param name="memFree" type="unsigned long" dir="out">
7829	<desc>Free amount of physical guest RAM</desc>
7830	</param>
7831	<param name="memBalloon" type="unsigned long" dir="out">
7832	<desc>Amount of ballooned physical guest RAM</desc>
7833	</param>
7834	<param name="memShared" type="unsigned long" dir="out">
7835	<desc>Amount of shared physical guest RAM</desc>
7836	</param>
7837	<param name="memCache" type="unsigned long" dir="out">
7838	<desc>Total amount of guest (disk) cache memory</desc>
7839	</param>
7840	<param name="pagedTotal" type="unsigned long" dir="out">
7841	<desc>Total amount of space in the page file</desc>
7842	</param>
7843	<param name="memAllocTotal" type="unsigned long" dir="out">
7844	<desc>Total amount of memory allocated by the hypervisor</desc>
7845	</param>
7846	<param name="memFreeTotal" type="unsigned long" dir="out">
7847	<desc>Total amount of free memory available in the hypervisor</desc>
7848	</param>
7849	<param name="memBalloonTotal" type="unsigned long" dir="out">
7850	<desc>Total amount of memory ballooned by the hypervisor</desc>
7851	</param>
7852	<param name="memSharedTotal" type="unsigned long" dir="out">
7853	<desc>Total amount of shared memory in the hypervisor</desc>
7854	</param>
7855	</method>
7856
7857	<method name="setCredentials">
7858	<desc>
7859	Store login credentials that can be queried by guest operating
7860	systems with Additions installed. The credentials are transient
7861	to the session and the guest may also choose to erase them. Note
7862	that the caller cannot determine whether the guest operating system
7863	has queried or made use of the credentials.
7864
7865	<result name="VBOX_E_VM_ERROR">
7866	VMM device is not available.
7867	</result>
7868
7869	</desc>
7870	<param name="userName" type="wstring" dir="in">
7871	<desc>User name string, can be empty</desc>
7872	</param>
7873	<param name="password" type="wstring" dir="in">
7874	<desc>Password string, can be empty</desc>
7875	</param>
7876	<param name="domain" type="wstring" dir="in">
7877	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7878	</param>
7879	<param name="allowInteractiveLogon" type="boolean" dir="in">
7880	<desc>
7881	Flag whether the guest should alternatively allow the user to
7882	interactively specify different credentials. This flag might
7883	not be supported by all versions of the Additions.
7884	</desc>
7885	</param>
7886	</method>
7887
7888	<method name="executeProcess">
7889	<desc>
7890	Executes an existing program inside the guest VM.
7891
7892	<result name="VBOX_E_IPRT_ERROR">
7893	Could not execute process.
7894	</result>
7895
7896	</desc>
7897	<param name="execName" type="wstring" dir="in">
7898	<desc>
7899	Full path name of the command to execute on the guest; the
7900	commands has to exists in the guest VM in order to be executed.
7901	</desc>
7902	</param>
7903	<param name="flags" type="unsigned long" dir="in">
7904	<desc>
7905	Execution flags - currently not supported and therefore
7906	has to be set to 0.
7907	</desc>
7908	</param>
7909	<param name="arguments" type="wstring" safearray="yes" dir="in">
7910	<desc>
7911	Array of arguments passed to the execution command.
7912	</desc>
7913	</param>
7914	<param name="environment" type="wstring" safearray="yes" dir="in">
7915	<desc>
7916	Environment variables that can be set while the command is being
7917	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7918	variable just set its name ("NAME") without a value.
7919	</desc>
7920	</param>
7921	<param name="userName" type="wstring" dir="in">
7922	<desc>
7923	User name under which the command will be executed; has to exist
7924	and have the appropriate rights to execute programs in the VM.
7925	</desc>
7926	</param>
7927	<param name="password" type="wstring" dir="in">
7928	<desc>
7929	Password of the user account specified.
7930	</desc>
7931	</param>
7932	<param name="timeoutMS" type="unsigned long" dir="in">
7933	<desc>
7934	The maximum timeout value (in msec) to wait for finished program
7935	execution. Pass 0 for an infinite timeout.
7936	</desc>
7937	</param>
7938	<param name="pid" type="unsigned long" dir="out">
7939	<desc>
7940	The PID (process ID) of the started command for later reference.
7941	</desc>
7942	</param>
7943	<param name="progress" type="IProgress" dir="return">
7944	<desc>Progress object to track the operation completion.</desc>
7945	</param>
7946	</method>
7947
7948	<method name="getProcessOutput">
7949	<desc>
7950	Retrieves output of a formerly started process.
7951
7952	<result name="VBOX_E_IPRT_ERROR">
7953	Could not retrieve output.
7954	</result>
7955
7956	</desc>
7957	<param name="pid" type="unsigned long" dir="in">
7958	<desc>
7959	Process id returned by earlier executeProcess() call.
7960	</desc>
7961	</param>
7962	<param name="flags" type="unsigned long" dir="in">
7963	<desc>
7964	Flags describing which output to retrieve.
7965	</desc>
7966	</param>
7967	<param name="timeoutMS" type="unsigned long" dir="in">
7968	<desc>
7969	The maximum timeout value (in msec) to wait for output
7970	data. Pass 0 for an infinite timeout.
7971	</desc>
7972	</param>
7973	<param name="size" type="unsigned long long" dir="in">
7974	<desc>
7975	Size in bytes to read in the buffer.
7976	</desc>
7977	</param>
7978	<param name="data" type="octet" dir="return" safearray="yes">
7979	<desc>
7980	Buffer for retrieving the actual output. A data size of 0 means end of file
7981	if the requested size was not 0. This is the unprocessed
7982	output data, i.e. the line ending style depends on the platform of
7983	the system the server is running on.
7984	</desc>
7985	</param>
7986	</method>
7987
7988	<method name="getProcessStatus">
7989	<desc>
7990	Retrieves status, exit code and the exit reason of a formerly started process.
7991
7992	<result name="VBOX_E_IPRT_ERROR">
7993	Process with specified PID was not found.
7994	</result>
7995
7996	</desc>
7997	<param name="pid" type="unsigned long" dir="in">
7998	<desc>
7999	Process id returned by earlier executeProcess() call.
8000	</desc>
8001	</param>
8002	<param name="exitcode" type="unsigned long" dir="out">
8003	<desc>
8004	The exit code (if available).
8005	</desc>
8006	</param>
8007	<param name="flags" type="unsigned long" dir="out">
8008	<desc>
8009	Additional flags of process status (not used at the moment).
8010	</desc>
8011	</param>
8012	<param name="reason" type="unsigned long" dir="return">
8013	<desc>
8014	The current process status.
8015	</desc>
8016	</param>
8017	</method>
8018
8019	</interface>
8020
8021
8022	<!--
8023	// IProgress
8024	/////////////////////////////////////////////////////////////////////////
8025	-->
8026
8027	<interface
8028	name="IProgress" extends="$unknown"
8029	uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
8030	wsmap="managed"
8031	>
8032	<desc>
8033	The IProgress interface is used to track and control
8034	asynchronous tasks within VirtualBox.
8035
8036	An instance of this is returned every time VirtualBox starts
8037	an asynchronous task (in other words, a separate thread) which
8038	continues to run after a method call returns. For example,
8039	<link to="IConsole::saveState" />, which saves the state of
8040	a running virtual machine, can take a long time to complete.
8041	To be able to display a progress bar, a user interface such as
8042	the VirtualBox graphical user interface can use the IProgress
8043	object returned by that method.
8044
8045	Note that IProgress is a "read-only" interface in the sense
8046	that only the VirtualBox internals behind the Main API can
8047	create and manipulate progress objects, whereas client code
8048	can only use the IProgress object to monitor a task's
8049	progress and, if <link to="#cancelable" /> is @c true,
8050	cancel the task by calling <link to="#cancel" />.
8051
8052	A task represented by IProgress consists of either one or
8053	several sub-operations that run sequentially, one by one (see
8054	<link to="#operation" /> and <link to="#operationCount" />).
8055	Every operation is identified by a number (starting from 0)
8056	and has a separate description.
8057
8058	You can find the individual percentage of completion of the current
8059	operation in <link to="#operationPercent" /> and the
8060	percentage of completion of the task as a whole
8061	in <link to="#percent" />.
8062
8063	Similarly, you can wait for the completion of a particular
8064	operation via <link to="#waitForOperationCompletion" /> or
8065	for the completion of the whole task via
8066	<link to="#waitForCompletion" />.
8067	</desc>
8068
8069	<attribute name="id" type="uuid" mod="string" readonly="yes">
8070	<desc>ID of the task.</desc>
8071	</attribute>
8072
8073	<attribute name="description" type="wstring" readonly="yes">
8074	<desc>Description of the task.</desc>
8075	</attribute>
8076
8077	<attribute name="initiator" type="$unknown" readonly="yes">
8078	<desc>Initiator of the task.</desc>
8079	</attribute>
8080
8081	<attribute name="cancelable" type="boolean" readonly="yes">
8082	<desc>Whether the task can be interrupted.</desc>
8083	</attribute>
8084
8085	<attribute name="percent" type="unsigned long" readonly="yes">
8086	<desc>
8087	Current progress value of the task as a whole, in percent.
8088	This value depends on how many operations are already complete.
8089	Returns 100 if <link to="#completed" /> is @c true.
8090	</desc>
8091	</attribute>
8092
8093	<attribute name="timeRemaining" type="long" readonly="yes">
8094	<desc>
8095	Estimated remaining time until the task completes, in
8096	seconds. Returns 0 once the task has completed; returns -1
8097	if the remaining time cannot be computed, in particular if
8098	the current progress is 0.
8099
8100	Even if a value is returned, the estimate will be unreliable
8101	for low progress values. It will become more reliable as the
8102	task progresses; it is not recommended to display an ETA
8103	before at least 20% of a task have completed.
8104	</desc>
8105	</attribute>
8106
8107	<attribute name="completed" type="boolean" readonly="yes">
8108	<desc>Whether the task has been completed.</desc>
8109	</attribute>
8110
8111	<attribute name="canceled" type="boolean" readonly="yes">
8112	<desc>Whether the task has been canceled.</desc>
8113	</attribute>
8114
8115	<attribute name="resultCode" type="long" readonly="yes">
8116	<desc>
8117	Result code of the progress task.
8118	Valid only if <link to="#completed"/> is @c true.
8119	</desc>
8120	</attribute>
8121
8122	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8123	<desc>
8124	Extended information about the unsuccessful result of the
8125	progress operation. May be @c null if no extended information
8126	is available.
8127	Valid only if <link to="#completed"/> is @c true and
8128	<link to="#resultCode"/> indicates a failure.
8129	</desc>
8130	</attribute>
8131
8132	<attribute name="operationCount" type="unsigned long" readonly="yes">
8133	<desc>
8134	Number of sub-operations this task is divided into.
8135	Every task consists of at least one suboperation.
8136	</desc>
8137	</attribute>
8138
8139	<attribute name="operation" type="unsigned long" readonly="yes">
8140	<desc>Number of the sub-operation being currently executed.</desc>
8141	</attribute>
8142
8143	<attribute name="operationDescription" type="wstring" readonly="yes">
8144	<desc>
8145	Description of the sub-operation being currently executed.
8146	</desc>
8147	</attribute>
8148
8149	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8150	<desc>Progress value of the current sub-operation only, in percent.</desc>
8151	</attribute>
8152
8153	<attribute name="timeout" type="unsigned long">
8154	<desc>
8155	When non-zero, this specifies the number of milliseconds after which
8156	the operation will automatically be canceled. This can only be set on
8157	cancelable objects.
8158	</desc>
8159	</attribute>
8160
8161	<method name="setCurrentOperationProgress">
8162	<desc>Internal method, not to be called externally.</desc>
8163	<param name="percent" type="unsigned long" dir="in" />
8164	</method>
8165	<method name="setNextOperation">
8166	<desc>Internal method, not to be called externally.</desc>
8167	<param name="nextOperationDescription" type="wstring" dir="in" />
8168	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8169	</method>
8170
8171	<method name="waitForCompletion">
8172	<desc>
8173	Waits until the task is done (including all sub-operations)
8174	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8175
8176	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8177	thread are not processed while waiting. Neglecting event queues may
8178	have dire consequences (degrade performance, resource hogs,
8179	deadlocks, etc.), this is specially so for the main thread on
8180	platforms using XPCOM. Callers are adviced wait for short periods
8181	and service their event queues between calls, or to create a worker
8182	thread to do the waiting.
8183
8184	<result name="VBOX_E_IPRT_ERROR">
8185	Failed to wait for task completion.
8186	</result>
8187	</desc>
8188
8189	<param name="timeout" type="long" dir="in">
8190	<desc>
8191	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8192	</desc>
8193	</param>
8194	</method>
8195
8196	<method name="waitForOperationCompletion">
8197	<desc>
8198	Waits until the given operation is done with a given timeout in
8199	milliseconds; specify -1 for an indefinite wait.
8200
8201	See <link to="#waitForCompletion"> for event queue considerations.</link>
8202
8203	<result name="VBOX_E_IPRT_ERROR">
8204	Failed to wait for operation completion.
8205	</result>
8206
8207	</desc>
8208	<param name="operation" type="unsigned long" dir="in">
8209	<desc>
8210	Number of the operation to wait for.
8211	Must be less than <link to="#operationCount"/>.
8212	</desc>
8213	</param>
8214	<param name="timeout" type="long" dir="in">
8215	<desc>
8216	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8217	</desc>
8218	</param>
8219	</method>
8220
8221	<method name="cancel">
8222	<desc>
8223	Cancels the task.
8224	<note>
8225	If <link to="#cancelable"/> is @c false, then this method will fail.
8226	</note>
8227
8228	<result name="VBOX_E_INVALID_OBJECT_STATE">
8229	Operation cannot be canceled.
8230	</result>
8231
8232	</desc>
8233	</method>
8234
8235	</interface>
8236
8237	<!--
8238	// ISnapshot
8239	/////////////////////////////////////////////////////////////////////////
8240	-->
8241
8242	<interface
8243	name="ISnapshot" extends="$unknown"
8244	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8245	wsmap="managed"
8246	>
8247	<desc>
8248	The ISnapshot interface represents a snapshot of the virtual
8249	machine.
8250
8251	Together with the differencing media that are created
8252	when a snapshot is taken, a machine can be brought back to
8253	the exact state it was in when the snapshot was taken.
8254
8255	The ISnapshot interface has no methods, only attributes; snapshots
8256	are controlled through methods of the <link to="IConsole" /> interface
8257	which also manage the media associated with the snapshot.
8258	The following operations exist:
8259
8260	<ul>
8261	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8262	by creating new, empty differencing images for the machine's
8263	media and saving the VM settings and (if the VM is running)
8264	the current VM state in the snapshot.
8265
8266	The differencing images will then receive all data written to
8267	the machine's media, while their parent (base) images
8268	remain unmodified after the snapshot has been taken (see
8269	<link to="IMedium" /> for details about differencing images).
8270	This simplifies restoring a machine to the state of a snapshot:
8271	only the differencing images need to be deleted.
8272
8273	The current machine state is not changed by taking a snapshot.
8274	If the machine is running, it will resume execution after the
8275	snapshot has been taken.
8276	</li>
8277
8278	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8279	a previous snapshot. This resets the machine's state to that of
8280	the previous snapshot by deleting the differencing image of each
8281	of the machine's media and setting the machine's settings
8282	and state to the state that was saved in the snapshot (if any).
8283
8284	This destroys the machine's current state.
8285	</li>
8286
8287	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8288	without affecting the current machine state.
8289
8290	This does not change the machine, but instead frees the resources
8291	allocated when the snapshot was taken: the settings and machine state
8292	is deleted (if any), and the snapshot's differencing image for each
8293	of the machine's media gets merged with its parent image.
8294
8295	Neither the current machine state nor other snapshots are affected
8296	by this operation, except that parent media will be modified
8297	to contain the disk data associated with the snapshot being deleted.
8298	</li>
8299	</ul>
8300
8301	Each snapshot contains the settings of the virtual machine (hardware
8302	configuration etc.). In addition, if the machine was running when the
8303	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8304	the current VM state is saved in the snapshot (similarly to what happens
8305	when a VM's state is saved). The snapshot is then said to
8306	be <i>online</i> because when restoring it, the VM will be running.
8307
8308	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8309	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8310
8311	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8312	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8313	it then contains a so-called "zero execution state", representing a
8314	machine that is powered off.
8315
8316	<h3>Snapshot branches and the "current" snapshot</h3>
8317
8318	Snapshots can be chained, whereby every next snapshot is based on the
8319	previous one. This chaining is related to medium branching
8320	(see the <link to="IMedium"/> description) in that every time
8321	a new snapshot is created, a new differencing medium is implicitly
8322	created for all normal media attached to the machine.
8323
8324	Each virtual machine has a "current snapshot", identified by
8325	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8326	to the last snapshot in the chain. In a future version of VirtualBox,
8327	it will be possible to reset a machine's current state to that of an
8328	earlier snapshot without deleting the current state so that it will be
8329	possible to create alternative snapshot paths in a snapshot tree.
8330
8331	In the current implementation, multiple snapshot branches within one
8332	virtual machine are not allowed. Every machine has a single branch,
8333	and <link to="IConsole::takeSnapshot"/> operation adds a new
8334	snapshot to the top of that branch.
8335	</desc>
8336
8337	<attribute name="id" type="uuid" mod="string" readonly="yes">
8338	<desc>UUID of the snapshot.</desc>
8339	</attribute>
8340
8341	<attribute name="name" type="wstring">
8342	<desc>Short name of the snapshot.</desc>
8343	</attribute>
8344
8345	<attribute name="description" type="wstring">
8346	<desc>Optional description of the snapshot.</desc>
8347	</attribute>
8348
8349	<attribute name="timeStamp" type="long long" readonly="yes">
8350	<desc>
8351	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8352	</desc>
8353	</attribute>
8354
8355	<attribute name="online" type="boolean" readonly="yes">
8356	<desc>
8357	@c true if this snapshot is an online snapshot and @c false otherwise.
8358
8359	When this attribute is @c true, the
8360	<link to="IMachine::stateFilePath"/> attribute of the
8361	<link to="#machine"/> object associated with this snapshot
8362	will point to the saved state file. Otherwise, it will be
8363	an empty string.
8364	</desc>
8365	</attribute>
8366
8367	<attribute name="machine" type="IMachine" readonly="yes">
8368	<desc>
8369	Virtual machine this snapshot is taken on. This object
8370	stores all settings the machine had when taking this snapshot.
8371	<note>
8372	The returned machine object is immutable, i.e. no
8373	any settings can be changed.
8374	</note>
8375	</desc>
8376	</attribute>
8377
8378	<attribute name="parent" type="ISnapshot" readonly="yes">
8379	<desc>
8380	Parent snapshot (a snapshot this one is based on), or
8381	@c null if the snapshot has no parent (i.e. is the first snapshot).
8382	</desc>
8383	</attribute>
8384
8385	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8386	<desc>
8387	Child snapshots (all snapshots having this one as a parent).
8388	</desc>
8389	</attribute>
8390
8391	</interface>
8392
8393
8394	<!--
8395	// IMedium
8396	/////////////////////////////////////////////////////////////////////////
8397	-->
8398
8399	<enum
8400	name="MediumState"
8401	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8402	>
8403	<desc>
8404	Virtual medium state.
8405	<see>IMedium</see>
8406	</desc>
8407
8408	<const name="NotCreated" value="0">
8409	<desc>
8410	Associated medium storage does not exist (either was not created yet or
8411	was deleted).
8412	</desc>
8413	</const>
8414	<const name="Created" value="1">
8415	<desc>
8416	Associated storage exists and accessible; this gets set if the
8417	accessibility check performed by <link to="IMedium::refreshState" />
8418	was successful.
8419	</desc>
8420	</const>
8421	<const name="LockedRead" value="2">
8422	<desc>
8423	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8424	no data modification is possible.
8425	</desc>
8426	</const>
8427	<const name="LockedWrite" value="3">
8428	<desc>
8429	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8430	no concurrent data reading or modification is possible.
8431	</desc>
8432	</const>
8433	<const name="Inaccessible" value="4">
8434	<desc>
8435	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8436	not yet been performed, or else, associated medium storage is not
8437	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8438	is empty, in the second case, it describes the error that occured.
8439	</desc>
8440	</const>
8441	<const name="Creating" value="5">
8442	<desc>
8443	Associated medium storage is being created.
8444	</desc>
8445	</const>
8446	<const name="Deleting" value="6">
8447	<desc>
8448	Associated medium storage is being deleted.
8449	</desc>
8450	</const>
8451	</enum>
8452
8453	<enum
8454	name="MediumType"
8455	uuid="46bf1fd4-ad86-4ded-8c49-28bd2d148e5a"
8456	>
8457	<desc>
8458	Virtual medium type.
8459	<see>IMedium</see>
8460	</desc>
8461
8462	<const name="Normal" value="0">
8463	<desc>
8464	Normal medium (attached directly or indirectly, preserved
8465	when taking snapshots).
8466	</desc>
8467	</const>
8468	<const name="Immutable" value="1">
8469	<desc>
8470	Immutable medium (attached indirectly, changes are wiped out
8471	the next time the virtual machine is started).
8472	</desc>
8473	</const>
8474	<const name="Writethrough" value="2">
8475	<desc>
8476	Write through medium (attached directly, ignored when
8477	taking snapshots).
8478	</desc>
8479	</const>
8480	<const name="Shareable" value="3">
8481	<desc>
8482	Allow using this medium concurrently by several machines.
8483	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8484	</desc>
8485	</const>
8486	</enum>
8487
8488	<enum
8489	name="MediumVariant"
8490	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8491	>
8492	<desc>
8493	Virtual medium image variant. More than one flag may be set.
8494	<see>IMedium</see>
8495	</desc>
8496
8497	<const name="Standard" value="0">
8498	<desc>
8499	No particular variant requested, results in using the backend default.
8500	</desc>
8501	</const>
8502	<const name="VmdkSplit2G" value="0x01">
8503	<desc>
8504	VMDK image split in chunks of less than 2GByte.
8505	</desc>
8506	</const>
8507	<const name="VmdkStreamOptimized" value="0x04">
8508	<desc>
8509	VMDK streamOptimized image. Special import/export format which is
8510	read-only/append-only.
8511	</desc>
8512	</const>
8513	<const name="VmdkESX" value="0x08">
8514	<desc>
8515	VMDK format variant used on ESX products.
8516	</desc>
8517	</const>
8518	<const name="Fixed" value="0x10000">
8519	<desc>
8520	Fixed image. Only allowed for base images.
8521	</desc>
8522	</const>
8523	<const name="Diff" value="0x20000">
8524	<desc>
8525	Differencing image. Only allowed for child images.
8526	</desc>
8527	</const>
8528	</enum>
8529
8530	<interface
8531	name="IMediumAttachment" extends="$unknown"
8532	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8533	wsmap="struct"
8534	>
8535	<desc>
8536	The IMediumAttachment interface links storage media to virtual machines.
8537	For each medium (<link to="IMedium"/>) which has been attached to a
8538	storage controller (<link to="IStorageController"/>) of a machine
8539	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8540	method, one instance of IMediumAttachment is added to the machine's
8541	<link to="IMachine::mediumAttachments"/> array attribute.
8542
8543	Each medium attachment specifies the storage controller as well as a
8544	port and device number and the IMedium instance representing a virtual
8545	hard disk or floppy or DVD image.
8546
8547	For removeable media (DVDs or floppies), there are two additional
8548	options. For one, the IMedium instance can be @c null to represent
8549	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8550	secondly, the medium can be one of the pseudo-media for host drives
8551	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8552	</desc>
8553
8554	<attribute name="medium" type="IMedium" readonly="yes">
8555	<desc>Medium object associated with this attachment; it
8556	can be @c null for removable devices.</desc>
8557	</attribute>
8558
8559	<attribute name="controller" type="wstring" readonly="yes">
8560	<desc>Name of the storage controller of this attachment; this
8561	refers to one of the controllers in <link to="IMachine::storageControllers" />
8562	by name.</desc>
8563	</attribute>
8564
8565	<attribute name="port" type="long" readonly="yes">
8566	<desc>Port number of this attachment.
8567	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8568	</desc>
8569	</attribute>
8570
8571	<attribute name="device" type="long" readonly="yes">
8572	<desc>Device slot number of this attachment.
8573	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8574	</desc>
8575	</attribute>
8576
8577	<attribute name="type" type="DeviceType" readonly="yes">
8578	<desc>Device type of this attachment.</desc>
8579	</attribute>
8580
8581	<attribute name="passthrough" type="boolean" readonly="yes">
8582	<desc>Pass I/O requests through to a device on the host.</desc>
8583	</attribute>
8584
8585	<attribute name="bandwidthLimit" type="unsigned long">
8586	<desc>
8587	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8588	A zero value means uncapped/unlimited.
8589	</desc>
8590	</attribute>
8591
8592	</interface>
8593
8594	<interface
8595	name="IMedium" extends="$unknown"
8596	uuid="858ea9d3-9ade-4aa7-91b7-d8a40f8f9b16"
8597	wsmap="managed"
8598	>
8599	<desc>
8600	The IMedium interface represents virtual storage for a machine's
8601	hard disks, CD/DVD or floppy drives. It will typically represent
8602	a disk image on the host, for example a VDI or VMDK file representing
8603	a virtual hard disk, or an ISO or RAW file representing virtual
8604	removable media, but can also point to a network location (e.g.
8605	for iSCSI targets).
8606
8607	Instances of IMedium are connected to virtual machines by way of
8608	medium attachments (see <link to="IMediumAttachment" />), which link
8609	the storage medium to a particular device slot of a storage controller
8610	of the virtual machine.
8611	In the VirtualBox API, virtual storage is therefore always represented
8612	by the following chain of object links:
8613
8614	<ul>
8615	<li><link to="IMachine::storageControllers"/> contains an array of
8616	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8617	these are instances of <link to="IStorageController"/>).</li>
8618	<li><link to="IMachine::mediumAttachments"/> contains an array of
8619	medium attachments (instances of <link to="IMediumAttachment"/>),
8620	each containing a storage controller from the above array, a
8621	port/device specification, and an instance of IMedium representing
8622	the medium storage (image file).
8623
8624	For removable media, the storage medium is optional; a medium
8625	attachment with no medium represents a CD/DVD or floppy drive
8626	with no medium inserted. By contrast, hard disk attachments
8627	will always have an IMedium object attached.</li>
8628	<li>Each IMedium in turn points to a storage unit (such as a file
8629	on the host computer or a network resource) that holds actual
8630	data. This location is represented by the <link to="#location"/>
8631	attribute.</li>
8632	</ul>
8633
8634	Existing media are opened using the following methods, depending on the
8635	media type:
8636	<ul>
8637	<li><link to="IVirtualBox::openHardDisk"/></li>
8638	<li><link to="IVirtualBox::openDVDImage"/></li>
8639	<li><link to="IVirtualBox::openFloppyImage"/></li>
8640	</ul>
8641
8642	New hard disk media can be created with the VirtualBox API using the
8643	<link to="IVirtualBox::createHardDisk"/> method.
8644
8645	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8646	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8647	type in a regular file.
8648
8649	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8650	drive; in that case the <link to="#id" /> attribute contains the UUID of
8651	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8652
8653	<h3>Known media</h3>
8654
8655	When an existing medium is opened for the first time, it is automatically
8656	remembered by the given VirtualBox installation or, in other words, becomes
8657	a <i>known medium</i>. Known media are stored in the media
8658	registry transparently maintained by VirtualBox and stored in settings
8659	files so that this registry is preserved when VirtualBox is not running.
8660
8661	Newly created virtual media are remembered only when the associated
8662	storage unit is actually created.
8663
8664	All known media can be enumerated using
8665	<link to="IVirtualBox::hardDisks"/>,
8666	<link to="IVirtualBox::DVDImages"/> and
8667	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8668	quickly found by UUID using <link to="IVirtualBox::getHardDisk"/>
8669	and similar methods or by location using
8670	<link to="IVirtualBox::findHardDisk"/> and similar methods.
8671
8672	Only known media can be attached to virtual machines.
8673
8674	Removing known media from the media registry is performed when the given
8675	medium is closed using the <link to="#close"/> method or when its
8676	associated storage unit is deleted.
8677
8678	<h3>Accessibility checks</h3>
8679
8680	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8681	method is called explicitly on a medium. This is done to make the VirtualBox object
8682	ready for serving requests as fast as possible and let the end-user
8683	application decide if it needs to check media accessibility right away or not.
8684
8685	As a result, when VirtualBox starts up (e.g. the VirtualBox
8686	object gets created for the first time), all known media are in the
8687	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8688	attribute is an empty string because no actual accessibility check has
8689	been made yet.
8690
8691	After calling <link to="#refreshState" />, a medium is considered
8692	<i>accessible</i> if its storage unit can be read. In that case, the
8693	<link to="#state"/> attribute has a value of "Created". If the storage
8694	unit cannot be read (for example, because it is located on a disconnected
8695	network resource, or was accidentally deleted outside VirtualBox),
8696	the medium is considered <i>inaccessible</i>, which is indicated by the
8697	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8698	obtained by reading the <link to="#lastAccessError"/> attribute.
8699
8700	<h3>Medium types</h3>
8701
8702	There are four types of medium behavior (see <link to="MediumType" />):
8703	"normal", "immutable", "writethrough" and "shareable", represented by the
8704	<link to="#type"/> attribute. The type of the medium defines how the
8705	medium is attached to a virtual machine and what happens when a
8706	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8707	attached medium is taken. At the moment DVD and floppy media are always
8708	of type "writethrough".
8709
8710	All media can be also divided in two groups: <i>base</i> media and
8711	<i>differencing</i> media. A base medium contains all sectors of the
8712	medium data in its own storage and therefore can be used independently.
8713	In contrast, a differencing mediun is a "delta" to some other medium and
8714	contains only those sectors which differ from that other medium, which is
8715	then called a <i>parent</i>. The differencing medium is said to be
8716	<i>linked to</i> that parent. The parent may be itself a differencing
8717	medium, thus forming a chain of linked media. The last element in that
8718	chain must always be a base medium. Note that several differencing
8719	media may be linked to the same parent medium.
8720
8721	Differencing media can be distinguished from base media by querying the
8722	<link to="#parent"/> attribute: base media do not have parents they would
8723	depend on, so the value of this attribute is always @c null for them.
8724	Using this attribute, it is possible to walk up the medium tree (from the
8725	child medium to its parent). It is also possible to walk down the tree
8726	using the <link to="#children"/> attribute.
8727
8728	Note that the type of all differencing media is "normal"; all other
8729	values are meaningless for them. Base media may be of any type.
8730
8731	<h3>Creating hard disks</h3>
8732
8733	New base hard disks are created using
8734	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8735	opened using <link to="IVirtualBox::openHardDisk"/>. Differencing hard
8736	disks are usually implicitly created by VirtualBox when needed but may
8737	also be created explicitly using <link to="#createDiffStorage"/>.
8738
8739	After the hard disk is successfully created (including the storage unit)
8740	or opened, it becomes a known hard disk (remembered in the internal media
8741	registry). Known hard disks can be attached to a virtual machine, accessed
8742	through <link to="IVirtualBox::getHardDisk"/> and
8743	<link to="IVirtualBox::findHardDisk"/> methods or enumerated using the
8744	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8745
8746	The following methods, besides <link to="IMedium::close"/>,
8747	automatically remove the hard disk from the media registry:
8748	<ul>
8749	<li><link to="#deleteStorage"/></li>
8750	<li><link to="#mergeTo"/></li>
8751	</ul>
8752
8753	If the storage unit of the hard disk is a regular file in the host's
8754	file system then the rules stated in the description of the
8755	<link to="IMedium::location"/> attribute apply when setting its value. In
8756	addition, a plain file name without any path may be given, in which case
8757	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8758	folder</link> will be prepended to it.
8759
8760	<h4>Automatic composition of the file name part</h4>
8761
8762	Another extension to the <link to="IMedium::location"/> attribute is that
8763	there is a possibility to cause VirtualBox to compose a unique value for
8764	the file name part of the location using the UUID of the hard disk. This
8765	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8766	e.g. before the storage unit is created, and works as follows. You set the
8767	value of the <link to="IMedium::location"/> attribute to a location
8768	specification which only contains the path specification but not the file
8769	name part and ends with either a forward slash or a backslash character.
8770	In response, VirtualBox will generate a new UUID for the hard disk and
8771	compose the file name using the following pattern:
8772	<pre>
8773	<path>/{<uuid>}.<ext>
8774	</pre>
8775	where <tt><path></tt> is the supplied path specification,
8776	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8777	is the default extension for the storage format of this hard disk. After
8778	that, you may call any of the methods that create a new hard disk storage
8779	unit and they will use the generated UUID and file name.
8780
8781	<h3>Attaching Hard Disks</h3>
8782
8783	Hard disks are attached to virtual machines using the
8784	<link to="IMachine::attachDevice"/> method and detached using the
8785	<link to="IMachine::detachDevice"/> method. Depending on their
8786	<link to="#type"/>, hard disks are attached either
8787	<i>directly</i> or <i>indirectly</i>.
8788
8789	When a hard disk is being attached directly, it is associated with the
8790	virtual machine and used for hard disk operations when the machine is
8791	running. When a hard disk is being attached indirectly, a new differencing
8792	hard disk linked to it is implicitly created and this differencing hard
8793	disk is associated with the machine and used for hard disk operations.
8794	This also means that if <link to="IMachine::attachDevice"/> performs
8795	a direct attachment then the same hard disk will be returned in response
8796	to the subsequent <link to="IMachine::getMedium"/> call; however if
8797	an indirect attachment is performed then
8798	<link to="IMachine::getMedium"/> will return the implicitly created
8799	differencing hard disk, not the original one passed to <link
8800	to="IMachine::attachDevice"/>. In detail:
8801
8802	<ul>
8803	<li><b>Normal base</b> hard disks that do not have children (i.e.
8804	differencing hard disks linked to them) and that are not already
8805	attached to virtual machines in snapshots are attached <b>directly</b>.
8806	Otherwise, they are attached <b>indirectly</b> because having
8807	dependent children or being part of the snapshot makes it impossible
8808	to modify hard disk contents without breaking the integrity of the
8809	dependent party. The <link to="#readOnly"/> attribute allows to
8810	quickly determine the kind of the attachment for the given hard
8811	disk. Note that if a normal base hard disk is to be indirectly
8812	attached to a virtual machine with snapshots then a special
8813	procedure called <i>smart attachment</i> is performed (see below).</li>
8814	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8815	they are attached <b>directly</b> if they do not have children and are
8816	not attached to virtual machines in snapshots, and <b>indirectly</b>
8817	otherwise. Note that the smart attachment procedure is never performed
8818	for differencing hard disks.</li>
8819	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8820	they are designed to be non-writable. If an immutable hard disk is
8821	attached to a virtual machine with snapshots then a special
8822	procedure called smart attachment is performed (see below).</li>
8823	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8824	also as designed. This also means that writethrough hard disks cannot
8825	have other hard disks linked to them at all.</li>
8826	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
8827	also as designed. This also means that shareable hard disks cannot
8828	have other hard disks linked to them at all. They behave almost
8829	like writethrough hard disks, except that shareable hard disks can
8830	be attached to several virtual machines which are running, allowing
8831	concurrent accesses. You need special cluster software running in
8832	the virtual machines to make use of such disks.</li>
8833	</ul>
8834
8835	Note that the same hard disk, regardless of its type, may be attached to
8836	more than one virtual machine at a time. In this case, the machine that is
8837	started first gains exclusive access to the hard disk and attempts to
8838	start other machines having this hard disk attached will fail until the
8839	first machine is powered down.
8840
8841	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8842	that the given hard disk remains associated with the given machine after a
8843	successful <link to="IMachine::detachDevice"/> call until
8844	<link to="IMachine::saveSettings"/> is called to save all changes to
8845	machine settings to disk. This deferring is necessary to guarantee that
8846	the hard disk configuration may be restored at any time by a call to
8847	<link to="IMachine::discardSettings"/> before the settings
8848	are saved (committed).
8849
8850	Note that if <link to="IMachine::discardSettings"/> is called after
8851	indirectly attaching some hard disks to the machine but before a call to
8852	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8853	all differencing hard disks implicitly created by
8854	<link to="IMachine::attachDevice"/> for these indirect attachments.
8855	Such implicitly created hard disks will also be immediately deleted when
8856	detached explicitly using the <link to="IMachine::detachDevice"/>
8857	call if it is made before <link to="IMachine::saveSettings"/>. This
8858	implicit deletion is safe because newly created differencing hard
8859	disks do not contain any user data.
8860
8861	However, keep in mind that detaching differencing hard disks that were
8862	implicitly created by <link to="IMachine::attachDevice"/>
8863	before the last <link to="IMachine::saveSettings"/> call will
8864	<b>not</b> implicitly delete them as they may already contain some data
8865	(for example, as a result of virtual machine execution). If these hard
8866	disks are no more necessary, the caller can always delete them explicitly
8867	using <link to="#deleteStorage"/> after they are actually de-associated
8868	from this machine by the <link to="IMachine::saveSettings"/> call.
8869
8870	<h3>Smart Attachment</h3>
8871
8872	When normal base or immutable hard disks are indirectly attached to a
8873	virtual machine then some additional steps are performed to make sure the
8874	virtual machine will have the most recent "view" of the hard disk being
8875	attached. These steps include walking through the machine's snapshots
8876	starting from the current one and going through ancestors up to the first
8877	snapshot. Hard disks attached to the virtual machine in all
8878	of the encountered snapshots are checked whether they are descendants of
8879	the given normal base or immutable hard disk. The first found child (which
8880	is the differencing hard disk) will be used instead of the normal base or
8881	immutable hard disk as a parent for creating a new differencing hard disk
8882	that will be actually attached to the machine. And only if no descendants
8883	are found or if the virtual machine does not have any snapshots then the
8884	normal base or immutable hard disk will be used itself as a parent for
8885	this differencing hard disk.
8886
8887	It is easier to explain what smart attachment does using the
8888	following example:
8889	<pre>
8890	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8891
8892	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8893	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8894	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8895	Snapshot 4 (none) Snapshot 4 (none)
8896	CurState (none) CurState (D3->D2.vdi)
8897
8898	NOT
8899	...
8900	CurState (D3->B.vdi)
8901	</pre>
8902	The first column is the virtual machine configuration before the base hard
8903	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8904	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8905	mean that the hard disk that is actually attached to the machine is a
8906	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8907	another hard disk, <tt>B.vdi</tt>.
8908
8909	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8910	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8911	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8912	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8913	it cannot be attached directly and needs an indirect attachment (i.e.
8914	implicit creation of a new differencing hard disk). Due to the smart
8915	attachment procedure, the new differencing hard disk
8916	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8917	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8918	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8919	machine.
8920
8921	Note that if there is more than one descendant hard disk of the given base
8922	hard disk found in a snapshot, and there is an exact device, channel and
8923	bus match, then this exact match will be used. Otherwise, the youngest
8924	descendant will be picked up.
8925
8926	There is one more important aspect of the smart attachment procedure which
8927	is not related to snapshots at all. Before walking through the snapshots
8928	as described above, the backup copy of the current list of hard disk
8929	attachment is searched for descendants. This backup copy is created when
8930	the hard disk configuration is changed for the first time after the last
8931	<link to="IMachine::saveSettings"/> call and used by
8932	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8933	changes. When such a descendant is found in this backup copy, it will be
8934	simply re-attached back, without creating a new differencing hard disk for
8935	it. This optimization is necessary to make it possible to re-attach the
8936	base or immutable hard disk to a different bus, channel or device slot
8937	without losing the contents of the differencing hard disk actually
8938	attached to the machine in place of it.
8939	</desc>
8940
8941	<attribute name="id" type="uuid" mod="string" readonly="yes">
8942	<desc>
8943	UUID of the medium. For a newly created medium, this value is a randomly
8944	generated UUID.
8945
8946	<note>
8947	For media in one of MediumState_NotCreated, MediumState_Creating or
8948	MediumState_Deleting states, the value of this property is undefined
8949	and will most likely be an empty UUID.
8950	</note>
8951	</desc>
8952	</attribute>
8953
8954	<attribute name="description" type="wstring">
8955	<desc>
8956	Optional description of the medium. For a newly created medium the value
8957	of this attribute is an empty string.
8958
8959	Medium types that don't support this attribute will return E_NOTIMPL in
8960	attempt to get or set this attribute's value.
8961
8962	<note>
8963	For some storage types, reading this attribute may return an outdated
8964	(last known) value when <link to="#state"/> is <link
8965	to="MediumState_Inaccessible"/> or <link
8966	to="MediumState_LockedWrite"/> because the value of this attribute is
8967	stored within the storage unit itself. Also note that changing the
8968	attribute value is not possible in such case, as well as when the
8969	medium is the <link to="MediumState_LockedRead"/> state.
8970	</note>
8971	</desc>
8972	</attribute>
8973
8974	<attribute name="state" type="MediumState" readonly="yes">
8975	<desc>
8976	Returns the current medium state, which is the last state set by
8977	the accessibility check performed by <link to="#refreshState"/>.
8978	If that method has not yet been called on the medium, the state
8979	is "Inaccessible"; as opposed to truly inaccessible media, the
8980	value of <link to="#lastAccessError"/> will be an empty string in
8981	that case.
8982
8983	<note>As of version 3.1, this no longer performs an accessibility check
8984	automatically; call <link to="#refreshState"/> for that.
8985	</note>
8986	</desc>
8987	</attribute>
8988
8989	<attribute name="variant" type="MediumVariant" readonly="yes">
8990	<desc>
8991	Returns the storage format variant information for this medium.
8992	Before <link to="#refreshState"/> is called this method returns
8993	an undefined value.
8994	</desc>
8995	</attribute>
8996
8997	<attribute name="location" type="wstring">
8998	<desc>
8999	Location of the storage unit holding medium data.
9000
9001	The format of the location string is medium type specific. For medium
9002	types using regular files in a host's file system, the location
9003	string is the full file name.
9004
9005	Some medium types may support changing the storage unit location by
9006	simply changing the value of this property. If this operation is not
9007	supported, the implementation will return E_NOTIMPL in attempt to set
9008	this attribute's value.
9009
9010	When setting a value of the location attribute which is a regular file
9011	in the host's file system, the given file name may be either relative to
9012	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9013	absolute. Note that if the given location specification does not contain
9014	the file extension part then a proper default extension will be
9015	automatically appended by the implementation depending on the medium type.
9016	</desc>
9017	</attribute>
9018
9019	<attribute name="name" type="wstring" readonly="yes">
9020	<desc>
9021	Name of the storage unit holding medium data.
9022
9023	The returned string is a short version of the <link to="#location"/>
9024	attribute that is suitable for representing the medium in situations
9025	where the full location specification is too long (such as lists
9026	and comboboxes in GUI frontends). This string is also used by frontends
9027	to sort the media list alphabetically when needed.
9028
9029	For example, for locations that are regular files in the host's file
9030	system, the value of this attribute is just the file name (+ extension),
9031	without the path specification.
9032
9033	Note that as opposed to the <link to="#location"/> attribute, the name
9034	attribute will not necessary be unique for a list of media of the
9035	given type and format.
9036	</desc>
9037	</attribute>
9038
9039	<attribute name="deviceType" type="DeviceType" readonly="yes">
9040	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9041	medium.</desc>
9042	</attribute>
9043
9044	<attribute name="hostDrive" type="boolean" readonly="yes">
9045	<desc>True if this corresponds to a drive on the host.</desc>
9046	</attribute>
9047
9048	<attribute name="size" type="unsigned long long" readonly="yes">
9049	<desc>
9050	Physical size of the storage unit used to hold medium data (in bytes).
9051
9052	<note>
9053	For media whose <link to="#state"/> is <link
9054	to="MediumState_Inaccessible"/>, the value of this property is the
9055	last known size. For <link to="MediumState_NotCreated"/> media,
9056	the returned value is zero.
9057	</note>
9058	</desc>
9059	</attribute>
9060
9061	<attribute name="format" type="wstring" readonly="yes">
9062	<desc>
9063	Storage format of this medium.
9064
9065	The value of this attribute is a string that specifies a backend used
9066	to store medium data. The storage format is defined when you create a
9067	new medium or automatically detected when you open an existing medium,
9068	and cannot be changed later.
9069
9070	The list of all storage formats supported by this VirtualBox
9071	installation can be obtained using
9072	<link to="ISystemProperties::mediumFormats"/>.
9073	</desc>
9074	</attribute>
9075
9076	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9077	<desc>
9078	Storage medium format object corresponding to this medium.
9079
9080	The value of this attribute is a reference to the medium format object
9081	that specifies the backend properties used to store medium data. The
9082	storage format is defined when you create a new medium or automatically
9083	detected when you open an existing medium, and cannot be changed later.
9084
9085	<note>@c null is returned if there is no associated medium format
9086	object. This can e.g. happen for medium objects representing host
9087	drives and other special medium objects.</note>
9088	</desc>
9089	</attribute>
9090
9091	<attribute name="type" type="MediumType">
9092	<desc>
9093	Type (role) of this medium.
9094
9095	The following constraints apply when changing the value of this
9096	attribute:
9097	<ul>
9098	<li>If a medium is attached to a virtual machine (either in the
9099	current state or in one of the snapshots), its type cannot be
9100	changed.
9101	</li>
9102	<li>As long as the medium has children, its type cannot be set
9103	to <link to="MediumType_Writethrough"/>.
9104	</li>
9105	<li>The type of all differencing media is
9106	<link to="MediumType_Normal"/> and cannot be changed.
9107	</li>
9108	</ul>
9109
9110	The type of a newly created or opened medium is set to
9111	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9112	which have a type of <link to="MediumType_Writethrough"/>.
9113	</desc>
9114	</attribute>
9115
9116	<attribute name="parent" type="IMedium" readonly="yes">
9117	<desc>
9118	Parent of this medium (the medium this medium is directly based
9119	on).
9120
9121	Only differencing media have parents. For base (non-differencing)
9122	media, @c null is returned.
9123	</desc>
9124	</attribute>
9125
9126	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9127	<desc>
9128	Children of this medium (all differencing media directly based
9129	on this medium). A @c null array is returned if this medium
9130	does not have any children.
9131	</desc>
9132	</attribute>
9133
9134	<attribute name="base" type="IMedium" readonly="yes">
9135	<desc>
9136	Base medium of this medium.
9137
9138	If this is a differencing medium, its base medium is the medium
9139	the given medium branch starts from. For all other types of media, this
9140	property returns the medium object itself (i.e. the same object this
9141	property is read on).
9142	</desc>
9143	</attribute>
9144
9145	<attribute name="readOnly" type="boolean" readonly="yes">
9146	<desc>
9147	Returns @c true if this medium is read-only and @c false otherwise.
9148
9149	A medium is considered to be read-only when its contents cannot be
9150	modified without breaking the integrity of other parties that depend on
9151	this medium such as its child media or snapshots of virtual machines
9152	where this medium is attached to these machines. If there are no
9153	children and no such snapshots then there is no dependency and the
9154	medium is not read-only.
9155
9156	The value of this attribute can be used to determine the kind of the
9157	attachment that will take place when attaching this medium to a
9158	virtual machine. If the value is @c false then the medium will
9159	be attached directly. If the value is @c true then the medium
9160	will be attached indirectly by creating a new differencing child
9161	medium for that. See the interface description for more information.
9162
9163	Note that all <link to="MediumType_Immutable">Immutable</link> media
9164	are always read-only while all
9165	<link to="MediumType_Writethrough">Writethrough</link> media are
9166	always not.
9167
9168	<note>
9169	The read-only condition represented by this attribute is related to
9170	the medium type and usage, not to the current
9171	<link to="IMedium::state">medium state</link> and not to the read-only
9172	state of the storage unit.
9173	</note>
9174	</desc>
9175	</attribute>
9176
9177	<attribute name="logicalSize" type="unsigned long long" readonly="yes">
9178	<desc>
9179	Logical size of this medium (in megabytes), as reported to the
9180	guest OS running inside the virtual machine this medium is
9181	attached to. The logical size is defined when the medium is created
9182	and cannot be changed later.
9183
9184	<note>
9185	Reading this property on a differencing medium will return the size
9186	of its <link to="#base"/> medium.
9187	</note>
9188	<note>
9189	For media whose state is <link to="#state"/> is <link
9190	to="MediumState_Inaccessible"/>, the value of this property is the
9191	last known logical size. For <link to="MediumState_NotCreated"/>
9192	media, the returned value is zero.
9193	</note>
9194	</desc>
9195	</attribute>
9196
9197	<attribute name="autoReset" type="boolean">
9198	<desc>
9199	Whether this differencing medium will be automatically reset each
9200	time a virtual machine it is attached to is powered up. This
9201	attribute is automatically set to @c true for the last
9202	differencing image of an "immutable" medium (see
9203	<link to="MediumType" />).
9204
9205	See <link to="#reset"/> for more information about resetting
9206	differencing media.
9207
9208	<note>
9209	Reading this property on a base (non-differencing) medium will
9210	always @c false. Changing the value of this property in this
9211	case is not supported.
9212	</note>
9213
9214	<result name="VBOX_E_NOT_SUPPORTED">
9215	This is not a differencing medium (when changing the attribute
9216	value).
9217	</result>
9218	</desc>
9219	</attribute>
9220
9221	<attribute name="lastAccessError" type="wstring" readonly="yes">
9222	<desc>
9223	Text message that represents the result of the last accessibility
9224	check performed by <link to="#refreshState"/>.
9225
9226	An empty string is returned if the last accessibility check
9227	was successful or has not yet been called. As a result, if
9228	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9229	then <link to="#refreshState"/> has yet to be called; this is the
9230	default value of media after VirtualBox initialization.
9231	A non-empty string indicates a failure and should normally describe
9232	a reason of the failure (for example, a file read error).
9233	</desc>
9234	</attribute>
9235
9236	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9237	<desc>
9238	Array of UUIDs of all machines this medium is attached to.
9239
9240	A @c null array is returned if this medium is not attached to any
9241	machine or to any machine's snapshot.
9242
9243	<note>
9244	The returned array will include a machine even if this medium is not
9245	attached to that machine in the current state but attached to it in
9246	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9247	details.
9248	</note>
9249	</desc>
9250	</attribute>
9251
9252	<method name="refreshState">
9253	<desc>
9254	If the current medium state (see <link to="MediumState"/>) is one of
9255	"Created", "Inaccessible" or "LockedRead", then this performs an
9256	accessibility check on the medium and sets the value of the <link to="#state"/>
9257	attribute accordingly; that value is also returned for convenience.
9258
9259	For all other state values, this does not perform a refresh but returns
9260	the state only.
9261
9262	The refresh, if performed, may take a long time (several seconds or even
9263	minutes, depending on the storage unit location and format) because it performs an
9264	accessibility check of the storage unit. This check may cause a significant
9265	delay if the storage unit of the given medium is, for example, a file located
9266	on a network share which is not currently accessible due to connectivity
9267	problems. In that case, the call will not return until a timeout
9268	interval defined by the host OS for this operation expires. For this reason,
9269	it is recommended to never read this attribute on the main UI thread to avoid
9270	making the UI unresponsive.
9271
9272	If the last known state of the medium is "Created" and the accessibility
9273	check fails, then the state would be set to "Inaccessible", and
9274	<link to="#lastAccessError"/> may be used to get more details about the
9275	failure. If the state of the medium is "LockedRead", then it remains the
9276	same, and a non-empty value of <link to="#lastAccessError"/> will
9277	indicate a failed accessibility check in this case.
9278
9279	Note that not all medium states are applicable to all medium types.
9280	</desc>
9281	<param name="state" type="MediumState" dir="return">
9282	<desc>
9283	New medium state.
9284	</desc>
9285	</param>
9286	</method>
9287
9288	<method name="getSnapshotIds">
9289	<desc>
9290	Returns an array of UUIDs of all snapshots of the given machine where
9291	this medium is attached to.
9292
9293	If the medium is attached to the machine in the current state, then the
9294	first element in the array will always be the ID of the queried machine
9295	(i.e. the value equal to the @c machineId argument), followed by
9296	snapshot IDs (if any).
9297
9298	If the medium is not attached to the machine in the current state, then
9299	the array will contain only snapshot IDs.
9300
9301	The returned array may be @c null if this medium is not attached
9302	to the given machine at all, neither in the current state nor in one of
9303	the snapshots.
9304	</desc>
9305	<param name="machineId" type="uuid" mod="string" dir="in">
9306	<desc>
9307	UUID of the machine to query.
9308	</desc>
9309	</param>
9310	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9311	<desc>
9312	Array of snapshot UUIDs of the given machine using this medium.
9313	</desc>
9314	</param>
9315	</method>
9316
9317	<method name="lockRead">
9318	<desc>
9319	Locks this medium for reading.
9320
9321	A read lock is shared: many clients can simultaneously lock the
9322	same medium for reading unless it is already locked for writing (see
9323	<link to="#lockWrite"/>) in which case an error is returned.
9324
9325	When the medium is locked for reading, it cannot be modified
9326	from within VirtualBox. This means that any method that changes
9327	the properties of this medium or contents of the storage unit
9328	will return an error (unless explicitly stated otherwise). That
9329	includes an attempt to start a virtual machine that wants to
9330	write to the the medium.
9331
9332	When the virtual machine is started up, it locks for reading all
9333	media it uses in read-only mode. If some medium cannot be locked
9334	for reading, the startup procedure will fail.
9335	A medium is typically locked for reading while it is used by a running
9336	virtual machine but has a depending differencing image that receives
9337	the actual write operations. This way one base medium can have
9338	multiple child differencing images which can be written to
9339	simultaneously. Read-only media such as DVD and floppy images are
9340	also locked for reading only (so they can be in use by multiple
9341	machines simultaneously).
9342
9343	A medium is also locked for reading when it is the source of a
9344	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9345
9346	The medium locked for reading must be unlocked using the <link
9347	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9348	can be nested and must be followed by the same number of paired
9349	<link to="#unlockRead"/> calls.
9350
9351	This method sets the medium state (see <link to="#state"/>) to
9352	"LockedRead" on success. The medium's previous state must be
9353	one of "Created", "Inaccessible" or "LockedRead".
9354
9355	Locking an inaccessible medium is not an error; this method performs
9356	a logical lock that prevents modifications of this medium through
9357	the VirtualBox API, not a physical file-system lock of the underlying
9358	storage unit.
9359
9360	This method returns the current state of the medium
9361	<i>before</i> the operation.
9362
9363	<result name="VBOX_E_INVALID_OBJECT_STATE">
9364	Invalid medium state (e.g. not created, locked, inaccessible,
9365	creating, deleting).
9366	</result>
9367
9368	</desc>
9369	<param name="state" type="MediumState" dir="return">
9370	<desc>
9371	State of the medium after the operation.
9372	</desc>
9373	</param>
9374	</method>
9375
9376	<method name="unlockRead">
9377	<desc>
9378	Cancels the read lock previously set by <link to="#lockRead"/>.
9379
9380	For both success and failure, this method returns the current state
9381	of the medium <i>after</i> the operation.
9382
9383	See <link to="#lockRead"/> for more details.
9384
9385	<result name="VBOX_E_INVALID_OBJECT_STATE">
9386	Medium not locked for reading.
9387	</result>
9388
9389	</desc>
9390	<param name="state" type="MediumState" dir="return">
9391	<desc>
9392	State of the medium after the operation.
9393	</desc>
9394	</param>
9395	</method>
9396
9397	<method name="lockWrite">
9398	<desc>
9399	Locks this medium for writing.
9400
9401	A write lock, as opposed to <link to="#lockRead"/>, is
9402	exclusive: there may be only one client holding a write lock,
9403	and there may be no read locks while the write lock is held.
9404	As a result, read-locking fails if a write lock is held, and
9405	write-locking fails if either a read or another write lock is held.
9406
9407	When a medium is locked for writing, it cannot be modified
9408	from within VirtualBox, and it is not guaranteed that the values
9409	of its properties are up-to-date. Any method that changes the
9410	properties of this medium or contents of the storage unit will
9411	return an error (unless explicitly stated otherwise).
9412
9413	When a virtual machine is started up, it locks for writing all
9414	media it uses to write data to. If any medium could not be locked
9415	for writing, the startup procedure will fail. If a medium has
9416	differencing images, then while the machine is running, only
9417	the last ("leaf") differencing image is locked for writing,
9418	whereas its parents are locked for reading only.
9419
9420	A medium is also locked for writing when it is the target of a
9421	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9422
9423	The medium locked for writing must be unlocked using the <link
9424	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9425
9426	This method sets the medium state (see <link to="#state"/>) to
9427	"LockedWrite" on success. The medium's previous state must be
9428	either "Created" or "Inaccessible".
9429
9430	Locking an inaccessible medium is not an error; this method performs
9431	a logical lock that prevents modifications of this medium through
9432	the VirtualBox API, not a physical file-system lock of the underlying
9433	storage unit.
9434
9435	For both, success and failure, this method returns the current
9436	state of the medium <i>before</i> the operation.
9437
9438	<result name="VBOX_E_INVALID_OBJECT_STATE">
9439	Invalid medium state (e.g. not created, locked, inaccessible,
9440	creating, deleting).
9441	</result>
9442
9443	</desc>
9444	<param name="state" type="MediumState" dir="return">
9445	<desc>
9446	State of the medium after the operation.
9447	</desc>
9448	</param>
9449	</method>
9450
9451	<method name="unlockWrite">
9452	<desc>
9453	Cancels the write lock previously set by <link to="#lockWrite"/>.
9454
9455	For both success and failure, this method returns the current
9456	state of the medium <i>after</i> the operation.
9457
9458	See <link to="#lockWrite"/> for more details.
9459
9460	<result name="VBOX_E_INVALID_OBJECT_STATE">
9461	Medium not locked for writing.
9462	</result>
9463
9464	</desc>
9465	<param name="state" type="MediumState" dir="return">
9466	<desc>
9467	State of the medium after the operation.
9468	</desc>
9469	</param>
9470	</method>
9471
9472	<method name="close">
9473	<desc>
9474	Closes this medium.
9475
9476	The medium must not be attached to any known virtual machine
9477	and must not have any known child media, otherwise the
9478	operation will fail.
9479
9480	When the medium is successfully closed, it gets removed from
9481	the list of remembered media, but its storage unit is not
9482	deleted. In particular, this means that this medium can be
9483	later opened again using the <link
9484	to="IVirtualBox::openHardDisk"/> call.
9485
9486	Note that after this method successfully returns, the given medium
9487	object becomes uninitialized. This means that any attempt
9488	to call any of its methods or attributes will fail with the
9489	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9490
9491	<result name="VBOX_E_INVALID_OBJECT_STATE">
9492	Invalid medium state (other than not created, created or
9493	inaccessible).
9494	</result>
9495	<result name="VBOX_E_OBJECT_IN_USE">
9496	Medium attached to virtual machine.
9497	</result>
9498	<result name="VBOX_E_FILE_ERROR">
9499	Settings file not accessible.
9500	</result>
9501	<result name="VBOX_E_XML_ERROR">
9502	Could not parse the settings file.
9503	</result>
9504
9505	</desc>
9506	</method>
9507
9508	<!-- storage methods -->
9509
9510	<method name="getProperty">
9511	<desc>
9512	Returns the value of the custom medium property with the given name.
9513
9514	The list of all properties supported by the given medium format can
9515	be obtained with <link to="IMediumFormat::describeProperties"/>.
9516
9517	Note that if this method returns an empty string in @a value, the
9518	requested property is supported but currently not assigned any value.
9519
9520	<result name="VBOX_E_OBJECT_NOT_FOUND">
9521	Requested property does not exist (not supported by the format).
9522	</result>
9523	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9524	</desc>
9525	<param name="name" type="wstring" dir="in">
9526	<desc>Name of the property to get.</desc>
9527	</param>
9528	<param name="value" type="wstring" dir="return">
9529	<desc>Current property value.</desc>
9530	</param>
9531	</method>
9532
9533	<method name="setProperty">
9534	<desc>
9535	Sets the value of the custom medium property with the given name.
9536
9537	The list of all properties supported by the given medium format can
9538	be obtained with <link to="IMediumFormat::describeProperties"/>.
9539
9540	Note that setting the property value to @c null or an empty string is
9541	equivalent to deleting the existing value. A default value (if it is
9542	defined for this property) will be used by the format backend in this
9543	case.
9544
9545	<result name="VBOX_E_OBJECT_NOT_FOUND">
9546	Requested property does not exist (not supported by the format).
9547	</result>
9548	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9549	</desc>
9550	<param name="name" type="wstring" dir="in">
9551	<desc>Name of the property to set.</desc>
9552	</param>
9553	<param name="value" type="wstring" dir="in">
9554	<desc>Property value to set.</desc>
9555	</param>
9556	</method>
9557
9558	<method name="getProperties">
9559	<desc>
9560	Returns values for a group of properties in one call.
9561
9562	The names of the properties to get are specified using the @a names
9563	argument which is a list of comma-separated property names or
9564	an empty string if all properties are to be returned. Note that currently
9565	the value of this argument is ignored and the method always returns all
9566	existing properties.
9567
9568	The list of all properties supported by the given medium format can
9569	be obtained with <link to="IMediumFormat::describeProperties"/>.
9570
9571	The method returns two arrays, the array of property names corresponding
9572	to the @a names argument and the current values of these properties.
9573	Both arrays have the same number of elements with each elemend at the
9574	given index in the first array corresponds to an element at the same
9575	index in the second array.
9576
9577	Note that for properties that do not have assigned values,
9578	an empty string is returned at the appropriate index in the
9579	@a returnValues array.
9580
9581	</desc>
9582	<param name="names" type="wstring" dir="in">
9583	<desc>
9584	Names of properties to get.
9585	</desc>
9586	</param>
9587	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9588	<desc>Names of returned properties.</desc>
9589	</param>
9590	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9591	<desc>Values of returned properties.</desc>
9592	</param>
9593	</method>
9594
9595	<method name="setProperties">
9596	<desc>
9597	Sets values for a group of properties in one call.
9598
9599	The names of the properties to set are passed in the @a names
9600	array along with the new values for them in the @a values array. Both
9601	arrays have the same number of elements with each elemend at the given
9602	index in the first array corresponding to an element at the same index
9603	in the second array.
9604
9605	If there is at least one property name in @a names that is not valid,
9606	the method will fail before changing the values of any other properties
9607	from the @a names array.
9608
9609	Using this method over <link to="#setProperty"/> is preferred if you
9610	need to set several properties at once since it will result into less
9611	IPC calls.
9612
9613	The list of all properties supported by the given medium format can
9614	be obtained with <link to="IMediumFormat::describeProperties"/>.
9615
9616	Note that setting the property value to @c null or an empty string is
9617	equivalent to deleting the existing value. A default value (if it is
9618	defined for this property) will be used by the format backend in this
9619	case.
9620	</desc>
9621	<param name="names" type="wstring" safearray="yes" dir="in">
9622	<desc>Names of properties to set.</desc>
9623	</param>
9624	<param name="values" type="wstring" safearray="yes" dir="in">
9625	<desc>Values of properties to set.</desc>
9626	</param>
9627	</method>
9628
9629	<!-- storage methods -->
9630
9631	<method name="createBaseStorage">
9632	<desc>
9633	Starts creating a hard disk storage unit (fixed/dynamic, according
9634	to the variant flags) in in the background. The previous storage unit
9635	created for this object, if any, must first be deleted using
9636	<link to="#deleteStorage"/>, otherwise the operation will fail.
9637
9638	Before the operation starts, the medium is placed in
9639	<link to="MediumState_Creating"/> state. If the create operation
9640	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9641	state.
9642
9643	After the returned progress object reports that the operation has
9644	successfully completed, the medium state will be set to <link
9645	to="MediumState_Created"/>, the medium will be remembered by this
9646	VirtualBox installation and may be attached to virtual machines.
9647
9648	<result name="VBOX_E_NOT_SUPPORTED">
9649	The variant of storage creation operation is not supported. See <link
9650	to="IMediumFormat::capabilities"/>.
9651	</result>
9652	</desc>
9653	<param name="logicalSize" type="unsigned long long" dir="in">
9654	<desc>Maximum logical size of the medium in megabytes.</desc>
9655	</param>
9656	<param name="variant" type="MediumVariant" dir="in">
9657	<desc>Exact image variant which should be created.</desc>
9658	</param>
9659	<param name="progress" type="IProgress" dir="return">
9660	<desc>Progress object to track the operation completion.</desc>
9661	</param>
9662	</method>
9663
9664	<method name="deleteStorage">
9665	<desc>
9666	Starts deleting the storage unit of this medium.
9667
9668	The medium must not be attached to any known virtual machine and must
9669	not have any known child media, otherwise the operation will fail.
9670	It will also fail if there is no storage unit to delete or if deletion
9671	is already in progress, or if the medium is being in use (locked for
9672	read or for write) or inaccessible. Therefore, the only valid state for
9673	this operation to succeed is <link to="MediumState_Created"/>.
9674
9675	Before the operation starts, the medium is placed in
9676	<link to="MediumState_Deleting"/> state and gets removed from the list
9677	of remembered hard disks (media registry). If the delete operation
9678	fails, the medium will be remembered again and placed back to
9679	<link to="MediumState_Created"/> state.
9680
9681	After the returned progress object reports that the operation is
9682	complete, the medium state will be set to
9683	<link to="MediumState_NotCreated"/> and you will be able to use one of
9684	the storage creation methods to create it again.
9685
9686	<see>#close()</see>
9687
9688	<result name="VBOX_E_OBJECT_IN_USE">
9689	Medium is attached to a virtual machine.
9690	</result>
9691	<result name="VBOX_E_NOT_SUPPORTED">
9692	Storage deletion is not allowed because neither of storage creation
9693	operations are supported. See
9694	<link to="IMediumFormat::capabilities"/>.
9695	</result>
9696
9697	<note>
9698	If the deletion operation fails, it is not guaranteed that the storage
9699	unit still exists. You may check the <link to="IMedium::state"/> value
9700	to answer this question.
9701	</note>
9702	</desc>
9703	<param name="progress" type="IProgress" dir="return">
9704	<desc>Progress object to track the operation completion.</desc>
9705	</param>
9706	</method>
9707
9708	<!-- diff methods -->
9709
9710	<method name="createDiffStorage">
9711	<desc>
9712	Starts creating an empty differencing storage unit based on this
9713	medium in the format and at the location defined by the @a target
9714	argument.
9715
9716	The target medium must be in <link to="MediumState_NotCreated"/>
9717	state (i.e. must not have an existing storage unit). Upon successful
9718	completion, this operation will set the type of the target medium to
9719	<link to="MediumType_Normal"/> and create a storage unit necessary to
9720	represent the differencing medium data in the given format (according
9721	to the storage format of the target object).
9722
9723	After the returned progress object reports that the operation is
9724	successfully complete, the target medium gets remembered by this
9725	VirtualBox installation and may be attached to virtual machines.
9726
9727	<note>
9728	The medium will be set to <link to="MediumState_LockedRead"/>
9729	state for the duration of this operation.
9730	</note>
9731	<result name="VBOX_E_OBJECT_IN_USE">
9732	Medium not in @c NotCreated state.
9733	</result>
9734	</desc>
9735	<param name="target" type="IMedium" dir="in">
9736	<desc>Target medium.</desc>
9737	</param>
9738	<param name="variant" type="MediumVariant" dir="in">
9739	<desc>Exact image variant which should be created.</desc>
9740	</param>
9741	<param name="progress" type="IProgress" dir="return">
9742	<desc>Progress object to track the operation completion.</desc>
9743	</param>
9744	</method>
9745
9746	<method name="mergeTo">
9747	<desc>
9748	Starts merging the contents of this medium and all intermediate
9749	differencing media in the chain to the given target medium.
9750
9751	The target medium must be either a descendant of this medium or
9752	its ancestor (otherwise this method will immediately return a failure).
9753	It follows that there are two logical directions of the merge operation:
9754	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9755	ancestor (<i>backward merge</i>). Let us consider the following medium
9756	chain:
9757
9758	<pre>Base <- Diff_1 <- Diff_2</pre>
9759
9760	Here, calling this method on the <tt>Base</tt> medium object with
9761	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9762	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9763	merge. Note that in both cases the contents of the resulting medium
9764	will be the same, the only difference is the medium object that takes
9765	the result of the merge operation. In case of the forward merge in the
9766	above example, the result will be written to <tt>Diff_2</tt>; in case of
9767	the backward merge, the result will be written to <tt>Base</tt>. In
9768	other words, the result of the operation is always stored in the target
9769	medium.
9770
9771	Upon successful operation completion, the storage units of all media in
9772	the chain between this (source) medium and the target medium, including
9773	the source medium itself, will be automatically deleted and the
9774	relevant medium objects (including this medium) will become
9775	uninitialized. This means that any attempt to call any of
9776	their methods or attributes will fail with the
9777	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9778	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9779	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9780	Note that <tt>Diff_2</tt> in this case will become a base medium
9781	itself since it will no longer be based on any other medium.
9782
9783	Considering the above, all of the following conditions must be met in
9784	order for the merge operation to succeed:
9785	<ul>
9786	<li>
9787	Neither this (source) medium nor any intermediate
9788	differencing medium in the chain between it and the target
9789	medium is attached to any virtual machine.
9790	</li>
9791	<li>
9792	Neither the source medium nor the target medium is an
9793	<link to="MediumType_Immutable"/> medium.
9794	</li>
9795	<li>
9796	The part of the medium tree from the source medium to the
9797	target medium is a linear chain, i.e. all medium in this
9798	chain have exactly one child which is the next medium in this
9799	chain. The only exception from this rule is the target medium in
9800	the forward merge operation; it is allowed to have any number of
9801	child media because the merge operation will not change its
9802	logical contents (as it is seen by the guest OS or by children).
9803	</li>
9804	<li>
9805	None of the involved media are in
9806	<link to="MediumState_LockedRead"/> or
9807	<link to="MediumState_LockedWrite"/> state.
9808	</li>
9809	</ul>
9810
9811	<note>
9812	This (source) medium and all intermediates will be placed to <link
9813	to="MediumState_Deleting"/> state and the target medium will be
9814	placed to <link to="MediumState_LockedWrite"/> state and for the
9815	duration of this operation.
9816	</note>
9817	</desc>
9818	<param name="target" type="IMedium" dir="in">
9819	<desc>Target medium.</desc>
9820	</param>
9821	<param name="progress" type="IProgress" dir="return">
9822	<desc>Progress object to track the operation completion.</desc>
9823	</param>
9824	</method>
9825
9826	<!-- clone method -->
9827
9828	<method name="cloneTo">
9829	<desc>
9830	Starts creating a clone of this medium in the format and at the
9831	location defined by the @a target argument.
9832
9833	The target medium must be either in <link to="MediumState_NotCreated"/>
9834	state (i.e. must not have an existing storage unit) or in
9835	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9836	big enough to hold the data or else the copy will be partial). Upon
9837	successful completion, the cloned medium will contain exactly the
9838	same sector data as the medium being cloned, except that in the
9839	first case a new UUID for the clone will be randomly generated, and in
9840	the second case the UUID will remain unchanged.
9841
9842	The @a parent argument defines which medium will be the parent
9843	of the clone. Passing a @c null reference indicates that the clone will
9844	be a base image, i.e. completely independent. It is possible to specify
9845	an arbitrary medium for this parameter, including the parent of the
9846	medium which is being cloned. Even cloning to a child of the source
9847	medium is possible. Note that when cloning to an existing image, the
9848	@a parent irgument is ignored.
9849
9850	After the returned progress object reports that the operation is
9851	successfully complete, the target medium gets remembered by this
9852	VirtualBox installation and may be attached to virtual machines.
9853
9854	<note>
9855	This medium will be placed to <link to="MediumState_LockedRead"/>
9856	state for the duration of this operation.
9857	</note>
9858	<result name="E_NOTIMPL">
9859	The specified cloning variant is not supported at the moment.
9860	</result>
9861	</desc>
9862	<param name="target" type="IMedium" dir="in">
9863	<desc>Target medium.</desc>
9864	</param>
9865	<param name="variant" type="MediumVariant" dir="in">
9866	<desc>Exact image variant which should be created.</desc>
9867	</param>
9868	<param name="parent" type="IMedium" dir="in">
9869	<desc>Parent of the cloned medium.</desc>
9870	</param>
9871	<param name="progress" type="IProgress" dir="return">
9872	<desc>Progress object to track the operation completion.</desc>
9873	</param>
9874	</method>
9875
9876	<!-- other methods -->
9877
9878	<method name="compact">
9879	<desc>
9880	Starts compacting of this medium. This means that the medium is
9881	transformed into a possibly more compact storage representation.
9882	This potentially creates temporary images, which can require a
9883	substantial amount of additional disk space.
9884
9885	This medium will be placed to <link to="MediumState_LockedWrite"/>
9886	state and all its parent media (if any) will be placed to
9887	<link to="MediumState_LockedRead"/> state for the duration of this
9888	operation.
9889
9890	Please note that the results can be either returned straight away,
9891	or later as the result of the background operation via the object
9892	returned via the @a progress parameter.
9893
9894	<result name="VBOX_E_NOT_SUPPORTED">
9895	Medium format does not support compacting (but potentially
9896	needs it).
9897	</result>
9898	</desc>
9899	<param name="progress" type="IProgress" dir="return">
9900	<desc>Progress object to track the operation completion.</desc>
9901	</param>
9902	</method>
9903
9904	<method name="resize">
9905	<desc>
9906	Starts resizing this medium. This means that the nominal size of the
9907	medium is set to the new value. Both increasing and decreasing the
9908	size is possible, and there are no safety checks, since VirtualBox
9909	does not make any assumptions about the medium contents.
9910
9911	Resizing usually needs additional disk space, and possibly also
9912	some temporary disk space. Note that resize does not create a full
9913	temporary copy of the medium, so the additional disk space requirement
9914	is usually much lower than using the clone operation.
9915
9916	This medium will be placed to <link to="MediumState_LockedWrite"/>
9917	state for the duration of this operation.
9918
9919	Please note that the results can be either returned straight away,
9920	or later as the result of the background operation via the object
9921	returned via the @a progress parameter.
9922
9923	<result name="VBOX_E_NOT_SUPPORTED">
9924	Medium format does not support resizing.
9925	</result>
9926	</desc>
9927	<param name="logicalSize" type="unsigned long long" dir="in">
9928	<desc>New nominal capacity of the medium in megabytes.</desc>
9929	</param>
9930	<param name="progress" type="IProgress" dir="return">
9931	<desc>Progress object to track the operation completion.</desc>
9932	</param>
9933	</method>
9934
9935	<method name="reset">
9936	<desc>
9937	Starts erasing the contents of this differencing medium.
9938
9939	This operation will reset the differencing medium to its initial
9940	state when it does not contain any sector data and any read operation is
9941	redirected to its parent medium. This automatically gets called
9942	during VM power-up for every medium whose <link to="#autoReset" />
9943	attribute is @c true.
9944
9945	The medium will be write-locked for the duration of this operation (see
9946	<link to="#lockWrite" />).
9947
9948	<result name="VBOX_E_NOT_SUPPORTED">
9949	This is not a differencing medium.
9950	</result>
9951	<result name="VBOX_E_INVALID_OBJECT_STATE">
9952	Medium is not in <link to="MediumState_Created"/> or
9953	<link to="MediumState_Inaccessible"/> state.
9954	</result>
9955	</desc>
9956	<param name="progress" type="IProgress" dir="return">
9957	<desc>Progress object to track the operation completion.</desc>
9958	</param>
9959	</method>
9960
9961	</interface>
9962
9963
9964	<!--
9965	// IMediumFormat
9966	/////////////////////////////////////////////////////////////////////////
9967	-->
9968
9969	<enum
9970	name="DataType"
9971	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
9972	>
9973	<const name="Int32" value="0"/>
9974	<const name="Int8" value="1"/>
9975	<const name="String" value="2"/>
9976	</enum>
9977
9978	<enum
9979	name="DataFlags"
9980	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
9981	>
9982	<const name="None" value="0x00"/>
9983	<const name="Mandatory" value="0x01"/>
9984	<const name="Expert" value="0x02"/>
9985	<const name="Array" value="0x04"/>
9986	<const name="FlagMask" value="0x07"/>
9987	</enum>
9988
9989	<enum
9990	name="MediumFormatCapabilities"
9991	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
9992	>
9993	<desc>
9994	Medium format capability flags.
9995	</desc>
9996
9997	<const name="Uuid" value="0x01">
9998	<desc>
9999	Supports UUIDs as expected by VirtualBox code.
10000	</desc>
10001	</const>
10002
10003	<const name="CreateFixed" value="0x02">
10004	<desc>
10005	Supports creating fixed size images, allocating all space instantly.
10006	</desc>
10007	</const>
10008
10009	<const name="CreateDynamic" value="0x04">
10010	<desc>
10011	Supports creating dynamically growing images, allocating space on
10012	demand.
10013	</desc>
10014	</const>
10015
10016	<const name="CreateSplit2G" value="0x08">
10017	<desc>
10018	Supports creating images split in chunks of a bit less than 2 GBytes.
10019	</desc>
10020	</const>
10021
10022	<const name="Differencing" value="0x10">
10023	<desc>
10024	Supports being used as a format for differencing media (see <link
10025	to="IMedium::createDiffStorage"/>).
10026	</desc>
10027	</const>
10028
10029	<const name="Asynchronous" value="0x20">
10030	<desc>
10031	Supports asynchronous I/O operations for at least some configurations.
10032	</desc>
10033	</const>
10034
10035	<const name="File" value="0x40">
10036	<desc>
10037	The format backend operates on files (the <link to="IMedium::location"/>
10038	attribute of the medium specifies a file used to store medium
10039	data; for a list of supported file extensions see
10040	<link to="IMediumFormat::fileExtensions"/>).
10041	</desc>
10042	</const>
10043
10044	<const name="Properties" value="0x80">
10045	<desc>
10046	The format backend uses the property interface to configure the storage
10047	location and properties (the <link to="IMediumFormat::describeProperties"/>
10048	method is used to get access to properties supported by the given medium format).
10049	</desc>
10050	</const>
10051
10052	<const name="CapabilityMask" value="0xFF"/>
10053	</enum>
10054
10055	<interface
10056	name="IMediumFormat" extends="$unknown"
10057	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
10058	wsmap="managed"
10059	>
10060	<desc>
10061	The IMediumFormat interface represents a medium format.
10062
10063	Each medium format has an associated backend which is used to handle
10064	media stored in this format. This interface provides information
10065	about the properties of the associated backend.
10066
10067	Each medium format is identified by a string represented by the
10068	<link to="#id"/> attribute. This string is used in calls like
10069	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10070	format.
10071
10072	The list of all supported medium formats can be obtained using
10073	<link to="ISystemProperties::mediumFormats"/>.
10074
10075	<see>IMedium</see>
10076	</desc>
10077
10078	<attribute name="id" type="wstring" readonly="yes">
10079	<desc>
10080	Identifier of this format.
10081
10082	The format identifier is a non-@c null non-empty ASCII string. Note that
10083	this string is case-insensitive. This means that, for example, all of
10084	the following strings:
10085	<pre>
10086	"VDI"
10087	"vdi"
10088	"VdI"</pre>
10089	refer to the same medium format.
10090
10091	This string is used in methods of other interfaces where it is necessary
10092	to specify a medium format, such as
10093	<link to="IVirtualBox::createHardDisk"/>.
10094	</desc>
10095	</attribute>
10096
10097	<attribute name="name" type="wstring" readonly="yes">
10098	<desc>
10099	Human readable description of this format.
10100
10101	Mainly for use in file open dialogs.
10102	</desc>
10103	</attribute>
10104
10105	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10106	<desc>
10107	Array of strings containing the supported file extensions.
10108
10109	The first extension in the array is the extension preferred by the
10110	backend. It is recommended to use this extension when specifying a
10111	location of the storage unit for a new medium.
10112
10113	Note that some backends do not work on files, so this array may be
10114	empty.
10115
10116	<see>IMediumFormat::capabilities</see>
10117	</desc>
10118	</attribute>
10119
10120	<attribute name="capabilities" type="unsigned long" readonly="yes">
10121	<desc>
10122	Capabilities of the format as a set of bit flags.
10123
10124	For the meaning of individual capability flags see
10125	<link to="MediumFormatCapabilities"/>.
10126	</desc>
10127	</attribute>
10128
10129	<method name="describeProperties">
10130	<desc>
10131	Returns several arrays describing the properties supported by this
10132	format.
10133
10134	An element with the given index in each array describes one
10135	property. Thus, the number of elements in each returned array is the
10136	same and corresponds to the number of supported properties.
10137
10138	The returned arrays are filled in only if the
10139	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10140	All arguments must be non-@c null.
10141
10142	<see>DataType</see>
10143	<see>DataFlags</see>
10144	</desc>
10145
10146	<param name="names" type="wstring" safearray="yes" dir="out">
10147	<desc>Array of property names.</desc>
10148	</param>
10149	<param name="description" type="wstring" safearray="yes" dir="out">
10150	<desc>Array of property descriptions.</desc>
10151	</param>
10152	<param name="types" type="DataType" safearray="yes" dir="out">
10153	<desc>Array of property types.</desc>
10154	</param>
10155	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10156	<desc>Array of property flags.</desc>
10157	</param>
10158	<param name="defaults" type="wstring" safearray="yes" dir="out">
10159	<desc>Array of default property values.</desc>
10160	</param>
10161	</method>
10162
10163	</interface>
10164
10165
10166	<!--
10167	// IKeyboard
10168	/////////////////////////////////////////////////////////////////////////
10169	-->
10170
10171	<interface
10172	name="IKeyboard" extends="$unknown"
10173	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10174	wsmap="managed"
10175	>
10176	<desc>
10177	The IKeyboard interface represents the virtual machine's keyboard. Used
10178	in <link to="IConsole::keyboard"/>.
10179
10180	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10181	to the virtual machine.
10182
10183	</desc>
10184	<method name="putScancode">
10185	<desc>Sends a scancode to the keyboard.
10186
10187	<result name="VBOX_E_IPRT_ERROR">
10188	Could not send scan code to virtual keyboard.
10189	</result>
10190
10191	</desc>
10192	<param name="scancode" type="long" dir="in"/>
10193	</method>
10194
10195	<method name="putScancodes">
10196	<desc>Sends an array of scancodes to the keyboard.
10197
10198	<result name="VBOX_E_IPRT_ERROR">
10199	Could not send all scan codes to virtual keyboard.
10200	</result>
10201
10202	</desc>
10203	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10204	<param name="codesStored" type="unsigned long" dir="return"/>
10205	</method>
10206
10207	<method name="putCAD">
10208	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10209	function is nothing special, it is just a convenience function
10210	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10211
10212	<result name="VBOX_E_IPRT_ERROR">
10213	Could not send all scan codes to virtual keyboard.
10214	</result>
10215
10216	</desc>
10217	</method>
10218
10219	</interface>
10220
10221
10222	<!--
10223	// IMouse
10224	/////////////////////////////////////////////////////////////////////////
10225	-->
10226
10227	<enum
10228	name="MouseButtonState"
10229	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10230	>
10231	<desc>
10232	Mouse button state.
10233	</desc>
10234
10235	<const name="LeftButton" value="0x01"/>
10236	<const name="RightButton" value="0x02"/>
10237	<const name="MiddleButton" value="0x04"/>
10238	<const name="WheelUp" value="0x08"/>
10239	<const name="WheelDown" value="0x10"/>
10240	<const name="XButton1" value="0x20"/>
10241	<const name="XButton2" value="0x40"/>
10242	<const name="MouseStateMask" value="0x7F"/>
10243	</enum>
10244
10245	<interface
10246	name="IMouse" extends="$unknown"
10247	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10248	wsmap="managed"
10249	>
10250	<desc>
10251	The IMouse interface represents the virtual machine's mouse. Used in
10252	<link to="IConsole::mouse"/>.
10253
10254	Through this interface, the virtual machine's virtual mouse can be
10255	controlled.
10256	</desc>
10257
10258	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10259	<desc>
10260	Whether the guest OS supports absolute mouse pointer positioning
10261	or not.
10262	<note>
10263	You can use the <link to="IMouseCapabilityChangedEvent"/>
10264	event to be instantly informed about changes of this attribute
10265	during virtual machine execution.
10266	</note>
10267	<see><link to="#putMouseEventAbsolute"/></see>
10268	</desc>
10269	</attribute>
10270
10271	<attribute name="relativeSupported" type="boolean" readonly="yes">
10272	<desc>
10273	Whether the guest OS supports relative mouse pointer positioning
10274	or not.
10275	<note>
10276	You can use the <link to="IMouseCapabilityChangedEvent"/>
10277	event to be instantly informed about changes of this attribute
10278	during virtual machine execution.
10279	</note>
10280	<see><link to="#putMouseEvent"/></see>
10281	</desc>
10282	</attribute>
10283
10284	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10285	<desc>
10286	Whether the guest OS can currently switch to drawing it's own mouse
10287	cursor on demand.
10288	<note>
10289	You can use the <link to="IMouseCapabilityChangedEvent"/>
10290	event to be instantly informed about changes of this attribute
10291	during virtual machine execution.
10292	</note>
10293	<see><link to="#putMouseEvent"/></see>
10294	</desc>
10295	</attribute>
10296
10297	<method name="putMouseEvent">
10298	<desc>
10299	Initiates a mouse event using relative pointer movements
10300	along x and y axis.
10301
10302	<result name="E_ACCESSDENIED">
10303	Console not powered up.
10304	</result>
10305	<result name="VBOX_E_IPRT_ERROR">
10306	Could not send mouse event to virtual mouse.
10307	</result>
10308
10309	</desc>
10310
10311	<param name="dx" type="long" dir="in">
10312	<desc>
10313	Amount of pixels the mouse should move to the right.
10314	Negative values move the mouse to the left.
10315	</desc>
10316	</param>
10317	<param name="dy" type="long" dir="in">
10318	<desc>
10319	Amount of pixels the mouse should move downwards.
10320	Negative values move the mouse upwards.
10321	</desc>
10322	</param>
10323	<param name="dz" type="long" dir="in">
10324	<desc>
10325	Amount of mouse wheel moves.
10326	Positive values describe clockwise wheel rotations,
10327	negative values describe counterclockwise rotations.
10328	</desc>
10329	</param>
10330	<param name="dw" type="long" dir="in">
10331	<desc>
10332	Amount of horizontal mouse wheel moves.
10333	Positive values describe a movement to the left,
10334	negative values describe a movement to the right.
10335	</desc>
10336	</param>
10337	<param name="buttonState" type="long" dir="in">
10338	<desc>
10339	The current state of mouse buttons. Every bit represents
10340	a mouse button as follows:
10341	<table>
10342	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10343	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10344	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10345	</table>
10346	A value of <tt>1</tt> means the corresponding button is pressed.
10347	otherwise it is released.
10348	</desc>
10349	</param>
10350	</method>
10351
10352	<method name="putMouseEventAbsolute">
10353	<desc>
10354	Positions the mouse pointer using absolute x and y coordinates.
10355	These coordinates are expressed in pixels and
10356	start from <tt>[1,1]</tt> which corresponds to the top left
10357	corner of the virtual display.
10358
10359	<result name="E_ACCESSDENIED">
10360	Console not powered up.
10361	</result>
10362	<result name="VBOX_E_IPRT_ERROR">
10363	Could not send mouse event to virtual mouse.
10364	</result>
10365
10366	<note>
10367	This method will have effect only if absolute mouse
10368	positioning is supported by the guest OS.
10369	</note>
10370
10371	<see><link to="#absoluteSupported"/></see>
10372	</desc>
10373
10374	<param name="x" type="long" dir="in">
10375	<desc>
10376	X coordinate of the pointer in pixels, starting from @c 1.
10377	</desc>
10378	</param>
10379	<param name="y" type="long" dir="in">
10380	<desc>
10381	Y coordinate of the pointer in pixels, starting from @c 1.
10382	</desc>
10383	</param>
10384	<param name="dz" type="long" dir="in">
10385	<desc>
10386	Amount of mouse wheel moves.
10387	Positive values describe clockwise wheel rotations,
10388	negative values describe counterclockwise rotations.
10389	</desc>
10390	</param>
10391	<param name="dw" type="long" dir="in">
10392	<desc>
10393	Amount of horizontal mouse wheel moves.
10394	Positive values describe a movement to the left,
10395	negative values describe a movement to the right.
10396	</desc>
10397	</param>
10398	<param name="buttonState" type="long" dir="in">
10399	<desc>
10400	The current state of mouse buttons. Every bit represents
10401	a mouse button as follows:
10402	<table>
10403	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10404	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10405	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10406	</table>
10407	A value of @c 1 means the corresponding button is pressed.
10408	otherwise it is released.
10409	</desc>
10410	</param>
10411	</method>
10412
10413	</interface>
10414
10415	<!--
10416	// IDisplay
10417	/////////////////////////////////////////////////////////////////////////
10418	-->
10419
10420	<enum
10421	name="FramebufferPixelFormat"
10422	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10423	>
10424	<desc>
10425	Format of the video memory buffer. Constants represented by this enum can
10426	be used to test for particular values of <link
10427	to="IFramebuffer::pixelFormat"/>. See also <link
10428	to="IFramebuffer::requestResize"/>.
10429
10430	See also www.fourcc.org for more information about FOURCC pixel formats.
10431	</desc>
10432
10433	<const name="Opaque" value="0">
10434	<desc>
10435	Unknown buffer format (the user may not assume any particular format of
10436	the buffer).
10437	</desc>
10438	</const>
10439	<const name="FOURCC_RGB" value="0x32424752">
10440	<desc>
10441	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10442	bit layout).
10443	</desc>
10444	</const>
10445	</enum>
10446
10447	<interface
10448	name="IFramebuffer" extends="$unknown"
10449	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10450	wsmap="suppress"
10451	>
10452	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10453	<desc>Address of the start byte of the frame buffer.</desc>
10454	</attribute>
10455
10456	<attribute name="width" type="unsigned long" readonly="yes">
10457	<desc>Frame buffer width, in pixels.</desc>
10458	</attribute>
10459
10460	<attribute name="height" type="unsigned long" readonly="yes">
10461	<desc>Frame buffer height, in pixels.</desc>
10462	</attribute>
10463
10464	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10465	<desc>
10466	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10467	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10468	are: 8, 15, 16, 24 and 32.
10469	</desc>
10470	</attribute>
10471
10472	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10473	<desc>
10474	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10475	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10476	size of the scan line must be aligned to 32 bits.
10477	</desc>
10478	</attribute>
10479
10480	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10481	<desc>
10482	Frame buffer pixel format. It's either one of the values defined by <link
10483	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10484	<note>
10485	This attribute must never return <link
10486	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10487	<link to="#address"/> points to must be always known.
10488	</note>
10489	</desc>
10490	</attribute>
10491
10492	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10493	<desc>
10494	Defines whether this frame buffer uses the virtual video card's memory
10495	buffer (guest VRAM) directly or not. See <link
10496	to="IFramebuffer::requestResize"/> for more information.
10497	</desc>
10498	</attribute>
10499
10500	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10501	<desc>
10502	Hint from the frame buffer about how much of the standard
10503	screen height it wants to use for itself. This information is
10504	exposed to the guest through the VESA BIOS and VMMDev interface
10505	so that it can use it for determining its video mode table. It
10506	is not guaranteed that the guest respects the value.
10507	</desc>
10508	</attribute>
10509
10510	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10511	<desc>
10512	An alpha-blended overlay which is superposed over the frame buffer.
10513	The initial purpose is to allow the display of icons providing
10514	information about the VM state, including disk activity, in front
10515	ends which do not have other means of doing that. The overlay is
10516	designed to controlled exclusively by IDisplay. It has no locking
10517	of its own, and any changes made to it are not guaranteed to be
10518	visible until the affected portion of IFramebuffer is updated. The
10519	overlay can be created lazily the first time it is requested. This
10520	attribute can also return @c null to signal that the overlay is not
10521	implemented.
10522	</desc>
10523	</attribute>
10524
10525	<attribute name="winId" type="unsigned long long" readonly="yes">
10526	<desc>
10527	Platform-dependent identifier of the window where context of this
10528	frame buffer is drawn, or zero if there's no such window.
10529	</desc>
10530	</attribute>
10531
10532	<method name="lock">
10533	<desc>
10534	Locks the frame buffer.
10535	Gets called by the IDisplay object where this frame buffer is
10536	bound to.
10537	</desc>
10538	</method>
10539
10540	<method name="unlock">
10541	<desc>
10542	Unlocks the frame buffer.
10543	Gets called by the IDisplay object where this frame buffer is
10544	bound to.
10545	</desc>
10546	</method>
10547
10548	<method name="notifyUpdate">
10549	<desc>
10550	Informs about an update.
10551	Gets called by the display object where this buffer is
10552	registered.
10553	</desc>
10554	<param name="x" type="unsigned long" dir="in"/>
10555	<param name="y" type="unsigned long" dir="in"/>
10556	<param name="width" type="unsigned long" dir="in"/>
10557	<param name="height" type="unsigned long" dir="in"/>
10558	</method>
10559
10560	<method name="requestResize">
10561	<desc>
10562	Requests a size and pixel format change.
10563
10564	There are two modes of working with the video buffer of the virtual
10565	machine. The <i>indirect</i> mode implies that the IFramebuffer
10566	implementation allocates a memory buffer for the requested display mode
10567	and provides it to the virtual machine. In <i>direct</i> mode, the
10568	IFramebuffer implementation uses the memory buffer allocated and owned
10569	by the virtual machine. This buffer represents the video memory of the
10570	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10571	usually faster because the implementation gets a raw pointer to the
10572	guest VRAM buffer which it can directly use for visualizing the contents
10573	of the virtual display, as opposed to the indirect mode where the
10574	contents of guest VRAM are copied to the memory buffer provided by
10575	the implementation every time a display update occurs.
10576
10577	It is important to note that the direct mode is really fast only when
10578	the implementation uses the given guest VRAM buffer directly, for
10579	example, by blitting it to the window representing the virtual machine's
10580	display, which saves at least one copy operation comparing to the
10581	indirect mode. However, using the guest VRAM buffer directly is not
10582	always possible: the format and the color depth of this buffer may be
10583	not supported by the target window, or it may be unknown (opaque) as in
10584	case of text or non-linear multi-plane VGA video modes. In this case,
10585	the indirect mode (that is always available) should be used as a
10586	fallback: when the guest VRAM contents are copied to the
10587	implementation-provided memory buffer, color and format conversion is
10588	done automatically by the underlying code.
10589
10590	The @a pixelFormat parameter defines whether the direct mode is
10591	available or not. If @a pixelFormat is <link
10592	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10593	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10594	@a bytesPerLine parameters must be ignored and the implementation must use
10595	the indirect mode (where it provides its own buffer in one of the
10596	supported formats). In all other cases, @a pixelFormat together with
10597	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10598	buffer pointed to by the @a VRAM parameter and the implementation is
10599	free to choose which mode to use. To indicate that this frame buffer uses
10600	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10601	attribute must return @c true and <link to="#address"/> must
10602	return exactly the same address that is passed in the @a VRAM parameter
10603	of this method; otherwise it is assumed that the indirect strategy is
10604	chosen.
10605
10606	The @a width and @a height parameters represent the size of the
10607	requested display mode in both modes. In case of indirect mode, the
10608	provided memory buffer should be big enough to store data of the given
10609	display mode. In case of direct mode, it is guaranteed that the given
10610	@a VRAM buffer contains enough space to represent the display mode of the
10611	given size. Note that this frame buffer's <link to="#width"/> and <link
10612	to="#height"/> attributes must return exactly the same values as
10613	passed to this method after the resize is completed (see below).
10614
10615	The @a finished output parameter determines if the implementation has
10616	finished resizing the frame buffer or not. If, for some reason, the
10617	resize cannot be finished immediately during this call, @a finished
10618	must be set to @c false, and the implementation must call
10619	<link to="IDisplay::resizeCompleted"/> after it has returned from
10620	this method as soon as possible. If @a finished is @c false, the
10621	machine will not call any frame buffer methods until
10622	<link to="IDisplay::resizeCompleted"/> is called.
10623
10624	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10625	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10626	this frame buffer must return exactly the same values as specified in the
10627	parameters of this method, after the resize is completed. If the
10628	indirect mode is chosen, these attributes must return values describing
10629	the format of the implementation's own memory buffer <link
10630	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10631	value must always correlate with <link to="#pixelFormat"/>. Note that
10632	the <link to="#pixelFormat"/> attribute must never return <link
10633	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10634
10635	<note>
10636	This method is called by the IDisplay object under the
10637	<link to="#lock"/> provided by this IFramebuffer
10638	implementation. If this method returns @c false in @a finished, then
10639	this lock is not released until
10640	<link to="IDisplay::resizeCompleted"/> is called.
10641	</note>
10642	</desc>
10643	<param name="screenId" type="unsigned long" dir="in">
10644	<desc>
10645	Logical screen number. Must be used in the corresponding call to
10646	<link to="IDisplay::resizeCompleted"/> if this call is made.
10647	</desc>
10648	</param>
10649	<param name="pixelFormat" type="unsigned long" dir="in">
10650	<desc>
10651	Pixel format of the memory buffer pointed to by @a VRAM.
10652	See also <link to="FramebufferPixelFormat"/>.
10653	</desc>
10654	</param>
10655	<param name="VRAM" type="octet" mod="ptr" dir="in">
10656	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10657	</param>
10658	<param name="bitsPerPixel" type="unsigned long" dir="in">
10659	<desc>Color depth, bits per pixel.</desc>
10660	</param>
10661	<param name="bytesPerLine" type="unsigned long" dir="in">
10662	<desc>Size of one scan line, in bytes.</desc>
10663	</param>
10664	<param name="width" type="unsigned long" dir="in">
10665	<desc>Width of the guest display, in pixels.</desc>
10666	</param>
10667	<param name="height" type="unsigned long" dir="in">
10668	<desc>Height of the guest display, in pixels.</desc>
10669	</param>
10670	<param name="finished" type="boolean" dir="return">
10671	<desc>
10672	Can the VM start using the new frame buffer immediately
10673	after this method returns or it should wait for
10674	<link to="IDisplay::resizeCompleted"/>.
10675	</desc>
10676	</param>
10677	</method>
10678
10679	<method name="videoModeSupported">
10680	<desc>
10681	Returns whether the frame buffer implementation is willing to
10682	support a given video mode. In case it is not able to render
10683	the video mode (or for some reason not willing), it should
10684	return @c false. Usually this method is called when the guest
10685	asks the VMM device whether a given video mode is supported
10686	so the information returned is directly exposed to the guest.
10687	It is important that this method returns very quickly.
10688	</desc>
10689	<param name="width" type="unsigned long" dir="in"/>
10690	<param name="height" type="unsigned long" dir="in"/>
10691	<param name="bpp" type="unsigned long" dir="in"/>
10692	<param name="supported" type="boolean" dir="return"/>
10693	</method>
10694
10695	<method name="getVisibleRegion">
10696	<desc>
10697	Returns the visible region of this frame buffer.
10698
10699	If the @a rectangles parameter is @c null then the value of the
10700	@a count parameter is ignored and the number of elements necessary to
10701	describe the current visible region is returned in @a countCopied.
10702
10703	If @a rectangles is not @c null but @a count is less
10704	than the required number of elements to store region data, the method
10705	will report a failure. If @a count is equal or greater than the
10706	required number of elements, then the actual number of elements copied
10707	to the provided array will be returned in @a countCopied.
10708
10709	<note>
10710	The address of the provided array must be in the process space of
10711	this IFramebuffer object.
10712	</note>
10713	<note>
10714	Method not yet implemented.
10715	</note>
10716	</desc>
10717	<param name="rectangles" type="octet" mod="ptr" dir="in">
10718	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10719	</param>
10720	<param name="count" type="unsigned long" dir="in">
10721	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10722	</param>
10723	<param name="countCopied" type="unsigned long" dir="return">
10724	<desc>Number of elements copied to the @a rectangles array.</desc>
10725	</param>
10726	</method>
10727
10728	<method name="setVisibleRegion">
10729	<desc>
10730	Suggests a new visible region to this frame buffer. This region
10731	represents the area of the VM display which is a union of regions of
10732	all top-level windows of the guest operating system running inside the
10733	VM (if the Guest Additions for this system support this
10734	functionality). This information may be used by the frontends to
10735	implement the seamless desktop integration feature.
10736
10737	<note>
10738	The address of the provided array must be in the process space of
10739	this IFramebuffer object.
10740	</note>
10741	<note>
10742	The IFramebuffer implementation must make a copy of the provided
10743	array of rectangles.
10744	</note>
10745	<note>
10746	Method not yet implemented.
10747	</note>
10748	</desc>
10749	<param name="rectangles" type="octet" mod="ptr" dir="in">
10750	<desc>Pointer to the @c RTRECT array.</desc>
10751	</param>
10752	<param name="count" type="unsigned long" dir="in">
10753	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10754	</param>
10755	</method>
10756
10757	<method name="processVHWACommand">
10758	<desc>
10759	Posts a Video HW Acceleration Command to the frame buffer for processing.
10760	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10761	are posted from quest to the host to be processed by the host hardware.
10762
10763	<note>
10764	The address of the provided command must be in the process space of
10765	this IFramebuffer object.
10766	</note>
10767	</desc>
10768
10769	<param name="command" type="octet" mod="ptr" dir="in">
10770	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10771	</param>
10772	</method>
10773
10774	</interface>
10775
10776	<interface
10777	name="IFramebufferOverlay" extends="IFramebuffer"
10778	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10779	wsmap="suppress"
10780	>
10781	<desc>
10782	The IFramebufferOverlay interface represents an alpha blended overlay
10783	for displaying status icons above an IFramebuffer. It is always created
10784	not visible, so that it must be explicitly shown. It only covers a
10785	portion of the IFramebuffer, determined by its width, height and
10786	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10787	that order) format, and may be written to directly. Do re-read the
10788	width though, after setting it, as it may be adjusted (increased) to
10789	make it more suitable for the front end.
10790	</desc>
10791	<attribute name="x" type="unsigned long" readonly="yes">
10792	<desc>X position of the overlay, relative to the frame buffer.</desc>
10793	</attribute>
10794
10795	<attribute name="y" type="unsigned long" readonly="yes">
10796	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10797	</attribute>
10798
10799	<attribute name="visible" type="boolean" readonly="no">
10800	<desc>
10801	Whether the overlay is currently visible.
10802	</desc>
10803	</attribute>
10804
10805	<attribute name="alpha" type="unsigned long" readonly="no">
10806	<desc>
10807	The global alpha value for the overlay. This may or may not be
10808	supported by a given front end.
10809	</desc>
10810	</attribute>
10811
10812	<method name="move">
10813	<desc>
10814	Changes the overlay's position relative to the IFramebuffer.
10815	</desc>
10816	<param name="x" type="unsigned long" dir="in"/>
10817	<param name="y" type="unsigned long" dir="in"/>
10818	</method>
10819
10820	</interface>
10821
10822	<interface
10823	name="IDisplay" extends="$unknown"
10824	uuid="1fa79e39-0cc9-4ab3-9df3-ed3e96b42496"
10825	wsmap="managed"
10826	>
10827	<desc>
10828	The IDisplay interface represents the virtual machine's display.
10829
10830	The object implementing this interface is contained in each
10831	<link to="IConsole::display"/> attribute and represents the visual
10832	output of the virtual machine.
10833
10834	The virtual display supports pluggable output targets represented by the
10835	IFramebuffer interface. Examples of the output target are a window on
10836	the host computer or an RDP session's display on a remote computer.
10837	</desc>
10838	<method name="getScreenResolution">
10839	<desc>Queries display width, height and color depth for given screen.</desc>
10840	<param name="screenId" type="unsigned long" dir="in"/>
10841	<param name="width" type="unsigned long" dir="out"/>
10842	<param name="height" type="unsigned long" dir="out"/>
10843	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
10844	</method>
10845
10846	<method name="setFramebuffer">
10847	<desc>
10848	Sets the framebuffer for given screen.
10849	</desc>
10850	<param name="screenId" type="unsigned long" dir="in"/>
10851	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10852	</method>
10853
10854	<method name="getFramebuffer">
10855	<desc>
10856	Queries the framebuffer for given screen.
10857	</desc>
10858	<param name="screenId" type="unsigned long" dir="in"/>
10859	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10860	<param name="xOrigin" type="long" dir="out"/>
10861	<param name="yOrigin" type="long" dir="out"/>
10862	</method>
10863
10864	<method name="setVideoModeHint">
10865	<desc>
10866	Asks VirtualBox to request the given video mode from
10867	the guest. This is just a hint and it cannot be guaranteed
10868	that the requested resolution will be used. Guest Additions
10869	are required for the request to be seen by guests. The caller
10870	should issue the request and wait for a resolution change and
10871	after a timeout retry.
10872
10873	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10874	parameters means that the corresponding values should be taken from the
10875	current video mode (i.e. left unchanged).
10876
10877	If the guest OS supports multi-monitor configuration then the @a display
10878	parameter specifies the number of the guest display to send the hint to:
10879	@c 0 is the primary display, @c 1 is the first secondary and
10880	so on. If the multi-monitor configuration is not supported, @a display
10881	must be @c 0.
10882
10883	<result name="E_INVALIDARG">
10884	The @a display is not associated with any monitor.
10885	</result>
10886
10887	</desc>
10888	<param name="width" type="unsigned long" dir="in"/>
10889	<param name="height" type="unsigned long" dir="in"/>
10890	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
10891	<param name="display" type="unsigned long" dir="in"/>
10892	</method>
10893
10894	<method name="setSeamlessMode">
10895	<desc>
10896	Enables or disables seamless guest display rendering (seamless desktop
10897	integration) mode.
10898	<note>
10899	Calling this method has no effect if <link
10900	to="IGuest::supportsSeamless"/> returns @c false.
10901	</note>
10902	</desc>
10903	<param name="enabled" type="boolean" dir="in"/>
10904	</method>
10905
10906	<method name="takeScreenShot">
10907	<desc>
10908	Takes a screen shot of the requested size and copies it to the
10909	32-bpp buffer allocated by the caller and pointed to by @a address.
10910	A pixel consists of 4 bytes in order: B, G, R, 0.
10911
10912	<note>This API can be used only by the COM/XPCOM C++ API as it
10913	requires pointer support. Use <link to="#takeScreenShotToArray" />
10914	with other language bindings.
10915	</note>
10916
10917	<result name="E_NOTIMPL">
10918	Feature not implemented.
10919	</result>
10920	<result name="VBOX_E_IPRT_ERROR">
10921	Could not take a screenshot.
10922	</result>
10923
10924	</desc>
10925	<param name="screenId" type="unsigned long" dir="in"/>
10926	<param name="address" type="octet" mod="ptr" dir="in"/>
10927	<param name="width" type="unsigned long" dir="in"/>
10928	<param name="height" type="unsigned long" dir="in"/>
10929	</method>
10930
10931	<method name="takeScreenShotToArray">
10932	<desc>
10933	Takes a guest screen shot of the requested size and returns it as
10934	an array of bytes in uncompressed 32-bit RGBA format.
10935	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
10936
10937	This API is slow, but could be the only option to get guest screenshot
10938	for scriptable languages not allowed to manipulate with addresses
10939	directly.
10940
10941	<result name="E_NOTIMPL">
10942	Feature not implemented.
10943	</result>
10944	<result name="VBOX_E_IPRT_ERROR">
10945	Could not take a screenshot.
10946	</result>
10947	</desc>
10948	<param name="screenId" type="unsigned long" dir="in">
10949	<desc>
10950	Monitor to take screenshot from.
10951	</desc>
10952	</param>
10953	<param name="width" type="unsigned long" dir="in">
10954	<desc>
10955	Desired image width.
10956	</desc>
10957	</param>
10958	<param name="height" type="unsigned long" dir="in">
10959	<desc>
10960	Desired image height.
10961	</desc>
10962	</param>
10963	<param name="screenData" type="octet" dir="return" safearray="yes">
10964	<desc>
10965	Array with resulting screen data.
10966	</desc>
10967	</param>
10968	</method>
10969
10970	<method name="drawToScreen">
10971	<desc>
10972	Draws a 32-bpp image of the specified size from the given buffer
10973	to the given point on the VM display.
10974
10975	<result name="E_NOTIMPL">
10976	Feature not implemented.
10977	</result>
10978	<result name="VBOX_E_IPRT_ERROR">
10979	Could not draw to screen.
10980	</result>
10981
10982	</desc>
10983	<param name="screenId" type="unsigned long" dir="in"/>
10984	<param name="address" type="octet" mod="ptr" dir="in"/>
10985	<param name="x" type="unsigned long" dir="in">
10986	<desc>Relative to the screen top left corner.</desc>
10987	</param>
10988	<param name="y" type="unsigned long" dir="in">
10989	<desc>Relative to the screen top left corner.</desc>
10990	</param>
10991	<param name="width" type="unsigned long" dir="in"/>
10992	<param name="height" type="unsigned long" dir="in"/>
10993	</method>
10994
10995	<method name="invalidateAndUpdate">
10996	<desc>
10997	Does a full invalidation of the VM display and instructs the VM
10998	to update it.
10999
11000	<result name="VBOX_E_IPRT_ERROR">
11001	Could not invalidate and update screen.
11002	</result>
11003
11004	</desc>
11005	</method>
11006
11007	<method name="resizeCompleted">
11008	<desc>
11009	Signals that a framebuffer has completed the resize operation.
11010
11011	<result name="VBOX_E_NOT_SUPPORTED">
11012	Operation only valid for external frame buffers.
11013	</result>
11014
11015	</desc>
11016	<param name="screenId" type="unsigned long" dir="in"/>
11017	</method>
11018
11019	<method name="completeVHWACommand">
11020	<desc>
11021	Signals that the Video HW Acceleration command has completed.
11022	</desc>
11023
11024	<param name="command" type="octet" mod="ptr" dir="in">
11025	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11026	</param>
11027	</method>
11028
11029	</interface>
11030
11031	<!--
11032	// INetworkAdapter
11033	/////////////////////////////////////////////////////////////////////////
11034	-->
11035
11036	<enum
11037	name="NetworkAttachmentType"
11038	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11039	>
11040	<desc>
11041	Network attachment type.
11042	</desc>
11043
11044	<const name="Null" value="0">
11045	<desc>Null value, also means "not attached".</desc>
11046	</const>
11047	<const name="NAT" value="1"/>
11048	<const name="Bridged" value="2"/>
11049	<const name="Internal" value="3"/>
11050	<const name="HostOnly" value="4"/>
11051	<const name="VDE" value="5"/>
11052	</enum>
11053
11054	<enum
11055	name="NetworkAdapterType"
11056	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11057	>
11058	<desc>
11059	Network adapter type.
11060	</desc>
11061
11062	<const name="Null" value="0">
11063	<desc>Null value (never used by the API).</desc>
11064	</const>
11065	<const name="Am79C970A" value="1">
11066	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11067	</const>
11068	<const name="Am79C973" value="2">
11069	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11070	</const>
11071	<const name="I82540EM" value="3">
11072	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11073	</const>
11074	<const name="I82543GC" value="4">
11075	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11076	</const>
11077	<const name="I82545EM" value="5">
11078	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11079	</const>
11080	<const name="Virtio" value="6">
11081	<desc>Virtio network device.</desc>
11082	</const>
11083	</enum>
11084
11085	<interface
11086	name="INetworkAdapter" extends="$unknown"
11087	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11088	wsmap="managed"
11089	>
11090	<desc>
11091	Represents a virtual network adapter that is attached to a virtual machine.
11092	Each virtual machine has a fixed number of network adapter slots with one
11093	instance of this attached to each of them. Call
11094	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11095	is attached to a given slot in a given machine.
11096
11097	Each network adapter can be in one of five attachment modes, which are
11098	represented by the <link to="NetworkAttachmentType" /> enumeration;
11099	see the <link to="#attachmentType" /> attribute.
11100	</desc>
11101
11102	<attribute name="adapterType" type="NetworkAdapterType">
11103	<desc>
11104	Type of the virtual network adapter. Depending on this value,
11105	VirtualBox will provide a different virtual network hardware
11106	to the guest.
11107	</desc>
11108	</attribute>
11109
11110	<attribute name="slot" type="unsigned long" readonly="yes">
11111	<desc>
11112	Slot number this adapter is plugged into. Corresponds to
11113	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11114	to obtain this instance.
11115	</desc>
11116	</attribute>
11117
11118	<attribute name="enabled" type="boolean">
11119	<desc>
11120	Flag whether the network adapter is present in the
11121	guest system. If disabled, the virtual guest hardware will
11122	not contain this network adapter. Can only be changed when
11123	the VM is not running.
11124	</desc>
11125	</attribute>
11126
11127	<attribute name="MACAddress" type="wstring">
11128	<desc>
11129	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11130	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11131	</desc>
11132	</attribute>
11133
11134	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11135
11136	<attribute name="hostInterface" type="wstring">
11137	<desc>
11138	Name of the host network interface the VM is attached to.
11139	</desc>
11140	</attribute>
11141
11142	<attribute name="internalNetwork" type="wstring">
11143	<desc>
11144	Name of the internal network the VM is attached to.
11145	</desc>
11146	</attribute>
11147
11148	<attribute name="NATNetwork" type="wstring">
11149	<desc>
11150	Name of the NAT network the VM is attached to.
11151	</desc>
11152	</attribute>
11153
11154	<attribute name="VDENetwork" type="wstring">
11155	<desc>
11156	Name of the VDE switch the VM is attached to.
11157	</desc>
11158	</attribute>
11159
11160	<attribute name="cableConnected" type="boolean">
11161	<desc>
11162	Flag whether the adapter reports the cable as connected or not.
11163	It can be used to report offline situations to a VM.
11164	</desc>
11165	</attribute>
11166
11167	<attribute name="lineSpeed" type="unsigned long">
11168	<desc>
11169	Line speed reported by custom drivers, in units of 1 kbps.
11170	</desc>
11171	</attribute>
11172
11173	<attribute name="traceEnabled" type="boolean">
11174	<desc>
11175	Flag whether network traffic from/to the network card should be traced.
11176	Can only be toggled when the VM is turned off.
11177	</desc>
11178	</attribute>
11179
11180	<attribute name="traceFile" type="wstring">
11181	<desc>
11182	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11183	will be used.
11184	</desc>
11185	</attribute>
11186
11187	<attribute name="natDriver" type="INATEngine" readonly="yes">
11188	<desc>
11189	Points to the NAT engine which handles the network address translation
11190	for this interface. This is active only when the interface actually uses
11191	NAT (see <link to="#attachToNAT" />).
11192	</desc>
11193	</attribute>
11194
11195	<attribute name="bootPriority" type="unsigned long">
11196	<desc>
11197	Network boot priority of the adapter. Priority 1 is highest. If not set,
11198	the priority is considered to be at the lowest possible setting.
11199	</desc>
11200	</attribute>
11201
11202	<attribute name="bandwidthLimit" type="unsigned long">
11203	<desc>
11204	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11205	A zero value means uncapped/unlimited.
11206	</desc>
11207	</attribute>
11208
11209	<method name="attachToNAT">
11210	<desc>
11211	Attach the network adapter to the Network Address Translation (NAT) interface.
11212	</desc>
11213	</method>
11214
11215	<method name="attachToBridgedInterface">
11216	<desc>
11217	Attach the network adapter to a bridged host interface.
11218	</desc>
11219	</method>
11220
11221	<method name="attachToInternalNetwork">
11222	<desc>
11223	Attach the network adapter to an internal network.
11224	</desc>
11225	</method>
11226
11227	<method name="attachToHostOnlyInterface">
11228	<desc>
11229	Attach the network adapter to the host-only network.
11230	</desc>
11231	</method>
11232
11233	<method name="attachToVDE">
11234	<desc>
11235	Attach the network adapter to a VDE network.
11236	</desc>
11237	</method>
11238
11239	<method name="detach">
11240	<desc>
11241	Detach the network adapter
11242	</desc>
11243	</method>
11244	</interface>
11245
11246
11247	<!--
11248	// ISerialPort
11249	/////////////////////////////////////////////////////////////////////////
11250	-->
11251
11252	<enum
11253	name="PortMode"
11254	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11255	>
11256	<desc>
11257	The PortMode enumeration represents possible communication modes for
11258	the virtual serial port device.
11259	</desc>
11260
11261	<const name="Disconnected" value="0">
11262	<desc>Virtual device is not attached to any real host device.</desc>
11263	</const>
11264	<const name="HostPipe" value="1">
11265	<desc>Virtual device is attached to a host pipe.</desc>
11266	</const>
11267	<const name="HostDevice" value="2">
11268	<desc>Virtual device is attached to a host device.</desc>
11269	</const>
11270	<const name="RawFile" value="3">
11271	<desc>Virtual device is attached to a raw file.</desc>
11272	</const>
11273	</enum>
11274
11275	<interface
11276	name="ISerialPort" extends="$unknown"
11277	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11278	wsmap="managed"
11279	>
11280
11281	<desc>
11282	The ISerialPort interface represents the virtual serial port device.
11283
11284	The virtual serial port device acts like an ordinary serial port
11285	inside the virtual machine. This device communicates to the real
11286	serial port hardware in one of two modes: host pipe or host device.
11287
11288	In host pipe mode, the #path attribute specifies the path to the pipe on
11289	the host computer that represents a serial port. The #server attribute
11290	determines if this pipe is created by the virtual machine process at
11291	machine startup or it must already exist before starting machine
11292	execution.
11293
11294	In host device mode, the #path attribute specifies the name of the
11295	serial port device on the host computer.
11296
11297	There is also a third communication mode: the disconnected mode. In this
11298	mode, the guest OS running inside the virtual machine will be able to
11299	detect the serial port, but all port write operations will be discarded
11300	and all port read operations will return no data.
11301
11302	<see>IMachine::getSerialPort</see>
11303	</desc>
11304
11305	<attribute name="slot" type="unsigned long" readonly="yes">
11306	<desc>
11307	Slot number this serial port is plugged into. Corresponds to
11308	the value you pass to <link to="IMachine::getSerialPort"/>
11309	to obtain this instance.
11310	</desc>
11311	</attribute>
11312
11313	<attribute name="enabled" type="boolean">
11314	<desc>
11315	Flag whether the serial port is enabled. If disabled,
11316	the serial port will not be reported to the guest OS.
11317	</desc>
11318	</attribute>
11319
11320	<attribute name="IOBase" type="unsigned long">
11321	<desc>Base I/O address of the serial port.</desc>
11322	</attribute>
11323
11324	<attribute name="IRQ" type="unsigned long">
11325	<desc>IRQ number of the serial port.</desc>
11326	</attribute>
11327
11328	<attribute name="hostMode" type="PortMode">
11329	<desc>
11330	How is this port connected to the host.
11331	<note>
11332	Changing this attribute may fail if the conditions for
11333	<link to="#path"/> are not met.
11334	</note>
11335	</desc>
11336	</attribute>
11337
11338	<attribute name="server" type="boolean">
11339	<desc>
11340	Flag whether this serial port acts as a server (creates a new pipe on
11341	the host) or as a client (uses the existing pipe). This attribute is
11342	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11343	</desc>
11344	</attribute>
11345
11346	<attribute name="path" type="wstring">
11347	<desc>
11348	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11349	PortMode_HostPipe, or the host serial device name when
11350	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11351	cases, setting a @c null or empty string as the attribute's value
11352	is an error. Otherwise, the value of this property is ignored.
11353	</desc>
11354	</attribute>
11355
11356	</interface>
11357
11358	<!--
11359	// IParallelPort
11360	/////////////////////////////////////////////////////////////////////////
11361	-->
11362
11363	<interface
11364	name="IParallelPort" extends="$unknown"
11365	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11366	wsmap="managed"
11367	>
11368
11369	<desc>
11370	The IParallelPort interface represents the virtual parallel port device.
11371
11372	The virtual parallel port device acts like an ordinary parallel port
11373	inside the virtual machine. This device communicates to the real
11374	parallel port hardware using the name of the parallel device on the host
11375	computer specified in the #path attribute.
11376
11377	Each virtual parallel port device is assigned a base I/O address and an
11378	IRQ number that will be reported to the guest operating system and used
11379	to operate the given parallel port from within the virtual machine.
11380
11381	<see>IMachine::getParallelPort</see>
11382	</desc>
11383
11384	<attribute name="slot" type="unsigned long" readonly="yes">
11385	<desc>
11386	Slot number this parallel port is plugged into. Corresponds to
11387	the value you pass to <link to="IMachine::getParallelPort"/>
11388	to obtain this instance.
11389	</desc>
11390	</attribute>
11391
11392	<attribute name="enabled" type="boolean">
11393	<desc>
11394	Flag whether the parallel port is enabled. If disabled,
11395	the parallel port will not be reported to the guest OS.
11396	</desc>
11397	</attribute>
11398
11399	<attribute name="IOBase" type="unsigned long">
11400	<desc>Base I/O address of the parallel port.</desc>
11401	</attribute>
11402
11403	<attribute name="IRQ" type="unsigned long">
11404	<desc>IRQ number of the parallel port.</desc>
11405	</attribute>
11406
11407	<attribute name="path" type="wstring">
11408	<desc>
11409	Host parallel device name. If this parallel port is enabled, setting a
11410	@c null or an empty string as this attribute's value will result into
11411	an error.
11412	</desc>
11413	</attribute>
11414
11415	</interface>
11416
11417
11418	<!--
11419	// IMachineDebugger
11420	/////////////////////////////////////////////////////////////////////////
11421	-->
11422
11423	<interface
11424	name="IMachineDebugger" extends="$unknown"
11425	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11426	wsmap="suppress"
11427	>
11428	<method name="resetStats">
11429	<desc>
11430	Reset VM statistics.
11431	</desc>
11432	<param name="pattern" type="wstring" dir="in">
11433	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11434	</param>
11435	</method>
11436
11437	<method name="dumpStats">
11438	<desc>
11439	Dumps VM statistics.
11440	</desc>
11441	<param name="pattern" type="wstring" dir="in">
11442	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11443	</param>
11444	</method>
11445
11446	<method name="getStats">
11447	<desc>
11448	Get the VM statistics in a XMLish format.
11449	</desc>
11450	<param name="pattern" type="wstring" dir="in">
11451	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11452	</param>
11453	<param name="withDescriptions" type="boolean" dir="in">
11454	<desc>Whether to include the descriptions.</desc>
11455	</param>
11456	<param name="stats" type="wstring" dir="out">
11457	<desc>The XML document containing the statistics.</desc>
11458	</param>
11459	</method>
11460
11461	<method name="injectNMI">
11462	<desc>
11463	Inject an NMI into a running VT-x/AMD-V VM.
11464	</desc>
11465	</method>
11466
11467	<attribute name="singlestep" type="boolean">
11468	<desc>Switch for enabling singlestepping.</desc>
11469	</attribute>
11470
11471	<attribute name="recompileUser" type="boolean">
11472	<desc>Switch for forcing code recompilation for user mode code.</desc>
11473	</attribute>
11474
11475	<attribute name="recompileSupervisor" type="boolean">
11476	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11477	</attribute>
11478
11479	<attribute name="PATMEnabled" type="boolean">
11480	<desc>Switch for enabling and disabling the PATM component.</desc>
11481	</attribute>
11482
11483	<attribute name="CSAMEnabled" type="boolean">
11484	<desc>Switch for enabling and disabling the CSAM component.</desc>
11485	</attribute>
11486
11487	<attribute name="logEnabled" type="boolean">
11488	<desc>Switch for enabling and disabling logging.</desc>
11489	</attribute>
11490
11491	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11492	<desc>
11493	Flag indicating whether the VM is currently making use of CPU hardware
11494	virtualization extensions.
11495	</desc>
11496	</attribute>
11497
11498	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11499	<desc>
11500	Flag indicating whether the VM is currently making use of the nested paging
11501	CPU hardware virtualization extension.
11502	</desc>
11503	</attribute>
11504
11505	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11506	<desc>
11507	Flag indicating whether the VM is currently making use of the VPID
11508	VT-x extension.
11509	</desc>
11510	</attribute>
11511
11512	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11513	<desc>
11514	Flag indicating whether the VM is currently making use of the Physical
11515	Address Extension CPU feature.
11516	</desc>
11517	</attribute>
11518
11519	<attribute name="virtualTimeRate" type="unsigned long">
11520	<desc>
11521	The rate at which the virtual time runs expressed as a percentage.
11522	The accepted range is 2% to 20000%.
11523	</desc>
11524	</attribute>
11525
11526	<!-- @todo method for setting log flags, groups and destination! -->
11527
11528	<attribute name="VM" type="unsigned long long" readonly="yes">
11529	<desc>
11530	Gets the VM handle. This is only for internal use while
11531	we carve the details of this interface.
11532	</desc>
11533	</attribute>
11534
11535	</interface>
11536
11537	<!--
11538	// IUSBController
11539	/////////////////////////////////////////////////////////////////////////
11540	-->
11541
11542	<interface
11543	name="IUSBController" extends="$unknown"
11544	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11545	wsmap="managed"
11546	>
11547	<attribute name="enabled" type="boolean">
11548	<desc>
11549	Flag whether the USB controller is present in the
11550	guest system. If disabled, the virtual guest hardware will
11551	not contain any USB controller. Can only be changed when
11552	the VM is powered off.
11553	</desc>
11554	</attribute>
11555
11556	<attribute name="enabledEhci" type="boolean">
11557	<desc>
11558	Flag whether the USB EHCI controller is present in the
11559	guest system. If disabled, the virtual guest hardware will
11560	not contain a USB EHCI controller. Can only be changed when
11561	the VM is powered off.
11562	</desc>
11563	</attribute>
11564
11565	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11566	<desc>
11567	Flag whether there is an USB proxy available.
11568	</desc>
11569	</attribute>
11570
11571	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11572	<desc>
11573	USB standard version which the controller implements.
11574	This is a BCD which means that the major version is in the
11575	high byte and minor version is in the low byte.
11576	</desc>
11577	</attribute>
11578
11579	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11580	<desc>
11581	List of USB device filters associated with the machine.
11582
11583	If the machine is currently running, these filters are activated
11584	every time a new (supported) USB device is attached to the host
11585	computer that was not ignored by global filters
11586	(<link to="IHost::USBDeviceFilters"/>).
11587
11588	These filters are also activated when the machine is powered up.
11589	They are run against a list of all currently available USB
11590	devices (in states
11591	<link to="USBDeviceState_Available"/>,
11592	<link to="USBDeviceState_Busy"/>,
11593	<link to="USBDeviceState_Held"/>) that were not previously
11594	ignored by global filters.
11595
11596	If at least one filter matches the USB device in question, this
11597	device is automatically captured (attached to) the virtual USB
11598	controller of this machine.
11599
11600	<see>IUSBDeviceFilter, ::IUSBController</see>
11601	</desc>
11602	</attribute>
11603
11604	<method name="createDeviceFilter">
11605	<desc>
11606	Creates a new USB device filter. All attributes except
11607	the filter name are set to empty (any match),
11608	<i>active</i> is @c false (the filter is not active).
11609
11610	The created filter can then be added to the list of filters using
11611	<link to="#insertDeviceFilter"/>.
11612
11613	<result name="VBOX_E_INVALID_VM_STATE">
11614	The virtual machine is not mutable.
11615	</result>
11616
11617	<see>#deviceFilters</see>
11618	</desc>
11619	<param name="name" type="wstring" dir="in">
11620	<desc>
11621	Filter name. See <link to="IUSBDeviceFilter::name"/>
11622	for more info.
11623	</desc>
11624	</param>
11625	<param name="filter" type="IUSBDeviceFilter" dir="return">
11626	<desc>Created filter object.</desc>
11627	</param>
11628	</method>
11629
11630	<method name="insertDeviceFilter">
11631	<desc>
11632	Inserts the given USB device to the specified position
11633	in the list of filters.
11634
11635	Positions are numbered starting from <tt>0</tt>. If the specified
11636	position is equal to or greater than the number of elements in
11637	the list, the filter is added to the end of the collection.
11638
11639	<note>
11640	Duplicates are not allowed, so an attempt to insert a
11641	filter that is already in the collection, will return an
11642	error.
11643	</note>
11644
11645	<result name="VBOX_E_INVALID_VM_STATE">
11646	Virtual machine is not mutable.
11647	</result>
11648	<result name="E_INVALIDARG">
11649	USB device filter not created within this VirtualBox instance.
11650	</result>
11651	<result name="VBOX_E_INVALID_OBJECT_STATE">
11652	USB device filter already in list.
11653	</result>
11654
11655	<see>#deviceFilters</see>
11656	</desc>
11657	<param name="position" type="unsigned long" dir="in">
11658	<desc>Position to insert the filter to.</desc>
11659	</param>
11660	<param name="filter" type="IUSBDeviceFilter" dir="in">
11661	<desc>USB device filter to insert.</desc>
11662	</param>
11663	</method>
11664
11665	<method name="removeDeviceFilter">
11666	<desc>
11667	Removes a USB device filter from the specified position in the
11668	list of filters.
11669
11670	Positions are numbered starting from <tt>0</tt>. Specifying a
11671	position equal to or greater than the number of elements in
11672	the list will produce an error.
11673
11674	<see>#deviceFilters</see>
11675
11676	<result name="VBOX_E_INVALID_VM_STATE">
11677	Virtual machine is not mutable.
11678	</result>
11679	<result name="E_INVALIDARG">
11680	USB device filter list empty or invalid @a position.
11681	</result>
11682
11683	</desc>
11684	<param name="position" type="unsigned long" dir="in">
11685	<desc>Position to remove the filter from.</desc>
11686	</param>
11687	<param name="filter" type="IUSBDeviceFilter" dir="return">
11688	<desc>Removed USB device filter.</desc>
11689	</param>
11690	</method>
11691
11692	</interface>
11693
11694
11695	<!--
11696	// IUSBDevice
11697	/////////////////////////////////////////////////////////////////////////
11698	-->
11699
11700	<interface
11701	name="IUSBDevice" extends="$unknown"
11702	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11703	wsmap="managed"
11704	>
11705	<desc>
11706	The IUSBDevice interface represents a virtual USB device attached to the
11707	virtual machine.
11708
11709	A collection of objects implementing this interface is stored in the
11710	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11711	attached to a running virtual machine's USB controller.
11712	</desc>
11713
11714	<attribute name="id" type="uuid" mod="string" readonly="yes">
11715	<desc>
11716	Unique USB device ID. This ID is built from #vendorId,
11717	#productId, #revision and #serialNumber.
11718	</desc>
11719	</attribute>
11720
11721	<attribute name="vendorId" type="unsigned short" readonly="yes">
11722	<desc>Vendor ID.</desc>
11723	</attribute>
11724
11725	<attribute name="productId" type="unsigned short" readonly="yes">
11726	<desc>Product ID.</desc>
11727	</attribute>
11728
11729	<attribute name="revision" type="unsigned short" readonly="yes">
11730	<desc>
11731	Product revision number. This is a packed BCD represented as
11732	unsigned short. The high byte is the integer part and the low
11733	byte is the decimal.
11734	</desc>
11735	</attribute>
11736
11737	<attribute name="manufacturer" type="wstring" readonly="yes">
11738	<desc>Manufacturer string.</desc>
11739	</attribute>
11740
11741	<attribute name="product" type="wstring" readonly="yes">
11742	<desc>Product string.</desc>
11743	</attribute>
11744
11745	<attribute name="serialNumber" type="wstring" readonly="yes">
11746	<desc>Serial number string.</desc>
11747	</attribute>
11748
11749	<attribute name="address" type="wstring" readonly="yes">
11750	<desc>Host specific address of the device.</desc>
11751	</attribute>
11752
11753	<attribute name="port" type="unsigned short" readonly="yes">
11754	<desc>
11755	Host USB port number the device is physically
11756	connected to.
11757	</desc>
11758	</attribute>
11759
11760	<attribute name="version" type="unsigned short" readonly="yes">
11761	<desc>
11762	The major USB version of the device - 1 or 2.
11763	</desc>
11764	</attribute>
11765
11766	<attribute name="portVersion" type="unsigned short" readonly="yes">
11767	<desc>
11768	The major USB version of the host USB port the device is
11769	physically connected to - 1 or 2. For devices not connected to
11770	anything this will have the same value as the version attribute.
11771	</desc>
11772	</attribute>
11773
11774	<attribute name="remote" type="boolean" readonly="yes">
11775	<desc>
11776	Whether the device is physically connected to a remote VRDP
11777	client or to a local host machine.
11778	</desc>
11779	</attribute>
11780
11781	</interface>
11782
11783
11784	<!--
11785	// IUSBDeviceFilter
11786	/////////////////////////////////////////////////////////////////////////
11787	-->
11788
11789	<interface
11790	name="IUSBDeviceFilter" extends="$unknown"
11791	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11792	wsmap="managed"
11793	>
11794	<desc>
11795	The IUSBDeviceFilter interface represents an USB device filter used
11796	to perform actions on a group of USB devices.
11797
11798	This type of filters is used by running virtual machines to
11799	automatically capture selected USB devices once they are physically
11800	attached to the host computer.
11801
11802	A USB device is matched to the given device filter if and only if all
11803	attributes of the device match the corresponding attributes of the
11804	filter (that is, attributes are joined together using the logical AND
11805	operation). On the other hand, all together, filters in the list of
11806	filters carry the semantics of the logical OR operation. So if it is
11807	desirable to create a match like "this vendor id OR this product id",
11808	one needs to create two filters and specify "any match" (see below)
11809	for unused attributes.
11810
11811	All filter attributes used for matching are strings. Each string
11812	is an expression representing a set of values of the corresponding
11813	device attribute, that will match the given filter. Currently, the
11814	following filtering expressions are supported:
11815
11816	<ul>
11817	<li><i>Interval filters</i>. Used to specify valid intervals for
11818	integer device attributes (Vendor ID, Product ID and Revision).
11819	The format of the string is:
11820
11821	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11822
11823	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11824	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11825	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11826	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11827	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11828	possible integer is assumed.
11829	</li>
11830	<li><i>Boolean filters</i>. Used to specify acceptable values for
11831	boolean device attributes. The format of the string is:
11832
11833	<tt>true\|false\|yes\|no\|0\|1</tt>
11834
11835	</li>
11836	<li><i>Exact match</i>. Used to specify a single value for the given
11837	device attribute. Any string that doesn't start with <tt>int:</tt>
11838	represents the exact match. String device attributes are compared to
11839	this string including case of symbols. Integer attributes are first
11840	converted to a string (see individual filter attributes) and then
11841	compared ignoring case.
11842
11843	</li>
11844	<li><i>Any match</i>. Any value of the corresponding device attribute
11845	will match the given filter. An empty or @c null string is
11846	used to construct this type of filtering expressions.
11847
11848	</li>
11849	</ul>
11850
11851	<note>
11852	On the Windows host platform, interval filters are not currently
11853	available. Also all string filter attributes
11854	(<link to="#manufacturer"/>, <link to="#product"/>,
11855	<link to="#serialNumber"/>) are ignored, so they behave as
11856	<i>any match</i> no matter what string expression is specified.
11857	</note>
11858
11859	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11860	</desc>
11861
11862	<attribute name="name" type="wstring">
11863	<desc>
11864	Visible name for this filter.
11865	This name is used to visually distinguish one filter from another,
11866	so it can neither be @c null nor an empty string.
11867	</desc>
11868	</attribute>
11869
11870	<attribute name="active" type="boolean">
11871	<desc>Whether this filter active or has been temporarily disabled.</desc>
11872	</attribute>
11873
11874	<attribute name="vendorId" type="wstring">
11875	<desc>
11876	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
11877	The string representation for the <i>exact matching</i>
11878	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11879	(including leading zeroes).
11880	</desc>
11881	</attribute>
11882
11883	<attribute name="productId" type="wstring">
11884	<desc>
11885	<link to="IUSBDevice::productId">Product ID</link> filter.
11886	The string representation for the <i>exact matching</i>
11887	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11888	(including leading zeroes).
11889	</desc>
11890	</attribute>
11891
11892	<attribute name="revision" type="wstring">
11893	<desc>
11894	<link to="IUSBDevice::productId">Product revision number</link>
11895	filter. The string representation for the <i>exact matching</i>
11896	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
11897	of the integer part of the revision, and <tt>F</tt> is the
11898	decimal digit of its fractional part (including leading and
11899	trailing zeros).
11900	Note that for interval filters, it's best to use the hexadecimal
11901	form, because the revision is stored as a 16 bit packed BCD value;
11902	so the expression <tt>int:0x0100-0x0199</tt> will match any
11903	revision from <tt>1.0</tt> to <tt>1.99</tt>.
11904	</desc>
11905	</attribute>
11906
11907	<attribute name="manufacturer" type="wstring">
11908	<desc>
11909	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
11910	</desc>
11911	</attribute>
11912
11913	<attribute name="product" type="wstring">
11914	<desc>
11915	<link to="IUSBDevice::product">Product</link> filter.
11916	</desc>
11917	</attribute>
11918
11919	<attribute name="serialNumber" type="wstring">
11920	<desc>
11921	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
11922	</desc>
11923	</attribute>
11924
11925	<attribute name="port" type="wstring">
11926	<desc>
11927	<link to="IUSBDevice::port">Host USB port</link> filter.
11928	</desc>
11929	</attribute>
11930
11931	<attribute name="remote" type="wstring">
11932	<desc>
11933	<link to="IUSBDevice::remote">Remote state</link> filter.
11934	<note>
11935	This filter makes sense only for machine USB filters,
11936	i.e. it is ignored by IHostUSBDeviceFilter objects.
11937	</note>
11938	</desc>
11939	</attribute>
11940
11941	<attribute name="maskedInterfaces" type="unsigned long">
11942	<desc>
11943	This is an advanced option for hiding one or more USB interfaces
11944	from the guest. The value is a bit mask where the bits that are set
11945	means the corresponding USB interface should be hidden, masked off
11946	if you like.
11947	This feature only works on Linux hosts.
11948	</desc>
11949	</attribute>
11950
11951	</interface>
11952
11953
11954	<!--
11955	// IHostUSBDevice
11956	/////////////////////////////////////////////////////////////////////////
11957	-->
11958
11959	<enum
11960	name="USBDeviceState"
11961	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
11962	>
11963	<desc>
11964	USB device state. This enumeration represents all possible states
11965	of the USB device physically attached to the host computer regarding
11966	its state on the host computer and availability to guest computers
11967	(all currently running virtual machines).
11968
11969	Once a supported USB device is attached to the host, global USB
11970	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
11971	either ignore the device, or put it to USBDeviceState_Held state, or do
11972	nothing. Unless the device is ignored by global filters, filters of all
11973	currently running guests (<link to="IUSBController::deviceFilters"/>) are
11974	activated that can put it to USBDeviceState_Captured state.
11975
11976	If the device was ignored by global filters, or didn't match
11977	any filters at all (including guest ones), it is handled by the host
11978	in a normal way. In this case, the device state is determined by
11979	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
11980	or USBDeviceState_Available, depending on the current device usage.
11981
11982	Besides auto-capturing based on filters, the device can be manually
11983	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
11984	state is USBDeviceState_Busy, USBDeviceState_Available or
11985	USBDeviceState_Held.
11986
11987	<note>
11988	Due to differences in USB stack implementations in Linux and Win32,
11989	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
11990	only to the Linux version of the product. This also means that (<link
11991	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
11992	device state is USBDeviceState_Held.
11993	</note>
11994
11995	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
11996	</desc>
11997
11998	<const name="NotSupported" value="0">
11999	<desc>
12000	Not supported by the VirtualBox server, not available to guests.
12001	</desc>
12002	</const>
12003	<const name="Unavailable" value="1">
12004	<desc>
12005	Being used by the host computer exclusively,
12006	not available to guests.
12007	</desc>
12008	</const>
12009	<const name="Busy" value="2">
12010	<desc>
12011	Being used by the host computer, potentially available to guests.
12012	</desc>
12013	</const>
12014	<const name="Available" value="3">
12015	<desc>
12016	Not used by the host computer, available to guests (the host computer
12017	can also start using the device at any time).
12018	</desc>
12019	</const>
12020	<const name="Held" value="4">
12021	<desc>
12022	Held by the VirtualBox server (ignored by the host computer),
12023	available to guests.
12024	</desc>
12025	</const>
12026	<const name="Captured" value="5">
12027	<desc>
12028	Captured by one of the guest computers, not available
12029	to anybody else.
12030	</desc>
12031	</const>
12032	</enum>
12033
12034	<interface
12035	name="IHostUSBDevice" extends="IUSBDevice"
12036	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12037	wsmap="managed"
12038	>
12039	<desc>
12040	The IHostUSBDevice interface represents a physical USB device attached
12041	to the host computer.
12042
12043	Besides properties inherited from IUSBDevice, this interface adds the
12044	<link to="#state"/> property that holds the current state of the USB
12045	device.
12046
12047	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12048	</desc>
12049
12050	<attribute name="state" type="USBDeviceState" readonly="yes">
12051	<desc>
12052	Current state of the device.
12053	</desc>
12054	</attribute>
12055
12056	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12057
12058	</interface>
12059
12060
12061	<!--
12062	// IHostUSBDeviceFilter
12063	/////////////////////////////////////////////////////////////////////////
12064	-->
12065
12066	<enum
12067	name="USBDeviceFilterAction"
12068	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12069	>
12070	<desc>
12071	Actions for host USB device filters.
12072	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12073	</desc>
12074
12075	<const name="Null" value="0">
12076	<desc>Null value (never used by the API).</desc>
12077	</const>
12078	<const name="Ignore" value="1">
12079	<desc>Ignore the matched USB device.</desc>
12080	</const>
12081	<const name="Hold" value="2">
12082	<desc>Hold the matched USB device.</desc>
12083	</const>
12084	</enum>
12085
12086	<interface
12087	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12088	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12089	wsmap="managed"
12090	>
12091	<desc>
12092	The IHostUSBDeviceFilter interface represents a global filter for a
12093	physical USB device used by the host computer. Used indirectly in
12094	<link to="IHost::USBDeviceFilters"/>.
12095
12096	Using filters of this type, the host computer determines the initial
12097	state of the USB device after it is physically attached to the
12098	host's USB controller.
12099
12100	<note>
12101	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12102	filters, because it makes sense only for
12103	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12104	</note>
12105
12106	<see>IHost::USBDeviceFilters</see>
12107	</desc>
12108
12109	<attribute name="action" type="USBDeviceFilterAction">
12110	<desc>
12111	Action performed by the host when an attached USB device
12112	matches this filter.
12113	</desc>
12114	</attribute>
12115
12116	</interface>
12117
12118	<!--
12119	// IAudioAdapter
12120	/////////////////////////////////////////////////////////////////////////
12121	-->
12122
12123	<enum
12124	name="AudioDriverType"
12125	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12126	>
12127	<desc>
12128	Host audio driver type.
12129	</desc>
12130
12131	<const name="Null" value="0">
12132	<desc>Null value, also means "dummy audio driver".</desc>
12133	</const>
12134	<const name="WinMM" value="1">
12135	<desc>Windows multimedia (Windows hosts only).</desc>
12136	</const>
12137	<const name="OSS" value="2">
12138	<desc>Open Sound System (Linux hosts only).</desc>
12139	</const>
12140	<const name="ALSA" value="3">
12141	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12142	</const>
12143	<const name="DirectSound" value="4">
12144	<desc>DirectSound (Windows hosts only).</desc>
12145	</const>
12146	<const name="CoreAudio" value="5">
12147	<desc>CoreAudio (Mac hosts only).</desc>
12148	</const>
12149	<const name="MMPM" value="6">
12150	<desc>Reserved for historical reasons.</desc>
12151	</const>
12152	<const name="Pulse" value="7">
12153	<desc>PulseAudio (Linux hosts only).</desc>
12154	</const>
12155	<const name="SolAudio" value="8">
12156	<desc>Solaris audio (Solaris hosts only).</desc>
12157	</const>
12158	</enum>
12159
12160	<enum
12161	name="AudioControllerType"
12162	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12163	>
12164	<desc>
12165	Virtual audio controller type.
12166	</desc>
12167
12168	<const name="AC97" value="0"/>
12169	<const name="SB16" value="1"/>
12170	<const name="HDA" value="2"/>
12171	</enum>
12172
12173	<interface
12174	name="IAudioAdapter" extends="$unknown"
12175	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12176	wsmap="managed"
12177	>
12178	<desc>
12179	The IAudioAdapter interface represents the virtual audio adapter of
12180	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12181	</desc>
12182	<attribute name="enabled" type="boolean">
12183	<desc>
12184	Flag whether the audio adapter is present in the
12185	guest system. If disabled, the virtual guest hardware will
12186	not contain any audio adapter. Can only be changed when
12187	the VM is not running.
12188	</desc>
12189	</attribute>
12190	<attribute name="audioController" type="AudioControllerType">
12191	<desc>
12192	The audio hardware we emulate.
12193	</desc>
12194	</attribute>
12195	<attribute name="audioDriver" type="AudioDriverType">
12196	<desc>
12197	Audio driver the adapter is connected to. This setting
12198	can only be changed when the VM is not running.
12199	</desc>
12200	</attribute>
12201	</interface>
12202
12203	<!--
12204	// IVRDPServer
12205	/////////////////////////////////////////////////////////////////////////
12206	-->
12207
12208	<enum
12209	name="VRDPAuthType"
12210	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12211	>
12212	<desc>
12213	VRDP authentication type.
12214	</desc>
12215
12216	<const name="Null" value="0">
12217	<desc>Null value, also means "no authentication".</desc>
12218	</const>
12219	<const name="External" value="1"/>
12220	<const name="Guest" value="2"/>
12221	</enum>
12222
12223	<interface
12224	name="IVRDPServer" extends="$unknown"
12225	uuid="7aeeb530-0b08-41fe-835d-9be9ec1dbe5c"
12226	wsmap="managed"
12227	>
12228	<attribute name="enabled" type="boolean">
12229	<desc>VRDP server status.</desc>
12230	</attribute>
12231
12232	<attribute name="ports" type="wstring">
12233	<desc>
12234	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12235	<note>
12236	This is a string of comma separated TCP port numbers or port number ranges.
12237	Example <tt>5000,5010-5012,5015</tt>
12238	</note>
12239	</desc>
12240	</attribute>
12241
12242	<attribute name="netAddress" type="wstring">
12243	<desc>VRDP server address.</desc>
12244	</attribute>
12245
12246	<attribute name="authType" type="VRDPAuthType">
12247	<desc>VRDP authentication method.</desc>
12248	</attribute>
12249
12250	<attribute name="authTimeout" type="unsigned long">
12251	<desc>Timeout for guest authentication. Milliseconds.</desc>
12252	</attribute>
12253
12254	<attribute name="allowMultiConnection" type="boolean">
12255	<desc>
12256	Flag whether multiple simultaneous connections to the VM are permitted.
12257	Note that this will be replaced by a more powerful mechanism in the future.
12258	</desc>
12259	</attribute>
12260
12261	<attribute name="reuseSingleConnection" type="boolean">
12262	<desc>
12263	Flag whether the existing connection must be dropped and a new connection
12264	must be established by the VRDP server, when a new client connects in single
12265	connection mode.
12266	</desc>
12267	</attribute>
12268
12269	<attribute name="videoChannel" type="boolean">
12270	<desc>
12271	Flag whether RDP video channel is supported.
12272	</desc>
12273	</attribute>
12274
12275	<attribute name="videoChannelQuality" type="unsigned long">
12276	<desc>
12277	Image quality in percents.
12278	</desc>
12279	</attribute>
12280
12281	</interface>
12282
12283
12284	<!--
12285	// ISharedFolder
12286	/////////////////////////////////////////////////////////////////////////
12287	-->
12288
12289	<interface
12290	name="ISharedFolder" extends="$unknown"
12291	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12292	wsmap="struct"
12293	>
12294	<desc>
12295	The ISharedFolder interface represents a folder in the host computer's
12296	file system accessible from the guest OS running inside a virtual
12297	machine using an associated logical name.
12298
12299	There are three types of shared folders:
12300	<ul>
12301	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12302	folders available to all virtual machines.</li>
12303	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12304	VM-specific shared folders available to the given virtual machine at
12305	startup.</li>
12306	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12307	VM-specific shared folders created in the session context (for
12308	example, when the virtual machine is running) and automatically
12309	discarded when the session is closed (the VM is powered off).</li>
12310	</ul>
12311
12312	Logical names of shared folders must be unique within the given scope
12313	(global, permanent or transient). However, they do not need to be unique
12314	across scopes. In this case, the definition of the shared folder in a
12315	more specific scope takes precedence over definitions in all other
12316	scopes. The order of precedence is (more specific to more general):
12317	<ol>
12318	<li>Transient definitions</li>
12319	<li>Permanent definitions</li>
12320	<li>Global definitions</li>
12321	</ol>
12322
12323	For example, if MyMachine has a shared folder named
12324	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12325	transient shared folder named <tt>C_DRIVE</tt> (that points
12326	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12327	of <tt>C_DRIVE</tt> in the guest OS so
12328	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12329	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12330	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12331	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12332	to <tt>C:\\</tt> if it still exists.
12333
12334	Note that permanent and transient shared folders of different machines
12335	are in different name spaces, so they don't overlap and don't need to
12336	have unique logical names.
12337
12338	<note>
12339	Global shared folders are not implemented in the current version of the
12340	product.
12341	</note>
12342	</desc>
12343
12344	<attribute name="name" type="wstring" readonly="yes">
12345	<desc>Logical name of the shared folder.</desc>
12346	</attribute>
12347
12348	<attribute name="hostPath" type="wstring" readonly="yes">
12349	<desc>Full path to the shared folder in the host file system.</desc>
12350	</attribute>
12351
12352	<attribute name="accessible" type="boolean" readonly="yes">
12353	<desc>
12354	Whether the folder defined by the host path is currently
12355	accessible or not.
12356	For example, the folder can be unaccessible if it is placed
12357	on the network share that is not available by the time
12358	this property is read.
12359	</desc>
12360	</attribute>
12361
12362	<attribute name="writable" type="boolean" readonly="yes">
12363	<desc>
12364	Whether the folder defined by the host path is writable or
12365	not.
12366	</desc>
12367	</attribute>
12368
12369	<attribute name="autoMount" type="boolean" readonly="yes">
12370	<desc>
12371	Whether the folder gets automatically mounted by the guest or not.
12372	</desc>
12373	</attribute>
12374
12375	<attribute name="lastAccessError" type="wstring" readonly="yes">
12376	<desc>
12377	Text message that represents the result of the last accessibility
12378	check.
12379
12380	Accessibility checks are performed each time the <link to="#accessible"/>
12381	attribute is read. An empty string is returned if the last
12382	accessibility check was successful. A non-empty string indicates a
12383	failure and should normally describe a reason of the failure (for
12384	example, a file read error).
12385	</desc>
12386	</attribute>
12387
12388	</interface>
12389
12390	<!--
12391	// ISession
12392	/////////////////////////////////////////////////////////////////////////
12393	-->
12394
12395	<interface
12396	name="IInternalSessionControl" extends="$unknown"
12397	uuid="ab161f72-e4b3-44e6-a919-2256474bda66"
12398	internal="yes"
12399	wsmap="suppress"
12400	>
12401	<method name="getPID">
12402	<desc>PID of the process that has created this Session object.
12403	</desc>
12404	<param name="pid" type="unsigned long" dir="return"/>
12405	</method>
12406
12407	<method name="getRemoteConsole">
12408	<desc>
12409	Returns the console object suitable for remote control.
12410
12411	<result name="VBOX_E_INVALID_VM_STATE">
12412	Session state prevents operation.
12413	</result>
12414	<result name="VBOX_E_INVALID_OBJECT_STATE">
12415	Session type prevents operation.
12416	</result>
12417
12418	</desc>
12419	<param name="console" type="IConsole" dir="return"/>
12420	</method>
12421
12422	<method name="assignMachine">
12423	<desc>
12424	Assigns the machine object associated with this direct-type
12425	session or informs the session that it will be a remote one
12426	(if @a machine == @c null).
12427
12428	<result name="VBOX_E_INVALID_VM_STATE">
12429	Session state prevents operation.
12430	</result>
12431	<result name="VBOX_E_INVALID_OBJECT_STATE">
12432	Session type prevents operation.
12433	</result>
12434
12435	</desc>
12436	<param name="machine" type="IMachine" dir="in"/>
12437	</method>
12438
12439	<method name="assignRemoteMachine">
12440	<desc>
12441	Assigns the machine and the (remote) console object associated with
12442	this remote-type session.
12443
12444	<result name="VBOX_E_INVALID_VM_STATE">
12445	Session state prevents operation.
12446	</result>
12447
12448	</desc>
12449	<param name="machine" type="IMachine" dir="in"/>
12450	<param name="console" type="IConsole" dir="in"/>
12451	</method>
12452
12453	<method name="updateMachineState">
12454	<desc>
12455	Updates the machine state in the VM process.
12456	Must be called only in certain cases
12457	(see the method implementation).
12458
12459	<result name="VBOX_E_INVALID_VM_STATE">
12460	Session state prevents operation.
12461	</result>
12462	<result name="VBOX_E_INVALID_OBJECT_STATE">
12463	Session type prevents operation.
12464	</result>
12465
12466	</desc>
12467	<param name="aMachineState" type="MachineState" dir="in"/>
12468	</method>
12469
12470	<method name="uninitialize">
12471	<desc>
12472	Uninitializes (closes) this session. Used by VirtualBox to close
12473	the corresponding remote session when the direct session dies
12474	or gets closed.
12475
12476	<result name="VBOX_E_INVALID_VM_STATE">
12477	Session state prevents operation.
12478	</result>
12479
12480	</desc>
12481	</method>
12482
12483	<method name="onNetworkAdapterChange">
12484	<desc>
12485	Triggered when settings of a network adapter of the
12486	associated virtual machine have changed.
12487
12488	<result name="VBOX_E_INVALID_VM_STATE">
12489	Session state prevents operation.
12490	</result>
12491	<result name="VBOX_E_INVALID_OBJECT_STATE">
12492	Session type prevents operation.
12493	</result>
12494
12495	</desc>
12496	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12497	<param name="changeAdapter" type="boolean" dir="in"/>
12498	</method>
12499
12500	<method name="onSerialPortChange">
12501	<desc>
12502	Triggered when settings of a serial port of the
12503	associated virtual machine have changed.
12504
12505	<result name="VBOX_E_INVALID_VM_STATE">
12506	Session state prevents operation.
12507	</result>
12508	<result name="VBOX_E_INVALID_OBJECT_STATE">
12509	Session type prevents operation.
12510	</result>
12511
12512	</desc>
12513	<param name="serialPort" type="ISerialPort" dir="in"/>
12514	</method>
12515
12516	<method name="onParallelPortChange">
12517	<desc>
12518	Triggered when settings of a parallel port of the
12519	associated virtual machine have changed.
12520
12521	<result name="VBOX_E_INVALID_VM_STATE">
12522	Session state prevents operation.
12523	</result>
12524	<result name="VBOX_E_INVALID_OBJECT_STATE">
12525	Session type prevents operation.
12526	</result>
12527
12528	</desc>
12529	<param name="parallelPort" type="IParallelPort" dir="in"/>
12530	</method>
12531
12532	<method name="onStorageControllerChange">
12533	<desc>
12534	Triggered when settings of a storage controller of the
12535	associated virtual machine have changed.
12536
12537	<result name="VBOX_E_INVALID_VM_STATE">
12538	Session state prevents operation.
12539	</result>
12540	<result name="VBOX_E_INVALID_OBJECT_STATE">
12541	Session type prevents operation.
12542	</result>
12543
12544	</desc>
12545	</method>
12546
12547	<method name="onMediumChange">
12548	<desc>
12549	Triggered when attached media of the
12550	associated virtual machine have changed.
12551
12552	<result name="VBOX_E_INVALID_VM_STATE">
12553	Session state prevents operation.
12554	</result>
12555	<result name="VBOX_E_INVALID_OBJECT_STATE">
12556	Session type prevents operation.
12557	</result>
12558
12559	</desc>
12560
12561	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12562	<param name="force" type="boolean" dir="in"/>
12563	</method>
12564
12565	<method name="onCPUChange">
12566	<desc>
12567	Notification when a CPU changes.
12568	</desc>
12569	<param name="cpu" type="unsigned long" dir="in">
12570	<desc>The CPU which changed</desc>
12571	</param>
12572	<param name="add" type="boolean" dir="in">
12573	<desc>Flag whether the CPU was added or removed</desc>
12574	</param>
12575	</method>
12576
12577	<method name="onVRDPServerChange">
12578	<desc>
12579	Triggered when settings of the VRDP server object of the
12580	associated virtual machine have changed.
12581
12582	<result name="VBOX_E_INVALID_VM_STATE">
12583	Session state prevents operation.
12584	</result>
12585	<result name="VBOX_E_INVALID_OBJECT_STATE">
12586	Session type prevents operation.
12587	</result>
12588
12589	</desc>
12590	<param name="restart" type="boolean" dir="in">
12591	<desc>Flag whether the server must be restarted</desc>
12592	</param>
12593	</method>
12594
12595	<method name="onUSBControllerChange">
12596	<desc>
12597	Triggered when settings of the USB controller object of the
12598	associated virtual machine have changed.
12599
12600	<result name="VBOX_E_INVALID_VM_STATE">
12601	Session state prevents operation.
12602	</result>
12603	<result name="VBOX_E_INVALID_OBJECT_STATE">
12604	Session type prevents operation.
12605	</result>
12606
12607	</desc>
12608	</method>
12609
12610	<method name="onSharedFolderChange">
12611	<desc>
12612	Triggered when a permanent (global or machine) shared folder has been
12613	created or removed.
12614	<note>
12615	We don't pass shared folder parameters in this notification because
12616	the order in which parallel notifications are delivered is not defined,
12617	therefore it could happen that these parameters were outdated by the
12618	time of processing this notification.
12619	</note>
12620
12621	<result name="VBOX_E_INVALID_VM_STATE">
12622	Session state prevents operation.
12623	</result>
12624	<result name="VBOX_E_INVALID_OBJECT_STATE">
12625	Session type prevents operation.
12626	</result>
12627
12628	</desc>
12629	<param name="global" type="boolean" dir="in"/>
12630	</method>
12631
12632	<method name="onUSBDeviceAttach">
12633	<desc>
12634	Triggered when a request to capture a USB device (as a result
12635	of matched USB filters or direct call to
12636	<link to="IConsole::attachUSBDevice"/>) has completed.
12637	A @c null @a error object means success, otherwise it
12638	describes a failure.
12639
12640	<result name="VBOX_E_INVALID_VM_STATE">
12641	Session state prevents operation.
12642	</result>
12643	<result name="VBOX_E_INVALID_OBJECT_STATE">
12644	Session type prevents operation.
12645	</result>
12646
12647	</desc>
12648	<param name="device" type="IUSBDevice" dir="in"/>
12649	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12650	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12651	</method>
12652
12653	<method name="onUSBDeviceDetach">
12654	<desc>
12655	Triggered when a request to release the USB device (as a result
12656	of machine termination or direct call to
12657	<link to="IConsole::detachUSBDevice"/>) has completed.
12658	A @c null @a error object means success, otherwise it
12659	describes a failure.
12660
12661	<result name="VBOX_E_INVALID_VM_STATE">
12662	Session state prevents operation.
12663	</result>
12664	<result name="VBOX_E_INVALID_OBJECT_STATE">
12665	Session type prevents operation.
12666	</result>
12667
12668	</desc>
12669	<param name="id" type="uuid" mod="string" dir="in"/>
12670	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12671	</method>
12672
12673	<method name="onShowWindow">
12674	<desc>
12675	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12676	<link to="IMachine::showConsoleWindow"/> in order to notify
12677	console listeners
12678	<link to="ICanShowWindowEvent"/>
12679	and <link to="IShowWindowEvent"/>.
12680
12681	<result name="VBOX_E_INVALID_OBJECT_STATE">
12682	Session type prevents operation.
12683	</result>
12684
12685	</desc>
12686	<param name="check" type="boolean" dir="in"/>
12687	<param name="canShow" type="boolean" dir="out"/>
12688	<param name="winId" type="unsigned long long" dir="out"/>
12689	</method>
12690
12691	<method name="accessGuestProperty">
12692	<desc>
12693	Called by <link to="IMachine::getGuestProperty"/> and by
12694	<link to="IMachine::setGuestProperty"/> in order to read and
12695	modify guest properties.
12696
12697	<result name="VBOX_E_INVALID_VM_STATE">
12698	Machine session is not open.
12699	</result>
12700	<result name="VBOX_E_INVALID_OBJECT_STATE">
12701	Session type is not direct.
12702	</result>
12703
12704	</desc>
12705	<param name="name" type="wstring" dir="in"/>
12706	<param name="value" type="wstring" dir="in"/>
12707	<param name="flags" type="wstring" dir="in"/>
12708	<param name="isSetter" type="boolean" dir="in"/>
12709	<param name="retValue" type="wstring" dir="out"/>
12710	<param name="retTimestamp" type="unsigned long long" dir="out"/>
12711	<param name="retFlags" type="wstring" dir="out"/>
12712	</method>
12713
12714	<method name="enumerateGuestProperties">
12715	<desc>
12716	Return a list of the guest properties matching a set of patterns along
12717	with their values, time stamps and flags.
12718
12719	<result name="VBOX_E_INVALID_VM_STATE">
12720	Machine session is not open.
12721	</result>
12722	<result name="VBOX_E_INVALID_OBJECT_STATE">
12723	Session type is not direct.
12724	</result>
12725
12726	</desc>
12727	<param name="patterns" type="wstring" dir="in">
12728	<desc>
12729	The patterns to match the properties against as a comma-separated
12730	string. If this is empty, all properties currently set will be
12731	returned.
12732	</desc>
12733	</param>
12734	<param name="key" type="wstring" dir="out" safearray="yes">
12735	<desc>
12736	The key names of the properties returned.
12737	</desc>
12738	</param>
12739	<param name="value" type="wstring" dir="out" safearray="yes">
12740	<desc>
12741	The values of the properties returned. The array entries match the
12742	corresponding entries in the @a key array.
12743	</desc>
12744	</param>
12745	<param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
12746	<desc>
12747	The time stamps of the properties returned. The array entries match
12748	the corresponding entries in the @a key array.
12749	</desc>
12750	</param>
12751	<param name="flags" type="wstring" dir="out" safearray="yes">
12752	<desc>
12753	The flags of the properties returned. The array entries match the
12754	corresponding entries in the @a key array.
12755	</desc>
12756	</param>
12757	</method>
12758
12759	<method name="onlineMergeMedium">
12760	<desc>
12761	Triggers online merging of a hard disk. Used internally when deleting
12762	a snapshot while a VM referring to the same hard disk chain is running.
12763
12764	<result name="VBOX_E_INVALID_VM_STATE">
12765	Machine session is not open.
12766	</result>
12767	<result name="VBOX_E_INVALID_OBJECT_STATE">
12768	Session type is not direct.
12769	</result>
12770
12771	</desc>
12772	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
12773	<desc>The medium attachment to identify the medium chain.</desc>
12774	</param>
12775	<param name="sourceIdx" type="unsigned long" dir="in">
12776	<desc>The index of the source image in the chain.
12777	Redundant, but drastically reduces IPC.</desc>
12778	</param>
12779	<param name="targetIdx" type="unsigned long" dir="in">
12780	<desc>The index of the target image in the chain.
12781	Redundant, but drastically reduces IPC.</desc>
12782	</param>
12783	<param name="source" type="IMedium" dir="in">
12784	<desc>Merge source medium.</desc>
12785	</param>
12786	<param name="target" type="IMedium" dir="in">
12787	<desc>Merge target medium.</desc>
12788	</param>
12789	<param name="mergeForward" type="boolean" dir="in">
12790	<desc>Merge direction.</desc>
12791	</param>
12792	<param name="parentForTarget" type="IMedium" dir="in">
12793	<desc>For forward merges: new parent for target medium.</desc>
12794	</param>
12795	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
12796	<desc>For backward merges: list of media which need their parent UUID
12797	updated.</desc>
12798	</param>
12799	<param name="progress" type="IProgress" dir="in">
12800	<desc>
12801	Progress object for this operation.
12802	</desc>
12803	</param>
12804	</method>
12805
12806	</interface>
12807
12808	<interface
12809	name="ISession" extends="$unknown"
12810	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12811	wsmap="managed"
12812	>
12813	<desc>
12814	The ISession interface represents a client process and allows for locking
12815	virtual machines (represented by IMachine objects) to prevent conflicting
12816	changes to the machine.
12817
12818	Any caller wishing to manipulate a virtual machine needs to create a session
12819	object first, which lives in its own process space. Such session objects are
12820	then associated with <link to="IMachine" /> objects living in the VirtualBox
12821	server process to coordinate such changes.
12822
12823	There are two typical scenarios in which sessions are used:
12824
12825	<ul>
12826	<li>To alter machine settings or control a running virtual machine, one
12827	needs to lock a machine for a given session (client process) by calling
12828	<link to="IMachine::lockMachine"/>.
12829
12830	Whereas multiple sessions may control a running virtual machine, only
12831	one process can obtain a write lock on the machine to prevent conflicting
12832	changes. A write lock is also needed if a process wants to actually run a
12833	virtual machine in its own context, such as the VirtualBox GUI or
12834	VBoxHeadless front-ends. They must also lock a machine for their own
12835	sessions before they are allowed to power up the virtual machine.
12836
12837	As a result, no machine settings can be altered while another process is
12838	already using it, either because that process is modifying machine settings
12839	or because the machine is running.
12840	</li>
12841	<li>
12842	To start a VM using one of the existing VirtualBox front-ends (e.g. the
12843	VirtualBox GUI or VBoxHeadless), one would use
12844	<link to="IMachine::launchVMProcess"/>, which also takes a session object
12845	as its first parameter. This session then identifies the caller and lets the
12846	caller control the started machine (for example, pause machine execution or
12847	power it down) as well as be notified about machine execution state changes.
12848	</li>
12849	</ul>
12850
12851	How sessions objects are created in a client process depends on whether you use
12852	the Main API via COM or via the webservice:
12853
12854	<ul>
12855	<li>When using the COM API directly, an object of the Session class from the
12856	VirtualBox type library needs to be created. In regular COM C++ client code,
12857	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12858	This object will then act as a local session object in further calls to open
12859	a session.
12860	</li>
12861
12862	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12863	a session object automatically whenever <link to="IWebsessionManager::logon" />
12864	is called. A managed object reference to that session object can be retrieved by
12865	calling <link to="IWebsessionManager::getSessionObject" />.
12866	</li>
12867	</ul>
12868	</desc>
12869
12870	<attribute name="state" type="SessionState" readonly="yes">
12871	<desc>Current state of this session.</desc>
12872	</attribute>
12873
12874	<attribute name="type" type="SessionType" readonly="yes">
12875	<desc>
12876	Type of this session. The value of this attribute is valid only
12877	if the session currently has a machine locked (i.e. its
12878	<link to="#state" /> is Locked), otherwise an error will be returned.
12879	</desc>
12880	</attribute>
12881
12882	<attribute name="machine" type="IMachine" readonly="yes">
12883	<desc>Machine object associated with this session.</desc>
12884	</attribute>
12885
12886	<attribute name="console" type="IConsole" readonly="yes">
12887	<desc>Console object associated with this session.</desc>
12888	</attribute>
12889
12890	<method name="unlockMachine">
12891	<desc>
12892	Unlocks a machine that was previously locked for the current session.
12893
12894	Calling this method is required every time a machine has been locked
12895	for a particular session using the <link to="IMachine::launchVMProcess" />
12896	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
12897	the machine will be set to <link to="MachineState_Aborted" /> on the
12898	server, and changes made to the machine settings will be lost.
12899
12900	Generally, it is recommended to unlock all machines explicitly
12901	before terminating the application (regardless of the reason for
12902	the termination).
12903
12904	<note>
12905	Do not expect the session state (<link to="ISession::state" />
12906	to return to "Unlocked" immediately after you invoke this method,
12907	particularly if you have started a new VM process. The session
12908	state will automatically return to "Unlocked" once the VM is no
12909	longer executing, which can of course take a very long time.
12910	</note>
12911
12912	<result name="E_UNEXPECTED">
12913	Session is not locked.
12914	</result>
12915
12916	</desc>
12917	</method>
12918
12919	</interface>
12920
12921	<!--
12922	// IStorageController
12923	/////////////////////////////////////////////////////////////////////////
12924	-->
12925
12926	<enum
12927	name="StorageBus"
12928	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
12929	>
12930	<desc>
12931	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
12932	see <link to="IStorageController::bus" />.
12933	</desc>
12934	<const name="Null" value="0">
12935	<desc>@c null value. Never used by the API.</desc>
12936	</const>
12937	<const name="IDE" value="1"/>
12938	<const name="SATA" value="2"/>
12939	<const name="SCSI" value="3"/>
12940	<const name="Floppy" value="4"/>
12941	<const name="SAS" value="5"/>
12942	</enum>
12943
12944	<enum
12945	name="StorageControllerType"
12946	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
12947	>
12948	<desc>
12949	The exact variant of storage controller hardware presented
12950	to the guest; see <link to="IStorageController::controllerType" />.
12951	</desc>
12952
12953	<const name="Null" value="0">
12954	<desc>@c null value. Never used by the API.</desc>
12955	</const>
12956	<const name="LsiLogic" value="1">
12957	<desc>A SCSI controller of the LsiLogic variant.</desc>
12958	</const>
12959	<const name="BusLogic" value="2">
12960	<desc>A SCSI controller of the BusLogic variant.</desc>
12961	</const>
12962	<const name="IntelAhci" value="3">
12963	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
12964	</const>
12965	<const name="PIIX3" value="4">
12966	<desc>An IDE controller of the PIIX3 variant.</desc>
12967	</const>
12968	<const name="PIIX4" value="5">
12969	<desc>An IDE controller of the PIIX4 variant.</desc>
12970	</const>
12971	<const name="ICH6" value="6">
12972	<desc>An IDE controller of the ICH6 variant.</desc>
12973	</const>
12974	<const name="I82078" value="7">
12975	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
12976	</const>
12977	<const name="LsiLogicSas" value="8">
12978	<desc>A variant of the LsiLogic controller using SAS.</desc>
12979	</const>
12980	</enum>
12981
12982	<interface
12983	name="IStorageController" extends="$unknown"
12984	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
12985	wsmap="managed"
12986	>
12987	<desc>
12988	Represents a storage controller that is attached to a virtual machine
12989	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
12990	attached to storage controllers in a real computer, virtual drives
12991	(represented by <link to="IMediumAttachment" />) are attached to virtual
12992	storage controllers, represented by this interface.
12993
12994	As opposed to physical hardware, VirtualBox has a very generic concept
12995	of a storage controller, and for purposes of the Main API, all virtual
12996	storage is attached to virtual machines via instances of this interface.
12997	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
12998	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
12999	is used, certain sub-types may be available and can be selected in
13000	<link to="#controllerType" />.
13001
13002	Depending on these settings, the guest operating system might see
13003	significantly different virtual hardware.
13004	</desc>
13005
13006	<attribute name="name" type="wstring" readonly="yes">
13007	<desc>
13008	Name of the storage controller, as originally specified with
13009	<link to="IMachine::addStorageController" />. This then uniquely
13010	identifies this controller with other method calls such as
13011	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13012	</desc>
13013	</attribute>
13014
13015	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13016	<desc>
13017	Maximum number of devices which can be attached to one port.
13018	</desc>
13019	</attribute>
13020
13021	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13022	<desc>
13023	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13024	</desc>
13025	</attribute>
13026
13027	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13028	<desc>
13029	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13030	</desc>
13031	</attribute>
13032
13033	<attribute name="instance" type="unsigned long">
13034	<desc>
13035	The instance number of the device in the running VM.
13036	</desc>
13037	</attribute>
13038
13039	<attribute name="portCount" type="unsigned long">
13040	<desc>
13041	The number of currently usable ports on the controller.
13042	The minimum and maximum number of ports for one controller are
13043	stored in <link to="IStorageController::minPortCount"/>
13044	and <link to="IStorageController::maxPortCount"/>.
13045	</desc>
13046	</attribute>
13047
13048	<attribute name="bus" type="StorageBus" readonly="yes">
13049	<desc>
13050	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13051	</desc>
13052	</attribute>
13053
13054	<attribute name="controllerType" type="StorageControllerType">
13055	<desc>
13056	The exact variant of storage controller hardware presented
13057	to the guest.
13058	Depending on this value, VirtualBox will provide a different
13059	virtual storage controller hardware to the guest.
13060	For SATA, SAS and floppy controllers, only one variant is
13061	available, but for IDE and SCSI, there are several.
13062
13063	For SCSI controllers, the default type is LsiLogic.
13064	</desc>
13065	</attribute>
13066
13067	<attribute name="useHostIOCache" type="boolean">
13068	<desc>
13069	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13070	caches and use synchronous file APIs on the host. This was the only option in the API before
13071	VirtualBox 3.2 and is still the default for IDE controllers.
13072
13073	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13074	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13075	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13076	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13077	virtual machines are running at the same time to prevent I/O cache related hangs.
13078	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13079	</desc>
13080	</attribute>
13081
13082	<method name="getIDEEmulationPort">
13083	<desc>
13084	Gets the corresponding port number which is emulated as an IDE device.
13085	Works only with SATA controllers.
13086
13087	<result name="E_INVALIDARG">
13088	The @a devicePosition is not in the range 0 to 3.
13089	</result>
13090	<result name="E_NOTIMPL">
13091	The storage controller type is not SATAIntelAhci.
13092	</result>
13093
13094	</desc>
13095	<param name="devicePosition" type="long" dir="in"/>
13096	<param name="portNumber" type="long" dir="return"/>
13097	</method>
13098
13099	<method name="setIDEEmulationPort">
13100	<desc>
13101	Sets the port number which is emulated as an IDE device.
13102	Works only with SATA controllers.
13103
13104	<result name="E_INVALIDARG">
13105	The @a devicePosition is not in the range 0 to 3 or the
13106	@a portNumber is not in the range 0 to 29.
13107	</result>
13108	<result name="E_NOTIMPL">
13109	The storage controller type is not SATAIntelAhci.
13110	</result>
13111
13112	</desc>
13113	<param name="devicePosition" type="long" dir="in"/>
13114	<param name="portNumber" type="long" dir="in"/>
13115	</method>
13116
13117	</interface>
13118
13119	<if target="wsdl">
13120
13121	<!--
13122	// IManagedObjectRef
13123	/////////////////////////////////////////////////////////////////////////
13124	-->
13125
13126	<interface
13127	name="IManagedObjectRef" extends="$unknown"
13128	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13129	internal="yes"
13130	wsmap="managed"
13131	wscpp="hardcoded"
13132	>
13133	<desc>
13134	Managed object reference.
13135
13136	Only within the webservice, a managed object reference (which is really
13137	an opaque number) allows a webservice client to address an object
13138	that lives in the address space of the webservice server.
13139
13140	Behind each managed object reference, there is a COM object that lives
13141	in the webservice server's address space. The COM object is not freed
13142	until the managed object reference is released, either by an explicit
13143	call to <link to="IManagedObjectRef::release" /> or by logging off from
13144	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13145	all objects created during the webservice session.
13146
13147	Whenever a method call of the VirtualBox API returns a COM object, the
13148	webservice representation of that method will instead return a
13149	managed object reference, which can then be used to invoke methods
13150	on that object.
13151	</desc>
13152
13153	<method name="getInterfaceName">
13154	<desc>
13155	Returns the name of the interface that this managed object represents,
13156	for example, "IMachine", as a string.
13157	</desc>
13158	<param name="return" type="wstring" dir="return"/>
13159	</method>
13160
13161	<method name="release">
13162	<desc>
13163	Releases this managed object reference and frees the resources that
13164	were allocated for it in the webservice server process. After calling
13165	this method, the identifier of the reference can no longer be used.
13166	</desc>
13167	</method>
13168
13169	</interface>
13170
13171	<!--
13172	// IWebsessionManager
13173	/////////////////////////////////////////////////////////////////////////
13174	-->
13175
13176	<interface
13177	name="IWebsessionManager" extends="$unknown"
13178	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13179	internal="yes"
13180	wsmap="global"
13181	wscpp="hardcoded"
13182	>
13183	<desc>
13184	Websession manager. This provides essential services
13185	to webservice clients.
13186	</desc>
13187	<method name="logon">
13188	<desc>
13189	Logs a new client onto the webservice and returns a managed object reference to
13190	the IVirtualBox instance, which the client can then use as a basis to further
13191	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13192	interface, in one way or the other.
13193	</desc>
13194	<param name="username" type="wstring" dir="in"/>
13195	<param name="password" type="wstring" dir="in"/>
13196	<param name="return" type="IVirtualBox" dir="return"/>
13197	</method>
13198
13199	<method name="getSessionObject">
13200	<desc>
13201	Returns a managed object reference to the internal ISession object that was created
13202	for this web service session when the client logged on.
13203
13204	<see>ISession</see>
13205	</desc>
13206	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13207	<param name="return" type="ISession" dir="return"/>
13208	</method>
13209
13210	<method name="logoff">
13211	<desc>
13212	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13213	and destroys all resources associated with the session (most importantly, all
13214	managed objects created in the server while the session was active).
13215	</desc>
13216	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13217	</method>
13218
13219	</interface>
13220
13221	</if>
13222
13223	<!--
13224	// IPerformanceCollector & friends
13225	/////////////////////////////////////////////////////////////////////////
13226	-->
13227
13228	<interface
13229	name="IPerformanceMetric" extends="$unknown"
13230	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13231	>
13232	<desc>
13233	The IPerformanceMetric interface represents parameters of the given
13234	performance metric.
13235	</desc>
13236
13237	<attribute name="metricName" type="wstring" readonly="yes">
13238	<desc>
13239	Name of the metric.
13240	</desc>
13241	</attribute>
13242
13243	<attribute name="object" type="$unknown" readonly="yes">
13244	<desc>
13245	Object this metric belongs to.
13246	</desc>
13247	</attribute>
13248
13249	<attribute name="description" type="wstring" readonly="yes">
13250	<desc>
13251	Textual description of the metric.
13252	</desc>
13253	</attribute>
13254
13255	<attribute name="period" type="unsigned long" readonly="yes">
13256	<desc>
13257	Time interval between samples, measured in seconds.
13258	</desc>
13259	</attribute>
13260
13261	<attribute name="count" type="unsigned long" readonly="yes">
13262	<desc>
13263	Number of recent samples retained by the performance collector for this
13264	metric.
13265
13266	When the collected sample count exceeds this number, older samples
13267	are discarded.
13268	</desc>
13269	</attribute>
13270
13271	<attribute name="unit" type="wstring" readonly="yes">
13272	<desc>
13273	Unit of measurement.
13274	</desc>
13275	</attribute>
13276
13277	<attribute name="minimumValue" type="long" readonly="yes">
13278	<desc>
13279	Minimum possible value of this metric.
13280	</desc>
13281	</attribute>
13282
13283	<attribute name="maximumValue" type="long" readonly="yes">
13284	<desc>
13285	Maximum possible value of this metric.
13286	</desc>
13287	</attribute>
13288	</interface>
13289
13290	<interface
13291	name="IPerformanceCollector" extends="$unknown"
13292	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13293	wsmap="managed"
13294	>
13295	<desc>
13296	The IPerformanceCollector interface represents a service that collects
13297	and stores performance metrics data.
13298
13299	Performance metrics are associated with objects of interfaces like IHost
13300	and IMachine. Each object has a distinct set of performance metrics. The
13301	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13302
13303	Metric data is collected at the specified intervals and is retained
13304	internally. The interval and the number of retained samples can be set
13305	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13306	and collection settings are not persistent, they are discarded as soon as
13307	VBoxSVC process terminates. Moreover, metric settings and data associated
13308	with a particular VM only exist while VM is running. They disappear as
13309	soon as VM shuts down. It is not possible to set up metrics for machines
13310	that are powered off. One needs to start VM first, then set up metric
13311	collection parameters.
13312
13313	Metrics are organized hierarchically, with each level separated by a
13314	slash (/) character. Generally, the scheme for metric names is like this:
13315
13316	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13317
13318	"Category/Metric" together form the base metric name. A base metric is
13319	the smallest unit for which a sampling interval and the number of
13320	retained samples can be set. Only base metrics can be enabled and
13321	disabled. All sub-metrics are collected when their base metric is
13322	collected. Collected values for any set of sub-metrics can be queried
13323	with <link to="IPerformanceCollector::queryMetricsData" />.
13324
13325	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13326	category, "Load" metric, "User" submetric, "average" aggregate. An
13327	aggregate function is computed over all retained data. Valid aggregate
13328	functions are:
13329
13330	<ul>
13331	<li>avg -- average</li>
13332	<li>min -- minimum</li>
13333	<li>max -- maximum</li>
13334	</ul>
13335
13336	When setting up metric parameters, querying metric data, enabling or
13337	disabling metrics wildcards can be used in metric names to specify a
13338	subset of metrics. For example, to select all CPU-related metrics
13339	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13340	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13341
13342	The valid names for base metrics are:
13343
13344	<ul>
13345	<li>CPU/Load</li>
13346	<li>CPU/MHz</li>
13347	<li>RAM/Usage</li>
13348	</ul>
13349
13350	The general sequence for collecting and retrieving the metrics is:
13351	<ul>
13352	<li>
13353	Obtain an instance of IPerformanceCollector with
13354	<link to="IVirtualBox::performanceCollector" />
13355	</li>
13356	<li>
13357	Allocate and populate an array with references to objects the metrics
13358	will be collected for. Use references to IHost and IMachine objects.
13359	</li>
13360	<li>
13361	Allocate and populate an array with base metric names the data will
13362	be collected for.
13363	</li>
13364	<li>
13365	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13366	the metric data will be collected and stored.
13367	</li>
13368	<li>
13369	Wait for the data to get collected.
13370	</li>
13371	<li>
13372	Allocate and populate an array with references to objects the metric
13373	values will be queried for. You can re-use the object array used for
13374	setting base metrics.
13375	</li>
13376	<li>
13377	Allocate and populate an array with metric names the data will be
13378	collected for. Note that metric names differ from base metric names.
13379	</li>
13380	<li>
13381	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13382	that have been collected so far are returned. Note that the values
13383	are still retained internally and data collection continues.
13384	</li>
13385	</ul>
13386
13387	For an example of usage refer to the following files in VirtualBox SDK:
13388	<ul>
13389	<li>
13390	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13391	</li>
13392	<li>
13393	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13394	</li>
13395	</ul>
13396	</desc>
13397
13398	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13399	<desc>
13400	Array of unique names of metrics.
13401
13402	This array represents all metrics supported by the performance
13403	collector. Individual objects do not necessarily support all of them.
13404	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13405	list of supported metrics for a particular object.
13406	</desc>
13407	</attribute>
13408
13409	<method name="getMetrics">
13410	<desc>
13411	Returns parameters of specified metrics for a set of objects.
13412	<note>
13413	@c Null metrics array means all metrics. @c Null object array means
13414	all existing objects.
13415	</note>
13416	</desc>
13417	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13418	<desc>
13419	Metric name filter. Currently, only a comma-separated list of metrics
13420	is supported.
13421	</desc>
13422	</param>
13423	<param name="objects" type="$unknown" dir="in" safearray="yes">
13424	<desc>
13425	Set of objects to return metric parameters for.
13426	</desc>
13427	</param>
13428	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13429	<desc>
13430	Array of returned metric parameters.
13431	</desc>
13432	</param>
13433	</method>
13434
13435	<method name="setupMetrics">
13436	<desc>
13437	Sets parameters of specified base metrics for a set of objects. Returns
13438	an array of <link to="IPerformanceMetric" /> describing the metrics
13439	have been affected.
13440	<note>
13441	@c Null or empty metric name array means all metrics. @c Null or
13442	empty object array means all existing objects. If metric name array
13443	contains a single element and object array contains many, the single
13444	metric name array element is applied to each object array element to
13445	form metric/object pairs.
13446	</note>
13447	</desc>
13448	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13449	<desc>
13450	Metric name filter. Comma-separated list of metrics with wildcard
13451	support.
13452	</desc>
13453	</param>
13454	<param name="objects" type="$unknown" dir="in" safearray="yes">
13455	<desc>
13456	Set of objects to setup metric parameters for.
13457	</desc>
13458	</param>
13459	<param name="period" type="unsigned long" dir="in">
13460	<desc>
13461	Time interval in seconds between two consecutive samples of
13462	performance data.
13463	</desc>
13464	</param>
13465	<param name="count" type="unsigned long" dir="in">
13466	<desc>
13467	Number of samples to retain in performance data history. Older
13468	samples get discarded.
13469	</desc>
13470	</param>
13471	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13472	<desc>
13473	Array of metrics that have been modified by the call to this method.
13474	</desc>
13475	</param>
13476	</method>
13477
13478	<method name="enableMetrics">
13479	<desc>
13480	Turns on collecting specified base metrics. Returns an array of
13481	<link to="IPerformanceMetric" /> describing the metrics have been
13482	affected.
13483	<note>
13484	@c Null or empty metric name array means all metrics. @c Null or
13485	empty object array means all existing objects. If metric name array
13486	contains a single element and object array contains many, the single
13487	metric name array element is applied to each object array element to
13488	form metric/object pairs.
13489	</note>
13490	</desc>
13491	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13492	<desc>
13493	Metric name filter. Comma-separated list of metrics with wildcard
13494	support.
13495	</desc>
13496	</param>
13497	<param name="objects" type="$unknown" dir="in" safearray="yes">
13498	<desc>
13499	Set of objects to enable metrics for.
13500	</desc>
13501	</param>
13502	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13503	<desc>
13504	Array of metrics that have been modified by the call to this method.
13505	</desc>
13506	</param>
13507	</method>
13508
13509	<method name="disableMetrics">
13510	<desc>
13511	Turns off collecting specified base metrics. Returns an array of
13512	<link to="IPerformanceMetric" /> describing the metrics have been
13513	affected.
13514	<note>
13515	@c Null or empty metric name array means all metrics. @c Null or
13516	empty object array means all existing objects. If metric name array
13517	contains a single element and object array contains many, the single
13518	metric name array element is applied to each object array element to
13519	form metric/object pairs.
13520	</note>
13521	</desc>
13522	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13523	<desc>
13524	Metric name filter. Comma-separated list of metrics with wildcard
13525	support.
13526	</desc>
13527	</param>
13528	<param name="objects" type="$unknown" dir="in" safearray="yes">
13529	<desc>
13530	Set of objects to disable metrics for.
13531	</desc>
13532	</param>
13533	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13534	<desc>
13535	Array of metrics that have been modified by the call to this method.
13536	</desc>
13537	</param>
13538	</method>
13539
13540	<method name="queryMetricsData">
13541	<desc>
13542	Queries collected metrics data for a set of objects.
13543
13544	The data itself and related metric information are returned in seven
13545	parallel and one flattened array of arrays. Elements of
13546	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13547	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13548	the same index describe one set of values corresponding to a single
13549	metric.
13550
13551	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13552	start and length of a sub-array is indicated by
13553	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13554	value for metric <tt>metricNames[i]</tt> is at
13555	<tt>returnData[returnIndices[i]]</tt>.
13556
13557	<note>
13558	@c Null or empty metric name array means all metrics. @c Null or
13559	empty object array means all existing objects. If metric name array
13560	contains a single element and object array contains many, the single
13561	metric name array element is applied to each object array element to
13562	form metric/object pairs.
13563	</note>
13564	<note>
13565	Data collection continues behind the scenes after call to @c
13566	queryMetricsData. The return data can be seen as the snapshot of the
13567	current state at the time of @c queryMetricsData call. The internally
13568	kept metric values are not cleared by the call. This makes possible
13569	querying different subsets of metrics or aggregates with subsequent
13570	calls. If periodic querying is needed it is highly suggested to query
13571	the values with @c interval*count period to avoid confusion. This way
13572	a completely new set of data values will be provided by each query.
13573	</note>
13574	</desc>
13575	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13576	<desc>
13577	Metric name filter. Comma-separated list of metrics with wildcard
13578	support.
13579	</desc>
13580	</param>
13581	<param name="objects" type="$unknown" dir="in" safearray="yes">
13582	<desc>
13583	Set of objects to query metrics for.
13584	</desc>
13585	</param>
13586	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13587	<desc>
13588	Names of metrics returned in @c returnData.
13589	</desc>
13590	</param>
13591	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13592	<desc>
13593	Objects associated with metrics returned in @c returnData.
13594	</desc>
13595	</param>
13596	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13597	<desc>
13598	Units of measurement for each returned metric.
13599	</desc>
13600	</param>
13601	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13602	<desc>
13603	Divisor that should be applied to return values in order to get
13604	floating point values. For example:
13605	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13606	will retrieve the floating point value of i-th sample of the first
13607	metric.
13608	</desc>
13609	</param>
13610	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13611	<desc>
13612	Sequence numbers of the first elements of value sequences of
13613	particular metrics returned in @c returnData. For aggregate metrics
13614	it is the sequence number of the sample the aggregate started
13615	calculation from.
13616	</desc>
13617	</param>
13618	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13619	<desc>
13620	Indices of the first elements of value sequences of particular
13621	metrics returned in @c returnData.
13622	</desc>
13623	</param>
13624	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13625	<desc>
13626	Lengths of value sequences of particular metrics.
13627	</desc>
13628	</param>
13629	<param name="returnData" type="long" dir="return" safearray="yes">
13630	<desc>
13631	Flattened array of all metric data containing sequences of values for
13632	each metric.
13633	</desc>
13634	</param>
13635	</method>
13636
13637	</interface>
13638	<enum
13639	name="NATAliasMode"
13640	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13641	<desc></desc>
13642	<const name="AliasLog" value="0x1">
13643	<desc></desc>
13644	</const>
13645	<const name="AliasProxyOnly" value="0x02">
13646	<desc></desc>
13647	</const>
13648	<const name="AliasUseSamePorts" value="0x04">
13649	<desc></desc>
13650	</const>
13651	</enum>
13652	<enum
13653	name="NATProtocol"
13654	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13655	>
13656	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13657	<const name="UDP" value="0">
13658	<desc>Port-forwarding uses UDP protocol.</desc>
13659	</const>
13660	<const name="TCP" value="1">
13661	<desc>Port-forwarding uses TCP protocol.</desc>
13662	</const>
13663	</enum>
13664
13665	<interface
13666	name="INATEngine" extends="$unknown"
13667	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13668	wsmap="managed"
13669	>
13670	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13671	allows for changing NAT behavior such as port-forwarding rules. This interface is
13672	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13673	<attribute name="network" type="wstring">
13674	<desc>The network attribute of the NAT engine (the same value is used with built-in
13675	DHCP server to fill corresponding fields of DHCP leases).</desc>
13676	</attribute>
13677	<attribute name="hostIP" type="wstring">
13678	<desc>IP of host interface to bind all opened sockets to.
13679	<note>Changing this does not change binding of port forwarding.</note>
13680	</desc>
13681	</attribute>
13682	<attribute name="tftpPrefix" type="wstring">
13683	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13684	the corresponding fields of DHCP leases.</desc>
13685	</attribute>
13686	<attribute name="tftpBootFile" type="wstring">
13687	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
13688	the corresponding fields of DHCP leases.</desc>
13689	</attribute>
13690	<attribute name="tftpNextServer" type="wstring">
13691	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
13692	the corresponding fields of DHCP leases.
13693	<note>The preferred form is IPv4 addresses.</note>
13694	</desc>
13695	</attribute>
13696	<attribute name="aliasMode" type="unsigned long">
13697	<desc></desc>
13698	</attribute>
13699	<attribute name="dnsPassDomain" type="boolean">
13700	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
13701	</attribute>
13702	<attribute name="dnsProxy" type="boolean">
13703	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13704	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
13705	</attribute>
13706	<attribute name="dnsUseHostResolver" type="boolean">
13707	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13708	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
13709	</attribute>
13710	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
13711	<desc>Array of NAT port-forwarding rules in string representation, in the following
13712	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
13713	</attribute>
13714	<method name="setNetworkSettings">
13715	<desc>Sets network configuration of the NAT engine.</desc>
13716	<param name="mtu" type="unsigned long" dir="in">
13717	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
13718	</param>
13719	<param name="sockSnd" type="unsigned long" dir="in">
13720	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
13721	</param>
13722	<param name="sockRcv" type="unsigned long" dir="in">
13723	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
13724	</param>
13725	<param name="TcpWndSnd" type="unsigned long" dir="in">
13726	<desc>Initial size of the NAT engine's sending TCP window in bytes when
13727	establishing a new TCP connection.</desc>
13728	</param>
13729	<param name="TcpWndRcv" type="unsigned long" dir="in">
13730	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
13731	establishing a new TCP connection.</desc>
13732	</param>
13733	</method>
13734	<method name="getNetworkSettings">
13735	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
13736	for parameter descriptions.</desc>
13737	<param name="mtu" type="unsigned long" dir="out" />
13738	<param name="sockSnd" type="unsigned long" dir="out" />
13739	<param name="sockRcv" type="unsigned long" dir="out" />
13740	<param name="TcpWndSnd" type="unsigned long" dir="out" />
13741	<param name="TcpWndRcv" type="unsigned long" dir="out" />
13742	</method>
13743	<method name="addRedirect">
13744	<desc>Adds a new NAT port-forwarding rule.</desc>
13745	<param name="name" type="wstring" dir="in">
13746	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
13747	auto-generates one using the other parameters.</desc>
13748	</param>
13749	<param name="proto" type="NATProtocol" dir="in">
13750	<desc>Protocol handled with the rule.</desc>
13751	</param>
13752	<param name="hostIp" type="wstring" dir="in">
13753	<desc>IP of the host interface to which the rule should apply. An empty ip address is
13754	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
13755	</param>
13756	<param name="hostPort" type="unsigned short" dir="in">
13757	<desc>The port number to listen on.</desc>
13758	</param>
13759	<param name="guestIp" type="wstring" dir="in">
13760	<desc>The IP address of the guest which the NAT engine will forward matching packets
13761	to. An empty IP address is acceptable, in which case the NAT engine will forward
13762	packets to the first DHCP lease (x.x.x.15).</desc>
13763	</param>
13764	<param name="guestPort" type="unsigned short" dir="in">
13765	<desc>The port number to forward.</desc>
13766	</param>
13767	</method>
13768	<method name="removeRedirect">
13769	<desc>Removes a port-forwarding rule that was previously registered.</desc>
13770	<param name="name" type="wstring" dir="in">
13771	<desc>The name of the rule to delete.</desc>
13772	</param>
13773	</method>
13774	</interface>
13775
13776	<enum
13777	name="VBoxEventType"
13778	uuid="7d695029-32b8-4855-86d3-75de9082923b">
13779
13780	<desc>
13781	Type of an event.
13782	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
13783	</desc>
13784
13785	<const name="Invalid" value="0">
13786	<desc>
13787	Invalid event, must be first.
13788	</desc>
13789	</const>
13790
13791	<const name="Any" value="1">
13792	<desc>
13793	Wildcard for all events. Events of this type are never delivered, and only used in
13794	registerListener() call to simplify registration.
13795	</desc>
13796	</const>
13797
13798	<const name="MachineEvent" value="2">
13799	<desc>
13800	Wildcard for all machine events. Events of this type are never delivered, and only used in
13801	registerListener() call to simplify registration.
13802	</desc>
13803	</const>
13804
13805	<const name="SnapshotEvent" value="3">
13806	<desc>
13807	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
13808	registerListener() call to simplify registration.
13809	</desc>
13810	</const>
13811
13812	<const name="InputEvent" value="4">
13813	<desc>
13814	Wildcard for all input device (keyboard, mouse) events.
13815	Events of this type are never delivered, and only used in
13816	registerListener() call to simplify registration.
13817	</desc>
13818	</const>
13819
13820	<const name="LastWildcard" value="31">
13821	<desc>
13822	Last wildcard.
13823	</desc>
13824	</const>
13825
13826	<const name="OnMachineStateChanged" value="32">
13827	<desc>
13828	<see>IMachineStateChangedEvent</see>
13829	</desc>
13830	</const>
13831	<const name="OnMachineDataChanged" value="33">
13832	<desc>
13833	<see>IMachineDataChangedEvent</see>
13834	</desc>
13835	</const>
13836	<const name="OnExtraDataChanged" value="34">
13837	<desc>
13838	<see>IExtraDataChangedEvent</see>
13839	</desc>
13840	</const>
13841	<const name="OnExtraDataCanChange" value="35">
13842	<desc>
13843	<see>IExtraDataCanChangeEvent</see>
13844	</desc>
13845	</const>
13846	<const name="OnMediumRegistered" value="36">
13847	<desc>
13848	<see>IMediumRegistered</see>
13849	</desc>
13850	</const>
13851	<const name="OnMachineRegistered" value="37">
13852	<desc>
13853	<see>IMachineRegisteredEvent</see>
13854	</desc>
13855	</const>
13856	<const name="OnSessionStateChanged" value="38">
13857	<desc>
13858	<see>ISessionStateChangedEvent</see>
13859	</desc>
13860	</const>
13861	<const name="OnSnapshotTaken" value="39">
13862	<desc>
13863	<see>ISnapshotTakenEvent</see>
13864	</desc>
13865	</const>
13866	<const name="OnSnapshotDeleted" value="40">
13867	<desc>
13868	<see>ISnapshotDeletedEvent</see>
13869	</desc>
13870	</const>
13871	<const name="OnSnapshotChanged" value="41">
13872	<desc>
13873	<see>ISnapshotChangedEvent</see>
13874	</desc>
13875	</const>
13876	<const name="OnGuestPropertyChanged" value="42">
13877	<desc>
13878	<see>IGuestPropertyChangedEvent</see>
13879	</desc>
13880	</const>
13881	<!-- Console events -->
13882	<const name="OnMousePointerShapeChanged" value="43">
13883	<desc>
13884	<see>IMousePointerShapeChangedEvent</see>
13885	</desc>
13886	</const>
13887	<const name="OnMouseCapabilityChanged" value="44">
13888	<desc>
13889	<see>IMouseCapabilityChangedEvent</see>
13890	</desc>
13891	</const>
13892	<const name="OnKeyboardLedsChanged" value="45">
13893	<desc>
13894	<see>IKeyboardLedsChangedEvent</see>
13895	</desc>
13896	</const>
13897	<const name="OnStateChanged" value="46">
13898	<desc>
13899	<see>IStateChangedEvent</see>
13900	</desc>
13901	</const>
13902	<const name="OnAdditionsStateChanged" value="47">
13903	<desc>
13904	<see>IAdditionsStateChangedEvent</see>
13905	</desc>
13906	</const>
13907	<const name="OnNetworkAdapterChanged" value="48">
13908	<desc>
13909	<see>INetworkAdapterChangedEvent</see>
13910	</desc>
13911	</const>
13912	<const name="OnSerialPortChanged" value="49">
13913	<desc>
13914	<see>ISerialPortChangedEvent</see>
13915	</desc>
13916	</const>
13917	<const name="OnParallelPortChanged" value="50">
13918	<desc>
13919	<see>IParallelPortChangedEvent</see>
13920	</desc>
13921	</const>
13922	<const name="OnStorageControllerChanged" value="51">
13923	<desc>
13924	<see>IStorageControllerChangedEvent</see>
13925	</desc>
13926	</const>
13927	<const name="OnMediumChanged" value="52">
13928	<desc>
13929	<see>IMediumChangedEvent</see>
13930	</desc>
13931	</const>
13932	<const name="OnVRDPServerChanged" value="53">
13933	<desc>
13934	<see>IVRDPServerChangedEvent</see>
13935	</desc>
13936	</const>
13937	<const name="OnUSBControllerChanged" value="54">
13938	<desc>
13939	<see>IUSBControllerChangedEvent</see>
13940	</desc>
13941	</const>
13942	<const name="OnUSBDeviceStateChanged" value="55">
13943	<desc>
13944	<see>IUSBDeviceStateChangedEvent</see>
13945	</desc>
13946	</const>
13947	<const name="OnSharedFolderChanged" value="56">
13948	<desc>
13949	<see>ISharedFolderChangedEvent</see>
13950	</desc>
13951	</const>
13952	<const name="OnRuntimeError" value="57">
13953	<desc>
13954	<see>IRuntimeErrorEvent</see>
13955	</desc>
13956	</const>
13957	<const name="OnCanShowWindow" value="58">
13958	<desc>
13959	<see>ICanShowWindowEvent</see>
13960	</desc>
13961	</const>
13962	<const name="OnShowWindow" value="59">
13963	<desc>
13964	<see>IShowWindowEvent</see>
13965	</desc>
13966	</const>
13967	<const name="OnCPUChanged" value="60">
13968	<desc>
13969	<see>ICPUChangedEvent</see>
13970	</desc>
13971	</const>
13972	<const name="OnRemoteDisplayInfoChanged" value="61">
13973	<desc>
13974	<see>IRemoteDisplayInfoChangedEvent</see>
13975	</desc>
13976	</const>
13977	<const name="OnEventSourceChanged" value="62">
13978	<desc>
13979	<see>IEventSourceChangedEvent</see>
13980	</desc>
13981	</const>
13982	<!-- Last event marker -->
13983	<const name="Last" value="63">
13984	<desc>
13985	Must be last event, used for iterations and structures relying on numerical event values.
13986	</desc>
13987	</const>
13988
13989	</enum>
13990
13991	<interface
13992	name="IEventSource" extends="$unknown"
13993	uuid="3c670618-f727-4fe9-94d2-8243f489a033"
13994	wsmap="managed"
13995	>
13996	<desc>
13997	Event source. Generally, any object which could generate events can be an event source,
13998	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
13999	an event source can work with listeners in either active or passive mode. In active mode it is up to
14000	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14001	event source keeps track of pending events for each listener and returns available events on demand.
14002
14003	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14004	</desc>
14005
14006	<method name="createListener">
14007	<desc>
14008	Creates a new listener object, useful for passive mode.
14009	</desc>
14010	<param name="listener" type="IEventListener" dir="return"/>
14011	</method>
14012
14013	<method name="registerListener">
14014	<desc>
14015	Register an event listener.
14016
14017	<note>
14018	To avoid system overload, the VirtualBox server process checks if passive event
14019	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14020	current implementation, if more than 100 pending events are detected for a passive
14021	event listener, it is forcefully unregistered by the system, and further
14022	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
14023	</note>
14024	</desc>
14025	<param name="listener" type="IEventListener" dir="in">
14026	<desc>Listener to register.</desc>
14027	</param>
14028	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
14029	<desc>
14030	Event types listener is interested in. One can use wildcards like -
14031	<link to="VBoxEventType::Any"/> to specify wildcards, matching more
14032	than one event.
14033	</desc>
14034	</param>
14035	<param name="active" type="boolean" dir="in">
14036	<desc>
14037	Which mode this listener is operating in.
14038	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
14039	In passive mode, an internal event queue is created for this this IEventListener.
14040	For each event coming in, it is added to queues for all interested registered passive
14041	listeners. It is then up to the external code to call the listener's
14042	<link to="IEventListener::handleEvent" /> method. When done with an event, the
14043	external code must call <link to="#eventProcessed" />.
14044	</desc>
14045	</param>
14046	</method>
14047
14048	<method name="unregisterListener">
14049	<desc>
14050	Unregister an event listener. If listener is passive, and some waitable events are still
14051	in queue they are marked as processed automatically.
14052	</desc>
14053	<param name="listener" type="IEventListener" dir="in">
14054	<desc>Listener to unregister.</desc>
14055	</param>
14056	</method>
14057
14058	<method name="fireEvent">
14059	<desc>
14060	Fire an event for this source.
14061	</desc>
14062	<param name="event" type="IEvent" dir="in">
14063	<desc>Event to deliver.</desc>
14064	</param>
14065	<param name="timeout" type="long" dir="in">
14066	<desc>
14067	Maximum time to wait for event processing (if event is waitable), in ms;
14068	0 = no wait, -1 = indefinite wait.
14069	</desc>
14070	</param>
14071	<param name="result" type="boolean" dir="return">
14072	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14073	</param>
14074	</method>
14075
14076	<method name="getEvent">
14077	<desc>
14078	Get events from this peer's event queue (for passive mode). Calling this method
14079	regularly is required for passive event listeners to avoid system overload;
14080	see <link to="IEventSource::registerListener" /> for details.
14081
14082	<result name="VBOX_E_OBJECT_NOT_FOUND">
14083	Listener is not registered, or autounregistered.
14084	</result>
14085	</desc>
14086	<param name="listener" type="IEventListener" dir="in">
14087	<desc>Which listener to get data for.</desc>
14088	</param>
14089	<param name="timeout" type="long" dir="in">
14090	<desc>
14091	Maximum time to wait for events, in ms;
14092	0 = no wait, -1 = indefinite wait.
14093	</desc>
14094	</param>
14095	<param name="event" type="IEvent" dir="return">
14096	<desc>Event retrieved, or null if none available.</desc>
14097	</param>
14098	</method>
14099
14100	<method name="eventProcessed">
14101	<desc>
14102	Must be called for waitable events after a particular listener finished its
14103	event processing. When all listeners of a particular event have called this
14104	method, the system will then call <link to="IEvent::setProcessed" />.
14105	</desc>
14106	<param name="listener" type="IEventListener" dir="in">
14107	<desc>Which listener processed event.</desc>
14108	</param>
14109	<param name="event" type="IEvent" dir="in">
14110	<desc>Which event.</desc>
14111	</param>
14112	</method>
14113
14114	</interface>
14115
14116	<interface
14117	name="IEventListener" extends="$unknown"
14118	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14119	wsmap="managed"
14120	>
14121	<desc>
14122	Event listener. An event listener can work in either active or passive mode, depending on the way
14123	it was registered.
14124	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14125	</desc>
14126
14127	<method name="handleEvent">
14128	<desc>
14129	Handle event callback (called directly by IEventSource in active mode, or could be
14130	called by event processor thread in passive mode).
14131	</desc>
14132	<param name="event" type="IEvent" dir="in">
14133	<desc>Event available.</desc>
14134	</param>
14135	</method>
14136
14137	</interface>
14138
14139	<interface
14140	name="IEvent" extends="$unknown"
14141	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14142	wsmap="managed"
14143	>
14144	<desc>
14145	Abstract parent interface for VirtualBox events. Actual events will typically implement
14146	a more specific interface which derives from this (see below).
14147
14148	<b>Introduction to VirtualBox events</b>
14149
14150	Generally speaking, an event (represented by this interface) signals that something
14151	happened, while an event listener (see <link to="IEventListener" /> represents an
14152	entity that is interested in certain events. In order for this to work with
14153	unidirectional protocols (i.e. web services), the concepts of passive and active
14154	listener are used.
14155
14156	Event consumers can register themselves as listeners, providing an array of
14157	events they are interested in (see <link to="IEventSource::registerListener" />).
14158	When an event triggers, the listener is notified about the event. The exact
14159	mechanism of the notification depends on whether the listener was registered as
14160	an active or passive listener:
14161
14162	<ul>
14163	<li>An active listener is very similar to a callback: it is a function invoked
14164	by the API. As opposed to the callbacks that were used in the API before
14165	VirtualBox 3.3 however, events are now objects with an interface hierarchy.
14166	</li>
14167
14168	<li>Passive listeners are somewhat tricker to implement, but do not require
14169	a client function to be callable, which is not an option with scripting
14170	languages or web service clients. Internally the <link to="IEventSource" />
14171	implementation maintains an event queue for each passive listener, and
14172	newly arrived events are put in this queue. When the listener calls
14173	<link to="IEventSource::getEvent"/>, all elements from its internal event
14174	queue are returned. When the client completes processing of an event,
14175	the <link to="IEventSource::eventProcessed" /> function must be called,
14176	acknowledging that the events were processed. It supports implementing
14177	waitable events. On passive listener unregistration, all events from its
14178	queue are auto-acknowledged.
14179	</li>
14180	</ul>
14181
14182	Waitable events are useful in situations where the event generator wants to track
14183	delivery or a party wants to wait until all listeners have completed the event. A
14184	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14185	listeners might veto a certain action, and thus the event producer has to make
14186	sure that all listeners have processed the event and not vetoed before taking
14187	the action.
14188
14189	A given event may have both passive and active listeners at the same time.
14190
14191	<b>Using events</b>
14192
14193	Any VirtualBox object capable of producing externally visible events provides an
14194	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14195	This event source object is notified by VirtualBox once something has happened, so
14196	consumers may register event listeners with this event source. To register a listener,
14197	an object implementing the <link to="IEventListener" /> interface must be provided.
14198	For active listeners, such an object is typically created by the consumer, while for
14199	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14200	note that a listener created with @c createListener() must not be used as an active listener.
14201
14202	Once created, the listener must be registered to listen for the desired events
14203	(see <link to="IEventSource::registerListener" />), providing an array of
14204	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14205	event IDs or wildcards matching multiple event IDs.
14206
14207	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14208	called automatically when the event is triggered, while passive listeners have to call
14209	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14210	an event processing loop.
14211
14212	The IEvent interface is an abstract parent interface for all such VirtualBox events
14213	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14214	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14215	then cast to the appropriate specific interface using @c QueryInterface().
14216	</desc>
14217
14218	<attribute name="type" readonly="yes" type="VBoxEventType">
14219	<desc>
14220	Event type.
14221	</desc>
14222	</attribute>
14223
14224	<attribute name="source" readonly="yes" type="IEventSource">
14225	<desc>
14226	Source of this event.
14227	</desc>
14228	</attribute>
14229
14230	<attribute name="waitable" readonly="yes" type="boolean">
14231	<desc>
14232	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14233	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14234	as no additional overhead associated with waitability imposed.
14235	Waitable events are needed when one need to be able to wait for particular event processed,
14236	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14237	until all consumers confirmed events.
14238	</desc>
14239	</attribute>
14240
14241	<method name="setProcessed">
14242	<desc>
14243	Internal method called by the system when all listeners of a particular event have called
14244	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14245	</desc>
14246	</method>
14247
14248	<method name="waitProcessed">
14249	<desc>
14250	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14251	described semantics, for non-waitable returns true immediately.
14252	</desc>
14253	<param name="timeout" type="long" dir="in">
14254	<desc>
14255	Maximum time to wait for event processeing, in ms;
14256	0 = no wait, -1 = indefinite wait.
14257	</desc>
14258	</param>
14259	<param name="result" type="boolean" dir="return">
14260	<desc>If this event was processed before timeout.</desc>
14261	</param>
14262	</method>
14263	</interface>
14264
14265
14266	<interface
14267	name="IMachineEvent" extends="IEvent"
14268	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14269	wsmap="managed" id="MachineEvent"
14270	>
14271	<desc>Base abstract interface for all machine events.</desc>
14272
14273	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14274	<desc>ID of the machine this event relates to.</desc>
14275	</attribute>
14276
14277	</interface>
14278
14279	<interface
14280	name="IMachineStateChangedEvent" extends="IMachineEvent"
14281	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14282	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14283	>
14284	<desc>Machine state change event.</desc>
14285
14286	<attribute name="state" readonly="yes" type="MachineState">
14287	<desc>New execution state.</desc>
14288	</attribute>
14289	</interface>
14290
14291	<interface
14292	name="IMachineDataChangedEvent" extends="IMachineEvent"
14293	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14294	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14295	>
14296	<desc>
14297	Any of the settings of the given machine has changed.
14298	</desc>
14299	</interface>
14300
14301	<interface
14302	name="IMachineRegisteredEvent" extends="IMachineEvent"
14303	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14304	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14305	>
14306	<desc>
14307	The given machine was registered or unregistered
14308	within this VirtualBox installation.
14309	</desc>
14310
14311	<attribute name="registered" type="boolean" readonly="yes">
14312	<desc>
14313	If @c true, the machine was registered, otherwise it was
14314	unregistered.
14315	</desc>
14316	</attribute>
14317	</interface>
14318
14319	<interface
14320	name="ISessionStateChangedEvent" extends="IMachineEvent"
14321	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14322	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14323	>
14324	<desc>
14325	The state of the session for the given machine was changed.
14326	<see>IMachine::sessionState</see>
14327	</desc>
14328
14329	<attribute name="state" type="SessionState" readonly="yes">
14330	<desc>
14331	New session state.
14332	</desc>
14333	</attribute>
14334	</interface>
14335
14336	<interface
14337	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14338	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14339	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14340	>
14341	<desc>
14342	Notification when a guest property has changed.
14343	</desc>
14344
14345	<attribute name="name" readonly="yes" type="wstring">
14346	<desc>
14347	The name of the property that has changed.
14348	</desc>
14349	</attribute>
14350
14351	<attribute name="value" readonly="yes" type="wstring">
14352	<desc>
14353	The new property value.
14354	</desc>
14355	</attribute>
14356
14357	<attribute name="flags" readonly="yes" type="wstring">
14358	<desc>
14359	The new property flags.
14360	</desc>
14361	</attribute>
14362
14363	</interface>
14364
14365	<interface
14366	name="ISnapshotEvent" extends="IMachineEvent"
14367	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14368	wsmap="managed" id="SnapshotEvent"
14369	>
14370	<desc>Base interface for all snapshot events.</desc>
14371
14372	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14373	<desc>ID of the snapshot this event relates to.</desc>
14374	</attribute>
14375
14376	</interface>
14377
14378	<interface
14379	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14380	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14381	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14382	>
14383	<desc>
14384	A new snapshot of the machine has been taken.
14385	<see>ISnapshot</see>
14386	</desc>
14387	</interface>
14388
14389	<interface
14390	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14391	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14392	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14393	>
14394	<desc>
14395	Snapshot of the given machine has been deleted.
14396
14397	<note>
14398	This notification is delivered <b>after</b> the snapshot
14399	object has been uninitialized on the server (so that any
14400	attempt to call its methods will return an error).
14401	</note>
14402
14403	<see>ISnapshot</see>
14404	</desc>
14405	</interface>
14406
14407	<interface
14408	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14409	uuid="07541941-8079-447a-a33e-47a69c7980db"
14410	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14411	>
14412	<desc>
14413	Snapshot properties (name and/or description) have been changed.
14414	<see>ISnapshot</see>
14415	</desc>
14416	</interface>
14417
14418	<interface
14419	name="IMousePointerShapeChangedEvent" extends="IEvent"
14420	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14421	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14422	>
14423	<desc>
14424	Notification when the guest mouse pointer shape has
14425	changed. The new shape data is given.
14426	</desc>
14427
14428	<attribute name="visible" type="boolean" readonly="yes">
14429	<desc>
14430	Flag whether the pointer is visible.
14431	</desc>
14432	</attribute>
14433	<attribute name="alpha" type="boolean" readonly="yes">
14434	<desc>
14435	Flag whether the pointer has an alpha channel.
14436	</desc>
14437	</attribute>
14438	<attribute name="xhot" type="unsigned long" readonly="yes">
14439	<desc>
14440	The pointer hot spot X coordinate.
14441	</desc>
14442	</attribute>
14443	<attribute name="yhot" type="unsigned long" readonly="yes">
14444	<desc>
14445	The pointer hot spot Y coordinate.
14446	</desc>
14447	</attribute>
14448	<attribute name="width" type="unsigned long" readonly="yes">
14449	<desc>
14450	Width of the pointer shape in pixels.
14451	</desc>
14452	</attribute>
14453	<attribute name="height" type="unsigned long" readonly="yes">
14454	<desc>
14455	Height of the pointer shape in pixels.
14456	</desc>
14457	</attribute>
14458	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14459	<desc>
14460	Shape buffer arrays.
14461
14462	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14463	followed by a 32-bpp XOR (color) mask.
14464
14465	For pointers without alpha channel the XOR mask pixels are 32
14466	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14467	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14468
14469	An AND mask is used for pointers with alpha channel, so if the
14470	callback does not support alpha, the pointer could be
14471	displayed as a normal color pointer.
14472
14473	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14474	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14475	height</tt>. The padding bits at the end of each scanline are
14476	undefined.
14477
14478	The XOR mask follows the AND mask on the next 4-byte aligned
14479	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14480	Bytes in the gap between the AND and the XOR mask are undefined.
14481	The XOR mask scanlines have no gap between them and the size of
14482	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14483
14484	<note>
14485	If @a shape is 0, only the pointer visibility is changed.
14486	</note>
14487	</desc>
14488	</attribute>
14489	</interface>
14490
14491	<interface
14492	name="IMouseCapabilityChangedEvent" extends="IEvent"
14493	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
14494	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
14495	>
14496	<desc>
14497	Notification when the mouse capabilities reported by the
14498	guest have changed. The new capabilities are passed.
14499	</desc>
14500	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
14501	<desc>
14502	Supports absolute coordinates.
14503	</desc>
14504	</attribute>
14505	<attribute name="supportsRelative" type="boolean" readonly="yes">
14506	<desc>
14507	Supports relative coordinates.
14508	</desc>
14509	</attribute>
14510	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14511	<desc>
14512	If host cursor is needed.
14513	</desc>
14514	</attribute>
14515	</interface>
14516
14517	<interface
14518	name="IKeyboardLedsChangedEvent" extends="IEvent"
14519	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
14520	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
14521	>
14522	<desc>
14523	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
14524	to alter the state of the keyboard LEDs.
14525	</desc>
14526	<attribute name="numLock" type="boolean" readonly="yes">
14527	<desc>
14528	NumLock status.
14529	</desc>
14530	</attribute>
14531	<attribute name="capsLock" type="boolean" readonly="yes">
14532	<desc>
14533	CapsLock status.
14534	</desc>
14535	</attribute>
14536	<attribute name="scrollLock" type="boolean" readonly="yes">
14537	<desc>
14538	ScrollLock status.
14539	</desc>
14540	</attribute>
14541	</interface>
14542
14543	<interface
14544	name="IStateChangedEvent" extends="IEvent"
14545	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
14546	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
14547	>
14548	<desc>
14549	Notification when the execution state of the machine has changed.
14550	The new state is given.
14551	</desc>
14552	<attribute name="state" type="MachineState" readonly="yes">
14553	<desc>
14554	New machine state.
14555	</desc>
14556	</attribute>
14557	</interface>
14558
14559	<interface
14560	name="IAdditionsStateChangedEvent" extends="IEvent"
14561	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
14562	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
14563	>
14564	<desc>
14565	Notification when a Guest Additions property changes.
14566	Interested callees should query IGuest attributes to
14567	find out what has changed.
14568	</desc>
14569	</interface>
14570
14571	<interface
14572	name="INetworkAdapterChangedEvent" extends="IEvent"
14573	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
14574	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
14575	>
14576	<desc>
14577	Notification when a property of one of the
14578	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
14579	changes. Interested callees should use INetworkAdapter methods and
14580	attributes to find out what has changed.
14581	</desc>
14582	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
14583	<desc>
14584	Network adapter that is subject to change.
14585	</desc>
14586	</attribute>
14587	</interface>
14588
14589	<interface
14590	name="ISerialPortChangedEvent" extends="IEvent"
14591	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
14592	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
14593	>
14594	<desc>
14595	Notification when a property of one of the
14596	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
14597	Interested callees should use ISerialPort methods and attributes
14598	to find out what has changed.
14599	</desc>
14600	<attribute name="serialPort" type="ISerialPort" readonly="yes">
14601	<desc>
14602	Serial port that is subject to change.
14603	</desc>
14604	</attribute>
14605	</interface>
14606
14607	<interface
14608	name="IParallelPortChangedEvent" extends="IEvent"
14609	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
14610	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
14611	>
14612	<desc>
14613	Notification when a property of one of the
14614	virtual <link to="IMachine::getParallelPort">parallel ports</link>
14615	changes. Interested callees should use ISerialPort methods and
14616	attributes to find out what has changed.
14617	</desc>
14618	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
14619	<desc>
14620	Parallel port that is subject to change.
14621	</desc>
14622	</attribute>
14623	</interface>
14624
14625	<interface
14626	name="IStorageControllerChangedEvent" extends="IEvent"
14627	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
14628	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
14629	>
14630	<desc>
14631	Notification when a
14632	<link to="IMachine::mediumAttachments">medium attachment</link>
14633	changes.
14634	</desc>
14635	</interface>
14636
14637	<interface
14638	name="IMediumChangedEvent" extends="IEvent"
14639	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
14640	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
14641	>
14642	<desc>
14643	Notification when a
14644	<link to="IMachine::mediumAttachments">medium attachment</link>
14645	changes.
14646	</desc>
14647	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
14648	<desc>
14649	Medium attachment that is subject to change.
14650	</desc>
14651	</attribute>
14652	</interface>
14653
14654	<interface
14655	name="ICPUChangedEvent" extends="IEvent"
14656	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
14657	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
14658	>
14659	<desc>
14660	Notification when a CPU changes.
14661	</desc>
14662	<attribute name="cpu" type="unsigned long" readonly="yes">
14663	<desc>
14664	The CPU which changed.
14665	</desc>
14666	</attribute>
14667	<attribute name="add" type="boolean" readonly="yes">
14668	<desc>
14669	Flag whether the CPU was added or removed.
14670	</desc>
14671	</attribute>
14672	</interface>
14673
14674	<interface
14675	name="IVRDPServerChangedEvent" extends="IEvent"
14676	uuid="726038B6-6279-4A7A-8037-D041693D1915"
14677	wsmap="managed" autogen="VBoxEvent" id="OnVRDPServerChanged"
14678	>
14679	<desc>
14680	Notification when a property of the
14681	<link to="IMachine::VRDPServer">VRDP server</link> changes.
14682	Interested callees should use IVRDPServer methods and attributes to
14683	find out what has changed.
14684	</desc>
14685	</interface>
14686
14687	<interface
14688	name="IRemoteDisplayInfoChangedEvent" extends="IEvent"
14689	uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
14690	wsmap="managed" autogen="VBoxEvent" id="OnRemoteDisplayInfoChanged"
14691	>
14692	<desc>
14693	Notification when the status of the VRDP server changes. Interested callees
14694	should use <link to="IConsole::remoteDisplayInfo">IRemoteDisplayInfo</link>
14695	attributes to find out what is the current status.
14696	</desc>
14697	</interface>
14698
14699	<interface
14700	name="IUSBControllerChangedEvent" extends="IEvent"
14701	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
14702	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
14703	>
14704	<desc>
14705	Notification when a property of the virtual
14706	<link to="IMachine::USBController">USB controller</link> changes.
14707	Interested callees should use IUSBController methods and attributes to
14708	find out what has changed.
14709	</desc>
14710	</interface>
14711
14712	<interface
14713	name="IUSBDeviceStateChangedEvent" extends="IEvent"
14714	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
14715	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
14716	>
14717	<desc>
14718	Notification when a USB device is attached to or detached from
14719	the virtual USB controller.
14720
14721	This notification is sent as a result of the indirect
14722	request to attach the device because it matches one of the
14723	machine USB filters, or as a result of the direct request
14724	issued by <link to="IConsole::attachUSBDevice"/> or
14725	<link to="IConsole::detachUSBDevice"/>.
14726
14727	This notification is sent in case of both a succeeded and a
14728	failed request completion. When the request succeeds, the
14729	@a error parameter is @c null, and the given device has been
14730	already added to (when @a attached is @c true) or removed from
14731	(when @a attached is @c false) the collection represented by
14732	<link to="IConsole::USBDevices"/>. On failure, the collection
14733	doesn't change and the @a error parameter represents the error
14734	message describing the failure.
14735	</desc>
14736	<attribute name="device" type="IUSBDevice" readonly="yes">
14737	<desc>
14738	Device that is subject to state change.
14739	</desc>
14740	</attribute>
14741	<attribute name="attached" type="boolean" readonly="yes">
14742	<desc>
14743	@c true if the device was attached and @c false otherwise.
14744	</desc>
14745	</attribute>
14746	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
14747	<desc>
14748	@c null on success or an error message object on failure.
14749	</desc>
14750	</attribute>
14751	</interface>
14752
14753	<interface
14754	name="ISharedFolderChangedEvent" extends="IEvent"
14755	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
14756	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
14757	>
14758	<desc>
14759	Notification when a shared folder is added or removed.
14760	The @a scope argument defines one of three scopes:
14761	<link to="IVirtualBox::sharedFolders">global shared folders</link>
14762	(<link to="Scope_Global">Global</link>),
14763	<link to="IMachine::sharedFolders">permanent shared folders</link> of
14764	the machine (<link to="Scope_Machine">Machine</link>) or <link
14765	to="IConsole::sharedFolders">transient shared folders</link> of the
14766	machine (<link to="Scope_Session">Session</link>). Interested callees
14767	should use query the corresponding collections to find out what has
14768	changed.
14769	</desc>
14770	<attribute name="scope" type="Scope" readonly="yes">
14771	<desc>
14772	Scope of the notification.
14773	</desc>
14774	</attribute>
14775	</interface>
14776
14777	<interface
14778	name="IRuntimeErrorEvent" extends="IEvent"
14779	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
14780	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
14781	>
14782	<desc>
14783	Notification when an error happens during the virtual
14784	machine execution.
14785
14786	There are three kinds of runtime errors:
14787	<ul>
14788	<li><i>fatal</i></li>
14789	<li><i>non-fatal with retry</i></li>
14790	<li><i>non-fatal warnings</i></li>
14791	</ul>
14792
14793	<b>Fatal</b> errors are indicated by the @a fatal parameter set
14794	to @c true. In case of fatal errors, the virtual machine
14795	execution is always paused before calling this notification, and
14796	the notification handler is supposed either to immediately save
14797	the virtual machine state using <link to="IConsole::saveState"/>
14798	or power it off using <link to="IConsole::powerDown"/>.
14799	Resuming the execution can lead to unpredictable results.
14800
14801	<b>Non-fatal</b> errors and warnings are indicated by the
14802	@a fatal parameter set to @c false. If the virtual machine
14803	is in the Paused state by the time the error notification is
14804	received, it means that the user can <i>try to resume</i> the machine
14805	execution after attempting to solve the problem that caused the
14806	error. In this case, the notification handler is supposed
14807	to show an appropriate message to the user (depending on the
14808	value of the @a id parameter) that offers several actions such
14809	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
14810	wants to retry, the notification handler should continue
14811	the machine execution using the <link to="IConsole::resume"/>
14812	call. If the machine execution is not Paused during this
14813	notification, then it means this notification is a <i>warning</i>
14814	(for example, about a fatal condition that can happen very soon);
14815	no immediate action is required from the user, the machine
14816	continues its normal execution.
14817
14818	Note that in either case the notification handler
14819	<b>must not</b> perform any action directly on a thread
14820	where this notification is called. Everything it is allowed to
14821	do is to post a message to another thread that will then talk
14822	to the user and take the corresponding action.
14823
14824	Currently, the following error identifiers are known:
14825	<ul>
14826	<li><tt>"HostMemoryLow"</tt></li>
14827	<li><tt>"HostAudioNotResponding"</tt></li>
14828	<li><tt>"VDIStorageFull"</tt></li>
14829	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
14830	</ul>
14831	</desc>
14832	<attribute name="fatal" type="boolean" readonly="yes">
14833	<desc>
14834	Whether the error is fatal or not.
14835	</desc>
14836	</attribute>
14837	<attribute name="id" type="wstring" readonly="yes">
14838	<desc>
14839	Error identifier.
14840	</desc>
14841	</attribute>
14842	<attribute name="message" type="wstring" readonly="yes">
14843	<desc>
14844	Optional error message.
14845	</desc>
14846	</attribute>
14847	</interface>
14848
14849
14850	<interface
14851	name="IEventSourceChangedEvent" extends="IEvent"
14852	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
14853	waitable="yes"
14854	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
14855	>
14856	<desc>
14857	Notification when an event source state changes (listener added or removed).
14858	</desc>
14859
14860	<attribute name="listener" type="IEventListener" readonly="yes">
14861	<desc>
14862	Event listener which has changed.
14863	</desc>
14864	</attribute>
14865
14866	<attribute name="add" type="boolean" readonly="yes">
14867	<desc>
14868	Flag whether listener was added or removed.
14869	</desc>
14870	</attribute>
14871	</interface>
14872
14873	<interface
14874	name="IExtraDataChangedEvent" extends="IEvent"
14875	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
14876	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
14877	>
14878	<desc>
14879	Notification when machine specific or global extra data
14880	has changed.
14881	</desc>
14882	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
14883	<desc>
14884	ID of the machine this event relates to.
14885	Null for global extra data changes.
14886	</desc>
14887	</attribute>
14888	<attribute name="key" type="wstring" readonly="yes">
14889	<desc>
14890	Extra data key that has changed.
14891	</desc>
14892	</attribute>
14893	<attribute name="value" type="wstring" readonly="yes">
14894	<desc>
14895	Extra data value for the given key.
14896	</desc>
14897	</attribute>
14898	</interface>
14899
14900	<interface
14901	name="IVetoEvent" extends="IEvent"
14902	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
14903	wsmap="managed"
14904	>
14905	<desc>Base abstract interface for veto events.</desc>
14906
14907	<method name="addVeto">
14908	<desc>
14909	Adds a veto on this event.
14910	</desc>
14911	<param name="reason" type="wstring" dir="in">
14912	<desc>
14913	Reason for veto, could be null or empty string.
14914	</desc>
14915	</param>
14916	</method>
14917
14918	<method name="isVetoed">
14919	<desc>
14920	If this event was vetoed.
14921	</desc>
14922	<param name="result" type="boolean" dir="return">
14923	<desc>
14924	Reason for veto.
14925	</desc>
14926	</param>
14927	</method>
14928
14929	<method name="getVetos">
14930	<desc>
14931	Current veto reason list, if size is 0 - no veto.
14932	</desc>
14933	<param name="result" type="wstring" dir="return" safearray="yes">
14934	<desc>
14935	Array of reasons for veto provided by different event handlers.
14936	</desc>
14937	</param>
14938	</method>
14939
14940	</interface>
14941
14942	<interface
14943	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
14944	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
14945	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
14946	waitable="true"
14947	>
14948	<desc>
14949	Notification when someone tries to change extra data for
14950	either the given machine or (if @c null) global extra data.
14951	This gives the chance to veto against changes.
14952	</desc>
14953	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
14954	<desc>
14955	ID of the machine this event relates to.
14956	Null for global extra data changes.
14957	</desc>
14958	</attribute>
14959	<attribute name="key" type="wstring" readonly="yes">
14960	<desc>
14961	Extra data key that has changed.
14962	</desc>
14963	</attribute>
14964	<attribute name="value" type="wstring" readonly="yes">
14965	<desc>
14966	Extra data value for the given key.
14967	</desc>
14968	</attribute>
14969	</interface>
14970
14971	<interface
14972	name="ICanShowWindowEvent" extends="IVetoEvent"
14973	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
14974	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
14975	waitable="true"
14976	>
14977	<desc>
14978	Notification when a call to
14979	<link to="IMachine::canShowConsoleWindow"/> is made by a
14980	front-end to check if a subsequent call to
14981	<link to="IMachine::showConsoleWindow"/> can succeed.
14982
14983	The callee should give an answer appropriate to the current
14984	machine state using event veto. This answer must
14985	remain valid at least until the next
14986	<link to="IConsole::state">machine state</link> change.
14987	</desc>
14988	</interface>
14989
14990	<interface
14991	name="IShowWindowEvent" extends="IEvent"
14992	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
14993	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
14994	waitable="true"
14995	>
14996	<desc>
14997	Notification when a call to
14998	<link to="IMachine::showConsoleWindow"/>
14999	requests the console window to be activated and brought to
15000	foreground on the desktop of the host PC.
15001
15002	This notification should cause the VM console process to
15003	perform the requested action as described above. If it is
15004	impossible to do it at a time of this notification, this
15005	method should return a failure.
15006
15007	Note that many modern window managers on many platforms
15008	implement some sort of focus stealing prevention logic, so
15009	that it may be impossible to activate a window without the
15010	help of the currently active application (which is supposedly
15011	an initiator of this notification). In this case, this method
15012	must return a non-zero identifier that represents the
15013	top-level window of the VM console process. The caller, if it
15014	represents a currently active process, is responsible to use
15015	this identifier (in a platform-dependent manner) to perform
15016	actual window activation.
15017
15018	This method must set @a winId to zero if it has performed all
15019	actions necessary to complete the request and the console
15020	window is now active and in foreground, to indicate that no
15021	further action is required on the caller's side.
15022	</desc>
15023	<attribute name="winId" type="unsigned long long">
15024	<desc>
15025	Platform-dependent identifier of the top-level VM console
15026	window, or zero if this method has performed all actions
15027	necessary to implement the <i>show window</i> semantics for
15028	the given platform and/or this VirtualBox front-end.
15029	</desc>
15030	</attribute>
15031	</interface>
15032
15033	<module name="VBoxSVC" context="LocalServer">
15034	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15035	namespace="virtualbox.org">
15036	<interface name="IVirtualBox" default="yes"/>
15037	</class>
15038	</module>
15039
15040	<module name="VBoxC" context="InprocServer" threadingModel="Free">
15041	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
15042	namespace="virtualbox.org">
15043	<interface name="ISession" default="yes"/>
15044	</class>
15045
15046	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
15047	namespace="virtualbox.org">
15048	<interface name="IConsole" default="yes"/>
15049	</class>
15050	</module>
15051
15052	</library>
15053
15054	</idl>
15055
15056	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format