VirtualBox.xidl@ 31818

Last change on this file since 31818 was 31818, checked in by vboxsync, 14 years ago
added HWVirtEx force property to API
Property svn:eol-style set to `native`
File size: 557.5 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, per-machine disk registries
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="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
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="FaultTolerantSyncing" value="16">
736	<desc>
737	The machine is being synced with a fault tolerant VM running elsewhere.
738	</desc>
739	</const>
740	<const name="DeletingSnapshotOnline" value="17">
741	<desc>
742	Like @c DeletingSnapshot, but the merging of media is ongoing in
743	the background while the machine is running.
744	</desc>
745	</const>
746	<const name="DeletingSnapshotPaused" value="18">
747	<desc>
748	Like @c DeletingSnapshotOnline, but the machine was paused when the
749	merging of differencing media was started.
750	</desc>
751	</const>
752	<const name="RestoringSnapshot" value="19">
753	<desc>
754	A machine snapshot is being restored; this typically does not take long.
755	</desc>
756	</const>
757	<const name="DeletingSnapshot" value="20">
758	<desc>
759	A machine snapshot is being deleted; this can take a long time since this
760	may require merging differencing media. This value indicates that the
761	machine is not running while the snapshot is being deleted.
762	</desc>
763	</const>
764	<const name="SettingUp" value="21">
765	<desc>
766	Lengthy setup operation is in progress.
767	</desc>
768	</const>
769
770	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
771	<desc>
772	Pseudo-state: first online state (for use in relational expressions).
773	</desc>
774	</const>
775	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
776	<desc>
777	Pseudo-state: last online state (for use in relational expressions).
778	</desc>
779	</const>
780
781	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
782	<desc>
783	Pseudo-state: first transient state (for use in relational expressions).
784	</desc>
785	</const>
786	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
787	<desc>
788	Pseudo-state: last transient state (for use in relational expressions).
789	</desc>
790	</const>
791
792	</enum>
793
794	<enum
795	name="SessionState"
796	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
797	>
798	<desc>
799	Session state. This enumeration represents possible values of
800	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
801	attributes.
802	</desc>
803
804	<const name="Null" value="0">
805	<desc>Null value (never used by the API).</desc>
806	</const>
807	<const name="Unlocked" value="1">
808	<desc>
809	In <link to="IMachine::sessionState"/>, this means that the machine
810	is not locked for any sessions.
811
812	In <link to="ISession::state"/>, this means that no machine is
813	currently locked for this session.
814	</desc>
815	</const>
816	<const name="Locked" value="2">
817	<desc>
818	In <link to="IMachine::sessionState"/>, this means that the machine
819	is currently locked for a session, whose process identifier can
820	then be found in the <link to="IMachine::sessionPid" /> attribute.
821
822	In <link to="ISession::state"/>, this means that a machine is
823	currently locked for this session, and the mutable machine object
824	can be found in the <link to="ISession::machine"/> attribute
825	(see <link to="IMachine::lockMachine" /> for details).
826	</desc>
827	</const>
828	<const name="Spawning" value="3">
829	<desc>
830	A new process is being spawned for the machine as a result of
831	<link to="IMachine::launchVMProcess"/> call. This state also occurs
832	as a short transient state during an <link to="IMachine::lockMachine"/>
833	call.
834	</desc>
835	</const>
836	<const name="Unlocking" value="4">
837	<desc>
838	The session is being unlocked.
839	</desc>
840	</const>
841	</enum>
842
843	<enum
844	name="CPUPropertyType"
845	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
846	>
847	<desc>
848	Virtual CPU property type. This enumeration represents possible values of the
849	IMachine get- and setCPUProperty methods.
850	</desc>
851	<const name="Null" value="0">
852	<desc>Null value (never used by the API).</desc>
853	</const>
854	<const name="PAE" value="1">
855	<desc>
856	This setting determines whether VirtualBox will expose the Physical Address
857	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
858	is not available, it will not be reported.
859	</desc>
860	</const>
861	<const name="Synthetic" value="2">
862	<desc>
863	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
864	teleporting between host systems that differ significantly.
865	</desc>
866	</const>
867	</enum>
868
869
870	<enum
871	name="HWVirtExPropertyType"
872	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
873	>
874	<desc>
875	Hardware virtualization property type. This enumeration represents possible values
876	for the <link to="IMachine::getHWVirtExProperty"/> and
877	<link to="IMachine::setHWVirtExProperty"/> methods.
878	</desc>
879	<const name="Null" value="0">
880	<desc>Null value (never used by the API).</desc>
881	</const>
882	<const name="Enabled" value="1">
883	<desc>
884	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
885	such extensions are not available, they will not be used.
886	</desc>
887	</const>
888	<const name="Exclusive" value="2">
889	<desc>
890	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
891	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
892	feature of the host. To share these with other hypervisors, you must disable this property.
893	</desc>
894	</const>
895	<const name="VPID" value="3">
896	<desc>
897	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
898	</desc>
899	</const>
900	<const name="NestedPaging" value="4">
901	<desc>
902	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
903	</desc>
904	</const>
905	<const name="LargePages" value="5">
906	<desc>
907	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
908	</desc>
909	</const>
910	<const name="Force" value="6">
911	<desc>
912	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
913	not set, there will be an automatic fallback to software virtualization.
914	</desc>
915	</const>
916	</enum>
917
918	<enum
919	name="FaultToleranceState"
920	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
921	>
922	<desc>
923	Used with <link to="IMachine::faultToleranceState" />.
924	</desc>
925	<const name="Inactive" value="1">
926	<desc>No fault tolerance enabled.</desc>
927	</const>
928	<const name="Master" value="2">
929	<desc>Fault tolerant master VM.</desc>
930	</const>
931	<const name="Standby" value="3">
932	<desc>Fault tolerant standby VM.</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="LockType"
938	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
939	>
940	<desc>
941	Used with <link to="IMachine::lockMachine" />.
942	</desc>
943	<const name="Write" value="2">
944	<desc>Lock the machine for writing.</desc>
945	</const>
946	<const name="Shared" value="1">
947	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
948	</const>
949	</enum>
950
951	<enum
952	name="SessionType"
953	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
954	>
955	<desc>
956	Session type. This enumeration represents possible values of the
957	<link to="ISession::type"/> attribute.
958	</desc>
959
960	<const name="Null" value="0">
961	<desc>Null value (never used by the API).</desc>
962	</const>
963	<const name="WriteLock" value="1">
964	<desc>
965	Session has acquired an exclusive write lock on a machine
966	using <link to="IMachine::lockMachine"/>.
967	</desc>
968	</const>
969	<const name="Remote" value="2">
970	<desc>
971	Session has launched a VM process using
972	<link to="IMachine::launchVMProcess"/>
973	</desc>
974	</const>
975	<const name="Shared" value="3">
976	<desc>
977	Session has obtained a link to another session using
978	<link to="IMachine::lockMachine"/>
979	</desc>
980	</const>
981	</enum>
982
983	<enum
984	name="DeviceType"
985	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
986	>
987	<desc>
988	Device type.
989	</desc>
990	<const name="Null" value="0">
991	<desc>
992	Null value, may also mean "no device" (not allowed for
993	<link to="IConsole::getDeviceActivity"/>).
994	</desc>
995	</const>
996	<const name="Floppy" value="1">
997	<desc>Floppy device.</desc>
998	</const>
999	<const name="DVD" value="2">
1000	<desc>CD/DVD-ROM device.</desc>
1001	</const>
1002	<const name="HardDisk" value="3">
1003	<desc>Hard disk device.</desc>
1004	</const>
1005	<const name="Network" value="4">
1006	<desc>Network device.</desc>
1007	</const>
1008	<const name="USB" value="5">
1009	<desc>USB device.</desc>
1010	</const>
1011	<const name="SharedFolder" value="6">
1012	<desc>Shared folder device.</desc>
1013	</const>
1014	</enum>
1015
1016	<enum
1017	name="DeviceActivity"
1018	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1019	>
1020	<desc>
1021	Device activity for <link to="IConsole::getDeviceActivity"/>.
1022	</desc>
1023
1024	<const name="Null" value="0"/>
1025	<const name="Idle" value="1"/>
1026	<const name="Reading" value="2"/>
1027	<const name="Writing" value="3"/>
1028	</enum>
1029
1030	<enum
1031	name="ClipboardMode"
1032	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1033	>
1034	<desc>
1035	Host-Guest clipboard interchange mode.
1036	</desc>
1037
1038	<const name="Disabled" value="0"/>
1039	<const name="HostToGuest" value="1"/>
1040	<const name="GuestToHost" value="2"/>
1041	<const name="Bidirectional" value="3"/>
1042	</enum>
1043
1044	<enum
1045	name="Scope"
1046	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1047	>
1048	<desc>
1049	Scope of the operation.
1050
1051	A generic enumeration used in various methods to define the action or
1052	argument scope.
1053	</desc>
1054
1055	<const name="Global" value="0"/>
1056	<const name="Machine" value="1"/>
1057	<const name="Session" value="2"/>
1058	</enum>
1059
1060	<enum
1061	name="BIOSBootMenuMode"
1062	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1063	>
1064	<desc>
1065	BIOS boot menu mode.
1066	</desc>
1067
1068	<const name="Disabled" value="0"/>
1069	<const name="MenuOnly" value="1"/>
1070	<const name="MessageAndMenu" value="2"/>
1071	</enum>
1072
1073	<enum
1074	name="ProcessorFeature"
1075	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1076	>
1077	<desc>
1078	CPU features.
1079	</desc>
1080
1081	<const name="HWVirtEx" value="0"/>
1082	<const name="PAE" value="1"/>
1083	<const name="LongMode" value="2"/>
1084	<const name="NestedPaging" value="3"/>
1085	</enum>
1086
1087	<enum
1088	name="FirmwareType"
1089	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1090	>
1091	<desc>
1092	Firmware type.
1093	</desc>
1094	<const name="BIOS" value="1">
1095	<desc>BIOS Firmware.</desc>
1096	</const>
1097	<const name="EFI" value="2">
1098	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1099	</const>
1100	<const name="EFI32" value="3">
1101	<desc>Efi firmware, 32-bit.</desc>
1102	</const>
1103	<const name="EFI64" value="4">
1104	<desc>Efi firmware, 64-bit.</desc>
1105	</const>
1106	<const name="EFIDUAL" value="5">
1107	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1108	</const>
1109	</enum>
1110
1111	<enum
1112	name="PointingHidType"
1113	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1114	>
1115	<desc>
1116	Type of pointing device used in a virtual machine.
1117	</desc>
1118	<const name="None" value="1">
1119	<desc>No mouse.</desc>
1120	</const>
1121	<const name="PS2Mouse" value="2">
1122	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1123	</const>
1124	<const name="USBMouse" value="3">
1125	<desc>USB mouse (relative pointer).</desc>
1126	</const>
1127	<const name="USBTablet" value="4">
1128	<desc>USB tablet (absolute pointer).</desc>
1129	</const>
1130	<const name="ComboMouse" value="5">
1131	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1132	Using of such device can have negative performance implications. </desc>
1133	</const>
1134	</enum>
1135
1136	<enum
1137	name="KeyboardHidType"
1138	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1139	>
1140	<desc>
1141	Type of keyboard device used in a virtual machine.
1142	</desc>
1143	<const name="None" value="1">
1144	<desc>No keyboard.</desc>
1145	</const>
1146	<const name="PS2Keyboard" value="2">
1147	<desc>PS/2 keyboard.</desc>
1148	</const>
1149	<const name="USBKeyboard" value="3">
1150	<desc>USB keyboard.</desc>
1151	</const>
1152	<const name="ComboKeyboard" value="4">
1153	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1154	Using of such device can have negative performance implications. </desc>
1155	</const>
1156	</enum>
1157
1158	<!--
1159	// IVirtualBoxErrorInfo
1160	/////////////////////////////////////////////////////////////////////////
1161	-->
1162
1163	<interface
1164	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1165	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1166	supportsErrorInfo="no"
1167	wsmap="managed"
1168	>
1169	<desc>
1170	The IVirtualBoxErrorInfo interface represents extended error information.
1171
1172	Extended error information can be set by VirtualBox components after
1173	unsuccessful or partially successful method invocation. This information
1174	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1175	and then shown to the client in addition to the plain 32-bit result code.
1176
1177	In MS COM, this interface extends the IErrorInfo interface,
1178	in XPCOM, it extends the nsIException interface. In both cases,
1179	it provides a set of common attributes to retrieve error
1180	information.
1181
1182	Sometimes invocation of some component's method may involve methods of
1183	other components that may also fail (independently of this method's
1184	failure), or a series of non-fatal errors may precede a fatal error that
1185	causes method failure. In cases like that, it may be desirable to preserve
1186	information about all errors happened during method invocation and deliver
1187	it to the caller. The <link to="#next"/> attribute is intended
1188	specifically for this purpose and allows to represent a chain of errors
1189	through a single IVirtualBoxErrorInfo object set after method invocation.
1190
1191	Note that errors are stored to a chain in the reverse order, i.e. the
1192	initial error object you query right after method invocation is the last
1193	error set by the callee, the object it points to in the @a next attribute
1194	is the previous error and so on, up to the first error (which is the last
1195	in the chain).
1196	</desc>
1197
1198	<attribute name="resultCode" type="long" readonly="yes">
1199	<desc>
1200	Result code of the error.
1201	Usually, it will be the same as the result code returned
1202	by the method that provided this error information, but not
1203	always. For example, on Win32, CoCreateInstance() will most
1204	likely return E_NOINTERFACE upon unsuccessful component
1205	instantiation attempt, but not the value the component factory
1206	returned. Value is typed 'long', not 'result',
1207	to make interface usable from scripting languages.
1208	<note>
1209	In MS COM, there is no equivalent.
1210	In XPCOM, it is the same as nsIException::result.
1211	</note>
1212	</desc>
1213	</attribute>
1214
1215	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1216	<desc>
1217	UUID of the interface that defined the error.
1218	<note>
1219	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1220	data type.
1221	In XPCOM, there is no equivalent.
1222	</note>
1223	</desc>
1224	</attribute>
1225
1226	<attribute name="component" type="wstring" readonly="yes">
1227	<desc>
1228	Name of the component that generated the error.
1229	<note>
1230	In MS COM, it is the same as IErrorInfo::GetSource.
1231	In XPCOM, there is no equivalent.
1232	</note>
1233	</desc>
1234	</attribute>
1235
1236	<attribute name="text" type="wstring" readonly="yes">
1237	<desc>
1238	Text description of the error.
1239	<note>
1240	In MS COM, it is the same as IErrorInfo::GetDescription.
1241	In XPCOM, it is the same as nsIException::message.
1242	</note>
1243	</desc>
1244	</attribute>
1245
1246	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1247	<desc>
1248	Next error object if there is any, or @c null otherwise.
1249	<note>
1250	In MS COM, there is no equivalent.
1251	In XPCOM, it is the same as nsIException::inner.
1252	</note>
1253	</desc>
1254	</attribute>
1255
1256	</interface>
1257
1258	<!--
1259	// IVirtualBox
1260	/////////////////////////////////////////////////////////////////////////
1261	-->
1262
1263	<interface
1264	name="IDHCPServer" extends="$unknown"
1265	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1266	wsmap="managed"
1267	>
1268	<desc>
1269	The IDHCPServer interface represents the vbox dhcp server configuration.
1270
1271	To enumerate all the dhcp servers on the host, use the
1272	<link to="IVirtualBox::DHCPServers"/> attribute.
1273	</desc>
1274
1275	<attribute name="enabled" type="boolean">
1276	<desc>
1277	specifies if the dhcp server is enabled
1278	</desc>
1279	</attribute>
1280
1281	<attribute name="IPAddress" type="wstring" readonly="yes">
1282	<desc>
1283	specifies server IP
1284	</desc>
1285	</attribute>
1286
1287	<attribute name="networkMask" type="wstring" readonly="yes">
1288	<desc>
1289	specifies server network mask
1290	</desc>
1291	</attribute>
1292
1293	<attribute name="networkName" type="wstring" readonly="yes">
1294	<desc>
1295	specifies internal network name the server is used for
1296	</desc>
1297	</attribute>
1298
1299	<attribute name="lowerIP" type="wstring" readonly="yes">
1300	<desc>
1301	specifies from IP adrres in server address range
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="upperIP" type="wstring" readonly="yes">
1306	<desc>
1307	specifies to IP adrres in server address range
1308	</desc>
1309	</attribute>
1310
1311	<method name="setConfiguration">
1312	<desc>
1313	configures the server
1314	<result name="E_INVALIDARG">
1315	invalid configuration supplied
1316	</result>
1317	</desc>
1318	<param name="IPAddress" type="wstring" dir="in">
1319	<desc>
1320	server IP address
1321	</desc>
1322	</param>
1323	<param name="networkMask" type="wstring" dir="in">
1324	<desc>
1325	server network mask
1326	</desc>
1327	</param>
1328	<param name="FromIPAddress" type="wstring" dir="in">
1329	<desc>
1330	server From IP address for address range
1331	</desc>
1332	</param>
1333	<param name="ToIPAddress" type="wstring" dir="in">
1334	<desc>
1335	server To IP address for address range
1336	</desc>
1337	</param>
1338	</method>
1339
1340	<method name="start">
1341	<desc>
1342	Starts DHCP server process.
1343	<result name="E_FAIL">
1344	Failed to start the process.
1345	</result>
1346	</desc>
1347	<param name="networkName" type="wstring" dir="in">
1348	<desc>
1349	Name of internal network DHCP server should attach to.
1350	</desc>
1351	</param>
1352	<param name="trunkName" type="wstring" dir="in">
1353	<desc>
1354	Name of internal network trunk.
1355	</desc>
1356	</param>
1357	<param name="trunkType" type="wstring" dir="in">
1358	<desc>
1359	Type of internal network trunk.
1360	</desc>
1361	</param>
1362	</method>
1363
1364	<method name="stop">
1365	<desc>
1366	Stops DHCP server process.
1367	<result name="E_FAIL">
1368	Failed to stop the process.
1369	</result>
1370	</desc>
1371	</method>
1372	</interface>
1373
1374	<interface
1375	name="IVirtualBox" extends="$unknown"
1376	uuid="ec6cc7e7-06a2-4c5d-8993-1e3619c53817"
1377	wsmap="managed"
1378	>
1379	<desc>
1380	The IVirtualBox interface represents the main interface exposed by the
1381	product that provides virtual machine management.
1382
1383	An instance of IVirtualBox is required for the product to do anything
1384	useful. Even though the interface does not expose this, internally,
1385	IVirtualBox is implemented as a singleton and actually lives in the
1386	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1387	IVirtualBox can track the state of all virtual machines on a particular
1388	host, regardless of which frontend started them.
1389
1390	To enumerate all the virtual machines on the host, use the
1391	<link to="IVirtualBox::machines"/> attribute.
1392	</desc>
1393
1394	<attribute name="version" type="wstring" readonly="yes">
1395	<desc>
1396	A string representing the version number of the product. The
1397	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1398	last number represents the build number and will frequently change.
1399	</desc>
1400	</attribute>
1401
1402	<attribute name="revision" type="unsigned long" readonly="yes">
1403	<desc>
1404	The internal build revision number of the product.
1405	</desc>
1406	</attribute>
1407
1408	<attribute name="packageType" type="wstring" readonly="yes">
1409	<desc>
1410	A string representing the package type of this product. The
1411	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1412	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1413	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1414	this.
1415	</desc>
1416	</attribute>
1417
1418	<attribute name="homeFolder" type="wstring" readonly="yes">
1419	<desc>
1420	Full path to the directory where the global settings file,
1421	<tt>VirtualBox.xml</tt>, is stored.
1422
1423	In this version of VirtualBox, the value of this property is
1424	always <tt><user_dir>/.VirtualBox</tt> (where
1425	<tt><user_dir></tt> is the path to the user directory,
1426	as determined by the host OS), and cannot be changed.
1427
1428	This path is also used as the base to resolve relative paths in
1429	places where relative paths are allowed (unless otherwise
1430	expressly indicated).
1431	</desc>
1432	</attribute>
1433
1434	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1435	<desc>
1436	Full name of the global settings file.
1437	The value of this property corresponds to the value of
1438	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1439	</desc>
1440	</attribute>
1441
1442	<attribute name="host" type="IHost" readonly="yes">
1443	<desc>Associated host object.</desc>
1444	</attribute>
1445
1446	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1447	<desc>Associated system information object.</desc>
1448	</attribute>
1449
1450	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1451	<desc>
1452	Array of machine objects registered within this VirtualBox instance.
1453	</desc>
1454	</attribute>
1455
1456	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1457	<desc>
1458	Array of medium objects known to this VirtualBox installation.
1459
1460	This array contains only base media. All differencing
1461	media of the given base medium can be enumerated using
1462	<link to="IMedium::children"/>.
1463	</desc>
1464	</attribute>
1465
1466	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1467	<desc>
1468	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1469	</desc>
1470	</attribute>
1471
1472	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1473	<desc>
1474	Array of floppy image objects currently in use by this VirtualBox instance.
1475	</desc>
1476	</attribute>
1477
1478	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1479
1480	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1481
1482	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1483	<desc>
1484	Collection of global shared folders. Global shared folders are
1485	available to all virtual machines.
1486
1487	New shared folders are added to the collection using
1488	<link to="#createSharedFolder"/>. Existing shared folders can be
1489	removed using <link to="#removeSharedFolder"/>.
1490
1491	<note>
1492	In the current version of the product, global shared folders are not
1493	implemented and therefore this collection is always empty.
1494	</note>
1495	</desc>
1496	</attribute>
1497
1498	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1499	<desc>
1500	Associated performance collector object.
1501	</desc>
1502	</attribute>
1503
1504	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1505	<desc>
1506	dhcp server settings.
1507	</desc>
1508	</attribute>
1509
1510	<attribute name="eventSource" type="IEventSource" readonly="yes">
1511	<desc>
1512	Event source for VirtualBox events.
1513	</desc>
1514	</attribute>
1515
1516
1517	<method name="createMachine">
1518	<desc>
1519	Creates a new virtual machine.
1520
1521	The new machine is created unregistered, with the initial configuration
1522	set according to the specified guest OS type. A typical sequence of
1523	actions to create a new virtual machine is as follows:
1524
1525	<ol>
1526	<li>
1527	Call this method to have a new machine created. The returned machine
1528	object will be "mutable" allowing to change any machine property.
1529	</li>
1530
1531	<li>
1532	Configure the machine using the appropriate attributes and methods.
1533	</li>
1534
1535	<li>
1536	Call <link to="IMachine::saveSettings" /> to write the settings
1537	to the machine's XML settings file. The configuration of the newly
1538	created machine will not be saved to disk until this method is
1539	called.
1540	</li>
1541
1542	<li>
1543	Call <link to="#registerMachine" /> to add the machine to the list
1544	of machines known to VirtualBox.
1545	</li>
1546	</ol>
1547
1548	You should specify valid name for the newly created machine when calling
1549	this method. See the <link to="IMachine::name"/> attribute description
1550	for more details about the machine name.
1551
1552	The specified guest OS type identifier must match an ID of one of known
1553	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1554	array.
1555
1556	Every machine has a <i>settings file</i> that is used to store
1557	the machine configuration. This file is stored in a directory called the
1558	<i>machine settings subfolder</i>. Both the settings subfolder and file
1559	will have a name that corresponds to the name of the virtual machine.
1560	You can specify where to create the machine setting subfolder using the
1561	@a baseFolder argument. The base folder can be absolute (full path) or
1562	relative to the <link to="IVirtualBox::homeFolder">VirtualBox home
1563	directory</link>.
1564
1565	If @a baseFolder is a @c null or empty string (which is recommended), the
1566	<link to="ISystemProperties::defaultMachineFolder">default machine
1567	settings folder</link> will be used as a base folder for the created
1568	machine. Otherwise the given base folder will be used. In either case,
1569	the full path to the resulting settings file has the following
1570	structure:
1571	<pre>
1572	<base_folder>/<machine_name>/<machine_name>.xml
1573	</pre>
1574
1575	Note that if the resulting settings file already exists, this method
1576	will fail with <link to="VBOX_E_FILE_ERROR"/>.
1577
1578	Optionally, you may specify an UUID of to assign to the created machine.
1579	However, this is not recommended and you should normally pass an empty
1580	(@c null) UUID to this method so that a new UUID will be automatically
1581	generated for every created machine. You can use UUID
1582	00000000-0000-0000-0000-000000000000 as @c null value.
1583
1584	<note>
1585	There is no way to change the name of the settings file or
1586	subfolder of the created machine directly.
1587	</note>
1588
1589	<result name="VBOX_E_OBJECT_NOT_FOUND">
1590	@a osTypeId is invalid.
1591	</result>
1592	<result name="VBOX_E_FILE_ERROR">
1593	Resulting settings file name is invalid or the settings file already
1594	exists or could not be created due to an I/O error.
1595	</result>
1596	<result name="E_INVALIDARG">
1597	@a name is empty or @c null.
1598	</result>
1599	</desc>
1600
1601	<param name="name" type="wstring" dir="in">
1602	<desc>Machine name.</desc>
1603	</param>
1604	<param name="osTypeId" type="wstring" dir="in">
1605	<desc>Guest OS Type ID.</desc>
1606	</param>
1607	<param name="baseFolder" type="wstring" dir="in">
1608	<desc>Base machine folder (optional).</desc>
1609	</param>
1610	<param name="id" type="uuid" mod="string" dir="in">
1611	<desc>Machine UUID (optional).</desc>
1612	</param>
1613	<param name="override" type="boolean" dir="in">
1614	<desc>Create the VM even if there are conflicting files.</desc>
1615	</param>
1616	<param name="machine" type="IMachine" dir="return">
1617	<desc>Created machine object.</desc>
1618	</param>
1619	</method>
1620
1621	<method name="openMachine">
1622	<desc>
1623	Opens a virtual machine from the existing settings file.
1624	The opened machine remains unregistered until you call
1625	<link to="#registerMachine"/>.
1626
1627	The specified settings file name can be absolute
1628	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1629	VirtualBox home directory</link>. This file must exist
1630	and must be a valid machine settings file whose contents
1631	will be used to construct the machine object.
1632
1633	<result name="VBOX_E_FILE_ERROR">
1634	Settings file name invalid, not found or sharing violation.
1635	</result>
1636	</desc>
1637	<param name="settingsFile" type="wstring" dir="in">
1638	<desc>
1639	Name of the machine settings file.
1640	</desc>
1641	</param>
1642	<param name="machine" type="IMachine" dir="return">
1643	<desc>Opened machine object.</desc>
1644	</param>
1645	<note>
1646	<link to="IMachine::settingsModified"/> will return
1647	@c false for the created machine, until any of machine settings
1648	are changed.
1649	</note>
1650	</method>
1651
1652	<method name="registerMachine">
1653	<desc>
1654
1655	Registers the machine previously created using
1656	<link to="#createMachine"/> or opened using
1657	<link to="#openMachine"/> within this VirtualBox installation. After
1658	successful method invocation, the
1659	<link to="IMachineRegisteredEvent"/> event is fired.
1660
1661	<note>
1662	This method implicitly calls <link to="IMachine::saveSettings"/>
1663	to save all current machine settings before registering it.
1664	</note>
1665
1666	<result name="VBOX_E_OBJECT_NOT_FOUND">
1667	No matching virtual machine found.
1668	</result>
1669	<result name="VBOX_E_INVALID_OBJECT_STATE">
1670	Virtual machine was not created within this VirtualBox instance.
1671	</result>
1672
1673	</desc>
1674	<param name="machine" type="IMachine" dir="in"/>
1675	</method>
1676
1677	<method name="getMachine">
1678	<desc>
1679	Attempts to find a virtual machine given its UUID.
1680	To look up a machine by name, use <link to="IVirtualBox::findMachine" />
1681	instead.
1682
1683	<result name="VBOX_E_OBJECT_NOT_FOUND">
1684	Could not find registered machine matching @a id.
1685	</result>
1686
1687	</desc>
1688	<param name="id" type="uuid" mod="string" dir="in"/>
1689	<param name="machine" type="IMachine" dir="return"/>
1690	</method>
1691
1692	<method name="findMachine">
1693	<desc>
1694	Attempts to find a virtual machine given its name.
1695	To look up a machine by UUID, use <link to="IVirtualBox::getMachine" />
1696	instead.
1697
1698	<result name="VBOX_E_OBJECT_NOT_FOUND">
1699	Could not find registered machine matching @a name.
1700	</result>
1701
1702	</desc>
1703	<param name="name" type="wstring" dir="in"/>
1704	<param name="machine" type="IMachine" dir="return"/>
1705	</method>
1706
1707	<method name="createAppliance">
1708	<desc>
1709	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1710	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1711	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1712	</desc>
1713	<param name="appliance" type="IAppliance" dir="return">
1714	<desc>New appliance.</desc>
1715	</param>
1716	</method>
1717
1718	<method name="createHardDisk">
1719	<desc>
1720	Creates a new base medium object that will use the given storage
1721	format and location for medium data.
1722
1723	Note that the actual storage unit is not created by this method. In
1724	order to do it, and before you are able to attach the created medium
1725	to virtual machines, you must call one of the following methods to
1726	allocate a format-specific storage unit at the specified location:
1727	<ul>
1728	<li><link to="IMedium::createBaseStorage"/></li>
1729	<li><link to="IMedium::createDiffStorage"/></li>
1730	</ul>
1731
1732	Some medium attributes, such as <link to="IMedium::id"/>, may
1733	remain uninitialized until the medium storage unit is successfully
1734	created by one of the above methods.
1735
1736	After the storage unit is successfully created, it will be
1737	accessible through the <link to="#findMedium"/> method and can
1738	be found in the <link to="#hardDisks"/> array.
1739
1740	The list of all storage formats supported by this VirtualBox
1741	installation can be obtained using
1742	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1743	attribute is empty or @c null then the default storage format
1744	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1745	be used for creating a storage unit of the medium.
1746
1747	Note that the format of the location string is storage format specific.
1748	See <link to="IMedium::location"/>, IMedium and
1749	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1750
1751	<result name="VBOX_E_OBJECT_NOT_FOUND">
1752	@a format identifier is invalid. See
1753	<link to="ISystemProperties::mediumFormats"/>.
1754	</result>
1755	<result name="VBOX_E_FILE_ERROR">
1756	@a location is a not valid file name (for file-based formats only).
1757	</result>
1758	</desc>
1759	<param name="format" type="wstring" dir="in">
1760	<desc>
1761	Identifier of the storage format to use for the new medium.
1762	</desc>
1763	</param>
1764	<param name="location" type="wstring" dir="in">
1765	<desc>
1766	Location of the storage unit for the new medium.
1767	</desc>
1768	</param>
1769	<param name="medium" type="IMedium" dir="return">
1770	<desc>Created medium object.</desc>
1771	</param>
1772	</method>
1773
1774	<method name="openMedium">
1775	<desc>
1776	Opens a medium from an existing storage location.
1777
1778	Once a medium has been opened, it can be passed to other VirtualBox
1779	methods, in particular to <link to="IMachine::attachDevice" />.
1780
1781	Depending on the given device type, the file at the storage location
1782	must be in one of the media formats understood by VirtualBox:
1783
1784	<ul>
1785	<li>With a "HardDisk" device type, the file must be a hard disk image
1786	in one of the formats supported by VirtualBox (see
1787	<link to="ISystemProperties::mediumFormats" />).
1788	After this method succeeds, if the medium is a base medium, it
1789	will be added to the <link to="#hardDisks"/> array attribute. </li>
1790	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1791	After this method succeeds, the medium will be added to the
1792	<link to="#DVDImages"/> array attribute.</li>
1793	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1794	After this method succeeds, the medium will be added to the
1795	<link to="#floppyImages"/> array attribute.</li>
1796	</ul>
1797
1798	After having been opened, the medium can be found by the <link to="#findMedium"/>
1799	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1800
1801	The UUID of the newly opened medium will either be retrieved from the
1802	storage location, if the format supports it (e.g. for hard disk images),
1803	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1804	If for some reason you need to change the medium's UUID, use
1805	<link to="IMedium::setIDs" />.
1806
1807	If a differencing hard disk medium is to be opened by this method, the
1808	operation will succeed only if its parent medium and all ancestors,
1809	if any, are already known to this VirtualBox installation (for example,
1810	were opened by this method before).
1811
1812	This method attempts to guess the storage format of the specified medium
1813	by reading medium data at the specified location.
1814
1815	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1816	the image is opened for read/write access and must have according permissions,
1817	as VirtualBox may actually write status information into the disk's metadata
1818	sections.
1819
1820	Note that write access is required for all typical hard disk usage in VirtualBox,
1821	since VirtualBox may need to write metadata such as a UUID into the image.
1822	The only exception is opening a source image temporarily for copying and
1823	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1824	again soon.
1825
1826	The format of the location string is storage format specific. See
1827	<link to="IMedium::location"/>, IMedium and
1828	<link to="ISystemProperties::defaultHardDiskFolder"/> for more details.
1829
1830	Prior to VirtualBox 3.3, opening a medium added it to a global media
1831	registry in the VirtualBox.xml file, which was shared between
1832	all machines and made transporting machines and their media from one
1833	host to another difficult.
1834
1835	Starting with VirtualBox 3.3, media are only added to a registry when
1836	they are attached to a machine. Machines created with VirtualBox 3.3
1837	or later can have their own media registry. As a result, a medium attached
1838	to such a machine will be remembered in that machine's XML settings file.
1839	Media attached to older machines will continue to be added to the global
1840	registry.
1841
1842	<result name="VBOX_E_FILE_ERROR">
1843	Invalid medium storage file location or could not find the medium
1844	at the specified location.
1845	</result>
1846	<result name="VBOX_E_IPRT_ERROR">
1847	Could not get medium storage format.
1848	</result>
1849	<result name="E_INVALIDARG">
1850	Invalid medium storage format.
1851	</result>
1852	<result name="VBOX_E_INVALID_OBJECT_STATE">
1853	Medium has already been added to a media registry.
1854	</result>
1855	</desc>
1856	<param name="location" type="wstring" dir="in">
1857	<desc>
1858	Location of the storage unit that contains medium data in one of
1859	the supported storage formats.
1860	</desc>
1861	</param>
1862	<param name="deviceType" type="DeviceType" dir="in">
1863	<desc>
1864	Must be one of "HardDisk", "DVD" or "Floppy".
1865	</desc>
1866	</param>
1867	<param name="accessMode" type="AccessMode" dir="in">
1868	<desc>Whether to open the image in read/write or read-only mode. For
1869	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1870	</param>
1871	<param name="medium" type="IMedium" dir="return">
1872	<desc>Opened medium object.</desc>
1873	</param>
1874	</method>
1875
1876	<method name="findMedium">
1877	<desc>
1878	Returns a medium of the given type that uses the given location or
1879	UUID to store medium data.
1880
1881	The given medium must be known to this VirtualBox installation, i.e.
1882	it must be previously created by <link to="#createHardDisk"/> or opened
1883	by <link to="#openMedium"/>.
1884
1885	The search is done by comparing the value of the @a location argument to
1886	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1887	attributes of each known medium.
1888
1889	For locations represented by file names in the host's file system, the
1890	requested location can be a path relative to the
1891	<link to="IVirtualBox::homeFolder">VirtualBox home folder</link>. If
1892	only a file name without any path is given, the
1893	<link to="ISystemProperties::defaultHardDiskFolder"> default medium
1894	folder</link> will be prepended to the file name before searching. Note
1895	that on case sensitive file systems, a case sensitive comparison is
1896	performed, otherwise the case of symbols in the file path is ignored.
1897
1898	<result name="VBOX_E_OBJECT_NOT_FOUND">
1899	No medium object matching @a location found.
1900	</result>
1901	</desc>
1902	<param name="location" type="wstring" dir="in">
1903	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1904	</param>
1905	<param name="type" type="DeviceType" dir="in">
1906	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1907	</param>
1908	<param name="medium" type="IMedium" dir="return">
1909	<desc>Medium object, if found.</desc>
1910	</param>
1911	</method>
1912
1913	<method name="getGuestOSType">
1914	<desc>
1915	Returns an object describing the specified guest OS type.
1916
1917	The requested guest OS type is specified using a string which is a
1918	mnemonic identifier of the guest operating system, such as
1919	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1920	particular virtual machine can be read or set using the
1921	<link to="IMachine::OSTypeId"/> attribute.
1922
1923	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1924	available guest OS type objects. Each object has an
1925	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1926	the guest OS this object describes.
1927
1928	<result name="E_INVALIDARG">
1929	@a id is not a valid Guest OS type.
1930	</result>
1931
1932	</desc>
1933	<param name="id" type="uuid" mod="string" dir="in">
1934	<desc>Guest OS type ID string.</desc>
1935	</param>
1936	<param name="type" type="IGuestOSType" dir="return">
1937	<desc>Guest OS type object.</desc>
1938	</param>
1939	</method>
1940
1941	<method name="createSharedFolder">
1942	<desc>
1943	Creates a new global shared folder by associating the given logical
1944	name with the given host path, adds it to the collection of shared
1945	folders and starts sharing it. Refer to the description of
1946	<link to="ISharedFolder"/> to read more about logical names.
1947	<note>
1948	In the current implementation, this operation is not
1949	implemented.
1950	</note>
1951	</desc>
1952	<param name="name" type="wstring" dir="in">
1953	<desc>Unique logical name of the shared folder.</desc>
1954	</param>
1955	<param name="hostPath" type="wstring" dir="in">
1956	<desc>Full path to the shared folder in the host file system.</desc>
1957	</param>
1958	<param name="writable" type="boolean" dir="in">
1959	<desc>Whether the share is writable or readonly</desc>
1960	</param>
1961	<param name="automount" type="boolean" dir="in">
1962	<desc>Whether the share gets automatically mounted by the guest
1963	or not.</desc>
1964	</param>
1965	</method>
1966
1967	<method name="removeSharedFolder">
1968	<desc>
1969	Removes the global shared folder with the given name previously
1970	created by <link to="#createSharedFolder"/> from the collection of
1971	shared folders and stops sharing it.
1972	<note>
1973	In the current implementation, this operation is not
1974	implemented.
1975	</note>
1976	</desc>
1977	<param name="name" type="wstring" dir="in">
1978	<desc>Logical name of the shared folder to remove.</desc>
1979	</param>
1980	</method>
1981
1982	<method name="getExtraDataKeys">
1983	<desc>
1984	Returns an array representing the global extra data keys which currently
1985	have values defined.
1986	</desc>
1987	<param name="value" type="wstring" dir="return" safearray="yes">
1988	<desc>Array of extra data keys.</desc>
1989	</param>
1990	</method>
1991
1992	<method name="getExtraData">
1993	<desc>
1994	Returns associated global extra data.
1995
1996	If the requested data @a key does not exist, this function will
1997	succeed and return an empty string in the @a value argument.
1998
1999	<result name="VBOX_E_FILE_ERROR">
2000	Settings file not accessible.
2001	</result>
2002	<result name="VBOX_E_XML_ERROR">
2003	Could not parse the settings file.
2004	</result>
2005
2006	</desc>
2007	<param name="key" type="wstring" dir="in">
2008	<desc>Name of the data key to get.</desc>
2009	</param>
2010	<param name="value" type="wstring" dir="return">
2011	<desc>Value of the requested data key.</desc>
2012	</param>
2013	</method>
2014
2015	<method name="setExtraData">
2016	<desc>
2017	Sets associated global extra data.
2018
2019	If you pass @c null or empty string as a key @a value, the given @a key
2020	will be deleted.
2021
2022	<note>
2023	Before performing the actual data change, this method will ask all
2024	registered event listener using the
2025	<link to="IExtraDataCanChangeEvent"/>
2026	notification for a permission. If one of the listeners refuses the
2027	new value, the change will not be performed.
2028	</note>
2029	<note>
2030	On success, the
2031	<link to="IExtraDataChangedEvent"/> notification
2032	is called to inform all registered listeners about a successful data
2033	change.
2034	</note>
2035
2036	<result name="VBOX_E_FILE_ERROR">
2037	Settings file not accessible.
2038	</result>
2039	<result name="VBOX_E_XML_ERROR">
2040	Could not parse the settings file.
2041	</result>
2042	<result name="E_ACCESSDENIED">
2043	Modification request refused.
2044	</result>
2045
2046	</desc>
2047	<param name="key" type="wstring" dir="in">
2048	<desc>Name of the data key to set.</desc>
2049	</param>
2050	<param name="value" type="wstring" dir="in">
2051	<desc>Value to assign to the key.</desc>
2052	</param>
2053	</method>
2054
2055	<method name="waitForPropertyChange">
2056	<desc>
2057	Blocks the caller until any of the properties represented by the
2058	@a what argument changes the value or until the given timeout interval
2059	expires.
2060
2061	The @a what argument is a comma separated list of property masks that
2062	describe properties the caller is interested in. The property mask is
2063	a string in the following format:
2064
2065	<pre>
2066	[[group.]subgroup.]name
2067	</pre>
2068
2069	where @c name is the property name and @c group, @c subgroup are zero
2070	or more property group specifiers. Each element (group or name) in
2071	the property mask may be either a Latin string or an asterisk symbol
2072	(@c "*") which is used to match any string for the given element. A
2073	property mask that doesn't contain asterisk symbols represents a
2074	single fully qualified property name.
2075
2076	Groups in the fully qualified property name go from more generic (the
2077	left-most part) to more specific (the right-most part). The first
2078	element is usually a name of the object the property belongs to. The
2079	second element may be either a property name, or a child object name,
2080	or an index if the preceding element names an object which is one of
2081	many objects of the same type. This way, property names form a
2082	hierarchy of properties. Here are some examples of property names:
2083
2084	<table>
2085	<tr>
2086	<td><tt>VirtualBox.version</tt></td>
2087	<td><link to="IVirtualBox::version"/> property</td>
2088	</tr>
2089	<tr>
2090	<td><tt>Machine.<UUID>.name</tt></td>
2091	<td><link to="IMachine::name"/> property of the machine with the
2092	given UUID</td>
2093	</tr>
2094	</table>
2095
2096	Most property names directly correspond to the properties of objects
2097	(components) provided by the VirtualBox library and may be used to
2098	track changes to these properties. However, there may be
2099	pseudo-property names that don't correspond to any existing object's
2100	property directly, as well as there may be object properties that
2101	don't have a corresponding property name that is understood by this
2102	method, and therefore changes to such properties cannot be
2103	tracked. See individual object's property descriptions to get a
2104	fully qualified property name that can be used with this method (if
2105	any).
2106
2107	There is a special property mask @c "*" (i.e. a string consisting of a
2108	single asterisk symbol) that can be used to match all properties.
2109	Below are more examples of property masks:
2110
2111	<table>
2112	<tr>
2113	<td><tt>VirtualBox.*</tt></td>
2114	<td>Track all properties of the VirtualBox object</td>
2115	</tr>
2116	<tr>
2117	<td><tt>Machine.*.name</tt></td>
2118	<td>Track changes to the <link to="IMachine::name"/> property of
2119	all registered virtual machines</td>
2120	</tr>
2121	</table>
2122
2123	<note>
2124	This function is not implemented in the current version of the
2125	product.
2126	</note>
2127	</desc>
2128	<param name="what" type="wstring" dir="in">
2129	<desc>Comma separated list of property masks.</desc>
2130	</param>
2131	<param name="timeout" type="unsigned long" dir="in">
2132	<desc>
2133	Wait timeout in milliseconds.
2134	Specify -1 for an indefinite wait.
2135	</desc>
2136	</param>
2137	<param name="changed" type="wstring" dir="out">
2138	<desc>
2139	Comma separated list of properties that have been changed and caused
2140	this method to return to the caller.
2141	</desc>
2142	</param>
2143	<param name="values" type="wstring" dir="out">
2144	<desc>Reserved, not currently used.</desc>
2145	</param>
2146	</method>
2147
2148	<!--method name="createDHCPServerForInterface">
2149	<desc>
2150	Creates a dhcp server settings to be used for the given interface
2151	<result name="E_INVALIDARG">
2152	Host network interface @a name already exists.
2153	</result>
2154	</desc>
2155	<param name="interface" type="IHostNetworkInterface" dir="in">
2156	<desc>Network Interface</desc>
2157	</param>
2158	<param name="server" type="IDHCPServer" dir="out">
2159	<desc>Dhcp server settings</desc>
2160	</param>
2161	</method-->
2162
2163	<method name="createDHCPServer">
2164	<desc>
2165	Creates a dhcp server settings to be used for the given internal network name
2166	<result name="E_INVALIDARG">
2167	Host network interface @a name already exists.
2168	</result>
2169	</desc>
2170	<param name="name" type="wstring" dir="in">
2171	<desc>server name</desc>
2172	</param>
2173	<param name="server" type="IDHCPServer" dir="return">
2174	<desc>Dhcp server settings</desc>
2175	</param>
2176	</method>
2177
2178	<method name="findDHCPServerByNetworkName">
2179	<desc>
2180	Searches a dhcp server settings to be used for the given internal network name
2181	<result name="E_INVALIDARG">
2182	Host network interface @a name already exists.
2183	</result>
2184
2185	</desc>
2186	<param name="name" type="wstring" dir="in">
2187	<desc>server name</desc>
2188	</param>
2189	<param name="server" type="IDHCPServer" dir="return">
2190	<desc>Dhcp server settings</desc>
2191	</param>
2192	</method>
2193
2194	<!--method name="findDHCPServerForInterface">
2195	<desc>
2196	Searches a dhcp server settings to be used for the given interface
2197	<result name="E_INVALIDARG">
2198	Host network interface @a name already exists.
2199	</result>
2200	</desc>
2201	<param name="interface" type="IHostNetworkInterface" dir="in">
2202	<desc>Network Interface</desc>
2203	</param>
2204	<param name="server" type="IDHCPServer" dir="out">
2205	<desc>Dhcp server settings</desc>
2206	</param>
2207	</method-->
2208
2209	<method name="removeDHCPServer">
2210	<desc>
2211	Removes the dhcp server settings
2212	<result name="E_INVALIDARG">
2213	Host network interface @a name already exists.
2214	</result>
2215	</desc>
2216	<param name="server" type="IDHCPServer" dir="in">
2217	<desc>Dhcp server settings to be removed</desc>
2218	</param>
2219	</method>
2220
2221
2222	<method name="checkFirmwarePresent">
2223	<desc>
2224	Check if this VirtualBox installation has a firmware
2225	of the given type available, either system-wide or per-user.
2226	Optionally, this may return a hint where this firmware can be
2227	downloaded from.
2228	</desc>
2229	<param name="firmwareType" type="FirmwareType" dir="in">
2230	<desc>
2231	Type of firmware to check.
2232	</desc>
2233	</param>
2234	<param name="version" type="wstring" dir="in">
2235	<desc>Expected version number, usually empty string (presently ignored).</desc>
2236	</param>
2237
2238	<param name="url" type="wstring" dir="out">
2239	<desc>
2240	Suggested URL to download this firmware from.
2241	</desc>
2242	</param>
2243
2244	<param name="file" type="wstring" dir="out">
2245	<desc>
2246	Filename of firmware, only valid if result == TRUE.
2247	</desc>
2248	</param>
2249
2250	<param name="result" type="boolean" dir="return">
2251	<desc>If firmware of this type and version is available.</desc>
2252	</param>
2253	</method>
2254
2255	</interface>
2256
2257	<!--
2258	// IVFSExplorer
2259	/////////////////////////////////////////////////////////////////////////
2260	-->
2261
2262	<enum
2263	name="VFSType"
2264	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2265	>
2266	<desc>
2267	Virtual file systems supported by VFSExplorer.
2268	</desc>
2269
2270	<const name="File" value="1" />
2271	<const name="Cloud" value="2" />
2272	<const name="S3" value="3" />
2273	<const name="WebDav" value="4" />
2274	</enum>
2275
2276	<enum
2277	name="VFSFileType"
2278	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2279	>
2280	<desc>
2281	File types known by VFSExplorer.
2282	</desc>
2283
2284	<const name="Unknown" value="1" />
2285	<const name="Fifo" value="2" />
2286	<const name="DevChar" value="3" />
2287	<const name="Directory" value="4" />
2288	<const name="DevBlock" value="5" />
2289	<const name="File" value="6" />
2290	<const name="SymLink" value="7" />
2291	<const name="Socket" value="8" />
2292	<const name="WhiteOut" value="9" />
2293	</enum>
2294
2295	<interface
2296	name="IVFSExplorer" extends="$unknown"
2297	uuid="2bb864a1-02a3-4474-a1d4-fb5f23b742e1"
2298	wsmap="managed"
2299	>
2300	<desc>
2301	The VFSExplorer interface unifies access to different file system
2302	types. This includes local file systems as well remote file systems like
2303	S3. For a list of supported types see <link to="VFSType" />.
2304	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2305	</desc>
2306
2307	<attribute name="path" type="wstring" readonly="yes">
2308	<desc>Returns the current path in the virtual file system.</desc>
2309	</attribute>
2310
2311	<attribute name="type" type="VFSType" readonly="yes">
2312	<desc>Returns the file system type which is currently in use.</desc>
2313	</attribute>
2314
2315	<method name="update">
2316	<desc>Updates the internal list of files/directories from the
2317	current directory level. Use <link to="#entryList" /> to get the full list
2318	after a call to this method.</desc>
2319
2320	<param name="aProgress" type="IProgress" dir="return">
2321	<desc>Progress object to track the operation completion.</desc>
2322	</param>
2323	</method>
2324
2325	<method name="cd">
2326	<desc>Change the current directory level.</desc>
2327
2328	<param name="aDir" type="wstring" dir="in">
2329	<desc>The name of the directory to go in.</desc>
2330	</param>
2331
2332	<param name="aProgress" type="IProgress" dir="return">
2333	<desc>Progress object to track the operation completion.</desc>
2334	</param>
2335	</method>
2336
2337	<method name="cdUp">
2338	<desc>Go one directory upwards from the current directory level.</desc>
2339
2340	<param name="aProgress" type="IProgress" dir="return">
2341	<desc>Progress object to track the operation completion.</desc>
2342	</param>
2343	</method>
2344
2345	<method name="entryList">
2346	<desc>Returns a list of files/directories after a call to <link
2347	to="#update" />. The user is responsible for keeping this internal
2348	list up do date.</desc>
2349
2350	<param name="aNames" type="wstring" safearray="yes" dir="out">
2351	<desc>The list of names for the entries.</desc>
2352	</param>
2353
2354	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2355	<desc>The list of types for the entries.</desc>
2356	</param>
2357	</method>
2358
2359	<method name="exists">
2360	<desc>Checks if the given file list exists in the current directory
2361	level.</desc>
2362
2363	<param name="aNames" type="wstring" safearray="yes" dir="in">
2364	<desc>The names to check.</desc>
2365	</param>
2366
2367	<param name="aExists" type="wstring" safearray="yes" dir="return">
2368	<desc>The names which exist.</desc>
2369	</param>
2370	</method>
2371
2372	<method name="remove">
2373	<desc>Deletes the given files in the current directory level.</desc>
2374
2375	<param name="aNames" type="wstring" safearray="yes" dir="in">
2376	<desc>The names to remove.</desc>
2377	</param>
2378
2379	<param name="aProgress" type="IProgress" dir="return">
2380	<desc>Progress object to track the operation completion.</desc>
2381	</param>
2382	</method>
2383
2384	</interface>
2385
2386	<!--
2387	// IAppliance
2388	/////////////////////////////////////////////////////////////////////////
2389	-->
2390
2391	<interface
2392	name="IAppliance" extends="$unknown"
2393	uuid="fb61a4fc-57e7-48d6-859b-71f37d484cf2"
2394	wsmap="managed"
2395	>
2396	<desc>
2397	Represents a platform-independent appliance in OVF format. An instance of this is returned
2398	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2399	virtual machines within an appliance with VirtualBox.
2400
2401	The OVF standard suggests two different physical file formats:
2402
2403	<ol>
2404	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2405	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2406	this descriptor file references other files such as disk images, as OVF appliances typically
2407	do, those additional files must be in the same directory as the descriptor file.</li>
2408
2409	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2410	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2411	files and optionally other files.
2412
2413	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2414	be added with a later version.</li>
2415	</ol>
2416
2417	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2418	<link to="IMachine" /> involves the following sequence of API calls:
2419
2420	<ol>
2421	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2422	</li>
2423
2424	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2425	would like to import. So long as this file is syntactically valid, this will succeed
2426	and fill the appliance object with the parsed data from the OVF file.
2427	</li>
2428
2429	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2430	contents of the IAppliance attributes accordingly. These can be inspected by a
2431	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2432	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2433	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2434	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2435	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2436	The GUI can then give the user the option to confirm and/or change these suggestions.
2437	</li>
2438
2439	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2440	virtual system (machine) to override the suggestions made by the interpret() routine.
2441	</li>
2442
2443	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2444	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2445	virtual system descriptions. After this call suceeded, the UUIDs of the machines created
2446	can be found in the <link to="#machines" /> array attribute.
2447	</li>
2448	</ol>
2449
2450	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2451
2452	<ol>
2453	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2454	an empty IAppliance object.
2455	</li>
2456
2457	<li>For each machine you would like to export, call <link to="IMachine::export" />
2458	with the IAppliance object you just created. Each such call creates one instance of
2459	<link to="IVirtualSystemDescription" /> inside the appliance.
2460	</li>
2461
2462	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2463	virtual system (machine) to override the suggestions made by the export() routine.
2464	</li>
2465
2466	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2467	file written.</li>
2468	</ol>
2469
2470	</desc>
2471
2472	<attribute name="path" type="wstring" readonly="yes">
2473	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2474	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2475	<link to="#write" /> (for export).
2476	This attribute is empty until one of these methods has been called.
2477	</desc>
2478	</attribute>
2479
2480	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2481	<desc>
2482	Array of virtual disk definitions. One such description exists for each
2483	disk definition in the OVF; each string array item represents one such piece of
2484	disk information, with the information fields separated by tab (\t) characters.
2485
2486	The caller should be prepared for additional fields being appended to
2487	this string in future versions of VirtualBox and therefore check for
2488	the number of tabs in the strings returned.
2489
2490	In the current version, the following eight fields are returned per string
2491	in the array:
2492
2493	<ol>
2494	<li>Disk ID (unique string identifier given to disk)</li>
2495
2496	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2497
2498	<li>Populated size (optional unsigned integer indicating the current size of the
2499	disk; can be approximate; -1 if unspecified)</li>
2500
2501	<li>Format (string identifying the disk format, typically
2502	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2503
2504	<li>Reference (where to find the disk image, typically a file name; if empty,
2505	then the disk should be created on import)</li>
2506
2507	<li>Image size (optional unsigned integer indicating the size of the image,
2508	which need not necessarily be the same as the values specified above, since
2509	the image may be compressed or sparse; -1 if not specified)</li>
2510
2511	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2512	presently unsupported and always -1)</li>
2513
2514	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2515	</ol>
2516	</desc>
2517	</attribute>
2518
2519	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2520	<desc> Array of virtual system descriptions. One such description is created
2521	for each virtual system (machine) found in the OVF.
2522	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2523	(for export) has been called.
2524	</desc>
2525	</attribute>
2526
2527	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2528	<desc>
2529	Contains the UUIDs of the machines created from the information in this appliances. This is only
2530	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2531	succeeded.
2532	</desc>
2533	</attribute>
2534
2535	<method name="read">
2536	<desc>
2537	Reads an OVF file into the appliance object.
2538
2539	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2540	mere fact that this method returns successfully does not mean that VirtualBox supports all
2541	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2542	</desc>
2543	<param name="file" type="wstring" dir="in">
2544	<desc>
2545	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2546	on whether the appliance is distributed as a set of files or as a single file, respectively).
2547	</desc>
2548	</param>
2549	<param name="aProgress" type="IProgress" dir="return">
2550	<desc>Progress object to track the operation completion.</desc>
2551	</param>
2552	</method>
2553
2554	<method name="interpret">
2555	<desc>
2556	Interprets the OVF data that was read when the appliance was constructed. After
2557	calling this method, one can inspect the
2558	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2559	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2560	the appliance.
2561
2562	Calling this method is the second step of importing an appliance into VirtualBox;
2563	see <link to="IAppliance" /> for an overview.
2564
2565	After calling this method, one should call <link to="#getWarnings" /> to find out
2566	if problems were encountered during the processing which might later lead to
2567	errors.
2568	</desc>
2569	</method>
2570
2571	<method name="importMachines">
2572	<desc>
2573	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2574	and other interfaces that match the information contained in the appliance as
2575	closely as possible, as represented by the import instructions in the
2576	<link to="#virtualSystemDescriptions" /> array.
2577
2578	Calling this method is the final step of importing an appliance into VirtualBox;
2579	see <link to="IAppliance" /> for an overview.
2580
2581	Since importing the appliance will most probably involve copying and converting
2582	disk images, which can take a long time, this method operates asynchronously and
2583	returns an IProgress object to allow the caller to monitor the progress.
2584
2585	After the import succeeded, the UUIDs of the IMachine instances created can be
2586	retrieved from the <link to="#machines" /> array attribute.
2587	</desc>
2588
2589	<param name="aProgress" type="IProgress" dir="return">
2590	<desc>Progress object to track the operation completion.</desc>
2591	</param>
2592	</method>
2593
2594	<method name="createVFSExplorer">
2595	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2596
2597	<param name="aUri" type="wstring" dir="in">
2598	<desc>The URI describing the file system to use.</desc>
2599	</param>
2600
2601	<param name="aExplorer" type="IVFSExplorer" dir="return">
2602	<desc></desc>
2603	</param>
2604	</method>
2605
2606	<method name="write">
2607	<desc>
2608	Writes the contents of the appliance exports into a new OVF file.
2609
2610	Calling this method is the final step of exporting an appliance from VirtualBox;
2611	see <link to="IAppliance" /> for an overview.
2612
2613	Since exporting the appliance will most probably involve copying and converting
2614	disk images, which can take a long time, this method operates asynchronously and
2615	returns an IProgress object to allow the caller to monitor the progress.
2616	</desc>
2617	<param name="format" type="wstring" dir="in">
2618	<desc>
2619	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2620	future versions of VirtualBox may support additional formats.
2621	</desc>
2622	</param>
2623	<param name="path" type="wstring" dir="in">
2624	<desc>
2625	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2626	on whether the appliance is distributed as a set of files or as a single file, respectively).
2627	</desc>
2628	</param>
2629	<param name="aProgress" type="IProgress" dir="return">
2630	<desc>Progress object to track the operation completion.</desc>
2631	</param>
2632	</method>
2633
2634	<method name="getWarnings">
2635	<desc>Returns textual warnings which occured during execution of <link to="#interpret" />.</desc>
2636
2637	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2638	<desc></desc>
2639	</param>
2640	</method>
2641
2642	</interface>
2643
2644	<enum
2645	name="VirtualSystemDescriptionType"
2646	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2647	>
2648	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2649	a configuration value.</desc>
2650
2651	<const name="Ignore" value="1" />
2652	<const name="OS" value="2" />
2653	<const name="Name" value="3" />
2654	<const name="Product" value="4" />
2655	<const name="Vendor" value="5" />
2656	<const name="Version" value="6" />
2657	<const name="ProductUrl" value="7" />
2658	<const name="VendorUrl" value="8" />
2659	<const name="Description" value="9" />
2660	<const name="License" value="10" />
2661	<const name="Miscellaneous" value="11" />
2662	<const name="CPU" value="12" />
2663	<const name="Memory" value="13" />
2664	<const name="HardDiskControllerIDE" value="14" />
2665	<const name="HardDiskControllerSATA" value="15" />
2666	<const name="HardDiskControllerSCSI" value="16" />
2667	<const name="HardDiskControllerSAS" value="17" />
2668	<const name="HardDiskImage" value="18" />
2669	<const name="Floppy" value="19" />
2670	<const name="CDROM" value="20" />
2671	<const name="NetworkAdapter" value="21" />
2672	<const name="USBController" value="22" />
2673	<const name="SoundCard" value="23" />
2674
2675	</enum>
2676
2677	<enum
2678	name="VirtualSystemDescriptionValueType"
2679	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2680	>
2681	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2682	type to fetch.</desc>
2683
2684	<const name="Reference" value="1" />
2685	<const name="Original" value="2" />
2686	<const name="Auto" value="3" />
2687	<const name="ExtraConfig" value="4" />
2688
2689	</enum>
2690
2691	<interface
2692	name="IVirtualSystemDescription" extends="$unknown"
2693	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2694	wsmap="managed"
2695	>
2696
2697	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2698	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2699	<link to="IAppliance::interpret" /> has been called, that array contains information
2700	about how the virtual systems described in the OVF should best be imported into
2701	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2702	import an OVF into VirtualBox.
2703	</desc>
2704
2705	<attribute name="count" type="unsigned long" readonly="yes">
2706	<desc>Return the number of virtual system description entries.</desc>
2707	</attribute>
2708
2709	<method name="getDescription">
2710	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2711	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2712
2713	The list below identifies the value sets that are possible depending on the
2714	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2715	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2716	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2717	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2718	the @a aExtraConfigValues[] array item may also be used.
2719
2720	<ul>
2721	<li>
2722	"OS": the guest operating system type. There must be exactly one such array item on import. The
2723	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2724	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2725	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2726	</li>
2727	<li>
2728	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2729	if none is present on import, then an automatic name will be created from the operating system
2730	type. The correponding item im @a aOvfValues[] will contain the suggested virtual machine name
2731	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2732	<link to="IMachine" /> name that does not exist yet.
2733	</li>
2734	<li>
2735	"Description": an arbitrary description.
2736	</li>
2737	<li>
2738	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2739	code to display such a license for agreement; the Main API does not enforce any such policy.
2740	</li>
2741	<li>
2742	Miscellaneous: reserved for future use.
2743	</li>
2744	<li>
2745	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2746	</li>
2747	<li>
2748	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2749	is present on import, then VirtualBox will set a meaningful default based on the operating system
2750	type.
2751	</li>
2752	<li>
2753	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2754	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2755	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2756	writes into the OVF.
2757	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2758	type can use to specify which hard disk controller a virtual disk should be connected to.
2759	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2760	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2761	its virtual machines supports four channels (primary master, primary slave, secondary master,
2762	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2763	</li>
2764	<li>
2765	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2766	has no value in @a aOvfValues[] or @a aVBoxValues[].
2767	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2768	</li>
2769	<li>
2770	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2771	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2772	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2773	whereas VirtualBox considers it a class of storage controllers of its own; see
2774	<link to="StorageControllerType" />).
2775	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2776	</li>
2777	<li>
2778	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2779	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2780
2781	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2782	a path since the image file should be in the same location as the OVF file itself), whereas the
2783	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2784	hard disk image. This means that on import the image will be copied and converted from the
2785	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2786
2787	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2788	format: "controller=<index>;channel=<c>"
2789	In this string, <index> must be an integer specifying the hard disk controller to connect
2790	the image to. That number must be the index of an array item with one of the hard disk controller
2791	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2792	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2793	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2794	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2795	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2796	</li>
2797	<li>
2798	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2799	attachment information as with "HardDiskImage" items.
2800	</li>
2801	<li>
2802	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2803	attachment information as with "HardDiskImage" items.
2804	</li>
2805	<li>
2806	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2807	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2808	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2809	</li>
2810	<li>
2811	"USBController": a USB controller. There can be at most one such item. If and only if such an
2812	item ispresent, USB support will be enabled for the new virtual machine.
2813	</li>
2814	<li>
2815	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2816	present, sound support will be enabled for the new virtual machine. Note that the virtual
2817	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2818	may be different from the virtual soundcard expected by the appliance.
2819	</li>
2820	</ul>
2821
2822	</desc>
2823
2824	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2825	<desc></desc>
2826	</param>
2827
2828	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2829	<desc></desc>
2830	</param>
2831
2832	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2833	<desc></desc>
2834	</param>
2835
2836	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2837	<desc></desc>
2838	</param>
2839
2840	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2841	<desc></desc>
2842	</param>
2843
2844	</method>
2845
2846	<method name="getDescriptionByType">
2847	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2848	should be returned.</desc>
2849
2850	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2871	<desc></desc>
2872	</param>
2873
2874	</method>
2875
2876	<method name="getValuesByType">
2877	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2878	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2879	values.</desc>
2880
2881	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2882	<desc></desc>
2883	</param>
2884
2885	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2886	<desc></desc>
2887	</param>
2888
2889	<param name="aValues" type="wstring" dir="return" safearray="yes">
2890	<desc></desc>
2891	</param>
2892
2893	</method>
2894
2895	<method name="setFinalValues">
2896	<desc>
2897	This method allows the appliance's user to change the configuration for the virtual
2898	system descriptions. For each array item returned from <link to="#getDescription" />,
2899	you must pass in one boolean value and one configuration value.
2900
2901	Each item in the boolean array determines whether the particular configuration item
2902	should be enabled.
2903	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2904	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2905	and SoundCard.
2906
2907	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2908	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2909	the configuration remains unchanged. Please see the documentation for getDescription()
2910	for valid configuration values for the individual array item types. If the
2911	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2912	</desc>
2913
2914	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2915	<desc></desc>
2916	</param>
2917
2918	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2919	<desc></desc>
2920	</param>
2921
2922	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2923	<desc></desc>
2924	</param>
2925	</method>
2926
2927	<method name="addDescription">
2928	<desc>
2929	This method adds an additional description entry to the stack of already
2930	available descriptions for this virtual system. This is handy for writing
2931	values which aren't directly supported by VirtualBox. One example would
2932	be the License type of <link to="VirtualSystemDescriptionType" />.
2933	</desc>
2934
2935	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2936	<desc></desc>
2937	</param>
2938
2939	<param name="aVBoxValue" type="wstring" dir="in">
2940	<desc></desc>
2941	</param>
2942
2943	<param name="aExtraConfigValue" type="wstring" dir="in">
2944	<desc></desc>
2945	</param>
2946	</method>
2947	</interface>
2948
2949
2950	<!--
2951	// IMachine
2952	/////////////////////////////////////////////////////////////////////////
2953	-->
2954
2955	<interface
2956	name="IInternalMachineControl" extends="$unknown"
2957	uuid="e2da8b1a-2ad1-490e-b29e-c33a144791b6"
2958	internal="yes"
2959	wsmap="suppress"
2960	>
2961	<method name="setRemoveSavedStateFile">
2962	<desc>
2963	Updates the flag whether the saved state file is removed on a
2964	machine state change from Saved to PoweredOff.
2965	</desc>
2966	<param name="aRemove" type="boolean" dir="in"/>
2967	</method>
2968
2969	<method name="updateState">
2970	<desc>
2971	Updates the VM state.
2972	<note>
2973	This operation will also update the settings file with the correct
2974	information about the saved state file and delete this file from disk
2975	when appropriate.
2976	</note>
2977	</desc>
2978	<param name="state" type="MachineState" dir="in"/>
2979	</method>
2980
2981	<method name="getIPCId">
2982	<param name="id" type="wstring" dir="return"/>
2983	</method>
2984
2985	<method name="beginPowerUp">
2986	<desc>
2987	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2988	gives it the progress object that should be part of any pending
2989	<link to="IMachine::launchVMProcess"/> operations. The progress
2990	object may be called back to reflect an early cancelation, so some care
2991	have to be taken with respect to any cancelation callbacks. The console
2992	object will call <link to="IInternalMachineControl::endPowerUp"/>
2993	to signal the completion of the progress object.
2994	</desc>
2995	<param name="aProgress" type="IProgress" dir="in" />
2996	</method>
2997
2998	<method name="endPowerUp">
2999	<desc>
3000	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3001	This method may query status information from the progress object it
3002	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3003	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3004	call in order to complete that progress object.
3005	</desc>
3006	<param name="result" type="long" dir="in"/>
3007	</method>
3008
3009	<method name="runUSBDeviceFilters">
3010	<desc>
3011	Asks the server to run USB devices filters of the associated
3012	machine against the given USB device and tell if there is
3013	a match.
3014	<note>
3015	Intended to be used only for remote USB devices. Local
3016	ones don't require to call this method (this is done
3017	implicitly by the Host and USBProxyService).
3018	</note>
3019	</desc>
3020	<param name="device" type="IUSBDevice" dir="in"/>
3021	<param name="matched" type="boolean" dir="out"/>
3022	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3023	</method>
3024
3025	<method name="captureUSBDevice">
3026	<desc>
3027	Requests a capture of the given host USB device.
3028	When the request is completed, the VM process will
3029	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3030	notification.
3031	</desc>
3032	<param name="id" type="uuid" mod="string" dir="in"/>
3033	</method>
3034
3035	<method name="detachUSBDevice">
3036	<desc>
3037	Notification that a VM is going to detach (@a done = @c false) or has
3038	already detached (@a done = @c true) the given USB device.
3039	When the @a done = @c true request is completed, the VM process will
3040	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3041	notification.
3042	<note>
3043	In the @a done = @c true case, the server must run its own filters
3044	and filters of all VMs but this one on the detached device
3045	as if it were just attached to the host computer.
3046	</note>
3047	</desc>
3048	<param name="id" type="uuid" mod="string" dir="in"/>
3049	<param name="done" type="boolean" dir="in"/>
3050	</method>
3051
3052	<method name="autoCaptureUSBDevices">
3053	<desc>
3054	Requests a capture all matching USB devices attached to the host.
3055	When the request is completed, the VM process will
3056	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3057	notification per every captured device.
3058	</desc>
3059	</method>
3060
3061	<method name="detachAllUSBDevices">
3062	<desc>
3063	Notification that a VM that is being powered down. The done
3064	parameter indicates whether which stage of the power down
3065	we're at. When @a done = @c false the VM is announcing its
3066	intentions, while when @a done = @c true the VM is reporting
3067	what it has done.
3068	<note>
3069	In the @a done = @c true case, the server must run its own filters
3070	and filters of all VMs but this one on all detach devices as
3071	if they were just attached to the host computer.
3072	</note>
3073	</desc>
3074	<param name="done" type="boolean" dir="in"/>
3075	</method>
3076
3077	<method name="onSessionEnd">
3078	<desc>
3079	Triggered by the given session object when the session is about
3080	to close normally.
3081	</desc>
3082	<param name="session" type="ISession" dir="in">
3083	<desc>Session that is being closed</desc>
3084	</param>
3085	<param name="progress" type="IProgress" dir="return">
3086	<desc>
3087	Used to wait until the corresponding machine is actually
3088	dissociated from the given session on the server.
3089	Returned only when this session is a direct one.
3090	</desc>
3091	</param>
3092	</method>
3093
3094	<method name="beginSavingState">
3095	<desc>
3096	Called by the VM process to inform the server it wants to
3097	save the current state and stop the VM execution.
3098	</desc>
3099	<param name="progress" type="IProgress" dir="in">
3100	<desc>
3101	Progress object created by the VM process to wait until
3102	the state is saved.
3103	</desc>
3104	</param>
3105	<param name="stateFilePath" type="wstring" dir="out">
3106	<desc>
3107	File path the VM process must save the execution state to.
3108	</desc>
3109	</param>
3110	</method>
3111
3112	<method name="endSavingState">
3113	<desc>
3114	Called by the VM process to inform the server that saving
3115	the state previously requested by #beginSavingState is either
3116	successfully finished or there was a failure.
3117
3118	<result name="VBOX_E_FILE_ERROR">
3119	Settings file not accessible.
3120	</result>
3121	<result name="VBOX_E_XML_ERROR">
3122	Could not parse the settings file.
3123	</result>
3124
3125	</desc>
3126
3127	<param name="success" type="boolean" dir="in">
3128	<desc>@c true to indicate success and @c false otherwise.
3129	</desc>
3130	</param>
3131	</method>
3132
3133	<method name="adoptSavedState">
3134	<desc>
3135	Gets called by IConsole::adoptSavedState.
3136	<result name="VBOX_E_FILE_ERROR">
3137	Invalid saved state file path.
3138	</result>
3139	</desc>
3140	<param name="savedStateFile" type="wstring" dir="in">
3141	<desc>Path to the saved state file to adopt.</desc>
3142	</param>
3143	</method>
3144
3145	<method name="beginTakingSnapshot">
3146	<desc>
3147	Called from the VM process to request from the server to perform the
3148	server-side actions of creating a snapshot (creating differencing images
3149	and the snapshot object).
3150
3151	<result name="VBOX_E_FILE_ERROR">
3152	Settings file not accessible.
3153	</result>
3154	<result name="VBOX_E_XML_ERROR">
3155	Could not parse the settings file.
3156	</result>
3157	</desc>
3158	<param name="initiator" type="IConsole" dir="in">
3159	<desc>The console object that initiated this call.</desc>
3160	</param>
3161	<param name="name" type="wstring" dir="in">
3162	<desc>Snapshot name.</desc>
3163	</param>
3164	<param name="description" type="wstring" dir="in">
3165	<desc>Snapshot description.</desc>
3166	</param>
3167	<param name="consoleProgress" type="IProgress" dir="in">
3168	<desc>
3169	Progress object created by the VM process tracking the
3170	snapshot's progress. This has the following sub-operations:
3171	<ul>
3172	<li>setting up (weight 1);</li>
3173	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3174	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3175	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3176	<li>finishing up (weight 1)</li>
3177	</ul>
3178	</desc>
3179	</param>
3180	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3181	<desc>
3182	Whether this is an online snapshot (i.e. the machine is running).
3183	</desc>
3184	</param>
3185	<param name="stateFilePath" type="wstring" dir="out">
3186	<desc>
3187	File path the VM process must save the execution state to.
3188	</desc>
3189	</param>
3190	</method>
3191
3192	<method name="endTakingSnapshot">
3193	<desc>
3194	Called by the VM process to inform the server that the snapshot
3195	previously requested by #beginTakingSnapshot is either
3196	successfully taken or there was a failure.
3197	</desc>
3198
3199	<param name="success" type="boolean" dir="in">
3200	<desc>@c true to indicate success and @c false otherwise</desc>
3201	</param>
3202	</method>
3203
3204	<method name="deleteSnapshot">
3205	<desc>
3206	Gets called by IConsole::deleteSnapshot.
3207	<result name="VBOX_E_INVALID_OBJECT_STATE">
3208	Snapshot has more than one child snapshot.
3209	</result>
3210	</desc>
3211	<param name="initiator" type="IConsole" dir="in">
3212	<desc>The console object that initiated this call.</desc>
3213	</param>
3214	<param name="id" type="uuid" mod="string" dir="in">
3215	<desc>UUID of the snapshot to delete.</desc>
3216	</param>
3217	<param name="machineState" type="MachineState" dir="out">
3218	<desc>New machine state after this operation is started.</desc>
3219	</param>
3220	<param name="progress" type="IProgress" dir="return">
3221	<desc>Progress object to track the operation completion.</desc>
3222	</param>
3223	</method>
3224
3225	<method name="finishOnlineMergeMedium">
3226	<desc>
3227	Gets called by IConsole::onlineMergeMedium.
3228	</desc>
3229	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3230	<desc>The medium attachment which needs to be cleaned up.</desc>
3231	</param>
3232	<param name="source" type="IMedium" dir="in">
3233	<desc>Merge source medium.</desc>
3234	</param>
3235	<param name="target" type="IMedium" dir="in">
3236	<desc>Merge target medium.</desc>
3237	</param>
3238	<param name="mergeForward" type="boolean" dir="in">
3239	<desc>Merge direction.</desc>
3240	</param>
3241	<param name="parentForTarget" type="IMedium" dir="in">
3242	<desc>For forward merges: new parent for target medium.</desc>
3243	</param>
3244	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3245	<desc>For backward merges: list of media which need their parent UUID
3246	updated.</desc>
3247	</param>
3248	</method>
3249
3250	<method name="restoreSnapshot">
3251	<desc>
3252	Gets called by IConsole::RestoreSnapshot.
3253	</desc>
3254	<param name="initiator" type="IConsole" dir="in">
3255	<desc>The console object that initiated this call.</desc>
3256	</param>
3257	<param name="snapshot" type="ISnapshot" dir="in">
3258	<desc>The snapshot to restore the VM state from.</desc>
3259	</param>
3260	<param name="machineState" type="MachineState" dir="out">
3261	<desc>New machine state after this operation is started.</desc>
3262	</param>
3263	<param name="progress" type="IProgress" dir="return">
3264	<desc>Progress object to track the operation completion.</desc>
3265	</param>
3266	</method>
3267
3268	<method name="pullGuestProperties">
3269	<desc>
3270	Get the list of the guest properties matching a set of patterns along
3271	with their values, time stamps and flags and give responsibility for
3272	managing properties to the console.
3273	</desc>
3274	<param name="name" type="wstring" dir="out" safearray="yes">
3275	<desc>
3276	The names of the properties returned.
3277	</desc>
3278	</param>
3279	<param name="value" type="wstring" dir="out" safearray="yes">
3280	<desc>
3281	The values of the properties returned. The array entries match the
3282	corresponding entries in the @a name array.
3283	</desc>
3284	</param>
3285	<param name="timestamp" type="long long" dir="out" safearray="yes">
3286	<desc>
3287	The time stamps of the properties returned. The array entries match
3288	the corresponding entries in the @a name array.
3289	</desc>
3290	</param>
3291	<param name="flags" type="wstring" dir="out" safearray="yes">
3292	<desc>
3293	The flags of the properties returned. The array entries match the
3294	corresponding entries in the @a name array.
3295	</desc>
3296	</param>
3297	</method>
3298
3299	<method name="pushGuestProperty">
3300	<desc>
3301	Update a single guest property in IMachine.
3302	</desc>
3303	<param name="name" type="wstring" dir="in">
3304	<desc>
3305	The name of the property to be updated.
3306	</desc>
3307	</param>
3308	<param name="value" type="wstring" dir="in">
3309	<desc>
3310	The value of the property.
3311	</desc>
3312	</param>
3313	<param name="timestamp" type="long long" dir="in">
3314	<desc>
3315	The timestamp of the property.
3316	</desc>
3317	</param>
3318	<param name="flags" type="wstring" dir="in">
3319	<desc>
3320	The flags of the property.
3321	</desc>
3322	</param>
3323	</method>
3324
3325	<method name="lockMedia">
3326	<desc>
3327	Locks all media attached to the machine for writing and parents of
3328	attached differencing media (if any) for reading. This operation is
3329	atomic so that if it fails no media is actually locked.
3330
3331	This method is intended to be called when the machine is in Starting or
3332	Restoring state. The locked media will be automatically unlocked when
3333	the machine is powered off or crashed.
3334	</desc>
3335	</method>
3336	<method name="unlockMedia">
3337	<desc>
3338	Unlocks all media previously locked using
3339	<link to="IInternalMachineControl::lockMedia"/>.
3340
3341	This method is intended to be used with teleportation so that it is
3342	possible to teleport between processes on the same machine.
3343	</desc>
3344	</method>
3345	</interface>
3346
3347	<interface
3348	name="IBIOSSettings" extends="$unknown"
3349	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3350	wsmap="managed"
3351	>
3352	<desc>
3353	The IBIOSSettings interface represents BIOS settings of the virtual
3354	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3355	</desc>
3356	<attribute name="logoFadeIn" type="boolean">
3357	<desc>Fade in flag for BIOS logo animation.</desc>
3358	</attribute>
3359
3360	<attribute name="logoFadeOut" type="boolean">
3361	<desc>Fade out flag for BIOS logo animation.</desc>
3362	</attribute>
3363
3364	<attribute name="logoDisplayTime" type="unsigned long">
3365	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3366	</attribute>
3367
3368	<attribute name="logoImagePath" type="wstring">
3369	<desc>
3370	Local file system path for external BIOS splash image. Empty string
3371	means the default image is shown on boot.
3372	</desc>
3373	</attribute>
3374
3375	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3376	<desc>Mode of the BIOS boot device menu.</desc>
3377	</attribute>
3378
3379	<attribute name="ACPIEnabled" type="boolean">
3380	<desc>ACPI support flag.</desc>
3381	</attribute>
3382
3383	<attribute name="IOAPICEnabled" type="boolean">
3384	<desc>
3385	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3386	and support IRQs above 15.
3387	</desc>
3388	</attribute>
3389
3390	<attribute name="timeOffset" type="long long">
3391	<desc>
3392	Offset in milliseconds from the host system time. This allows for
3393	guests running with a different system date/time than the host.
3394	It is equivalent to setting the system date/time in the BIOS except
3395	it is not an absolute value but a relative one. Guest Additions
3396	time synchronization honors this offset.
3397	</desc>
3398	</attribute>
3399
3400	<attribute name="PXEDebugEnabled" type="boolean">
3401	<desc>
3402	PXE debug logging flag. If set, VirtualBox will write extensive
3403	PXE trace information to the release log.
3404	</desc>
3405	</attribute>
3406
3407	</interface>
3408
3409	<enum name="CleanupMode"
3410	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441">
3411	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3412	</desc>
3413	<const name="UnregisterOnly" value="1">
3414	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3415	</const>
3416	<const name="DetachAllReturnNone" value="2">
3417	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3418	</const>
3419	<const name="DetachAllReturnHardDisksOnly" value="3">
3420	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3421	</const>
3422	<const name="Full" value="4">
3423	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3424	</const>
3425	</enum>
3426
3427	<interface
3428	name="IMachine" extends="$unknown"
3429	uuid="70ddc295-39fb-46e2-a93b-854e123b2b97"
3430	wsmap="managed"
3431	>
3432	<desc>
3433	The IMachine interface represents a virtual machine, or guest, created
3434	in VirtualBox.
3435
3436	This interface is used in two contexts. First of all, a collection of
3437	objects implementing this interface is stored in the
3438	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3439	machines that are currently registered with this VirtualBox
3440	installation. Also, once a session has been opened for the given virtual
3441	machine (e.g. the virtual machine is running), the machine object
3442	associated with the open session can be queried from the session object;
3443	see <link to="ISession"/> for details.
3444
3445	The main role of this interface is to expose the settings of the virtual
3446	machine and provide methods to change various aspects of the virtual
3447	machine's configuration. For machine objects stored in the
3448	<link to="IVirtualBox::machines"/> collection, all attributes are
3449	read-only unless explicitly stated otherwise in individual attribute
3450	and method descriptions.
3451
3452	In order to change a machine setting, a session for this machine must be
3453	opened using one of the <link to="IMachine::lockMachine" /> or
3454	<link to="IMachine::launchVMProcess"/> methods. After the
3455	machine has been successfully locked for a session, a mutable machine object
3456	needs to be queried from the session object and then the desired settings
3457	changes can be applied to the returned object using IMachine attributes and
3458	methods. See the <link to="ISession"/> interface description for more
3459	information about sessions.
3460
3461	Note that IMachine does not provide methods to control virtual machine
3462	execution (such as start the machine, or power it down) -- these methods
3463	are grouped in a separate interface called <link to="IConsole" />.
3464
3465	<see>ISession, IConsole</see>
3466	</desc>
3467
3468	<attribute name="parent" type="IVirtualBox" readonly="yes">
3469	<desc>Associated parent object.</desc>
3470	</attribute>
3471
3472	<attribute name="accessible" type="boolean" readonly="yes">
3473	<desc>
3474	Whether this virtual machine is currently accessible or not.
3475
3476	A machine is always deemed accessible unless it is registered <i>and</i>
3477	its settings file cannot be read or parsed (either because the file itself
3478	is unavailable or has invalid XML contents).
3479
3480	Every time this property is read, the accessibility state of
3481	this machine is re-evaluated. If the returned value is @c false,
3482	the <link to="#accessError"/> property may be used to get the
3483	detailed error information describing the reason of
3484	inaccessibility, including XML error messages.
3485
3486	When the machine is inaccessible, only the following properties
3487	can be used on it:
3488	<ul>
3489	<li><link to="#parent"/></li>
3490	<li><link to="#id"/></li>
3491	<li><link to="#settingsFilePath"/></li>
3492	<li><link to="#accessible"/></li>
3493	<li><link to="#accessError"/></li>
3494	</ul>
3495
3496	An attempt to access any other property or method will return
3497	an error.
3498
3499	The only possible action you can perform on an inaccessible
3500	machine is to unregister it using the
3501	<link to="IMachine::unregister"/> call (or, to check
3502	for the accessibility state once more by querying this
3503	property).
3504
3505	<note>
3506	In the current implementation, once this property returns
3507	@c true, the machine will never become inaccessible
3508	later, even if its settings file cannot be successfully
3509	read/written any more (at least, until the VirtualBox
3510	server is restarted). This limitation may be removed in
3511	future releases.
3512	</note>
3513	</desc>
3514	</attribute>
3515
3516	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3517	<desc>
3518	Error information describing the reason of machine
3519	inaccessibility.
3520
3521	Reading this property is only valid after the last call to
3522	<link to="#accessible"/> returned @c false (i.e. the
3523	machine is currently unaccessible). Otherwise, a @c null
3524	IVirtualBoxErrorInfo object will be returned.
3525	</desc>
3526	</attribute>
3527
3528	<attribute name="name" type="wstring">
3529	<desc>
3530	Name of the virtual machine.
3531
3532	Besides being used for human-readable identification purposes
3533	everywhere in VirtualBox, the virtual machine name is also used
3534	as a name of the machine's settings file and as a name of the
3535	subdirectory this settings file resides in. Thus, every time you
3536	change the value of this property, the settings file will be
3537	renamed once you call <link to="#saveSettings"/> to confirm the
3538	change. The containing subdirectory will be also renamed, but
3539	only if it has exactly the same name as the settings file
3540	itself prior to changing this property (for backward compatibility
3541	with previous API releases). The above implies the following
3542	limitations:
3543	<ul>
3544	<li>The machine name cannot be empty.</li>
3545	<li>The machine name can contain only characters that are valid
3546	file name characters according to the rules of the file
3547	system used to store VirtualBox configuration.</li>
3548	<li>You cannot have two or more machines with the same name
3549	if they use the same subdirectory for storing the machine
3550	settings files.</li>
3551	<li>You cannot change the name of the machine if it is running,
3552	or if any file in the directory containing the settings file
3553	is being used by another running machine or by any other
3554	process in the host operating system at a time when
3555	<link to="#saveSettings"/> is called.
3556	</li>
3557	</ul>
3558	If any of the above limitations are hit, <link to="#saveSettings"/>
3559	will return an appropriate error message explaining the exact
3560	reason and the changes you made to this machine will not be saved.
3561	</desc>
3562	</attribute>
3563
3564	<attribute name="description" type="wstring">
3565	<desc>
3566	Description of the virtual machine.
3567
3568	The description attribute can contain any text and is
3569	typically used to describe the hardware and software
3570	configuration of the virtual machine in detail (i.e. network
3571	settings, versions of the installed software and so on).
3572	</desc>
3573	</attribute>
3574
3575	<attribute name="id" type="uuid" mod="string" readonly="yes">
3576	<desc>UUID of the virtual machine.</desc>
3577	</attribute>
3578
3579	<attribute name="OSTypeId" type="wstring">
3580	<desc>
3581	User-defined identifier of the Guest OS type.
3582	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3583	an IGuestOSType object representing details about the given
3584	Guest OS type.
3585	<note>
3586	This value may differ from the value returned by
3587	<link to="IGuest::OSTypeId"/> if Guest Additions are
3588	installed to the guest OS.
3589	</note>
3590	</desc>
3591	</attribute>
3592
3593	<attribute name="HardwareVersion" type="wstring">
3594	<desc>Hardware version identifier. Internal use only for now.</desc>
3595	</attribute>
3596
3597	<attribute name="hardwareUUID" type="uuid" mod="string">
3598	<desc>
3599	The UUID presented to the guest via memory tables, hardware and guest
3600	properties. For most VMs this is the same as the @a id, but for VMs
3601	which have been cloned or teleported it may be the same as the source
3602	VM. This latter is because the guest shouldn't notice that it was
3603	cloned or teleported.
3604	</desc>
3605	</attribute>
3606
3607	<attribute name="CPUCount" type="unsigned long">
3608	<desc>Number of virtual CPUs in the VM.</desc>
3609	</attribute>
3610
3611	<attribute name="CPUHotPlugEnabled" type="boolean">
3612	<desc>
3613	This setting determines whether VirtualBox allows CPU
3614	hotplugging for this machine.</desc>
3615	</attribute>
3616
3617	<attribute name="CPUPriority" type="unsigned long">
3618	<desc>
3619	Priority of the virtual CPUs. Means to limit the number of CPU cycles
3620	a guest can use. The unit is percentage of host CPU cycles per second.
3621	The valid range is 1 - 100. 100 (the default) implies no limit.
3622	</desc>
3623	</attribute>
3624
3625	<attribute name="memorySize" type="unsigned long">
3626	<desc>System memory size in megabytes.</desc>
3627	</attribute>
3628
3629	<attribute name="memoryBalloonSize" type="unsigned long">
3630	<desc>Memory balloon size in megabytes.</desc>
3631	</attribute>
3632
3633	<attribute name="PageFusionEnabled" type="boolean">
3634	<desc>
3635	This setting determines whether VirtualBox allows page
3636	fusion for this machine (64 bits host only).
3637	</desc>
3638	</attribute>
3639
3640	<attribute name="VRAMSize" type="unsigned long">
3641	<desc>Video memory size in megabytes.</desc>
3642	</attribute>
3643
3644	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3645	<desc>
3646	This setting determines whether VirtualBox allows this machine to make
3647	use of the 3D graphics support available on the host.</desc>
3648	</attribute>
3649
3650	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3651	<desc>
3652	This setting determines whether VirtualBox allows this machine to make
3653	use of the 2D video acceleration support available on the host.</desc>
3654	</attribute>
3655
3656	<attribute name="monitorCount" type="unsigned long">
3657	<desc>
3658	Number of virtual monitors.
3659	<note>
3660	Only effective on Windows XP and later guests with
3661	Guest Additions installed.
3662	</note>
3663	</desc>
3664	</attribute>
3665
3666	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3667	<desc>Object containing all BIOS settings.</desc>
3668	</attribute>
3669
3670	<attribute name="firmwareType" type="FirmwareType">
3671	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3672	bootstrap in this VM.</desc>
3673	</attribute>
3674
3675	<attribute name="pointingHidType" type="PointingHidType">
3676	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3677	The default is typically "PS2Mouse" but can vary depending on the
3678	requirements of the guest operating system.</desc>
3679	</attribute>
3680
3681	<attribute name="keyboardHidType" type="KeyboardHidType">
3682	<desc>Type of keyboard HID used in this VM.
3683	The default is typically "PS2Keyboard" but can vary depending on the
3684	requirements of the guest operating system.</desc>
3685	</attribute>
3686
3687	<attribute name="hpetEnabled" type="boolean">
3688	<desc>This attribute controls if High Precision Event Timer (HPET) is
3689	enabled in this VM. Use this property if you want to provide guests
3690	with additional time source, or if guest requires HPET to function correctly.
3691	Default is false.</desc>
3692	</attribute>
3693
3694	<attribute name="snapshotFolder" type="wstring">
3695	<desc>
3696	Full path to the directory used to store snapshot data
3697	(differencing media and saved state files) of this machine.
3698
3699	The initial value of this property is
3700	<tt><</tt><link to="#settingsFilePath">
3701	path_to_settings_file</link><tt>>/<</tt>
3702	<link to="#id">machine_uuid</link>
3703	<tt>></tt>.
3704
3705	Currently, it is an error to try to change this property on
3706	a machine that has snapshots (because this would require to
3707	move possibly large files to a different location).
3708	A separate method will be available for this purpose later.
3709
3710	<note>
3711	Setting this property to @c null or to an empty string will restore
3712	the initial value.
3713	</note>
3714	<note>
3715	When setting this property, the specified path can be
3716	absolute (full path) or relative to the directory where the
3717	<link to="#settingsFilePath">machine settings file</link>
3718	is located. When reading this property, a full path is
3719	always returned.
3720	</note>
3721	<note>
3722	The specified path may not exist, it will be created
3723	when necessary.
3724	</note>
3725	</desc>
3726	</attribute>
3727
3728	<attribute name="VRDPServer" type="IVRDPServer" readonly="yes">
3729	<desc>VRDP server object.</desc>
3730	</attribute>
3731
3732	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3733	<desc>Array of media attached to this machine.</desc>
3734	</attribute>
3735
3736	<attribute name="USBController" type="IUSBController" readonly="yes">
3737	<desc>
3738	Associated USB controller object.
3739
3740	<note>
3741	If USB functionality is not available in the given edition of
3742	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3743	</note>
3744	</desc>
3745	</attribute>
3746
3747	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3748	<desc>Associated audio adapter, always present.</desc>
3749	</attribute>
3750
3751	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3752	<desc>Array of storage controllers attached to this machine.</desc>
3753	</attribute>
3754
3755	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3756	<desc>
3757	Full name of the file containing machine settings data.
3758	</desc>
3759	</attribute>
3760
3761	<attribute name="settingsModified" type="boolean" readonly="yes">
3762	<desc>
3763	Whether the settings of this machine have been modified
3764	(but neither yet saved nor discarded).
3765	<note>
3766	Reading this property is only valid on instances returned
3767	by <link to="ISession::machine"/> and on new machines
3768	created by <link to="IVirtualBox::createMachine"/> or opened
3769	by <link to="IVirtualBox::openMachine"/> but not
3770	yet registered, or on unregistered machines after calling
3771	<link to="IMachine::unregister"/>. For all other
3772	cases, the settings can never be modified.
3773	</note>
3774	<note>
3775	For newly created unregistered machines, the value of this
3776	property is always @c true until <link to="#saveSettings"/>
3777	is called (no matter if any machine settings have been
3778	changed after the creation or not). For opened machines
3779	the value is set to @c false (and then follows to normal rules).
3780	</note>
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="sessionState" type="SessionState" readonly="yes">
3785	<desc>Current session state for this machine.</desc>
3786	</attribute>
3787
3788	<attribute name="sessionType" type="wstring" readonly="yes">
3789	<desc>
3790	Type of the session. If <link to="#sessionState"/> is
3791	Spawning or Locked, this attribute contains the
3792	same value as passed to the
3793	<link to="IMachine::launchVMProcess"/> method in the
3794	@a type parameter. If the session was used with
3795	<link to="IMachine::lockMachine" />, or if
3796	<link to="#sessionState"/> is SessionClosed, the value of this
3797	attribute is an empty string.
3798	</desc>
3799	</attribute>
3800
3801	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3802	<desc>
3803	Identifier of the session process. This attribute contains the
3804	platform-dependent identifier of the process whose session was
3805	used with <link to="IMachine::lockMachine" /> call. The returned
3806	value is only valid if <link to="#sessionState"/> is Locked or
3807	Unlocking by the time this property is read.
3808	</desc>
3809	</attribute>
3810
3811	<attribute name="state" type="MachineState" readonly="yes">
3812	<desc>Current execution state of this machine.</desc>
3813	</attribute>
3814
3815	<attribute name="lastStateChange" type="long long" readonly="yes">
3816	<desc>
3817	Time stamp of the last execution state change,
3818	in milliseconds since 1970-01-01 UTC.
3819	</desc>
3820	</attribute>
3821
3822	<attribute name="stateFilePath" type="wstring" readonly="yes">
3823	<desc>
3824	Full path to the file that stores the execution state of
3825	the machine when it is in the <link to="MachineState::Saved"/> state.
3826	<note>
3827	When the machine is not in the Saved state, this attribute is
3828	an empty string.
3829	</note>
3830	</desc>
3831	</attribute>
3832
3833	<attribute name="logFolder" type="wstring" readonly="yes">
3834	<desc>
3835	Full path to the folder that stores a set of rotated log files
3836	recorded during machine execution. The most recent log file is
3837	named <tt>VBox.log</tt>, the previous log file is
3838	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3839	in the current version).
3840	</desc>
3841	</attribute>
3842
3843	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3844	<desc>
3845	Current snapshot of this machine. This is @c null if the machine
3846	currently has no snapshots. If it is not @c null, then it was
3847	set by one of <link to="IConsole::takeSnapshot" />,
3848	<link to="IConsole::deleteSnapshot" />
3849	or <link to="IConsole::restoreSnapshot" />, depending on which
3850	was called last. See <link to="ISnapshot"/> for details.
3851	</desc>
3852	</attribute>
3853
3854	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3855	<desc>
3856	Number of snapshots taken on this machine. Zero means the
3857	machine doesn't have any snapshots.
3858	</desc>
3859	</attribute>
3860
3861	<attribute name="currentStateModified" type="boolean" readonly="yes">
3862	<desc>
3863	Returns @c true if the current state of the machine is not
3864	identical to the state stored in the current snapshot.
3865
3866	The current state is identical to the current snapshot only
3867	directly after one of the following calls are made:
3868
3869	<ul>
3870	<li><link to="IConsole::restoreSnapshot"/>
3871	</li>
3872	<li><link to="IConsole::takeSnapshot"/> (issued on a
3873	"powered off" or "saved" machine, for which
3874	<link to="#settingsModified"/> returns @c false)
3875	</li>
3876	<li><link to="IMachine::setCurrentSnapshot"/>
3877	</li>
3878	</ul>
3879
3880	The current state remains identical until one of the following
3881	happens:
3882	<ul>
3883	<li>settings of the machine are changed</li>
3884	<li>the saved state is deleted</li>
3885	<li>the current snapshot is deleted</li>
3886	<li>an attempt to execute the machine is made</li>
3887	</ul>
3888
3889	<note>
3890	For machines that don't have snapshots, this property is
3891	always @c false.
3892	</note>
3893	</desc>
3894	</attribute>
3895
3896	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3897	<desc>
3898	Collection of shared folders for this machine (permanent shared
3899	folders). These folders are shared automatically at machine startup
3900	and available only to the guest OS installed within this machine.
3901
3902	New shared folders are added to the collection using
3903	<link to="#createSharedFolder"/>. Existing shared folders can be
3904	removed using <link to="#removeSharedFolder"/>.
3905	</desc>
3906	</attribute>
3907
3908	<attribute name="clipboardMode" type="ClipboardMode">
3909	<desc>
3910	Synchronization mode between the host OS clipboard
3911	and the guest OS clipboard.
3912	</desc>
3913	</attribute>
3914
3915	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3916	<desc>
3917	A comma-separated list of simple glob patterns. Changes to guest
3918	properties whose name matches one of the patterns will generate an
3919	<link to="IGuestPropertyChangedEvent"/> signal.
3920	</desc>
3921	</attribute>
3922
3923	<attribute name="teleporterEnabled" type="boolean">
3924	<desc>
3925	When set to @a true, the virtual machine becomes a target teleporter
3926	the next time it is powered on. This can only set to @a true when the
3927	VM is in the @a PoweredOff or @a Aborted state.
3928
3929	<!-- This property is automatically set to @a false when the VM is powered
3930	on. (bird: This doesn't work yet ) -->
3931	</desc>
3932	</attribute>
3933
3934	<attribute name="teleporterPort" type="unsigned long">
3935	<desc>
3936	The TCP port the target teleporter will listen for incoming
3937	teleportations on.
3938
3939	0 means the port is automatically selected upon power on. The actual
3940	value can be read from this property while the machine is waiting for
3941	incoming teleportations.
3942	</desc>
3943	</attribute>
3944
3945	<attribute name="teleporterAddress" type="wstring">
3946	<desc>
3947	The address the target teleporter will listen on. If set to an empty
3948	string, it will listen on all addresses.
3949	</desc>
3950	</attribute>
3951
3952	<attribute name="teleporterPassword" type="wstring">
3953	<desc>
3954	The password to check for on the target teleporter. This is just a
3955	very basic measure to prevent simple hacks and operators accidentally
3956	beaming a virtual machine to the wrong place.
3957	</desc>
3958	</attribute>
3959
3960	<attribute name="faultToleranceState" type="FaultToleranceState">
3961	<desc>
3962	Fault tolerance state; disabled, source or target.
3963	This property can be changed at any time. If you change it for a running
3964	VM, then the fault tolerance address and port must be set beforehand.
3965	</desc>
3966	</attribute>
3967
3968	<attribute name="faultTolerancePort" type="unsigned long">
3969	<desc>
3970	The TCP port the fault tolerance source or target will use for
3971	communication.
3972	</desc>
3973	</attribute>
3974
3975	<attribute name="faultToleranceAddress" type="wstring">
3976	<desc>
3977	The address the fault tolerance source or target.
3978	</desc>
3979	</attribute>
3980
3981	<attribute name="faultTolerancePassword" type="wstring">
3982	<desc>
3983	The password to check for on the standby VM. This is just a
3984	very basic measure to prevent simple hacks and operators accidentally
3985	choosing the wrong standby VM.
3986	</desc>
3987	</attribute>
3988
3989	<attribute name="faultToleranceSyncInterval" type="unsigned long">
3990	<desc>
3991	The interval in ms used for syncing the state between source and target.
3992	</desc>
3993	</attribute>
3994
3995	<attribute name="RTCUseUTC" type="boolean">
3996	<desc>
3997	When set to @a true, the RTC device of the virtual machine will run
3998	in UTC time, otherwise in local time. Especially Unix guests prefer
3999	the time in UTC.
4000	</desc>
4001	</attribute>
4002
4003	<attribute name="ioCacheEnabled" type="boolean">
4004	<desc>
4005	When set to @a true, the builtin I/O cache of the virtual machine
4006	will be enabled.
4007	</desc>
4008	</attribute>
4009
4010	<attribute name="ioCacheSize" type="unsigned long">
4011	<desc>
4012	Maximum size of the I/O cache in MB.
4013	</desc>
4014	</attribute>
4015
4016	<method name="lockMachine">
4017	<desc>
4018	Locks the machine for the given session to enable the caller
4019	to make changes to the machine or start the VM or control
4020	VM execution.
4021
4022	There are two ways to lock a machine for such uses:
4023
4024	<ul>
4025	<li>If you want to make changes to the machine settings,
4026	you must obtain an exclusive write lock on the machine
4027	by setting @a lockType to @c Write.
4028
4029	This will only succeed if no other process has locked
4030	the machine to prevent conflicting changes. Only after
4031	an exclusive write lock has been obtained using this method, one
4032	can change all VM settings or execute the VM in the process
4033	space of the session object. (Note that the latter is only of
4034	interest if you actually want to write a new front-end for
4035	virtual machines; but this API gets called internally by
4036	the existing front-ends such as VBoxHeadless and the VirtualBox
4037	GUI to acquire a write lock on the machine that they are running.)
4038
4039	On success, write-locking the machine for a session creates
4040	a second copy of the IMachine object. It is this second object
4041	upon which changes can be made; in VirtualBox terminology, the
4042	second copy is "mutable". It is only this second, mutable machine
4043	object upon which you can call methods that change the
4044	machine state. After having called this method, you can
4045	obtain this second, mutable machine object using the
4046	<link to="ISession::machine" /> attribute.
4047	</li>
4048	<li>If you only want to check the machine state or control
4049	machine execution without actually changing machine
4050	settings (e.g. to get access to VM statistics or take
4051	a snapshot or save the machine state), then set the
4052	@a lockType argument to @c Shared.
4053
4054	If no other session has obtained a lock, you will obtain an
4055	exclusive write lock as described above. However, if another
4056	session has already obtained such a lock, then a link to that
4057	existing session will be established which allows you
4058	to control that existing session.
4059
4060	To find out which type of lock was obtained, you can
4061	inspect <link to="ISession::type" />, which will have been
4062	set to either @c WriteLock or @c Shared.
4063	</li>
4064	</ul>
4065
4066	In either case, you can get access to the <link to="IConsole" />
4067	object which controls VM execution.
4068
4069	Also in all of the above cases, one must always call
4070	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4071	the machine's state will eventually be set to "Aborted".
4072
4073	To change settings on a machine, the following sequence is typically
4074	performed:
4075
4076	<ol>
4077	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4078
4079	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4080
4081	<li>Change the settings of the machine by invoking IMachine methods.</li>
4082
4083	<li>Call <link to="IMachine::saveSettings" />.</li>
4084
4085	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4086	</ol>
4087
4088	<result name="E_UNEXPECTED">
4089	Virtual machine not registered.
4090	</result>
4091	<result name="E_ACCESSDENIED">
4092	Process not started by OpenRemoteSession.
4093	</result>
4094	<result name="VBOX_E_INVALID_OBJECT_STATE">
4095	Session already open or being opened.
4096	</result>
4097	<result name="VBOX_E_VM_ERROR">
4098	Failed to assign machine to session.
4099	</result>
4100	</desc>
4101	<param name="session" type="ISession" dir="in">
4102	<desc>
4103	Session object for which the machine will be locked.
4104	</desc>
4105	</param>
4106	<param name="lockType" type="LockType" dir="in">
4107	<desc>
4108	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4109	If set to @c Shared, then either acquire an exclusive write lock or establish
4110	a link to an existing session.
4111	</desc>
4112	</param>
4113	</method>
4114
4115	<method name="launchVMProcess">
4116	<desc>
4117	Spawns a new process that will execute the virtual machine and obtains a shared
4118	lock on the machine for the calling session.
4119
4120	If launching the VM succeeds, the new VM process will create its own session
4121	and write-lock the machine for it, preventing conflicting changes from other
4122	processes. If the machine is already locked (because it is already running or
4123	because another session has a write lock), launching the VM process will therefore
4124	fail. Reversely, future attempts to obtain a write lock will also fail while the
4125	machine is running.
4126
4127	The caller's session object remains separate from the session opened by the new
4128	VM process. It receives its own <link to="IConsole" /> object which can be used
4129	to control machine execution, but it cannot be used to change all VM settings
4130	which would be available after a <link to="#lockMachine" /> call.
4131
4132	The caller must eventually release the session's shared lock by calling
4133	<link to="ISession::unlockMachine" /> on the local session object once this call
4134	has returned. However, the session's state (see <link to="ISession::state" />)
4135	will not return to "Unlocked" until the remote session has also unlocked
4136	the machine (i.e. the machine has stopped running).
4137
4138	Lauching a VM process can take some time (a new VM is started in a new process,
4139	for which memory and other resources need to be set up). Because of this,
4140	an <link to="IProgress" /> object is returned to allow the caller to wait
4141	for this asynchronous operation to be completed. Until then, the caller's
4142	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4143	and <link to="ISession::console" /> attributes cannot be accessed.
4144	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4145	similar calls to wait for completion. Completion is signalled when the VM
4146	is powered on. If launching the VM fails, error messages can be queried
4147	via the progress object, if available.
4148
4149	The progress object will have at least 2 sub-operations. The first
4150	operation covers the period up to the new VM process calls powerUp.
4151	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4152	progress object. Because <link to="IConsole::powerUp"/> may require
4153	some extra sub-operations, the <link to="IProgress::operationCount"/>
4154	may change at the completion of operation.
4155
4156	For details on the teleportation progress operation, see
4157	<link to="IConsole::powerUp"/>.
4158
4159	The @a environment argument is a string containing definitions of
4160	environment variables in the following format:
4161	@code
4162	NAME[=VALUE]\n
4163	NAME[=VALUE]\n
4164	...
4165	@endcode
4166	where <tt>\\n</tt> is the new line character. These environment
4167	variables will be appended to the environment of the VirtualBox server
4168	process. If an environment variable exists both in the server process
4169	and in this list, the value from this list takes precedence over the
4170	server's variable. If the value of the environment variable is
4171	omitted, this variable will be removed from the resulting environment.
4172	If the environment string is @c null or empty, the server environment
4173	is inherited by the started process as is.
4174
4175	<result name="E_UNEXPECTED">
4176	Virtual machine not registered.
4177	</result>
4178	<result name="E_INVALIDARG">
4179	Invalid session type @a type.
4180	</result>
4181	<result name="VBOX_E_OBJECT_NOT_FOUND">
4182	No machine matching @a machineId found.
4183	</result>
4184	<result name="VBOX_E_INVALID_OBJECT_STATE">
4185	Session already open or being opened.
4186	</result>
4187	<result name="VBOX_E_IPRT_ERROR">
4188	Launching process for machine failed.
4189	</result>
4190	<result name="VBOX_E_VM_ERROR">
4191	Failed to assign machine to session.
4192	</result>
4193	</desc>
4194	<param name="session" type="ISession" dir="in">
4195	<desc>
4196	Client session object to which the VM process will be connected (this
4197	must be in "Unlocked" state).
4198	</desc>
4199	</param>
4200	<param name="type" type="wstring" dir="in">
4201	<desc>
4202	Front-end to use for the new VM process. The following are currently supported:
4203	<ul>
4204	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4205	<li><tt>"vrdp"</tt>: VBoxHeadless (VRDP Server) front-end</li>
4206	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4207	</ul>
4208	</desc>
4209	</param>
4210	<param name="environment" type="wstring" dir="in">
4211	<desc>
4212	Environment to pass to the VM process.
4213	</desc>
4214	</param>
4215	<param name="progress" type="IProgress" dir="return">
4216	<desc>Progress object to track the operation completion.</desc>
4217	</param>
4218	</method>
4219
4220	<method name="setBootOrder">
4221	<desc>
4222	Puts the given device to the specified position in
4223	the boot order.
4224
4225	To indicate that no device is associated with the given position,
4226	<link to="DeviceType::Null"/> should be used.
4227
4228	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4229
4230	<result name="E_INVALIDARG">
4231	Boot @a position out of range.
4232	</result>
4233	<result name="E_NOTIMPL">
4234	Booting from USB @a device currently not supported.
4235	</result>
4236
4237	</desc>
4238	<param name="position" type="unsigned long" dir="in">
4239	<desc>
4240	Position in the boot order (@c 1 to the total number of
4241	devices the machine can boot from, as returned by
4242	<link to="ISystemProperties::maxBootPosition"/>).
4243	</desc>
4244	</param>
4245	<param name="device" type="DeviceType" dir="in">
4246	<desc>
4247	The type of the device used to boot at the given position.
4248	</desc>
4249	</param>
4250	</method>
4251
4252	<method name="getBootOrder" const="yes">
4253	<desc>
4254	Returns the device type that occupies the specified
4255	position in the boot order.
4256
4257	@todo [remove?]
4258	If the machine can have more than one device of the returned type
4259	(such as hard disks), then a separate method should be used to
4260	retrieve the individual device that occupies the given position.
4261
4262	If here are no devices at the given position, then
4263	<link to="DeviceType::Null"/> is returned.
4264
4265	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4266
4267	<result name="E_INVALIDARG">
4268	Boot @a position out of range.
4269	</result>
4270
4271	</desc>
4272	<param name="position" type="unsigned long" dir="in">
4273	<desc>
4274	Position in the boot order (@c 1 to the total number of
4275	devices the machine can boot from, as returned by
4276	<link to="ISystemProperties::maxBootPosition"/>).
4277	</desc>
4278	</param>
4279	<param name="device" type="DeviceType" dir="return">
4280	<desc>
4281	Device at the given position.
4282	</desc>
4283	</param>
4284	</method>
4285
4286	<method name="attachDevice">
4287	<desc>
4288	Attaches a device and optionally mounts a medium to the given storage
4289	controller (<link to="IStorageController" />, identified by @a name),
4290	at the indicated port and device.
4291
4292	This method is intended for managing storage devices in general while a
4293	machine is powered off. It can be used to attach and detach fixed
4294	and removeable media. The following kind of media can be attached
4295	to a machine:
4296
4297	<ul>
4298	<li>For fixed and removable media, you can pass in a medium that was
4299	previously opened using <link to="IVirtualBox::openMedium" />.
4300	</li>
4301
4302	<li>Only for storage devices supporting removable media (such as
4303	DVDs and floppies), you can also specify a null pointer to
4304	indicate an empty drive or one of the medium objects listed
4305	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4306	arrays to indicate a host drive.
4307	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4308	to change the media while the machine is running.
4309	</li>
4310	</ul>
4311
4312	In a VM's default configuration of virtual machines, the secondary
4313	master of the IDE controller is used for a CD/DVD drive.
4314
4315	After calling this returns successfully, a new instance of
4316	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4317	attachments (see <link to="IMachine::mediumAttachments"/>).
4318
4319	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4320	information about attaching media.
4321
4322	The specified device slot must not have a device attached to it,
4323	or this method will fail.
4324
4325	<note>
4326	You cannot attach a device to a newly created machine until
4327	this machine's settings are saved to disk using
4328	<link to="#saveSettings"/>.
4329	</note>
4330	<note>
4331	If the medium is being attached indirectly, a new differencing medium
4332	will implicitly be created for it and attached instead. If the
4333	changes made to the machine settings (including this indirect
4334	attachment) are later cancelled using <link to="#discardSettings"/>,
4335	this implicitly created differencing medium will implicitly
4336	be deleted.
4337	</note>
4338
4339	<result name="E_INVALIDARG">
4340	SATA device, SATA port, IDE port or IDE slot out of range, or
4341	file or UUID not found.
4342	</result>
4343	<result name="VBOX_E_INVALID_OBJECT_STATE">
4344	Machine must be registered before media can be attached.
4345	</result>
4346	<result name="VBOX_E_INVALID_VM_STATE">
4347	Invalid machine state.
4348	</result>
4349	<result name="VBOX_E_OBJECT_IN_USE">
4350	A medium is already attached to this or another virtual machine.
4351	</result>
4352
4353	</desc>
4354	<param name="name" type="wstring" dir="in">
4355	<desc>Name of the storage controller to attach the device to.</desc>
4356	</param>
4357	<param name="controllerPort" type="long" dir="in">
4358	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4359	the primary controller and 1 specifies the secondary controller.
4360	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4361	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4362	</param>
4363	<param name="device" type="long" dir="in">
4364	<desc>Device slot in the given port to attach the device to. This is only
4365	relevant for IDE controllers, for which 0 specifies the master device and
4366	1 specifies the slave device. For all other controller types, this must
4367	be 0.</desc>
4368	</param>
4369	<param name="type" type="DeviceType" dir="in">
4370	<desc>Device type of the attached device. For media opened by
4371	<link to="IVirtualBox::openMedium" />, this must match the device type
4372	specified there.</desc>
4373	</param>
4374	<param name="medium" type="IMedium" dir="in">
4375	<desc>Medium to mount or NULL for an empty drive.</desc>
4376	</param>
4377	</method>
4378
4379	<method name="detachDevice">
4380	<desc>
4381	Detaches the device attached to a device slot of the specified bus.
4382
4383	Detaching the device from the virtual machine is deferred. This means
4384	that the medium remains associated with the machine when this method
4385	returns and gets actually de-associated only after a successful
4386	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4387	for more detailed information about attaching media.
4388
4389	<note>
4390	You cannot detach a device from a running machine.
4391	</note>
4392	<note>
4393	Detaching differencing media implicitly created by <link
4394	to="#attachDevice"/> for the indirect attachment using this
4395	method will <b>not</b> implicitly delete them. The
4396	<link to="IMedium::deleteStorage"/> operation should be
4397	explicitly performed by the caller after the medium is successfully
4398	detached and the settings are saved with
4399	<link to="#saveSettings"/>, if it is the desired action.
4400	</note>
4401
4402	<result name="VBOX_E_INVALID_VM_STATE">
4403	Attempt to detach medium from a running virtual machine.
4404	</result>
4405	<result name="VBOX_E_OBJECT_NOT_FOUND">
4406	No medium attached to given slot/bus.
4407	</result>
4408	<result name="VBOX_E_NOT_SUPPORTED">
4409	Medium format does not support storage deletion.
4410	</result>
4411
4412	</desc>
4413	<param name="name" type="wstring" dir="in">
4414	<desc>Name of the storage controller to detach the medium from.</desc>
4415	</param>
4416	<param name="controllerPort" type="long" dir="in">
4417	<desc>Port number to detach the medium from.</desc>
4418	</param>
4419	<param name="device" type="long" dir="in">
4420	<desc>Device slot number to detach the medium from.</desc>
4421	</param>
4422	</method>
4423
4424	<method name="passthroughDevice">
4425	<desc>
4426	Sets the passthrough mode of an existing DVD device. Changing the
4427	setting while the VM is running is forbidden. The setting is only used
4428	if at VM start the device is configured as a host DVD drive, in all
4429	other cases it is ignored. The device must already exist; see
4430	<link to="IMachine::attachDevice"/> for how to attach a new device.
4431
4432	The @a controllerPort and @a device parameters specify the device slot and
4433	have have the same meaning as with <link to="IMachine::attachDevice" />.
4434
4435	<result name="E_INVALIDARG">
4436	SATA device, SATA port, IDE port or IDE slot out of range.
4437	</result>
4438	<result name="VBOX_E_INVALID_OBJECT_STATE">
4439	Attempt to modify an unregistered virtual machine.
4440	</result>
4441	<result name="VBOX_E_INVALID_VM_STATE">
4442	Invalid machine state.
4443	</result>
4444
4445	</desc>
4446	<param name="name" type="wstring" dir="in">
4447	<desc>Name of the storage controller.</desc>
4448	</param>
4449	<param name="controllerPort" type="long" dir="in">
4450	<desc>Storage controller port.</desc>
4451	</param>
4452	<param name="device" type="long" dir="in">
4453	<desc>Device slot in the given port.</desc>
4454	</param>
4455	<param name="passthrough" type="boolean" dir="in">
4456	<desc>New value for the passthrough setting.</desc>
4457	</param>
4458	</method>
4459
4460	<method name="mountMedium">
4461	<desc>
4462	Mounts a medium (<link to="IMedium" />, identified
4463	by the given UUID @a id) to the given storage controller
4464	(<link to="IStorageController" />, identified by @a name),
4465	at the indicated port and device. The device must already exist;
4466	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4467
4468	This method is intended only for managing removable media, where the
4469	device is fixed but media is changeable at runtime (such as DVDs
4470	and floppies). It cannot be used for fixed media such as hard disks.
4471
4472	The @a controllerPort and @a device parameters specify the device slot and
4473	have have the same meaning as with <link to="IMachine::attachDevice" />.
4474
4475	The specified device slot can have a medium mounted, which will be
4476	unmounted first. Specifying a zero UUID (or an empty string) for
4477	@a medium does just an unmount.
4478
4479	See <link to="IMedium"/> for more detailed information about
4480	attaching media.
4481
4482	<result name="E_INVALIDARG">
4483	SATA device, SATA port, IDE port or IDE slot out of range.
4484	</result>
4485	<result name="VBOX_E_INVALID_OBJECT_STATE">
4486	Attempt to attach medium to an unregistered virtual machine.
4487	</result>
4488	<result name="VBOX_E_INVALID_VM_STATE">
4489	Invalid machine state.
4490	</result>
4491	<result name="VBOX_E_OBJECT_IN_USE">
4492	Medium already attached to this or another virtual machine.
4493	</result>
4494
4495	</desc>
4496	<param name="name" type="wstring" dir="in">
4497	<desc>Name of the storage controller to attach the medium to.</desc>
4498	</param>
4499	<param name="controllerPort" type="long" dir="in">
4500	<desc>Port to attach the medium to.</desc>
4501	</param>
4502	<param name="device" type="long" dir="in">
4503	<desc>Device slot in the given port to attach the medium to.</desc>
4504	</param>
4505	<param name="medium" type="uuid" mod="string" dir="in">
4506	<desc>UUID of the medium to attach. A zero UUID means unmount the
4507	currently mounted medium.</desc>
4508	</param>
4509	<param name="force" type="boolean" dir="in">
4510	<desc>Allows to force unmount/mount of a medium which is locked by
4511	theDevice slot in the given port to attach the medium to.</desc>
4512	</param>
4513	</method>
4514
4515	<method name="getMedium" const="yes">
4516	<desc>
4517	Returns the virtual medium attached to a device slot of the specified
4518	bus.
4519
4520	Note that if the medium was indirectly attached by
4521	<link to="#mountMedium"/> to the given device slot then this
4522	method will return not the same object as passed to the
4523	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4524	more detailed information about mounting a medium.
4525
4526	<result name="VBOX_E_OBJECT_NOT_FOUND">
4527	No medium attached to given slot/bus.
4528	</result>
4529
4530	</desc>
4531	<param name="name" type="wstring" dir="in">
4532	<desc>Name of the storage controller the medium is attached to.</desc>
4533	</param>
4534	<param name="controllerPort" type="long" dir="in">
4535	<desc>Port to query.</desc>
4536	</param>
4537	<param name="device" type="long" dir="in">
4538	<desc>Device slot in the given port to query.</desc>
4539	</param>
4540	<param name="medium" type="IMedium" dir="return">
4541	<desc>Attached medium object.</desc>
4542	</param>
4543	</method>
4544
4545	<method name="getMediumAttachmentsOfController" const="yes">
4546	<desc>
4547	Returns an array of medium attachments which are attached to the
4548	the controller with the given name.
4549
4550	<result name="VBOX_E_OBJECT_NOT_FOUND">
4551	A storage controller with given name doesn't exist.
4552	</result>
4553	</desc>
4554	<param name="name" type="wstring" dir="in"/>
4555	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4556	</method>
4557
4558	<method name="getMediumAttachment" const="yes">
4559	<desc>
4560	Returns a medium attachment which corresponds to the controller with
4561	the given name, on the given port and device slot.
4562
4563	<result name="VBOX_E_OBJECT_NOT_FOUND">
4564	No attachment exists for the given controller/port/device combination.
4565	</result>
4566	</desc>
4567	<param name="name" type="wstring" dir="in"/>
4568	<param name="controllerPort" type="long" dir="in"/>
4569	<param name="device" type="long" dir="in"/>
4570	<param name="attachment" type="IMediumAttachment" dir="return"/>
4571	</method>
4572
4573	<method name="getNetworkAdapter" const="yes">
4574	<desc>
4575	Returns the network adapter associated with the given slot.
4576	Slots are numbered sequentially, starting with zero. The total
4577	number of adapters per machine is defined by the
4578	<link to="ISystemProperties::networkAdapterCount"/> property,
4579	so the maximum slot number is one less than that property's value.
4580
4581	<result name="E_INVALIDARG">
4582	Invalid @a slot number.
4583	</result>
4584
4585	</desc>
4586	<param name="slot" type="unsigned long" dir="in"/>
4587	<param name="adapter" type="INetworkAdapter" dir="return"/>
4588	</method>
4589
4590	<method name="addStorageController">
4591	<desc>
4592	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4593	machine and returns it as an instance of
4594	<link to="IStorageController" />.
4595
4596	@a name identifies the controller for subsequent calls such as
4597	<link to="#getStorageControllerByName" />,
4598	<link to="#getStorageControllerByInstance" />,
4599	<link to="#removeStorageController" />,
4600	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4601
4602	After the controller has been added, you can set its exact
4603	type by setting the <link to="IStorageController::controllerType" />.
4604
4605	<result name="VBOX_E_OBJECT_IN_USE">
4606	A storage controller with given name exists already.
4607	</result>
4608	<result name="E_INVALIDARG">
4609	Invalid @a controllerType.
4610	</result>
4611	</desc>
4612	<param name="name" type="wstring" dir="in"/>
4613	<param name="connectionType" type="StorageBus" dir="in"/>
4614	<param name="controller" type="IStorageController" dir="return"/>
4615	</method>
4616
4617	<method name="getStorageControllerByName" const="yes">
4618	<desc>
4619	Returns a storage controller with the given name.
4620
4621	<result name="VBOX_E_OBJECT_NOT_FOUND">
4622	A storage controller with given name doesn't exist.
4623	</result>
4624	</desc>
4625	<param name="name" type="wstring" dir="in"/>
4626	<param name="storageController" type="IStorageController" dir="return"/>
4627	</method>
4628
4629	<method name="getStorageControllerByInstance" const="yes">
4630	<desc>
4631	Returns a storage controller with the given instance number.
4632
4633	<result name="VBOX_E_OBJECT_NOT_FOUND">
4634	A storage controller with given instance number doesn't exist.
4635	</result>
4636	</desc>
4637	<param name="instance" type="unsigned long" dir="in"/>
4638	<param name="storageController" type="IStorageController" dir="return"/>
4639	</method>
4640
4641	<method name="removeStorageController">
4642	<desc>
4643	Removes a storage controller from the machine.
4644
4645	<result name="VBOX_E_OBJECT_NOT_FOUND">
4646	A storage controller with given name doesn't exist.
4647	</result>
4648	</desc>
4649	<param name="name" type="wstring" dir="in"/>
4650	</method>
4651
4652	<method name="getSerialPort" const="yes">
4653	<desc>
4654	Returns the serial port associated with the given slot.
4655	Slots are numbered sequentially, starting with zero. The total
4656	number of serial ports per machine is defined by the
4657	<link to="ISystemProperties::serialPortCount"/> property,
4658	so the maximum slot number is one less than that property's value.
4659
4660	<result name="E_INVALIDARG">
4661	Invalid @a slot number.
4662	</result>
4663
4664	</desc>
4665	<param name="slot" type="unsigned long" dir="in"/>
4666	<param name="port" type="ISerialPort" dir="return"/>
4667	</method>
4668
4669	<method name="getParallelPort" const="yes">
4670	<desc>
4671	Returns the parallel port associated with the given slot.
4672	Slots are numbered sequentially, starting with zero. The total
4673	number of parallel ports per machine is defined by the
4674	<link to="ISystemProperties::parallelPortCount"/> property,
4675	so the maximum slot number is one less than that property's value.
4676
4677	<result name="E_INVALIDARG">
4678	Invalid @a slot number.
4679	</result>
4680
4681	</desc>
4682	<param name="slot" type="unsigned long" dir="in"/>
4683	<param name="port" type="IParallelPort" dir="return"/>
4684	</method>
4685
4686	<method name="getExtraDataKeys">
4687	<desc>
4688	Returns an array representing the machine-specific extra data keys
4689	which currently have values defined.
4690	</desc>
4691	<param name="value" type="wstring" dir="return" safearray="yes">
4692	<desc>Array of extra data keys.</desc>
4693	</param>
4694	</method>
4695
4696	<method name="getExtraData">
4697	<desc>
4698	Returns associated machine-specific extra data.
4699
4700	If the requested data @a key does not exist, this function will
4701	succeed and return an empty string in the @a value argument.
4702
4703	<result name="VBOX_E_FILE_ERROR">
4704	Settings file not accessible.
4705	</result>
4706	<result name="VBOX_E_XML_ERROR">
4707	Could not parse the settings file.
4708	</result>
4709
4710	</desc>
4711	<param name="key" type="wstring" dir="in">
4712	<desc>Name of the data key to get.</desc>
4713	</param>
4714	<param name="value" type="wstring" dir="return">
4715	<desc>Value of the requested data key.</desc>
4716	</param>
4717	</method>
4718
4719	<method name="setExtraData">
4720	<desc>
4721	Sets associated machine-specific extra data.
4722
4723	If you pass @c null or an empty string as a key @a value, the given
4724	@a key will be deleted.
4725
4726	<note>
4727	Before performing the actual data change, this method will ask all
4728	registered listeners using the
4729	<link to="IExtraDataCanChangeEvent"/>
4730	notification for a permission. If one of the listeners refuses the
4731	new value, the change will not be performed.
4732	</note>
4733	<note>
4734	On success, the
4735	<link to="IExtraDataChangedEvent"/> notification
4736	is called to inform all registered listeners about a successful data
4737	change.
4738	</note>
4739	<note>
4740	This method can be called outside the machine session and therefore
4741	it's a caller's responsibility to handle possible race conditions
4742	when several clients change the same key at the same time.
4743	</note>
4744
4745	<result name="VBOX_E_FILE_ERROR">
4746	Settings file not accessible.
4747	</result>
4748	<result name="VBOX_E_XML_ERROR">
4749	Could not parse the settings file.
4750	</result>
4751
4752	</desc>
4753	<param name="key" type="wstring" dir="in">
4754	<desc>Name of the data key to set.</desc>
4755	</param>
4756	<param name="value" type="wstring" dir="in">
4757	<desc>Value to assign to the key.</desc>
4758	</param>
4759	</method>
4760
4761	<method name="getCPUProperty" const="yes">
4762	<desc>
4763	Returns the virtual CPU boolean value of the specified property.
4764
4765	<result name="E_INVALIDARG">
4766	Invalid property.
4767	</result>
4768
4769	</desc>
4770	<param name="property" type="CPUPropertyType" dir="in">
4771	<desc>
4772	Property type to query.
4773	</desc>
4774	</param>
4775	<param name="value" type="boolean" dir="return">
4776	<desc>
4777	Property value.
4778	</desc>
4779	</param>
4780	</method>
4781
4782	<method name="setCPUProperty">
4783	<desc>
4784	Sets the virtual CPU boolean value of the specified property.
4785
4786	<result name="E_INVALIDARG">
4787	Invalid property.
4788	</result>
4789
4790	</desc>
4791	<param name="property" type="CPUPropertyType" dir="in">
4792	<desc>
4793	Property type to query.
4794	</desc>
4795	</param>
4796	<param name="value" type="boolean" dir="in">
4797	<desc>
4798	Property value.
4799	</desc>
4800	</param>
4801	</method>
4802
4803	<method name="getCPUIDLeaf" const="yes">
4804	<desc>
4805	Returns the virtual CPU cpuid information for the specified leaf.
4806
4807	Currently supported index values for cpuid:
4808	Standard CPUID leafs: 0 - 0xA
4809	Extended CPUID leafs: 0x80000000 - 0x8000000A
4810
4811	See the Intel and AMD programmer's manuals for detailed information
4812	about the cpuid instruction and its leafs.
4813	<result name="E_INVALIDARG">
4814	Invalid id.
4815	</result>
4816
4817	</desc>
4818	<param name="id" type="unsigned long" dir="in">
4819	<desc>
4820	CPUID leaf index.
4821	</desc>
4822	</param>
4823	<param name="valEax" type="unsigned long" dir="out">
4824	<desc>
4825	CPUID leaf value for register eax.
4826	</desc>
4827	</param>
4828	<param name="valEbx" type="unsigned long" dir="out">
4829	<desc>
4830	CPUID leaf value for register ebx.
4831	</desc>
4832	</param>
4833	<param name="valEcx" type="unsigned long" dir="out">
4834	<desc>
4835	CPUID leaf value for register ecx.
4836	</desc>
4837	</param>
4838	<param name="valEdx" type="unsigned long" dir="out">
4839	<desc>
4840	CPUID leaf value for register edx.
4841	</desc>
4842	</param>
4843	</method>
4844
4845	<method name="setCPUIDLeaf">
4846	<desc>
4847	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
4848	are not passed unmodified. VirtualBox clears features that it doesn't support.
4849
4850	Currently supported index values for cpuid:
4851	Standard CPUID leafs: 0 - 0xA
4852	Extended CPUID leafs: 0x80000000 - 0x8000000A
4853
4854	See the Intel and AMD programmer's manuals for detailed information
4855	about the cpuid instruction and its leafs.
4856
4857	Do not use this method unless you know exactly what you're doing. Misuse can lead to
4858	random crashes inside VMs.
4859	<result name="E_INVALIDARG">
4860	Invalid id.
4861	</result>
4862
4863	</desc>
4864	<param name="id" type="unsigned long" dir="in">
4865	<desc>
4866	CPUID leaf index.
4867	</desc>
4868	</param>
4869	<param name="valEax" type="unsigned long" dir="in">
4870	<desc>
4871	CPUID leaf value for register eax.
4872	</desc>
4873	</param>
4874	<param name="valEbx" type="unsigned long" dir="in">
4875	<desc>
4876	CPUID leaf value for register ebx.
4877	</desc>
4878	</param>
4879	<param name="valEcx" type="unsigned long" dir="in">
4880	<desc>
4881	CPUID leaf value for register ecx.
4882	</desc>
4883	</param>
4884	<param name="valEdx" type="unsigned long" dir="in">
4885	<desc>
4886	CPUID leaf value for register edx.
4887	</desc>
4888	</param>
4889	</method>
4890
4891	<method name="removeCPUIDLeaf">
4892	<desc>
4893	Removes the virtual CPU cpuid leaf for the specified index
4894
4895	<result name="E_INVALIDARG">
4896	Invalid id.
4897	</result>
4898
4899	</desc>
4900	<param name="id" type="unsigned long" dir="in">
4901	<desc>
4902	CPUID leaf index.
4903	</desc>
4904	</param>
4905	</method>
4906
4907	<method name="removeAllCPUIDLeaves">
4908	<desc>
4909	Removes all the virtual CPU cpuid leaves
4910	</desc>
4911	</method>
4912
4913	<method name="getHWVirtExProperty" const="yes">
4914	<desc>
4915	Returns the value of the specified hardware virtualization boolean property.
4916
4917	<result name="E_INVALIDARG">
4918	Invalid property.
4919	</result>
4920
4921	</desc>
4922	<param name="property" type="HWVirtExPropertyType" dir="in">
4923	<desc>
4924	Property type to query.
4925	</desc>
4926	</param>
4927	<param name="value" type="boolean" dir="return">
4928	<desc>
4929	Property value.
4930	</desc>
4931	</param>
4932	</method>
4933
4934	<method name="setHWVirtExProperty">
4935	<desc>
4936	Sets a new value for the specified hardware virtualization boolean property.
4937
4938	<result name="E_INVALIDARG">
4939	Invalid property.
4940	</result>
4941
4942	</desc>
4943	<param name="property" type="HWVirtExPropertyType" dir="in">
4944	<desc>
4945	Property type to set.
4946	</desc>
4947	</param>
4948	<param name="value" type="boolean" dir="in">
4949	<desc>
4950	New property value.
4951	</desc>
4952	</param>
4953	</method>
4954
4955	<method name="saveSettings">
4956	<desc>
4957	Saves any changes to machine settings made since the session
4958	has been opened or a new machine has been created, or since the
4959	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4960	For registered machines, new settings become visible to all
4961	other VirtualBox clients after successful invocation of this
4962	method.
4963	<note>
4964	The method sends <link to="IMachineDataChangedEvent"/>
4965	notification event after the configuration has been successfully
4966	saved (only for registered machines).
4967	</note>
4968	<note>
4969	Calling this method is only valid on instances returned
4970	by <link to="ISession::machine"/> and on new machines
4971	created by <link to="IVirtualBox::createMachine"/> but not
4972	yet registered, or on unregistered machines after calling
4973	<link to="IMachine::unregister"/>.
4974	</note>
4975
4976	<result name="VBOX_E_FILE_ERROR">
4977	Settings file not accessible.
4978	</result>
4979	<result name="VBOX_E_XML_ERROR">
4980	Could not parse the settings file.
4981	</result>
4982	<result name="E_ACCESSDENIED">
4983	Modification request refused.
4984	</result>
4985
4986	</desc>
4987	</method>
4988
4989	<method name="discardSettings">
4990	<desc>
4991	Discards any changes to the machine settings made since the session
4992	has been opened or since the last call to <link to="#saveSettings"/>
4993	or <link to="#discardSettings"/>.
4994	<note>
4995	Calling this method is only valid on instances returned
4996	by <link to="ISession::machine"/> and on new machines
4997	created by <link to="IVirtualBox::createMachine"/> or
4998	opened by <link to="IVirtualBox::openMachine"/> but not
4999	yet registered, or on unregistered machines after calling
5000	<link to="IMachine::unregister"/>.
5001	</note>
5002
5003	<result name="VBOX_E_INVALID_VM_STATE">
5004	Virtual machine is not mutable.
5005	</result>
5006
5007	</desc>
5008	</method>
5009
5010	<method name="unregister">
5011	<desc>
5012	Unregisters the machine, which must have been previously registered using
5013	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5014	cleanup before the machine is unregistered.
5015
5016	This method does not delete any files. It only changes the machine configuration and
5017	the list of registered machines in the VirtualBox object. To delete the files which
5018	belonged to the machine, including the XML file of the machine itself, call
5019	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5020	from this method.
5021
5022	How thoroughly this method cleans up the machine configuration before unregistering
5023	the machine depends on the @a cleanupMode argument.
5024
5025	<ul>
5026	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5027	cleanup will be performed. The call will fail if the machine is in "Saved" state
5028	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5029	It is the responsibility of the caller to delete all such configuration in this mode.
5030	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5031	which it replaces.</li>
5032	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5033	state or if it has snapshots or media attached. All media attached to the current machine
5034	state or in snapshots will be detached. No medium objects will be returned; all of the
5035	machine's media will remain open.</li>
5036	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5037	except that all the hard disk medium objects which were detached from the machine will
5038	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5039	API for closing and deletion.</li>
5040	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5041	that all media will be returned in the array, including removeable media like DVDs and
5042	floppies. This might be useful if the user wants to inspect in detail which media were
5043	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5044	in that case because users will typically want to preserve ISO and RAW image files.</li>
5045	</ul>
5046
5047	This API does not verify whether the media files returned in the array are still
5048	attached to other machines (i.e. shared between several machines). If such a shared
5049	image is passed to <link to="#delete" /> however, closing the image will fail there
5050	and the image will be silently skipped.
5051
5052	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5053	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5054	deleted with all its saved states and hard disk images, but images for removeable
5055	drives (such as ISO and RAW files) will remain on disk.
5056
5057	The call will fail if the machine is currently locked (see <link to="ISession" />).
5058	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5059	before unregistering it.
5060
5061	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5062	is fired.
5063
5064	<note>
5065	If the given machine is inaccessible (see <link to="#accessible"/>), it
5066	will be unregistered and fully uninitialized right afterwards. As a result,
5067	the returned machine object will be unusable and an attempt to call
5068	<b>any</b> method will return the "Object not ready" error.
5069	</note>
5070
5071	<result name="VBOX_E_INVALID_OBJECT_STATE">
5072	Machine is currently locked for a session.
5073	</result>
5074	</desc>
5075
5076	<param name="cleanupMode" type="CleanupMode" dir="in">
5077	<desc>How to clean up after the machine has been unregistered.</desc>
5078	</param>
5079	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5080	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5081	</param>
5082	</method>
5083
5084	<method name="delete">
5085	<desc>
5086	Deletes the files associated with this machine from disk. If medium objects are passed
5087	in with the @a aMedia argument, they are closed and, if closing was succesful, their
5088	storage files are deleted as well. For convenience, this array of media files can be
5089	the same as the one returned from a previous <link to="#unregister" /> call.
5090
5091	This method must only be called on machines which are either write-locked (i.e. on instances
5092	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5093	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5094	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5095
5096	The following files will be deleted by this method:
5097	<ul>
5098	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5099	argument other than "UnregisterOnly", this will delete all saved state files that
5100	the machine had in use; possibly one if the machine was in "Saved" state and one
5101	for each online snapshot that the machine had.</li>
5102	<li>On each medium object passed in the @a aMedia array, this will call
5103	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5104	medium's storage on disk. Since the close() call will fail if the medium is still
5105	in use, e.g. because it is still attached to a second machine; in that case the
5106	storage will not be deleted.</li>
5107	<li>Finally, the machine's own XML file will be deleted.</li>
5108	</ul>
5109
5110	Since deleting large disk image files can be a time-consuming I/O operation, this
5111	method operates asynchronously and returns an IProgress object to allow the caller
5112	to monitor the progress. There will be one sub-operation for each file that is
5113	being deleted (saved state or medium storage file).
5114
5115	<note>
5116	<link to="#settingsModified"/> will return @c true after this
5117	method successfully returns.
5118	</note>
5119
5120	<result name="VBOX_E_INVALID_VM_STATE">
5121	Machine is registered but not write-locked.
5122	</result>
5123	<result name="VBOX_E_IPRT_ERROR">
5124	Could not delete the settings file.
5125	</result>
5126	</desc>
5127	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5128	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5129	</param>
5130	<param name="aProgress" type="IProgress" dir="return">
5131	<desc>Progress object to track the operation completion.</desc>
5132	</param>
5133	</method>
5134
5135	<method name="export">
5136	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5137	steps required to export VirtualBox machines to OVF.
5138	</desc>
5139
5140	<param name="aAppliance" type="IAppliance" dir="in">
5141	<desc>Appliance to export this machine to.</desc>
5142	</param>
5143	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5144	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5145	</param>
5146	</method >
5147
5148	<method name="getSnapshot">
5149	<desc>
5150	Returns a snapshot of this machine with the given UUID.
5151	A @c null UUID can be used to obtain the first snapshot
5152	taken on this machine. This is useful if you want to traverse
5153	the whole tree of snapshots starting from the root.
5154
5155	<result name="VBOX_E_OBJECT_NOT_FOUND">
5156	Virtual machine has no snapshots or snapshot not found.
5157	</result>
5158
5159	</desc>
5160	<param name="id" type="uuid" mod="string" dir="in">
5161	<desc>UUID of the snapshot to get</desc>
5162	</param>
5163	<param name="snapshot" type="ISnapshot" dir="return">
5164	<desc>Snapshot object with the given UUID.</desc>
5165	</param>
5166	</method>
5167
5168	<method name="findSnapshot">
5169	<desc>
5170	Returns a snapshot of this machine with the given name.
5171
5172	<result name="VBOX_E_OBJECT_NOT_FOUND">
5173	Virtual machine has no snapshots or snapshot not found.
5174	</result>
5175
5176	</desc>
5177	<param name="name" type="wstring" dir="in">
5178	<desc>Name of the snapshot to find</desc>
5179	</param>
5180	<param name="snapshot" type="ISnapshot" dir="return">
5181	<desc>Snapshot object with the given name.</desc>
5182	</param>
5183	</method>
5184
5185	<method name="setCurrentSnapshot">
5186	<desc>
5187	Sets the current snapshot of this machine.
5188	<note>
5189	In the current implementation, this operation is not
5190	implemented.
5191	</note>
5192	</desc>
5193	<param name="id" type="uuid" mod="string" dir="in">
5194	<desc>UUID of the snapshot to set as the current snapshot.</desc>
5195	</param>
5196	</method>
5197
5198	<method name="createSharedFolder">
5199	<desc>
5200	Creates a new permanent shared folder by associating the given logical
5201	name with the given host path, adds it to the collection of shared
5202	folders and starts sharing it. Refer to the description of
5203	<link to="ISharedFolder"/> to read more about logical names.
5204
5205	<result name="VBOX_E_OBJECT_IN_USE">
5206	Shared folder already exists.
5207	</result>
5208	<result name="VBOX_E_FILE_ERROR">
5209	Shared folder @a hostPath not accessible.
5210	</result>
5211
5212	</desc>
5213	<param name="name" type="wstring" dir="in">
5214	<desc>Unique logical name of the shared folder.</desc>
5215	</param>
5216	<param name="hostPath" type="wstring" dir="in">
5217	<desc>Full path to the shared folder in the host file system.</desc>
5218	</param>
5219	<param name="writable" type="boolean" dir="in">
5220	<desc>Whether the share is writable or readonly.</desc>
5221	</param>
5222	<param name="automount" type="boolean" dir="in">
5223	<desc>Whether the share gets automatically mounted by the guest
5224	or not.</desc>
5225	</param>
5226	</method>
5227
5228	<method name="removeSharedFolder">
5229	<desc>
5230	Removes the permanent shared folder with the given name previously
5231	created by <link to="#createSharedFolder"/> from the collection of
5232	shared folders and stops sharing it.
5233
5234	<result name="VBOX_E_INVALID_VM_STATE">
5235	Virtual machine is not mutable.
5236	</result>
5237	<result name="VBOX_E_OBJECT_NOT_FOUND">
5238	Shared folder @a name does not exist.
5239	</result>
5240
5241	</desc>
5242	<param name="name" type="wstring" dir="in">
5243	<desc>Logical name of the shared folder to remove.</desc>
5244	</param>
5245	</method>
5246
5247	<method name="canShowConsoleWindow">
5248	<desc>
5249	Returns @c true if the VM console process can activate the
5250	console window and bring it to foreground on the desktop of
5251	the host PC.
5252	<note>
5253	This method will fail if a session for this machine is not
5254	currently open.
5255	</note>
5256
5257	<result name="VBOX_E_INVALID_VM_STATE">
5258	Machine session is not open.
5259	</result>
5260
5261	</desc>
5262	<param name="canShow" type="boolean" dir="return">
5263	<desc>
5264	@c true if the console window can be shown and @c false otherwise.
5265	</desc>
5266	</param>
5267	</method>
5268
5269	<method name="showConsoleWindow">
5270	<desc>
5271	Activates the console window and brings it to foreground on
5272	the desktop of the host PC. Many modern window managers on
5273	many platforms implement some sort of focus stealing
5274	prevention logic, so that it may be impossible to activate
5275	a window without the help of the currently active
5276	application. In this case, this method will return a non-zero
5277	identifier that represents the top-level window of the VM
5278	console process. The caller, if it represents a currently
5279	active process, is responsible to use this identifier (in a
5280	platform-dependent manner) to perform actual window
5281	activation.
5282	<note>
5283	This method will fail if a session for this machine is not
5284	currently open.
5285	</note>
5286
5287	<result name="VBOX_E_INVALID_VM_STATE">
5288	Machine session is not open.
5289	</result>
5290
5291	</desc>
5292	<param name="winId" type="long long" dir="return">
5293	<desc>
5294	Platform-dependent identifier of the top-level VM console
5295	window, or zero if this method has performed all actions
5296	necessary to implement the <i>show window</i> semantics for
5297	the given platform and/or VirtualBox front-end.
5298	</desc>
5299	</param>
5300	</method>
5301
5302	<method name="getGuestProperty" const="yes">
5303	<desc>
5304	Reads an entry from the machine's guest property store.
5305
5306	<result name="VBOX_E_INVALID_VM_STATE">
5307	Machine session is not open.
5308	</result>
5309
5310	</desc>
5311	<param name="name" type="wstring" dir="in">
5312	<desc>
5313	The name of the property to read.
5314	</desc>
5315	</param>
5316	<param name="value" type="wstring" dir="out">
5317	<desc>
5318	The value of the property. If the property does not exist then this
5319	will be empty.
5320	</desc>
5321	</param>
5322	<param name="timestamp" type="long long" dir="out">
5323	<desc>
5324	The time at which the property was last modified, as seen by the
5325	server process.
5326	</desc>
5327	</param>
5328	<param name="flags" type="wstring" dir="out">
5329	<desc>
5330	Additional property parameters, passed as a comma-separated list of
5331	"name=value" type entries.
5332	</desc>
5333	</param>
5334	</method>
5335
5336	<method name="getGuestPropertyValue" const="yes">
5337	<desc>
5338	Reads a value from the machine's guest property store.
5339
5340	<result name="VBOX_E_INVALID_VM_STATE">
5341	Machine session is not open.
5342	</result>
5343
5344	</desc>
5345	<param name="property" type="wstring" dir="in">
5346	<desc>
5347	The name of the property to read.
5348	</desc>
5349	</param>
5350	<param name="value" type="wstring" dir="return">
5351	<desc>
5352	The value of the property. If the property does not exist then this
5353	will be empty.
5354	</desc>
5355	</param>
5356	</method>
5357
5358	<method name="getGuestPropertyTimestamp" const="yes">
5359	<desc>
5360	Reads a property timestamp from the machine's guest property store.
5361
5362	<result name="VBOX_E_INVALID_VM_STATE">
5363	Machine session is not open.
5364	</result>
5365
5366	</desc>
5367	<param name="property" type="wstring" dir="in">
5368	<desc>
5369	The name of the property to read.
5370	</desc>
5371	</param>
5372	<param name="value" type="long long" dir="return">
5373	<desc>
5374	The timestamp. If the property does not exist then this will be
5375	empty.
5376	</desc>
5377	</param>
5378	</method>
5379
5380	<method name="setGuestProperty">
5381	<desc>
5382	Sets, changes or deletes an entry in the machine's guest property
5383	store.
5384
5385	<result name="E_ACCESSDENIED">
5386	Property cannot be changed.
5387	</result>
5388	<result name="E_INVALIDARG">
5389	Invalid @a flags.
5390	</result>
5391	<result name="VBOX_E_INVALID_VM_STATE">
5392	Virtual machine is not mutable or session not open.
5393	</result>
5394	<result name="VBOX_E_INVALID_OBJECT_STATE">
5395	Cannot set transient property when machine not running.
5396	</result>
5397
5398	</desc>
5399	<param name="property" type="wstring" dir="in">
5400	<desc>
5401	The name of the property to set, change or delete.
5402	</desc>
5403	</param>
5404	<param name="value" type="wstring" dir="in">
5405	<desc>
5406	The new value of the property to set, change or delete. If the
5407	property does not yet exist and value is non-empty, it will be
5408	created. If the value is @c null or empty, the property will be
5409	deleted if it exists.
5410	</desc>
5411	</param>
5412	<param name="flags" type="wstring" dir="in">
5413	<desc>
5414	Additional property parameters, passed as a comma-separated list of
5415	"name=value" type entries.
5416	</desc>
5417	</param>
5418	</method>
5419
5420	<method name="setGuestPropertyValue">
5421	<desc>
5422	Sets, changes or deletes a value in the machine's guest property
5423	store. The flags field will be left unchanged or created empty for a
5424	new property.
5425
5426	<result name="E_ACCESSDENIED">
5427	Property cannot be changed.
5428	</result>
5429	<result name="VBOX_E_INVALID_VM_STATE">
5430	Virtual machine is not mutable or session not open.
5431	</result>
5432	<result name="VBOX_E_INVALID_OBJECT_STATE">
5433	Cannot set transient property when machine not running.
5434	</result>
5435	</desc>
5436
5437	<param name="property" type="wstring" dir="in">
5438	<desc>
5439	The name of the property to set, change or delete.
5440	</desc>
5441	</param>
5442	<param name="value" type="wstring" dir="in">
5443	<desc>
5444	The new value of the property to set, change or delete. If the
5445	property does not yet exist and value is non-empty, it will be
5446	created. If the value is @c null or empty, the property will be
5447	deleted if it exists.
5448	</desc>
5449	</param>
5450	</method>
5451
5452	<method name="enumerateGuestProperties">
5453	<desc>
5454	Return a list of the guest properties matching a set of patterns along
5455	with their values, time stamps and flags.
5456	</desc>
5457	<param name="patterns" type="wstring" dir="in">
5458	<desc>
5459	The patterns to match the properties against, separated by '\|'
5460	characters. If this is empty or @c null, all properties will match.
5461	</desc>
5462	</param>
5463	<param name="name" type="wstring" dir="out" safearray="yes">
5464	<desc>
5465	The names of the properties returned.
5466	</desc>
5467	</param>
5468	<param name="value" type="wstring" dir="out" safearray="yes">
5469	<desc>
5470	The values of the properties returned. The array entries match the
5471	corresponding entries in the @a name array.
5472	</desc>
5473	</param>
5474	<param name="timestamp" type="long long" dir="out" safearray="yes">
5475	<desc>
5476	The time stamps of the properties returned. The array entries match
5477	the corresponding entries in the @a name array.
5478	</desc>
5479	</param>
5480	<param name="flags" type="wstring" dir="out" safearray="yes">
5481	<desc>
5482	The flags of the properties returned. The array entries match the
5483	corresponding entries in the @a name array.
5484	</desc>
5485	</param>
5486	</method>
5487
5488	<method name="querySavedThumbnailSize">
5489	<desc>
5490	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5491	</desc>
5492	<param name="screenId" type="unsigned long" dir="in">
5493	<desc>
5494	Saved guest screen to query info from.
5495	</desc>
5496	</param>
5497	<param name="size" type="unsigned long" dir="out">
5498	<desc>
5499	Size of buffer required to store the bitmap.
5500	</desc>
5501	</param>
5502	<param name="width" type="unsigned long" dir="out">
5503	<desc>
5504	Bitmap width.
5505	</desc>
5506	</param>
5507	<param name="height" type="unsigned long" dir="out">
5508	<desc>
5509	Bitmap height.
5510	</desc>
5511	</param>
5512	</method>
5513
5514	<method name="readSavedThumbnailToArray">
5515	<desc>
5516	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5517	</desc>
5518	<param name="screenId" type="unsigned long" dir="in">
5519	<desc>
5520	Saved guest screen to read from.
5521	</desc>
5522	</param>
5523	<param name="BGR" type="boolean" dir="in">
5524	<desc>
5525	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5526	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5527	</desc>
5528	</param>
5529	<param name="width" type="unsigned long" dir="out">
5530	<desc>
5531	Bitmap width.
5532	</desc>
5533	</param>
5534	<param name="height" type="unsigned long" dir="out">
5535	<desc>
5536	Bitmap height.
5537	</desc>
5538	</param>
5539	<param name="data" type="octet" safearray="yes" dir="return">
5540	<desc>
5541	Array with resulting bitmap data.
5542	</desc>
5543	</param>
5544	</method>
5545
5546	<method name="querySavedScreenshotPNGSize">
5547	<desc>
5548	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5549	</desc>
5550	<param name="screenId" type="unsigned long" dir="in">
5551	<desc>
5552	Saved guest screen to query info from.
5553	</desc>
5554	</param>
5555	<param name="size" type="unsigned long" dir="out">
5556	<desc>
5557	Size of buffer required to store the PNG binary data.
5558	</desc>
5559	</param>
5560	<param name="width" type="unsigned long" dir="out">
5561	<desc>
5562	Image width.
5563	</desc>
5564	</param>
5565	<param name="height" type="unsigned long" dir="out">
5566	<desc>
5567	Image height.
5568	</desc>
5569	</param>
5570	</method>
5571
5572	<method name="readSavedScreenshotPNGToArray">
5573	<desc>
5574	Screenshot in PNG format is retrieved to an array of bytes.
5575	</desc>
5576	<param name="screenId" type="unsigned long" dir="in">
5577	<desc>
5578	Saved guest screen to read from.
5579	</desc>
5580	</param>
5581	<param name="width" type="unsigned long" dir="out">
5582	<desc>
5583	Image width.
5584	</desc>
5585	</param>
5586	<param name="height" type="unsigned long" dir="out">
5587	<desc>
5588	Image height.
5589	</desc>
5590	</param>
5591	<param name="data" type="octet" dir="return" safearray="yes">
5592	<desc>
5593	Array with resulting PNG data.
5594	</desc>
5595	</param>
5596	</method>
5597
5598	<method name="hotPlugCPU">
5599	<desc>
5600	Plugs a CPU into the machine.
5601	</desc>
5602	<param name="cpu" type="unsigned long" dir="in">
5603	<desc>
5604	The CPU id to insert.
5605	</desc>
5606	</param>
5607	</method>
5608
5609	<method name="hotUnplugCPU">
5610	<desc>
5611	Removes a CPU from the machine.
5612	</desc>
5613	<param name="cpu" type="unsigned long" dir="in">
5614	<desc>
5615	The CPU id to remove.
5616	</desc>
5617	</param>
5618	</method>
5619
5620	<method name="getCPUStatus">
5621	<desc>
5622	Returns the current status of the given CPU.
5623	</desc>
5624	<param name="cpu" type="unsigned long" dir="in">
5625	<desc>
5626	The CPU id to check for.
5627	</desc>
5628	</param>
5629	<param name="attached" type="boolean" dir="return">
5630	<desc>
5631	Status of the CPU.
5632	</desc>
5633	</param>
5634	</method>
5635
5636	<method name="queryLogFilename">
5637	<desc>
5638	Queries for the VM log file name of an given index. Returns an empty
5639	string if a log file with that index doesn't exists.
5640	</desc>
5641	<param name="idx" type="unsigned long" dir="in">
5642	<desc>
5643	Which log file name to query. 0=current log file.
5644	</desc>
5645	</param>
5646	<param name="filename" type="wstring" dir="return">
5647	<desc>
5648	On return the full path to the log file or an empty string on error.
5649	</desc>
5650	</param>
5651	</method>
5652
5653	<method name="readLog">
5654	<desc>
5655	Reads the VM log file. The chunk size is limited, so even if you
5656	ask for a big piece there might be less data returned.
5657	</desc>
5658	<param name="idx" type="unsigned long" dir="in">
5659	<desc>
5660	Which log file to read. 0=current log file.
5661	</desc>
5662	</param>
5663	<param name="offset" type="long long" dir="in">
5664	<desc>
5665	Offset in the log file.
5666	</desc>
5667	</param>
5668	<param name="size" type="long long" dir="in">
5669	<desc>
5670	Chunk size to read in the log file.
5671	</desc>
5672	</param>
5673	<param name="data" type="octet" dir="return" safearray="yes">
5674	<desc>
5675	Data read from the log file. A data size of 0 means end of file
5676	if the requested chunk size was not 0. This is the unprocessed
5677	file data, i.e. the line ending style depends on the platform of
5678	the system the server is running on.
5679	</desc>
5680	</param>
5681	</method>
5682	</interface>
5683
5684	<!--
5685	// IConsole
5686	/////////////////////////////////////////////////////////////////////////
5687	-->
5688
5689	<interface
5690	name="IRemoteDisplayInfo" extends="$unknown"
5691	uuid="b3741084-806f-4c3b-8c42-ebad1a81e45a"
5692	wsmap="struct"
5693	>
5694	<desc>
5695	Contains information about the remote display (VRDP) capabilities and status.
5696	This is used in the <link to="IConsole::remoteDisplayInfo" /> attribute.
5697	</desc>
5698
5699	<attribute name="active" type="boolean" readonly="yes">
5700	<desc>
5701	Whether the remote display connection is active.
5702	</desc>
5703	</attribute>
5704
5705	<attribute name="port" type="long" readonly="yes">
5706	<desc>
5707	VRDP server port number. If this property is equal to <tt>0</tt>, then
5708	the VRDP server failed to start, usually because there are no free TCP
5709	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDP
5710	server has not yet been started.
5711	</desc>
5712	</attribute>
5713
5714	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5715	<desc>
5716	How many times a client connected.
5717	</desc>
5718	</attribute>
5719
5720	<attribute name="beginTime" type="long long" readonly="yes">
5721	<desc>
5722	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5723	</desc>
5724	</attribute>
5725
5726	<attribute name="endTime" type="long long" readonly="yes">
5727	<desc>
5728	When the last connection was terminated or the current time, if
5729	connection is still active, in milliseconds since 1970-01-01 UTC.
5730	</desc>
5731	</attribute>
5732
5733	<attribute name="bytesSent" type="long long" readonly="yes">
5734	<desc>
5735	How many bytes were sent in last or current, if still active, connection.
5736	</desc>
5737	</attribute>
5738
5739	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5740	<desc>
5741	How many bytes were sent in all connections.
5742	</desc>
5743	</attribute>
5744
5745	<attribute name="bytesReceived" type="long long" readonly="yes">
5746	<desc>
5747	How many bytes were received in last or current, if still active, connection.
5748	</desc>
5749	</attribute>
5750
5751	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5752	<desc>
5753	How many bytes were received in all connections.
5754	</desc>
5755	</attribute>
5756
5757	<attribute name="user" type="wstring" readonly="yes">
5758	<desc>
5759	Login user name supplied by the client.
5760	</desc>
5761	</attribute>
5762
5763	<attribute name="domain" type="wstring" readonly="yes">
5764	<desc>
5765	Login domain name supplied by the client.
5766	</desc>
5767	</attribute>
5768
5769	<attribute name="clientName" type="wstring" readonly="yes">
5770	<desc>
5771	The client name supplied by the client.
5772	</desc>
5773	</attribute>
5774
5775	<attribute name="clientIP" type="wstring" readonly="yes">
5776	<desc>
5777	The IP address of the client.
5778	</desc>
5779	</attribute>
5780
5781	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5782	<desc>
5783	The client software version number.
5784	</desc>
5785	</attribute>
5786
5787	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5788	<desc>
5789	Public key exchange method used when connection was established.
5790	Values: 0 - RDP4 public key exchange scheme.
5791	1 - X509 certificates were sent to client.
5792	</desc>
5793	</attribute>
5794
5795	</interface>
5796
5797	<interface
5798	name="IConsole" extends="$unknown"
5799	uuid="03cb7897-ea17-4e6c-81ae-4bd90be2fde2"
5800	wsmap="managed"
5801	>
5802	<desc>
5803	The IConsole interface represents an interface to control virtual
5804	machine execution.
5805
5806	A console object gets created when a machine has been locked for a
5807	particular session (client process) using <link to="IMachine::lockMachine" />
5808	or <link to="IMachine::launchVMProcess"/>. The console object can
5809	then be found in the session's <link to="ISession::console" /> attribute.
5810
5811	Methods of the IConsole interface allow the caller to query the current
5812	virtual machine execution state, pause the machine or power it down, save
5813	the machine state or take a snapshot, attach and detach removable media
5814	and so on.
5815
5816	<see>ISession</see>
5817	</desc>
5818
5819	<attribute name="machine" type="IMachine" readonly="yes">
5820	<desc>
5821	Machine object this console is sessioned with.
5822	<note>
5823	This is a convenience property, it has the same value as
5824	<link to="ISession::machine"/> of the corresponding session
5825	object.
5826	</note>
5827	</desc>
5828	</attribute>
5829
5830	<attribute name="state" type="MachineState" readonly="yes">
5831	<desc>
5832	Current execution state of the machine.
5833	<note>
5834	This property always returns the same value as the corresponding
5835	property of the IMachine object this console is sessioned with.
5836	For the process that owns (executes) the VM, this is the
5837	preferable way of querying the VM state, because no IPC
5838	calls are made.
5839	</note>
5840	</desc>
5841	</attribute>
5842
5843	<attribute name="guest" type="IGuest" readonly="yes">
5844	<desc>Guest object.</desc>
5845	</attribute>
5846
5847	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5848	<desc>
5849	Virtual keyboard object.
5850	<note>
5851	If the machine is not running, any attempt to use
5852	the returned object will result in an error.
5853	</note>
5854	</desc>
5855	</attribute>
5856
5857	<attribute name="mouse" type="IMouse" readonly="yes">
5858	<desc>
5859	Virtual mouse object.
5860	<note>
5861	If the machine is not running, any attempt to use
5862	the returned object will result in an error.
5863	</note>
5864	</desc>
5865	</attribute>
5866
5867	<attribute name="display" type="IDisplay" readonly="yes">
5868	<desc>Virtual display object.
5869	<note>
5870	If the machine is not running, any attempt to use
5871	the returned object will result in an error.
5872	</note>
5873	</desc>
5874	</attribute>
5875
5876	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5877	<desc>Debugging interface.</desc>
5878	</attribute>
5879
5880	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5881	<desc>
5882	Collection of USB devices currently attached to the virtual
5883	USB controller.
5884	<note>
5885	The collection is empty if the machine is not running.
5886	</note>
5887	</desc>
5888	</attribute>
5889
5890	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
5891	<desc>
5892	List of USB devices currently attached to the remote VRDP client.
5893	Once a new device is physically attached to the remote host computer,
5894	it appears in this list and remains there until detached.
5895	</desc>
5896	</attribute>
5897
5898	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
5899	<desc>
5900	Collection of shared folders for the current session. These folders
5901	are called transient shared folders because they are available to the
5902	guest OS running inside the associated virtual machine only for the
5903	duration of the session (as opposed to
5904	<link to="IMachine::sharedFolders"/> which represent permanent shared
5905	folders). When the session is closed (e.g. the machine is powered down),
5906	these folders are automatically discarded.
5907
5908	New shared folders are added to the collection using
5909	<link to="#createSharedFolder"/>. Existing shared folders can be
5910	removed using <link to="#removeSharedFolder"/>.
5911	</desc>
5912	</attribute>
5913
5914	<attribute name="remoteDisplayInfo" type="IRemoteDisplayInfo" readonly="yes">
5915	<desc>
5916	Interface that provides information on Remote Display (VRDP) connection.
5917	</desc>
5918	</attribute>
5919
5920	<attribute name="eventSource" type="IEventSource" readonly="yes">
5921	<desc>
5922	Event source for console events.
5923	</desc>
5924	</attribute>
5925
5926	<method name="powerUp">
5927	<desc>
5928	Starts the virtual machine execution using the current machine
5929	state (that is, its current execution state, current settings and
5930	current storage devices).
5931
5932	<note>
5933	This method is only useful for front-ends that want to actually
5934	execute virtual machines in their own process (like the VirtualBox
5935	or VBoxSDL front-ends). Unless you are intending to write such a
5936	front-end, do not call this method. If you simply want to
5937	start virtual machine execution using one of the existing front-ends
5938	(for example the VirtualBox GUI or headless server), use
5939	<link to="IMachine::launchVMProcess"/> instead; these
5940	front-ends will power up the machine automatically for you.
5941	</note>
5942
5943	If the machine is powered off or aborted, the execution will
5944	start from the beginning (as if the real hardware were just
5945	powered on).
5946
5947	If the machine is in the <link to="MachineState::Saved"/> state,
5948	it will continue its execution the point where the state has
5949	been saved.
5950
5951	If the machine <link to="IMachine::teleporterEnabled"/> property is
5952	enabled on the machine being powered up, the machine will wait for an
5953	incoming teleportation in the <link to="MachineState::TeleportingIn"/>
5954	state. The returned progress object will have at least three
5955	operations where the last three are defined as: (1) powering up and
5956	starting TCP server, (2) waiting for incoming teleportations, and
5957	(3) perform teleportation. These operations will be reflected as the
5958	last three operations of the progress objected returned by
5959	<link to="IMachine::launchVMProcess"/> as well.
5960
5961	<see>#saveState</see>
5962
5963	<result name="VBOX_E_INVALID_VM_STATE">
5964	Virtual machine already running.
5965	</result>
5966	<result name="VBOX_E_HOST_ERROR">
5967	Host interface does not exist or name not set.
5968	</result>
5969	<result name="VBOX_E_FILE_ERROR">
5970	Invalid saved state file.
5971	</result>
5972	</desc>
5973	<param name="progress" type="IProgress" dir="return">
5974	<desc>Progress object to track the operation completion.</desc>
5975	</param>
5976	</method>
5977
5978	<method name="powerUpPaused">
5979	<desc>
5980	Identical to powerUp except that the VM will enter the
5981	<link to="MachineState::Paused"/> state, instead of
5982	<link to="MachineState::Running"/>.
5983
5984	<see>#powerUp</see>
5985	<result name="VBOX_E_INVALID_VM_STATE">
5986	Virtual machine already running.
5987	</result>
5988	<result name="VBOX_E_HOST_ERROR">
5989	Host interface does not exist or name not set.
5990	</result>
5991	<result name="VBOX_E_FILE_ERROR">
5992	Invalid saved state file.
5993	</result>
5994	</desc>
5995	<param name="progress" type="IProgress" dir="return">
5996	<desc>Progress object to track the operation completion.</desc>
5997	</param>
5998	</method>
5999
6000	<method name="powerDown">
6001	<desc>
6002	Initiates the power down procedure to stop the virtual machine
6003	execution.
6004
6005	The completion of the power down procedure is tracked using the returned
6006	IProgress object. After the operation is complete, the machine will go
6007	to the PoweredOff state.
6008	<result name="VBOX_E_INVALID_VM_STATE">
6009	Virtual machine must be Running, Paused or Stuck to be powered down.
6010	</result>
6011	</desc>
6012	<param name="progress" type="IProgress" dir="return">
6013	<desc>Progress object to track the operation completion.</desc>
6014	</param>
6015	</method>
6016
6017	<method name="reset">
6018	<desc>Resets the virtual machine.
6019	<result name="VBOX_E_INVALID_VM_STATE">
6020	Virtual machine not in Running state.
6021	</result>
6022	<result name="VBOX_E_VM_ERROR">
6023	Virtual machine error in reset operation.
6024	</result>
6025	</desc>
6026	</method>
6027
6028	<method name="pause">
6029	<desc>Pauses the virtual machine execution.
6030	<result name="VBOX_E_INVALID_VM_STATE">
6031	Virtual machine not in Running state.
6032	</result>
6033	<result name="VBOX_E_VM_ERROR">
6034	Virtual machine error in suspend operation.
6035	</result>
6036	</desc>
6037	</method>
6038
6039	<method name="resume">
6040	<desc>Resumes the virtual machine execution.
6041	<result name="VBOX_E_INVALID_VM_STATE">
6042	Virtual machine not in Paused state.
6043	</result>
6044	<result name="VBOX_E_VM_ERROR">
6045	Virtual machine error in resume operation.
6046	</result>
6047	</desc>
6048	</method>
6049
6050	<method name="powerButton">
6051	<desc>Sends the ACPI power button event to the guest.
6052	<result name="VBOX_E_INVALID_VM_STATE">
6053	Virtual machine not in Running state.
6054	</result>
6055	<result name="VBOX_E_PDM_ERROR">
6056	Controlled power off failed.
6057	</result>
6058	</desc>
6059	</method>
6060
6061	<method name="sleepButton">
6062	<desc>Sends the ACPI sleep button event to the guest.
6063	<result name="VBOX_E_INVALID_VM_STATE">
6064	Virtual machine not in Running state.
6065	</result>
6066	<result name="VBOX_E_PDM_ERROR">
6067	Sending sleep button event failed.
6068	</result>
6069	</desc>
6070	</method>
6071
6072	<method name="getPowerButtonHandled">
6073	<desc>Checks if the last power button event was handled by guest.
6074	<result name="VBOX_E_PDM_ERROR">
6075	Checking if the event was handled by the guest OS failed.
6076	</result>
6077	</desc>
6078	<param name="handled" type="boolean" dir="return"/>
6079	</method>
6080
6081	<method name="getGuestEnteredACPIMode">
6082	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6083	G1 (sleeping). If this method returns @c false, the guest will
6084	most likely not respond to external ACPI events.
6085	<result name="VBOX_E_INVALID_VM_STATE">
6086	Virtual machine not in Running state.
6087	</result>
6088	</desc>
6089	<param name="entered" type="boolean" dir="return"/>
6090	</method>
6091
6092	<method name="saveState">
6093	<desc>
6094	Saves the current execution state of a running virtual machine
6095	and stops its execution.
6096
6097	After this operation completes, the machine will go to the
6098	Saved state. Next time it is powered up, this state will
6099	be restored and the machine will continue its execution from
6100	the place where it was saved.
6101
6102	This operation differs from taking a snapshot to the effect
6103	that it doesn't create new differencing media. Also, once
6104	the machine is powered up from the state saved using this method,
6105	the saved state is deleted, so it will be impossible to return
6106	to this state later.
6107
6108	<note>
6109	On success, this method implicitly calls
6110	<link to="IMachine::saveSettings"/> to save all current machine
6111	settings (including runtime changes to the DVD medium, etc.).
6112	Together with the impossibility to change any VM settings when it is
6113	in the Saved state, this guarantees adequate hardware
6114	configuration of the machine when it is restored from the saved
6115	state file.
6116	</note>
6117
6118	<note>
6119	The machine must be in the Running or Paused state, otherwise
6120	the operation will fail.
6121	</note>
6122	<result name="VBOX_E_INVALID_VM_STATE">
6123	Virtual machine state neither Running nor Paused.
6124	</result>
6125	<result name="VBOX_E_FILE_ERROR">
6126	Failed to create directory for saved state file.
6127	</result>
6128
6129	<see><link to="#takeSnapshot"/></see>
6130	</desc>
6131	<param name="progress" type="IProgress" dir="return">
6132	<desc>Progress object to track the operation completion.</desc>
6133	</param>
6134	</method>
6135
6136	<method name="adoptSavedState">
6137	<desc>
6138	Associates the given saved state file to the virtual machine.
6139
6140	On success, the machine will go to the Saved state. Next time it is
6141	powered up, it will be restored from the adopted saved state and
6142	continue execution from the place where the saved state file was
6143	created.
6144
6145	The specified saved state file path may be absolute or relative to the
6146	folder the VM normally saves the state to (usually,
6147	<link to="IMachine::snapshotFolder"/>).
6148
6149	<note>
6150	It's a caller's responsibility to make sure the given saved state
6151	file is compatible with the settings of this virtual machine that
6152	represent its virtual hardware (memory size, storage disk configuration
6153	etc.). If there is a mismatch, the behavior of the virtual machine
6154	is undefined.
6155	</note>
6156	<result name="VBOX_E_INVALID_VM_STATE">
6157	Virtual machine state neither PoweredOff nor Aborted.
6158	</result>
6159	</desc>
6160	<param name="savedStateFile" type="wstring" dir="in">
6161	<desc>Path to the saved state file to adopt.</desc>
6162	</param>
6163	</method>
6164
6165	<method name="discardSavedState">
6166	<desc>
6167	Forcibly resets the machine to "Powered Off" state if it is
6168	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6169	Next time the machine is powered up, a clean boot will occur.
6170	<note>
6171	This operation is equivalent to resetting or powering off
6172	the machine without doing a proper shutdown of the guest
6173	operating system; as with resetting a running phyiscal
6174	computer, it can can lead to data loss.
6175	</note>
6176	If @a fRemoveFile is @c true, the file in the machine directory
6177	into which the machine state was saved is also deleted. If
6178	this is @c false, then the state can be recovered and later
6179	re-inserted into a machine using <link to="#adoptSavedState" />.
6180	The location of the file can be found in the
6181	<link to="IMachine::stateFilePath" /> attribute.
6182	<result name="VBOX_E_INVALID_VM_STATE">
6183	Virtual machine not in state Saved.
6184	</result>
6185	</desc>
6186	<param name="fRemoveFile" type="boolean" dir="in" >
6187	<desc>Whether to also remove the saved state file.</desc>
6188	</param>
6189	</method>
6190
6191	<method name="getDeviceActivity">
6192	<desc>
6193	Gets the current activity type of a given device or device group.
6194	<result name="E_INVALIDARG">
6195	Invalid device type.
6196	</result>
6197	</desc>
6198	<param name="type" type="DeviceType" dir="in"/>
6199	<param name="activity" type="DeviceActivity" dir="return"/>
6200	</method>
6201
6202	<method name="attachUSBDevice">
6203	<desc>
6204	Attaches a host USB device with the given UUID to the
6205	USB controller of the virtual machine.
6206
6207	The device needs to be in one of the following states:
6208	<link to="USBDeviceState::Busy"/>,
6209	<link to="USBDeviceState::Available"/> or
6210	<link to="USBDeviceState::Held"/>,
6211	otherwise an error is immediately returned.
6212
6213	When the device state is
6214	<link to="USBDeviceState::Busy">Busy</link>, an error may also
6215	be returned if the host computer refuses to release it for some reason.
6216
6217	<see>IUSBController::deviceFilters, USBDeviceState</see>
6218	<result name="VBOX_E_INVALID_VM_STATE">
6219	Virtual machine state neither Running nor Paused.
6220	</result>
6221	<result name="VBOX_E_PDM_ERROR">
6222	Virtual machine does not have a USB controller.
6223	</result>
6224	</desc>
6225	<param name="id" type="uuid" mod="string" dir="in">
6226	<desc>UUID of the host USB device to attach.</desc>
6227	</param>
6228	</method>
6229
6230	<method name="detachUSBDevice">
6231	<desc>
6232	Detaches an USB device with the given UUID from the USB controller
6233	of the virtual machine.
6234
6235	After this method succeeds, the VirtualBox server re-initiates
6236	all USB filters as if the device were just physically attached
6237	to the host, but filters of this machine are ignored to avoid
6238	a possible automatic re-attachment.
6239
6240	<see>IUSBController::deviceFilters, USBDeviceState</see>
6241
6242	<result name="VBOX_E_PDM_ERROR">
6243	Virtual machine does not have a USB controller.
6244	</result>
6245	<result name="E_INVALIDARG">
6246	USB device not attached to this virtual machine.
6247	</result>
6248	</desc>
6249	<param name="id" type="uuid" mod="string" dir="in">
6250	<desc>UUID of the USB device to detach.</desc>
6251	</param>
6252	<param name="device" type="IUSBDevice" dir="return">
6253	<desc>Detached USB device.</desc>
6254	</param>
6255	</method>
6256
6257	<method name="findUSBDeviceByAddress">
6258	<desc>
6259	Searches for a USB device with the given host address.
6260
6261	<result name="VBOX_E_OBJECT_NOT_FOUND">
6262	Given @c name does not correspond to any USB device.
6263	</result>
6264
6265	<see>IUSBDevice::address</see>
6266	</desc>
6267	<param name="name" type="wstring" dir="in">
6268	<desc>
6269	Address of the USB device (as assigned by the host) to
6270	search for.
6271	</desc>
6272	</param>
6273	<param name="device" type="IUSBDevice" dir="return">
6274	<desc>Found USB device object.</desc>
6275	</param>
6276	</method>
6277
6278	<method name="findUSBDeviceById">
6279	<desc>
6280	Searches for a USB device with the given UUID.
6281
6282	<result name="VBOX_E_OBJECT_NOT_FOUND">
6283	Given @c id does not correspond to any USB device.
6284	</result>
6285
6286	<see>IUSBDevice::id</see>
6287	</desc>
6288	<param name="id" type="uuid" mod="string" dir="in">
6289	<desc>UUID of the USB device to search for.</desc>
6290	</param>
6291	<param name="device" type="IUSBDevice" dir="return">
6292	<desc>Found USB device object.</desc>
6293	</param>
6294	</method>
6295
6296	<method name="createSharedFolder">
6297	<desc>
6298	Creates a transient new shared folder by associating the given logical
6299	name with the given host path, adds it to the collection of shared
6300	folders and starts sharing it. Refer to the description of
6301	<link to="ISharedFolder"/> to read more about logical names.
6302
6303	<result name="VBOX_E_INVALID_VM_STATE">
6304	Virtual machine in Saved state or currently changing state.
6305	</result>
6306	<result name="VBOX_E_FILE_ERROR">
6307	Shared folder already exists or not accessible.
6308	</result>
6309	</desc>
6310	<param name="name" type="wstring" dir="in">
6311	<desc>Unique logical name of the shared folder.</desc>
6312	</param>
6313	<param name="hostPath" type="wstring" dir="in">
6314	<desc>Full path to the shared folder in the host file system.</desc>
6315	</param>
6316	<param name="writable" type="boolean" dir="in">
6317	<desc>Whether the share is writable or readonly</desc>
6318	</param>
6319	<param name="automount" type="boolean" dir="in">
6320	<desc>Whether the share gets automatically mounted by the guest
6321	or not.</desc>
6322	</param>
6323	</method>
6324
6325	<method name="removeSharedFolder">
6326	<desc>
6327	Removes a transient shared folder with the given name previously
6328	created by <link to="#createSharedFolder"/> from the collection of
6329	shared folders and stops sharing it.
6330	<result name="VBOX_E_INVALID_VM_STATE">
6331	Virtual machine in Saved state or currently changing state.
6332	</result>
6333	<result name="VBOX_E_FILE_ERROR">
6334	Shared folder does not exists.
6335	</result>
6336	</desc>
6337	<param name="name" type="wstring" dir="in">
6338	<desc>Logical name of the shared folder to remove.</desc>
6339	</param>
6340	</method>
6341
6342	<method name="takeSnapshot">
6343	<desc>
6344	Saves the current execution state
6345	and all settings of the machine and creates differencing images
6346	for all normal (non-independent) media.
6347	See <link to="ISnapshot" /> for an introduction to snapshots.
6348
6349	This method can be called for a PoweredOff, Saved (see
6350	<link to="#saveState"/>), Running or
6351	Paused virtual machine. When the machine is PoweredOff, an
6352	offline snapshot is created. When the machine is Running a live
6353	snapshot is created, and an online snapshot is is created when Paused.
6354
6355	The taken snapshot is always based on the
6356	<link to="IMachine::currentSnapshot">current snapshot</link>
6357	of the associated virtual machine and becomes a new current snapshot.
6358
6359	<note>
6360	This method implicitly calls <link to="IMachine::saveSettings"/> to
6361	save all current machine settings before taking an offline snapshot.
6362	</note>
6363
6364	<result name="VBOX_E_INVALID_VM_STATE">
6365	Virtual machine currently changing state.
6366	</result>
6367	</desc>
6368	<param name="name" type="wstring" dir="in">
6369	<desc>Short name for the snapshot.</desc>
6370	</param>
6371	<param name="description" type="wstring" dir="in">
6372	<desc>Optional description of the snapshot.</desc>
6373	</param>
6374	<param name="progress" type="IProgress" dir="return">
6375	<desc>Progress object to track the operation completion.</desc>
6376	</param>
6377	</method>
6378
6379	<method name="deleteSnapshot">
6380	<desc>
6381	Starts deleting the specified snapshot asynchronously.
6382	See <link to="ISnapshot" /> for an introduction to snapshots.
6383
6384	The execution state and settings of the associated machine stored in
6385	the snapshot will be deleted. The contents of all differencing media of
6386	this snapshot will be merged with the contents of their dependent child
6387	media to keep the medium chain valid (in other words, all changes
6388	represented by media being deleted will be propagated to their child
6389	medium). After that, this snapshot's differencing medium will be
6390	deleted. The parent of this snapshot will become a new parent for all
6391	its child snapshots.
6392
6393	If the deleted snapshot is the current one, its parent snapshot will
6394	become a new current snapshot. The current machine state is not directly
6395	affected in this case, except that currently attached differencing
6396	media based on media of the deleted snapshot will be also merged as
6397	described above.
6398
6399	If the deleted snapshot is the first or current snapshot, then the
6400	respective IMachine attributes will be adjusted. Deleting the current
6401	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6402	to make all current machine settings permanent.
6403
6404	Deleting a snapshot has the following preconditions:
6405
6406	<ul>
6407	<li>Child media of all normal media of the deleted snapshot
6408	must be accessible (see <link to="IMedium::state"/>) for this
6409	operation to succeed. In particular, this means that all virtual
6410	machines, whose media are directly or indirectly based on the
6411	media of deleted snapshot, must be powered off.</li>
6412
6413	<li>You cannot delete the snapshot if a medium attached to it has
6414	more than once child medium (differencing images) because otherwise
6415	merging would be impossible. This might be the case if there is
6416	more than one child snapshot or differencing images were created
6417	for other reason (e.g. implicitly because of multiple machine
6418	attachments).</li>
6419	</ul>
6420
6421
6422	The virtual machine's <link to="IMachine::state">state</link> is
6423	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6424	"DeletingSnapshotPaused" while this operation is in progress.
6425
6426	<note>
6427	Merging medium contents can be very time and disk space
6428	consuming, if these media are big in size and have many
6429	children. However, if the snapshot being deleted is the last
6430	(head) snapshot on the branch, the operation will be rather
6431	quick.
6432	</note>
6433	<result name="VBOX_E_INVALID_VM_STATE">
6434	The running virtual machine prevents deleting this snapshot. This
6435	happens only in very specific situations, usually snapshots can be
6436	deleted without trouble while a VM is running. The error message
6437	text explains the reason for the failure.
6438	</result>
6439	</desc>
6440	<param name="id" type="uuid" mod="string" dir="in">
6441	<desc>UUID of the snapshot to delete.</desc>
6442	</param>
6443	<param name="progress" type="IProgress" dir="return">
6444	<desc>Progress object to track the operation completion.</desc>
6445	</param>
6446	</method>
6447
6448	<method name="restoreSnapshot">
6449	<desc>
6450	Starts resetting the machine's current state to the state contained
6451	in the given snapshot, asynchronously. All current settings of the
6452	machine will be reset and changes stored in differencing media
6453	will be lost.
6454	See <link to="ISnapshot" /> for an introduction to snapshots.
6455
6456	After this operation is successfully completed, new empty differencing
6457	media are created for all normal media of the machine.
6458
6459	If the given snapshot is an online snapshot, the machine will go to
6460	the <link to="MachineState::Saved"> saved state</link>, so that the
6461	next time it is powered on, the execution state will be restored
6462	from the state of the snapshot.
6463
6464	<note>
6465	The machine must not be running, otherwise the operation will fail.
6466	</note>
6467
6468	<note>
6469	If the machine state is <link to="MachineState::Saved">Saved</link>
6470	prior to this operation, the saved state file will be implicitly
6471	deleted (as if <link to="IConsole::discardSavedState"/> were
6472	called).
6473	</note>
6474
6475	<result name="VBOX_E_INVALID_VM_STATE">
6476	Virtual machine is running.
6477	</result>
6478	</desc>
6479	<param name="snapshot" type="ISnapshot" dir="in">
6480	<desc>The snapshot to restore the VM state from.</desc>
6481	</param>
6482	<param name="progress" type="IProgress" dir="return">
6483	<desc>Progress object to track the operation completion.</desc>
6484	</param>
6485	</method>
6486
6487	<method name="teleport">
6488	<desc>
6489	Teleport the VM to a different host machine or process.
6490
6491	TODO explain the details.
6492
6493	<result name="VBOX_E_INVALID_VM_STATE">
6494	Virtual machine not running or paused.
6495	</result>
6496	</desc>
6497	<param name="hostname" type="wstring" dir="in">
6498	<desc>The name or IP of the host to teleport to.</desc>
6499	</param>
6500	<param name="tcpport" type="unsigned long" dir="in">
6501	<desc>The TCP port to connect to (1..65535).</desc>
6502	</param>
6503	<param name="password" type="wstring" dir="in">
6504	<desc>The password.</desc>
6505	</param>
6506	<param name="maxDowntime" type="unsigned long" dir="in">
6507	<desc>
6508	The maximum allowed downtime given as milliseconds. 0 is not a valid
6509	value. Recommended value: 250 ms.
6510
6511	The higher the value is, the greater the chance for a successful
6512	teleportation. A small value may easily result in the teleportation
6513	process taking hours and eventually fail.
6514
6515	<note>
6516	The current implementation treats this a guideline, not as an
6517	absolute rule.
6518	</note>
6519	</desc>
6520	</param>
6521	<param name="progress" type="IProgress" dir="return">
6522	<desc>Progress object to track the operation completion.</desc>
6523	</param>
6524	</method>
6525
6526	</interface>
6527
6528	<!--
6529	// IHost
6530	/////////////////////////////////////////////////////////////////////////
6531	-->
6532
6533	<enum
6534	name="HostNetworkInterfaceMediumType"
6535	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6536	>
6537	<desc>
6538	Type of encapsulation. Ethernet encapsulation includes both wired and
6539	wireless Ethernet connections.
6540	<see>IHostNetworkInterface</see>
6541	</desc>
6542
6543	<const name="Unknown" value="0">
6544	<desc>
6545	The type of interface cannot be determined.
6546	</desc>
6547	</const>
6548	<const name="Ethernet" value="1">
6549	<desc>
6550	Ethernet frame encapsulation.
6551	</desc>
6552	</const>
6553	<const name="PPP" value="2">
6554	<desc>
6555	Point-to-point protocol encapsulation.
6556	</desc>
6557	</const>
6558	<const name="SLIP" value="3">
6559	<desc>
6560	Serial line IP encapsulation.
6561	</desc>
6562	</const>
6563	</enum>
6564
6565	<enum
6566	name="HostNetworkInterfaceStatus"
6567	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6568	>
6569	<desc>
6570	Current status of the interface.
6571	<see>IHostNetworkInterface</see>
6572	</desc>
6573
6574	<const name="Unknown" value="0">
6575	<desc>
6576	The state of interface cannot be determined.
6577	</desc>
6578	</const>
6579	<const name="Up" value="1">
6580	<desc>
6581	The interface is fully operational.
6582	</desc>
6583	</const>
6584	<const name="Down" value="2">
6585	<desc>
6586	The interface is not functioning.
6587	</desc>
6588	</const>
6589	</enum>
6590
6591	<enum
6592	name="HostNetworkInterfaceType"
6593	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6594	>
6595	<desc>
6596	Network interface type.
6597	</desc>
6598	<const name="Bridged" value="1"/>
6599	<const name="HostOnly" value="2"/>
6600	</enum>
6601
6602	<interface
6603	name="IHostNetworkInterface" extends="$unknown"
6604	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6605	wsmap="managed"
6606	>
6607	<desc>
6608	Represents one of host's network interfaces. IP V6 address and network
6609	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6610	separated by colons.
6611	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6612	</desc>
6613	<attribute name="name" type="wstring" readonly="yes">
6614	<desc>Returns the host network interface name.</desc>
6615	</attribute>
6616
6617	<attribute name="id" type="uuid" mod="string" readonly="yes">
6618	<desc>Returns the interface UUID.</desc>
6619	</attribute>
6620
6621	<attribute name="networkName" type="wstring" readonly="yes">
6622	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6623	</attribute>
6624
6625	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6626	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6627	</attribute>
6628
6629	<attribute name="IPAddress" type="wstring" readonly="yes">
6630	<desc>Returns the IP V4 address of the interface.</desc>
6631	</attribute>
6632
6633	<attribute name="networkMask" type="wstring" readonly="yes">
6634	<desc>Returns the network mask of the interface.</desc>
6635	</attribute>
6636
6637	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6638	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6639	</attribute>
6640
6641	<attribute name="IPV6Address" type="wstring" readonly="yes">
6642	<desc>Returns the IP V6 address of the interface.</desc>
6643	</attribute>
6644
6645	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6646	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6647	</attribute>
6648
6649	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6650	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6651	</attribute>
6652
6653	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6654	<desc>Type of protocol encapsulation used.</desc>
6655	</attribute>
6656
6657	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6658	<desc>Status of the interface.</desc>
6659	</attribute>
6660
6661	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6662	<desc>specifies the host interface type.</desc>
6663	</attribute>
6664
6665	<method name="enableStaticIpConfig">
6666	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6667	<param name="IPAddress" type="wstring" dir="in">
6668	<desc>
6669	IP address.
6670	</desc>
6671	</param>
6672	<param name="networkMask" type="wstring" dir="in">
6673	<desc>
6674	network mask.
6675	</desc>
6676	</param>
6677	</method>
6678
6679	<method name="enableStaticIpConfigV6">
6680	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6681	<param name="IPV6Address" type="wstring" dir="in">
6682	<desc>
6683	IP address.
6684	</desc>
6685	</param>
6686	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6687	<desc>
6688	network mask.
6689	</desc>
6690	</param>
6691	</method>
6692
6693	<method name="enableDynamicIpConfig">
6694	<desc>enables the dynamic IP configuration.</desc>
6695	</method>
6696
6697	<method name="dhcpRediscover">
6698	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6699	</method>
6700
6701	</interface>
6702
6703	<interface
6704	name="IHost" extends="$unknown"
6705	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6706	wsmap="managed"
6707	>
6708	<desc>
6709	The IHost interface represents the physical machine that this VirtualBox
6710	installation runs on.
6711
6712	An object implementing this interface is returned by the
6713	<link to="IVirtualBox::host" /> attribute. This interface contains
6714	read-only information about the host's physical hardware (such as what
6715	processors and disks are available, what the host operating system is,
6716	and so on) and also allows for manipulating some of the host's hardware,
6717	such as global USB device filters and host interface networking.
6718
6719	</desc>
6720	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6721	<desc>List of DVD drives available on the host.</desc>
6722	</attribute>
6723
6724	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6725	<desc>List of floppy drives available on the host.</desc>
6726	</attribute>
6727
6728	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6729	<desc>
6730	List of USB devices currently attached to the host.
6731	Once a new device is physically attached to the host computer,
6732	it appears in this list and remains there until detached.
6733
6734	<note>
6735	If USB functionality is not available in the given edition of
6736	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6737	</note>
6738	</desc>
6739	</attribute>
6740
6741	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6742	<desc>
6743	List of USB device filters in action.
6744	When a new device is physically attached to the host computer,
6745	filters from this list are applied to it (in order they are stored
6746	in the list). The first matched filter will determine the
6747	<link to="IHostUSBDeviceFilter::action">action</link>
6748	performed on the device.
6749
6750	Unless the device is ignored by these filters, filters of all
6751	currently running virtual machines
6752	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6753
6754	<note>
6755	If USB functionality is not available in the given edition of
6756	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6757	</note>
6758
6759	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6760	</desc>
6761	</attribute>
6762
6763	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6764	<desc>List of host network interfaces currently defined on the host.</desc>
6765	</attribute>
6766
6767	<attribute name="processorCount" type="unsigned long" readonly="yes">
6768	<desc>Number of (logical) CPUs installed in the host system.</desc>
6769	</attribute>
6770
6771	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6772	<desc>Number of (logical) CPUs online in the host system.</desc>
6773	</attribute>
6774
6775	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6776	<desc>Number of physical processor cores installed in the host system.</desc>
6777	</attribute>
6778
6779	<method name="getProcessorSpeed">
6780	<desc>Query the (approximate) maximum speed of a specified host CPU in
6781	Megahertz.
6782	</desc>
6783	<param name="cpuId" type="unsigned long" dir="in">
6784	<desc>
6785	Identifier of the CPU.
6786	</desc>
6787	</param>
6788	<param name="speed" type="unsigned long" dir="return">
6789	<desc>
6790	Speed value. 0 is returned if value is not known or @a cpuId is
6791	invalid.
6792	</desc>
6793	</param>
6794	</method>
6795
6796	<method name="getProcessorFeature">
6797	<desc>Query whether a CPU feature is supported or not.</desc>
6798	<param name="feature" type="ProcessorFeature" dir="in">
6799	<desc>
6800	CPU Feature identifier.
6801	</desc>
6802	</param>
6803	<param name="supported" type="boolean" dir="return">
6804	<desc>
6805	Feature is supported or not.
6806	</desc>
6807	</param>
6808	</method>
6809
6810	<method name="getProcessorDescription">
6811	<desc>Query the model string of a specified host CPU.
6812	</desc>
6813	<param name="cpuId" type="unsigned long" dir="in">
6814	<desc>
6815	Identifier of the CPU.
6816	<note>
6817	The current implementation might not necessarily return the
6818	description for this exact CPU.
6819	</note>
6820	</desc>
6821	</param>
6822	<param name="description" type="wstring" dir="return">
6823	<desc>
6824	Model string. An empty string is returned if value is not known or
6825	@a cpuId is invalid.
6826	</desc>
6827	</param>
6828	</method>
6829
6830	<method name="getProcessorCPUIDLeaf">
6831	<desc>
6832	Returns the CPU cpuid information for the specified leaf.
6833	</desc>
6834	<param name="cpuId" type="unsigned long" dir="in">
6835	<desc>
6836	Identifier of the CPU. The CPU most be online.
6837	<note>
6838	The current implementation might not necessarily return the
6839	description for this exact CPU.
6840	</note>
6841	</desc>
6842	</param>
6843	<param name="leaf" type="unsigned long" dir="in">
6844	<desc>
6845	CPUID leaf index (eax).
6846	</desc>
6847	</param>
6848	<param name="subLeaf" type="unsigned long" dir="in">
6849	<desc>
6850	CPUID leaf sub index (ecx). This currently only applies to cache
6851	information on Intel CPUs. Use 0 if retriving values for
6852	<link to="IMachine::setCPUIDLeaf"/>.
6853	</desc>
6854	</param>
6855	<param name="valEax" type="unsigned long" dir="out">
6856	<desc>
6857	CPUID leaf value for register eax.
6858	</desc>
6859	</param>
6860	<param name="valEbx" type="unsigned long" dir="out">
6861	<desc>
6862	CPUID leaf value for register ebx.
6863	</desc>
6864	</param>
6865	<param name="valEcx" type="unsigned long" dir="out">
6866	<desc>
6867	CPUID leaf value for register ecx.
6868	</desc>
6869	</param>
6870	<param name="valEdx" type="unsigned long" dir="out">
6871	<desc>
6872	CPUID leaf value for register edx.
6873	</desc>
6874	</param>
6875	</method>
6876
6877	<attribute name="memorySize" type="unsigned long" readonly="yes">
6878	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6879	</attribute>
6880
6881	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6882	<desc>Available system memory in the host system.</desc>
6883	</attribute>
6884
6885	<attribute name="operatingSystem" type="wstring" readonly="yes">
6886	<desc>Name of the host system's operating system.</desc>
6887	</attribute>
6888
6889	<attribute name="OSVersion" type="wstring" readonly="yes">
6890	<desc>Host operating system's version string.</desc>
6891	</attribute>
6892
6893	<attribute name="UTCTime" type="long long" readonly="yes">
6894	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6895	</attribute>
6896
6897	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6898	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6899	</attribute>
6900
6901	<method name="createHostOnlyNetworkInterface">
6902	<desc>
6903	Creates a new adapter for Host Only Networking.
6904	<result name="E_INVALIDARG">
6905	Host network interface @a name already exists.
6906	</result>
6907	</desc>
6908	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6909	<desc>
6910	Created host interface object.
6911	</desc>
6912	</param>
6913	<param name="progress" type="IProgress" dir="return">
6914	<desc>
6915	Progress object to track the operation completion.
6916	</desc>
6917	</param>
6918	</method>
6919
6920	<method name="removeHostOnlyNetworkInterface">
6921	<desc>
6922	Removes the given Host Only Networking interface.
6923	<result name="VBOX_E_OBJECT_NOT_FOUND">
6924	No host network interface matching @a id found.
6925	</result>
6926	</desc>
6927	<param name="id" type="uuid" mod="string" dir="in">
6928	<desc>
6929	Adapter GUID.
6930	</desc>
6931	</param>
6932	<param name="progress" type="IProgress" dir="return">
6933	<desc>
6934	Progress object to track the operation completion.
6935	</desc>
6936	</param>
6937	</method>
6938
6939	<method name="createUSBDeviceFilter">
6940	<desc>
6941	Creates a new USB device filter. All attributes except
6942	the filter name are set to empty (any match),
6943	<i>active</i> is @c false (the filter is not active).
6944
6945	The created filter can be added to the list of filters using
6946	<link to="#insertUSBDeviceFilter"/>.
6947
6948	<see>#USBDeviceFilters</see>
6949	</desc>
6950	<param name="name" type="wstring" dir="in">
6951	<desc>
6952	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
6953	</desc>
6954	</param>
6955	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
6956	<desc>Created filter object.</desc>
6957	</param>
6958	</method>
6959
6960	<method name="insertUSBDeviceFilter">
6961	<desc>
6962	Inserts the given USB device to the specified position
6963	in the list of filters.
6964
6965	Positions are numbered starting from @c 0. If the specified
6966	position is equal to or greater than the number of elements in
6967	the list, the filter is added at the end of the collection.
6968
6969	<note>
6970	Duplicates are not allowed, so an attempt to insert a
6971	filter already in the list is an error.
6972	</note>
6973	<note>
6974	If USB functionality is not available in the given edition of
6975	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6976	</note>
6977
6978	<see>#USBDeviceFilters</see>
6979
6980	<result name="VBOX_E_INVALID_OBJECT_STATE">
6981	USB device filter is not created within this VirtualBox instance.
6982	</result>
6983	<result name="E_INVALIDARG">
6984	USB device filter already in list.
6985	</result>
6986
6987	</desc>
6988	<param name="position" type="unsigned long" dir="in">
6989	<desc>Position to insert the filter to.</desc>
6990	</param>
6991	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
6992	<desc>USB device filter to insert.</desc>
6993	</param>
6994	</method>
6995
6996	<method name="removeUSBDeviceFilter">
6997	<desc>
6998	Removes a USB device filter from the specified position in the
6999	list of filters.
7000
7001	Positions are numbered starting from @c 0. Specifying a
7002	position equal to or greater than the number of elements in
7003	the list will produce an error.
7004
7005	<note>
7006	If USB functionality is not available in the given edition of
7007	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7008	</note>
7009
7010	<see>#USBDeviceFilters</see>
7011
7012	<result name="E_INVALIDARG">
7013	USB device filter list empty or invalid @a position.
7014	</result>
7015
7016	</desc>
7017	<param name="position" type="unsigned long" dir="in">
7018	<desc>Position to remove the filter from.</desc>
7019	</param>
7020	</method>
7021
7022	<method name="findHostDVDDrive">
7023	<desc>
7024	Searches for a host DVD drive with the given @c name.
7025
7026	<result name="VBOX_E_OBJECT_NOT_FOUND">
7027	Given @c name does not correspond to any host drive.
7028	</result>
7029
7030	</desc>
7031	<param name="name" type="wstring" dir="in">
7032	<desc>Name of the host drive to search for</desc>
7033	</param>
7034	<param name="drive" type="IMedium" dir="return">
7035	<desc>Found host drive object</desc>
7036	</param>
7037	</method>
7038
7039	<method name="findHostFloppyDrive">
7040	<desc>
7041	Searches for a host floppy drive with the given @c name.
7042
7043	<result name="VBOX_E_OBJECT_NOT_FOUND">
7044	Given @c name does not correspond to any host floppy drive.
7045	</result>
7046
7047	</desc>
7048	<param name="name" type="wstring" dir="in">
7049	<desc>Name of the host floppy drive to search for</desc>
7050	</param>
7051	<param name="drive" type="IMedium" dir="return">
7052	<desc>Found host floppy drive object</desc>
7053	</param>
7054	</method>
7055
7056	<method name="findHostNetworkInterfaceByName">
7057	<desc>
7058	Searches through all host network interfaces for an interface with
7059	the given @c name.
7060	<note>
7061	The method returns an error if the given @c name does not
7062	correspond to any host network interface.
7063	</note>
7064	</desc>
7065	<param name="name" type="wstring" dir="in">
7066	<desc>Name of the host network interface to search for.</desc>
7067	</param>
7068	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7069	<desc>Found host network interface object.</desc>
7070	</param>
7071	</method>
7072	<method name="findHostNetworkInterfaceById">
7073	<desc>
7074	Searches through all host network interfaces for an interface with
7075	the given GUID.
7076	<note>
7077	The method returns an error if the given GUID does not
7078	correspond to any host network interface.
7079	</note>
7080	</desc>
7081	<param name="id" type="uuid" mod="string" dir="in">
7082	<desc>GUID of the host network interface to search for.</desc>
7083	</param>
7084	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7085	<desc>Found host network interface object.</desc>
7086	</param>
7087	</method>
7088	<method name="findHostNetworkInterfacesOfType">
7089	<desc>
7090	Searches through all host network interfaces and returns a list of interfaces of the specified type
7091	</desc>
7092	<param name="type" type="HostNetworkInterfaceType" dir="in">
7093	<desc>type of the host network interfaces to search for.</desc>
7094	</param>
7095	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7096	<desc>Found host network interface objects.</desc>
7097	</param>
7098	</method>
7099
7100	<method name="findUSBDeviceById">
7101	<desc>
7102	Searches for a USB device with the given UUID.
7103
7104	<result name="VBOX_E_OBJECT_NOT_FOUND">
7105	Given @c id does not correspond to any USB device.
7106	</result>
7107
7108	<see>IHostUSBDevice::id</see>
7109	</desc>
7110	<param name="id" type="uuid" mod="string" dir="in">
7111	<desc>UUID of the USB device to search for.</desc>
7112	</param>
7113	<param name="device" type="IHostUSBDevice" dir="return">
7114	<desc>Found USB device object.</desc>
7115	</param>
7116	</method>
7117
7118	<method name="findUSBDeviceByAddress">
7119	<desc>
7120	Searches for a USB device with the given host address.
7121
7122	<result name="VBOX_E_OBJECT_NOT_FOUND">
7123	Given @c name does not correspond to any USB device.
7124	</result>
7125
7126	<see>IHostUSBDevice::address</see>
7127	</desc>
7128	<param name="name" type="wstring" dir="in">
7129	<desc>
7130	Address of the USB device (as assigned by the host) to
7131	search for.
7132	</desc>
7133	</param>
7134	<param name="device" type="IHostUSBDevice" dir="return">
7135	<desc>Found USB device object.</desc>
7136	</param>
7137	</method>
7138
7139	</interface>
7140
7141	<!--
7142	// ISystemProperties
7143	/////////////////////////////////////////////////////////////////////////
7144	-->
7145
7146	<interface
7147	name="ISystemProperties"
7148	extends="$unknown"
7149	uuid="07c3ffd8-8f59-49cc-b608-53a332e85cc3"
7150	wsmap="managed"
7151	>
7152	<desc>
7153	The ISystemProperties interface represents global properties of the given
7154	VirtualBox installation.
7155
7156	These properties define limits and default values for various attributes
7157	and parameters. Most of the properties are read-only, but some can be
7158	changed by a user.
7159	</desc>
7160
7161	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7162	<desc>Minimum guest system memory in Megabytes.</desc>
7163	</attribute>
7164
7165	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7166	<desc>Maximum guest system memory in Megabytes.</desc>
7167	</attribute>
7168
7169	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7170	<desc>Minimum guest video memory in Megabytes.</desc>
7171	</attribute>
7172
7173	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7174	<desc>Maximum guest video memory in Megabytes.</desc>
7175	</attribute>
7176
7177	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7178	<desc>Minimum CPU count.</desc>
7179	</attribute>
7180
7181	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7182	<desc>Maximum CPU count.</desc>
7183	</attribute>
7184
7185	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7186	<desc>Maximum of monitors which could be connected.</desc>
7187	</attribute>
7188
7189	<attribute name="maxVDISize" type="long long" readonly="yes">
7190	<desc>Maximum size of a virtual disk image in Megabytes.</desc>
7191	</attribute>
7192
7193	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7194	<desc>
7195	Number of network adapters associated with every
7196	<link to="IMachine"/> instance.
7197	</desc>
7198	</attribute>
7199
7200	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7201	<desc>
7202	Number of serial ports associated with every
7203	<link to="IMachine"/> instance.
7204	</desc>
7205	</attribute>
7206
7207	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7208	<desc>
7209	Number of parallel ports associated with every
7210	<link to="IMachine"/> instance.
7211	</desc>
7212	</attribute>
7213
7214	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7215	<desc>
7216	Maximum device position in the boot order. This value corresponds
7217	to the total number of devices a machine can boot from, to make it
7218	possible to include all possible devices to the boot list.
7219	<see><link to="IMachine::setBootOrder"/></see>
7220	</desc>
7221	</attribute>
7222
7223	<attribute name="defaultMachineFolder" type="wstring">
7224	<desc>
7225	Full path to the default directory used to create new or open
7226	existing machines when a settings file name contains no
7227	path.
7228
7229	The initial value of this property is
7230	<tt><</tt><link to="IVirtualBox::homeFolder">
7231	VirtualBox_home</link><tt>>/Machines</tt>.
7232
7233	<note>
7234	Setting this property to @c null or an empty string will restore the
7235	initial value.
7236	</note>
7237	<note>
7238	When settings this property, the specified path can be
7239	absolute (full path) or relative
7240	to the <link to="IVirtualBox::homeFolder">
7241	VirtualBox home directory</link>.
7242	When reading this property, a full path is
7243	always returned.
7244	</note>
7245	<note>
7246	The specified path may not exist, it will be created
7247	when necessary.
7248	</note>
7249
7250	<see>
7251	<link to="IVirtualBox::createMachine"/>,
7252	<link to="IVirtualBox::openMachine"/>
7253	</see>
7254	</desc>
7255	</attribute>
7256
7257	<attribute name="defaultHardDiskFolder" type="wstring">
7258	<desc>
7259	Full path to the default directory used to create new or open existing
7260	virtual disks.
7261
7262	This path is used when the storage unit of a hard disk is a regular file
7263	in the host's file system and only a file name that contains no path is
7264	given.
7265
7266	The initial value of this property is
7267	<tt><</tt>
7268	<link to="IVirtualBox::homeFolder">VirtualBox_home</link>
7269	<tt>>/HardDisks</tt>.
7270
7271	<note>
7272	Setting this property to @c null or empty string will restore the
7273	initial value.
7274	</note>
7275	<note>
7276	When settings this property, the specified path can be relative
7277	to the
7278	<link to="IVirtualBox::homeFolder">VirtualBox home directory</link> or
7279	absolute. When reading this property, a full path is
7280	always returned.
7281	</note>
7282	<note>
7283	The specified path may not exist, it will be created
7284	when necessary.
7285	</note>
7286
7287	<see>
7288	IMedium,
7289	<link to="IVirtualBox::createHardDisk"/>,
7290	<link to="IVirtualBox::openMedium"/>,
7291	<link to="IMedium::location"/>
7292	</see>
7293	</desc>
7294	</attribute>
7295
7296	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7297	<desc>
7298	List of all medium storage formats supported by this VirtualBox
7299	installation.
7300
7301	Keep in mind that the medium format identifier
7302	(<link to="IMediumFormat::id"/>) used in other API calls like
7303	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7304	medium format is a case-insensitive string. This means that, for
7305	example, all of the following strings:
7306	<pre>
7307	"VDI"
7308	"vdi"
7309	"VdI"</pre>
7310	refer to the same medium format.
7311
7312	Note that the virtual medium framework is backend-based, therefore
7313	the list of supported formats depends on what backends are currently
7314	installed.
7315
7316	<see>
7317	<link to="IMediumFormat"/>,
7318	</see>
7319	</desc>
7320	</attribute>
7321
7322	<attribute name="defaultHardDiskFormat" type="wstring">
7323	<desc>
7324	Identifier of the default medium format used by VirtualBox.
7325
7326	The medium format set by this attribute is used by VirtualBox
7327	when the medium format was not specified explicitly. One example is
7328	<link to="IVirtualBox::createHardDisk"/> with the empty
7329	format argument. A more complex example is implicit creation of
7330	differencing media when taking a snapshot of a virtual machine:
7331	this operation will try to use a format of the parent medium first
7332	and if this format does not support differencing media the default
7333	format specified by this argument will be used.
7334
7335	The list of supported medium formats may be obtained by the
7336	<link to="#mediumFormats"/> call. Note that the default medium
7337	format must have a capability to create differencing media;
7338	otherwise operations that create media implicitly may fail
7339	unexpectedly.
7340
7341	The initial value of this property is <tt>"VDI"</tt> in the current
7342	version of the VirtualBox product, but may change in the future.
7343
7344	<note>
7345	Setting this property to @c null or empty string will restore the
7346	initial value.
7347	</note>
7348
7349	<see>
7350	<link to="#mediumFormats"/>,
7351	<link to="IMediumFormat::id"/>,
7352	<link to="IVirtualBox::createHardDisk"/>
7353	</see>
7354	</desc>
7355	</attribute>
7356
7357	<attribute name="freeDiskSpaceWarning" type="long long">
7358	<desc>Issue a warning if the free disk space is below (or in some disk
7359	intensive operation is expected to go below) the given size in
7360	Megabytes.</desc>
7361	</attribute>
7362
7363	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7364	<desc>Issue a warning if the free disk space is below (or in some disk
7365	intensive operation is expected to go below) the given percentage.</desc>
7366	</attribute>
7367
7368	<attribute name="freeDiskSpaceError" type="long long">
7369	<desc>Issue an error if the free disk space is below (or in some disk
7370	intensive operation is expected to go below) the given size in
7371	Megabytes.</desc>
7372	</attribute>
7373
7374	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7375	<desc>Issue an error if the free disk space is below (or in some disk
7376	intensive operation is expected to go below) the given percentage.</desc>
7377	</attribute>
7378
7379	<attribute name="remoteDisplayAuthLibrary" type="wstring">
7380	<desc>
7381	Library that provides authentication for VRDP clients. The library
7382	is used if a virtual machine's authentication type is set to "external"
7383	in the VM RemoteDisplay configuration.
7384
7385	The system library extension (".DLL" or ".so") must be omitted.
7386	A full path can be specified; if not, then the library must reside on the
7387	system's default library path.
7388
7389	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7390	of that name in one of the default VirtualBox library directories.
7391
7392	For details about VirtualBox authentication libraries and how to implement
7393	them, please refer to the VirtualBox manual.
7394
7395	<note>
7396	Setting this property to @c null or empty string will restore the
7397	initial value.
7398	</note>
7399	</desc>
7400	</attribute>
7401
7402	<attribute name="webServiceAuthLibrary" type="wstring">
7403	<desc>
7404	Library that provides authentication for webservice clients. The library
7405	is used if a virtual machine's authentication type is set to "external"
7406	in the VM RemoteDisplay configuration and will be called from
7407	within the <link to="IWebsessionManager::logon" /> implementation.
7408
7409	As opposed to <link to="ISystemProperties::remoteDisplayAuthLibrary" />,
7410	there is no per-VM setting for this, as the webservice is a global
7411	resource (if it is running). Only for this setting (for the webservice),
7412	setting this value to a literal <tt>"null"</tt> string disables authentication,
7413	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7414	no matter what user name and password are supplied.
7415
7416	The initial value of this property is <tt>"VRDPAuth"</tt>,
7417	meaning that the webservice will use the same authentication
7418	library that is used by default for VBoxVRDP (again, see
7419	<link to="ISystemProperties::remoteDisplayAuthLibrary" />).
7420	The format and calling convention of authentication libraries
7421	is the same for the webservice as it is for VBoxVRDP.
7422
7423	<note>
7424	Setting this property to @c null or empty string will restore the
7425	initial value.
7426	</note>
7427	</desc>
7428	</attribute>
7429
7430	<attribute name="LogHistoryCount" type="unsigned long">
7431	<desc>
7432	This value specifies how many old release log files are kept.
7433	</desc>
7434	</attribute>
7435
7436	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7437	<desc>This value hold the default audio driver for the current
7438	system.</desc>
7439	</attribute>
7440
7441	<method name="getMaxDevicesPerPortForStorageBus">
7442	<desc>Returns the maximum number of devices which can be attached to a port
7443	for the given storage bus.</desc>
7444
7445	<param name="bus" type="StorageBus" dir="in">
7446	<desc>The storage bus type to get the value for.</desc>
7447	</param>
7448
7449	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7450	<desc>The maximum number of devices which can eb attached to the port for the given
7451	storage bus.</desc>
7452	</param>
7453	</method>
7454
7455	<method name="getMinPortCountForStorageBus">
7456	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7457
7458	<param name="bus" type="StorageBus" dir="in">
7459	<desc>The storage bus type to get the value for.</desc>
7460	</param>
7461
7462	<param name="minPortCount" type="unsigned long" dir="return">
7463	<desc>The minimum number of ports for the given storage bus.</desc>
7464	</param>
7465	</method>
7466
7467	<method name="getMaxPortCountForStorageBus">
7468	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7469
7470	<param name="bus" type="StorageBus" dir="in">
7471	<desc>The storage bus type to get the value for.</desc>
7472	</param>
7473
7474	<param name="maxPortCount" type="unsigned long" dir="return">
7475	<desc>The maximum number of ports for the given storage bus.</desc>
7476	</param>
7477	</method>
7478
7479	<method name="getMaxInstancesOfStorageBus">
7480	<desc>Returns the maximum number of storage bus instances which
7481	can be configured for each VM. This corresponds to the number of
7482	storage controllers one can have.</desc>
7483
7484	<param name="bus" type="StorageBus" dir="in">
7485	<desc>The storage bus type to get the value for.</desc>
7486	</param>
7487
7488	<param name="maxInstances" type="unsigned long" dir="return">
7489	<desc>The maximum number of instances for the given storage bus.</desc>
7490	</param>
7491	</method>
7492
7493	<method name="getDeviceTypesForStorageBus">
7494	<desc>Returns list of all the supported device types
7495	(<link to="DeviceType"/>) for the given type of storage
7496	bus.</desc>
7497
7498	<param name="bus" type="StorageBus" dir="in">
7499	<desc>The storage bus type to get the value for.</desc>
7500	</param>
7501
7502	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7503	<desc>The list of all supported device types for the given storage bus.</desc>
7504	</param>
7505	</method>
7506	</interface>
7507
7508	<!--
7509	// IGuest
7510	/////////////////////////////////////////////////////////////////////////
7511	-->
7512
7513	<interface
7514	name="IGuestOSType" extends="$unknown"
7515	uuid="e3f6727e-a09b-41ea-a824-864a176472f3"
7516	wsmap="struct"
7517	>
7518	<desc>
7519	</desc>
7520
7521	<attribute name="familyId" type="wstring" readonly="yes">
7522	<desc>Guest OS family identifier string.</desc>
7523	</attribute>
7524
7525	<attribute name="familyDescription" type="wstring" readonly="yes">
7526	<desc>Human readable description of the guest OS family.</desc>
7527	</attribute>
7528
7529	<attribute name="id" type="wstring" readonly="yes">
7530	<desc>Guest OS identifier string.</desc>
7531	</attribute>
7532
7533	<attribute name="description" type="wstring" readonly="yes">
7534	<desc>Human readable description of the guest OS.</desc>
7535	</attribute>
7536
7537	<attribute name="is64Bit" type="boolean" readonly="yes">
7538	<desc>Returns @c true if the given OS is 64-bit</desc>
7539	</attribute>
7540
7541	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7542	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7543	</attribute>
7544
7545	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7546	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7547	</attribute>
7548
7549	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7550	<desc>Recommended RAM size in Megabytes.</desc>
7551	</attribute>
7552
7553	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7554	<desc>Recommended video RAM size in Megabytes.</desc>
7555	</attribute>
7556
7557	<attribute name="recommendedHDD" type="unsigned long" readonly="yes">
7558	<desc>Recommended hard disk size in Megabytes.</desc>
7559	</attribute>
7560
7561	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7562	<desc>Returns recommended network adapter for this OS type.</desc>
7563	</attribute>
7564
7565	<attribute name="recommendedPae" type="boolean" readonly="yes">
7566	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7567	</attribute>
7568
7569	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7570	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7571	</attribute>
7572
7573	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7574	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7575	</attribute>
7576
7577	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7578	<desc>Recommended storage controller type for HD drives.</desc>
7579	</attribute>
7580
7581	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7582	<desc>Recommended storage bus type for HD drives.</desc>
7583	</attribute>
7584
7585	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7586	<desc>Recommended firmware type.</desc>
7587	</attribute>
7588
7589	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7590	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7591	</attribute>
7592
7593	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7594	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7595	</attribute>
7596
7597	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7598	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7599	</attribute>
7600
7601	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7602	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7603	</attribute>
7604
7605	</interface>
7606
7607	<interface
7608	name="IGuest" extends="$unknown"
7609	uuid="506da00d-1ca5-4ccf-851d-8683253d0f5e"
7610	wsmap="managed"
7611	>
7612	<desc>
7613	The IGuest interface represents information about the operating system
7614	running inside the virtual machine. Used in
7615	<link to="IConsole::guest"/>.
7616
7617	IGuest provides information about the guest operating system, whether
7618	Guest Additions are installed and other OS-specific virtual machine
7619	properties.
7620	</desc>
7621
7622	<attribute name="OSTypeId" type="wstring" readonly="yes">
7623	<desc>
7624	Identifier of the Guest OS type as reported by the Guest
7625	Additions.
7626	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7627	an IGuestOSType object representing details about the given
7628	Guest OS type.
7629	<note>
7630	If Guest Additions are not installed, this value will be
7631	the same as <link to="IMachine::OSTypeId"/>.
7632	</note>
7633	</desc>
7634	</attribute>
7635
7636	<attribute name="additionsActive" type="boolean" readonly="yes">
7637	<desc>
7638	Flag whether the Guest Additions are installed and active
7639	in which case their version will be returned by the
7640	<link to="#additionsVersion"/> property.
7641	</desc>
7642	</attribute>
7643
7644	<attribute name="additionsVersion" type="wstring" readonly="yes">
7645	<desc>
7646	Version of the Guest Additions including the revision (3 decimal numbers
7647	separated by dots + revision number) installed on the guest or empty
7648	when the Additions are not installed.
7649	</desc>
7650	</attribute>
7651
7652	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7653	<desc>
7654	Flag whether seamless guest display rendering (seamless desktop
7655	integration) is supported.
7656	</desc>
7657	</attribute>
7658
7659	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7660	<desc>
7661	Flag whether the guest is in graphics mode. If it is not, then
7662	seamless rendering will not work, resize hints are not immediately
7663	acted on and guest display resizes are probably not initiated by
7664	the guest additions.
7665	</desc>
7666	</attribute>
7667
7668	<attribute name="memoryBalloonSize" type="unsigned long">
7669	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7670	</attribute>
7671
7672	<attribute name="statisticsUpdateInterval" type="unsigned long">
7673	<desc>Interval to update guest statistics in seconds.</desc>
7674	</attribute>
7675
7676	<method name="internalGetStatistics">
7677	<desc>
7678	Internal method; do not use as it might change at any time
7679	</desc>
7680	<param name="cpuUser" type="unsigned long" dir="out">
7681	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7682	</param>
7683	<param name="cpuKernel" type="unsigned long" dir="out">
7684	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7685	</param>
7686	<param name="cpuIdle" type="unsigned long" dir="out">
7687	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7688	</param>
7689	<param name="memTotal" type="unsigned long" dir="out">
7690	<desc>Total amount of physical guest RAM</desc>
7691	</param>
7692	<param name="memFree" type="unsigned long" dir="out">
7693	<desc>Free amount of physical guest RAM</desc>
7694	</param>
7695	<param name="memBalloon" type="unsigned long" dir="out">
7696	<desc>Amount of ballooned physical guest RAM</desc>
7697	</param>
7698	<param name="memShared" type="unsigned long" dir="out">
7699	<desc>Amount of shared physical guest RAM</desc>
7700	</param>
7701	<param name="memCache" type="unsigned long" dir="out">
7702	<desc>Total amount of guest (disk) cache memory</desc>
7703	</param>
7704	<param name="pagedTotal" type="unsigned long" dir="out">
7705	<desc>Total amount of space in the page file</desc>
7706	</param>
7707	<param name="memAllocTotal" type="unsigned long" dir="out">
7708	<desc>Total amount of memory allocated by the hypervisor</desc>
7709	</param>
7710	<param name="memFreeTotal" type="unsigned long" dir="out">
7711	<desc>Total amount of free memory available in the hypervisor</desc>
7712	</param>
7713	<param name="memBalloonTotal" type="unsigned long" dir="out">
7714	<desc>Total amount of memory ballooned by the hypervisor</desc>
7715	</param>
7716	<param name="memSharedTotal" type="unsigned long" dir="out">
7717	<desc>Total amount of shared memory in the hypervisor</desc>
7718	</param>
7719	</method>
7720
7721	<method name="setCredentials">
7722	<desc>
7723	Store login credentials that can be queried by guest operating
7724	systems with Additions installed. The credentials are transient
7725	to the session and the guest may also choose to erase them. Note
7726	that the caller cannot determine whether the guest operating system
7727	has queried or made use of the credentials.
7728
7729	<result name="VBOX_E_VM_ERROR">
7730	VMM device is not available.
7731	</result>
7732
7733	</desc>
7734	<param name="userName" type="wstring" dir="in">
7735	<desc>User name string, can be empty</desc>
7736	</param>
7737	<param name="password" type="wstring" dir="in">
7738	<desc>Password string, can be empty</desc>
7739	</param>
7740	<param name="domain" type="wstring" dir="in">
7741	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7742	</param>
7743	<param name="allowInteractiveLogon" type="boolean" dir="in">
7744	<desc>
7745	Flag whether the guest should alternatively allow the user to
7746	interactively specify different credentials. This flag might
7747	not be supported by all versions of the Additions.
7748	</desc>
7749	</param>
7750	</method>
7751
7752	<method name="executeProcess">
7753	<desc>
7754	Executes an existing program inside the guest VM.
7755
7756	<result name="VBOX_E_IPRT_ERROR">
7757	Could not execute process.
7758	</result>
7759
7760	</desc>
7761	<param name="execName" type="wstring" dir="in">
7762	<desc>
7763	Full path name of the command to execute on the guest; the
7764	commands has to exists in the guest VM in order to be executed.
7765	</desc>
7766	</param>
7767	<param name="flags" type="unsigned long" dir="in">
7768	<desc>
7769	Execution flags - currently not supported and therefore
7770	has to be set to 0.
7771	</desc>
7772	</param>
7773	<param name="arguments" type="wstring" safearray="yes" dir="in">
7774	<desc>
7775	Array of arguments passed to the execution command.
7776	</desc>
7777	</param>
7778	<param name="environment" type="wstring" safearray="yes" dir="in">
7779	<desc>
7780	Environment variables that can be set while the command is being
7781	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7782	variable just set its name ("NAME") without a value.
7783	</desc>
7784	</param>
7785	<param name="userName" type="wstring" dir="in">
7786	<desc>
7787	User name under which the command will be executed; has to exist
7788	and have the appropriate rights to execute programs in the VM.
7789	</desc>
7790	</param>
7791	<param name="password" type="wstring" dir="in">
7792	<desc>
7793	Password of the user account specified.
7794	</desc>
7795	</param>
7796	<param name="timeoutMS" type="unsigned long" dir="in">
7797	<desc>
7798	The maximum timeout value (in msec) to wait for finished program
7799	execution. Pass 0 for an infinite timeout.
7800	</desc>
7801	</param>
7802	<param name="pid" type="unsigned long" dir="out">
7803	<desc>
7804	The PID (process ID) of the started command for later reference.
7805	</desc>
7806	</param>
7807	<param name="progress" type="IProgress" dir="return">
7808	<desc>Progress object to track the operation completion.</desc>
7809	</param>
7810	</method>
7811
7812	<method name="getProcessOutput">
7813	<desc>
7814	Retrieves output of a formerly started process.
7815
7816	<result name="VBOX_E_IPRT_ERROR">
7817	Could not retrieve output.
7818	</result>
7819
7820	</desc>
7821	<param name="pid" type="unsigned long" dir="in">
7822	<desc>
7823	Process id returned by earlier executeProcess() call.
7824	</desc>
7825	</param>
7826	<param name="flags" type="unsigned long" dir="in">
7827	<desc>
7828	Flags describing which output to retrieve.
7829	</desc>
7830	</param>
7831	<param name="timeoutMS" type="unsigned long" dir="in">
7832	<desc>
7833	The maximum timeout value (in msec) to wait for output
7834	data. Pass 0 for an infinite timeout.
7835	</desc>
7836	</param>
7837	<param name="size" type="long long" dir="in">
7838	<desc>
7839	Size in bytes to read in the buffer.
7840	</desc>
7841	</param>
7842	<param name="data" type="octet" dir="return" safearray="yes">
7843	<desc>
7844	Buffer for retrieving the actual output. A data size of 0 means end of file
7845	if the requested size was not 0. This is the unprocessed
7846	output data, i.e. the line ending style depends on the platform of
7847	the system the server is running on.
7848	</desc>
7849	</param>
7850	</method>
7851
7852	<method name="getProcessStatus">
7853	<desc>
7854	Retrieves status, exit code and the exit reason of a formerly started process.
7855
7856	<result name="VBOX_E_IPRT_ERROR">
7857	Process with specified PID was not found.
7858	</result>
7859
7860	</desc>
7861	<param name="pid" type="unsigned long" dir="in">
7862	<desc>
7863	Process id returned by earlier executeProcess() call.
7864	</desc>
7865	</param>
7866	<param name="exitcode" type="unsigned long" dir="out">
7867	<desc>
7868	The exit code (if available).
7869	</desc>
7870	</param>
7871	<param name="flags" type="unsigned long" dir="out">
7872	<desc>
7873	Additional flags of process status (not used at the moment).
7874	</desc>
7875	</param>
7876	<param name="reason" type="unsigned long" dir="return">
7877	<desc>
7878	The current process status.
7879	</desc>
7880	</param>
7881	</method>
7882
7883	</interface>
7884
7885
7886	<!--
7887	// IProgress
7888	/////////////////////////////////////////////////////////////////////////
7889	-->
7890
7891	<interface
7892	name="IProgress" extends="$unknown"
7893	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
7894	wsmap="managed"
7895	>
7896	<desc>
7897	The IProgress interface is used to track and control
7898	asynchronous tasks within VirtualBox.
7899
7900	An instance of this is returned every time VirtualBox starts
7901	an asynchronous task (in other words, a separate thread) which
7902	continues to run after a method call returns. For example,
7903	<link to="IConsole::saveState" />, which saves the state of
7904	a running virtual machine, can take a long time to complete.
7905	To be able to display a progress bar, a user interface such as
7906	the VirtualBox graphical user interface can use the IProgress
7907	object returned by that method.
7908
7909	Note that IProgress is a "read-only" interface in the sense
7910	that only the VirtualBox internals behind the Main API can
7911	create and manipulate progress objects, whereas client code
7912	can only use the IProgress object to monitor a task's
7913	progress and, if <link to="#cancelable" /> is @c true,
7914	cancel the task by calling <link to="#cancel" />.
7915
7916	A task represented by IProgress consists of either one or
7917	several sub-operations that run sequentially, one by one (see
7918	<link to="#operation" /> and <link to="#operationCount" />).
7919	Every operation is identified by a number (starting from 0)
7920	and has a separate description.
7921
7922	You can find the individual percentage of completion of the current
7923	operation in <link to="#operationPercent" /> and the
7924	percentage of completion of the task as a whole
7925	in <link to="#percent" />.
7926
7927	Similarly, you can wait for the completion of a particular
7928	operation via <link to="#waitForOperationCompletion" /> or
7929	for the completion of the whole task via
7930	<link to="#waitForCompletion" />.
7931	</desc>
7932
7933	<attribute name="id" type="uuid" mod="string" readonly="yes">
7934	<desc>ID of the task.</desc>
7935	</attribute>
7936
7937	<attribute name="description" type="wstring" readonly="yes">
7938	<desc>Description of the task.</desc>
7939	</attribute>
7940
7941	<attribute name="initiator" type="$unknown" readonly="yes">
7942	<desc>Initiator of the task.</desc>
7943	</attribute>
7944
7945	<attribute name="cancelable" type="boolean" readonly="yes">
7946	<desc>Whether the task can be interrupted.</desc>
7947	</attribute>
7948
7949	<attribute name="percent" type="unsigned long" readonly="yes">
7950	<desc>
7951	Current progress value of the task as a whole, in percent.
7952	This value depends on how many operations are already complete.
7953	Returns 100 if <link to="#completed" /> is @c true.
7954	</desc>
7955	</attribute>
7956
7957	<attribute name="timeRemaining" type="long" readonly="yes">
7958	<desc>
7959	Estimated remaining time until the task completes, in
7960	seconds. Returns 0 once the task has completed; returns -1
7961	if the remaining time cannot be computed, in particular if
7962	the current progress is 0.
7963
7964	Even if a value is returned, the estimate will be unreliable
7965	for low progress values. It will become more reliable as the
7966	task progresses; it is not recommended to display an ETA
7967	before at least 20% of a task have completed.
7968	</desc>
7969	</attribute>
7970
7971	<attribute name="completed" type="boolean" readonly="yes">
7972	<desc>Whether the task has been completed.</desc>
7973	</attribute>
7974
7975	<attribute name="canceled" type="boolean" readonly="yes">
7976	<desc>Whether the task has been canceled.</desc>
7977	</attribute>
7978
7979	<attribute name="resultCode" type="long" readonly="yes">
7980	<desc>
7981	Result code of the progress task.
7982	Valid only if <link to="#completed"/> is @c true.
7983	</desc>
7984	</attribute>
7985
7986	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
7987	<desc>
7988	Extended information about the unsuccessful result of the
7989	progress operation. May be @c null if no extended information
7990	is available.
7991	Valid only if <link to="#completed"/> is @c true and
7992	<link to="#resultCode"/> indicates a failure.
7993	</desc>
7994	</attribute>
7995
7996	<attribute name="operationCount" type="unsigned long" readonly="yes">
7997	<desc>
7998	Number of sub-operations this task is divided into.
7999	Every task consists of at least one suboperation.
8000	</desc>
8001	</attribute>
8002
8003	<attribute name="operation" type="unsigned long" readonly="yes">
8004	<desc>Number of the sub-operation being currently executed.</desc>
8005	</attribute>
8006
8007	<attribute name="operationDescription" type="wstring" readonly="yes">
8008	<desc>
8009	Description of the sub-operation being currently executed.
8010	</desc>
8011	</attribute>
8012
8013	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8014	<desc>Progress value of the current sub-operation only, in percent.</desc>
8015	</attribute>
8016
8017	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8018	<desc>Weight value of the current sub-operation only.</desc>
8019	</attribute>
8020
8021	<attribute name="timeout" type="unsigned long">
8022	<desc>
8023	When non-zero, this specifies the number of milliseconds after which
8024	the operation will automatically be canceled. This can only be set on
8025	cancelable objects.
8026	</desc>
8027	</attribute>
8028
8029	<method name="setCurrentOperationProgress">
8030	<desc>Internal method, not to be called externally.</desc>
8031	<param name="percent" type="unsigned long" dir="in" />
8032	</method>
8033	<method name="setNextOperation">
8034	<desc>Internal method, not to be called externally.</desc>
8035	<param name="nextOperationDescription" type="wstring" dir="in" />
8036	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8037	</method>
8038
8039	<method name="waitForCompletion">
8040	<desc>
8041	Waits until the task is done (including all sub-operations)
8042	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8043
8044	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8045	thread are not processed while waiting. Neglecting event queues may
8046	have dire consequences (degrade performance, resource hogs,
8047	deadlocks, etc.), this is specially so for the main thread on
8048	platforms using XPCOM. Callers are adviced wait for short periods
8049	and service their event queues between calls, or to create a worker
8050	thread to do the waiting.
8051
8052	<result name="VBOX_E_IPRT_ERROR">
8053	Failed to wait for task completion.
8054	</result>
8055	</desc>
8056
8057	<param name="timeout" type="long" dir="in">
8058	<desc>
8059	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8060	</desc>
8061	</param>
8062	</method>
8063
8064	<method name="waitForOperationCompletion">
8065	<desc>
8066	Waits until the given operation is done with a given timeout in
8067	milliseconds; specify -1 for an indefinite wait.
8068
8069	See <link to="#waitForCompletion"> for event queue considerations.</link>
8070
8071	<result name="VBOX_E_IPRT_ERROR">
8072	Failed to wait for operation completion.
8073	</result>
8074
8075	</desc>
8076	<param name="operation" type="unsigned long" dir="in">
8077	<desc>
8078	Number of the operation to wait for.
8079	Must be less than <link to="#operationCount"/>.
8080	</desc>
8081	</param>
8082	<param name="timeout" type="long" dir="in">
8083	<desc>
8084	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8085	</desc>
8086	</param>
8087	</method>
8088
8089	<method name="cancel">
8090	<desc>
8091	Cancels the task.
8092	<note>
8093	If <link to="#cancelable"/> is @c false, then this method will fail.
8094	</note>
8095
8096	<result name="VBOX_E_INVALID_OBJECT_STATE">
8097	Operation cannot be canceled.
8098	</result>
8099
8100	</desc>
8101	</method>
8102
8103	</interface>
8104
8105	<!--
8106	// ISnapshot
8107	/////////////////////////////////////////////////////////////////////////
8108	-->
8109
8110	<interface
8111	name="ISnapshot" extends="$unknown"
8112	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8113	wsmap="managed"
8114	>
8115	<desc>
8116	The ISnapshot interface represents a snapshot of the virtual
8117	machine.
8118
8119	Together with the differencing media that are created
8120	when a snapshot is taken, a machine can be brought back to
8121	the exact state it was in when the snapshot was taken.
8122
8123	The ISnapshot interface has no methods, only attributes; snapshots
8124	are controlled through methods of the <link to="IConsole" /> interface
8125	which also manage the media associated with the snapshot.
8126	The following operations exist:
8127
8128	<ul>
8129	<li><link to="IConsole::takeSnapshot"/>: creates a new snapshot
8130	by creating new, empty differencing images for the machine's
8131	media and saving the VM settings and (if the VM is running)
8132	the current VM state in the snapshot.
8133
8134	The differencing images will then receive all data written to
8135	the machine's media, while their parent (base) images
8136	remain unmodified after the snapshot has been taken (see
8137	<link to="IMedium" /> for details about differencing images).
8138	This simplifies restoring a machine to the state of a snapshot:
8139	only the differencing images need to be deleted.
8140
8141	The current machine state is not changed by taking a snapshot.
8142	If the machine is running, it will resume execution after the
8143	snapshot has been taken.
8144	</li>
8145
8146	<li><link to="IConsole::restoreSnapshot"/>: this goes back to
8147	a previous snapshot. This resets the machine's state to that of
8148	the previous snapshot by deleting the differencing image of each
8149	of the machine's media and setting the machine's settings
8150	and state to the state that was saved in the snapshot (if any).
8151
8152	This destroys the machine's current state.
8153	</li>
8154
8155	<li><link to="IConsole::deleteSnapshot"/>: deletes a snapshot
8156	without affecting the current machine state.
8157
8158	This does not change the machine, but instead frees the resources
8159	allocated when the snapshot was taken: the settings and machine state
8160	is deleted (if any), and the snapshot's differencing image for each
8161	of the machine's media gets merged with its parent image.
8162
8163	Neither the current machine state nor other snapshots are affected
8164	by this operation, except that parent media will be modified
8165	to contain the disk data associated with the snapshot being deleted.
8166	</li>
8167	</ul>
8168
8169	Each snapshot contains the settings of the virtual machine (hardware
8170	configuration etc.). In addition, if the machine was running when the
8171	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState::Running"/>),
8172	the current VM state is saved in the snapshot (similarly to what happens
8173	when a VM's state is saved). The snapshot is then said to
8174	be <i>online</i> because when restoring it, the VM will be running.
8175
8176	If the machine is saved (<link to="MachineState::Saved"/>), the snapshot
8177	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8178
8179	Otherwise, if the machine was not running (<link to="MachineState::PoweredOff"/>
8180	or <link to="MachineState::Aborted"/>), the snapshot is <i>offline</i>;
8181	it then contains a so-called "zero execution state", representing a
8182	machine that is powered off.
8183
8184	<h3>Snapshot branches and the "current" snapshot</h3>
8185
8186	Snapshots can be chained, whereby every next snapshot is based on the
8187	previous one. This chaining is related to medium branching
8188	(see the <link to="IMedium"/> description) in that every time
8189	a new snapshot is created, a new differencing medium is implicitly
8190	created for all normal media attached to the machine.
8191
8192	Each virtual machine has a "current snapshot", identified by
8193	<link to="IMachine::currentSnapshot"/>. Presently, this is always set
8194	to the last snapshot in the chain. In a future version of VirtualBox,
8195	it will be possible to reset a machine's current state to that of an
8196	earlier snapshot without deleting the current state so that it will be
8197	possible to create alternative snapshot paths in a snapshot tree.
8198
8199	In the current implementation, multiple snapshot branches within one
8200	virtual machine are not allowed. Every machine has a single branch,
8201	and <link to="IConsole::takeSnapshot"/> operation adds a new
8202	snapshot to the top of that branch.
8203	</desc>
8204
8205	<attribute name="id" type="uuid" mod="string" readonly="yes">
8206	<desc>UUID of the snapshot.</desc>
8207	</attribute>
8208
8209	<attribute name="name" type="wstring">
8210	<desc>Short name of the snapshot.</desc>
8211	</attribute>
8212
8213	<attribute name="description" type="wstring">
8214	<desc>Optional description of the snapshot.</desc>
8215	</attribute>
8216
8217	<attribute name="timeStamp" type="long long" readonly="yes">
8218	<desc>
8219	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8220	</desc>
8221	</attribute>
8222
8223	<attribute name="online" type="boolean" readonly="yes">
8224	<desc>
8225	@c true if this snapshot is an online snapshot and @c false otherwise.
8226
8227	When this attribute is @c true, the
8228	<link to="IMachine::stateFilePath"/> attribute of the
8229	<link to="#machine"/> object associated with this snapshot
8230	will point to the saved state file. Otherwise, it will be
8231	an empty string.
8232	</desc>
8233	</attribute>
8234
8235	<attribute name="machine" type="IMachine" readonly="yes">
8236	<desc>
8237	Virtual machine this snapshot is taken on. This object
8238	stores all settings the machine had when taking this snapshot.
8239	<note>
8240	The returned machine object is immutable, i.e. no
8241	any settings can be changed.
8242	</note>
8243	</desc>
8244	</attribute>
8245
8246	<attribute name="parent" type="ISnapshot" readonly="yes">
8247	<desc>
8248	Parent snapshot (a snapshot this one is based on), or
8249	@c null if the snapshot has no parent (i.e. is the first snapshot).
8250	</desc>
8251	</attribute>
8252
8253	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8254	<desc>
8255	Child snapshots (all snapshots having this one as a parent).
8256	</desc>
8257	</attribute>
8258
8259	</interface>
8260
8261
8262	<!--
8263	// IMedium
8264	/////////////////////////////////////////////////////////////////////////
8265	-->
8266
8267	<enum
8268	name="MediumState"
8269	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8270	>
8271	<desc>
8272	Virtual medium state.
8273	<see>IMedium</see>
8274	</desc>
8275
8276	<const name="NotCreated" value="0">
8277	<desc>
8278	Associated medium storage does not exist (either was not created yet or
8279	was deleted).
8280	</desc>
8281	</const>
8282	<const name="Created" value="1">
8283	<desc>
8284	Associated storage exists and accessible; this gets set if the
8285	accessibility check performed by <link to="IMedium::refreshState" />
8286	was successful.
8287	</desc>
8288	</const>
8289	<const name="LockedRead" value="2">
8290	<desc>
8291	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8292	no data modification is possible.
8293	</desc>
8294	</const>
8295	<const name="LockedWrite" value="3">
8296	<desc>
8297	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8298	no concurrent data reading or modification is possible.
8299	</desc>
8300	</const>
8301	<const name="Inaccessible" value="4">
8302	<desc>
8303	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8304	not yet been performed, or else, associated medium storage is not
8305	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8306	is empty, in the second case, it describes the error that occured.
8307	</desc>
8308	</const>
8309	<const name="Creating" value="5">
8310	<desc>
8311	Associated medium storage is being created.
8312	</desc>
8313	</const>
8314	<const name="Deleting" value="6">
8315	<desc>
8316	Associated medium storage is being deleted.
8317	</desc>
8318	</const>
8319	</enum>
8320
8321	<enum
8322	name="MediumType"
8323	uuid="46bf1fd4-ad86-4ded-8c49-28bd2d148e5a"
8324	>
8325	<desc>
8326	Virtual medium type.
8327	<see>IMedium</see>
8328	</desc>
8329
8330	<const name="Normal" value="0">
8331	<desc>
8332	Normal medium (attached directly or indirectly, preserved
8333	when taking snapshots).
8334	</desc>
8335	</const>
8336	<const name="Immutable" value="1">
8337	<desc>
8338	Immutable medium (attached indirectly, changes are wiped out
8339	the next time the virtual machine is started).
8340	</desc>
8341	</const>
8342	<const name="Writethrough" value="2">
8343	<desc>
8344	Write through medium (attached directly, ignored when
8345	taking snapshots).
8346	</desc>
8347	</const>
8348	<const name="Shareable" value="3">
8349	<desc>
8350	Allow using this medium concurrently by several machines.
8351	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8352	</desc>
8353	</const>
8354	</enum>
8355
8356	<enum
8357	name="MediumVariant"
8358	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8359	>
8360	<desc>
8361	Virtual medium image variant. More than one flag may be set.
8362	<see>IMedium</see>
8363	</desc>
8364
8365	<const name="Standard" value="0">
8366	<desc>
8367	No particular variant requested, results in using the backend default.
8368	</desc>
8369	</const>
8370	<const name="VmdkSplit2G" value="0x01">
8371	<desc>
8372	VMDK image split in chunks of less than 2GByte.
8373	</desc>
8374	</const>
8375	<const name="VmdkStreamOptimized" value="0x04">
8376	<desc>
8377	VMDK streamOptimized image. Special import/export format which is
8378	read-only/append-only.
8379	</desc>
8380	</const>
8381	<const name="VmdkESX" value="0x08">
8382	<desc>
8383	VMDK format variant used on ESX products.
8384	</desc>
8385	</const>
8386	<const name="Fixed" value="0x10000">
8387	<desc>
8388	Fixed image. Only allowed for base images.
8389	</desc>
8390	</const>
8391	<const name="Diff" value="0x20000">
8392	<desc>
8393	Differencing image. Only allowed for child images.
8394	</desc>
8395	</const>
8396	</enum>
8397
8398	<interface
8399	name="IMediumAttachment" extends="$unknown"
8400	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8401	wsmap="struct"
8402	>
8403	<desc>
8404	The IMediumAttachment interface links storage media to virtual machines.
8405	For each medium (<link to="IMedium"/>) which has been attached to a
8406	storage controller (<link to="IStorageController"/>) of a machine
8407	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8408	method, one instance of IMediumAttachment is added to the machine's
8409	<link to="IMachine::mediumAttachments"/> array attribute.
8410
8411	Each medium attachment specifies the storage controller as well as a
8412	port and device number and the IMedium instance representing a virtual
8413	hard disk or floppy or DVD image.
8414
8415	For removeable media (DVDs or floppies), there are two additional
8416	options. For one, the IMedium instance can be @c null to represent
8417	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8418	secondly, the medium can be one of the pseudo-media for host drives
8419	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8420	</desc>
8421
8422	<attribute name="medium" type="IMedium" readonly="yes">
8423	<desc>Medium object associated with this attachment; it
8424	can be @c null for removable devices.</desc>
8425	</attribute>
8426
8427	<attribute name="controller" type="wstring" readonly="yes">
8428	<desc>Name of the storage controller of this attachment; this
8429	refers to one of the controllers in <link to="IMachine::storageControllers" />
8430	by name.</desc>
8431	</attribute>
8432
8433	<attribute name="port" type="long" readonly="yes">
8434	<desc>Port number of this attachment.
8435	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8436	</desc>
8437	</attribute>
8438
8439	<attribute name="device" type="long" readonly="yes">
8440	<desc>Device slot number of this attachment.
8441	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8442	</desc>
8443	</attribute>
8444
8445	<attribute name="type" type="DeviceType" readonly="yes">
8446	<desc>Device type of this attachment.</desc>
8447	</attribute>
8448
8449	<attribute name="passthrough" type="boolean" readonly="yes">
8450	<desc>Pass I/O requests through to a device on the host.</desc>
8451	</attribute>
8452
8453	<attribute name="bandwidthLimit" type="unsigned long">
8454	<desc>
8455	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8456	A zero value means uncapped/unlimited.
8457	</desc>
8458	</attribute>
8459
8460	</interface>
8461
8462	<interface
8463	name="IMedium" extends="$unknown"
8464	uuid="858ea9d3-9ade-4aa7-91b7-d8a40f8f9b16"
8465	wsmap="managed"
8466	>
8467	<desc>
8468	The IMedium interface represents virtual storage for a machine's
8469	hard disks, CD/DVD or floppy drives. It will typically represent
8470	a disk image on the host, for example a VDI or VMDK file representing
8471	a virtual hard disk, or an ISO or RAW file representing virtual
8472	removable media, but can also point to a network location (e.g.
8473	for iSCSI targets).
8474
8475	Instances of IMedium are connected to virtual machines by way of
8476	medium attachments (see <link to="IMediumAttachment" />), which link
8477	the storage medium to a particular device slot of a storage controller
8478	of the virtual machine.
8479	In the VirtualBox API, virtual storage is therefore always represented
8480	by the following chain of object links:
8481
8482	<ul>
8483	<li><link to="IMachine::storageControllers"/> contains an array of
8484	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8485	these are instances of <link to="IStorageController"/>).</li>
8486	<li><link to="IMachine::mediumAttachments"/> contains an array of
8487	medium attachments (instances of <link to="IMediumAttachment"/>),
8488	each containing a storage controller from the above array, a
8489	port/device specification, and an instance of IMedium representing
8490	the medium storage (image file).
8491
8492	For removable media, the storage medium is optional; a medium
8493	attachment with no medium represents a CD/DVD or floppy drive
8494	with no medium inserted. By contrast, hard disk attachments
8495	will always have an IMedium object attached.</li>
8496	<li>Each IMedium in turn points to a storage unit (such as a file
8497	on the host computer or a network resource) that holds actual
8498	data. This location is represented by the <link to="#location"/>
8499	attribute.</li>
8500	</ul>
8501
8502	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8503	new hard disk media can be created with the VirtualBox API using the
8504	<link to="IVirtualBox::createHardDisk"/> method.
8505
8506	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8507	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8508	type in a regular file.
8509
8510	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8511	drive; in that case the <link to="#id" /> attribute contains the UUID of
8512	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8513
8514	<h3>Known media</h3>
8515
8516	When an existing medium is opened for the first time, it is automatically
8517	remembered by the given VirtualBox installation or, in other words, becomes
8518	a <i>known medium</i>. Known media are stored in the media
8519	registry transparently maintained by VirtualBox and stored in settings
8520	files so that this registry is preserved when VirtualBox is not running.
8521
8522	Newly created virtual media are remembered only when the associated
8523	storage unit is actually created.
8524
8525	All known media can be enumerated using
8526	<link to="IVirtualBox::hardDisks"/>,
8527	<link to="IVirtualBox::DVDImages"/> and
8528	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8529	quickly found using the <link to="IVirtualBox::findMedium"/> method.
8530
8531	Only known media can be attached to virtual machines.
8532
8533	Removing known media from the media registry is performed when the given
8534	medium is closed using the <link to="#close"/> method or when its
8535	associated storage unit is deleted.
8536
8537	<h3>Accessibility checks</h3>
8538
8539	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8540	method is called explicitly on a medium. This is done to make the VirtualBox object
8541	ready for serving requests as fast as possible and let the end-user
8542	application decide if it needs to check media accessibility right away or not.
8543
8544	As a result, when VirtualBox starts up (e.g. the VirtualBox
8545	object gets created for the first time), all known media are in the
8546	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8547	attribute is an empty string because no actual accessibility check has
8548	been made yet.
8549
8550	After calling <link to="#refreshState" />, a medium is considered
8551	<i>accessible</i> if its storage unit can be read. In that case, the
8552	<link to="#state"/> attribute has a value of "Created". If the storage
8553	unit cannot be read (for example, because it is located on a disconnected
8554	network resource, or was accidentally deleted outside VirtualBox),
8555	the medium is considered <i>inaccessible</i>, which is indicated by the
8556	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8557	obtained by reading the <link to="#lastAccessError"/> attribute.
8558
8559	<h3>Medium types</h3>
8560
8561	There are four types of medium behavior (see <link to="MediumType" />):
8562	"normal", "immutable", "writethrough" and "shareable", represented by the
8563	<link to="#type"/> attribute. The type of the medium defines how the
8564	medium is attached to a virtual machine and what happens when a
8565	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8566	attached medium is taken. At the moment DVD and floppy media are always
8567	of type "writethrough".
8568
8569	All media can be also divided in two groups: <i>base</i> media and
8570	<i>differencing</i> media. A base medium contains all sectors of the
8571	medium data in its own storage and therefore can be used independently.
8572	In contrast, a differencing mediun is a "delta" to some other medium and
8573	contains only those sectors which differ from that other medium, which is
8574	then called a <i>parent</i>. The differencing medium is said to be
8575	<i>linked to</i> that parent. The parent may be itself a differencing
8576	medium, thus forming a chain of linked media. The last element in that
8577	chain must always be a base medium. Note that several differencing
8578	media may be linked to the same parent medium.
8579
8580	Differencing media can be distinguished from base media by querying the
8581	<link to="#parent"/> attribute: base media do not have parents they would
8582	depend on, so the value of this attribute is always @c null for them.
8583	Using this attribute, it is possible to walk up the medium tree (from the
8584	child medium to its parent). It is also possible to walk down the tree
8585	using the <link to="#children"/> attribute.
8586
8587	Note that the type of all differencing media is "normal"; all other
8588	values are meaningless for them. Base media may be of any type.
8589
8590	<h3>Creating hard disks</h3>
8591
8592	New base hard disks are created using
8593	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8594	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
8595	disks are usually implicitly created by VirtualBox when needed but may
8596	also be created explicitly using <link to="#createDiffStorage"/>.
8597
8598	After the hard disk is successfully created (including the storage unit)
8599	or opened, it becomes a known hard disk (remembered in the internal media
8600	registry). Known hard disks can be attached to a virtual machine, accessed
8601	through <link to="IVirtualBox::findMedium"/> or enumerated using the
8602	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8603
8604	The following methods, besides <link to="IMedium::close"/>,
8605	automatically remove the hard disk from the media registry:
8606	<ul>
8607	<li><link to="#deleteStorage"/></li>
8608	<li><link to="#mergeTo"/></li>
8609	</ul>
8610
8611	If the storage unit of the hard disk is a regular file in the host's
8612	file system then the rules stated in the description of the
8613	<link to="IMedium::location"/> attribute apply when setting its value. In
8614	addition, a plain file name without any path may be given, in which case
8615	the <link to="ISystemProperties::defaultHardDiskFolder"> default hard disk
8616	folder</link> will be prepended to it.
8617
8618	<h4>Automatic composition of the file name part</h4>
8619
8620	Another extension to the <link to="IMedium::location"/> attribute is that
8621	there is a possibility to cause VirtualBox to compose a unique value for
8622	the file name part of the location using the UUID of the hard disk. This
8623	applies only to hard disks in <link to="MediumState::NotCreated"/> state,
8624	e.g. before the storage unit is created, and works as follows. You set the
8625	value of the <link to="IMedium::location"/> attribute to a location
8626	specification which only contains the path specification but not the file
8627	name part and ends with either a forward slash or a backslash character.
8628	In response, VirtualBox will generate a new UUID for the hard disk and
8629	compose the file name using the following pattern:
8630	<pre>
8631	<path>/{<uuid>}.<ext>
8632	</pre>
8633	where <tt><path></tt> is the supplied path specification,
8634	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8635	is the default extension for the storage format of this hard disk. After
8636	that, you may call any of the methods that create a new hard disk storage
8637	unit and they will use the generated UUID and file name.
8638
8639	<h3>Attaching Hard Disks</h3>
8640
8641	Hard disks are attached to virtual machines using the
8642	<link to="IMachine::attachDevice"/> method and detached using the
8643	<link to="IMachine::detachDevice"/> method. Depending on their
8644	<link to="#type"/>, hard disks are attached either
8645	<i>directly</i> or <i>indirectly</i>.
8646
8647	When a hard disk is being attached directly, it is associated with the
8648	virtual machine and used for hard disk operations when the machine is
8649	running. When a hard disk is being attached indirectly, a new differencing
8650	hard disk linked to it is implicitly created and this differencing hard
8651	disk is associated with the machine and used for hard disk operations.
8652	This also means that if <link to="IMachine::attachDevice"/> performs
8653	a direct attachment then the same hard disk will be returned in response
8654	to the subsequent <link to="IMachine::getMedium"/> call; however if
8655	an indirect attachment is performed then
8656	<link to="IMachine::getMedium"/> will return the implicitly created
8657	differencing hard disk, not the original one passed to <link
8658	to="IMachine::attachDevice"/>. In detail:
8659
8660	<ul>
8661	<li><b>Normal base</b> hard disks that do not have children (i.e.
8662	differencing hard disks linked to them) and that are not already
8663	attached to virtual machines in snapshots are attached <b>directly</b>.
8664	Otherwise, they are attached <b>indirectly</b> because having
8665	dependent children or being part of the snapshot makes it impossible
8666	to modify hard disk contents without breaking the integrity of the
8667	dependent party. The <link to="#readOnly"/> attribute allows to
8668	quickly determine the kind of the attachment for the given hard
8669	disk. Note that if a normal base hard disk is to be indirectly
8670	attached to a virtual machine with snapshots then a special
8671	procedure called <i>smart attachment</i> is performed (see below).</li>
8672	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8673	they are attached <b>directly</b> if they do not have children and are
8674	not attached to virtual machines in snapshots, and <b>indirectly</b>
8675	otherwise. Note that the smart attachment procedure is never performed
8676	for differencing hard disks.</li>
8677	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8678	they are designed to be non-writable. If an immutable hard disk is
8679	attached to a virtual machine with snapshots then a special
8680	procedure called smart attachment is performed (see below).</li>
8681	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8682	also as designed. This also means that writethrough hard disks cannot
8683	have other hard disks linked to them at all.</li>
8684	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
8685	also as designed. This also means that shareable hard disks cannot
8686	have other hard disks linked to them at all. They behave almost
8687	like writethrough hard disks, except that shareable hard disks can
8688	be attached to several virtual machines which are running, allowing
8689	concurrent accesses. You need special cluster software running in
8690	the virtual machines to make use of such disks.</li>
8691	</ul>
8692
8693	Note that the same hard disk, regardless of its type, may be attached to
8694	more than one virtual machine at a time. In this case, the machine that is
8695	started first gains exclusive access to the hard disk and attempts to
8696	start other machines having this hard disk attached will fail until the
8697	first machine is powered down.
8698
8699	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8700	that the given hard disk remains associated with the given machine after a
8701	successful <link to="IMachine::detachDevice"/> call until
8702	<link to="IMachine::saveSettings"/> is called to save all changes to
8703	machine settings to disk. This deferring is necessary to guarantee that
8704	the hard disk configuration may be restored at any time by a call to
8705	<link to="IMachine::discardSettings"/> before the settings
8706	are saved (committed).
8707
8708	Note that if <link to="IMachine::discardSettings"/> is called after
8709	indirectly attaching some hard disks to the machine but before a call to
8710	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8711	all differencing hard disks implicitly created by
8712	<link to="IMachine::attachDevice"/> for these indirect attachments.
8713	Such implicitly created hard disks will also be immediately deleted when
8714	detached explicitly using the <link to="IMachine::detachDevice"/>
8715	call if it is made before <link to="IMachine::saveSettings"/>. This
8716	implicit deletion is safe because newly created differencing hard
8717	disks do not contain any user data.
8718
8719	However, keep in mind that detaching differencing hard disks that were
8720	implicitly created by <link to="IMachine::attachDevice"/>
8721	before the last <link to="IMachine::saveSettings"/> call will
8722	<b>not</b> implicitly delete them as they may already contain some data
8723	(for example, as a result of virtual machine execution). If these hard
8724	disks are no more necessary, the caller can always delete them explicitly
8725	using <link to="#deleteStorage"/> after they are actually de-associated
8726	from this machine by the <link to="IMachine::saveSettings"/> call.
8727
8728	<h3>Smart Attachment</h3>
8729
8730	When normal base or immutable hard disks are indirectly attached to a
8731	virtual machine then some additional steps are performed to make sure the
8732	virtual machine will have the most recent "view" of the hard disk being
8733	attached. These steps include walking through the machine's snapshots
8734	starting from the current one and going through ancestors up to the first
8735	snapshot. Hard disks attached to the virtual machine in all
8736	of the encountered snapshots are checked whether they are descendants of
8737	the given normal base or immutable hard disk. The first found child (which
8738	is the differencing hard disk) will be used instead of the normal base or
8739	immutable hard disk as a parent for creating a new differencing hard disk
8740	that will be actually attached to the machine. And only if no descendants
8741	are found or if the virtual machine does not have any snapshots then the
8742	normal base or immutable hard disk will be used itself as a parent for
8743	this differencing hard disk.
8744
8745	It is easier to explain what smart attachment does using the
8746	following example:
8747	<pre>
8748	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8749
8750	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8751	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8752	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8753	Snapshot 4 (none) Snapshot 4 (none)
8754	CurState (none) CurState (D3->D2.vdi)
8755
8756	NOT
8757	...
8758	CurState (D3->B.vdi)
8759	</pre>
8760	The first column is the virtual machine configuration before the base hard
8761	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8762	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8763	mean that the hard disk that is actually attached to the machine is a
8764	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8765	another hard disk, <tt>B.vdi</tt>.
8766
8767	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8768	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8769	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8770	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8771	it cannot be attached directly and needs an indirect attachment (i.e.
8772	implicit creation of a new differencing hard disk). Due to the smart
8773	attachment procedure, the new differencing hard disk
8774	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8775	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8776	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8777	machine.
8778
8779	Note that if there is more than one descendant hard disk of the given base
8780	hard disk found in a snapshot, and there is an exact device, channel and
8781	bus match, then this exact match will be used. Otherwise, the youngest
8782	descendant will be picked up.
8783
8784	There is one more important aspect of the smart attachment procedure which
8785	is not related to snapshots at all. Before walking through the snapshots
8786	as described above, the backup copy of the current list of hard disk
8787	attachment is searched for descendants. This backup copy is created when
8788	the hard disk configuration is changed for the first time after the last
8789	<link to="IMachine::saveSettings"/> call and used by
8790	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8791	changes. When such a descendant is found in this backup copy, it will be
8792	simply re-attached back, without creating a new differencing hard disk for
8793	it. This optimization is necessary to make it possible to re-attach the
8794	base or immutable hard disk to a different bus, channel or device slot
8795	without losing the contents of the differencing hard disk actually
8796	attached to the machine in place of it.
8797	</desc>
8798
8799	<attribute name="id" type="uuid" mod="string" readonly="yes">
8800	<desc>
8801	UUID of the medium. For a newly created medium, this value is a randomly
8802	generated UUID.
8803
8804	<note>
8805	For media in one of MediumState_NotCreated, MediumState_Creating or
8806	MediumState_Deleting states, the value of this property is undefined
8807	and will most likely be an empty UUID.
8808	</note>
8809	</desc>
8810	</attribute>
8811
8812	<attribute name="description" type="wstring">
8813	<desc>
8814	Optional description of the medium. For a newly created medium the value
8815	of this attribute is an empty string.
8816
8817	Medium types that don't support this attribute will return E_NOTIMPL in
8818	attempt to get or set this attribute's value.
8819
8820	<note>
8821	For some storage types, reading this attribute may return an outdated
8822	(last known) value when <link to="#state"/> is <link
8823	to="MediumState::Inaccessible"/> or <link
8824	to="MediumState::LockedWrite"/> because the value of this attribute is
8825	stored within the storage unit itself. Also note that changing the
8826	attribute value is not possible in such case, as well as when the
8827	medium is the <link to="MediumState::LockedRead"/> state.
8828	</note>
8829	</desc>
8830	</attribute>
8831
8832	<attribute name="state" type="MediumState" readonly="yes">
8833	<desc>
8834	Returns the current medium state, which is the last state set by
8835	the accessibility check performed by <link to="#refreshState"/>.
8836	If that method has not yet been called on the medium, the state
8837	is "Inaccessible"; as opposed to truly inaccessible media, the
8838	value of <link to="#lastAccessError"/> will be an empty string in
8839	that case.
8840
8841	<note>As of version 3.1, this no longer performs an accessibility check
8842	automatically; call <link to="#refreshState"/> for that.
8843	</note>
8844	</desc>
8845	</attribute>
8846
8847	<attribute name="variant" type="MediumVariant" readonly="yes">
8848	<desc>
8849	Returns the storage format variant information for this medium.
8850	Before <link to="#refreshState"/> is called this method returns
8851	an undefined value.
8852	</desc>
8853	</attribute>
8854
8855	<attribute name="location" type="wstring">
8856	<desc>
8857	Location of the storage unit holding medium data.
8858
8859	The format of the location string is medium type specific. For medium
8860	types using regular files in a host's file system, the location
8861	string is the full file name.
8862
8863	Some medium types may support changing the storage unit location by
8864	simply changing the value of this property. If this operation is not
8865	supported, the implementation will return E_NOTIMPL in attempt to set
8866	this attribute's value.
8867
8868	When setting a value of the location attribute which is a regular file
8869	in the host's file system, the given file name may be either relative to
8870	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
8871	absolute. Note that if the given location specification does not contain
8872	the file extension part then a proper default extension will be
8873	automatically appended by the implementation depending on the medium type.
8874	</desc>
8875	</attribute>
8876
8877	<attribute name="name" type="wstring" readonly="yes">
8878	<desc>
8879	Name of the storage unit holding medium data.
8880
8881	The returned string is a short version of the <link to="#location"/>
8882	attribute that is suitable for representing the medium in situations
8883	where the full location specification is too long (such as lists
8884	and comboboxes in GUI frontends). This string is also used by frontends
8885	to sort the media list alphabetically when needed.
8886
8887	For example, for locations that are regular files in the host's file
8888	system, the value of this attribute is just the file name (+ extension),
8889	without the path specification.
8890
8891	Note that as opposed to the <link to="#location"/> attribute, the name
8892	attribute will not necessary be unique for a list of media of the
8893	given type and format.
8894	</desc>
8895	</attribute>
8896
8897	<attribute name="deviceType" type="DeviceType" readonly="yes">
8898	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
8899	medium.</desc>
8900	</attribute>
8901
8902	<attribute name="hostDrive" type="boolean" readonly="yes">
8903	<desc>True if this corresponds to a drive on the host.</desc>
8904	</attribute>
8905
8906	<attribute name="size" type="long long" readonly="yes">
8907	<desc>
8908	Physical size of the storage unit used to hold medium data (in bytes).
8909
8910	<note>
8911	For media whose <link to="#state"/> is <link
8912	to="MediumState::Inaccessible"/>, the value of this property is the
8913	last known size. For <link to="MediumState::NotCreated"/> media,
8914	the returned value is zero.
8915	</note>
8916	</desc>
8917	</attribute>
8918
8919	<attribute name="format" type="wstring" readonly="yes">
8920	<desc>
8921	Storage format of this medium.
8922
8923	The value of this attribute is a string that specifies a backend used
8924	to store medium data. The storage format is defined when you create a
8925	new medium or automatically detected when you open an existing medium,
8926	and cannot be changed later.
8927
8928	The list of all storage formats supported by this VirtualBox
8929	installation can be obtained using
8930	<link to="ISystemProperties::mediumFormats"/>.
8931	</desc>
8932	</attribute>
8933
8934	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
8935	<desc>
8936	Storage medium format object corresponding to this medium.
8937
8938	The value of this attribute is a reference to the medium format object
8939	that specifies the backend properties used to store medium data. The
8940	storage format is defined when you create a new medium or automatically
8941	detected when you open an existing medium, and cannot be changed later.
8942
8943	<note>@c null is returned if there is no associated medium format
8944	object. This can e.g. happen for medium objects representing host
8945	drives and other special medium objects.</note>
8946	</desc>
8947	</attribute>
8948
8949	<attribute name="type" type="MediumType">
8950	<desc>
8951	Type (role) of this medium.
8952
8953	The following constraints apply when changing the value of this
8954	attribute:
8955	<ul>
8956	<li>If a medium is attached to a virtual machine (either in the
8957	current state or in one of the snapshots), its type cannot be
8958	changed.
8959	</li>
8960	<li>As long as the medium has children, its type cannot be set
8961	to <link to="MediumType::Writethrough"/>.
8962	</li>
8963	<li>The type of all differencing media is
8964	<link to="MediumType::Normal"/> and cannot be changed.
8965	</li>
8966	</ul>
8967
8968	The type of a newly created or opened medium is set to
8969	<link to="MediumType::Normal"/>, except for DVD and floppy media,
8970	which have a type of <link to="MediumType::Writethrough"/>.
8971	</desc>
8972	</attribute>
8973
8974	<attribute name="parent" type="IMedium" readonly="yes">
8975	<desc>
8976	Parent of this medium (the medium this medium is directly based
8977	on).
8978
8979	Only differencing media have parents. For base (non-differencing)
8980	media, @c null is returned.
8981	</desc>
8982	</attribute>
8983
8984	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
8985	<desc>
8986	Children of this medium (all differencing media directly based
8987	on this medium). A @c null array is returned if this medium
8988	does not have any children.
8989	</desc>
8990	</attribute>
8991
8992	<attribute name="base" type="IMedium" readonly="yes">
8993	<desc>
8994	Base medium of this medium.
8995
8996	If this is a differencing medium, its base medium is the medium
8997	the given medium branch starts from. For all other types of media, this
8998	property returns the medium object itself (i.e. the same object this
8999	property is read on).
9000	</desc>
9001	</attribute>
9002
9003	<attribute name="readOnly" type="boolean" readonly="yes">
9004	<desc>
9005	Returns @c true if this medium is read-only and @c false otherwise.
9006
9007	A medium is considered to be read-only when its contents cannot be
9008	modified without breaking the integrity of other parties that depend on
9009	this medium such as its child media or snapshots of virtual machines
9010	where this medium is attached to these machines. If there are no
9011	children and no such snapshots then there is no dependency and the
9012	medium is not read-only.
9013
9014	The value of this attribute can be used to determine the kind of the
9015	attachment that will take place when attaching this medium to a
9016	virtual machine. If the value is @c false then the medium will
9017	be attached directly. If the value is @c true then the medium
9018	will be attached indirectly by creating a new differencing child
9019	medium for that. See the interface description for more information.
9020
9021	Note that all <link to="MediumType::Immutable">Immutable</link> media
9022	are always read-only while all
9023	<link to="MediumType::Writethrough">Writethrough</link> media are
9024	always not.
9025
9026	<note>
9027	The read-only condition represented by this attribute is related to
9028	the medium type and usage, not to the current
9029	<link to="IMedium::state">medium state</link> and not to the read-only
9030	state of the storage unit.
9031	</note>
9032	</desc>
9033	</attribute>
9034
9035	<attribute name="logicalSize" type="long long" readonly="yes">
9036	<desc>
9037	Logical size of this medium (in megabytes), as reported to the
9038	guest OS running inside the virtual machine this medium is
9039	attached to. The logical size is defined when the medium is created
9040	and cannot be changed later.
9041
9042	<note>
9043	Reading this property on a differencing medium will return the size
9044	of its <link to="#base"/> medium.
9045	</note>
9046	<note>
9047	For media whose state is <link to="#state"/> is <link
9048	to="MediumState::Inaccessible"/>, the value of this property is the
9049	last known logical size. For <link to="MediumState::NotCreated"/>
9050	media, the returned value is zero.
9051	</note>
9052	</desc>
9053	</attribute>
9054
9055	<attribute name="autoReset" type="boolean">
9056	<desc>
9057	Whether this differencing medium will be automatically reset each
9058	time a virtual machine it is attached to is powered up. This
9059	attribute is automatically set to @c true for the last
9060	differencing image of an "immutable" medium (see
9061	<link to="MediumType" />).
9062
9063	See <link to="#reset"/> for more information about resetting
9064	differencing media.
9065
9066	<note>
9067	Reading this property on a base (non-differencing) medium will
9068	always @c false. Changing the value of this property in this
9069	case is not supported.
9070	</note>
9071
9072	<result name="VBOX_E_NOT_SUPPORTED">
9073	This is not a differencing medium (when changing the attribute
9074	value).
9075	</result>
9076	</desc>
9077	</attribute>
9078
9079	<attribute name="lastAccessError" type="wstring" readonly="yes">
9080	<desc>
9081	Text message that represents the result of the last accessibility
9082	check performed by <link to="#refreshState"/>.
9083
9084	An empty string is returned if the last accessibility check
9085	was successful or has not yet been called. As a result, if
9086	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9087	then <link to="#refreshState"/> has yet to be called; this is the
9088	default value of media after VirtualBox initialization.
9089	A non-empty string indicates a failure and should normally describe
9090	a reason of the failure (for example, a file read error).
9091	</desc>
9092	</attribute>
9093
9094	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9095	<desc>
9096	Array of UUIDs of all machines this medium is attached to.
9097
9098	A @c null array is returned if this medium is not attached to any
9099	machine or to any machine's snapshot.
9100
9101	<note>
9102	The returned array will include a machine even if this medium is not
9103	attached to that machine in the current state but attached to it in
9104	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9105	details.
9106	</note>
9107	</desc>
9108	</attribute>
9109
9110	<method name="setIDs">
9111	<desc>
9112	Changes the UUID and parent UUID for a hard disk medium.
9113	</desc>
9114	<param name="setImageId" type="boolean" dir="in">
9115	<desc>
9116	Select whether a new image UUID is set or not.
9117	</desc>
9118	</param>
9119	<param name="imageId" type="uuid" mod="string" dir="in">
9120	<desc>
9121	New UUID for the image. If an empty string is passed, then a new
9122	UUID is automatically created, provided that @a setImageId is @c true.
9123	Specifying a zero UUID is not allowed.
9124	</desc>
9125	</param>
9126	<param name="setParentId" type="boolean" dir="in">
9127	<desc>
9128	Select whether a new parent UUID is set or not.
9129	</desc>
9130	</param>
9131	<param name="parentId" type="uuid" mod="string" dir="in">
9132	<desc>
9133	New parent UUID for the image. If an empty string is passed, then a
9134	new UUID is automatically created, provided @a setParentId is
9135	@c true. A zero UUID is valid.
9136	</desc>
9137	</param>
9138	<result name="E_INVALIDARG">
9139	Invalid parameter combination.
9140	</result>
9141	<result name="VBOX_E_NOT_SUPPORTED">
9142	Medium is not a hard disk medium.
9143	</result>
9144	</method>
9145
9146	<method name="refreshState">
9147	<desc>
9148	If the current medium state (see <link to="MediumState"/>) is one of
9149	"Created", "Inaccessible" or "LockedRead", then this performs an
9150	accessibility check on the medium and sets the value of the <link to="#state"/>
9151	attribute accordingly; that value is also returned for convenience.
9152
9153	For all other state values, this does not perform a refresh but returns
9154	the state only.
9155
9156	The refresh, if performed, may take a long time (several seconds or even
9157	minutes, depending on the storage unit location and format) because it performs an
9158	accessibility check of the storage unit. This check may cause a significant
9159	delay if the storage unit of the given medium is, for example, a file located
9160	on a network share which is not currently accessible due to connectivity
9161	problems. In that case, the call will not return until a timeout
9162	interval defined by the host OS for this operation expires. For this reason,
9163	it is recommended to never read this attribute on the main UI thread to avoid
9164	making the UI unresponsive.
9165
9166	If the last known state of the medium is "Created" and the accessibility
9167	check fails, then the state would be set to "Inaccessible", and
9168	<link to="#lastAccessError"/> may be used to get more details about the
9169	failure. If the state of the medium is "LockedRead", then it remains the
9170	same, and a non-empty value of <link to="#lastAccessError"/> will
9171	indicate a failed accessibility check in this case.
9172
9173	Note that not all medium states are applicable to all medium types.
9174	</desc>
9175	<param name="state" type="MediumState" dir="return">
9176	<desc>
9177	New medium state.
9178	</desc>
9179	</param>
9180	</method>
9181
9182	<method name="getSnapshotIds">
9183	<desc>
9184	Returns an array of UUIDs of all snapshots of the given machine where
9185	this medium is attached to.
9186
9187	If the medium is attached to the machine in the current state, then the
9188	first element in the array will always be the ID of the queried machine
9189	(i.e. the value equal to the @c machineId argument), followed by
9190	snapshot IDs (if any).
9191
9192	If the medium is not attached to the machine in the current state, then
9193	the array will contain only snapshot IDs.
9194
9195	The returned array may be @c null if this medium is not attached
9196	to the given machine at all, neither in the current state nor in one of
9197	the snapshots.
9198	</desc>
9199	<param name="machineId" type="uuid" mod="string" dir="in">
9200	<desc>
9201	UUID of the machine to query.
9202	</desc>
9203	</param>
9204	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9205	<desc>
9206	Array of snapshot UUIDs of the given machine using this medium.
9207	</desc>
9208	</param>
9209	</method>
9210
9211	<method name="lockRead">
9212	<desc>
9213	Locks this medium for reading.
9214
9215	A read lock is shared: many clients can simultaneously lock the
9216	same medium for reading unless it is already locked for writing (see
9217	<link to="#lockWrite"/>) in which case an error is returned.
9218
9219	When the medium is locked for reading, it cannot be modified
9220	from within VirtualBox. This means that any method that changes
9221	the properties of this medium or contents of the storage unit
9222	will return an error (unless explicitly stated otherwise). That
9223	includes an attempt to start a virtual machine that wants to
9224	write to the the medium.
9225
9226	When the virtual machine is started up, it locks for reading all
9227	media it uses in read-only mode. If some medium cannot be locked
9228	for reading, the startup procedure will fail.
9229	A medium is typically locked for reading while it is used by a running
9230	virtual machine but has a depending differencing image that receives
9231	the actual write operations. This way one base medium can have
9232	multiple child differencing images which can be written to
9233	simultaneously. Read-only media such as DVD and floppy images are
9234	also locked for reading only (so they can be in use by multiple
9235	machines simultaneously).
9236
9237	A medium is also locked for reading when it is the source of a
9238	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9239
9240	The medium locked for reading must be unlocked using the <link
9241	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9242	can be nested and must be followed by the same number of paired
9243	<link to="#unlockRead"/> calls.
9244
9245	This method sets the medium state (see <link to="#state"/>) to
9246	"LockedRead" on success. The medium's previous state must be
9247	one of "Created", "Inaccessible" or "LockedRead".
9248
9249	Locking an inaccessible medium is not an error; this method performs
9250	a logical lock that prevents modifications of this medium through
9251	the VirtualBox API, not a physical file-system lock of the underlying
9252	storage unit.
9253
9254	This method returns the current state of the medium
9255	<i>before</i> the operation.
9256
9257	<result name="VBOX_E_INVALID_OBJECT_STATE">
9258	Invalid medium state (e.g. not created, locked, inaccessible,
9259	creating, deleting).
9260	</result>
9261
9262	</desc>
9263	<param name="state" type="MediumState" dir="return">
9264	<desc>
9265	State of the medium after the operation.
9266	</desc>
9267	</param>
9268	</method>
9269
9270	<method name="unlockRead">
9271	<desc>
9272	Cancels the read lock previously set by <link to="#lockRead"/>.
9273
9274	For both success and failure, this method returns the current state
9275	of the medium <i>after</i> the operation.
9276
9277	See <link to="#lockRead"/> for more details.
9278
9279	<result name="VBOX_E_INVALID_OBJECT_STATE">
9280	Medium not locked for reading.
9281	</result>
9282
9283	</desc>
9284	<param name="state" type="MediumState" dir="return">
9285	<desc>
9286	State of the medium after the operation.
9287	</desc>
9288	</param>
9289	</method>
9290
9291	<method name="lockWrite">
9292	<desc>
9293	Locks this medium for writing.
9294
9295	A write lock, as opposed to <link to="#lockRead"/>, is
9296	exclusive: there may be only one client holding a write lock,
9297	and there may be no read locks while the write lock is held.
9298	As a result, read-locking fails if a write lock is held, and
9299	write-locking fails if either a read or another write lock is held.
9300
9301	When a medium is locked for writing, it cannot be modified
9302	from within VirtualBox, and it is not guaranteed that the values
9303	of its properties are up-to-date. Any method that changes the
9304	properties of this medium or contents of the storage unit will
9305	return an error (unless explicitly stated otherwise).
9306
9307	When a virtual machine is started up, it locks for writing all
9308	media it uses to write data to. If any medium could not be locked
9309	for writing, the startup procedure will fail. If a medium has
9310	differencing images, then while the machine is running, only
9311	the last ("leaf") differencing image is locked for writing,
9312	whereas its parents are locked for reading only.
9313
9314	A medium is also locked for writing when it is the target of a
9315	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9316
9317	The medium locked for writing must be unlocked using the <link
9318	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9319
9320	This method sets the medium state (see <link to="#state"/>) to
9321	"LockedWrite" on success. The medium's previous state must be
9322	either "Created" or "Inaccessible".
9323
9324	Locking an inaccessible medium is not an error; this method performs
9325	a logical lock that prevents modifications of this medium through
9326	the VirtualBox API, not a physical file-system lock of the underlying
9327	storage unit.
9328
9329	For both, success and failure, this method returns the current
9330	state of the medium <i>before</i> the operation.
9331
9332	<result name="VBOX_E_INVALID_OBJECT_STATE">
9333	Invalid medium state (e.g. not created, locked, inaccessible,
9334	creating, deleting).
9335	</result>
9336
9337	</desc>
9338	<param name="state" type="MediumState" dir="return">
9339	<desc>
9340	State of the medium after the operation.
9341	</desc>
9342	</param>
9343	</method>
9344
9345	<method name="unlockWrite">
9346	<desc>
9347	Cancels the write lock previously set by <link to="#lockWrite"/>.
9348
9349	For both success and failure, this method returns the current
9350	state of the medium <i>after</i> the operation.
9351
9352	See <link to="#lockWrite"/> for more details.
9353
9354	<result name="VBOX_E_INVALID_OBJECT_STATE">
9355	Medium not locked for writing.
9356	</result>
9357
9358	</desc>
9359	<param name="state" type="MediumState" dir="return">
9360	<desc>
9361	State of the medium after the operation.
9362	</desc>
9363	</param>
9364	</method>
9365
9366	<method name="close">
9367	<desc>
9368	Closes this medium.
9369
9370	The medium must not be attached to any known virtual machine
9371	and must not have any known child media, otherwise the
9372	operation will fail.
9373
9374	When the medium is successfully closed, it is removed from
9375	the list of registered media, but its storage unit is not
9376	deleted. In particular, this means that this medium can
9377	later be opened again using the <link to="IVirtualBox::openMedium"/>
9378	call.
9379
9380	Note that after this method successfully returns, the given medium
9381	object becomes uninitialized. This means that any attempt
9382	to call any of its methods or attributes will fail with the
9383	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9384
9385	<result name="VBOX_E_INVALID_OBJECT_STATE">
9386	Invalid medium state (other than not created, created or
9387	inaccessible).
9388	</result>
9389	<result name="VBOX_E_OBJECT_IN_USE">
9390	Medium attached to virtual machine.
9391	</result>
9392	<result name="VBOX_E_FILE_ERROR">
9393	Settings file not accessible.
9394	</result>
9395	<result name="VBOX_E_XML_ERROR">
9396	Could not parse the settings file.
9397	</result>
9398
9399	</desc>
9400	</method>
9401
9402	<!-- storage methods -->
9403
9404	<method name="getProperty">
9405	<desc>
9406	Returns the value of the custom medium property with the given name.
9407
9408	The list of all properties supported by the given medium format can
9409	be obtained with <link to="IMediumFormat::describeProperties"/>.
9410
9411	Note that if this method returns an empty string in @a value, the
9412	requested property is supported but currently not assigned any value.
9413
9414	<result name="VBOX_E_OBJECT_NOT_FOUND">
9415	Requested property does not exist (not supported by the format).
9416	</result>
9417	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9418	</desc>
9419	<param name="name" type="wstring" dir="in">
9420	<desc>Name of the property to get.</desc>
9421	</param>
9422	<param name="value" type="wstring" dir="return">
9423	<desc>Current property value.</desc>
9424	</param>
9425	</method>
9426
9427	<method name="setProperty">
9428	<desc>
9429	Sets the value of the custom medium property with the given name.
9430
9431	The list of all properties supported by the given medium format can
9432	be obtained with <link to="IMediumFormat::describeProperties"/>.
9433
9434	Note that setting the property value to @c null or an empty string is
9435	equivalent to deleting the existing value. A default value (if it is
9436	defined for this property) will be used by the format backend in this
9437	case.
9438
9439	<result name="VBOX_E_OBJECT_NOT_FOUND">
9440	Requested property does not exist (not supported by the format).
9441	</result>
9442	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9443	</desc>
9444	<param name="name" type="wstring" dir="in">
9445	<desc>Name of the property to set.</desc>
9446	</param>
9447	<param name="value" type="wstring" dir="in">
9448	<desc>Property value to set.</desc>
9449	</param>
9450	</method>
9451
9452	<method name="getProperties">
9453	<desc>
9454	Returns values for a group of properties in one call.
9455
9456	The names of the properties to get are specified using the @a names
9457	argument which is a list of comma-separated property names or
9458	an empty string if all properties are to be returned. Note that currently
9459	the value of this argument is ignored and the method always returns all
9460	existing properties.
9461
9462	The list of all properties supported by the given medium format can
9463	be obtained with <link to="IMediumFormat::describeProperties"/>.
9464
9465	The method returns two arrays, the array of property names corresponding
9466	to the @a names argument and the current values of these properties.
9467	Both arrays have the same number of elements with each elemend at the
9468	given index in the first array corresponds to an element at the same
9469	index in the second array.
9470
9471	Note that for properties that do not have assigned values,
9472	an empty string is returned at the appropriate index in the
9473	@a returnValues array.
9474
9475	</desc>
9476	<param name="names" type="wstring" dir="in">
9477	<desc>
9478	Names of properties to get.
9479	</desc>
9480	</param>
9481	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9482	<desc>Names of returned properties.</desc>
9483	</param>
9484	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9485	<desc>Values of returned properties.</desc>
9486	</param>
9487	</method>
9488
9489	<method name="setProperties">
9490	<desc>
9491	Sets values for a group of properties in one call.
9492
9493	The names of the properties to set are passed in the @a names
9494	array along with the new values for them in the @a values array. Both
9495	arrays have the same number of elements with each elemend at the given
9496	index in the first array corresponding to an element at the same index
9497	in the second array.
9498
9499	If there is at least one property name in @a names that is not valid,
9500	the method will fail before changing the values of any other properties
9501	from the @a names array.
9502
9503	Using this method over <link to="#setProperty"/> is preferred if you
9504	need to set several properties at once since it will result into less
9505	IPC calls.
9506
9507	The list of all properties supported by the given medium format can
9508	be obtained with <link to="IMediumFormat::describeProperties"/>.
9509
9510	Note that setting the property value to @c null or an empty string is
9511	equivalent to deleting the existing value. A default value (if it is
9512	defined for this property) will be used by the format backend in this
9513	case.
9514	</desc>
9515	<param name="names" type="wstring" safearray="yes" dir="in">
9516	<desc>Names of properties to set.</desc>
9517	</param>
9518	<param name="values" type="wstring" safearray="yes" dir="in">
9519	<desc>Values of properties to set.</desc>
9520	</param>
9521	</method>
9522
9523	<!-- storage methods -->
9524
9525	<method name="createBaseStorage">
9526	<desc>
9527	Starts creating a hard disk storage unit (fixed/dynamic, according
9528	to the variant flags) in in the background. The previous storage unit
9529	created for this object, if any, must first be deleted using
9530	<link to="#deleteStorage"/>, otherwise the operation will fail.
9531
9532	Before the operation starts, the medium is placed in
9533	<link to="MediumState::Creating"/> state. If the create operation
9534	fails, the medium will be placed back in <link to="MediumState::NotCreated"/>
9535	state.
9536
9537	After the returned progress object reports that the operation has
9538	successfully completed, the medium state will be set to <link
9539	to="MediumState::Created"/>, the medium will be remembered by this
9540	VirtualBox installation and may be attached to virtual machines.
9541
9542	<result name="VBOX_E_NOT_SUPPORTED">
9543	The variant of storage creation operation is not supported. See <link
9544	to="IMediumFormat::capabilities"/>.
9545	</result>
9546	</desc>
9547	<param name="logicalSize" type="long long" dir="in">
9548	<desc>Maximum logical size of the medium in megabytes.</desc>
9549	</param>
9550	<param name="variant" type="MediumVariant" dir="in">
9551	<desc>Exact image variant which should be created.</desc>
9552	</param>
9553	<param name="progress" type="IProgress" dir="return">
9554	<desc>Progress object to track the operation completion.</desc>
9555	</param>
9556	</method>
9557
9558	<method name="deleteStorage">
9559	<desc>
9560	Starts deleting the storage unit of this medium.
9561
9562	The medium must not be attached to any known virtual machine and must
9563	not have any known child media, otherwise the operation will fail.
9564	It will also fail if there is no storage unit to delete or if deletion
9565	is already in progress, or if the medium is being in use (locked for
9566	read or for write) or inaccessible. Therefore, the only valid state for
9567	this operation to succeed is <link to="MediumState::Created"/>.
9568
9569	Before the operation starts, the medium is placed in
9570	<link to="MediumState::Deleting"/> state and gets removed from the list
9571	of remembered hard disks (media registry). If the delete operation
9572	fails, the medium will be remembered again and placed back to
9573	<link to="MediumState::Created"/> state.
9574
9575	After the returned progress object reports that the operation is
9576	complete, the medium state will be set to
9577	<link to="MediumState::NotCreated"/> and you will be able to use one of
9578	the storage creation methods to create it again.
9579
9580	<see>#close()</see>
9581
9582	<result name="VBOX_E_OBJECT_IN_USE">
9583	Medium is attached to a virtual machine.
9584	</result>
9585	<result name="VBOX_E_NOT_SUPPORTED">
9586	Storage deletion is not allowed because neither of storage creation
9587	operations are supported. See
9588	<link to="IMediumFormat::capabilities"/>.
9589	</result>
9590
9591	<note>
9592	If the deletion operation fails, it is not guaranteed that the storage
9593	unit still exists. You may check the <link to="IMedium::state"/> value
9594	to answer this question.
9595	</note>
9596	</desc>
9597	<param name="progress" type="IProgress" dir="return">
9598	<desc>Progress object to track the operation completion.</desc>
9599	</param>
9600	</method>
9601
9602	<!-- diff methods -->
9603
9604	<method name="createDiffStorage">
9605	<desc>
9606	Starts creating an empty differencing storage unit based on this
9607	medium in the format and at the location defined by the @a target
9608	argument.
9609
9610	The target medium must be in <link to="MediumState::NotCreated"/>
9611	state (i.e. must not have an existing storage unit). Upon successful
9612	completion, this operation will set the type of the target medium to
9613	<link to="MediumType::Normal"/> and create a storage unit necessary to
9614	represent the differencing medium data in the given format (according
9615	to the storage format of the target object).
9616
9617	After the returned progress object reports that the operation is
9618	successfully complete, the target medium gets remembered by this
9619	VirtualBox installation and may be attached to virtual machines.
9620
9621	<note>
9622	The medium will be set to <link to="MediumState::LockedRead"/>
9623	state for the duration of this operation.
9624	</note>
9625	<result name="VBOX_E_OBJECT_IN_USE">
9626	Medium not in @c NotCreated state.
9627	</result>
9628	</desc>
9629	<param name="target" type="IMedium" dir="in">
9630	<desc>Target medium.</desc>
9631	</param>
9632	<param name="variant" type="MediumVariant" dir="in">
9633	<desc>Exact image variant which should be created.</desc>
9634	</param>
9635	<param name="progress" type="IProgress" dir="return">
9636	<desc>Progress object to track the operation completion.</desc>
9637	</param>
9638	</method>
9639
9640	<method name="mergeTo">
9641	<desc>
9642	Starts merging the contents of this medium and all intermediate
9643	differencing media in the chain to the given target medium.
9644
9645	The target medium must be either a descendant of this medium or
9646	its ancestor (otherwise this method will immediately return a failure).
9647	It follows that there are two logical directions of the merge operation:
9648	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9649	ancestor (<i>backward merge</i>). Let us consider the following medium
9650	chain:
9651
9652	<pre>Base <- Diff_1 <- Diff_2</pre>
9653
9654	Here, calling this method on the <tt>Base</tt> medium object with
9655	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9656	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9657	merge. Note that in both cases the contents of the resulting medium
9658	will be the same, the only difference is the medium object that takes
9659	the result of the merge operation. In case of the forward merge in the
9660	above example, the result will be written to <tt>Diff_2</tt>; in case of
9661	the backward merge, the result will be written to <tt>Base</tt>. In
9662	other words, the result of the operation is always stored in the target
9663	medium.
9664
9665	Upon successful operation completion, the storage units of all media in
9666	the chain between this (source) medium and the target medium, including
9667	the source medium itself, will be automatically deleted and the
9668	relevant medium objects (including this medium) will become
9669	uninitialized. This means that any attempt to call any of
9670	their methods or attributes will fail with the
9671	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9672	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9673	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9674	Note that <tt>Diff_2</tt> in this case will become a base medium
9675	itself since it will no longer be based on any other medium.
9676
9677	Considering the above, all of the following conditions must be met in
9678	order for the merge operation to succeed:
9679	<ul>
9680	<li>
9681	Neither this (source) medium nor any intermediate
9682	differencing medium in the chain between it and the target
9683	medium is attached to any virtual machine.
9684	</li>
9685	<li>
9686	Neither the source medium nor the target medium is an
9687	<link to="MediumType::Immutable"/> medium.
9688	</li>
9689	<li>
9690	The part of the medium tree from the source medium to the
9691	target medium is a linear chain, i.e. all medium in this
9692	chain have exactly one child which is the next medium in this
9693	chain. The only exception from this rule is the target medium in
9694	the forward merge operation; it is allowed to have any number of
9695	child media because the merge operation will not change its
9696	logical contents (as it is seen by the guest OS or by children).
9697	</li>
9698	<li>
9699	None of the involved media are in
9700	<link to="MediumState::LockedRead"/> or
9701	<link to="MediumState::LockedWrite"/> state.
9702	</li>
9703	</ul>
9704
9705	<note>
9706	This (source) medium and all intermediates will be placed to <link
9707	to="MediumState::Deleting"/> state and the target medium will be
9708	placed to <link to="MediumState::LockedWrite"/> state and for the
9709	duration of this operation.
9710	</note>
9711	</desc>
9712	<param name="target" type="IMedium" dir="in">
9713	<desc>Target medium.</desc>
9714	</param>
9715	<param name="progress" type="IProgress" dir="return">
9716	<desc>Progress object to track the operation completion.</desc>
9717	</param>
9718	</method>
9719
9720	<!-- clone method -->
9721
9722	<method name="cloneTo">
9723	<desc>
9724	Starts creating a clone of this medium in the format and at the
9725	location defined by the @a target argument.
9726
9727	The target medium must be either in <link to="MediumState::NotCreated"/>
9728	state (i.e. must not have an existing storage unit) or in
9729	<link to="MediumState::Created"/> state (i.e. created and not locked, and
9730	big enough to hold the data or else the copy will be partial). Upon
9731	successful completion, the cloned medium will contain exactly the
9732	same sector data as the medium being cloned, except that in the
9733	first case a new UUID for the clone will be randomly generated, and in
9734	the second case the UUID will remain unchanged.
9735
9736	The @a parent argument defines which medium will be the parent
9737	of the clone. Passing a @c null reference indicates that the clone will
9738	be a base image, i.e. completely independent. It is possible to specify
9739	an arbitrary medium for this parameter, including the parent of the
9740	medium which is being cloned. Even cloning to a child of the source
9741	medium is possible. Note that when cloning to an existing image, the
9742	@a parent irgument is ignored.
9743
9744	After the returned progress object reports that the operation is
9745	successfully complete, the target medium gets remembered by this
9746	VirtualBox installation and may be attached to virtual machines.
9747
9748	<note>
9749	This medium will be placed to <link to="MediumState::LockedRead"/>
9750	state for the duration of this operation.
9751	</note>
9752	<result name="E_NOTIMPL">
9753	The specified cloning variant is not supported at the moment.
9754	</result>
9755	</desc>
9756	<param name="target" type="IMedium" dir="in">
9757	<desc>Target medium.</desc>
9758	</param>
9759	<param name="variant" type="MediumVariant" dir="in">
9760	<desc>Exact image variant which should be created.</desc>
9761	</param>
9762	<param name="parent" type="IMedium" dir="in">
9763	<desc>Parent of the cloned medium.</desc>
9764	</param>
9765	<param name="progress" type="IProgress" dir="return">
9766	<desc>Progress object to track the operation completion.</desc>
9767	</param>
9768	</method>
9769
9770	<!-- other methods -->
9771
9772	<method name="compact">
9773	<desc>
9774	Starts compacting of this medium. This means that the medium is
9775	transformed into a possibly more compact storage representation.
9776	This potentially creates temporary images, which can require a
9777	substantial amount of additional disk space.
9778
9779	This medium will be placed to <link to="MediumState::LockedWrite"/>
9780	state and all its parent media (if any) will be placed to
9781	<link to="MediumState::LockedRead"/> state for the duration of this
9782	operation.
9783
9784	Please note that the results can be either returned straight away,
9785	or later as the result of the background operation via the object
9786	returned via the @a progress parameter.
9787
9788	<result name="VBOX_E_NOT_SUPPORTED">
9789	Medium format does not support compacting (but potentially
9790	needs it).
9791	</result>
9792	</desc>
9793	<param name="progress" type="IProgress" dir="return">
9794	<desc>Progress object to track the operation completion.</desc>
9795	</param>
9796	</method>
9797
9798	<method name="resize">
9799	<desc>
9800	Starts resizing this medium. This means that the nominal size of the
9801	medium is set to the new value. Both increasing and decreasing the
9802	size is possible, and there are no safety checks, since VirtualBox
9803	does not make any assumptions about the medium contents.
9804
9805	Resizing usually needs additional disk space, and possibly also
9806	some temporary disk space. Note that resize does not create a full
9807	temporary copy of the medium, so the additional disk space requirement
9808	is usually much lower than using the clone operation.
9809
9810	This medium will be placed to <link to="MediumState::LockedWrite"/>
9811	state for the duration of this operation.
9812
9813	Please note that the results can be either returned straight away,
9814	or later as the result of the background operation via the object
9815	returned via the @a progress parameter.
9816
9817	<result name="VBOX_E_NOT_SUPPORTED">
9818	Medium format does not support resizing.
9819	</result>
9820	</desc>
9821	<param name="logicalSize" type="long long" dir="in">
9822	<desc>New nominal capacity of the medium in megabytes.</desc>
9823	</param>
9824	<param name="progress" type="IProgress" dir="return">
9825	<desc>Progress object to track the operation completion.</desc>
9826	</param>
9827	</method>
9828
9829	<method name="reset">
9830	<desc>
9831	Starts erasing the contents of this differencing medium.
9832
9833	This operation will reset the differencing medium to its initial
9834	state when it does not contain any sector data and any read operation is
9835	redirected to its parent medium. This automatically gets called
9836	during VM power-up for every medium whose <link to="#autoReset" />
9837	attribute is @c true.
9838
9839	The medium will be write-locked for the duration of this operation (see
9840	<link to="#lockWrite" />).
9841
9842	<result name="VBOX_E_NOT_SUPPORTED">
9843	This is not a differencing medium.
9844	</result>
9845	<result name="VBOX_E_INVALID_OBJECT_STATE">
9846	Medium is not in <link to="MediumState::Created"/> or
9847	<link to="MediumState::Inaccessible"/> state.
9848	</result>
9849	</desc>
9850	<param name="progress" type="IProgress" dir="return">
9851	<desc>Progress object to track the operation completion.</desc>
9852	</param>
9853	</method>
9854
9855	</interface>
9856
9857
9858	<!--
9859	// IMediumFormat
9860	/////////////////////////////////////////////////////////////////////////
9861	-->
9862
9863	<enum
9864	name="DataType"
9865	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
9866	>
9867	<const name="Int32" value="0"/>
9868	<const name="Int8" value="1"/>
9869	<const name="String" value="2"/>
9870	</enum>
9871
9872	<enum
9873	name="DataFlags"
9874	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
9875	>
9876	<const name="None" value="0x00"/>
9877	<const name="Mandatory" value="0x01"/>
9878	<const name="Expert" value="0x02"/>
9879	<const name="Array" value="0x04"/>
9880	<const name="FlagMask" value="0x07"/>
9881	</enum>
9882
9883	<enum
9884	name="MediumFormatCapabilities"
9885	uuid="70fcf810-99e8-4edc-aee4-7f51d489e657"
9886	>
9887	<desc>
9888	Medium format capability flags.
9889	</desc>
9890
9891	<const name="Uuid" value="0x01">
9892	<desc>
9893	Supports UUIDs as expected by VirtualBox code.
9894	</desc>
9895	</const>
9896
9897	<const name="CreateFixed" value="0x02">
9898	<desc>
9899	Supports creating fixed size images, allocating all space instantly.
9900	</desc>
9901	</const>
9902
9903	<const name="CreateDynamic" value="0x04">
9904	<desc>
9905	Supports creating dynamically growing images, allocating space on
9906	demand.
9907	</desc>
9908	</const>
9909
9910	<const name="CreateSplit2G" value="0x08">
9911	<desc>
9912	Supports creating images split in chunks of a bit less than 2 GBytes.
9913	</desc>
9914	</const>
9915
9916	<const name="Differencing" value="0x10">
9917	<desc>
9918	Supports being used as a format for differencing media (see <link
9919	to="IMedium::createDiffStorage"/>).
9920	</desc>
9921	</const>
9922
9923	<const name="Asynchronous" value="0x20">
9924	<desc>
9925	Supports asynchronous I/O operations for at least some configurations.
9926	</desc>
9927	</const>
9928
9929	<const name="File" value="0x40">
9930	<desc>
9931	The format backend operates on files (the <link to="IMedium::location"/>
9932	attribute of the medium specifies a file used to store medium
9933	data; for a list of supported file extensions see
9934	<link to="IMediumFormat::fileExtensions"/>).
9935	</desc>
9936	</const>
9937
9938	<const name="Properties" value="0x80">
9939	<desc>
9940	The format backend uses the property interface to configure the storage
9941	location and properties (the <link to="IMediumFormat::describeProperties"/>
9942	method is used to get access to properties supported by the given medium format).
9943	</desc>
9944	</const>
9945
9946	<const name="CapabilityMask" value="0xFF"/>
9947	</enum>
9948
9949	<interface
9950	name="IMediumFormat" extends="$unknown"
9951	uuid="89f52554-d469-4799-9fad-1705e86a08b1"
9952	wsmap="managed"
9953	>
9954	<desc>
9955	The IMediumFormat interface represents a medium format.
9956
9957	Each medium format has an associated backend which is used to handle
9958	media stored in this format. This interface provides information
9959	about the properties of the associated backend.
9960
9961	Each medium format is identified by a string represented by the
9962	<link to="#id"/> attribute. This string is used in calls like
9963	<link to="IVirtualBox::createHardDisk"/> to specify the desired
9964	format.
9965
9966	The list of all supported medium formats can be obtained using
9967	<link to="ISystemProperties::mediumFormats"/>.
9968
9969	<see>IMedium</see>
9970	</desc>
9971
9972	<attribute name="id" type="wstring" readonly="yes">
9973	<desc>
9974	Identifier of this format.
9975
9976	The format identifier is a non-@c null non-empty ASCII string. Note that
9977	this string is case-insensitive. This means that, for example, all of
9978	the following strings:
9979	<pre>
9980	"VDI"
9981	"vdi"
9982	"VdI"</pre>
9983	refer to the same medium format.
9984
9985	This string is used in methods of other interfaces where it is necessary
9986	to specify a medium format, such as
9987	<link to="IVirtualBox::createHardDisk"/>.
9988	</desc>
9989	</attribute>
9990
9991	<attribute name="name" type="wstring" readonly="yes">
9992	<desc>
9993	Human readable description of this format.
9994
9995	Mainly for use in file open dialogs.
9996	</desc>
9997	</attribute>
9998
9999	<attribute name="fileExtensions" type="wstring" safearray="yes" readonly="yes">
10000	<desc>
10001	Array of strings containing the supported file extensions.
10002
10003	The first extension in the array is the extension preferred by the
10004	backend. It is recommended to use this extension when specifying a
10005	location of the storage unit for a new medium.
10006
10007	Note that some backends do not work on files, so this array may be
10008	empty.
10009
10010	<see>IMediumFormat::capabilities</see>
10011	</desc>
10012	</attribute>
10013
10014	<attribute name="capabilities" type="unsigned long" readonly="yes">
10015	<desc>
10016	Capabilities of the format as a set of bit flags.
10017
10018	For the meaning of individual capability flags see
10019	<link to="MediumFormatCapabilities"/>.
10020	</desc>
10021	</attribute>
10022
10023	<method name="describeProperties">
10024	<desc>
10025	Returns several arrays describing the properties supported by this
10026	format.
10027
10028	An element with the given index in each array describes one
10029	property. Thus, the number of elements in each returned array is the
10030	same and corresponds to the number of supported properties.
10031
10032	The returned arrays are filled in only if the
10033	<link to="MediumFormatCapabilities::Properties"/> flag is set.
10034	All arguments must be non-@c null.
10035
10036	<see>DataType</see>
10037	<see>DataFlags</see>
10038	</desc>
10039
10040	<param name="names" type="wstring" safearray="yes" dir="out">
10041	<desc>Array of property names.</desc>
10042	</param>
10043	<param name="description" type="wstring" safearray="yes" dir="out">
10044	<desc>Array of property descriptions.</desc>
10045	</param>
10046	<param name="types" type="DataType" safearray="yes" dir="out">
10047	<desc>Array of property types.</desc>
10048	</param>
10049	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10050	<desc>Array of property flags.</desc>
10051	</param>
10052	<param name="defaults" type="wstring" safearray="yes" dir="out">
10053	<desc>Array of default property values.</desc>
10054	</param>
10055	</method>
10056
10057	</interface>
10058
10059
10060	<!--
10061	// IKeyboard
10062	/////////////////////////////////////////////////////////////////////////
10063	-->
10064
10065	<interface
10066	name="IKeyboard" extends="$unknown"
10067	uuid="2d1a531b-4c6e-49cc-8af6-5c857b78b5d7"
10068	wsmap="managed"
10069	>
10070	<desc>
10071	The IKeyboard interface represents the virtual machine's keyboard. Used
10072	in <link to="IConsole::keyboard"/>.
10073
10074	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10075	to the virtual machine.
10076
10077	</desc>
10078	<method name="putScancode">
10079	<desc>Sends a scancode to the keyboard.
10080
10081	<result name="VBOX_E_IPRT_ERROR">
10082	Could not send scan code to virtual keyboard.
10083	</result>
10084
10085	</desc>
10086	<param name="scancode" type="long" dir="in"/>
10087	</method>
10088
10089	<method name="putScancodes">
10090	<desc>Sends an array of scancodes to the keyboard.
10091
10092	<result name="VBOX_E_IPRT_ERROR">
10093	Could not send all scan codes to virtual keyboard.
10094	</result>
10095
10096	</desc>
10097	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10098	<param name="codesStored" type="unsigned long" dir="return"/>
10099	</method>
10100
10101	<method name="putCAD">
10102	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10103	function is nothing special, it is just a convenience function
10104	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10105
10106	<result name="VBOX_E_IPRT_ERROR">
10107	Could not send all scan codes to virtual keyboard.
10108	</result>
10109
10110	</desc>
10111	</method>
10112
10113	</interface>
10114
10115
10116	<!--
10117	// IMouse
10118	/////////////////////////////////////////////////////////////////////////
10119	-->
10120
10121	<enum
10122	name="MouseButtonState"
10123	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10124	>
10125	<desc>
10126	Mouse button state.
10127	</desc>
10128
10129	<const name="LeftButton" value="0x01"/>
10130	<const name="RightButton" value="0x02"/>
10131	<const name="MiddleButton" value="0x04"/>
10132	<const name="WheelUp" value="0x08"/>
10133	<const name="WheelDown" value="0x10"/>
10134	<const name="XButton1" value="0x20"/>
10135	<const name="XButton2" value="0x40"/>
10136	<const name="MouseStateMask" value="0x7F"/>
10137	</enum>
10138
10139	<interface
10140	name="IMouse" extends="$unknown"
10141	uuid="7c0f2eae-f92d-498c-b802-e1a3763774dc"
10142	wsmap="managed"
10143	>
10144	<desc>
10145	The IMouse interface represents the virtual machine's mouse. Used in
10146	<link to="IConsole::mouse"/>.
10147
10148	Through this interface, the virtual machine's virtual mouse can be
10149	controlled.
10150	</desc>
10151
10152	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10153	<desc>
10154	Whether the guest OS supports absolute mouse pointer positioning
10155	or not.
10156	<note>
10157	You can use the <link to="IMouseCapabilityChangedEvent"/>
10158	event to be instantly informed about changes of this attribute
10159	during virtual machine execution.
10160	</note>
10161	<see><link to="#putMouseEventAbsolute"/></see>
10162	</desc>
10163	</attribute>
10164
10165	<attribute name="relativeSupported" type="boolean" readonly="yes">
10166	<desc>
10167	Whether the guest OS supports relative mouse pointer positioning
10168	or not.
10169	<note>
10170	You can use the <link to="IMouseCapabilityChangedEvent"/>
10171	event to be instantly informed about changes of this attribute
10172	during virtual machine execution.
10173	</note>
10174	<see><link to="#putMouseEvent"/></see>
10175	</desc>
10176	</attribute>
10177
10178	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10179	<desc>
10180	Whether the guest OS can currently switch to drawing it's own mouse
10181	cursor on demand.
10182	<note>
10183	You can use the <link to="IMouseCapabilityChangedEvent"/>
10184	event to be instantly informed about changes of this attribute
10185	during virtual machine execution.
10186	</note>
10187	<see><link to="#putMouseEvent"/></see>
10188	</desc>
10189	</attribute>
10190
10191	<method name="putMouseEvent">
10192	<desc>
10193	Initiates a mouse event using relative pointer movements
10194	along x and y axis.
10195
10196	<result name="E_ACCESSDENIED">
10197	Console not powered up.
10198	</result>
10199	<result name="VBOX_E_IPRT_ERROR">
10200	Could not send mouse event to virtual mouse.
10201	</result>
10202
10203	</desc>
10204
10205	<param name="dx" type="long" dir="in">
10206	<desc>
10207	Amount of pixels the mouse should move to the right.
10208	Negative values move the mouse to the left.
10209	</desc>
10210	</param>
10211	<param name="dy" type="long" dir="in">
10212	<desc>
10213	Amount of pixels the mouse should move downwards.
10214	Negative values move the mouse upwards.
10215	</desc>
10216	</param>
10217	<param name="dz" type="long" dir="in">
10218	<desc>
10219	Amount of mouse wheel moves.
10220	Positive values describe clockwise wheel rotations,
10221	negative values describe counterclockwise rotations.
10222	</desc>
10223	</param>
10224	<param name="dw" type="long" dir="in">
10225	<desc>
10226	Amount of horizontal mouse wheel moves.
10227	Positive values describe a movement to the left,
10228	negative values describe a movement to the right.
10229	</desc>
10230	</param>
10231	<param name="buttonState" type="long" dir="in">
10232	<desc>
10233	The current state of mouse buttons. Every bit represents
10234	a mouse button as follows:
10235	<table>
10236	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10237	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10238	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10239	</table>
10240	A value of <tt>1</tt> means the corresponding button is pressed.
10241	otherwise it is released.
10242	</desc>
10243	</param>
10244	</method>
10245
10246	<method name="putMouseEventAbsolute">
10247	<desc>
10248	Positions the mouse pointer using absolute x and y coordinates.
10249	These coordinates are expressed in pixels and
10250	start from <tt>[1,1]</tt> which corresponds to the top left
10251	corner of the virtual display.
10252
10253	<result name="E_ACCESSDENIED">
10254	Console not powered up.
10255	</result>
10256	<result name="VBOX_E_IPRT_ERROR">
10257	Could not send mouse event to virtual mouse.
10258	</result>
10259
10260	<note>
10261	This method will have effect only if absolute mouse
10262	positioning is supported by the guest OS.
10263	</note>
10264
10265	<see><link to="#absoluteSupported"/></see>
10266	</desc>
10267
10268	<param name="x" type="long" dir="in">
10269	<desc>
10270	X coordinate of the pointer in pixels, starting from @c 1.
10271	</desc>
10272	</param>
10273	<param name="y" type="long" dir="in">
10274	<desc>
10275	Y coordinate of the pointer in pixels, starting from @c 1.
10276	</desc>
10277	</param>
10278	<param name="dz" type="long" dir="in">
10279	<desc>
10280	Amount of mouse wheel moves.
10281	Positive values describe clockwise wheel rotations,
10282	negative values describe counterclockwise rotations.
10283	</desc>
10284	</param>
10285	<param name="dw" type="long" dir="in">
10286	<desc>
10287	Amount of horizontal mouse wheel moves.
10288	Positive values describe a movement to the left,
10289	negative values describe a movement to the right.
10290	</desc>
10291	</param>
10292	<param name="buttonState" type="long" dir="in">
10293	<desc>
10294	The current state of mouse buttons. Every bit represents
10295	a mouse button as follows:
10296	<table>
10297	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10298	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10299	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10300	</table>
10301	A value of @c 1 means the corresponding button is pressed.
10302	otherwise it is released.
10303	</desc>
10304	</param>
10305	</method>
10306
10307	</interface>
10308
10309	<!--
10310	// IDisplay
10311	/////////////////////////////////////////////////////////////////////////
10312	-->
10313
10314	<enum
10315	name="FramebufferPixelFormat"
10316	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10317	>
10318	<desc>
10319	Format of the video memory buffer. Constants represented by this enum can
10320	be used to test for particular values of <link
10321	to="IFramebuffer::pixelFormat"/>. See also <link
10322	to="IFramebuffer::requestResize"/>.
10323
10324	See also www.fourcc.org for more information about FOURCC pixel formats.
10325	</desc>
10326
10327	<const name="Opaque" value="0">
10328	<desc>
10329	Unknown buffer format (the user may not assume any particular format of
10330	the buffer).
10331	</desc>
10332	</const>
10333	<const name="FOURCC_RGB" value="0x32424752">
10334	<desc>
10335	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10336	bit layout).
10337	</desc>
10338	</const>
10339	</enum>
10340
10341	<interface
10342	name="IFramebuffer" extends="$unknown"
10343	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10344	wsmap="suppress"
10345	>
10346	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10347	<desc>Address of the start byte of the frame buffer.</desc>
10348	</attribute>
10349
10350	<attribute name="width" type="unsigned long" readonly="yes">
10351	<desc>Frame buffer width, in pixels.</desc>
10352	</attribute>
10353
10354	<attribute name="height" type="unsigned long" readonly="yes">
10355	<desc>Frame buffer height, in pixels.</desc>
10356	</attribute>
10357
10358	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10359	<desc>
10360	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10361	to="FramebufferPixelFormat::FOURCC_RGB">FOURCC_RGB</link>, valid values
10362	are: 8, 15, 16, 24 and 32.
10363	</desc>
10364	</attribute>
10365
10366	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10367	<desc>
10368	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10369	to="FramebufferPixelFormat::FOURCC_RGB">FOURCC_RGB</link>, the
10370	size of the scan line must be aligned to 32 bits.
10371	</desc>
10372	</attribute>
10373
10374	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10375	<desc>
10376	Frame buffer pixel format. It's either one of the values defined by <link
10377	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10378	<note>
10379	This attribute must never return <link
10380	to="FramebufferPixelFormat::Opaque"/> -- the format of the buffer
10381	<link to="#address"/> points to must be always known.
10382	</note>
10383	</desc>
10384	</attribute>
10385
10386	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10387	<desc>
10388	Defines whether this frame buffer uses the virtual video card's memory
10389	buffer (guest VRAM) directly or not. See <link
10390	to="IFramebuffer::requestResize"/> for more information.
10391	</desc>
10392	</attribute>
10393
10394	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10395	<desc>
10396	Hint from the frame buffer about how much of the standard
10397	screen height it wants to use for itself. This information is
10398	exposed to the guest through the VESA BIOS and VMMDev interface
10399	so that it can use it for determining its video mode table. It
10400	is not guaranteed that the guest respects the value.
10401	</desc>
10402	</attribute>
10403
10404	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10405	<desc>
10406	An alpha-blended overlay which is superposed over the frame buffer.
10407	The initial purpose is to allow the display of icons providing
10408	information about the VM state, including disk activity, in front
10409	ends which do not have other means of doing that. The overlay is
10410	designed to controlled exclusively by IDisplay. It has no locking
10411	of its own, and any changes made to it are not guaranteed to be
10412	visible until the affected portion of IFramebuffer is updated. The
10413	overlay can be created lazily the first time it is requested. This
10414	attribute can also return @c null to signal that the overlay is not
10415	implemented.
10416	</desc>
10417	</attribute>
10418
10419	<attribute name="winId" type="long long" readonly="yes">
10420	<desc>
10421	Platform-dependent identifier of the window where context of this
10422	frame buffer is drawn, or zero if there's no such window.
10423	</desc>
10424	</attribute>
10425
10426	<method name="lock">
10427	<desc>
10428	Locks the frame buffer.
10429	Gets called by the IDisplay object where this frame buffer is
10430	bound to.
10431	</desc>
10432	</method>
10433
10434	<method name="unlock">
10435	<desc>
10436	Unlocks the frame buffer.
10437	Gets called by the IDisplay object where this frame buffer is
10438	bound to.
10439	</desc>
10440	</method>
10441
10442	<method name="notifyUpdate">
10443	<desc>
10444	Informs about an update.
10445	Gets called by the display object where this buffer is
10446	registered.
10447	</desc>
10448	<param name="x" type="unsigned long" dir="in"/>
10449	<param name="y" type="unsigned long" dir="in"/>
10450	<param name="width" type="unsigned long" dir="in"/>
10451	<param name="height" type="unsigned long" dir="in"/>
10452	</method>
10453
10454	<method name="requestResize">
10455	<desc>
10456	Requests a size and pixel format change.
10457
10458	There are two modes of working with the video buffer of the virtual
10459	machine. The <i>indirect</i> mode implies that the IFramebuffer
10460	implementation allocates a memory buffer for the requested display mode
10461	and provides it to the virtual machine. In <i>direct</i> mode, the
10462	IFramebuffer implementation uses the memory buffer allocated and owned
10463	by the virtual machine. This buffer represents the video memory of the
10464	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10465	usually faster because the implementation gets a raw pointer to the
10466	guest VRAM buffer which it can directly use for visualizing the contents
10467	of the virtual display, as opposed to the indirect mode where the
10468	contents of guest VRAM are copied to the memory buffer provided by
10469	the implementation every time a display update occurs.
10470
10471	It is important to note that the direct mode is really fast only when
10472	the implementation uses the given guest VRAM buffer directly, for
10473	example, by blitting it to the window representing the virtual machine's
10474	display, which saves at least one copy operation comparing to the
10475	indirect mode. However, using the guest VRAM buffer directly is not
10476	always possible: the format and the color depth of this buffer may be
10477	not supported by the target window, or it may be unknown (opaque) as in
10478	case of text or non-linear multi-plane VGA video modes. In this case,
10479	the indirect mode (that is always available) should be used as a
10480	fallback: when the guest VRAM contents are copied to the
10481	implementation-provided memory buffer, color and format conversion is
10482	done automatically by the underlying code.
10483
10484	The @a pixelFormat parameter defines whether the direct mode is
10485	available or not. If @a pixelFormat is <link
10486	to="FramebufferPixelFormat::Opaque"/> then direct access to the guest
10487	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10488	@a bytesPerLine parameters must be ignored and the implementation must use
10489	the indirect mode (where it provides its own buffer in one of the
10490	supported formats). In all other cases, @a pixelFormat together with
10491	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10492	buffer pointed to by the @a VRAM parameter and the implementation is
10493	free to choose which mode to use. To indicate that this frame buffer uses
10494	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10495	attribute must return @c true and <link to="#address"/> must
10496	return exactly the same address that is passed in the @a VRAM parameter
10497	of this method; otherwise it is assumed that the indirect strategy is
10498	chosen.
10499
10500	The @a width and @a height parameters represent the size of the
10501	requested display mode in both modes. In case of indirect mode, the
10502	provided memory buffer should be big enough to store data of the given
10503	display mode. In case of direct mode, it is guaranteed that the given
10504	@a VRAM buffer contains enough space to represent the display mode of the
10505	given size. Note that this frame buffer's <link to="#width"/> and <link
10506	to="#height"/> attributes must return exactly the same values as
10507	passed to this method after the resize is completed (see below).
10508
10509	The @a finished output parameter determines if the implementation has
10510	finished resizing the frame buffer or not. If, for some reason, the
10511	resize cannot be finished immediately during this call, @a finished
10512	must be set to @c false, and the implementation must call
10513	<link to="IDisplay::resizeCompleted"/> after it has returned from
10514	this method as soon as possible. If @a finished is @c false, the
10515	machine will not call any frame buffer methods until
10516	<link to="IDisplay::resizeCompleted"/> is called.
10517
10518	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10519	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10520	this frame buffer must return exactly the same values as specified in the
10521	parameters of this method, after the resize is completed. If the
10522	indirect mode is chosen, these attributes must return values describing
10523	the format of the implementation's own memory buffer <link
10524	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10525	value must always correlate with <link to="#pixelFormat"/>. Note that
10526	the <link to="#pixelFormat"/> attribute must never return <link
10527	to="FramebufferPixelFormat::Opaque"/> regardless of the selected mode.
10528
10529	<note>
10530	This method is called by the IDisplay object under the
10531	<link to="#lock"/> provided by this IFramebuffer
10532	implementation. If this method returns @c false in @a finished, then
10533	this lock is not released until
10534	<link to="IDisplay::resizeCompleted"/> is called.
10535	</note>
10536	</desc>
10537	<param name="screenId" type="unsigned long" dir="in">
10538	<desc>
10539	Logical screen number. Must be used in the corresponding call to
10540	<link to="IDisplay::resizeCompleted"/> if this call is made.
10541	</desc>
10542	</param>
10543	<param name="pixelFormat" type="unsigned long" dir="in">
10544	<desc>
10545	Pixel format of the memory buffer pointed to by @a VRAM.
10546	See also <link to="FramebufferPixelFormat"/>.
10547	</desc>
10548	</param>
10549	<param name="VRAM" type="octet" mod="ptr" dir="in">
10550	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10551	</param>
10552	<param name="bitsPerPixel" type="unsigned long" dir="in">
10553	<desc>Color depth, bits per pixel.</desc>
10554	</param>
10555	<param name="bytesPerLine" type="unsigned long" dir="in">
10556	<desc>Size of one scan line, in bytes.</desc>
10557	</param>
10558	<param name="width" type="unsigned long" dir="in">
10559	<desc>Width of the guest display, in pixels.</desc>
10560	</param>
10561	<param name="height" type="unsigned long" dir="in">
10562	<desc>Height of the guest display, in pixels.</desc>
10563	</param>
10564	<param name="finished" type="boolean" dir="return">
10565	<desc>
10566	Can the VM start using the new frame buffer immediately
10567	after this method returns or it should wait for
10568	<link to="IDisplay::resizeCompleted"/>.
10569	</desc>
10570	</param>
10571	</method>
10572
10573	<method name="videoModeSupported">
10574	<desc>
10575	Returns whether the frame buffer implementation is willing to
10576	support a given video mode. In case it is not able to render
10577	the video mode (or for some reason not willing), it should
10578	return @c false. Usually this method is called when the guest
10579	asks the VMM device whether a given video mode is supported
10580	so the information returned is directly exposed to the guest.
10581	It is important that this method returns very quickly.
10582	</desc>
10583	<param name="width" type="unsigned long" dir="in"/>
10584	<param name="height" type="unsigned long" dir="in"/>
10585	<param name="bpp" type="unsigned long" dir="in"/>
10586	<param name="supported" type="boolean" dir="return"/>
10587	</method>
10588
10589	<method name="getVisibleRegion">
10590	<desc>
10591	Returns the visible region of this frame buffer.
10592
10593	If the @a rectangles parameter is @c null then the value of the
10594	@a count parameter is ignored and the number of elements necessary to
10595	describe the current visible region is returned in @a countCopied.
10596
10597	If @a rectangles is not @c null but @a count is less
10598	than the required number of elements to store region data, the method
10599	will report a failure. If @a count is equal or greater than the
10600	required number of elements, then the actual number of elements copied
10601	to the provided array will be returned in @a countCopied.
10602
10603	<note>
10604	The address of the provided array must be in the process space of
10605	this IFramebuffer object.
10606	</note>
10607	<note>
10608	Method not yet implemented.
10609	</note>
10610	</desc>
10611	<param name="rectangles" type="octet" mod="ptr" dir="in">
10612	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10613	</param>
10614	<param name="count" type="unsigned long" dir="in">
10615	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10616	</param>
10617	<param name="countCopied" type="unsigned long" dir="return">
10618	<desc>Number of elements copied to the @a rectangles array.</desc>
10619	</param>
10620	</method>
10621
10622	<method name="setVisibleRegion">
10623	<desc>
10624	Suggests a new visible region to this frame buffer. This region
10625	represents the area of the VM display which is a union of regions of
10626	all top-level windows of the guest operating system running inside the
10627	VM (if the Guest Additions for this system support this
10628	functionality). This information may be used by the frontends to
10629	implement the seamless desktop integration feature.
10630
10631	<note>
10632	The address of the provided array must be in the process space of
10633	this IFramebuffer object.
10634	</note>
10635	<note>
10636	The IFramebuffer implementation must make a copy of the provided
10637	array of rectangles.
10638	</note>
10639	<note>
10640	Method not yet implemented.
10641	</note>
10642	</desc>
10643	<param name="rectangles" type="octet" mod="ptr" dir="in">
10644	<desc>Pointer to the @c RTRECT array.</desc>
10645	</param>
10646	<param name="count" type="unsigned long" dir="in">
10647	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10648	</param>
10649	</method>
10650
10651	<method name="processVHWACommand">
10652	<desc>
10653	Posts a Video HW Acceleration Command to the frame buffer for processing.
10654	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10655	are posted from quest to the host to be processed by the host hardware.
10656
10657	<note>
10658	The address of the provided command must be in the process space of
10659	this IFramebuffer object.
10660	</note>
10661	</desc>
10662
10663	<param name="command" type="octet" mod="ptr" dir="in">
10664	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10665	</param>
10666	</method>
10667
10668	</interface>
10669
10670	<interface
10671	name="IFramebufferOverlay" extends="IFramebuffer"
10672	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10673	wsmap="suppress"
10674	>
10675	<desc>
10676	The IFramebufferOverlay interface represents an alpha blended overlay
10677	for displaying status icons above an IFramebuffer. It is always created
10678	not visible, so that it must be explicitly shown. It only covers a
10679	portion of the IFramebuffer, determined by its width, height and
10680	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10681	that order) format, and may be written to directly. Do re-read the
10682	width though, after setting it, as it may be adjusted (increased) to
10683	make it more suitable for the front end.
10684	</desc>
10685	<attribute name="x" type="unsigned long" readonly="yes">
10686	<desc>X position of the overlay, relative to the frame buffer.</desc>
10687	</attribute>
10688
10689	<attribute name="y" type="unsigned long" readonly="yes">
10690	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10691	</attribute>
10692
10693	<attribute name="visible" type="boolean" readonly="no">
10694	<desc>
10695	Whether the overlay is currently visible.
10696	</desc>
10697	</attribute>
10698
10699	<attribute name="alpha" type="unsigned long" readonly="no">
10700	<desc>
10701	The global alpha value for the overlay. This may or may not be
10702	supported by a given front end.
10703	</desc>
10704	</attribute>
10705
10706	<method name="move">
10707	<desc>
10708	Changes the overlay's position relative to the IFramebuffer.
10709	</desc>
10710	<param name="x" type="unsigned long" dir="in"/>
10711	<param name="y" type="unsigned long" dir="in"/>
10712	</method>
10713
10714	</interface>
10715
10716	<interface
10717	name="IDisplay" extends="$unknown"
10718	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
10719	wsmap="managed"
10720	>
10721	<desc>
10722	The IDisplay interface represents the virtual machine's display.
10723
10724	The object implementing this interface is contained in each
10725	<link to="IConsole::display"/> attribute and represents the visual
10726	output of the virtual machine.
10727
10728	The virtual display supports pluggable output targets represented by the
10729	IFramebuffer interface. Examples of the output target are a window on
10730	the host computer or an RDP session's display on a remote computer.
10731	</desc>
10732	<method name="getScreenResolution">
10733	<desc>Queries display width, height and color depth for given screen.</desc>
10734	<param name="screenId" type="unsigned long" dir="in"/>
10735	<param name="width" type="unsigned long" dir="out"/>
10736	<param name="height" type="unsigned long" dir="out"/>
10737	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
10738	</method>
10739
10740	<method name="setFramebuffer">
10741	<desc>
10742	Sets the framebuffer for given screen.
10743	</desc>
10744	<param name="screenId" type="unsigned long" dir="in"/>
10745	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10746	</method>
10747
10748	<method name="getFramebuffer">
10749	<desc>
10750	Queries the framebuffer for given screen.
10751	</desc>
10752	<param name="screenId" type="unsigned long" dir="in"/>
10753	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10754	<param name="xOrigin" type="long" dir="out"/>
10755	<param name="yOrigin" type="long" dir="out"/>
10756	</method>
10757
10758	<method name="setVideoModeHint">
10759	<desc>
10760	Asks VirtualBox to request the given video mode from
10761	the guest. This is just a hint and it cannot be guaranteed
10762	that the requested resolution will be used. Guest Additions
10763	are required for the request to be seen by guests. The caller
10764	should issue the request and wait for a resolution change and
10765	after a timeout retry.
10766
10767	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10768	parameters means that the corresponding values should be taken from the
10769	current video mode (i.e. left unchanged).
10770
10771	If the guest OS supports multi-monitor configuration then the @a display
10772	parameter specifies the number of the guest display to send the hint to:
10773	@c 0 is the primary display, @c 1 is the first secondary and
10774	so on. If the multi-monitor configuration is not supported, @a display
10775	must be @c 0.
10776
10777	<result name="E_INVALIDARG">
10778	The @a display is not associated with any monitor.
10779	</result>
10780
10781	</desc>
10782	<param name="width" type="unsigned long" dir="in"/>
10783	<param name="height" type="unsigned long" dir="in"/>
10784	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
10785	<param name="display" type="unsigned long" dir="in"/>
10786	</method>
10787
10788	<method name="setSeamlessMode">
10789	<desc>
10790	Enables or disables seamless guest display rendering (seamless desktop
10791	integration) mode.
10792	<note>
10793	Calling this method has no effect if <link
10794	to="IGuest::supportsSeamless"/> returns @c false.
10795	</note>
10796	</desc>
10797	<param name="enabled" type="boolean" dir="in"/>
10798	</method>
10799
10800	<method name="takeScreenShot">
10801	<desc>
10802	Takes a screen shot of the requested size and copies it to the
10803	32-bpp buffer allocated by the caller and pointed to by @a address.
10804	A pixel consists of 4 bytes in order: B, G, R, 0.
10805
10806	<note>This API can be used only by the COM/XPCOM C++ API as it
10807	requires pointer support. Use <link to="#takeScreenShotToArray" />
10808	with other language bindings.
10809	</note>
10810
10811	<result name="E_NOTIMPL">
10812	Feature not implemented.
10813	</result>
10814	<result name="VBOX_E_IPRT_ERROR">
10815	Could not take a screenshot.
10816	</result>
10817
10818	</desc>
10819	<param name="screenId" type="unsigned long" dir="in"/>
10820	<param name="address" type="octet" mod="ptr" dir="in"/>
10821	<param name="width" type="unsigned long" dir="in"/>
10822	<param name="height" type="unsigned long" dir="in"/>
10823	</method>
10824
10825	<method name="takeScreenShotToArray">
10826	<desc>
10827	Takes a guest screen shot of the requested size and returns it as
10828	an array of bytes in uncompressed 32-bit RGBA format.
10829	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
10830
10831	This API is slow, but could be the only option to get guest screenshot
10832	for scriptable languages not allowed to manipulate with addresses
10833	directly.
10834
10835	<result name="E_NOTIMPL">
10836	Feature not implemented.
10837	</result>
10838	<result name="VBOX_E_IPRT_ERROR">
10839	Could not take a screenshot.
10840	</result>
10841	</desc>
10842	<param name="screenId" type="unsigned long" dir="in">
10843	<desc>
10844	Monitor to take screenshot from.
10845	</desc>
10846	</param>
10847	<param name="width" type="unsigned long" dir="in">
10848	<desc>
10849	Desired image width.
10850	</desc>
10851	</param>
10852	<param name="height" type="unsigned long" dir="in">
10853	<desc>
10854	Desired image height.
10855	</desc>
10856	</param>
10857	<param name="screenData" type="octet" dir="return" safearray="yes">
10858	<desc>
10859	Array with resulting screen data.
10860	</desc>
10861	</param>
10862	</method>
10863
10864	<method name="takeScreenShotPNGToArray">
10865	<desc>
10866	Takes a guest screen shot of the requested size and returns it as
10867	PNG image in array.
10868
10869	<result name="E_NOTIMPL">
10870	Feature not implemented.
10871	</result>
10872	<result name="VBOX_E_IPRT_ERROR">
10873	Could not take a screenshot.
10874	</result>
10875	</desc>
10876	<param name="screenId" type="unsigned long" dir="in">
10877	<desc>
10878	Monitor to take screenshot from.
10879	</desc>
10880	</param>
10881	<param name="width" type="unsigned long" dir="in">
10882	<desc>
10883	Desired image width.
10884	</desc>
10885	</param>
10886	<param name="height" type="unsigned long" dir="in">
10887	<desc>
10888	Desired image height.
10889	</desc>
10890	</param>
10891	<param name="screenData" type="octet" dir="return" safearray="yes">
10892	<desc>
10893	Array with resulting screen data.
10894	</desc>
10895	</param>
10896	</method>
10897
10898	<method name="drawToScreen">
10899	<desc>
10900	Draws a 32-bpp image of the specified size from the given buffer
10901	to the given point on the VM display.
10902
10903	<result name="E_NOTIMPL">
10904	Feature not implemented.
10905	</result>
10906	<result name="VBOX_E_IPRT_ERROR">
10907	Could not draw to screen.
10908	</result>
10909
10910	</desc>
10911	<param name="screenId" type="unsigned long" dir="in"/>
10912	<param name="address" type="octet" mod="ptr" dir="in"/>
10913	<param name="x" type="unsigned long" dir="in">
10914	<desc>Relative to the screen top left corner.</desc>
10915	</param>
10916	<param name="y" type="unsigned long" dir="in">
10917	<desc>Relative to the screen top left corner.</desc>
10918	</param>
10919	<param name="width" type="unsigned long" dir="in"/>
10920	<param name="height" type="unsigned long" dir="in"/>
10921	</method>
10922
10923	<method name="invalidateAndUpdate">
10924	<desc>
10925	Does a full invalidation of the VM display and instructs the VM
10926	to update it.
10927
10928	<result name="VBOX_E_IPRT_ERROR">
10929	Could not invalidate and update screen.
10930	</result>
10931
10932	</desc>
10933	</method>
10934
10935	<method name="resizeCompleted">
10936	<desc>
10937	Signals that a framebuffer has completed the resize operation.
10938
10939	<result name="VBOX_E_NOT_SUPPORTED">
10940	Operation only valid for external frame buffers.
10941	</result>
10942
10943	</desc>
10944	<param name="screenId" type="unsigned long" dir="in"/>
10945	</method>
10946
10947	<method name="completeVHWACommand">
10948	<desc>
10949	Signals that the Video HW Acceleration command has completed.
10950	</desc>
10951
10952	<param name="command" type="octet" mod="ptr" dir="in">
10953	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
10954	</param>
10955	</method>
10956
10957	</interface>
10958
10959	<!--
10960	// INetworkAdapter
10961	/////////////////////////////////////////////////////////////////////////
10962	-->
10963
10964	<enum
10965	name="NetworkAttachmentType"
10966	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
10967	>
10968	<desc>
10969	Network attachment type.
10970	</desc>
10971
10972	<const name="Null" value="0">
10973	<desc>Null value, also means "not attached".</desc>
10974	</const>
10975	<const name="NAT" value="1"/>
10976	<const name="Bridged" value="2"/>
10977	<const name="Internal" value="3"/>
10978	<const name="HostOnly" value="4"/>
10979	<const name="VDE" value="5"/>
10980	</enum>
10981
10982	<enum
10983	name="NetworkAdapterType"
10984	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
10985	>
10986	<desc>
10987	Network adapter type.
10988	</desc>
10989
10990	<const name="Null" value="0">
10991	<desc>Null value (never used by the API).</desc>
10992	</const>
10993	<const name="Am79C970A" value="1">
10994	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
10995	</const>
10996	<const name="Am79C973" value="2">
10997	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
10998	</const>
10999	<const name="I82540EM" value="3">
11000	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11001	</const>
11002	<const name="I82543GC" value="4">
11003	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11004	</const>
11005	<const name="I82545EM" value="5">
11006	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11007	</const>
11008	<const name="Virtio" value="6">
11009	<desc>Virtio network device.</desc>
11010	</const>
11011	</enum>
11012
11013	<interface
11014	name="INetworkAdapter" extends="$unknown"
11015	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11016	wsmap="managed"
11017	>
11018	<desc>
11019	Represents a virtual network adapter that is attached to a virtual machine.
11020	Each virtual machine has a fixed number of network adapter slots with one
11021	instance of this attached to each of them. Call
11022	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11023	is attached to a given slot in a given machine.
11024
11025	Each network adapter can be in one of five attachment modes, which are
11026	represented by the <link to="NetworkAttachmentType" /> enumeration;
11027	see the <link to="#attachmentType" /> attribute.
11028	</desc>
11029
11030	<attribute name="adapterType" type="NetworkAdapterType">
11031	<desc>
11032	Type of the virtual network adapter. Depending on this value,
11033	VirtualBox will provide a different virtual network hardware
11034	to the guest.
11035	</desc>
11036	</attribute>
11037
11038	<attribute name="slot" type="unsigned long" readonly="yes">
11039	<desc>
11040	Slot number this adapter is plugged into. Corresponds to
11041	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11042	to obtain this instance.
11043	</desc>
11044	</attribute>
11045
11046	<attribute name="enabled" type="boolean">
11047	<desc>
11048	Flag whether the network adapter is present in the
11049	guest system. If disabled, the virtual guest hardware will
11050	not contain this network adapter. Can only be changed when
11051	the VM is not running.
11052	</desc>
11053	</attribute>
11054
11055	<attribute name="MACAddress" type="wstring">
11056	<desc>
11057	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11058	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11059	</desc>
11060	</attribute>
11061
11062	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11063
11064	<attribute name="hostInterface" type="wstring">
11065	<desc>
11066	Name of the host network interface the VM is attached to.
11067	</desc>
11068	</attribute>
11069
11070	<attribute name="internalNetwork" type="wstring">
11071	<desc>
11072	Name of the internal network the VM is attached to.
11073	</desc>
11074	</attribute>
11075
11076	<attribute name="NATNetwork" type="wstring">
11077	<desc>
11078	Name of the NAT network the VM is attached to.
11079	</desc>
11080	</attribute>
11081
11082	<attribute name="VDENetwork" type="wstring">
11083	<desc>
11084	Name of the VDE switch the VM is attached to.
11085	</desc>
11086	</attribute>
11087
11088	<attribute name="cableConnected" type="boolean">
11089	<desc>
11090	Flag whether the adapter reports the cable as connected or not.
11091	It can be used to report offline situations to a VM.
11092	</desc>
11093	</attribute>
11094
11095	<attribute name="lineSpeed" type="unsigned long">
11096	<desc>
11097	Line speed reported by custom drivers, in units of 1 kbps.
11098	</desc>
11099	</attribute>
11100
11101	<attribute name="traceEnabled" type="boolean">
11102	<desc>
11103	Flag whether network traffic from/to the network card should be traced.
11104	Can only be toggled when the VM is turned off.
11105	</desc>
11106	</attribute>
11107
11108	<attribute name="traceFile" type="wstring">
11109	<desc>
11110	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11111	will be used.
11112	</desc>
11113	</attribute>
11114
11115	<attribute name="natDriver" type="INATEngine" readonly="yes">
11116	<desc>
11117	Points to the NAT engine which handles the network address translation
11118	for this interface. This is active only when the interface actually uses
11119	NAT (see <link to="#attachToNAT" />).
11120	</desc>
11121	</attribute>
11122
11123	<attribute name="bootPriority" type="unsigned long">
11124	<desc>
11125	Network boot priority of the adapter. Priority 1 is highest. If not set,
11126	the priority is considered to be at the lowest possible setting.
11127	</desc>
11128	</attribute>
11129
11130	<attribute name="bandwidthLimit" type="unsigned long">
11131	<desc>
11132	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11133	A zero value means uncapped/unlimited.
11134	</desc>
11135	</attribute>
11136
11137	<method name="attachToNAT">
11138	<desc>
11139	Attach the network adapter to the Network Address Translation (NAT) interface.
11140	</desc>
11141	</method>
11142
11143	<method name="attachToBridgedInterface">
11144	<desc>
11145	Attach the network adapter to a bridged host interface.
11146	</desc>
11147	</method>
11148
11149	<method name="attachToInternalNetwork">
11150	<desc>
11151	Attach the network adapter to an internal network.
11152	</desc>
11153	</method>
11154
11155	<method name="attachToHostOnlyInterface">
11156	<desc>
11157	Attach the network adapter to the host-only network.
11158	</desc>
11159	</method>
11160
11161	<method name="attachToVDE">
11162	<desc>
11163	Attach the network adapter to a VDE network.
11164	</desc>
11165	</method>
11166
11167	<method name="detach">
11168	<desc>
11169	Detach the network adapter
11170	</desc>
11171	</method>
11172	</interface>
11173
11174
11175	<!--
11176	// ISerialPort
11177	/////////////////////////////////////////////////////////////////////////
11178	-->
11179
11180	<enum
11181	name="PortMode"
11182	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11183	>
11184	<desc>
11185	The PortMode enumeration represents possible communication modes for
11186	the virtual serial port device.
11187	</desc>
11188
11189	<const name="Disconnected" value="0">
11190	<desc>Virtual device is not attached to any real host device.</desc>
11191	</const>
11192	<const name="HostPipe" value="1">
11193	<desc>Virtual device is attached to a host pipe.</desc>
11194	</const>
11195	<const name="HostDevice" value="2">
11196	<desc>Virtual device is attached to a host device.</desc>
11197	</const>
11198	<const name="RawFile" value="3">
11199	<desc>Virtual device is attached to a raw file.</desc>
11200	</const>
11201	</enum>
11202
11203	<interface
11204	name="ISerialPort" extends="$unknown"
11205	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11206	wsmap="managed"
11207	>
11208
11209	<desc>
11210	The ISerialPort interface represents the virtual serial port device.
11211
11212	The virtual serial port device acts like an ordinary serial port
11213	inside the virtual machine. This device communicates to the real
11214	serial port hardware in one of two modes: host pipe or host device.
11215
11216	In host pipe mode, the #path attribute specifies the path to the pipe on
11217	the host computer that represents a serial port. The #server attribute
11218	determines if this pipe is created by the virtual machine process at
11219	machine startup or it must already exist before starting machine
11220	execution.
11221
11222	In host device mode, the #path attribute specifies the name of the
11223	serial port device on the host computer.
11224
11225	There is also a third communication mode: the disconnected mode. In this
11226	mode, the guest OS running inside the virtual machine will be able to
11227	detect the serial port, but all port write operations will be discarded
11228	and all port read operations will return no data.
11229
11230	<see>IMachine::getSerialPort</see>
11231	</desc>
11232
11233	<attribute name="slot" type="unsigned long" readonly="yes">
11234	<desc>
11235	Slot number this serial port is plugged into. Corresponds to
11236	the value you pass to <link to="IMachine::getSerialPort"/>
11237	to obtain this instance.
11238	</desc>
11239	</attribute>
11240
11241	<attribute name="enabled" type="boolean">
11242	<desc>
11243	Flag whether the serial port is enabled. If disabled,
11244	the serial port will not be reported to the guest OS.
11245	</desc>
11246	</attribute>
11247
11248	<attribute name="IOBase" type="unsigned long">
11249	<desc>Base I/O address of the serial port.</desc>
11250	</attribute>
11251
11252	<attribute name="IRQ" type="unsigned long">
11253	<desc>IRQ number of the serial port.</desc>
11254	</attribute>
11255
11256	<attribute name="hostMode" type="PortMode">
11257	<desc>
11258	How is this port connected to the host.
11259	<note>
11260	Changing this attribute may fail if the conditions for
11261	<link to="#path"/> are not met.
11262	</note>
11263	</desc>
11264	</attribute>
11265
11266	<attribute name="server" type="boolean">
11267	<desc>
11268	Flag whether this serial port acts as a server (creates a new pipe on
11269	the host) or as a client (uses the existing pipe). This attribute is
11270	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11271	</desc>
11272	</attribute>
11273
11274	<attribute name="path" type="wstring">
11275	<desc>
11276	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11277	PortMode_HostPipe, or the host serial device name when
11278	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11279	cases, setting a @c null or empty string as the attribute's value
11280	is an error. Otherwise, the value of this property is ignored.
11281	</desc>
11282	</attribute>
11283
11284	</interface>
11285
11286	<!--
11287	// IParallelPort
11288	/////////////////////////////////////////////////////////////////////////
11289	-->
11290
11291	<interface
11292	name="IParallelPort" extends="$unknown"
11293	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11294	wsmap="managed"
11295	>
11296
11297	<desc>
11298	The IParallelPort interface represents the virtual parallel port device.
11299
11300	The virtual parallel port device acts like an ordinary parallel port
11301	inside the virtual machine. This device communicates to the real
11302	parallel port hardware using the name of the parallel device on the host
11303	computer specified in the #path attribute.
11304
11305	Each virtual parallel port device is assigned a base I/O address and an
11306	IRQ number that will be reported to the guest operating system and used
11307	to operate the given parallel port from within the virtual machine.
11308
11309	<see>IMachine::getParallelPort</see>
11310	</desc>
11311
11312	<attribute name="slot" type="unsigned long" readonly="yes">
11313	<desc>
11314	Slot number this parallel port is plugged into. Corresponds to
11315	the value you pass to <link to="IMachine::getParallelPort"/>
11316	to obtain this instance.
11317	</desc>
11318	</attribute>
11319
11320	<attribute name="enabled" type="boolean">
11321	<desc>
11322	Flag whether the parallel port is enabled. If disabled,
11323	the parallel port will not be reported to the guest OS.
11324	</desc>
11325	</attribute>
11326
11327	<attribute name="IOBase" type="unsigned long">
11328	<desc>Base I/O address of the parallel port.</desc>
11329	</attribute>
11330
11331	<attribute name="IRQ" type="unsigned long">
11332	<desc>IRQ number of the parallel port.</desc>
11333	</attribute>
11334
11335	<attribute name="path" type="wstring">
11336	<desc>
11337	Host parallel device name. If this parallel port is enabled, setting a
11338	@c null or an empty string as this attribute's value will result into
11339	an error.
11340	</desc>
11341	</attribute>
11342
11343	</interface>
11344
11345
11346	<!--
11347	// IMachineDebugger
11348	/////////////////////////////////////////////////////////////////////////
11349	-->
11350
11351	<interface
11352	name="IMachineDebugger" extends="$unknown"
11353	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11354	wsmap="suppress"
11355	>
11356	<method name="resetStats">
11357	<desc>
11358	Reset VM statistics.
11359	</desc>
11360	<param name="pattern" type="wstring" dir="in">
11361	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11362	</param>
11363	</method>
11364
11365	<method name="dumpStats">
11366	<desc>
11367	Dumps VM statistics.
11368	</desc>
11369	<param name="pattern" type="wstring" dir="in">
11370	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11371	</param>
11372	</method>
11373
11374	<method name="getStats">
11375	<desc>
11376	Get the VM statistics in a XMLish format.
11377	</desc>
11378	<param name="pattern" type="wstring" dir="in">
11379	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11380	</param>
11381	<param name="withDescriptions" type="boolean" dir="in">
11382	<desc>Whether to include the descriptions.</desc>
11383	</param>
11384	<param name="stats" type="wstring" dir="out">
11385	<desc>The XML document containing the statistics.</desc>
11386	</param>
11387	</method>
11388
11389	<method name="injectNMI">
11390	<desc>
11391	Inject an NMI into a running VT-x/AMD-V VM.
11392	</desc>
11393	</method>
11394
11395	<attribute name="singlestep" type="boolean">
11396	<desc>Switch for enabling singlestepping.</desc>
11397	</attribute>
11398
11399	<attribute name="recompileUser" type="boolean">
11400	<desc>Switch for forcing code recompilation for user mode code.</desc>
11401	</attribute>
11402
11403	<attribute name="recompileSupervisor" type="boolean">
11404	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11405	</attribute>
11406
11407	<attribute name="PATMEnabled" type="boolean">
11408	<desc>Switch for enabling and disabling the PATM component.</desc>
11409	</attribute>
11410
11411	<attribute name="CSAMEnabled" type="boolean">
11412	<desc>Switch for enabling and disabling the CSAM component.</desc>
11413	</attribute>
11414
11415	<attribute name="logEnabled" type="boolean">
11416	<desc>Switch for enabling and disabling logging.</desc>
11417	</attribute>
11418
11419	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11420	<desc>
11421	Flag indicating whether the VM is currently making use of CPU hardware
11422	virtualization extensions.
11423	</desc>
11424	</attribute>
11425
11426	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11427	<desc>
11428	Flag indicating whether the VM is currently making use of the nested paging
11429	CPU hardware virtualization extension.
11430	</desc>
11431	</attribute>
11432
11433	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11434	<desc>
11435	Flag indicating whether the VM is currently making use of the VPID
11436	VT-x extension.
11437	</desc>
11438	</attribute>
11439
11440	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11441	<desc>
11442	Flag indicating whether the VM is currently making use of the Physical
11443	Address Extension CPU feature.
11444	</desc>
11445	</attribute>
11446
11447	<attribute name="virtualTimeRate" type="unsigned long">
11448	<desc>
11449	The rate at which the virtual time runs expressed as a percentage.
11450	The accepted range is 2% to 20000%.
11451	</desc>
11452	</attribute>
11453
11454	<!-- @todo method for setting log flags, groups and destination! -->
11455
11456	<attribute name="VM" type="long long" readonly="yes">
11457	<desc>
11458	Gets the VM handle. This is only for internal use while
11459	we carve the details of this interface.
11460	</desc>
11461	</attribute>
11462
11463	</interface>
11464
11465	<!--
11466	// IUSBController
11467	/////////////////////////////////////////////////////////////////////////
11468	-->
11469
11470	<interface
11471	name="IUSBController" extends="$unknown"
11472	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11473	wsmap="managed"
11474	>
11475	<attribute name="enabled" type="boolean">
11476	<desc>
11477	Flag whether the USB controller is present in the
11478	guest system. If disabled, the virtual guest hardware will
11479	not contain any USB controller. Can only be changed when
11480	the VM is powered off.
11481	</desc>
11482	</attribute>
11483
11484	<attribute name="enabledEhci" type="boolean">
11485	<desc>
11486	Flag whether the USB EHCI controller is present in the
11487	guest system. If disabled, the virtual guest hardware will
11488	not contain a USB EHCI controller. Can only be changed when
11489	the VM is powered off.
11490	</desc>
11491	</attribute>
11492
11493	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11494	<desc>
11495	Flag whether there is an USB proxy available.
11496	</desc>
11497	</attribute>
11498
11499	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11500	<desc>
11501	USB standard version which the controller implements.
11502	This is a BCD which means that the major version is in the
11503	high byte and minor version is in the low byte.
11504	</desc>
11505	</attribute>
11506
11507	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11508	<desc>
11509	List of USB device filters associated with the machine.
11510
11511	If the machine is currently running, these filters are activated
11512	every time a new (supported) USB device is attached to the host
11513	computer that was not ignored by global filters
11514	(<link to="IHost::USBDeviceFilters"/>).
11515
11516	These filters are also activated when the machine is powered up.
11517	They are run against a list of all currently available USB
11518	devices (in states
11519	<link to="USBDeviceState::Available"/>,
11520	<link to="USBDeviceState::Busy"/>,
11521	<link to="USBDeviceState::Held"/>) that were not previously
11522	ignored by global filters.
11523
11524	If at least one filter matches the USB device in question, this
11525	device is automatically captured (attached to) the virtual USB
11526	controller of this machine.
11527
11528	<see>IUSBDeviceFilter, ::IUSBController</see>
11529	</desc>
11530	</attribute>
11531
11532	<method name="createDeviceFilter">
11533	<desc>
11534	Creates a new USB device filter. All attributes except
11535	the filter name are set to empty (any match),
11536	<i>active</i> is @c false (the filter is not active).
11537
11538	The created filter can then be added to the list of filters using
11539	<link to="#insertDeviceFilter"/>.
11540
11541	<result name="VBOX_E_INVALID_VM_STATE">
11542	The virtual machine is not mutable.
11543	</result>
11544
11545	<see>#deviceFilters</see>
11546	</desc>
11547	<param name="name" type="wstring" dir="in">
11548	<desc>
11549	Filter name. See <link to="IUSBDeviceFilter::name"/>
11550	for more info.
11551	</desc>
11552	</param>
11553	<param name="filter" type="IUSBDeviceFilter" dir="return">
11554	<desc>Created filter object.</desc>
11555	</param>
11556	</method>
11557
11558	<method name="insertDeviceFilter">
11559	<desc>
11560	Inserts the given USB device to the specified position
11561	in the list of filters.
11562
11563	Positions are numbered starting from <tt>0</tt>. If the specified
11564	position is equal to or greater than the number of elements in
11565	the list, the filter is added to the end of the collection.
11566
11567	<note>
11568	Duplicates are not allowed, so an attempt to insert a
11569	filter that is already in the collection, will return an
11570	error.
11571	</note>
11572
11573	<result name="VBOX_E_INVALID_VM_STATE">
11574	Virtual machine is not mutable.
11575	</result>
11576	<result name="E_INVALIDARG">
11577	USB device filter not created within this VirtualBox instance.
11578	</result>
11579	<result name="VBOX_E_INVALID_OBJECT_STATE">
11580	USB device filter already in list.
11581	</result>
11582
11583	<see>#deviceFilters</see>
11584	</desc>
11585	<param name="position" type="unsigned long" dir="in">
11586	<desc>Position to insert the filter to.</desc>
11587	</param>
11588	<param name="filter" type="IUSBDeviceFilter" dir="in">
11589	<desc>USB device filter to insert.</desc>
11590	</param>
11591	</method>
11592
11593	<method name="removeDeviceFilter">
11594	<desc>
11595	Removes a USB device filter from the specified position in the
11596	list of filters.
11597
11598	Positions are numbered starting from <tt>0</tt>. Specifying a
11599	position equal to or greater than the number of elements in
11600	the list will produce an error.
11601
11602	<see>#deviceFilters</see>
11603
11604	<result name="VBOX_E_INVALID_VM_STATE">
11605	Virtual machine is not mutable.
11606	</result>
11607	<result name="E_INVALIDARG">
11608	USB device filter list empty or invalid @a position.
11609	</result>
11610
11611	</desc>
11612	<param name="position" type="unsigned long" dir="in">
11613	<desc>Position to remove the filter from.</desc>
11614	</param>
11615	<param name="filter" type="IUSBDeviceFilter" dir="return">
11616	<desc>Removed USB device filter.</desc>
11617	</param>
11618	</method>
11619
11620	</interface>
11621
11622
11623	<!--
11624	// IUSBDevice
11625	/////////////////////////////////////////////////////////////////////////
11626	-->
11627
11628	<interface
11629	name="IUSBDevice" extends="$unknown"
11630	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11631	wsmap="managed"
11632	>
11633	<desc>
11634	The IUSBDevice interface represents a virtual USB device attached to the
11635	virtual machine.
11636
11637	A collection of objects implementing this interface is stored in the
11638	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11639	attached to a running virtual machine's USB controller.
11640	</desc>
11641
11642	<attribute name="id" type="uuid" mod="string" readonly="yes">
11643	<desc>
11644	Unique USB device ID. This ID is built from #vendorId,
11645	#productId, #revision and #serialNumber.
11646	</desc>
11647	</attribute>
11648
11649	<attribute name="vendorId" type="unsigned short" readonly="yes">
11650	<desc>Vendor ID.</desc>
11651	</attribute>
11652
11653	<attribute name="productId" type="unsigned short" readonly="yes">
11654	<desc>Product ID.</desc>
11655	</attribute>
11656
11657	<attribute name="revision" type="unsigned short" readonly="yes">
11658	<desc>
11659	Product revision number. This is a packed BCD represented as
11660	unsigned short. The high byte is the integer part and the low
11661	byte is the decimal.
11662	</desc>
11663	</attribute>
11664
11665	<attribute name="manufacturer" type="wstring" readonly="yes">
11666	<desc>Manufacturer string.</desc>
11667	</attribute>
11668
11669	<attribute name="product" type="wstring" readonly="yes">
11670	<desc>Product string.</desc>
11671	</attribute>
11672
11673	<attribute name="serialNumber" type="wstring" readonly="yes">
11674	<desc>Serial number string.</desc>
11675	</attribute>
11676
11677	<attribute name="address" type="wstring" readonly="yes">
11678	<desc>Host specific address of the device.</desc>
11679	</attribute>
11680
11681	<attribute name="port" type="unsigned short" readonly="yes">
11682	<desc>
11683	Host USB port number the device is physically
11684	connected to.
11685	</desc>
11686	</attribute>
11687
11688	<attribute name="version" type="unsigned short" readonly="yes">
11689	<desc>
11690	The major USB version of the device - 1 or 2.
11691	</desc>
11692	</attribute>
11693
11694	<attribute name="portVersion" type="unsigned short" readonly="yes">
11695	<desc>
11696	The major USB version of the host USB port the device is
11697	physically connected to - 1 or 2. For devices not connected to
11698	anything this will have the same value as the version attribute.
11699	</desc>
11700	</attribute>
11701
11702	<attribute name="remote" type="boolean" readonly="yes">
11703	<desc>
11704	Whether the device is physically connected to a remote VRDP
11705	client or to a local host machine.
11706	</desc>
11707	</attribute>
11708
11709	</interface>
11710
11711
11712	<!--
11713	// IUSBDeviceFilter
11714	/////////////////////////////////////////////////////////////////////////
11715	-->
11716
11717	<interface
11718	name="IUSBDeviceFilter" extends="$unknown"
11719	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11720	wsmap="managed"
11721	>
11722	<desc>
11723	The IUSBDeviceFilter interface represents an USB device filter used
11724	to perform actions on a group of USB devices.
11725
11726	This type of filters is used by running virtual machines to
11727	automatically capture selected USB devices once they are physically
11728	attached to the host computer.
11729
11730	A USB device is matched to the given device filter if and only if all
11731	attributes of the device match the corresponding attributes of the
11732	filter (that is, attributes are joined together using the logical AND
11733	operation). On the other hand, all together, filters in the list of
11734	filters carry the semantics of the logical OR operation. So if it is
11735	desirable to create a match like "this vendor id OR this product id",
11736	one needs to create two filters and specify "any match" (see below)
11737	for unused attributes.
11738
11739	All filter attributes used for matching are strings. Each string
11740	is an expression representing a set of values of the corresponding
11741	device attribute, that will match the given filter. Currently, the
11742	following filtering expressions are supported:
11743
11744	<ul>
11745	<li><i>Interval filters</i>. Used to specify valid intervals for
11746	integer device attributes (Vendor ID, Product ID and Revision).
11747	The format of the string is:
11748
11749	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11750
11751	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11752	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11753	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11754	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11755	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11756	possible integer is assumed.
11757	</li>
11758	<li><i>Boolean filters</i>. Used to specify acceptable values for
11759	boolean device attributes. The format of the string is:
11760
11761	<tt>true\|false\|yes\|no\|0\|1</tt>
11762
11763	</li>
11764	<li><i>Exact match</i>. Used to specify a single value for the given
11765	device attribute. Any string that doesn't start with <tt>int:</tt>
11766	represents the exact match. String device attributes are compared to
11767	this string including case of symbols. Integer attributes are first
11768	converted to a string (see individual filter attributes) and then
11769	compared ignoring case.
11770
11771	</li>
11772	<li><i>Any match</i>. Any value of the corresponding device attribute
11773	will match the given filter. An empty or @c null string is
11774	used to construct this type of filtering expressions.
11775
11776	</li>
11777	</ul>
11778
11779	<note>
11780	On the Windows host platform, interval filters are not currently
11781	available. Also all string filter attributes
11782	(<link to="#manufacturer"/>, <link to="#product"/>,
11783	<link to="#serialNumber"/>) are ignored, so they behave as
11784	<i>any match</i> no matter what string expression is specified.
11785	</note>
11786
11787	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
11788	</desc>
11789
11790	<attribute name="name" type="wstring">
11791	<desc>
11792	Visible name for this filter.
11793	This name is used to visually distinguish one filter from another,
11794	so it can neither be @c null nor an empty string.
11795	</desc>
11796	</attribute>
11797
11798	<attribute name="active" type="boolean">
11799	<desc>Whether this filter active or has been temporarily disabled.</desc>
11800	</attribute>
11801
11802	<attribute name="vendorId" type="wstring">
11803	<desc>
11804	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
11805	The string representation for the <i>exact matching</i>
11806	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11807	(including leading zeroes).
11808	</desc>
11809	</attribute>
11810
11811	<attribute name="productId" type="wstring">
11812	<desc>
11813	<link to="IUSBDevice::productId">Product ID</link> filter.
11814	The string representation for the <i>exact matching</i>
11815	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
11816	(including leading zeroes).
11817	</desc>
11818	</attribute>
11819
11820	<attribute name="revision" type="wstring">
11821	<desc>
11822	<link to="IUSBDevice::productId">Product revision number</link>
11823	filter. The string representation for the <i>exact matching</i>
11824	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
11825	of the integer part of the revision, and <tt>F</tt> is the
11826	decimal digit of its fractional part (including leading and
11827	trailing zeros).
11828	Note that for interval filters, it's best to use the hexadecimal
11829	form, because the revision is stored as a 16 bit packed BCD value;
11830	so the expression <tt>int:0x0100-0x0199</tt> will match any
11831	revision from <tt>1.0</tt> to <tt>1.99</tt>.
11832	</desc>
11833	</attribute>
11834
11835	<attribute name="manufacturer" type="wstring">
11836	<desc>
11837	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
11838	</desc>
11839	</attribute>
11840
11841	<attribute name="product" type="wstring">
11842	<desc>
11843	<link to="IUSBDevice::product">Product</link> filter.
11844	</desc>
11845	</attribute>
11846
11847	<attribute name="serialNumber" type="wstring">
11848	<desc>
11849	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
11850	</desc>
11851	</attribute>
11852
11853	<attribute name="port" type="wstring">
11854	<desc>
11855	<link to="IUSBDevice::port">Host USB port</link> filter.
11856	</desc>
11857	</attribute>
11858
11859	<attribute name="remote" type="wstring">
11860	<desc>
11861	<link to="IUSBDevice::remote">Remote state</link> filter.
11862	<note>
11863	This filter makes sense only for machine USB filters,
11864	i.e. it is ignored by IHostUSBDeviceFilter objects.
11865	</note>
11866	</desc>
11867	</attribute>
11868
11869	<attribute name="maskedInterfaces" type="unsigned long">
11870	<desc>
11871	This is an advanced option for hiding one or more USB interfaces
11872	from the guest. The value is a bit mask where the bits that are set
11873	means the corresponding USB interface should be hidden, masked off
11874	if you like.
11875	This feature only works on Linux hosts.
11876	</desc>
11877	</attribute>
11878
11879	</interface>
11880
11881
11882	<!--
11883	// IHostUSBDevice
11884	/////////////////////////////////////////////////////////////////////////
11885	-->
11886
11887	<enum
11888	name="USBDeviceState"
11889	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
11890	>
11891	<desc>
11892	USB device state. This enumeration represents all possible states
11893	of the USB device physically attached to the host computer regarding
11894	its state on the host computer and availability to guest computers
11895	(all currently running virtual machines).
11896
11897	Once a supported USB device is attached to the host, global USB
11898	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
11899	either ignore the device, or put it to USBDeviceState_Held state, or do
11900	nothing. Unless the device is ignored by global filters, filters of all
11901	currently running guests (<link to="IUSBController::deviceFilters"/>) are
11902	activated that can put it to USBDeviceState_Captured state.
11903
11904	If the device was ignored by global filters, or didn't match
11905	any filters at all (including guest ones), it is handled by the host
11906	in a normal way. In this case, the device state is determined by
11907	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
11908	or USBDeviceState_Available, depending on the current device usage.
11909
11910	Besides auto-capturing based on filters, the device can be manually
11911	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
11912	state is USBDeviceState_Busy, USBDeviceState_Available or
11913	USBDeviceState_Held.
11914
11915	<note>
11916	Due to differences in USB stack implementations in Linux and Win32,
11917	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
11918	only to the Linux version of the product. This also means that (<link
11919	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
11920	device state is USBDeviceState_Held.
11921	</note>
11922
11923	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
11924	</desc>
11925
11926	<const name="NotSupported" value="0">
11927	<desc>
11928	Not supported by the VirtualBox server, not available to guests.
11929	</desc>
11930	</const>
11931	<const name="Unavailable" value="1">
11932	<desc>
11933	Being used by the host computer exclusively,
11934	not available to guests.
11935	</desc>
11936	</const>
11937	<const name="Busy" value="2">
11938	<desc>
11939	Being used by the host computer, potentially available to guests.
11940	</desc>
11941	</const>
11942	<const name="Available" value="3">
11943	<desc>
11944	Not used by the host computer, available to guests (the host computer
11945	can also start using the device at any time).
11946	</desc>
11947	</const>
11948	<const name="Held" value="4">
11949	<desc>
11950	Held by the VirtualBox server (ignored by the host computer),
11951	available to guests.
11952	</desc>
11953	</const>
11954	<const name="Captured" value="5">
11955	<desc>
11956	Captured by one of the guest computers, not available
11957	to anybody else.
11958	</desc>
11959	</const>
11960	</enum>
11961
11962	<interface
11963	name="IHostUSBDevice" extends="IUSBDevice"
11964	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
11965	wsmap="managed"
11966	>
11967	<desc>
11968	The IHostUSBDevice interface represents a physical USB device attached
11969	to the host computer.
11970
11971	Besides properties inherited from IUSBDevice, this interface adds the
11972	<link to="#state"/> property that holds the current state of the USB
11973	device.
11974
11975	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
11976	</desc>
11977
11978	<attribute name="state" type="USBDeviceState" readonly="yes">
11979	<desc>
11980	Current state of the device.
11981	</desc>
11982	</attribute>
11983
11984	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
11985
11986	</interface>
11987
11988
11989	<!--
11990	// IHostUSBDeviceFilter
11991	/////////////////////////////////////////////////////////////////////////
11992	-->
11993
11994	<enum
11995	name="USBDeviceFilterAction"
11996	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
11997	>
11998	<desc>
11999	Actions for host USB device filters.
12000	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12001	</desc>
12002
12003	<const name="Null" value="0">
12004	<desc>Null value (never used by the API).</desc>
12005	</const>
12006	<const name="Ignore" value="1">
12007	<desc>Ignore the matched USB device.</desc>
12008	</const>
12009	<const name="Hold" value="2">
12010	<desc>Hold the matched USB device.</desc>
12011	</const>
12012	</enum>
12013
12014	<interface
12015	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12016	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12017	wsmap="managed"
12018	>
12019	<desc>
12020	The IHostUSBDeviceFilter interface represents a global filter for a
12021	physical USB device used by the host computer. Used indirectly in
12022	<link to="IHost::USBDeviceFilters"/>.
12023
12024	Using filters of this type, the host computer determines the initial
12025	state of the USB device after it is physically attached to the
12026	host's USB controller.
12027
12028	<note>
12029	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12030	filters, because it makes sense only for
12031	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12032	</note>
12033
12034	<see>IHost::USBDeviceFilters</see>
12035	</desc>
12036
12037	<attribute name="action" type="USBDeviceFilterAction">
12038	<desc>
12039	Action performed by the host when an attached USB device
12040	matches this filter.
12041	</desc>
12042	</attribute>
12043
12044	</interface>
12045
12046	<!--
12047	// IAudioAdapter
12048	/////////////////////////////////////////////////////////////////////////
12049	-->
12050
12051	<enum
12052	name="AudioDriverType"
12053	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12054	>
12055	<desc>
12056	Host audio driver type.
12057	</desc>
12058
12059	<const name="Null" value="0">
12060	<desc>Null value, also means "dummy audio driver".</desc>
12061	</const>
12062	<const name="WinMM" value="1">
12063	<desc>Windows multimedia (Windows hosts only).</desc>
12064	</const>
12065	<const name="OSS" value="2">
12066	<desc>Open Sound System (Linux hosts only).</desc>
12067	</const>
12068	<const name="ALSA" value="3">
12069	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12070	</const>
12071	<const name="DirectSound" value="4">
12072	<desc>DirectSound (Windows hosts only).</desc>
12073	</const>
12074	<const name="CoreAudio" value="5">
12075	<desc>CoreAudio (Mac hosts only).</desc>
12076	</const>
12077	<const name="MMPM" value="6">
12078	<desc>Reserved for historical reasons.</desc>
12079	</const>
12080	<const name="Pulse" value="7">
12081	<desc>PulseAudio (Linux hosts only).</desc>
12082	</const>
12083	<const name="SolAudio" value="8">
12084	<desc>Solaris audio (Solaris hosts only).</desc>
12085	</const>
12086	</enum>
12087
12088	<enum
12089	name="AudioControllerType"
12090	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12091	>
12092	<desc>
12093	Virtual audio controller type.
12094	</desc>
12095
12096	<const name="AC97" value="0"/>
12097	<const name="SB16" value="1"/>
12098	<const name="HDA" value="2"/>
12099	</enum>
12100
12101	<interface
12102	name="IAudioAdapter" extends="$unknown"
12103	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12104	wsmap="managed"
12105	>
12106	<desc>
12107	The IAudioAdapter interface represents the virtual audio adapter of
12108	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12109	</desc>
12110	<attribute name="enabled" type="boolean">
12111	<desc>
12112	Flag whether the audio adapter is present in the
12113	guest system. If disabled, the virtual guest hardware will
12114	not contain any audio adapter. Can only be changed when
12115	the VM is not running.
12116	</desc>
12117	</attribute>
12118	<attribute name="audioController" type="AudioControllerType">
12119	<desc>
12120	The audio hardware we emulate.
12121	</desc>
12122	</attribute>
12123	<attribute name="audioDriver" type="AudioDriverType">
12124	<desc>
12125	Audio driver the adapter is connected to. This setting
12126	can only be changed when the VM is not running.
12127	</desc>
12128	</attribute>
12129	</interface>
12130
12131	<!--
12132	// IVRDPServer
12133	/////////////////////////////////////////////////////////////////////////
12134	-->
12135
12136	<enum
12137	name="VRDPAuthType"
12138	uuid="3d91887a-b67f-4b33-85bf-2da7ab1ea83a"
12139	>
12140	<desc>
12141	VRDP authentication type.
12142	</desc>
12143
12144	<const name="Null" value="0">
12145	<desc>Null value, also means "no authentication".</desc>
12146	</const>
12147	<const name="External" value="1"/>
12148	<const name="Guest" value="2"/>
12149	</enum>
12150
12151	<interface
12152	name="IVRDPServer" extends="$unknown"
12153	uuid="7aeeb530-0b08-41fe-835d-9be9ec1dbe5c"
12154	wsmap="managed"
12155	>
12156	<attribute name="enabled" type="boolean">
12157	<desc>VRDP server status.</desc>
12158	</attribute>
12159
12160	<attribute name="ports" type="wstring">
12161	<desc>
12162	VRDP server port numbers. The server will try to bind to one of free ports from the list.
12163	<note>
12164	This is a string of comma separated TCP port numbers or port number ranges.
12165	Example <tt>5000,5010-5012,5015</tt>
12166	</note>
12167	</desc>
12168	</attribute>
12169
12170	<attribute name="netAddress" type="wstring">
12171	<desc>VRDP server address.</desc>
12172	</attribute>
12173
12174	<attribute name="authType" type="VRDPAuthType">
12175	<desc>VRDP authentication method.</desc>
12176	</attribute>
12177
12178	<attribute name="authTimeout" type="unsigned long">
12179	<desc>Timeout for guest authentication. Milliseconds.</desc>
12180	</attribute>
12181
12182	<attribute name="allowMultiConnection" type="boolean">
12183	<desc>
12184	Flag whether multiple simultaneous connections to the VM are permitted.
12185	Note that this will be replaced by a more powerful mechanism in the future.
12186	</desc>
12187	</attribute>
12188
12189	<attribute name="reuseSingleConnection" type="boolean">
12190	<desc>
12191	Flag whether the existing connection must be dropped and a new connection
12192	must be established by the VRDP server, when a new client connects in single
12193	connection mode.
12194	</desc>
12195	</attribute>
12196
12197	<attribute name="videoChannel" type="boolean">
12198	<desc>
12199	Flag whether RDP video channel is supported.
12200	</desc>
12201	</attribute>
12202
12203	<attribute name="videoChannelQuality" type="unsigned long">
12204	<desc>
12205	Image quality in percents.
12206	</desc>
12207	</attribute>
12208
12209	</interface>
12210
12211
12212	<!--
12213	// ISharedFolder
12214	/////////////////////////////////////////////////////////////////////////
12215	-->
12216
12217	<interface
12218	name="ISharedFolder" extends="$unknown"
12219	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12220	wsmap="struct"
12221	>
12222	<desc>
12223	The ISharedFolder interface represents a folder in the host computer's
12224	file system accessible from the guest OS running inside a virtual
12225	machine using an associated logical name.
12226
12227	There are three types of shared folders:
12228	<ul>
12229	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12230	folders available to all virtual machines.</li>
12231	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12232	VM-specific shared folders available to the given virtual machine at
12233	startup.</li>
12234	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12235	VM-specific shared folders created in the session context (for
12236	example, when the virtual machine is running) and automatically
12237	discarded when the session is closed (the VM is powered off).</li>
12238	</ul>
12239
12240	Logical names of shared folders must be unique within the given scope
12241	(global, permanent or transient). However, they do not need to be unique
12242	across scopes. In this case, the definition of the shared folder in a
12243	more specific scope takes precedence over definitions in all other
12244	scopes. The order of precedence is (more specific to more general):
12245	<ol>
12246	<li>Transient definitions</li>
12247	<li>Permanent definitions</li>
12248	<li>Global definitions</li>
12249	</ol>
12250
12251	For example, if MyMachine has a shared folder named
12252	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12253	transient shared folder named <tt>C_DRIVE</tt> (that points
12254	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12255	of <tt>C_DRIVE</tt> in the guest OS so
12256	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12257	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12258	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12259	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12260	to <tt>C:\\</tt> if it still exists.
12261
12262	Note that permanent and transient shared folders of different machines
12263	are in different name spaces, so they don't overlap and don't need to
12264	have unique logical names.
12265
12266	<note>
12267	Global shared folders are not implemented in the current version of the
12268	product.
12269	</note>
12270	</desc>
12271
12272	<attribute name="name" type="wstring" readonly="yes">
12273	<desc>Logical name of the shared folder.</desc>
12274	</attribute>
12275
12276	<attribute name="hostPath" type="wstring" readonly="yes">
12277	<desc>Full path to the shared folder in the host file system.</desc>
12278	</attribute>
12279
12280	<attribute name="accessible" type="boolean" readonly="yes">
12281	<desc>
12282	Whether the folder defined by the host path is currently
12283	accessible or not.
12284	For example, the folder can be unaccessible if it is placed
12285	on the network share that is not available by the time
12286	this property is read.
12287	</desc>
12288	</attribute>
12289
12290	<attribute name="writable" type="boolean" readonly="yes">
12291	<desc>
12292	Whether the folder defined by the host path is writable or
12293	not.
12294	</desc>
12295	</attribute>
12296
12297	<attribute name="autoMount" type="boolean" readonly="yes">
12298	<desc>
12299	Whether the folder gets automatically mounted by the guest or not.
12300	</desc>
12301	</attribute>
12302
12303	<attribute name="lastAccessError" type="wstring" readonly="yes">
12304	<desc>
12305	Text message that represents the result of the last accessibility
12306	check.
12307
12308	Accessibility checks are performed each time the <link to="#accessible"/>
12309	attribute is read. An empty string is returned if the last
12310	accessibility check was successful. A non-empty string indicates a
12311	failure and should normally describe a reason of the failure (for
12312	example, a file read error).
12313	</desc>
12314	</attribute>
12315
12316	</interface>
12317
12318	<!--
12319	// ISession
12320	/////////////////////////////////////////////////////////////////////////
12321	-->
12322
12323	<interface
12324	name="IInternalSessionControl" extends="$unknown"
12325	uuid="ef059f1d-2273-4f81-9342-c152a0d2cd40"
12326	internal="yes"
12327	wsmap="suppress"
12328	>
12329	<method name="getPID">
12330	<desc>PID of the process that has created this Session object.
12331	</desc>
12332	<param name="pid" type="unsigned long" dir="return"/>
12333	</method>
12334
12335	<method name="getRemoteConsole">
12336	<desc>
12337	Returns the console object suitable for remote control.
12338
12339	<result name="VBOX_E_INVALID_VM_STATE">
12340	Session state prevents operation.
12341	</result>
12342	<result name="VBOX_E_INVALID_OBJECT_STATE">
12343	Session type prevents operation.
12344	</result>
12345
12346	</desc>
12347	<param name="console" type="IConsole" dir="return"/>
12348	</method>
12349
12350	<method name="assignMachine">
12351	<desc>
12352	Assigns the machine object associated with this direct-type
12353	session or informs the session that it will be a remote one
12354	(if @a machine == @c null).
12355
12356	<result name="VBOX_E_INVALID_VM_STATE">
12357	Session state prevents operation.
12358	</result>
12359	<result name="VBOX_E_INVALID_OBJECT_STATE">
12360	Session type prevents operation.
12361	</result>
12362
12363	</desc>
12364	<param name="machine" type="IMachine" dir="in"/>
12365	</method>
12366
12367	<method name="assignRemoteMachine">
12368	<desc>
12369	Assigns the machine and the (remote) console object associated with
12370	this remote-type session.
12371
12372	<result name="VBOX_E_INVALID_VM_STATE">
12373	Session state prevents operation.
12374	</result>
12375
12376	</desc>
12377	<param name="machine" type="IMachine" dir="in"/>
12378	<param name="console" type="IConsole" dir="in"/>
12379	</method>
12380
12381	<method name="updateMachineState">
12382	<desc>
12383	Updates the machine state in the VM process.
12384	Must be called only in certain cases
12385	(see the method implementation).
12386
12387	<result name="VBOX_E_INVALID_VM_STATE">
12388	Session state prevents operation.
12389	</result>
12390	<result name="VBOX_E_INVALID_OBJECT_STATE">
12391	Session type prevents operation.
12392	</result>
12393
12394	</desc>
12395	<param name="aMachineState" type="MachineState" dir="in"/>
12396	</method>
12397
12398	<method name="uninitialize">
12399	<desc>
12400	Uninitializes (closes) this session. Used by VirtualBox to close
12401	the corresponding remote session when the direct session dies
12402	or gets closed.
12403
12404	<result name="VBOX_E_INVALID_VM_STATE">
12405	Session state prevents operation.
12406	</result>
12407
12408	</desc>
12409	</method>
12410
12411	<method name="onNetworkAdapterChange">
12412	<desc>
12413	Triggered when settings of a network adapter of the
12414	associated virtual machine have changed.
12415
12416	<result name="VBOX_E_INVALID_VM_STATE">
12417	Session state prevents operation.
12418	</result>
12419	<result name="VBOX_E_INVALID_OBJECT_STATE">
12420	Session type prevents operation.
12421	</result>
12422
12423	</desc>
12424	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12425	<param name="changeAdapter" type="boolean" dir="in"/>
12426	</method>
12427
12428	<method name="onSerialPortChange">
12429	<desc>
12430	Triggered when settings of a serial port of the
12431	associated virtual machine have changed.
12432
12433	<result name="VBOX_E_INVALID_VM_STATE">
12434	Session state prevents operation.
12435	</result>
12436	<result name="VBOX_E_INVALID_OBJECT_STATE">
12437	Session type prevents operation.
12438	</result>
12439
12440	</desc>
12441	<param name="serialPort" type="ISerialPort" dir="in"/>
12442	</method>
12443
12444	<method name="onParallelPortChange">
12445	<desc>
12446	Triggered when settings of a parallel port of the
12447	associated virtual machine have changed.
12448
12449	<result name="VBOX_E_INVALID_VM_STATE">
12450	Session state prevents operation.
12451	</result>
12452	<result name="VBOX_E_INVALID_OBJECT_STATE">
12453	Session type prevents operation.
12454	</result>
12455
12456	</desc>
12457	<param name="parallelPort" type="IParallelPort" dir="in"/>
12458	</method>
12459
12460	<method name="onStorageControllerChange">
12461	<desc>
12462	Triggered when settings of a storage controller of the
12463	associated virtual machine have changed.
12464
12465	<result name="VBOX_E_INVALID_VM_STATE">
12466	Session state prevents operation.
12467	</result>
12468	<result name="VBOX_E_INVALID_OBJECT_STATE">
12469	Session type prevents operation.
12470	</result>
12471
12472	</desc>
12473	</method>
12474
12475	<method name="onMediumChange">
12476	<desc>
12477	Triggered when attached media of the
12478	associated virtual machine have changed.
12479
12480	<result name="VBOX_E_INVALID_VM_STATE">
12481	Session state prevents operation.
12482	</result>
12483	<result name="VBOX_E_INVALID_OBJECT_STATE">
12484	Session type prevents operation.
12485	</result>
12486
12487	</desc>
12488
12489	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12490	<param name="force" type="boolean" dir="in"/>
12491	</method>
12492
12493	<method name="onCPUChange">
12494	<desc>
12495	Notification when a CPU changes.
12496	</desc>
12497	<param name="cpu" type="unsigned long" dir="in">
12498	<desc>The CPU which changed</desc>
12499	</param>
12500	<param name="add" type="boolean" dir="in">
12501	<desc>Flag whether the CPU was added or removed</desc>
12502	</param>
12503	</method>
12504
12505	<method name="onCPUPriorityChange">
12506	<desc>
12507	Notification when the CPU priority changes.
12508	</desc>
12509	<param name="priority" type="unsigned long" dir="in">
12510	<desc>The new CPU priority value. (1-100)</desc>
12511	</param>
12512	</method>
12513
12514	<method name="onVRDPServerChange">
12515	<desc>
12516	Triggered when settings of the VRDP server object of the
12517	associated virtual machine have changed.
12518
12519	<result name="VBOX_E_INVALID_VM_STATE">
12520	Session state prevents operation.
12521	</result>
12522	<result name="VBOX_E_INVALID_OBJECT_STATE">
12523	Session type prevents operation.
12524	</result>
12525
12526	</desc>
12527	<param name="restart" type="boolean" dir="in">
12528	<desc>Flag whether the server must be restarted</desc>
12529	</param>
12530	</method>
12531
12532	<method name="onUSBControllerChange">
12533	<desc>
12534	Triggered when settings of the USB controller object 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="onSharedFolderChange">
12548	<desc>
12549	Triggered when a permanent (global or machine) shared folder has been
12550	created or removed.
12551	<note>
12552	We don't pass shared folder parameters in this notification because
12553	the order in which parallel notifications are delivered is not defined,
12554	therefore it could happen that these parameters were outdated by the
12555	time of processing this notification.
12556	</note>
12557
12558	<result name="VBOX_E_INVALID_VM_STATE">
12559	Session state prevents operation.
12560	</result>
12561	<result name="VBOX_E_INVALID_OBJECT_STATE">
12562	Session type prevents operation.
12563	</result>
12564
12565	</desc>
12566	<param name="global" type="boolean" dir="in"/>
12567	</method>
12568
12569	<method name="onUSBDeviceAttach">
12570	<desc>
12571	Triggered when a request to capture a USB device (as a result
12572	of matched USB filters or direct call to
12573	<link to="IConsole::attachUSBDevice"/>) has completed.
12574	A @c null @a error object means success, otherwise it
12575	describes a failure.
12576
12577	<result name="VBOX_E_INVALID_VM_STATE">
12578	Session state prevents operation.
12579	</result>
12580	<result name="VBOX_E_INVALID_OBJECT_STATE">
12581	Session type prevents operation.
12582	</result>
12583
12584	</desc>
12585	<param name="device" type="IUSBDevice" dir="in"/>
12586	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12587	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12588	</method>
12589
12590	<method name="onUSBDeviceDetach">
12591	<desc>
12592	Triggered when a request to release the USB device (as a result
12593	of machine termination or direct call to
12594	<link to="IConsole::detachUSBDevice"/>) has completed.
12595	A @c null @a error object means success, otherwise it
12596	describes a failure.
12597
12598	<result name="VBOX_E_INVALID_VM_STATE">
12599	Session state prevents operation.
12600	</result>
12601	<result name="VBOX_E_INVALID_OBJECT_STATE">
12602	Session type prevents operation.
12603	</result>
12604
12605	</desc>
12606	<param name="id" type="uuid" mod="string" dir="in"/>
12607	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12608	</method>
12609
12610	<method name="onShowWindow">
12611	<desc>
12612	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12613	<link to="IMachine::showConsoleWindow"/> in order to notify
12614	console listeners
12615	<link to="ICanShowWindowEvent"/>
12616	and <link to="IShowWindowEvent"/>.
12617
12618	<result name="VBOX_E_INVALID_OBJECT_STATE">
12619	Session type prevents operation.
12620	</result>
12621
12622	</desc>
12623	<param name="check" type="boolean" dir="in"/>
12624	<param name="canShow" type="boolean" dir="out"/>
12625	<param name="winId" type="long long" dir="out"/>
12626	</method>
12627
12628	<method name="accessGuestProperty">
12629	<desc>
12630	Called by <link to="IMachine::getGuestProperty"/> and by
12631	<link to="IMachine::setGuestProperty"/> in order to read and
12632	modify guest properties.
12633
12634	<result name="VBOX_E_INVALID_VM_STATE">
12635	Machine session is not open.
12636	</result>
12637	<result name="VBOX_E_INVALID_OBJECT_STATE">
12638	Session type is not direct.
12639	</result>
12640
12641	</desc>
12642	<param name="name" type="wstring" dir="in"/>
12643	<param name="value" type="wstring" dir="in"/>
12644	<param name="flags" type="wstring" dir="in"/>
12645	<param name="isSetter" type="boolean" dir="in"/>
12646	<param name="retValue" type="wstring" dir="out"/>
12647	<param name="retTimestamp" type="long long" dir="out"/>
12648	<param name="retFlags" type="wstring" dir="out"/>
12649	</method>
12650
12651	<method name="enumerateGuestProperties">
12652	<desc>
12653	Return a list of the guest properties matching a set of patterns along
12654	with their values, time stamps and flags.
12655
12656	<result name="VBOX_E_INVALID_VM_STATE">
12657	Machine session is not open.
12658	</result>
12659	<result name="VBOX_E_INVALID_OBJECT_STATE">
12660	Session type is not direct.
12661	</result>
12662
12663	</desc>
12664	<param name="patterns" type="wstring" dir="in">
12665	<desc>
12666	The patterns to match the properties against as a comma-separated
12667	string. If this is empty, all properties currently set will be
12668	returned.
12669	</desc>
12670	</param>
12671	<param name="key" type="wstring" dir="out" safearray="yes">
12672	<desc>
12673	The key names of the properties returned.
12674	</desc>
12675	</param>
12676	<param name="value" type="wstring" dir="out" safearray="yes">
12677	<desc>
12678	The values of the properties returned. The array entries match the
12679	corresponding entries in the @a key array.
12680	</desc>
12681	</param>
12682	<param name="timestamp" type="long long" dir="out" safearray="yes">
12683	<desc>
12684	The time stamps of the properties returned. The array entries match
12685	the corresponding entries in the @a key array.
12686	</desc>
12687	</param>
12688	<param name="flags" type="wstring" dir="out" safearray="yes">
12689	<desc>
12690	The flags of the properties returned. The array entries match the
12691	corresponding entries in the @a key array.
12692	</desc>
12693	</param>
12694	</method>
12695
12696	<method name="onlineMergeMedium">
12697	<desc>
12698	Triggers online merging of a hard disk. Used internally when deleting
12699	a snapshot while a VM referring to the same hard disk chain is running.
12700
12701	<result name="VBOX_E_INVALID_VM_STATE">
12702	Machine session is not open.
12703	</result>
12704	<result name="VBOX_E_INVALID_OBJECT_STATE">
12705	Session type is not direct.
12706	</result>
12707
12708	</desc>
12709	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
12710	<desc>The medium attachment to identify the medium chain.</desc>
12711	</param>
12712	<param name="sourceIdx" type="unsigned long" dir="in">
12713	<desc>The index of the source image in the chain.
12714	Redundant, but drastically reduces IPC.</desc>
12715	</param>
12716	<param name="targetIdx" type="unsigned long" dir="in">
12717	<desc>The index of the target image in the chain.
12718	Redundant, but drastically reduces IPC.</desc>
12719	</param>
12720	<param name="source" type="IMedium" dir="in">
12721	<desc>Merge source medium.</desc>
12722	</param>
12723	<param name="target" type="IMedium" dir="in">
12724	<desc>Merge target medium.</desc>
12725	</param>
12726	<param name="mergeForward" type="boolean" dir="in">
12727	<desc>Merge direction.</desc>
12728	</param>
12729	<param name="parentForTarget" type="IMedium" dir="in">
12730	<desc>For forward merges: new parent for target medium.</desc>
12731	</param>
12732	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
12733	<desc>For backward merges: list of media which need their parent UUID
12734	updated.</desc>
12735	</param>
12736	<param name="progress" type="IProgress" dir="in">
12737	<desc>
12738	Progress object for this operation.
12739	</desc>
12740	</param>
12741	</method>
12742
12743	</interface>
12744
12745	<interface
12746	name="ISession" extends="$unknown"
12747	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
12748	wsmap="managed"
12749	>
12750	<desc>
12751	The ISession interface represents a client process and allows for locking
12752	virtual machines (represented by IMachine objects) to prevent conflicting
12753	changes to the machine.
12754
12755	Any caller wishing to manipulate a virtual machine needs to create a session
12756	object first, which lives in its own process space. Such session objects are
12757	then associated with <link to="IMachine" /> objects living in the VirtualBox
12758	server process to coordinate such changes.
12759
12760	There are two typical scenarios in which sessions are used:
12761
12762	<ul>
12763	<li>To alter machine settings or control a running virtual machine, one
12764	needs to lock a machine for a given session (client process) by calling
12765	<link to="IMachine::lockMachine"/>.
12766
12767	Whereas multiple sessions may control a running virtual machine, only
12768	one process can obtain a write lock on the machine to prevent conflicting
12769	changes. A write lock is also needed if a process wants to actually run a
12770	virtual machine in its own context, such as the VirtualBox GUI or
12771	VBoxHeadless front-ends. They must also lock a machine for their own
12772	sessions before they are allowed to power up the virtual machine.
12773
12774	As a result, no machine settings can be altered while another process is
12775	already using it, either because that process is modifying machine settings
12776	or because the machine is running.
12777	</li>
12778	<li>
12779	To start a VM using one of the existing VirtualBox front-ends (e.g. the
12780	VirtualBox GUI or VBoxHeadless), one would use
12781	<link to="IMachine::launchVMProcess"/>, which also takes a session object
12782	as its first parameter. This session then identifies the caller and lets the
12783	caller control the started machine (for example, pause machine execution or
12784	power it down) as well as be notified about machine execution state changes.
12785	</li>
12786	</ul>
12787
12788	How sessions objects are created in a client process depends on whether you use
12789	the Main API via COM or via the webservice:
12790
12791	<ul>
12792	<li>When using the COM API directly, an object of the Session class from the
12793	VirtualBox type library needs to be created. In regular COM C++ client code,
12794	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
12795	This object will then act as a local session object in further calls to open
12796	a session.
12797	</li>
12798
12799	<li>In the webservice, the session manager (IWebsessionManager) instead creates
12800	a session object automatically whenever <link to="IWebsessionManager::logon" />
12801	is called. A managed object reference to that session object can be retrieved by
12802	calling <link to="IWebsessionManager::getSessionObject" />.
12803	</li>
12804	</ul>
12805	</desc>
12806
12807	<attribute name="state" type="SessionState" readonly="yes">
12808	<desc>Current state of this session.</desc>
12809	</attribute>
12810
12811	<attribute name="type" type="SessionType" readonly="yes">
12812	<desc>
12813	Type of this session. The value of this attribute is valid only
12814	if the session currently has a machine locked (i.e. its
12815	<link to="#state" /> is Locked), otherwise an error will be returned.
12816	</desc>
12817	</attribute>
12818
12819	<attribute name="machine" type="IMachine" readonly="yes">
12820	<desc>Machine object associated with this session.</desc>
12821	</attribute>
12822
12823	<attribute name="console" type="IConsole" readonly="yes">
12824	<desc>Console object associated with this session.</desc>
12825	</attribute>
12826
12827	<method name="unlockMachine">
12828	<desc>
12829	Unlocks a machine that was previously locked for the current session.
12830
12831	Calling this method is required every time a machine has been locked
12832	for a particular session using the <link to="IMachine::launchVMProcess" />
12833	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
12834	the machine will be set to <link to="MachineState::Aborted" /> on the
12835	server, and changes made to the machine settings will be lost.
12836
12837	Generally, it is recommended to unlock all machines explicitly
12838	before terminating the application (regardless of the reason for
12839	the termination).
12840
12841	<note>
12842	Do not expect the session state (<link to="ISession::state" />
12843	to return to "Unlocked" immediately after you invoke this method,
12844	particularly if you have started a new VM process. The session
12845	state will automatically return to "Unlocked" once the VM is no
12846	longer executing, which can of course take a very long time.
12847	</note>
12848
12849	<result name="E_UNEXPECTED">
12850	Session is not locked.
12851	</result>
12852
12853	</desc>
12854	</method>
12855
12856	</interface>
12857
12858	<!--
12859	// IStorageController
12860	/////////////////////////////////////////////////////////////////////////
12861	-->
12862
12863	<enum
12864	name="StorageBus"
12865	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
12866	>
12867	<desc>
12868	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
12869	see <link to="IStorageController::bus" />.
12870	</desc>
12871	<const name="Null" value="0">
12872	<desc>@c null value. Never used by the API.</desc>
12873	</const>
12874	<const name="IDE" value="1"/>
12875	<const name="SATA" value="2"/>
12876	<const name="SCSI" value="3"/>
12877	<const name="Floppy" value="4"/>
12878	<const name="SAS" value="5"/>
12879	</enum>
12880
12881	<enum
12882	name="StorageControllerType"
12883	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
12884	>
12885	<desc>
12886	The exact variant of storage controller hardware presented
12887	to the guest; see <link to="IStorageController::controllerType" />.
12888	</desc>
12889
12890	<const name="Null" value="0">
12891	<desc>@c null value. Never used by the API.</desc>
12892	</const>
12893	<const name="LsiLogic" value="1">
12894	<desc>A SCSI controller of the LsiLogic variant.</desc>
12895	</const>
12896	<const name="BusLogic" value="2">
12897	<desc>A SCSI controller of the BusLogic variant.</desc>
12898	</const>
12899	<const name="IntelAhci" value="3">
12900	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
12901	</const>
12902	<const name="PIIX3" value="4">
12903	<desc>An IDE controller of the PIIX3 variant.</desc>
12904	</const>
12905	<const name="PIIX4" value="5">
12906	<desc>An IDE controller of the PIIX4 variant.</desc>
12907	</const>
12908	<const name="ICH6" value="6">
12909	<desc>An IDE controller of the ICH6 variant.</desc>
12910	</const>
12911	<const name="I82078" value="7">
12912	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
12913	</const>
12914	<const name="LsiLogicSas" value="8">
12915	<desc>A variant of the LsiLogic controller using SAS.</desc>
12916	</const>
12917	</enum>
12918
12919	<interface
12920	name="IStorageController" extends="$unknown"
12921	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
12922	wsmap="managed"
12923	>
12924	<desc>
12925	Represents a storage controller that is attached to a virtual machine
12926	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
12927	attached to storage controllers in a real computer, virtual drives
12928	(represented by <link to="IMediumAttachment" />) are attached to virtual
12929	storage controllers, represented by this interface.
12930
12931	As opposed to physical hardware, VirtualBox has a very generic concept
12932	of a storage controller, and for purposes of the Main API, all virtual
12933	storage is attached to virtual machines via instances of this interface.
12934	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
12935	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
12936	is used, certain sub-types may be available and can be selected in
12937	<link to="#controllerType" />.
12938
12939	Depending on these settings, the guest operating system might see
12940	significantly different virtual hardware.
12941	</desc>
12942
12943	<attribute name="name" type="wstring" readonly="yes">
12944	<desc>
12945	Name of the storage controller, as originally specified with
12946	<link to="IMachine::addStorageController" />. This then uniquely
12947	identifies this controller with other method calls such as
12948	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
12949	</desc>
12950	</attribute>
12951
12952	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
12953	<desc>
12954	Maximum number of devices which can be attached to one port.
12955	</desc>
12956	</attribute>
12957
12958	<attribute name="minPortCount" type="unsigned long" readonly="yes">
12959	<desc>
12960	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
12961	</desc>
12962	</attribute>
12963
12964	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
12965	<desc>
12966	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
12967	</desc>
12968	</attribute>
12969
12970	<attribute name="instance" type="unsigned long">
12971	<desc>
12972	The instance number of the device in the running VM.
12973	</desc>
12974	</attribute>
12975
12976	<attribute name="portCount" type="unsigned long">
12977	<desc>
12978	The number of currently usable ports on the controller.
12979	The minimum and maximum number of ports for one controller are
12980	stored in <link to="IStorageController::minPortCount"/>
12981	and <link to="IStorageController::maxPortCount"/>.
12982	</desc>
12983	</attribute>
12984
12985	<attribute name="bus" type="StorageBus" readonly="yes">
12986	<desc>
12987	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
12988	</desc>
12989	</attribute>
12990
12991	<attribute name="controllerType" type="StorageControllerType">
12992	<desc>
12993	The exact variant of storage controller hardware presented
12994	to the guest.
12995	Depending on this value, VirtualBox will provide a different
12996	virtual storage controller hardware to the guest.
12997	For SATA, SAS and floppy controllers, only one variant is
12998	available, but for IDE and SCSI, there are several.
12999
13000	For SCSI controllers, the default type is LsiLogic.
13001	</desc>
13002	</attribute>
13003
13004	<attribute name="useHostIOCache" type="boolean">
13005	<desc>
13006	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13007	caches and use synchronous file APIs on the host. This was the only option in the API before
13008	VirtualBox 3.2 and is still the default for IDE controllers.
13009
13010	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13011	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13012	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13013	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13014	virtual machines are running at the same time to prevent I/O cache related hangs.
13015	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13016	</desc>
13017	</attribute>
13018
13019	<method name="getIDEEmulationPort">
13020	<desc>
13021	Gets the corresponding port number which is emulated as an IDE device.
13022	Works only with SATA controllers.
13023
13024	<result name="E_INVALIDARG">
13025	The @a devicePosition is not in the range 0 to 3.
13026	</result>
13027	<result name="E_NOTIMPL">
13028	The storage controller type is not SATAIntelAhci.
13029	</result>
13030
13031	</desc>
13032	<param name="devicePosition" type="long" dir="in"/>
13033	<param name="portNumber" type="long" dir="return"/>
13034	</method>
13035
13036	<method name="setIDEEmulationPort">
13037	<desc>
13038	Sets the port number which is emulated as an IDE device.
13039	Works only with SATA controllers.
13040
13041	<result name="E_INVALIDARG">
13042	The @a devicePosition is not in the range 0 to 3 or the
13043	@a portNumber is not in the range 0 to 29.
13044	</result>
13045	<result name="E_NOTIMPL">
13046	The storage controller type is not SATAIntelAhci.
13047	</result>
13048
13049	</desc>
13050	<param name="devicePosition" type="long" dir="in"/>
13051	<param name="portNumber" type="long" dir="in"/>
13052	</method>
13053
13054	</interface>
13055
13056	<if target="wsdl">
13057
13058	<!--
13059	// IManagedObjectRef
13060	/////////////////////////////////////////////////////////////////////////
13061	-->
13062
13063	<interface
13064	name="IManagedObjectRef" extends="$unknown"
13065	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13066	internal="yes"
13067	wsmap="managed"
13068	wscpp="hardcoded"
13069	>
13070	<desc>
13071	Managed object reference.
13072
13073	Only within the webservice, a managed object reference (which is really
13074	an opaque number) allows a webservice client to address an object
13075	that lives in the address space of the webservice server.
13076
13077	Behind each managed object reference, there is a COM object that lives
13078	in the webservice server's address space. The COM object is not freed
13079	until the managed object reference is released, either by an explicit
13080	call to <link to="IManagedObjectRef::release" /> or by logging off from
13081	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13082	all objects created during the webservice session.
13083
13084	Whenever a method call of the VirtualBox API returns a COM object, the
13085	webservice representation of that method will instead return a
13086	managed object reference, which can then be used to invoke methods
13087	on that object.
13088	</desc>
13089
13090	<method name="getInterfaceName">
13091	<desc>
13092	Returns the name of the interface that this managed object represents,
13093	for example, "IMachine", as a string.
13094	</desc>
13095	<param name="return" type="wstring" dir="return"/>
13096	</method>
13097
13098	<method name="release">
13099	<desc>
13100	Releases this managed object reference and frees the resources that
13101	were allocated for it in the webservice server process. After calling
13102	this method, the identifier of the reference can no longer be used.
13103	</desc>
13104	</method>
13105
13106	</interface>
13107
13108	<!--
13109	// IWebsessionManager
13110	/////////////////////////////////////////////////////////////////////////
13111	-->
13112
13113	<interface
13114	name="IWebsessionManager" extends="$unknown"
13115	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13116	internal="yes"
13117	wsmap="global"
13118	wscpp="hardcoded"
13119	>
13120	<desc>
13121	Websession manager. This provides essential services
13122	to webservice clients.
13123	</desc>
13124	<method name="logon">
13125	<desc>
13126	Logs a new client onto the webservice and returns a managed object reference to
13127	the IVirtualBox instance, which the client can then use as a basis to further
13128	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13129	interface, in one way or the other.
13130	</desc>
13131	<param name="username" type="wstring" dir="in"/>
13132	<param name="password" type="wstring" dir="in"/>
13133	<param name="return" type="IVirtualBox" dir="return"/>
13134	</method>
13135
13136	<method name="getSessionObject">
13137	<desc>
13138	Returns a managed object reference to the internal ISession object that was created
13139	for this web service session when the client logged on.
13140
13141	<see>ISession</see>
13142	</desc>
13143	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13144	<param name="return" type="ISession" dir="return"/>
13145	</method>
13146
13147	<method name="logoff">
13148	<desc>
13149	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13150	and destroys all resources associated with the session (most importantly, all
13151	managed objects created in the server while the session was active).
13152	</desc>
13153	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13154	</method>
13155
13156	</interface>
13157
13158	</if>
13159
13160	<!--
13161	// IPerformanceCollector & friends
13162	/////////////////////////////////////////////////////////////////////////
13163	-->
13164
13165	<interface
13166	name="IPerformanceMetric" extends="$unknown"
13167	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13168	>
13169	<desc>
13170	The IPerformanceMetric interface represents parameters of the given
13171	performance metric.
13172	</desc>
13173
13174	<attribute name="metricName" type="wstring" readonly="yes">
13175	<desc>
13176	Name of the metric.
13177	</desc>
13178	</attribute>
13179
13180	<attribute name="object" type="$unknown" readonly="yes">
13181	<desc>
13182	Object this metric belongs to.
13183	</desc>
13184	</attribute>
13185
13186	<attribute name="description" type="wstring" readonly="yes">
13187	<desc>
13188	Textual description of the metric.
13189	</desc>
13190	</attribute>
13191
13192	<attribute name="period" type="unsigned long" readonly="yes">
13193	<desc>
13194	Time interval between samples, measured in seconds.
13195	</desc>
13196	</attribute>
13197
13198	<attribute name="count" type="unsigned long" readonly="yes">
13199	<desc>
13200	Number of recent samples retained by the performance collector for this
13201	metric.
13202
13203	When the collected sample count exceeds this number, older samples
13204	are discarded.
13205	</desc>
13206	</attribute>
13207
13208	<attribute name="unit" type="wstring" readonly="yes">
13209	<desc>
13210	Unit of measurement.
13211	</desc>
13212	</attribute>
13213
13214	<attribute name="minimumValue" type="long" readonly="yes">
13215	<desc>
13216	Minimum possible value of this metric.
13217	</desc>
13218	</attribute>
13219
13220	<attribute name="maximumValue" type="long" readonly="yes">
13221	<desc>
13222	Maximum possible value of this metric.
13223	</desc>
13224	</attribute>
13225	</interface>
13226
13227	<interface
13228	name="IPerformanceCollector" extends="$unknown"
13229	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13230	wsmap="managed"
13231	>
13232	<desc>
13233	The IPerformanceCollector interface represents a service that collects
13234	and stores performance metrics data.
13235
13236	Performance metrics are associated with objects of interfaces like IHost
13237	and IMachine. Each object has a distinct set of performance metrics. The
13238	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13239
13240	Metric data is collected at the specified intervals and is retained
13241	internally. The interval and the number of retained samples can be set
13242	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13243	and collection settings are not persistent, they are discarded as soon as
13244	VBoxSVC process terminates. Moreover, metric settings and data associated
13245	with a particular VM only exist while VM is running. They disappear as
13246	soon as VM shuts down. It is not possible to set up metrics for machines
13247	that are powered off. One needs to start VM first, then set up metric
13248	collection parameters.
13249
13250	Metrics are organized hierarchically, with each level separated by a
13251	slash (/) character. Generally, the scheme for metric names is like this:
13252
13253	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13254
13255	"Category/Metric" together form the base metric name. A base metric is
13256	the smallest unit for which a sampling interval and the number of
13257	retained samples can be set. Only base metrics can be enabled and
13258	disabled. All sub-metrics are collected when their base metric is
13259	collected. Collected values for any set of sub-metrics can be queried
13260	with <link to="IPerformanceCollector::queryMetricsData" />.
13261
13262	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13263	category, "Load" metric, "User" submetric, "average" aggregate. An
13264	aggregate function is computed over all retained data. Valid aggregate
13265	functions are:
13266
13267	<ul>
13268	<li>avg -- average</li>
13269	<li>min -- minimum</li>
13270	<li>max -- maximum</li>
13271	</ul>
13272
13273	When setting up metric parameters, querying metric data, enabling or
13274	disabling metrics wildcards can be used in metric names to specify a
13275	subset of metrics. For example, to select all CPU-related metrics
13276	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13277	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13278
13279	The valid names for base metrics are:
13280
13281	<ul>
13282	<li>CPU/Load</li>
13283	<li>CPU/MHz</li>
13284	<li>RAM/Usage</li>
13285	</ul>
13286
13287	The general sequence for collecting and retrieving the metrics is:
13288	<ul>
13289	<li>
13290	Obtain an instance of IPerformanceCollector with
13291	<link to="IVirtualBox::performanceCollector" />
13292	</li>
13293	<li>
13294	Allocate and populate an array with references to objects the metrics
13295	will be collected for. Use references to IHost and IMachine objects.
13296	</li>
13297	<li>
13298	Allocate and populate an array with base metric names the data will
13299	be collected for.
13300	</li>
13301	<li>
13302	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13303	the metric data will be collected and stored.
13304	</li>
13305	<li>
13306	Wait for the data to get collected.
13307	</li>
13308	<li>
13309	Allocate and populate an array with references to objects the metric
13310	values will be queried for. You can re-use the object array used for
13311	setting base metrics.
13312	</li>
13313	<li>
13314	Allocate and populate an array with metric names the data will be
13315	collected for. Note that metric names differ from base metric names.
13316	</li>
13317	<li>
13318	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13319	that have been collected so far are returned. Note that the values
13320	are still retained internally and data collection continues.
13321	</li>
13322	</ul>
13323
13324	For an example of usage refer to the following files in VirtualBox SDK:
13325	<ul>
13326	<li>
13327	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13328	</li>
13329	<li>
13330	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13331	</li>
13332	</ul>
13333	</desc>
13334
13335	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13336	<desc>
13337	Array of unique names of metrics.
13338
13339	This array represents all metrics supported by the performance
13340	collector. Individual objects do not necessarily support all of them.
13341	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13342	list of supported metrics for a particular object.
13343	</desc>
13344	</attribute>
13345
13346	<method name="getMetrics">
13347	<desc>
13348	Returns parameters of specified metrics for a set of objects.
13349	<note>
13350	@c Null metrics array means all metrics. @c Null object array means
13351	all existing objects.
13352	</note>
13353	</desc>
13354	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13355	<desc>
13356	Metric name filter. Currently, only a comma-separated list of metrics
13357	is supported.
13358	</desc>
13359	</param>
13360	<param name="objects" type="$unknown" dir="in" safearray="yes">
13361	<desc>
13362	Set of objects to return metric parameters for.
13363	</desc>
13364	</param>
13365	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13366	<desc>
13367	Array of returned metric parameters.
13368	</desc>
13369	</param>
13370	</method>
13371
13372	<method name="setupMetrics">
13373	<desc>
13374	Sets parameters of specified base metrics for a set of objects. Returns
13375	an array of <link to="IPerformanceMetric" /> describing the metrics
13376	have been affected.
13377	<note>
13378	@c Null or empty metric name array means all metrics. @c Null or
13379	empty object array means all existing objects. If metric name array
13380	contains a single element and object array contains many, the single
13381	metric name array element is applied to each object array element to
13382	form metric/object pairs.
13383	</note>
13384	</desc>
13385	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13386	<desc>
13387	Metric name filter. Comma-separated list of metrics with wildcard
13388	support.
13389	</desc>
13390	</param>
13391	<param name="objects" type="$unknown" dir="in" safearray="yes">
13392	<desc>
13393	Set of objects to setup metric parameters for.
13394	</desc>
13395	</param>
13396	<param name="period" type="unsigned long" dir="in">
13397	<desc>
13398	Time interval in seconds between two consecutive samples of
13399	performance data.
13400	</desc>
13401	</param>
13402	<param name="count" type="unsigned long" dir="in">
13403	<desc>
13404	Number of samples to retain in performance data history. Older
13405	samples get discarded.
13406	</desc>
13407	</param>
13408	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13409	<desc>
13410	Array of metrics that have been modified by the call to this method.
13411	</desc>
13412	</param>
13413	</method>
13414
13415	<method name="enableMetrics">
13416	<desc>
13417	Turns on collecting specified base metrics. Returns an array of
13418	<link to="IPerformanceMetric" /> describing the metrics have been
13419	affected.
13420	<note>
13421	@c Null or empty metric name array means all metrics. @c Null or
13422	empty object array means all existing objects. If metric name array
13423	contains a single element and object array contains many, the single
13424	metric name array element is applied to each object array element to
13425	form metric/object pairs.
13426	</note>
13427	</desc>
13428	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13429	<desc>
13430	Metric name filter. Comma-separated list of metrics with wildcard
13431	support.
13432	</desc>
13433	</param>
13434	<param name="objects" type="$unknown" dir="in" safearray="yes">
13435	<desc>
13436	Set of objects to enable metrics for.
13437	</desc>
13438	</param>
13439	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13440	<desc>
13441	Array of metrics that have been modified by the call to this method.
13442	</desc>
13443	</param>
13444	</method>
13445
13446	<method name="disableMetrics">
13447	<desc>
13448	Turns off collecting specified base metrics. Returns an array of
13449	<link to="IPerformanceMetric" /> describing the metrics have been
13450	affected.
13451	<note>
13452	@c Null or empty metric name array means all metrics. @c Null or
13453	empty object array means all existing objects. If metric name array
13454	contains a single element and object array contains many, the single
13455	metric name array element is applied to each object array element to
13456	form metric/object pairs.
13457	</note>
13458	</desc>
13459	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13460	<desc>
13461	Metric name filter. Comma-separated list of metrics with wildcard
13462	support.
13463	</desc>
13464	</param>
13465	<param name="objects" type="$unknown" dir="in" safearray="yes">
13466	<desc>
13467	Set of objects to disable metrics for.
13468	</desc>
13469	</param>
13470	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13471	<desc>
13472	Array of metrics that have been modified by the call to this method.
13473	</desc>
13474	</param>
13475	</method>
13476
13477	<method name="queryMetricsData">
13478	<desc>
13479	Queries collected metrics data for a set of objects.
13480
13481	The data itself and related metric information are returned in seven
13482	parallel and one flattened array of arrays. Elements of
13483	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13484	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13485	the same index describe one set of values corresponding to a single
13486	metric.
13487
13488	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13489	start and length of a sub-array is indicated by
13490	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13491	value for metric <tt>metricNames[i]</tt> is at
13492	<tt>returnData[returnIndices[i]]</tt>.
13493
13494	<note>
13495	@c Null or empty metric name array means all metrics. @c Null or
13496	empty object array means all existing objects. If metric name array
13497	contains a single element and object array contains many, the single
13498	metric name array element is applied to each object array element to
13499	form metric/object pairs.
13500	</note>
13501	<note>
13502	Data collection continues behind the scenes after call to @c
13503	queryMetricsData. The return data can be seen as the snapshot of the
13504	current state at the time of @c queryMetricsData call. The internally
13505	kept metric values are not cleared by the call. This makes possible
13506	querying different subsets of metrics or aggregates with subsequent
13507	calls. If periodic querying is needed it is highly suggested to query
13508	the values with @c interval*count period to avoid confusion. This way
13509	a completely new set of data values will be provided by each query.
13510	</note>
13511	</desc>
13512	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13513	<desc>
13514	Metric name filter. Comma-separated list of metrics with wildcard
13515	support.
13516	</desc>
13517	</param>
13518	<param name="objects" type="$unknown" dir="in" safearray="yes">
13519	<desc>
13520	Set of objects to query metrics for.
13521	</desc>
13522	</param>
13523	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13524	<desc>
13525	Names of metrics returned in @c returnData.
13526	</desc>
13527	</param>
13528	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13529	<desc>
13530	Objects associated with metrics returned in @c returnData.
13531	</desc>
13532	</param>
13533	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13534	<desc>
13535	Units of measurement for each returned metric.
13536	</desc>
13537	</param>
13538	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13539	<desc>
13540	Divisor that should be applied to return values in order to get
13541	floating point values. For example:
13542	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13543	will retrieve the floating point value of i-th sample of the first
13544	metric.
13545	</desc>
13546	</param>
13547	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13548	<desc>
13549	Sequence numbers of the first elements of value sequences of
13550	particular metrics returned in @c returnData. For aggregate metrics
13551	it is the sequence number of the sample the aggregate started
13552	calculation from.
13553	</desc>
13554	</param>
13555	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13556	<desc>
13557	Indices of the first elements of value sequences of particular
13558	metrics returned in @c returnData.
13559	</desc>
13560	</param>
13561	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13562	<desc>
13563	Lengths of value sequences of particular metrics.
13564	</desc>
13565	</param>
13566	<param name="returnData" type="long" dir="return" safearray="yes">
13567	<desc>
13568	Flattened array of all metric data containing sequences of values for
13569	each metric.
13570	</desc>
13571	</param>
13572	</method>
13573
13574	</interface>
13575	<enum
13576	name="NATAliasMode"
13577	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13578	<desc></desc>
13579	<const name="AliasLog" value="0x1">
13580	<desc></desc>
13581	</const>
13582	<const name="AliasProxyOnly" value="0x02">
13583	<desc></desc>
13584	</const>
13585	<const name="AliasUseSamePorts" value="0x04">
13586	<desc></desc>
13587	</const>
13588	</enum>
13589	<enum
13590	name="NATProtocol"
13591	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13592	>
13593	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13594	<const name="UDP" value="0">
13595	<desc>Port-forwarding uses UDP protocol.</desc>
13596	</const>
13597	<const name="TCP" value="1">
13598	<desc>Port-forwarding uses TCP protocol.</desc>
13599	</const>
13600	</enum>
13601
13602	<interface
13603	name="INATEngine" extends="$unknown"
13604	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13605	wsmap="managed"
13606	>
13607	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13608	allows for changing NAT behavior such as port-forwarding rules. This interface is
13609	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13610	<attribute name="network" type="wstring">
13611	<desc>The network attribute of the NAT engine (the same value is used with built-in
13612	DHCP server to fill corresponding fields of DHCP leases).</desc>
13613	</attribute>
13614	<attribute name="hostIP" type="wstring">
13615	<desc>IP of host interface to bind all opened sockets to.
13616	<note>Changing this does not change binding of port forwarding.</note>
13617	</desc>
13618	</attribute>
13619	<attribute name="tftpPrefix" type="wstring">
13620	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13621	the corresponding fields of DHCP leases.</desc>
13622	</attribute>
13623	<attribute name="tftpBootFile" type="wstring">
13624	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
13625	the corresponding fields of DHCP leases.</desc>
13626	</attribute>
13627	<attribute name="tftpNextServer" type="wstring">
13628	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
13629	the corresponding fields of DHCP leases.
13630	<note>The preferred form is IPv4 addresses.</note>
13631	</desc>
13632	</attribute>
13633	<attribute name="aliasMode" type="unsigned long">
13634	<desc></desc>
13635	</attribute>
13636	<attribute name="dnsPassDomain" type="boolean">
13637	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
13638	</attribute>
13639	<attribute name="dnsProxy" type="boolean">
13640	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13641	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
13642	</attribute>
13643	<attribute name="dnsUseHostResolver" type="boolean">
13644	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13645	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
13646	</attribute>
13647	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
13648	<desc>Array of NAT port-forwarding rules in string representation, in the following
13649	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
13650	</attribute>
13651	<method name="setNetworkSettings">
13652	<desc>Sets network configuration of the NAT engine.</desc>
13653	<param name="mtu" type="unsigned long" dir="in">
13654	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
13655	</param>
13656	<param name="sockSnd" type="unsigned long" dir="in">
13657	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
13658	</param>
13659	<param name="sockRcv" type="unsigned long" dir="in">
13660	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
13661	</param>
13662	<param name="TcpWndSnd" type="unsigned long" dir="in">
13663	<desc>Initial size of the NAT engine's sending TCP window in bytes when
13664	establishing a new TCP connection.</desc>
13665	</param>
13666	<param name="TcpWndRcv" type="unsigned long" dir="in">
13667	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
13668	establishing a new TCP connection.</desc>
13669	</param>
13670	</method>
13671	<method name="getNetworkSettings">
13672	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
13673	for parameter descriptions.</desc>
13674	<param name="mtu" type="unsigned long" dir="out" />
13675	<param name="sockSnd" type="unsigned long" dir="out" />
13676	<param name="sockRcv" type="unsigned long" dir="out" />
13677	<param name="TcpWndSnd" type="unsigned long" dir="out" />
13678	<param name="TcpWndRcv" type="unsigned long" dir="out" />
13679	</method>
13680	<method name="addRedirect">
13681	<desc>Adds a new NAT port-forwarding rule.</desc>
13682	<param name="name" type="wstring" dir="in">
13683	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
13684	auto-generates one using the other parameters.</desc>
13685	</param>
13686	<param name="proto" type="NATProtocol" dir="in">
13687	<desc>Protocol handled with the rule.</desc>
13688	</param>
13689	<param name="hostIp" type="wstring" dir="in">
13690	<desc>IP of the host interface to which the rule should apply. An empty ip address is
13691	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
13692	</param>
13693	<param name="hostPort" type="unsigned short" dir="in">
13694	<desc>The port number to listen on.</desc>
13695	</param>
13696	<param name="guestIp" type="wstring" dir="in">
13697	<desc>The IP address of the guest which the NAT engine will forward matching packets
13698	to. An empty IP address is acceptable, in which case the NAT engine will forward
13699	packets to the first DHCP lease (x.x.x.15).</desc>
13700	</param>
13701	<param name="guestPort" type="unsigned short" dir="in">
13702	<desc>The port number to forward.</desc>
13703	</param>
13704	</method>
13705	<method name="removeRedirect">
13706	<desc>Removes a port-forwarding rule that was previously registered.</desc>
13707	<param name="name" type="wstring" dir="in">
13708	<desc>The name of the rule to delete.</desc>
13709	</param>
13710	</method>
13711	</interface>
13712
13713	<enum
13714	name="VBoxEventType"
13715	uuid="2c76667e-6981-4122-a71a-cdfd6a6eb575">
13716
13717	<desc>
13718	Type of an event.
13719	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
13720	</desc>
13721
13722	<const name="Invalid" value="0">
13723	<desc>
13724	Invalid event, must be first.
13725	</desc>
13726	</const>
13727
13728	<const name="Any" value="1">
13729	<desc>
13730	Wildcard for all events.
13731	Events of this type are never delivered, and only used in
13732	registerListener() call to simplify registration.
13733	</desc>
13734	</const>
13735
13736	<const name="Vetoable" value="2">
13737	<desc>
13738	Wildcard for all vetoable events. Events of this type are never delivered, and only
13739	used in registerListener() call to simplify registration.
13740	</desc>
13741	</const>
13742
13743	<const name="MachineEvent" value="3">
13744	<desc>
13745	Wildcard for all machine events. Events of this type are never delivered, and only used in
13746	registerListener() call to simplify registration.
13747	</desc>
13748	</const>
13749
13750	<const name="SnapshotEvent" value="4">
13751	<desc>
13752	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
13753	registerListener() call to simplify registration.
13754	</desc>
13755	</const>
13756
13757	<const name="InputEvent" value="5">
13758	<desc>
13759	Wildcard for all input device (keyboard, mouse) events.
13760	Events of this type are never delivered, and only used in
13761	registerListener() call to simplify registration.
13762	</desc>
13763	</const>
13764
13765	<const name="LastWildcard" value="31">
13766	<desc>
13767	Last wildcard.
13768	</desc>
13769	</const>
13770
13771	<const name="OnMachineStateChanged" value="32">
13772	<desc>
13773	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
13774	</desc>
13775	</const>
13776	<const name="OnMachineDataChanged" value="33">
13777	<desc>
13778	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
13779	</desc>
13780	</const>
13781	<const name="OnExtraDataChanged" value="34">
13782	<desc>
13783	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
13784	</desc>
13785	</const>
13786	<const name="OnExtraDataCanChange" value="35">
13787	<desc>
13788	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
13789	</desc>
13790	</const>
13791	<const name="OnMediumRegistered" value="36">
13792	<desc>
13793	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
13794	</desc>
13795	</const>
13796	<const name="OnMachineRegistered" value="37">
13797	<desc>
13798	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
13799	</desc>
13800	</const>
13801	<const name="OnSessionStateChanged" value="38">
13802	<desc>
13803	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
13804	</desc>
13805	</const>
13806	<const name="OnSnapshotTaken" value="39">
13807	<desc>
13808	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
13809	</desc>
13810	</const>
13811	<const name="OnSnapshotDeleted" value="40">
13812	<desc>
13813	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
13814	</desc>
13815	</const>
13816	<const name="OnSnapshotChanged" value="41">
13817	<desc>
13818	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
13819	</desc>
13820	</const>
13821	<const name="OnGuestPropertyChanged" value="42">
13822	<desc>
13823	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
13824	</desc>
13825	</const>
13826	<!-- Console events -->
13827	<const name="OnMousePointerShapeChanged" value="43">
13828	<desc>
13829	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
13830	</desc>
13831	</const>
13832	<const name="OnMouseCapabilityChanged" value="44">
13833	<desc>
13834	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
13835	</desc>
13836	</const>
13837	<const name="OnKeyboardLedsChanged" value="45">
13838	<desc>
13839	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
13840	</desc>
13841	</const>
13842	<const name="OnStateChanged" value="46">
13843	<desc>
13844	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
13845	</desc>
13846	</const>
13847	<const name="OnAdditionsStateChanged" value="47">
13848	<desc>
13849	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
13850	</desc>
13851	</const>
13852	<const name="OnNetworkAdapterChanged" value="48">
13853	<desc>
13854	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
13855	</desc>
13856	</const>
13857	<const name="OnSerialPortChanged" value="49">
13858	<desc>
13859	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
13860	</desc>
13861	</const>
13862	<const name="OnParallelPortChanged" value="50">
13863	<desc>
13864	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
13865	</desc>
13866	</const>
13867	<const name="OnStorageControllerChanged" value="51">
13868	<desc>
13869	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
13870	</desc>
13871	</const>
13872	<const name="OnMediumChanged" value="52">
13873	<desc>
13874	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
13875	</desc>
13876	</const>
13877	<const name="OnVRDPServerChanged" value="53">
13878	<desc>
13879	See <link to="IVRDPServerChangedEvent">IVRDPServerChangedEvent</link>.
13880	</desc>
13881	</const>
13882	<const name="OnUSBControllerChanged" value="54">
13883	<desc>
13884	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
13885	</desc>
13886	</const>
13887	<const name="OnUSBDeviceStateChanged" value="55">
13888	<desc>
13889	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
13890	</desc>
13891	</const>
13892	<const name="OnSharedFolderChanged" value="56">
13893	<desc>
13894	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
13895	</desc>
13896	</const>
13897	<const name="OnRuntimeError" value="57">
13898	<desc>
13899	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
13900	</desc>
13901	</const>
13902	<const name="OnCanShowWindow" value="58">
13903	<desc>
13904	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
13905	</desc>
13906	</const>
13907	<const name="OnShowWindow" value="59">
13908	<desc>
13909	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
13910	</desc>
13911	</const>
13912	<const name="OnCPUChanged" value="60">
13913	<desc>
13914	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
13915	</desc>
13916	</const>
13917	<const name="OnRemoteDisplayInfoChanged" value="61">
13918	<desc>
13919	See <link to="IRemoteDisplayInfoChangedEvent">IRemoteDisplayInfoChangedEvent</link>.
13920	</desc>
13921	</const>
13922	<const name="OnEventSourceChanged" value="62">
13923	<desc>
13924	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
13925	</desc>
13926	</const>
13927	<const name="OnCPUPriorityChanged" value="63">
13928	<desc>
13929	See <link to="ICPUPriorityChangedEvent">ICPUPriorityChangedEvent</link>.
13930	</desc>
13931	</const>
13932	<!-- Last event marker -->
13933	<const name="Last" value="64">
13934	<desc>
13935	Must be last event, used for iterations and structures relying on numerical event values.
13936	</desc>
13937	</const>
13938
13939	</enum>
13940
13941	<interface
13942	name="IEventSource" extends="$unknown"
13943	uuid="3c670618-f727-4fe9-94d2-8243f489a033"
13944	wsmap="managed"
13945	>
13946	<desc>
13947	Event source. Generally, any object which could generate events can be an event source,
13948	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
13949	an event source can work with listeners in either active or passive mode. In active mode it is up to
13950	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
13951	event source keeps track of pending events for each listener and returns available events on demand.
13952
13953	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
13954	</desc>
13955
13956	<method name="createListener">
13957	<desc>
13958	Creates a new listener object, useful for passive mode.
13959	</desc>
13960	<param name="listener" type="IEventListener" dir="return"/>
13961	</method>
13962
13963	<method name="registerListener">
13964	<desc>
13965	Register an event listener.
13966
13967	<note>
13968	To avoid system overload, the VirtualBox server process checks if passive event
13969	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
13970	current implementation, if more than 100 pending events are detected for a passive
13971	event listener, it is forcefully unregistered by the system, and further
13972	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
13973	</note>
13974	</desc>
13975	<param name="listener" type="IEventListener" dir="in">
13976	<desc>Listener to register.</desc>
13977	</param>
13978	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
13979	<desc>
13980	Event types listener is interested in. One can use wildcards like -
13981	<link to="VBoxEventType::Any"/> to specify wildcards, matching more
13982	than one event.
13983	</desc>
13984	</param>
13985	<param name="active" type="boolean" dir="in">
13986	<desc>
13987	Which mode this listener is operating in.
13988	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
13989	In passive mode, an internal event queue is created for this this IEventListener.
13990	For each event coming in, it is added to queues for all interested registered passive
13991	listeners. It is then up to the external code to call the listener's
13992	<link to="IEventListener::handleEvent" /> method. When done with an event, the
13993	external code must call <link to="#eventProcessed" />.
13994	</desc>
13995	</param>
13996	</method>
13997
13998	<method name="unregisterListener">
13999	<desc>
14000	Unregister an event listener. If listener is passive, and some waitable events are still
14001	in queue they are marked as processed automatically.
14002	</desc>
14003	<param name="listener" type="IEventListener" dir="in">
14004	<desc>Listener to unregister.</desc>
14005	</param>
14006	</method>
14007
14008	<method name="fireEvent">
14009	<desc>
14010	Fire an event for this source.
14011	</desc>
14012	<param name="event" type="IEvent" dir="in">
14013	<desc>Event to deliver.</desc>
14014	</param>
14015	<param name="timeout" type="long" dir="in">
14016	<desc>
14017	Maximum time to wait for event processing (if event is waitable), in ms;
14018	0 = no wait, -1 = indefinite wait.
14019	</desc>
14020	</param>
14021	<param name="result" type="boolean" dir="return">
14022	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14023	</param>
14024	</method>
14025
14026	<method name="getEvent">
14027	<desc>
14028	Get events from this peer's event queue (for passive mode). Calling this method
14029	regularly is required for passive event listeners to avoid system overload;
14030	see <link to="IEventSource::registerListener" /> for details.
14031
14032	<result name="VBOX_E_OBJECT_NOT_FOUND">
14033	Listener is not registered, or autounregistered.
14034	</result>
14035	</desc>
14036	<param name="listener" type="IEventListener" dir="in">
14037	<desc>Which listener to get data for.</desc>
14038	</param>
14039	<param name="timeout" type="long" dir="in">
14040	<desc>
14041	Maximum time to wait for events, in ms;
14042	0 = no wait, -1 = indefinite wait.
14043	</desc>
14044	</param>
14045	<param name="event" type="IEvent" dir="return">
14046	<desc>Event retrieved, or null if none available.</desc>
14047	</param>
14048	</method>
14049
14050	<method name="eventProcessed">
14051	<desc>
14052	Must be called for waitable events after a particular listener finished its
14053	event processing. When all listeners of a particular event have called this
14054	method, the system will then call <link to="IEvent::setProcessed" />.
14055	</desc>
14056	<param name="listener" type="IEventListener" dir="in">
14057	<desc>Which listener processed event.</desc>
14058	</param>
14059	<param name="event" type="IEvent" dir="in">
14060	<desc>Which event.</desc>
14061	</param>
14062	</method>
14063
14064	</interface>
14065
14066	<interface
14067	name="IEventListener" extends="$unknown"
14068	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14069	wsmap="managed"
14070	>
14071	<desc>
14072	Event listener. An event listener can work in either active or passive mode, depending on the way
14073	it was registered.
14074	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14075	</desc>
14076
14077	<method name="handleEvent">
14078	<desc>
14079	Handle event callback (called directly by IEventSource in active mode, or could be
14080	called by event processor thread in passive mode).
14081	</desc>
14082	<param name="event" type="IEvent" dir="in">
14083	<desc>Event available.</desc>
14084	</param>
14085	</method>
14086
14087	</interface>
14088
14089	<interface
14090	name="IEvent" extends="$unknown"
14091	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14092	wsmap="managed"
14093	>
14094	<desc>
14095	Abstract parent interface for VirtualBox events. Actual events will typically implement
14096	a more specific interface which derives from this (see below).
14097
14098	<b>Introduction to VirtualBox events</b>
14099
14100	Generally speaking, an event (represented by this interface) signals that something
14101	happened, while an event listener (see <link to="IEventListener" />) represents an
14102	entity that is interested in certain events. In order for this to work with
14103	unidirectional protocols (i.e. web services), the concepts of passive and active
14104	listener are used.
14105
14106	Event consumers can register themselves as listeners, providing an array of
14107	events they are interested in (see <link to="IEventSource::registerListener" />).
14108	When an event triggers, the listener is notified about the event. The exact
14109	mechanism of the notification depends on whether the listener was registered as
14110	an active or passive listener:
14111
14112	<ul>
14113	<li>An active listener is very similar to a callback: it is a function invoked
14114	by the API. As opposed to the callbacks that were used in the API before
14115	VirtualBox 3.3 however, events are now objects with an interface hierarchy.
14116	</li>
14117
14118	<li>Passive listeners are somewhat tricker to implement, but do not require
14119	a client function to be callable, which is not an option with scripting
14120	languages or web service clients. Internally the <link to="IEventSource" />
14121	implementation maintains an event queue for each passive listener, and
14122	newly arrived events are put in this queue. When the listener calls
14123	<link to="IEventSource::getEvent"/>, first element from its internal event
14124	queue is returned. When the client completes processing of an event,
14125	the <link to="IEventSource::eventProcessed" /> function must be called,
14126	acknowledging that the event was processed. It supports implementing
14127	waitable events. On passive listener unregistration, all events from its
14128	queue are auto-acknowledged.
14129	</li>
14130	</ul>
14131
14132	Waitable events are useful in situations where the event generator wants to track
14133	delivery or a party wants to wait until all listeners have completed the event. A
14134	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14135	listeners might veto a certain action, and thus the event producer has to make
14136	sure that all listeners have processed the event and not vetoed before taking
14137	the action.
14138
14139	A given event may have both passive and active listeners at the same time.
14140
14141	<b>Using events</b>
14142
14143	Any VirtualBox object capable of producing externally visible events provides an
14144	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14145	This event source object is notified by VirtualBox once something has happened, so
14146	consumers may register event listeners with this event source. To register a listener,
14147	an object implementing the <link to="IEventListener" /> interface must be provided.
14148	For active listeners, such an object is typically created by the consumer, while for
14149	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14150	note that a listener created with @c createListener() must not be used as an active listener.
14151
14152	Once created, the listener must be registered to listen for the desired events
14153	(see <link to="IEventSource::registerListener" />), providing an array of
14154	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14155	event IDs or wildcards matching multiple event IDs.
14156
14157	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14158	called automatically when the event is triggered, while passive listeners have to call
14159	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14160	an event processing loop.
14161
14162	The IEvent interface is an abstract parent interface for all such VirtualBox events
14163	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14164	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14165	then cast to the appropriate specific interface using @c QueryInterface().
14166	</desc>
14167
14168	<attribute name="type" readonly="yes" type="VBoxEventType">
14169	<desc>
14170	Event type.
14171	</desc>
14172	</attribute>
14173
14174	<attribute name="source" readonly="yes" type="IEventSource">
14175	<desc>
14176	Source of this event.
14177	</desc>
14178	</attribute>
14179
14180	<attribute name="waitable" readonly="yes" type="boolean">
14181	<desc>
14182	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14183	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14184	as no additional overhead associated with waitability imposed.
14185	Waitable events are needed when one need to be able to wait for particular event processed,
14186	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14187	until all consumers confirmed events.
14188	</desc>
14189	</attribute>
14190
14191	<method name="setProcessed">
14192	<desc>
14193	Internal method called by the system when all listeners of a particular event have called
14194	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14195	</desc>
14196	</method>
14197
14198	<method name="waitProcessed">
14199	<desc>
14200	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14201	described semantics, for non-waitable returns true immediately.
14202	</desc>
14203	<param name="timeout" type="long" dir="in">
14204	<desc>
14205	Maximum time to wait for event processeing, in ms;
14206	0 = no wait, -1 = indefinite wait.
14207	</desc>
14208	</param>
14209	<param name="result" type="boolean" dir="return">
14210	<desc>If this event was processed before timeout.</desc>
14211	</param>
14212	</method>
14213	</interface>
14214
14215
14216	<interface
14217	name="IReusableEvent" extends="IEvent"
14218	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
14219	wsmap="managed"
14220	>
14221	<desc>Base abstract interface for all reusable events.</desc>
14222
14223	<attribute name="generation" readonly="yes" type="unsigned long">
14224	<desc>Current generation of event, incremented on reuse.</desc>
14225	</attribute>
14226
14227	<method name="reuse">
14228	<desc>
14229	Marks an event as reused, increments 'generation', fields shall no
14230	longer be considered valid.
14231	</desc>
14232	</method>
14233	</interface>
14234
14235	<interface
14236	name="IMachineEvent" extends="IEvent"
14237	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14238	wsmap="managed" id="MachineEvent"
14239	>
14240	<desc>Base abstract interface for all machine events.</desc>
14241
14242	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14243	<desc>ID of the machine this event relates to.</desc>
14244	</attribute>
14245
14246	</interface>
14247
14248	<interface
14249	name="IMachineStateChangedEvent" extends="IMachineEvent"
14250	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14251	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14252	>
14253	<desc>Machine state change event.</desc>
14254
14255	<attribute name="state" readonly="yes" type="MachineState">
14256	<desc>New execution state.</desc>
14257	</attribute>
14258	</interface>
14259
14260	<interface
14261	name="IMachineDataChangedEvent" extends="IMachineEvent"
14262	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14263	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14264	>
14265	<desc>
14266	Any of the settings of the given machine has changed.
14267	</desc>
14268	</interface>
14269
14270	<interface
14271	name="IMediumRegisteredEvent" extends="IEvent"
14272	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
14273	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
14274	>
14275	<desc>
14276	The given medium was registered or unregistered
14277	within this VirtualBox installation.
14278	</desc>
14279
14280	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
14281	<desc>ID of the medium this event relates to.</desc>
14282	</attribute>
14283
14284	<attribute name="mediumType" readonly="yes" type="DeviceType">
14285	<desc>Type of the medium this event relates to.</desc>
14286	</attribute>
14287
14288	<attribute name="registered" type="boolean" readonly="yes">
14289	<desc>
14290	If @c true, the medium was registered, otherwise it was
14291	unregistered.
14292	</desc>
14293	</attribute>
14294	</interface>
14295
14296	<interface
14297	name="IMachineRegisteredEvent" extends="IMachineEvent"
14298	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14299	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14300	>
14301	<desc>
14302	The given machine was registered or unregistered
14303	within this VirtualBox installation.
14304	</desc>
14305
14306	<attribute name="registered" type="boolean" readonly="yes">
14307	<desc>
14308	If @c true, the machine was registered, otherwise it was
14309	unregistered.
14310	</desc>
14311	</attribute>
14312	</interface>
14313
14314	<interface
14315	name="ISessionStateChangedEvent" extends="IMachineEvent"
14316	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14317	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14318	>
14319	<desc>
14320	The state of the session for the given machine was changed.
14321	<see>IMachine::sessionState</see>
14322	</desc>
14323
14324	<attribute name="state" type="SessionState" readonly="yes">
14325	<desc>
14326	New session state.
14327	</desc>
14328	</attribute>
14329	</interface>
14330
14331	<interface
14332	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14333	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14334	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14335	>
14336	<desc>
14337	Notification when a guest property has changed.
14338	</desc>
14339
14340	<attribute name="name" readonly="yes" type="wstring">
14341	<desc>
14342	The name of the property that has changed.
14343	</desc>
14344	</attribute>
14345
14346	<attribute name="value" readonly="yes" type="wstring">
14347	<desc>
14348	The new property value.
14349	</desc>
14350	</attribute>
14351
14352	<attribute name="flags" readonly="yes" type="wstring">
14353	<desc>
14354	The new property flags.
14355	</desc>
14356	</attribute>
14357
14358	</interface>
14359
14360	<interface
14361	name="ISnapshotEvent" extends="IMachineEvent"
14362	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14363	wsmap="managed" id="SnapshotEvent"
14364	>
14365	<desc>Base interface for all snapshot events.</desc>
14366
14367	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14368	<desc>ID of the snapshot this event relates to.</desc>
14369	</attribute>
14370
14371	</interface>
14372
14373	<interface
14374	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14375	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14376	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14377	>
14378	<desc>
14379	A new snapshot of the machine has been taken.
14380	<see>ISnapshot</see>
14381	</desc>
14382	</interface>
14383
14384	<interface
14385	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14386	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14387	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14388	>
14389	<desc>
14390	Snapshot of the given machine has been deleted.
14391
14392	<note>
14393	This notification is delivered <b>after</b> the snapshot
14394	object has been uninitialized on the server (so that any
14395	attempt to call its methods will return an error).
14396	</note>
14397
14398	<see>ISnapshot</see>
14399	</desc>
14400	</interface>
14401
14402	<interface
14403	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14404	uuid="07541941-8079-447a-a33e-47a69c7980db"
14405	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14406	>
14407	<desc>
14408	Snapshot properties (name and/or description) have been changed.
14409	<see>ISnapshot</see>
14410	</desc>
14411	</interface>
14412
14413	<interface
14414	name="IMousePointerShapeChangedEvent" extends="IEvent"
14415	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14416	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14417	>
14418	<desc>
14419	Notification when the guest mouse pointer shape has
14420	changed. The new shape data is given.
14421	</desc>
14422
14423	<attribute name="visible" type="boolean" readonly="yes">
14424	<desc>
14425	Flag whether the pointer is visible.
14426	</desc>
14427	</attribute>
14428	<attribute name="alpha" type="boolean" readonly="yes">
14429	<desc>
14430	Flag whether the pointer has an alpha channel.
14431	</desc>
14432	</attribute>
14433	<attribute name="xhot" type="unsigned long" readonly="yes">
14434	<desc>
14435	The pointer hot spot X coordinate.
14436	</desc>
14437	</attribute>
14438	<attribute name="yhot" type="unsigned long" readonly="yes">
14439	<desc>
14440	The pointer hot spot Y coordinate.
14441	</desc>
14442	</attribute>
14443	<attribute name="width" type="unsigned long" readonly="yes">
14444	<desc>
14445	Width of the pointer shape in pixels.
14446	</desc>
14447	</attribute>
14448	<attribute name="height" type="unsigned long" readonly="yes">
14449	<desc>
14450	Height of the pointer shape in pixels.
14451	</desc>
14452	</attribute>
14453	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14454	<desc>
14455	Shape buffer arrays.
14456
14457	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14458	followed by a 32-bpp XOR (color) mask.
14459
14460	For pointers without alpha channel the XOR mask pixels are 32
14461	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14462	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14463
14464	An AND mask is used for pointers with alpha channel, so if the
14465	callback does not support alpha, the pointer could be
14466	displayed as a normal color pointer.
14467
14468	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14469	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14470	height</tt>. The padding bits at the end of each scanline are
14471	undefined.
14472
14473	The XOR mask follows the AND mask on the next 4-byte aligned
14474	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14475	Bytes in the gap between the AND and the XOR mask are undefined.
14476	The XOR mask scanlines have no gap between them and the size of
14477	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14478
14479	<note>
14480	If @a shape is 0, only the pointer visibility is changed.
14481	</note>
14482	</desc>
14483	</attribute>
14484	</interface>
14485
14486	<interface
14487	name="IMouseCapabilityChangedEvent" extends="IEvent"
14488	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
14489	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
14490	>
14491	<desc>
14492	Notification when the mouse capabilities reported by the
14493	guest have changed. The new capabilities are passed.
14494	</desc>
14495	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
14496	<desc>
14497	Supports absolute coordinates.
14498	</desc>
14499	</attribute>
14500	<attribute name="supportsRelative" type="boolean" readonly="yes">
14501	<desc>
14502	Supports relative coordinates.
14503	</desc>
14504	</attribute>
14505	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14506	<desc>
14507	If host cursor is needed.
14508	</desc>
14509	</attribute>
14510	</interface>
14511
14512	<interface
14513	name="IKeyboardLedsChangedEvent" extends="IEvent"
14514	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
14515	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
14516	>
14517	<desc>
14518	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
14519	to alter the state of the keyboard LEDs.
14520	</desc>
14521	<attribute name="numLock" type="boolean" readonly="yes">
14522	<desc>
14523	NumLock status.
14524	</desc>
14525	</attribute>
14526	<attribute name="capsLock" type="boolean" readonly="yes">
14527	<desc>
14528	CapsLock status.
14529	</desc>
14530	</attribute>
14531	<attribute name="scrollLock" type="boolean" readonly="yes">
14532	<desc>
14533	ScrollLock status.
14534	</desc>
14535	</attribute>
14536	</interface>
14537
14538	<interface
14539	name="IStateChangedEvent" extends="IEvent"
14540	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
14541	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
14542	>
14543	<desc>
14544	Notification when the execution state of the machine has changed.
14545	The new state is given.
14546	</desc>
14547	<attribute name="state" type="MachineState" readonly="yes">
14548	<desc>
14549	New machine state.
14550	</desc>
14551	</attribute>
14552	</interface>
14553
14554	<interface
14555	name="IAdditionsStateChangedEvent" extends="IEvent"
14556	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
14557	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
14558	>
14559	<desc>
14560	Notification when a Guest Additions property changes.
14561	Interested callees should query IGuest attributes to
14562	find out what has changed.
14563	</desc>
14564	</interface>
14565
14566	<interface
14567	name="INetworkAdapterChangedEvent" extends="IEvent"
14568	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
14569	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
14570	>
14571	<desc>
14572	Notification when a property of one of the
14573	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
14574	changes. Interested callees should use INetworkAdapter methods and
14575	attributes to find out what has changed.
14576	</desc>
14577	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
14578	<desc>
14579	Network adapter that is subject to change.
14580	</desc>
14581	</attribute>
14582	</interface>
14583
14584	<interface
14585	name="ISerialPortChangedEvent" extends="IEvent"
14586	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
14587	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
14588	>
14589	<desc>
14590	Notification when a property of one of the
14591	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
14592	Interested callees should use ISerialPort methods and attributes
14593	to find out what has changed.
14594	</desc>
14595	<attribute name="serialPort" type="ISerialPort" readonly="yes">
14596	<desc>
14597	Serial port that is subject to change.
14598	</desc>
14599	</attribute>
14600	</interface>
14601
14602	<interface
14603	name="IParallelPortChangedEvent" extends="IEvent"
14604	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
14605	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
14606	>
14607	<desc>
14608	Notification when a property of one of the
14609	virtual <link to="IMachine::getParallelPort">parallel ports</link>
14610	changes. Interested callees should use ISerialPort methods and
14611	attributes to find out what has changed.
14612	</desc>
14613	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
14614	<desc>
14615	Parallel port that is subject to change.
14616	</desc>
14617	</attribute>
14618	</interface>
14619
14620	<interface
14621	name="IStorageControllerChangedEvent" extends="IEvent"
14622	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
14623	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
14624	>
14625	<desc>
14626	Notification when a
14627	<link to="IMachine::mediumAttachments">medium attachment</link>
14628	changes.
14629	</desc>
14630	</interface>
14631
14632	<interface
14633	name="IMediumChangedEvent" extends="IEvent"
14634	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
14635	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
14636	>
14637	<desc>
14638	Notification when a
14639	<link to="IMachine::mediumAttachments">medium attachment</link>
14640	changes.
14641	</desc>
14642	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
14643	<desc>
14644	Medium attachment that is subject to change.
14645	</desc>
14646	</attribute>
14647	</interface>
14648
14649	<interface
14650	name="ICPUChangedEvent" extends="IEvent"
14651	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
14652	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
14653	>
14654	<desc>
14655	Notification when a CPU changes.
14656	</desc>
14657	<attribute name="cpu" type="unsigned long" readonly="yes">
14658	<desc>
14659	The CPU which changed.
14660	</desc>
14661	</attribute>
14662	<attribute name="add" type="boolean" readonly="yes">
14663	<desc>
14664	Flag whether the CPU was added or removed.
14665	</desc>
14666	</attribute>
14667	</interface>
14668
14669	<interface
14670	name="ICPUPriorityChangedEvent" extends="IEvent"
14671	uuid="657fe2fe-a75a-4cb6-8cf9-072aa41e7d75"
14672	wsmap="managed" autogen="VBoxEvent" id="OnCPUPriorityChanged"
14673	>
14674	<desc>
14675	Notification when the CPU priority changes.
14676	</desc>
14677	<attribute name="priority" type="unsigned long" readonly="yes">
14678	<desc>
14679	The new CPU priority value. (1-100)
14680	</desc>
14681	</attribute>
14682	</interface>
14683
14684	<interface
14685	name="IVRDPServerChangedEvent" extends="IEvent"
14686	uuid="726038B6-6279-4A7A-8037-D041693D1915"
14687	wsmap="managed" autogen="VBoxEvent" id="OnVRDPServerChanged"
14688	>
14689	<desc>
14690	Notification when a property of the
14691	<link to="IMachine::VRDPServer">VRDP server</link> changes.
14692	Interested callees should use IVRDPServer methods and attributes to
14693	find out what has changed.
14694	</desc>
14695	</interface>
14696
14697	<interface
14698	name="IRemoteDisplayInfoChangedEvent" extends="IEvent"
14699	uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
14700	wsmap="managed" autogen="VBoxEvent" id="OnRemoteDisplayInfoChanged"
14701	>
14702	<desc>
14703	Notification when the status of the VRDP server changes. Interested callees
14704	should use <link to="IConsole::remoteDisplayInfo">IRemoteDisplayInfo</link>
14705	attributes to find out what is the current status.
14706	</desc>
14707	</interface>
14708
14709	<interface
14710	name="IUSBControllerChangedEvent" extends="IEvent"
14711	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
14712	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
14713	>
14714	<desc>
14715	Notification when a property of the virtual
14716	<link to="IMachine::USBController">USB controller</link> changes.
14717	Interested callees should use IUSBController methods and attributes to
14718	find out what has changed.
14719	</desc>
14720	</interface>
14721
14722	<interface
14723	name="IUSBDeviceStateChangedEvent" extends="IEvent"
14724	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
14725	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
14726	>
14727	<desc>
14728	Notification when a USB device is attached to or detached from
14729	the virtual USB controller.
14730
14731	This notification is sent as a result of the indirect
14732	request to attach the device because it matches one of the
14733	machine USB filters, or as a result of the direct request
14734	issued by <link to="IConsole::attachUSBDevice"/> or
14735	<link to="IConsole::detachUSBDevice"/>.
14736
14737	This notification is sent in case of both a succeeded and a
14738	failed request completion. When the request succeeds, the
14739	@a error parameter is @c null, and the given device has been
14740	already added to (when @a attached is @c true) or removed from
14741	(when @a attached is @c false) the collection represented by
14742	<link to="IConsole::USBDevices"/>. On failure, the collection
14743	doesn't change and the @a error parameter represents the error
14744	message describing the failure.
14745	</desc>
14746	<attribute name="device" type="IUSBDevice" readonly="yes">
14747	<desc>
14748	Device that is subject to state change.
14749	</desc>
14750	</attribute>
14751	<attribute name="attached" type="boolean" readonly="yes">
14752	<desc>
14753	@c true if the device was attached and @c false otherwise.
14754	</desc>
14755	</attribute>
14756	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
14757	<desc>
14758	@c null on success or an error message object on failure.
14759	</desc>
14760	</attribute>
14761	</interface>
14762
14763	<interface
14764	name="ISharedFolderChangedEvent" extends="IEvent"
14765	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
14766	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
14767	>
14768	<desc>
14769	Notification when a shared folder is added or removed.
14770	The @a scope argument defines one of three scopes:
14771	<link to="IVirtualBox::sharedFolders">global shared folders</link>
14772	(<link to="Scope::Global">Global</link>),
14773	<link to="IMachine::sharedFolders">permanent shared folders</link> of
14774	the machine (<link to="Scope::Machine">Machine</link>) or <link
14775	to="IConsole::sharedFolders">transient shared folders</link> of the
14776	machine (<link to="Scope::Session">Session</link>). Interested callees
14777	should use query the corresponding collections to find out what has
14778	changed.
14779	</desc>
14780	<attribute name="scope" type="Scope" readonly="yes">
14781	<desc>
14782	Scope of the notification.
14783	</desc>
14784	</attribute>
14785	</interface>
14786
14787	<interface
14788	name="IRuntimeErrorEvent" extends="IEvent"
14789	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
14790	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
14791	>
14792	<desc>
14793	Notification when an error happens during the virtual
14794	machine execution.
14795
14796	There are three kinds of runtime errors:
14797	<ul>
14798	<li><i>fatal</i></li>
14799	<li><i>non-fatal with retry</i></li>
14800	<li><i>non-fatal warnings</i></li>
14801	</ul>
14802
14803	<b>Fatal</b> errors are indicated by the @a fatal parameter set
14804	to @c true. In case of fatal errors, the virtual machine
14805	execution is always paused before calling this notification, and
14806	the notification handler is supposed either to immediately save
14807	the virtual machine state using <link to="IConsole::saveState"/>
14808	or power it off using <link to="IConsole::powerDown"/>.
14809	Resuming the execution can lead to unpredictable results.
14810
14811	<b>Non-fatal</b> errors and warnings are indicated by the
14812	@a fatal parameter set to @c false. If the virtual machine
14813	is in the Paused state by the time the error notification is
14814	received, it means that the user can <i>try to resume</i> the machine
14815	execution after attempting to solve the problem that caused the
14816	error. In this case, the notification handler is supposed
14817	to show an appropriate message to the user (depending on the
14818	value of the @a id parameter) that offers several actions such
14819	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
14820	wants to retry, the notification handler should continue
14821	the machine execution using the <link to="IConsole::resume"/>
14822	call. If the machine execution is not Paused during this
14823	notification, then it means this notification is a <i>warning</i>
14824	(for example, about a fatal condition that can happen very soon);
14825	no immediate action is required from the user, the machine
14826	continues its normal execution.
14827
14828	Note that in either case the notification handler
14829	<b>must not</b> perform any action directly on a thread
14830	where this notification is called. Everything it is allowed to
14831	do is to post a message to another thread that will then talk
14832	to the user and take the corresponding action.
14833
14834	Currently, the following error identifiers are known:
14835	<ul>
14836	<li><tt>"HostMemoryLow"</tt></li>
14837	<li><tt>"HostAudioNotResponding"</tt></li>
14838	<li><tt>"VDIStorageFull"</tt></li>
14839	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
14840	</ul>
14841	</desc>
14842	<attribute name="fatal" type="boolean" readonly="yes">
14843	<desc>
14844	Whether the error is fatal or not.
14845	</desc>
14846	</attribute>
14847	<attribute name="id" type="wstring" readonly="yes">
14848	<desc>
14849	Error identifier.
14850	</desc>
14851	</attribute>
14852	<attribute name="message" type="wstring" readonly="yes">
14853	<desc>
14854	Optional error message.
14855	</desc>
14856	</attribute>
14857	</interface>
14858
14859
14860	<interface
14861	name="IEventSourceChangedEvent" extends="IEvent"
14862	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
14863	waitable="yes"
14864	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
14865	>
14866	<desc>
14867	Notification when an event source state changes (listener added or removed).
14868	</desc>
14869
14870	<attribute name="listener" type="IEventListener" readonly="yes">
14871	<desc>
14872	Event listener which has changed.
14873	</desc>
14874	</attribute>
14875
14876	<attribute name="add" type="boolean" readonly="yes">
14877	<desc>
14878	Flag whether listener was added or removed.
14879	</desc>
14880	</attribute>
14881	</interface>
14882
14883	<interface
14884	name="IExtraDataChangedEvent" extends="IEvent"
14885	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
14886	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
14887	>
14888	<desc>
14889	Notification when machine specific or global extra data
14890	has changed.
14891	</desc>
14892	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
14893	<desc>
14894	ID of the machine this event relates to.
14895	Null for global extra data changes.
14896	</desc>
14897	</attribute>
14898	<attribute name="key" type="wstring" readonly="yes">
14899	<desc>
14900	Extra data key that has changed.
14901	</desc>
14902	</attribute>
14903	<attribute name="value" type="wstring" readonly="yes">
14904	<desc>
14905	Extra data value for the given key.
14906	</desc>
14907	</attribute>
14908	</interface>
14909
14910	<interface
14911	name="IVetoEvent" extends="IEvent"
14912	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
14913	wsmap="managed"
14914	>
14915	<desc>Base abstract interface for veto events.</desc>
14916
14917	<method name="addVeto">
14918	<desc>
14919	Adds a veto on this event.
14920	</desc>
14921	<param name="reason" type="wstring" dir="in">
14922	<desc>
14923	Reason for veto, could be null or empty string.
14924	</desc>
14925	</param>
14926	</method>
14927
14928	<method name="isVetoed">
14929	<desc>
14930	If this event was vetoed.
14931	</desc>
14932	<param name="result" type="boolean" dir="return">
14933	<desc>
14934	Reason for veto.
14935	</desc>
14936	</param>
14937	</method>
14938
14939	<method name="getVetos">
14940	<desc>
14941	Current veto reason list, if size is 0 - no veto.
14942	</desc>
14943	<param name="result" type="wstring" dir="return" safearray="yes">
14944	<desc>
14945	Array of reasons for veto provided by different event handlers.
14946	</desc>
14947	</param>
14948	</method>
14949
14950	</interface>
14951
14952	<interface
14953	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
14954	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
14955	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
14956	waitable="true"
14957	>
14958	<desc>
14959	Notification when someone tries to change extra data for
14960	either the given machine or (if @c null) global extra data.
14961	This gives the chance to veto against changes.
14962	</desc>
14963	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
14964	<desc>
14965	ID of the machine this event relates to.
14966	Null for global extra data changes.
14967	</desc>
14968	</attribute>
14969	<attribute name="key" type="wstring" readonly="yes">
14970	<desc>
14971	Extra data key that has changed.
14972	</desc>
14973	</attribute>
14974	<attribute name="value" type="wstring" readonly="yes">
14975	<desc>
14976	Extra data value for the given key.
14977	</desc>
14978	</attribute>
14979	</interface>
14980
14981	<interface
14982	name="ICanShowWindowEvent" extends="IVetoEvent"
14983	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
14984	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
14985	waitable="true"
14986	>
14987	<desc>
14988	Notification when a call to
14989	<link to="IMachine::canShowConsoleWindow"/> is made by a
14990	front-end to check if a subsequent call to
14991	<link to="IMachine::showConsoleWindow"/> can succeed.
14992
14993	The callee should give an answer appropriate to the current
14994	machine state using event veto. This answer must
14995	remain valid at least until the next
14996	<link to="IConsole::state">machine state</link> change.
14997	</desc>
14998	</interface>
14999
15000	<interface
15001	name="IShowWindowEvent" extends="IEvent"
15002	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
15003	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
15004	waitable="true"
15005	>
15006	<desc>
15007	Notification when a call to
15008	<link to="IMachine::showConsoleWindow"/>
15009	requests the console window to be activated and brought to
15010	foreground on the desktop of the host PC.
15011
15012	This notification should cause the VM console process to
15013	perform the requested action as described above. If it is
15014	impossible to do it at a time of this notification, this
15015	method should return a failure.
15016
15017	Note that many modern window managers on many platforms
15018	implement some sort of focus stealing prevention logic, so
15019	that it may be impossible to activate a window without the
15020	help of the currently active application (which is supposedly
15021	an initiator of this notification). In this case, this method
15022	must return a non-zero identifier that represents the
15023	top-level window of the VM console process. The caller, if it
15024	represents a currently active process, is responsible to use
15025	this identifier (in a platform-dependent manner) to perform
15026	actual window activation.
15027
15028	This method must set @a winId to zero if it has performed all
15029	actions necessary to complete the request and the console
15030	window is now active and in foreground, to indicate that no
15031	further action is required on the caller's side.
15032	</desc>
15033	<attribute name="winId" type="long long">
15034	<desc>
15035	Platform-dependent identifier of the top-level VM console
15036	window, or zero if this method has performed all actions
15037	necessary to implement the <i>show window</i> semantics for
15038	the given platform and/or this VirtualBox front-end.
15039	</desc>
15040	</attribute>
15041	</interface>
15042
15043	<module name="VBoxSVC" context="LocalServer">
15044	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15045	namespace="virtualbox.org">
15046	<interface name="IVirtualBox" default="yes"/>
15047	</class>
15048	</module>
15049
15050	<module name="VBoxC" context="InprocServer" threadingModel="Free">
15051	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
15052	namespace="virtualbox.org">
15053	<interface name="ISession" default="yes"/>
15054	</class>
15055
15056	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
15057	namespace="virtualbox.org">
15058	<interface name="IConsole" default="yes"/>
15059	</class>
15060	</module>
15061
15062	</library>
15063
15064	</idl>
15065
15066	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format