VirtualBox.xidl@ 33526

Last change on this file since 33526 was 33526, checked in by vboxsync, 14 years ago
Fix burn
Property svn:eol-style set to `native`
File size: 569.9 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	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</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 4.0.x.</desc>
470	<!-- Machine changes: HD Audio controller, per-machine disk registries,
471	/@format attribute for DVD and floppy images.
472	-->
473	</const>
474	<const name="Future" value="99999">
475	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
476	</const>
477	</enum>
478
479	<enum
480	name="AccessMode"
481	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
482	>
483	<desc>
484	Access mode for opening files.
485	</desc>
486
487	<const name="ReadOnly" value="1"/>
488	<const name="ReadWrite" value="2"/>
489	</enum>
490
491	<enum
492	name="MachineState"
493	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
494	>
495	<desc>
496	Virtual machine execution state.
497
498	This enumeration represents possible values of the <link
499	to="IMachine::state"/> attribute.
500
501	Below is the basic virtual machine state diagram. It shows how the state
502	changes during virtual machine execution. The text in square braces shows
503	a method of the IConsole interface that performs the given state
504	transition.
505
506	<pre>
507	+---------[powerDown()] <- Stuck <--[failure]-+
508	V \|
509	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
510	\| \| \| \| V \|
511	\| Aborted -----+ +--> Running --[pause()]--> Paused
512	\| \| ^ \| ^ \|
513	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
514	\| ^ \| \| \| \|
515	\| \| +-----------------------------------------+-\|-------------------+ +
516	\| \| \| \| \|
517	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
518	\| \| \| \|
519	\| +-------- Saving <--------[saveState()]<----------+---------------------+
520	\| \| \|
521	+-------------- Stopping -------[powerDown()]<----------+---------------------+
522	</pre>
523
524	Note that states to the right from PoweredOff, Aborted and Saved in the
525	above diagram are called <i>online VM states</i>. These states
526	represent the virtual machine which is being executed in a dedicated
527	process (usually with a GUI window attached to it where you can see the
528	activity of the virtual machine and interact with it). There are two
529	special pseudo-states, FirstOnline and LastOnline, that can be used in
530	relational expressions to detect if the given machine state is online or
531	not:
532
533	<pre>
534	if (machine.GetState() >= MachineState_FirstOnline &&
535	machine.GetState() <= MachineState_LastOnline)
536	{
537	...the machine is being executed...
538	}
539	</pre>
540
541	When the virtual machine is in one of the online VM states (that is, being
542	executed), only a few machine settings can be modified. Methods working
543	with such settings contain an explicit note about that. An attempt to
544	change any oter setting or perform a modifying operation during this time
545	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
546
547	All online states except Running, Paused and Stuck are transitional: they
548	represent temporary conditions of the virtual machine that will last as
549	long as the operation that initiated such a condition.
550
551	The Stuck state is a special case. It means that execution of the machine
552	has reached the "Guru Meditation" condition. This condition indicates an
553	internal VMM (virtual machine manager) failure which may happen as a
554	result of either an unhandled low-level virtual hardware exception or one
555	of the recompiler exceptions (such as the <i>too-many-traps</i>
556	condition).
557
558	Note also that any online VM state may transit to the Aborted state. This
559	happens if the process that is executing the virtual machine terminates
560	unexpectedly (for example, crashes). Other than that, the Aborted state is
561	equivalent to PoweredOff.
562
563	There are also a few additional state diagrams that do not deal with
564	virtual machine execution and therefore are shown separately. The states
565	shown on these diagrams are called <i>offline VM states</i> (this includes
566	PoweredOff, Aborted and Saved too).
567
568	The first diagram shows what happens when a lengthy setup operation is
569	being executed (such as <link to="IMachine::attachDevice"/>).
570
571	<pre>
572	+----------------------------------(same state as before the call)------+
573	\| \|
574	+-> PoweredOff --+ \|
575	\| \| \|
576	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
577	\| \|
578	+-> Saved -------+
579	</pre>
580
581	The next two diagrams demonstrate the process of taking a snapshot of a
582	powered off virtual machine, restoring the state to that as of a snapshot
583	or deleting a snapshot, respectively.
584
585	<pre>
586	+----------------------------------(same state as before the call)------+
587	\| \|
588	+-> PoweredOff --+ \|
589	\| +-->[takeSnapshot()] -------------------> Saving ------+
590	+-> Aborted -----+
591
592	+-> PoweredOff --+
593	\| \|
594	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
595	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
596	+-> Saved -------+ \|
597	\| \|
598	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
599	</pre>
600
601	Note that the Saving state is present in both the offline state group and
602	online state group. Currently, the only way to determine what group is
603	assumed in a particular case is to remember the previous machine state: if
604	it was Running or Paused, then Saving is an online state, otherwise it is
605	an offline state. This inconsistency may be removed in one of the future
606	versions of VirtualBox by adding a new state.
607
608	<note internal="yes">
609	For whoever decides to touch this enum: In order to keep the
610	comparisons involving FirstOnline and LastOnline pseudo-states valid,
611	the numeric values of these states must be correspondingly updated if
612	needed: for any online VM state, the condition
613	<tt>FirstOnline <= state <= LastOnline</tt> must be
614	@c true. The same relates to transient states for which
615	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
616	@c true.
617	</note>
618	</desc>
619
620	<const name="Null" value="0">
621	<desc>Null value (never used by the API).</desc>
622	</const>
623	<const name="PoweredOff" value="1">
624	<desc>
625	The machine is not running and has no saved execution state; it has
626	either never been started or been shut down successfully.
627	</desc>
628	</const>
629	<const name="Saved" value="2">
630	<desc>
631	The machine is not currently running, but the execution state of the machine
632	has been saved to an external file when it was running, from where
633	it can be resumed.
634	</desc>
635	</const>
636	<const name="Teleported" value="3">
637	<desc>
638	The machine was teleported to a different host (or process) and then
639	powered off. Take care when powering it on again may corrupt resources
640	it shares with the teleportation target (e.g. disk and network).
641	</desc>
642	</const>
643	<const name="Aborted" value="4">
644	<desc>
645	The process running the machine has terminated abnormally. This may
646	indicate a crash of the VM process in host execution context, or
647	the VM process has been terminated externally.
648	</desc>
649	</const>
650	<const name="Running" value="5">
651	<desc>
652	The machine is currently being executed.
653	<note internal="yes">
654	For whoever decides to touch this enum: In order to keep the
655	comparisons in the old source code valid, this state must immediately
656	precede the Paused state.
657	TODO: Lift this spectacularly wonderful restriction.
658	</note>
659	</desc>
660	</const>
661	<const name="Paused" value="6">
662	<desc>
663	Execution of the machine has been paused.
664	<note internal="yes">
665	For whoever decides to touch this enum: In order to keep the
666	comparisons in the old source code valid, this state must immediately
667	follow the Running state.
668	TODO: Lift this spectacularly wonderful restriction.
669	</note>
670	</desc>
671	</const>
672	<const name="Stuck" value="7">
673	<desc>
674	Execution of the machine has reached the "Guru Meditation"
675	condition. This indicates a severe error in the hypervisor itself.
676	<note internal="yes">
677	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
678	"Guru", perhaps? Or are there some other VMM states that are
679	intended to be lumped in here as well?
680	</note>
681	</desc>
682	</const>
683	<const name="Teleporting" value="8">
684	<desc>
685	The machine is about to be teleported to a different host or process.
686	It is possible to pause a machine in this state, but it will go to the
687	@c TeleportingPausedVM state and it will not be
688	possible to resume it again unless the teleportation fails.
689	</desc>
690	</const>
691	<const name="LiveSnapshotting" value="9">
692	<desc>
693	A live snapshot is being taken. The machine is running normally, but
694	some of the runtime configuration options are inaccessible. Also, if
695	paused while in this state it will transition to
696	@c Saving and it will not be resume the
697	execution until the snapshot operation has completed.
698	</desc>
699	</const>
700	<const name="Starting" value="10">
701	<desc>
702	Machine is being started after powering it on from a
703	zero execution state.
704	</desc>
705	</const>
706	<const name="Stopping" value="11">
707	<desc>
708	Machine is being normally stopped powering it off, or after the guest OS
709	has initiated a shutdown sequence.
710	</desc>
711	</const>
712	<const name="Saving" value="12">
713	<desc>
714	Machine is saving its execution state to a file, or an online
715	snapshot of the machine is being taken.
716	</desc>
717	</const>
718	<const name="Restoring" value="13">
719	<desc>
720	Execution state of the machine is being restored from a file
721	after powering it on from the saved execution state.
722	</desc>
723	</const>
724	<const name="TeleportingPausedVM" value="14">
725	<desc>
726	The machine is being teleported to another host or process, but it is
727	not running. This is the paused variant of the
728	@c state.
729	</desc>
730	</const>
731	<const name="TeleportingIn" value="15">
732	<desc>
733	Teleporting the machine state in from another host or process.
734	</desc>
735	</const>
736	<const name="FaultTolerantSyncing" value="16">
737	<desc>
738	The machine is being synced with a fault tolerant VM running elsewhere.
739	</desc>
740	</const>
741	<const name="DeletingSnapshotOnline" value="17">
742	<desc>
743	Like @c DeletingSnapshot, but the merging of media is ongoing in
744	the background while the machine is running.
745	</desc>
746	</const>
747	<const name="DeletingSnapshotPaused" value="18">
748	<desc>
749	Like @c DeletingSnapshotOnline, but the machine was paused when the
750	merging of differencing media was started.
751	</desc>
752	</const>
753	<const name="RestoringSnapshot" value="19">
754	<desc>
755	A machine snapshot is being restored; this typically does not take long.
756	</desc>
757	</const>
758	<const name="DeletingSnapshot" value="20">
759	<desc>
760	A machine snapshot is being deleted; this can take a long time since this
761	may require merging differencing media. This value indicates that the
762	machine is not running while the snapshot is being deleted.
763	</desc>
764	</const>
765	<const name="SettingUp" value="21">
766	<desc>
767	Lengthy setup operation is in progress.
768	</desc>
769	</const>
770
771	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
772	<desc>
773	Pseudo-state: first online state (for use in relational expressions).
774	</desc>
775	</const>
776	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
777	<desc>
778	Pseudo-state: last online state (for use in relational expressions).
779	</desc>
780	</const>
781
782	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
783	<desc>
784	Pseudo-state: first transient state (for use in relational expressions).
785	</desc>
786	</const>
787	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
788	<desc>
789	Pseudo-state: last transient state (for use in relational expressions).
790	</desc>
791	</const>
792
793	</enum>
794
795	<enum
796	name="SessionState"
797	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
798	>
799	<desc>
800	Session state. This enumeration represents possible values of
801	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
802	attributes.
803	</desc>
804
805	<const name="Null" value="0">
806	<desc>Null value (never used by the API).</desc>
807	</const>
808	<const name="Unlocked" value="1">
809	<desc>
810	In <link to="IMachine::sessionState"/>, this means that the machine
811	is not locked for any sessions.
812
813	In <link to="ISession::state"/>, this means that no machine is
814	currently locked for this session.
815	</desc>
816	</const>
817	<const name="Locked" value="2">
818	<desc>
819	In <link to="IMachine::sessionState"/>, this means that the machine
820	is currently locked for a session, whose process identifier can
821	then be found in the <link to="IMachine::sessionPid" /> attribute.
822
823	In <link to="ISession::state"/>, this means that a machine is
824	currently locked for this session, and the mutable machine object
825	can be found in the <link to="ISession::machine"/> attribute
826	(see <link to="IMachine::lockMachine" /> for details).
827	</desc>
828	</const>
829	<const name="Spawning" value="3">
830	<desc>
831	A new process is being spawned for the machine as a result of
832	<link to="IMachine::launchVMProcess"/> call. This state also occurs
833	as a short transient state during an <link to="IMachine::lockMachine"/>
834	call.
835	</desc>
836	</const>
837	<const name="Unlocking" value="4">
838	<desc>
839	The session is being unlocked.
840	</desc>
841	</const>
842	</enum>
843
844	<enum
845	name="CPUPropertyType"
846	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
847	>
848	<desc>
849	Virtual CPU property type. This enumeration represents possible values of the
850	IMachine get- and setCPUProperty methods.
851	</desc>
852	<const name="Null" value="0">
853	<desc>Null value (never used by the API).</desc>
854	</const>
855	<const name="PAE" value="1">
856	<desc>
857	This setting determines whether VirtualBox will expose the Physical Address
858	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
859	is not available, it will not be reported.
860	</desc>
861	</const>
862	<const name="Synthetic" value="2">
863	<desc>
864	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
865	teleporting between host systems that differ significantly.
866	</desc>
867	</const>
868	</enum>
869
870
871	<enum
872	name="HWVirtExPropertyType"
873	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
874	>
875	<desc>
876	Hardware virtualization property type. This enumeration represents possible values
877	for the <link to="IMachine::getHWVirtExProperty"/> and
878	<link to="IMachine::setHWVirtExProperty"/> methods.
879	</desc>
880	<const name="Null" value="0">
881	<desc>Null value (never used by the API).</desc>
882	</const>
883	<const name="Enabled" value="1">
884	<desc>
885	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
886	such extensions are not available, they will not be used.
887	</desc>
888	</const>
889	<const name="Exclusive" value="2">
890	<desc>
891	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
892	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
893	feature of the host. To share these with other hypervisors, you must disable this property.
894	</desc>
895	</const>
896	<const name="VPID" value="3">
897	<desc>
898	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
899	</desc>
900	</const>
901	<const name="NestedPaging" value="4">
902	<desc>
903	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
904	</desc>
905	</const>
906	<const name="LargePages" value="5">
907	<desc>
908	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
909	</desc>
910	</const>
911	<const name="Force" value="6">
912	<desc>
913	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
914	not set, there will be an automatic fallback to software virtualization.
915	</desc>
916	</const>
917	</enum>
918
919	<enum
920	name="FaultToleranceState"
921	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
922	>
923	<desc>
924	Used with <link to="IMachine::faultToleranceState" />.
925	</desc>
926	<const name="Inactive" value="1">
927	<desc>No fault tolerance enabled.</desc>
928	</const>
929	<const name="Master" value="2">
930	<desc>Fault tolerant master VM.</desc>
931	</const>
932	<const name="Standby" value="3">
933	<desc>Fault tolerant standby VM.</desc>
934	</const>
935	</enum>
936
937	<enum
938	name="LockType"
939	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
940	>
941	<desc>
942	Used with <link to="IMachine::lockMachine" />.
943	</desc>
944	<const name="Write" value="2">
945	<desc>Lock the machine for writing.</desc>
946	</const>
947	<const name="Shared" value="1">
948	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
949	</const>
950	</enum>
951
952	<enum
953	name="SessionType"
954	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
955	>
956	<desc>
957	Session type. This enumeration represents possible values of the
958	<link to="ISession::type"/> attribute.
959	</desc>
960
961	<const name="Null" value="0">
962	<desc>Null value (never used by the API).</desc>
963	</const>
964	<const name="WriteLock" value="1">
965	<desc>
966	Session has acquired an exclusive write lock on a machine
967	using <link to="IMachine::lockMachine"/>.
968	</desc>
969	</const>
970	<const name="Remote" value="2">
971	<desc>
972	Session has launched a VM process using
973	<link to="IMachine::launchVMProcess"/>
974	</desc>
975	</const>
976	<const name="Shared" value="3">
977	<desc>
978	Session has obtained a link to another session using
979	<link to="IMachine::lockMachine"/>
980	</desc>
981	</const>
982	</enum>
983
984	<enum
985	name="DeviceType"
986	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
987	>
988	<desc>
989	Device type.
990	</desc>
991	<const name="Null" value="0">
992	<desc>
993	Null value, may also mean "no device" (not allowed for
994	<link to="IConsole::getDeviceActivity"/>).
995	</desc>
996	</const>
997	<const name="Floppy" value="1">
998	<desc>Floppy device.</desc>
999	</const>
1000	<const name="DVD" value="2">
1001	<desc>CD/DVD-ROM device.</desc>
1002	</const>
1003	<const name="HardDisk" value="3">
1004	<desc>Hard disk device.</desc>
1005	</const>
1006	<const name="Network" value="4">
1007	<desc>Network device.</desc>
1008	</const>
1009	<const name="USB" value="5">
1010	<desc>USB device.</desc>
1011	</const>
1012	<const name="SharedFolder" value="6">
1013	<desc>Shared folder device.</desc>
1014	</const>
1015	</enum>
1016
1017	<enum
1018	name="DeviceActivity"
1019	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1020	>
1021	<desc>
1022	Device activity for <link to="IConsole::getDeviceActivity"/>.
1023	</desc>
1024
1025	<const name="Null" value="0"/>
1026	<const name="Idle" value="1"/>
1027	<const name="Reading" value="2"/>
1028	<const name="Writing" value="3"/>
1029	</enum>
1030
1031	<enum
1032	name="ClipboardMode"
1033	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1034	>
1035	<desc>
1036	Host-Guest clipboard interchange mode.
1037	</desc>
1038
1039	<const name="Disabled" value="0"/>
1040	<const name="HostToGuest" value="1"/>
1041	<const name="GuestToHost" value="2"/>
1042	<const name="Bidirectional" value="3"/>
1043	</enum>
1044
1045	<enum
1046	name="Scope"
1047	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1048	>
1049	<desc>
1050	Scope of the operation.
1051
1052	A generic enumeration used in various methods to define the action or
1053	argument scope.
1054	</desc>
1055
1056	<const name="Global" value="0"/>
1057	<const name="Machine" value="1"/>
1058	<const name="Session" value="2"/>
1059	</enum>
1060
1061	<enum
1062	name="BIOSBootMenuMode"
1063	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1064	>
1065	<desc>
1066	BIOS boot menu mode.
1067	</desc>
1068
1069	<const name="Disabled" value="0"/>
1070	<const name="MenuOnly" value="1"/>
1071	<const name="MessageAndMenu" value="2"/>
1072	</enum>
1073
1074	<enum
1075	name="ProcessorFeature"
1076	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1077	>
1078	<desc>
1079	CPU features.
1080	</desc>
1081
1082	<const name="HWVirtEx" value="0"/>
1083	<const name="PAE" value="1"/>
1084	<const name="LongMode" value="2"/>
1085	<const name="NestedPaging" value="3"/>
1086	</enum>
1087
1088	<enum
1089	name="FirmwareType"
1090	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1091	>
1092	<desc>
1093	Firmware type.
1094	</desc>
1095	<const name="BIOS" value="1">
1096	<desc>BIOS Firmware.</desc>
1097	</const>
1098	<const name="EFI" value="2">
1099	<desc>EFI Firmware, bitness detetced basing on OS type.</desc>
1100	</const>
1101	<const name="EFI32" value="3">
1102	<desc>Efi firmware, 32-bit.</desc>
1103	</const>
1104	<const name="EFI64" value="4">
1105	<desc>Efi firmware, 64-bit.</desc>
1106	</const>
1107	<const name="EFIDUAL" value="5">
1108	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1109	</const>
1110	</enum>
1111
1112	<enum
1113	name="PointingHidType"
1114	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1115	>
1116	<desc>
1117	Type of pointing device used in a virtual machine.
1118	</desc>
1119	<const name="None" value="1">
1120	<desc>No mouse.</desc>
1121	</const>
1122	<const name="PS2Mouse" value="2">
1123	<desc>PS/2 auxillary device, a.k.a. mouse.</desc>
1124	</const>
1125	<const name="USBMouse" value="3">
1126	<desc>USB mouse (relative pointer).</desc>
1127	</const>
1128	<const name="USBTablet" value="4">
1129	<desc>USB tablet (absolute pointer).</desc>
1130	</const>
1131	<const name="ComboMouse" value="5">
1132	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1133	Using of such device can have negative performance implications. </desc>
1134	</const>
1135	</enum>
1136
1137	<enum
1138	name="KeyboardHidType"
1139	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1140	>
1141	<desc>
1142	Type of keyboard device used in a virtual machine.
1143	</desc>
1144	<const name="None" value="1">
1145	<desc>No keyboard.</desc>
1146	</const>
1147	<const name="PS2Keyboard" value="2">
1148	<desc>PS/2 keyboard.</desc>
1149	</const>
1150	<const name="USBKeyboard" value="3">
1151	<desc>USB keyboard.</desc>
1152	</const>
1153	<const name="ComboKeyboard" value="4">
1154	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1155	Using of such device can have negative performance implications. </desc>
1156	</const>
1157	</enum>
1158
1159	<!--
1160	// IVirtualBoxErrorInfo
1161	/////////////////////////////////////////////////////////////////////////
1162	-->
1163
1164	<interface
1165	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1166	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1167	supportsErrorInfo="no"
1168	wsmap="managed"
1169	>
1170	<desc>
1171	The IVirtualBoxErrorInfo interface represents extended error information.
1172
1173	Extended error information can be set by VirtualBox components after
1174	unsuccessful or partially successful method invocation. This information
1175	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1176	and then shown to the client in addition to the plain 32-bit result code.
1177
1178	In MS COM, this interface extends the IErrorInfo interface,
1179	in XPCOM, it extends the nsIException interface. In both cases,
1180	it provides a set of common attributes to retrieve error
1181	information.
1182
1183	Sometimes invocation of some component's method may involve methods of
1184	other components that may also fail (independently of this method's
1185	failure), or a series of non-fatal errors may precede a fatal error that
1186	causes method failure. In cases like that, it may be desirable to preserve
1187	information about all errors happened during method invocation and deliver
1188	it to the caller. The <link to="#next"/> attribute is intended
1189	specifically for this purpose and allows to represent a chain of errors
1190	through a single IVirtualBoxErrorInfo object set after method invocation.
1191
1192	Note that errors are stored to a chain in the reverse order, i.e. the
1193	initial error object you query right after method invocation is the last
1194	error set by the callee, the object it points to in the @a next attribute
1195	is the previous error and so on, up to the first error (which is the last
1196	in the chain).
1197	</desc>
1198
1199	<attribute name="resultCode" type="long" readonly="yes">
1200	<desc>
1201	Result code of the error.
1202	Usually, it will be the same as the result code returned
1203	by the method that provided this error information, but not
1204	always. For example, on Win32, CoCreateInstance() will most
1205	likely return E_NOINTERFACE upon unsuccessful component
1206	instantiation attempt, but not the value the component factory
1207	returned. Value is typed 'long', not 'result',
1208	to make interface usable from scripting languages.
1209	<note>
1210	In MS COM, there is no equivalent.
1211	In XPCOM, it is the same as nsIException::result.
1212	</note>
1213	</desc>
1214	</attribute>
1215
1216	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1217	<desc>
1218	UUID of the interface that defined the error.
1219	<note>
1220	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1221	data type.
1222	In XPCOM, there is no equivalent.
1223	</note>
1224	</desc>
1225	</attribute>
1226
1227	<attribute name="component" type="wstring" readonly="yes">
1228	<desc>
1229	Name of the component that generated the error.
1230	<note>
1231	In MS COM, it is the same as IErrorInfo::GetSource.
1232	In XPCOM, there is no equivalent.
1233	</note>
1234	</desc>
1235	</attribute>
1236
1237	<attribute name="text" type="wstring" readonly="yes">
1238	<desc>
1239	Text description of the error.
1240	<note>
1241	In MS COM, it is the same as IErrorInfo::GetDescription.
1242	In XPCOM, it is the same as nsIException::message.
1243	</note>
1244	</desc>
1245	</attribute>
1246
1247	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1248	<desc>
1249	Next error object if there is any, or @c null otherwise.
1250	<note>
1251	In MS COM, there is no equivalent.
1252	In XPCOM, it is the same as nsIException::inner.
1253	</note>
1254	</desc>
1255	</attribute>
1256
1257	</interface>
1258
1259	<!--
1260	// IVirtualBox
1261	/////////////////////////////////////////////////////////////////////////
1262	-->
1263
1264	<interface
1265	name="IDHCPServer" extends="$unknown"
1266	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1267	wsmap="managed"
1268	>
1269	<desc>
1270	The IDHCPServer interface represents the vbox dhcp server configuration.
1271
1272	To enumerate all the dhcp servers on the host, use the
1273	<link to="IVirtualBox::DHCPServers"/> attribute.
1274	</desc>
1275
1276	<attribute name="enabled" type="boolean">
1277	<desc>
1278	specifies if the dhcp server is enabled
1279	</desc>
1280	</attribute>
1281
1282	<attribute name="IPAddress" type="wstring" readonly="yes">
1283	<desc>
1284	specifies server IP
1285	</desc>
1286	</attribute>
1287
1288	<attribute name="networkMask" type="wstring" readonly="yes">
1289	<desc>
1290	specifies server network mask
1291	</desc>
1292	</attribute>
1293
1294	<attribute name="networkName" type="wstring" readonly="yes">
1295	<desc>
1296	specifies internal network name the server is used for
1297	</desc>
1298	</attribute>
1299
1300	<attribute name="lowerIP" type="wstring" readonly="yes">
1301	<desc>
1302	specifies from IP adrres in server address range
1303	</desc>
1304	</attribute>
1305
1306	<attribute name="upperIP" type="wstring" readonly="yes">
1307	<desc>
1308	specifies to IP adrres in server address range
1309	</desc>
1310	</attribute>
1311
1312	<method name="setConfiguration">
1313	<desc>
1314	configures the server
1315	<result name="E_INVALIDARG">
1316	invalid configuration supplied
1317	</result>
1318	</desc>
1319	<param name="IPAddress" type="wstring" dir="in">
1320	<desc>
1321	server IP address
1322	</desc>
1323	</param>
1324	<param name="networkMask" type="wstring" dir="in">
1325	<desc>
1326	server network mask
1327	</desc>
1328	</param>
1329	<param name="FromIPAddress" type="wstring" dir="in">
1330	<desc>
1331	server From IP address for address range
1332	</desc>
1333	</param>
1334	<param name="ToIPAddress" type="wstring" dir="in">
1335	<desc>
1336	server To IP address for address range
1337	</desc>
1338	</param>
1339	</method>
1340
1341	<method name="start">
1342	<desc>
1343	Starts DHCP server process.
1344	<result name="E_FAIL">
1345	Failed to start the process.
1346	</result>
1347	</desc>
1348	<param name="networkName" type="wstring" dir="in">
1349	<desc>
1350	Name of internal network DHCP server should attach to.
1351	</desc>
1352	</param>
1353	<param name="trunkName" type="wstring" dir="in">
1354	<desc>
1355	Name of internal network trunk.
1356	</desc>
1357	</param>
1358	<param name="trunkType" type="wstring" dir="in">
1359	<desc>
1360	Type of internal network trunk.
1361	</desc>
1362	</param>
1363	</method>
1364
1365	<method name="stop">
1366	<desc>
1367	Stops DHCP server process.
1368	<result name="E_FAIL">
1369	Failed to stop the process.
1370	</result>
1371	</desc>
1372	</method>
1373	</interface>
1374
1375	<interface
1376	name="IVirtualBox" extends="$unknown"
1377	uuid="6e123115-af60-49b3-9727-d3f302306cd2"
1378	wsmap="managed"
1379	>
1380	<desc>
1381	The IVirtualBox interface represents the main interface exposed by the
1382	product that provides virtual machine management.
1383
1384	An instance of IVirtualBox is required for the product to do anything
1385	useful. Even though the interface does not expose this, internally,
1386	IVirtualBox is implemented as a singleton and actually lives in the
1387	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1388	IVirtualBox can track the state of all virtual machines on a particular
1389	host, regardless of which frontend started them.
1390
1391	To enumerate all the virtual machines on the host, use the
1392	<link to="IVirtualBox::machines"/> attribute.
1393	</desc>
1394
1395	<attribute name="version" type="wstring" readonly="yes">
1396	<desc>
1397	A string representing the version number of the product. The
1398	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1399	last number represents the build number and will frequently change.
1400	</desc>
1401	</attribute>
1402
1403	<attribute name="revision" type="unsigned long" readonly="yes">
1404	<desc>
1405	The internal build revision number of the product.
1406	</desc>
1407	</attribute>
1408
1409	<attribute name="packageType" type="wstring" readonly="yes">
1410	<desc>
1411	A string representing the package type of this product. The
1412	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1413	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1414	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1415	this.
1416	</desc>
1417	</attribute>
1418
1419	<attribute name="homeFolder" type="wstring" readonly="yes">
1420	<desc>
1421	Full path to the directory where the global settings file,
1422	<tt>VirtualBox.xml</tt>, is stored.
1423
1424	In this version of VirtualBox, the value of this property is
1425	always <tt><user_dir>/.VirtualBox</tt> (where
1426	<tt><user_dir></tt> is the path to the user directory,
1427	as determined by the host OS), and cannot be changed.
1428
1429	This path is also used as the base to resolve relative paths in
1430	places where relative paths are allowed (unless otherwise
1431	expressly indicated).
1432	</desc>
1433	</attribute>
1434
1435	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1436	<desc>
1437	Full name of the global settings file.
1438	The value of this property corresponds to the value of
1439	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1440	</desc>
1441	</attribute>
1442
1443	<attribute name="host" type="IHost" readonly="yes">
1444	<desc>Associated host object.</desc>
1445	</attribute>
1446
1447	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1448	<desc>Associated system information object.</desc>
1449	</attribute>
1450
1451	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1452	<desc>
1453	Array of machine objects registered within this VirtualBox instance.
1454	</desc>
1455	</attribute>
1456
1457	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1458	<desc>
1459	Array of medium objects known to this VirtualBox installation.
1460
1461	This array contains only base media. All differencing
1462	media of the given base medium can be enumerated using
1463	<link to="IMedium::children"/>.
1464	</desc>
1465	</attribute>
1466
1467	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1468	<desc>
1469	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1470	</desc>
1471	</attribute>
1472
1473	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1474	<desc>
1475	Array of floppy image objects currently in use by this VirtualBox instance.
1476	</desc>
1477	</attribute>
1478
1479	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1480
1481	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1482
1483	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1484	<desc>
1485	Collection of global shared folders. Global shared folders are
1486	available to all virtual machines.
1487
1488	New shared folders are added to the collection using
1489	<link to="#createSharedFolder"/>. Existing shared folders can be
1490	removed using <link to="#removeSharedFolder"/>.
1491
1492	<note>
1493	In the current version of the product, global shared folders are not
1494	implemented and therefore this collection is always empty.
1495	</note>
1496	</desc>
1497	</attribute>
1498
1499	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1500	<desc>
1501	Associated performance collector object.
1502	</desc>
1503	</attribute>
1504
1505	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1506	<desc>
1507	dhcp server settings.
1508	</desc>
1509	</attribute>
1510
1511	<attribute name="eventSource" type="IEventSource" readonly="yes">
1512	<desc>
1513	Event source for VirtualBox events.
1514	</desc>
1515	</attribute>
1516
1517	<method name="composeMachineFilename">
1518	<desc>
1519	Returns a recommended full path of the settings file name for a new virtual
1520	machine.
1521
1522	This API serves two purposes:
1523
1524	<ul>
1525	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1526	for the @a settingsFile argument there, which means that API should use
1527	a recommended default file name.</li>
1528
1529	<li>It can be called manually by a client software before creating a machine,
1530	e.g. if that client wants to pre-create the machine directory to create
1531	virtual hard disks in that directory together with the new machine
1532	settings file. In that case, the file name should be stripped from the
1533	full settings file path returned by this function to obtain the
1534	machine directory.</li>
1535	</ul>
1536
1537	See the <link to="IMachine::name"/> attribute description for more details about
1538	the machine name.
1539
1540	Every machine has a <i>settings file</i> that is used to store
1541	the machine configuration. This file is stored in a directory called the
1542	<i>machine settings subfolder</i>. Both the settings subfolder and file
1543	will have a name that corresponds to the name of the virtual machine.
1544	You can specify where to create the machine setting subfolder using the
1545	@a baseFolder argument.
1546
1547	If @a baseFolder is a @c null or empty string (which is recommended), the
1548	default machine settings folder
1549	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1550	a base folder for the created machine. Otherwise the given base folder
1551	will be used.
1552
1553	In either case, the full path to the resulting settings file has the
1554	following structure:
1555	<pre>
1556	<base_folder>/<machine_name>/<machine_name>.xml
1557	</pre>
1558
1559	This method does not access the host disks. In particular, it does not check
1560	for whether a machine of this name already exists.
1561	</desc>
1562	<param name="name" type="wstring" dir="in">
1563	<desc>Suggested machine name.</desc>
1564	</param>
1565	<param name="baseFolder" type="wstring" dir="in">
1566	<desc>Base machine folder (optional).</desc>
1567	</param>
1568	<param name="file" type="wstring" dir="return">
1569	<desc>Fully qualified path where the machine would be created.</desc>
1570	</param>
1571	</method>
1572
1573	<method name="createMachine">
1574	<desc>
1575	Creates a new virtual machine by creating a machine settings file at
1576	the given location.
1577
1578	VirtualBox machine settings files use a custom XML dialect. Starting
1579	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1580	and machine files can be created at arbitrary locations. However, it is
1581	is recommended that machines are created in the "VirtualBox VMs" folder
1582	created in the user's home directory
1583	(e.g. "/home/user/VirtualBox VMs/name/name.vbox").
1584
1585	If you specify NULL for the @a settingsFile argument,
1586	<link to="#composeMachineFilename" /> is called automatically to have
1587	such a recommended name composed based on the machine name given in
1588	the @a name argument.
1589
1590	The new machine is created unregistered, with the initial configuration
1591	set according to the specified guest OS type. A typical sequence of
1592	actions to create a new virtual machine is as follows:
1593
1594	<ol>
1595	<li>
1596	Call this method to have a new machine created. The returned machine
1597	object will be "mutable" allowing to change any machine property.
1598	</li>
1599
1600	<li>
1601	Configure the machine using the appropriate attributes and methods.
1602	</li>
1603
1604	<li>
1605	Call <link to="IMachine::saveSettings" /> to write the settings
1606	to the machine's XML settings file. The configuration of the newly
1607	created machine will not be saved to disk until this method is
1608	called.
1609	</li>
1610
1611	<li>
1612	Call <link to="#registerMachine" /> to add the machine to the list
1613	of machines known to VirtualBox.
1614	</li>
1615	</ol>
1616
1617	The specified guest OS type identifier must match an ID of one of known
1618	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1619	array.
1620
1621	If the resulting settings file already exists, this method will fail
1622	with <link to="VBOX_E_FILE_ERROR"/>.
1623
1624	Optionally, you may specify an UUID of to assign to the created machine.
1625	However, this is not recommended and you should normally pass an empty
1626	(@c null) UUID to this method so that a new UUID will be automatically
1627	generated for every created machine. You can use UUID
1628	00000000-0000-0000-0000-000000000000 as @c null value.
1629
1630	<note>
1631	There is no way to change the name of the settings file or
1632	subfolder of the created machine directly.
1633	</note>
1634
1635	<result name="VBOX_E_OBJECT_NOT_FOUND">
1636	@a osTypeId is invalid.
1637	</result>
1638	<result name="VBOX_E_FILE_ERROR">
1639	Resulting settings file name is invalid or the settings file already
1640	exists or could not be created due to an I/O error.
1641	</result>
1642	<result name="E_INVALIDARG">
1643	@a name is empty or @c null.
1644	</result>
1645	</desc>
1646
1647	<param name="settingsFile" type="wstring" dir="in">
1648	<desc>Fully qualified path where the settings file should be created,
1649	or NULL for a default folder and file based on the @a name argument
1650	(see <link to="#composeMachineFilename" />).</desc>
1651	</param>
1652	<param name="name" type="wstring" dir="in">
1653	<desc>Machine name.</desc>
1654	</param>
1655	<param name="osTypeId" type="wstring" dir="in">
1656	<desc>Guest OS Type ID.</desc>
1657	</param>
1658	<param name="id" type="uuid" mod="string" dir="in">
1659	<desc>Machine UUID (optional).</desc>
1660	</param>
1661	<param name="forceOverwrite" type="boolean" dir="in">
1662	<desc>If true, an existing machine settings file will be overwritten.</desc>
1663	</param>
1664	<param name="machine" type="IMachine" dir="return">
1665	<desc>Created machine object.</desc>
1666	</param>
1667	</method>
1668
1669	<method name="openMachine">
1670	<desc>
1671	Opens a virtual machine from the existing settings file.
1672	The opened machine remains unregistered until you call
1673	<link to="#registerMachine"/>.
1674
1675	The specified settings file name can be absolute
1676	(full path) or relative to the <link to="IVirtualBox::homeFolder">
1677	VirtualBox home directory</link>. This file must exist
1678	and must be a valid machine settings file whose contents
1679	will be used to construct the machine object.
1680
1681	<result name="VBOX_E_FILE_ERROR">
1682	Settings file name invalid, not found or sharing violation.
1683	</result>
1684	</desc>
1685	<param name="settingsFile" type="wstring" dir="in">
1686	<desc>
1687	Name of the machine settings file.
1688	</desc>
1689	</param>
1690	<param name="machine" type="IMachine" dir="return">
1691	<desc>Opened machine object.</desc>
1692	</param>
1693	<note>
1694	<link to="IMachine::settingsModified"/> will return
1695	@c false for the created machine, until any of machine settings
1696	are changed.
1697	</note>
1698	</method>
1699
1700	<method name="registerMachine">
1701	<desc>
1702
1703	Registers the machine previously created using
1704	<link to="#createMachine"/> or opened using
1705	<link to="#openMachine"/> within this VirtualBox installation. After
1706	successful method invocation, the
1707	<link to="IMachineRegisteredEvent"/> event is fired.
1708
1709	<note>
1710	This method implicitly calls <link to="IMachine::saveSettings"/>
1711	to save all current machine settings before registering it.
1712	</note>
1713
1714	<result name="VBOX_E_OBJECT_NOT_FOUND">
1715	No matching virtual machine found.
1716	</result>
1717	<result name="VBOX_E_INVALID_OBJECT_STATE">
1718	Virtual machine was not created within this VirtualBox instance.
1719	</result>
1720
1721	</desc>
1722	<param name="machine" type="IMachine" dir="in"/>
1723	</method>
1724
1725	<method name="findMachine">
1726	<desc>
1727	Attempts to find a virtual machine given its name or UUID.
1728
1729	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1730	cannot safely be determined.</note>
1731
1732	<result name="VBOX_E_OBJECT_NOT_FOUND">
1733	Could not find registered machine matching @a nameOrId.
1734	</result>
1735
1736	</desc>
1737	<param name="nameOrId" type="wstring" dir="in">
1738	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1739	</param>
1740	<param name="machine" type="IMachine" dir="return">
1741	<desc>Machine object, if found.</desc>
1742	</param>
1743	</method>
1744
1745	<method name="createAppliance">
1746	<desc>
1747	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1748	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1749	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1750	</desc>
1751	<param name="appliance" type="IAppliance" dir="return">
1752	<desc>New appliance.</desc>
1753	</param>
1754	</method>
1755
1756	<method name="createHardDisk">
1757	<desc>
1758	Creates a new base medium object that will use the given storage
1759	format and location for medium data.
1760
1761	Note that the actual storage unit is not created by this method. In
1762	order to do it, and before you are able to attach the created medium
1763	to virtual machines, you must call one of the following methods to
1764	allocate a format-specific storage unit at the specified location:
1765	<ul>
1766	<li><link to="IMedium::createBaseStorage"/></li>
1767	<li><link to="IMedium::createDiffStorage"/></li>
1768	</ul>
1769
1770	Some medium attributes, such as <link to="IMedium::id"/>, may
1771	remain uninitialized until the medium storage unit is successfully
1772	created by one of the above methods.
1773
1774	After the storage unit is successfully created, it will be
1775	accessible through the <link to="#findMedium"/> method and can
1776	be found in the <link to="#hardDisks"/> array.
1777
1778	The list of all storage formats supported by this VirtualBox
1779	installation can be obtained using
1780	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1781	attribute is empty or @c null then the default storage format
1782	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1783	be used for creating a storage unit of the medium.
1784
1785	Note that the format of the location string is storage format specific.
1786	See <link to="IMedium::location"/> and IMedium for more details.
1787
1788	<result name="VBOX_E_OBJECT_NOT_FOUND">
1789	@a format identifier is invalid. See
1790	<link to="ISystemProperties::mediumFormats"/>.
1791	</result>
1792	<result name="VBOX_E_FILE_ERROR">
1793	@a location is a not valid file name (for file-based formats only).
1794	</result>
1795	</desc>
1796	<param name="format" type="wstring" dir="in">
1797	<desc>
1798	Identifier of the storage format to use for the new medium.
1799	</desc>
1800	</param>
1801	<param name="location" type="wstring" dir="in">
1802	<desc>
1803	Location of the storage unit for the new medium.
1804	</desc>
1805	</param>
1806	<param name="medium" type="IMedium" dir="return">
1807	<desc>Created medium object.</desc>
1808	</param>
1809	</method>
1810
1811	<method name="openMedium">
1812	<desc>
1813	Opens a medium from an existing storage location.
1814
1815	Once a medium has been opened, it can be passed to other VirtualBox
1816	methods, in particular to <link to="IMachine::attachDevice" />.
1817
1818	Depending on the given device type, the file at the storage location
1819	must be in one of the media formats understood by VirtualBox:
1820
1821	<ul>
1822	<li>With a "HardDisk" device type, the file must be a hard disk image
1823	in one of the formats supported by VirtualBox (see
1824	<link to="ISystemProperties::mediumFormats" />).
1825	After this method succeeds, if the medium is a base medium, it
1826	will be added to the <link to="#hardDisks"/> array attribute. </li>
1827	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1828	After this method succeeds, the medium will be added to the
1829	<link to="#DVDImages"/> array attribute.</li>
1830	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1831	After this method succeeds, the medium will be added to the
1832	<link to="#floppyImages"/> array attribute.</li>
1833	</ul>
1834
1835	After having been opened, the medium can be found by the <link to="#findMedium"/>
1836	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1837
1838	The UUID of the newly opened medium will either be retrieved from the
1839	storage location, if the format supports it (e.g. for hard disk images),
1840	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1841	If for some reason you need to change the medium's UUID, use
1842	<link to="IMedium::setIDs" />.
1843
1844	If a differencing hard disk medium is to be opened by this method, the
1845	operation will succeed only if its parent medium and all ancestors,
1846	if any, are already known to this VirtualBox installation (for example,
1847	were opened by this method before).
1848
1849	This method attempts to guess the storage format of the specified medium
1850	by reading medium data at the specified location.
1851
1852	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1853	the image is opened for read/write access and must have according permissions,
1854	as VirtualBox may actually write status information into the disk's metadata
1855	sections.
1856
1857	Note that write access is required for all typical hard disk usage in VirtualBox,
1858	since VirtualBox may need to write metadata such as a UUID into the image.
1859	The only exception is opening a source image temporarily for copying and
1860	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1861	again soon.
1862
1863	The format of the location string is storage format specific. See
1864	<link to="IMedium::location"/> and IMedium for more details.
1865
1866	Prior to VirtualBox 4.0, opening a medium added it to a global media
1867	registry in the VirtualBox.xml file, which was shared between all machines
1868	and made transporting machines and their media from one host to another
1869	difficult.
1870
1871	Starting with VirtualBox 4.0, media are only added to a registry when
1872	they are attached to a machine. Machines created with VirtualBox 4.0
1873	or later can have their own media registry. As a result, a medium attached
1874	to such a machine will be remembered in that machine's XML settings file.
1875	Media attached to older machines will continue to be added to the global
1876	registry.
1877
1878	<result name="VBOX_E_FILE_ERROR">
1879	Invalid medium storage file location or could not find the medium
1880	at the specified location.
1881	</result>
1882	<result name="VBOX_E_IPRT_ERROR">
1883	Could not get medium storage format.
1884	</result>
1885	<result name="E_INVALIDARG">
1886	Invalid medium storage format.
1887	</result>
1888	<result name="VBOX_E_INVALID_OBJECT_STATE">
1889	Medium has already been added to a media registry.
1890	</result>
1891	</desc>
1892	<param name="location" type="wstring" dir="in">
1893	<desc>
1894	Location of the storage unit that contains medium data in one of
1895	the supported storage formats.
1896	</desc>
1897	</param>
1898	<param name="deviceType" type="DeviceType" dir="in">
1899	<desc>
1900	Must be one of "HardDisk", "DVD" or "Floppy".
1901	</desc>
1902	</param>
1903	<param name="accessMode" type="AccessMode" dir="in">
1904	<desc>Whether to open the image in read/write or read-only mode. For
1905	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1906	</param>
1907	<param name="medium" type="IMedium" dir="return">
1908	<desc>Opened medium object.</desc>
1909	</param>
1910	</method>
1911
1912	<method name="findMedium">
1913	<desc>
1914	Returns a medium of the given type that uses the given fully qualified
1915	location or UUID to store medium data.
1916
1917	The given medium must be known to this VirtualBox installation, i.e.
1918	it must be previously created by <link to="#createHardDisk"/> or opened
1919	by <link to="#openMedium"/>.
1920
1921	The search is done by comparing the value of the @a location argument to
1922	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1923	attributes of each known medium.
1924
1925	On case sensitive file systems, a case sensitive comparison is performed,
1926	otherwise the case of symbols in the file path is ignored.
1927
1928	<result name="VBOX_E_OBJECT_NOT_FOUND">
1929	No medium object matching @a location found.
1930	</result>
1931	</desc>
1932	<param name="location" type="wstring" dir="in">
1933	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1934	</param>
1935	<param name="type" type="DeviceType" dir="in">
1936	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1937	</param>
1938	<param name="medium" type="IMedium" dir="return">
1939	<desc>Medium object, if found.</desc>
1940	</param>
1941	</method>
1942
1943	<method name="getGuestOSType">
1944	<desc>
1945	Returns an object describing the specified guest OS type.
1946
1947	The requested guest OS type is specified using a string which is a
1948	mnemonic identifier of the guest operating system, such as
1949	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1950	particular virtual machine can be read or set using the
1951	<link to="IMachine::OSTypeId"/> attribute.
1952
1953	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1954	available guest OS type objects. Each object has an
1955	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1956	the guest OS this object describes.
1957
1958	<result name="E_INVALIDARG">
1959	@a id is not a valid Guest OS type.
1960	</result>
1961
1962	</desc>
1963	<param name="id" type="uuid" mod="string" dir="in">
1964	<desc>Guest OS type ID string.</desc>
1965	</param>
1966	<param name="type" type="IGuestOSType" dir="return">
1967	<desc>Guest OS type object.</desc>
1968	</param>
1969	</method>
1970
1971	<method name="createSharedFolder">
1972	<desc>
1973	Creates a new global shared folder by associating the given logical
1974	name with the given host path, adds it to the collection of shared
1975	folders and starts sharing it. Refer to the description of
1976	<link to="ISharedFolder"/> to read more about logical names.
1977	<note>
1978	In the current implementation, this operation is not
1979	implemented.
1980	</note>
1981	</desc>
1982	<param name="name" type="wstring" dir="in">
1983	<desc>Unique logical name of the shared folder.</desc>
1984	</param>
1985	<param name="hostPath" type="wstring" dir="in">
1986	<desc>Full path to the shared folder in the host file system.</desc>
1987	</param>
1988	<param name="writable" type="boolean" dir="in">
1989	<desc>Whether the share is writable or readonly</desc>
1990	</param>
1991	<param name="automount" type="boolean" dir="in">
1992	<desc>Whether the share gets automatically mounted by the guest
1993	or not.</desc>
1994	</param>
1995	</method>
1996
1997	<method name="removeSharedFolder">
1998	<desc>
1999	Removes the global shared folder with the given name previously
2000	created by <link to="#createSharedFolder"/> from the collection of
2001	shared folders and stops sharing it.
2002	<note>
2003	In the current implementation, this operation is not
2004	implemented.
2005	</note>
2006	</desc>
2007	<param name="name" type="wstring" dir="in">
2008	<desc>Logical name of the shared folder to remove.</desc>
2009	</param>
2010	</method>
2011
2012	<method name="getExtraDataKeys">
2013	<desc>
2014	Returns an array representing the global extra data keys which currently
2015	have values defined.
2016	</desc>
2017	<param name="value" type="wstring" dir="return" safearray="yes">
2018	<desc>Array of extra data keys.</desc>
2019	</param>
2020	</method>
2021
2022	<method name="getExtraData">
2023	<desc>
2024	Returns associated global extra data.
2025
2026	If the requested data @a key does not exist, this function will
2027	succeed and return an empty string in the @a value argument.
2028
2029	<result name="VBOX_E_FILE_ERROR">
2030	Settings file not accessible.
2031	</result>
2032	<result name="VBOX_E_XML_ERROR">
2033	Could not parse the settings file.
2034	</result>
2035
2036	</desc>
2037	<param name="key" type="wstring" dir="in">
2038	<desc>Name of the data key to get.</desc>
2039	</param>
2040	<param name="value" type="wstring" dir="return">
2041	<desc>Value of the requested data key.</desc>
2042	</param>
2043	</method>
2044
2045	<method name="setExtraData">
2046	<desc>
2047	Sets associated global extra data.
2048
2049	If you pass @c null or empty string as a key @a value, the given @a key
2050	will be deleted.
2051
2052	<note>
2053	Before performing the actual data change, this method will ask all
2054	registered event listener using the
2055	<link to="IExtraDataCanChangeEvent"/>
2056	notification for a permission. If one of the listeners refuses the
2057	new value, the change will not be performed.
2058	</note>
2059	<note>
2060	On success, the
2061	<link to="IExtraDataChangedEvent"/> notification
2062	is called to inform all registered listeners about a successful data
2063	change.
2064	</note>
2065
2066	<result name="VBOX_E_FILE_ERROR">
2067	Settings file not accessible.
2068	</result>
2069	<result name="VBOX_E_XML_ERROR">
2070	Could not parse the settings file.
2071	</result>
2072	<result name="E_ACCESSDENIED">
2073	Modification request refused.
2074	</result>
2075
2076	</desc>
2077	<param name="key" type="wstring" dir="in">
2078	<desc>Name of the data key to set.</desc>
2079	</param>
2080	<param name="value" type="wstring" dir="in">
2081	<desc>Value to assign to the key.</desc>
2082	</param>
2083	</method>
2084
2085	<!--method name="createDHCPServerForInterface">
2086	<desc>
2087	Creates a dhcp server settings to be used for the given interface
2088	<result name="E_INVALIDARG">
2089	Host network interface @a name already exists.
2090	</result>
2091	</desc>
2092	<param name="interface" type="IHostNetworkInterface" dir="in">
2093	<desc>Network Interface</desc>
2094	</param>
2095	<param name="server" type="IDHCPServer" dir="out">
2096	<desc>Dhcp server settings</desc>
2097	</param>
2098	</method-->
2099
2100	<method name="createDHCPServer">
2101	<desc>
2102	Creates a dhcp server settings to be used for the given internal network name
2103	<result name="E_INVALIDARG">
2104	Host network interface @a name already exists.
2105	</result>
2106	</desc>
2107	<param name="name" type="wstring" dir="in">
2108	<desc>server name</desc>
2109	</param>
2110	<param name="server" type="IDHCPServer" dir="return">
2111	<desc>Dhcp server settings</desc>
2112	</param>
2113	</method>
2114
2115	<method name="findDHCPServerByNetworkName">
2116	<desc>
2117	Searches a dhcp server settings to be used for the given internal network name
2118	<result name="E_INVALIDARG">
2119	Host network interface @a name already exists.
2120	</result>
2121
2122	</desc>
2123	<param name="name" type="wstring" dir="in">
2124	<desc>server name</desc>
2125	</param>
2126	<param name="server" type="IDHCPServer" dir="return">
2127	<desc>Dhcp server settings</desc>
2128	</param>
2129	</method>
2130
2131	<!--method name="findDHCPServerForInterface">
2132	<desc>
2133	Searches a dhcp server settings to be used for the given interface
2134	<result name="E_INVALIDARG">
2135	Host network interface @a name already exists.
2136	</result>
2137	</desc>
2138	<param name="interface" type="IHostNetworkInterface" dir="in">
2139	<desc>Network Interface</desc>
2140	</param>
2141	<param name="server" type="IDHCPServer" dir="out">
2142	<desc>Dhcp server settings</desc>
2143	</param>
2144	</method-->
2145
2146	<method name="removeDHCPServer">
2147	<desc>
2148	Removes the dhcp server settings
2149	<result name="E_INVALIDARG">
2150	Host network interface @a name already exists.
2151	</result>
2152	</desc>
2153	<param name="server" type="IDHCPServer" dir="in">
2154	<desc>Dhcp server settings to be removed</desc>
2155	</param>
2156	</method>
2157
2158
2159	<method name="checkFirmwarePresent">
2160	<desc>
2161	Check if this VirtualBox installation has a firmware
2162	of the given type available, either system-wide or per-user.
2163	Optionally, this may return a hint where this firmware can be
2164	downloaded from.
2165	</desc>
2166	<param name="firmwareType" type="FirmwareType" dir="in">
2167	<desc>
2168	Type of firmware to check.
2169	</desc>
2170	</param>
2171	<param name="version" type="wstring" dir="in">
2172	<desc>Expected version number, usually empty string (presently ignored).</desc>
2173	</param>
2174
2175	<param name="url" type="wstring" dir="out">
2176	<desc>
2177	Suggested URL to download this firmware from.
2178	</desc>
2179	</param>
2180
2181	<param name="file" type="wstring" dir="out">
2182	<desc>
2183	Filename of firmware, only valid if result == TRUE.
2184	</desc>
2185	</param>
2186
2187	<param name="result" type="boolean" dir="return">
2188	<desc>If firmware of this type and version is available.</desc>
2189	</param>
2190	</method>
2191
2192	<method name="VRDERegisterLibrary">
2193	<desc>
2194	Appends a VRDE library to this VirtualBox installation.
2195
2196	The library implements a VirtualBox Remote Desktop Extension (VRDE),
2197	which is used to remotely connect to the virtual machines.
2198
2199	The system library extension (".DLL" or ".so") must be omitted.
2200	The library must reside in the VirtualBox installation directory.
2201	</desc>
2202	<param name="name" type="wstring" dir="in">
2203	<desc>The library name.</desc>
2204	</param>
2205	</method>
2206
2207	<method name="VRDEUnregisterLibrary">
2208	<desc>
2209	Removes a VRDE library from this VirtualBox installation.
2210	</desc>
2211	<param name="name" type="wstring" dir="in">
2212	<desc>The library name.</desc>
2213	</param>
2214	</method>
2215
2216	<method name="VRDEListLibraries">
2217	<desc>
2218	List registered libraries.
2219	</desc>
2220	<param name="names" type="wstring" dir="return" safearray="yes">
2221	<desc>Array of names of the libraries.</desc>
2222	</param>
2223	</method>
2224
2225	</interface>
2226
2227	<!--
2228	// IVFSExplorer
2229	/////////////////////////////////////////////////////////////////////////
2230	-->
2231
2232	<enum
2233	name="VFSType"
2234	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2235	>
2236	<desc>
2237	Virtual file systems supported by VFSExplorer.
2238	</desc>
2239
2240	<const name="File" value="1" />
2241	<const name="Cloud" value="2" />
2242	<const name="S3" value="3" />
2243	<const name="WebDav" value="4" />
2244	</enum>
2245
2246	<enum
2247	name="VFSFileType"
2248	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2249	>
2250	<desc>
2251	File types known by VFSExplorer.
2252	</desc>
2253
2254	<const name="Unknown" value="1" />
2255	<const name="Fifo" value="2" />
2256	<const name="DevChar" value="3" />
2257	<const name="Directory" value="4" />
2258	<const name="DevBlock" value="5" />
2259	<const name="File" value="6" />
2260	<const name="SymLink" value="7" />
2261	<const name="Socket" value="8" />
2262	<const name="WhiteOut" value="9" />
2263	</enum>
2264
2265	<interface
2266	name="IVFSExplorer" extends="$unknown"
2267	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2268	wsmap="managed"
2269	>
2270	<desc>
2271	The VFSExplorer interface unifies access to different file system
2272	types. This includes local file systems as well remote file systems like
2273	S3. For a list of supported types see <link to="VFSType" />.
2274	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2275	</desc>
2276
2277	<attribute name="path" type="wstring" readonly="yes">
2278	<desc>Returns the current path in the virtual file system.</desc>
2279	</attribute>
2280
2281	<attribute name="type" type="VFSType" readonly="yes">
2282	<desc>Returns the file system type which is currently in use.</desc>
2283	</attribute>
2284
2285	<method name="update">
2286	<desc>Updates the internal list of files/directories from the
2287	current directory level. Use <link to="#entryList" /> to get the full list
2288	after a call to this method.</desc>
2289
2290	<param name="aProgress" type="IProgress" dir="return">
2291	<desc>Progress object to track the operation completion.</desc>
2292	</param>
2293	</method>
2294
2295	<method name="cd">
2296	<desc>Change the current directory level.</desc>
2297
2298	<param name="aDir" type="wstring" dir="in">
2299	<desc>The name of the directory to go in.</desc>
2300	</param>
2301
2302	<param name="aProgress" type="IProgress" dir="return">
2303	<desc>Progress object to track the operation completion.</desc>
2304	</param>
2305	</method>
2306
2307	<method name="cdUp">
2308	<desc>Go one directory upwards from the current directory level.</desc>
2309
2310	<param name="aProgress" type="IProgress" dir="return">
2311	<desc>Progress object to track the operation completion.</desc>
2312	</param>
2313	</method>
2314
2315	<method name="entryList">
2316	<desc>Returns a list of files/directories after a call to <link
2317	to="#update" />. The user is responsible for keeping this internal
2318	list up do date.</desc>
2319
2320	<param name="aNames" type="wstring" safearray="yes" dir="out">
2321	<desc>The list of names for the entries.</desc>
2322	</param>
2323
2324	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2325	<desc>The list of types for the entries.</desc>
2326	</param>
2327
2328	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2329	<desc>The list of sizes (in bytes) for the entries.</desc>
2330	</param>
2331
2332	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2333	<desc>The list of file modes (in octal form) for the entries.</desc>
2334	</param>
2335	</method>
2336
2337	<method name="exists">
2338	<desc>Checks if the given file list exists in the current directory
2339	level.</desc>
2340
2341	<param name="aNames" type="wstring" safearray="yes" dir="in">
2342	<desc>The names to check.</desc>
2343	</param>
2344
2345	<param name="aExists" type="wstring" safearray="yes" dir="return">
2346	<desc>The names which exist.</desc>
2347	</param>
2348	</method>
2349
2350	<method name="remove">
2351	<desc>Deletes the given files in the current directory level.</desc>
2352
2353	<param name="aNames" type="wstring" safearray="yes" dir="in">
2354	<desc>The names to remove.</desc>
2355	</param>
2356
2357	<param name="aProgress" type="IProgress" dir="return">
2358	<desc>Progress object to track the operation completion.</desc>
2359	</param>
2360	</method>
2361
2362	</interface>
2363
2364	<!--
2365	// IAppliance
2366	/////////////////////////////////////////////////////////////////////////
2367	-->
2368
2369	<interface
2370	name="IAppliance" extends="$unknown"
2371	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2372	wsmap="managed"
2373	>
2374	<desc>
2375	Represents a platform-independent appliance in OVF format. An instance of this is returned
2376	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2377	virtual machines within an appliance with VirtualBox.
2378
2379	The OVF standard suggests two different physical file formats:
2380
2381	<ol>
2382	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2383	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2384	this descriptor file references other files such as disk images, as OVF appliances typically
2385	do, those additional files must be in the same directory as the descriptor file.</li>
2386
2387	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2388	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2389	files and optionally other files.
2390
2391	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2392	be added with a later version.</li>
2393	</ol>
2394
2395	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2396	<link to="IMachine" /> involves the following sequence of API calls:
2397
2398	<ol>
2399	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2400	</li>
2401
2402	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2403	would like to import. So long as this file is syntactically valid, this will succeed
2404	and fill the appliance object with the parsed data from the OVF file.
2405	</li>
2406
2407	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2408	contents of the IAppliance attributes accordingly. These can be inspected by a
2409	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2410	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2411	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2412	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2413	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2414	The GUI can then give the user the option to confirm and/or change these suggestions.
2415	</li>
2416
2417	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2418	virtual system (machine) to override the suggestions made by the interpret() routine.
2419	</li>
2420
2421	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2422	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2423	virtual system descriptions. After this call suceeded, the UUIDs of the machines created
2424	can be found in the <link to="#machines" /> array attribute.
2425	</li>
2426	</ol>
2427
2428	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2429
2430	<ol>
2431	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2432	an empty IAppliance object.
2433	</li>
2434
2435	<li>For each machine you would like to export, call <link to="IMachine::export" />
2436	with the IAppliance object you just created. Each such call creates one instance of
2437	<link to="IVirtualSystemDescription" /> inside the appliance.
2438	</li>
2439
2440	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2441	virtual system (machine) to override the suggestions made by the export() routine.
2442	</li>
2443
2444	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2445	file written.</li>
2446	</ol>
2447
2448	</desc>
2449
2450	<attribute name="path" type="wstring" readonly="yes">
2451	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2452	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2453	<link to="#write" /> (for export).
2454	This attribute is empty until one of these methods has been called.
2455	</desc>
2456	</attribute>
2457
2458	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2459	<desc>
2460	Array of virtual disk definitions. One such description exists for each
2461	disk definition in the OVF; each string array item represents one such piece of
2462	disk information, with the information fields separated by tab (\t) characters.
2463
2464	The caller should be prepared for additional fields being appended to
2465	this string in future versions of VirtualBox and therefore check for
2466	the number of tabs in the strings returned.
2467
2468	In the current version, the following eight fields are returned per string
2469	in the array:
2470
2471	<ol>
2472	<li>Disk ID (unique string identifier given to disk)</li>
2473
2474	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2475
2476	<li>Populated size (optional unsigned integer indicating the current size of the
2477	disk; can be approximate; -1 if unspecified)</li>
2478
2479	<li>Format (string identifying the disk format, typically
2480	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2481
2482	<li>Reference (where to find the disk image, typically a file name; if empty,
2483	then the disk should be created on import)</li>
2484
2485	<li>Image size (optional unsigned integer indicating the size of the image,
2486	which need not necessarily be the same as the values specified above, since
2487	the image may be compressed or sparse; -1 if not specified)</li>
2488
2489	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2490	presently unsupported and always -1)</li>
2491
2492	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2493	</ol>
2494	</desc>
2495	</attribute>
2496
2497	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2498	<desc> Array of virtual system descriptions. One such description is created
2499	for each virtual system (machine) found in the OVF.
2500	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2501	(for export) has been called.
2502	</desc>
2503	</attribute>
2504
2505	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2506	<desc>
2507	Contains the UUIDs of the machines created from the information in this appliances. This is only
2508	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2509	succeeded.
2510	</desc>
2511	</attribute>
2512
2513	<method name="read">
2514	<desc>
2515	Reads an OVF file into the appliance object.
2516
2517	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2518	mere fact that this method returns successfully does not mean that VirtualBox supports all
2519	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2520	</desc>
2521	<param name="file" type="wstring" dir="in">
2522	<desc>
2523	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2524	on whether the appliance is distributed as a set of files or as a single file, respectively).
2525	</desc>
2526	</param>
2527	<param name="aProgress" type="IProgress" dir="return">
2528	<desc>Progress object to track the operation completion.</desc>
2529	</param>
2530	</method>
2531
2532	<method name="interpret">
2533	<desc>
2534	Interprets the OVF data that was read when the appliance was constructed. After
2535	calling this method, one can inspect the
2536	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2537	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2538	the appliance.
2539
2540	Calling this method is the second step of importing an appliance into VirtualBox;
2541	see <link to="IAppliance" /> for an overview.
2542
2543	After calling this method, one should call <link to="#getWarnings" /> to find out
2544	if problems were encountered during the processing which might later lead to
2545	errors.
2546	</desc>
2547	</method>
2548
2549	<method name="importMachines">
2550	<desc>
2551	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2552	and other interfaces that match the information contained in the appliance as
2553	closely as possible, as represented by the import instructions in the
2554	<link to="#virtualSystemDescriptions" /> array.
2555
2556	Calling this method is the final step of importing an appliance into VirtualBox;
2557	see <link to="IAppliance" /> for an overview.
2558
2559	Since importing the appliance will most probably involve copying and converting
2560	disk images, which can take a long time, this method operates asynchronously and
2561	returns an IProgress object to allow the caller to monitor the progress.
2562
2563	After the import succeeded, the UUIDs of the IMachine instances created can be
2564	retrieved from the <link to="#machines" /> array attribute.
2565	</desc>
2566
2567	<param name="aProgress" type="IProgress" dir="return">
2568	<desc>Progress object to track the operation completion.</desc>
2569	</param>
2570	</method>
2571
2572	<method name="createVFSExplorer">
2573	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2574
2575	<param name="aUri" type="wstring" dir="in">
2576	<desc>The URI describing the file system to use.</desc>
2577	</param>
2578
2579	<param name="aExplorer" type="IVFSExplorer" dir="return">
2580	<desc></desc>
2581	</param>
2582	</method>
2583
2584	<method name="write">
2585	<desc>
2586	Writes the contents of the appliance exports into a new OVF file.
2587
2588	Calling this method is the final step of exporting an appliance from VirtualBox;
2589	see <link to="IAppliance" /> for an overview.
2590
2591	Since exporting the appliance will most probably involve copying and converting
2592	disk images, which can take a long time, this method operates asynchronously and
2593	returns an IProgress object to allow the caller to monitor the progress.
2594	</desc>
2595	<param name="format" type="wstring" dir="in">
2596	<desc>
2597	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2598	future versions of VirtualBox may support additional formats.
2599	</desc>
2600	</param>
2601	<param name="manifest" type="boolean" dir="in">
2602	<desc>
2603	Indicate if the optional manifest file (.mf) should be written. The manifest file
2604	is used for integrity checks prior import.
2605	</desc>
2606	</param>
2607	<param name="path" type="wstring" dir="in">
2608	<desc>
2609	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2610	on whether the appliance is distributed as a set of files or as a single file, respectively).
2611	</desc>
2612	</param>
2613	<param name="progress" type="IProgress" dir="return">
2614	<desc>Progress object to track the operation completion.</desc>
2615	</param>
2616	</method>
2617
2618	<method name="getWarnings">
2619	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2620
2621	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2622	<desc></desc>
2623	</param>
2624	</method>
2625
2626	</interface>
2627
2628	<enum
2629	name="VirtualSystemDescriptionType"
2630	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2631	>
2632	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2633	a configuration value.</desc>
2634
2635	<const name="Ignore" value="1" />
2636	<const name="OS" value="2" />
2637	<const name="Name" value="3" />
2638	<const name="Product" value="4" />
2639	<const name="Vendor" value="5" />
2640	<const name="Version" value="6" />
2641	<const name="ProductUrl" value="7" />
2642	<const name="VendorUrl" value="8" />
2643	<const name="Description" value="9" />
2644	<const name="License" value="10" />
2645	<const name="Miscellaneous" value="11" />
2646	<const name="CPU" value="12" />
2647	<const name="Memory" value="13" />
2648	<const name="HardDiskControllerIDE" value="14" />
2649	<const name="HardDiskControllerSATA" value="15" />
2650	<const name="HardDiskControllerSCSI" value="16" />
2651	<const name="HardDiskControllerSAS" value="17" />
2652	<const name="HardDiskImage" value="18" />
2653	<const name="Floppy" value="19" />
2654	<const name="CDROM" value="20" />
2655	<const name="NetworkAdapter" value="21" />
2656	<const name="USBController" value="22" />
2657	<const name="SoundCard" value="23" />
2658
2659	</enum>
2660
2661	<enum
2662	name="VirtualSystemDescriptionValueType"
2663	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2664	>
2665	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2666	type to fetch.</desc>
2667
2668	<const name="Reference" value="1" />
2669	<const name="Original" value="2" />
2670	<const name="Auto" value="3" />
2671	<const name="ExtraConfig" value="4" />
2672
2673	</enum>
2674
2675	<interface
2676	name="IVirtualSystemDescription" extends="$unknown"
2677	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2678	wsmap="managed"
2679	>
2680
2681	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2682	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2683	<link to="IAppliance::interpret" /> has been called, that array contains information
2684	about how the virtual systems described in the OVF should best be imported into
2685	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2686	import an OVF into VirtualBox.
2687	</desc>
2688
2689	<attribute name="count" type="unsigned long" readonly="yes">
2690	<desc>Return the number of virtual system description entries.</desc>
2691	</attribute>
2692
2693	<method name="getDescription">
2694	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2695	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2696
2697	The list below identifies the value sets that are possible depending on the
2698	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2699	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2700	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2701	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2702	the @a aExtraConfigValues[] array item may also be used.
2703
2704	<ul>
2705	<li>
2706	"OS": the guest operating system type. There must be exactly one such array item on import. The
2707	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2708	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2709	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2710	</li>
2711	<li>
2712	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2713	if none is present on import, then an automatic name will be created from the operating system
2714	type. The correponding item im @a aOvfValues[] will contain the suggested virtual machine name
2715	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2716	<link to="IMachine" /> name that does not exist yet.
2717	</li>
2718	<li>
2719	"Description": an arbitrary description.
2720	</li>
2721	<li>
2722	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2723	code to display such a license for agreement; the Main API does not enforce any such policy.
2724	</li>
2725	<li>
2726	Miscellaneous: reserved for future use.
2727	</li>
2728	<li>
2729	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2730	</li>
2731	<li>
2732	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2733	is present on import, then VirtualBox will set a meaningful default based on the operating system
2734	type.
2735	</li>
2736	<li>
2737	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2738	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2739	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2740	writes into the OVF.
2741	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2742	type can use to specify which hard disk controller a virtual disk should be connected to.
2743	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2744	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2745	its virtual machines supports four channels (primary master, primary slave, secondary master,
2746	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2747	</li>
2748	<li>
2749	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2750	has no value in @a aOvfValues[] or @a aVBoxValues[].
2751	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2752	</li>
2753	<li>
2754	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2755	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2756	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2757	whereas VirtualBox considers it a class of storage controllers of its own; see
2758	<link to="StorageControllerType" />).
2759	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2760	</li>
2761	<li>
2762	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2763	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2764
2765	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2766	a path since the image file should be in the same location as the OVF file itself), whereas the
2767	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2768	hard disk image. This means that on import the image will be copied and converted from the
2769	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2770
2771	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2772	format: "controller=<index>;channel=<c>"
2773	In this string, <index> must be an integer specifying the hard disk controller to connect
2774	the image to. That number must be the index of an array item with one of the hard disk controller
2775	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2776	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2777	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2778	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2779	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2780	</li>
2781	<li>
2782	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2783	attachment information as with "HardDiskImage" items.
2784	</li>
2785	<li>
2786	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2787	attachment information as with "HardDiskImage" items.
2788	</li>
2789	<li>
2790	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2791	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2792	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2793	</li>
2794	<li>
2795	"USBController": a USB controller. There can be at most one such item. If and only if such an
2796	item ispresent, USB support will be enabled for the new virtual machine.
2797	</li>
2798	<li>
2799	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2800	present, sound support will be enabled for the new virtual machine. Note that the virtual
2801	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2802	may be different from the virtual soundcard expected by the appliance.
2803	</li>
2804	</ul>
2805
2806	</desc>
2807
2808	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2809	<desc></desc>
2810	</param>
2811
2812	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2813	<desc></desc>
2814	</param>
2815
2816	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2817	<desc></desc>
2818	</param>
2819
2820	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2821	<desc></desc>
2822	</param>
2823
2824	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2825	<desc></desc>
2826	</param>
2827
2828	</method>
2829
2830	<method name="getDescriptionByType">
2831	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2832	should be returned.</desc>
2833
2834	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2835	<desc></desc>
2836	</param>
2837
2838	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2839	<desc></desc>
2840	</param>
2841
2842	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2843	<desc></desc>
2844	</param>
2845
2846	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2847	<desc></desc>
2848	</param>
2849
2850	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	</method>
2859
2860	<method name="getValuesByType">
2861	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2862	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2863	values.</desc>
2864
2865	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2866	<desc></desc>
2867	</param>
2868
2869	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2870	<desc></desc>
2871	</param>
2872
2873	<param name="aValues" type="wstring" dir="return" safearray="yes">
2874	<desc></desc>
2875	</param>
2876
2877	</method>
2878
2879	<method name="setFinalValues">
2880	<desc>
2881	This method allows the appliance's user to change the configuration for the virtual
2882	system descriptions. For each array item returned from <link to="#getDescription" />,
2883	you must pass in one boolean value and one configuration value.
2884
2885	Each item in the boolean array determines whether the particular configuration item
2886	should be enabled.
2887	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2888	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2889	and SoundCard.
2890
2891	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2892	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2893	the configuration remains unchanged. Please see the documentation for getDescription()
2894	for valid configuration values for the individual array item types. If the
2895	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2896	</desc>
2897
2898	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2899	<desc></desc>
2900	</param>
2901
2902	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2903	<desc></desc>
2904	</param>
2905
2906	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2907	<desc></desc>
2908	</param>
2909	</method>
2910
2911	<method name="addDescription">
2912	<desc>
2913	This method adds an additional description entry to the stack of already
2914	available descriptions for this virtual system. This is handy for writing
2915	values which aren't directly supported by VirtualBox. One example would
2916	be the License type of <link to="VirtualSystemDescriptionType" />.
2917	</desc>
2918
2919	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2920	<desc></desc>
2921	</param>
2922
2923	<param name="aVBoxValue" type="wstring" dir="in">
2924	<desc></desc>
2925	</param>
2926
2927	<param name="aExtraConfigValue" type="wstring" dir="in">
2928	<desc></desc>
2929	</param>
2930	</method>
2931	</interface>
2932
2933
2934	<!--
2935	// IMachine
2936	/////////////////////////////////////////////////////////////////////////
2937	-->
2938
2939	<interface
2940	name="IInternalMachineControl" extends="$unknown"
2941	uuid="e2da8b1a-2ad1-490e-b29e-c33a144791b6"
2942	internal="yes"
2943	wsmap="suppress"
2944	>
2945	<method name="setRemoveSavedStateFile">
2946	<desc>
2947	Updates the flag whether the saved state file is removed on a
2948	machine state change from Saved to PoweredOff.
2949	</desc>
2950	<param name="aRemove" type="boolean" dir="in"/>
2951	</method>
2952
2953	<method name="updateState">
2954	<desc>
2955	Updates the VM state.
2956	<note>
2957	This operation will also update the settings file with the correct
2958	information about the saved state file and delete this file from disk
2959	when appropriate.
2960	</note>
2961	</desc>
2962	<param name="state" type="MachineState" dir="in"/>
2963	</method>
2964
2965	<method name="getIPCId">
2966	<param name="id" type="wstring" dir="return"/>
2967	</method>
2968
2969	<method name="beginPowerUp">
2970	<desc>
2971	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2972	gives it the progress object that should be part of any pending
2973	<link to="IMachine::launchVMProcess"/> operations. The progress
2974	object may be called back to reflect an early cancelation, so some care
2975	have to be taken with respect to any cancelation callbacks. The console
2976	object will call <link to="IInternalMachineControl::endPowerUp"/>
2977	to signal the completion of the progress object.
2978	</desc>
2979	<param name="aProgress" type="IProgress" dir="in" />
2980	</method>
2981
2982	<method name="endPowerUp">
2983	<desc>
2984	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2985	This method may query status information from the progress object it
2986	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2987	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2988	call in order to complete that progress object.
2989	</desc>
2990	<param name="result" type="long" dir="in"/>
2991	</method>
2992
2993	<method name="runUSBDeviceFilters">
2994	<desc>
2995	Asks the server to run USB devices filters of the associated
2996	machine against the given USB device and tell if there is
2997	a match.
2998	<note>
2999	Intended to be used only for remote USB devices. Local
3000	ones don't require to call this method (this is done
3001	implicitly by the Host and USBProxyService).
3002	</note>
3003	</desc>
3004	<param name="device" type="IUSBDevice" dir="in"/>
3005	<param name="matched" type="boolean" dir="out"/>
3006	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3007	</method>
3008
3009	<method name="captureUSBDevice">
3010	<desc>
3011	Requests a capture of the given host USB device.
3012	When the request is completed, the VM process will
3013	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3014	notification.
3015	</desc>
3016	<param name="id" type="uuid" mod="string" dir="in"/>
3017	</method>
3018
3019	<method name="detachUSBDevice">
3020	<desc>
3021	Notification that a VM is going to detach (@a done = @c false) or has
3022	already detached (@a done = @c true) the given USB device.
3023	When the @a done = @c true request is completed, the VM process will
3024	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3025	notification.
3026	<note>
3027	In the @a done = @c true case, the server must run its own filters
3028	and filters of all VMs but this one on the detached device
3029	as if it were just attached to the host computer.
3030	</note>
3031	</desc>
3032	<param name="id" type="uuid" mod="string" dir="in"/>
3033	<param name="done" type="boolean" dir="in"/>
3034	</method>
3035
3036	<method name="autoCaptureUSBDevices">
3037	<desc>
3038	Requests a capture all matching USB devices attached to the host.
3039	When the request is completed, the VM process will
3040	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3041	notification per every captured device.
3042	</desc>
3043	</method>
3044
3045	<method name="detachAllUSBDevices">
3046	<desc>
3047	Notification that a VM that is being powered down. The done
3048	parameter indicates whether which stage of the power down
3049	we're at. When @a done = @c false the VM is announcing its
3050	intentions, while when @a done = @c true the VM is reporting
3051	what it has done.
3052	<note>
3053	In the @a done = @c true case, the server must run its own filters
3054	and filters of all VMs but this one on all detach devices as
3055	if they were just attached to the host computer.
3056	</note>
3057	</desc>
3058	<param name="done" type="boolean" dir="in"/>
3059	</method>
3060
3061	<method name="onSessionEnd">
3062	<desc>
3063	Triggered by the given session object when the session is about
3064	to close normally.
3065	</desc>
3066	<param name="session" type="ISession" dir="in">
3067	<desc>Session that is being closed</desc>
3068	</param>
3069	<param name="progress" type="IProgress" dir="return">
3070	<desc>
3071	Used to wait until the corresponding machine is actually
3072	dissociated from the given session on the server.
3073	Returned only when this session is a direct one.
3074	</desc>
3075	</param>
3076	</method>
3077
3078	<method name="beginSavingState">
3079	<desc>
3080	Called by the VM process to inform the server it wants to
3081	save the current state and stop the VM execution.
3082	</desc>
3083	<param name="progress" type="IProgress" dir="in">
3084	<desc>
3085	Progress object created by the VM process to wait until
3086	the state is saved.
3087	</desc>
3088	</param>
3089	<param name="stateFilePath" type="wstring" dir="out">
3090	<desc>
3091	File path the VM process must save the execution state to.
3092	</desc>
3093	</param>
3094	</method>
3095
3096	<method name="endSavingState">
3097	<desc>
3098	Called by the VM process to inform the server that saving
3099	the state previously requested by #beginSavingState is either
3100	successfully finished or there was a failure.
3101
3102	<result name="VBOX_E_FILE_ERROR">
3103	Settings file not accessible.
3104	</result>
3105	<result name="VBOX_E_XML_ERROR">
3106	Could not parse the settings file.
3107	</result>
3108
3109	</desc>
3110
3111	<param name="success" type="boolean" dir="in">
3112	<desc>@c true to indicate success and @c false otherwise.
3113	</desc>
3114	</param>
3115	</method>
3116
3117	<method name="adoptSavedState">
3118	<desc>
3119	Gets called by IConsole::adoptSavedState.
3120	<result name="VBOX_E_FILE_ERROR">
3121	Invalid saved state file path.
3122	</result>
3123	</desc>
3124	<param name="savedStateFile" type="wstring" dir="in">
3125	<desc>Path to the saved state file to adopt.</desc>
3126	</param>
3127	</method>
3128
3129	<method name="beginTakingSnapshot">
3130	<desc>
3131	Called from the VM process to request from the server to perform the
3132	server-side actions of creating a snapshot (creating differencing images
3133	and the snapshot object).
3134
3135	<result name="VBOX_E_FILE_ERROR">
3136	Settings file not accessible.
3137	</result>
3138	<result name="VBOX_E_XML_ERROR">
3139	Could not parse the settings file.
3140	</result>
3141	</desc>
3142	<param name="initiator" type="IConsole" dir="in">
3143	<desc>The console object that initiated this call.</desc>
3144	</param>
3145	<param name="name" type="wstring" dir="in">
3146	<desc>Snapshot name.</desc>
3147	</param>
3148	<param name="description" type="wstring" dir="in">
3149	<desc>Snapshot description.</desc>
3150	</param>
3151	<param name="consoleProgress" type="IProgress" dir="in">
3152	<desc>
3153	Progress object created by the VM process tracking the
3154	snapshot's progress. This has the following sub-operations:
3155	<ul>
3156	<li>setting up (weight 1);</li>
3157	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3158	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3159	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3160	<li>finishing up (weight 1)</li>
3161	</ul>
3162	</desc>
3163	</param>
3164	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3165	<desc>
3166	Whether this is an online snapshot (i.e. the machine is running).
3167	</desc>
3168	</param>
3169	<param name="stateFilePath" type="wstring" dir="out">
3170	<desc>
3171	File path the VM process must save the execution state to.
3172	</desc>
3173	</param>
3174	</method>
3175
3176	<method name="endTakingSnapshot">
3177	<desc>
3178	Called by the VM process to inform the server that the snapshot
3179	previously requested by #beginTakingSnapshot is either
3180	successfully taken or there was a failure.
3181	</desc>
3182
3183	<param name="success" type="boolean" dir="in">
3184	<desc>@c true to indicate success and @c false otherwise</desc>
3185	</param>
3186	</method>
3187
3188	<method name="deleteSnapshot">
3189	<desc>
3190	Gets called by IConsole::deleteSnapshot.
3191	<result name="VBOX_E_INVALID_OBJECT_STATE">
3192	Snapshot has more than one child snapshot.
3193	</result>
3194	</desc>
3195	<param name="initiator" type="IConsole" dir="in">
3196	<desc>The console object that initiated this call.</desc>
3197	</param>
3198	<param name="id" type="uuid" mod="string" dir="in">
3199	<desc>UUID of the snapshot to delete.</desc>
3200	</param>
3201	<param name="machineState" type="MachineState" dir="out">
3202	<desc>New machine state after this operation is started.</desc>
3203	</param>
3204	<param name="progress" type="IProgress" dir="return">
3205	<desc>Progress object to track the operation completion.</desc>
3206	</param>
3207	</method>
3208
3209	<method name="finishOnlineMergeMedium">
3210	<desc>
3211	Gets called by IConsole::onlineMergeMedium.
3212	</desc>
3213	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3214	<desc>The medium attachment which needs to be cleaned up.</desc>
3215	</param>
3216	<param name="source" type="IMedium" dir="in">
3217	<desc>Merge source medium.</desc>
3218	</param>
3219	<param name="target" type="IMedium" dir="in">
3220	<desc>Merge target medium.</desc>
3221	</param>
3222	<param name="mergeForward" type="boolean" dir="in">
3223	<desc>Merge direction.</desc>
3224	</param>
3225	<param name="parentForTarget" type="IMedium" dir="in">
3226	<desc>For forward merges: new parent for target medium.</desc>
3227	</param>
3228	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3229	<desc>For backward merges: list of media which need their parent UUID
3230	updated.</desc>
3231	</param>
3232	</method>
3233
3234	<method name="restoreSnapshot">
3235	<desc>
3236	Gets called by IConsole::RestoreSnapshot.
3237	</desc>
3238	<param name="initiator" type="IConsole" dir="in">
3239	<desc>The console object that initiated this call.</desc>
3240	</param>
3241	<param name="snapshot" type="ISnapshot" dir="in">
3242	<desc>The snapshot to restore the VM state from.</desc>
3243	</param>
3244	<param name="machineState" type="MachineState" dir="out">
3245	<desc>New machine state after this operation is started.</desc>
3246	</param>
3247	<param name="progress" type="IProgress" dir="return">
3248	<desc>Progress object to track the operation completion.</desc>
3249	</param>
3250	</method>
3251
3252	<method name="pullGuestProperties">
3253	<desc>
3254	Get the list of the guest properties matching a set of patterns along
3255	with their values, time stamps and flags and give responsibility for
3256	managing properties to the console.
3257	</desc>
3258	<param name="name" type="wstring" dir="out" safearray="yes">
3259	<desc>
3260	The names of the properties returned.
3261	</desc>
3262	</param>
3263	<param name="value" type="wstring" dir="out" safearray="yes">
3264	<desc>
3265	The values of the properties returned. The array entries match the
3266	corresponding entries in the @a name array.
3267	</desc>
3268	</param>
3269	<param name="timestamp" type="long long" dir="out" safearray="yes">
3270	<desc>
3271	The time stamps of the properties returned. The array entries match
3272	the corresponding entries in the @a name array.
3273	</desc>
3274	</param>
3275	<param name="flags" type="wstring" dir="out" safearray="yes">
3276	<desc>
3277	The flags of the properties returned. The array entries match the
3278	corresponding entries in the @a name array.
3279	</desc>
3280	</param>
3281	</method>
3282
3283	<method name="pushGuestProperty">
3284	<desc>
3285	Update a single guest property in IMachine.
3286	</desc>
3287	<param name="name" type="wstring" dir="in">
3288	<desc>
3289	The name of the property to be updated.
3290	</desc>
3291	</param>
3292	<param name="value" type="wstring" dir="in">
3293	<desc>
3294	The value of the property.
3295	</desc>
3296	</param>
3297	<param name="timestamp" type="long long" dir="in">
3298	<desc>
3299	The timestamp of the property.
3300	</desc>
3301	</param>
3302	<param name="flags" type="wstring" dir="in">
3303	<desc>
3304	The flags of the property.
3305	</desc>
3306	</param>
3307	</method>
3308
3309	<method name="lockMedia">
3310	<desc>
3311	Locks all media attached to the machine for writing and parents of
3312	attached differencing media (if any) for reading. This operation is
3313	atomic so that if it fails no media is actually locked.
3314
3315	This method is intended to be called when the machine is in Starting or
3316	Restoring state. The locked media will be automatically unlocked when
3317	the machine is powered off or crashed.
3318	</desc>
3319	</method>
3320	<method name="unlockMedia">
3321	<desc>
3322	Unlocks all media previously locked using
3323	<link to="IInternalMachineControl::lockMedia"/>.
3324
3325	This method is intended to be used with teleportation so that it is
3326	possible to teleport between processes on the same machine.
3327	</desc>
3328	</method>
3329	</interface>
3330
3331	<interface
3332	name="IBIOSSettings" extends="$unknown"
3333	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3334	wsmap="managed"
3335	>
3336	<desc>
3337	The IBIOSSettings interface represents BIOS settings of the virtual
3338	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3339	</desc>
3340	<attribute name="logoFadeIn" type="boolean">
3341	<desc>Fade in flag for BIOS logo animation.</desc>
3342	</attribute>
3343
3344	<attribute name="logoFadeOut" type="boolean">
3345	<desc>Fade out flag for BIOS logo animation.</desc>
3346	</attribute>
3347
3348	<attribute name="logoDisplayTime" type="unsigned long">
3349	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3350	</attribute>
3351
3352	<attribute name="logoImagePath" type="wstring">
3353	<desc>
3354	Local file system path for external BIOS splash image. Empty string
3355	means the default image is shown on boot.
3356	</desc>
3357	</attribute>
3358
3359	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3360	<desc>Mode of the BIOS boot device menu.</desc>
3361	</attribute>
3362
3363	<attribute name="ACPIEnabled" type="boolean">
3364	<desc>ACPI support flag.</desc>
3365	</attribute>
3366
3367	<attribute name="IOAPICEnabled" type="boolean">
3368	<desc>
3369	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3370	and support IRQs above 15.
3371	</desc>
3372	</attribute>
3373
3374	<attribute name="timeOffset" type="long long">
3375	<desc>
3376	Offset in milliseconds from the host system time. This allows for
3377	guests running with a different system date/time than the host.
3378	It is equivalent to setting the system date/time in the BIOS except
3379	it is not an absolute value but a relative one. Guest Additions
3380	time synchronization honors this offset.
3381	</desc>
3382	</attribute>
3383
3384	<attribute name="PXEDebugEnabled" type="boolean">
3385	<desc>
3386	PXE debug logging flag. If set, VirtualBox will write extensive
3387	PXE trace information to the release log.
3388	</desc>
3389	</attribute>
3390
3391	</interface>
3392
3393	<enum name="CleanupMode"
3394	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441">
3395	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3396	</desc>
3397	<const name="UnregisterOnly" value="1">
3398	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3399	</const>
3400	<const name="DetachAllReturnNone" value="2">
3401	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3402	</const>
3403	<const name="DetachAllReturnHardDisksOnly" value="3">
3404	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3405	</const>
3406	<const name="Full" value="4">
3407	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3408	</const>
3409	</enum>
3410
3411	<interface
3412	name="IMachine" extends="$unknown"
3413	uuid="cc4fec9a-3150-45df-9ee9-f00ba54d6ac3"
3414	wsmap="managed"
3415	>
3416	<desc>
3417	The IMachine interface represents a virtual machine, or guest, created
3418	in VirtualBox.
3419
3420	This interface is used in two contexts. First of all, a collection of
3421	objects implementing this interface is stored in the
3422	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3423	machines that are currently registered with this VirtualBox
3424	installation. Also, once a session has been opened for the given virtual
3425	machine (e.g. the virtual machine is running), the machine object
3426	associated with the open session can be queried from the session object;
3427	see <link to="ISession"/> for details.
3428
3429	The main role of this interface is to expose the settings of the virtual
3430	machine and provide methods to change various aspects of the virtual
3431	machine's configuration. For machine objects stored in the
3432	<link to="IVirtualBox::machines"/> collection, all attributes are
3433	read-only unless explicitly stated otherwise in individual attribute
3434	and method descriptions.
3435
3436	In order to change a machine setting, a session for this machine must be
3437	opened using one of the <link to="IMachine::lockMachine" /> or
3438	<link to="IMachine::launchVMProcess"/> methods. After the
3439	machine has been successfully locked for a session, a mutable machine object
3440	needs to be queried from the session object and then the desired settings
3441	changes can be applied to the returned object using IMachine attributes and
3442	methods. See the <link to="ISession"/> interface description for more
3443	information about sessions.
3444
3445	Note that IMachine does not provide methods to control virtual machine
3446	execution (such as start the machine, or power it down) -- these methods
3447	are grouped in a separate interface called <link to="IConsole" />.
3448
3449	<see>ISession, IConsole</see>
3450	</desc>
3451
3452	<attribute name="parent" type="IVirtualBox" readonly="yes">
3453	<desc>Associated parent object.</desc>
3454	</attribute>
3455
3456	<attribute name="accessible" type="boolean" readonly="yes">
3457	<desc>
3458	Whether this virtual machine is currently accessible or not.
3459
3460	A machine is always deemed accessible unless it is registered <i>and</i>
3461	its settings file cannot be read or parsed (either because the file itself
3462	is unavailable or has invalid XML contents).
3463
3464	Every time this property is read, the accessibility state of
3465	this machine is re-evaluated. If the returned value is @c false,
3466	the <link to="#accessError"/> property may be used to get the
3467	detailed error information describing the reason of
3468	inaccessibility, including XML error messages.
3469
3470	When the machine is inaccessible, only the following properties
3471	can be used on it:
3472	<ul>
3473	<li><link to="#parent"/></li>
3474	<li><link to="#id"/></li>
3475	<li><link to="#settingsFilePath"/></li>
3476	<li><link to="#accessible"/></li>
3477	<li><link to="#accessError"/></li>
3478	</ul>
3479
3480	An attempt to access any other property or method will return
3481	an error.
3482
3483	The only possible action you can perform on an inaccessible
3484	machine is to unregister it using the
3485	<link to="IMachine::unregister"/> call (or, to check
3486	for the accessibility state once more by querying this
3487	property).
3488
3489	<note>
3490	In the current implementation, once this property returns
3491	@c true, the machine will never become inaccessible
3492	later, even if its settings file cannot be successfully
3493	read/written any more (at least, until the VirtualBox
3494	server is restarted). This limitation may be removed in
3495	future releases.
3496	</note>
3497	</desc>
3498	</attribute>
3499
3500	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3501	<desc>
3502	Error information describing the reason of machine
3503	inaccessibility.
3504
3505	Reading this property is only valid after the last call to
3506	<link to="#accessible"/> returned @c false (i.e. the
3507	machine is currently unaccessible). Otherwise, a @c null
3508	IVirtualBoxErrorInfo object will be returned.
3509	</desc>
3510	</attribute>
3511
3512	<attribute name="name" type="wstring">
3513	<desc>
3514	Name of the virtual machine.
3515
3516	Besides being used for human-readable identification purposes
3517	everywhere in VirtualBox, the virtual machine name is also used
3518	as a name of the machine's settings file and as a name of the
3519	subdirectory this settings file resides in. Thus, every time you
3520	change the value of this property, the settings file will be
3521	renamed once you call <link to="#saveSettings"/> to confirm the
3522	change. The containing subdirectory will be also renamed, but
3523	only if it has exactly the same name as the settings file
3524	itself prior to changing this property (for backward compatibility
3525	with previous API releases). The above implies the following
3526	limitations:
3527	<ul>
3528	<li>The machine name cannot be empty.</li>
3529	<li>The machine name can contain only characters that are valid
3530	file name characters according to the rules of the file
3531	system used to store VirtualBox configuration.</li>
3532	<li>You cannot have two or more machines with the same name
3533	if they use the same subdirectory for storing the machine
3534	settings files.</li>
3535	<li>You cannot change the name of the machine if it is running,
3536	or if any file in the directory containing the settings file
3537	is being used by another running machine or by any other
3538	process in the host operating system at a time when
3539	<link to="#saveSettings"/> is called.
3540	</li>
3541	</ul>
3542	If any of the above limitations are hit, <link to="#saveSettings"/>
3543	will return an appropriate error message explaining the exact
3544	reason and the changes you made to this machine will not be saved.
3545	</desc>
3546	</attribute>
3547
3548	<attribute name="description" type="wstring">
3549	<desc>
3550	Description of the virtual machine.
3551
3552	The description attribute can contain any text and is
3553	typically used to describe the hardware and software
3554	configuration of the virtual machine in detail (i.e. network
3555	settings, versions of the installed software and so on).
3556	</desc>
3557	</attribute>
3558
3559	<attribute name="id" type="uuid" mod="string" readonly="yes">
3560	<desc>UUID of the virtual machine.</desc>
3561	</attribute>
3562
3563	<attribute name="OSTypeId" type="wstring">
3564	<desc>
3565	User-defined identifier of the Guest OS type.
3566	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3567	an IGuestOSType object representing details about the given
3568	Guest OS type.
3569	<note>
3570	This value may differ from the value returned by
3571	<link to="IGuest::OSTypeId"/> if Guest Additions are
3572	installed to the guest OS.
3573	</note>
3574	</desc>
3575	</attribute>
3576
3577	<attribute name="HardwareVersion" type="wstring">
3578	<desc>Hardware version identifier. Internal use only for now.</desc>
3579	</attribute>
3580
3581	<attribute name="hardwareUUID" type="uuid" mod="string">
3582	<desc>
3583	The UUID presented to the guest via memory tables, hardware and guest
3584	properties. For most VMs this is the same as the @a id, but for VMs
3585	which have been cloned or teleported it may be the same as the source
3586	VM. This latter is because the guest shouldn't notice that it was
3587	cloned or teleported.
3588	</desc>
3589	</attribute>
3590
3591	<attribute name="CPUCount" type="unsigned long">
3592	<desc>Number of virtual CPUs in the VM.</desc>
3593	</attribute>
3594
3595	<attribute name="CPUHotPlugEnabled" type="boolean">
3596	<desc>
3597	This setting determines whether VirtualBox allows CPU
3598	hotplugging for this machine.</desc>
3599	</attribute>
3600
3601	<attribute name="CPUExecutionCap" type="unsigned long">
3602	<desc>
3603	Means to limit the number of CPU cycles a guest can use. The unit
3604	is percentage of host CPU cycles per second. The valid range
3605	is 1 - 100. 100 (the default) implies no limit.
3606	</desc>
3607	</attribute>
3608
3609	<attribute name="memorySize" type="unsigned long">
3610	<desc>System memory size in megabytes.</desc>
3611	</attribute>
3612
3613	<attribute name="memoryBalloonSize" type="unsigned long">
3614	<desc>Memory balloon size in megabytes.</desc>
3615	</attribute>
3616
3617	<attribute name="PageFusionEnabled" type="boolean">
3618	<desc>
3619	This setting determines whether VirtualBox allows page
3620	fusion for this machine (64 bits host only).
3621	</desc>
3622	</attribute>
3623
3624	<attribute name="VRAMSize" type="unsigned long">
3625	<desc>Video memory size in megabytes.</desc>
3626	</attribute>
3627
3628	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3629	<desc>
3630	This setting determines whether VirtualBox allows this machine to make
3631	use of the 3D graphics support available on the host.</desc>
3632	</attribute>
3633
3634	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3635	<desc>
3636	This setting determines whether VirtualBox allows this machine to make
3637	use of the 2D video acceleration support available on the host.</desc>
3638	</attribute>
3639
3640	<attribute name="monitorCount" type="unsigned long">
3641	<desc>
3642	Number of virtual monitors.
3643	<note>
3644	Only effective on Windows XP and later guests with
3645	Guest Additions installed.
3646	</note>
3647	</desc>
3648	</attribute>
3649
3650	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3651	<desc>Object containing all BIOS settings.</desc>
3652	</attribute>
3653
3654	<attribute name="firmwareType" type="FirmwareType">
3655	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3656	bootstrap in this VM.</desc>
3657	</attribute>
3658
3659	<attribute name="pointingHidType" type="PointingHidType">
3660	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3661	The default is typically "PS2Mouse" but can vary depending on the
3662	requirements of the guest operating system.</desc>
3663	</attribute>
3664
3665	<attribute name="keyboardHidType" type="KeyboardHidType">
3666	<desc>Type of keyboard HID used in this VM.
3667	The default is typically "PS2Keyboard" but can vary depending on the
3668	requirements of the guest operating system.</desc>
3669	</attribute>
3670
3671	<attribute name="hpetEnabled" type="boolean">
3672	<desc>This attribute controls if High Precision Event Timer (HPET) is
3673	enabled in this VM. Use this property if you want to provide guests
3674	with additional time source, or if guest requires HPET to function correctly.
3675	Default is false.</desc>
3676	</attribute>
3677
3678	<attribute name="chipsetType" type="ChipsetType">
3679	<desc>Chipset type used in this VM.</desc>
3680	</attribute>
3681
3682	<attribute name="snapshotFolder" type="wstring">
3683	<desc>
3684	Full path to the directory used to store snapshot data
3685	(differencing media and saved state files) of this machine.
3686
3687	The initial value of this property is
3688	<tt><</tt><link to="#settingsFilePath">
3689	path_to_settings_file</link><tt>>/<</tt>
3690	<link to="#id">machine_uuid</link>
3691	<tt>></tt>.
3692
3693	Currently, it is an error to try to change this property on
3694	a machine that has snapshots (because this would require to
3695	move possibly large files to a different location).
3696	A separate method will be available for this purpose later.
3697
3698	<note>
3699	Setting this property to @c null or to an empty string will restore
3700	the initial value.
3701	</note>
3702	<note>
3703	When setting this property, the specified path can be
3704	absolute (full path) or relative to the directory where the
3705	<link to="#settingsFilePath">machine settings file</link>
3706	is located. When reading this property, a full path is
3707	always returned.
3708	</note>
3709	<note>
3710	The specified path may not exist, it will be created
3711	when necessary.
3712	</note>
3713	</desc>
3714	</attribute>
3715
3716	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3717	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3718	</attribute>
3719
3720	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3721	<desc>Array of media attached to this machine.</desc>
3722	</attribute>
3723
3724	<attribute name="USBController" type="IUSBController" readonly="yes">
3725	<desc>
3726	Associated USB controller object.
3727
3728	<note>
3729	If USB functionality is not available in the given edition of
3730	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3731	</note>
3732	</desc>
3733	</attribute>
3734
3735	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3736	<desc>Associated audio adapter, always present.</desc>
3737	</attribute>
3738
3739	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3740	<desc>Array of storage controllers attached to this machine.</desc>
3741	</attribute>
3742
3743	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3744	<desc>
3745	Full name of the file containing machine settings data.
3746	</desc>
3747	</attribute>
3748
3749	<attribute name="settingsModified" type="boolean" readonly="yes">
3750	<desc>
3751	Whether the settings of this machine have been modified
3752	(but neither yet saved nor discarded).
3753	<note>
3754	Reading this property is only valid on instances returned
3755	by <link to="ISession::machine"/> and on new machines
3756	created by <link to="IVirtualBox::createMachine"/> or opened
3757	by <link to="IVirtualBox::openMachine"/> but not
3758	yet registered, or on unregistered machines after calling
3759	<link to="IMachine::unregister"/>. For all other
3760	cases, the settings can never be modified.
3761	</note>
3762	<note>
3763	For newly created unregistered machines, the value of this
3764	property is always @c true until <link to="#saveSettings"/>
3765	is called (no matter if any machine settings have been
3766	changed after the creation or not). For opened machines
3767	the value is set to @c false (and then follows to normal rules).
3768	</note>
3769	</desc>
3770	</attribute>
3771
3772	<attribute name="sessionState" type="SessionState" readonly="yes">
3773	<desc>Current session state for this machine.</desc>
3774	</attribute>
3775
3776	<attribute name="sessionType" type="wstring" readonly="yes">
3777	<desc>
3778	Type of the session. If <link to="#sessionState"/> is
3779	Spawning or Locked, this attribute contains the
3780	same value as passed to the
3781	<link to="IMachine::launchVMProcess"/> method in the
3782	@a type parameter. If the session was used with
3783	<link to="IMachine::lockMachine" />, or if
3784	<link to="#sessionState"/> is SessionClosed, the value of this
3785	attribute is an empty string.
3786	</desc>
3787	</attribute>
3788
3789	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3790	<desc>
3791	Identifier of the session process. This attribute contains the
3792	platform-dependent identifier of the process whose session was
3793	used with <link to="IMachine::lockMachine" /> call. The returned
3794	value is only valid if <link to="#sessionState"/> is Locked or
3795	Unlocking by the time this property is read.
3796	</desc>
3797	</attribute>
3798
3799	<attribute name="state" type="MachineState" readonly="yes">
3800	<desc>Current execution state of this machine.</desc>
3801	</attribute>
3802
3803	<attribute name="lastStateChange" type="long long" readonly="yes">
3804	<desc>
3805	Time stamp of the last execution state change,
3806	in milliseconds since 1970-01-01 UTC.
3807	</desc>
3808	</attribute>
3809
3810	<attribute name="stateFilePath" type="wstring" readonly="yes">
3811	<desc>
3812	Full path to the file that stores the execution state of
3813	the machine when it is in the <link to="MachineState_Saved"/> state.
3814	<note>
3815	When the machine is not in the Saved state, this attribute is
3816	an empty string.
3817	</note>
3818	</desc>
3819	</attribute>
3820
3821	<attribute name="logFolder" type="wstring" readonly="yes">
3822	<desc>
3823	Full path to the folder that stores a set of rotated log files
3824	recorded during machine execution. The most recent log file is
3825	named <tt>VBox.log</tt>, the previous log file is
3826	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3827	in the current version).
3828	</desc>
3829	</attribute>
3830
3831	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3832	<desc>
3833	Current snapshot of this machine. This is @c null if the machine
3834	currently has no snapshots. If it is not @c null, then it was
3835	set by one of <link to="IConsole::takeSnapshot" />,
3836	<link to="IConsole::deleteSnapshot" />
3837	or <link to="IConsole::restoreSnapshot" />, depending on which
3838	was called last. See <link to="ISnapshot"/> for details.
3839	</desc>
3840	</attribute>
3841
3842	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3843	<desc>
3844	Number of snapshots taken on this machine. Zero means the
3845	machine doesn't have any snapshots.
3846	</desc>
3847	</attribute>
3848
3849	<attribute name="currentStateModified" type="boolean" readonly="yes">
3850	<desc>
3851	Returns @c true if the current state of the machine is not
3852	identical to the state stored in the current snapshot.
3853
3854	The current state is identical to the current snapshot only
3855	directly after one of the following calls are made:
3856
3857	<ul>
3858	<li><link to="IConsole::restoreSnapshot"/>
3859	</li>
3860	<li><link to="IConsole::takeSnapshot"/> (issued on a
3861	"powered off" or "saved" machine, for which
3862	<link to="#settingsModified"/> returns @c false)
3863	</li>
3864	</ul>
3865
3866	The current state remains identical until one of the following
3867	happens:
3868	<ul>
3869	<li>settings of the machine are changed</li>
3870	<li>the saved state is deleted</li>
3871	<li>the current snapshot is deleted</li>
3872	<li>an attempt to execute the machine is made</li>
3873	</ul>
3874
3875	<note>
3876	For machines that don't have snapshots, this property is
3877	always @c false.
3878	</note>
3879	</desc>
3880	</attribute>
3881
3882	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3883	<desc>
3884	Collection of shared folders for this machine (permanent shared
3885	folders). These folders are shared automatically at machine startup
3886	and available only to the guest OS installed within this machine.
3887
3888	New shared folders are added to the collection using
3889	<link to="#createSharedFolder"/>. Existing shared folders can be
3890	removed using <link to="#removeSharedFolder"/>.
3891	</desc>
3892	</attribute>
3893
3894	<attribute name="clipboardMode" type="ClipboardMode">
3895	<desc>
3896	Synchronization mode between the host OS clipboard
3897	and the guest OS clipboard.
3898	</desc>
3899	</attribute>
3900
3901	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3902	<desc>
3903	A comma-separated list of simple glob patterns. Changes to guest
3904	properties whose name matches one of the patterns will generate an
3905	<link to="IGuestPropertyChangedEvent"/> signal.
3906	</desc>
3907	</attribute>
3908
3909	<attribute name="teleporterEnabled" type="boolean">
3910	<desc>
3911	When set to @a true, the virtual machine becomes a target teleporter
3912	the next time it is powered on. This can only set to @a true when the
3913	VM is in the @a PoweredOff or @a Aborted state.
3914
3915	<!-- This property is automatically set to @a false when the VM is powered
3916	on. (bird: This doesn't work yet ) -->
3917	</desc>
3918	</attribute>
3919
3920	<attribute name="teleporterPort" type="unsigned long">
3921	<desc>
3922	The TCP port the target teleporter will listen for incoming
3923	teleportations on.
3924
3925	0 means the port is automatically selected upon power on. The actual
3926	value can be read from this property while the machine is waiting for
3927	incoming teleportations.
3928	</desc>
3929	</attribute>
3930
3931	<attribute name="teleporterAddress" type="wstring">
3932	<desc>
3933	The address the target teleporter will listen on. If set to an empty
3934	string, it will listen on all addresses.
3935	</desc>
3936	</attribute>
3937
3938	<attribute name="teleporterPassword" type="wstring">
3939	<desc>
3940	The password to check for on the target teleporter. This is just a
3941	very basic measure to prevent simple hacks and operators accidentally
3942	beaming a virtual machine to the wrong place.
3943	</desc>
3944	</attribute>
3945
3946	<attribute name="faultToleranceState" type="FaultToleranceState">
3947	<desc>
3948	Fault tolerance state; disabled, source or target.
3949	This property can be changed at any time. If you change it for a running
3950	VM, then the fault tolerance address and port must be set beforehand.
3951	</desc>
3952	</attribute>
3953
3954	<attribute name="faultTolerancePort" type="unsigned long">
3955	<desc>
3956	The TCP port the fault tolerance source or target will use for
3957	communication.
3958	</desc>
3959	</attribute>
3960
3961	<attribute name="faultToleranceAddress" type="wstring">
3962	<desc>
3963	The address the fault tolerance source or target.
3964	</desc>
3965	</attribute>
3966
3967	<attribute name="faultTolerancePassword" type="wstring">
3968	<desc>
3969	The password to check for on the standby VM. This is just a
3970	very basic measure to prevent simple hacks and operators accidentally
3971	choosing the wrong standby VM.
3972	</desc>
3973	</attribute>
3974
3975	<attribute name="faultToleranceSyncInterval" type="unsigned long">
3976	<desc>
3977	The interval in ms used for syncing the state between source and target.
3978	</desc>
3979	</attribute>
3980
3981	<attribute name="RTCUseUTC" type="boolean">
3982	<desc>
3983	When set to @a true, the RTC device of the virtual machine will run
3984	in UTC time, otherwise in local time. Especially Unix guests prefer
3985	the time in UTC.
3986	</desc>
3987	</attribute>
3988
3989	<attribute name="ioCacheEnabled" type="boolean">
3990	<desc>
3991	When set to @a true, the builtin I/O cache of the virtual machine
3992	will be enabled.
3993	</desc>
3994	</attribute>
3995
3996	<attribute name="ioCacheSize" type="unsigned long">
3997	<desc>
3998	Maximum size of the I/O cache in MB.
3999	</desc>
4000	</attribute>
4001
4002	<method name="lockMachine">
4003	<desc>
4004	Locks the machine for the given session to enable the caller
4005	to make changes to the machine or start the VM or control
4006	VM execution.
4007
4008	There are two ways to lock a machine for such uses:
4009
4010	<ul>
4011	<li>If you want to make changes to the machine settings,
4012	you must obtain an exclusive write lock on the machine
4013	by setting @a lockType to @c Write.
4014
4015	This will only succeed if no other process has locked
4016	the machine to prevent conflicting changes. Only after
4017	an exclusive write lock has been obtained using this method, one
4018	can change all VM settings or execute the VM in the process
4019	space of the session object. (Note that the latter is only of
4020	interest if you actually want to write a new front-end for
4021	virtual machines; but this API gets called internally by
4022	the existing front-ends such as VBoxHeadless and the VirtualBox
4023	GUI to acquire a write lock on the machine that they are running.)
4024
4025	On success, write-locking the machine for a session creates
4026	a second copy of the IMachine object. It is this second object
4027	upon which changes can be made; in VirtualBox terminology, the
4028	second copy is "mutable". It is only this second, mutable machine
4029	object upon which you can call methods that change the
4030	machine state. After having called this method, you can
4031	obtain this second, mutable machine object using the
4032	<link to="ISession::machine" /> attribute.
4033	</li>
4034	<li>If you only want to check the machine state or control
4035	machine execution without actually changing machine
4036	settings (e.g. to get access to VM statistics or take
4037	a snapshot or save the machine state), then set the
4038	@a lockType argument to @c Shared.
4039
4040	If no other session has obtained a lock, you will obtain an
4041	exclusive write lock as described above. However, if another
4042	session has already obtained such a lock, then a link to that
4043	existing session will be established which allows you
4044	to control that existing session.
4045
4046	To find out which type of lock was obtained, you can
4047	inspect <link to="ISession::type" />, which will have been
4048	set to either @c WriteLock or @c Shared.
4049	</li>
4050	</ul>
4051
4052	In either case, you can get access to the <link to="IConsole" />
4053	object which controls VM execution.
4054
4055	Also in all of the above cases, one must always call
4056	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4057	the machine's state will eventually be set to "Aborted".
4058
4059	To change settings on a machine, the following sequence is typically
4060	performed:
4061
4062	<ol>
4063	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4064
4065	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4066
4067	<li>Change the settings of the machine by invoking IMachine methods.</li>
4068
4069	<li>Call <link to="IMachine::saveSettings" />.</li>
4070
4071	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4072	</ol>
4073
4074	<result name="E_UNEXPECTED">
4075	Virtual machine not registered.
4076	</result>
4077	<result name="E_ACCESSDENIED">
4078	Process not started by OpenRemoteSession.
4079	</result>
4080	<result name="VBOX_E_INVALID_OBJECT_STATE">
4081	Session already open or being opened.
4082	</result>
4083	<result name="VBOX_E_VM_ERROR">
4084	Failed to assign machine to session.
4085	</result>
4086	</desc>
4087	<param name="session" type="ISession" dir="in">
4088	<desc>
4089	Session object for which the machine will be locked.
4090	</desc>
4091	</param>
4092	<param name="lockType" type="LockType" dir="in">
4093	<desc>
4094	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4095	If set to @c Shared, then either acquire an exclusive write lock or establish
4096	a link to an existing session.
4097	</desc>
4098	</param>
4099	</method>
4100
4101	<method name="launchVMProcess">
4102	<desc>
4103	Spawns a new process that will execute the virtual machine and obtains a shared
4104	lock on the machine for the calling session.
4105
4106	If launching the VM succeeds, the new VM process will create its own session
4107	and write-lock the machine for it, preventing conflicting changes from other
4108	processes. If the machine is already locked (because it is already running or
4109	because another session has a write lock), launching the VM process will therefore
4110	fail. Reversely, future attempts to obtain a write lock will also fail while the
4111	machine is running.
4112
4113	The caller's session object remains separate from the session opened by the new
4114	VM process. It receives its own <link to="IConsole" /> object which can be used
4115	to control machine execution, but it cannot be used to change all VM settings
4116	which would be available after a <link to="#lockMachine" /> call.
4117
4118	The caller must eventually release the session's shared lock by calling
4119	<link to="ISession::unlockMachine" /> on the local session object once this call
4120	has returned. However, the session's state (see <link to="ISession::state" />)
4121	will not return to "Unlocked" until the remote session has also unlocked
4122	the machine (i.e. the machine has stopped running).
4123
4124	Lauching a VM process can take some time (a new VM is started in a new process,
4125	for which memory and other resources need to be set up). Because of this,
4126	an <link to="IProgress" /> object is returned to allow the caller to wait
4127	for this asynchronous operation to be completed. Until then, the caller's
4128	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4129	and <link to="ISession::console" /> attributes cannot be accessed.
4130	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4131	similar calls to wait for completion. Completion is signalled when the VM
4132	is powered on. If launching the VM fails, error messages can be queried
4133	via the progress object, if available.
4134
4135	The progress object will have at least 2 sub-operations. The first
4136	operation covers the period up to the new VM process calls powerUp.
4137	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4138	progress object. Because <link to="IConsole::powerUp"/> may require
4139	some extra sub-operations, the <link to="IProgress::operationCount"/>
4140	may change at the completion of operation.
4141
4142	For details on the teleportation progress operation, see
4143	<link to="IConsole::powerUp"/>.
4144
4145	The @a environment argument is a string containing definitions of
4146	environment variables in the following format:
4147	@code
4148	NAME[=VALUE]\n
4149	NAME[=VALUE]\n
4150	...
4151	@endcode
4152	where <tt>\\n</tt> is the new line character. These environment
4153	variables will be appended to the environment of the VirtualBox server
4154	process. If an environment variable exists both in the server process
4155	and in this list, the value from this list takes precedence over the
4156	server's variable. If the value of the environment variable is
4157	omitted, this variable will be removed from the resulting environment.
4158	If the environment string is @c null or empty, the server environment
4159	is inherited by the started process as is.
4160
4161	<result name="E_UNEXPECTED">
4162	Virtual machine not registered.
4163	</result>
4164	<result name="E_INVALIDARG">
4165	Invalid session type @a type.
4166	</result>
4167	<result name="VBOX_E_OBJECT_NOT_FOUND">
4168	No machine matching @a machineId found.
4169	</result>
4170	<result name="VBOX_E_INVALID_OBJECT_STATE">
4171	Session already open or being opened.
4172	</result>
4173	<result name="VBOX_E_IPRT_ERROR">
4174	Launching process for machine failed.
4175	</result>
4176	<result name="VBOX_E_VM_ERROR">
4177	Failed to assign machine to session.
4178	</result>
4179	</desc>
4180	<param name="session" type="ISession" dir="in">
4181	<desc>
4182	Client session object to which the VM process will be connected (this
4183	must be in "Unlocked" state).
4184	</desc>
4185	</param>
4186	<param name="type" type="wstring" dir="in">
4187	<desc>
4188	Front-end to use for the new VM process. The following are currently supported:
4189	<ul>
4190	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4191	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4192	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4193	</ul>
4194	</desc>
4195	</param>
4196	<param name="environment" type="wstring" dir="in">
4197	<desc>
4198	Environment to pass to the VM process.
4199	</desc>
4200	</param>
4201	<param name="progress" type="IProgress" dir="return">
4202	<desc>Progress object to track the operation completion.</desc>
4203	</param>
4204	</method>
4205
4206	<method name="setBootOrder">
4207	<desc>
4208	Puts the given device to the specified position in
4209	the boot order.
4210
4211	To indicate that no device is associated with the given position,
4212	<link to="DeviceType_Null"/> should be used.
4213
4214	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4215
4216	<result name="E_INVALIDARG">
4217	Boot @a position out of range.
4218	</result>
4219	<result name="E_NOTIMPL">
4220	Booting from USB @a device currently not supported.
4221	</result>
4222
4223	</desc>
4224	<param name="position" type="unsigned long" dir="in">
4225	<desc>
4226	Position in the boot order (@c 1 to the total number of
4227	devices the machine can boot from, as returned by
4228	<link to="ISystemProperties::maxBootPosition"/>).
4229	</desc>
4230	</param>
4231	<param name="device" type="DeviceType" dir="in">
4232	<desc>
4233	The type of the device used to boot at the given position.
4234	</desc>
4235	</param>
4236	</method>
4237
4238	<method name="getBootOrder" const="yes">
4239	<desc>
4240	Returns the device type that occupies the specified
4241	position in the boot order.
4242
4243	@todo [remove?]
4244	If the machine can have more than one device of the returned type
4245	(such as hard disks), then a separate method should be used to
4246	retrieve the individual device that occupies the given position.
4247
4248	If here are no devices at the given position, then
4249	<link to="DeviceType_Null"/> is returned.
4250
4251	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4252
4253	<result name="E_INVALIDARG">
4254	Boot @a position out of range.
4255	</result>
4256
4257	</desc>
4258	<param name="position" type="unsigned long" dir="in">
4259	<desc>
4260	Position in the boot order (@c 1 to the total number of
4261	devices the machine can boot from, as returned by
4262	<link to="ISystemProperties::maxBootPosition"/>).
4263	</desc>
4264	</param>
4265	<param name="device" type="DeviceType" dir="return">
4266	<desc>
4267	Device at the given position.
4268	</desc>
4269	</param>
4270	</method>
4271
4272	<method name="attachDevice">
4273	<desc>
4274	Attaches a device and optionally mounts a medium to the given storage
4275	controller (<link to="IStorageController" />, identified by @a name),
4276	at the indicated port and device.
4277
4278	This method is intended for managing storage devices in general while a
4279	machine is powered off. It can be used to attach and detach fixed
4280	and removeable media. The following kind of media can be attached
4281	to a machine:
4282
4283	<ul>
4284	<li>For fixed and removable media, you can pass in a medium that was
4285	previously opened using <link to="IVirtualBox::openMedium" />.
4286	</li>
4287
4288	<li>Only for storage devices supporting removable media (such as
4289	DVDs and floppies), you can also specify a null pointer to
4290	indicate an empty drive or one of the medium objects listed
4291	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4292	arrays to indicate a host drive.
4293	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4294	to change the media while the machine is running.
4295	</li>
4296	</ul>
4297
4298	In a VM's default configuration of virtual machines, the secondary
4299	master of the IDE controller is used for a CD/DVD drive.
4300
4301	After calling this returns successfully, a new instance of
4302	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4303	attachments (see <link to="IMachine::mediumAttachments"/>).
4304
4305	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4306	information about attaching media.
4307
4308	The specified device slot must not have a device attached to it,
4309	or this method will fail.
4310
4311	<note>
4312	You cannot attach a device to a newly created machine until
4313	this machine's settings are saved to disk using
4314	<link to="#saveSettings"/>.
4315	</note>
4316	<note>
4317	If the medium is being attached indirectly, a new differencing medium
4318	will implicitly be created for it and attached instead. If the
4319	changes made to the machine settings (including this indirect
4320	attachment) are later cancelled using <link to="#discardSettings"/>,
4321	this implicitly created differencing medium will implicitly
4322	be deleted.
4323	</note>
4324
4325	<result name="E_INVALIDARG">
4326	SATA device, SATA port, IDE port or IDE slot out of range, or
4327	file or UUID not found.
4328	</result>
4329	<result name="VBOX_E_INVALID_OBJECT_STATE">
4330	Machine must be registered before media can be attached.
4331	</result>
4332	<result name="VBOX_E_INVALID_VM_STATE">
4333	Invalid machine state.
4334	</result>
4335	<result name="VBOX_E_OBJECT_IN_USE">
4336	A medium is already attached to this or another virtual machine.
4337	</result>
4338
4339	</desc>
4340	<param name="name" type="wstring" dir="in">
4341	<desc>Name of the storage controller to attach the device to.</desc>
4342	</param>
4343	<param name="controllerPort" type="long" dir="in">
4344	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4345	the primary controller and 1 specifies the secondary controller.
4346	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4347	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4348	</param>
4349	<param name="device" type="long" dir="in">
4350	<desc>Device slot in the given port to attach the device to. This is only
4351	relevant for IDE controllers, for which 0 specifies the master device and
4352	1 specifies the slave device. For all other controller types, this must
4353	be 0.</desc>
4354	</param>
4355	<param name="type" type="DeviceType" dir="in">
4356	<desc>Device type of the attached device. For media opened by
4357	<link to="IVirtualBox::openMedium" />, this must match the device type
4358	specified there.</desc>
4359	</param>
4360	<param name="medium" type="IMedium" dir="in">
4361	<desc>Medium to mount or NULL for an empty drive.</desc>
4362	</param>
4363	</method>
4364
4365	<method name="detachDevice">
4366	<desc>
4367	Detaches the device attached to a device slot of the specified bus.
4368
4369	Detaching the device from the virtual machine is deferred. This means
4370	that the medium remains associated with the machine when this method
4371	returns and gets actually de-associated only after a successful
4372	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4373	for more detailed information about attaching media.
4374
4375	<note>
4376	You cannot detach a device from a running machine.
4377	</note>
4378	<note>
4379	Detaching differencing media implicitly created by <link
4380	to="#attachDevice"/> for the indirect attachment using this
4381	method will <b>not</b> implicitly delete them. The
4382	<link to="IMedium::deleteStorage"/> operation should be
4383	explicitly performed by the caller after the medium is successfully
4384	detached and the settings are saved with
4385	<link to="#saveSettings"/>, if it is the desired action.
4386	</note>
4387
4388	<result name="VBOX_E_INVALID_VM_STATE">
4389	Attempt to detach medium from a running virtual machine.
4390	</result>
4391	<result name="VBOX_E_OBJECT_NOT_FOUND">
4392	No medium attached to given slot/bus.
4393	</result>
4394	<result name="VBOX_E_NOT_SUPPORTED">
4395	Medium format does not support storage deletion.
4396	</result>
4397
4398	</desc>
4399	<param name="name" type="wstring" dir="in">
4400	<desc>Name of the storage controller to detach the medium from.</desc>
4401	</param>
4402	<param name="controllerPort" type="long" dir="in">
4403	<desc>Port number to detach the medium from.</desc>
4404	</param>
4405	<param name="device" type="long" dir="in">
4406	<desc>Device slot number to detach the medium from.</desc>
4407	</param>
4408	</method>
4409
4410	<method name="passthroughDevice">
4411	<desc>
4412	Sets the passthrough mode of an existing DVD device. Changing the
4413	setting while the VM is running is forbidden. The setting is only used
4414	if at VM start the device is configured as a host DVD drive, in all
4415	other cases it is ignored. The device must already exist; see
4416	<link to="IMachine::attachDevice"/> for how to attach a new device.
4417
4418	The @a controllerPort and @a device parameters specify the device slot and
4419	have have the same meaning as with <link to="IMachine::attachDevice" />.
4420
4421	<result name="E_INVALIDARG">
4422	SATA device, SATA port, IDE port or IDE slot out of range.
4423	</result>
4424	<result name="VBOX_E_INVALID_OBJECT_STATE">
4425	Attempt to modify an unregistered virtual machine.
4426	</result>
4427	<result name="VBOX_E_INVALID_VM_STATE">
4428	Invalid machine state.
4429	</result>
4430
4431	</desc>
4432	<param name="name" type="wstring" dir="in">
4433	<desc>Name of the storage controller.</desc>
4434	</param>
4435	<param name="controllerPort" type="long" dir="in">
4436	<desc>Storage controller port.</desc>
4437	</param>
4438	<param name="device" type="long" dir="in">
4439	<desc>Device slot in the given port.</desc>
4440	</param>
4441	<param name="passthrough" type="boolean" dir="in">
4442	<desc>New value for the passthrough setting.</desc>
4443	</param>
4444	</method>
4445
4446	<method name="mountMedium">
4447	<desc>
4448	Mounts a medium (<link to="IMedium" />, identified
4449	by the given UUID @a id) to the given storage controller
4450	(<link to="IStorageController" />, identified by @a name),
4451	at the indicated port and device. The device must already exist;
4452	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4453
4454	This method is intended only for managing removable media, where the
4455	device is fixed but media is changeable at runtime (such as DVDs
4456	and floppies). It cannot be used for fixed media such as hard disks.
4457
4458	The @a controllerPort and @a device parameters specify the device slot and
4459	have have the same meaning as with <link to="IMachine::attachDevice" />.
4460
4461	The specified device slot can have a medium mounted, which will be
4462	unmounted first. Specifying a zero UUID (or an empty string) for
4463	@a medium does just an unmount.
4464
4465	See <link to="IMedium"/> for more detailed information about
4466	attaching media.
4467
4468	<result name="E_INVALIDARG">
4469	SATA device, SATA port, IDE port or IDE slot out of range.
4470	</result>
4471	<result name="VBOX_E_INVALID_OBJECT_STATE">
4472	Attempt to attach medium to an unregistered virtual machine.
4473	</result>
4474	<result name="VBOX_E_INVALID_VM_STATE">
4475	Invalid machine state.
4476	</result>
4477	<result name="VBOX_E_OBJECT_IN_USE">
4478	Medium already attached to this or another virtual machine.
4479	</result>
4480
4481	</desc>
4482	<param name="name" type="wstring" dir="in">
4483	<desc>Name of the storage controller to attach the medium to.</desc>
4484	</param>
4485	<param name="controllerPort" type="long" dir="in">
4486	<desc>Port to attach the medium to.</desc>
4487	</param>
4488	<param name="device" type="long" dir="in">
4489	<desc>Device slot in the given port to attach the medium to.</desc>
4490	</param>
4491	<param name="medium" type="IMedium" dir="in">
4492	<desc>Medium to mount or NULL for an empty drive.</desc>
4493	</param>
4494	<param name="force" type="boolean" dir="in">
4495	<desc>Allows to force unmount/mount of a medium which is locked by
4496	the device slot in the given port to attach the medium to.</desc>
4497	</param>
4498	</method>
4499
4500	<method name="getMedium" const="yes">
4501	<desc>
4502	Returns the virtual medium attached to a device slot of the specified
4503	bus.
4504
4505	Note that if the medium was indirectly attached by
4506	<link to="#mountMedium"/> to the given device slot then this
4507	method will return not the same object as passed to the
4508	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4509	more detailed information about mounting a medium.
4510
4511	<result name="VBOX_E_OBJECT_NOT_FOUND">
4512	No medium attached to given slot/bus.
4513	</result>
4514
4515	</desc>
4516	<param name="name" type="wstring" dir="in">
4517	<desc>Name of the storage controller the medium is attached to.</desc>
4518	</param>
4519	<param name="controllerPort" type="long" dir="in">
4520	<desc>Port to query.</desc>
4521	</param>
4522	<param name="device" type="long" dir="in">
4523	<desc>Device slot in the given port to query.</desc>
4524	</param>
4525	<param name="medium" type="IMedium" dir="return">
4526	<desc>Attached medium object.</desc>
4527	</param>
4528	</method>
4529
4530	<method name="getMediumAttachmentsOfController" const="yes">
4531	<desc>
4532	Returns an array of medium attachments which are attached to the
4533	the controller with the given name.
4534
4535	<result name="VBOX_E_OBJECT_NOT_FOUND">
4536	A storage controller with given name doesn't exist.
4537	</result>
4538	</desc>
4539	<param name="name" type="wstring" dir="in"/>
4540	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4541	</method>
4542
4543	<method name="getMediumAttachment" const="yes">
4544	<desc>
4545	Returns a medium attachment which corresponds to the controller with
4546	the given name, on the given port and device slot.
4547
4548	<result name="VBOX_E_OBJECT_NOT_FOUND">
4549	No attachment exists for the given controller/port/device combination.
4550	</result>
4551	</desc>
4552	<param name="name" type="wstring" dir="in"/>
4553	<param name="controllerPort" type="long" dir="in"/>
4554	<param name="device" type="long" dir="in"/>
4555	<param name="attachment" type="IMediumAttachment" dir="return"/>
4556	</method>
4557
4558	<method name="getNetworkAdapter" const="yes">
4559	<desc>
4560	Returns the network adapter associated with the given slot.
4561	Slots are numbered sequentially, starting with zero. The total
4562	number of adapters per machine is defined by the
4563	<link to="ISystemProperties::networkAdapterCount"/> property,
4564	so the maximum slot number is one less than that property's value.
4565
4566	<result name="E_INVALIDARG">
4567	Invalid @a slot number.
4568	</result>
4569
4570	</desc>
4571	<param name="slot" type="unsigned long" dir="in"/>
4572	<param name="adapter" type="INetworkAdapter" dir="return"/>
4573	</method>
4574
4575	<method name="addStorageController">
4576	<desc>
4577	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4578	machine and returns it as an instance of
4579	<link to="IStorageController" />.
4580
4581	@a name identifies the controller for subsequent calls such as
4582	<link to="#getStorageControllerByName" />,
4583	<link to="#getStorageControllerByInstance" />,
4584	<link to="#removeStorageController" />,
4585	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4586
4587	After the controller has been added, you can set its exact
4588	type by setting the <link to="IStorageController::controllerType" />.
4589
4590	<result name="VBOX_E_OBJECT_IN_USE">
4591	A storage controller with given name exists already.
4592	</result>
4593	<result name="E_INVALIDARG">
4594	Invalid @a controllerType.
4595	</result>
4596	</desc>
4597	<param name="name" type="wstring" dir="in"/>
4598	<param name="connectionType" type="StorageBus" dir="in"/>
4599	<param name="controller" type="IStorageController" dir="return"/>
4600	</method>
4601
4602	<method name="getStorageControllerByName" const="yes">
4603	<desc>
4604	Returns a storage controller with the given name.
4605
4606	<result name="VBOX_E_OBJECT_NOT_FOUND">
4607	A storage controller with given name doesn't exist.
4608	</result>
4609	</desc>
4610	<param name="name" type="wstring" dir="in"/>
4611	<param name="storageController" type="IStorageController" dir="return"/>
4612	</method>
4613
4614	<method name="getStorageControllerByInstance" const="yes">
4615	<desc>
4616	Returns a storage controller with the given instance number.
4617
4618	<result name="VBOX_E_OBJECT_NOT_FOUND">
4619	A storage controller with given instance number doesn't exist.
4620	</result>
4621	</desc>
4622	<param name="instance" type="unsigned long" dir="in"/>
4623	<param name="storageController" type="IStorageController" dir="return"/>
4624	</method>
4625
4626	<method name="removeStorageController">
4627	<desc>
4628	Removes a storage controller from the machine.
4629
4630	<result name="VBOX_E_OBJECT_NOT_FOUND">
4631	A storage controller with given name doesn't exist.
4632	</result>
4633	</desc>
4634	<param name="name" type="wstring" dir="in"/>
4635	</method>
4636
4637	<method name="getSerialPort" const="yes">
4638	<desc>
4639	Returns the serial port associated with the given slot.
4640	Slots are numbered sequentially, starting with zero. The total
4641	number of serial ports per machine is defined by the
4642	<link to="ISystemProperties::serialPortCount"/> property,
4643	so the maximum slot number is one less than that property's value.
4644
4645	<result name="E_INVALIDARG">
4646	Invalid @a slot number.
4647	</result>
4648
4649	</desc>
4650	<param name="slot" type="unsigned long" dir="in"/>
4651	<param name="port" type="ISerialPort" dir="return"/>
4652	</method>
4653
4654	<method name="getParallelPort" const="yes">
4655	<desc>
4656	Returns the parallel port associated with the given slot.
4657	Slots are numbered sequentially, starting with zero. The total
4658	number of parallel ports per machine is defined by the
4659	<link to="ISystemProperties::parallelPortCount"/> property,
4660	so the maximum slot number is one less than that property's value.
4661
4662	<result name="E_INVALIDARG">
4663	Invalid @a slot number.
4664	</result>
4665
4666	</desc>
4667	<param name="slot" type="unsigned long" dir="in"/>
4668	<param name="port" type="IParallelPort" dir="return"/>
4669	</method>
4670
4671	<method name="getExtraDataKeys">
4672	<desc>
4673	Returns an array representing the machine-specific extra data keys
4674	which currently have values defined.
4675	</desc>
4676	<param name="value" type="wstring" dir="return" safearray="yes">
4677	<desc>Array of extra data keys.</desc>
4678	</param>
4679	</method>
4680
4681	<method name="getExtraData">
4682	<desc>
4683	Returns associated machine-specific extra data.
4684
4685	If the requested data @a key does not exist, this function will
4686	succeed and return an empty string in the @a value argument.
4687
4688	<result name="VBOX_E_FILE_ERROR">
4689	Settings file not accessible.
4690	</result>
4691	<result name="VBOX_E_XML_ERROR">
4692	Could not parse the settings file.
4693	</result>
4694
4695	</desc>
4696	<param name="key" type="wstring" dir="in">
4697	<desc>Name of the data key to get.</desc>
4698	</param>
4699	<param name="value" type="wstring" dir="return">
4700	<desc>Value of the requested data key.</desc>
4701	</param>
4702	</method>
4703
4704	<method name="setExtraData">
4705	<desc>
4706	Sets associated machine-specific extra data.
4707
4708	If you pass @c null or an empty string as a key @a value, the given
4709	@a key will be deleted.
4710
4711	<note>
4712	Before performing the actual data change, this method will ask all
4713	registered listeners using the
4714	<link to="IExtraDataCanChangeEvent"/>
4715	notification for a permission. If one of the listeners refuses the
4716	new value, the change will not be performed.
4717	</note>
4718	<note>
4719	On success, the
4720	<link to="IExtraDataChangedEvent"/> notification
4721	is called to inform all registered listeners about a successful data
4722	change.
4723	</note>
4724	<note>
4725	This method can be called outside the machine session and therefore
4726	it's a caller's responsibility to handle possible race conditions
4727	when several clients change the same key at the same time.
4728	</note>
4729
4730	<result name="VBOX_E_FILE_ERROR">
4731	Settings file not accessible.
4732	</result>
4733	<result name="VBOX_E_XML_ERROR">
4734	Could not parse the settings file.
4735	</result>
4736
4737	</desc>
4738	<param name="key" type="wstring" dir="in">
4739	<desc>Name of the data key to set.</desc>
4740	</param>
4741	<param name="value" type="wstring" dir="in">
4742	<desc>Value to assign to the key.</desc>
4743	</param>
4744	</method>
4745
4746	<method name="getCPUProperty" const="yes">
4747	<desc>
4748	Returns the virtual CPU boolean value of the specified property.
4749
4750	<result name="E_INVALIDARG">
4751	Invalid property.
4752	</result>
4753
4754	</desc>
4755	<param name="property" type="CPUPropertyType" dir="in">
4756	<desc>
4757	Property type to query.
4758	</desc>
4759	</param>
4760	<param name="value" type="boolean" dir="return">
4761	<desc>
4762	Property value.
4763	</desc>
4764	</param>
4765	</method>
4766
4767	<method name="setCPUProperty">
4768	<desc>
4769	Sets the virtual CPU boolean value of the specified property.
4770
4771	<result name="E_INVALIDARG">
4772	Invalid property.
4773	</result>
4774
4775	</desc>
4776	<param name="property" type="CPUPropertyType" dir="in">
4777	<desc>
4778	Property type to query.
4779	</desc>
4780	</param>
4781	<param name="value" type="boolean" dir="in">
4782	<desc>
4783	Property value.
4784	</desc>
4785	</param>
4786	</method>
4787
4788	<method name="getCPUIDLeaf" const="yes">
4789	<desc>
4790	Returns the virtual CPU cpuid information for the specified leaf.
4791
4792	Currently supported index values for cpuid:
4793	Standard CPUID leafs: 0 - 0xA
4794	Extended CPUID leafs: 0x80000000 - 0x8000000A
4795
4796	See the Intel and AMD programmer's manuals for detailed information
4797	about the cpuid instruction and its leafs.
4798	<result name="E_INVALIDARG">
4799	Invalid id.
4800	</result>
4801
4802	</desc>
4803	<param name="id" type="unsigned long" dir="in">
4804	<desc>
4805	CPUID leaf index.
4806	</desc>
4807	</param>
4808	<param name="valEax" type="unsigned long" dir="out">
4809	<desc>
4810	CPUID leaf value for register eax.
4811	</desc>
4812	</param>
4813	<param name="valEbx" type="unsigned long" dir="out">
4814	<desc>
4815	CPUID leaf value for register ebx.
4816	</desc>
4817	</param>
4818	<param name="valEcx" type="unsigned long" dir="out">
4819	<desc>
4820	CPUID leaf value for register ecx.
4821	</desc>
4822	</param>
4823	<param name="valEdx" type="unsigned long" dir="out">
4824	<desc>
4825	CPUID leaf value for register edx.
4826	</desc>
4827	</param>
4828	</method>
4829
4830	<method name="setCPUIDLeaf">
4831	<desc>
4832	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
4833	are not passed unmodified. VirtualBox clears features that it doesn't support.
4834
4835	Currently supported index values for cpuid:
4836	Standard CPUID leafs: 0 - 0xA
4837	Extended CPUID leafs: 0x80000000 - 0x8000000A
4838
4839	See the Intel and AMD programmer's manuals for detailed information
4840	about the cpuid instruction and its leafs.
4841
4842	Do not use this method unless you know exactly what you're doing. Misuse can lead to
4843	random crashes inside VMs.
4844	<result name="E_INVALIDARG">
4845	Invalid id.
4846	</result>
4847
4848	</desc>
4849	<param name="id" type="unsigned long" dir="in">
4850	<desc>
4851	CPUID leaf index.
4852	</desc>
4853	</param>
4854	<param name="valEax" type="unsigned long" dir="in">
4855	<desc>
4856	CPUID leaf value for register eax.
4857	</desc>
4858	</param>
4859	<param name="valEbx" type="unsigned long" dir="in">
4860	<desc>
4861	CPUID leaf value for register ebx.
4862	</desc>
4863	</param>
4864	<param name="valEcx" type="unsigned long" dir="in">
4865	<desc>
4866	CPUID leaf value for register ecx.
4867	</desc>
4868	</param>
4869	<param name="valEdx" type="unsigned long" dir="in">
4870	<desc>
4871	CPUID leaf value for register edx.
4872	</desc>
4873	</param>
4874	</method>
4875
4876	<method name="removeCPUIDLeaf">
4877	<desc>
4878	Removes the virtual CPU cpuid leaf for the specified index
4879
4880	<result name="E_INVALIDARG">
4881	Invalid id.
4882	</result>
4883
4884	</desc>
4885	<param name="id" type="unsigned long" dir="in">
4886	<desc>
4887	CPUID leaf index.
4888	</desc>
4889	</param>
4890	</method>
4891
4892	<method name="removeAllCPUIDLeaves">
4893	<desc>
4894	Removes all the virtual CPU cpuid leaves
4895	</desc>
4896	</method>
4897
4898	<method name="getHWVirtExProperty" const="yes">
4899	<desc>
4900	Returns the value of the specified hardware virtualization boolean property.
4901
4902	<result name="E_INVALIDARG">
4903	Invalid property.
4904	</result>
4905
4906	</desc>
4907	<param name="property" type="HWVirtExPropertyType" dir="in">
4908	<desc>
4909	Property type to query.
4910	</desc>
4911	</param>
4912	<param name="value" type="boolean" dir="return">
4913	<desc>
4914	Property value.
4915	</desc>
4916	</param>
4917	</method>
4918
4919	<method name="setHWVirtExProperty">
4920	<desc>
4921	Sets a new value for the specified hardware virtualization boolean property.
4922
4923	<result name="E_INVALIDARG">
4924	Invalid property.
4925	</result>
4926
4927	</desc>
4928	<param name="property" type="HWVirtExPropertyType" dir="in">
4929	<desc>
4930	Property type to set.
4931	</desc>
4932	</param>
4933	<param name="value" type="boolean" dir="in">
4934	<desc>
4935	New property value.
4936	</desc>
4937	</param>
4938	</method>
4939
4940	<method name="saveSettings">
4941	<desc>
4942	Saves any changes to machine settings made since the session
4943	has been opened or a new machine has been created, or since the
4944	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4945	For registered machines, new settings become visible to all
4946	other VirtualBox clients after successful invocation of this
4947	method.
4948	<note>
4949	The method sends <link to="IMachineDataChangedEvent"/>
4950	notification event after the configuration has been successfully
4951	saved (only for registered machines).
4952	</note>
4953	<note>
4954	Calling this method is only valid on instances returned
4955	by <link to="ISession::machine"/> and on new machines
4956	created by <link to="IVirtualBox::createMachine"/> but not
4957	yet registered, or on unregistered machines after calling
4958	<link to="IMachine::unregister"/>.
4959	</note>
4960
4961	<result name="VBOX_E_FILE_ERROR">
4962	Settings file not accessible.
4963	</result>
4964	<result name="VBOX_E_XML_ERROR">
4965	Could not parse the settings file.
4966	</result>
4967	<result name="E_ACCESSDENIED">
4968	Modification request refused.
4969	</result>
4970
4971	</desc>
4972	</method>
4973
4974	<method name="discardSettings">
4975	<desc>
4976	Discards any changes to the machine settings made since the session
4977	has been opened or since the last call to <link to="#saveSettings"/>
4978	or <link to="#discardSettings"/>.
4979	<note>
4980	Calling this method is only valid on instances returned
4981	by <link to="ISession::machine"/> and on new machines
4982	created by <link to="IVirtualBox::createMachine"/> or
4983	opened by <link to="IVirtualBox::openMachine"/> but not
4984	yet registered, or on unregistered machines after calling
4985	<link to="IMachine::unregister"/>.
4986	</note>
4987
4988	<result name="VBOX_E_INVALID_VM_STATE">
4989	Virtual machine is not mutable.
4990	</result>
4991
4992	</desc>
4993	</method>
4994
4995	<method name="unregister">
4996	<desc>
4997	Unregisters the machine, which must have been previously registered using
4998	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
4999	cleanup before the machine is unregistered.
5000
5001	This method does not delete any files. It only changes the machine configuration and
5002	the list of registered machines in the VirtualBox object. To delete the files which
5003	belonged to the machine, including the XML file of the machine itself, call
5004	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5005	from this method.
5006
5007	How thoroughly this method cleans up the machine configuration before unregistering
5008	the machine depends on the @a cleanupMode argument.
5009
5010	<ul>
5011	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5012	cleanup will be performed. The call will fail if the machine is in "Saved" state
5013	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5014	It is the responsibility of the caller to delete all such configuration in this mode.
5015	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5016	which it replaces.</li>
5017	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5018	state or if it has snapshots or media attached. All media attached to the current machine
5019	state or in snapshots will be detached. No medium objects will be returned; all of the
5020	machine's media will remain open.</li>
5021	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5022	except that all the hard disk medium objects which were detached from the machine will
5023	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5024	API for closing and deletion.</li>
5025	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5026	that all media will be returned in the array, including removeable media like DVDs and
5027	floppies. This might be useful if the user wants to inspect in detail which media were
5028	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5029	in that case because users will typically want to preserve ISO and RAW image files.</li>
5030	</ul>
5031
5032	This API does not verify whether the media files returned in the array are still
5033	attached to other machines (i.e. shared between several machines). If such a shared
5034	image is passed to <link to="#delete" /> however, closing the image will fail there
5035	and the image will be silently skipped.
5036
5037	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5038	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5039	deleted with all its saved states and hard disk images, but images for removeable
5040	drives (such as ISO and RAW files) will remain on disk.
5041
5042	The call will fail if the machine is currently locked (see <link to="ISession" />).
5043	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5044	before unregistering it.
5045
5046	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5047	is fired.
5048
5049	<note>
5050	If the given machine is inaccessible (see <link to="#accessible"/>), it
5051	will be unregistered and fully uninitialized right afterwards. As a result,
5052	the returned machine object will be unusable and an attempt to call
5053	<b>any</b> method will return the "Object not ready" error.
5054	</note>
5055
5056	<result name="VBOX_E_INVALID_OBJECT_STATE">
5057	Machine is currently locked for a session.
5058	</result>
5059	</desc>
5060
5061	<param name="cleanupMode" type="CleanupMode" dir="in">
5062	<desc>How to clean up after the machine has been unregistered.</desc>
5063	</param>
5064	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5065	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5066	</param>
5067	</method>
5068
5069	<method name="delete">
5070	<desc>
5071	Deletes the files associated with this machine from disk. If medium objects are passed
5072	in with the @a aMedia argument, they are closed and, if closing was succesful, their
5073	storage files are deleted as well. For convenience, this array of media files can be
5074	the same as the one returned from a previous <link to="#unregister" /> call.
5075
5076	This method must only be called on machines which are either write-locked (i.e. on instances
5077	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5078	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5079	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5080
5081	The following files will be deleted by this method:
5082	<ul>
5083	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5084	argument other than "UnregisterOnly", this will delete all saved state files that
5085	the machine had in use; possibly one if the machine was in "Saved" state and one
5086	for each online snapshot that the machine had.</li>
5087	<li>On each medium object passed in the @a aMedia array, this will call
5088	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5089	medium's storage on disk. Since the close() call will fail if the medium is still
5090	in use, e.g. because it is still attached to a second machine; in that case the
5091	storage will not be deleted.</li>
5092	<li>Finally, the machine's own XML file will be deleted.</li>
5093	</ul>
5094
5095	Since deleting large disk image files can be a time-consuming I/O operation, this
5096	method operates asynchronously and returns an IProgress object to allow the caller
5097	to monitor the progress. There will be one sub-operation for each file that is
5098	being deleted (saved state or medium storage file).
5099
5100	<note>
5101	<link to="#settingsModified"/> will return @c true after this
5102	method successfully returns.
5103	</note>
5104
5105	<result name="VBOX_E_INVALID_VM_STATE">
5106	Machine is registered but not write-locked.
5107	</result>
5108	<result name="VBOX_E_IPRT_ERROR">
5109	Could not delete the settings file.
5110	</result>
5111	</desc>
5112	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5113	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5114	</param>
5115	<param name="aProgress" type="IProgress" dir="return">
5116	<desc>Progress object to track the operation completion.</desc>
5117	</param>
5118	</method>
5119
5120	<method name="export">
5121	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5122	steps required to export VirtualBox machines to OVF.
5123	</desc>
5124
5125	<param name="aAppliance" type="IAppliance" dir="in">
5126	<desc>Appliance to export this machine to.</desc>
5127	</param>
5128	<param name="location" type="wstring" dir="in">
5129	<desc>The target location.</desc>
5130	</param>
5131	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5132	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5133	</param>
5134	</method >
5135
5136	<method name="findSnapshot">
5137	<desc>
5138	Returns a snapshot of this machine with the given name or UUID.
5139
5140	Returns a snapshot of this machine with the given UUID.
5141	A @c null argument can be used to obtain the first snapshot
5142	taken on this machine. This is useful if you want to traverse
5143	the whole tree of snapshots starting from the root.
5144
5145	<result name="VBOX_E_OBJECT_NOT_FOUND">
5146	Virtual machine has no snapshots or snapshot not found.
5147	</result>
5148
5149	</desc>
5150	<param name="nameOrId" type="wstring" dir="in">
5151	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5152	</param>
5153	<param name="snapshot" type="ISnapshot" dir="return">
5154	<desc>Snapshot object with the given name.</desc>
5155	</param>
5156	</method>
5157
5158	<method name="createSharedFolder">
5159	<desc>
5160	Creates a new permanent shared folder by associating the given logical
5161	name with the given host path, adds it to the collection of shared
5162	folders and starts sharing it. Refer to the description of
5163	<link to="ISharedFolder"/> to read more about logical names.
5164
5165	<result name="VBOX_E_OBJECT_IN_USE">
5166	Shared folder already exists.
5167	</result>
5168	<result name="VBOX_E_FILE_ERROR">
5169	Shared folder @a hostPath not accessible.
5170	</result>
5171
5172	</desc>
5173	<param name="name" type="wstring" dir="in">
5174	<desc>Unique logical name of the shared folder.</desc>
5175	</param>
5176	<param name="hostPath" type="wstring" dir="in">
5177	<desc>Full path to the shared folder in the host file system.</desc>
5178	</param>
5179	<param name="writable" type="boolean" dir="in">
5180	<desc>Whether the share is writable or readonly.</desc>
5181	</param>
5182	<param name="automount" type="boolean" dir="in">
5183	<desc>Whether the share gets automatically mounted by the guest
5184	or not.</desc>
5185	</param>
5186	</method>
5187
5188	<method name="removeSharedFolder">
5189	<desc>
5190	Removes the permanent shared folder with the given name previously
5191	created by <link to="#createSharedFolder"/> from the collection of
5192	shared folders and stops sharing it.
5193
5194	<result name="VBOX_E_INVALID_VM_STATE">
5195	Virtual machine is not mutable.
5196	</result>
5197	<result name="VBOX_E_OBJECT_NOT_FOUND">
5198	Shared folder @a name does not exist.
5199	</result>
5200
5201	</desc>
5202	<param name="name" type="wstring" dir="in">
5203	<desc>Logical name of the shared folder to remove.</desc>
5204	</param>
5205	</method>
5206
5207	<method name="canShowConsoleWindow">
5208	<desc>
5209	Returns @c true if the VM console process can activate the
5210	console window and bring it to foreground on the desktop of
5211	the host PC.
5212	<note>
5213	This method will fail if a session for this machine is not
5214	currently open.
5215	</note>
5216
5217	<result name="VBOX_E_INVALID_VM_STATE">
5218	Machine session is not open.
5219	</result>
5220
5221	</desc>
5222	<param name="canShow" type="boolean" dir="return">
5223	<desc>
5224	@c true if the console window can be shown and @c false otherwise.
5225	</desc>
5226	</param>
5227	</method>
5228
5229	<method name="showConsoleWindow">
5230	<desc>
5231	Activates the console window and brings it to foreground on
5232	the desktop of the host PC. Many modern window managers on
5233	many platforms implement some sort of focus stealing
5234	prevention logic, so that it may be impossible to activate
5235	a window without the help of the currently active
5236	application. In this case, this method will return a non-zero
5237	identifier that represents the top-level window of the VM
5238	console process. The caller, if it represents a currently
5239	active process, is responsible to use this identifier (in a
5240	platform-dependent manner) to perform actual window
5241	activation.
5242	<note>
5243	This method will fail if a session for this machine is not
5244	currently open.
5245	</note>
5246
5247	<result name="VBOX_E_INVALID_VM_STATE">
5248	Machine session is not open.
5249	</result>
5250
5251	</desc>
5252	<param name="winId" type="long long" dir="return">
5253	<desc>
5254	Platform-dependent identifier of the top-level VM console
5255	window, or zero if this method has performed all actions
5256	necessary to implement the <i>show window</i> semantics for
5257	the given platform and/or VirtualBox front-end.
5258	</desc>
5259	</param>
5260	</method>
5261
5262	<method name="getGuestProperty" const="yes">
5263	<desc>
5264	Reads an entry from the machine's guest property store.
5265
5266	<result name="VBOX_E_INVALID_VM_STATE">
5267	Machine session is not open.
5268	</result>
5269
5270	</desc>
5271	<param name="name" type="wstring" dir="in">
5272	<desc>
5273	The name of the property to read.
5274	</desc>
5275	</param>
5276	<param name="value" type="wstring" dir="out">
5277	<desc>
5278	The value of the property. If the property does not exist then this
5279	will be empty.
5280	</desc>
5281	</param>
5282	<param name="timestamp" type="long long" dir="out">
5283	<desc>
5284	The time at which the property was last modified, as seen by the
5285	server process.
5286	</desc>
5287	</param>
5288	<param name="flags" type="wstring" dir="out">
5289	<desc>
5290	Additional property parameters, passed as a comma-separated list of
5291	"name=value" type entries.
5292	</desc>
5293	</param>
5294	</method>
5295
5296	<method name="getGuestPropertyValue" const="yes">
5297	<desc>
5298	Reads a value from the machine's guest property store.
5299
5300	<result name="VBOX_E_INVALID_VM_STATE">
5301	Machine session is not open.
5302	</result>
5303
5304	</desc>
5305	<param name="property" type="wstring" dir="in">
5306	<desc>
5307	The name of the property to read.
5308	</desc>
5309	</param>
5310	<param name="value" type="wstring" dir="return">
5311	<desc>
5312	The value of the property. If the property does not exist then this
5313	will be empty.
5314	</desc>
5315	</param>
5316	</method>
5317
5318	<method name="getGuestPropertyTimestamp" const="yes">
5319	<desc>
5320	Reads a property timestamp from the machine's guest property store.
5321
5322	<result name="VBOX_E_INVALID_VM_STATE">
5323	Machine session is not open.
5324	</result>
5325
5326	</desc>
5327	<param name="property" type="wstring" dir="in">
5328	<desc>
5329	The name of the property to read.
5330	</desc>
5331	</param>
5332	<param name="value" type="long long" dir="return">
5333	<desc>
5334	The timestamp. If the property does not exist then this will be
5335	empty.
5336	</desc>
5337	</param>
5338	</method>
5339
5340	<method name="setGuestProperty">
5341	<desc>
5342	Sets, changes or deletes an entry in the machine's guest property
5343	store.
5344
5345	<result name="E_ACCESSDENIED">
5346	Property cannot be changed.
5347	</result>
5348	<result name="E_INVALIDARG">
5349	Invalid @a flags.
5350	</result>
5351	<result name="VBOX_E_INVALID_VM_STATE">
5352	Virtual machine is not mutable or session not open.
5353	</result>
5354	<result name="VBOX_E_INVALID_OBJECT_STATE">
5355	Cannot set transient property when machine not running.
5356	</result>
5357
5358	</desc>
5359	<param name="property" type="wstring" dir="in">
5360	<desc>
5361	The name of the property to set, change or delete.
5362	</desc>
5363	</param>
5364	<param name="value" type="wstring" dir="in">
5365	<desc>
5366	The new value of the property to set, change or delete. If the
5367	property does not yet exist and value is non-empty, it will be
5368	created. If the value is @c null or empty, the property will be
5369	deleted if it exists.
5370	</desc>
5371	</param>
5372	<param name="flags" type="wstring" dir="in">
5373	<desc>
5374	Additional property parameters, passed as a comma-separated list of
5375	"name=value" type entries.
5376	</desc>
5377	</param>
5378	</method>
5379
5380	<method name="setGuestPropertyValue">
5381	<desc>
5382	Sets, changes or deletes a value in the machine's guest property
5383	store. The flags field will be left unchanged or created empty for a
5384	new property.
5385
5386	<result name="E_ACCESSDENIED">
5387	Property cannot be changed.
5388	</result>
5389	<result name="VBOX_E_INVALID_VM_STATE">
5390	Virtual machine is not mutable or session not open.
5391	</result>
5392	<result name="VBOX_E_INVALID_OBJECT_STATE">
5393	Cannot set transient property when machine not running.
5394	</result>
5395	</desc>
5396
5397	<param name="property" type="wstring" dir="in">
5398	<desc>
5399	The name of the property to set, change or delete.
5400	</desc>
5401	</param>
5402	<param name="value" type="wstring" dir="in">
5403	<desc>
5404	The new value of the property to set, change or delete. If the
5405	property does not yet exist and value is non-empty, it will be
5406	created. If the value is @c null or empty, the property will be
5407	deleted if it exists.
5408	</desc>
5409	</param>
5410	</method>
5411
5412	<method name="enumerateGuestProperties">
5413	<desc>
5414	Return a list of the guest properties matching a set of patterns along
5415	with their values, time stamps and flags.
5416	</desc>
5417	<param name="patterns" type="wstring" dir="in">
5418	<desc>
5419	The patterns to match the properties against, separated by '\|'
5420	characters. If this is empty or @c null, all properties will match.
5421	</desc>
5422	</param>
5423	<param name="name" type="wstring" dir="out" safearray="yes">
5424	<desc>
5425	The names of the properties returned.
5426	</desc>
5427	</param>
5428	<param name="value" type="wstring" dir="out" safearray="yes">
5429	<desc>
5430	The values of the properties returned. The array entries match the
5431	corresponding entries in the @a name array.
5432	</desc>
5433	</param>
5434	<param name="timestamp" type="long long" dir="out" safearray="yes">
5435	<desc>
5436	The time stamps of the properties returned. The array entries match
5437	the corresponding entries in the @a name array.
5438	</desc>
5439	</param>
5440	<param name="flags" type="wstring" dir="out" safearray="yes">
5441	<desc>
5442	The flags of the properties returned. The array entries match the
5443	corresponding entries in the @a name array.
5444	</desc>
5445	</param>
5446	</method>
5447
5448	<method name="querySavedGuestSize">
5449	<desc>
5450	Returns the guest dimensions from the saved state.
5451	</desc>
5452	<param name="screenId" type="unsigned long" dir="in">
5453	<desc>
5454	Saved guest screen to query info from.
5455	</desc>
5456	</param>
5457	<param name="width" type="unsigned long" dir="out">
5458	<desc>
5459	Guest width at the time of the saved state was taken.
5460	</desc>
5461	</param>
5462	<param name="height" type="unsigned long" dir="out">
5463	<desc>
5464	Guest height at the time of the saved state was taken.
5465	</desc>
5466	</param>
5467	</method>
5468
5469	<method name="querySavedThumbnailSize">
5470	<desc>
5471	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5472	</desc>
5473	<param name="screenId" type="unsigned long" dir="in">
5474	<desc>
5475	Saved guest screen to query info from.
5476	</desc>
5477	</param>
5478	<param name="size" type="unsigned long" dir="out">
5479	<desc>
5480	Size of buffer required to store the bitmap.
5481	</desc>
5482	</param>
5483	<param name="width" type="unsigned long" dir="out">
5484	<desc>
5485	Bitmap width.
5486	</desc>
5487	</param>
5488	<param name="height" type="unsigned long" dir="out">
5489	<desc>
5490	Bitmap height.
5491	</desc>
5492	</param>
5493	</method>
5494
5495	<method name="readSavedThumbnailToArray">
5496	<desc>
5497	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5498	</desc>
5499	<param name="screenId" type="unsigned long" dir="in">
5500	<desc>
5501	Saved guest screen to read from.
5502	</desc>
5503	</param>
5504	<param name="BGR" type="boolean" dir="in">
5505	<desc>
5506	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5507	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5508	</desc>
5509	</param>
5510	<param name="width" type="unsigned long" dir="out">
5511	<desc>
5512	Bitmap width.
5513	</desc>
5514	</param>
5515	<param name="height" type="unsigned long" dir="out">
5516	<desc>
5517	Bitmap height.
5518	</desc>
5519	</param>
5520	<param name="data" type="octet" safearray="yes" dir="return">
5521	<desc>
5522	Array with resulting bitmap data.
5523	</desc>
5524	</param>
5525	</method>
5526
5527	<method name="readSavedThumbnailPNGToArray">
5528	<desc>
5529	Thumbnail in PNG format is retrieved to an array of bytes.
5530	</desc>
5531	<param name="screenId" type="unsigned long" dir="in">
5532	<desc>
5533	Saved guest screen to read from.
5534	</desc>
5535	</param>
5536	<param name="width" type="unsigned long" dir="out">
5537	<desc>
5538	Image width.
5539	</desc>
5540	</param>
5541	<param name="height" type="unsigned long" dir="out">
5542	<desc>
5543	Image height.
5544	</desc>
5545	</param>
5546	<param name="data" type="octet" dir="return" safearray="yes">
5547	<desc>
5548	Array with resulting PNG data.
5549	</desc>
5550	</param>
5551	</method>
5552
5553	<method name="querySavedScreenshotPNGSize">
5554	<desc>
5555	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5556	</desc>
5557	<param name="screenId" type="unsigned long" dir="in">
5558	<desc>
5559	Saved guest screen to query info from.
5560	</desc>
5561	</param>
5562	<param name="size" type="unsigned long" dir="out">
5563	<desc>
5564	Size of buffer required to store the PNG binary data.
5565	</desc>
5566	</param>
5567	<param name="width" type="unsigned long" dir="out">
5568	<desc>
5569	Image width.
5570	</desc>
5571	</param>
5572	<param name="height" type="unsigned long" dir="out">
5573	<desc>
5574	Image height.
5575	</desc>
5576	</param>
5577	</method>
5578
5579	<method name="readSavedScreenshotPNGToArray">
5580	<desc>
5581	Screenshot in PNG format is retrieved to an array of bytes.
5582	</desc>
5583	<param name="screenId" type="unsigned long" dir="in">
5584	<desc>
5585	Saved guest screen to read from.
5586	</desc>
5587	</param>
5588	<param name="width" type="unsigned long" dir="out">
5589	<desc>
5590	Image width.
5591	</desc>
5592	</param>
5593	<param name="height" type="unsigned long" dir="out">
5594	<desc>
5595	Image height.
5596	</desc>
5597	</param>
5598	<param name="data" type="octet" dir="return" safearray="yes">
5599	<desc>
5600	Array with resulting PNG data.
5601	</desc>
5602	</param>
5603	</method>
5604
5605	<method name="hotPlugCPU">
5606	<desc>
5607	Plugs a CPU into the machine.
5608	</desc>
5609	<param name="cpu" type="unsigned long" dir="in">
5610	<desc>
5611	The CPU id to insert.
5612	</desc>
5613	</param>
5614	</method>
5615
5616	<method name="hotUnplugCPU">
5617	<desc>
5618	Removes a CPU from the machine.
5619	</desc>
5620	<param name="cpu" type="unsigned long" dir="in">
5621	<desc>
5622	The CPU id to remove.
5623	</desc>
5624	</param>
5625	</method>
5626
5627	<method name="getCPUStatus">
5628	<desc>
5629	Returns the current status of the given CPU.
5630	</desc>
5631	<param name="cpu" type="unsigned long" dir="in">
5632	<desc>
5633	The CPU id to check for.
5634	</desc>
5635	</param>
5636	<param name="attached" type="boolean" dir="return">
5637	<desc>
5638	Status of the CPU.
5639	</desc>
5640	</param>
5641	</method>
5642
5643	<method name="queryLogFilename">
5644	<desc>
5645	Queries for the VM log file name of an given index. Returns an empty
5646	string if a log file with that index doesn't exists.
5647	</desc>
5648	<param name="idx" type="unsigned long" dir="in">
5649	<desc>
5650	Which log file name to query. 0=current log file.
5651	</desc>
5652	</param>
5653	<param name="filename" type="wstring" dir="return">
5654	<desc>
5655	On return the full path to the log file or an empty string on error.
5656	</desc>
5657	</param>
5658	</method>
5659
5660	<method name="readLog">
5661	<desc>
5662	Reads the VM log file. The chunk size is limited, so even if you
5663	ask for a big piece there might be less data returned.
5664	</desc>
5665	<param name="idx" type="unsigned long" dir="in">
5666	<desc>
5667	Which log file to read. 0=current log file.
5668	</desc>
5669	</param>
5670	<param name="offset" type="long long" dir="in">
5671	<desc>
5672	Offset in the log file.
5673	</desc>
5674	</param>
5675	<param name="size" type="long long" dir="in">
5676	<desc>
5677	Chunk size to read in the log file.
5678	</desc>
5679	</param>
5680	<param name="data" type="octet" dir="return" safearray="yes">
5681	<desc>
5682	Data read from the log file. A data size of 0 means end of file
5683	if the requested chunk size was not 0. This is the unprocessed
5684	file data, i.e. the line ending style depends on the platform of
5685	the system the server is running on.
5686	</desc>
5687	</param>
5688	</method>
5689	</interface>
5690
5691	<!--
5692	// IConsole
5693	/////////////////////////////////////////////////////////////////////////
5694	-->
5695
5696	<interface
5697	name="IVRDEServerInfo" extends="$unknown"
5698	uuid="6890123c-5218-42ba-9afd-c71699475115"
5699	wsmap="struct"
5700	>
5701	<desc>
5702	Contains information about the remote desktop (VRDE) server capabilities and status.
5703	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5704	</desc>
5705
5706	<attribute name="active" type="boolean" readonly="yes">
5707	<desc>
5708	Whether the remote desktop connection is active.
5709	</desc>
5710	</attribute>
5711
5712	<attribute name="port" type="long" readonly="yes">
5713	<desc>
5714	VRDE server port number. If this property is equal to <tt>0</tt>, then
5715	the VRDE server failed to start, usually because there are no free IP
5716	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5717	server has not yet been started.
5718	</desc>
5719	</attribute>
5720
5721	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5722	<desc>
5723	How many times a client connected.
5724	</desc>
5725	</attribute>
5726
5727	<attribute name="beginTime" type="long long" readonly="yes">
5728	<desc>
5729	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5730	</desc>
5731	</attribute>
5732
5733	<attribute name="endTime" type="long long" readonly="yes">
5734	<desc>
5735	When the last connection was terminated or the current time, if
5736	connection is still active, in milliseconds since 1970-01-01 UTC.
5737	</desc>
5738	</attribute>
5739
5740	<attribute name="bytesSent" type="long long" readonly="yes">
5741	<desc>
5742	How many bytes were sent in last or current, if still active, connection.
5743	</desc>
5744	</attribute>
5745
5746	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5747	<desc>
5748	How many bytes were sent in all connections.
5749	</desc>
5750	</attribute>
5751
5752	<attribute name="bytesReceived" type="long long" readonly="yes">
5753	<desc>
5754	How many bytes were received in last or current, if still active, connection.
5755	</desc>
5756	</attribute>
5757
5758	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5759	<desc>
5760	How many bytes were received in all connections.
5761	</desc>
5762	</attribute>
5763
5764	<attribute name="user" type="wstring" readonly="yes">
5765	<desc>
5766	Login user name supplied by the client.
5767	</desc>
5768	</attribute>
5769
5770	<attribute name="domain" type="wstring" readonly="yes">
5771	<desc>
5772	Login domain name supplied by the client.
5773	</desc>
5774	</attribute>
5775
5776	<attribute name="clientName" type="wstring" readonly="yes">
5777	<desc>
5778	The client name supplied by the client.
5779	</desc>
5780	</attribute>
5781
5782	<attribute name="clientIP" type="wstring" readonly="yes">
5783	<desc>
5784	The IP address of the client.
5785	</desc>
5786	</attribute>
5787
5788	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5789	<desc>
5790	The client software version number.
5791	</desc>
5792	</attribute>
5793
5794	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5795	<desc>
5796	Public key exchange method used when connection was established.
5797	Values: 0 - RDP4 public key exchange scheme.
5798	1 - X509 certificates were sent to client.
5799	</desc>
5800	</attribute>
5801
5802	</interface>
5803
5804	<interface
5805	name="IConsole" extends="$unknown"
5806	uuid="3c4a453e-d27b-44a2-b59d-dda6e1835e57"
5807	wsmap="managed"
5808	>
5809	<desc>
5810	The IConsole interface represents an interface to control virtual
5811	machine execution.
5812
5813	A console object gets created when a machine has been locked for a
5814	particular session (client process) using <link to="IMachine::lockMachine" />
5815	or <link to="IMachine::launchVMProcess"/>. The console object can
5816	then be found in the session's <link to="ISession::console" /> attribute.
5817
5818	Methods of the IConsole interface allow the caller to query the current
5819	virtual machine execution state, pause the machine or power it down, save
5820	the machine state or take a snapshot, attach and detach removable media
5821	and so on.
5822
5823	<see>ISession</see>
5824	</desc>
5825
5826	<attribute name="machine" type="IMachine" readonly="yes">
5827	<desc>
5828	Machine object this console is sessioned with.
5829	<note>
5830	This is a convenience property, it has the same value as
5831	<link to="ISession::machine"/> of the corresponding session
5832	object.
5833	</note>
5834	</desc>
5835	</attribute>
5836
5837	<attribute name="state" type="MachineState" readonly="yes">
5838	<desc>
5839	Current execution state of the machine.
5840	<note>
5841	This property always returns the same value as the corresponding
5842	property of the IMachine object this console is sessioned with.
5843	For the process that owns (executes) the VM, this is the
5844	preferable way of querying the VM state, because no IPC
5845	calls are made.
5846	</note>
5847	</desc>
5848	</attribute>
5849
5850	<attribute name="guest" type="IGuest" readonly="yes">
5851	<desc>Guest object.</desc>
5852	</attribute>
5853
5854	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5855	<desc>
5856	Virtual keyboard object.
5857	<note>
5858	If the machine is not running, any attempt to use
5859	the returned object will result in an error.
5860	</note>
5861	</desc>
5862	</attribute>
5863
5864	<attribute name="mouse" type="IMouse" readonly="yes">
5865	<desc>
5866	Virtual mouse object.
5867	<note>
5868	If the machine is not running, any attempt to use
5869	the returned object will result in an error.
5870	</note>
5871	</desc>
5872	</attribute>
5873
5874	<attribute name="display" type="IDisplay" readonly="yes">
5875	<desc>Virtual display object.
5876	<note>
5877	If the machine is not running, any attempt to use
5878	the returned object will result in an error.
5879	</note>
5880	</desc>
5881	</attribute>
5882
5883	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5884	<desc>Debugging interface.</desc>
5885	</attribute>
5886
5887	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5888	<desc>
5889	Collection of USB devices currently attached to the virtual
5890	USB controller.
5891	<note>
5892	The collection is empty if the machine is not running.
5893	</note>
5894	</desc>
5895	</attribute>
5896
5897	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
5898	<desc>
5899	List of USB devices currently attached to the remote VRDE client.
5900	Once a new device is physically attached to the remote host computer,
5901	it appears in this list and remains there until detached.
5902	</desc>
5903	</attribute>
5904
5905	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
5906	<desc>
5907	Collection of shared folders for the current session. These folders
5908	are called transient shared folders because they are available to the
5909	guest OS running inside the associated virtual machine only for the
5910	duration of the session (as opposed to
5911	<link to="IMachine::sharedFolders"/> which represent permanent shared
5912	folders). When the session is closed (e.g. the machine is powered down),
5913	these folders are automatically discarded.
5914
5915	New shared folders are added to the collection using
5916	<link to="#createSharedFolder"/>. Existing shared folders can be
5917	removed using <link to="#removeSharedFolder"/>.
5918	</desc>
5919	</attribute>
5920
5921	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
5922	<desc>
5923	Interface that provides information on Remote Desktop Extension (VRDE) connection.
5924	</desc>
5925	</attribute>
5926
5927	<attribute name="eventSource" type="IEventSource" readonly="yes">
5928	<desc>
5929	Event source for console events.
5930	</desc>
5931	</attribute>
5932
5933	<method name="powerUp">
5934	<desc>
5935	Starts the virtual machine execution using the current machine
5936	state (that is, its current execution state, current settings and
5937	current storage devices).
5938
5939	<note>
5940	This method is only useful for front-ends that want to actually
5941	execute virtual machines in their own process (like the VirtualBox
5942	or VBoxSDL front-ends). Unless you are intending to write such a
5943	front-end, do not call this method. If you simply want to
5944	start virtual machine execution using one of the existing front-ends
5945	(for example the VirtualBox GUI or headless server), use
5946	<link to="IMachine::launchVMProcess"/> instead; these
5947	front-ends will power up the machine automatically for you.
5948	</note>
5949
5950	If the machine is powered off or aborted, the execution will
5951	start from the beginning (as if the real hardware were just
5952	powered on).
5953
5954	If the machine is in the <link to="MachineState_Saved"/> state,
5955	it will continue its execution the point where the state has
5956	been saved.
5957
5958	If the machine <link to="IMachine::teleporterEnabled"/> property is
5959	enabled on the machine being powered up, the machine will wait for an
5960	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
5961	state. The returned progress object will have at least three
5962	operations where the last three are defined as: (1) powering up and
5963	starting TCP server, (2) waiting for incoming teleportations, and
5964	(3) perform teleportation. These operations will be reflected as the
5965	last three operations of the progress objected returned by
5966	<link to="IMachine::launchVMProcess"/> as well.
5967
5968	<see>#saveState</see>
5969
5970	<result name="VBOX_E_INVALID_VM_STATE">
5971	Virtual machine already running.
5972	</result>
5973	<result name="VBOX_E_HOST_ERROR">
5974	Host interface does not exist or name not set.
5975	</result>
5976	<result name="VBOX_E_FILE_ERROR">
5977	Invalid saved state file.
5978	</result>
5979	</desc>
5980	<param name="progress" type="IProgress" dir="return">
5981	<desc>Progress object to track the operation completion.</desc>
5982	</param>
5983	</method>
5984
5985	<method name="powerUpPaused">
5986	<desc>
5987	Identical to powerUp except that the VM will enter the
5988	<link to="MachineState_Paused"/> state, instead of
5989	<link to="MachineState_Running"/>.
5990
5991	<see>#powerUp</see>
5992	<result name="VBOX_E_INVALID_VM_STATE">
5993	Virtual machine already running.
5994	</result>
5995	<result name="VBOX_E_HOST_ERROR">
5996	Host interface does not exist or name not set.
5997	</result>
5998	<result name="VBOX_E_FILE_ERROR">
5999	Invalid saved state file.
6000	</result>
6001	</desc>
6002	<param name="progress" type="IProgress" dir="return">
6003	<desc>Progress object to track the operation completion.</desc>
6004	</param>
6005	</method>
6006
6007	<method name="powerDown">
6008	<desc>
6009	Initiates the power down procedure to stop the virtual machine
6010	execution.
6011
6012	The completion of the power down procedure is tracked using the returned
6013	IProgress object. After the operation is complete, the machine will go
6014	to the PoweredOff state.
6015	<result name="VBOX_E_INVALID_VM_STATE">
6016	Virtual machine must be Running, Paused or Stuck to be powered down.
6017	</result>
6018	</desc>
6019	<param name="progress" type="IProgress" dir="return">
6020	<desc>Progress object to track the operation completion.</desc>
6021	</param>
6022	</method>
6023
6024	<method name="reset">
6025	<desc>Resets the virtual machine.
6026	<result name="VBOX_E_INVALID_VM_STATE">
6027	Virtual machine not in Running state.
6028	</result>
6029	<result name="VBOX_E_VM_ERROR">
6030	Virtual machine error in reset operation.
6031	</result>
6032	</desc>
6033	</method>
6034
6035	<method name="pause">
6036	<desc>Pauses the virtual machine execution.
6037	<result name="VBOX_E_INVALID_VM_STATE">
6038	Virtual machine not in Running state.
6039	</result>
6040	<result name="VBOX_E_VM_ERROR">
6041	Virtual machine error in suspend operation.
6042	</result>
6043	</desc>
6044	</method>
6045
6046	<method name="resume">
6047	<desc>Resumes the virtual machine execution.
6048	<result name="VBOX_E_INVALID_VM_STATE">
6049	Virtual machine not in Paused state.
6050	</result>
6051	<result name="VBOX_E_VM_ERROR">
6052	Virtual machine error in resume operation.
6053	</result>
6054	</desc>
6055	</method>
6056
6057	<method name="powerButton">
6058	<desc>Sends the ACPI power button event to the guest.
6059	<result name="VBOX_E_INVALID_VM_STATE">
6060	Virtual machine not in Running state.
6061	</result>
6062	<result name="VBOX_E_PDM_ERROR">
6063	Controlled power off failed.
6064	</result>
6065	</desc>
6066	</method>
6067
6068	<method name="sleepButton">
6069	<desc>Sends the ACPI sleep button event to the guest.
6070	<result name="VBOX_E_INVALID_VM_STATE">
6071	Virtual machine not in Running state.
6072	</result>
6073	<result name="VBOX_E_PDM_ERROR">
6074	Sending sleep button event failed.
6075	</result>
6076	</desc>
6077	</method>
6078
6079	<method name="getPowerButtonHandled">
6080	<desc>Checks if the last power button event was handled by guest.
6081	<result name="VBOX_E_PDM_ERROR">
6082	Checking if the event was handled by the guest OS failed.
6083	</result>
6084	</desc>
6085	<param name="handled" type="boolean" dir="return"/>
6086	</method>
6087
6088	<method name="getGuestEnteredACPIMode">
6089	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6090	G1 (sleeping). If this method returns @c false, the guest will
6091	most likely not respond to external ACPI events.
6092	<result name="VBOX_E_INVALID_VM_STATE">
6093	Virtual machine not in Running state.
6094	</result>
6095	</desc>
6096	<param name="entered" type="boolean" dir="return"/>
6097	</method>
6098
6099	<method name="saveState">
6100	<desc>
6101	Saves the current execution state of a running virtual machine
6102	and stops its execution.
6103
6104	After this operation completes, the machine will go to the
6105	Saved state. Next time it is powered up, this state will
6106	be restored and the machine will continue its execution from
6107	the place where it was saved.
6108
6109	This operation differs from taking a snapshot to the effect
6110	that it doesn't create new differencing media. Also, once
6111	the machine is powered up from the state saved using this method,
6112	the saved state is deleted, so it will be impossible to return
6113	to this state later.
6114
6115	<note>
6116	On success, this method implicitly calls
6117	<link to="IMachine::saveSettings"/> to save all current machine
6118	settings (including runtime changes to the DVD medium, etc.).
6119	Together with the impossibility to change any VM settings when it is
6120	in the Saved state, this guarantees adequate hardware
6121	configuration of the machine when it is restored from the saved
6122	state file.
6123	</note>
6124
6125	<note>
6126	The machine must be in the Running or Paused state, otherwise
6127	the operation will fail.
6128	</note>
6129	<result name="VBOX_E_INVALID_VM_STATE">
6130	Virtual machine state neither Running nor Paused.
6131	</result>
6132	<result name="VBOX_E_FILE_ERROR">
6133	Failed to create directory for saved state file.
6134	</result>
6135
6136	<see><link to="#takeSnapshot"/></see>
6137	</desc>
6138	<param name="progress" type="IProgress" dir="return">
6139	<desc>Progress object to track the operation completion.</desc>
6140	</param>
6141	</method>
6142
6143	<method name="adoptSavedState">
6144	<desc>
6145	Associates the given saved state file to the virtual machine.
6146
6147	On success, the machine will go to the Saved state. Next time it is
6148	powered up, it will be restored from the adopted saved state and
6149	continue execution from the place where the saved state file was
6150	created.
6151
6152	The specified saved state file path may be absolute or relative to the
6153	folder the VM normally saves the state to (usually,
6154	<link to="IMachine::snapshotFolder"/>).
6155
6156	<note>
6157	It's a caller's responsibility to make sure the given saved state
6158	file is compatible with the settings of this virtual machine that
6159	represent its virtual hardware (memory size, storage disk configuration
6160	etc.). If there is a mismatch, the behavior of the virtual machine
6161	is undefined.
6162	</note>
6163	<result name="VBOX_E_INVALID_VM_STATE">
6164	Virtual machine state neither PoweredOff nor Aborted.
6165	</result>
6166	</desc>
6167	<param name="savedStateFile" type="wstring" dir="in">
6168	<desc>Path to the saved state file to adopt.</desc>
6169	</param>
6170	</method>
6171
6172	<method name="discardSavedState">
6173	<desc>
6174	Forcibly resets the machine to "Powered Off" state if it is
6175	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6176	Next time the machine is powered up, a clean boot will occur.
6177	<note>
6178	This operation is equivalent to resetting or powering off
6179	the machine without doing a proper shutdown of the guest
6180	operating system; as with resetting a running phyiscal
6181	computer, it can can lead to data loss.
6182	</note>
6183	If @a fRemoveFile is @c true, the file in the machine directory
6184	into which the machine state was saved is also deleted. If
6185	this is @c false, then the state can be recovered and later
6186	re-inserted into a machine using <link to="#adoptSavedState" />.
6187	The location of the file can be found in the
6188	<link to="IMachine::stateFilePath" /> attribute.
6189	<result name="VBOX_E_INVALID_VM_STATE">
6190	Virtual machine not in state Saved.
6191	</result>
6192	</desc>
6193	<param name="fRemoveFile" type="boolean" dir="in" >
6194	<desc>Whether to also remove the saved state file.</desc>
6195	</param>
6196	</method>
6197
6198	<method name="getDeviceActivity">
6199	<desc>
6200	Gets the current activity type of a given device or device group.
6201	<result name="E_INVALIDARG">
6202	Invalid device type.
6203	</result>
6204	</desc>
6205	<param name="type" type="DeviceType" dir="in"/>
6206	<param name="activity" type="DeviceActivity" dir="return"/>
6207	</method>
6208
6209	<method name="attachUSBDevice">
6210	<desc>
6211	Attaches a host USB device with the given UUID to the
6212	USB controller of the virtual machine.
6213
6214	The device needs to be in one of the following states:
6215	<link to="USBDeviceState_Busy"/>,
6216	<link to="USBDeviceState_Available"/> or
6217	<link to="USBDeviceState_Held"/>,
6218	otherwise an error is immediately returned.
6219
6220	When the device state is
6221	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6222	be returned if the host computer refuses to release it for some reason.
6223
6224	<see>IUSBController::deviceFilters, USBDeviceState</see>
6225	<result name="VBOX_E_INVALID_VM_STATE">
6226	Virtual machine state neither Running nor Paused.
6227	</result>
6228	<result name="VBOX_E_PDM_ERROR">
6229	Virtual machine does not have a USB controller.
6230	</result>
6231	</desc>
6232	<param name="id" type="uuid" mod="string" dir="in">
6233	<desc>UUID of the host USB device to attach.</desc>
6234	</param>
6235	</method>
6236
6237	<method name="detachUSBDevice">
6238	<desc>
6239	Detaches an USB device with the given UUID from the USB controller
6240	of the virtual machine.
6241
6242	After this method succeeds, the VirtualBox server re-initiates
6243	all USB filters as if the device were just physically attached
6244	to the host, but filters of this machine are ignored to avoid
6245	a possible automatic re-attachment.
6246
6247	<see>IUSBController::deviceFilters, USBDeviceState</see>
6248
6249	<result name="VBOX_E_PDM_ERROR">
6250	Virtual machine does not have a USB controller.
6251	</result>
6252	<result name="E_INVALIDARG">
6253	USB device not attached to this virtual machine.
6254	</result>
6255	</desc>
6256	<param name="id" type="uuid" mod="string" dir="in">
6257	<desc>UUID of the USB device to detach.</desc>
6258	</param>
6259	<param name="device" type="IUSBDevice" dir="return">
6260	<desc>Detached USB device.</desc>
6261	</param>
6262	</method>
6263
6264	<method name="findUSBDeviceByAddress">
6265	<desc>
6266	Searches for a USB device with the given host address.
6267
6268	<result name="VBOX_E_OBJECT_NOT_FOUND">
6269	Given @c name does not correspond to any USB device.
6270	</result>
6271
6272	<see>IUSBDevice::address</see>
6273	</desc>
6274	<param name="name" type="wstring" dir="in">
6275	<desc>
6276	Address of the USB device (as assigned by the host) to
6277	search for.
6278	</desc>
6279	</param>
6280	<param name="device" type="IUSBDevice" dir="return">
6281	<desc>Found USB device object.</desc>
6282	</param>
6283	</method>
6284
6285	<method name="findUSBDeviceById">
6286	<desc>
6287	Searches for a USB device with the given UUID.
6288
6289	<result name="VBOX_E_OBJECT_NOT_FOUND">
6290	Given @c id does not correspond to any USB device.
6291	</result>
6292
6293	<see>IUSBDevice::id</see>
6294	</desc>
6295	<param name="id" type="uuid" mod="string" dir="in">
6296	<desc>UUID of the USB device to search for.</desc>
6297	</param>
6298	<param name="device" type="IUSBDevice" dir="return">
6299	<desc>Found USB device object.</desc>
6300	</param>
6301	</method>
6302
6303	<method name="createSharedFolder">
6304	<desc>
6305	Creates a transient new shared folder by associating the given logical
6306	name with the given host path, adds it to the collection of shared
6307	folders and starts sharing it. Refer to the description of
6308	<link to="ISharedFolder"/> to read more about logical names.
6309
6310	<result name="VBOX_E_INVALID_VM_STATE">
6311	Virtual machine in Saved state or currently changing state.
6312	</result>
6313	<result name="VBOX_E_FILE_ERROR">
6314	Shared folder already exists or not accessible.
6315	</result>
6316	</desc>
6317	<param name="name" type="wstring" dir="in">
6318	<desc>Unique logical name of the shared folder.</desc>
6319	</param>
6320	<param name="hostPath" type="wstring" dir="in">
6321	<desc>Full path to the shared folder in the host file system.</desc>
6322	</param>
6323	<param name="writable" type="boolean" dir="in">
6324	<desc>Whether the share is writable or readonly</desc>
6325	</param>
6326	<param name="automount" type="boolean" dir="in">
6327	<desc>Whether the share gets automatically mounted by the guest
6328	or not.</desc>
6329	</param>
6330	</method>
6331
6332	<method name="removeSharedFolder">
6333	<desc>
6334	Removes a transient shared folder with the given name previously
6335	created by <link to="#createSharedFolder"/> from the collection of
6336	shared folders and stops sharing it.
6337	<result name="VBOX_E_INVALID_VM_STATE">
6338	Virtual machine in Saved state or currently changing state.
6339	</result>
6340	<result name="VBOX_E_FILE_ERROR">
6341	Shared folder does not exists.
6342	</result>
6343	</desc>
6344	<param name="name" type="wstring" dir="in">
6345	<desc>Logical name of the shared folder to remove.</desc>
6346	</param>
6347	</method>
6348
6349	<method name="takeSnapshot">
6350	<desc>
6351	Saves the current execution state
6352	and all settings of the machine and creates differencing images
6353	for all normal (non-independent) media.
6354	See <link to="ISnapshot" /> for an introduction to snapshots.
6355
6356	This method can be called for a PoweredOff, Saved (see
6357	<link to="#saveState"/>), Running or
6358	Paused virtual machine. When the machine is PoweredOff, an
6359	offline snapshot is created. When the machine is Running a live
6360	snapshot is created, and an online snapshot is is created when Paused.
6361
6362	The taken snapshot is always based on the
6363	<link to="IMachine::currentSnapshot">current snapshot</link>
6364	of the associated virtual machine and becomes a new current snapshot.
6365
6366	<note>
6367	This method implicitly calls <link to="IMachine::saveSettings"/> to
6368	save all current machine settings before taking an offline snapshot.
6369	</note>
6370
6371	<result name="VBOX_E_INVALID_VM_STATE">
6372	Virtual machine currently changing state.
6373	</result>
6374	</desc>
6375	<param name="name" type="wstring" dir="in">
6376	<desc>Short name for the snapshot.</desc>
6377	</param>
6378	<param name="description" type="wstring" dir="in">
6379	<desc>Optional description of the snapshot.</desc>
6380	</param>
6381	<param name="progress" type="IProgress" dir="return">
6382	<desc>Progress object to track the operation completion.</desc>
6383	</param>
6384	</method>
6385
6386	<method name="deleteSnapshot">
6387	<desc>
6388	Starts deleting the specified snapshot asynchronously.
6389	See <link to="ISnapshot" /> for an introduction to snapshots.
6390
6391	The execution state and settings of the associated machine stored in
6392	the snapshot will be deleted. The contents of all differencing media of
6393	this snapshot will be merged with the contents of their dependent child
6394	media to keep the medium chain valid (in other words, all changes
6395	represented by media being deleted will be propagated to their child
6396	medium). After that, this snapshot's differencing medium will be
6397	deleted. The parent of this snapshot will become a new parent for all
6398	its child snapshots.
6399
6400	If the deleted snapshot is the current one, its parent snapshot will
6401	become a new current snapshot. The current machine state is not directly
6402	affected in this case, except that currently attached differencing
6403	media based on media of the deleted snapshot will be also merged as
6404	described above.
6405
6406	If the deleted snapshot is the first or current snapshot, then the
6407	respective IMachine attributes will be adjusted. Deleting the current
6408	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6409	to make all current machine settings permanent.
6410
6411	Deleting a snapshot has the following preconditions:
6412
6413	<ul>
6414	<li>Child media of all normal media of the deleted snapshot
6415	must be accessible (see <link to="IMedium::state"/>) for this
6416	operation to succeed. In particular, this means that all virtual
6417	machines, whose media are directly or indirectly based on the
6418	media of deleted snapshot, must be powered off.</li>
6419
6420	<li>You cannot delete the snapshot if a medium attached to it has
6421	more than once child medium (differencing images) because otherwise
6422	merging would be impossible. This might be the case if there is
6423	more than one child snapshot or differencing images were created
6424	for other reason (e.g. implicitly because of multiple machine
6425	attachments).</li>
6426	</ul>
6427
6428
6429	The virtual machine's <link to="IMachine::state">state</link> is
6430	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6431	"DeletingSnapshotPaused" while this operation is in progress.
6432
6433	<note>
6434	Merging medium contents can be very time and disk space
6435	consuming, if these media are big in size and have many
6436	children. However, if the snapshot being deleted is the last
6437	(head) snapshot on the branch, the operation will be rather
6438	quick.
6439	</note>
6440	<result name="VBOX_E_INVALID_VM_STATE">
6441	The running virtual machine prevents deleting this snapshot. This
6442	happens only in very specific situations, usually snapshots can be
6443	deleted without trouble while a VM is running. The error message
6444	text explains the reason for the failure.
6445	</result>
6446	</desc>
6447	<param name="id" type="uuid" mod="string" dir="in">
6448	<desc>UUID of the snapshot to delete.</desc>
6449	</param>
6450	<param name="progress" type="IProgress" dir="return">
6451	<desc>Progress object to track the operation completion.</desc>
6452	</param>
6453	</method>
6454
6455	<method name="restoreSnapshot">
6456	<desc>
6457	Starts resetting the machine's current state to the state contained
6458	in the given snapshot, asynchronously. All current settings of the
6459	machine will be reset and changes stored in differencing media
6460	will be lost.
6461	See <link to="ISnapshot" /> for an introduction to snapshots.
6462
6463	After this operation is successfully completed, new empty differencing
6464	media are created for all normal media of the machine.
6465
6466	If the given snapshot is an online snapshot, the machine will go to
6467	the <link to="MachineState_Saved"> saved state</link>, so that the
6468	next time it is powered on, the execution state will be restored
6469	from the state of the snapshot.
6470
6471	<note>
6472	The machine must not be running, otherwise the operation will fail.
6473	</note>
6474
6475	<note>
6476	If the machine state is <link to="MachineState_Saved">Saved</link>
6477	prior to this operation, the saved state file will be implicitly
6478	deleted (as if <link to="IConsole::discardSavedState"/> were
6479	called).
6480	</note>
6481
6482	<result name="VBOX_E_INVALID_VM_STATE">
6483	Virtual machine is running.
6484	</result>
6485	</desc>
6486	<param name="snapshot" type="ISnapshot" dir="in">
6487	<desc>The snapshot to restore the VM state from.</desc>
6488	</param>
6489	<param name="progress" type="IProgress" dir="return">
6490	<desc>Progress object to track the operation completion.</desc>
6491	</param>
6492	</method>
6493
6494	<method name="teleport">
6495	<desc>
6496	Teleport the VM to a different host machine or process.
6497
6498	TODO explain the details.
6499
6500	<result name="VBOX_E_INVALID_VM_STATE">
6501	Virtual machine not running or paused.
6502	</result>
6503	</desc>
6504	<param name="hostname" type="wstring" dir="in">
6505	<desc>The name or IP of the host to teleport to.</desc>
6506	</param>
6507	<param name="tcpport" type="unsigned long" dir="in">
6508	<desc>The TCP port to connect to (1..65535).</desc>
6509	</param>
6510	<param name="password" type="wstring" dir="in">
6511	<desc>The password.</desc>
6512	</param>
6513	<param name="maxDowntime" type="unsigned long" dir="in">
6514	<desc>
6515	The maximum allowed downtime given as milliseconds. 0 is not a valid
6516	value. Recommended value: 250 ms.
6517
6518	The higher the value is, the greater the chance for a successful
6519	teleportation. A small value may easily result in the teleportation
6520	process taking hours and eventually fail.
6521
6522	<note>
6523	The current implementation treats this a guideline, not as an
6524	absolute rule.
6525	</note>
6526	</desc>
6527	</param>
6528	<param name="progress" type="IProgress" dir="return">
6529	<desc>Progress object to track the operation completion.</desc>
6530	</param>
6531	</method>
6532
6533	</interface>
6534
6535	<!--
6536	// IHost
6537	/////////////////////////////////////////////////////////////////////////
6538	-->
6539
6540	<enum
6541	name="HostNetworkInterfaceMediumType"
6542	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6543	>
6544	<desc>
6545	Type of encapsulation. Ethernet encapsulation includes both wired and
6546	wireless Ethernet connections.
6547	<see>IHostNetworkInterface</see>
6548	</desc>
6549
6550	<const name="Unknown" value="0">
6551	<desc>
6552	The type of interface cannot be determined.
6553	</desc>
6554	</const>
6555	<const name="Ethernet" value="1">
6556	<desc>
6557	Ethernet frame encapsulation.
6558	</desc>
6559	</const>
6560	<const name="PPP" value="2">
6561	<desc>
6562	Point-to-point protocol encapsulation.
6563	</desc>
6564	</const>
6565	<const name="SLIP" value="3">
6566	<desc>
6567	Serial line IP encapsulation.
6568	</desc>
6569	</const>
6570	</enum>
6571
6572	<enum
6573	name="HostNetworkInterfaceStatus"
6574	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6575	>
6576	<desc>
6577	Current status of the interface.
6578	<see>IHostNetworkInterface</see>
6579	</desc>
6580
6581	<const name="Unknown" value="0">
6582	<desc>
6583	The state of interface cannot be determined.
6584	</desc>
6585	</const>
6586	<const name="Up" value="1">
6587	<desc>
6588	The interface is fully operational.
6589	</desc>
6590	</const>
6591	<const name="Down" value="2">
6592	<desc>
6593	The interface is not functioning.
6594	</desc>
6595	</const>
6596	</enum>
6597
6598	<enum
6599	name="HostNetworkInterfaceType"
6600	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6601	>
6602	<desc>
6603	Network interface type.
6604	</desc>
6605	<const name="Bridged" value="1"/>
6606	<const name="HostOnly" value="2"/>
6607	</enum>
6608
6609	<interface
6610	name="IHostNetworkInterface" extends="$unknown"
6611	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6612	wsmap="managed"
6613	>
6614	<desc>
6615	Represents one of host's network interfaces. IP V6 address and network
6616	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6617	separated by colons.
6618	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6619	</desc>
6620	<attribute name="name" type="wstring" readonly="yes">
6621	<desc>Returns the host network interface name.</desc>
6622	</attribute>
6623
6624	<attribute name="id" type="uuid" mod="string" readonly="yes">
6625	<desc>Returns the interface UUID.</desc>
6626	</attribute>
6627
6628	<attribute name="networkName" type="wstring" readonly="yes">
6629	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6630	</attribute>
6631
6632	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6633	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6634	</attribute>
6635
6636	<attribute name="IPAddress" type="wstring" readonly="yes">
6637	<desc>Returns the IP V4 address of the interface.</desc>
6638	</attribute>
6639
6640	<attribute name="networkMask" type="wstring" readonly="yes">
6641	<desc>Returns the network mask of the interface.</desc>
6642	</attribute>
6643
6644	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6645	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6646	</attribute>
6647
6648	<attribute name="IPV6Address" type="wstring" readonly="yes">
6649	<desc>Returns the IP V6 address of the interface.</desc>
6650	</attribute>
6651
6652	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6653	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6654	</attribute>
6655
6656	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6657	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6658	</attribute>
6659
6660	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6661	<desc>Type of protocol encapsulation used.</desc>
6662	</attribute>
6663
6664	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6665	<desc>Status of the interface.</desc>
6666	</attribute>
6667
6668	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6669	<desc>specifies the host interface type.</desc>
6670	</attribute>
6671
6672	<method name="enableStaticIpConfig">
6673	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6674	<param name="IPAddress" type="wstring" dir="in">
6675	<desc>
6676	IP address.
6677	</desc>
6678	</param>
6679	<param name="networkMask" type="wstring" dir="in">
6680	<desc>
6681	network mask.
6682	</desc>
6683	</param>
6684	</method>
6685
6686	<method name="enableStaticIpConfigV6">
6687	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6688	<param name="IPV6Address" type="wstring" dir="in">
6689	<desc>
6690	IP address.
6691	</desc>
6692	</param>
6693	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6694	<desc>
6695	network mask.
6696	</desc>
6697	</param>
6698	</method>
6699
6700	<method name="enableDynamicIpConfig">
6701	<desc>enables the dynamic IP configuration.</desc>
6702	</method>
6703
6704	<method name="dhcpRediscover">
6705	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6706	</method>
6707
6708	</interface>
6709
6710	<interface
6711	name="IHost" extends="$unknown"
6712	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6713	wsmap="managed"
6714	>
6715	<desc>
6716	The IHost interface represents the physical machine that this VirtualBox
6717	installation runs on.
6718
6719	An object implementing this interface is returned by the
6720	<link to="IVirtualBox::host" /> attribute. This interface contains
6721	read-only information about the host's physical hardware (such as what
6722	processors and disks are available, what the host operating system is,
6723	and so on) and also allows for manipulating some of the host's hardware,
6724	such as global USB device filters and host interface networking.
6725
6726	</desc>
6727	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6728	<desc>List of DVD drives available on the host.</desc>
6729	</attribute>
6730
6731	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6732	<desc>List of floppy drives available on the host.</desc>
6733	</attribute>
6734
6735	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6736	<desc>
6737	List of USB devices currently attached to the host.
6738	Once a new device is physically attached to the host computer,
6739	it appears in this list and remains there until detached.
6740
6741	<note>
6742	If USB functionality is not available in the given edition of
6743	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6744	</note>
6745	</desc>
6746	</attribute>
6747
6748	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6749	<desc>
6750	List of USB device filters in action.
6751	When a new device is physically attached to the host computer,
6752	filters from this list are applied to it (in order they are stored
6753	in the list). The first matched filter will determine the
6754	<link to="IHostUSBDeviceFilter::action">action</link>
6755	performed on the device.
6756
6757	Unless the device is ignored by these filters, filters of all
6758	currently running virtual machines
6759	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6760
6761	<note>
6762	If USB functionality is not available in the given edition of
6763	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6764	</note>
6765
6766	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6767	</desc>
6768	</attribute>
6769
6770	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6771	<desc>List of host network interfaces currently defined on the host.</desc>
6772	</attribute>
6773
6774	<attribute name="processorCount" type="unsigned long" readonly="yes">
6775	<desc>Number of (logical) CPUs installed in the host system.</desc>
6776	</attribute>
6777
6778	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6779	<desc>Number of (logical) CPUs online in the host system.</desc>
6780	</attribute>
6781
6782	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6783	<desc>Number of physical processor cores installed in the host system.</desc>
6784	</attribute>
6785
6786	<method name="getProcessorSpeed">
6787	<desc>Query the (approximate) maximum speed of a specified host CPU in
6788	Megahertz.
6789	</desc>
6790	<param name="cpuId" type="unsigned long" dir="in">
6791	<desc>
6792	Identifier of the CPU.
6793	</desc>
6794	</param>
6795	<param name="speed" type="unsigned long" dir="return">
6796	<desc>
6797	Speed value. 0 is returned if value is not known or @a cpuId is
6798	invalid.
6799	</desc>
6800	</param>
6801	</method>
6802
6803	<method name="getProcessorFeature">
6804	<desc>Query whether a CPU feature is supported or not.</desc>
6805	<param name="feature" type="ProcessorFeature" dir="in">
6806	<desc>
6807	CPU Feature identifier.
6808	</desc>
6809	</param>
6810	<param name="supported" type="boolean" dir="return">
6811	<desc>
6812	Feature is supported or not.
6813	</desc>
6814	</param>
6815	</method>
6816
6817	<method name="getProcessorDescription">
6818	<desc>Query the model string of a specified host CPU.
6819	</desc>
6820	<param name="cpuId" type="unsigned long" dir="in">
6821	<desc>
6822	Identifier of the CPU.
6823	<note>
6824	The current implementation might not necessarily return the
6825	description for this exact CPU.
6826	</note>
6827	</desc>
6828	</param>
6829	<param name="description" type="wstring" dir="return">
6830	<desc>
6831	Model string. An empty string is returned if value is not known or
6832	@a cpuId is invalid.
6833	</desc>
6834	</param>
6835	</method>
6836
6837	<method name="getProcessorCPUIDLeaf">
6838	<desc>
6839	Returns the CPU cpuid information for the specified leaf.
6840	</desc>
6841	<param name="cpuId" type="unsigned long" dir="in">
6842	<desc>
6843	Identifier of the CPU. The CPU most be online.
6844	<note>
6845	The current implementation might not necessarily return the
6846	description for this exact CPU.
6847	</note>
6848	</desc>
6849	</param>
6850	<param name="leaf" type="unsigned long" dir="in">
6851	<desc>
6852	CPUID leaf index (eax).
6853	</desc>
6854	</param>
6855	<param name="subLeaf" type="unsigned long" dir="in">
6856	<desc>
6857	CPUID leaf sub index (ecx). This currently only applies to cache
6858	information on Intel CPUs. Use 0 if retriving values for
6859	<link to="IMachine::setCPUIDLeaf"/>.
6860	</desc>
6861	</param>
6862	<param name="valEax" type="unsigned long" dir="out">
6863	<desc>
6864	CPUID leaf value for register eax.
6865	</desc>
6866	</param>
6867	<param name="valEbx" type="unsigned long" dir="out">
6868	<desc>
6869	CPUID leaf value for register ebx.
6870	</desc>
6871	</param>
6872	<param name="valEcx" type="unsigned long" dir="out">
6873	<desc>
6874	CPUID leaf value for register ecx.
6875	</desc>
6876	</param>
6877	<param name="valEdx" type="unsigned long" dir="out">
6878	<desc>
6879	CPUID leaf value for register edx.
6880	</desc>
6881	</param>
6882	</method>
6883
6884	<attribute name="memorySize" type="unsigned long" readonly="yes">
6885	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6886	</attribute>
6887
6888	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6889	<desc>Available system memory in the host system.</desc>
6890	</attribute>
6891
6892	<attribute name="operatingSystem" type="wstring" readonly="yes">
6893	<desc>Name of the host system's operating system.</desc>
6894	</attribute>
6895
6896	<attribute name="OSVersion" type="wstring" readonly="yes">
6897	<desc>Host operating system's version string.</desc>
6898	</attribute>
6899
6900	<attribute name="UTCTime" type="long long" readonly="yes">
6901	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6902	</attribute>
6903
6904	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6905	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6906	</attribute>
6907
6908	<method name="createHostOnlyNetworkInterface">
6909	<desc>
6910	Creates a new adapter for Host Only Networking.
6911	<result name="E_INVALIDARG">
6912	Host network interface @a name already exists.
6913	</result>
6914	</desc>
6915	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6916	<desc>
6917	Created host interface object.
6918	</desc>
6919	</param>
6920	<param name="progress" type="IProgress" dir="return">
6921	<desc>
6922	Progress object to track the operation completion.
6923	</desc>
6924	</param>
6925	</method>
6926
6927	<method name="removeHostOnlyNetworkInterface">
6928	<desc>
6929	Removes the given Host Only Networking interface.
6930	<result name="VBOX_E_OBJECT_NOT_FOUND">
6931	No host network interface matching @a id found.
6932	</result>
6933	</desc>
6934	<param name="id" type="uuid" mod="string" dir="in">
6935	<desc>
6936	Adapter GUID.
6937	</desc>
6938	</param>
6939	<param name="progress" type="IProgress" dir="return">
6940	<desc>
6941	Progress object to track the operation completion.
6942	</desc>
6943	</param>
6944	</method>
6945
6946	<method name="createUSBDeviceFilter">
6947	<desc>
6948	Creates a new USB device filter. All attributes except
6949	the filter name are set to empty (any match),
6950	<i>active</i> is @c false (the filter is not active).
6951
6952	The created filter can be added to the list of filters using
6953	<link to="#insertUSBDeviceFilter"/>.
6954
6955	<see>#USBDeviceFilters</see>
6956	</desc>
6957	<param name="name" type="wstring" dir="in">
6958	<desc>
6959	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
6960	</desc>
6961	</param>
6962	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
6963	<desc>Created filter object.</desc>
6964	</param>
6965	</method>
6966
6967	<method name="insertUSBDeviceFilter">
6968	<desc>
6969	Inserts the given USB device to the specified position
6970	in the list of filters.
6971
6972	Positions are numbered starting from @c 0. If the specified
6973	position is equal to or greater than the number of elements in
6974	the list, the filter is added at the end of the collection.
6975
6976	<note>
6977	Duplicates are not allowed, so an attempt to insert a
6978	filter already in the list is an error.
6979	</note>
6980	<note>
6981	If USB functionality is not available in the given edition of
6982	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6983	</note>
6984
6985	<see>#USBDeviceFilters</see>
6986
6987	<result name="VBOX_E_INVALID_OBJECT_STATE">
6988	USB device filter is not created within this VirtualBox instance.
6989	</result>
6990	<result name="E_INVALIDARG">
6991	USB device filter already in list.
6992	</result>
6993
6994	</desc>
6995	<param name="position" type="unsigned long" dir="in">
6996	<desc>Position to insert the filter to.</desc>
6997	</param>
6998	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
6999	<desc>USB device filter to insert.</desc>
7000	</param>
7001	</method>
7002
7003	<method name="removeUSBDeviceFilter">
7004	<desc>
7005	Removes a USB device filter from the specified position in the
7006	list of filters.
7007
7008	Positions are numbered starting from @c 0. Specifying a
7009	position equal to or greater than the number of elements in
7010	the list will produce an error.
7011
7012	<note>
7013	If USB functionality is not available in the given edition of
7014	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7015	</note>
7016
7017	<see>#USBDeviceFilters</see>
7018
7019	<result name="E_INVALIDARG">
7020	USB device filter list empty or invalid @a position.
7021	</result>
7022
7023	</desc>
7024	<param name="position" type="unsigned long" dir="in">
7025	<desc>Position to remove the filter from.</desc>
7026	</param>
7027	</method>
7028
7029	<method name="findHostDVDDrive">
7030	<desc>
7031	Searches for a host DVD drive with the given @c name.
7032
7033	<result name="VBOX_E_OBJECT_NOT_FOUND">
7034	Given @c name does not correspond to any host drive.
7035	</result>
7036
7037	</desc>
7038	<param name="name" type="wstring" dir="in">
7039	<desc>Name of the host drive to search for</desc>
7040	</param>
7041	<param name="drive" type="IMedium" dir="return">
7042	<desc>Found host drive object</desc>
7043	</param>
7044	</method>
7045
7046	<method name="findHostFloppyDrive">
7047	<desc>
7048	Searches for a host floppy drive with the given @c name.
7049
7050	<result name="VBOX_E_OBJECT_NOT_FOUND">
7051	Given @c name does not correspond to any host floppy drive.
7052	</result>
7053
7054	</desc>
7055	<param name="name" type="wstring" dir="in">
7056	<desc>Name of the host floppy drive to search for</desc>
7057	</param>
7058	<param name="drive" type="IMedium" dir="return">
7059	<desc>Found host floppy drive object</desc>
7060	</param>
7061	</method>
7062
7063	<method name="findHostNetworkInterfaceByName">
7064	<desc>
7065	Searches through all host network interfaces for an interface with
7066	the given @c name.
7067	<note>
7068	The method returns an error if the given @c name does not
7069	correspond to any host network interface.
7070	</note>
7071	</desc>
7072	<param name="name" type="wstring" dir="in">
7073	<desc>Name of the host network interface to search for.</desc>
7074	</param>
7075	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7076	<desc>Found host network interface object.</desc>
7077	</param>
7078	</method>
7079	<method name="findHostNetworkInterfaceById">
7080	<desc>
7081	Searches through all host network interfaces for an interface with
7082	the given GUID.
7083	<note>
7084	The method returns an error if the given GUID does not
7085	correspond to any host network interface.
7086	</note>
7087	</desc>
7088	<param name="id" type="uuid" mod="string" dir="in">
7089	<desc>GUID of the host network interface to search for.</desc>
7090	</param>
7091	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7092	<desc>Found host network interface object.</desc>
7093	</param>
7094	</method>
7095	<method name="findHostNetworkInterfacesOfType">
7096	<desc>
7097	Searches through all host network interfaces and returns a list of interfaces of the specified type
7098	</desc>
7099	<param name="type" type="HostNetworkInterfaceType" dir="in">
7100	<desc>type of the host network interfaces to search for.</desc>
7101	</param>
7102	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7103	<desc>Found host network interface objects.</desc>
7104	</param>
7105	</method>
7106
7107	<method name="findUSBDeviceById">
7108	<desc>
7109	Searches for a USB device with the given UUID.
7110
7111	<result name="VBOX_E_OBJECT_NOT_FOUND">
7112	Given @c id does not correspond to any USB device.
7113	</result>
7114
7115	<see>IHostUSBDevice::id</see>
7116	</desc>
7117	<param name="id" type="uuid" mod="string" dir="in">
7118	<desc>UUID of the USB device to search for.</desc>
7119	</param>
7120	<param name="device" type="IHostUSBDevice" dir="return">
7121	<desc>Found USB device object.</desc>
7122	</param>
7123	</method>
7124
7125	<method name="findUSBDeviceByAddress">
7126	<desc>
7127	Searches for a USB device with the given host address.
7128
7129	<result name="VBOX_E_OBJECT_NOT_FOUND">
7130	Given @c name does not correspond to any USB device.
7131	</result>
7132
7133	<see>IHostUSBDevice::address</see>
7134	</desc>
7135	<param name="name" type="wstring" dir="in">
7136	<desc>
7137	Address of the USB device (as assigned by the host) to
7138	search for.
7139	</desc>
7140	</param>
7141	<param name="device" type="IHostUSBDevice" dir="return">
7142	<desc>Found USB device object.</desc>
7143	</param>
7144	</method>
7145
7146	</interface>
7147
7148	<!--
7149	// ISystemProperties
7150	/////////////////////////////////////////////////////////////////////////
7151	-->
7152
7153	<interface
7154	name="ISystemProperties"
7155	extends="$unknown"
7156	uuid="2af0100b-fda2-4c6a-8e8f-31e4ba871886"
7157	wsmap="managed"
7158	>
7159	<desc>
7160	The ISystemProperties interface represents global properties of the given
7161	VirtualBox installation.
7162
7163	These properties define limits and default values for various attributes
7164	and parameters. Most of the properties are read-only, but some can be
7165	changed by a user.
7166	</desc>
7167
7168	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7169	<desc>Minimum guest system memory in Megabytes.</desc>
7170	</attribute>
7171
7172	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7173	<desc>Maximum guest system memory in Megabytes.</desc>
7174	</attribute>
7175
7176	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7177	<desc>Minimum guest video memory in Megabytes.</desc>
7178	</attribute>
7179
7180	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7181	<desc>Maximum guest video memory in Megabytes.</desc>
7182	</attribute>
7183
7184	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7185	<desc>Minimum CPU count.</desc>
7186	</attribute>
7187
7188	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7189	<desc>Maximum CPU count.</desc>
7190	</attribute>
7191
7192	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7193	<desc>Maximum of monitors which could be connected.</desc>
7194	</attribute>
7195
7196	<attribute name="infoVDSize" type="long long" readonly="yes">
7197	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7198	does not reflect the limits of any virtual disk image format.</desc>
7199	</attribute>
7200
7201	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7202	<desc>
7203	Number of network adapters associated with every
7204	<link to="IMachine"/> instance.
7205	</desc>
7206	</attribute>
7207
7208	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7209	<desc>
7210	Number of serial ports associated with every
7211	<link to="IMachine"/> instance.
7212	</desc>
7213	</attribute>
7214
7215	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7216	<desc>
7217	Number of parallel ports associated with every
7218	<link to="IMachine"/> instance.
7219	</desc>
7220	</attribute>
7221
7222	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7223	<desc>
7224	Maximum device position in the boot order. This value corresponds
7225	to the total number of devices a machine can boot from, to make it
7226	possible to include all possible devices to the boot list.
7227	<see><link to="IMachine::setBootOrder"/></see>
7228	</desc>
7229	</attribute>
7230
7231	<attribute name="defaultMachineFolder" type="wstring">
7232	<desc>
7233	Full path to the default directory used to create new or open
7234	existing machines when a settings file name contains no
7235	path.
7236
7237	The initial value of this property is
7238	<tt><</tt><link to="IVirtualBox::homeFolder">
7239	VirtualBox_home</link><tt>>/Machines</tt>.
7240
7241	<note>
7242	Setting this property to @c null or an empty string will restore the
7243	initial value.
7244	</note>
7245	<note>
7246	When settings this property, the specified path can be
7247	absolute (full path) or relative
7248	to the <link to="IVirtualBox::homeFolder">
7249	VirtualBox home directory</link>.
7250	When reading this property, a full path is
7251	always returned.
7252	</note>
7253	<note>
7254	The specified path may not exist, it will be created
7255	when necessary.
7256	</note>
7257
7258	<see>
7259	<link to="IVirtualBox::createMachine"/>,
7260	<link to="IVirtualBox::openMachine"/>
7261	</see>
7262	</desc>
7263	</attribute>
7264
7265	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7266	<desc>
7267	List of all medium storage formats supported by this VirtualBox
7268	installation.
7269
7270	Keep in mind that the medium format identifier
7271	(<link to="IMediumFormat::id"/>) used in other API calls like
7272	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7273	medium format is a case-insensitive string. This means that, for
7274	example, all of the following strings:
7275	<pre>
7276	"VDI"
7277	"vdi"
7278	"VdI"</pre>
7279	refer to the same medium format.
7280
7281	Note that the virtual medium framework is backend-based, therefore
7282	the list of supported formats depends on what backends are currently
7283	installed.
7284
7285	<see>
7286	<link to="IMediumFormat"/>,
7287	</see>
7288	</desc>
7289	</attribute>
7290
7291	<attribute name="defaultHardDiskFormat" type="wstring">
7292	<desc>
7293	Identifier of the default medium format used by VirtualBox.
7294
7295	The medium format set by this attribute is used by VirtualBox
7296	when the medium format was not specified explicitly. One example is
7297	<link to="IVirtualBox::createHardDisk"/> with the empty
7298	format argument. A more complex example is implicit creation of
7299	differencing media when taking a snapshot of a virtual machine:
7300	this operation will try to use a format of the parent medium first
7301	and if this format does not support differencing media the default
7302	format specified by this argument will be used.
7303
7304	The list of supported medium formats may be obtained by the
7305	<link to="#mediumFormats"/> call. Note that the default medium
7306	format must have a capability to create differencing media;
7307	otherwise operations that create media implicitly may fail
7308	unexpectedly.
7309
7310	The initial value of this property is <tt>"VDI"</tt> in the current
7311	version of the VirtualBox product, but may change in the future.
7312
7313	<note>
7314	Setting this property to @c null or empty string will restore the
7315	initial value.
7316	</note>
7317
7318	<see>
7319	<link to="#mediumFormats"/>,
7320	<link to="IMediumFormat::id"/>,
7321	<link to="IVirtualBox::createHardDisk"/>
7322	</see>
7323	</desc>
7324	</attribute>
7325
7326	<attribute name="freeDiskSpaceWarning" type="long long">
7327	<desc>Issue a warning if the free disk space is below (or in some disk
7328	intensive operation is expected to go below) the given size in
7329	bytes.</desc>
7330	</attribute>
7331
7332	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7333	<desc>Issue a warning if the free disk space is below (or in some disk
7334	intensive operation is expected to go below) the given percentage.</desc>
7335	</attribute>
7336
7337	<attribute name="freeDiskSpaceError" type="long long">
7338	<desc>Issue an error if the free disk space is below (or in some disk
7339	intensive operation is expected to go below) the given size in
7340	bytes.</desc>
7341	</attribute>
7342
7343	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7344	<desc>Issue an error if the free disk space is below (or in some disk
7345	intensive operation is expected to go below) the given percentage.</desc>
7346	</attribute>
7347
7348	<attribute name="VRDEAuthLibrary" type="wstring">
7349	<desc>
7350	Library that provides authentication for Remote Desktop clients. The library
7351	is used if a virtual machine's authentication type is set to "external"
7352	in the VM RemoteDisplay configuration.
7353
7354	The system library extension (".DLL" or ".so") must be omitted.
7355	A full path can be specified; if not, then the library must reside on the
7356	system's default library path.
7357
7358	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7359	of that name in one of the default VirtualBox library directories.
7360
7361	For details about VirtualBox authentication libraries and how to implement
7362	them, please refer to the VirtualBox manual.
7363
7364	<note>
7365	Setting this property to @c null or empty string will restore the
7366	initial value.
7367	</note>
7368	</desc>
7369	</attribute>
7370
7371	<attribute name="webServiceAuthLibrary" type="wstring">
7372	<desc>
7373	Library that provides authentication for webservice clients. The library
7374	is used if a virtual machine's authentication type is set to "external"
7375	in the VM RemoteDisplay configuration and will be called from
7376	within the <link to="IWebsessionManager::logon" /> implementation.
7377
7378	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7379	there is no per-VM setting for this, as the webservice is a global
7380	resource (if it is running). Only for this setting (for the webservice),
7381	setting this value to a literal <tt>"null"</tt> string disables authentication,
7382	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7383	no matter what user name and password are supplied.
7384
7385	The initial value of this property is <tt>"VRDPAuth"</tt>,
7386	meaning that the webservice will use the same authentication
7387	library that is used by default for VRDE (again, see
7388	<link to="ISystemProperties::VRDEAuthLibrary" />).
7389	The format and calling convention of authentication libraries
7390	is the same for the webservice as it is for VRDE.
7391
7392	<note>
7393	Setting this property to @c null or empty string will restore the
7394	initial value.
7395	</note>
7396	</desc>
7397	</attribute>
7398
7399	<attribute name="defaultVRDELibrary" type="wstring">
7400	<desc>
7401	Default VRDE library.
7402
7403	The default value of this property is an empty string, which means that the
7404	VRDE is not available.
7405
7406	For details about VirtualBox Remote Desktop Extension and how to implement
7407	it, please refer to the VirtualBox SDK.
7408	</desc>
7409	</attribute>
7410
7411	<attribute name="LogHistoryCount" type="unsigned long">
7412	<desc>
7413	This value specifies how many old release log files are kept.
7414	</desc>
7415	</attribute>
7416
7417	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7418	<desc>This value hold the default audio driver for the current
7419	system.</desc>
7420	</attribute>
7421
7422	<method name="getMaxDevicesPerPortForStorageBus">
7423	<desc>Returns the maximum number of devices which can be attached to a port
7424	for the given storage bus.</desc>
7425
7426	<param name="bus" type="StorageBus" dir="in">
7427	<desc>The storage bus type to get the value for.</desc>
7428	</param>
7429
7430	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7431	<desc>The maximum number of devices which can eb attached to the port for the given
7432	storage bus.</desc>
7433	</param>
7434	</method>
7435
7436	<method name="getMinPortCountForStorageBus">
7437	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7438
7439	<param name="bus" type="StorageBus" dir="in">
7440	<desc>The storage bus type to get the value for.</desc>
7441	</param>
7442
7443	<param name="minPortCount" type="unsigned long" dir="return">
7444	<desc>The minimum number of ports for the given storage bus.</desc>
7445	</param>
7446	</method>
7447
7448	<method name="getMaxPortCountForStorageBus">
7449	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7450
7451	<param name="bus" type="StorageBus" dir="in">
7452	<desc>The storage bus type to get the value for.</desc>
7453	</param>
7454
7455	<param name="maxPortCount" type="unsigned long" dir="return">
7456	<desc>The maximum number of ports for the given storage bus.</desc>
7457	</param>
7458	</method>
7459
7460	<method name="getMaxInstancesOfStorageBus">
7461	<desc>Returns the maximum number of storage bus instances which
7462	can be configured for each VM. This corresponds to the number of
7463	storage controllers one can have.</desc>
7464
7465	<param name="bus" type="StorageBus" dir="in">
7466	<desc>The storage bus type to get the value for.</desc>
7467	</param>
7468
7469	<param name="maxInstances" type="unsigned long" dir="return">
7470	<desc>The maximum number of instances for the given storage bus.</desc>
7471	</param>
7472	</method>
7473
7474	<method name="getDeviceTypesForStorageBus">
7475	<desc>Returns list of all the supported device types
7476	(<link to="DeviceType"/>) for the given type of storage
7477	bus.</desc>
7478
7479	<param name="bus" type="StorageBus" dir="in">
7480	<desc>The storage bus type to get the value for.</desc>
7481	</param>
7482
7483	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7484	<desc>The list of all supported device types for the given storage bus.</desc>
7485	</param>
7486	</method>
7487
7488	<method name="getDefaultIoCacheSettingForStorageController">
7489	<desc>Returns the default I/O cache setting for the
7490	given storage controller</desc>
7491
7492	<param name="controllerType" type="StorageControllerType" dir="in">
7493	<desc>The storage controller to the setting for.</desc>
7494	</param>
7495
7496	<param name="enabled" type="boolean" dir="return">
7497	<desc>Returned flag indicating the default value</desc>
7498	</param>
7499	</method>
7500	</interface>
7501
7502	<!--
7503	// IGuest
7504	/////////////////////////////////////////////////////////////////////////
7505	-->
7506
7507	<interface
7508	name="IGuestOSType" extends="$unknown"
7509	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7510	wsmap="struct"
7511	>
7512	<desc>
7513	</desc>
7514
7515	<attribute name="familyId" type="wstring" readonly="yes">
7516	<desc>Guest OS family identifier string.</desc>
7517	</attribute>
7518
7519	<attribute name="familyDescription" type="wstring" readonly="yes">
7520	<desc>Human readable description of the guest OS family.</desc>
7521	</attribute>
7522
7523	<attribute name="id" type="wstring" readonly="yes">
7524	<desc>Guest OS identifier string.</desc>
7525	</attribute>
7526
7527	<attribute name="description" type="wstring" readonly="yes">
7528	<desc>Human readable description of the guest OS.</desc>
7529	</attribute>
7530
7531	<attribute name="is64Bit" type="boolean" readonly="yes">
7532	<desc>Returns @c true if the given OS is 64-bit</desc>
7533	</attribute>
7534
7535	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7536	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7537	</attribute>
7538
7539	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7540	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7541	</attribute>
7542
7543	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7544	<desc>Recommended RAM size in Megabytes.</desc>
7545	</attribute>
7546
7547	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7548	<desc>Recommended video RAM size in Megabytes.</desc>
7549	</attribute>
7550
7551	<attribute name="recommendedHDD" type="long long" readonly="yes">
7552	<desc>Recommended hard disk size in bytes.</desc>
7553	</attribute>
7554
7555	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7556	<desc>Returns recommended network adapter for this OS type.</desc>
7557	</attribute>
7558
7559	<attribute name="recommendedPae" type="boolean" readonly="yes">
7560	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7561	</attribute>
7562
7563	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7564	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7565	</attribute>
7566
7567	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7568	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7569	</attribute>
7570
7571	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7572	<desc>Recommended storage controller type for HD drives.</desc>
7573	</attribute>
7574
7575	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7576	<desc>Recommended storage bus type for HD drives.</desc>
7577	</attribute>
7578
7579	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7580	<desc>Recommended firmware type.</desc>
7581	</attribute>
7582
7583	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7584	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7585	</attribute>
7586
7587	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7588	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7589	</attribute>
7590
7591	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7592	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7593	</attribute>
7594
7595	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7596	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7597	</attribute>
7598
7599	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7600	<desc>Recommended chipset type.</desc>
7601	</attribute>
7602
7603	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7604	<desc>Recommended audio type.</desc>
7605	</attribute>
7606
7607	</interface>
7608
7609	<enum
7610	name="AdditionsRunLevelType"
7611	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7612	>
7613	<desc>
7614	Guest Additions run level type.
7615	</desc>
7616
7617	<const name="None" value="0">
7618	<desc>Guest Additions are not loaded.</desc>
7619	</const>
7620	<const name="System" value="1">
7621	<desc>Guest drivers are loaded.</desc>
7622	</const>
7623	<const name="Userland" value="2">
7624	<desc>Common components (such as application services) are loaded.</desc>
7625	</const>
7626	<const name="Desktop" value="3">
7627	<desc>Per-user desktop components are loaded.</desc>
7628	</const>
7629	</enum>
7630
7631	<enum
7632	name="ExecuteProcessFlag"
7633	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7634	>
7635	<desc>
7636	Guest process execution flags.
7637	</desc>
7638
7639	<const name="None" value="0">
7640	<desc>No flag set.</desc>
7641	</const>
7642
7643	<const name="WaitForProcessStartOnly" value="1">
7644	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
7645	process itself then uses an infinite timeout.</desc>
7646	</const>
7647
7648	<const name="IgnoreOrphanedProcesses" value="2">
7649	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7650	</const>
7651	</enum>
7652
7653	<enum
7654	name="ProcessInputFlag"
7655	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7656	>
7657	<desc>
7658	Guest process input flags.
7659	</desc>
7660
7661	<const name="None" value="0">
7662	<desc>No flag set.</desc>
7663	</const>
7664	<const name="EndOfFile" value="1">
7665	<desc>End of file (input) reached.</desc>
7666	</const>
7667	</enum>
7668
7669	<enum
7670	name="CopyFileFlag"
7671	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7672	>
7673	<desc>
7674	Host/Guest copy flags.
7675	</desc>
7676
7677	<const name="None" value="0">
7678	<desc>No flag set.</desc>
7679	</const>
7680
7681	<const name="Recursive" value="1">
7682	<desc>Copy directories recursively.</desc>
7683	</const>
7684
7685	<const name="Update" value="2">
7686	<desc>Copy only when the source file is newer than the destination file or when the destination file is missing.</desc>
7687	</const>
7688
7689	<const name="FollowLinks" value="4">
7690	<desc>Follow symbolic links.</desc>
7691	</const>
7692	</enum>
7693
7694	<interface
7695	name="IGuest" extends="$unknown"
7696	uuid="5a4f265c-0c0e-495a-8ff6-7d68682e276b"
7697	wsmap="managed"
7698	>
7699	<desc>
7700	The IGuest interface represents information about the operating system
7701	running inside the virtual machine. Used in
7702	<link to="IConsole::guest"/>.
7703
7704	IGuest provides information about the guest operating system, whether
7705	Guest Additions are installed and other OS-specific virtual machine
7706	properties.
7707	</desc>
7708
7709	<attribute name="OSTypeId" type="wstring" readonly="yes">
7710	<desc>
7711	Identifier of the Guest OS type as reported by the Guest
7712	Additions.
7713	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7714	an IGuestOSType object representing details about the given
7715	Guest OS type.
7716	<note>
7717	If Guest Additions are not installed, this value will be
7718	the same as <link to="IMachine::OSTypeId"/>.
7719	</note>
7720	</desc>
7721	</attribute>
7722
7723	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
7724	<desc>
7725	Current run level of the Guest Additions.
7726	</desc>
7727	</attribute>
7728
7729	<attribute name="additionsVersion" type="wstring" readonly="yes">
7730	<desc>
7731	Version of the Guest Additions including the revision (3 decimal numbers
7732	separated by dots + revision number) installed on the guest or empty
7733	when the Additions are not installed.
7734	</desc>
7735	</attribute>
7736
7737	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7738	<desc>
7739	Flag whether seamless guest display rendering (seamless desktop
7740	integration) is supported.
7741	</desc>
7742	</attribute>
7743
7744	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7745	<desc>
7746	Flag whether the guest is in graphics mode. If it is not, then
7747	seamless rendering will not work, resize hints are not immediately
7748	acted on and guest display resizes are probably not initiated by
7749	the guest additions.
7750	</desc>
7751	</attribute>
7752
7753	<attribute name="memoryBalloonSize" type="unsigned long">
7754	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7755	</attribute>
7756
7757	<attribute name="statisticsUpdateInterval" type="unsigned long">
7758	<desc>Interval to update guest statistics in seconds.</desc>
7759	</attribute>
7760
7761	<method name="internalGetStatistics">
7762	<desc>
7763	Internal method; do not use as it might change at any time
7764	</desc>
7765	<param name="cpuUser" type="unsigned long" dir="out">
7766	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7767	</param>
7768	<param name="cpuKernel" type="unsigned long" dir="out">
7769	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7770	</param>
7771	<param name="cpuIdle" type="unsigned long" dir="out">
7772	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7773	</param>
7774	<param name="memTotal" type="unsigned long" dir="out">
7775	<desc>Total amount of physical guest RAM</desc>
7776	</param>
7777	<param name="memFree" type="unsigned long" dir="out">
7778	<desc>Free amount of physical guest RAM</desc>
7779	</param>
7780	<param name="memBalloon" type="unsigned long" dir="out">
7781	<desc>Amount of ballooned physical guest RAM</desc>
7782	</param>
7783	<param name="memShared" type="unsigned long" dir="out">
7784	<desc>Amount of shared physical guest RAM</desc>
7785	</param>
7786	<param name="memCache" type="unsigned long" dir="out">
7787	<desc>Total amount of guest (disk) cache memory</desc>
7788	</param>
7789	<param name="pagedTotal" type="unsigned long" dir="out">
7790	<desc>Total amount of space in the page file</desc>
7791	</param>
7792	<param name="memAllocTotal" type="unsigned long" dir="out">
7793	<desc>Total amount of memory allocated by the hypervisor</desc>
7794	</param>
7795	<param name="memFreeTotal" type="unsigned long" dir="out">
7796	<desc>Total amount of free memory available in the hypervisor</desc>
7797	</param>
7798	<param name="memBalloonTotal" type="unsigned long" dir="out">
7799	<desc>Total amount of memory ballooned by the hypervisor</desc>
7800	</param>
7801	<param name="memSharedTotal" type="unsigned long" dir="out">
7802	<desc>Total amount of shared memory in the hypervisor</desc>
7803	</param>
7804	</method>
7805
7806	<method name="getAdditionsStatus">
7807	<desc>
7808	Retrieve the current status of a certain Guest Additions run level.
7809
7810	<result name="VBOX_E_NOT_SUPPORTED">
7811	Wrong status level specified.
7812	</result>
7813
7814	</desc>
7815	<param name="level" type="AdditionsRunLevelType" dir="in">
7816	<desc>Status level to check</desc>
7817	</param>
7818	<param name="active" type="boolean" dir="return">
7819	<desc>Flag whether the status level has been reached or not</desc>
7820	</param>
7821	</method>
7822
7823	<method name="setCredentials">
7824	<desc>
7825	Store login credentials that can be queried by guest operating
7826	systems with Additions installed. The credentials are transient
7827	to the session and the guest may also choose to erase them. Note
7828	that the caller cannot determine whether the guest operating system
7829	has queried or made use of the credentials.
7830
7831	<result name="VBOX_E_VM_ERROR">
7832	VMM device is not available.
7833	</result>
7834
7835	</desc>
7836	<param name="userName" type="wstring" dir="in">
7837	<desc>User name string, can be empty</desc>
7838	</param>
7839	<param name="password" type="wstring" dir="in">
7840	<desc>Password string, can be empty</desc>
7841	</param>
7842	<param name="domain" type="wstring" dir="in">
7843	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7844	</param>
7845	<param name="allowInteractiveLogon" type="boolean" dir="in">
7846	<desc>
7847	Flag whether the guest should alternatively allow the user to
7848	interactively specify different credentials. This flag might
7849	not be supported by all versions of the Additions.
7850	</desc>
7851	</param>
7852	</method>
7853
7854	<method name="executeProcess">
7855	<desc>
7856	Executes an existing program inside the guest VM.
7857
7858	<result name="VBOX_E_IPRT_ERROR">
7859	Could not execute process.
7860	</result>
7861
7862	</desc>
7863	<param name="execName" type="wstring" dir="in">
7864	<desc>
7865	Full path name of the command to execute on the guest; the
7866	commands has to exists in the guest VM in order to be executed.
7867	</desc>
7868	</param>
7869	<param name="flags" type="unsigned long" dir="in">
7870	<desc>
7871	Execution flags - currently not supported and therefore
7872	has to be set to 0.
7873	</desc>
7874	</param>
7875	<param name="arguments" type="wstring" safearray="yes" dir="in">
7876	<desc>
7877	Array of arguments passed to the execution command.
7878	</desc>
7879	</param>
7880	<param name="environment" type="wstring" safearray="yes" dir="in">
7881	<desc>
7882	Environment variables that can be set while the command is being
7883	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7884	variable just set its name ("NAME") without a value.
7885	</desc>
7886	</param>
7887	<param name="userName" type="wstring" dir="in">
7888	<desc>
7889	User name under which the command will be executed; has to exist
7890	and have the appropriate rights to execute programs in the VM.
7891	</desc>
7892	</param>
7893	<param name="password" type="wstring" dir="in">
7894	<desc>
7895	Password of the user account specified.
7896	</desc>
7897	</param>
7898	<param name="timeoutMS" type="unsigned long" dir="in">
7899	<desc>
7900	The maximum timeout value (in msec) to wait for finished program
7901	execution. Pass 0 for an infinite timeout.
7902	</desc>
7903	</param>
7904	<param name="pid" type="unsigned long" dir="out">
7905	<desc>
7906	The PID (process ID) of the started command for later reference.
7907	</desc>
7908	</param>
7909	<param name="progress" type="IProgress" dir="return">
7910	<desc>Progress object to track the operation completion.</desc>
7911	</param>
7912	</method>
7913
7914	<method name="getProcessOutput">
7915	<desc>
7916	Retrieves output of a formerly started process.
7917
7918	<result name="VBOX_E_IPRT_ERROR">
7919	Could not retrieve output.
7920	</result>
7921
7922	</desc>
7923	<param name="pid" type="unsigned long" dir="in">
7924	<desc>
7925	Process id returned by earlier executeProcess() call.
7926	</desc>
7927	</param>
7928	<param name="flags" type="unsigned long" dir="in">
7929	<desc>
7930	Flags describing which output to retrieve.
7931	</desc>
7932	</param>
7933	<param name="timeoutMS" type="unsigned long" dir="in">
7934	<desc>
7935	The maximum timeout value (in msec) to wait for output
7936	data. Pass 0 for an infinite timeout.
7937	</desc>
7938	</param>
7939	<param name="size" type="long long" dir="in">
7940	<desc>
7941	Size in bytes to read in the buffer.
7942	</desc>
7943	</param>
7944	<param name="data" type="octet" dir="return" safearray="yes">
7945	<desc>
7946	Buffer for retrieving the actual output. A data size of 0 means end of file
7947	if the requested size was not 0. This is the unprocessed
7948	output data, i.e. the line ending style depends on the platform of
7949	the system the server is running on.
7950	</desc>
7951	</param>
7952	</method>
7953
7954	<method name="getProcessStatus">
7955	<desc>
7956	Retrieves status, exit code and the exit reason of a formerly started process.
7957
7958	<result name="VBOX_E_IPRT_ERROR">
7959	Process with specified PID was not found.
7960	</result>
7961
7962	</desc>
7963	<param name="pid" type="unsigned long" dir="in">
7964	<desc>
7965	Process id returned by earlier executeProcess() call.
7966	</desc>
7967	</param>
7968	<param name="exitcode" type="unsigned long" dir="out">
7969	<desc>
7970	The exit code (if available).
7971	</desc>
7972	</param>
7973	<param name="flags" type="unsigned long" dir="out">
7974	<desc>
7975	Additional flags of process status (not used at the moment).
7976	</desc>
7977	</param>
7978	<param name="reason" type="unsigned long" dir="return">
7979	<desc>
7980	The current process status.
7981	</desc>
7982	</param>
7983	</method>
7984
7985	<method name="copyToGuest">
7986	<desc>
7987	Copies files/directories from host to the guest.
7988
7989	<result name="VBOX_E_IPRT_ERROR">
7990	Error while copying.
7991	</result>
7992
7993	</desc>
7994	<param name="source" type="wstring" dir="in">
7995	<desc>
7996	Source file on the host to copy.
7997	</desc>
7998	</param>
7999	<param name="dest" type="wstring" dir="in">
8000	<desc>
8001	Destination path on the guest.
8002	</desc>
8003	</param>
8004	<param name="userName" type="wstring" dir="in">
8005	<desc>
8006	User name under which the copy command will be executed; the
8007	user has to exist and have the appropriate rights to write to
8008	the destination path.
8009	</desc>
8010	</param>
8011	<param name="password" type="wstring" dir="in">
8012	<desc>
8013	Password of the user account specified.
8014	</desc>
8015	</param>
8016	<param name="flags" type="unsigned long" dir="in">
8017	<desc>
8018	Copy flags.
8019	</desc>
8020	</param>
8021	<param name="progress" type="IProgress" dir="return">
8022	<desc>Progress object to track the operation completion.</desc>
8023	</param>
8024	</method>
8025
8026	<method name="setProcessInput">
8027	<desc>
8028	Sends input into a formerly started process.
8029
8030	<result name="VBOX_E_IPRT_ERROR">
8031	Could not send input.
8032	</result>
8033
8034	</desc>
8035	<param name="pid" type="unsigned long" dir="in">
8036	<desc>
8037	Process id returned by earlier executeProcess() call.
8038	</desc>
8039	</param>
8040	<param name="flags" type="unsigned long" dir="in">
8041	<desc>
8042	Not used, must be set to zero.
8043	</desc>
8044	</param>
8045	<param name="data" type="octet" dir="in" safearray="yes">
8046	<desc>
8047	Buffer of input data to send to the started process to.
8048	</desc>
8049	</param>
8050	<param name="written" type="unsigned long" dir="return">
8051	<desc>
8052	Number of bytes written.
8053	</desc>
8054	</param>
8055	</method>
8056
8057	<method name="updateGuestAdditions">
8058	<desc>
8059	Updates already installed Guest Additions in a VM
8060	(Windows guests only).
8061
8062	<result name="VBOX_E_IPRT_ERROR">
8063	Error while updating.
8064	</result>
8065
8066	</desc>
8067	<param name="source" type="wstring" dir="in">
8068	<desc>
8069	Path to the Guest Additions .ISO file to use for the upate.
8070	</desc>
8071	</param>
8072	<param name="progress" type="IProgress" dir="return">
8073	<desc>Progress object to track the operation completion.</desc>
8074	</param>
8075	</method>
8076
8077	</interface>
8078
8079
8080	<!--
8081	// IProgress
8082	/////////////////////////////////////////////////////////////////////////
8083	-->
8084
8085	<interface
8086	name="IProgress" extends="$unknown"
8087	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8088	wsmap="managed"
8089	>
8090	<desc>
8091	The IProgress interface is used to track and control
8092	asynchronous tasks within VirtualBox.
8093
8094	An instance of this is returned every time VirtualBox starts
8095	an asynchronous task (in other words, a separate thread) which
8096	continues to run after a method call returns. For example,
8097	<link to="IConsole::saveState" />, which saves the state of
8098	a running virtual machine, can take a long time to complete.
8099	To be able to display a progress bar, a user interface such as
8100	the VirtualBox graphical user interface can use the IProgress
8101	object returned by that method.
8102
8103	Note that IProgress is a "read-only" interface in the sense
8104	that only the VirtualBox internals behind the Main API can
8105	create and manipulate progress objects, whereas client code
8106	can only use the IProgress object to monitor a task's
8107	progress and, if <link to="#cancelable" /> is @c true,
8108	cancel the task by calling <link to="#cancel" />.
8109
8110	A task represented by IProgress consists of either one or
8111	several sub-operations that run sequentially, one by one (see
8112	<link to="#operation" /> and <link to="#operationCount" />).
8113	Every operation is identified by a number (starting from 0)
8114	and has a separate description.
8115
8116	You can find the individual percentage of completion of the current
8117	operation in <link to="#operationPercent" /> and the
8118	percentage of completion of the task as a whole
8119	in <link to="#percent" />.
8120
8121	Similarly, you can wait for the completion of a particular
8122	operation via <link to="#waitForOperationCompletion" /> or
8123	for the completion of the whole task via
8124	<link to="#waitForCompletion" />.
8125	</desc>
8126
8127	<attribute name="id" type="uuid" mod="string" readonly="yes">
8128	<desc>ID of the task.</desc>
8129	</attribute>
8130
8131	<attribute name="description" type="wstring" readonly="yes">
8132	<desc>Description of the task.</desc>
8133	</attribute>
8134
8135	<attribute name="initiator" type="$unknown" readonly="yes">
8136	<desc>Initiator of the task.</desc>
8137	</attribute>
8138
8139	<attribute name="cancelable" type="boolean" readonly="yes">
8140	<desc>Whether the task can be interrupted.</desc>
8141	</attribute>
8142
8143	<attribute name="percent" type="unsigned long" readonly="yes">
8144	<desc>
8145	Current progress value of the task as a whole, in percent.
8146	This value depends on how many operations are already complete.
8147	Returns 100 if <link to="#completed" /> is @c true.
8148	</desc>
8149	</attribute>
8150
8151	<attribute name="timeRemaining" type="long" readonly="yes">
8152	<desc>
8153	Estimated remaining time until the task completes, in
8154	seconds. Returns 0 once the task has completed; returns -1
8155	if the remaining time cannot be computed, in particular if
8156	the current progress is 0.
8157
8158	Even if a value is returned, the estimate will be unreliable
8159	for low progress values. It will become more reliable as the
8160	task progresses; it is not recommended to display an ETA
8161	before at least 20% of a task have completed.
8162	</desc>
8163	</attribute>
8164
8165	<attribute name="completed" type="boolean" readonly="yes">
8166	<desc>Whether the task has been completed.</desc>
8167	</attribute>
8168
8169	<attribute name="canceled" type="boolean" readonly="yes">
8170	<desc>Whether the task has been canceled.</desc>
8171	</attribute>
8172
8173	<attribute name="resultCode" type="long" readonly="yes">
8174	<desc>
8175	Result code of the progress task.
8176	Valid only if <link to="#completed"/> is @c true.
8177	</desc>
8178	</attribute>
8179
8180	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8181	<desc>
8182	Extended information about the unsuccessful result of the
8183	progress operation. May be @c null if no extended information
8184	is available.
8185	Valid only if <link to="#completed"/> is @c true and
8186	<link to="#resultCode"/> indicates a failure.
8187	</desc>
8188	</attribute>
8189
8190	<attribute name="operationCount" type="unsigned long" readonly="yes">
8191	<desc>
8192	Number of sub-operations this task is divided into.
8193	Every task consists of at least one suboperation.
8194	</desc>
8195	</attribute>
8196
8197	<attribute name="operation" type="unsigned long" readonly="yes">
8198	<desc>Number of the sub-operation being currently executed.</desc>
8199	</attribute>
8200
8201	<attribute name="operationDescription" type="wstring" readonly="yes">
8202	<desc>
8203	Description of the sub-operation being currently executed.
8204	</desc>
8205	</attribute>
8206
8207	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8208	<desc>Progress value of the current sub-operation only, in percent.</desc>
8209	</attribute>
8210
8211	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8212	<desc>Weight value of the current sub-operation only.</desc>
8213	</attribute>
8214
8215	<attribute name="timeout" type="unsigned long">
8216	<desc>
8217	When non-zero, this specifies the number of milliseconds after which
8218	the operation will automatically be canceled. This can only be set on
8219	cancelable objects.
8220	</desc>
8221	</attribute>
8222
8223	<method name="setCurrentOperationProgress">
8224	<desc>Internal method, not to be called externally.</desc>
8225	<param name="percent" type="unsigned long" dir="in" />
8226	</method>
8227	<method name="setNextOperation">
8228	<desc>Internal method, not to be called externally.</desc>
8229	<param name="nextOperationDescription" type="wstring" dir="in" />
8230	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8231	</method>
8232
8233	<method name="waitForCompletion">
8234	<desc>
8235	Waits until the task is done (including all sub-operations)
8236	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8237
8238	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8239	thread are not processed while waiting. Neglecting event queues may
8240	have dire consequences (degrade performance, resource hogs,
8241	deadlocks, etc.), this is specially so for the main thread on
8242	platforms using XPCOM. Callers are adviced wait for short periods
8243	and service their event queues between calls, or to create a worker
8244	thread to do the waiting.
8245
8246	<result name="VBOX_E_IPRT_ERROR">
8247	Failed to wait for task completion.
8248	</result>
8249	</desc>
8250
8251	<param name="timeout" type="long" dir="in">
8252	<desc>
8253	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8254	</desc>
8255	</param>
8256	</method>
8257
8258	<method name="waitForOperationCompletion">
8259	<desc>
8260	Waits until the given operation is done with a given timeout in
8261	milliseconds; specify -1 for an indefinite wait.
8262
8263	See <link to="#waitForCompletion"> for event queue considerations.</link>
8264
8265	<result name="VBOX_E_IPRT_ERROR">
8266	Failed to wait for operation completion.
8267	</result>
8268
8269	</desc>
8270	<param name="operation" type="unsigned long" dir="in">
8271	<desc>
8272	Number of the operation to wait for.
8273	Must be less than <link to="#operationCount"/>.
8274	</desc>
8275	</param>
8276	<param name="timeout" type="long" dir="in">
8277	<desc>
8278	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8279	</desc>
8280	</param>
8281	</method>
8282
8283	<method name="cancel">
8284	<desc>
8285	Cancels the task.
8286	<note>
8287	If <link to="#cancelable"/> is @c false, then this method will fail.
8288	</note>
8289
8290	<result name="VBOX_E_INVALID_OBJECT_STATE">
8291	Operation cannot be canceled.
8292	</result>
8293
8294	</desc>
8295	</method>
8296
8297	</interface>
8298
8299	<!--
8300	// ISnapshot
8301	/////////////////////////////////////////////////////////////////////////
8302	-->
8303
8304	<interface
8305	name="ISnapshot" extends="$unknown"
8306	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8307	wsmap="managed"
8308	>
8309	<desc>
8310	The ISnapshot interface represents a snapshot of the virtual
8311	machine.
8312
8313	Together with the differencing media that are created
8314	when a snapshot is taken, a machine can be brought back to
8315	the exact state it was in when the snapshot was taken.
8316
8317	The ISnapshot interface has no methods, only attributes; snapshots
8318	are controlled through methods of the <link to="IConsole" /> interface
8319	which also manage the media associated with the snapshot.
8320	The following operations exist:
8321
8322	<ul>
8323	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8324	by creating new, empty differencing images for the machine's
8325	media and saving the VM settings and (if the VM is running)
8326	the current VM state in the snapshot.
8327
8328	The differencing images will then receive all data written to
8329	the machine's media, while their parent (base) images
8330	remain unmodified after the snapshot has been taken (see
8331	<link to="IMedium" /> for details about differencing images).
8332	This simplifies restoring a machine to the state of a snapshot:
8333	only the differencing images need to be deleted.
8334
8335	The current machine state is not changed by taking a snapshot.
8336	If the machine is running, it will resume execution after the
8337	snapshot has been taken. After calling this,
8338	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8339	just created.
8340	</li>
8341
8342	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8343	the state of a previous snapshot by deleting the differencing
8344	image of each of the machine's media and setting the machine's
8345	settings and state to the state that was saved in the snapshot (if any).
8346
8347	This destroys the machine's current state. After calling this,
8348	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8349	restored.
8350	</li>
8351
8352	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8353	without affecting the current machine state.
8354
8355	This does not change the current machine state, but instead frees the
8356	resources allocated when the snapshot was taken: the settings and machine
8357	state file are deleted (if any), and the snapshot's differencing image for
8358	each of the machine's media gets merged with its parent image.
8359
8360	Neither the current machine state nor other snapshots are affected
8361	by this operation, except that parent media will be modified
8362	to contain the disk data associated with the snapshot being deleted.
8363
8364	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8365	attribute is set to the current snapshot's parent or NULL if it
8366	has no parent. Otherwise the attribute is unchanged.
8367	</li>
8368	</ul>
8369
8370	Each snapshot contains the settings of the virtual machine (hardware
8371	configuration etc.). In addition, if the machine was running when the
8372	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8373	the current VM state is saved in the snapshot (similarly to what happens
8374	when a VM's state is saved). The snapshot is then said to
8375	be <i>online</i> because when restoring it, the VM will be running.
8376
8377	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8378	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8379
8380	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8381	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8382	it then contains a so-called "zero execution state", representing a
8383	machine that is powered off.
8384	</desc>
8385
8386	<attribute name="id" type="uuid" mod="string" readonly="yes">
8387	<desc>UUID of the snapshot.</desc>
8388	</attribute>
8389
8390	<attribute name="name" type="wstring">
8391	<desc>Short name of the snapshot.</desc>
8392	</attribute>
8393
8394	<attribute name="description" type="wstring">
8395	<desc>Optional description of the snapshot.</desc>
8396	</attribute>
8397
8398	<attribute name="timeStamp" type="long long" readonly="yes">
8399	<desc>
8400	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8401	</desc>
8402	</attribute>
8403
8404	<attribute name="online" type="boolean" readonly="yes">
8405	<desc>
8406	@c true if this snapshot is an online snapshot and @c false otherwise.
8407
8408	When this attribute is @c true, the
8409	<link to="IMachine::stateFilePath"/> attribute of the
8410	<link to="#machine"/> object associated with this snapshot
8411	will point to the saved state file. Otherwise, it will be
8412	an empty string.
8413	</desc>
8414	</attribute>
8415
8416	<attribute name="machine" type="IMachine" readonly="yes">
8417	<desc>
8418	Virtual machine this snapshot is taken on. This object
8419	stores all settings the machine had when taking this snapshot.
8420	<note>
8421	The returned machine object is immutable, i.e. no
8422	any settings can be changed.
8423	</note>
8424	</desc>
8425	</attribute>
8426
8427	<attribute name="parent" type="ISnapshot" readonly="yes">
8428	<desc>
8429	Parent snapshot (a snapshot this one is based on), or
8430	@c null if the snapshot has no parent (i.e. is the first snapshot).
8431	</desc>
8432	</attribute>
8433
8434	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8435	<desc>
8436	Child snapshots (all snapshots having this one as a parent).
8437	</desc>
8438	</attribute>
8439
8440	</interface>
8441
8442
8443	<!--
8444	// IMedium
8445	/////////////////////////////////////////////////////////////////////////
8446	-->
8447
8448	<enum
8449	name="MediumState"
8450	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8451	>
8452	<desc>
8453	Virtual medium state.
8454	<see>IMedium</see>
8455	</desc>
8456
8457	<const name="NotCreated" value="0">
8458	<desc>
8459	Associated medium storage does not exist (either was not created yet or
8460	was deleted).
8461	</desc>
8462	</const>
8463	<const name="Created" value="1">
8464	<desc>
8465	Associated storage exists and accessible; this gets set if the
8466	accessibility check performed by <link to="IMedium::refreshState" />
8467	was successful.
8468	</desc>
8469	</const>
8470	<const name="LockedRead" value="2">
8471	<desc>
8472	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8473	no data modification is possible.
8474	</desc>
8475	</const>
8476	<const name="LockedWrite" value="3">
8477	<desc>
8478	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8479	no concurrent data reading or modification is possible.
8480	</desc>
8481	</const>
8482	<const name="Inaccessible" value="4">
8483	<desc>
8484	Medium accessiblity check (see <link to="IMedium::refreshState" />) has
8485	not yet been performed, or else, associated medium storage is not
8486	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8487	is empty, in the second case, it describes the error that occured.
8488	</desc>
8489	</const>
8490	<const name="Creating" value="5">
8491	<desc>
8492	Associated medium storage is being created.
8493	</desc>
8494	</const>
8495	<const name="Deleting" value="6">
8496	<desc>
8497	Associated medium storage is being deleted.
8498	</desc>
8499	</const>
8500	</enum>
8501
8502	<enum
8503	name="MediumType"
8504	uuid="19388a99-8e70-4bd4-9a95-90cbc513ef6d"
8505	>
8506	<desc>
8507	Virtual medium type.
8508	<see>IMedium</see>
8509	</desc>
8510
8511	<const name="Normal" value="0">
8512	<desc>
8513	Normal medium (attached directly or indirectly, preserved
8514	when taking snapshots).
8515	</desc>
8516	</const>
8517	<const name="Immutable" value="1">
8518	<desc>
8519	Immutable medium (attached indirectly, changes are wiped out
8520	the next time the virtual machine is started).
8521	</desc>
8522	</const>
8523	<const name="Writethrough" value="2">
8524	<desc>
8525	Write through medium (attached directly, ignored when
8526	taking snapshots).
8527	</desc>
8528	</const>
8529	<const name="Shareable" value="3">
8530	<desc>
8531	Allow using this medium concurrently by several machines.
8532	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8533	</desc>
8534	</const>
8535	<const name="Readonly" value="4">
8536	<desc>
8537	A readonly medium, which can of course be used by several machines.
8538	<note>Present and accepted since VirtualBox 4.0.</note>
8539	</desc>
8540	</const>
8541	</enum>
8542
8543	<enum
8544	name="MediumVariant"
8545	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8546	>
8547	<desc>
8548	Virtual medium image variant. More than one flag may be set.
8549	<see>IMedium</see>
8550	</desc>
8551
8552	<const name="Standard" value="0">
8553	<desc>
8554	No particular variant requested, results in using the backend default.
8555	</desc>
8556	</const>
8557	<const name="VmdkSplit2G" value="0x01">
8558	<desc>
8559	VMDK image split in chunks of less than 2GByte.
8560	</desc>
8561	</const>
8562	<const name="VmdkStreamOptimized" value="0x04">
8563	<desc>
8564	VMDK streamOptimized image. Special import/export format which is
8565	read-only/append-only.
8566	</desc>
8567	</const>
8568	<const name="VmdkESX" value="0x08">
8569	<desc>
8570	VMDK format variant used on ESX products.
8571	</desc>
8572	</const>
8573	<const name="Fixed" value="0x10000">
8574	<desc>
8575	Fixed image. Only allowed for base images.
8576	</desc>
8577	</const>
8578	<const name="Diff" value="0x20000">
8579	<desc>
8580	Differencing image. Only allowed for child images.
8581	</desc>
8582	</const>
8583	</enum>
8584
8585	<interface
8586	name="IMediumAttachment" extends="$unknown"
8587	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8588	wsmap="struct"
8589	>
8590	<desc>
8591	The IMediumAttachment interface links storage media to virtual machines.
8592	For each medium (<link to="IMedium"/>) which has been attached to a
8593	storage controller (<link to="IStorageController"/>) of a machine
8594	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8595	method, one instance of IMediumAttachment is added to the machine's
8596	<link to="IMachine::mediumAttachments"/> array attribute.
8597
8598	Each medium attachment specifies the storage controller as well as a
8599	port and device number and the IMedium instance representing a virtual
8600	hard disk or floppy or DVD image.
8601
8602	For removeable media (DVDs or floppies), there are two additional
8603	options. For one, the IMedium instance can be @c null to represent
8604	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8605	secondly, the medium can be one of the pseudo-media for host drives
8606	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8607	</desc>
8608
8609	<attribute name="medium" type="IMedium" readonly="yes">
8610	<desc>Medium object associated with this attachment; it
8611	can be @c null for removable devices.</desc>
8612	</attribute>
8613
8614	<attribute name="controller" type="wstring" readonly="yes">
8615	<desc>Name of the storage controller of this attachment; this
8616	refers to one of the controllers in <link to="IMachine::storageControllers" />
8617	by name.</desc>
8618	</attribute>
8619
8620	<attribute name="port" type="long" readonly="yes">
8621	<desc>Port number of this attachment.
8622	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8623	</desc>
8624	</attribute>
8625
8626	<attribute name="device" type="long" readonly="yes">
8627	<desc>Device slot number of this attachment.
8628	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8629	</desc>
8630	</attribute>
8631
8632	<attribute name="type" type="DeviceType" readonly="yes">
8633	<desc>Device type of this attachment.</desc>
8634	</attribute>
8635
8636	<attribute name="passthrough" type="boolean" readonly="yes">
8637	<desc>Pass I/O requests through to a device on the host.</desc>
8638	</attribute>
8639
8640	<attribute name="bandwidthLimit" type="unsigned long">
8641	<desc>
8642	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8643	A zero value means uncapped/unlimited.
8644	</desc>
8645	</attribute>
8646
8647	</interface>
8648
8649	<interface
8650	name="IMedium" extends="$unknown"
8651	uuid="bfcf5b8c-5155-4f24-9414-9457054b16db"
8652	wsmap="managed"
8653	>
8654	<desc>
8655	The IMedium interface represents virtual storage for a machine's
8656	hard disks, CD/DVD or floppy drives. It will typically represent
8657	a disk image on the host, for example a VDI or VMDK file representing
8658	a virtual hard disk, or an ISO or RAW file representing virtual
8659	removable media, but can also point to a network location (e.g.
8660	for iSCSI targets).
8661
8662	Instances of IMedium are connected to virtual machines by way of
8663	medium attachments (see <link to="IMediumAttachment" />), which link
8664	the storage medium to a particular device slot of a storage controller
8665	of the virtual machine.
8666	In the VirtualBox API, virtual storage is therefore always represented
8667	by the following chain of object links:
8668
8669	<ul>
8670	<li><link to="IMachine::storageControllers"/> contains an array of
8671	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8672	these are instances of <link to="IStorageController"/>).</li>
8673	<li><link to="IMachine::mediumAttachments"/> contains an array of
8674	medium attachments (instances of <link to="IMediumAttachment"/>),
8675	each containing a storage controller from the above array, a
8676	port/device specification, and an instance of IMedium representing
8677	the medium storage (image file).
8678
8679	For removable media, the storage medium is optional; a medium
8680	attachment with no medium represents a CD/DVD or floppy drive
8681	with no medium inserted. By contrast, hard disk attachments
8682	will always have an IMedium object attached.</li>
8683	<li>Each IMedium in turn points to a storage unit (such as a file
8684	on the host computer or a network resource) that holds actual
8685	data. This location is represented by the <link to="#location"/>
8686	attribute.</li>
8687	</ul>
8688
8689	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8690	new hard disk media can be created with the VirtualBox API using the
8691	<link to="IVirtualBox::createHardDisk"/> method.
8692
8693	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8694	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8695	type in a regular file.
8696
8697	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8698	drive; in that case the <link to="#id" /> attribute contains the UUID of
8699	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8700
8701	<h3>Known media</h3>
8702
8703	When an existing medium is opened and attached to a virtual machine, it
8704	is automatically added to a media registry. If the medium has first
8705	been attached to a machine which was created by VirtualBox 4.0 or later,
8706	it is added to that machine's media registry (in the machine XML settings
8707	file; this way all information about a machine's media attachments is
8708	contained in a single file). For older media attachments (i.e. if the
8709	medium was first attached to a machine which was created with a VirtualBox
8710	version before 4.0), media continue to be registered in the global
8711	VirtualBox settings file, for backwards compatibility.
8712
8713	See <link to="IVirtualBox::openMedium" /> for more information.
8714
8715	All known media can be enumerated using
8716	<link to="IVirtualBox::hardDisks"/>,
8717	<link to="IVirtualBox::DVDImages"/> and
8718	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8719	quickly found using the <link to="IVirtualBox::findMedium"/> method.
8720
8721	Only known media can be attached to virtual machines.
8722
8723	Removing known media from the media registry is performed when the given
8724	medium is closed using the <link to="#close"/> method or when its
8725	associated storage unit is deleted.
8726
8727	<h3>Accessibility checks</h3>
8728
8729	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8730	method is called explicitly on a medium. This is done to make the VirtualBox object
8731	ready for serving requests as fast as possible and let the end-user
8732	application decide if it needs to check media accessibility right away or not.
8733
8734	As a result, when VirtualBox starts up (e.g. the VirtualBox
8735	object gets created for the first time), all known media are in the
8736	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8737	attribute is an empty string because no actual accessibility check has
8738	been made yet.
8739
8740	After calling <link to="#refreshState" />, a medium is considered
8741	<i>accessible</i> if its storage unit can be read. In that case, the
8742	<link to="#state"/> attribute has a value of "Created". If the storage
8743	unit cannot be read (for example, because it is located on a disconnected
8744	network resource, or was accidentally deleted outside VirtualBox),
8745	the medium is considered <i>inaccessible</i>, which is indicated by the
8746	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8747	obtained by reading the <link to="#lastAccessError"/> attribute.
8748
8749	<h3>Medium types</h3>
8750
8751	There are four types of medium behavior (see <link to="MediumType" />):
8752	"normal", "immutable", "writethrough" and "shareable", represented by the
8753	<link to="#type"/> attribute. The type of the medium defines how the
8754	medium is attached to a virtual machine and what happens when a
8755	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8756	attached medium is taken. At the moment DVD and floppy media are always
8757	of type "writethrough".
8758
8759	All media can be also divided in two groups: <i>base</i> media and
8760	<i>differencing</i> media. A base medium contains all sectors of the
8761	medium data in its own storage and therefore can be used independently.
8762	In contrast, a differencing mediun is a "delta" to some other medium and
8763	contains only those sectors which differ from that other medium, which is
8764	then called a <i>parent</i>. The differencing medium is said to be
8765	<i>linked to</i> that parent. The parent may be itself a differencing
8766	medium, thus forming a chain of linked media. The last element in that
8767	chain must always be a base medium. Note that several differencing
8768	media may be linked to the same parent medium.
8769
8770	Differencing media can be distinguished from base media by querying the
8771	<link to="#parent"/> attribute: base media do not have parents they would
8772	depend on, so the value of this attribute is always @c null for them.
8773	Using this attribute, it is possible to walk up the medium tree (from the
8774	child medium to its parent). It is also possible to walk down the tree
8775	using the <link to="#children"/> attribute.
8776
8777	Note that the type of all differencing media is "normal"; all other
8778	values are meaningless for them. Base media may be of any type.
8779
8780	<h3>Creating hard disks</h3>
8781
8782	New base hard disks are created using
8783	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8784	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
8785	disks are usually implicitly created by VirtualBox when needed but may
8786	also be created explicitly using <link to="#createDiffStorage"/>.
8787
8788	After the hard disk is successfully created (including the storage unit)
8789	or opened, it becomes a known hard disk (remembered in the internal media
8790	registry). Known hard disks can be attached to a virtual machine, accessed
8791	through <link to="IVirtualBox::findMedium"/> or enumerated using the
8792	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8793
8794	The following methods, besides <link to="IMedium::close"/>,
8795	automatically remove the hard disk from the media registry:
8796	<ul>
8797	<li><link to="#deleteStorage"/></li>
8798	<li><link to="#mergeTo"/></li>
8799	</ul>
8800
8801	If the storage unit of the hard disk is a regular file in the host's
8802	file system then the rules stated in the description of the
8803	<link to="IMedium::location"/> attribute apply when setting its value.
8804
8805	<h4>Automatic composition of the file name part</h4>
8806
8807	Another extension to the <link to="IMedium::location"/> attribute is that
8808	there is a possibility to cause VirtualBox to compose a unique value for
8809	the file name part of the location using the UUID of the hard disk. This
8810	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8811	e.g. before the storage unit is created, and works as follows. You set the
8812	value of the <link to="IMedium::location"/> attribute to a location
8813	specification which only contains the path specification but not the file
8814	name part and ends with either a forward slash or a backslash character.
8815	In response, VirtualBox will generate a new UUID for the hard disk and
8816	compose the file name using the following pattern:
8817	<pre>
8818	<path>/{<uuid>}.<ext>
8819	</pre>
8820	where <tt><path></tt> is the supplied path specification,
8821	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8822	is the default extension for the storage format of this hard disk. After
8823	that, you may call any of the methods that create a new hard disk storage
8824	unit and they will use the generated UUID and file name.
8825
8826	<h3>Attaching Hard Disks</h3>
8827
8828	Hard disks are attached to virtual machines using the
8829	<link to="IMachine::attachDevice"/> method and detached using the
8830	<link to="IMachine::detachDevice"/> method. Depending on their
8831	<link to="#type"/>, hard disks are attached either
8832	<i>directly</i> or <i>indirectly</i>.
8833
8834	When a hard disk is being attached directly, it is associated with the
8835	virtual machine and used for hard disk operations when the machine is
8836	running. When a hard disk is being attached indirectly, a new differencing
8837	hard disk linked to it is implicitly created and this differencing hard
8838	disk is associated with the machine and used for hard disk operations.
8839	This also means that if <link to="IMachine::attachDevice"/> performs
8840	a direct attachment then the same hard disk will be returned in response
8841	to the subsequent <link to="IMachine::getMedium"/> call; however if
8842	an indirect attachment is performed then
8843	<link to="IMachine::getMedium"/> will return the implicitly created
8844	differencing hard disk, not the original one passed to <link
8845	to="IMachine::attachDevice"/>. In detail:
8846
8847	<ul>
8848	<li><b>Normal base</b> hard disks that do not have children (i.e.
8849	differencing hard disks linked to them) and that are not already
8850	attached to virtual machines in snapshots are attached <b>directly</b>.
8851	Otherwise, they are attached <b>indirectly</b> because having
8852	dependent children or being part of the snapshot makes it impossible
8853	to modify hard disk contents without breaking the integrity of the
8854	dependent party. The <link to="#readOnly"/> attribute allows to
8855	quickly determine the kind of the attachment for the given hard
8856	disk. Note that if a normal base hard disk is to be indirectly
8857	attached to a virtual machine with snapshots then a special
8858	procedure called <i>smart attachment</i> is performed (see below).</li>
8859	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8860	they are attached <b>directly</b> if they do not have children and are
8861	not attached to virtual machines in snapshots, and <b>indirectly</b>
8862	otherwise. Note that the smart attachment procedure is never performed
8863	for differencing hard disks.</li>
8864	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8865	they are designed to be non-writable. If an immutable hard disk is
8866	attached to a virtual machine with snapshots then a special
8867	procedure called smart attachment is performed (see below).</li>
8868	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8869	also as designed. This also means that writethrough hard disks cannot
8870	have other hard disks linked to them at all.</li>
8871	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
8872	also as designed. This also means that shareable hard disks cannot
8873	have other hard disks linked to them at all. They behave almost
8874	like writethrough hard disks, except that shareable hard disks can
8875	be attached to several virtual machines which are running, allowing
8876	concurrent accesses. You need special cluster software running in
8877	the virtual machines to make use of such disks.</li>
8878	</ul>
8879
8880	Note that the same hard disk, regardless of its type, may be attached to
8881	more than one virtual machine at a time. In this case, the machine that is
8882	started first gains exclusive access to the hard disk and attempts to
8883	start other machines having this hard disk attached will fail until the
8884	first machine is powered down.
8885
8886	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8887	that the given hard disk remains associated with the given machine after a
8888	successful <link to="IMachine::detachDevice"/> call until
8889	<link to="IMachine::saveSettings"/> is called to save all changes to
8890	machine settings to disk. This deferring is necessary to guarantee that
8891	the hard disk configuration may be restored at any time by a call to
8892	<link to="IMachine::discardSettings"/> before the settings
8893	are saved (committed).
8894
8895	Note that if <link to="IMachine::discardSettings"/> is called after
8896	indirectly attaching some hard disks to the machine but before a call to
8897	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8898	all differencing hard disks implicitly created by
8899	<link to="IMachine::attachDevice"/> for these indirect attachments.
8900	Such implicitly created hard disks will also be immediately deleted when
8901	detached explicitly using the <link to="IMachine::detachDevice"/>
8902	call if it is made before <link to="IMachine::saveSettings"/>. This
8903	implicit deletion is safe because newly created differencing hard
8904	disks do not contain any user data.
8905
8906	However, keep in mind that detaching differencing hard disks that were
8907	implicitly created by <link to="IMachine::attachDevice"/>
8908	before the last <link to="IMachine::saveSettings"/> call will
8909	<b>not</b> implicitly delete them as they may already contain some data
8910	(for example, as a result of virtual machine execution). If these hard
8911	disks are no more necessary, the caller can always delete them explicitly
8912	using <link to="#deleteStorage"/> after they are actually de-associated
8913	from this machine by the <link to="IMachine::saveSettings"/> call.
8914
8915	<h3>Smart Attachment</h3>
8916
8917	When normal base or immutable hard disks are indirectly attached to a
8918	virtual machine then some additional steps are performed to make sure the
8919	virtual machine will have the most recent "view" of the hard disk being
8920	attached. These steps include walking through the machine's snapshots
8921	starting from the current one and going through ancestors up to the first
8922	snapshot. Hard disks attached to the virtual machine in all
8923	of the encountered snapshots are checked whether they are descendants of
8924	the given normal base or immutable hard disk. The first found child (which
8925	is the differencing hard disk) will be used instead of the normal base or
8926	immutable hard disk as a parent for creating a new differencing hard disk
8927	that will be actually attached to the machine. And only if no descendants
8928	are found or if the virtual machine does not have any snapshots then the
8929	normal base or immutable hard disk will be used itself as a parent for
8930	this differencing hard disk.
8931
8932	It is easier to explain what smart attachment does using the
8933	following example:
8934	<pre>
8935	BEFORE attaching B.vdi: AFTER attaching B.vdi:
8936
8937	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
8938	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
8939	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
8940	Snapshot 4 (none) Snapshot 4 (none)
8941	CurState (none) CurState (D3->D2.vdi)
8942
8943	NOT
8944	...
8945	CurState (D3->B.vdi)
8946	</pre>
8947	The first column is the virtual machine configuration before the base hard
8948	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
8949	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
8950	mean that the hard disk that is actually attached to the machine is a
8951	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
8952	another hard disk, <tt>B.vdi</tt>.
8953
8954	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
8955	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
8956	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
8957	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
8958	it cannot be attached directly and needs an indirect attachment (i.e.
8959	implicit creation of a new differencing hard disk). Due to the smart
8960	attachment procedure, the new differencing hard disk
8961	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
8962	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
8963	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
8964	machine.
8965
8966	Note that if there is more than one descendant hard disk of the given base
8967	hard disk found in a snapshot, and there is an exact device, channel and
8968	bus match, then this exact match will be used. Otherwise, the youngest
8969	descendant will be picked up.
8970
8971	There is one more important aspect of the smart attachment procedure which
8972	is not related to snapshots at all. Before walking through the snapshots
8973	as described above, the backup copy of the current list of hard disk
8974	attachment is searched for descendants. This backup copy is created when
8975	the hard disk configuration is changed for the first time after the last
8976	<link to="IMachine::saveSettings"/> call and used by
8977	<link to="IMachine::discardSettings"/> to undo the recent hard disk
8978	changes. When such a descendant is found in this backup copy, it will be
8979	simply re-attached back, without creating a new differencing hard disk for
8980	it. This optimization is necessary to make it possible to re-attach the
8981	base or immutable hard disk to a different bus, channel or device slot
8982	without losing the contents of the differencing hard disk actually
8983	attached to the machine in place of it.
8984	</desc>
8985
8986	<attribute name="id" type="uuid" mod="string" readonly="yes">
8987	<desc>
8988	UUID of the medium. For a newly created medium, this value is a randomly
8989	generated UUID.
8990
8991	<note>
8992	For media in one of MediumState_NotCreated, MediumState_Creating or
8993	MediumState_Deleting states, the value of this property is undefined
8994	and will most likely be an empty UUID.
8995	</note>
8996	</desc>
8997	</attribute>
8998
8999	<attribute name="description" type="wstring">
9000	<desc>
9001	Optional description of the medium. For a newly created medium the value
9002	of this attribute is an empty string.
9003
9004	Medium types that don't support this attribute will return E_NOTIMPL in
9005	attempt to get or set this attribute's value.
9006
9007	<note>
9008	For some storage types, reading this attribute may return an outdated
9009	(last known) value when <link to="#state"/> is <link
9010	to="MediumState_Inaccessible"/> or <link
9011	to="MediumState_LockedWrite"/> because the value of this attribute is
9012	stored within the storage unit itself. Also note that changing the
9013	attribute value is not possible in such case, as well as when the
9014	medium is the <link to="MediumState_LockedRead"/> state.
9015	</note>
9016	</desc>
9017	</attribute>
9018
9019	<attribute name="state" type="MediumState" readonly="yes">
9020	<desc>
9021	Returns the current medium state, which is the last state set by
9022	the accessibility check performed by <link to="#refreshState"/>.
9023	If that method has not yet been called on the medium, the state
9024	is "Inaccessible"; as opposed to truly inaccessible media, the
9025	value of <link to="#lastAccessError"/> will be an empty string in
9026	that case.
9027
9028	<note>As of version 3.1, this no longer performs an accessibility check
9029	automatically; call <link to="#refreshState"/> for that.
9030	</note>
9031	</desc>
9032	</attribute>
9033
9034	<attribute name="variant" type="MediumVariant" readonly="yes">
9035	<desc>
9036	Returns the storage format variant information for this medium.
9037	Before <link to="#refreshState"/> is called this method returns
9038	an undefined value.
9039	</desc>
9040	</attribute>
9041
9042	<attribute name="location" type="wstring">
9043	<desc>
9044	Location of the storage unit holding medium data.
9045
9046	The format of the location string is medium type specific. For medium
9047	types using regular files in a host's file system, the location
9048	string is the full file name.
9049
9050	Some medium types may support changing the storage unit location by
9051	simply changing the value of this property. If this operation is not
9052	supported, the implementation will return E_NOTIMPL in attempt to set
9053	this attribute's value.
9054
9055	When setting a value of the location attribute which is a regular file
9056	in the host's file system, the given file name may be either relative to
9057	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9058	absolute. Note that if the given location specification does not contain
9059	the file extension part then a proper default extension will be
9060	automatically appended by the implementation depending on the medium type.
9061	</desc>
9062	</attribute>
9063
9064	<attribute name="name" type="wstring" readonly="yes">
9065	<desc>
9066	Name of the storage unit holding medium data.
9067
9068	The returned string is a short version of the <link to="#location"/>
9069	attribute that is suitable for representing the medium in situations
9070	where the full location specification is too long (such as lists
9071	and comboboxes in GUI frontends). This string is also used by frontends
9072	to sort the media list alphabetically when needed.
9073
9074	For example, for locations that are regular files in the host's file
9075	system, the value of this attribute is just the file name (+ extension),
9076	without the path specification.
9077
9078	Note that as opposed to the <link to="#location"/> attribute, the name
9079	attribute will not necessary be unique for a list of media of the
9080	given type and format.
9081	</desc>
9082	</attribute>
9083
9084	<attribute name="deviceType" type="DeviceType" readonly="yes">
9085	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9086	medium.</desc>
9087	</attribute>
9088
9089	<attribute name="hostDrive" type="boolean" readonly="yes">
9090	<desc>True if this corresponds to a drive on the host.</desc>
9091	</attribute>
9092
9093	<attribute name="size" type="long long" readonly="yes">
9094	<desc>
9095	Physical size of the storage unit used to hold medium data (in bytes).
9096
9097	<note>
9098	For media whose <link to="#state"/> is <link
9099	to="MediumState_Inaccessible"/>, the value of this property is the
9100	last known size. For <link to="MediumState_NotCreated"/> media,
9101	the returned value is zero.
9102	</note>
9103	</desc>
9104	</attribute>
9105
9106	<attribute name="format" type="wstring" readonly="yes">
9107	<desc>
9108	Storage format of this medium.
9109
9110	The value of this attribute is a string that specifies a backend used
9111	to store medium data. The storage format is defined when you create a
9112	new medium or automatically detected when you open an existing medium,
9113	and cannot be changed later.
9114
9115	The list of all storage formats supported by this VirtualBox
9116	installation can be obtained using
9117	<link to="ISystemProperties::mediumFormats"/>.
9118	</desc>
9119	</attribute>
9120
9121	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9122	<desc>
9123	Storage medium format object corresponding to this medium.
9124
9125	The value of this attribute is a reference to the medium format object
9126	that specifies the backend properties used to store medium data. The
9127	storage format is defined when you create a new medium or automatically
9128	detected when you open an existing medium, and cannot be changed later.
9129
9130	<note>@c null is returned if there is no associated medium format
9131	object. This can e.g. happen for medium objects representing host
9132	drives and other special medium objects.</note>
9133	</desc>
9134	</attribute>
9135
9136	<attribute name="type" type="MediumType">
9137	<desc>
9138	Type (role) of this medium.
9139
9140	The following constraints apply when changing the value of this
9141	attribute:
9142	<ul>
9143	<li>If a medium is attached to a virtual machine (either in the
9144	current state or in one of the snapshots), its type cannot be
9145	changed.
9146	</li>
9147	<li>As long as the medium has children, its type cannot be set
9148	to <link to="MediumType_Writethrough"/>.
9149	</li>
9150	<li>The type of all differencing media is
9151	<link to="MediumType_Normal"/> and cannot be changed.
9152	</li>
9153	</ul>
9154
9155	The type of a newly created or opened medium is set to
9156	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9157	which have a type of <link to="MediumType_Writethrough"/>.
9158	</desc>
9159	</attribute>
9160
9161	<attribute name="parent" type="IMedium" readonly="yes">
9162	<desc>
9163	Parent of this medium (the medium this medium is directly based
9164	on).
9165
9166	Only differencing media have parents. For base (non-differencing)
9167	media, @c null is returned.
9168	</desc>
9169	</attribute>
9170
9171	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9172	<desc>
9173	Children of this medium (all differencing media directly based
9174	on this medium). A @c null array is returned if this medium
9175	does not have any children.
9176	</desc>
9177	</attribute>
9178
9179	<attribute name="base" type="IMedium" readonly="yes">
9180	<desc>
9181	Base medium of this medium.
9182
9183	If this is a differencing medium, its base medium is the medium
9184	the given medium branch starts from. For all other types of media, this
9185	property returns the medium object itself (i.e. the same object this
9186	property is read on).
9187	</desc>
9188	</attribute>
9189
9190	<attribute name="readOnly" type="boolean" readonly="yes">
9191	<desc>
9192	Returns @c true if this medium is read-only and @c false otherwise.
9193
9194	A medium is considered to be read-only when its contents cannot be
9195	modified without breaking the integrity of other parties that depend on
9196	this medium such as its child media or snapshots of virtual machines
9197	where this medium is attached to these machines. If there are no
9198	children and no such snapshots then there is no dependency and the
9199	medium is not read-only.
9200
9201	The value of this attribute can be used to determine the kind of the
9202	attachment that will take place when attaching this medium to a
9203	virtual machine. If the value is @c false then the medium will
9204	be attached directly. If the value is @c true then the medium
9205	will be attached indirectly by creating a new differencing child
9206	medium for that. See the interface description for more information.
9207
9208	Note that all <link to="MediumType_Immutable">Immutable</link> media
9209	are always read-only while all
9210	<link to="MediumType_Writethrough">Writethrough</link> media are
9211	always not.
9212
9213	<note>
9214	The read-only condition represented by this attribute is related to
9215	the medium type and usage, not to the current
9216	<link to="IMedium::state">medium state</link> and not to the read-only
9217	state of the storage unit.
9218	</note>
9219	</desc>
9220	</attribute>
9221
9222	<attribute name="logicalSize" type="long long" readonly="yes">
9223	<desc>
9224	Logical size of this medium (in bytes), as reported to the
9225	guest OS running inside the virtual machine this medium is
9226	attached to. The logical size is defined when the medium is created
9227	and cannot be changed later.
9228
9229	<note>
9230	Reading this property on a differencing medium will return the size
9231	of its <link to="#base"/> medium.
9232	</note>
9233	<note>
9234	For media whose state is <link to="#state"/> is <link
9235	to="MediumState_Inaccessible"/>, the value of this property is the
9236	last known logical size. For <link to="MediumState_NotCreated"/>
9237	media, the returned value is zero.
9238	</note>
9239	</desc>
9240	</attribute>
9241
9242	<attribute name="autoReset" type="boolean">
9243	<desc>
9244	Whether this differencing medium will be automatically reset each
9245	time a virtual machine it is attached to is powered up. This
9246	attribute is automatically set to @c true for the last
9247	differencing image of an "immutable" medium (see
9248	<link to="MediumType" />).
9249
9250	See <link to="#reset"/> for more information about resetting
9251	differencing media.
9252
9253	<note>
9254	Reading this property on a base (non-differencing) medium will
9255	always @c false. Changing the value of this property in this
9256	case is not supported.
9257	</note>
9258
9259	<result name="VBOX_E_NOT_SUPPORTED">
9260	This is not a differencing medium (when changing the attribute
9261	value).
9262	</result>
9263	</desc>
9264	</attribute>
9265
9266	<attribute name="lastAccessError" type="wstring" readonly="yes">
9267	<desc>
9268	Text message that represents the result of the last accessibility
9269	check performed by <link to="#refreshState"/>.
9270
9271	An empty string is returned if the last accessibility check
9272	was successful or has not yet been called. As a result, if
9273	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9274	then <link to="#refreshState"/> has yet to be called; this is the
9275	default value of media after VirtualBox initialization.
9276	A non-empty string indicates a failure and should normally describe
9277	a reason of the failure (for example, a file read error).
9278	</desc>
9279	</attribute>
9280
9281	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9282	<desc>
9283	Array of UUIDs of all machines this medium is attached to.
9284
9285	A @c null array is returned if this medium is not attached to any
9286	machine or to any machine's snapshot.
9287
9288	<note>
9289	The returned array will include a machine even if this medium is not
9290	attached to that machine in the current state but attached to it in
9291	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9292	details.
9293	</note>
9294	</desc>
9295	</attribute>
9296
9297	<method name="setIDs">
9298	<desc>
9299	Changes the UUID and parent UUID for a hard disk medium.
9300	</desc>
9301	<param name="setImageId" type="boolean" dir="in">
9302	<desc>
9303	Select whether a new image UUID is set or not.
9304	</desc>
9305	</param>
9306	<param name="imageId" type="uuid" mod="string" dir="in">
9307	<desc>
9308	New UUID for the image. If an empty string is passed, then a new
9309	UUID is automatically created, provided that @a setImageId is @c true.
9310	Specifying a zero UUID is not allowed.
9311	</desc>
9312	</param>
9313	<param name="setParentId" type="boolean" dir="in">
9314	<desc>
9315	Select whether a new parent UUID is set or not.
9316	</desc>
9317	</param>
9318	<param name="parentId" type="uuid" mod="string" dir="in">
9319	<desc>
9320	New parent UUID for the image. If an empty string is passed, then a
9321	new UUID is automatically created, provided @a setParentId is
9322	@c true. A zero UUID is valid.
9323	</desc>
9324	</param>
9325	<result name="E_INVALIDARG">
9326	Invalid parameter combination.
9327	</result>
9328	<result name="VBOX_E_NOT_SUPPORTED">
9329	Medium is not a hard disk medium.
9330	</result>
9331	</method>
9332
9333	<method name="refreshState">
9334	<desc>
9335	If the current medium state (see <link to="MediumState"/>) is one of
9336	"Created", "Inaccessible" or "LockedRead", then this performs an
9337	accessibility check on the medium and sets the value of the <link to="#state"/>
9338	attribute accordingly; that value is also returned for convenience.
9339
9340	For all other state values, this does not perform a refresh but returns
9341	the state only.
9342
9343	The refresh, if performed, may take a long time (several seconds or even
9344	minutes, depending on the storage unit location and format) because it performs an
9345	accessibility check of the storage unit. This check may cause a significant
9346	delay if the storage unit of the given medium is, for example, a file located
9347	on a network share which is not currently accessible due to connectivity
9348	problems. In that case, the call will not return until a timeout
9349	interval defined by the host OS for this operation expires. For this reason,
9350	it is recommended to never read this attribute on the main UI thread to avoid
9351	making the UI unresponsive.
9352
9353	If the last known state of the medium is "Created" and the accessibility
9354	check fails, then the state would be set to "Inaccessible", and
9355	<link to="#lastAccessError"/> may be used to get more details about the
9356	failure. If the state of the medium is "LockedRead", then it remains the
9357	same, and a non-empty value of <link to="#lastAccessError"/> will
9358	indicate a failed accessibility check in this case.
9359
9360	Note that not all medium states are applicable to all medium types.
9361	</desc>
9362	<param name="state" type="MediumState" dir="return">
9363	<desc>
9364	New medium state.
9365	</desc>
9366	</param>
9367	</method>
9368
9369	<method name="getSnapshotIds">
9370	<desc>
9371	Returns an array of UUIDs of all snapshots of the given machine where
9372	this medium is attached to.
9373
9374	If the medium is attached to the machine in the current state, then the
9375	first element in the array will always be the ID of the queried machine
9376	(i.e. the value equal to the @c machineId argument), followed by
9377	snapshot IDs (if any).
9378
9379	If the medium is not attached to the machine in the current state, then
9380	the array will contain only snapshot IDs.
9381
9382	The returned array may be @c null if this medium is not attached
9383	to the given machine at all, neither in the current state nor in one of
9384	the snapshots.
9385	</desc>
9386	<param name="machineId" type="uuid" mod="string" dir="in">
9387	<desc>
9388	UUID of the machine to query.
9389	</desc>
9390	</param>
9391	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9392	<desc>
9393	Array of snapshot UUIDs of the given machine using this medium.
9394	</desc>
9395	</param>
9396	</method>
9397
9398	<method name="lockRead">
9399	<desc>
9400	Locks this medium for reading.
9401
9402	A read lock is shared: many clients can simultaneously lock the
9403	same medium for reading unless it is already locked for writing (see
9404	<link to="#lockWrite"/>) in which case an error is returned.
9405
9406	When the medium is locked for reading, it cannot be modified
9407	from within VirtualBox. This means that any method that changes
9408	the properties of this medium or contents of the storage unit
9409	will return an error (unless explicitly stated otherwise). That
9410	includes an attempt to start a virtual machine that wants to
9411	write to the the medium.
9412
9413	When the virtual machine is started up, it locks for reading all
9414	media it uses in read-only mode. If some medium cannot be locked
9415	for reading, the startup procedure will fail.
9416	A medium is typically locked for reading while it is used by a running
9417	virtual machine but has a depending differencing image that receives
9418	the actual write operations. This way one base medium can have
9419	multiple child differencing images which can be written to
9420	simultaneously. Read-only media such as DVD and floppy images are
9421	also locked for reading only (so they can be in use by multiple
9422	machines simultaneously).
9423
9424	A medium is also locked for reading when it is the source of a
9425	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9426
9427	The medium locked for reading must be unlocked using the <link
9428	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9429	can be nested and must be followed by the same number of paired
9430	<link to="#unlockRead"/> calls.
9431
9432	This method sets the medium state (see <link to="#state"/>) to
9433	"LockedRead" on success. The medium's previous state must be
9434	one of "Created", "Inaccessible" or "LockedRead".
9435
9436	Locking an inaccessible medium is not an error; this method performs
9437	a logical lock that prevents modifications of this medium through
9438	the VirtualBox API, not a physical file-system lock of the underlying
9439	storage unit.
9440
9441	This method returns the current state of the medium
9442	<i>before</i> the operation.
9443
9444	<result name="VBOX_E_INVALID_OBJECT_STATE">
9445	Invalid medium state (e.g. not created, locked, inaccessible,
9446	creating, deleting).
9447	</result>
9448
9449	</desc>
9450	<param name="state" type="MediumState" dir="return">
9451	<desc>
9452	State of the medium after the operation.
9453	</desc>
9454	</param>
9455	</method>
9456
9457	<method name="unlockRead">
9458	<desc>
9459	Cancels the read lock previously set by <link to="#lockRead"/>.
9460
9461	For both success and failure, this method returns the current state
9462	of the medium <i>after</i> the operation.
9463
9464	See <link to="#lockRead"/> for more details.
9465
9466	<result name="VBOX_E_INVALID_OBJECT_STATE">
9467	Medium not locked for reading.
9468	</result>
9469
9470	</desc>
9471	<param name="state" type="MediumState" dir="return">
9472	<desc>
9473	State of the medium after the operation.
9474	</desc>
9475	</param>
9476	</method>
9477
9478	<method name="lockWrite">
9479	<desc>
9480	Locks this medium for writing.
9481
9482	A write lock, as opposed to <link to="#lockRead"/>, is
9483	exclusive: there may be only one client holding a write lock,
9484	and there may be no read locks while the write lock is held.
9485	As a result, read-locking fails if a write lock is held, and
9486	write-locking fails if either a read or another write lock is held.
9487
9488	When a medium is locked for writing, it cannot be modified
9489	from within VirtualBox, and it is not guaranteed that the values
9490	of its properties are up-to-date. Any method that changes the
9491	properties of this medium or contents of the storage unit will
9492	return an error (unless explicitly stated otherwise).
9493
9494	When a virtual machine is started up, it locks for writing all
9495	media it uses to write data to. If any medium could not be locked
9496	for writing, the startup procedure will fail. If a medium has
9497	differencing images, then while the machine is running, only
9498	the last ("leaf") differencing image is locked for writing,
9499	whereas its parents are locked for reading only.
9500
9501	A medium is also locked for writing when it is the target of a
9502	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9503
9504	The medium locked for writing must be unlocked using the <link
9505	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9506
9507	This method sets the medium state (see <link to="#state"/>) to
9508	"LockedWrite" on success. The medium's previous state must be
9509	either "Created" or "Inaccessible".
9510
9511	Locking an inaccessible medium is not an error; this method performs
9512	a logical lock that prevents modifications of this medium through
9513	the VirtualBox API, not a physical file-system lock of the underlying
9514	storage unit.
9515
9516	For both, success and failure, this method returns the current
9517	state of the medium <i>before</i> the operation.
9518
9519	<result name="VBOX_E_INVALID_OBJECT_STATE">
9520	Invalid medium state (e.g. not created, locked, inaccessible,
9521	creating, deleting).
9522	</result>
9523
9524	</desc>
9525	<param name="state" type="MediumState" dir="return">
9526	<desc>
9527	State of the medium after the operation.
9528	</desc>
9529	</param>
9530	</method>
9531
9532	<method name="unlockWrite">
9533	<desc>
9534	Cancels the write lock previously set by <link to="#lockWrite"/>.
9535
9536	For both success and failure, this method returns the current
9537	state of the medium <i>after</i> the operation.
9538
9539	See <link to="#lockWrite"/> for more details.
9540
9541	<result name="VBOX_E_INVALID_OBJECT_STATE">
9542	Medium not locked for writing.
9543	</result>
9544
9545	</desc>
9546	<param name="state" type="MediumState" dir="return">
9547	<desc>
9548	State of the medium after the operation.
9549	</desc>
9550	</param>
9551	</method>
9552
9553	<method name="close">
9554	<desc>
9555	Closes this medium.
9556
9557	The medium must not be attached to any known virtual machine
9558	and must not have any known child media, otherwise the
9559	operation will fail.
9560
9561	When the medium is successfully closed, it is removed from
9562	the list of registered media, but its storage unit is not
9563	deleted. In particular, this means that this medium can
9564	later be opened again using the <link to="IVirtualBox::openMedium"/>
9565	call.
9566
9567	Note that after this method successfully returns, the given medium
9568	object becomes uninitialized. This means that any attempt
9569	to call any of its methods or attributes will fail with the
9570	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9571
9572	<result name="VBOX_E_INVALID_OBJECT_STATE">
9573	Invalid medium state (other than not created, created or
9574	inaccessible).
9575	</result>
9576	<result name="VBOX_E_OBJECT_IN_USE">
9577	Medium attached to virtual machine.
9578	</result>
9579	<result name="VBOX_E_FILE_ERROR">
9580	Settings file not accessible.
9581	</result>
9582	<result name="VBOX_E_XML_ERROR">
9583	Could not parse the settings file.
9584	</result>
9585
9586	</desc>
9587	</method>
9588
9589	<!-- storage methods -->
9590
9591	<method name="getProperty">
9592	<desc>
9593	Returns the value of the custom medium property with the given name.
9594
9595	The list of all properties supported by the given medium format can
9596	be obtained with <link to="IMediumFormat::describeProperties"/>.
9597
9598	Note that if this method returns an empty string in @a value, the
9599	requested property is supported but currently not assigned any value.
9600
9601	<result name="VBOX_E_OBJECT_NOT_FOUND">
9602	Requested property does not exist (not supported by the format).
9603	</result>
9604	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9605	</desc>
9606	<param name="name" type="wstring" dir="in">
9607	<desc>Name of the property to get.</desc>
9608	</param>
9609	<param name="value" type="wstring" dir="return">
9610	<desc>Current property value.</desc>
9611	</param>
9612	</method>
9613
9614	<method name="setProperty">
9615	<desc>
9616	Sets the value of the custom medium property with the given name.
9617
9618	The list of all properties supported by the given medium format can
9619	be obtained with <link to="IMediumFormat::describeProperties"/>.
9620
9621	Note that setting the property value to @c null or an empty string is
9622	equivalent to deleting the existing value. A default value (if it is
9623	defined for this property) will be used by the format backend in this
9624	case.
9625
9626	<result name="VBOX_E_OBJECT_NOT_FOUND">
9627	Requested property does not exist (not supported by the format).
9628	</result>
9629	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9630	</desc>
9631	<param name="name" type="wstring" dir="in">
9632	<desc>Name of the property to set.</desc>
9633	</param>
9634	<param name="value" type="wstring" dir="in">
9635	<desc>Property value to set.</desc>
9636	</param>
9637	</method>
9638
9639	<method name="getProperties">
9640	<desc>
9641	Returns values for a group of properties in one call.
9642
9643	The names of the properties to get are specified using the @a names
9644	argument which is a list of comma-separated property names or
9645	an empty string if all properties are to be returned. Note that currently
9646	the value of this argument is ignored and the method always returns all
9647	existing properties.
9648
9649	The list of all properties supported by the given medium format can
9650	be obtained with <link to="IMediumFormat::describeProperties"/>.
9651
9652	The method returns two arrays, the array of property names corresponding
9653	to the @a names argument and the current values of these properties.
9654	Both arrays have the same number of elements with each elemend at the
9655	given index in the first array corresponds to an element at the same
9656	index in the second array.
9657
9658	Note that for properties that do not have assigned values,
9659	an empty string is returned at the appropriate index in the
9660	@a returnValues array.
9661
9662	</desc>
9663	<param name="names" type="wstring" dir="in">
9664	<desc>
9665	Names of properties to get.
9666	</desc>
9667	</param>
9668	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9669	<desc>Names of returned properties.</desc>
9670	</param>
9671	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9672	<desc>Values of returned properties.</desc>
9673	</param>
9674	</method>
9675
9676	<method name="setProperties">
9677	<desc>
9678	Sets values for a group of properties in one call.
9679
9680	The names of the properties to set are passed in the @a names
9681	array along with the new values for them in the @a values array. Both
9682	arrays have the same number of elements with each elemend at the given
9683	index in the first array corresponding to an element at the same index
9684	in the second array.
9685
9686	If there is at least one property name in @a names that is not valid,
9687	the method will fail before changing the values of any other properties
9688	from the @a names array.
9689
9690	Using this method over <link to="#setProperty"/> is preferred if you
9691	need to set several properties at once since it will result into less
9692	IPC calls.
9693
9694	The list of all properties supported by the given medium format can
9695	be obtained with <link to="IMediumFormat::describeProperties"/>.
9696
9697	Note that setting the property value to @c null or an empty string is
9698	equivalent to deleting the existing value. A default value (if it is
9699	defined for this property) will be used by the format backend in this
9700	case.
9701	</desc>
9702	<param name="names" type="wstring" safearray="yes" dir="in">
9703	<desc>Names of properties to set.</desc>
9704	</param>
9705	<param name="values" type="wstring" safearray="yes" dir="in">
9706	<desc>Values of properties to set.</desc>
9707	</param>
9708	</method>
9709
9710	<!-- storage methods -->
9711
9712	<method name="createBaseStorage">
9713	<desc>
9714	Starts creating a hard disk storage unit (fixed/dynamic, according
9715	to the variant flags) in in the background. The previous storage unit
9716	created for this object, if any, must first be deleted using
9717	<link to="#deleteStorage"/>, otherwise the operation will fail.
9718
9719	Before the operation starts, the medium is placed in
9720	<link to="MediumState_Creating"/> state. If the create operation
9721	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9722	state.
9723
9724	After the returned progress object reports that the operation has
9725	successfully completed, the medium state will be set to <link
9726	to="MediumState_Created"/>, the medium will be remembered by this
9727	VirtualBox installation and may be attached to virtual machines.
9728
9729	<result name="VBOX_E_NOT_SUPPORTED">
9730	The variant of storage creation operation is not supported. See <link
9731	to="IMediumFormat::capabilities"/>.
9732	</result>
9733	</desc>
9734	<param name="logicalSize" type="long long" dir="in">
9735	<desc>Maximum logical size of the medium in bytes.</desc>
9736	</param>
9737	<param name="variant" type="MediumVariant" dir="in">
9738	<desc>Exact image variant which should be created.</desc>
9739	</param>
9740	<param name="progress" type="IProgress" dir="return">
9741	<desc>Progress object to track the operation completion.</desc>
9742	</param>
9743	</method>
9744
9745	<method name="deleteStorage">
9746	<desc>
9747	Starts deleting the storage unit of this medium.
9748
9749	The medium must not be attached to any known virtual machine and must
9750	not have any known child media, otherwise the operation will fail.
9751	It will also fail if there is no storage unit to delete or if deletion
9752	is already in progress, or if the medium is being in use (locked for
9753	read or for write) or inaccessible. Therefore, the only valid state for
9754	this operation to succeed is <link to="MediumState_Created"/>.
9755
9756	Before the operation starts, the medium is placed in
9757	<link to="MediumState_Deleting"/> state and gets removed from the list
9758	of remembered hard disks (media registry). If the delete operation
9759	fails, the medium will be remembered again and placed back to
9760	<link to="MediumState_Created"/> state.
9761
9762	After the returned progress object reports that the operation is
9763	complete, the medium state will be set to
9764	<link to="MediumState_NotCreated"/> and you will be able to use one of
9765	the storage creation methods to create it again.
9766
9767	<see>#close()</see>
9768
9769	<result name="VBOX_E_OBJECT_IN_USE">
9770	Medium is attached to a virtual machine.
9771	</result>
9772	<result name="VBOX_E_NOT_SUPPORTED">
9773	Storage deletion is not allowed because neither of storage creation
9774	operations are supported. See
9775	<link to="IMediumFormat::capabilities"/>.
9776	</result>
9777
9778	<note>
9779	If the deletion operation fails, it is not guaranteed that the storage
9780	unit still exists. You may check the <link to="IMedium::state"/> value
9781	to answer this question.
9782	</note>
9783	</desc>
9784	<param name="progress" type="IProgress" dir="return">
9785	<desc>Progress object to track the operation completion.</desc>
9786	</param>
9787	</method>
9788
9789	<!-- diff methods -->
9790
9791	<method name="createDiffStorage">
9792	<desc>
9793	Starts creating an empty differencing storage unit based on this
9794	medium in the format and at the location defined by the @a target
9795	argument.
9796
9797	The target medium must be in <link to="MediumState_NotCreated"/>
9798	state (i.e. must not have an existing storage unit). Upon successful
9799	completion, this operation will set the type of the target medium to
9800	<link to="MediumType_Normal"/> and create a storage unit necessary to
9801	represent the differencing medium data in the given format (according
9802	to the storage format of the target object).
9803
9804	After the returned progress object reports that the operation is
9805	successfully complete, the target medium gets remembered by this
9806	VirtualBox installation and may be attached to virtual machines.
9807
9808	<note>
9809	The medium will be set to <link to="MediumState_LockedRead"/>
9810	state for the duration of this operation.
9811	</note>
9812	<result name="VBOX_E_OBJECT_IN_USE">
9813	Medium not in @c NotCreated state.
9814	</result>
9815	</desc>
9816	<param name="target" type="IMedium" dir="in">
9817	<desc>Target medium.</desc>
9818	</param>
9819	<param name="variant" type="MediumVariant" dir="in">
9820	<desc>Exact image variant which should be created.</desc>
9821	</param>
9822	<param name="progress" type="IProgress" dir="return">
9823	<desc>Progress object to track the operation completion.</desc>
9824	</param>
9825	</method>
9826
9827	<method name="mergeTo">
9828	<desc>
9829	Starts merging the contents of this medium and all intermediate
9830	differencing media in the chain to the given target medium.
9831
9832	The target medium must be either a descendant of this medium or
9833	its ancestor (otherwise this method will immediately return a failure).
9834	It follows that there are two logical directions of the merge operation:
9835	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9836	ancestor (<i>backward merge</i>). Let us consider the following medium
9837	chain:
9838
9839	<pre>Base <- Diff_1 <- Diff_2</pre>
9840
9841	Here, calling this method on the <tt>Base</tt> medium object with
9842	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9843	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9844	merge. Note that in both cases the contents of the resulting medium
9845	will be the same, the only difference is the medium object that takes
9846	the result of the merge operation. In case of the forward merge in the
9847	above example, the result will be written to <tt>Diff_2</tt>; in case of
9848	the backward merge, the result will be written to <tt>Base</tt>. In
9849	other words, the result of the operation is always stored in the target
9850	medium.
9851
9852	Upon successful operation completion, the storage units of all media in
9853	the chain between this (source) medium and the target medium, including
9854	the source medium itself, will be automatically deleted and the
9855	relevant medium objects (including this medium) will become
9856	uninitialized. This means that any attempt to call any of
9857	their methods or attributes will fail with the
9858	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9859	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9860	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9861	Note that <tt>Diff_2</tt> in this case will become a base medium
9862	itself since it will no longer be based on any other medium.
9863
9864	Considering the above, all of the following conditions must be met in
9865	order for the merge operation to succeed:
9866	<ul>
9867	<li>
9868	Neither this (source) medium nor any intermediate
9869	differencing medium in the chain between it and the target
9870	medium is attached to any virtual machine.
9871	</li>
9872	<li>
9873	Neither the source medium nor the target medium is an
9874	<link to="MediumType_Immutable"/> medium.
9875	</li>
9876	<li>
9877	The part of the medium tree from the source medium to the
9878	target medium is a linear chain, i.e. all medium in this
9879	chain have exactly one child which is the next medium in this
9880	chain. The only exception from this rule is the target medium in
9881	the forward merge operation; it is allowed to have any number of
9882	child media because the merge operation will not change its
9883	logical contents (as it is seen by the guest OS or by children).
9884	</li>
9885	<li>
9886	None of the involved media are in
9887	<link to="MediumState_LockedRead"/> or
9888	<link to="MediumState_LockedWrite"/> state.
9889	</li>
9890	</ul>
9891
9892	<note>
9893	This (source) medium and all intermediates will be placed to <link
9894	to="MediumState_Deleting"/> state and the target medium will be
9895	placed to <link to="MediumState_LockedWrite"/> state and for the
9896	duration of this operation.
9897	</note>
9898	</desc>
9899	<param name="target" type="IMedium" dir="in">
9900	<desc>Target medium.</desc>
9901	</param>
9902	<param name="progress" type="IProgress" dir="return">
9903	<desc>Progress object to track the operation completion.</desc>
9904	</param>
9905	</method>
9906
9907	<!-- clone method -->
9908
9909	<method name="cloneTo">
9910	<desc>
9911	Starts creating a clone of this medium in the format and at the
9912	location defined by the @a target argument.
9913
9914	The target medium must be either in <link to="MediumState_NotCreated"/>
9915	state (i.e. must not have an existing storage unit) or in
9916	<link to="MediumState_Created"/> state (i.e. created and not locked, and
9917	big enough to hold the data or else the copy will be partial). Upon
9918	successful completion, the cloned medium will contain exactly the
9919	same sector data as the medium being cloned, except that in the
9920	first case a new UUID for the clone will be randomly generated, and in
9921	the second case the UUID will remain unchanged.
9922
9923	The @a parent argument defines which medium will be the parent
9924	of the clone. Passing a @c null reference indicates that the clone will
9925	be a base image, i.e. completely independent. It is possible to specify
9926	an arbitrary medium for this parameter, including the parent of the
9927	medium which is being cloned. Even cloning to a child of the source
9928	medium is possible. Note that when cloning to an existing image, the
9929	@a parent irgument is ignored.
9930
9931	After the returned progress object reports that the operation is
9932	successfully complete, the target medium gets remembered by this
9933	VirtualBox installation and may be attached to virtual machines.
9934
9935	<note>
9936	This medium will be placed to <link to="MediumState_LockedRead"/>
9937	state for the duration of this operation.
9938	</note>
9939	<result name="E_NOTIMPL">
9940	The specified cloning variant is not supported at the moment.
9941	</result>
9942	</desc>
9943	<param name="target" type="IMedium" dir="in">
9944	<desc>Target medium.</desc>
9945	</param>
9946	<param name="variant" type="MediumVariant" dir="in">
9947	<desc>Exact image variant which should be created.</desc>
9948	</param>
9949	<param name="parent" type="IMedium" dir="in">
9950	<desc>Parent of the cloned medium.</desc>
9951	</param>
9952	<param name="progress" type="IProgress" dir="return">
9953	<desc>Progress object to track the operation completion.</desc>
9954	</param>
9955	</method>
9956
9957	<!-- other methods -->
9958
9959	<method name="compact">
9960	<desc>
9961	Starts compacting of this medium. This means that the medium is
9962	transformed into a possibly more compact storage representation.
9963	This potentially creates temporary images, which can require a
9964	substantial amount of additional disk space.
9965
9966	This medium will be placed to <link to="MediumState_LockedWrite"/>
9967	state and all its parent media (if any) will be placed to
9968	<link to="MediumState_LockedRead"/> state for the duration of this
9969	operation.
9970
9971	Please note that the results can be either returned straight away,
9972	or later as the result of the background operation via the object
9973	returned via the @a progress parameter.
9974
9975	<result name="VBOX_E_NOT_SUPPORTED">
9976	Medium format does not support compacting (but potentially
9977	needs it).
9978	</result>
9979	</desc>
9980	<param name="progress" type="IProgress" dir="return">
9981	<desc>Progress object to track the operation completion.</desc>
9982	</param>
9983	</method>
9984
9985	<method name="resize">
9986	<desc>
9987	Starts resizing this medium. This means that the nominal size of the
9988	medium is set to the new value. Both increasing and decreasing the
9989	size is possible, and there are no safety checks, since VirtualBox
9990	does not make any assumptions about the medium contents.
9991
9992	Resizing usually needs additional disk space, and possibly also
9993	some temporary disk space. Note that resize does not create a full
9994	temporary copy of the medium, so the additional disk space requirement
9995	is usually much lower than using the clone operation.
9996
9997	This medium will be placed to <link to="MediumState_LockedWrite"/>
9998	state for the duration of this operation.
9999
10000	Please note that the results can be either returned straight away,
10001	or later as the result of the background operation via the object
10002	returned via the @a progress parameter.
10003
10004	<result name="VBOX_E_NOT_SUPPORTED">
10005	Medium format does not support resizing.
10006	</result>
10007	</desc>
10008	<param name="logicalSize" type="long long" dir="in">
10009	<desc>New nominal capacity of the medium in bytes.</desc>
10010	</param>
10011	<param name="progress" type="IProgress" dir="return">
10012	<desc>Progress object to track the operation completion.</desc>
10013	</param>
10014	</method>
10015
10016	<method name="reset">
10017	<desc>
10018	Starts erasing the contents of this differencing medium.
10019
10020	This operation will reset the differencing medium to its initial
10021	state when it does not contain any sector data and any read operation is
10022	redirected to its parent medium. This automatically gets called
10023	during VM power-up for every medium whose <link to="#autoReset" />
10024	attribute is @c true.
10025
10026	The medium will be write-locked for the duration of this operation (see
10027	<link to="#lockWrite" />).
10028
10029	<result name="VBOX_E_NOT_SUPPORTED">
10030	This is not a differencing medium.
10031	</result>
10032	<result name="VBOX_E_INVALID_OBJECT_STATE">
10033	Medium is not in <link to="MediumState_Created"/> or
10034	<link to="MediumState_Inaccessible"/> state.
10035	</result>
10036	</desc>
10037	<param name="progress" type="IProgress" dir="return">
10038	<desc>Progress object to track the operation completion.</desc>
10039	</param>
10040	</method>
10041
10042	</interface>
10043
10044
10045	<!--
10046	// IMediumFormat
10047	/////////////////////////////////////////////////////////////////////////
10048	-->
10049
10050	<enum
10051	name="DataType"
10052	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10053	>
10054	<const name="Int32" value="0"/>
10055	<const name="Int8" value="1"/>
10056	<const name="String" value="2"/>
10057	</enum>
10058
10059	<enum
10060	name="DataFlags"
10061	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10062	>
10063	<const name="None" value="0x00"/>
10064	<const name="Mandatory" value="0x01"/>
10065	<const name="Expert" value="0x02"/>
10066	<const name="Array" value="0x04"/>
10067	<const name="FlagMask" value="0x07"/>
10068	</enum>
10069
10070	<enum
10071	name="MediumFormatCapabilities"
10072	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10073	>
10074	<desc>
10075	Medium format capability flags.
10076	</desc>
10077
10078	<const name="Uuid" value="0x01">
10079	<desc>
10080	Supports UUIDs as expected by VirtualBox code.
10081	</desc>
10082	</const>
10083
10084	<const name="CreateFixed" value="0x02">
10085	<desc>
10086	Supports creating fixed size images, allocating all space instantly.
10087	</desc>
10088	</const>
10089
10090	<const name="CreateDynamic" value="0x04">
10091	<desc>
10092	Supports creating dynamically growing images, allocating space on
10093	demand.
10094	</desc>
10095	</const>
10096
10097	<const name="CreateSplit2G" value="0x08">
10098	<desc>
10099	Supports creating images split in chunks of a bit less than 2 GBytes.
10100	</desc>
10101	</const>
10102
10103	<const name="Differencing" value="0x10">
10104	<desc>
10105	Supports being used as a format for differencing media (see <link
10106	to="IMedium::createDiffStorage"/>).
10107	</desc>
10108	</const>
10109
10110	<const name="Asynchronous" value="0x20">
10111	<desc>
10112	Supports asynchronous I/O operations for at least some configurations.
10113	</desc>
10114	</const>
10115
10116	<const name="File" value="0x40">
10117	<desc>
10118	The format backend operates on files (the <link to="IMedium::location"/>
10119	attribute of the medium specifies a file used to store medium
10120	data; for a list of supported file extensions see
10121	<link to="IMediumFormat::describeFileExtensions"/>).
10122	</desc>
10123	</const>
10124
10125	<const name="Properties" value="0x80">
10126	<desc>
10127	The format backend uses the property interface to configure the storage
10128	location and properties (the <link to="IMediumFormat::describeProperties"/>
10129	method is used to get access to properties supported by the given medium format).
10130	</desc>
10131	</const>
10132
10133	<const name="TcpNetworking" value="0x100">
10134	<desc>
10135	The format backend uses the TCP networking interface for network access.
10136	</desc>
10137	</const>
10138
10139	<const name="VFS" value="0x200">
10140	<desc>
10141	The format backend supports virtual filesystem functionality.
10142	</desc>
10143	</const>
10144
10145	<const name="CapabilityMask" value="0x3FF"/>
10146	</enum>
10147
10148	<interface
10149	name="IMediumFormat" extends="$unknown"
10150	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10151	wsmap="managed"
10152	>
10153	<desc>
10154	The IMediumFormat interface represents a medium format.
10155
10156	Each medium format has an associated backend which is used to handle
10157	media stored in this format. This interface provides information
10158	about the properties of the associated backend.
10159
10160	Each medium format is identified by a string represented by the
10161	<link to="#id"/> attribute. This string is used in calls like
10162	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10163	format.
10164
10165	The list of all supported medium formats can be obtained using
10166	<link to="ISystemProperties::mediumFormats"/>.
10167
10168	<see>IMedium</see>
10169	</desc>
10170
10171	<attribute name="id" type="wstring" readonly="yes">
10172	<desc>
10173	Identifier of this format.
10174
10175	The format identifier is a non-@c null non-empty ASCII string. Note that
10176	this string is case-insensitive. This means that, for example, all of
10177	the following strings:
10178	<pre>
10179	"VDI"
10180	"vdi"
10181	"VdI"</pre>
10182	refer to the same medium format.
10183
10184	This string is used in methods of other interfaces where it is necessary
10185	to specify a medium format, such as
10186	<link to="IVirtualBox::createHardDisk"/>.
10187	</desc>
10188	</attribute>
10189
10190	<attribute name="name" type="wstring" readonly="yes">
10191	<desc>
10192	Human readable description of this format.
10193
10194	Mainly for use in file open dialogs.
10195	</desc>
10196	</attribute>
10197
10198	<attribute name="capabilities" type="unsigned long" readonly="yes">
10199	<desc>
10200	Capabilities of the format as a set of bit flags.
10201
10202	For the meaning of individual capability flags see
10203	<link to="MediumFormatCapabilities"/>.
10204	</desc>
10205	</attribute>
10206
10207	<method name="describeFileExtensions">
10208	<desc>
10209	Returns two arrays describing the supported file extensions.
10210
10211	The first array contains the supported extensions and the seconds one
10212	the type each extension supports. Both have the same size.
10213
10214	Note that some backends do not work on files, so this array may be
10215	empty.
10216
10217	<see>IMediumFormat::capabilities</see>
10218	</desc>
10219	<param name="extensions" type="wstring" safearray="yes" dir="out">
10220	<desc>The array of supported extensions.</desc>
10221	</param>
10222	<param name="type" type="DeviceType" safearray="yes" dir="out">
10223	<desc>The array which indicates the device type for every given extension.</desc>
10224	</param>
10225	</method>
10226
10227	<method name="describeProperties">
10228	<desc>
10229	Returns several arrays describing the properties supported by this
10230	format.
10231
10232	An element with the given index in each array describes one
10233	property. Thus, the number of elements in each returned array is the
10234	same and corresponds to the number of supported properties.
10235
10236	The returned arrays are filled in only if the
10237	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10238	All arguments must be non-@c null.
10239
10240	<see>DataType</see>
10241	<see>DataFlags</see>
10242	</desc>
10243
10244	<param name="names" type="wstring" safearray="yes" dir="out">
10245	<desc>Array of property names.</desc>
10246	</param>
10247	<param name="description" type="wstring" safearray="yes" dir="out">
10248	<desc>Array of property descriptions.</desc>
10249	</param>
10250	<param name="types" type="DataType" safearray="yes" dir="out">
10251	<desc>Array of property types.</desc>
10252	</param>
10253	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10254	<desc>Array of property flags.</desc>
10255	</param>
10256	<param name="defaults" type="wstring" safearray="yes" dir="out">
10257	<desc>Array of default property values.</desc>
10258	</param>
10259	</method>
10260
10261	</interface>
10262
10263
10264	<!--
10265	// IKeyboard
10266	/////////////////////////////////////////////////////////////////////////
10267	-->
10268
10269	<interface
10270	name="IKeyboard" extends="$unknown"
10271	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10272	wsmap="managed"
10273	>
10274	<desc>
10275	The IKeyboard interface represents the virtual machine's keyboard. Used
10276	in <link to="IConsole::keyboard"/>.
10277
10278	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10279	to the virtual machine.
10280
10281	</desc>
10282	<method name="putScancode">
10283	<desc>Sends a scancode to the keyboard.
10284
10285	<result name="VBOX_E_IPRT_ERROR">
10286	Could not send scan code to virtual keyboard.
10287	</result>
10288
10289	</desc>
10290	<param name="scancode" type="long" dir="in"/>
10291	</method>
10292
10293	<method name="putScancodes">
10294	<desc>Sends an array of scancodes to the keyboard.
10295
10296	<result name="VBOX_E_IPRT_ERROR">
10297	Could not send all scan codes to virtual keyboard.
10298	</result>
10299
10300	</desc>
10301	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10302	<param name="codesStored" type="unsigned long" dir="return"/>
10303	</method>
10304
10305	<method name="putCAD">
10306	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10307	function is nothing special, it is just a convenience function
10308	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10309
10310	<result name="VBOX_E_IPRT_ERROR">
10311	Could not send all scan codes to virtual keyboard.
10312	</result>
10313
10314	</desc>
10315	</method>
10316
10317	<attribute name="eventSource" type="IEventSource" readonly="yes">
10318	<desc>
10319	Event source for keyboard events.
10320	</desc>
10321	</attribute>
10322
10323	</interface>
10324
10325
10326	<!--
10327	// IMouse
10328	/////////////////////////////////////////////////////////////////////////
10329	-->
10330
10331	<enum
10332	name="MouseButtonState"
10333	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10334	>
10335	<desc>
10336	Mouse button state.
10337	</desc>
10338
10339	<const name="LeftButton" value="0x01"/>
10340	<const name="RightButton" value="0x02"/>
10341	<const name="MiddleButton" value="0x04"/>
10342	<const name="WheelUp" value="0x08"/>
10343	<const name="WheelDown" value="0x10"/>
10344	<const name="XButton1" value="0x20"/>
10345	<const name="XButton2" value="0x40"/>
10346	<const name="MouseStateMask" value="0x7F"/>
10347	</enum>
10348
10349	<interface
10350	name="IMouse" extends="$unknown"
10351	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10352	wsmap="managed"
10353	>
10354	<desc>
10355	The IMouse interface represents the virtual machine's mouse. Used in
10356	<link to="IConsole::mouse"/>.
10357
10358	Through this interface, the virtual machine's virtual mouse can be
10359	controlled.
10360	</desc>
10361
10362	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10363	<desc>
10364	Whether the guest OS supports absolute mouse pointer positioning
10365	or not.
10366	<note>
10367	You can use the <link to="IMouseCapabilityChangedEvent"/>
10368	event to be instantly informed about changes of this attribute
10369	during virtual machine execution.
10370	</note>
10371	<see><link to="#putMouseEventAbsolute"/></see>
10372	</desc>
10373	</attribute>
10374
10375	<attribute name="relativeSupported" type="boolean" readonly="yes">
10376	<desc>
10377	Whether the guest OS supports relative mouse pointer positioning
10378	or not.
10379	<note>
10380	You can use the <link to="IMouseCapabilityChangedEvent"/>
10381	event to be instantly informed about changes of this attribute
10382	during virtual machine execution.
10383	</note>
10384	<see><link to="#putMouseEvent"/></see>
10385	</desc>
10386	</attribute>
10387
10388	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10389	<desc>
10390	Whether the guest OS can currently switch to drawing it's own mouse
10391	cursor on demand.
10392	<note>
10393	You can use the <link to="IMouseCapabilityChangedEvent"/>
10394	event to be instantly informed about changes of this attribute
10395	during virtual machine execution.
10396	</note>
10397	<see><link to="#putMouseEvent"/></see>
10398	</desc>
10399	</attribute>
10400
10401	<method name="putMouseEvent">
10402	<desc>
10403	Initiates a mouse event using relative pointer movements
10404	along x and y axis.
10405
10406	<result name="E_ACCESSDENIED">
10407	Console not powered up.
10408	</result>
10409	<result name="VBOX_E_IPRT_ERROR">
10410	Could not send mouse event to virtual mouse.
10411	</result>
10412
10413	</desc>
10414
10415	<param name="dx" type="long" dir="in">
10416	<desc>
10417	Amount of pixels the mouse should move to the right.
10418	Negative values move the mouse to the left.
10419	</desc>
10420	</param>
10421	<param name="dy" type="long" dir="in">
10422	<desc>
10423	Amount of pixels the mouse should move downwards.
10424	Negative values move the mouse upwards.
10425	</desc>
10426	</param>
10427	<param name="dz" type="long" dir="in">
10428	<desc>
10429	Amount of mouse wheel moves.
10430	Positive values describe clockwise wheel rotations,
10431	negative values describe counterclockwise rotations.
10432	</desc>
10433	</param>
10434	<param name="dw" type="long" dir="in">
10435	<desc>
10436	Amount of horizontal mouse wheel moves.
10437	Positive values describe a movement to the left,
10438	negative values describe a movement to the right.
10439	</desc>
10440	</param>
10441	<param name="buttonState" type="long" dir="in">
10442	<desc>
10443	The current state of mouse buttons. Every bit represents
10444	a mouse button as follows:
10445	<table>
10446	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10447	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10448	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10449	</table>
10450	A value of <tt>1</tt> means the corresponding button is pressed.
10451	otherwise it is released.
10452	</desc>
10453	</param>
10454	</method>
10455
10456	<method name="putMouseEventAbsolute">
10457	<desc>
10458	Positions the mouse pointer using absolute x and y coordinates.
10459	These coordinates are expressed in pixels and
10460	start from <tt>[1,1]</tt> which corresponds to the top left
10461	corner of the virtual display.
10462
10463	<result name="E_ACCESSDENIED">
10464	Console not powered up.
10465	</result>
10466	<result name="VBOX_E_IPRT_ERROR">
10467	Could not send mouse event to virtual mouse.
10468	</result>
10469
10470	<note>
10471	This method will have effect only if absolute mouse
10472	positioning is supported by the guest OS.
10473	</note>
10474
10475	<see><link to="#absoluteSupported"/></see>
10476	</desc>
10477
10478	<param name="x" type="long" dir="in">
10479	<desc>
10480	X coordinate of the pointer in pixels, starting from @c 1.
10481	</desc>
10482	</param>
10483	<param name="y" type="long" dir="in">
10484	<desc>
10485	Y coordinate of the pointer in pixels, starting from @c 1.
10486	</desc>
10487	</param>
10488	<param name="dz" type="long" dir="in">
10489	<desc>
10490	Amount of mouse wheel moves.
10491	Positive values describe clockwise wheel rotations,
10492	negative values describe counterclockwise rotations.
10493	</desc>
10494	</param>
10495	<param name="dw" type="long" dir="in">
10496	<desc>
10497	Amount of horizontal mouse wheel moves.
10498	Positive values describe a movement to the left,
10499	negative values describe a movement to the right.
10500	</desc>
10501	</param>
10502	<param name="buttonState" type="long" dir="in">
10503	<desc>
10504	The current state of mouse buttons. Every bit represents
10505	a mouse button as follows:
10506	<table>
10507	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10508	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10509	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10510	</table>
10511	A value of @c 1 means the corresponding button is pressed.
10512	otherwise it is released.
10513	</desc>
10514	</param>
10515	</method>
10516
10517	<attribute name="eventSource" type="IEventSource" readonly="yes">
10518	<desc>
10519	Event source for mouse events.
10520	</desc>
10521	</attribute>
10522
10523	</interface>
10524
10525	<!--
10526	// IDisplay
10527	/////////////////////////////////////////////////////////////////////////
10528	-->
10529
10530	<enum
10531	name="FramebufferPixelFormat"
10532	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10533	>
10534	<desc>
10535	Format of the video memory buffer. Constants represented by this enum can
10536	be used to test for particular values of <link
10537	to="IFramebuffer::pixelFormat"/>. See also <link
10538	to="IFramebuffer::requestResize"/>.
10539
10540	See also www.fourcc.org for more information about FOURCC pixel formats.
10541	</desc>
10542
10543	<const name="Opaque" value="0">
10544	<desc>
10545	Unknown buffer format (the user may not assume any particular format of
10546	the buffer).
10547	</desc>
10548	</const>
10549	<const name="FOURCC_RGB" value="0x32424752">
10550	<desc>
10551	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10552	bit layout).
10553	</desc>
10554	</const>
10555	</enum>
10556
10557	<interface
10558	name="IFramebuffer" extends="$unknown"
10559	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10560	wsmap="suppress"
10561	>
10562	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10563	<desc>Address of the start byte of the frame buffer.</desc>
10564	</attribute>
10565
10566	<attribute name="width" type="unsigned long" readonly="yes">
10567	<desc>Frame buffer width, in pixels.</desc>
10568	</attribute>
10569
10570	<attribute name="height" type="unsigned long" readonly="yes">
10571	<desc>Frame buffer height, in pixels.</desc>
10572	</attribute>
10573
10574	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10575	<desc>
10576	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10577	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10578	are: 8, 15, 16, 24 and 32.
10579	</desc>
10580	</attribute>
10581
10582	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10583	<desc>
10584	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10585	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10586	size of the scan line must be aligned to 32 bits.
10587	</desc>
10588	</attribute>
10589
10590	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10591	<desc>
10592	Frame buffer pixel format. It's either one of the values defined by <link
10593	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10594	<note>
10595	This attribute must never return <link
10596	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10597	<link to="#address"/> points to must be always known.
10598	</note>
10599	</desc>
10600	</attribute>
10601
10602	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10603	<desc>
10604	Defines whether this frame buffer uses the virtual video card's memory
10605	buffer (guest VRAM) directly or not. See <link
10606	to="IFramebuffer::requestResize"/> for more information.
10607	</desc>
10608	</attribute>
10609
10610	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10611	<desc>
10612	Hint from the frame buffer about how much of the standard
10613	screen height it wants to use for itself. This information is
10614	exposed to the guest through the VESA BIOS and VMMDev interface
10615	so that it can use it for determining its video mode table. It
10616	is not guaranteed that the guest respects the value.
10617	</desc>
10618	</attribute>
10619
10620	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10621	<desc>
10622	An alpha-blended overlay which is superposed over the frame buffer.
10623	The initial purpose is to allow the display of icons providing
10624	information about the VM state, including disk activity, in front
10625	ends which do not have other means of doing that. The overlay is
10626	designed to controlled exclusively by IDisplay. It has no locking
10627	of its own, and any changes made to it are not guaranteed to be
10628	visible until the affected portion of IFramebuffer is updated. The
10629	overlay can be created lazily the first time it is requested. This
10630	attribute can also return @c null to signal that the overlay is not
10631	implemented.
10632	</desc>
10633	</attribute>
10634
10635	<attribute name="winId" type="long long" readonly="yes">
10636	<desc>
10637	Platform-dependent identifier of the window where context of this
10638	frame buffer is drawn, or zero if there's no such window.
10639	</desc>
10640	</attribute>
10641
10642	<method name="lock">
10643	<desc>
10644	Locks the frame buffer.
10645	Gets called by the IDisplay object where this frame buffer is
10646	bound to.
10647	</desc>
10648	</method>
10649
10650	<method name="unlock">
10651	<desc>
10652	Unlocks the frame buffer.
10653	Gets called by the IDisplay object where this frame buffer is
10654	bound to.
10655	</desc>
10656	</method>
10657
10658	<method name="notifyUpdate">
10659	<desc>
10660	Informs about an update.
10661	Gets called by the display object where this buffer is
10662	registered.
10663	</desc>
10664	<param name="x" type="unsigned long" dir="in"/>
10665	<param name="y" type="unsigned long" dir="in"/>
10666	<param name="width" type="unsigned long" dir="in"/>
10667	<param name="height" type="unsigned long" dir="in"/>
10668	</method>
10669
10670	<method name="requestResize">
10671	<desc>
10672	Requests a size and pixel format change.
10673
10674	There are two modes of working with the video buffer of the virtual
10675	machine. The <i>indirect</i> mode implies that the IFramebuffer
10676	implementation allocates a memory buffer for the requested display mode
10677	and provides it to the virtual machine. In <i>direct</i> mode, the
10678	IFramebuffer implementation uses the memory buffer allocated and owned
10679	by the virtual machine. This buffer represents the video memory of the
10680	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10681	usually faster because the implementation gets a raw pointer to the
10682	guest VRAM buffer which it can directly use for visualizing the contents
10683	of the virtual display, as opposed to the indirect mode where the
10684	contents of guest VRAM are copied to the memory buffer provided by
10685	the implementation every time a display update occurs.
10686
10687	It is important to note that the direct mode is really fast only when
10688	the implementation uses the given guest VRAM buffer directly, for
10689	example, by blitting it to the window representing the virtual machine's
10690	display, which saves at least one copy operation comparing to the
10691	indirect mode. However, using the guest VRAM buffer directly is not
10692	always possible: the format and the color depth of this buffer may be
10693	not supported by the target window, or it may be unknown (opaque) as in
10694	case of text or non-linear multi-plane VGA video modes. In this case,
10695	the indirect mode (that is always available) should be used as a
10696	fallback: when the guest VRAM contents are copied to the
10697	implementation-provided memory buffer, color and format conversion is
10698	done automatically by the underlying code.
10699
10700	The @a pixelFormat parameter defines whether the direct mode is
10701	available or not. If @a pixelFormat is <link
10702	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10703	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10704	@a bytesPerLine parameters must be ignored and the implementation must use
10705	the indirect mode (where it provides its own buffer in one of the
10706	supported formats). In all other cases, @a pixelFormat together with
10707	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10708	buffer pointed to by the @a VRAM parameter and the implementation is
10709	free to choose which mode to use. To indicate that this frame buffer uses
10710	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10711	attribute must return @c true and <link to="#address"/> must
10712	return exactly the same address that is passed in the @a VRAM parameter
10713	of this method; otherwise it is assumed that the indirect strategy is
10714	chosen.
10715
10716	The @a width and @a height parameters represent the size of the
10717	requested display mode in both modes. In case of indirect mode, the
10718	provided memory buffer should be big enough to store data of the given
10719	display mode. In case of direct mode, it is guaranteed that the given
10720	@a VRAM buffer contains enough space to represent the display mode of the
10721	given size. Note that this frame buffer's <link to="#width"/> and <link
10722	to="#height"/> attributes must return exactly the same values as
10723	passed to this method after the resize is completed (see below).
10724
10725	The @a finished output parameter determines if the implementation has
10726	finished resizing the frame buffer or not. If, for some reason, the
10727	resize cannot be finished immediately during this call, @a finished
10728	must be set to @c false, and the implementation must call
10729	<link to="IDisplay::resizeCompleted"/> after it has returned from
10730	this method as soon as possible. If @a finished is @c false, the
10731	machine will not call any frame buffer methods until
10732	<link to="IDisplay::resizeCompleted"/> is called.
10733
10734	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10735	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10736	this frame buffer must return exactly the same values as specified in the
10737	parameters of this method, after the resize is completed. If the
10738	indirect mode is chosen, these attributes must return values describing
10739	the format of the implementation's own memory buffer <link
10740	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10741	value must always correlate with <link to="#pixelFormat"/>. Note that
10742	the <link to="#pixelFormat"/> attribute must never return <link
10743	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10744
10745	<note>
10746	This method is called by the IDisplay object under the
10747	<link to="#lock"/> provided by this IFramebuffer
10748	implementation. If this method returns @c false in @a finished, then
10749	this lock is not released until
10750	<link to="IDisplay::resizeCompleted"/> is called.
10751	</note>
10752	</desc>
10753	<param name="screenId" type="unsigned long" dir="in">
10754	<desc>
10755	Logical screen number. Must be used in the corresponding call to
10756	<link to="IDisplay::resizeCompleted"/> if this call is made.
10757	</desc>
10758	</param>
10759	<param name="pixelFormat" type="unsigned long" dir="in">
10760	<desc>
10761	Pixel format of the memory buffer pointed to by @a VRAM.
10762	See also <link to="FramebufferPixelFormat"/>.
10763	</desc>
10764	</param>
10765	<param name="VRAM" type="octet" mod="ptr" dir="in">
10766	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10767	</param>
10768	<param name="bitsPerPixel" type="unsigned long" dir="in">
10769	<desc>Color depth, bits per pixel.</desc>
10770	</param>
10771	<param name="bytesPerLine" type="unsigned long" dir="in">
10772	<desc>Size of one scan line, in bytes.</desc>
10773	</param>
10774	<param name="width" type="unsigned long" dir="in">
10775	<desc>Width of the guest display, in pixels.</desc>
10776	</param>
10777	<param name="height" type="unsigned long" dir="in">
10778	<desc>Height of the guest display, in pixels.</desc>
10779	</param>
10780	<param name="finished" type="boolean" dir="return">
10781	<desc>
10782	Can the VM start using the new frame buffer immediately
10783	after this method returns or it should wait for
10784	<link to="IDisplay::resizeCompleted"/>.
10785	</desc>
10786	</param>
10787	</method>
10788
10789	<method name="videoModeSupported">
10790	<desc>
10791	Returns whether the frame buffer implementation is willing to
10792	support a given video mode. In case it is not able to render
10793	the video mode (or for some reason not willing), it should
10794	return @c false. Usually this method is called when the guest
10795	asks the VMM device whether a given video mode is supported
10796	so the information returned is directly exposed to the guest.
10797	It is important that this method returns very quickly.
10798	</desc>
10799	<param name="width" type="unsigned long" dir="in"/>
10800	<param name="height" type="unsigned long" dir="in"/>
10801	<param name="bpp" type="unsigned long" dir="in"/>
10802	<param name="supported" type="boolean" dir="return"/>
10803	</method>
10804
10805	<method name="getVisibleRegion">
10806	<desc>
10807	Returns the visible region of this frame buffer.
10808
10809	If the @a rectangles parameter is @c null then the value of the
10810	@a count parameter is ignored and the number of elements necessary to
10811	describe the current visible region is returned in @a countCopied.
10812
10813	If @a rectangles is not @c null but @a count is less
10814	than the required number of elements to store region data, the method
10815	will report a failure. If @a count is equal or greater than the
10816	required number of elements, then the actual number of elements copied
10817	to the provided array will be returned in @a countCopied.
10818
10819	<note>
10820	The address of the provided array must be in the process space of
10821	this IFramebuffer object.
10822	</note>
10823	<note>
10824	Method not yet implemented.
10825	</note>
10826	</desc>
10827	<param name="rectangles" type="octet" mod="ptr" dir="in">
10828	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10829	</param>
10830	<param name="count" type="unsigned long" dir="in">
10831	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10832	</param>
10833	<param name="countCopied" type="unsigned long" dir="return">
10834	<desc>Number of elements copied to the @a rectangles array.</desc>
10835	</param>
10836	</method>
10837
10838	<method name="setVisibleRegion">
10839	<desc>
10840	Suggests a new visible region to this frame buffer. This region
10841	represents the area of the VM display which is a union of regions of
10842	all top-level windows of the guest operating system running inside the
10843	VM (if the Guest Additions for this system support this
10844	functionality). This information may be used by the frontends to
10845	implement the seamless desktop integration feature.
10846
10847	<note>
10848	The address of the provided array must be in the process space of
10849	this IFramebuffer object.
10850	</note>
10851	<note>
10852	The IFramebuffer implementation must make a copy of the provided
10853	array of rectangles.
10854	</note>
10855	<note>
10856	Method not yet implemented.
10857	</note>
10858	</desc>
10859	<param name="rectangles" type="octet" mod="ptr" dir="in">
10860	<desc>Pointer to the @c RTRECT array.</desc>
10861	</param>
10862	<param name="count" type="unsigned long" dir="in">
10863	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10864	</param>
10865	</method>
10866
10867	<method name="processVHWACommand">
10868	<desc>
10869	Posts a Video HW Acceleration Command to the frame buffer for processing.
10870	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color covnersion, overlaying, etc.)
10871	are posted from quest to the host to be processed by the host hardware.
10872
10873	<note>
10874	The address of the provided command must be in the process space of
10875	this IFramebuffer object.
10876	</note>
10877	</desc>
10878
10879	<param name="command" type="octet" mod="ptr" dir="in">
10880	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10881	</param>
10882	</method>
10883
10884	</interface>
10885
10886	<interface
10887	name="IFramebufferOverlay" extends="IFramebuffer"
10888	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10889	wsmap="suppress"
10890	>
10891	<desc>
10892	The IFramebufferOverlay interface represents an alpha blended overlay
10893	for displaying status icons above an IFramebuffer. It is always created
10894	not visible, so that it must be explicitly shown. It only covers a
10895	portion of the IFramebuffer, determined by its width, height and
10896	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10897	that order) format, and may be written to directly. Do re-read the
10898	width though, after setting it, as it may be adjusted (increased) to
10899	make it more suitable for the front end.
10900	</desc>
10901	<attribute name="x" type="unsigned long" readonly="yes">
10902	<desc>X position of the overlay, relative to the frame buffer.</desc>
10903	</attribute>
10904
10905	<attribute name="y" type="unsigned long" readonly="yes">
10906	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10907	</attribute>
10908
10909	<attribute name="visible" type="boolean" readonly="no">
10910	<desc>
10911	Whether the overlay is currently visible.
10912	</desc>
10913	</attribute>
10914
10915	<attribute name="alpha" type="unsigned long" readonly="no">
10916	<desc>
10917	The global alpha value for the overlay. This may or may not be
10918	supported by a given front end.
10919	</desc>
10920	</attribute>
10921
10922	<method name="move">
10923	<desc>
10924	Changes the overlay's position relative to the IFramebuffer.
10925	</desc>
10926	<param name="x" type="unsigned long" dir="in"/>
10927	<param name="y" type="unsigned long" dir="in"/>
10928	</method>
10929
10930	</interface>
10931
10932	<interface
10933	name="IDisplay" extends="$unknown"
10934	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
10935	wsmap="managed"
10936	>
10937	<desc>
10938	The IDisplay interface represents the virtual machine's display.
10939
10940	The object implementing this interface is contained in each
10941	<link to="IConsole::display"/> attribute and represents the visual
10942	output of the virtual machine.
10943
10944	The virtual display supports pluggable output targets represented by the
10945	IFramebuffer interface. Examples of the output target are a window on
10946	the host computer or an RDP session's display on a remote computer.
10947	</desc>
10948	<method name="getScreenResolution">
10949	<desc>Queries display width, height and color depth for given screen.</desc>
10950	<param name="screenId" type="unsigned long" dir="in"/>
10951	<param name="width" type="unsigned long" dir="out"/>
10952	<param name="height" type="unsigned long" dir="out"/>
10953	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
10954	</method>
10955
10956	<method name="setFramebuffer">
10957	<desc>
10958	Sets the framebuffer for given screen.
10959	</desc>
10960	<param name="screenId" type="unsigned long" dir="in"/>
10961	<param name="framebuffer" type="IFramebuffer" dir="in"/>
10962	</method>
10963
10964	<method name="getFramebuffer">
10965	<desc>
10966	Queries the framebuffer for given screen.
10967	</desc>
10968	<param name="screenId" type="unsigned long" dir="in"/>
10969	<param name="framebuffer" type="IFramebuffer" dir="out"/>
10970	<param name="xOrigin" type="long" dir="out"/>
10971	<param name="yOrigin" type="long" dir="out"/>
10972	</method>
10973
10974	<method name="setVideoModeHint">
10975	<desc>
10976	Asks VirtualBox to request the given video mode from
10977	the guest. This is just a hint and it cannot be guaranteed
10978	that the requested resolution will be used. Guest Additions
10979	are required for the request to be seen by guests. The caller
10980	should issue the request and wait for a resolution change and
10981	after a timeout retry.
10982
10983	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
10984	parameters means that the corresponding values should be taken from the
10985	current video mode (i.e. left unchanged).
10986
10987	If the guest OS supports multi-monitor configuration then the @a display
10988	parameter specifies the number of the guest display to send the hint to:
10989	@c 0 is the primary display, @c 1 is the first secondary and
10990	so on. If the multi-monitor configuration is not supported, @a display
10991	must be @c 0.
10992
10993	<result name="E_INVALIDARG">
10994	The @a display is not associated with any monitor.
10995	</result>
10996
10997	</desc>
10998	<param name="width" type="unsigned long" dir="in"/>
10999	<param name="height" type="unsigned long" dir="in"/>
11000	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11001	<param name="display" type="unsigned long" dir="in"/>
11002	</method>
11003
11004	<method name="setSeamlessMode">
11005	<desc>
11006	Enables or disables seamless guest display rendering (seamless desktop
11007	integration) mode.
11008	<note>
11009	Calling this method has no effect if <link
11010	to="IGuest::supportsSeamless"/> returns @c false.
11011	</note>
11012	</desc>
11013	<param name="enabled" type="boolean" dir="in"/>
11014	</method>
11015
11016	<method name="takeScreenShot">
11017	<desc>
11018	Takes a screen shot of the requested size and copies it to the
11019	32-bpp buffer allocated by the caller and pointed to by @a address.
11020	A pixel consists of 4 bytes in order: B, G, R, 0.
11021
11022	<note>This API can be used only by the COM/XPCOM C++ API as it
11023	requires pointer support. Use <link to="#takeScreenShotToArray" />
11024	with other language bindings.
11025	</note>
11026
11027	<result name="E_NOTIMPL">
11028	Feature not implemented.
11029	</result>
11030	<result name="VBOX_E_IPRT_ERROR">
11031	Could not take a screenshot.
11032	</result>
11033
11034	</desc>
11035	<param name="screenId" type="unsigned long" dir="in"/>
11036	<param name="address" type="octet" mod="ptr" dir="in"/>
11037	<param name="width" type="unsigned long" dir="in"/>
11038	<param name="height" type="unsigned long" dir="in"/>
11039	</method>
11040
11041	<method name="takeScreenShotToArray">
11042	<desc>
11043	Takes a guest screen shot of the requested size and returns it as
11044	an array of bytes in uncompressed 32-bit RGBA format.
11045	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11046
11047	This API is slow, but could be the only option to get guest screenshot
11048	for scriptable languages not allowed to manipulate with addresses
11049	directly.
11050
11051	<result name="E_NOTIMPL">
11052	Feature not implemented.
11053	</result>
11054	<result name="VBOX_E_IPRT_ERROR">
11055	Could not take a screenshot.
11056	</result>
11057	</desc>
11058	<param name="screenId" type="unsigned long" dir="in">
11059	<desc>
11060	Monitor to take screenshot from.
11061	</desc>
11062	</param>
11063	<param name="width" type="unsigned long" dir="in">
11064	<desc>
11065	Desired image width.
11066	</desc>
11067	</param>
11068	<param name="height" type="unsigned long" dir="in">
11069	<desc>
11070	Desired image height.
11071	</desc>
11072	</param>
11073	<param name="screenData" type="octet" dir="return" safearray="yes">
11074	<desc>
11075	Array with resulting screen data.
11076	</desc>
11077	</param>
11078	</method>
11079
11080	<method name="takeScreenShotPNGToArray">
11081	<desc>
11082	Takes a guest screen shot of the requested size and returns it as
11083	PNG image in array.
11084
11085	<result name="E_NOTIMPL">
11086	Feature not implemented.
11087	</result>
11088	<result name="VBOX_E_IPRT_ERROR">
11089	Could not take a screenshot.
11090	</result>
11091	</desc>
11092	<param name="screenId" type="unsigned long" dir="in">
11093	<desc>
11094	Monitor to take the screenshot from.
11095	</desc>
11096	</param>
11097	<param name="width" type="unsigned long" dir="in">
11098	<desc>
11099	Desired image width.
11100	</desc>
11101	</param>
11102	<param name="height" type="unsigned long" dir="in">
11103	<desc>
11104	Desired image height.
11105	</desc>
11106	</param>
11107	<param name="screenData" type="octet" dir="return" safearray="yes">
11108	<desc>
11109	Array with resulting screen data.
11110	</desc>
11111	</param>
11112	</method>
11113
11114	<method name="drawToScreen">
11115	<desc>
11116	Draws a 32-bpp image of the specified size from the given buffer
11117	to the given point on the VM display.
11118
11119	<result name="E_NOTIMPL">
11120	Feature not implemented.
11121	</result>
11122	<result name="VBOX_E_IPRT_ERROR">
11123	Could not draw to screen.
11124	</result>
11125
11126	</desc>
11127	<param name="screenId" type="unsigned long" dir="in">
11128	<desc>
11129	Monitor to take the screenshot from.
11130	</desc>
11131	</param>
11132	<param name="address" type="octet" mod="ptr" dir="in">
11133	<desc>
11134	Address to store the screenshot to
11135	</desc>
11136	</param>
11137	<param name="x" type="unsigned long" dir="in">
11138	<desc>
11139	Relative to the screen top left corner.
11140	</desc>
11141	</param>
11142	<param name="y" type="unsigned long" dir="in">
11143	<desc>
11144	Relative to the screen top left corner.
11145	</desc>
11146	</param>
11147	<param name="width" type="unsigned long" dir="in">
11148	<desc>
11149	Desired image width.
11150	</desc>
11151	</param>
11152	<param name="height" type="unsigned long" dir="in">
11153	<desc>
11154	Desired image height.
11155	</desc>
11156	</param>
11157	</method>
11158
11159	<method name="invalidateAndUpdate">
11160	<desc>
11161	Does a full invalidation of the VM display and instructs the VM
11162	to update it.
11163
11164	<result name="VBOX_E_IPRT_ERROR">
11165	Could not invalidate and update screen.
11166	</result>
11167
11168	</desc>
11169	</method>
11170
11171	<method name="resizeCompleted">
11172	<desc>
11173	Signals that a framebuffer has completed the resize operation.
11174
11175	<result name="VBOX_E_NOT_SUPPORTED">
11176	Operation only valid for external frame buffers.
11177	</result>
11178
11179	</desc>
11180	<param name="screenId" type="unsigned long" dir="in"/>
11181	</method>
11182
11183	<method name="completeVHWACommand">
11184	<desc>
11185	Signals that the Video HW Acceleration command has completed.
11186	</desc>
11187
11188	<param name="command" type="octet" mod="ptr" dir="in">
11189	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11190	</param>
11191	</method>
11192
11193	</interface>
11194
11195	<!--
11196	// INetworkAdapter
11197	/////////////////////////////////////////////////////////////////////////
11198	-->
11199
11200	<enum
11201	name="NetworkAttachmentType"
11202	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11203	>
11204	<desc>
11205	Network attachment type.
11206	</desc>
11207
11208	<const name="Null" value="0">
11209	<desc>Null value, also means "not attached".</desc>
11210	</const>
11211	<const name="NAT" value="1"/>
11212	<const name="Bridged" value="2"/>
11213	<const name="Internal" value="3"/>
11214	<const name="HostOnly" value="4"/>
11215	<const name="VDE" value="5"/>
11216	</enum>
11217
11218	<enum
11219	name="NetworkAdapterType"
11220	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11221	>
11222	<desc>
11223	Network adapter type.
11224	</desc>
11225
11226	<const name="Null" value="0">
11227	<desc>Null value (never used by the API).</desc>
11228	</const>
11229	<const name="Am79C970A" value="1">
11230	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11231	</const>
11232	<const name="Am79C973" value="2">
11233	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11234	</const>
11235	<const name="I82540EM" value="3">
11236	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11237	</const>
11238	<const name="I82543GC" value="4">
11239	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11240	</const>
11241	<const name="I82545EM" value="5">
11242	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11243	</const>
11244	<const name="Virtio" value="6">
11245	<desc>Virtio network device.</desc>
11246	</const>
11247	</enum>
11248
11249	<interface
11250	name="INetworkAdapter" extends="$unknown"
11251	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11252	wsmap="managed"
11253	>
11254	<desc>
11255	Represents a virtual network adapter that is attached to a virtual machine.
11256	Each virtual machine has a fixed number of network adapter slots with one
11257	instance of this attached to each of them. Call
11258	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11259	is attached to a given slot in a given machine.
11260
11261	Each network adapter can be in one of five attachment modes, which are
11262	represented by the <link to="NetworkAttachmentType" /> enumeration;
11263	see the <link to="#attachmentType" /> attribute.
11264	</desc>
11265
11266	<attribute name="adapterType" type="NetworkAdapterType">
11267	<desc>
11268	Type of the virtual network adapter. Depending on this value,
11269	VirtualBox will provide a different virtual network hardware
11270	to the guest.
11271	</desc>
11272	</attribute>
11273
11274	<attribute name="slot" type="unsigned long" readonly="yes">
11275	<desc>
11276	Slot number this adapter is plugged into. Corresponds to
11277	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11278	to obtain this instance.
11279	</desc>
11280	</attribute>
11281
11282	<attribute name="enabled" type="boolean">
11283	<desc>
11284	Flag whether the network adapter is present in the
11285	guest system. If disabled, the virtual guest hardware will
11286	not contain this network adapter. Can only be changed when
11287	the VM is not running.
11288	</desc>
11289	</attribute>
11290
11291	<attribute name="MACAddress" type="wstring">
11292	<desc>
11293	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11294	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11295	</desc>
11296	</attribute>
11297
11298	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11299
11300	<attribute name="hostInterface" type="wstring">
11301	<desc>
11302	Name of the host network interface the VM is attached to.
11303	</desc>
11304	</attribute>
11305
11306	<attribute name="internalNetwork" type="wstring">
11307	<desc>
11308	Name of the internal network the VM is attached to.
11309	</desc>
11310	</attribute>
11311
11312	<attribute name="NATNetwork" type="wstring">
11313	<desc>
11314	Name of the NAT network the VM is attached to.
11315	</desc>
11316	</attribute>
11317
11318	<attribute name="VDENetwork" type="wstring">
11319	<desc>
11320	Name of the VDE switch the VM is attached to.
11321	</desc>
11322	</attribute>
11323
11324	<attribute name="cableConnected" type="boolean">
11325	<desc>
11326	Flag whether the adapter reports the cable as connected or not.
11327	It can be used to report offline situations to a VM.
11328	</desc>
11329	</attribute>
11330
11331	<attribute name="lineSpeed" type="unsigned long">
11332	<desc>
11333	Line speed reported by custom drivers, in units of 1 kbps.
11334	</desc>
11335	</attribute>
11336
11337	<attribute name="traceEnabled" type="boolean">
11338	<desc>
11339	Flag whether network traffic from/to the network card should be traced.
11340	Can only be toggled when the VM is turned off.
11341	</desc>
11342	</attribute>
11343
11344	<attribute name="traceFile" type="wstring">
11345	<desc>
11346	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11347	will be used.
11348	</desc>
11349	</attribute>
11350
11351	<attribute name="natDriver" type="INATEngine" readonly="yes">
11352	<desc>
11353	Points to the NAT engine which handles the network address translation
11354	for this interface. This is active only when the interface actually uses
11355	NAT (see <link to="#attachToNAT" />).
11356	</desc>
11357	</attribute>
11358
11359	<attribute name="bootPriority" type="unsigned long">
11360	<desc>
11361	Network boot priority of the adapter. Priority 1 is highest. If not set,
11362	the priority is considered to be at the lowest possible setting.
11363	</desc>
11364	</attribute>
11365
11366	<attribute name="bandwidthLimit" type="unsigned long">
11367	<desc>
11368	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11369	A zero value means uncapped/unlimited.
11370	</desc>
11371	</attribute>
11372
11373	<method name="attachToNAT">
11374	<desc>
11375	Attach the network adapter to the Network Address Translation (NAT) interface.
11376	</desc>
11377	</method>
11378
11379	<method name="attachToBridgedInterface">
11380	<desc>
11381	Attach the network adapter to a bridged host interface.
11382	</desc>
11383	</method>
11384
11385	<method name="attachToInternalNetwork">
11386	<desc>
11387	Attach the network adapter to an internal network.
11388	</desc>
11389	</method>
11390
11391	<method name="attachToHostOnlyInterface">
11392	<desc>
11393	Attach the network adapter to the host-only network.
11394	</desc>
11395	</method>
11396
11397	<method name="attachToVDE">
11398	<desc>
11399	Attach the network adapter to a VDE network.
11400	</desc>
11401	</method>
11402
11403	<method name="detach">
11404	<desc>
11405	Detach the network adapter
11406	</desc>
11407	</method>
11408	</interface>
11409
11410
11411	<!--
11412	// ISerialPort
11413	/////////////////////////////////////////////////////////////////////////
11414	-->
11415
11416	<enum
11417	name="PortMode"
11418	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11419	>
11420	<desc>
11421	The PortMode enumeration represents possible communication modes for
11422	the virtual serial port device.
11423	</desc>
11424
11425	<const name="Disconnected" value="0">
11426	<desc>Virtual device is not attached to any real host device.</desc>
11427	</const>
11428	<const name="HostPipe" value="1">
11429	<desc>Virtual device is attached to a host pipe.</desc>
11430	</const>
11431	<const name="HostDevice" value="2">
11432	<desc>Virtual device is attached to a host device.</desc>
11433	</const>
11434	<const name="RawFile" value="3">
11435	<desc>Virtual device is attached to a raw file.</desc>
11436	</const>
11437	</enum>
11438
11439	<interface
11440	name="ISerialPort" extends="$unknown"
11441	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11442	wsmap="managed"
11443	>
11444
11445	<desc>
11446	The ISerialPort interface represents the virtual serial port device.
11447
11448	The virtual serial port device acts like an ordinary serial port
11449	inside the virtual machine. This device communicates to the real
11450	serial port hardware in one of two modes: host pipe or host device.
11451
11452	In host pipe mode, the #path attribute specifies the path to the pipe on
11453	the host computer that represents a serial port. The #server attribute
11454	determines if this pipe is created by the virtual machine process at
11455	machine startup or it must already exist before starting machine
11456	execution.
11457
11458	In host device mode, the #path attribute specifies the name of the
11459	serial port device on the host computer.
11460
11461	There is also a third communication mode: the disconnected mode. In this
11462	mode, the guest OS running inside the virtual machine will be able to
11463	detect the serial port, but all port write operations will be discarded
11464	and all port read operations will return no data.
11465
11466	<see>IMachine::getSerialPort</see>
11467	</desc>
11468
11469	<attribute name="slot" type="unsigned long" readonly="yes">
11470	<desc>
11471	Slot number this serial port is plugged into. Corresponds to
11472	the value you pass to <link to="IMachine::getSerialPort"/>
11473	to obtain this instance.
11474	</desc>
11475	</attribute>
11476
11477	<attribute name="enabled" type="boolean">
11478	<desc>
11479	Flag whether the serial port is enabled. If disabled,
11480	the serial port will not be reported to the guest OS.
11481	</desc>
11482	</attribute>
11483
11484	<attribute name="IOBase" type="unsigned long">
11485	<desc>Base I/O address of the serial port.</desc>
11486	</attribute>
11487
11488	<attribute name="IRQ" type="unsigned long">
11489	<desc>IRQ number of the serial port.</desc>
11490	</attribute>
11491
11492	<attribute name="hostMode" type="PortMode">
11493	<desc>
11494	How is this port connected to the host.
11495	<note>
11496	Changing this attribute may fail if the conditions for
11497	<link to="#path"/> are not met.
11498	</note>
11499	</desc>
11500	</attribute>
11501
11502	<attribute name="server" type="boolean">
11503	<desc>
11504	Flag whether this serial port acts as a server (creates a new pipe on
11505	the host) or as a client (uses the existing pipe). This attribute is
11506	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11507	</desc>
11508	</attribute>
11509
11510	<attribute name="path" type="wstring">
11511	<desc>
11512	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11513	PortMode_HostPipe, or the host serial device name when
11514	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11515	cases, setting a @c null or empty string as the attribute's value
11516	is an error. Otherwise, the value of this property is ignored.
11517	</desc>
11518	</attribute>
11519
11520	</interface>
11521
11522	<!--
11523	// IParallelPort
11524	/////////////////////////////////////////////////////////////////////////
11525	-->
11526
11527	<interface
11528	name="IParallelPort" extends="$unknown"
11529	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11530	wsmap="managed"
11531	>
11532
11533	<desc>
11534	The IParallelPort interface represents the virtual parallel port device.
11535
11536	The virtual parallel port device acts like an ordinary parallel port
11537	inside the virtual machine. This device communicates to the real
11538	parallel port hardware using the name of the parallel device on the host
11539	computer specified in the #path attribute.
11540
11541	Each virtual parallel port device is assigned a base I/O address and an
11542	IRQ number that will be reported to the guest operating system and used
11543	to operate the given parallel port from within the virtual machine.
11544
11545	<see>IMachine::getParallelPort</see>
11546	</desc>
11547
11548	<attribute name="slot" type="unsigned long" readonly="yes">
11549	<desc>
11550	Slot number this parallel port is plugged into. Corresponds to
11551	the value you pass to <link to="IMachine::getParallelPort"/>
11552	to obtain this instance.
11553	</desc>
11554	</attribute>
11555
11556	<attribute name="enabled" type="boolean">
11557	<desc>
11558	Flag whether the parallel port is enabled. If disabled,
11559	the parallel port will not be reported to the guest OS.
11560	</desc>
11561	</attribute>
11562
11563	<attribute name="IOBase" type="unsigned long">
11564	<desc>Base I/O address of the parallel port.</desc>
11565	</attribute>
11566
11567	<attribute name="IRQ" type="unsigned long">
11568	<desc>IRQ number of the parallel port.</desc>
11569	</attribute>
11570
11571	<attribute name="path" type="wstring">
11572	<desc>
11573	Host parallel device name. If this parallel port is enabled, setting a
11574	@c null or an empty string as this attribute's value will result into
11575	an error.
11576	</desc>
11577	</attribute>
11578
11579	</interface>
11580
11581
11582	<!--
11583	// IMachineDebugger
11584	/////////////////////////////////////////////////////////////////////////
11585	-->
11586
11587	<interface
11588	name="IMachineDebugger" extends="$unknown"
11589	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11590	wsmap="suppress"
11591	>
11592	<method name="resetStats">
11593	<desc>
11594	Reset VM statistics.
11595	</desc>
11596	<param name="pattern" type="wstring" dir="in">
11597	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11598	</param>
11599	</method>
11600
11601	<method name="dumpStats">
11602	<desc>
11603	Dumps VM statistics.
11604	</desc>
11605	<param name="pattern" type="wstring" dir="in">
11606	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11607	</param>
11608	</method>
11609
11610	<method name="getStats">
11611	<desc>
11612	Get the VM statistics in a XMLish format.
11613	</desc>
11614	<param name="pattern" type="wstring" dir="in">
11615	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11616	</param>
11617	<param name="withDescriptions" type="boolean" dir="in">
11618	<desc>Whether to include the descriptions.</desc>
11619	</param>
11620	<param name="stats" type="wstring" dir="out">
11621	<desc>The XML document containing the statistics.</desc>
11622	</param>
11623	</method>
11624
11625	<method name="injectNMI">
11626	<desc>
11627	Inject an NMI into a running VT-x/AMD-V VM.
11628	</desc>
11629	</method>
11630
11631	<attribute name="singlestep" type="boolean">
11632	<desc>Switch for enabling singlestepping.</desc>
11633	</attribute>
11634
11635	<attribute name="recompileUser" type="boolean">
11636	<desc>Switch for forcing code recompilation for user mode code.</desc>
11637	</attribute>
11638
11639	<attribute name="recompileSupervisor" type="boolean">
11640	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11641	</attribute>
11642
11643	<attribute name="PATMEnabled" type="boolean">
11644	<desc>Switch for enabling and disabling the PATM component.</desc>
11645	</attribute>
11646
11647	<attribute name="CSAMEnabled" type="boolean">
11648	<desc>Switch for enabling and disabling the CSAM component.</desc>
11649	</attribute>
11650
11651	<attribute name="logEnabled" type="boolean">
11652	<desc>Switch for enabling and disabling logging.</desc>
11653	</attribute>
11654
11655	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11656	<desc>
11657	Flag indicating whether the VM is currently making use of CPU hardware
11658	virtualization extensions.
11659	</desc>
11660	</attribute>
11661
11662	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11663	<desc>
11664	Flag indicating whether the VM is currently making use of the nested paging
11665	CPU hardware virtualization extension.
11666	</desc>
11667	</attribute>
11668
11669	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11670	<desc>
11671	Flag indicating whether the VM is currently making use of the VPID
11672	VT-x extension.
11673	</desc>
11674	</attribute>
11675
11676	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11677	<desc>
11678	Flag indicating whether the VM is currently making use of the Physical
11679	Address Extension CPU feature.
11680	</desc>
11681	</attribute>
11682
11683	<attribute name="virtualTimeRate" type="unsigned long">
11684	<desc>
11685	The rate at which the virtual time runs expressed as a percentage.
11686	The accepted range is 2% to 20000%.
11687	</desc>
11688	</attribute>
11689
11690	<!-- @todo method for setting log flags, groups and destination! -->
11691
11692	<attribute name="VM" type="long long" readonly="yes">
11693	<desc>
11694	Gets the VM handle. This is only for internal use while
11695	we carve the details of this interface.
11696	</desc>
11697	</attribute>
11698
11699	</interface>
11700
11701	<!--
11702	// IUSBController
11703	/////////////////////////////////////////////////////////////////////////
11704	-->
11705
11706	<interface
11707	name="IUSBController" extends="$unknown"
11708	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11709	wsmap="managed"
11710	>
11711	<attribute name="enabled" type="boolean">
11712	<desc>
11713	Flag whether the USB controller is present in the
11714	guest system. If disabled, the virtual guest hardware will
11715	not contain any USB controller. Can only be changed when
11716	the VM is powered off.
11717	</desc>
11718	</attribute>
11719
11720	<attribute name="enabledEhci" type="boolean">
11721	<desc>
11722	Flag whether the USB EHCI controller is present in the
11723	guest system. If disabled, the virtual guest hardware will
11724	not contain a USB EHCI controller. Can only be changed when
11725	the VM is powered off.
11726	</desc>
11727	</attribute>
11728
11729	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11730	<desc>
11731	Flag whether there is an USB proxy available.
11732	</desc>
11733	</attribute>
11734
11735	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11736	<desc>
11737	USB standard version which the controller implements.
11738	This is a BCD which means that the major version is in the
11739	high byte and minor version is in the low byte.
11740	</desc>
11741	</attribute>
11742
11743	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11744	<desc>
11745	List of USB device filters associated with the machine.
11746
11747	If the machine is currently running, these filters are activated
11748	every time a new (supported) USB device is attached to the host
11749	computer that was not ignored by global filters
11750	(<link to="IHost::USBDeviceFilters"/>).
11751
11752	These filters are also activated when the machine is powered up.
11753	They are run against a list of all currently available USB
11754	devices (in states
11755	<link to="USBDeviceState_Available"/>,
11756	<link to="USBDeviceState_Busy"/>,
11757	<link to="USBDeviceState_Held"/>) that were not previously
11758	ignored by global filters.
11759
11760	If at least one filter matches the USB device in question, this
11761	device is automatically captured (attached to) the virtual USB
11762	controller of this machine.
11763
11764	<see>IUSBDeviceFilter, ::IUSBController</see>
11765	</desc>
11766	</attribute>
11767
11768	<method name="createDeviceFilter">
11769	<desc>
11770	Creates a new USB device filter. All attributes except
11771	the filter name are set to empty (any match),
11772	<i>active</i> is @c false (the filter is not active).
11773
11774	The created filter can then be added to the list of filters using
11775	<link to="#insertDeviceFilter"/>.
11776
11777	<result name="VBOX_E_INVALID_VM_STATE">
11778	The virtual machine is not mutable.
11779	</result>
11780
11781	<see>#deviceFilters</see>
11782	</desc>
11783	<param name="name" type="wstring" dir="in">
11784	<desc>
11785	Filter name. See <link to="IUSBDeviceFilter::name"/>
11786	for more info.
11787	</desc>
11788	</param>
11789	<param name="filter" type="IUSBDeviceFilter" dir="return">
11790	<desc>Created filter object.</desc>
11791	</param>
11792	</method>
11793
11794	<method name="insertDeviceFilter">
11795	<desc>
11796	Inserts the given USB device to the specified position
11797	in the list of filters.
11798
11799	Positions are numbered starting from <tt>0</tt>. If the specified
11800	position is equal to or greater than the number of elements in
11801	the list, the filter is added to the end of the collection.
11802
11803	<note>
11804	Duplicates are not allowed, so an attempt to insert a
11805	filter that is already in the collection, will return an
11806	error.
11807	</note>
11808
11809	<result name="VBOX_E_INVALID_VM_STATE">
11810	Virtual machine is not mutable.
11811	</result>
11812	<result name="E_INVALIDARG">
11813	USB device filter not created within this VirtualBox instance.
11814	</result>
11815	<result name="VBOX_E_INVALID_OBJECT_STATE">
11816	USB device filter already in list.
11817	</result>
11818
11819	<see>#deviceFilters</see>
11820	</desc>
11821	<param name="position" type="unsigned long" dir="in">
11822	<desc>Position to insert the filter to.</desc>
11823	</param>
11824	<param name="filter" type="IUSBDeviceFilter" dir="in">
11825	<desc>USB device filter to insert.</desc>
11826	</param>
11827	</method>
11828
11829	<method name="removeDeviceFilter">
11830	<desc>
11831	Removes a USB device filter from the specified position in the
11832	list of filters.
11833
11834	Positions are numbered starting from <tt>0</tt>. Specifying a
11835	position equal to or greater than the number of elements in
11836	the list will produce an error.
11837
11838	<see>#deviceFilters</see>
11839
11840	<result name="VBOX_E_INVALID_VM_STATE">
11841	Virtual machine is not mutable.
11842	</result>
11843	<result name="E_INVALIDARG">
11844	USB device filter list empty or invalid @a position.
11845	</result>
11846
11847	</desc>
11848	<param name="position" type="unsigned long" dir="in">
11849	<desc>Position to remove the filter from.</desc>
11850	</param>
11851	<param name="filter" type="IUSBDeviceFilter" dir="return">
11852	<desc>Removed USB device filter.</desc>
11853	</param>
11854	</method>
11855
11856	</interface>
11857
11858
11859	<!--
11860	// IUSBDevice
11861	/////////////////////////////////////////////////////////////////////////
11862	-->
11863
11864	<interface
11865	name="IUSBDevice" extends="$unknown"
11866	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11867	wsmap="managed"
11868	>
11869	<desc>
11870	The IUSBDevice interface represents a virtual USB device attached to the
11871	virtual machine.
11872
11873	A collection of objects implementing this interface is stored in the
11874	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11875	attached to a running virtual machine's USB controller.
11876	</desc>
11877
11878	<attribute name="id" type="uuid" mod="string" readonly="yes">
11879	<desc>
11880	Unique USB device ID. This ID is built from #vendorId,
11881	#productId, #revision and #serialNumber.
11882	</desc>
11883	</attribute>
11884
11885	<attribute name="vendorId" type="unsigned short" readonly="yes">
11886	<desc>Vendor ID.</desc>
11887	</attribute>
11888
11889	<attribute name="productId" type="unsigned short" readonly="yes">
11890	<desc>Product ID.</desc>
11891	</attribute>
11892
11893	<attribute name="revision" type="unsigned short" readonly="yes">
11894	<desc>
11895	Product revision number. This is a packed BCD represented as
11896	unsigned short. The high byte is the integer part and the low
11897	byte is the decimal.
11898	</desc>
11899	</attribute>
11900
11901	<attribute name="manufacturer" type="wstring" readonly="yes">
11902	<desc>Manufacturer string.</desc>
11903	</attribute>
11904
11905	<attribute name="product" type="wstring" readonly="yes">
11906	<desc>Product string.</desc>
11907	</attribute>
11908
11909	<attribute name="serialNumber" type="wstring" readonly="yes">
11910	<desc>Serial number string.</desc>
11911	</attribute>
11912
11913	<attribute name="address" type="wstring" readonly="yes">
11914	<desc>Host specific address of the device.</desc>
11915	</attribute>
11916
11917	<attribute name="port" type="unsigned short" readonly="yes">
11918	<desc>
11919	Host USB port number the device is physically
11920	connected to.
11921	</desc>
11922	</attribute>
11923
11924	<attribute name="version" type="unsigned short" readonly="yes">
11925	<desc>
11926	The major USB version of the device - 1 or 2.
11927	</desc>
11928	</attribute>
11929
11930	<attribute name="portVersion" type="unsigned short" readonly="yes">
11931	<desc>
11932	The major USB version of the host USB port the device is
11933	physically connected to - 1 or 2. For devices not connected to
11934	anything this will have the same value as the version attribute.
11935	</desc>
11936	</attribute>
11937
11938	<attribute name="remote" type="boolean" readonly="yes">
11939	<desc>
11940	Whether the device is physically connected to a remote VRDE
11941	client or to a local host machine.
11942	</desc>
11943	</attribute>
11944
11945	</interface>
11946
11947
11948	<!--
11949	// IUSBDeviceFilter
11950	/////////////////////////////////////////////////////////////////////////
11951	-->
11952
11953	<interface
11954	name="IUSBDeviceFilter" extends="$unknown"
11955	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
11956	wsmap="managed"
11957	>
11958	<desc>
11959	The IUSBDeviceFilter interface represents an USB device filter used
11960	to perform actions on a group of USB devices.
11961
11962	This type of filters is used by running virtual machines to
11963	automatically capture selected USB devices once they are physically
11964	attached to the host computer.
11965
11966	A USB device is matched to the given device filter if and only if all
11967	attributes of the device match the corresponding attributes of the
11968	filter (that is, attributes are joined together using the logical AND
11969	operation). On the other hand, all together, filters in the list of
11970	filters carry the semantics of the logical OR operation. So if it is
11971	desirable to create a match like "this vendor id OR this product id",
11972	one needs to create two filters and specify "any match" (see below)
11973	for unused attributes.
11974
11975	All filter attributes used for matching are strings. Each string
11976	is an expression representing a set of values of the corresponding
11977	device attribute, that will match the given filter. Currently, the
11978	following filtering expressions are supported:
11979
11980	<ul>
11981	<li><i>Interval filters</i>. Used to specify valid intervals for
11982	integer device attributes (Vendor ID, Product ID and Revision).
11983	The format of the string is:
11984
11985	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
11986
11987	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
11988	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
11989	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
11990	is omitted before a dash (<tt>-</tt>), the minimum possible integer
11991	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
11992	possible integer is assumed.
11993	</li>
11994	<li><i>Boolean filters</i>. Used to specify acceptable values for
11995	boolean device attributes. The format of the string is:
11996
11997	<tt>true\|false\|yes\|no\|0\|1</tt>
11998
11999	</li>
12000	<li><i>Exact match</i>. Used to specify a single value for the given
12001	device attribute. Any string that doesn't start with <tt>int:</tt>
12002	represents the exact match. String device attributes are compared to
12003	this string including case of symbols. Integer attributes are first
12004	converted to a string (see individual filter attributes) and then
12005	compared ignoring case.
12006
12007	</li>
12008	<li><i>Any match</i>. Any value of the corresponding device attribute
12009	will match the given filter. An empty or @c null string is
12010	used to construct this type of filtering expressions.
12011
12012	</li>
12013	</ul>
12014
12015	<note>
12016	On the Windows host platform, interval filters are not currently
12017	available. Also all string filter attributes
12018	(<link to="#manufacturer"/>, <link to="#product"/>,
12019	<link to="#serialNumber"/>) are ignored, so they behave as
12020	<i>any match</i> no matter what string expression is specified.
12021	</note>
12022
12023	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12024	</desc>
12025
12026	<attribute name="name" type="wstring">
12027	<desc>
12028	Visible name for this filter.
12029	This name is used to visually distinguish one filter from another,
12030	so it can neither be @c null nor an empty string.
12031	</desc>
12032	</attribute>
12033
12034	<attribute name="active" type="boolean">
12035	<desc>Whether this filter active or has been temporarily disabled.</desc>
12036	</attribute>
12037
12038	<attribute name="vendorId" type="wstring">
12039	<desc>
12040	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12041	The string representation for the <i>exact matching</i>
12042	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12043	(including leading zeroes).
12044	</desc>
12045	</attribute>
12046
12047	<attribute name="productId" type="wstring">
12048	<desc>
12049	<link to="IUSBDevice::productId">Product ID</link> filter.
12050	The string representation for the <i>exact matching</i>
12051	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12052	(including leading zeroes).
12053	</desc>
12054	</attribute>
12055
12056	<attribute name="revision" type="wstring">
12057	<desc>
12058	<link to="IUSBDevice::productId">Product revision number</link>
12059	filter. The string representation for the <i>exact matching</i>
12060	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12061	of the integer part of the revision, and <tt>F</tt> is the
12062	decimal digit of its fractional part (including leading and
12063	trailing zeros).
12064	Note that for interval filters, it's best to use the hexadecimal
12065	form, because the revision is stored as a 16 bit packed BCD value;
12066	so the expression <tt>int:0x0100-0x0199</tt> will match any
12067	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12068	</desc>
12069	</attribute>
12070
12071	<attribute name="manufacturer" type="wstring">
12072	<desc>
12073	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12074	</desc>
12075	</attribute>
12076
12077	<attribute name="product" type="wstring">
12078	<desc>
12079	<link to="IUSBDevice::product">Product</link> filter.
12080	</desc>
12081	</attribute>
12082
12083	<attribute name="serialNumber" type="wstring">
12084	<desc>
12085	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12086	</desc>
12087	</attribute>
12088
12089	<attribute name="port" type="wstring">
12090	<desc>
12091	<link to="IUSBDevice::port">Host USB port</link> filter.
12092	</desc>
12093	</attribute>
12094
12095	<attribute name="remote" type="wstring">
12096	<desc>
12097	<link to="IUSBDevice::remote">Remote state</link> filter.
12098	<note>
12099	This filter makes sense only for machine USB filters,
12100	i.e. it is ignored by IHostUSBDeviceFilter objects.
12101	</note>
12102	</desc>
12103	</attribute>
12104
12105	<attribute name="maskedInterfaces" type="unsigned long">
12106	<desc>
12107	This is an advanced option for hiding one or more USB interfaces
12108	from the guest. The value is a bit mask where the bits that are set
12109	means the corresponding USB interface should be hidden, masked off
12110	if you like.
12111	This feature only works on Linux hosts.
12112	</desc>
12113	</attribute>
12114
12115	</interface>
12116
12117
12118	<!--
12119	// IHostUSBDevice
12120	/////////////////////////////////////////////////////////////////////////
12121	-->
12122
12123	<enum
12124	name="USBDeviceState"
12125	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12126	>
12127	<desc>
12128	USB device state. This enumeration represents all possible states
12129	of the USB device physically attached to the host computer regarding
12130	its state on the host computer and availability to guest computers
12131	(all currently running virtual machines).
12132
12133	Once a supported USB device is attached to the host, global USB
12134	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12135	either ignore the device, or put it to USBDeviceState_Held state, or do
12136	nothing. Unless the device is ignored by global filters, filters of all
12137	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12138	activated that can put it to USBDeviceState_Captured state.
12139
12140	If the device was ignored by global filters, or didn't match
12141	any filters at all (including guest ones), it is handled by the host
12142	in a normal way. In this case, the device state is determined by
12143	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12144	or USBDeviceState_Available, depending on the current device usage.
12145
12146	Besides auto-capturing based on filters, the device can be manually
12147	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12148	state is USBDeviceState_Busy, USBDeviceState_Available or
12149	USBDeviceState_Held.
12150
12151	<note>
12152	Due to differences in USB stack implementations in Linux and Win32,
12153	states USBDeviceState_Busy and USBDeviceState_vailable are applicable
12154	only to the Linux version of the product. This also means that (<link
12155	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12156	device state is USBDeviceState_Held.
12157	</note>
12158
12159	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12160	</desc>
12161
12162	<const name="NotSupported" value="0">
12163	<desc>
12164	Not supported by the VirtualBox server, not available to guests.
12165	</desc>
12166	</const>
12167	<const name="Unavailable" value="1">
12168	<desc>
12169	Being used by the host computer exclusively,
12170	not available to guests.
12171	</desc>
12172	</const>
12173	<const name="Busy" value="2">
12174	<desc>
12175	Being used by the host computer, potentially available to guests.
12176	</desc>
12177	</const>
12178	<const name="Available" value="3">
12179	<desc>
12180	Not used by the host computer, available to guests (the host computer
12181	can also start using the device at any time).
12182	</desc>
12183	</const>
12184	<const name="Held" value="4">
12185	<desc>
12186	Held by the VirtualBox server (ignored by the host computer),
12187	available to guests.
12188	</desc>
12189	</const>
12190	<const name="Captured" value="5">
12191	<desc>
12192	Captured by one of the guest computers, not available
12193	to anybody else.
12194	</desc>
12195	</const>
12196	</enum>
12197
12198	<interface
12199	name="IHostUSBDevice" extends="IUSBDevice"
12200	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12201	wsmap="managed"
12202	>
12203	<desc>
12204	The IHostUSBDevice interface represents a physical USB device attached
12205	to the host computer.
12206
12207	Besides properties inherited from IUSBDevice, this interface adds the
12208	<link to="#state"/> property that holds the current state of the USB
12209	device.
12210
12211	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12212	</desc>
12213
12214	<attribute name="state" type="USBDeviceState" readonly="yes">
12215	<desc>
12216	Current state of the device.
12217	</desc>
12218	</attribute>
12219
12220	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12221
12222	</interface>
12223
12224
12225	<!--
12226	// IHostUSBDeviceFilter
12227	/////////////////////////////////////////////////////////////////////////
12228	-->
12229
12230	<enum
12231	name="USBDeviceFilterAction"
12232	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12233	>
12234	<desc>
12235	Actions for host USB device filters.
12236	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12237	</desc>
12238
12239	<const name="Null" value="0">
12240	<desc>Null value (never used by the API).</desc>
12241	</const>
12242	<const name="Ignore" value="1">
12243	<desc>Ignore the matched USB device.</desc>
12244	</const>
12245	<const name="Hold" value="2">
12246	<desc>Hold the matched USB device.</desc>
12247	</const>
12248	</enum>
12249
12250	<interface
12251	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12252	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12253	wsmap="managed"
12254	>
12255	<desc>
12256	The IHostUSBDeviceFilter interface represents a global filter for a
12257	physical USB device used by the host computer. Used indirectly in
12258	<link to="IHost::USBDeviceFilters"/>.
12259
12260	Using filters of this type, the host computer determines the initial
12261	state of the USB device after it is physically attached to the
12262	host's USB controller.
12263
12264	<note>
12265	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12266	filters, because it makes sense only for
12267	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12268	</note>
12269
12270	<see>IHost::USBDeviceFilters</see>
12271	</desc>
12272
12273	<attribute name="action" type="USBDeviceFilterAction">
12274	<desc>
12275	Action performed by the host when an attached USB device
12276	matches this filter.
12277	</desc>
12278	</attribute>
12279
12280	</interface>
12281
12282	<!--
12283	// IAudioAdapter
12284	/////////////////////////////////////////////////////////////////////////
12285	-->
12286
12287	<enum
12288	name="AudioDriverType"
12289	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12290	>
12291	<desc>
12292	Host audio driver type.
12293	</desc>
12294
12295	<const name="Null" value="0">
12296	<desc>Null value, also means "dummy audio driver".</desc>
12297	</const>
12298	<const name="WinMM" value="1">
12299	<desc>Windows multimedia (Windows hosts only).</desc>
12300	</const>
12301	<const name="OSS" value="2">
12302	<desc>Open Sound System (Linux hosts only).</desc>
12303	</const>
12304	<const name="ALSA" value="3">
12305	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12306	</const>
12307	<const name="DirectSound" value="4">
12308	<desc>DirectSound (Windows hosts only).</desc>
12309	</const>
12310	<const name="CoreAudio" value="5">
12311	<desc>CoreAudio (Mac hosts only).</desc>
12312	</const>
12313	<const name="MMPM" value="6">
12314	<desc>Reserved for historical reasons.</desc>
12315	</const>
12316	<const name="Pulse" value="7">
12317	<desc>PulseAudio (Linux hosts only).</desc>
12318	</const>
12319	<const name="SolAudio" value="8">
12320	<desc>Solaris audio (Solaris hosts only).</desc>
12321	</const>
12322	</enum>
12323
12324	<enum
12325	name="AudioControllerType"
12326	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12327	>
12328	<desc>
12329	Virtual audio controller type.
12330	</desc>
12331
12332	<const name="AC97" value="0"/>
12333	<const name="SB16" value="1"/>
12334	<const name="HDA" value="2"/>
12335	</enum>
12336
12337	<interface
12338	name="IAudioAdapter" extends="$unknown"
12339	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12340	wsmap="managed"
12341	>
12342	<desc>
12343	The IAudioAdapter interface represents the virtual audio adapter of
12344	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12345	</desc>
12346	<attribute name="enabled" type="boolean">
12347	<desc>
12348	Flag whether the audio adapter is present in the
12349	guest system. If disabled, the virtual guest hardware will
12350	not contain any audio adapter. Can only be changed when
12351	the VM is not running.
12352	</desc>
12353	</attribute>
12354	<attribute name="audioController" type="AudioControllerType">
12355	<desc>
12356	The audio hardware we emulate.
12357	</desc>
12358	</attribute>
12359	<attribute name="audioDriver" type="AudioDriverType">
12360	<desc>
12361	Audio driver the adapter is connected to. This setting
12362	can only be changed when the VM is not running.
12363	</desc>
12364	</attribute>
12365	</interface>
12366
12367	<enum
12368	name="AuthType"
12369	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
12370	>
12371	<desc>
12372	VirtualBox authentication type.
12373	</desc>
12374
12375	<const name="Null" value="0">
12376	<desc>Null value, also means "no authentication".</desc>
12377	</const>
12378	<const name="External" value="1"/>
12379	<const name="Guest" value="2"/>
12380	</enum>
12381
12382	<!--
12383	// IVRDEServer
12384	/////////////////////////////////////////////////////////////////////////
12385	-->
12386
12387	<interface
12388	name="IVRDEServer" extends="$unknown"
12389	uuid="f68a6b34-6f09-4040-8de1-e8d746c4a9ea"
12390	wsmap="managed"
12391	>
12392	<attribute name="enabled" type="boolean">
12393	<desc>VRDE server status.</desc>
12394	</attribute>
12395
12396	<attribute name="authType" type="AuthType">
12397	<desc>VRDE authentication method.</desc>
12398	</attribute>
12399
12400	<attribute name="authTimeout" type="unsigned long">
12401	<desc>Timeout for guest authentication. Milliseconds.</desc>
12402	</attribute>
12403
12404	<attribute name="allowMultiConnection" type="boolean">
12405	<desc>
12406	Flag whether multiple simultaneous connections to the VM are permitted.
12407	Note that this will be replaced by a more powerful mechanism in the future.
12408	</desc>
12409	</attribute>
12410
12411	<attribute name="reuseSingleConnection" type="boolean">
12412	<desc>
12413	Flag whether the existing connection must be dropped and a new connection
12414	must be established by the VRDE server, when a new client connects in single
12415	connection mode.
12416	</desc>
12417	</attribute>
12418
12419	<attribute name="videoChannel" type="boolean">
12420	<desc>
12421	Flag whether video redirectiron channel is enabled.
12422	</desc>
12423	</attribute>
12424
12425	<attribute name="videoChannelQuality" type="unsigned long">
12426	<desc>
12427	Image quality in percents.
12428	</desc>
12429	</attribute>
12430
12431	<method name="setVRDEProperty">
12432	<desc>
12433	Sets a VRDE specific property string.
12434
12435	If you pass @c null or empty string as a key @a value, the given @a key
12436	will be deleted.
12437
12438	</desc>
12439	<param name="key" type="wstring" dir="in">
12440	<desc>Name of the key to set.</desc>
12441	</param>
12442	<param name="value" type="wstring" dir="in">
12443	<desc>Value to assign to the key.</desc>
12444	</param>
12445	</method>
12446
12447	<method name="getVRDEProperty">
12448	<desc>
12449	Returns a VRDE specific property string.
12450
12451	If the requested data @a key does not exist, this function will
12452	succeed and return an empty string in the @a value argument.
12453
12454	</desc>
12455	<param name="key" type="wstring" dir="in">
12456	<desc>Name of the key to get.</desc>
12457	</param>
12458	<param name="value" type="wstring" dir="return">
12459	<desc>Value of the requested key.</desc>
12460	</param>
12461	</method>
12462
12463	</interface>
12464
12465
12466	<!--
12467	// ISharedFolder
12468	/////////////////////////////////////////////////////////////////////////
12469	-->
12470
12471	<interface
12472	name="ISharedFolder" extends="$unknown"
12473	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12474	wsmap="struct"
12475	>
12476	<desc>
12477	The ISharedFolder interface represents a folder in the host computer's
12478	file system accessible from the guest OS running inside a virtual
12479	machine using an associated logical name.
12480
12481	There are three types of shared folders:
12482	<ul>
12483	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12484	folders available to all virtual machines.</li>
12485	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12486	VM-specific shared folders available to the given virtual machine at
12487	startup.</li>
12488	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12489	VM-specific shared folders created in the session context (for
12490	example, when the virtual machine is running) and automatically
12491	discarded when the session is closed (the VM is powered off).</li>
12492	</ul>
12493
12494	Logical names of shared folders must be unique within the given scope
12495	(global, permanent or transient). However, they do not need to be unique
12496	across scopes. In this case, the definition of the shared folder in a
12497	more specific scope takes precedence over definitions in all other
12498	scopes. The order of precedence is (more specific to more general):
12499	<ol>
12500	<li>Transient definitions</li>
12501	<li>Permanent definitions</li>
12502	<li>Global definitions</li>
12503	</ol>
12504
12505	For example, if MyMachine has a shared folder named
12506	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12507	transient shared folder named <tt>C_DRIVE</tt> (that points
12508	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12509	of <tt>C_DRIVE</tt> in the guest OS so
12510	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12511	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12512	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12513	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12514	to <tt>C:\\</tt> if it still exists.
12515
12516	Note that permanent and transient shared folders of different machines
12517	are in different name spaces, so they don't overlap and don't need to
12518	have unique logical names.
12519
12520	<note>
12521	Global shared folders are not implemented in the current version of the
12522	product.
12523	</note>
12524	</desc>
12525
12526	<attribute name="name" type="wstring" readonly="yes">
12527	<desc>Logical name of the shared folder.</desc>
12528	</attribute>
12529
12530	<attribute name="hostPath" type="wstring" readonly="yes">
12531	<desc>Full path to the shared folder in the host file system.</desc>
12532	</attribute>
12533
12534	<attribute name="accessible" type="boolean" readonly="yes">
12535	<desc>
12536	Whether the folder defined by the host path is currently
12537	accessible or not.
12538	For example, the folder can be unaccessible if it is placed
12539	on the network share that is not available by the time
12540	this property is read.
12541	</desc>
12542	</attribute>
12543
12544	<attribute name="writable" type="boolean" readonly="yes">
12545	<desc>
12546	Whether the folder defined by the host path is writable or
12547	not.
12548	</desc>
12549	</attribute>
12550
12551	<attribute name="autoMount" type="boolean" readonly="yes">
12552	<desc>
12553	Whether the folder gets automatically mounted by the guest or not.
12554	</desc>
12555	</attribute>
12556
12557	<attribute name="lastAccessError" type="wstring" readonly="yes">
12558	<desc>
12559	Text message that represents the result of the last accessibility
12560	check.
12561
12562	Accessibility checks are performed each time the <link to="#accessible"/>
12563	attribute is read. An empty string is returned if the last
12564	accessibility check was successful. A non-empty string indicates a
12565	failure and should normally describe a reason of the failure (for
12566	example, a file read error).
12567	</desc>
12568	</attribute>
12569
12570	</interface>
12571
12572	<!--
12573	// ISession
12574	/////////////////////////////////////////////////////////////////////////
12575	-->
12576
12577	<interface
12578	name="IInternalSessionControl" extends="$unknown"
12579	uuid="06ef98a7-f7c0-45ba-bf99-9aca7a4d5530"
12580	internal="yes"
12581	wsmap="suppress"
12582	>
12583	<method name="getPID">
12584	<desc>PID of the process that has created this Session object.
12585	</desc>
12586	<param name="pid" type="unsigned long" dir="return"/>
12587	</method>
12588
12589	<method name="getRemoteConsole">
12590	<desc>
12591	Returns the console object suitable for remote control.
12592
12593	<result name="VBOX_E_INVALID_VM_STATE">
12594	Session state prevents operation.
12595	</result>
12596	<result name="VBOX_E_INVALID_OBJECT_STATE">
12597	Session type prevents operation.
12598	</result>
12599
12600	</desc>
12601	<param name="console" type="IConsole" dir="return"/>
12602	</method>
12603
12604	<method name="assignMachine">
12605	<desc>
12606	Assigns the machine object associated with this direct-type
12607	session or informs the session that it will be a remote one
12608	(if @a machine == @c null).
12609
12610	<result name="VBOX_E_INVALID_VM_STATE">
12611	Session state prevents operation.
12612	</result>
12613	<result name="VBOX_E_INVALID_OBJECT_STATE">
12614	Session type prevents operation.
12615	</result>
12616
12617	</desc>
12618	<param name="machine" type="IMachine" dir="in"/>
12619	</method>
12620
12621	<method name="assignRemoteMachine">
12622	<desc>
12623	Assigns the machine and the (remote) console object associated with
12624	this remote-type session.
12625
12626	<result name="VBOX_E_INVALID_VM_STATE">
12627	Session state prevents operation.
12628	</result>
12629
12630	</desc>
12631	<param name="machine" type="IMachine" dir="in"/>
12632	<param name="console" type="IConsole" dir="in"/>
12633	</method>
12634
12635	<method name="updateMachineState">
12636	<desc>
12637	Updates the machine state in the VM process.
12638	Must be called only in certain cases
12639	(see the method implementation).
12640
12641	<result name="VBOX_E_INVALID_VM_STATE">
12642	Session state prevents operation.
12643	</result>
12644	<result name="VBOX_E_INVALID_OBJECT_STATE">
12645	Session type prevents operation.
12646	</result>
12647
12648	</desc>
12649	<param name="aMachineState" type="MachineState" dir="in"/>
12650	</method>
12651
12652	<method name="uninitialize">
12653	<desc>
12654	Uninitializes (closes) this session. Used by VirtualBox to close
12655	the corresponding remote session when the direct session dies
12656	or gets closed.
12657
12658	<result name="VBOX_E_INVALID_VM_STATE">
12659	Session state prevents operation.
12660	</result>
12661
12662	</desc>
12663	</method>
12664
12665	<method name="onNetworkAdapterChange">
12666	<desc>
12667	Triggered when settings of a network adapter of the
12668	associated virtual machine have changed.
12669
12670	<result name="VBOX_E_INVALID_VM_STATE">
12671	Session state prevents operation.
12672	</result>
12673	<result name="VBOX_E_INVALID_OBJECT_STATE">
12674	Session type prevents operation.
12675	</result>
12676
12677	</desc>
12678	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12679	<param name="changeAdapter" type="boolean" dir="in"/>
12680	</method>
12681
12682	<method name="onSerialPortChange">
12683	<desc>
12684	Triggered when settings of a serial port of the
12685	associated virtual machine have changed.
12686
12687	<result name="VBOX_E_INVALID_VM_STATE">
12688	Session state prevents operation.
12689	</result>
12690	<result name="VBOX_E_INVALID_OBJECT_STATE">
12691	Session type prevents operation.
12692	</result>
12693
12694	</desc>
12695	<param name="serialPort" type="ISerialPort" dir="in"/>
12696	</method>
12697
12698	<method name="onParallelPortChange">
12699	<desc>
12700	Triggered when settings of a parallel port of the
12701	associated virtual machine have changed.
12702
12703	<result name="VBOX_E_INVALID_VM_STATE">
12704	Session state prevents operation.
12705	</result>
12706	<result name="VBOX_E_INVALID_OBJECT_STATE">
12707	Session type prevents operation.
12708	</result>
12709
12710	</desc>
12711	<param name="parallelPort" type="IParallelPort" dir="in"/>
12712	</method>
12713
12714	<method name="onStorageControllerChange">
12715	<desc>
12716	Triggered when settings of a storage controller of the
12717	associated virtual machine have changed.
12718
12719	<result name="VBOX_E_INVALID_VM_STATE">
12720	Session state prevents operation.
12721	</result>
12722	<result name="VBOX_E_INVALID_OBJECT_STATE">
12723	Session type prevents operation.
12724	</result>
12725
12726	</desc>
12727	</method>
12728
12729	<method name="onMediumChange">
12730	<desc>
12731	Triggered when attached media of the
12732	associated virtual machine have changed.
12733
12734	<result name="VBOX_E_INVALID_VM_STATE">
12735	Session state prevents operation.
12736	</result>
12737	<result name="VBOX_E_INVALID_OBJECT_STATE">
12738	Session type prevents operation.
12739	</result>
12740
12741	</desc>
12742
12743	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12744	<param name="force" type="boolean" dir="in"/>
12745	</method>
12746
12747	<method name="onCPUChange">
12748	<desc>
12749	Notification when a CPU changes.
12750	</desc>
12751	<param name="cpu" type="unsigned long" dir="in">
12752	<desc>The CPU which changed</desc>
12753	</param>
12754	<param name="add" type="boolean" dir="in">
12755	<desc>Flag whether the CPU was added or removed</desc>
12756	</param>
12757	</method>
12758
12759	<method name="onCPUExecutionCapChange">
12760	<desc>
12761	Notification when the CPU execution cap changes.
12762	</desc>
12763	<param name="executionCap" type="unsigned long" dir="in">
12764	<desc>The new CPU execution cap value. (1-100)</desc>
12765	</param>
12766	</method>
12767
12768	<method name="onVRDEServerChange">
12769	<desc>
12770	Triggered when settings of the VRDE server object of the
12771	associated virtual machine have changed.
12772
12773	<result name="VBOX_E_INVALID_VM_STATE">
12774	Session state prevents operation.
12775	</result>
12776	<result name="VBOX_E_INVALID_OBJECT_STATE">
12777	Session type prevents operation.
12778	</result>
12779
12780	</desc>
12781	<param name="restart" type="boolean" dir="in">
12782	<desc>Flag whether the server must be restarted</desc>
12783	</param>
12784	</method>
12785
12786	<method name="onUSBControllerChange">
12787	<desc>
12788	Triggered when settings of the USB controller object of the
12789	associated virtual machine have changed.
12790
12791	<result name="VBOX_E_INVALID_VM_STATE">
12792	Session state prevents operation.
12793	</result>
12794	<result name="VBOX_E_INVALID_OBJECT_STATE">
12795	Session type prevents operation.
12796	</result>
12797
12798	</desc>
12799	</method>
12800
12801	<method name="onSharedFolderChange">
12802	<desc>
12803	Triggered when a permanent (global or machine) shared folder has been
12804	created or removed.
12805	<note>
12806	We don't pass shared folder parameters in this notification because
12807	the order in which parallel notifications are delivered is not defined,
12808	therefore it could happen that these parameters were outdated by the
12809	time of processing this notification.
12810	</note>
12811
12812	<result name="VBOX_E_INVALID_VM_STATE">
12813	Session state prevents operation.
12814	</result>
12815	<result name="VBOX_E_INVALID_OBJECT_STATE">
12816	Session type prevents operation.
12817	</result>
12818
12819	</desc>
12820	<param name="global" type="boolean" dir="in"/>
12821	</method>
12822
12823	<method name="onUSBDeviceAttach">
12824	<desc>
12825	Triggered when a request to capture a USB device (as a result
12826	of matched USB filters or direct call to
12827	<link to="IConsole::attachUSBDevice"/>) has completed.
12828	A @c null @a error object means success, otherwise it
12829	describes a failure.
12830
12831	<result name="VBOX_E_INVALID_VM_STATE">
12832	Session state prevents operation.
12833	</result>
12834	<result name="VBOX_E_INVALID_OBJECT_STATE">
12835	Session type prevents operation.
12836	</result>
12837
12838	</desc>
12839	<param name="device" type="IUSBDevice" dir="in"/>
12840	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12841	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12842	</method>
12843
12844	<method name="onUSBDeviceDetach">
12845	<desc>
12846	Triggered when a request to release the USB device (as a result
12847	of machine termination or direct call to
12848	<link to="IConsole::detachUSBDevice"/>) has completed.
12849	A @c null @a error object means success, otherwise it
12850	describes a failure.
12851
12852	<result name="VBOX_E_INVALID_VM_STATE">
12853	Session state prevents operation.
12854	</result>
12855	<result name="VBOX_E_INVALID_OBJECT_STATE">
12856	Session type prevents operation.
12857	</result>
12858
12859	</desc>
12860	<param name="id" type="uuid" mod="string" dir="in"/>
12861	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12862	</method>
12863
12864	<method name="onShowWindow">
12865	<desc>
12866	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12867	<link to="IMachine::showConsoleWindow"/> in order to notify
12868	console listeners
12869	<link to="ICanShowWindowEvent"/>
12870	and <link to="IShowWindowEvent"/>.
12871
12872	<result name="VBOX_E_INVALID_OBJECT_STATE">
12873	Session type prevents operation.
12874	</result>
12875
12876	</desc>
12877	<param name="check" type="boolean" dir="in"/>
12878	<param name="canShow" type="boolean" dir="out"/>
12879	<param name="winId" type="long long" dir="out"/>
12880	</method>
12881
12882	<method name="accessGuestProperty">
12883	<desc>
12884	Called by <link to="IMachine::getGuestProperty"/> and by
12885	<link to="IMachine::setGuestProperty"/> in order to read and
12886	modify guest properties.
12887
12888	<result name="VBOX_E_INVALID_VM_STATE">
12889	Machine session is not open.
12890	</result>
12891	<result name="VBOX_E_INVALID_OBJECT_STATE">
12892	Session type is not direct.
12893	</result>
12894
12895	</desc>
12896	<param name="name" type="wstring" dir="in"/>
12897	<param name="value" type="wstring" dir="in"/>
12898	<param name="flags" type="wstring" dir="in"/>
12899	<param name="isSetter" type="boolean" dir="in"/>
12900	<param name="retValue" type="wstring" dir="out"/>
12901	<param name="retTimestamp" type="long long" dir="out"/>
12902	<param name="retFlags" type="wstring" dir="out"/>
12903	</method>
12904
12905	<method name="enumerateGuestProperties">
12906	<desc>
12907	Return a list of the guest properties matching a set of patterns along
12908	with their values, time stamps and flags.
12909
12910	<result name="VBOX_E_INVALID_VM_STATE">
12911	Machine session is not open.
12912	</result>
12913	<result name="VBOX_E_INVALID_OBJECT_STATE">
12914	Session type is not direct.
12915	</result>
12916
12917	</desc>
12918	<param name="patterns" type="wstring" dir="in">
12919	<desc>
12920	The patterns to match the properties against as a comma-separated
12921	string. If this is empty, all properties currently set will be
12922	returned.
12923	</desc>
12924	</param>
12925	<param name="key" type="wstring" dir="out" safearray="yes">
12926	<desc>
12927	The key names of the properties returned.
12928	</desc>
12929	</param>
12930	<param name="value" type="wstring" dir="out" safearray="yes">
12931	<desc>
12932	The values of the properties returned. The array entries match the
12933	corresponding entries in the @a key array.
12934	</desc>
12935	</param>
12936	<param name="timestamp" type="long long" dir="out" safearray="yes">
12937	<desc>
12938	The time stamps of the properties returned. The array entries match
12939	the corresponding entries in the @a key array.
12940	</desc>
12941	</param>
12942	<param name="flags" type="wstring" dir="out" safearray="yes">
12943	<desc>
12944	The flags of the properties returned. The array entries match the
12945	corresponding entries in the @a key array.
12946	</desc>
12947	</param>
12948	</method>
12949
12950	<method name="onlineMergeMedium">
12951	<desc>
12952	Triggers online merging of a hard disk. Used internally when deleting
12953	a snapshot while a VM referring to the same hard disk chain is running.
12954
12955	<result name="VBOX_E_INVALID_VM_STATE">
12956	Machine session is not open.
12957	</result>
12958	<result name="VBOX_E_INVALID_OBJECT_STATE">
12959	Session type is not direct.
12960	</result>
12961
12962	</desc>
12963	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
12964	<desc>The medium attachment to identify the medium chain.</desc>
12965	</param>
12966	<param name="sourceIdx" type="unsigned long" dir="in">
12967	<desc>The index of the source image in the chain.
12968	Redundant, but drastically reduces IPC.</desc>
12969	</param>
12970	<param name="targetIdx" type="unsigned long" dir="in">
12971	<desc>The index of the target image in the chain.
12972	Redundant, but drastically reduces IPC.</desc>
12973	</param>
12974	<param name="source" type="IMedium" dir="in">
12975	<desc>Merge source medium.</desc>
12976	</param>
12977	<param name="target" type="IMedium" dir="in">
12978	<desc>Merge target medium.</desc>
12979	</param>
12980	<param name="mergeForward" type="boolean" dir="in">
12981	<desc>Merge direction.</desc>
12982	</param>
12983	<param name="parentForTarget" type="IMedium" dir="in">
12984	<desc>For forward merges: new parent for target medium.</desc>
12985	</param>
12986	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
12987	<desc>For backward merges: list of media which need their parent UUID
12988	updated.</desc>
12989	</param>
12990	<param name="progress" type="IProgress" dir="in">
12991	<desc>
12992	Progress object for this operation.
12993	</desc>
12994	</param>
12995	</method>
12996
12997	</interface>
12998
12999	<interface
13000	name="ISession" extends="$unknown"
13001	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13002	wsmap="managed"
13003	>
13004	<desc>
13005	The ISession interface represents a client process and allows for locking
13006	virtual machines (represented by IMachine objects) to prevent conflicting
13007	changes to the machine.
13008
13009	Any caller wishing to manipulate a virtual machine needs to create a session
13010	object first, which lives in its own process space. Such session objects are
13011	then associated with <link to="IMachine" /> objects living in the VirtualBox
13012	server process to coordinate such changes.
13013
13014	There are two typical scenarios in which sessions are used:
13015
13016	<ul>
13017	<li>To alter machine settings or control a running virtual machine, one
13018	needs to lock a machine for a given session (client process) by calling
13019	<link to="IMachine::lockMachine"/>.
13020
13021	Whereas multiple sessions may control a running virtual machine, only
13022	one process can obtain a write lock on the machine to prevent conflicting
13023	changes. A write lock is also needed if a process wants to actually run a
13024	virtual machine in its own context, such as the VirtualBox GUI or
13025	VBoxHeadless front-ends. They must also lock a machine for their own
13026	sessions before they are allowed to power up the virtual machine.
13027
13028	As a result, no machine settings can be altered while another process is
13029	already using it, either because that process is modifying machine settings
13030	or because the machine is running.
13031	</li>
13032	<li>
13033	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13034	VirtualBox GUI or VBoxHeadless), one would use
13035	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13036	as its first parameter. This session then identifies the caller and lets the
13037	caller control the started machine (for example, pause machine execution or
13038	power it down) as well as be notified about machine execution state changes.
13039	</li>
13040	</ul>
13041
13042	How sessions objects are created in a client process depends on whether you use
13043	the Main API via COM or via the webservice:
13044
13045	<ul>
13046	<li>When using the COM API directly, an object of the Session class from the
13047	VirtualBox type library needs to be created. In regular COM C++ client code,
13048	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13049	This object will then act as a local session object in further calls to open
13050	a session.
13051	</li>
13052
13053	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13054	a session object automatically whenever <link to="IWebsessionManager::logon" />
13055	is called. A managed object reference to that session object can be retrieved by
13056	calling <link to="IWebsessionManager::getSessionObject" />.
13057	</li>
13058	</ul>
13059	</desc>
13060
13061	<attribute name="state" type="SessionState" readonly="yes">
13062	<desc>Current state of this session.</desc>
13063	</attribute>
13064
13065	<attribute name="type" type="SessionType" readonly="yes">
13066	<desc>
13067	Type of this session. The value of this attribute is valid only
13068	if the session currently has a machine locked (i.e. its
13069	<link to="#state" /> is Locked), otherwise an error will be returned.
13070	</desc>
13071	</attribute>
13072
13073	<attribute name="machine" type="IMachine" readonly="yes">
13074	<desc>Machine object associated with this session.</desc>
13075	</attribute>
13076
13077	<attribute name="console" type="IConsole" readonly="yes">
13078	<desc>Console object associated with this session.</desc>
13079	</attribute>
13080
13081	<method name="unlockMachine">
13082	<desc>
13083	Unlocks a machine that was previously locked for the current session.
13084
13085	Calling this method is required every time a machine has been locked
13086	for a particular session using the <link to="IMachine::launchVMProcess" />
13087	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13088	the machine will be set to <link to="MachineState_Aborted" /> on the
13089	server, and changes made to the machine settings will be lost.
13090
13091	Generally, it is recommended to unlock all machines explicitly
13092	before terminating the application (regardless of the reason for
13093	the termination).
13094
13095	<note>
13096	Do not expect the session state (<link to="ISession::state" />
13097	to return to "Unlocked" immediately after you invoke this method,
13098	particularly if you have started a new VM process. The session
13099	state will automatically return to "Unlocked" once the VM is no
13100	longer executing, which can of course take a very long time.
13101	</note>
13102
13103	<result name="E_UNEXPECTED">
13104	Session is not locked.
13105	</result>
13106
13107	</desc>
13108	</method>
13109
13110	</interface>
13111
13112	<!--
13113	// IStorageController
13114	/////////////////////////////////////////////////////////////////////////
13115	-->
13116
13117	<enum
13118	name="StorageBus"
13119	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13120	>
13121	<desc>
13122	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13123	see <link to="IStorageController::bus" />.
13124	</desc>
13125	<const name="Null" value="0">
13126	<desc>@c null value. Never used by the API.</desc>
13127	</const>
13128	<const name="IDE" value="1"/>
13129	<const name="SATA" value="2"/>
13130	<const name="SCSI" value="3"/>
13131	<const name="Floppy" value="4"/>
13132	<const name="SAS" value="5"/>
13133	</enum>
13134
13135	<enum
13136	name="StorageControllerType"
13137	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13138	>
13139	<desc>
13140	The exact variant of storage controller hardware presented
13141	to the guest; see <link to="IStorageController::controllerType" />.
13142	</desc>
13143
13144	<const name="Null" value="0">
13145	<desc>@c null value. Never used by the API.</desc>
13146	</const>
13147	<const name="LsiLogic" value="1">
13148	<desc>A SCSI controller of the LsiLogic variant.</desc>
13149	</const>
13150	<const name="BusLogic" value="2">
13151	<desc>A SCSI controller of the BusLogic variant.</desc>
13152	</const>
13153	<const name="IntelAhci" value="3">
13154	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13155	</const>
13156	<const name="PIIX3" value="4">
13157	<desc>An IDE controller of the PIIX3 variant.</desc>
13158	</const>
13159	<const name="PIIX4" value="5">
13160	<desc>An IDE controller of the PIIX4 variant.</desc>
13161	</const>
13162	<const name="ICH6" value="6">
13163	<desc>An IDE controller of the ICH6 variant.</desc>
13164	</const>
13165	<const name="I82078" value="7">
13166	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13167	</const>
13168	<const name="LsiLogicSas" value="8">
13169	<desc>A variant of the LsiLogic controller using SAS.</desc>
13170	</const>
13171	</enum>
13172
13173	<enum
13174	name="ChipsetType"
13175	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13176	>
13177	<desc>
13178	Type of emulated chipset (mostly southbridge).
13179	</desc>
13180
13181	<const name="Null" value="0">
13182	<desc>@c null value. Never used by the API.</desc>
13183	</const>
13184	<const name="PIIX3" value="1">
13185	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13186	</const>
13187	<const name="ICH9" value="2">
13188	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13189	</const>
13190	</enum>
13191
13192	<interface
13193	name="IStorageController" extends="$unknown"
13194	uuid="fd93adc0-bbaa-4256-9e6e-00e29f9151c9"
13195	wsmap="managed"
13196	>
13197	<desc>
13198	Represents a storage controller that is attached to a virtual machine
13199	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13200	attached to storage controllers in a real computer, virtual drives
13201	(represented by <link to="IMediumAttachment" />) are attached to virtual
13202	storage controllers, represented by this interface.
13203
13204	As opposed to physical hardware, VirtualBox has a very generic concept
13205	of a storage controller, and for purposes of the Main API, all virtual
13206	storage is attached to virtual machines via instances of this interface.
13207	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13208	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13209	is used, certain sub-types may be available and can be selected in
13210	<link to="#controllerType" />.
13211
13212	Depending on these settings, the guest operating system might see
13213	significantly different virtual hardware.
13214	</desc>
13215
13216	<attribute name="name" type="wstring" readonly="yes">
13217	<desc>
13218	Name of the storage controller, as originally specified with
13219	<link to="IMachine::addStorageController" />. This then uniquely
13220	identifies this controller with other method calls such as
13221	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13222	</desc>
13223	</attribute>
13224
13225	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13226	<desc>
13227	Maximum number of devices which can be attached to one port.
13228	</desc>
13229	</attribute>
13230
13231	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13232	<desc>
13233	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13234	</desc>
13235	</attribute>
13236
13237	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13238	<desc>
13239	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13240	</desc>
13241	</attribute>
13242
13243	<attribute name="instance" type="unsigned long">
13244	<desc>
13245	The instance number of the device in the running VM.
13246	</desc>
13247	</attribute>
13248
13249	<attribute name="portCount" type="unsigned long">
13250	<desc>
13251	The number of currently usable ports on the controller.
13252	The minimum and maximum number of ports for one controller are
13253	stored in <link to="IStorageController::minPortCount"/>
13254	and <link to="IStorageController::maxPortCount"/>.
13255	</desc>
13256	</attribute>
13257
13258	<attribute name="bus" type="StorageBus" readonly="yes">
13259	<desc>
13260	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13261	</desc>
13262	</attribute>
13263
13264	<attribute name="controllerType" type="StorageControllerType">
13265	<desc>
13266	The exact variant of storage controller hardware presented
13267	to the guest.
13268	Depending on this value, VirtualBox will provide a different
13269	virtual storage controller hardware to the guest.
13270	For SATA, SAS and floppy controllers, only one variant is
13271	available, but for IDE and SCSI, there are several.
13272
13273	For SCSI controllers, the default type is LsiLogic.
13274	</desc>
13275	</attribute>
13276
13277	<attribute name="useHostIOCache" type="boolean">
13278	<desc>
13279	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13280	caches and use synchronous file APIs on the host. This was the only option in the API before
13281	VirtualBox 3.2 and is still the default for IDE controllers.
13282
13283	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13284	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13285	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13286	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13287	virtual machines are running at the same time to prevent I/O cache related hangs.
13288	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13289	</desc>
13290	</attribute>
13291
13292	<method name="getIDEEmulationPort">
13293	<desc>
13294	Gets the corresponding port number which is emulated as an IDE device.
13295	Works only with SATA controllers.
13296
13297	<result name="E_INVALIDARG">
13298	The @a devicePosition is not in the range 0 to 3.
13299	</result>
13300	<result name="E_NOTIMPL">
13301	The storage controller type is not SATAIntelAhci.
13302	</result>
13303
13304	</desc>
13305	<param name="devicePosition" type="long" dir="in"/>
13306	<param name="portNumber" type="long" dir="return"/>
13307	</method>
13308
13309	<method name="setIDEEmulationPort">
13310	<desc>
13311	Sets the port number which is emulated as an IDE device.
13312	Works only with SATA controllers.
13313
13314	<result name="E_INVALIDARG">
13315	The @a devicePosition is not in the range 0 to 3 or the
13316	@a portNumber is not in the range 0 to 29.
13317	</result>
13318	<result name="E_NOTIMPL">
13319	The storage controller type is not SATAIntelAhci.
13320	</result>
13321
13322	</desc>
13323	<param name="devicePosition" type="long" dir="in"/>
13324	<param name="portNumber" type="long" dir="in"/>
13325	</method>
13326
13327	</interface>
13328
13329	<if target="wsdl">
13330
13331	<!--
13332	// IManagedObjectRef
13333	/////////////////////////////////////////////////////////////////////////
13334	-->
13335
13336	<interface
13337	name="IManagedObjectRef" extends="$unknown"
13338	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13339	internal="yes"
13340	wsmap="managed"
13341	wscpp="hardcoded"
13342	>
13343	<desc>
13344	Managed object reference.
13345
13346	Only within the webservice, a managed object reference (which is really
13347	an opaque number) allows a webservice client to address an object
13348	that lives in the address space of the webservice server.
13349
13350	Behind each managed object reference, there is a COM object that lives
13351	in the webservice server's address space. The COM object is not freed
13352	until the managed object reference is released, either by an explicit
13353	call to <link to="IManagedObjectRef::release" /> or by logging off from
13354	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13355	all objects created during the webservice session.
13356
13357	Whenever a method call of the VirtualBox API returns a COM object, the
13358	webservice representation of that method will instead return a
13359	managed object reference, which can then be used to invoke methods
13360	on that object.
13361	</desc>
13362
13363	<method name="getInterfaceName">
13364	<desc>
13365	Returns the name of the interface that this managed object represents,
13366	for example, "IMachine", as a string.
13367	</desc>
13368	<param name="return" type="wstring" dir="return"/>
13369	</method>
13370
13371	<method name="release">
13372	<desc>
13373	Releases this managed object reference and frees the resources that
13374	were allocated for it in the webservice server process. After calling
13375	this method, the identifier of the reference can no longer be used.
13376	</desc>
13377	</method>
13378
13379	</interface>
13380
13381	<!--
13382	// IWebsessionManager
13383	/////////////////////////////////////////////////////////////////////////
13384	-->
13385
13386	<interface
13387	name="IWebsessionManager" extends="$unknown"
13388	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13389	internal="yes"
13390	wsmap="global"
13391	wscpp="hardcoded"
13392	>
13393	<desc>
13394	Websession manager. This provides essential services
13395	to webservice clients.
13396	</desc>
13397	<method name="logon">
13398	<desc>
13399	Logs a new client onto the webservice and returns a managed object reference to
13400	the IVirtualBox instance, which the client can then use as a basis to further
13401	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13402	interface, in one way or the other.
13403	</desc>
13404	<param name="username" type="wstring" dir="in"/>
13405	<param name="password" type="wstring" dir="in"/>
13406	<param name="return" type="IVirtualBox" dir="return"/>
13407	</method>
13408
13409	<method name="getSessionObject">
13410	<desc>
13411	Returns a managed object reference to the internal ISession object that was created
13412	for this web service session when the client logged on.
13413
13414	<see>ISession</see>
13415	</desc>
13416	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13417	<param name="return" type="ISession" dir="return"/>
13418	</method>
13419
13420	<method name="logoff">
13421	<desc>
13422	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13423	and destroys all resources associated with the session (most importantly, all
13424	managed objects created in the server while the session was active).
13425	</desc>
13426	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13427	</method>
13428
13429	</interface>
13430
13431	</if>
13432
13433	<!--
13434	// IPerformanceCollector & friends
13435	/////////////////////////////////////////////////////////////////////////
13436	-->
13437
13438	<interface
13439	name="IPerformanceMetric" extends="$unknown"
13440	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13441	>
13442	<desc>
13443	The IPerformanceMetric interface represents parameters of the given
13444	performance metric.
13445	</desc>
13446
13447	<attribute name="metricName" type="wstring" readonly="yes">
13448	<desc>
13449	Name of the metric.
13450	</desc>
13451	</attribute>
13452
13453	<attribute name="object" type="$unknown" readonly="yes">
13454	<desc>
13455	Object this metric belongs to.
13456	</desc>
13457	</attribute>
13458
13459	<attribute name="description" type="wstring" readonly="yes">
13460	<desc>
13461	Textual description of the metric.
13462	</desc>
13463	</attribute>
13464
13465	<attribute name="period" type="unsigned long" readonly="yes">
13466	<desc>
13467	Time interval between samples, measured in seconds.
13468	</desc>
13469	</attribute>
13470
13471	<attribute name="count" type="unsigned long" readonly="yes">
13472	<desc>
13473	Number of recent samples retained by the performance collector for this
13474	metric.
13475
13476	When the collected sample count exceeds this number, older samples
13477	are discarded.
13478	</desc>
13479	</attribute>
13480
13481	<attribute name="unit" type="wstring" readonly="yes">
13482	<desc>
13483	Unit of measurement.
13484	</desc>
13485	</attribute>
13486
13487	<attribute name="minimumValue" type="long" readonly="yes">
13488	<desc>
13489	Minimum possible value of this metric.
13490	</desc>
13491	</attribute>
13492
13493	<attribute name="maximumValue" type="long" readonly="yes">
13494	<desc>
13495	Maximum possible value of this metric.
13496	</desc>
13497	</attribute>
13498	</interface>
13499
13500	<interface
13501	name="IPerformanceCollector" extends="$unknown"
13502	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13503	wsmap="managed"
13504	>
13505	<desc>
13506	The IPerformanceCollector interface represents a service that collects
13507	and stores performance metrics data.
13508
13509	Performance metrics are associated with objects of interfaces like IHost
13510	and IMachine. Each object has a distinct set of performance metrics. The
13511	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13512
13513	Metric data is collected at the specified intervals and is retained
13514	internally. The interval and the number of retained samples can be set
13515	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13516	and collection settings are not persistent, they are discarded as soon as
13517	VBoxSVC process terminates. Moreover, metric settings and data associated
13518	with a particular VM only exist while VM is running. They disappear as
13519	soon as VM shuts down. It is not possible to set up metrics for machines
13520	that are powered off. One needs to start VM first, then set up metric
13521	collection parameters.
13522
13523	Metrics are organized hierarchically, with each level separated by a
13524	slash (/) character. Generally, the scheme for metric names is like this:
13525
13526	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13527
13528	"Category/Metric" together form the base metric name. A base metric is
13529	the smallest unit for which a sampling interval and the number of
13530	retained samples can be set. Only base metrics can be enabled and
13531	disabled. All sub-metrics are collected when their base metric is
13532	collected. Collected values for any set of sub-metrics can be queried
13533	with <link to="IPerformanceCollector::queryMetricsData" />.
13534
13535	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13536	category, "Load" metric, "User" submetric, "average" aggregate. An
13537	aggregate function is computed over all retained data. Valid aggregate
13538	functions are:
13539
13540	<ul>
13541	<li>avg -- average</li>
13542	<li>min -- minimum</li>
13543	<li>max -- maximum</li>
13544	</ul>
13545
13546	When setting up metric parameters, querying metric data, enabling or
13547	disabling metrics wildcards can be used in metric names to specify a
13548	subset of metrics. For example, to select all CPU-related metrics
13549	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13550	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13551
13552	The valid names for base metrics are:
13553
13554	<ul>
13555	<li>CPU/Load</li>
13556	<li>CPU/MHz</li>
13557	<li>RAM/Usage</li>
13558	</ul>
13559
13560	The general sequence for collecting and retrieving the metrics is:
13561	<ul>
13562	<li>
13563	Obtain an instance of IPerformanceCollector with
13564	<link to="IVirtualBox::performanceCollector" />
13565	</li>
13566	<li>
13567	Allocate and populate an array with references to objects the metrics
13568	will be collected for. Use references to IHost and IMachine objects.
13569	</li>
13570	<li>
13571	Allocate and populate an array with base metric names the data will
13572	be collected for.
13573	</li>
13574	<li>
13575	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13576	the metric data will be collected and stored.
13577	</li>
13578	<li>
13579	Wait for the data to get collected.
13580	</li>
13581	<li>
13582	Allocate and populate an array with references to objects the metric
13583	values will be queried for. You can re-use the object array used for
13584	setting base metrics.
13585	</li>
13586	<li>
13587	Allocate and populate an array with metric names the data will be
13588	collected for. Note that metric names differ from base metric names.
13589	</li>
13590	<li>
13591	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13592	that have been collected so far are returned. Note that the values
13593	are still retained internally and data collection continues.
13594	</li>
13595	</ul>
13596
13597	For an example of usage refer to the following files in VirtualBox SDK:
13598	<ul>
13599	<li>
13600	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13601	</li>
13602	<li>
13603	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13604	</li>
13605	</ul>
13606	</desc>
13607
13608	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13609	<desc>
13610	Array of unique names of metrics.
13611
13612	This array represents all metrics supported by the performance
13613	collector. Individual objects do not necessarily support all of them.
13614	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13615	list of supported metrics for a particular object.
13616	</desc>
13617	</attribute>
13618
13619	<method name="getMetrics">
13620	<desc>
13621	Returns parameters of specified metrics for a set of objects.
13622	<note>
13623	@c Null metrics array means all metrics. @c Null object array means
13624	all existing objects.
13625	</note>
13626	</desc>
13627	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13628	<desc>
13629	Metric name filter. Currently, only a comma-separated list of metrics
13630	is supported.
13631	</desc>
13632	</param>
13633	<param name="objects" type="$unknown" dir="in" safearray="yes">
13634	<desc>
13635	Set of objects to return metric parameters for.
13636	</desc>
13637	</param>
13638	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13639	<desc>
13640	Array of returned metric parameters.
13641	</desc>
13642	</param>
13643	</method>
13644
13645	<method name="setupMetrics">
13646	<desc>
13647	Sets parameters of specified base metrics for a set of objects. Returns
13648	an array of <link to="IPerformanceMetric" /> describing the metrics
13649	have been affected.
13650	<note>
13651	@c Null or empty metric name array means all metrics. @c Null or
13652	empty object array means all existing objects. If metric name array
13653	contains a single element and object array contains many, the single
13654	metric name array element is applied to each object array element to
13655	form metric/object pairs.
13656	</note>
13657	</desc>
13658	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13659	<desc>
13660	Metric name filter. Comma-separated list of metrics with wildcard
13661	support.
13662	</desc>
13663	</param>
13664	<param name="objects" type="$unknown" dir="in" safearray="yes">
13665	<desc>
13666	Set of objects to setup metric parameters for.
13667	</desc>
13668	</param>
13669	<param name="period" type="unsigned long" dir="in">
13670	<desc>
13671	Time interval in seconds between two consecutive samples of
13672	performance data.
13673	</desc>
13674	</param>
13675	<param name="count" type="unsigned long" dir="in">
13676	<desc>
13677	Number of samples to retain in performance data history. Older
13678	samples get discarded.
13679	</desc>
13680	</param>
13681	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13682	<desc>
13683	Array of metrics that have been modified by the call to this method.
13684	</desc>
13685	</param>
13686	</method>
13687
13688	<method name="enableMetrics">
13689	<desc>
13690	Turns on collecting specified base metrics. Returns an array of
13691	<link to="IPerformanceMetric" /> describing the metrics have been
13692	affected.
13693	<note>
13694	@c Null or empty metric name array means all metrics. @c Null or
13695	empty object array means all existing objects. If metric name array
13696	contains a single element and object array contains many, the single
13697	metric name array element is applied to each object array element to
13698	form metric/object pairs.
13699	</note>
13700	</desc>
13701	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13702	<desc>
13703	Metric name filter. Comma-separated list of metrics with wildcard
13704	support.
13705	</desc>
13706	</param>
13707	<param name="objects" type="$unknown" dir="in" safearray="yes">
13708	<desc>
13709	Set of objects to enable metrics for.
13710	</desc>
13711	</param>
13712	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13713	<desc>
13714	Array of metrics that have been modified by the call to this method.
13715	</desc>
13716	</param>
13717	</method>
13718
13719	<method name="disableMetrics">
13720	<desc>
13721	Turns off collecting specified base metrics. Returns an array of
13722	<link to="IPerformanceMetric" /> describing the metrics have been
13723	affected.
13724	<note>
13725	@c Null or empty metric name array means all metrics. @c Null or
13726	empty object array means all existing objects. If metric name array
13727	contains a single element and object array contains many, the single
13728	metric name array element is applied to each object array element to
13729	form metric/object pairs.
13730	</note>
13731	</desc>
13732	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13733	<desc>
13734	Metric name filter. Comma-separated list of metrics with wildcard
13735	support.
13736	</desc>
13737	</param>
13738	<param name="objects" type="$unknown" dir="in" safearray="yes">
13739	<desc>
13740	Set of objects to disable metrics for.
13741	</desc>
13742	</param>
13743	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13744	<desc>
13745	Array of metrics that have been modified by the call to this method.
13746	</desc>
13747	</param>
13748	</method>
13749
13750	<method name="queryMetricsData">
13751	<desc>
13752	Queries collected metrics data for a set of objects.
13753
13754	The data itself and related metric information are returned in seven
13755	parallel and one flattened array of arrays. Elements of
13756	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13757	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13758	the same index describe one set of values corresponding to a single
13759	metric.
13760
13761	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13762	start and length of a sub-array is indicated by
13763	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13764	value for metric <tt>metricNames[i]</tt> is at
13765	<tt>returnData[returnIndices[i]]</tt>.
13766
13767	<note>
13768	@c Null or empty metric name array means all metrics. @c Null or
13769	empty object array means all existing objects. If metric name array
13770	contains a single element and object array contains many, the single
13771	metric name array element is applied to each object array element to
13772	form metric/object pairs.
13773	</note>
13774	<note>
13775	Data collection continues behind the scenes after call to @c
13776	queryMetricsData. The return data can be seen as the snapshot of the
13777	current state at the time of @c queryMetricsData call. The internally
13778	kept metric values are not cleared by the call. This makes possible
13779	querying different subsets of metrics or aggregates with subsequent
13780	calls. If periodic querying is needed it is highly suggested to query
13781	the values with @c interval*count period to avoid confusion. This way
13782	a completely new set of data values will be provided by each query.
13783	</note>
13784	</desc>
13785	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13786	<desc>
13787	Metric name filter. Comma-separated list of metrics with wildcard
13788	support.
13789	</desc>
13790	</param>
13791	<param name="objects" type="$unknown" dir="in" safearray="yes">
13792	<desc>
13793	Set of objects to query metrics for.
13794	</desc>
13795	</param>
13796	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13797	<desc>
13798	Names of metrics returned in @c returnData.
13799	</desc>
13800	</param>
13801	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13802	<desc>
13803	Objects associated with metrics returned in @c returnData.
13804	</desc>
13805	</param>
13806	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13807	<desc>
13808	Units of measurement for each returned metric.
13809	</desc>
13810	</param>
13811	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13812	<desc>
13813	Divisor that should be applied to return values in order to get
13814	floating point values. For example:
13815	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13816	will retrieve the floating point value of i-th sample of the first
13817	metric.
13818	</desc>
13819	</param>
13820	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13821	<desc>
13822	Sequence numbers of the first elements of value sequences of
13823	particular metrics returned in @c returnData. For aggregate metrics
13824	it is the sequence number of the sample the aggregate started
13825	calculation from.
13826	</desc>
13827	</param>
13828	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13829	<desc>
13830	Indices of the first elements of value sequences of particular
13831	metrics returned in @c returnData.
13832	</desc>
13833	</param>
13834	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13835	<desc>
13836	Lengths of value sequences of particular metrics.
13837	</desc>
13838	</param>
13839	<param name="returnData" type="long" dir="return" safearray="yes">
13840	<desc>
13841	Flattened array of all metric data containing sequences of values for
13842	each metric.
13843	</desc>
13844	</param>
13845	</method>
13846
13847	</interface>
13848	<enum
13849	name="NATAliasMode"
13850	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13851	<desc></desc>
13852	<const name="AliasLog" value="0x1">
13853	<desc></desc>
13854	</const>
13855	<const name="AliasProxyOnly" value="0x02">
13856	<desc></desc>
13857	</const>
13858	<const name="AliasUseSamePorts" value="0x04">
13859	<desc></desc>
13860	</const>
13861	</enum>
13862	<enum
13863	name="NATProtocol"
13864	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13865	>
13866	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13867	<const name="UDP" value="0">
13868	<desc>Port-forwarding uses UDP protocol.</desc>
13869	</const>
13870	<const name="TCP" value="1">
13871	<desc>Port-forwarding uses TCP protocol.</desc>
13872	</const>
13873	</enum>
13874
13875	<interface
13876	name="INATEngine" extends="$unknown"
13877	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13878	wsmap="managed"
13879	>
13880	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13881	allows for changing NAT behavior such as port-forwarding rules. This interface is
13882	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13883	<attribute name="network" type="wstring">
13884	<desc>The network attribute of the NAT engine (the same value is used with built-in
13885	DHCP server to fill corresponding fields of DHCP leases).</desc>
13886	</attribute>
13887	<attribute name="hostIP" type="wstring">
13888	<desc>IP of host interface to bind all opened sockets to.
13889	<note>Changing this does not change binding of port forwarding.</note>
13890	</desc>
13891	</attribute>
13892	<attribute name="tftpPrefix" type="wstring">
13893	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13894	the corresponding fields of DHCP leases.</desc>
13895	</attribute>
13896	<attribute name="tftpBootFile" type="wstring">
13897	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
13898	the corresponding fields of DHCP leases.</desc>
13899	</attribute>
13900	<attribute name="tftpNextServer" type="wstring">
13901	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
13902	the corresponding fields of DHCP leases.
13903	<note>The preferred form is IPv4 addresses.</note>
13904	</desc>
13905	</attribute>
13906	<attribute name="aliasMode" type="unsigned long">
13907	<desc></desc>
13908	</attribute>
13909	<attribute name="dnsPassDomain" type="boolean">
13910	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
13911	</attribute>
13912	<attribute name="dnsProxy" type="boolean">
13913	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13914	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
13915	</attribute>
13916	<attribute name="dnsUseHostResolver" type="boolean">
13917	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
13918	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
13919	</attribute>
13920	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
13921	<desc>Array of NAT port-forwarding rules in string representation, in the following
13922	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
13923	</attribute>
13924	<method name="setNetworkSettings">
13925	<desc>Sets network configuration of the NAT engine.</desc>
13926	<param name="mtu" type="unsigned long" dir="in">
13927	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
13928	</param>
13929	<param name="sockSnd" type="unsigned long" dir="in">
13930	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
13931	</param>
13932	<param name="sockRcv" type="unsigned long" dir="in">
13933	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
13934	</param>
13935	<param name="TcpWndSnd" type="unsigned long" dir="in">
13936	<desc>Initial size of the NAT engine's sending TCP window in bytes when
13937	establishing a new TCP connection.</desc>
13938	</param>
13939	<param name="TcpWndRcv" type="unsigned long" dir="in">
13940	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
13941	establishing a new TCP connection.</desc>
13942	</param>
13943	</method>
13944	<method name="getNetworkSettings">
13945	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
13946	for parameter descriptions.</desc>
13947	<param name="mtu" type="unsigned long" dir="out" />
13948	<param name="sockSnd" type="unsigned long" dir="out" />
13949	<param name="sockRcv" type="unsigned long" dir="out" />
13950	<param name="TcpWndSnd" type="unsigned long" dir="out" />
13951	<param name="TcpWndRcv" type="unsigned long" dir="out" />
13952	</method>
13953	<method name="addRedirect">
13954	<desc>Adds a new NAT port-forwarding rule.</desc>
13955	<param name="name" type="wstring" dir="in">
13956	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
13957	auto-generates one using the other parameters.</desc>
13958	</param>
13959	<param name="proto" type="NATProtocol" dir="in">
13960	<desc>Protocol handled with the rule.</desc>
13961	</param>
13962	<param name="hostIp" type="wstring" dir="in">
13963	<desc>IP of the host interface to which the rule should apply. An empty ip address is
13964	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
13965	</param>
13966	<param name="hostPort" type="unsigned short" dir="in">
13967	<desc>The port number to listen on.</desc>
13968	</param>
13969	<param name="guestIp" type="wstring" dir="in">
13970	<desc>The IP address of the guest which the NAT engine will forward matching packets
13971	to. An empty IP address is acceptable, in which case the NAT engine will forward
13972	packets to the first DHCP lease (x.x.x.15).</desc>
13973	</param>
13974	<param name="guestPort" type="unsigned short" dir="in">
13975	<desc>The port number to forward.</desc>
13976	</param>
13977	</method>
13978	<method name="removeRedirect">
13979	<desc>Removes a port-forwarding rule that was previously registered.</desc>
13980	<param name="name" type="wstring" dir="in">
13981	<desc>The name of the rule to delete.</desc>
13982	</param>
13983	</method>
13984	</interface>
13985
13986	<!--
13987	// IExtPackManager
13988	/////////////////////////////////////////////////////////////////////////
13989	-->
13990
13991	<interface
13992	name="IExtPack" extends="$unknown"
13993	uuid="1b69431b-b22f-454a-977d-7d50986defcb"
13994	wsmap="suppress"
13995	>
13996	<desc>
13997	Interface for querying interfaces and information relating to an
13998	extension pack. The extension pack specific interfaces can be queried
13999	via the IUnknown::QueryInterface method.
14000	</desc>
14001	<attribute name="name" type="wstring" readonly="yes">
14002	<desc>The extension pack name. This is unique.</desc>
14003	</attribute>
14004	<attribute name="version" type="wstring" readonly="yes">
14005	<desc>
14006	The extension pack version string. This is on the same form as
14007	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14008	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14009	or "1.2.3_BETA1-r45678-OSE"
14010	</desc>
14011	</attribute>
14012	<attribute name="revision" type="unsigned long" readonly="yes">
14013	<desc>The extension pack internal revision number.</desc>
14014	</attribute>
14015	<attribute name="usable" type="boolean" readonly="yes">
14016	<desc>
14017	Indicates whether the extension pack is usable or not. An
14018	extension pack that is not compatible with the current VirtualBox
14019	version will be flagged as not usable.
14020	</desc>
14021	</attribute>
14022	<attribute name="whyUnusable" type="wstring" readonly="yes">
14023	<desc>
14024	String indicating why the extension pack is not usable. This is an
14025	empty string if usable and always a non-empty string if not usable.
14026	</desc>
14027	</attribute>
14028	</interface>
14029
14030	<interface
14031	name="IExtPackManager" extends="$unknown"
14032	uuid="ba1fbfca-53f1-471c-b5a1-416386f0f52b"
14033	wsmap="suppress"
14034	>
14035	<desc>
14036	Interface for managing VirtualBox Extension Packs.
14037
14038	TODO: Describe extension packs, how they are managed and how to create
14039	one.
14040	</desc>
14041
14042	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14043	<desc>
14044	List of the installed extension packs.
14045	</desc>
14046	</attribute>
14047
14048	<method name="find">
14049	<desc>
14050	Returns the extension pack with the specified name if found.
14051
14052	<result name="VBOX_E_OBJECT_NOT_FOUND">
14053	No extension pack matching @a name was found.
14054	</result>
14055	</desc>
14056	<param name="name" type="wstring" dir="in">
14057	<desc>The name of the extension pack to locate.</desc>
14058	</param>
14059	<param name="returnData" type="IExtPack" dir="return">
14060	<desc>The extension pack if found.</desc>
14061	</param>
14062	</method>
14063
14064	<method name="install">
14065	<param name="path" type="wstring" dir="in">
14066	<desc>The path of the extension pack tarball.</desc>
14067	</param>
14068	<param name="name" type="wstring" dir="out">
14069	<desc>The name of the installed extension pack.</desc>
14070	</param>
14071	</method>
14072
14073	<method name="uninstall">
14074	<desc>Uninstalls an extension pack, removing all related files.</desc>
14075	<param name="name" type="wstring" dir="in">
14076	<desc>The name of the extension pack to uninstall.</desc>
14077	</param>
14078	<param name="forcedRemoval" type="boolean" dir="in">
14079	<desc>
14080	Forced removal of the extension pack. This means that the uninstall
14081	hook will not be called.
14082	</desc>
14083	</param>
14084	</method>
14085	</interface>
14086
14087	<!--
14088	// Events
14089	/////////////////////////////////////////////////////////////////////////
14090	-->
14091	<enum
14092	name="VBoxEventType"
14093	uuid="e085d0b1-05e6-4f40-a709-b7266fbdb236">
14094
14095	<desc>
14096	Type of an event.
14097	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14098	</desc>
14099
14100	<const name="Invalid" value="0">
14101	<desc>
14102	Invalid event, must be first.
14103	</desc>
14104	</const>
14105
14106	<const name="Any" value="1">
14107	<desc>
14108	Wildcard for all events.
14109	Events of this type are never delivered, and only used in
14110	registerListener() call to simplify registration.
14111	</desc>
14112	</const>
14113
14114	<const name="Vetoable" value="2">
14115	<desc>
14116	Wildcard for all vetoable events. Events of this type are never delivered, and only
14117	used in registerListener() call to simplify registration.
14118	</desc>
14119	</const>
14120
14121	<const name="MachineEvent" value="3">
14122	<desc>
14123	Wildcard for all machine events. Events of this type are never delivered, and only used in
14124	registerListener() call to simplify registration.
14125	</desc>
14126	</const>
14127
14128	<const name="SnapshotEvent" value="4">
14129	<desc>
14130	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
14131	registerListener() call to simplify registration.
14132	</desc>
14133	</const>
14134
14135	<const name="InputEvent" value="5">
14136	<desc>
14137	Wildcard for all input device (keyboard, mouse) events.
14138	Events of this type are never delivered, and only used in
14139	registerListener() call to simplify registration.
14140	</desc>
14141	</const>
14142
14143	<const name="LastWildcard" value="31">
14144	<desc>
14145	Last wildcard.
14146	</desc>
14147	</const>
14148
14149	<const name="OnMachineStateChanged" value="32">
14150	<desc>
14151	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
14152	</desc>
14153	</const>
14154	<const name="OnMachineDataChanged" value="33">
14155	<desc>
14156	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
14157	</desc>
14158	</const>
14159	<const name="OnExtraDataChanged" value="34">
14160	<desc>
14161	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
14162	</desc>
14163	</const>
14164	<const name="OnExtraDataCanChange" value="35">
14165	<desc>
14166	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
14167	</desc>
14168	</const>
14169	<const name="OnMediumRegistered" value="36">
14170	<desc>
14171	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
14172	</desc>
14173	</const>
14174	<const name="OnMachineRegistered" value="37">
14175	<desc>
14176	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
14177	</desc>
14178	</const>
14179	<const name="OnSessionStateChanged" value="38">
14180	<desc>
14181	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
14182	</desc>
14183	</const>
14184	<const name="OnSnapshotTaken" value="39">
14185	<desc>
14186	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
14187	</desc>
14188	</const>
14189	<const name="OnSnapshotDeleted" value="40">
14190	<desc>
14191	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
14192	</desc>
14193	</const>
14194	<const name="OnSnapshotChanged" value="41">
14195	<desc>
14196	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
14197	</desc>
14198	</const>
14199	<const name="OnGuestPropertyChanged" value="42">
14200	<desc>
14201	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
14202	</desc>
14203	</const>
14204	<!-- Console events -->
14205	<const name="OnMousePointerShapeChanged" value="43">
14206	<desc>
14207	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
14208	</desc>
14209	</const>
14210	<const name="OnMouseCapabilityChanged" value="44">
14211	<desc>
14212	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
14213	</desc>
14214	</const>
14215	<const name="OnKeyboardLedsChanged" value="45">
14216	<desc>
14217	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
14218	</desc>
14219	</const>
14220	<const name="OnStateChanged" value="46">
14221	<desc>
14222	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
14223	</desc>
14224	</const>
14225	<const name="OnAdditionsStateChanged" value="47">
14226	<desc>
14227	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
14228	</desc>
14229	</const>
14230	<const name="OnNetworkAdapterChanged" value="48">
14231	<desc>
14232	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
14233	</desc>
14234	</const>
14235	<const name="OnSerialPortChanged" value="49">
14236	<desc>
14237	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
14238	</desc>
14239	</const>
14240	<const name="OnParallelPortChanged" value="50">
14241	<desc>
14242	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
14243	</desc>
14244	</const>
14245	<const name="OnStorageControllerChanged" value="51">
14246	<desc>
14247	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
14248	</desc>
14249	</const>
14250	<const name="OnMediumChanged" value="52">
14251	<desc>
14252	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
14253	</desc>
14254	</const>
14255	<const name="OnVRDEServerChanged" value="53">
14256	<desc>
14257	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
14258	</desc>
14259	</const>
14260	<const name="OnUSBControllerChanged" value="54">
14261	<desc>
14262	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
14263	</desc>
14264	</const>
14265	<const name="OnUSBDeviceStateChanged" value="55">
14266	<desc>
14267	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
14268	</desc>
14269	</const>
14270	<const name="OnSharedFolderChanged" value="56">
14271	<desc>
14272	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
14273	</desc>
14274	</const>
14275	<const name="OnRuntimeError" value="57">
14276	<desc>
14277	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
14278	</desc>
14279	</const>
14280	<const name="OnCanShowWindow" value="58">
14281	<desc>
14282	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
14283	</desc>
14284	</const>
14285	<const name="OnShowWindow" value="59">
14286	<desc>
14287	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
14288	</desc>
14289	</const>
14290	<const name="OnCPUChanged" value="60">
14291	<desc>
14292	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
14293	</desc>
14294	</const>
14295	<const name="OnVRDEServerInfoChanged" value="61">
14296	<desc>
14297	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
14298	</desc>
14299	</const>
14300	<const name="OnEventSourceChanged" value="62">
14301	<desc>
14302	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
14303	</desc>
14304	</const>
14305	<const name="OnCPUExecutionCapChanged" value="63">
14306	<desc>
14307	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
14308	</desc>
14309	</const>
14310	<const name="OnGuestKeyboardEvent" value="64">
14311	<desc>
14312	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
14313	</desc>
14314	</const>
14315	<const name="OnGuestMouseEvent" value="65">
14316	<desc>
14317	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
14318	</desc>
14319	</const>
14320	<!-- Last event marker -->
14321	<const name="Last" value="66">
14322	<desc>
14323	Must be last event, used for iterations and structures relying on numerical event values.
14324	</desc>
14325	</const>
14326
14327	</enum>
14328
14329	<interface
14330	name="IEventSource" extends="$unknown"
14331	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
14332	wsmap="managed"
14333	>
14334	<desc>
14335	Event source. Generally, any object which could generate events can be an event source,
14336	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
14337	an event source can work with listeners in either active or passive mode. In active mode it is up to
14338	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14339	event source keeps track of pending events for each listener and returns available events on demand.
14340
14341	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14342	</desc>
14343
14344	<method name="createListener">
14345	<desc>
14346	Creates a new listener object, useful for passive mode.
14347	</desc>
14348	<param name="listener" type="IEventListener" dir="return"/>
14349	</method>
14350
14351	<method name="createAggregator">
14352	<desc>
14353	Creates a aggregator event source, collecting events from multiple sources.
14354	This way single listener can listen for events coming from multiple sources,
14355	using single blocking getEvent() of this aggregator.
14356	</desc>
14357	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
14358	<desc>
14359	Subordinate event source this one aggregatres.
14360	</desc>
14361	</param>
14362	<param name="result" type="IEventSource" dir="return"/>
14363	</method>
14364
14365	<method name="registerListener">
14366	<desc>
14367	Register an event listener.
14368
14369	<note>
14370	To avoid system overload, the VirtualBox server process checks if passive event
14371	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14372	current implementation, if more than 500 pending events are detected for a passive
14373	event listener, it is forcefully unregistered by the system, and further
14374	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
14375	</note>
14376	</desc>
14377	<param name="listener" type="IEventListener" dir="in">
14378	<desc>Listener to register.</desc>
14379	</param>
14380	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
14381	<desc>
14382	Event types listener is interested in. One can use wildcards like -
14383	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
14384	than one event.
14385	</desc>
14386	</param>
14387	<param name="active" type="boolean" dir="in">
14388	<desc>
14389	Which mode this listener is operating in.
14390	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
14391	In passive mode, an internal event queue is created for this this IEventListener.
14392	For each event coming in, it is added to queues for all interested registered passive
14393	listeners. It is then up to the external code to call the listener's
14394	<link to="IEventListener::handleEvent" /> method. When done with an event, the
14395	external code must call <link to="#eventProcessed" />.
14396	</desc>
14397	</param>
14398	</method>
14399
14400	<method name="unregisterListener">
14401	<desc>
14402	Unregister an event listener. If listener is passive, and some waitable events are still
14403	in queue they are marked as processed automatically.
14404	</desc>
14405	<param name="listener" type="IEventListener" dir="in">
14406	<desc>Listener to unregister.</desc>
14407	</param>
14408	</method>
14409
14410	<method name="fireEvent">
14411	<desc>
14412	Fire an event for this source.
14413	</desc>
14414	<param name="event" type="IEvent" dir="in">
14415	<desc>Event to deliver.</desc>
14416	</param>
14417	<param name="timeout" type="long" dir="in">
14418	<desc>
14419	Maximum time to wait for event processing (if event is waitable), in ms;
14420	0 = no wait, -1 = indefinite wait.
14421	</desc>
14422	</param>
14423	<param name="result" type="boolean" dir="return">
14424	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14425	</param>
14426	</method>
14427
14428	<method name="getEvent">
14429	<desc>
14430	Get events from this peer's event queue (for passive mode). Calling this method
14431	regularly is required for passive event listeners to avoid system overload;
14432	see <link to="IEventSource::registerListener" /> for details.
14433
14434	<result name="VBOX_E_OBJECT_NOT_FOUND">
14435	Listener is not registered, or autounregistered.
14436	</result>
14437	</desc>
14438	<param name="listener" type="IEventListener" dir="in">
14439	<desc>Which listener to get data for.</desc>
14440	</param>
14441	<param name="timeout" type="long" dir="in">
14442	<desc>
14443	Maximum time to wait for events, in ms;
14444	0 = no wait, -1 = indefinite wait.
14445	</desc>
14446	</param>
14447	<param name="event" type="IEvent" dir="return">
14448	<desc>Event retrieved, or null if none available.</desc>
14449	</param>
14450	</method>
14451
14452	<method name="eventProcessed">
14453	<desc>
14454	Must be called for waitable events after a particular listener finished its
14455	event processing. When all listeners of a particular event have called this
14456	method, the system will then call <link to="IEvent::setProcessed" />.
14457	</desc>
14458	<param name="listener" type="IEventListener" dir="in">
14459	<desc>Which listener processed event.</desc>
14460	</param>
14461	<param name="event" type="IEvent" dir="in">
14462	<desc>Which event.</desc>
14463	</param>
14464	</method>
14465
14466	</interface>
14467
14468	<interface
14469	name="IEventListener" extends="$unknown"
14470	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14471	wsmap="managed"
14472	>
14473	<desc>
14474	Event listener. An event listener can work in either active or passive mode, depending on the way
14475	it was registered.
14476	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14477	</desc>
14478
14479	<method name="handleEvent">
14480	<desc>
14481	Handle event callback (called directly by IEventSource in active mode, or could be
14482	called by event processor thread in passive mode).
14483	</desc>
14484	<param name="event" type="IEvent" dir="in">
14485	<desc>Event available.</desc>
14486	</param>
14487	</method>
14488
14489	</interface>
14490
14491	<interface
14492	name="IEvent" extends="$unknown"
14493	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14494	wsmap="managed"
14495	>
14496	<desc>
14497	Abstract parent interface for VirtualBox events. Actual events will typically implement
14498	a more specific interface which derives from this (see below).
14499
14500	<b>Introduction to VirtualBox events</b>
14501
14502	Generally speaking, an event (represented by this interface) signals that something
14503	happened, while an event listener (see <link to="IEventListener" />) represents an
14504	entity that is interested in certain events. In order for this to work with
14505	unidirectional protocols (i.e. web services), the concepts of passive and active
14506	listener are used.
14507
14508	Event consumers can register themselves as listeners, providing an array of
14509	events they are interested in (see <link to="IEventSource::registerListener" />).
14510	When an event triggers, the listener is notified about the event. The exact
14511	mechanism of the notification depends on whether the listener was registered as
14512	an active or passive listener:
14513
14514	<ul>
14515	<li>An active listener is very similar to a callback: it is a function invoked
14516	by the API. As opposed to the callbacks that were used in the API before
14517	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
14518	</li>
14519
14520	<li>Passive listeners are somewhat tricker to implement, but do not require
14521	a client function to be callable, which is not an option with scripting
14522	languages or web service clients. Internally the <link to="IEventSource" />
14523	implementation maintains an event queue for each passive listener, and
14524	newly arrived events are put in this queue. When the listener calls
14525	<link to="IEventSource::getEvent"/>, first element from its internal event
14526	queue is returned. When the client completes processing of an event,
14527	the <link to="IEventSource::eventProcessed" /> function must be called,
14528	acknowledging that the event was processed. It supports implementing
14529	waitable events. On passive listener unregistration, all events from its
14530	queue are auto-acknowledged.
14531	</li>
14532	</ul>
14533
14534	Waitable events are useful in situations where the event generator wants to track
14535	delivery or a party wants to wait until all listeners have completed the event. A
14536	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14537	listeners might veto a certain action, and thus the event producer has to make
14538	sure that all listeners have processed the event and not vetoed before taking
14539	the action.
14540
14541	A given event may have both passive and active listeners at the same time.
14542
14543	<b>Using events</b>
14544
14545	Any VirtualBox object capable of producing externally visible events provides an
14546	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14547	This event source object is notified by VirtualBox once something has happened, so
14548	consumers may register event listeners with this event source. To register a listener,
14549	an object implementing the <link to="IEventListener" /> interface must be provided.
14550	For active listeners, such an object is typically created by the consumer, while for
14551	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14552	note that a listener created with @c createListener() must not be used as an active listener.
14553
14554	Once created, the listener must be registered to listen for the desired events
14555	(see <link to="IEventSource::registerListener" />), providing an array of
14556	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14557	event IDs or wildcards matching multiple event IDs.
14558
14559	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14560	called automatically when the event is triggered, while passive listeners have to call
14561	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14562	an event processing loop.
14563
14564	The IEvent interface is an abstract parent interface for all such VirtualBox events
14565	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14566	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14567	then cast to the appropriate specific interface using @c QueryInterface().
14568	</desc>
14569
14570	<attribute name="type" readonly="yes" type="VBoxEventType">
14571	<desc>
14572	Event type.
14573	</desc>
14574	</attribute>
14575
14576	<attribute name="source" readonly="yes" type="IEventSource">
14577	<desc>
14578	Source of this event.
14579	</desc>
14580	</attribute>
14581
14582	<attribute name="waitable" readonly="yes" type="boolean">
14583	<desc>
14584	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14585	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14586	as no additional overhead associated with waitability imposed.
14587	Waitable events are needed when one need to be able to wait for particular event processed,
14588	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14589	until all consumers confirmed events.
14590	</desc>
14591	</attribute>
14592
14593	<method name="setProcessed">
14594	<desc>
14595	Internal method called by the system when all listeners of a particular event have called
14596	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14597	</desc>
14598	</method>
14599
14600	<method name="waitProcessed">
14601	<desc>
14602	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14603	described semantics, for non-waitable returns true immediately.
14604	</desc>
14605	<param name="timeout" type="long" dir="in">
14606	<desc>
14607	Maximum time to wait for event processeing, in ms;
14608	0 = no wait, -1 = indefinite wait.
14609	</desc>
14610	</param>
14611	<param name="result" type="boolean" dir="return">
14612	<desc>If this event was processed before timeout.</desc>
14613	</param>
14614	</method>
14615	</interface>
14616
14617
14618	<interface
14619	name="IReusableEvent" extends="IEvent"
14620	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
14621	wsmap="managed"
14622	>
14623	<desc>Base abstract interface for all reusable events.</desc>
14624
14625	<attribute name="generation" readonly="yes" type="unsigned long">
14626	<desc>Current generation of event, incremented on reuse.</desc>
14627	</attribute>
14628
14629	<method name="reuse">
14630	<desc>
14631	Marks an event as reused, increments 'generation', fields shall no
14632	longer be considered valid.
14633	</desc>
14634	</method>
14635	</interface>
14636
14637	<interface
14638	name="IMachineEvent" extends="IEvent"
14639	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14640	wsmap="managed" id="MachineEvent"
14641	>
14642	<desc>Base abstract interface for all machine events.</desc>
14643
14644	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14645	<desc>ID of the machine this event relates to.</desc>
14646	</attribute>
14647
14648	</interface>
14649
14650	<interface
14651	name="IMachineStateChangedEvent" extends="IMachineEvent"
14652	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14653	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14654	>
14655	<desc>Machine state change event.</desc>
14656
14657	<attribute name="state" readonly="yes" type="MachineState">
14658	<desc>New execution state.</desc>
14659	</attribute>
14660	</interface>
14661
14662	<interface
14663	name="IMachineDataChangedEvent" extends="IMachineEvent"
14664	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14665	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14666	>
14667	<desc>
14668	Any of the settings of the given machine has changed.
14669	</desc>
14670	</interface>
14671
14672	<interface
14673	name="IMediumRegisteredEvent" extends="IEvent"
14674	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
14675	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
14676	>
14677	<desc>
14678	The given medium was registered or unregistered
14679	within this VirtualBox installation.
14680	</desc>
14681
14682	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
14683	<desc>ID of the medium this event relates to.</desc>
14684	</attribute>
14685
14686	<attribute name="mediumType" readonly="yes" type="DeviceType">
14687	<desc>Type of the medium this event relates to.</desc>
14688	</attribute>
14689
14690	<attribute name="registered" type="boolean" readonly="yes">
14691	<desc>
14692	If @c true, the medium was registered, otherwise it was
14693	unregistered.
14694	</desc>
14695	</attribute>
14696	</interface>
14697
14698	<interface
14699	name="IMachineRegisteredEvent" extends="IMachineEvent"
14700	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14701	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14702	>
14703	<desc>
14704	The given machine was registered or unregistered
14705	within this VirtualBox installation.
14706	</desc>
14707
14708	<attribute name="registered" type="boolean" readonly="yes">
14709	<desc>
14710	If @c true, the machine was registered, otherwise it was
14711	unregistered.
14712	</desc>
14713	</attribute>
14714	</interface>
14715
14716	<interface
14717	name="ISessionStateChangedEvent" extends="IMachineEvent"
14718	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14719	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14720	>
14721	<desc>
14722	The state of the session for the given machine was changed.
14723	<see>IMachine::sessionState</see>
14724	</desc>
14725
14726	<attribute name="state" type="SessionState" readonly="yes">
14727	<desc>
14728	New session state.
14729	</desc>
14730	</attribute>
14731	</interface>
14732
14733	<interface
14734	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14735	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14736	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14737	>
14738	<desc>
14739	Notification when a guest property has changed.
14740	</desc>
14741
14742	<attribute name="name" readonly="yes" type="wstring">
14743	<desc>
14744	The name of the property that has changed.
14745	</desc>
14746	</attribute>
14747
14748	<attribute name="value" readonly="yes" type="wstring">
14749	<desc>
14750	The new property value.
14751	</desc>
14752	</attribute>
14753
14754	<attribute name="flags" readonly="yes" type="wstring">
14755	<desc>
14756	The new property flags.
14757	</desc>
14758	</attribute>
14759
14760	</interface>
14761
14762	<interface
14763	name="ISnapshotEvent" extends="IMachineEvent"
14764	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14765	wsmap="managed" id="SnapshotEvent"
14766	>
14767	<desc>Base interface for all snapshot events.</desc>
14768
14769	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14770	<desc>ID of the snapshot this event relates to.</desc>
14771	</attribute>
14772
14773	</interface>
14774
14775	<interface
14776	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14777	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14778	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14779	>
14780	<desc>
14781	A new snapshot of the machine has been taken.
14782	<see>ISnapshot</see>
14783	</desc>
14784	</interface>
14785
14786	<interface
14787	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14788	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14789	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14790	>
14791	<desc>
14792	Snapshot of the given machine has been deleted.
14793
14794	<note>
14795	This notification is delivered <b>after</b> the snapshot
14796	object has been uninitialized on the server (so that any
14797	attempt to call its methods will return an error).
14798	</note>
14799
14800	<see>ISnapshot</see>
14801	</desc>
14802	</interface>
14803
14804	<interface
14805	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14806	uuid="07541941-8079-447a-a33e-47a69c7980db"
14807	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14808	>
14809	<desc>
14810	Snapshot properties (name and/or description) have been changed.
14811	<see>ISnapshot</see>
14812	</desc>
14813	</interface>
14814
14815	<interface
14816	name="IMousePointerShapeChangedEvent" extends="IEvent"
14817	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14818	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14819	>
14820	<desc>
14821	Notification when the guest mouse pointer shape has
14822	changed. The new shape data is given.
14823	</desc>
14824
14825	<attribute name="visible" type="boolean" readonly="yes">
14826	<desc>
14827	Flag whether the pointer is visible.
14828	</desc>
14829	</attribute>
14830	<attribute name="alpha" type="boolean" readonly="yes">
14831	<desc>
14832	Flag whether the pointer has an alpha channel.
14833	</desc>
14834	</attribute>
14835	<attribute name="xhot" type="unsigned long" readonly="yes">
14836	<desc>
14837	The pointer hot spot X coordinate.
14838	</desc>
14839	</attribute>
14840	<attribute name="yhot" type="unsigned long" readonly="yes">
14841	<desc>
14842	The pointer hot spot Y coordinate.
14843	</desc>
14844	</attribute>
14845	<attribute name="width" type="unsigned long" readonly="yes">
14846	<desc>
14847	Width of the pointer shape in pixels.
14848	</desc>
14849	</attribute>
14850	<attribute name="height" type="unsigned long" readonly="yes">
14851	<desc>
14852	Height of the pointer shape in pixels.
14853	</desc>
14854	</attribute>
14855	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14856	<desc>
14857	Shape buffer arrays.
14858
14859	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14860	followed by a 32-bpp XOR (color) mask.
14861
14862	For pointers without alpha channel the XOR mask pixels are 32
14863	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14864	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14865
14866	An AND mask is used for pointers with alpha channel, so if the
14867	callback does not support alpha, the pointer could be
14868	displayed as a normal color pointer.
14869
14870	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14871	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14872	height</tt>. The padding bits at the end of each scanline are
14873	undefined.
14874
14875	The XOR mask follows the AND mask on the next 4-byte aligned
14876	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14877	Bytes in the gap between the AND and the XOR mask are undefined.
14878	The XOR mask scanlines have no gap between them and the size of
14879	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14880
14881	<note>
14882	If @a shape is 0, only the pointer visibility is changed.
14883	</note>
14884	</desc>
14885	</attribute>
14886	</interface>
14887
14888	<interface
14889	name="IMouseCapabilityChangedEvent" extends="IEvent"
14890	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
14891	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
14892	>
14893	<desc>
14894	Notification when the mouse capabilities reported by the
14895	guest have changed. The new capabilities are passed.
14896	</desc>
14897	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
14898	<desc>
14899	Supports absolute coordinates.
14900	</desc>
14901	</attribute>
14902	<attribute name="supportsRelative" type="boolean" readonly="yes">
14903	<desc>
14904	Supports relative coordinates.
14905	</desc>
14906	</attribute>
14907	<attribute name="needsHostCursor" type="boolean" readonly="yes">
14908	<desc>
14909	If host cursor is needed.
14910	</desc>
14911	</attribute>
14912	</interface>
14913
14914	<interface
14915	name="IKeyboardLedsChangedEvent" extends="IEvent"
14916	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
14917	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
14918	>
14919	<desc>
14920	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
14921	to alter the state of the keyboard LEDs.
14922	</desc>
14923	<attribute name="numLock" type="boolean" readonly="yes">
14924	<desc>
14925	NumLock status.
14926	</desc>
14927	</attribute>
14928	<attribute name="capsLock" type="boolean" readonly="yes">
14929	<desc>
14930	CapsLock status.
14931	</desc>
14932	</attribute>
14933	<attribute name="scrollLock" type="boolean" readonly="yes">
14934	<desc>
14935	ScrollLock status.
14936	</desc>
14937	</attribute>
14938	</interface>
14939
14940	<interface
14941	name="IStateChangedEvent" extends="IEvent"
14942	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
14943	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
14944	>
14945	<desc>
14946	Notification when the execution state of the machine has changed.
14947	The new state is given.
14948	</desc>
14949	<attribute name="state" type="MachineState" readonly="yes">
14950	<desc>
14951	New machine state.
14952	</desc>
14953	</attribute>
14954	</interface>
14955
14956	<interface
14957	name="IAdditionsStateChangedEvent" extends="IEvent"
14958	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
14959	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
14960	>
14961	<desc>
14962	Notification when a Guest Additions property changes.
14963	Interested callees should query IGuest attributes to
14964	find out what has changed.
14965	</desc>
14966	</interface>
14967
14968	<interface
14969	name="INetworkAdapterChangedEvent" extends="IEvent"
14970	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
14971	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
14972	>
14973	<desc>
14974	Notification when a property of one of the
14975	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
14976	changes. Interested callees should use INetworkAdapter methods and
14977	attributes to find out what has changed.
14978	</desc>
14979	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
14980	<desc>
14981	Network adapter that is subject to change.
14982	</desc>
14983	</attribute>
14984	</interface>
14985
14986	<interface
14987	name="ISerialPortChangedEvent" extends="IEvent"
14988	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
14989	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
14990	>
14991	<desc>
14992	Notification when a property of one of the
14993	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
14994	Interested callees should use ISerialPort methods and attributes
14995	to find out what has changed.
14996	</desc>
14997	<attribute name="serialPort" type="ISerialPort" readonly="yes">
14998	<desc>
14999	Serial port that is subject to change.
15000	</desc>
15001	</attribute>
15002	</interface>
15003
15004	<interface
15005	name="IParallelPortChangedEvent" extends="IEvent"
15006	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
15007	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
15008	>
15009	<desc>
15010	Notification when a property of one of the
15011	virtual <link to="IMachine::getParallelPort">parallel ports</link>
15012	changes. Interested callees should use ISerialPort methods and
15013	attributes to find out what has changed.
15014	</desc>
15015	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
15016	<desc>
15017	Parallel port that is subject to change.
15018	</desc>
15019	</attribute>
15020	</interface>
15021
15022	<interface
15023	name="IStorageControllerChangedEvent" extends="IEvent"
15024	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
15025	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
15026	>
15027	<desc>
15028	Notification when a
15029	<link to="IMachine::mediumAttachments">medium attachment</link>
15030	changes.
15031	</desc>
15032	</interface>
15033
15034	<interface
15035	name="IMediumChangedEvent" extends="IEvent"
15036	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
15037	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
15038	>
15039	<desc>
15040	Notification when a
15041	<link to="IMachine::mediumAttachments">medium attachment</link>
15042	changes.
15043	</desc>
15044	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
15045	<desc>
15046	Medium attachment that is subject to change.
15047	</desc>
15048	</attribute>
15049	</interface>
15050
15051	<interface
15052	name="ICPUChangedEvent" extends="IEvent"
15053	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
15054	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
15055	>
15056	<desc>
15057	Notification when a CPU changes.
15058	</desc>
15059	<attribute name="cpu" type="unsigned long" readonly="yes">
15060	<desc>
15061	The CPU which changed.
15062	</desc>
15063	</attribute>
15064	<attribute name="add" type="boolean" readonly="yes">
15065	<desc>
15066	Flag whether the CPU was added or removed.
15067	</desc>
15068	</attribute>
15069	</interface>
15070
15071	<interface
15072	name="ICPUExecutionCapChangedEvent" extends="IEvent"
15073	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
15074	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
15075	>
15076	<desc>
15077	Notification when the CPU execution cap changes.
15078	</desc>
15079	<attribute name="executionCap" type="unsigned long" readonly="yes">
15080	<desc>
15081	The new CPU execution cap value. (1-100)
15082	</desc>
15083	</attribute>
15084	</interface>
15085
15086	<interface
15087	name="IGuestKeyboardEvent" extends="IEvent"
15088	uuid="88394258-7006-40d4-b339-472ee3801844"
15089	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboardEvent"
15090	>
15091	<desc>
15092	Notification when guest keyboard event happens.
15093	</desc>
15094	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
15095	<desc>
15096	Array of scancodes.
15097	</desc>
15098	</attribute>
15099	</interface>
15100
15101	<interface
15102	name="IGuestMouseEvent" extends="IReusableEvent"
15103	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
15104	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouseEvent"
15105	>
15106	<desc>
15107	Notification when guest mouse event happens.
15108	</desc>
15109
15110	<attribute name="absolute" type="boolean" readonly="yes">
15111	<desc>
15112	If this event is relative or absolute.
15113	</desc>
15114	</attribute>
15115
15116	<attribute name="x" type="long" readonly="yes">
15117	<desc>
15118	New X position, or X delta.
15119	</desc>
15120	</attribute>
15121
15122	<attribute name="y" type="long" readonly="yes">
15123	<desc>
15124	New Y position, or Y delta.
15125	</desc>
15126	</attribute>
15127
15128	<attribute name="z" type="long" readonly="yes">
15129	<desc>
15130	Z delta.
15131	</desc>
15132	</attribute>
15133
15134	<attribute name="w" type="long" readonly="yes">
15135	<desc>
15136	W delta.
15137	</desc>
15138	</attribute>
15139
15140	<attribute name="buttons" type="long" readonly="yes">
15141	<desc>
15142	Button state bitmask.
15143	</desc>
15144	</attribute>
15145
15146	</interface>
15147
15148
15149	<interface
15150	name="IVRDEServerChangedEvent" extends="IEvent"
15151	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
15152	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
15153	>
15154	<desc>
15155	Notification when a property of the
15156	<link to="IMachine::VRDEServer">VRDE server</link> changes.
15157	Interested callees should use IVRDEServer methods and attributes to
15158	find out what has changed.
15159	</desc>
15160	</interface>
15161
15162	<interface
15163	name="IVRDEServerInfoChangedEvent" extends="IEvent"
15164	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
15165	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
15166	>
15167	<desc>
15168	Notification when the status of the VRDE server changes. Interested callees
15169	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
15170	attributes to find out what is the current status.
15171	</desc>
15172	</interface>
15173
15174	<interface
15175	name="IUSBControllerChangedEvent" extends="IEvent"
15176	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
15177	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
15178	>
15179	<desc>
15180	Notification when a property of the virtual
15181	<link to="IMachine::USBController">USB controller</link> changes.
15182	Interested callees should use IUSBController methods and attributes to
15183	find out what has changed.
15184	</desc>
15185	</interface>
15186
15187	<interface
15188	name="IUSBDeviceStateChangedEvent" extends="IEvent"
15189	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
15190	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
15191	>
15192	<desc>
15193	Notification when a USB device is attached to or detached from
15194	the virtual USB controller.
15195
15196	This notification is sent as a result of the indirect
15197	request to attach the device because it matches one of the
15198	machine USB filters, or as a result of the direct request
15199	issued by <link to="IConsole::attachUSBDevice"/> or
15200	<link to="IConsole::detachUSBDevice"/>.
15201
15202	This notification is sent in case of both a succeeded and a
15203	failed request completion. When the request succeeds, the
15204	@a error parameter is @c null, and the given device has been
15205	already added to (when @a attached is @c true) or removed from
15206	(when @a attached is @c false) the collection represented by
15207	<link to="IConsole::USBDevices"/>. On failure, the collection
15208	doesn't change and the @a error parameter represents the error
15209	message describing the failure.
15210	</desc>
15211	<attribute name="device" type="IUSBDevice" readonly="yes">
15212	<desc>
15213	Device that is subject to state change.
15214	</desc>
15215	</attribute>
15216	<attribute name="attached" type="boolean" readonly="yes">
15217	<desc>
15218	@c true if the device was attached and @c false otherwise.
15219	</desc>
15220	</attribute>
15221	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
15222	<desc>
15223	@c null on success or an error message object on failure.
15224	</desc>
15225	</attribute>
15226	</interface>
15227
15228	<interface
15229	name="ISharedFolderChangedEvent" extends="IEvent"
15230	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
15231	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
15232	>
15233	<desc>
15234	Notification when a shared folder is added or removed.
15235	The @a scope argument defines one of three scopes:
15236	<link to="IVirtualBox::sharedFolders">global shared folders</link>
15237	(<link to="Scope_Global">Global</link>),
15238	<link to="IMachine::sharedFolders">permanent shared folders</link> of
15239	the machine (<link to="Scope_Machine">Machine</link>) or <link
15240	to="IConsole::sharedFolders">transient shared folders</link> of the
15241	machine (<link to="Scope_Session">Session</link>). Interested callees
15242	should use query the corresponding collections to find out what has
15243	changed.
15244	</desc>
15245	<attribute name="scope" type="Scope" readonly="yes">
15246	<desc>
15247	Scope of the notification.
15248	</desc>
15249	</attribute>
15250	</interface>
15251
15252	<interface
15253	name="IRuntimeErrorEvent" extends="IEvent"
15254	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
15255	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
15256	>
15257	<desc>
15258	Notification when an error happens during the virtual
15259	machine execution.
15260
15261	There are three kinds of runtime errors:
15262	<ul>
15263	<li><i>fatal</i></li>
15264	<li><i>non-fatal with retry</i></li>
15265	<li><i>non-fatal warnings</i></li>
15266	</ul>
15267
15268	<b>Fatal</b> errors are indicated by the @a fatal parameter set
15269	to @c true. In case of fatal errors, the virtual machine
15270	execution is always paused before calling this notification, and
15271	the notification handler is supposed either to immediately save
15272	the virtual machine state using <link to="IConsole::saveState"/>
15273	or power it off using <link to="IConsole::powerDown"/>.
15274	Resuming the execution can lead to unpredictable results.
15275
15276	<b>Non-fatal</b> errors and warnings are indicated by the
15277	@a fatal parameter set to @c false. If the virtual machine
15278	is in the Paused state by the time the error notification is
15279	received, it means that the user can <i>try to resume</i> the machine
15280	execution after attempting to solve the problem that caused the
15281	error. In this case, the notification handler is supposed
15282	to show an appropriate message to the user (depending on the
15283	value of the @a id parameter) that offers several actions such
15284	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
15285	wants to retry, the notification handler should continue
15286	the machine execution using the <link to="IConsole::resume"/>
15287	call. If the machine execution is not Paused during this
15288	notification, then it means this notification is a <i>warning</i>
15289	(for example, about a fatal condition that can happen very soon);
15290	no immediate action is required from the user, the machine
15291	continues its normal execution.
15292
15293	Note that in either case the notification handler
15294	<b>must not</b> perform any action directly on a thread
15295	where this notification is called. Everything it is allowed to
15296	do is to post a message to another thread that will then talk
15297	to the user and take the corresponding action.
15298
15299	Currently, the following error identifiers are known:
15300	<ul>
15301	<li><tt>"HostMemoryLow"</tt></li>
15302	<li><tt>"HostAudioNotResponding"</tt></li>
15303	<li><tt>"VDIStorageFull"</tt></li>
15304	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
15305	</ul>
15306	</desc>
15307	<attribute name="fatal" type="boolean" readonly="yes">
15308	<desc>
15309	Whether the error is fatal or not.
15310	</desc>
15311	</attribute>
15312	<attribute name="id" type="wstring" readonly="yes">
15313	<desc>
15314	Error identifier.
15315	</desc>
15316	</attribute>
15317	<attribute name="message" type="wstring" readonly="yes">
15318	<desc>
15319	Optional error message.
15320	</desc>
15321	</attribute>
15322	</interface>
15323
15324
15325	<interface
15326	name="IEventSourceChangedEvent" extends="IEvent"
15327	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
15328	waitable="yes"
15329	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
15330	>
15331	<desc>
15332	Notification when an event source state changes (listener added or removed).
15333	</desc>
15334
15335	<attribute name="listener" type="IEventListener" readonly="yes">
15336	<desc>
15337	Event listener which has changed.
15338	</desc>
15339	</attribute>
15340
15341	<attribute name="add" type="boolean" readonly="yes">
15342	<desc>
15343	Flag whether listener was added or removed.
15344	</desc>
15345	</attribute>
15346	</interface>
15347
15348	<interface
15349	name="IExtraDataChangedEvent" extends="IEvent"
15350	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
15351	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
15352	>
15353	<desc>
15354	Notification when machine specific or global extra data
15355	has changed.
15356	</desc>
15357	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15358	<desc>
15359	ID of the machine this event relates to.
15360	Null for global extra data changes.
15361	</desc>
15362	</attribute>
15363	<attribute name="key" type="wstring" readonly="yes">
15364	<desc>
15365	Extra data key that has changed.
15366	</desc>
15367	</attribute>
15368	<attribute name="value" type="wstring" readonly="yes">
15369	<desc>
15370	Extra data value for the given key.
15371	</desc>
15372	</attribute>
15373	</interface>
15374
15375	<interface
15376	name="IVetoEvent" extends="IEvent"
15377	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
15378	wsmap="managed"
15379	>
15380	<desc>Base abstract interface for veto events.</desc>
15381
15382	<method name="addVeto">
15383	<desc>
15384	Adds a veto on this event.
15385	</desc>
15386	<param name="reason" type="wstring" dir="in">
15387	<desc>
15388	Reason for veto, could be null or empty string.
15389	</desc>
15390	</param>
15391	</method>
15392
15393	<method name="isVetoed">
15394	<desc>
15395	If this event was vetoed.
15396	</desc>
15397	<param name="result" type="boolean" dir="return">
15398	<desc>
15399	Reason for veto.
15400	</desc>
15401	</param>
15402	</method>
15403
15404	<method name="getVetos">
15405	<desc>
15406	Current veto reason list, if size is 0 - no veto.
15407	</desc>
15408	<param name="result" type="wstring" dir="return" safearray="yes">
15409	<desc>
15410	Array of reasons for veto provided by different event handlers.
15411	</desc>
15412	</param>
15413	</method>
15414
15415	</interface>
15416
15417	<interface
15418	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
15419	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
15420	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
15421	waitable="true"
15422	>
15423	<desc>
15424	Notification when someone tries to change extra data for
15425	either the given machine or (if @c null) global extra data.
15426	This gives the chance to veto against changes.
15427	</desc>
15428	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15429	<desc>
15430	ID of the machine this event relates to.
15431	Null for global extra data changes.
15432	</desc>
15433	</attribute>
15434	<attribute name="key" type="wstring" readonly="yes">
15435	<desc>
15436	Extra data key that has changed.
15437	</desc>
15438	</attribute>
15439	<attribute name="value" type="wstring" readonly="yes">
15440	<desc>
15441	Extra data value for the given key.
15442	</desc>
15443	</attribute>
15444	</interface>
15445
15446	<interface
15447	name="ICanShowWindowEvent" extends="IVetoEvent"
15448	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
15449	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
15450	waitable="true"
15451	>
15452	<desc>
15453	Notification when a call to
15454	<link to="IMachine::canShowConsoleWindow"/> is made by a
15455	front-end to check if a subsequent call to
15456	<link to="IMachine::showConsoleWindow"/> can succeed.
15457
15458	The callee should give an answer appropriate to the current
15459	machine state using event veto. This answer must
15460	remain valid at least until the next
15461	<link to="IConsole::state">machine state</link> change.
15462	</desc>
15463	</interface>
15464
15465	<interface
15466	name="IShowWindowEvent" extends="IEvent"
15467	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
15468	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
15469	waitable="true"
15470	>
15471	<desc>
15472	Notification when a call to
15473	<link to="IMachine::showConsoleWindow"/>
15474	requests the console window to be activated and brought to
15475	foreground on the desktop of the host PC.
15476
15477	This notification should cause the VM console process to
15478	perform the requested action as described above. If it is
15479	impossible to do it at a time of this notification, this
15480	method should return a failure.
15481
15482	Note that many modern window managers on many platforms
15483	implement some sort of focus stealing prevention logic, so
15484	that it may be impossible to activate a window without the
15485	help of the currently active application (which is supposedly
15486	an initiator of this notification). In this case, this method
15487	must return a non-zero identifier that represents the
15488	top-level window of the VM console process. The caller, if it
15489	represents a currently active process, is responsible to use
15490	this identifier (in a platform-dependent manner) to perform
15491	actual window activation.
15492
15493	This method must set @a winId to zero if it has performed all
15494	actions necessary to complete the request and the console
15495	window is now active and in foreground, to indicate that no
15496	further action is required on the caller's side.
15497	</desc>
15498	<attribute name="winId" type="long long">
15499	<desc>
15500	Platform-dependent identifier of the top-level VM console
15501	window, or zero if this method has performed all actions
15502	necessary to implement the <i>show window</i> semantics for
15503	the given platform and/or this VirtualBox front-end.
15504	</desc>
15505	</attribute>
15506	</interface>
15507
15508	<module name="VBoxSVC" context="LocalServer">
15509	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15510	namespace="virtualbox.org">
15511	<interface name="IVirtualBox" default="yes"/>
15512	</class>
15513	</module>
15514
15515	<module name="VBoxC" context="InprocServer" threadingModel="Free">
15516	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
15517	namespace="virtualbox.org">
15518	<interface name="ISession" default="yes"/>
15519	</class>
15520
15521	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
15522	namespace="virtualbox.org">
15523	<interface name="IConsole" default="yes"/>
15524	</class>
15525	</module>
15526
15527	</library>
15528
15529	</idl>
15530
15531	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format