VirtualBox.xidl@ 37431

Last change on this file since 37431 was 37380, checked in by vboxsync, 14 years ago
Main/Console+InternalMachineControl: add a (not yet implemented) method which deletes a snapshot including all children. While I was at it I cleaned up the hyperlinks and method/attribute naming, and also marked a few more methods as const.
Property svn:eol-style set to `native`
File size: 632.9 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2011 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). When pointers representing input arguments (such
275	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
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490
491	<const name="Future" value="99999">
492	<desc>Settings version greater than "1.12", written by a future VirtualBox version.</desc>
493	</const>
494	</enum>
495
496	<enum
497	name="AccessMode"
498	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
499	>
500	<desc>
501	Access mode for opening files.
502	</desc>
503
504	<const name="ReadOnly" value="1"/>
505	<const name="ReadWrite" value="2"/>
506	</enum>
507
508	<enum
509	name="MachineState"
510	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
511	>
512	<desc>
513	Virtual machine execution state.
514
515	This enumeration represents possible values of the <link
516	to="IMachine::state"/> attribute.
517
518	Below is the basic virtual machine state diagram. It shows how the state
519	changes during virtual machine execution. The text in square braces shows
520	a method of the IConsole interface that performs the given state
521	transition.
522
523	<pre>
524	+---------[powerDown()] <- Stuck <--[failure]-+
525	V \|
526	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
527	\| \| \| \| V \|
528	\| Aborted -----+ +--> Running --[pause()]--> Paused
529	\| \| ^ \| ^ \|
530	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
531	\| ^ \| \| \| \|
532	\| \| +-----------------------------------------+-\|-------------------+ +
533	\| \| \| \| \|
534	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
535	\| \| \| \|
536	\| +-------- Saving <--------[saveState()]<----------+---------------------+
537	\| \| \|
538	+-------------- Stopping -------[powerDown()]<----------+---------------------+
539	</pre>
540
541	Note that states to the right from PoweredOff, Aborted and Saved in the
542	above diagram are called <i>online VM states</i>. These states
543	represent the virtual machine which is being executed in a dedicated
544	process (usually with a GUI window attached to it where you can see the
545	activity of the virtual machine and interact with it). There are two
546	special pseudo-states, FirstOnline and LastOnline, that can be used in
547	relational expressions to detect if the given machine state is online or
548	not:
549
550	<pre>
551	if (machine.GetState() >= MachineState_FirstOnline &&
552	machine.GetState() <= MachineState_LastOnline)
553	{
554	...the machine is being executed...
555	}
556	</pre>
557
558	When the virtual machine is in one of the online VM states (that is, being
559	executed), only a few machine settings can be modified. Methods working
560	with such settings contain an explicit note about that. An attempt to
561	change any other setting or perform a modifying operation during this time
562	will result in the @c VBOX_E_INVALID_VM_STATE error.
563
564	All online states except Running, Paused and Stuck are transitional: they
565	represent temporary conditions of the virtual machine that will last as
566	long as the operation that initiated such a condition.
567
568	The Stuck state is a special case. It means that execution of the machine
569	has reached the "Guru Meditation" condition. This condition indicates an
570	internal VMM (virtual machine manager) failure which may happen as a
571	result of either an unhandled low-level virtual hardware exception or one
572	of the recompiler exceptions (such as the <i>too-many-traps</i>
573	condition).
574
575	Note also that any online VM state may transit to the Aborted state. This
576	happens if the process that is executing the virtual machine terminates
577	unexpectedly (for example, crashes). Other than that, the Aborted state is
578	equivalent to PoweredOff.
579
580	There are also a few additional state diagrams that do not deal with
581	virtual machine execution and therefore are shown separately. The states
582	shown on these diagrams are called <i>offline VM states</i> (this includes
583	PoweredOff, Aborted and Saved too).
584
585	The first diagram shows what happens when a lengthy setup operation is
586	being executed (such as <link to="IMachine::attachDevice"/>).
587
588	<pre>
589	+----------------------------------(same state as before the call)------+
590	\| \|
591	+-> PoweredOff --+ \|
592	\| \| \|
593	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
594	\| \|
595	+-> Saved -------+
596	</pre>
597
598	The next two diagrams demonstrate the process of taking a snapshot of a
599	powered off virtual machine, restoring the state to that as of a snapshot
600	or deleting a snapshot, respectively.
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| +-->[takeSnapshot()] -------------------> Saving ------+
607	+-> Aborted -----+
608
609	+-> PoweredOff --+
610	\| \|
611	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
612	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
613	+-> Saved -------+ \|
614	\| \|
615	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
616	</pre>
617
618	Note that the Saving state is present in both the offline state group and
619	online state group. Currently, the only way to determine what group is
620	assumed in a particular case is to remember the previous machine state: if
621	it was Running or Paused, then Saving is an online state, otherwise it is
622	an offline state. This inconsistency may be removed in one of the future
623	versions of VirtualBox by adding a new state.
624
625	<note internal="yes">
626	For whoever decides to touch this enum: In order to keep the
627	comparisons involving FirstOnline and LastOnline pseudo-states valid,
628	the numeric values of these states must be correspondingly updated if
629	needed: for any online VM state, the condition
630	<tt>FirstOnline <= state <= LastOnline</tt> must be
631	@c true. The same relates to transient states for which
632	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
633	@c true.
634	</note>
635	</desc>
636
637	<const name="Null" value="0">
638	<desc>Null value (never used by the API).</desc>
639	</const>
640	<const name="PoweredOff" value="1">
641	<desc>
642	The machine is not running and has no saved execution state; it has
643	either never been started or been shut down successfully.
644	</desc>
645	</const>
646	<const name="Saved" value="2">
647	<desc>
648	The machine is not currently running, but the execution state of the machine
649	has been saved to an external file when it was running, from where
650	it can be resumed.
651	</desc>
652	</const>
653	<const name="Teleported" value="3">
654	<desc>
655	The machine was teleported to a different host (or process) and then
656	powered off. Take care when powering it on again may corrupt resources
657	it shares with the teleportation target (e.g. disk and network).
658	</desc>
659	</const>
660	<const name="Aborted" value="4">
661	<desc>
662	The process running the machine has terminated abnormally. This may
663	indicate a crash of the VM process in host execution context, or
664	the VM process has been terminated externally.
665	</desc>
666	</const>
667	<const name="Running" value="5">
668	<desc>
669	The machine is currently being executed.
670	<note internal="yes">
671	For whoever decides to touch this enum: In order to keep the
672	comparisons in the old source code valid, this state must immediately
673	precede the Paused state.
674	TODO: Lift this spectacularly wonderful restriction.
675	</note>
676	</desc>
677	</const>
678	<const name="Paused" value="6">
679	<desc>
680	Execution of the machine has been paused.
681	<note internal="yes">
682	For whoever decides to touch this enum: In order to keep the
683	comparisons in the old source code valid, this state must immediately
684	follow the Running state.
685	TODO: Lift this spectacularly wonderful restriction.
686	</note>
687	</desc>
688	</const>
689	<const name="Stuck" value="7">
690	<desc>
691	Execution of the machine has reached the "Guru Meditation"
692	condition. This indicates a severe error in the hypervisor itself.
693	<note internal="yes">
694	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
695	"Guru", perhaps? Or are there some other VMM states that are
696	intended to be lumped in here as well?
697	</note>
698	</desc>
699	</const>
700	<const name="Teleporting" value="8">
701	<desc>
702	The machine is about to be teleported to a different host or process.
703	It is possible to pause a machine in this state, but it will go to the
704	@c TeleportingPausedVM state and it will not be
705	possible to resume it again unless the teleportation fails.
706	</desc>
707	</const>
708	<const name="LiveSnapshotting" value="9">
709	<desc>
710	A live snapshot is being taken. The machine is running normally, but
711	some of the runtime configuration options are inaccessible. Also, if
712	paused while in this state it will transition to
713	@c Saving and it will not be resume the
714	execution until the snapshot operation has completed.
715	</desc>
716	</const>
717	<const name="Starting" value="10">
718	<desc>
719	Machine is being started after powering it on from a
720	zero execution state.
721	</desc>
722	</const>
723	<const name="Stopping" value="11">
724	<desc>
725	Machine is being normally stopped powering it off, or after the guest OS
726	has initiated a shutdown sequence.
727	</desc>
728	</const>
729	<const name="Saving" value="12">
730	<desc>
731	Machine is saving its execution state to a file, or an online
732	snapshot of the machine is being taken.
733	</desc>
734	</const>
735	<const name="Restoring" value="13">
736	<desc>
737	Execution state of the machine is being restored from a file
738	after powering it on from the saved execution state.
739	</desc>
740	</const>
741	<const name="TeleportingPausedVM" value="14">
742	<desc>
743	The machine is being teleported to another host or process, but it is
744	not running. This is the paused variant of the
745	@c state.
746	</desc>
747	</const>
748	<const name="TeleportingIn" value="15">
749	<desc>
750	Teleporting the machine state in from another host or process.
751	</desc>
752	</const>
753	<const name="FaultTolerantSyncing" value="16">
754	<desc>
755	The machine is being synced with a fault tolerant VM running elsewhere.
756	</desc>
757	</const>
758	<const name="DeletingSnapshotOnline" value="17">
759	<desc>
760	Like @c DeletingSnapshot, but the merging of media is ongoing in
761	the background while the machine is running.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotPaused" value="18">
765	<desc>
766	Like @c DeletingSnapshotOnline, but the machine was paused when the
767	merging of differencing media was started.
768	</desc>
769	</const>
770	<const name="RestoringSnapshot" value="19">
771	<desc>
772	A machine snapshot is being restored; this typically does not take long.
773	</desc>
774	</const>
775	<const name="DeletingSnapshot" value="20">
776	<desc>
777	A machine snapshot is being deleted; this can take a long time since this
778	may require merging differencing media. This value indicates that the
779	machine is not running while the snapshot is being deleted.
780	</desc>
781	</const>
782	<const name="SettingUp" value="21">
783	<desc>
784	Lengthy setup operation is in progress.
785	</desc>
786	</const>
787
788	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
789	<desc>
790	Pseudo-state: first online state (for use in relational expressions).
791	</desc>
792	</const>
793	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
794	<desc>
795	Pseudo-state: last online state (for use in relational expressions).
796	</desc>
797	</const>
798
799	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
800	<desc>
801	Pseudo-state: first transient state (for use in relational expressions).
802	</desc>
803	</const>
804	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
805	<desc>
806	Pseudo-state: last transient state (for use in relational expressions).
807	</desc>
808	</const>
809
810	</enum>
811
812	<enum
813	name="SessionState"
814	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
815	>
816	<desc>
817	Session state. This enumeration represents possible values of
818	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
819	attributes.
820	</desc>
821
822	<const name="Null" value="0">
823	<desc>Null value (never used by the API).</desc>
824	</const>
825	<const name="Unlocked" value="1">
826	<desc>
827	In <link to="IMachine::sessionState"/>, this means that the machine
828	is not locked for any sessions.
829
830	In <link to="ISession::state"/>, this means that no machine is
831	currently locked for this session.
832	</desc>
833	</const>
834	<const name="Locked" value="2">
835	<desc>
836	In <link to="IMachine::sessionState"/>, this means that the machine
837	is currently locked for a session, whose process identifier can
838	then be found in the <link to="IMachine::sessionPid" /> attribute.
839
840	In <link to="ISession::state"/>, this means that a machine is
841	currently locked for this session, and the mutable machine object
842	can be found in the <link to="ISession::machine"/> attribute
843	(see <link to="IMachine::lockMachine" /> for details).
844	</desc>
845	</const>
846	<const name="Spawning" value="3">
847	<desc>
848	A new process is being spawned for the machine as a result of
849	<link to="IMachine::launchVMProcess"/> call. This state also occurs
850	as a short transient state during an <link to="IMachine::lockMachine"/>
851	call.
852	</desc>
853	</const>
854	<const name="Unlocking" value="4">
855	<desc>
856	The session is being unlocked.
857	</desc>
858	</const>
859	</enum>
860
861	<enum
862	name="CPUPropertyType"
863	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
864	>
865	<desc>
866	Virtual CPU property type. This enumeration represents possible values of the
867	IMachine get- and setCPUProperty methods.
868	</desc>
869	<const name="Null" value="0">
870	<desc>Null value (never used by the API).</desc>
871	</const>
872	<const name="PAE" value="1">
873	<desc>
874	This setting determines whether VirtualBox will expose the Physical Address
875	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
876	is not available, it will not be reported.
877	</desc>
878	</const>
879	<const name="Synthetic" value="2">
880	<desc>
881	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
882	teleporting between host systems that differ significantly.
883	</desc>
884	</const>
885	</enum>
886
887
888	<enum
889	name="HWVirtExPropertyType"
890	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
891	>
892	<desc>
893	Hardware virtualization property type. This enumeration represents possible values
894	for the <link to="IMachine::getHWVirtExProperty"/> and
895	<link to="IMachine::setHWVirtExProperty"/> methods.
896	</desc>
897	<const name="Null" value="0">
898	<desc>Null value (never used by the API).</desc>
899	</const>
900	<const name="Enabled" value="1">
901	<desc>
902	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
903	such extensions are not available, they will not be used.
904	</desc>
905	</const>
906	<const name="Exclusive" value="2">
907	<desc>
908	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
909	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
910	feature of the host. To share these with other hypervisors, you must disable this property.
911	</desc>
912	</const>
913	<const name="VPID" value="3">
914	<desc>
915	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
916	</desc>
917	</const>
918	<const name="NestedPaging" value="4">
919	<desc>
920	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
921	</desc>
922	</const>
923	<const name="LargePages" value="5">
924	<desc>
925	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
926	</desc>
927	</const>
928	<const name="Force" value="6">
929	<desc>
930	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
931	not set, there will be an automatic fallback to software virtualization.
932	</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="FaultToleranceState"
938	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
939	>
940	<desc>
941	Used with <link to="IMachine::faultToleranceState" />.
942	</desc>
943	<const name="Inactive" value="1">
944	<desc>No fault tolerance enabled.</desc>
945	</const>
946	<const name="Master" value="2">
947	<desc>Fault tolerant master VM.</desc>
948	</const>
949	<const name="Standby" value="3">
950	<desc>Fault tolerant standby VM.</desc>
951	</const>
952	</enum>
953
954	<enum
955	name="LockType"
956	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
957	>
958	<desc>
959	Used with <link to="IMachine::lockMachine" />.
960	</desc>
961	<const name="Write" value="2">
962	<desc>Lock the machine for writing.</desc>
963	</const>
964	<const name="Shared" value="1">
965	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
966	</const>
967	</enum>
968
969	<enum
970	name="SessionType"
971	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
972	>
973	<desc>
974	Session type. This enumeration represents possible values of the
975	<link to="ISession::type"/> attribute.
976	</desc>
977
978	<const name="Null" value="0">
979	<desc>Null value (never used by the API).</desc>
980	</const>
981	<const name="WriteLock" value="1">
982	<desc>
983	Session has acquired an exclusive write lock on a machine
984	using <link to="IMachine::lockMachine"/>.
985	</desc>
986	</const>
987	<const name="Remote" value="2">
988	<desc>
989	Session has launched a VM process using
990	<link to="IMachine::launchVMProcess"/>
991	</desc>
992	</const>
993	<const name="Shared" value="3">
994	<desc>
995	Session has obtained a link to another session using
996	<link to="IMachine::lockMachine"/>
997	</desc>
998	</const>
999	</enum>
1000
1001	<enum
1002	name="DeviceType"
1003	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1004	>
1005	<desc>
1006	Device type.
1007	</desc>
1008	<const name="Null" value="0">
1009	<desc>
1010	Null value, may also mean "no device" (not allowed for
1011	<link to="IConsole::getDeviceActivity"/>).
1012	</desc>
1013	</const>
1014	<const name="Floppy" value="1">
1015	<desc>Floppy device.</desc>
1016	</const>
1017	<const name="DVD" value="2">
1018	<desc>CD/DVD-ROM device.</desc>
1019	</const>
1020	<const name="HardDisk" value="3">
1021	<desc>Hard disk device.</desc>
1022	</const>
1023	<const name="Network" value="4">
1024	<desc>Network device.</desc>
1025	</const>
1026	<const name="USB" value="5">
1027	<desc>USB device.</desc>
1028	</const>
1029	<const name="SharedFolder" value="6">
1030	<desc>Shared folder device.</desc>
1031	</const>
1032	</enum>
1033
1034	<enum
1035	name="DeviceActivity"
1036	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1037	>
1038	<desc>
1039	Device activity for <link to="IConsole::getDeviceActivity"/>.
1040	</desc>
1041
1042	<const name="Null" value="0"/>
1043	<const name="Idle" value="1"/>
1044	<const name="Reading" value="2"/>
1045	<const name="Writing" value="3"/>
1046	</enum>
1047
1048	<enum
1049	name="ClipboardMode"
1050	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1051	>
1052	<desc>
1053	Host-Guest clipboard interchange mode.
1054	</desc>
1055
1056	<const name="Disabled" value="0"/>
1057	<const name="HostToGuest" value="1"/>
1058	<const name="GuestToHost" value="2"/>
1059	<const name="Bidirectional" value="3"/>
1060	</enum>
1061
1062	<enum
1063	name="Scope"
1064	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1065	>
1066	<desc>
1067	Scope of the operation.
1068
1069	A generic enumeration used in various methods to define the action or
1070	argument scope.
1071	</desc>
1072
1073	<const name="Global" value="0"/>
1074	<const name="Machine" value="1"/>
1075	<const name="Session" value="2"/>
1076	</enum>
1077
1078	<enum
1079	name="BIOSBootMenuMode"
1080	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1081	>
1082	<desc>
1083	BIOS boot menu mode.
1084	</desc>
1085
1086	<const name="Disabled" value="0"/>
1087	<const name="MenuOnly" value="1"/>
1088	<const name="MessageAndMenu" value="2"/>
1089	</enum>
1090
1091	<enum
1092	name="ProcessorFeature"
1093	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1094	>
1095	<desc>
1096	CPU features.
1097	</desc>
1098
1099	<const name="HWVirtEx" value="0"/>
1100	<const name="PAE" value="1"/>
1101	<const name="LongMode" value="2"/>
1102	<const name="NestedPaging" value="3"/>
1103	</enum>
1104
1105	<enum
1106	name="FirmwareType"
1107	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1108	>
1109	<desc>
1110	Firmware type.
1111	</desc>
1112	<const name="BIOS" value="1">
1113	<desc>BIOS Firmware.</desc>
1114	</const>
1115	<const name="EFI" value="2">
1116	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1117	</const>
1118	<const name="EFI32" value="3">
1119	<desc>Efi firmware, 32-bit.</desc>
1120	</const>
1121	<const name="EFI64" value="4">
1122	<desc>Efi firmware, 64-bit.</desc>
1123	</const>
1124	<const name="EFIDUAL" value="5">
1125	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1126	</const>
1127	</enum>
1128
1129	<enum
1130	name="PointingHidType"
1131	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1132	>
1133	<desc>
1134	Type of pointing device used in a virtual machine.
1135	</desc>
1136	<const name="None" value="1">
1137	<desc>No mouse.</desc>
1138	</const>
1139	<const name="PS2Mouse" value="2">
1140	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1141	</const>
1142	<const name="USBMouse" value="3">
1143	<desc>USB mouse (relative pointer).</desc>
1144	</const>
1145	<const name="USBTablet" value="4">
1146	<desc>USB tablet (absolute pointer).</desc>
1147	</const>
1148	<const name="ComboMouse" value="5">
1149	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1150	Using of such device can have negative performance implications. </desc>
1151	</const>
1152	</enum>
1153
1154	<enum
1155	name="KeyboardHidType"
1156	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1157	>
1158	<desc>
1159	Type of keyboard device used in a virtual machine.
1160	</desc>
1161	<const name="None" value="1">
1162	<desc>No keyboard.</desc>
1163	</const>
1164	<const name="PS2Keyboard" value="2">
1165	<desc>PS/2 keyboard.</desc>
1166	</const>
1167	<const name="USBKeyboard" value="3">
1168	<desc>USB keyboard.</desc>
1169	</const>
1170	<const name="ComboKeyboard" value="4">
1171	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1172	Using of such device can have negative performance implications. </desc>
1173	</const>
1174	</enum>
1175
1176	<!--
1177	// IVirtualBoxErrorInfo
1178	/////////////////////////////////////////////////////////////////////////
1179	-->
1180
1181	<interface
1182	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1183	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1184	supportsErrorInfo="no"
1185	wsmap="managed"
1186	>
1187	<desc>
1188	The IVirtualBoxErrorInfo interface represents extended error information.
1189
1190	Extended error information can be set by VirtualBox components after
1191	unsuccessful or partially successful method invocation. This information
1192	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1193	and then shown to the client in addition to the plain 32-bit result code.
1194
1195	In MS COM, this interface extends the IErrorInfo interface,
1196	in XPCOM, it extends the nsIException interface. In both cases,
1197	it provides a set of common attributes to retrieve error
1198	information.
1199
1200	Sometimes invocation of some component's method may involve methods of
1201	other components that may also fail (independently of this method's
1202	failure), or a series of non-fatal errors may precede a fatal error that
1203	causes method failure. In cases like that, it may be desirable to preserve
1204	information about all errors happened during method invocation and deliver
1205	it to the caller. The <link to="#next"/> attribute is intended
1206	specifically for this purpose and allows to represent a chain of errors
1207	through a single IVirtualBoxErrorInfo object set after method invocation.
1208
1209	<note>errors are stored to a chain in the reverse order, i.e. the
1210	initial error object you query right after method invocation is the last
1211	error set by the callee, the object it points to in the @a next attribute
1212	is the previous error and so on, up to the first error (which is the last
1213	in the chain).</note>
1214	</desc>
1215
1216	<attribute name="resultCode" type="long" readonly="yes">
1217	<desc>
1218	Result code of the error.
1219	Usually, it will be the same as the result code returned
1220	by the method that provided this error information, but not
1221	always. For example, on Win32, CoCreateInstance() will most
1222	likely return E_NOINTERFACE upon unsuccessful component
1223	instantiation attempt, but not the value the component factory
1224	returned. Value is typed 'long', not 'result',
1225	to make interface usable from scripting languages.
1226	<note>
1227	In MS COM, there is no equivalent.
1228	In XPCOM, it is the same as nsIException::result.
1229	</note>
1230	</desc>
1231	</attribute>
1232
1233	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1234	<desc>
1235	UUID of the interface that defined the error.
1236	<note>
1237	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1238	data type.
1239	In XPCOM, there is no equivalent.
1240	</note>
1241	</desc>
1242	</attribute>
1243
1244	<attribute name="component" type="wstring" readonly="yes">
1245	<desc>
1246	Name of the component that generated the error.
1247	<note>
1248	In MS COM, it is the same as IErrorInfo::GetSource.
1249	In XPCOM, there is no equivalent.
1250	</note>
1251	</desc>
1252	</attribute>
1253
1254	<attribute name="text" type="wstring" readonly="yes">
1255	<desc>
1256	Text description of the error.
1257	<note>
1258	In MS COM, it is the same as IErrorInfo::GetDescription.
1259	In XPCOM, it is the same as nsIException::message.
1260	</note>
1261	</desc>
1262	</attribute>
1263
1264	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1265	<desc>
1266	Next error object if there is any, or @c null otherwise.
1267	<note>
1268	In MS COM, there is no equivalent.
1269	In XPCOM, it is the same as nsIException::inner.
1270	</note>
1271	</desc>
1272	</attribute>
1273
1274	</interface>
1275
1276	<!--
1277	// IVirtualBox
1278	/////////////////////////////////////////////////////////////////////////
1279	-->
1280
1281	<interface
1282	name="IDHCPServer" extends="$unknown"
1283	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1284	wsmap="managed"
1285	>
1286	<desc>
1287	The IDHCPServer interface represents the vbox dhcp server configuration.
1288
1289	To enumerate all the dhcp servers on the host, use the
1290	<link to="IVirtualBox::DHCPServers"/> attribute.
1291	</desc>
1292
1293	<attribute name="enabled" type="boolean">
1294	<desc>
1295	specifies if the dhcp server is enabled
1296	</desc>
1297	</attribute>
1298
1299	<attribute name="IPAddress" type="wstring" readonly="yes">
1300	<desc>
1301	specifies server IP
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="networkMask" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server network mask
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkName" type="wstring" readonly="yes">
1312	<desc>
1313	specifies internal network name the server is used for
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="lowerIP" type="wstring" readonly="yes">
1318	<desc>
1319	specifies from IP address in server address range
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="upperIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies to IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<method name="setConfiguration">
1330	<desc>
1331	configures the server
1332	<result name="E_INVALIDARG">
1333	invalid configuration supplied
1334	</result>
1335	</desc>
1336	<param name="IPAddress" type="wstring" dir="in">
1337	<desc>
1338	server IP address
1339	</desc>
1340	</param>
1341	<param name="networkMask" type="wstring" dir="in">
1342	<desc>
1343	server network mask
1344	</desc>
1345	</param>
1346	<param name="FromIPAddress" type="wstring" dir="in">
1347	<desc>
1348	server From IP address for address range
1349	</desc>
1350	</param>
1351	<param name="ToIPAddress" type="wstring" dir="in">
1352	<desc>
1353	server To IP address for address range
1354	</desc>
1355	</param>
1356	</method>
1357
1358	<method name="start">
1359	<desc>
1360	Starts DHCP server process.
1361	<result name="E_FAIL">
1362	Failed to start the process.
1363	</result>
1364	</desc>
1365	<param name="networkName" type="wstring" dir="in">
1366	<desc>
1367	Name of internal network DHCP server should attach to.
1368	</desc>
1369	</param>
1370	<param name="trunkName" type="wstring" dir="in">
1371	<desc>
1372	Name of internal network trunk.
1373	</desc>
1374	</param>
1375	<param name="trunkType" type="wstring" dir="in">
1376	<desc>
1377	Type of internal network trunk.
1378	</desc>
1379	</param>
1380	</method>
1381
1382	<method name="stop">
1383	<desc>
1384	Stops DHCP server process.
1385	<result name="E_FAIL">
1386	Failed to stop the process.
1387	</result>
1388	</desc>
1389	</method>
1390	</interface>
1391
1392	<interface
1393	name="IVirtualBox" extends="$unknown"
1394	uuid="bc166b9b-9b62-4145-b1f6-6c39068aaf00"
1395	wsmap="managed"
1396	>
1397	<desc>
1398	The IVirtualBox interface represents the main interface exposed by the
1399	product that provides virtual machine management.
1400
1401	An instance of IVirtualBox is required for the product to do anything
1402	useful. Even though the interface does not expose this, internally,
1403	IVirtualBox is implemented as a singleton and actually lives in the
1404	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1405	IVirtualBox can track the state of all virtual machines on a particular
1406	host, regardless of which frontend started them.
1407
1408	To enumerate all the virtual machines on the host, use the
1409	<link to="IVirtualBox::machines"/> attribute.
1410	</desc>
1411
1412	<attribute name="version" type="wstring" readonly="yes">
1413	<desc>
1414	A string representing the version number of the product. The
1415	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1416	last number represents the build number and will frequently change.
1417	</desc>
1418	</attribute>
1419
1420	<attribute name="revision" type="unsigned long" readonly="yes">
1421	<desc>
1422	The internal build revision number of the product.
1423	</desc>
1424	</attribute>
1425
1426	<attribute name="packageType" type="wstring" readonly="yes">
1427	<desc>
1428	A string representing the package type of this product. The
1429	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1430	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1431	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1432	this.
1433	</desc>
1434	</attribute>
1435
1436	<attribute name="APIVersion" type="wstring" readonly="yes">
1437	<desc>
1438	A string representing the VirtualBox API version number. The format is
1439	2 integer numbers divided by an underscore (e.g. 1_0). After the
1440	first public release of packages with a particular API version the
1441	API will not be changed in an incompatible way. Note that this
1442	guarantee does not apply to development builds, and also there is no
1443	guarantee that this version is identical to the first two integer
1444	numbers of the package version.
1445	</desc>
1446	</attribute>
1447
1448	<attribute name="homeFolder" type="wstring" readonly="yes">
1449	<desc>
1450	Full path to the directory where the global settings file,
1451	<tt>VirtualBox.xml</tt>, is stored.
1452
1453	In this version of VirtualBox, the value of this property is
1454	always <tt><user_dir>/.VirtualBox</tt> (where
1455	<tt><user_dir></tt> is the path to the user directory,
1456	as determined by the host OS), and cannot be changed.
1457
1458	This path is also used as the base to resolve relative paths in
1459	places where relative paths are allowed (unless otherwise
1460	expressly indicated).
1461	</desc>
1462	</attribute>
1463
1464	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1465	<desc>
1466	Full name of the global settings file.
1467	The value of this property corresponds to the value of
1468	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1469	</desc>
1470	</attribute>
1471
1472	<attribute name="host" type="IHost" readonly="yes">
1473	<desc>Associated host object.</desc>
1474	</attribute>
1475
1476	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1477	<desc>Associated system information object.</desc>
1478	</attribute>
1479
1480	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1481	<desc>
1482	Array of machine objects registered within this VirtualBox instance.
1483	</desc>
1484	</attribute>
1485
1486	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1487	<desc>
1488	Array of medium objects known to this VirtualBox installation.
1489
1490	This array contains only base media. All differencing
1491	media of the given base medium can be enumerated using
1492	<link to="IMedium::children"/>.
1493	</desc>
1494	</attribute>
1495
1496	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1497	<desc>
1498	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1499	</desc>
1500	</attribute>
1501
1502	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1503	<desc>
1504	Array of floppy image objects currently in use by this VirtualBox instance.
1505	</desc>
1506	</attribute>
1507
1508	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1509
1510	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1511
1512	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1513	<desc>
1514	Collection of global shared folders. Global shared folders are
1515	available to all virtual machines.
1516
1517	New shared folders are added to the collection using
1518	<link to="#createSharedFolder"/>. Existing shared folders can be
1519	removed using <link to="#removeSharedFolder"/>.
1520
1521	<note>
1522	In the current version of the product, global shared folders are not
1523	implemented and therefore this collection is always empty.
1524	</note>
1525	</desc>
1526	</attribute>
1527
1528	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1529	<desc>
1530	Associated performance collector object.
1531	</desc>
1532	</attribute>
1533
1534	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1535	<desc>
1536	DHCP servers.
1537	</desc>
1538	</attribute>
1539
1540	<attribute name="eventSource" type="IEventSource" readonly="yes">
1541	<desc>
1542	Event source for VirtualBox events.
1543	</desc>
1544	</attribute>
1545
1546	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1547	<desc>
1548	The extension pack manager.
1549	</desc>
1550	</attribute>
1551
1552
1553	<method name="composeMachineFilename">
1554	<desc>
1555	Returns a recommended full path of the settings file name for a new virtual
1556	machine.
1557
1558	This API serves two purposes:
1559
1560	<ul>
1561	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1562	for the @a settingsFile argument there, which means that API should use
1563	a recommended default file name.</li>
1564
1565	<li>It can be called manually by a client software before creating a machine,
1566	e.g. if that client wants to pre-create the machine directory to create
1567	virtual hard disks in that directory together with the new machine
1568	settings file. In that case, the file name should be stripped from the
1569	full settings file path returned by this function to obtain the
1570	machine directory.</li>
1571	</ul>
1572
1573	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1574	details about the machine name.
1575
1576	If @a baseFolder is a @c null or empty string (which is recommended), the
1577	default machine settings folder
1578	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1579	a base folder for the created machine, resulting in a file name like
1580	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1581	will be used.
1582
1583	This method does not access the host disks. In particular, it does not check
1584	for whether a machine of this name already exists.
1585	</desc>
1586	<param name="name" type="wstring" dir="in">
1587	<desc>Suggested machine name.</desc>
1588	</param>
1589	<param name="baseFolder" type="wstring" dir="in">
1590	<desc>Base machine folder (optional).</desc>
1591	</param>
1592	<param name="file" type="wstring" dir="return">
1593	<desc>Fully qualified path where the machine would be created.</desc>
1594	</param>
1595	</method>
1596
1597	<method name="createMachine">
1598	<desc>
1599	Creates a new virtual machine by creating a machine settings file at
1600	the given location.
1601
1602	VirtualBox machine settings files use a custom XML dialect. Starting
1603	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1604	and machine files can be created at arbitrary locations.
1605
1606	However, it is is recommended that machines be created in the default
1607	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1608	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1609	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1610	is called automatically to have such a recommended name composed based
1611	on the machine name given in the @a name argument.
1612
1613	If the resulting settings file already exists, this method will fail,
1614	unless @a forceOverwrite is set.
1615
1616	The new machine is created unregistered, with the initial configuration
1617	set according to the specified guest OS type. A typical sequence of
1618	actions to create a new virtual machine is as follows:
1619
1620	<ol>
1621	<li>
1622	Call this method to have a new machine created. The returned machine
1623	object will be "mutable" allowing to change any machine property.
1624	</li>
1625
1626	<li>
1627	Configure the machine using the appropriate attributes and methods.
1628	</li>
1629
1630	<li>
1631	Call <link to="IMachine::saveSettings" /> to write the settings
1632	to the machine's XML settings file. The configuration of the newly
1633	created machine will not be saved to disk until this method is
1634	called.
1635	</li>
1636
1637	<li>
1638	Call <link to="#registerMachine" /> to add the machine to the list
1639	of machines known to VirtualBox.
1640	</li>
1641	</ol>
1642
1643	The specified guest OS type identifier must match an ID of one of known
1644	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1645	array.
1646
1647	Optionally, you may specify an UUID of to assign to the created machine.
1648	However, this is not recommended and you should normally pass an empty
1649	(@c null) UUID to this method so that a new UUID will be automatically
1650	generated for every created machine. You can use UUID
1651	00000000-0000-0000-0000-000000000000 as @c null value.
1652
1653	<note>
1654	There is no way to change the name of the settings file or
1655	subfolder of the created machine directly.
1656	</note>
1657
1658	<result name="VBOX_E_OBJECT_NOT_FOUND">
1659	@a osTypeId is invalid.
1660	</result>
1661	<result name="VBOX_E_FILE_ERROR">
1662	Resulting settings file name is invalid or the settings file already
1663	exists or could not be created due to an I/O error.
1664	</result>
1665	<result name="E_INVALIDARG">
1666	@a name is empty or @c null.
1667	</result>
1668	</desc>
1669
1670	<param name="settingsFile" type="wstring" dir="in">
1671	<desc>Fully qualified path where the settings file should be created,
1672	or NULL for a default folder and file based on the @a name argument
1673	(see <link to="#composeMachineFilename" />).</desc>
1674	</param>
1675	<param name="name" type="wstring" dir="in">
1676	<desc>Machine name.</desc>
1677	</param>
1678	<param name="osTypeId" type="wstring" dir="in">
1679	<desc>Guest OS Type ID.</desc>
1680	</param>
1681	<param name="id" type="uuid" mod="string" dir="in">
1682	<desc>Machine UUID (optional).</desc>
1683	</param>
1684	<param name="forceOverwrite" type="boolean" dir="in">
1685	<desc>If true, an existing machine settings file will be overwritten.</desc>
1686	</param>
1687	<param name="machine" type="IMachine" dir="return">
1688	<desc>Created machine object.</desc>
1689	</param>
1690	</method>
1691
1692	<method name="openMachine">
1693	<desc>
1694	Opens a virtual machine from the existing settings file.
1695	The opened machine remains unregistered until you call
1696	<link to="#registerMachine"/>.
1697
1698	The specified settings file name must be fully qualified.
1699	The file must exist and be a valid machine XML settings file
1700	whose contents will be used to construct the machine object.
1701
1702	<result name="VBOX_E_FILE_ERROR">
1703	Settings file name invalid, not found or sharing violation.
1704	</result>
1705	</desc>
1706	<param name="settingsFile" type="wstring" dir="in">
1707	<desc>
1708	Name of the machine settings file.
1709	</desc>
1710	</param>
1711	<param name="machine" type="IMachine" dir="return">
1712	<desc>Opened machine object.</desc>
1713	</param>
1714	<note>
1715	<link to="IMachine::settingsModified"/> will return
1716	@c false for the created machine, until any of machine settings
1717	are changed.
1718	</note>
1719	</method>
1720
1721	<method name="registerMachine">
1722	<desc>
1723
1724	Registers the machine previously created using
1725	<link to="#createMachine"/> or opened using
1726	<link to="#openMachine"/> within this VirtualBox installation. After
1727	successful method invocation, the
1728	<link to="IMachineRegisteredEvent"/> event is fired.
1729
1730	<note>
1731	This method implicitly calls <link to="IMachine::saveSettings"/>
1732	to save all current machine settings before registering it.
1733	</note>
1734
1735	<result name="VBOX_E_OBJECT_NOT_FOUND">
1736	No matching virtual machine found.
1737	</result>
1738	<result name="VBOX_E_INVALID_OBJECT_STATE">
1739	Virtual machine was not created within this VirtualBox instance.
1740	</result>
1741
1742	</desc>
1743	<param name="machine" type="IMachine" dir="in"/>
1744	</method>
1745
1746	<method name="findMachine">
1747	<desc>
1748	Attempts to find a virtual machine given its name or UUID.
1749
1750	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1751	cannot safely be determined.</note>
1752
1753	<result name="VBOX_E_OBJECT_NOT_FOUND">
1754	Could not find registered machine matching @a nameOrId.
1755	</result>
1756
1757	</desc>
1758	<param name="nameOrId" type="wstring" dir="in">
1759	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1760	</param>
1761	<param name="machine" type="IMachine" dir="return">
1762	<desc>Machine object, if found.</desc>
1763	</param>
1764	</method>
1765
1766	<method name="createAppliance">
1767	<desc>
1768	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1769	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1770	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1771	</desc>
1772	<param name="appliance" type="IAppliance" dir="return">
1773	<desc>New appliance.</desc>
1774	</param>
1775	</method>
1776
1777	<method name="createHardDisk">
1778	<desc>
1779	Creates a new base medium object that will use the given storage
1780	format and location for medium data.
1781
1782	The actual storage unit is not created by this method. In order to
1783	do it, and before you are able to attach the created medium to
1784	virtual machines, you must call one of the following methods to
1785	allocate a format-specific storage unit at the specified location:
1786	<ul>
1787	<li><link to="IMedium::createBaseStorage"/></li>
1788	<li><link to="IMedium::createDiffStorage"/></li>
1789	</ul>
1790
1791	Some medium attributes, such as <link to="IMedium::id"/>, may
1792	remain uninitialized until the medium storage unit is successfully
1793	created by one of the above methods.
1794
1795	After the storage unit is successfully created, it will be
1796	accessible through the <link to="#findMedium"/> method and can
1797	be found in the <link to="#hardDisks"/> array.
1798
1799	The list of all storage formats supported by this VirtualBox
1800	installation can be obtained using
1801	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1802	attribute is empty or @c null then the default storage format
1803	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1804	be used for creating a storage unit of the medium.
1805
1806	Note that the format of the location string is storage format specific.
1807	See <link to="IMedium::location"/> and IMedium for more details.
1808
1809	<result name="VBOX_E_OBJECT_NOT_FOUND">
1810	@a format identifier is invalid. See
1811	<link to="ISystemProperties::mediumFormats"/>.
1812	</result>
1813	<result name="VBOX_E_FILE_ERROR">
1814	@a location is a not valid file name (for file-based formats only).
1815	</result>
1816	</desc>
1817	<param name="format" type="wstring" dir="in">
1818	<desc>
1819	Identifier of the storage format to use for the new medium.
1820	</desc>
1821	</param>
1822	<param name="location" type="wstring" dir="in">
1823	<desc>
1824	Location of the storage unit for the new medium.
1825	</desc>
1826	</param>
1827	<param name="medium" type="IMedium" dir="return">
1828	<desc>Created medium object.</desc>
1829	</param>
1830	</method>
1831
1832	<method name="openMedium">
1833	<desc>
1834	Opens a medium from an existing storage location.
1835
1836	Once a medium has been opened, it can be passed to other VirtualBox
1837	methods, in particular to <link to="IMachine::attachDevice" />.
1838
1839	Depending on the given device type, the file at the storage location
1840	must be in one of the media formats understood by VirtualBox:
1841
1842	<ul>
1843	<li>With a "HardDisk" device type, the file must be a hard disk image
1844	in one of the formats supported by VirtualBox (see
1845	<link to="ISystemProperties::mediumFormats" />).
1846	After this method succeeds, if the medium is a base medium, it
1847	will be added to the <link to="#hardDisks"/> array attribute. </li>
1848	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1849	After this method succeeds, the medium will be added to the
1850	<link to="#DVDImages"/> array attribute.</li>
1851	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1852	After this method succeeds, the medium will be added to the
1853	<link to="#floppyImages"/> array attribute.</li>
1854	</ul>
1855
1856	After having been opened, the medium can be found by the <link to="#findMedium"/>
1857	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1858
1859	The UUID of the newly opened medium will either be retrieved from the
1860	storage location, if the format supports it (e.g. for hard disk images),
1861	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1862	If for some reason you need to change the medium's UUID, use
1863	<link to="IMedium::setIDs" />.
1864
1865	If a differencing hard disk medium is to be opened by this method, the
1866	operation will succeed only if its parent medium and all ancestors,
1867	if any, are already known to this VirtualBox installation (for example,
1868	were opened by this method before).
1869
1870	This method attempts to guess the storage format of the specified medium
1871	by reading medium data at the specified location.
1872
1873	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1874	the image is opened for read/write access and must have according permissions,
1875	as VirtualBox may actually write status information into the disk's metadata
1876	sections.
1877
1878	Note that write access is required for all typical hard disk usage in VirtualBox,
1879	since VirtualBox may need to write metadata such as a UUID into the image.
1880	The only exception is opening a source image temporarily for copying and
1881	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1882	again soon.
1883
1884	The format of the location string is storage format specific. See
1885	<link to="IMedium::location"/> and IMedium for more details.
1886
1887	<result name="VBOX_E_FILE_ERROR">
1888	Invalid medium storage file location or could not find the medium
1889	at the specified location.
1890	</result>
1891	<result name="VBOX_E_IPRT_ERROR">
1892	Could not get medium storage format.
1893	</result>
1894	<result name="E_INVALIDARG">
1895	Invalid medium storage format.
1896	</result>
1897	<result name="VBOX_E_INVALID_OBJECT_STATE">
1898	Medium has already been added to a media registry.
1899	</result>
1900	</desc>
1901	<param name="location" type="wstring" dir="in">
1902	<desc>
1903	Location of the storage unit that contains medium data in one of
1904	the supported storage formats.
1905	</desc>
1906	</param>
1907	<param name="deviceType" type="DeviceType" dir="in">
1908	<desc>
1909	Must be one of "HardDisk", "DVD" or "Floppy".
1910	</desc>
1911	</param>
1912	<param name="accessMode" type="AccessMode" dir="in">
1913	<desc>Whether to open the image in read/write or read-only mode. For
1914	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1915	</param>
1916	<param name="medium" type="IMedium" dir="return">
1917	<desc>Opened medium object.</desc>
1918	</param>
1919	</method>
1920
1921	<method name="findMedium">
1922	<desc>
1923	Returns a medium of the given type that uses the given fully qualified
1924	location or UUID to store medium data.
1925
1926	The given medium must be known to this VirtualBox installation, i.e.
1927	it must be previously created by <link to="#createHardDisk"/> or opened
1928	by <link to="#openMedium"/>.
1929
1930	The search is done by comparing the value of the @a location argument to
1931	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1932	attributes of each known medium.
1933
1934	On case sensitive file systems, a case sensitive comparison is performed,
1935	otherwise the case of symbols in the file path is ignored.
1936
1937	<result name="VBOX_E_OBJECT_NOT_FOUND">
1938	No medium object matching @a location found.
1939	</result>
1940	</desc>
1941	<param name="location" type="wstring" dir="in">
1942	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1943	</param>
1944	<param name="type" type="DeviceType" dir="in">
1945	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1946	</param>
1947	<param name="medium" type="IMedium" dir="return">
1948	<desc>Medium object, if found.</desc>
1949	</param>
1950	</method>
1951
1952	<method name="getGuestOSType">
1953	<desc>
1954	Returns an object describing the specified guest OS type.
1955
1956	The requested guest OS type is specified using a string which is a
1957	mnemonic identifier of the guest operating system, such as
1958	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1959	particular virtual machine can be read or set using the
1960	<link to="IMachine::OSTypeId"/> attribute.
1961
1962	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1963	available guest OS type objects. Each object has an
1964	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1965	the guest OS this object describes.
1966
1967	<result name="E_INVALIDARG">
1968	@a id is not a valid Guest OS type.
1969	</result>
1970
1971	</desc>
1972	<param name="id" type="uuid" mod="string" dir="in">
1973	<desc>Guest OS type ID string.</desc>
1974	</param>
1975	<param name="type" type="IGuestOSType" dir="return">
1976	<desc>Guest OS type object.</desc>
1977	</param>
1978	</method>
1979
1980	<method name="createSharedFolder">
1981	<desc>
1982	Creates a new global shared folder by associating the given logical
1983	name with the given host path, adds it to the collection of shared
1984	folders and starts sharing it. Refer to the description of
1985	<link to="ISharedFolder"/> to read more about logical names.
1986	<note>
1987	In the current implementation, this operation is not
1988	implemented.
1989	</note>
1990	</desc>
1991	<param name="name" type="wstring" dir="in">
1992	<desc>Unique logical name of the shared folder.</desc>
1993	</param>
1994	<param name="hostPath" type="wstring" dir="in">
1995	<desc>Full path to the shared folder in the host file system.</desc>
1996	</param>
1997	<param name="writable" type="boolean" dir="in">
1998	<desc>Whether the share is writable or readonly</desc>
1999	</param>
2000	<param name="automount" type="boolean" dir="in">
2001	<desc>Whether the share gets automatically mounted by the guest
2002	or not.</desc>
2003	</param>
2004	</method>
2005
2006	<method name="removeSharedFolder">
2007	<desc>
2008	Removes the global shared folder with the given name previously
2009	created by <link to="#createSharedFolder"/> from the collection of
2010	shared folders and stops sharing it.
2011	<note>
2012	In the current implementation, this operation is not
2013	implemented.
2014	</note>
2015	</desc>
2016	<param name="name" type="wstring" dir="in">
2017	<desc>Logical name of the shared folder to remove.</desc>
2018	</param>
2019	</method>
2020
2021	<method name="getExtraDataKeys">
2022	<desc>
2023	Returns an array representing the global extra data keys which currently
2024	have values defined.
2025	</desc>
2026	<param name="value" type="wstring" dir="return" safearray="yes">
2027	<desc>Array of extra data keys.</desc>
2028	</param>
2029	</method>
2030
2031	<method name="getExtraData">
2032	<desc>
2033	Returns associated global extra data.
2034
2035	If the requested data @a key does not exist, this function will
2036	succeed and return an empty string in the @a value argument.
2037
2038	<result name="VBOX_E_FILE_ERROR">
2039	Settings file not accessible.
2040	</result>
2041	<result name="VBOX_E_XML_ERROR">
2042	Could not parse the settings file.
2043	</result>
2044
2045	</desc>
2046	<param name="key" type="wstring" dir="in">
2047	<desc>Name of the data key to get.</desc>
2048	</param>
2049	<param name="value" type="wstring" dir="return">
2050	<desc>Value of the requested data key.</desc>
2051	</param>
2052	</method>
2053
2054	<method name="setExtraData">
2055	<desc>
2056	Sets associated global extra data.
2057
2058	If you pass @c null or empty string as a key @a value, the given @a key
2059	will be deleted.
2060
2061	<note>
2062	Before performing the actual data change, this method will ask all
2063	registered event listener using the
2064	<link to="IExtraDataCanChangeEvent"/>
2065	notification for a permission. If one of the listeners refuses the
2066	new value, the change will not be performed.
2067	</note>
2068	<note>
2069	On success, the
2070	<link to="IExtraDataChangedEvent"/> notification
2071	is called to inform all registered listeners about a successful data
2072	change.
2073	</note>
2074
2075	<result name="VBOX_E_FILE_ERROR">
2076	Settings file not accessible.
2077	</result>
2078	<result name="VBOX_E_XML_ERROR">
2079	Could not parse the settings file.
2080	</result>
2081	<result name="E_ACCESSDENIED">
2082	Modification request refused.
2083	</result>
2084
2085	</desc>
2086	<param name="key" type="wstring" dir="in">
2087	<desc>Name of the data key to set.</desc>
2088	</param>
2089	<param name="value" type="wstring" dir="in">
2090	<desc>Value to assign to the key.</desc>
2091	</param>
2092	</method>
2093
2094	<!--method name="createDHCPServerForInterface">
2095	<desc>
2096	Creates a dhcp server settings to be used for the given interface
2097	<result name="E_INVALIDARG">
2098	Host network interface @a name already exists.
2099	</result>
2100	</desc>
2101	<param name="interface" type="IHostNetworkInterface" dir="in">
2102	<desc>Network Interface</desc>
2103	</param>
2104	<param name="server" type="IDHCPServer" dir="out">
2105	<desc>Dhcp server settings</desc>
2106	</param>
2107	</method-->
2108
2109	<method name="createDHCPServer">
2110	<desc>
2111	Creates a dhcp server settings to be used for the given internal network name
2112	<result name="E_INVALIDARG">
2113	Host network interface @a name already exists.
2114	</result>
2115	</desc>
2116	<param name="name" type="wstring" dir="in">
2117	<desc>server name</desc>
2118	</param>
2119	<param name="server" type="IDHCPServer" dir="return">
2120	<desc>Dhcp server settings</desc>
2121	</param>
2122	</method>
2123
2124	<method name="findDHCPServerByNetworkName">
2125	<desc>
2126	Searches a dhcp server settings to be used for the given internal network name
2127	<result name="E_INVALIDARG">
2128	Host network interface @a name already exists.
2129	</result>
2130
2131	</desc>
2132	<param name="name" type="wstring" dir="in">
2133	<desc>server name</desc>
2134	</param>
2135	<param name="server" type="IDHCPServer" dir="return">
2136	<desc>Dhcp server settings</desc>
2137	</param>
2138	</method>
2139
2140	<!--method name="findDHCPServerForInterface">
2141	<desc>
2142	Searches a dhcp server settings to be used for the given interface
2143	<result name="E_INVALIDARG">
2144	Host network interface @a name already exists.
2145	</result>
2146	</desc>
2147	<param name="interface" type="IHostNetworkInterface" dir="in">
2148	<desc>Network Interface</desc>
2149	</param>
2150	<param name="server" type="IDHCPServer" dir="out">
2151	<desc>Dhcp server settings</desc>
2152	</param>
2153	</method-->
2154
2155	<method name="removeDHCPServer">
2156	<desc>
2157	Removes the dhcp server settings
2158	<result name="E_INVALIDARG">
2159	Host network interface @a name already exists.
2160	</result>
2161	</desc>
2162	<param name="server" type="IDHCPServer" dir="in">
2163	<desc>Dhcp server settings to be removed</desc>
2164	</param>
2165	</method>
2166
2167
2168	<method name="checkFirmwarePresent">
2169	<desc>
2170	Check if this VirtualBox installation has a firmware
2171	of the given type available, either system-wide or per-user.
2172	Optionally, this may return a hint where this firmware can be
2173	downloaded from.
2174	</desc>
2175	<param name="firmwareType" type="FirmwareType" dir="in">
2176	<desc>
2177	Type of firmware to check.
2178	</desc>
2179	</param>
2180	<param name="version" type="wstring" dir="in">
2181	<desc>Expected version number, usually empty string (presently ignored).</desc>
2182	</param>
2183
2184	<param name="url" type="wstring" dir="out">
2185	<desc>
2186	Suggested URL to download this firmware from.
2187	</desc>
2188	</param>
2189
2190	<param name="file" type="wstring" dir="out">
2191	<desc>
2192	Filename of firmware, only valid if result == TRUE.
2193	</desc>
2194	</param>
2195
2196	<param name="result" type="boolean" dir="return">
2197	<desc>If firmware of this type and version is available.</desc>
2198	</param>
2199	</method>
2200
2201	</interface>
2202
2203	<!--
2204	// IVFSExplorer
2205	/////////////////////////////////////////////////////////////////////////
2206	-->
2207
2208	<enum
2209	name="VFSType"
2210	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2211	>
2212	<desc>
2213	Virtual file systems supported by VFSExplorer.
2214	</desc>
2215
2216	<const name="File" value="1" />
2217	<const name="Cloud" value="2" />
2218	<const name="S3" value="3" />
2219	<const name="WebDav" value="4" />
2220	</enum>
2221
2222	<enum
2223	name="VFSFileType"
2224	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2225	>
2226	<desc>
2227	File types known by VFSExplorer.
2228	</desc>
2229
2230	<const name="Unknown" value="1" />
2231	<const name="Fifo" value="2" />
2232	<const name="DevChar" value="3" />
2233	<const name="Directory" value="4" />
2234	<const name="DevBlock" value="5" />
2235	<const name="File" value="6" />
2236	<const name="SymLink" value="7" />
2237	<const name="Socket" value="8" />
2238	<const name="WhiteOut" value="9" />
2239	</enum>
2240
2241	<interface
2242	name="IVFSExplorer" extends="$unknown"
2243	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2244	wsmap="managed"
2245	>
2246	<desc>
2247	The VFSExplorer interface unifies access to different file system
2248	types. This includes local file systems as well remote file systems like
2249	S3. For a list of supported types see <link to="VFSType" />.
2250	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2251	</desc>
2252
2253	<attribute name="path" type="wstring" readonly="yes">
2254	<desc>Returns the current path in the virtual file system.</desc>
2255	</attribute>
2256
2257	<attribute name="type" type="VFSType" readonly="yes">
2258	<desc>Returns the file system type which is currently in use.</desc>
2259	</attribute>
2260
2261	<method name="update">
2262	<desc>Updates the internal list of files/directories from the
2263	current directory level. Use <link to="#entryList" /> to get the full list
2264	after a call to this method.</desc>
2265
2266	<param name="aProgress" type="IProgress" dir="return">
2267	<desc>Progress object to track the operation completion.</desc>
2268	</param>
2269	</method>
2270
2271	<method name="cd">
2272	<desc>Change the current directory level.</desc>
2273
2274	<param name="aDir" type="wstring" dir="in">
2275	<desc>The name of the directory to go in.</desc>
2276	</param>
2277
2278	<param name="aProgress" type="IProgress" dir="return">
2279	<desc>Progress object to track the operation completion.</desc>
2280	</param>
2281	</method>
2282
2283	<method name="cdUp">
2284	<desc>Go one directory upwards from the current directory level.</desc>
2285
2286	<param name="aProgress" type="IProgress" dir="return">
2287	<desc>Progress object to track the operation completion.</desc>
2288	</param>
2289	</method>
2290
2291	<method name="entryList">
2292	<desc>Returns a list of files/directories after a call to <link
2293	to="#update" />. The user is responsible for keeping this internal
2294	list up do date.</desc>
2295
2296	<param name="aNames" type="wstring" safearray="yes" dir="out">
2297	<desc>The list of names for the entries.</desc>
2298	</param>
2299
2300	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2301	<desc>The list of types for the entries.</desc>
2302	</param>
2303
2304	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2305	<desc>The list of sizes (in bytes) for the entries.</desc>
2306	</param>
2307
2308	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2309	<desc>The list of file modes (in octal form) for the entries.</desc>
2310	</param>
2311	</method>
2312
2313	<method name="exists">
2314	<desc>Checks if the given file list exists in the current directory
2315	level.</desc>
2316
2317	<param name="aNames" type="wstring" safearray="yes" dir="in">
2318	<desc>The names to check.</desc>
2319	</param>
2320
2321	<param name="aExists" type="wstring" safearray="yes" dir="return">
2322	<desc>The names which exist.</desc>
2323	</param>
2324	</method>
2325
2326	<method name="remove">
2327	<desc>Deletes the given files in the current directory level.</desc>
2328
2329	<param name="aNames" type="wstring" safearray="yes" dir="in">
2330	<desc>The names to remove.</desc>
2331	</param>
2332
2333	<param name="aProgress" type="IProgress" dir="return">
2334	<desc>Progress object to track the operation completion.</desc>
2335	</param>
2336	</method>
2337
2338	</interface>
2339
2340	<!--
2341	// IAppliance
2342	/////////////////////////////////////////////////////////////////////////
2343	-->
2344
2345	<interface
2346	name="IAppliance" extends="$unknown"
2347	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2348	wsmap="managed"
2349	>
2350	<desc>
2351	Represents a platform-independent appliance in OVF format. An instance of this is returned
2352	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2353	virtual machines within an appliance with VirtualBox.
2354
2355	The OVF standard suggests two different physical file formats:
2356
2357	<ol>
2358	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2359	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2360	this descriptor file references other files such as disk images, as OVF appliances typically
2361	do, those additional files must be in the same directory as the descriptor file.</li>
2362
2363	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2364	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2365	files and optionally other files.
2366
2367	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2368	be added with a later version.</li>
2369	</ol>
2370
2371	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2372	<link to="IMachine" /> involves the following sequence of API calls:
2373
2374	<ol>
2375	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2376	</li>
2377
2378	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2379	would like to import. So long as this file is syntactically valid, this will succeed
2380	and fill the appliance object with the parsed data from the OVF file.
2381	</li>
2382
2383	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2384	contents of the IAppliance attributes accordingly. These can be inspected by a
2385	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2386	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2387	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2388	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2389	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2390	The GUI can then give the user the option to confirm and/or change these suggestions.
2391	</li>
2392
2393	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2394	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2395	</li>
2396
2397	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2398	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2399	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2400	can be found in the <link to="#machines" /> array attribute.
2401	</li>
2402	</ol>
2403
2404	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2405
2406	<ol>
2407	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2408	an empty IAppliance object.
2409	</li>
2410
2411	<li>For each machine you would like to export, call <link to="IMachine::export" />
2412	with the IAppliance object you just created. Each such call creates one instance of
2413	<link to="IVirtualSystemDescription" /> inside the appliance.
2414	</li>
2415
2416	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2417	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2418	</li>
2419
2420	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2421	file written.</li>
2422	</ol>
2423
2424	</desc>
2425
2426	<attribute name="path" type="wstring" readonly="yes">
2427	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2428	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2429	<link to="#write" /> (for export).
2430	This attribute is empty until one of these methods has been called.
2431	</desc>
2432	</attribute>
2433
2434	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2435	<desc>
2436	Array of virtual disk definitions. One such description exists for each
2437	disk definition in the OVF; each string array item represents one such piece of
2438	disk information, with the information fields separated by tab (\\t) characters.
2439
2440	The caller should be prepared for additional fields being appended to
2441	this string in future versions of VirtualBox and therefore check for
2442	the number of tabs in the strings returned.
2443
2444	In the current version, the following eight fields are returned per string
2445	in the array:
2446
2447	<ol>
2448	<li>Disk ID (unique string identifier given to disk)</li>
2449
2450	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2451
2452	<li>Populated size (optional unsigned integer indicating the current size of the
2453	disk; can be approximate; -1 if unspecified)</li>
2454
2455	<li>Format (string identifying the disk format, typically
2456	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2457
2458	<li>Reference (where to find the disk image, typically a file name; if empty,
2459	then the disk should be created on import)</li>
2460
2461	<li>Image size (optional unsigned integer indicating the size of the image,
2462	which need not necessarily be the same as the values specified above, since
2463	the image may be compressed or sparse; -1 if not specified)</li>
2464
2465	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2466	presently unsupported and always -1)</li>
2467
2468	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2469	</ol>
2470	</desc>
2471	</attribute>
2472
2473	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2474	<desc> Array of virtual system descriptions. One such description is created
2475	for each virtual system (machine) found in the OVF.
2476	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2477	(for export) has been called.
2478	</desc>
2479	</attribute>
2480
2481	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2482	<desc>
2483	Contains the UUIDs of the machines created from the information in this appliances. This is only
2484	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2485	succeeded.
2486	</desc>
2487	</attribute>
2488
2489	<method name="read">
2490	<desc>
2491	Reads an OVF file into the appliance object.
2492
2493	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2494	mere fact that this method returns successfully does not mean that VirtualBox supports all
2495	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2496	</desc>
2497	<param name="file" type="wstring" dir="in">
2498	<desc>
2499	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2500	on whether the appliance is distributed as a set of files or as a single file, respectively).
2501	</desc>
2502	</param>
2503	<param name="aProgress" type="IProgress" dir="return">
2504	<desc>Progress object to track the operation completion.</desc>
2505	</param>
2506	</method>
2507
2508	<method name="interpret">
2509	<desc>
2510	Interprets the OVF data that was read when the appliance was constructed. After
2511	calling this method, one can inspect the
2512	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2513	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2514	the appliance.
2515
2516	Calling this method is the second step of importing an appliance into VirtualBox;
2517	see <link to="IAppliance" /> for an overview.
2518
2519	After calling this method, one should call <link to="#getWarnings" /> to find out
2520	if problems were encountered during the processing which might later lead to
2521	errors.
2522	</desc>
2523	</method>
2524
2525	<method name="importMachines">
2526	<desc>
2527	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2528	and other interfaces that match the information contained in the appliance as
2529	closely as possible, as represented by the import instructions in the
2530	<link to="#virtualSystemDescriptions" /> array.
2531
2532	Calling this method is the final step of importing an appliance into VirtualBox;
2533	see <link to="IAppliance" /> for an overview.
2534
2535	Since importing the appliance will most probably involve copying and converting
2536	disk images, which can take a long time, this method operates asynchronously and
2537	returns an IProgress object to allow the caller to monitor the progress.
2538
2539	After the import succeeded, the UUIDs of the IMachine instances created can be
2540	retrieved from the <link to="#machines" /> array attribute.
2541	</desc>
2542
2543	<param name="aProgress" type="IProgress" dir="return">
2544	<desc>Progress object to track the operation completion.</desc>
2545	</param>
2546	</method>
2547
2548	<method name="createVFSExplorer">
2549	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2550
2551	<param name="aUri" type="wstring" dir="in">
2552	<desc>The URI describing the file system to use.</desc>
2553	</param>
2554
2555	<param name="aExplorer" type="IVFSExplorer" dir="return">
2556	<desc></desc>
2557	</param>
2558	</method>
2559
2560	<method name="write">
2561	<desc>
2562	Writes the contents of the appliance exports into a new OVF file.
2563
2564	Calling this method is the final step of exporting an appliance from VirtualBox;
2565	see <link to="IAppliance" /> for an overview.
2566
2567	Since exporting the appliance will most probably involve copying and converting
2568	disk images, which can take a long time, this method operates asynchronously and
2569	returns an IProgress object to allow the caller to monitor the progress.
2570	</desc>
2571	<param name="format" type="wstring" dir="in">
2572	<desc>
2573	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2574	future versions of VirtualBox may support additional formats.
2575	</desc>
2576	</param>
2577	<param name="manifest" type="boolean" dir="in">
2578	<desc>
2579	Indicate if the optional manifest file (.mf) should be written. The manifest file
2580	is used for integrity checks prior import.
2581	</desc>
2582	</param>
2583	<param name="path" type="wstring" dir="in">
2584	<desc>
2585	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2586	on whether the appliance is distributed as a set of files or as a single file, respectively).
2587	</desc>
2588	</param>
2589	<param name="progress" type="IProgress" dir="return">
2590	<desc>Progress object to track the operation completion.</desc>
2591	</param>
2592	</method>
2593
2594	<method name="getWarnings">
2595	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2596
2597	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2598	<desc></desc>
2599	</param>
2600	</method>
2601
2602	</interface>
2603
2604	<enum
2605	name="VirtualSystemDescriptionType"
2606	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2607	>
2608	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2609	a configuration value.</desc>
2610
2611	<const name="Ignore" value="1" />
2612	<const name="OS" value="2" />
2613	<const name="Name" value="3" />
2614	<const name="Product" value="4" />
2615	<const name="Vendor" value="5" />
2616	<const name="Version" value="6" />
2617	<const name="ProductUrl" value="7" />
2618	<const name="VendorUrl" value="8" />
2619	<const name="Description" value="9" />
2620	<const name="License" value="10" />
2621	<const name="Miscellaneous" value="11" />
2622	<const name="CPU" value="12" />
2623	<const name="Memory" value="13" />
2624	<const name="HardDiskControllerIDE" value="14" />
2625	<const name="HardDiskControllerSATA" value="15" />
2626	<const name="HardDiskControllerSCSI" value="16" />
2627	<const name="HardDiskControllerSAS" value="17" />
2628	<const name="HardDiskImage" value="18" />
2629	<const name="Floppy" value="19" />
2630	<const name="CDROM" value="20" />
2631	<const name="NetworkAdapter" value="21" />
2632	<const name="USBController" value="22" />
2633	<const name="SoundCard" value="23" />
2634
2635	</enum>
2636
2637	<enum
2638	name="VirtualSystemDescriptionValueType"
2639	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2640	>
2641	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2642	type to fetch.</desc>
2643
2644	<const name="Reference" value="1" />
2645	<const name="Original" value="2" />
2646	<const name="Auto" value="3" />
2647	<const name="ExtraConfig" value="4" />
2648
2649	</enum>
2650
2651	<interface
2652	name="IVirtualSystemDescription" extends="$unknown"
2653	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2654	wsmap="managed"
2655	>
2656
2657	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2658	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2659	<link to="IAppliance::interpret" /> has been called, that array contains information
2660	about how the virtual systems described in the OVF should best be imported into
2661	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2662	import an OVF into VirtualBox.
2663	</desc>
2664
2665	<attribute name="count" type="unsigned long" readonly="yes">
2666	<desc>Return the number of virtual system description entries.</desc>
2667	</attribute>
2668
2669	<method name="getDescription">
2670	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2671	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2672
2673	The list below identifies the value sets that are possible depending on the
2674	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2675	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2676	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2677	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2678	the @a aExtraConfigValues[] array item may also be used.
2679
2680	<ul>
2681	<li>
2682	"OS": the guest operating system type. There must be exactly one such array item on import. The
2683	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2684	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2685	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2686	</li>
2687	<li>
2688	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2689	if none is present on import, then an automatic name will be created from the operating system
2690	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2691	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2692	<link to="IMachine" /> name that does not exist yet.
2693	</li>
2694	<li>
2695	"Description": an arbitrary description.
2696	</li>
2697	<li>
2698	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2699	code to display such a license for agreement; the Main API does not enforce any such policy.
2700	</li>
2701	<li>
2702	Miscellaneous: reserved for future use.
2703	</li>
2704	<li>
2705	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2706	</li>
2707	<li>
2708	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2709	is present on import, then VirtualBox will set a meaningful default based on the operating system
2710	type.
2711	</li>
2712	<li>
2713	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2714	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2715	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2716	writes into the OVF.
2717	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2718	type can use to specify which hard disk controller a virtual disk should be connected to.
2719	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2720	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2721	its virtual machines supports four channels (primary master, primary slave, secondary master,
2722	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2723	</li>
2724	<li>
2725	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2726	has no value in @a aOvfValues[] or @a aVBoxValues[].
2727	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2728	</li>
2729	<li>
2730	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2731	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2732	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2733	whereas VirtualBox considers it a class of storage controllers of its own; see
2734	<link to="StorageControllerType" />).
2735	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2736	</li>
2737	<li>
2738	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2739	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2740
2741	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2742	a path since the image file should be in the same location as the OVF file itself), whereas the
2743	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2744	hard disk image. This means that on import the image will be copied and converted from the
2745	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2746
2747	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2748	format: "controller=<index>;channel=<c>"
2749	In this string, <index> must be an integer specifying the hard disk controller to connect
2750	the image to. That number must be the index of an array item with one of the hard disk controller
2751	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2752	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2753	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2754	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2755	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2756	</li>
2757	<li>
2758	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2759	attachment information as with "HardDiskImage" items.
2760	</li>
2761	<li>
2762	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2763	attachment information as with "HardDiskImage" items.
2764	</li>
2765	<li>
2766	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2767	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2768	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2769	</li>
2770	<li>
2771	"USBController": a USB controller. There can be at most one such item. If and only if such an
2772	item ispresent, USB support will be enabled for the new virtual machine.
2773	</li>
2774	<li>
2775	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2776	present, sound support will be enabled for the new virtual machine. Note that the virtual
2777	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2778	may be different from the virtual soundcard expected by the appliance.
2779	</li>
2780	</ul>
2781
2782	</desc>
2783
2784	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2785	<desc></desc>
2786	</param>
2787
2788	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2789	<desc></desc>
2790	</param>
2791
2792	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2793	<desc></desc>
2794	</param>
2795
2796	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2797	<desc></desc>
2798	</param>
2799
2800	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2801	<desc></desc>
2802	</param>
2803
2804	</method>
2805
2806	<method name="getDescriptionByType">
2807	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2808	should be returned.</desc>
2809
2810	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2811	<desc></desc>
2812	</param>
2813
2814	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2815	<desc></desc>
2816	</param>
2817
2818	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2819	<desc></desc>
2820	</param>
2821
2822	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2823	<desc></desc>
2824	</param>
2825
2826	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2827	<desc></desc>
2828	</param>
2829
2830	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2831	<desc></desc>
2832	</param>
2833
2834	</method>
2835
2836	<method name="getValuesByType">
2837	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2838	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2839	values.</desc>
2840
2841	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2842	<desc></desc>
2843	</param>
2844
2845	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2846	<desc></desc>
2847	</param>
2848
2849	<param name="aValues" type="wstring" dir="return" safearray="yes">
2850	<desc></desc>
2851	</param>
2852
2853	</method>
2854
2855	<method name="setFinalValues">
2856	<desc>
2857	This method allows the appliance's user to change the configuration for the virtual
2858	system descriptions. For each array item returned from <link to="#getDescription" />,
2859	you must pass in one boolean value and one configuration value.
2860
2861	Each item in the boolean array determines whether the particular configuration item
2862	should be enabled.
2863	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2864	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2865	and SoundCard.
2866
2867	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2868	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2869	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2870	for valid configuration values for the individual array item types. If the
2871	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2872	</desc>
2873
2874	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2875	<desc></desc>
2876	</param>
2877
2878	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2879	<desc></desc>
2880	</param>
2881
2882	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2883	<desc></desc>
2884	</param>
2885	</method>
2886
2887	<method name="addDescription">
2888	<desc>
2889	This method adds an additional description entry to the stack of already
2890	available descriptions for this virtual system. This is handy for writing
2891	values which aren't directly supported by VirtualBox. One example would
2892	be the License type of <link to="VirtualSystemDescriptionType" />.
2893	</desc>
2894
2895	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2896	<desc></desc>
2897	</param>
2898
2899	<param name="aVBoxValue" type="wstring" dir="in">
2900	<desc></desc>
2901	</param>
2902
2903	<param name="aExtraConfigValue" type="wstring" dir="in">
2904	<desc></desc>
2905	</param>
2906	</method>
2907	</interface>
2908
2909
2910	<!--
2911	// IMachine
2912	/////////////////////////////////////////////////////////////////////////
2913	-->
2914
2915	<interface
2916	name="IInternalMachineControl" extends="$unknown"
2917	uuid="8e723ab0-812c-5662-dd8e-7ebc89637acf"
2918	internal="yes"
2919	wsmap="suppress"
2920	>
2921	<method name="setRemoveSavedStateFile">
2922	<desc>
2923	Updates the flag whether the saved state file is removed on a
2924	machine state change from Saved to PoweredOff.
2925	</desc>
2926	<param name="aRemove" type="boolean" dir="in"/>
2927	</method>
2928
2929	<method name="updateState">
2930	<desc>
2931	Updates the VM state.
2932	<note>
2933	This operation will also update the settings file with the correct
2934	information about the saved state file and delete this file from disk
2935	when appropriate.
2936	</note>
2937	</desc>
2938	<param name="state" type="MachineState" dir="in"/>
2939	</method>
2940
2941	<method name="getIPCId">
2942	<param name="id" type="wstring" dir="return"/>
2943	</method>
2944
2945	<method name="beginPowerUp">
2946	<desc>
2947	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2948	gives it the progress object that should be part of any pending
2949	<link to="IMachine::launchVMProcess"/> operations. The progress
2950	object may be called back to reflect an early cancelation, so some care
2951	have to be taken with respect to any cancelation callbacks. The console
2952	object will call <link to="IInternalMachineControl::endPowerUp"/>
2953	to signal the completion of the progress object.
2954	</desc>
2955	<param name="aProgress" type="IProgress" dir="in" />
2956	</method>
2957
2958	<method name="endPowerUp">
2959	<desc>
2960	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2961	This method may query status information from the progress object it
2962	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2963	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2964	call in order to complete that progress object.
2965	</desc>
2966	<param name="result" type="long" dir="in"/>
2967	</method>
2968
2969	<method name="beginPoweringDown">
2970	<desc>
2971	Called by the VM process to inform the server it wants to
2972	stop the VM execution and power down.
2973	</desc>
2974	<param name="progress" type="IProgress" dir="out">
2975	<desc>
2976	Progress object created by VBoxSVC to wait until
2977	the VM is powered down.
2978	</desc>
2979	</param>
2980	</method>
2981
2982	<method name="endPoweringDown">
2983	<desc>
2984	Called by the VM process to inform the server that powering
2985	down previously requested by #beginPoweringDown is either
2986	successfully finished or there was a failure.
2987
2988	<result name="VBOX_E_FILE_ERROR">
2989	Settings file not accessible.
2990	</result>
2991	<result name="VBOX_E_XML_ERROR">
2992	Could not parse the settings file.
2993	</result>
2994
2995	</desc>
2996
2997	<param name="result" type="long" dir="in">
2998	<desc>@c S_OK to indicate success.
2999	</desc>
3000	</param>
3001	<param name="errMsg" type="wstring" dir="in">
3002	<desc>@c human readable error message in case of failure.
3003	</desc>
3004	</param>
3005	</method>
3006
3007	<method name="runUSBDeviceFilters">
3008	<desc>
3009	Asks the server to run USB devices filters of the associated
3010	machine against the given USB device and tell if there is
3011	a match.
3012	<note>
3013	Intended to be used only for remote USB devices. Local
3014	ones don't require to call this method (this is done
3015	implicitly by the Host and USBProxyService).
3016	</note>
3017	</desc>
3018	<param name="device" type="IUSBDevice" dir="in"/>
3019	<param name="matched" type="boolean" dir="out"/>
3020	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3021	</method>
3022
3023	<method name="captureUSBDevice">
3024	<desc>
3025	Requests a capture of the given host USB device.
3026	When the request is completed, the VM process will
3027	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3028	notification.
3029	</desc>
3030	<param name="id" type="uuid" mod="string" dir="in"/>
3031	</method>
3032
3033	<method name="detachUSBDevice">
3034	<desc>
3035	Notification that a VM is going to detach (@a done = @c false) or has
3036	already detached (@a done = @c true) the given USB device.
3037	When the @a done = @c true request is completed, the VM process will
3038	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3039	notification.
3040	<note>
3041	In the @a done = @c true case, the server must run its own filters
3042	and filters of all VMs but this one on the detached device
3043	as if it were just attached to the host computer.
3044	</note>
3045	</desc>
3046	<param name="id" type="uuid" mod="string" dir="in"/>
3047	<param name="done" type="boolean" dir="in"/>
3048	</method>
3049
3050	<method name="autoCaptureUSBDevices">
3051	<desc>
3052	Requests a capture all matching USB devices attached to the host.
3053	When the request is completed, the VM process will
3054	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3055	notification per every captured device.
3056	</desc>
3057	</method>
3058
3059	<method name="detachAllUSBDevices">
3060	<desc>
3061	Notification that a VM that is being powered down. The done
3062	parameter indicates whether which stage of the power down
3063	we're at. When @a done = @c false the VM is announcing its
3064	intentions, while when @a done = @c true the VM is reporting
3065	what it has done.
3066	<note>
3067	In the @a done = @c true case, the server must run its own filters
3068	and filters of all VMs but this one on all detach devices as
3069	if they were just attached to the host computer.
3070	</note>
3071	</desc>
3072	<param name="done" type="boolean" dir="in"/>
3073	</method>
3074
3075	<method name="onSessionEnd">
3076	<desc>
3077	Triggered by the given session object when the session is about
3078	to close normally.
3079	</desc>
3080	<param name="session" type="ISession" dir="in">
3081	<desc>Session that is being closed</desc>
3082	</param>
3083	<param name="progress" type="IProgress" dir="return">
3084	<desc>
3085	Used to wait until the corresponding machine is actually
3086	dissociated from the given session on the server.
3087	Returned only when this session is a direct one.
3088	</desc>
3089	</param>
3090	</method>
3091
3092	<method name="beginSavingState">
3093	<desc>
3094	Called by the VM process to inform the server it wants to
3095	save the current state and stop the VM execution.
3096	</desc>
3097	<param name="progress" type="IProgress" dir="out">
3098	<desc>
3099	Progress object created by VBoxSVC to wait until
3100	the state is saved.
3101	</desc>
3102	</param>
3103	<param name="stateFilePath" type="wstring" dir="out">
3104	<desc>
3105	File path the VM process must save the execution state to.
3106	</desc>
3107	</param>
3108	</method>
3109
3110	<method name="endSavingState">
3111	<desc>
3112	Called by the VM process to inform the server that saving
3113	the state previously requested by #beginSavingState is either
3114	successfully finished or there was a failure.
3115
3116	<result name="VBOX_E_FILE_ERROR">
3117	Settings file not accessible.
3118	</result>
3119	<result name="VBOX_E_XML_ERROR">
3120	Could not parse the settings file.
3121	</result>
3122
3123	</desc>
3124
3125	<param name="result" type="long" dir="in">
3126	<desc>@c S_OK to indicate success.
3127	</desc>
3128	</param>
3129	<param name="errMsg" type="wstring" dir="in">
3130	<desc>@c human readable error message in case of failure.
3131	</desc>
3132	</param>
3133	</method>
3134
3135	<method name="adoptSavedState">
3136	<desc>
3137	Gets called by <link to="IConsole::adoptSavedState"/>.
3138	<result name="VBOX_E_FILE_ERROR">
3139	Invalid saved state file path.
3140	</result>
3141	</desc>
3142	<param name="savedStateFile" type="wstring" dir="in">
3143	<desc>Path to the saved state file to adopt.</desc>
3144	</param>
3145	</method>
3146
3147	<method name="beginTakingSnapshot">
3148	<desc>
3149	Called from the VM process to request from the server to perform the
3150	server-side actions of creating a snapshot (creating differencing images
3151	and the snapshot object).
3152
3153	<result name="VBOX_E_FILE_ERROR">
3154	Settings file not accessible.
3155	</result>
3156	<result name="VBOX_E_XML_ERROR">
3157	Could not parse the settings file.
3158	</result>
3159	</desc>
3160	<param name="initiator" type="IConsole" dir="in">
3161	<desc>The console object that initiated this call.</desc>
3162	</param>
3163	<param name="name" type="wstring" dir="in">
3164	<desc>Snapshot name.</desc>
3165	</param>
3166	<param name="description" type="wstring" dir="in">
3167	<desc>Snapshot description.</desc>
3168	</param>
3169	<param name="consoleProgress" type="IProgress" dir="in">
3170	<desc>
3171	Progress object created by the VM process tracking the
3172	snapshot's progress. This has the following sub-operations:
3173	<ul>
3174	<li>setting up (weight 1);</li>
3175	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3176	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3177	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3178	<li>finishing up (weight 1)</li>
3179	</ul>
3180	</desc>
3181	</param>
3182	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3183	<desc>
3184	Whether this is an online snapshot (i.e. the machine is running).
3185	</desc>
3186	</param>
3187	<param name="stateFilePath" type="wstring" dir="out">
3188	<desc>
3189	File path the VM process must save the execution state to.
3190	</desc>
3191	</param>
3192	</method>
3193
3194	<method name="endTakingSnapshot">
3195	<desc>
3196	Called by the VM process to inform the server that the snapshot
3197	previously requested by #beginTakingSnapshot is either
3198	successfully taken or there was a failure.
3199	</desc>
3200
3201	<param name="success" type="boolean" dir="in">
3202	<desc>@c true to indicate success and @c false otherwise</desc>
3203	</param>
3204	</method>
3205
3206	<method name="deleteSnapshot">
3207	<desc>
3208	Gets called by <link to="IConsole::deleteSnapshot"/> and
3209	<link to="IConsole::deleteSnapshotAndAllChildren"/>.
3210	<result name="VBOX_E_INVALID_OBJECT_STATE">
3211	Snapshot has more than one child snapshot. Only possible if the
3212	delete operation does not delete all children.
3213	</result>
3214	</desc>
3215	<param name="initiator" type="IConsole" dir="in">
3216	<desc>The console object that initiated this call.</desc>
3217	</param>
3218	<param name="id" type="uuid" mod="string" dir="in">
3219	<desc>UUID of the snapshot to delete.</desc>
3220	</param>
3221	<param name="deleteAllChildren" type="boolean" dir="in">
3222	<desc>Whether all children should be deleted.</desc>
3223	</param>
3224	<param name="machineState" type="MachineState" dir="out">
3225	<desc>New machine state after this operation is started.</desc>
3226	</param>
3227	<param name="progress" type="IProgress" dir="return">
3228	<desc>Progress object to track the operation completion.</desc>
3229	</param>
3230	</method>
3231
3232	<method name="finishOnlineMergeMedium">
3233	<desc>
3234	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3235	</desc>
3236	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3237	<desc>The medium attachment which needs to be cleaned up.</desc>
3238	</param>
3239	<param name="source" type="IMedium" dir="in">
3240	<desc>Merge source medium.</desc>
3241	</param>
3242	<param name="target" type="IMedium" dir="in">
3243	<desc>Merge target medium.</desc>
3244	</param>
3245	<param name="mergeForward" type="boolean" dir="in">
3246	<desc>Merge direction.</desc>
3247	</param>
3248	<param name="parentForTarget" type="IMedium" dir="in">
3249	<desc>For forward merges: new parent for target medium.</desc>
3250	</param>
3251	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3252	<desc>For backward merges: list of media which need their parent UUID
3253	updated.</desc>
3254	</param>
3255	</method>
3256
3257	<method name="restoreSnapshot">
3258	<desc>
3259	Gets called by <link to="IConsole::restoreSnapshot"/>.
3260	</desc>
3261	<param name="initiator" type="IConsole" dir="in">
3262	<desc>The console object that initiated this call.</desc>
3263	</param>
3264	<param name="snapshot" type="ISnapshot" dir="in">
3265	<desc>The snapshot to restore the VM state from.</desc>
3266	</param>
3267	<param name="machineState" type="MachineState" dir="out">
3268	<desc>New machine state after this operation is started.</desc>
3269	</param>
3270	<param name="progress" type="IProgress" dir="return">
3271	<desc>Progress object to track the operation completion.</desc>
3272	</param>
3273	</method>
3274
3275	<method name="pullGuestProperties">
3276	<desc>
3277	Get the list of the guest properties matching a set of patterns along
3278	with their values, time stamps and flags and give responsibility for
3279	managing properties to the console.
3280	</desc>
3281	<param name="name" type="wstring" dir="out" safearray="yes">
3282	<desc>
3283	The names of the properties returned.
3284	</desc>
3285	</param>
3286	<param name="value" type="wstring" dir="out" safearray="yes">
3287	<desc>
3288	The values of the properties returned. The array entries match the
3289	corresponding entries in the @a name array.
3290	</desc>
3291	</param>
3292	<param name="timestamp" type="long long" dir="out" safearray="yes">
3293	<desc>
3294	The time stamps of the properties returned. The array entries match
3295	the corresponding entries in the @a name array.
3296	</desc>
3297	</param>
3298	<param name="flags" type="wstring" dir="out" safearray="yes">
3299	<desc>
3300	The flags of the properties returned. The array entries match the
3301	corresponding entries in the @a name array.
3302	</desc>
3303	</param>
3304	</method>
3305
3306	<method name="pushGuestProperty">
3307	<desc>
3308	Update a single guest property in IMachine.
3309	</desc>
3310	<param name="name" type="wstring" dir="in">
3311	<desc>
3312	The name of the property to be updated.
3313	</desc>
3314	</param>
3315	<param name="value" type="wstring" dir="in">
3316	<desc>
3317	The value of the property.
3318	</desc>
3319	</param>
3320	<param name="timestamp" type="long long" dir="in">
3321	<desc>
3322	The timestamp of the property.
3323	</desc>
3324	</param>
3325	<param name="flags" type="wstring" dir="in">
3326	<desc>
3327	The flags of the property.
3328	</desc>
3329	</param>
3330	</method>
3331
3332	<method name="lockMedia">
3333	<desc>
3334	Locks all media attached to the machine for writing and parents of
3335	attached differencing media (if any) for reading. This operation is
3336	atomic so that if it fails no media is actually locked.
3337
3338	This method is intended to be called when the machine is in Starting or
3339	Restoring state. The locked media will be automatically unlocked when
3340	the machine is powered off or crashed.
3341	</desc>
3342	</method>
3343	<method name="unlockMedia">
3344	<desc>
3345	Unlocks all media previously locked using
3346	<link to="IInternalMachineControl::lockMedia"/>.
3347
3348	This method is intended to be used with teleportation so that it is
3349	possible to teleport between processes on the same machine.
3350	</desc>
3351	</method>
3352	</interface>
3353
3354	<interface
3355	name="IBIOSSettings" extends="$unknown"
3356	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3357	wsmap="managed"
3358	>
3359	<desc>
3360	The IBIOSSettings interface represents BIOS settings of the virtual
3361	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3362	</desc>
3363	<attribute name="logoFadeIn" type="boolean">
3364	<desc>Fade in flag for BIOS logo animation.</desc>
3365	</attribute>
3366
3367	<attribute name="logoFadeOut" type="boolean">
3368	<desc>Fade out flag for BIOS logo animation.</desc>
3369	</attribute>
3370
3371	<attribute name="logoDisplayTime" type="unsigned long">
3372	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3373	</attribute>
3374
3375	<attribute name="logoImagePath" type="wstring">
3376	<desc>
3377	Local file system path for external BIOS splash image. Empty string
3378	means the default image is shown on boot.
3379	</desc>
3380	</attribute>
3381
3382	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3383	<desc>Mode of the BIOS boot device menu.</desc>
3384	</attribute>
3385
3386	<attribute name="ACPIEnabled" type="boolean">
3387	<desc>ACPI support flag.</desc>
3388	</attribute>
3389
3390	<attribute name="IOAPICEnabled" type="boolean">
3391	<desc>
3392	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3393	and support IRQs above 15.
3394	</desc>
3395	</attribute>
3396
3397	<attribute name="timeOffset" type="long long">
3398	<desc>
3399	Offset in milliseconds from the host system time. This allows for
3400	guests running with a different system date/time than the host.
3401	It is equivalent to setting the system date/time in the BIOS except
3402	it is not an absolute value but a relative one. Guest Additions
3403	time synchronization honors this offset.
3404	</desc>
3405	</attribute>
3406
3407	<attribute name="PXEDebugEnabled" type="boolean">
3408	<desc>
3409	PXE debug logging flag. If set, VirtualBox will write extensive
3410	PXE trace information to the release log.
3411	</desc>
3412	</attribute>
3413
3414	</interface>
3415
3416	<enum
3417	name="CleanupMode"
3418	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3419	>
3420	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3421	</desc>
3422	<const name="UnregisterOnly" value="1">
3423	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3424	</const>
3425	<const name="DetachAllReturnNone" value="2">
3426	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3427	</const>
3428	<const name="DetachAllReturnHardDisksOnly" value="3">
3429	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3430	</const>
3431	<const name="Full" value="4">
3432	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3433	</const>
3434	</enum>
3435
3436	<interface
3437	name="IPciAddress" extends="$unknown"
3438	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3439	wsmap="struct"
3440	>
3441
3442	<desc>
3443	Address on the PCI bus.
3444	</desc>
3445
3446	<attribute name="bus" type="short">
3447	<desc>
3448	Bus number.
3449	</desc>
3450	</attribute>
3451
3452	<attribute name="device" type="short">
3453	<desc>
3454	Device number.
3455	</desc>
3456	</attribute>
3457
3458	<attribute name="devFunction" type="short">
3459	<desc>
3460	Device function number.
3461	</desc>
3462	</attribute>
3463
3464	<method name="asLong">
3465	<desc>
3466	Convert PCI address into long.
3467	</desc>
3468	<param name="result" type="long" dir="return" />
3469	</method>
3470
3471	<method name="fromLong">
3472	<desc>
3473	Make PCI address from long.
3474	</desc>
3475	<param name="number" type="long" dir="in" />
3476	</method>
3477	</interface>
3478
3479	<interface
3480	name="IPciDeviceAttachment" extends="$unknown"
3481	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3482	wsmap="struct"
3483	>
3484
3485	<desc>
3486	Information about PCI attachments.
3487	</desc>
3488
3489	<attribute name="name" type="wstring" readonly="yes">
3490	<desc>
3491	Device name.
3492	</desc>
3493	</attribute>
3494
3495	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3496	<desc>
3497	If this is physical or virtual device.
3498	</desc>
3499	</attribute>
3500
3501	<attribute name="hostAddress" type="long" readonly="yes">
3502	<desc>
3503	Address of device on the host, applicable only to host devices.
3504	</desc>
3505	</attribute>
3506
3507	<attribute name="guestAddress" type="long" readonly="yes">
3508	<desc>
3509	Address of device on the guest.
3510	</desc>
3511	</attribute>
3512
3513	</interface>
3514
3515
3516	<interface
3517	name="IMachine" extends="$unknown"
3518	uuid="84208466-c072-4e64-b993-c35c096cc837"
3519	wsmap="managed"
3520	>
3521	<desc>
3522	The IMachine interface represents a virtual machine, or guest, created
3523	in VirtualBox.
3524
3525	This interface is used in two contexts. First of all, a collection of
3526	objects implementing this interface is stored in the
3527	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3528	machines that are currently registered with this VirtualBox
3529	installation. Also, once a session has been opened for the given virtual
3530	machine (e.g. the virtual machine is running), the machine object
3531	associated with the open session can be queried from the session object;
3532	see <link to="ISession"/> for details.
3533
3534	The main role of this interface is to expose the settings of the virtual
3535	machine and provide methods to change various aspects of the virtual
3536	machine's configuration. For machine objects stored in the
3537	<link to="IVirtualBox::machines"/> collection, all attributes are
3538	read-only unless explicitly stated otherwise in individual attribute
3539	and method descriptions.
3540
3541	In order to change a machine setting, a session for this machine must be
3542	opened using one of the <link to="IMachine::lockMachine" /> or
3543	<link to="IMachine::launchVMProcess"/> methods. After the
3544	machine has been successfully locked for a session, a mutable machine object
3545	needs to be queried from the session object and then the desired settings
3546	changes can be applied to the returned object using IMachine attributes and
3547	methods. See the <link to="ISession"/> interface description for more
3548	information about sessions.
3549
3550	Note that IMachine does not provide methods to control virtual machine
3551	execution (such as start the machine, or power it down) -- these methods
3552	are grouped in a separate interface called <link to="IConsole" />.
3553
3554	<see><link to="ISession"/>, <link to="IConsole"/></see>
3555	</desc>
3556
3557	<attribute name="parent" type="IVirtualBox" readonly="yes">
3558	<desc>Associated parent object.</desc>
3559	</attribute>
3560
3561	<attribute name="accessible" type="boolean" readonly="yes">
3562	<desc>
3563	Whether this virtual machine is currently accessible or not.
3564
3565	A machine is always deemed accessible unless it is registered <i>and</i>
3566	its settings file cannot be read or parsed (either because the file itself
3567	is unavailable or has invalid XML contents).
3568
3569	Every time this property is read, the accessibility state of
3570	this machine is re-evaluated. If the returned value is @c false,
3571	the <link to="#accessError"/> property may be used to get the
3572	detailed error information describing the reason of
3573	inaccessibility, including XML error messages.
3574
3575	When the machine is inaccessible, only the following properties
3576	can be used on it:
3577	<ul>
3578	<li><link to="#parent"/></li>
3579	<li><link to="#id"/></li>
3580	<li><link to="#settingsFilePath"/></li>
3581	<li><link to="#accessible"/></li>
3582	<li><link to="#accessError"/></li>
3583	</ul>
3584
3585	An attempt to access any other property or method will return
3586	an error.
3587
3588	The only possible action you can perform on an inaccessible
3589	machine is to unregister it using the
3590	<link to="IMachine::unregister"/> call (or, to check
3591	for the accessibility state once more by querying this
3592	property).
3593
3594	<note>
3595	In the current implementation, once this property returns
3596	@c true, the machine will never become inaccessible
3597	later, even if its settings file cannot be successfully
3598	read/written any more (at least, until the VirtualBox
3599	server is restarted). This limitation may be removed in
3600	future releases.
3601	</note>
3602	</desc>
3603	</attribute>
3604
3605	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3606	<desc>
3607	Error information describing the reason of machine
3608	inaccessibility.
3609
3610	Reading this property is only valid after the last call to
3611	<link to="#accessible"/> returned @c false (i.e. the
3612	machine is currently inaccessible). Otherwise, a @c null
3613	IVirtualBoxErrorInfo object will be returned.
3614	</desc>
3615	</attribute>
3616
3617	<attribute name="name" type="wstring">
3618	<desc>
3619	Name of the virtual machine.
3620
3621	Besides being used for human-readable identification purposes
3622	everywhere in VirtualBox, the virtual machine name is also used
3623	as a name of the machine's settings file and as a name of the
3624	subdirectory this settings file resides in. Thus, every time you
3625	change the value of this property, the settings file will be
3626	renamed once you call <link to="#saveSettings"/> to confirm the
3627	change. The containing subdirectory will be also renamed, but
3628	only if it has exactly the same name as the settings file
3629	itself prior to changing this property (for backward compatibility
3630	with previous API releases). The above implies the following
3631	limitations:
3632	<ul>
3633	<li>The machine name cannot be empty.</li>
3634	<li>The machine name can contain only characters that are valid
3635	file name characters according to the rules of the file
3636	system used to store VirtualBox configuration.</li>
3637	<li>You cannot have two or more machines with the same name
3638	if they use the same subdirectory for storing the machine
3639	settings files.</li>
3640	<li>You cannot change the name of the machine if it is running,
3641	or if any file in the directory containing the settings file
3642	is being used by another running machine or by any other
3643	process in the host operating system at a time when
3644	<link to="#saveSettings"/> is called.
3645	</li>
3646	</ul>
3647	If any of the above limitations are hit, <link to="#saveSettings"/>
3648	will return an appropriate error message explaining the exact
3649	reason and the changes you made to this machine will not be saved.
3650
3651	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3652	file is recommended, but not enforced. (Previous versions always
3653	used a generic ".xml" extension.)
3654	</desc>
3655	</attribute>
3656
3657	<attribute name="description" type="wstring">
3658	<desc>
3659	Description of the virtual machine.
3660
3661	The description attribute can contain any text and is
3662	typically used to describe the hardware and software
3663	configuration of the virtual machine in detail (i.e. network
3664	settings, versions of the installed software and so on).
3665	</desc>
3666	</attribute>
3667
3668	<attribute name="id" type="uuid" mod="string" readonly="yes">
3669	<desc>UUID of the virtual machine.</desc>
3670	</attribute>
3671
3672	<attribute name="OSTypeId" type="wstring">
3673	<desc>
3674	User-defined identifier of the Guest OS type.
3675	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3676	an IGuestOSType object representing details about the given
3677	Guest OS type.
3678	<note>
3679	This value may differ from the value returned by
3680	<link to="IGuest::OSTypeId"/> if Guest Additions are
3681	installed to the guest OS.
3682	</note>
3683	</desc>
3684	</attribute>
3685
3686	<attribute name="hardwareVersion" type="wstring">
3687	<desc>Hardware version identifier. Internal use only for now.</desc>
3688	</attribute>
3689
3690	<attribute name="hardwareUUID" type="uuid" mod="string">
3691	<desc>
3692	The UUID presented to the guest via memory tables, hardware and guest
3693	properties. For most VMs this is the same as the @a id, but for VMs
3694	which have been cloned or teleported it may be the same as the source
3695	VM. This latter is because the guest shouldn't notice that it was
3696	cloned or teleported.
3697	</desc>
3698	</attribute>
3699
3700	<attribute name="CPUCount" type="unsigned long">
3701	<desc>Number of virtual CPUs in the VM.</desc>
3702	</attribute>
3703
3704	<attribute name="CPUHotPlugEnabled" type="boolean">
3705	<desc>
3706	This setting determines whether VirtualBox allows CPU
3707	hotplugging for this machine.</desc>
3708	</attribute>
3709
3710	<attribute name="CPUExecutionCap" type="unsigned long">
3711	<desc>
3712	Means to limit the number of CPU cycles a guest can use. The unit
3713	is percentage of host CPU cycles per second. The valid range
3714	is 1 - 100. 100 (the default) implies no limit.
3715	</desc>
3716	</attribute>
3717
3718	<attribute name="memorySize" type="unsigned long">
3719	<desc>System memory size in megabytes.</desc>
3720	</attribute>
3721
3722	<attribute name="memoryBalloonSize" type="unsigned long">
3723	<desc>Memory balloon size in megabytes.</desc>
3724	</attribute>
3725
3726	<attribute name="pageFusionEnabled" type="boolean">
3727	<desc>
3728	This setting determines whether VirtualBox allows page
3729	fusion for this machine (64 bits host only).
3730	</desc>
3731	</attribute>
3732
3733	<attribute name="VRAMSize" type="unsigned long">
3734	<desc>Video memory size in megabytes.</desc>
3735	</attribute>
3736
3737	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3738	<desc>
3739	This setting determines whether VirtualBox allows this machine to make
3740	use of the 3D graphics support available on the host.</desc>
3741	</attribute>
3742
3743	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3744	<desc>
3745	This setting determines whether VirtualBox allows this machine to make
3746	use of the 2D video acceleration support available on the host.</desc>
3747	</attribute>
3748
3749	<attribute name="monitorCount" type="unsigned long">
3750	<desc>
3751	Number of virtual monitors.
3752	<note>
3753	Only effective on Windows XP and later guests with
3754	Guest Additions installed.
3755	</note>
3756	</desc>
3757	</attribute>
3758
3759	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3760	<desc>Object containing all BIOS settings.</desc>
3761	</attribute>
3762
3763	<attribute name="firmwareType" type="FirmwareType">
3764	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3765	bootstrap in this VM.</desc>
3766	</attribute>
3767
3768	<attribute name="pointingHidType" type="PointingHidType">
3769	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3770	The default is typically "PS2Mouse" but can vary depending on the
3771	requirements of the guest operating system.</desc>
3772	</attribute>
3773
3774	<attribute name="keyboardHidType" type="KeyboardHidType">
3775	<desc>Type of keyboard HID used in this VM.
3776	The default is typically "PS2Keyboard" but can vary depending on the
3777	requirements of the guest operating system.</desc>
3778	</attribute>
3779
3780	<attribute name="hpetEnabled" type="boolean">
3781	<desc>This attribute controls if High Precision Event Timer (HPET) is
3782	enabled in this VM. Use this property if you want to provide guests
3783	with additional time source, or if guest requires HPET to function correctly.
3784	Default is false.</desc>
3785	</attribute>
3786
3787	<attribute name="chipsetType" type="ChipsetType">
3788	<desc>Chipset type used in this VM.</desc>
3789	</attribute>
3790
3791	<attribute name="snapshotFolder" type="wstring">
3792	<desc>
3793	Full path to the directory used to store snapshot data
3794	(differencing media and saved state files) of this machine.
3795
3796	The initial value of this property is
3797	<tt><</tt><link to="#settingsFilePath">
3798	path_to_settings_file</link><tt>>/<</tt>
3799	<link to="#id">machine_uuid</link>
3800	<tt>></tt>.
3801
3802	Currently, it is an error to try to change this property on
3803	a machine that has snapshots (because this would require to
3804	move possibly large files to a different location).
3805	A separate method will be available for this purpose later.
3806
3807	<note>
3808	Setting this property to @c null or to an empty string will restore
3809	the initial value.
3810	</note>
3811	<note>
3812	When setting this property, the specified path can be
3813	absolute (full path) or relative to the directory where the
3814	<link to="#settingsFilePath">machine settings file</link>
3815	is located. When reading this property, a full path is
3816	always returned.
3817	</note>
3818	<note>
3819	The specified path may not exist, it will be created
3820	when necessary.
3821	</note>
3822	</desc>
3823	</attribute>
3824
3825	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3826	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3827	</attribute>
3828
3829	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3830	<desc>Array of media attached to this machine.</desc>
3831	</attribute>
3832
3833	<attribute name="USBController" type="IUSBController" readonly="yes">
3834	<desc>
3835	Associated USB controller object.
3836
3837	<note>
3838	If USB functionality is not available in the given edition of
3839	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3840	</note>
3841	</desc>
3842	</attribute>
3843
3844	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3845	<desc>Associated audio adapter, always present.</desc>
3846	</attribute>
3847
3848	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3849	<desc>Array of storage controllers attached to this machine.</desc>
3850	</attribute>
3851
3852	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3853	<desc>
3854	Full name of the file containing machine settings data.
3855	</desc>
3856	</attribute>
3857
3858	<attribute name="settingsModified" type="boolean" readonly="yes">
3859	<desc>
3860	Whether the settings of this machine have been modified
3861	(but neither yet saved nor discarded).
3862	<note>
3863	Reading this property is only valid on instances returned
3864	by <link to="ISession::machine"/> and on new machines
3865	created by <link to="IVirtualBox::createMachine"/> or opened
3866	by <link to="IVirtualBox::openMachine"/> but not
3867	yet registered, or on unregistered machines after calling
3868	<link to="IMachine::unregister"/>. For all other
3869	cases, the settings can never be modified.
3870	</note>
3871	<note>
3872	For newly created unregistered machines, the value of this
3873	property is always @c true until <link to="#saveSettings"/>
3874	is called (no matter if any machine settings have been
3875	changed after the creation or not). For opened machines
3876	the value is set to @c false (and then follows to normal rules).
3877	</note>
3878	</desc>
3879	</attribute>
3880
3881	<attribute name="sessionState" type="SessionState" readonly="yes">
3882	<desc>Current session state for this machine.</desc>
3883	</attribute>
3884
3885	<attribute name="sessionType" type="wstring" readonly="yes">
3886	<desc>
3887	Type of the session. If <link to="#sessionState"/> is
3888	Spawning or Locked, this attribute contains the
3889	same value as passed to the
3890	<link to="IMachine::launchVMProcess"/> method in the
3891	@a type parameter. If the session was used with
3892	<link to="IMachine::lockMachine" />, or if
3893	<link to="#sessionState"/> is SessionClosed, the value of this
3894	attribute is an empty string.
3895	</desc>
3896	</attribute>
3897
3898	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3899	<desc>
3900	Identifier of the session process. This attribute contains the
3901	platform-dependent identifier of the process whose session was
3902	used with <link to="IMachine::lockMachine" /> call. The returned
3903	value is only valid if <link to="#sessionState"/> is Locked or
3904	Unlocking by the time this property is read.
3905	</desc>
3906	</attribute>
3907
3908	<attribute name="state" type="MachineState" readonly="yes">
3909	<desc>Current execution state of this machine.</desc>
3910	</attribute>
3911
3912	<attribute name="lastStateChange" type="long long" readonly="yes">
3913	<desc>
3914	Time stamp of the last execution state change,
3915	in milliseconds since 1970-01-01 UTC.
3916	</desc>
3917	</attribute>
3918
3919	<attribute name="stateFilePath" type="wstring" readonly="yes">
3920	<desc>
3921	Full path to the file that stores the execution state of
3922	the machine when it is in the <link to="MachineState_Saved"/> state.
3923	<note>
3924	When the machine is not in the Saved state, this attribute is
3925	an empty string.
3926	</note>
3927	</desc>
3928	</attribute>
3929
3930	<attribute name="logFolder" type="wstring" readonly="yes">
3931	<desc>
3932	Full path to the folder that stores a set of rotated log files
3933	recorded during machine execution. The most recent log file is
3934	named <tt>VBox.log</tt>, the previous log file is
3935	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3936	in the current version).
3937	</desc>
3938	</attribute>
3939
3940	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3941	<desc>
3942	Current snapshot of this machine. This is @c null if the machine
3943	currently has no snapshots. If it is not @c null, then it was
3944	set by one of <link to="IConsole::takeSnapshot" />,
3945	<link to="IConsole::deleteSnapshot" />
3946	or <link to="IConsole::restoreSnapshot" />, depending on which
3947	was called last. See <link to="ISnapshot"/> for details.
3948	</desc>
3949	</attribute>
3950
3951	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3952	<desc>
3953	Number of snapshots taken on this machine. Zero means the
3954	machine doesn't have any snapshots.
3955	</desc>
3956	</attribute>
3957
3958	<attribute name="currentStateModified" type="boolean" readonly="yes">
3959	<desc>
3960	Returns @c true if the current state of the machine is not
3961	identical to the state stored in the current snapshot.
3962
3963	The current state is identical to the current snapshot only
3964	directly after one of the following calls are made:
3965
3966	<ul>
3967	<li><link to="IConsole::restoreSnapshot"/>
3968	</li>
3969	<li><link to="IConsole::takeSnapshot"/> (issued on a
3970	"powered off" or "saved" machine, for which
3971	<link to="#settingsModified"/> returns @c false)
3972	</li>
3973	</ul>
3974
3975	The current state remains identical until one of the following
3976	happens:
3977	<ul>
3978	<li>settings of the machine are changed</li>
3979	<li>the saved state is deleted</li>
3980	<li>the current snapshot is deleted</li>
3981	<li>an attempt to execute the machine is made</li>
3982	</ul>
3983
3984	<note>
3985	For machines that don't have snapshots, this property is
3986	always @c false.
3987	</note>
3988	</desc>
3989	</attribute>
3990
3991	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3992	<desc>
3993	Collection of shared folders for this machine (permanent shared
3994	folders). These folders are shared automatically at machine startup
3995	and available only to the guest OS installed within this machine.
3996
3997	New shared folders are added to the collection using
3998	<link to="#createSharedFolder"/>. Existing shared folders can be
3999	removed using <link to="#removeSharedFolder"/>.
4000	</desc>
4001	</attribute>
4002
4003	<attribute name="clipboardMode" type="ClipboardMode">
4004	<desc>
4005	Synchronization mode between the host OS clipboard
4006	and the guest OS clipboard.
4007	</desc>
4008	</attribute>
4009
4010	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4011	<desc>
4012	A comma-separated list of simple glob patterns. Changes to guest
4013	properties whose name matches one of the patterns will generate an
4014	<link to="IGuestPropertyChangedEvent"/> signal.
4015	</desc>
4016	</attribute>
4017
4018	<attribute name="teleporterEnabled" type="boolean">
4019	<desc>
4020	When set to @a true, the virtual machine becomes a target teleporter
4021	the next time it is powered on. This can only set to @a true when the
4022	VM is in the @a PoweredOff or @a Aborted state.
4023
4024	<!-- This property is automatically set to @a false when the VM is powered
4025	on. (bird: This doesn't work yet ) -->
4026	</desc>
4027	</attribute>
4028
4029	<attribute name="teleporterPort" type="unsigned long">
4030	<desc>
4031	The TCP port the target teleporter will listen for incoming
4032	teleportations on.
4033
4034	0 means the port is automatically selected upon power on. The actual
4035	value can be read from this property while the machine is waiting for
4036	incoming teleportations.
4037	</desc>
4038	</attribute>
4039
4040	<attribute name="teleporterAddress" type="wstring">
4041	<desc>
4042	The address the target teleporter will listen on. If set to an empty
4043	string, it will listen on all addresses.
4044	</desc>
4045	</attribute>
4046
4047	<attribute name="teleporterPassword" type="wstring">
4048	<desc>
4049	The password to check for on the target teleporter. This is just a
4050	very basic measure to prevent simple hacks and operators accidentally
4051	beaming a virtual machine to the wrong place.
4052	</desc>
4053	</attribute>
4054
4055	<attribute name="faultToleranceState" type="FaultToleranceState">
4056	<desc>
4057	Fault tolerance state; disabled, source or target.
4058	This property can be changed at any time. If you change it for a running
4059	VM, then the fault tolerance address and port must be set beforehand.
4060	</desc>
4061	</attribute>
4062
4063	<attribute name="faultTolerancePort" type="unsigned long">
4064	<desc>
4065	The TCP port the fault tolerance source or target will use for
4066	communication.
4067	</desc>
4068	</attribute>
4069
4070	<attribute name="faultToleranceAddress" type="wstring">
4071	<desc>
4072	The address the fault tolerance source or target.
4073	</desc>
4074	</attribute>
4075
4076	<attribute name="faultTolerancePassword" type="wstring">
4077	<desc>
4078	The password to check for on the standby VM. This is just a
4079	very basic measure to prevent simple hacks and operators accidentally
4080	choosing the wrong standby VM.
4081	</desc>
4082	</attribute>
4083
4084	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4085	<desc>
4086	The interval in ms used for syncing the state between source and target.
4087	</desc>
4088	</attribute>
4089
4090	<attribute name="RTCUseUTC" type="boolean">
4091	<desc>
4092	When set to @a true, the RTC device of the virtual machine will run
4093	in UTC time, otherwise in local time. Especially Unix guests prefer
4094	the time in UTC.
4095	</desc>
4096	</attribute>
4097
4098	<attribute name="ioCacheEnabled" type="boolean">
4099	<desc>
4100	When set to @a true, the builtin I/O cache of the virtual machine
4101	will be enabled.
4102	</desc>
4103	</attribute>
4104
4105	<attribute name="ioCacheSize" type="unsigned long">
4106	<desc>
4107	Maximum size of the I/O cache in MB.
4108	</desc>
4109	</attribute>
4110
4111	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4112	<desc>
4113	Bandwidth control manager.
4114	</desc>
4115	</attribute>
4116
4117	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4118	<desc>Array of PCI devices assigned to this machine, to get list of all
4119	PCI devices attached to the machine use
4120	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4121	is intended to list only devices additional to what described in
4122	virtual hardware config. Usually, this list keeps host's physical
4123	devices assigned to the particular machine.
4124	</desc>
4125	</attribute>
4126
4127	<method name="lockMachine">
4128	<desc>
4129	Locks the machine for the given session to enable the caller
4130	to make changes to the machine or start the VM or control
4131	VM execution.
4132
4133	There are two ways to lock a machine for such uses:
4134
4135	<ul>
4136	<li>If you want to make changes to the machine settings,
4137	you must obtain an exclusive write lock on the machine
4138	by setting @a lockType to @c Write.
4139
4140	This will only succeed if no other process has locked
4141	the machine to prevent conflicting changes. Only after
4142	an exclusive write lock has been obtained using this method, one
4143	can change all VM settings or execute the VM in the process
4144	space of the session object. (Note that the latter is only of
4145	interest if you actually want to write a new front-end for
4146	virtual machines; but this API gets called internally by
4147	the existing front-ends such as VBoxHeadless and the VirtualBox
4148	GUI to acquire a write lock on the machine that they are running.)
4149
4150	On success, write-locking the machine for a session creates
4151	a second copy of the IMachine object. It is this second object
4152	upon which changes can be made; in VirtualBox terminology, the
4153	second copy is "mutable". It is only this second, mutable machine
4154	object upon which you can call methods that change the
4155	machine state. After having called this method, you can
4156	obtain this second, mutable machine object using the
4157	<link to="ISession::machine" /> attribute.
4158	</li>
4159	<li>If you only want to check the machine state or control
4160	machine execution without actually changing machine
4161	settings (e.g. to get access to VM statistics or take
4162	a snapshot or save the machine state), then set the
4163	@a lockType argument to @c Shared.
4164
4165	If no other session has obtained a lock, you will obtain an
4166	exclusive write lock as described above. However, if another
4167	session has already obtained such a lock, then a link to that
4168	existing session will be established which allows you
4169	to control that existing session.
4170
4171	To find out which type of lock was obtained, you can
4172	inspect <link to="ISession::type" />, which will have been
4173	set to either @c WriteLock or @c Shared.
4174	</li>
4175	</ul>
4176
4177	In either case, you can get access to the <link to="IConsole" />
4178	object which controls VM execution.
4179
4180	Also in all of the above cases, one must always call
4181	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4182	the machine's state will eventually be set to "Aborted".
4183
4184	To change settings on a machine, the following sequence is typically
4185	performed:
4186
4187	<ol>
4188	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4189
4190	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4191
4192	<li>Change the settings of the machine by invoking IMachine methods.</li>
4193
4194	<li>Call <link to="IMachine::saveSettings" />.</li>
4195
4196	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4197	</ol>
4198
4199	<result name="E_UNEXPECTED">
4200	Virtual machine not registered.
4201	</result>
4202	<result name="E_ACCESSDENIED">
4203	Process not started by OpenRemoteSession.
4204	</result>
4205	<result name="VBOX_E_INVALID_OBJECT_STATE">
4206	Session already open or being opened.
4207	</result>
4208	<result name="VBOX_E_VM_ERROR">
4209	Failed to assign machine to session.
4210	</result>
4211	</desc>
4212	<param name="session" type="ISession" dir="in">
4213	<desc>
4214	Session object for which the machine will be locked.
4215	</desc>
4216	</param>
4217	<param name="lockType" type="LockType" dir="in">
4218	<desc>
4219	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4220	If set to @c Shared, then either acquire an exclusive write lock or establish
4221	a link to an existing session.
4222	</desc>
4223	</param>
4224	</method>
4225
4226	<method name="launchVMProcess">
4227	<desc>
4228	Spawns a new process that will execute the virtual machine and obtains a shared
4229	lock on the machine for the calling session.
4230
4231	If launching the VM succeeds, the new VM process will create its own session
4232	and write-lock the machine for it, preventing conflicting changes from other
4233	processes. If the machine is already locked (because it is already running or
4234	because another session has a write lock), launching the VM process will therefore
4235	fail. Reversely, future attempts to obtain a write lock will also fail while the
4236	machine is running.
4237
4238	The caller's session object remains separate from the session opened by the new
4239	VM process. It receives its own <link to="IConsole" /> object which can be used
4240	to control machine execution, but it cannot be used to change all VM settings
4241	which would be available after a <link to="#lockMachine" /> call.
4242
4243	The caller must eventually release the session's shared lock by calling
4244	<link to="ISession::unlockMachine" /> on the local session object once this call
4245	has returned. However, the session's state (see <link to="ISession::state" />)
4246	will not return to "Unlocked" until the remote session has also unlocked
4247	the machine (i.e. the machine has stopped running).
4248
4249	Launching a VM process can take some time (a new VM is started in a new process,
4250	for which memory and other resources need to be set up). Because of this,
4251	an <link to="IProgress" /> object is returned to allow the caller to wait
4252	for this asynchronous operation to be completed. Until then, the caller's
4253	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4254	and <link to="ISession::console" /> attributes cannot be accessed.
4255	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4256	similar calls to wait for completion. Completion is signalled when the VM
4257	is powered on. If launching the VM fails, error messages can be queried
4258	via the progress object, if available.
4259
4260	The progress object will have at least 2 sub-operations. The first
4261	operation covers the period up to the new VM process calls powerUp.
4262	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4263	progress object. Because <link to="IConsole::powerUp"/> may require
4264	some extra sub-operations, the <link to="IProgress::operationCount"/>
4265	may change at the completion of operation.
4266
4267	For details on the teleportation progress operation, see
4268	<link to="IConsole::powerUp"/>.
4269
4270	The @a environment argument is a string containing definitions of
4271	environment variables in the following format:
4272	@code
4273	NAME[=VALUE]\n
4274	NAME[=VALUE]\n
4275	...
4276	@endcode
4277	where <tt>\\n</tt> is the new line character. These environment
4278	variables will be appended to the environment of the VirtualBox server
4279	process. If an environment variable exists both in the server process
4280	and in this list, the value from this list takes precedence over the
4281	server's variable. If the value of the environment variable is
4282	omitted, this variable will be removed from the resulting environment.
4283	If the environment string is @c null or empty, the server environment
4284	is inherited by the started process as is.
4285
4286	<result name="E_UNEXPECTED">
4287	Virtual machine not registered.
4288	</result>
4289	<result name="E_INVALIDARG">
4290	Invalid session type @a type.
4291	</result>
4292	<result name="VBOX_E_OBJECT_NOT_FOUND">
4293	No machine matching @a machineId found.
4294	</result>
4295	<result name="VBOX_E_INVALID_OBJECT_STATE">
4296	Session already open or being opened.
4297	</result>
4298	<result name="VBOX_E_IPRT_ERROR">
4299	Launching process for machine failed.
4300	</result>
4301	<result name="VBOX_E_VM_ERROR">
4302	Failed to assign machine to session.
4303	</result>
4304	</desc>
4305	<param name="session" type="ISession" dir="in">
4306	<desc>
4307	Client session object to which the VM process will be connected (this
4308	must be in "Unlocked" state).
4309	</desc>
4310	</param>
4311	<param name="type" type="wstring" dir="in">
4312	<desc>
4313	Front-end to use for the new VM process. The following are currently supported:
4314	<ul>
4315	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4316	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4317	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4318	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4319	the currently running VM or session owner. In this case the
4320	@a session parameter may be @c NULL (if it is non-null it isn't
4321	used in any way), and the @a progress return value will be always
4322	NULL. The operation completes immediately.</li>
4323	</ul>
4324	</desc>
4325	</param>
4326	<param name="environment" type="wstring" dir="in">
4327	<desc>
4328	Environment to pass to the VM process.
4329	</desc>
4330	</param>
4331	<param name="progress" type="IProgress" dir="return">
4332	<desc>Progress object to track the operation completion.</desc>
4333	</param>
4334	</method>
4335
4336	<method name="setBootOrder">
4337	<desc>
4338	Puts the given device to the specified position in
4339	the boot order.
4340
4341	To indicate that no device is associated with the given position,
4342	<link to="DeviceType_Null"/> should be used.
4343
4344	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4345
4346	<result name="E_INVALIDARG">
4347	Boot @a position out of range.
4348	</result>
4349	<result name="E_NOTIMPL">
4350	Booting from USB @a device currently not supported.
4351	</result>
4352
4353	</desc>
4354	<param name="position" type="unsigned long" dir="in">
4355	<desc>
4356	Position in the boot order (@c 1 to the total number of
4357	devices the machine can boot from, as returned by
4358	<link to="ISystemProperties::maxBootPosition"/>).
4359	</desc>
4360	</param>
4361	<param name="device" type="DeviceType" dir="in">
4362	<desc>
4363	The type of the device used to boot at the given position.
4364	</desc>
4365	</param>
4366	</method>
4367
4368	<method name="getBootOrder" const="yes">
4369	<desc>
4370	Returns the device type that occupies the specified
4371	position in the boot order.
4372
4373	@todo [remove?]
4374	If the machine can have more than one device of the returned type
4375	(such as hard disks), then a separate method should be used to
4376	retrieve the individual device that occupies the given position.
4377
4378	If here are no devices at the given position, then
4379	<link to="DeviceType_Null"/> is returned.
4380
4381	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4382
4383	<result name="E_INVALIDARG">
4384	Boot @a position out of range.
4385	</result>
4386
4387	</desc>
4388	<param name="position" type="unsigned long" dir="in">
4389	<desc>
4390	Position in the boot order (@c 1 to the total number of
4391	devices the machine can boot from, as returned by
4392	<link to="ISystemProperties::maxBootPosition"/>).
4393	</desc>
4394	</param>
4395	<param name="device" type="DeviceType" dir="return">
4396	<desc>
4397	Device at the given position.
4398	</desc>
4399	</param>
4400	</method>
4401
4402	<method name="attachDevice">
4403	<desc>
4404	Attaches a device and optionally mounts a medium to the given storage
4405	controller (<link to="IStorageController" />, identified by @a name),
4406	at the indicated port and device.
4407
4408	This method is intended for managing storage devices in general while a
4409	machine is powered off. It can be used to attach and detach fixed
4410	and removable media. The following kind of media can be attached
4411	to a machine:
4412
4413	<ul>
4414	<li>For fixed and removable media, you can pass in a medium that was
4415	previously opened using <link to="IVirtualBox::openMedium" />.
4416	</li>
4417
4418	<li>Only for storage devices supporting removable media (such as
4419	DVDs and floppies), you can also specify a null pointer to
4420	indicate an empty drive or one of the medium objects listed
4421	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4422	arrays to indicate a host drive.
4423	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4424	to change the media while the machine is running.
4425	</li>
4426	</ul>
4427
4428	In a VM's default configuration of virtual machines, the secondary
4429	master of the IDE controller is used for a CD/DVD drive.
4430
4431	After calling this returns successfully, a new instance of
4432	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4433	attachments (see <link to="IMachine::mediumAttachments"/>).
4434
4435	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4436	information about attaching media.
4437
4438	The specified device slot must not have a device attached to it,
4439	or this method will fail.
4440
4441	<note>
4442	You cannot attach a device to a newly created machine until
4443	this machine's settings are saved to disk using
4444	<link to="#saveSettings"/>.
4445	</note>
4446	<note>
4447	If the medium is being attached indirectly, a new differencing medium
4448	will implicitly be created for it and attached instead. If the
4449	changes made to the machine settings (including this indirect
4450	attachment) are later cancelled using <link to="#discardSettings"/>,
4451	this implicitly created differencing medium will implicitly
4452	be deleted.
4453	</note>
4454
4455	<result name="E_INVALIDARG">
4456	SATA device, SATA port, IDE port or IDE slot out of range, or
4457	file or UUID not found.
4458	</result>
4459	<result name="VBOX_E_INVALID_OBJECT_STATE">
4460	Machine must be registered before media can be attached.
4461	</result>
4462	<result name="VBOX_E_INVALID_VM_STATE">
4463	Invalid machine state.
4464	</result>
4465	<result name="VBOX_E_OBJECT_IN_USE">
4466	A medium is already attached to this or another virtual machine.
4467	</result>
4468
4469	</desc>
4470	<param name="name" type="wstring" dir="in">
4471	<desc>Name of the storage controller to attach the device to.</desc>
4472	</param>
4473	<param name="controllerPort" type="long" dir="in">
4474	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4475	the primary controller and 1 specifies the secondary controller.
4476	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4477	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4478	</param>
4479	<param name="device" type="long" dir="in">
4480	<desc>Device slot in the given port to attach the device to. This is only
4481	relevant for IDE controllers, for which 0 specifies the master device and
4482	1 specifies the slave device. For all other controller types, this must
4483	be 0.</desc>
4484	</param>
4485	<param name="type" type="DeviceType" dir="in">
4486	<desc>Device type of the attached device. For media opened by
4487	<link to="IVirtualBox::openMedium" />, this must match the device type
4488	specified there.</desc>
4489	</param>
4490	<param name="medium" type="IMedium" dir="in">
4491	<desc>Medium to mount or NULL for an empty drive.</desc>
4492	</param>
4493	</method>
4494
4495	<method name="detachDevice">
4496	<desc>
4497	Detaches the device attached to a device slot of the specified bus.
4498
4499	Detaching the device from the virtual machine is deferred. This means
4500	that the medium remains associated with the machine when this method
4501	returns and gets actually de-associated only after a successful
4502	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4503	for more detailed information about attaching media.
4504
4505	<note>
4506	You cannot detach a device from a running machine.
4507	</note>
4508	<note>
4509	Detaching differencing media implicitly created by <link
4510	to="#attachDevice"/> for the indirect attachment using this
4511	method will <b>not</b> implicitly delete them. The
4512	<link to="IMedium::deleteStorage"/> operation should be
4513	explicitly performed by the caller after the medium is successfully
4514	detached and the settings are saved with
4515	<link to="#saveSettings"/>, if it is the desired action.
4516	</note>
4517
4518	<result name="VBOX_E_INVALID_VM_STATE">
4519	Attempt to detach medium from a running virtual machine.
4520	</result>
4521	<result name="VBOX_E_OBJECT_NOT_FOUND">
4522	No medium attached to given slot/bus.
4523	</result>
4524	<result name="VBOX_E_NOT_SUPPORTED">
4525	Medium format does not support storage deletion.
4526	</result>
4527
4528	</desc>
4529	<param name="name" type="wstring" dir="in">
4530	<desc>Name of the storage controller to detach the medium from.</desc>
4531	</param>
4532	<param name="controllerPort" type="long" dir="in">
4533	<desc>Port number to detach the medium from.</desc>
4534	</param>
4535	<param name="device" type="long" dir="in">
4536	<desc>Device slot number to detach the medium from.</desc>
4537	</param>
4538	</method>
4539
4540	<method name="passthroughDevice">
4541	<desc>
4542	Sets the passthrough mode of an existing DVD device. Changing the
4543	setting while the VM is running is forbidden. The setting is only used
4544	if at VM start the device is configured as a host DVD drive, in all
4545	other cases it is ignored. The device must already exist; see
4546	<link to="IMachine::attachDevice"/> for how to attach a new device.
4547
4548	The @a controllerPort and @a device parameters specify the device slot and
4549	have have the same meaning as with <link to="IMachine::attachDevice" />.
4550
4551	<result name="E_INVALIDARG">
4552	SATA device, SATA port, IDE port or IDE slot out of range.
4553	</result>
4554	<result name="VBOX_E_INVALID_OBJECT_STATE">
4555	Attempt to modify an unregistered virtual machine.
4556	</result>
4557	<result name="VBOX_E_INVALID_VM_STATE">
4558	Invalid machine state.
4559	</result>
4560
4561	</desc>
4562	<param name="name" type="wstring" dir="in">
4563	<desc>Name of the storage controller.</desc>
4564	</param>
4565	<param name="controllerPort" type="long" dir="in">
4566	<desc>Storage controller port.</desc>
4567	</param>
4568	<param name="device" type="long" dir="in">
4569	<desc>Device slot in the given port.</desc>
4570	</param>
4571	<param name="passthrough" type="boolean" dir="in">
4572	<desc>New value for the passthrough setting.</desc>
4573	</param>
4574	</method>
4575
4576	<method name="setBandwidthGroupForDevice">
4577	<desc>
4578	Sets the bandwidth group of an existing storage device.
4579	The device must already exist; see <link to="IMachine::attachDevice"/>
4580	for how to attach a new device.
4581
4582	The @a controllerPort and @a device parameters specify the device slot and
4583	have have the same meaning as with <link to="IMachine::attachDevice" />.
4584
4585	<result name="E_INVALIDARG">
4586	SATA device, SATA port, IDE port or IDE slot out of range.
4587	</result>
4588	<result name="VBOX_E_INVALID_OBJECT_STATE">
4589	Attempt to modify an unregistered virtual machine.
4590	</result>
4591	<result name="VBOX_E_INVALID_VM_STATE">
4592	Invalid machine state.
4593	</result>
4594
4595	</desc>
4596	<param name="name" type="wstring" dir="in">
4597	<desc>Name of the storage controller.</desc>
4598	</param>
4599	<param name="controllerPort" type="long" dir="in">
4600	<desc>Storage controller port.</desc>
4601	</param>
4602	<param name="device" type="long" dir="in">
4603	<desc>Device slot in the given port.</desc>
4604	</param>
4605	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4606	<desc>New value for the bandwidth group or NULL for no group.</desc>
4607	</param>
4608	</method>
4609
4610	<method name="mountMedium">
4611	<desc>
4612	Mounts a medium (<link to="IMedium" />, identified
4613	by the given UUID @a id) to the given storage controller
4614	(<link to="IStorageController" />, identified by @a name),
4615	at the indicated port and device. The device must already exist;
4616	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4617
4618	This method is intended only for managing removable media, where the
4619	device is fixed but media is changeable at runtime (such as DVDs
4620	and floppies). It cannot be used for fixed media such as hard disks.
4621
4622	The @a controllerPort and @a device parameters specify the device slot and
4623	have have the same meaning as with <link to="IMachine::attachDevice" />.
4624
4625	The specified device slot can have a medium mounted, which will be
4626	unmounted first. Specifying a zero UUID (or an empty string) for
4627	@a medium does just an unmount.
4628
4629	See <link to="IMedium"/> for more detailed information about
4630	attaching media.
4631
4632	<result name="E_INVALIDARG">
4633	SATA device, SATA port, IDE port or IDE slot out of range.
4634	</result>
4635	<result name="VBOX_E_INVALID_OBJECT_STATE">
4636	Attempt to attach medium to an unregistered virtual machine.
4637	</result>
4638	<result name="VBOX_E_INVALID_VM_STATE">
4639	Invalid machine state.
4640	</result>
4641	<result name="VBOX_E_OBJECT_IN_USE">
4642	Medium already attached to this or another virtual machine.
4643	</result>
4644
4645	</desc>
4646	<param name="name" type="wstring" dir="in">
4647	<desc>Name of the storage controller to attach the medium to.</desc>
4648	</param>
4649	<param name="controllerPort" type="long" dir="in">
4650	<desc>Port to attach the medium to.</desc>
4651	</param>
4652	<param name="device" type="long" dir="in">
4653	<desc>Device slot in the given port to attach the medium to.</desc>
4654	</param>
4655	<param name="medium" type="IMedium" dir="in">
4656	<desc>Medium to mount or NULL for an empty drive.</desc>
4657	</param>
4658	<param name="force" type="boolean" dir="in">
4659	<desc>Allows to force unmount/mount of a medium which is locked by
4660	the device slot in the given port to attach the medium to.</desc>
4661	</param>
4662	</method>
4663
4664	<method name="getMedium" const="yes">
4665	<desc>
4666	Returns the virtual medium attached to a device slot of the specified
4667	bus.
4668
4669	Note that if the medium was indirectly attached by
4670	<link to="#mountMedium"/> to the given device slot then this
4671	method will return not the same object as passed to the
4672	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4673	more detailed information about mounting a medium.
4674
4675	<result name="VBOX_E_OBJECT_NOT_FOUND">
4676	No medium attached to given slot/bus.
4677	</result>
4678
4679	</desc>
4680	<param name="name" type="wstring" dir="in">
4681	<desc>Name of the storage controller the medium is attached to.</desc>
4682	</param>
4683	<param name="controllerPort" type="long" dir="in">
4684	<desc>Port to query.</desc>
4685	</param>
4686	<param name="device" type="long" dir="in">
4687	<desc>Device slot in the given port to query.</desc>
4688	</param>
4689	<param name="medium" type="IMedium" dir="return">
4690	<desc>Attached medium object.</desc>
4691	</param>
4692	</method>
4693
4694	<method name="getMediumAttachmentsOfController" const="yes">
4695	<desc>
4696	Returns an array of medium attachments which are attached to the
4697	the controller with the given name.
4698
4699	<result name="VBOX_E_OBJECT_NOT_FOUND">
4700	A storage controller with given name doesn't exist.
4701	</result>
4702	</desc>
4703	<param name="name" type="wstring" dir="in"/>
4704	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4705	</method>
4706
4707	<method name="getMediumAttachment" const="yes">
4708	<desc>
4709	Returns a medium attachment which corresponds to the controller with
4710	the given name, on the given port and device slot.
4711
4712	<result name="VBOX_E_OBJECT_NOT_FOUND">
4713	No attachment exists for the given controller/port/device combination.
4714	</result>
4715	</desc>
4716	<param name="name" type="wstring" dir="in"/>
4717	<param name="controllerPort" type="long" dir="in"/>
4718	<param name="device" type="long" dir="in"/>
4719	<param name="attachment" type="IMediumAttachment" dir="return"/>
4720	</method>
4721
4722	<method name="attachHostPciDevice">
4723	<desc>
4724	Attaches host PCI device with the given (host) PCI address to the
4725	PCI bus of the virtual machine. Please note, that this operation
4726	is two phase, as real attachment will happen when VM will start,
4727	and most information will be delivered as IHostPciDevicePlugEvent
4728	on IVirtualBox event source.
4729
4730	<see><link to="IHostPciDevicePlugEvent"/></see>
4731
4732	<result name="VBOX_E_INVALID_VM_STATE">
4733	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4734	</result>
4735	<result name="VBOX_E_PDM_ERROR">
4736	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4737	</result>
4738	<result name="VBOX_E_NOT_SUPPORTED">
4739	Hardware or host OS doesn't allow PCI device passthrought.
4740	</result>
4741	</desc>
4742	<param name="hostAddress" type="long" dir="in">
4743	<desc>Address of the host PCI device.</desc>
4744	</param>
4745	<param name="desiredGuestAddress" type="long" dir="in">
4746	<desc>Desired position of this device on guest PCI bus.</desc>
4747	</param>
4748	<param name="tryToUnbind" type="boolean" dir="in">
4749	<desc>If VMM shall try to unbind existing drivers from the
4750	device before attaching it to the guest.</desc>
4751	</param>
4752	</method>
4753
4754	<method name="detachHostPciDevice">
4755	<desc>
4756	Detach host PCI device from the virtual machine.
4757	Also HostPciDevicePlugEvent on IVirtualBox event source
4758	will be delivered. As currently we don't support hot device
4759	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4760
4761	<see><link to="IHostPciDevicePlugEvent"/></see>
4762
4763	<result name="VBOX_E_INVALID_VM_STATE">
4764	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4765	</result>
4766	<result name="VBOX_E_OBJECT_NOT_FOUND">
4767	This host device is not attached to this machine.
4768	</result>
4769	<result name="VBOX_E_PDM_ERROR">
4770	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4771	</result>
4772	<result name="VBOX_E_NOT_SUPPORTED">
4773	Hardware or host OS doesn't allow PCI device passthrought.
4774	</result>
4775	</desc>
4776	<param name="hostAddress" type="long" dir="in">
4777	<desc>Address of the host PCI device.</desc>
4778	</param>
4779	</method>
4780
4781	<method name="getNetworkAdapter" const="yes">
4782	<desc>
4783	Returns the network adapter associated with the given slot.
4784	Slots are numbered sequentially, starting with zero. The total
4785	number of adapters per machine is defined by the
4786	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
4787	so the maximum slot number is one less than that property's value.
4788
4789	<result name="E_INVALIDARG">
4790	Invalid @a slot number.
4791	</result>
4792
4793	</desc>
4794	<param name="slot" type="unsigned long" dir="in"/>
4795	<param name="adapter" type="INetworkAdapter" dir="return"/>
4796	</method>
4797
4798	<method name="addStorageController">
4799	<desc>
4800	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4801	machine and returns it as an instance of
4802	<link to="IStorageController" />.
4803
4804	@a name identifies the controller for subsequent calls such as
4805	<link to="#getStorageControllerByName" />,
4806	<link to="#getStorageControllerByInstance" />,
4807	<link to="#removeStorageController" />,
4808	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4809
4810	After the controller has been added, you can set its exact
4811	type by setting the <link to="IStorageController::controllerType" />.
4812
4813	<result name="VBOX_E_OBJECT_IN_USE">
4814	A storage controller with given name exists already.
4815	</result>
4816	<result name="E_INVALIDARG">
4817	Invalid @a controllerType.
4818	</result>
4819	</desc>
4820	<param name="name" type="wstring" dir="in"/>
4821	<param name="connectionType" type="StorageBus" dir="in"/>
4822	<param name="controller" type="IStorageController" dir="return"/>
4823	</method>
4824
4825	<method name="getStorageControllerByName" const="yes">
4826	<desc>
4827	Returns a storage controller with the given name.
4828
4829	<result name="VBOX_E_OBJECT_NOT_FOUND">
4830	A storage controller with given name doesn't exist.
4831	</result>
4832	</desc>
4833	<param name="name" type="wstring" dir="in"/>
4834	<param name="storageController" type="IStorageController" dir="return"/>
4835	</method>
4836
4837	<method name="getStorageControllerByInstance" const="yes">
4838	<desc>
4839	Returns a storage controller with the given instance number.
4840
4841	<result name="VBOX_E_OBJECT_NOT_FOUND">
4842	A storage controller with given instance number doesn't exist.
4843	</result>
4844	</desc>
4845	<param name="instance" type="unsigned long" dir="in"/>
4846	<param name="storageController" type="IStorageController" dir="return"/>
4847	</method>
4848
4849	<method name="removeStorageController">
4850	<desc>
4851	Removes a storage controller from the machine.
4852
4853	<result name="VBOX_E_OBJECT_NOT_FOUND">
4854	A storage controller with given name doesn't exist.
4855	</result>
4856	</desc>
4857	<param name="name" type="wstring" dir="in"/>
4858	</method>
4859
4860	<method name="setStorageControllerBootable">
4861	<desc>
4862	Sets the bootable flag of the storage controller with the given name.
4863
4864	<result name="VBOX_E_OBJECT_NOT_FOUND">
4865	A storage controller with given name doesn't exist.
4866	</result>
4867	<result name="VBOX_E_OBJECT_IN_USE">
4868	Another storage controller is marked as bootable already.
4869	</result>
4870	</desc>
4871	<param name="name" type="wstring" dir="in"/>
4872	<param name="bootable" type="boolean" dir="in"/>
4873	</method>
4874
4875	<method name="getSerialPort" const="yes">
4876	<desc>
4877	Returns the serial port associated with the given slot.
4878	Slots are numbered sequentially, starting with zero. The total
4879	number of serial ports per machine is defined by the
4880	<link to="ISystemProperties::serialPortCount"/> property,
4881	so the maximum slot number is one less than that property's value.
4882
4883	<result name="E_INVALIDARG">
4884	Invalid @a slot number.
4885	</result>
4886
4887	</desc>
4888	<param name="slot" type="unsigned long" dir="in"/>
4889	<param name="port" type="ISerialPort" dir="return"/>
4890	</method>
4891
4892	<method name="getParallelPort" const="yes">
4893	<desc>
4894	Returns the parallel port associated with the given slot.
4895	Slots are numbered sequentially, starting with zero. The total
4896	number of parallel ports per machine is defined by the
4897	<link to="ISystemProperties::parallelPortCount"/> property,
4898	so the maximum slot number is one less than that property's value.
4899
4900	<result name="E_INVALIDARG">
4901	Invalid @a slot number.
4902	</result>
4903
4904	</desc>
4905	<param name="slot" type="unsigned long" dir="in"/>
4906	<param name="port" type="IParallelPort" dir="return"/>
4907	</method>
4908
4909	<method name="getExtraDataKeys">
4910	<desc>
4911	Returns an array representing the machine-specific extra data keys
4912	which currently have values defined.
4913	</desc>
4914	<param name="value" type="wstring" dir="return" safearray="yes">
4915	<desc>Array of extra data keys.</desc>
4916	</param>
4917	</method>
4918
4919	<method name="getExtraData">
4920	<desc>
4921	Returns associated machine-specific extra data.
4922
4923	If the requested data @a key does not exist, this function will
4924	succeed and return an empty string in the @a value argument.
4925
4926	<result name="VBOX_E_FILE_ERROR">
4927	Settings file not accessible.
4928	</result>
4929	<result name="VBOX_E_XML_ERROR">
4930	Could not parse the settings file.
4931	</result>
4932
4933	</desc>
4934	<param name="key" type="wstring" dir="in">
4935	<desc>Name of the data key to get.</desc>
4936	</param>
4937	<param name="value" type="wstring" dir="return">
4938	<desc>Value of the requested data key.</desc>
4939	</param>
4940	</method>
4941
4942	<method name="setExtraData">
4943	<desc>
4944	Sets associated machine-specific extra data.
4945
4946	If you pass @c null or an empty string as a key @a value, the given
4947	@a key will be deleted.
4948
4949	<note>
4950	Before performing the actual data change, this method will ask all
4951	registered listeners using the
4952	<link to="IExtraDataCanChangeEvent"/>
4953	notification for a permission. If one of the listeners refuses the
4954	new value, the change will not be performed.
4955	</note>
4956	<note>
4957	On success, the
4958	<link to="IExtraDataChangedEvent"/> notification
4959	is called to inform all registered listeners about a successful data
4960	change.
4961	</note>
4962	<note>
4963	This method can be called outside the machine session and therefore
4964	it's a caller's responsibility to handle possible race conditions
4965	when several clients change the same key at the same time.
4966	</note>
4967
4968	<result name="VBOX_E_FILE_ERROR">
4969	Settings file not accessible.
4970	</result>
4971	<result name="VBOX_E_XML_ERROR">
4972	Could not parse the settings file.
4973	</result>
4974
4975	</desc>
4976	<param name="key" type="wstring" dir="in">
4977	<desc>Name of the data key to set.</desc>
4978	</param>
4979	<param name="value" type="wstring" dir="in">
4980	<desc>Value to assign to the key.</desc>
4981	</param>
4982	</method>
4983
4984	<method name="getCPUProperty" const="yes">
4985	<desc>
4986	Returns the virtual CPU boolean value of the specified property.
4987
4988	<result name="E_INVALIDARG">
4989	Invalid property.
4990	</result>
4991
4992	</desc>
4993	<param name="property" type="CPUPropertyType" dir="in">
4994	<desc>
4995	Property type to query.
4996	</desc>
4997	</param>
4998	<param name="value" type="boolean" dir="return">
4999	<desc>
5000	Property value.
5001	</desc>
5002	</param>
5003	</method>
5004
5005	<method name="setCPUProperty">
5006	<desc>
5007	Sets the virtual CPU boolean value of the specified property.
5008
5009	<result name="E_INVALIDARG">
5010	Invalid property.
5011	</result>
5012
5013	</desc>
5014	<param name="property" type="CPUPropertyType" dir="in">
5015	<desc>
5016	Property type to query.
5017	</desc>
5018	</param>
5019	<param name="value" type="boolean" dir="in">
5020	<desc>
5021	Property value.
5022	</desc>
5023	</param>
5024	</method>
5025
5026	<method name="getCPUIDLeaf" const="yes">
5027	<desc>
5028	Returns the virtual CPU cpuid information for the specified leaf.
5029
5030	Currently supported index values for cpuid:
5031	Standard CPUID leafs: 0 - 0xA
5032	Extended CPUID leafs: 0x80000000 - 0x8000000A
5033
5034	See the Intel and AMD programmer's manuals for detailed information
5035	about the cpuid instruction and its leafs.
5036	<result name="E_INVALIDARG">
5037	Invalid id.
5038	</result>
5039
5040	</desc>
5041	<param name="id" type="unsigned long" dir="in">
5042	<desc>
5043	CPUID leaf index.
5044	</desc>
5045	</param>
5046	<param name="valEax" type="unsigned long" dir="out">
5047	<desc>
5048	CPUID leaf value for register eax.
5049	</desc>
5050	</param>
5051	<param name="valEbx" type="unsigned long" dir="out">
5052	<desc>
5053	CPUID leaf value for register ebx.
5054	</desc>
5055	</param>
5056	<param name="valEcx" type="unsigned long" dir="out">
5057	<desc>
5058	CPUID leaf value for register ecx.
5059	</desc>
5060	</param>
5061	<param name="valEdx" type="unsigned long" dir="out">
5062	<desc>
5063	CPUID leaf value for register edx.
5064	</desc>
5065	</param>
5066	</method>
5067
5068	<method name="setCPUIDLeaf">
5069	<desc>
5070	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5071	are not passed unmodified. VirtualBox clears features that it doesn't support.
5072
5073	Currently supported index values for cpuid:
5074	Standard CPUID leafs: 0 - 0xA
5075	Extended CPUID leafs: 0x80000000 - 0x8000000A
5076
5077	See the Intel and AMD programmer's manuals for detailed information
5078	about the cpuid instruction and its leafs.
5079
5080	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5081	random crashes inside VMs.
5082	<result name="E_INVALIDARG">
5083	Invalid id.
5084	</result>
5085
5086	</desc>
5087	<param name="id" type="unsigned long" dir="in">
5088	<desc>
5089	CPUID leaf index.
5090	</desc>
5091	</param>
5092	<param name="valEax" type="unsigned long" dir="in">
5093	<desc>
5094	CPUID leaf value for register eax.
5095	</desc>
5096	</param>
5097	<param name="valEbx" type="unsigned long" dir="in">
5098	<desc>
5099	CPUID leaf value for register ebx.
5100	</desc>
5101	</param>
5102	<param name="valEcx" type="unsigned long" dir="in">
5103	<desc>
5104	CPUID leaf value for register ecx.
5105	</desc>
5106	</param>
5107	<param name="valEdx" type="unsigned long" dir="in">
5108	<desc>
5109	CPUID leaf value for register edx.
5110	</desc>
5111	</param>
5112	</method>
5113
5114	<method name="removeCPUIDLeaf">
5115	<desc>
5116	Removes the virtual CPU cpuid leaf for the specified index
5117
5118	<result name="E_INVALIDARG">
5119	Invalid id.
5120	</result>
5121
5122	</desc>
5123	<param name="id" type="unsigned long" dir="in">
5124	<desc>
5125	CPUID leaf index.
5126	</desc>
5127	</param>
5128	</method>
5129
5130	<method name="removeAllCPUIDLeaves">
5131	<desc>
5132	Removes all the virtual CPU cpuid leaves
5133	</desc>
5134	</method>
5135
5136	<method name="getHWVirtExProperty" const="yes">
5137	<desc>
5138	Returns the value of the specified hardware virtualization boolean property.
5139
5140	<result name="E_INVALIDARG">
5141	Invalid property.
5142	</result>
5143
5144	</desc>
5145	<param name="property" type="HWVirtExPropertyType" dir="in">
5146	<desc>
5147	Property type to query.
5148	</desc>
5149	</param>
5150	<param name="value" type="boolean" dir="return">
5151	<desc>
5152	Property value.
5153	</desc>
5154	</param>
5155	</method>
5156
5157	<method name="setHWVirtExProperty">
5158	<desc>
5159	Sets a new value for the specified hardware virtualization boolean property.
5160
5161	<result name="E_INVALIDARG">
5162	Invalid property.
5163	</result>
5164
5165	</desc>
5166	<param name="property" type="HWVirtExPropertyType" dir="in">
5167	<desc>
5168	Property type to set.
5169	</desc>
5170	</param>
5171	<param name="value" type="boolean" dir="in">
5172	<desc>
5173	New property value.
5174	</desc>
5175	</param>
5176	</method>
5177
5178	<method name="saveSettings">
5179	<desc>
5180	Saves any changes to machine settings made since the session
5181	has been opened or a new machine has been created, or since the
5182	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5183	For registered machines, new settings become visible to all
5184	other VirtualBox clients after successful invocation of this
5185	method.
5186	<note>
5187	The method sends <link to="IMachineDataChangedEvent"/>
5188	notification event after the configuration has been successfully
5189	saved (only for registered machines).
5190	</note>
5191	<note>
5192	Calling this method is only valid on instances returned
5193	by <link to="ISession::machine"/> and on new machines
5194	created by <link to="IVirtualBox::createMachine"/> but not
5195	yet registered, or on unregistered machines after calling
5196	<link to="IMachine::unregister"/>.
5197	</note>
5198
5199	<result name="VBOX_E_FILE_ERROR">
5200	Settings file not accessible.
5201	</result>
5202	<result name="VBOX_E_XML_ERROR">
5203	Could not parse the settings file.
5204	</result>
5205	<result name="E_ACCESSDENIED">
5206	Modification request refused.
5207	</result>
5208
5209	</desc>
5210	</method>
5211
5212	<method name="discardSettings">
5213	<desc>
5214	Discards any changes to the machine settings made since the session
5215	has been opened or since the last call to <link to="#saveSettings"/>
5216	or <link to="#discardSettings"/>.
5217	<note>
5218	Calling this method is only valid on instances returned
5219	by <link to="ISession::machine"/> and on new machines
5220	created by <link to="IVirtualBox::createMachine"/> or
5221	opened by <link to="IVirtualBox::openMachine"/> but not
5222	yet registered, or on unregistered machines after calling
5223	<link to="IMachine::unregister"/>.
5224	</note>
5225
5226	<result name="VBOX_E_INVALID_VM_STATE">
5227	Virtual machine is not mutable.
5228	</result>
5229
5230	</desc>
5231	</method>
5232
5233	<method name="unregister">
5234	<desc>
5235	Unregisters a machine previously registered with
5236	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5237	cleanup before the machine is unregistered.
5238
5239	This method does not delete any files. It only changes the machine configuration and
5240	the list of registered machines in the VirtualBox object. To delete the files which
5241	belonged to the machine, including the XML file of the machine itself, call
5242	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5243	from this method.
5244
5245	How thoroughly this method cleans up the machine configuration before unregistering
5246	the machine depends on the @a cleanupMode argument.
5247
5248	<ul>
5249	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5250	cleanup will be performed. The call will fail if the machine is in "Saved" state
5251	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5252	It is the responsibility of the caller to delete all such configuration in this mode.
5253	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5254	which it replaces.</li>
5255	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5256	state or if it has snapshots or media attached. All media attached to the current machine
5257	state or in snapshots will be detached. No medium objects will be returned;
5258	all of the machine's media will remain open.</li>
5259	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5260	except that all the hard disk medium objects which were detached from the machine will
5261	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5262	API for closing and deletion.</li>
5263	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5264	that all media will be returned in the array, including removable media like DVDs and
5265	floppies. This might be useful if the user wants to inspect in detail which media were
5266	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5267	in that case because users will typically want to preserve ISO and RAW image files.</li>
5268	</ul>
5269
5270	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5271	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5272	deleted with all its saved states and hard disk images, but images for removable
5273	drives (such as ISO and RAW files) will remain on disk.
5274
5275	This API does not verify whether the media files returned in the array are still
5276	attached to other machines (i.e. shared between several machines). If such a shared
5277	image is passed to <link to="#delete" /> however, closing the image will fail there
5278	and the image will be silently skipped.
5279
5280	This API may, however, move media from this machine's media registry to other media
5281	registries (see <link to="IMedium" /> for details on media registries). For machines
5282	created with VirtualBox 4.0 or later, if media from this machine's media registry
5283	are also attached to another machine (shared attachments), each such medium will be
5284	moved to another machine's registry. This is because without this machine's media
5285	registry, the other machine cannot find its media any more and would become inaccessible.
5286
5287	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5288	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5289	if media are moved to other machines' media registries.
5290
5291	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5292	is fired.
5293
5294	The call will fail if the machine is currently locked (see <link to="ISession" />).
5295
5296	<note>
5297	If the given machine is inaccessible (see <link to="#accessible"/>), it
5298	will be unregistered and fully uninitialized right afterwards. As a result,
5299	the returned machine object will be unusable and an attempt to call
5300	<b>any</b> method will return the "Object not ready" error.
5301	</note>
5302
5303	<result name="VBOX_E_INVALID_OBJECT_STATE">
5304	Machine is currently locked for a session.
5305	</result>
5306	</desc>
5307
5308	<param name="cleanupMode" type="CleanupMode" dir="in">
5309	<desc>How to clean up after the machine has been unregistered.</desc>
5310	</param>
5311	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5312	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5313	</param>
5314	</method>
5315
5316	<method name="delete">
5317	<desc>
5318	Deletes the files associated with this machine from disk. If medium objects are passed
5319	in with the @a aMedia argument, they are closed and, if closing was successful, their
5320	storage files are deleted as well. For convenience, this array of media files can be
5321	the same as the one returned from a previous <link to="#unregister" /> call.
5322
5323	This method must only be called on machines which are either write-locked (i.e. on instances
5324	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5325	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5326	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5327
5328	The following files will be deleted by this method:
5329	<ul>
5330	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5331	argument other than "UnregisterOnly", this will delete all saved state files that
5332	the machine had in use; possibly one if the machine was in "Saved" state and one
5333	for each online snapshot that the machine had.</li>
5334	<li>On each medium object passed in the @a aMedia array, this will call
5335	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5336	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5337	in use, e.g. because it is still attached to a second machine; in that case the
5338	storage will not be deleted.</li>
5339	<li>Finally, the machine's own XML file will be deleted.</li>
5340	</ul>
5341
5342	Since deleting large disk image files can be a time-consuming I/O operation, this
5343	method operates asynchronously and returns an IProgress object to allow the caller
5344	to monitor the progress. There will be one sub-operation for each file that is
5345	being deleted (saved state or medium storage file).
5346
5347	<note>
5348	<link to="#settingsModified"/> will return @c true after this
5349	method successfully returns.
5350	</note>
5351
5352	<result name="VBOX_E_INVALID_VM_STATE">
5353	Machine is registered but not write-locked.
5354	</result>
5355	<result name="VBOX_E_IPRT_ERROR">
5356	Could not delete the settings file.
5357	</result>
5358	</desc>
5359	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5360	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5361	</param>
5362	<param name="aProgress" type="IProgress" dir="return">
5363	<desc>Progress object to track the operation completion.</desc>
5364	</param>
5365	</method>
5366
5367	<method name="export">
5368	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5369	steps required to export VirtualBox machines to OVF.
5370	</desc>
5371
5372	<param name="aAppliance" type="IAppliance" dir="in">
5373	<desc>Appliance to export this machine to.</desc>
5374	</param>
5375	<param name="location" type="wstring" dir="in">
5376	<desc>The target location.</desc>
5377	</param>
5378	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5379	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5380	</param>
5381	</method >
5382
5383	<method name="findSnapshot">
5384	<desc>
5385	Returns a snapshot of this machine with the given name or UUID.
5386
5387	Returns a snapshot of this machine with the given UUID.
5388	A @c null argument can be used to obtain the first snapshot
5389	taken on this machine. To traverse the whole tree of snapshots
5390	starting from the root, inspect the root snapshot's
5391	<link to="ISnapshot::children" /> attribute and recurse over those children.
5392
5393	<result name="VBOX_E_OBJECT_NOT_FOUND">
5394	Virtual machine has no snapshots or snapshot not found.
5395	</result>
5396
5397	</desc>
5398	<param name="nameOrId" type="wstring" dir="in">
5399	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5400	</param>
5401	<param name="snapshot" type="ISnapshot" dir="return">
5402	<desc>Snapshot object with the given name.</desc>
5403	</param>
5404	</method>
5405
5406	<method name="createSharedFolder">
5407	<desc>
5408	Creates a new permanent shared folder by associating the given logical
5409	name with the given host path, adds it to the collection of shared
5410	folders and starts sharing it. Refer to the description of
5411	<link to="ISharedFolder"/> to read more about logical names.
5412
5413	<result name="VBOX_E_OBJECT_IN_USE">
5414	Shared folder already exists.
5415	</result>
5416	<result name="VBOX_E_FILE_ERROR">
5417	Shared folder @a hostPath not accessible.
5418	</result>
5419
5420	</desc>
5421	<param name="name" type="wstring" dir="in">
5422	<desc>Unique logical name of the shared folder.</desc>
5423	</param>
5424	<param name="hostPath" type="wstring" dir="in">
5425	<desc>Full path to the shared folder in the host file system.</desc>
5426	</param>
5427	<param name="writable" type="boolean" dir="in">
5428	<desc>Whether the share is writable or readonly.</desc>
5429	</param>
5430	<param name="automount" type="boolean" dir="in">
5431	<desc>Whether the share gets automatically mounted by the guest
5432	or not.</desc>
5433	</param>
5434	</method>
5435
5436	<method name="removeSharedFolder">
5437	<desc>
5438	Removes the permanent shared folder with the given name previously
5439	created by <link to="#createSharedFolder"/> from the collection of
5440	shared folders and stops sharing it.
5441
5442	<result name="VBOX_E_INVALID_VM_STATE">
5443	Virtual machine is not mutable.
5444	</result>
5445	<result name="VBOX_E_OBJECT_NOT_FOUND">
5446	Shared folder @a name does not exist.
5447	</result>
5448
5449	</desc>
5450	<param name="name" type="wstring" dir="in">
5451	<desc>Logical name of the shared folder to remove.</desc>
5452	</param>
5453	</method>
5454
5455	<method name="canShowConsoleWindow">
5456	<desc>
5457	Returns @c true if the VM console process can activate the
5458	console window and bring it to foreground on the desktop of
5459	the host PC.
5460	<note>
5461	This method will fail if a session for this machine is not
5462	currently open.
5463	</note>
5464
5465	<result name="VBOX_E_INVALID_VM_STATE">
5466	Machine session is not open.
5467	</result>
5468
5469	</desc>
5470	<param name="canShow" type="boolean" dir="return">
5471	<desc>
5472	@c true if the console window can be shown and @c false otherwise.
5473	</desc>
5474	</param>
5475	</method>
5476
5477	<method name="showConsoleWindow">
5478	<desc>
5479	Activates the console window and brings it to foreground on
5480	the desktop of the host PC. Many modern window managers on
5481	many platforms implement some sort of focus stealing
5482	prevention logic, so that it may be impossible to activate
5483	a window without the help of the currently active
5484	application. In this case, this method will return a non-zero
5485	identifier that represents the top-level window of the VM
5486	console process. The caller, if it represents a currently
5487	active process, is responsible to use this identifier (in a
5488	platform-dependent manner) to perform actual window
5489	activation.
5490	<note>
5491	This method will fail if a session for this machine is not
5492	currently open.
5493	</note>
5494
5495	<result name="VBOX_E_INVALID_VM_STATE">
5496	Machine session is not open.
5497	</result>
5498
5499	</desc>
5500	<param name="winId" type="long long" dir="return">
5501	<desc>
5502	Platform-dependent identifier of the top-level VM console
5503	window, or zero if this method has performed all actions
5504	necessary to implement the <i>show window</i> semantics for
5505	the given platform and/or VirtualBox front-end.
5506	</desc>
5507	</param>
5508	</method>
5509
5510	<method name="getGuestProperty" const="yes">
5511	<desc>
5512	Reads an entry from the machine's guest property store.
5513
5514	<result name="VBOX_E_INVALID_VM_STATE">
5515	Machine session is not open.
5516	</result>
5517
5518	</desc>
5519	<param name="name" type="wstring" dir="in">
5520	<desc>
5521	The name of the property to read.
5522	</desc>
5523	</param>
5524	<param name="value" type="wstring" dir="out">
5525	<desc>
5526	The value of the property. If the property does not exist then this
5527	will be empty.
5528	</desc>
5529	</param>
5530	<param name="timestamp" type="long long" dir="out">
5531	<desc>
5532	The time at which the property was last modified, as seen by the
5533	server process.
5534	</desc>
5535	</param>
5536	<param name="flags" type="wstring" dir="out">
5537	<desc>
5538	Additional property parameters, passed as a comma-separated list of
5539	"name=value" type entries.
5540	</desc>
5541	</param>
5542	</method>
5543
5544	<method name="getGuestPropertyValue" const="yes">
5545	<desc>
5546	Reads a value from the machine's guest property store.
5547
5548	<result name="VBOX_E_INVALID_VM_STATE">
5549	Machine session is not open.
5550	</result>
5551
5552	</desc>
5553	<param name="property" type="wstring" dir="in">
5554	<desc>
5555	The name of the property to read.
5556	</desc>
5557	</param>
5558	<param name="value" type="wstring" dir="return">
5559	<desc>
5560	The value of the property. If the property does not exist then this
5561	will be empty.
5562	</desc>
5563	</param>
5564	</method>
5565
5566	<method name="getGuestPropertyTimestamp" const="yes">
5567	<desc>
5568	Reads a property timestamp from the machine's guest property store.
5569
5570	<result name="VBOX_E_INVALID_VM_STATE">
5571	Machine session is not open.
5572	</result>
5573
5574	</desc>
5575	<param name="property" type="wstring" dir="in">
5576	<desc>
5577	The name of the property to read.
5578	</desc>
5579	</param>
5580	<param name="value" type="long long" dir="return">
5581	<desc>
5582	The timestamp. If the property does not exist then this will be
5583	empty.
5584	</desc>
5585	</param>
5586	</method>
5587
5588	<method name="setGuestProperty">
5589	<desc>
5590	Sets, changes or deletes an entry in the machine's guest property
5591	store.
5592
5593	<result name="E_ACCESSDENIED">
5594	Property cannot be changed.
5595	</result>
5596	<result name="E_INVALIDARG">
5597	Invalid @a flags.
5598	</result>
5599	<result name="VBOX_E_INVALID_VM_STATE">
5600	Virtual machine is not mutable or session not open.
5601	</result>
5602	<result name="VBOX_E_INVALID_OBJECT_STATE">
5603	Cannot set transient property when machine not running.
5604	</result>
5605
5606	</desc>
5607	<param name="property" type="wstring" dir="in">
5608	<desc>
5609	The name of the property to set, change or delete.
5610	</desc>
5611	</param>
5612	<param name="value" type="wstring" dir="in">
5613	<desc>
5614	The new value of the property to set, change or delete. If the
5615	property does not yet exist and value is non-empty, it will be
5616	created. If the value is @c null or empty, the property will be
5617	deleted if it exists.
5618	</desc>
5619	</param>
5620	<param name="flags" type="wstring" dir="in">
5621	<desc>
5622	Additional property parameters, passed as a comma-separated list of
5623	"name=value" type entries.
5624	</desc>
5625	</param>
5626	</method>
5627
5628	<method name="setGuestPropertyValue">
5629	<desc>
5630	Sets, changes or deletes a value in the machine's guest property
5631	store. The flags field will be left unchanged or created empty for a
5632	new property.
5633
5634	<result name="E_ACCESSDENIED">
5635	Property cannot be changed.
5636	</result>
5637	<result name="VBOX_E_INVALID_VM_STATE">
5638	Virtual machine is not mutable or session not open.
5639	</result>
5640	<result name="VBOX_E_INVALID_OBJECT_STATE">
5641	Cannot set transient property when machine not running.
5642	</result>
5643	</desc>
5644
5645	<param name="property" type="wstring" dir="in">
5646	<desc>
5647	The name of the property to set, change or delete.
5648	</desc>
5649	</param>
5650	<param name="value" type="wstring" dir="in">
5651	<desc>
5652	The new value of the property to set, change or delete. If the
5653	property does not yet exist and value is non-empty, it will be
5654	created. If the value is @c null or empty, the property will be
5655	deleted if it exists.
5656	</desc>
5657	</param>
5658	</method>
5659
5660	<method name="enumerateGuestProperties" const="yes">
5661	<desc>
5662	Return a list of the guest properties matching a set of patterns along
5663	with their values, time stamps and flags.
5664	</desc>
5665	<param name="patterns" type="wstring" dir="in">
5666	<desc>
5667	The patterns to match the properties against, separated by '\|'
5668	characters. If this is empty or @c null, all properties will match.
5669	</desc>
5670	</param>
5671	<param name="name" type="wstring" dir="out" safearray="yes">
5672	<desc>
5673	The names of the properties returned.
5674	</desc>
5675	</param>
5676	<param name="value" type="wstring" dir="out" safearray="yes">
5677	<desc>
5678	The values of the properties returned. The array entries match the
5679	corresponding entries in the @a name array.
5680	</desc>
5681	</param>
5682	<param name="timestamp" type="long long" dir="out" safearray="yes">
5683	<desc>
5684	The time stamps of the properties returned. The array entries match
5685	the corresponding entries in the @a name array.
5686	</desc>
5687	</param>
5688	<param name="flags" type="wstring" dir="out" safearray="yes">
5689	<desc>
5690	The flags of the properties returned. The array entries match the
5691	corresponding entries in the @a name array.
5692	</desc>
5693	</param>
5694	</method>
5695
5696	<method name="querySavedGuestSize" const="yes">
5697	<desc>
5698	Returns the guest dimensions from the saved state.
5699	</desc>
5700	<param name="screenId" type="unsigned long" dir="in">
5701	<desc>
5702	Saved guest screen to query info from.
5703	</desc>
5704	</param>
5705	<param name="width" type="unsigned long" dir="out">
5706	<desc>
5707	Guest width at the time of the saved state was taken.
5708	</desc>
5709	</param>
5710	<param name="height" type="unsigned long" dir="out">
5711	<desc>
5712	Guest height at the time of the saved state was taken.
5713	</desc>
5714	</param>
5715	</method>
5716
5717	<method name="querySavedThumbnailSize">
5718	<desc>
5719	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5720	</desc>
5721	<param name="screenId" type="unsigned long" dir="in">
5722	<desc>
5723	Saved guest screen to query info from.
5724	</desc>
5725	</param>
5726	<param name="size" type="unsigned long" dir="out">
5727	<desc>
5728	Size of buffer required to store the bitmap.
5729	</desc>
5730	</param>
5731	<param name="width" type="unsigned long" dir="out">
5732	<desc>
5733	Bitmap width.
5734	</desc>
5735	</param>
5736	<param name="height" type="unsigned long" dir="out">
5737	<desc>
5738	Bitmap height.
5739	</desc>
5740	</param>
5741	</method>
5742
5743	<method name="readSavedThumbnailToArray">
5744	<desc>
5745	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5746	</desc>
5747	<param name="screenId" type="unsigned long" dir="in">
5748	<desc>
5749	Saved guest screen to read from.
5750	</desc>
5751	</param>
5752	<param name="BGR" type="boolean" dir="in">
5753	<desc>
5754	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5755	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5756	</desc>
5757	</param>
5758	<param name="width" type="unsigned long" dir="out">
5759	<desc>
5760	Bitmap width.
5761	</desc>
5762	</param>
5763	<param name="height" type="unsigned long" dir="out">
5764	<desc>
5765	Bitmap height.
5766	</desc>
5767	</param>
5768	<param name="data" type="octet" safearray="yes" dir="return">
5769	<desc>
5770	Array with resulting bitmap data.
5771	</desc>
5772	</param>
5773	</method>
5774
5775	<method name="readSavedThumbnailPNGToArray">
5776	<desc>
5777	Thumbnail in PNG format is retrieved to an array of bytes.
5778	</desc>
5779	<param name="screenId" type="unsigned long" dir="in">
5780	<desc>
5781	Saved guest screen to read from.
5782	</desc>
5783	</param>
5784	<param name="width" type="unsigned long" dir="out">
5785	<desc>
5786	Image width.
5787	</desc>
5788	</param>
5789	<param name="height" type="unsigned long" dir="out">
5790	<desc>
5791	Image height.
5792	</desc>
5793	</param>
5794	<param name="data" type="octet" dir="return" safearray="yes">
5795	<desc>
5796	Array with resulting PNG data.
5797	</desc>
5798	</param>
5799	</method>
5800
5801	<method name="querySavedScreenshotPNGSize">
5802	<desc>
5803	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5804	</desc>
5805	<param name="screenId" type="unsigned long" dir="in">
5806	<desc>
5807	Saved guest screen to query info from.
5808	</desc>
5809	</param>
5810	<param name="size" type="unsigned long" dir="out">
5811	<desc>
5812	Size of buffer required to store the PNG binary data.
5813	</desc>
5814	</param>
5815	<param name="width" type="unsigned long" dir="out">
5816	<desc>
5817	Image width.
5818	</desc>
5819	</param>
5820	<param name="height" type="unsigned long" dir="out">
5821	<desc>
5822	Image height.
5823	</desc>
5824	</param>
5825	</method>
5826
5827	<method name="readSavedScreenshotPNGToArray">
5828	<desc>
5829	Screenshot in PNG format is retrieved to an array of bytes.
5830	</desc>
5831	<param name="screenId" type="unsigned long" dir="in">
5832	<desc>
5833	Saved guest screen to read from.
5834	</desc>
5835	</param>
5836	<param name="width" type="unsigned long" dir="out">
5837	<desc>
5838	Image width.
5839	</desc>
5840	</param>
5841	<param name="height" type="unsigned long" dir="out">
5842	<desc>
5843	Image height.
5844	</desc>
5845	</param>
5846	<param name="data" type="octet" dir="return" safearray="yes">
5847	<desc>
5848	Array with resulting PNG data.
5849	</desc>
5850	</param>
5851	</method>
5852
5853	<method name="hotPlugCPU">
5854	<desc>
5855	Plugs a CPU into the machine.
5856	</desc>
5857	<param name="cpu" type="unsigned long" dir="in">
5858	<desc>
5859	The CPU id to insert.
5860	</desc>
5861	</param>
5862	</method>
5863
5864	<method name="hotUnplugCPU">
5865	<desc>
5866	Removes a CPU from the machine.
5867	</desc>
5868	<param name="cpu" type="unsigned long" dir="in">
5869	<desc>
5870	The CPU id to remove.
5871	</desc>
5872	</param>
5873	</method>
5874
5875	<method name="getCPUStatus">
5876	<desc>
5877	Returns the current status of the given CPU.
5878	</desc>
5879	<param name="cpu" type="unsigned long" dir="in">
5880	<desc>
5881	The CPU id to check for.
5882	</desc>
5883	</param>
5884	<param name="attached" type="boolean" dir="return">
5885	<desc>
5886	Status of the CPU.
5887	</desc>
5888	</param>
5889	</method>
5890
5891	<method name="queryLogFilename">
5892	<desc>
5893	Queries for the VM log file name of an given index. Returns an empty
5894	string if a log file with that index doesn't exists.
5895	</desc>
5896	<param name="idx" type="unsigned long" dir="in">
5897	<desc>
5898	Which log file name to query. 0=current log file.
5899	</desc>
5900	</param>
5901	<param name="filename" type="wstring" dir="return">
5902	<desc>
5903	On return the full path to the log file or an empty string on error.
5904	</desc>
5905	</param>
5906	</method>
5907
5908	<method name="readLog">
5909	<desc>
5910	Reads the VM log file. The chunk size is limited, so even if you
5911	ask for a big piece there might be less data returned.
5912	</desc>
5913	<param name="idx" type="unsigned long" dir="in">
5914	<desc>
5915	Which log file to read. 0=current log file.
5916	</desc>
5917	</param>
5918	<param name="offset" type="long long" dir="in">
5919	<desc>
5920	Offset in the log file.
5921	</desc>
5922	</param>
5923	<param name="size" type="long long" dir="in">
5924	<desc>
5925	Chunk size to read in the log file.
5926	</desc>
5927	</param>
5928	<param name="data" type="octet" dir="return" safearray="yes">
5929	<desc>
5930	Data read from the log file. A data size of 0 means end of file
5931	if the requested chunk size was not 0. This is the unprocessed
5932	file data, i.e. the line ending style depends on the platform of
5933	the system the server is running on.
5934	</desc>
5935	</param>
5936	</method>
5937
5938	<method name="cloneTo">
5939	<desc>
5940	Creates a clone of this machine, either as a full clone (which means
5941	creating independent copies of the hard disk media), or as a linked
5942	clone (which uses its own differencing media, sharing the parent media
5943	with the source machine).
5944
5945	The target machine object must have been created previously with
5946	<link to="IVirtualBox::createMachine"/>, and all the settings will be
5947	transferred except the VM name, hardware UUID and the network card
5948	MAC addresses. These can be set after the clone operation if required.
5949	The operation is performed asynchronously, so the machine object will
5950	be not be usable until the @a progress object signals completion. If
5951	any step of the machine clone operation fails this will abort the
5952	operation. The result will be a machine which is not a complete clone.
5953	It is the responsibility of the caller to delete this incomplete
5954	machine if desired with <link to="#unregister"/> and/or
5955	<link to="#delete"/>.
5956
5957	<result name="E_INVALIDARG">
5958	@a target is @c null.
5959	</result>
5960	</desc>
5961
5962	<param name="target" type="IMachine" dir="in">
5963	<desc>Target machine object.</desc>
5964	</param>
5965	<param name="fullClone" type="boolean" dir="in">
5966	<desc>Selects whether a full or linked clone is created.</desc>
5967	</param>
5968	<param name="progress" type="IProgress" dir="return">
5969	<desc>Progress object to track the operation completion.</desc>
5970	</param>
5971	</method>
5972
5973	</interface>
5974
5975	<!--
5976	// IConsole
5977	/////////////////////////////////////////////////////////////////////////
5978	-->
5979
5980	<interface
5981	name="IVRDEServerInfo" extends="$unknown"
5982	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5983	wsmap="struct"
5984	>
5985	<desc>
5986	Contains information about the remote desktop (VRDE) server capabilities and status.
5987	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5988	</desc>
5989
5990	<attribute name="active" type="boolean" readonly="yes">
5991	<desc>
5992	Whether the remote desktop connection is active.
5993	</desc>
5994	</attribute>
5995
5996	<attribute name="port" type="long" readonly="yes">
5997	<desc>
5998	VRDE server port number. If this property is equal to <tt>0</tt>, then
5999	the VRDE server failed to start, usually because there are no free IP
6000	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6001	server has not yet been started.
6002	</desc>
6003	</attribute>
6004
6005	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6006	<desc>
6007	How many times a client connected.
6008	</desc>
6009	</attribute>
6010
6011	<attribute name="beginTime" type="long long" readonly="yes">
6012	<desc>
6013	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6014	</desc>
6015	</attribute>
6016
6017	<attribute name="endTime" type="long long" readonly="yes">
6018	<desc>
6019	When the last connection was terminated or the current time, if
6020	connection is still active, in milliseconds since 1970-01-01 UTC.
6021	</desc>
6022	</attribute>
6023
6024	<attribute name="bytesSent" type="long long" readonly="yes">
6025	<desc>
6026	How many bytes were sent in last or current, if still active, connection.
6027	</desc>
6028	</attribute>
6029
6030	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6031	<desc>
6032	How many bytes were sent in all connections.
6033	</desc>
6034	</attribute>
6035
6036	<attribute name="bytesReceived" type="long long" readonly="yes">
6037	<desc>
6038	How many bytes were received in last or current, if still active, connection.
6039	</desc>
6040	</attribute>
6041
6042	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6043	<desc>
6044	How many bytes were received in all connections.
6045	</desc>
6046	</attribute>
6047
6048	<attribute name="user" type="wstring" readonly="yes">
6049	<desc>
6050	Login user name supplied by the client.
6051	</desc>
6052	</attribute>
6053
6054	<attribute name="domain" type="wstring" readonly="yes">
6055	<desc>
6056	Login domain name supplied by the client.
6057	</desc>
6058	</attribute>
6059
6060	<attribute name="clientName" type="wstring" readonly="yes">
6061	<desc>
6062	The client name supplied by the client.
6063	</desc>
6064	</attribute>
6065
6066	<attribute name="clientIP" type="wstring" readonly="yes">
6067	<desc>
6068	The IP address of the client.
6069	</desc>
6070	</attribute>
6071
6072	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6073	<desc>
6074	The client software version number.
6075	</desc>
6076	</attribute>
6077
6078	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6079	<desc>
6080	Public key exchange method used when connection was established.
6081	Values: 0 - RDP4 public key exchange scheme.
6082	1 - X509 certificates were sent to client.
6083	</desc>
6084	</attribute>
6085
6086	</interface>
6087
6088	<interface
6089	name="IConsole" extends="$unknown"
6090	uuid="acf265ea-0433-4fda-9619-efa40275899c"
6091	wsmap="managed"
6092	>
6093	<desc>
6094	The IConsole interface represents an interface to control virtual
6095	machine execution.
6096
6097	A console object gets created when a machine has been locked for a
6098	particular session (client process) using <link to="IMachine::lockMachine" />
6099	or <link to="IMachine::launchVMProcess"/>. The console object can
6100	then be found in the session's <link to="ISession::console" /> attribute.
6101
6102	Methods of the IConsole interface allow the caller to query the current
6103	virtual machine execution state, pause the machine or power it down, save
6104	the machine state or take a snapshot, attach and detach removable media
6105	and so on.
6106
6107	<see><link to="ISession"/></see>
6108	</desc>
6109
6110	<attribute name="machine" type="IMachine" readonly="yes">
6111	<desc>
6112	Machine object for this console session.
6113	<note>
6114	This is a convenience property, it has the same value as
6115	<link to="ISession::machine"/> of the corresponding session
6116	object.
6117	</note>
6118	</desc>
6119	</attribute>
6120
6121	<attribute name="state" type="MachineState" readonly="yes">
6122	<desc>
6123	Current execution state of the machine.
6124	<note>
6125	This property always returns the same value as the corresponding
6126	property of the IMachine object for this console session.
6127	For the process that owns (executes) the VM, this is the
6128	preferable way of querying the VM state, because no IPC
6129	calls are made.
6130	</note>
6131	</desc>
6132	</attribute>
6133
6134	<attribute name="guest" type="IGuest" readonly="yes">
6135	<desc>Guest object.</desc>
6136	</attribute>
6137
6138	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6139	<desc>
6140	Virtual keyboard object.
6141	<note>
6142	If the machine is not running, any attempt to use
6143	the returned object will result in an error.
6144	</note>
6145	</desc>
6146	</attribute>
6147
6148	<attribute name="mouse" type="IMouse" readonly="yes">
6149	<desc>
6150	Virtual mouse object.
6151	<note>
6152	If the machine is not running, any attempt to use
6153	the returned object will result in an error.
6154	</note>
6155	</desc>
6156	</attribute>
6157
6158	<attribute name="display" type="IDisplay" readonly="yes">
6159	<desc>Virtual display object.
6160	<note>
6161	If the machine is not running, any attempt to use
6162	the returned object will result in an error.
6163	</note>
6164	</desc>
6165	</attribute>
6166
6167	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6168	<desc>Debugging interface.</desc>
6169	</attribute>
6170
6171	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6172	<desc>
6173	Collection of USB devices currently attached to the virtual
6174	USB controller.
6175	<note>
6176	The collection is empty if the machine is not running.
6177	</note>
6178	</desc>
6179	</attribute>
6180
6181	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6182	<desc>
6183	List of USB devices currently attached to the remote VRDE client.
6184	Once a new device is physically attached to the remote host computer,
6185	it appears in this list and remains there until detached.
6186	</desc>
6187	</attribute>
6188
6189	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6190	<desc>
6191	Collection of shared folders for the current session. These folders
6192	are called transient shared folders because they are available to the
6193	guest OS running inside the associated virtual machine only for the
6194	duration of the session (as opposed to
6195	<link to="IMachine::sharedFolders"/> which represent permanent shared
6196	folders). When the session is closed (e.g. the machine is powered down),
6197	these folders are automatically discarded.
6198
6199	New shared folders are added to the collection using
6200	<link to="#createSharedFolder"/>. Existing shared folders can be
6201	removed using <link to="#removeSharedFolder"/>.
6202	</desc>
6203	</attribute>
6204
6205	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6206	<desc>
6207	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6208	</desc>
6209	</attribute>
6210
6211	<attribute name="eventSource" type="IEventSource" readonly="yes">
6212	<desc>
6213	Event source for console events.
6214	</desc>
6215	</attribute>
6216
6217	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6218	<desc>Array of PCI devices attached to this machine.</desc>
6219	</attribute>
6220
6221	<method name="powerUp">
6222	<desc>
6223	Starts the virtual machine execution using the current machine
6224	state (that is, its current execution state, current settings and
6225	current storage devices).
6226
6227	<note>
6228	This method is only useful for front-ends that want to actually
6229	execute virtual machines in their own process (like the VirtualBox
6230	or VBoxSDL front-ends). Unless you are intending to write such a
6231	front-end, do not call this method. If you simply want to
6232	start virtual machine execution using one of the existing front-ends
6233	(for example the VirtualBox GUI or headless server), use
6234	<link to="IMachine::launchVMProcess"/> instead; these
6235	front-ends will power up the machine automatically for you.
6236	</note>
6237
6238	If the machine is powered off or aborted, the execution will
6239	start from the beginning (as if the real hardware were just
6240	powered on).
6241
6242	If the machine is in the <link to="MachineState_Saved"/> state,
6243	it will continue its execution the point where the state has
6244	been saved.
6245
6246	If the machine <link to="IMachine::teleporterEnabled"/> property is
6247	enabled on the machine being powered up, the machine will wait for an
6248	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6249	state. The returned progress object will have at least three
6250	operations where the last three are defined as: (1) powering up and
6251	starting TCP server, (2) waiting for incoming teleportations, and
6252	(3) perform teleportation. These operations will be reflected as the
6253	last three operations of the progress objected returned by
6254	<link to="IMachine::launchVMProcess"/> as well.
6255
6256	<see><link to="#saveState"/></see>
6257
6258	<result name="VBOX_E_INVALID_VM_STATE">
6259	Virtual machine already running.
6260	</result>
6261	<result name="VBOX_E_HOST_ERROR">
6262	Host interface does not exist or name not set.
6263	</result>
6264	<result name="VBOX_E_FILE_ERROR">
6265	Invalid saved state file.
6266	</result>
6267	</desc>
6268	<param name="progress" type="IProgress" dir="return">
6269	<desc>Progress object to track the operation completion.</desc>
6270	</param>
6271	</method>
6272
6273	<method name="powerUpPaused">
6274	<desc>
6275	Identical to powerUp except that the VM will enter the
6276	<link to="MachineState_Paused"/> state, instead of
6277	<link to="MachineState_Running"/>.
6278
6279	<see><link to="#powerUp"/></see>
6280	<result name="VBOX_E_INVALID_VM_STATE">
6281	Virtual machine already running.
6282	</result>
6283	<result name="VBOX_E_HOST_ERROR">
6284	Host interface does not exist or name not set.
6285	</result>
6286	<result name="VBOX_E_FILE_ERROR">
6287	Invalid saved state file.
6288	</result>
6289	</desc>
6290	<param name="progress" type="IProgress" dir="return">
6291	<desc>Progress object to track the operation completion.</desc>
6292	</param>
6293	</method>
6294
6295	<method name="powerDown">
6296	<desc>
6297	Initiates the power down procedure to stop the virtual machine
6298	execution.
6299
6300	The completion of the power down procedure is tracked using the returned
6301	IProgress object. After the operation is complete, the machine will go
6302	to the PoweredOff state.
6303	<result name="VBOX_E_INVALID_VM_STATE">
6304	Virtual machine must be Running, Paused or Stuck to be powered down.
6305	</result>
6306	</desc>
6307	<param name="progress" type="IProgress" dir="return">
6308	<desc>Progress object to track the operation completion.</desc>
6309	</param>
6310	</method>
6311
6312	<method name="reset">
6313	<desc>Resets the virtual machine.
6314	<result name="VBOX_E_INVALID_VM_STATE">
6315	Virtual machine not in Running state.
6316	</result>
6317	<result name="VBOX_E_VM_ERROR">
6318	Virtual machine error in reset operation.
6319	</result>
6320	</desc>
6321	</method>
6322
6323	<method name="pause">
6324	<desc>Pauses the virtual machine execution.
6325	<result name="VBOX_E_INVALID_VM_STATE">
6326	Virtual machine not in Running state.
6327	</result>
6328	<result name="VBOX_E_VM_ERROR">
6329	Virtual machine error in suspend operation.
6330	</result>
6331	</desc>
6332	</method>
6333
6334	<method name="resume">
6335	<desc>Resumes the virtual machine execution.
6336	<result name="VBOX_E_INVALID_VM_STATE">
6337	Virtual machine not in Paused state.
6338	</result>
6339	<result name="VBOX_E_VM_ERROR">
6340	Virtual machine error in resume operation.
6341	</result>
6342	</desc>
6343	</method>
6344
6345	<method name="powerButton">
6346	<desc>Sends the ACPI power button event to the guest.
6347	<result name="VBOX_E_INVALID_VM_STATE">
6348	Virtual machine not in Running state.
6349	</result>
6350	<result name="VBOX_E_PDM_ERROR">
6351	Controlled power off failed.
6352	</result>
6353	</desc>
6354	</method>
6355
6356	<method name="sleepButton">
6357	<desc>Sends the ACPI sleep button event to the guest.
6358	<result name="VBOX_E_INVALID_VM_STATE">
6359	Virtual machine not in Running state.
6360	</result>
6361	<result name="VBOX_E_PDM_ERROR">
6362	Sending sleep button event failed.
6363	</result>
6364	</desc>
6365	</method>
6366
6367	<method name="getPowerButtonHandled">
6368	<desc>Checks if the last power button event was handled by guest.
6369	<result name="VBOX_E_PDM_ERROR">
6370	Checking if the event was handled by the guest OS failed.
6371	</result>
6372	</desc>
6373	<param name="handled" type="boolean" dir="return"/>
6374	</method>
6375
6376	<method name="getGuestEnteredACPIMode">
6377	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6378	G1 (sleeping). If this method returns @c false, the guest will
6379	most likely not respond to external ACPI events.
6380	<result name="VBOX_E_INVALID_VM_STATE">
6381	Virtual machine not in Running state.
6382	</result>
6383	</desc>
6384	<param name="entered" type="boolean" dir="return"/>
6385	</method>
6386
6387	<method name="saveState">
6388	<desc>
6389	Saves the current execution state of a running virtual machine
6390	and stops its execution.
6391
6392	After this operation completes, the machine will go to the
6393	Saved state. Next time it is powered up, this state will
6394	be restored and the machine will continue its execution from
6395	the place where it was saved.
6396
6397	This operation differs from taking a snapshot to the effect
6398	that it doesn't create new differencing media. Also, once
6399	the machine is powered up from the state saved using this method,
6400	the saved state is deleted, so it will be impossible to return
6401	to this state later.
6402
6403	<note>
6404	On success, this method implicitly calls
6405	<link to="IMachine::saveSettings"/> to save all current machine
6406	settings (including runtime changes to the DVD medium, etc.).
6407	Together with the impossibility to change any VM settings when it is
6408	in the Saved state, this guarantees adequate hardware
6409	configuration of the machine when it is restored from the saved
6410	state file.
6411	</note>
6412
6413	<note>
6414	The machine must be in the Running or Paused state, otherwise
6415	the operation will fail.
6416	</note>
6417	<result name="VBOX_E_INVALID_VM_STATE">
6418	Virtual machine state neither Running nor Paused.
6419	</result>
6420	<result name="VBOX_E_FILE_ERROR">
6421	Failed to create directory for saved state file.
6422	</result>
6423
6424	<see><link to="#takeSnapshot"/></see>
6425	</desc>
6426	<param name="progress" type="IProgress" dir="return">
6427	<desc>Progress object to track the operation completion.</desc>
6428	</param>
6429	</method>
6430
6431	<method name="adoptSavedState">
6432	<desc>
6433	Associates the given saved state file to the virtual machine.
6434
6435	On success, the machine will go to the Saved state. Next time it is
6436	powered up, it will be restored from the adopted saved state and
6437	continue execution from the place where the saved state file was
6438	created.
6439
6440	The specified saved state file path may be absolute or relative to the
6441	folder the VM normally saves the state to (usually,
6442	<link to="IMachine::snapshotFolder"/>).
6443
6444	<note>
6445	It's a caller's responsibility to make sure the given saved state
6446	file is compatible with the settings of this virtual machine that
6447	represent its virtual hardware (memory size, storage disk configuration
6448	etc.). If there is a mismatch, the behavior of the virtual machine
6449	is undefined.
6450	</note>
6451	<result name="VBOX_E_INVALID_VM_STATE">
6452	Virtual machine state neither PoweredOff nor Aborted.
6453	</result>
6454	</desc>
6455	<param name="savedStateFile" type="wstring" dir="in">
6456	<desc>Path to the saved state file to adopt.</desc>
6457	</param>
6458	</method>
6459
6460	<method name="discardSavedState">
6461	<desc>
6462	Forcibly resets the machine to "Powered Off" state if it is
6463	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6464	Next time the machine is powered up, a clean boot will occur.
6465	<note>
6466	This operation is equivalent to resetting or powering off
6467	the machine without doing a proper shutdown of the guest
6468	operating system; as with resetting a running phyiscal
6469	computer, it can can lead to data loss.
6470	</note>
6471	If @a fRemoveFile is @c true, the file in the machine directory
6472	into which the machine state was saved is also deleted. If
6473	this is @c false, then the state can be recovered and later
6474	re-inserted into a machine using <link to="#adoptSavedState" />.
6475	The location of the file can be found in the
6476	<link to="IMachine::stateFilePath" /> attribute.
6477	<result name="VBOX_E_INVALID_VM_STATE">
6478	Virtual machine not in state Saved.
6479	</result>
6480	</desc>
6481	<param name="fRemoveFile" type="boolean" dir="in" >
6482	<desc>Whether to also remove the saved state file.</desc>
6483	</param>
6484	</method>
6485
6486	<method name="getDeviceActivity">
6487	<desc>
6488	Gets the current activity type of a given device or device group.
6489	<result name="E_INVALIDARG">
6490	Invalid device type.
6491	</result>
6492	</desc>
6493	<param name="type" type="DeviceType" dir="in"/>
6494	<param name="activity" type="DeviceActivity" dir="return"/>
6495	</method>
6496
6497	<method name="attachUSBDevice">
6498	<desc>
6499	Attaches a host USB device with the given UUID to the
6500	USB controller of the virtual machine.
6501
6502	The device needs to be in one of the following states:
6503	<link to="USBDeviceState_Busy"/>,
6504	<link to="USBDeviceState_Available"/> or
6505	<link to="USBDeviceState_Held"/>,
6506	otherwise an error is immediately returned.
6507
6508	When the device state is
6509	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6510	be returned if the host computer refuses to release it for some reason.
6511
6512	<see><link to="IUSBController::deviceFilters"/>,
6513	<link to="USBDeviceState"/></see>
6514	<result name="VBOX_E_INVALID_VM_STATE">
6515	Virtual machine state neither Running nor Paused.
6516	</result>
6517	<result name="VBOX_E_PDM_ERROR">
6518	Virtual machine does not have a USB controller.
6519	</result>
6520	</desc>
6521	<param name="id" type="uuid" mod="string" dir="in">
6522	<desc>UUID of the host USB device to attach.</desc>
6523	</param>
6524	</method>
6525
6526	<method name="detachUSBDevice">
6527	<desc>
6528	Detaches an USB device with the given UUID from the USB controller
6529	of the virtual machine.
6530
6531	After this method succeeds, the VirtualBox server re-initiates
6532	all USB filters as if the device were just physically attached
6533	to the host, but filters of this machine are ignored to avoid
6534	a possible automatic re-attachment.
6535
6536	<see><link to="IUSBController::deviceFilters"/>,
6537	<link to="USBDeviceState"/></see>
6538
6539	<result name="VBOX_E_PDM_ERROR">
6540	Virtual machine does not have a USB controller.
6541	</result>
6542	<result name="E_INVALIDARG">
6543	USB device not attached to this virtual machine.
6544	</result>
6545	</desc>
6546	<param name="id" type="uuid" mod="string" dir="in">
6547	<desc>UUID of the USB device to detach.</desc>
6548	</param>
6549	<param name="device" type="IUSBDevice" dir="return">
6550	<desc>Detached USB device.</desc>
6551	</param>
6552	</method>
6553
6554	<method name="findUSBDeviceByAddress">
6555	<desc>
6556	Searches for a USB device with the given host address.
6557
6558	<result name="VBOX_E_OBJECT_NOT_FOUND">
6559	Given @c name does not correspond to any USB device.
6560	</result>
6561
6562	<see><link to="IUSBDevice::address"/></see>
6563	</desc>
6564	<param name="name" type="wstring" dir="in">
6565	<desc>
6566	Address of the USB device (as assigned by the host) to
6567	search for.
6568	</desc>
6569	</param>
6570	<param name="device" type="IUSBDevice" dir="return">
6571	<desc>Found USB device object.</desc>
6572	</param>
6573	</method>
6574
6575	<method name="findUSBDeviceById">
6576	<desc>
6577	Searches for a USB device with the given UUID.
6578
6579	<result name="VBOX_E_OBJECT_NOT_FOUND">
6580	Given @c id does not correspond to any USB device.
6581	</result>
6582
6583	<see><link to="IUSBDevice::id"/></see>
6584	</desc>
6585	<param name="id" type="uuid" mod="string" dir="in">
6586	<desc>UUID of the USB device to search for.</desc>
6587	</param>
6588	<param name="device" type="IUSBDevice" dir="return">
6589	<desc>Found USB device object.</desc>
6590	</param>
6591	</method>
6592
6593	<method name="createSharedFolder">
6594	<desc>
6595	Creates a transient new shared folder by associating the given logical
6596	name with the given host path, adds it to the collection of shared
6597	folders and starts sharing it. Refer to the description of
6598	<link to="ISharedFolder"/> to read more about logical names.
6599
6600	<result name="VBOX_E_INVALID_VM_STATE">
6601	Virtual machine in Saved state or currently changing state.
6602	</result>
6603	<result name="VBOX_E_FILE_ERROR">
6604	Shared folder already exists or not accessible.
6605	</result>
6606	</desc>
6607	<param name="name" type="wstring" dir="in">
6608	<desc>Unique logical name of the shared folder.</desc>
6609	</param>
6610	<param name="hostPath" type="wstring" dir="in">
6611	<desc>Full path to the shared folder in the host file system.</desc>
6612	</param>
6613	<param name="writable" type="boolean" dir="in">
6614	<desc>Whether the share is writable or readonly</desc>
6615	</param>
6616	<param name="automount" type="boolean" dir="in">
6617	<desc>Whether the share gets automatically mounted by the guest
6618	or not.</desc>
6619	</param>
6620	</method>
6621
6622	<method name="removeSharedFolder">
6623	<desc>
6624	Removes a transient shared folder with the given name previously
6625	created by <link to="#createSharedFolder"/> from the collection of
6626	shared folders and stops sharing it.
6627	<result name="VBOX_E_INVALID_VM_STATE">
6628	Virtual machine in Saved state or currently changing state.
6629	</result>
6630	<result name="VBOX_E_FILE_ERROR">
6631	Shared folder does not exists.
6632	</result>
6633	</desc>
6634	<param name="name" type="wstring" dir="in">
6635	<desc>Logical name of the shared folder to remove.</desc>
6636	</param>
6637	</method>
6638
6639	<method name="takeSnapshot">
6640	<desc>
6641	Saves the current execution state
6642	and all settings of the machine and creates differencing images
6643	for all normal (non-independent) media.
6644	See <link to="ISnapshot" /> for an introduction to snapshots.
6645
6646	This method can be called for a PoweredOff, Saved (see
6647	<link to="#saveState"/>), Running or
6648	Paused virtual machine. When the machine is PoweredOff, an
6649	offline snapshot is created. When the machine is Running a live
6650	snapshot is created, and an online snapshot is is created when Paused.
6651
6652	The taken snapshot is always based on the
6653	<link to="IMachine::currentSnapshot">current snapshot</link>
6654	of the associated virtual machine and becomes a new current snapshot.
6655
6656	<note>
6657	This method implicitly calls <link to="IMachine::saveSettings"/> to
6658	save all current machine settings before taking an offline snapshot.
6659	</note>
6660
6661	<result name="VBOX_E_INVALID_VM_STATE">
6662	Virtual machine currently changing state.
6663	</result>
6664	</desc>
6665	<param name="name" type="wstring" dir="in">
6666	<desc>Short name for the snapshot.</desc>
6667	</param>
6668	<param name="description" type="wstring" dir="in">
6669	<desc>Optional description of the snapshot.</desc>
6670	</param>
6671	<param name="progress" type="IProgress" dir="return">
6672	<desc>Progress object to track the operation completion.</desc>
6673	</param>
6674	</method>
6675
6676	<method name="deleteSnapshot">
6677	<desc>
6678	Starts deleting the specified snapshot asynchronously.
6679	See <link to="ISnapshot" /> for an introduction to snapshots.
6680
6681	The execution state and settings of the associated machine stored in
6682	the snapshot will be deleted. The contents of all differencing media of
6683	this snapshot will be merged with the contents of their dependent child
6684	media to keep the medium chain valid (in other words, all changes
6685	represented by media being deleted will be propagated to their child
6686	medium). After that, this snapshot's differencing medium will be
6687	deleted. The parent of this snapshot will become a new parent for all
6688	its child snapshots.
6689
6690	If the deleted snapshot is the current one, its parent snapshot will
6691	become a new current snapshot. The current machine state is not directly
6692	affected in this case, except that currently attached differencing
6693	media based on media of the deleted snapshot will be also merged as
6694	described above.
6695
6696	If the deleted snapshot is the first or current snapshot, then the
6697	respective IMachine attributes will be adjusted. Deleting the current
6698	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6699	to make all current machine settings permanent.
6700
6701	Deleting a snapshot has the following preconditions:
6702
6703	<ul>
6704	<li>Child media of all normal media of the deleted snapshot
6705	must be accessible (see <link to="IMedium::state"/>) for this
6706	operation to succeed. If only one running VM refers to all images
6707	which participates in merging the operation can be performed while
6708	the VM is running. Otherwise all virtual machines whose media are
6709	directly or indirectly based on the media of deleted snapshot must
6710	be powered off. In any case, online snapshot deleting usually is
6711	slower than the same operation without any running VM.</li>
6712
6713	<li>You cannot delete the snapshot if a medium attached to it has
6714	more than one child medium (differencing images) because otherwise
6715	merging would be impossible. This might be the case if there is
6716	more than one child snapshot or differencing images were created
6717	for other reason (e.g. implicitly because of multiple machine
6718	attachments).</li>
6719	</ul>
6720
6721	The virtual machine's <link to="IMachine::state">state</link> is
6722	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6723	"DeletingSnapshotPaused" while this operation is in progress.
6724
6725	<note>
6726	Merging medium contents can be very time and disk space
6727	consuming, if these media are big in size and have many
6728	children. However, if the snapshot being deleted is the last
6729	(head) snapshot on the branch, the operation will be rather
6730	quick.
6731	</note>
6732	<result name="VBOX_E_INVALID_VM_STATE">
6733	The running virtual machine prevents deleting this snapshot. This
6734	happens only in very specific situations, usually snapshots can be
6735	deleted without trouble while a VM is running. The error message
6736	text explains the reason for the failure.
6737	</result>
6738	</desc>
6739	<param name="id" type="uuid" mod="string" dir="in">
6740	<desc>UUID of the snapshot to delete.</desc>
6741	</param>
6742	<param name="progress" type="IProgress" dir="return">
6743	<desc>Progress object to track the operation completion.</desc>
6744	</param>
6745	</method>
6746
6747	<method name="deleteSnapshotAndAllChildren">
6748	<desc>
6749	Starts deleting the specified snapshot and all its children
6750	asynchronously. See <link to="ISnapshot" /> for an introduction to
6751	snapshots. The conditions and many details are the same as with
6752	<link to="#deleteSnapshot"/>.
6753
6754	This operation is very fast if the snapshot subtree does not include
6755	the current state. It is still significantly faster than deleting the
6756	snapshots one by one if the current state is in the subtree and there
6757	are more than one snapshots from current state to the snapshot which
6758	marks the subtree, since it eliminates the incremental image merging.
6759
6760	<note>This API method is right now not implemented!</note>
6761
6762	<result name="VBOX_E_INVALID_VM_STATE">
6763	The running virtual machine prevents deleting this snapshot. This
6764	happens only in very specific situations, usually snapshots can be
6765	deleted without trouble while a VM is running. The error message
6766	text explains the reason for the failure.
6767	</result>
6768	<result name="E_NOTIMPL">
6769	The method is not implemented yet.
6770	</result>
6771	</desc>
6772	<param name="id" type="uuid" mod="string" dir="in">
6773	<desc>UUID of the snapshot to delete, including all its children.</desc>
6774	</param>
6775	<param name="progress" type="IProgress" dir="return">
6776	<desc>Progress object to track the operation completion.</desc>
6777	</param>
6778	</method>
6779
6780	<method name="restoreSnapshot">
6781	<desc>
6782	Starts resetting the machine's current state to the state contained
6783	in the given snapshot, asynchronously. All current settings of the
6784	machine will be reset and changes stored in differencing media
6785	will be lost.
6786	See <link to="ISnapshot" /> for an introduction to snapshots.
6787
6788	After this operation is successfully completed, new empty differencing
6789	media are created for all normal media of the machine.
6790
6791	If the given snapshot is an online snapshot, the machine will go to
6792	the <link to="MachineState_Saved"> saved state</link>, so that the
6793	next time it is powered on, the execution state will be restored
6794	from the state of the snapshot.
6795
6796	<note>
6797	The machine must not be running, otherwise the operation will fail.
6798	</note>
6799
6800	<note>
6801	If the machine state is <link to="MachineState_Saved">Saved</link>
6802	prior to this operation, the saved state file will be implicitly
6803	deleted (as if <link to="IConsole::discardSavedState"/> were
6804	called).
6805	</note>
6806
6807	<result name="VBOX_E_INVALID_VM_STATE">
6808	Virtual machine is running.
6809	</result>
6810	</desc>
6811	<param name="snapshot" type="ISnapshot" dir="in">
6812	<desc>The snapshot to restore the VM state from.</desc>
6813	</param>
6814	<param name="progress" type="IProgress" dir="return">
6815	<desc>Progress object to track the operation completion.</desc>
6816	</param>
6817	</method>
6818
6819	<method name="teleport">
6820	<desc>
6821	Teleport the VM to a different host machine or process.
6822
6823	TODO explain the details.
6824
6825	<result name="VBOX_E_INVALID_VM_STATE">
6826	Virtual machine not running or paused.
6827	</result>
6828	</desc>
6829	<param name="hostname" type="wstring" dir="in">
6830	<desc>The name or IP of the host to teleport to.</desc>
6831	</param>
6832	<param name="tcpport" type="unsigned long" dir="in">
6833	<desc>The TCP port to connect to (1..65535).</desc>
6834	</param>
6835	<param name="password" type="wstring" dir="in">
6836	<desc>The password.</desc>
6837	</param>
6838	<param name="maxDowntime" type="unsigned long" dir="in">
6839	<desc>
6840	The maximum allowed downtime given as milliseconds. 0 is not a valid
6841	value. Recommended value: 250 ms.
6842
6843	The higher the value is, the greater the chance for a successful
6844	teleportation. A small value may easily result in the teleportation
6845	process taking hours and eventually fail.
6846
6847	<note>
6848	The current implementation treats this a guideline, not as an
6849	absolute rule.
6850	</note>
6851	</desc>
6852	</param>
6853	<param name="progress" type="IProgress" dir="return">
6854	<desc>Progress object to track the operation completion.</desc>
6855	</param>
6856	</method>
6857
6858	</interface>
6859
6860	<!--
6861	// IHost
6862	/////////////////////////////////////////////////////////////////////////
6863	-->
6864
6865	<enum
6866	name="HostNetworkInterfaceMediumType"
6867	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6868	>
6869	<desc>
6870	Type of encapsulation. Ethernet encapsulation includes both wired and
6871	wireless Ethernet connections.
6872	<see><link to="IHostNetworkInterface"/></see>
6873	</desc>
6874
6875	<const name="Unknown" value="0">
6876	<desc>
6877	The type of interface cannot be determined.
6878	</desc>
6879	</const>
6880	<const name="Ethernet" value="1">
6881	<desc>
6882	Ethernet frame encapsulation.
6883	</desc>
6884	</const>
6885	<const name="PPP" value="2">
6886	<desc>
6887	Point-to-point protocol encapsulation.
6888	</desc>
6889	</const>
6890	<const name="SLIP" value="3">
6891	<desc>
6892	Serial line IP encapsulation.
6893	</desc>
6894	</const>
6895	</enum>
6896
6897	<enum
6898	name="HostNetworkInterfaceStatus"
6899	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6900	>
6901	<desc>
6902	Current status of the interface.
6903	<see><link to="IHostNetworkInterface"/></see>
6904	</desc>
6905
6906	<const name="Unknown" value="0">
6907	<desc>
6908	The state of interface cannot be determined.
6909	</desc>
6910	</const>
6911	<const name="Up" value="1">
6912	<desc>
6913	The interface is fully operational.
6914	</desc>
6915	</const>
6916	<const name="Down" value="2">
6917	<desc>
6918	The interface is not functioning.
6919	</desc>
6920	</const>
6921	</enum>
6922
6923	<enum
6924	name="HostNetworkInterfaceType"
6925	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6926	>
6927	<desc>
6928	Network interface type.
6929	</desc>
6930	<const name="Bridged" value="1"/>
6931	<const name="HostOnly" value="2"/>
6932	</enum>
6933
6934	<interface
6935	name="IHostNetworkInterface" extends="$unknown"
6936	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6937	wsmap="managed"
6938	>
6939	<desc>
6940	Represents one of host's network interfaces. IP V6 address and network
6941	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6942	separated by colons.
6943	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6944	</desc>
6945	<attribute name="name" type="wstring" readonly="yes">
6946	<desc>Returns the host network interface name.</desc>
6947	</attribute>
6948
6949	<attribute name="id" type="uuid" mod="string" readonly="yes">
6950	<desc>Returns the interface UUID.</desc>
6951	</attribute>
6952
6953	<attribute name="networkName" type="wstring" readonly="yes">
6954	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6955	</attribute>
6956
6957	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6958	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6959	</attribute>
6960
6961	<attribute name="IPAddress" type="wstring" readonly="yes">
6962	<desc>Returns the IP V4 address of the interface.</desc>
6963	</attribute>
6964
6965	<attribute name="networkMask" type="wstring" readonly="yes">
6966	<desc>Returns the network mask of the interface.</desc>
6967	</attribute>
6968
6969	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6970	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6971	</attribute>
6972
6973	<attribute name="IPV6Address" type="wstring" readonly="yes">
6974	<desc>Returns the IP V6 address of the interface.</desc>
6975	</attribute>
6976
6977	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6978	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6979	</attribute>
6980
6981	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6982	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6983	</attribute>
6984
6985	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6986	<desc>Type of protocol encapsulation used.</desc>
6987	</attribute>
6988
6989	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6990	<desc>Status of the interface.</desc>
6991	</attribute>
6992
6993	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6994	<desc>specifies the host interface type.</desc>
6995	</attribute>
6996
6997	<method name="enableStaticIpConfig">
6998	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6999	<param name="IPAddress" type="wstring" dir="in">
7000	<desc>
7001	IP address.
7002	</desc>
7003	</param>
7004	<param name="networkMask" type="wstring" dir="in">
7005	<desc>
7006	network mask.
7007	</desc>
7008	</param>
7009	</method>
7010
7011	<method name="enableStaticIpConfigV6">
7012	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7013	<param name="IPV6Address" type="wstring" dir="in">
7014	<desc>
7015	IP address.
7016	</desc>
7017	</param>
7018	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7019	<desc>
7020	network mask.
7021	</desc>
7022	</param>
7023	</method>
7024
7025	<method name="enableDynamicIpConfig">
7026	<desc>enables the dynamic IP configuration.</desc>
7027	</method>
7028
7029	<method name="dhcpRediscover">
7030	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7031	</method>
7032
7033	</interface>
7034
7035	<interface
7036	name="IHost" extends="$unknown"
7037	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7038	wsmap="managed"
7039	>
7040	<desc>
7041	The IHost interface represents the physical machine that this VirtualBox
7042	installation runs on.
7043
7044	An object implementing this interface is returned by the
7045	<link to="IVirtualBox::host" /> attribute. This interface contains
7046	read-only information about the host's physical hardware (such as what
7047	processors and disks are available, what the host operating system is,
7048	and so on) and also allows for manipulating some of the host's hardware,
7049	such as global USB device filters and host interface networking.
7050
7051	</desc>
7052	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7053	<desc>List of DVD drives available on the host.</desc>
7054	</attribute>
7055
7056	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7057	<desc>List of floppy drives available on the host.</desc>
7058	</attribute>
7059
7060	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7061	<desc>
7062	List of USB devices currently attached to the host.
7063	Once a new device is physically attached to the host computer,
7064	it appears in this list and remains there until detached.
7065
7066	<note>
7067	If USB functionality is not available in the given edition of
7068	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7069	</note>
7070	</desc>
7071	</attribute>
7072
7073	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7074	<desc>
7075	List of USB device filters in action.
7076	When a new device is physically attached to the host computer,
7077	filters from this list are applied to it (in order they are stored
7078	in the list). The first matched filter will determine the
7079	<link to="IHostUSBDeviceFilter::action">action</link>
7080	performed on the device.
7081
7082	Unless the device is ignored by these filters, filters of all
7083	currently running virtual machines
7084	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7085
7086	<note>
7087	If USB functionality is not available in the given edition of
7088	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7089	</note>
7090
7091	<see><link to="IHostUSBDeviceFilter"/>,
7092	<link to="USBDeviceState"/></see>
7093	</desc>
7094	</attribute>
7095
7096	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7097	<desc>List of host network interfaces currently defined on the host.</desc>
7098	</attribute>
7099
7100	<attribute name="processorCount" type="unsigned long" readonly="yes">
7101	<desc>Number of (logical) CPUs installed in the host system.</desc>
7102	</attribute>
7103
7104	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7105	<desc>Number of (logical) CPUs online in the host system.</desc>
7106	</attribute>
7107
7108	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7109	<desc>Number of physical processor cores installed in the host system.</desc>
7110	</attribute>
7111
7112	<method name="getProcessorSpeed">
7113	<desc>Query the (approximate) maximum speed of a specified host CPU in
7114	Megahertz.
7115	</desc>
7116	<param name="cpuId" type="unsigned long" dir="in">
7117	<desc>
7118	Identifier of the CPU.
7119	</desc>
7120	</param>
7121	<param name="speed" type="unsigned long" dir="return">
7122	<desc>
7123	Speed value. 0 is returned if value is not known or @a cpuId is
7124	invalid.
7125	</desc>
7126	</param>
7127	</method>
7128
7129	<method name="getProcessorFeature">
7130	<desc>Query whether a CPU feature is supported or not.</desc>
7131	<param name="feature" type="ProcessorFeature" dir="in">
7132	<desc>
7133	CPU Feature identifier.
7134	</desc>
7135	</param>
7136	<param name="supported" type="boolean" dir="return">
7137	<desc>
7138	Feature is supported or not.
7139	</desc>
7140	</param>
7141	</method>
7142
7143	<method name="getProcessorDescription">
7144	<desc>Query the model string of a specified host CPU.
7145	</desc>
7146	<param name="cpuId" type="unsigned long" dir="in">
7147	<desc>
7148	Identifier of the CPU.
7149	<note>
7150	The current implementation might not necessarily return the
7151	description for this exact CPU.
7152	</note>
7153	</desc>
7154	</param>
7155	<param name="description" type="wstring" dir="return">
7156	<desc>
7157	Model string. An empty string is returned if value is not known or
7158	@a cpuId is invalid.
7159	</desc>
7160	</param>
7161	</method>
7162
7163	<method name="getProcessorCPUIDLeaf">
7164	<desc>
7165	Returns the CPU cpuid information for the specified leaf.
7166	</desc>
7167	<param name="cpuId" type="unsigned long" dir="in">
7168	<desc>
7169	Identifier of the CPU. The CPU most be online.
7170	<note>
7171	The current implementation might not necessarily return the
7172	description for this exact CPU.
7173	</note>
7174	</desc>
7175	</param>
7176	<param name="leaf" type="unsigned long" dir="in">
7177	<desc>
7178	CPUID leaf index (eax).
7179	</desc>
7180	</param>
7181	<param name="subLeaf" type="unsigned long" dir="in">
7182	<desc>
7183	CPUID leaf sub index (ecx). This currently only applies to cache
7184	information on Intel CPUs. Use 0 if retrieving values for
7185	<link to="IMachine::setCPUIDLeaf"/>.
7186	</desc>
7187	</param>
7188	<param name="valEax" type="unsigned long" dir="out">
7189	<desc>
7190	CPUID leaf value for register eax.
7191	</desc>
7192	</param>
7193	<param name="valEbx" type="unsigned long" dir="out">
7194	<desc>
7195	CPUID leaf value for register ebx.
7196	</desc>
7197	</param>
7198	<param name="valEcx" type="unsigned long" dir="out">
7199	<desc>
7200	CPUID leaf value for register ecx.
7201	</desc>
7202	</param>
7203	<param name="valEdx" type="unsigned long" dir="out">
7204	<desc>
7205	CPUID leaf value for register edx.
7206	</desc>
7207	</param>
7208	</method>
7209
7210	<attribute name="memorySize" type="unsigned long" readonly="yes">
7211	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7212	</attribute>
7213
7214	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7215	<desc>Available system memory in the host system.</desc>
7216	</attribute>
7217
7218	<attribute name="operatingSystem" type="wstring" readonly="yes">
7219	<desc>Name of the host system's operating system.</desc>
7220	</attribute>
7221
7222	<attribute name="OSVersion" type="wstring" readonly="yes">
7223	<desc>Host operating system's version string.</desc>
7224	</attribute>
7225
7226	<attribute name="UTCTime" type="long long" readonly="yes">
7227	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7228	</attribute>
7229
7230	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7231	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7232	</attribute>
7233
7234	<method name="createHostOnlyNetworkInterface">
7235	<desc>
7236	Creates a new adapter for Host Only Networking.
7237	<result name="E_INVALIDARG">
7238	Host network interface @a name already exists.
7239	</result>
7240	</desc>
7241	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7242	<desc>
7243	Created host interface object.
7244	</desc>
7245	</param>
7246	<param name="progress" type="IProgress" dir="return">
7247	<desc>
7248	Progress object to track the operation completion.
7249	</desc>
7250	</param>
7251	</method>
7252
7253	<method name="removeHostOnlyNetworkInterface">
7254	<desc>
7255	Removes the given Host Only Networking interface.
7256	<result name="VBOX_E_OBJECT_NOT_FOUND">
7257	No host network interface matching @a id found.
7258	</result>
7259	</desc>
7260	<param name="id" type="uuid" mod="string" dir="in">
7261	<desc>
7262	Adapter GUID.
7263	</desc>
7264	</param>
7265	<param name="progress" type="IProgress" dir="return">
7266	<desc>
7267	Progress object to track the operation completion.
7268	</desc>
7269	</param>
7270	</method>
7271
7272	<method name="createUSBDeviceFilter">
7273	<desc>
7274	Creates a new USB device filter. All attributes except
7275	the filter name are set to empty (any match),
7276	<i>active</i> is @c false (the filter is not active).
7277
7278	The created filter can be added to the list of filters using
7279	<link to="#insertUSBDeviceFilter"/>.
7280
7281	<see><link to="#USBDeviceFilters"/></see>
7282	</desc>
7283	<param name="name" type="wstring" dir="in">
7284	<desc>
7285	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7286	</desc>
7287	</param>
7288	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7289	<desc>Created filter object.</desc>
7290	</param>
7291	</method>
7292
7293	<method name="insertUSBDeviceFilter">
7294	<desc>
7295	Inserts the given USB device to the specified position
7296	in the list of filters.
7297
7298	Positions are numbered starting from @c 0. If the specified
7299	position is equal to or greater than the number of elements in
7300	the list, the filter is added at the end of the collection.
7301
7302	<note>
7303	Duplicates are not allowed, so an attempt to insert a
7304	filter already in the list is an error.
7305	</note>
7306	<note>
7307	If USB functionality is not available in the given edition of
7308	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7309	</note>
7310
7311	<see><link to="#USBDeviceFilters"/></see>
7312
7313	<result name="VBOX_E_INVALID_OBJECT_STATE">
7314	USB device filter is not created within this VirtualBox instance.
7315	</result>
7316	<result name="E_INVALIDARG">
7317	USB device filter already in list.
7318	</result>
7319
7320	</desc>
7321	<param name="position" type="unsigned long" dir="in">
7322	<desc>Position to insert the filter to.</desc>
7323	</param>
7324	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7325	<desc>USB device filter to insert.</desc>
7326	</param>
7327	</method>
7328
7329	<method name="removeUSBDeviceFilter">
7330	<desc>
7331	Removes a USB device filter from the specified position in the
7332	list of filters.
7333
7334	Positions are numbered starting from @c 0. Specifying a
7335	position equal to or greater than the number of elements in
7336	the list will produce an error.
7337
7338	<note>
7339	If USB functionality is not available in the given edition of
7340	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7341	</note>
7342
7343	<see><link to="#USBDeviceFilters"/></see>
7344
7345	<result name="E_INVALIDARG">
7346	USB device filter list empty or invalid @a position.
7347	</result>
7348
7349	</desc>
7350	<param name="position" type="unsigned long" dir="in">
7351	<desc>Position to remove the filter from.</desc>
7352	</param>
7353	</method>
7354
7355	<method name="findHostDVDDrive">
7356	<desc>
7357	Searches for a host DVD drive with the given @c name.
7358
7359	<result name="VBOX_E_OBJECT_NOT_FOUND">
7360	Given @c name does not correspond to any host drive.
7361	</result>
7362
7363	</desc>
7364	<param name="name" type="wstring" dir="in">
7365	<desc>Name of the host drive to search for</desc>
7366	</param>
7367	<param name="drive" type="IMedium" dir="return">
7368	<desc>Found host drive object</desc>
7369	</param>
7370	</method>
7371
7372	<method name="findHostFloppyDrive">
7373	<desc>
7374	Searches for a host floppy drive with the given @c name.
7375
7376	<result name="VBOX_E_OBJECT_NOT_FOUND">
7377	Given @c name does not correspond to any host floppy drive.
7378	</result>
7379
7380	</desc>
7381	<param name="name" type="wstring" dir="in">
7382	<desc>Name of the host floppy drive to search for</desc>
7383	</param>
7384	<param name="drive" type="IMedium" dir="return">
7385	<desc>Found host floppy drive object</desc>
7386	</param>
7387	</method>
7388
7389	<method name="findHostNetworkInterfaceByName">
7390	<desc>
7391	Searches through all host network interfaces for an interface with
7392	the given @c name.
7393	<note>
7394	The method returns an error if the given @c name does not
7395	correspond to any host network interface.
7396	</note>
7397	</desc>
7398	<param name="name" type="wstring" dir="in">
7399	<desc>Name of the host network interface to search for.</desc>
7400	</param>
7401	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7402	<desc>Found host network interface object.</desc>
7403	</param>
7404	</method>
7405	<method name="findHostNetworkInterfaceById">
7406	<desc>
7407	Searches through all host network interfaces for an interface with
7408	the given GUID.
7409	<note>
7410	The method returns an error if the given GUID does not
7411	correspond to any host network interface.
7412	</note>
7413	</desc>
7414	<param name="id" type="uuid" mod="string" dir="in">
7415	<desc>GUID of the host network interface to search for.</desc>
7416	</param>
7417	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7418	<desc>Found host network interface object.</desc>
7419	</param>
7420	</method>
7421	<method name="findHostNetworkInterfacesOfType">
7422	<desc>
7423	Searches through all host network interfaces and returns a list of interfaces of the specified type
7424	</desc>
7425	<param name="type" type="HostNetworkInterfaceType" dir="in">
7426	<desc>type of the host network interfaces to search for.</desc>
7427	</param>
7428	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7429	<desc>Found host network interface objects.</desc>
7430	</param>
7431	</method>
7432
7433	<method name="findUSBDeviceById">
7434	<desc>
7435	Searches for a USB device with the given UUID.
7436
7437	<result name="VBOX_E_OBJECT_NOT_FOUND">
7438	Given @c id does not correspond to any USB device.
7439	</result>
7440
7441	<see><link to="IUSBDevice::id"/></see>
7442	</desc>
7443	<param name="id" type="uuid" mod="string" dir="in">
7444	<desc>UUID of the USB device to search for.</desc>
7445	</param>
7446	<param name="device" type="IHostUSBDevice" dir="return">
7447	<desc>Found USB device object.</desc>
7448	</param>
7449	</method>
7450
7451	<method name="findUSBDeviceByAddress">
7452	<desc>
7453	Searches for a USB device with the given host address.
7454
7455	<result name="VBOX_E_OBJECT_NOT_FOUND">
7456	Given @c name does not correspond to any USB device.
7457	</result>
7458
7459	<see><link to="IUSBDevice::address"/></see>
7460	</desc>
7461	<param name="name" type="wstring" dir="in">
7462	<desc>
7463	Address of the USB device (as assigned by the host) to
7464	search for.
7465	</desc>
7466	</param>
7467	<param name="device" type="IHostUSBDevice" dir="return">
7468	<desc>Found USB device object.</desc>
7469	</param>
7470	</method>
7471
7472	<method name="generateMACAddress">
7473	<desc>
7474	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7475	</desc>
7476	<param name="address" type="wstring" dir="return">
7477	<desc>New Ethernet MAC address.</desc>
7478	</param>
7479	</method>
7480
7481	</interface>
7482
7483	<!--
7484	// ISystemProperties
7485	/////////////////////////////////////////////////////////////////////////
7486	-->
7487
7488	<interface
7489	name="ISystemProperties"
7490	extends="$unknown"
7491	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7492	wsmap="managed"
7493	>
7494	<desc>
7495	The ISystemProperties interface represents global properties of the given
7496	VirtualBox installation.
7497
7498	These properties define limits and default values for various attributes
7499	and parameters. Most of the properties are read-only, but some can be
7500	changed by a user.
7501	</desc>
7502
7503	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7504	<desc>Minimum guest system memory in Megabytes.</desc>
7505	</attribute>
7506
7507	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7508	<desc>Maximum guest system memory in Megabytes.</desc>
7509	</attribute>
7510
7511	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7512	<desc>Minimum guest video memory in Megabytes.</desc>
7513	</attribute>
7514
7515	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7516	<desc>Maximum guest video memory in Megabytes.</desc>
7517	</attribute>
7518
7519	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7520	<desc>Minimum CPU count.</desc>
7521	</attribute>
7522
7523	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7524	<desc>Maximum CPU count.</desc>
7525	</attribute>
7526
7527	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7528	<desc>Maximum of monitors which could be connected.</desc>
7529	</attribute>
7530
7531	<attribute name="infoVDSize" type="long long" readonly="yes">
7532	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7533	does not reflect the limits of any virtual disk image format.</desc>
7534	</attribute>
7535
7536	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7537	<desc>
7538	Maximum number of serial ports associated with every
7539	<link to="IMachine"/> instance.
7540	</desc>
7541	</attribute>
7542
7543	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7544	<desc>
7545	Maximum number of parallel ports associated with every
7546	<link to="IMachine"/> instance.
7547	</desc>
7548	</attribute>
7549
7550	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7551	<desc>
7552	Maximum device position in the boot order. This value corresponds
7553	to the total number of devices a machine can boot from, to make it
7554	possible to include all possible devices to the boot list.
7555	<see><link to="IMachine::setBootOrder"/></see>
7556	</desc>
7557	</attribute>
7558
7559	<attribute name="defaultMachineFolder" type="wstring">
7560	<desc>
7561	Full path to the default directory used to create new or open
7562	existing machines when a machine settings file name contains no
7563	path.
7564
7565	Starting with VirtualBox 4.0, by default, this attribute contains
7566	the full path of folder named "VirtualBox VMs" in the user's
7567	home directory, which depends on the host platform.
7568
7569	When setting this attribute, a full path must be specified.
7570	Setting this property to @c null or an empty string or the
7571	special value "Machines" (for compatibility reasons) will restore
7572	that default value.
7573
7574	If the folder specified herein does not exist, it will be created
7575	automatically as needed.
7576
7577	<see>
7578	<link to="IVirtualBox::createMachine"/>,
7579	<link to="IVirtualBox::openMachine"/>
7580	</see>
7581	</desc>
7582	</attribute>
7583
7584	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7585	<desc>
7586	List of all medium storage formats supported by this VirtualBox
7587	installation.
7588
7589	Keep in mind that the medium format identifier
7590	(<link to="IMediumFormat::id"/>) used in other API calls like
7591	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7592	medium format is a case-insensitive string. This means that, for
7593	example, all of the following strings:
7594	<pre>
7595	"VDI"
7596	"vdi"
7597	"VdI"</pre>
7598	refer to the same medium format.
7599
7600	Note that the virtual medium framework is backend-based, therefore
7601	the list of supported formats depends on what backends are currently
7602	installed.
7603
7604	<see><link to="IMediumFormat"/></see>
7605	</desc>
7606	</attribute>
7607
7608	<attribute name="defaultHardDiskFormat" type="wstring">
7609	<desc>
7610	Identifier of the default medium format used by VirtualBox.
7611
7612	The medium format set by this attribute is used by VirtualBox
7613	when the medium format was not specified explicitly. One example is
7614	<link to="IVirtualBox::createHardDisk"/> with the empty
7615	format argument. A more complex example is implicit creation of
7616	differencing media when taking a snapshot of a virtual machine:
7617	this operation will try to use a format of the parent medium first
7618	and if this format does not support differencing media the default
7619	format specified by this argument will be used.
7620
7621	The list of supported medium formats may be obtained by the
7622	<link to="#mediumFormats"/> call. Note that the default medium
7623	format must have a capability to create differencing media;
7624	otherwise operations that create media implicitly may fail
7625	unexpectedly.
7626
7627	The initial value of this property is <tt>"VDI"</tt> in the current
7628	version of the VirtualBox product, but may change in the future.
7629
7630	<note>
7631	Setting this property to @c null or empty string will restore the
7632	initial value.
7633	</note>
7634
7635	<see>
7636	<link to="#mediumFormats"/>,
7637	<link to="IMediumFormat::id"/>,
7638	<link to="IVirtualBox::createHardDisk"/>
7639	</see>
7640	</desc>
7641	</attribute>
7642
7643	<attribute name="freeDiskSpaceWarning" type="long long">
7644	<desc>Issue a warning if the free disk space is below (or in some disk
7645	intensive operation is expected to go below) the given size in
7646	bytes.</desc>
7647	</attribute>
7648
7649	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7650	<desc>Issue a warning if the free disk space is below (or in some disk
7651	intensive operation is expected to go below) the given percentage.</desc>
7652	</attribute>
7653
7654	<attribute name="freeDiskSpaceError" type="long long">
7655	<desc>Issue an error if the free disk space is below (or in some disk
7656	intensive operation is expected to go below) the given size in
7657	bytes.</desc>
7658	</attribute>
7659
7660	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7661	<desc>Issue an error if the free disk space is below (or in some disk
7662	intensive operation is expected to go below) the given percentage.</desc>
7663	</attribute>
7664
7665	<attribute name="VRDEAuthLibrary" type="wstring">
7666	<desc>
7667	Library that provides authentication for Remote Desktop clients. The library
7668	is used if a virtual machine's authentication type is set to "external"
7669	in the VM RemoteDisplay configuration.
7670
7671	The system library extension (".DLL" or ".so") must be omitted.
7672	A full path can be specified; if not, then the library must reside on the
7673	system's default library path.
7674
7675	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7676	of that name in one of the default VirtualBox library directories.
7677
7678	For details about VirtualBox authentication libraries and how to implement
7679	them, please refer to the VirtualBox manual.
7680
7681	<note>
7682	Setting this property to @c null or empty string will restore the
7683	initial value.
7684	</note>
7685	</desc>
7686	</attribute>
7687
7688	<attribute name="webServiceAuthLibrary" type="wstring">
7689	<desc>
7690	Library that provides authentication for webservice clients. The library
7691	is used if a virtual machine's authentication type is set to "external"
7692	in the VM RemoteDisplay configuration and will be called from
7693	within the <link to="IWebsessionManager::logon" /> implementation.
7694
7695	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7696	there is no per-VM setting for this, as the webservice is a global
7697	resource (if it is running). Only for this setting (for the webservice),
7698	setting this value to a literal <tt>"null"</tt> string disables authentication,
7699	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7700	no matter what user name and password are supplied.
7701
7702	The initial value of this property is <tt>"VBoxAuth"</tt>,
7703	meaning that the webservice will use the same authentication
7704	library that is used by default for VRDE (again, see
7705	<link to="ISystemProperties::VRDEAuthLibrary" />).
7706	The format and calling convention of authentication libraries
7707	is the same for the webservice as it is for VRDE.
7708
7709	<note>
7710	Setting this property to @c null or empty string will restore the
7711	initial value.
7712	</note>
7713	</desc>
7714	</attribute>
7715
7716	<attribute name="defaultVRDEExtPack" type="wstring">
7717	<desc>
7718	The name of the extension pack providing the default VRDE.
7719
7720	This attribute is for choosing between multiple extension packs
7721	providing VRDE. If only one is installed, it will automatically be the
7722	default one. The attribute value can be empty if no VRDE extension
7723	pack is installed.
7724
7725	For details about VirtualBox Remote Desktop Extension and how to
7726	implement one, please refer to the VirtualBox SDK.
7727	</desc>
7728	</attribute>
7729
7730	<attribute name="logHistoryCount" type="unsigned long">
7731	<desc>
7732	This value specifies how many old release log files are kept.
7733	</desc>
7734	</attribute>
7735
7736	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7737	<desc>This value hold the default audio driver for the current
7738	system.</desc>
7739	</attribute>
7740
7741
7742	<method name="getMaxNetworkAdapters">
7743	<desc>
7744	Maximum total number of network adapters associated with every
7745	<link to="IMachine"/> instance.
7746	</desc>
7747
7748	<param name="chipset" type="ChipsetType" dir="in">
7749	<desc>The chipset type to get the value for.</desc>
7750	</param>
7751
7752
7753	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7754	<desc>The maximum total number of network adapters allowed.</desc>
7755	</param>
7756
7757	</method>
7758
7759	<method name="getMaxNetworkAdaptersOfType">
7760	<desc>
7761	Maximum number of network adapters of a given attachment type,
7762	associated with every <link to="IMachine"/> instance.
7763	</desc>
7764
7765	<param name="chipset" type="ChipsetType" dir="in">
7766	<desc>The chipset type to get the value for.</desc>
7767	</param>
7768
7769	<param name="type" type="NetworkAttachmentType" dir="in">
7770	<desc>Type of attachment.</desc>
7771	</param>
7772
7773	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7774	<desc>The maximum number of network adapters allowed for
7775	particular chipset and attachment type.</desc>
7776	</param>
7777
7778	</method>
7779
7780
7781	<method name="getMaxDevicesPerPortForStorageBus">
7782	<desc>Returns the maximum number of devices which can be attached to a port
7783	for the given storage bus.</desc>
7784
7785	<param name="bus" type="StorageBus" dir="in">
7786	<desc>The storage bus type to get the value for.</desc>
7787	</param>
7788
7789	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7790	<desc>The maximum number of devices which can be attached to the port for the given
7791	storage bus.</desc>
7792	</param>
7793	</method>
7794
7795	<method name="getMinPortCountForStorageBus">
7796	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7797
7798	<param name="bus" type="StorageBus" dir="in">
7799	<desc>The storage bus type to get the value for.</desc>
7800	</param>
7801
7802	<param name="minPortCount" type="unsigned long" dir="return">
7803	<desc>The minimum number of ports for the given storage bus.</desc>
7804	</param>
7805	</method>
7806
7807	<method name="getMaxPortCountForStorageBus">
7808	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7809
7810	<param name="bus" type="StorageBus" dir="in">
7811	<desc>The storage bus type to get the value for.</desc>
7812	</param>
7813
7814	<param name="maxPortCount" type="unsigned long" dir="return">
7815	<desc>The maximum number of ports for the given storage bus.</desc>
7816	</param>
7817	</method>
7818
7819	<method name="getMaxInstancesOfStorageBus">
7820	<desc>Returns the maximum number of storage bus instances which
7821	can be configured for each VM. This corresponds to the number of
7822	storage controllers one can have. Value may depend on chipset type
7823	used.</desc>
7824
7825	<param name="chipset" type="ChipsetType" dir="in">
7826	<desc>The chipset type to get the value for.</desc>
7827	</param>
7828
7829	<param name="bus" type="StorageBus" dir="in">
7830	<desc>The storage bus type to get the value for.</desc>
7831	</param>
7832
7833	<param name="maxInstances" type="unsigned long" dir="return">
7834	<desc>The maximum number of instances for the given storage bus.</desc>
7835	</param>
7836	</method>
7837
7838	<method name="getDeviceTypesForStorageBus">
7839	<desc>Returns list of all the supported device types
7840	(<link to="DeviceType"/>) for the given type of storage
7841	bus.</desc>
7842
7843	<param name="bus" type="StorageBus" dir="in">
7844	<desc>The storage bus type to get the value for.</desc>
7845	</param>
7846
7847	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7848	<desc>The list of all supported device types for the given storage bus.</desc>
7849	</param>
7850	</method>
7851
7852	<method name="getDefaultIoCacheSettingForStorageController">
7853	<desc>Returns the default I/O cache setting for the
7854	given storage controller</desc>
7855
7856	<param name="controllerType" type="StorageControllerType" dir="in">
7857	<desc>The storage controller to the setting for.</desc>
7858	</param>
7859
7860	<param name="enabled" type="boolean" dir="return">
7861	<desc>Returned flag indicating the default value</desc>
7862	</param>
7863	</method>
7864	</interface>
7865
7866	<!--
7867	// IGuest
7868	/////////////////////////////////////////////////////////////////////////
7869	-->
7870
7871	<interface
7872	name="IGuestOSType" extends="$unknown"
7873	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7874	wsmap="struct"
7875	>
7876	<desc>
7877	</desc>
7878
7879	<attribute name="familyId" type="wstring" readonly="yes">
7880	<desc>Guest OS family identifier string.</desc>
7881	</attribute>
7882
7883	<attribute name="familyDescription" type="wstring" readonly="yes">
7884	<desc>Human readable description of the guest OS family.</desc>
7885	</attribute>
7886
7887	<attribute name="id" type="wstring" readonly="yes">
7888	<desc>Guest OS identifier string.</desc>
7889	</attribute>
7890
7891	<attribute name="description" type="wstring" readonly="yes">
7892	<desc>Human readable description of the guest OS.</desc>
7893	</attribute>
7894
7895	<attribute name="is64Bit" type="boolean" readonly="yes">
7896	<desc>Returns @c true if the given OS is 64-bit</desc>
7897	</attribute>
7898
7899	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7900	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7901	</attribute>
7902
7903	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7904	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7905	</attribute>
7906
7907	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7908	<desc>Recommended RAM size in Megabytes.</desc>
7909	</attribute>
7910
7911	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7912	<desc>Recommended video RAM size in Megabytes.</desc>
7913	</attribute>
7914
7915	<attribute name="recommendedHDD" type="long long" readonly="yes">
7916	<desc>Recommended hard disk size in bytes.</desc>
7917	</attribute>
7918
7919	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7920	<desc>Returns recommended network adapter for this OS type.</desc>
7921	</attribute>
7922
7923	<attribute name="recommendedPae" type="boolean" readonly="yes">
7924	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7925	</attribute>
7926
7927	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7928	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7929	</attribute>
7930
7931	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7932	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7933	</attribute>
7934
7935	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7936	<desc>Recommended storage controller type for HD drives.</desc>
7937	</attribute>
7938
7939	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7940	<desc>Recommended storage bus type for HD drives.</desc>
7941	</attribute>
7942
7943	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7944	<desc>Recommended firmware type.</desc>
7945	</attribute>
7946
7947	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7948	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7949	</attribute>
7950
7951	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7952	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7953	</attribute>
7954
7955	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7956	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7957	</attribute>
7958
7959	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7960	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7961	</attribute>
7962
7963	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7964	<desc>Recommended chipset type.</desc>
7965	</attribute>
7966
7967	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7968	<desc>Recommended audio type.</desc>
7969	</attribute>
7970
7971	</interface>
7972
7973	<enum
7974	name="AdditionsFacilityType"
7975	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
7976	>
7977	<desc>
7978	Guest Additions facility IDs.
7979	</desc>
7980
7981	<const name="None" value="0">
7982	<desc>No/invalid facility.</desc>
7983	</const>
7984	<const name="VBoxGuestDriver" value="20">
7985	<desc>VirtualBox base driver (VBoxGuest).</desc>
7986	</const>
7987	<const name="VBoxService" value="100">
7988	<desc>VirtualBox system service (VBoxService).</desc>
7989	</const>
7990	<const name="VBoxTrayClient" value="101">
7991	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
7992	</const>
7993	<const name="Seamless" value="1000">
7994	<desc>Seamless guest desktop integration.</desc>
7995	</const>
7996	<const name="Graphics" value="1100">
7997	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
7998	are not immediately acted on and guest display resizes are probably not initiated by
7999	the guest additions.
8000	</desc>
8001	</const>
8002	<const name="All" value="2147483646">
8003	<desc>All facilities selected.</desc>
8004	</const>
8005	</enum>
8006
8007	<enum
8008	name="AdditionsFacilityClass"
8009	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8010	>
8011	<desc>
8012	Guest Additions facility classes.
8013	</desc>
8014
8015	<const name="None" value="0">
8016	<desc>No/invalid class.</desc>
8017	</const>
8018	<const name="Driver" value="10">
8019	<desc>Driver.</desc>
8020	</const>
8021	<const name="Service" value="30">
8022	<desc>System service.</desc>
8023	</const>
8024	<const name="Program" value="50">
8025	<desc>Program.</desc>
8026	</const>
8027	<const name="Feature" value="100">
8028	<desc>Feature.</desc>
8029	</const>
8030	<const name="ThirdParty" value="999">
8031	<desc>Third party.</desc>
8032	</const>
8033	<const name="All" value="2147483646">
8034	<desc>All facility classes selected.</desc>
8035	</const>
8036	</enum>
8037
8038	<enum
8039	name="AdditionsFacilityStatus"
8040	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8041	>
8042	<desc>
8043	Guest Additions facility states.
8044	</desc>
8045
8046	<const name="Inactive" value="0">
8047	<desc>Facility is not active.</desc>
8048	</const>
8049	<const name="Paused" value="1">
8050	<desc>Facility has been paused.</desc>
8051	</const>
8052	<const name="PreInit" value="20">
8053	<desc>Facility is preparing to initialize.</desc>
8054	</const>
8055	<const name="Init" value="30">
8056	<desc>Facility is initializing.</desc>
8057	</const>
8058	<const name="Active" value="50">
8059	<desc>Facility is up and running.</desc>
8060	</const>
8061	<const name="Terminating" value="100">
8062	<desc>Facility is shutting down.</desc>
8063	</const>
8064	<const name="Terminated" value="101">
8065	<desc>Facility successfully shut down.</desc>
8066	</const>
8067	<const name="Failed" value="800">
8068	<desc>Facility failed to start.</desc>
8069	</const>
8070	<const name="Unknown" value="999">
8071	<desc>Facility status is unknown.</desc>
8072	</const>
8073	</enum>
8074
8075	<interface
8076	name="IAdditionsFacility" extends="$unknown"
8077	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8078	wsmap="struct"
8079	>
8080	<desc>
8081	Structure representing a Guest Additions facility.
8082	</desc>
8083
8084	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8085	<desc>The class this facility is part of.</desc>
8086	</attribute>
8087
8088	<attribute name="lastUpdated" type="long long" readonly="yes">
8089	<desc>
8090	Time stamp of the last status update,
8091	in milliseconds since 1970-01-01 UTC.
8092	</desc>
8093	</attribute>
8094
8095	<attribute name="name" type="wstring" readonly="yes">
8096	<desc>The facility's friendly name.</desc>
8097	</attribute>
8098
8099	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8100	<desc>The current status.</desc>
8101	</attribute>
8102
8103	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8104	<desc>The facility's type ID.</desc>
8105	</attribute>
8106	</interface>
8107
8108	<enum
8109	name="AdditionsRunLevelType"
8110	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8111	>
8112	<desc>
8113	Guest Additions run level type.
8114	</desc>
8115
8116	<const name="None" value="0">
8117	<desc>Guest Additions are not loaded.</desc>
8118	</const>
8119	<const name="System" value="1">
8120	<desc>Guest drivers are loaded.</desc>
8121	</const>
8122	<const name="Userland" value="2">
8123	<desc>Common components (such as application services) are loaded.</desc>
8124	</const>
8125	<const name="Desktop" value="3">
8126	<desc>Per-user desktop components are loaded.</desc>
8127	</const>
8128	</enum>
8129
8130	<enum
8131	name="AdditionsUpdateFlag"
8132	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8133	>
8134	<desc>
8135	Guest Additions update flags.
8136	</desc>
8137
8138	<const name="None" value="0">
8139	<desc>No flag set.</desc>
8140	</const>
8141	<const name="WaitForUpdateStartOnly" value="1">
8142	<desc>Only wait for the update process being started and do not
8143	wait while peforming the actual update.</desc>
8144	</const>
8145	</enum>
8146
8147	<enum
8148	name="ExecuteProcessFlag"
8149	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
8150	>
8151	<desc>
8152	Guest process execution flags.
8153	</desc>
8154
8155	<const name="None" value="0">
8156	<desc>No flag set.</desc>
8157	</const>
8158	<const name="WaitForProcessStartOnly" value="1">
8159	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8160	process itself then uses an infinite timeout.</desc>
8161	</const>
8162	<const name="IgnoreOrphanedProcesses" value="2">
8163	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8164	</const>
8165	<const name="Hidden" value="4">
8166	<desc>Don't show the started process according to the guest OS guidelines.</desc>
8167	</const>
8168	</enum>
8169
8170	<enum
8171	name="ExecuteProcessStatus"
8172	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8173	>
8174	<desc>
8175	Guest process execution status.
8176	</desc>
8177	<const name="Undefined" value="0">
8178	<desc>Process is in an undefined state.</desc>
8179	</const>
8180
8181	<const name="Started" value="1">
8182	<desc>Process has been started.</desc>
8183	</const>
8184	<const name="TerminatedNormally" value="2">
8185	<desc>Process terminated normally.</desc>
8186	</const>
8187	<const name="TerminatedSignal" value="3">
8188	<desc>Process terminated via signal.</desc>
8189	</const>
8190	<const name="TerminatedAbnormally" value="4">
8191	<desc>Process terminated abnormally.</desc>
8192	</const>
8193	<const name="TimedOutKilled" value="5">
8194	<desc>Process timed out and was killed.</desc>
8195	</const>
8196	<const name="TimedOutAbnormally" value="6">
8197	<desc>Process timed out and was not killed successfully.</desc>
8198	</const>
8199	<const name="Down" value="7">
8200	<desc>Service/OS is stopping, process was killed.</desc>
8201	</const>
8202	<const name="Error" value="8">
8203	<desc>Something went wrong (error code in flags).</desc>
8204	</const>
8205	</enum>
8206
8207	<enum
8208	name="ProcessInputFlag"
8209	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8210	>
8211	<desc>
8212	Guest process input flags.
8213	</desc>
8214	<const name="None" value="0">
8215	<desc>No flag set.</desc>
8216	</const>
8217	<const name="EndOfFile" value="1">
8218	<desc>End of file (input) reached.</desc>
8219	</const>
8220	</enum>
8221
8222	<enum
8223	name="ProcessOutputFlag"
8224	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8225	>
8226	<desc>
8227	Guest process output flags for specifying which
8228	type of output to retrieve.
8229	</desc>
8230	<const name="None" value="0">
8231	<desc>No flags set. Get output from stdout.</desc>
8232	</const>
8233	<const name="StdErr" value="1">
8234	<desc>Get output from stderr.</desc>
8235	</const>
8236	</enum>
8237
8238	<enum
8239	name="CopyFileFlag"
8240	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8241	>
8242	<desc>
8243	Host/Guest copy flags. At the moment none of these flags
8244	are implemented.
8245	</desc>
8246	<const name="None" value="0">
8247	<desc>No flag set.</desc>
8248	</const>
8249	<const name="Recursive" value="1">
8250	<desc>Copy directories recursively.</desc>
8251	</const>
8252	<const name="Update" value="2">
8253	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8254	</const>
8255	<const name="FollowLinks" value="4">
8256	<desc>Follow symbolic links.</desc>
8257	</const>
8258	</enum>
8259
8260	<enum
8261	name="DirectoryCreateFlag"
8262	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8263	>
8264	<desc>
8265	Directory creation flags.
8266	</desc>
8267	<const name="None" value="0">
8268	<desc>No flag set.</desc>
8269	</const>
8270	<const name="Parents" value="1">
8271	<desc>No error if existing, make parent directories as needed.</desc>
8272	</const>
8273	</enum>
8274
8275	<enum
8276	name="DirectoryOpenFlag"
8277	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8278	>
8279	<desc>
8280	Directory open flags.
8281	</desc>
8282	<const name="None" value="0">
8283	<desc>No flag set.</desc>
8284	</const>
8285	</enum>
8286
8287	<enum
8288	name="GuestDirEntryType"
8289	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8290	>
8291	<desc>
8292	Guest directory entry type.
8293	</desc>
8294	<const name="Unknown" value="0">
8295	<desc>Unknown.</desc>
8296	</const>
8297	<const name="Directory" value="4">
8298	<desc>Regular file.</desc>
8299	</const>
8300	<const name="File" value="10">
8301	<desc>Regular file.</desc>
8302	</const>
8303	<const name="Symlink" value="12">
8304	<desc>Symbolic link.</desc>
8305	</const>
8306	</enum>
8307
8308	<interface
8309	name="IGuestDirEntry" extends="$unknown"
8310	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8311	wsmap="struct"
8312	>
8313	<desc>
8314	Structure representing a directory entry on the guest OS.
8315	</desc>
8316	<attribute name="nodeId" type="long long" readonly="yes">
8317	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8318	</attribute>
8319	<attribute name="name" type="wstring" readonly="yes">
8320	<desc>The filename.</desc>
8321	</attribute>
8322	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8323	<desc>The entry type.</desc>
8324	</attribute>
8325	</interface>
8326
8327	<interface
8328	name="IGuest" extends="$unknown"
8329	uuid="af2766d9-ebff-455f-b5ce-c6f855b8f584"
8330	wsmap="managed"
8331	>
8332	<desc>
8333	The IGuest interface represents information about the operating system
8334	running inside the virtual machine. Used in
8335	<link to="IConsole::guest"/>.
8336
8337	IGuest provides information about the guest operating system, whether
8338	Guest Additions are installed and other OS-specific virtual machine
8339	properties.
8340	</desc>
8341
8342	<attribute name="OSTypeId" type="wstring" readonly="yes">
8343	<desc>
8344	Identifier of the Guest OS type as reported by the Guest
8345	Additions.
8346	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8347	an IGuestOSType object representing details about the given
8348	Guest OS type.
8349	<note>
8350	If Guest Additions are not installed, this value will be
8351	the same as <link to="IMachine::OSTypeId"/>.
8352	</note>
8353	</desc>
8354	</attribute>
8355
8356	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8357	<desc>
8358	Current run level of the Guest Additions.
8359	</desc>
8360	</attribute>
8361
8362	<attribute name="additionsVersion" type="wstring" readonly="yes">
8363	<desc>
8364	Version of the Guest Additions including the revision (3 decimal numbers
8365	separated by dots + revision number) installed on the guest or empty
8366	when the Additions are not installed.
8367	</desc>
8368	</attribute>
8369
8370	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8371	<desc>
8372	Array of current known facilities. Only returns facilities where a status is known,
8373	e.g. facilities with an unknown status will not be returned.
8374	</desc>
8375	</attribute>
8376
8377	<attribute name="memoryBalloonSize" type="unsigned long">
8378	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8379	</attribute>
8380
8381	<attribute name="statisticsUpdateInterval" type="unsigned long">
8382	<desc>Interval to update guest statistics in seconds.</desc>
8383	</attribute>
8384
8385	<method name="internalGetStatistics">
8386	<desc>
8387	Internal method; do not use as it might change at any time.
8388	</desc>
8389	<param name="cpuUser" type="unsigned long" dir="out">
8390	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8391	</param>
8392	<param name="cpuKernel" type="unsigned long" dir="out">
8393	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8394	</param>
8395	<param name="cpuIdle" type="unsigned long" dir="out">
8396	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8397	</param>
8398	<param name="memTotal" type="unsigned long" dir="out">
8399	<desc>Total amount of physical guest RAM.</desc>
8400	</param>
8401	<param name="memFree" type="unsigned long" dir="out">
8402	<desc>Free amount of physical guest RAM.</desc>
8403	</param>
8404	<param name="memBalloon" type="unsigned long" dir="out">
8405	<desc>Amount of ballooned physical guest RAM.</desc>
8406	</param>
8407	<param name="memShared" type="unsigned long" dir="out">
8408	<desc>Amount of shared physical guest RAM.</desc>
8409	</param>
8410	<param name="memCache" type="unsigned long" dir="out">
8411	<desc>Total amount of guest (disk) cache memory.</desc>
8412	</param>
8413	<param name="pagedTotal" type="unsigned long" dir="out">
8414	<desc>Total amount of space in the page file.</desc>
8415	</param>
8416	<param name="memAllocTotal" type="unsigned long" dir="out">
8417	<desc>Total amount of memory allocated by the hypervisor.</desc>
8418	</param>
8419	<param name="memFreeTotal" type="unsigned long" dir="out">
8420	<desc>Total amount of free memory available in the hypervisor.</desc>
8421	</param>
8422	<param name="memBalloonTotal" type="unsigned long" dir="out">
8423	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8424	</param>
8425	<param name="memSharedTotal" type="unsigned long" dir="out">
8426	<desc>Total amount of shared memory in the hypervisor.</desc>
8427	</param>
8428	</method>
8429
8430	<method name="getFacilityStatus">
8431	<desc>
8432	Get the current status of a Guest Additions facility.
8433	</desc>
8434	<param name="facility" type="AdditionsFacilityType" dir="in">
8435	<desc>Facility to check status for.</desc>
8436	</param>
8437	<param name="timestamp" type="long long" dir="out">
8438	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8439	</param>
8440	<param name="status" type="AdditionsFacilityStatus" dir="return">
8441	<desc>The current (latest) facility status.</desc>
8442	</param>
8443	</method>
8444
8445	<method name="getAdditionsStatus">
8446	<desc>
8447	Retrieve the current status of a certain Guest Additions run level.
8448
8449	<result name="VBOX_E_NOT_SUPPORTED">
8450	Wrong status level specified.
8451	</result>
8452
8453	</desc>
8454	<param name="level" type="AdditionsRunLevelType" dir="in">
8455	<desc>Status level to check</desc>
8456	</param>
8457	<param name="active" type="boolean" dir="return">
8458	<desc>Flag whether the status level has been reached or not</desc>
8459	</param>
8460	</method>
8461
8462	<method name="setCredentials">
8463	<desc>
8464	Store login credentials that can be queried by guest operating
8465	systems with Additions installed. The credentials are transient
8466	to the session and the guest may also choose to erase them. Note
8467	that the caller cannot determine whether the guest operating system
8468	has queried or made use of the credentials.
8469
8470	<result name="VBOX_E_VM_ERROR">
8471	VMM device is not available.
8472	</result>
8473
8474	</desc>
8475	<param name="userName" type="wstring" dir="in">
8476	<desc>User name string, can be empty</desc>
8477	</param>
8478	<param name="password" type="wstring" dir="in">
8479	<desc>Password string, can be empty</desc>
8480	</param>
8481	<param name="domain" type="wstring" dir="in">
8482	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8483	</param>
8484	<param name="allowInteractiveLogon" type="boolean" dir="in">
8485	<desc>
8486	Flag whether the guest should alternatively allow the user to
8487	interactively specify different credentials. This flag might
8488	not be supported by all versions of the Additions.
8489	</desc>
8490	</param>
8491	</method>
8492
8493	<method name="executeProcess">
8494	<desc>
8495	Executes an existing program inside the guest VM.
8496
8497	<result name="VBOX_E_IPRT_ERROR">
8498	Could not execute process.
8499	</result>
8500
8501	</desc>
8502	<param name="execName" type="wstring" dir="in">
8503	<desc>
8504	Full path name of the command to execute on the guest; the
8505	commands has to exists in the guest VM in order to be executed.
8506	</desc>
8507	</param>
8508	<param name="flags" type="unsigned long" dir="in">
8509	<desc>
8510	<link to="ExecuteProcessFlag"/> flags.
8511	</desc>
8512	</param>
8513	<param name="arguments" type="wstring" safearray="yes" dir="in">
8514	<desc>
8515	Array of arguments passed to the execution command.
8516	</desc>
8517	</param>
8518	<param name="environment" type="wstring" safearray="yes" dir="in">
8519	<desc>
8520	Environment variables that can be set while the command is being
8521	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8522	variable just set its name ("NAME") without a value.
8523	</desc>
8524	</param>
8525	<param name="userName" type="wstring" dir="in">
8526	<desc>
8527	User name under which the command will be executed; has to exist
8528	and have the appropriate rights to execute programs in the VM.
8529	</desc>
8530	</param>
8531	<param name="password" type="wstring" dir="in">
8532	<desc>
8533	Password of the user account specified.
8534	</desc>
8535	</param>
8536	<param name="timeoutMS" type="unsigned long" dir="in">
8537	<desc>
8538	The maximum timeout value (in msec) to wait for finished program
8539	execution. Pass 0 for an infinite timeout.
8540	</desc>
8541	</param>
8542	<param name="pid" type="unsigned long" dir="out">
8543	<desc>
8544	The PID (process ID) of the started command for later reference.
8545	</desc>
8546	</param>
8547	<param name="progress" type="IProgress" dir="return">
8548	<desc>Progress object to track the operation completion.</desc>
8549	</param>
8550	</method>
8551
8552	<method name="getProcessOutput">
8553	<desc>
8554	Retrieves output of a formerly started process.
8555
8556	<result name="VBOX_E_IPRT_ERROR">
8557	Could not retrieve output.
8558	</result>
8559
8560	</desc>
8561	<param name="pid" type="unsigned long" dir="in">
8562	<desc>
8563	Process id returned by earlier <link to="#executeProcess"/> call.
8564	</desc>
8565	</param>
8566	<param name="flags" type="unsigned long" dir="in">
8567	<desc>
8568	<link to="ProcessOutputFlag"/> flags.
8569	</desc>
8570	</param>
8571	<param name="timeoutMS" type="unsigned long" dir="in">
8572	<desc>
8573	The maximum timeout value (in msec) to wait for output
8574	data. Pass 0 for an infinite timeout.
8575	</desc>
8576	</param>
8577	<param name="size" type="long long" dir="in">
8578	<desc>
8579	Size in bytes to read in the buffer.
8580	</desc>
8581	</param>
8582	<param name="data" type="octet" safearray="yes" dir="return">
8583	<desc>
8584	Buffer for retrieving the actual output. A data size of 0 means end of file
8585	if the requested size was not 0. This is the unprocessed
8586	output data, i.e. the line ending style depends on the platform of
8587	the system the server is running on.
8588	</desc>
8589	</param>
8590	</method>
8591
8592	<method name="getProcessStatus">
8593	<desc>
8594	Retrieves status, exit code and the exit reason of a formerly started process.
8595
8596	<result name="VBOX_E_IPRT_ERROR">
8597	Process with specified PID was not found.
8598	</result>
8599
8600	</desc>
8601	<param name="pid" type="unsigned long" dir="in">
8602	<desc>
8603	Process id returned by earlier <link to="#executeProcess"/> call.
8604	</desc>
8605	</param>
8606	<param name="exitcode" type="unsigned long" dir="out">
8607	<desc>
8608	The exit code (if available).
8609	</desc>
8610	</param>
8611	<param name="flags" type="unsigned long" dir="out">
8612	<desc>
8613	Additional flags of process status. Not used at the moment and
8614	must be set to 0.
8615	</desc>
8616	</param>
8617	<param name="reason" type="ExecuteProcessStatus" dir="return">
8618	<desc>
8619	The current process status.
8620	</desc>
8621	</param>
8622	</method>
8623
8624	<method name="copyFromGuest">
8625	<desc>
8626	Copies files/directories from guest to the host.
8627
8628	<result name="VBOX_E_IPRT_ERROR">
8629	Error while copying.
8630	</result>
8631
8632	</desc>
8633	<param name="source" type="wstring" dir="in">
8634	<desc>
8635	Source file on the guest to copy.
8636	</desc>
8637	</param>
8638	<param name="dest" type="wstring" dir="in">
8639	<desc>
8640	Destination path on the host.
8641	</desc>
8642	</param>
8643	<param name="userName" type="wstring" dir="in">
8644	<desc>
8645	User name under which the copy command will be executed; the
8646	user has to exist and have the appropriate rights to read from
8647	the source path.
8648	</desc>
8649	</param>
8650	<param name="password" type="wstring" dir="in">
8651	<desc>
8652	Password of the user account specified.
8653	</desc>
8654	</param>
8655	<param name="flags" type="unsigned long" dir="in">
8656	<desc>
8657	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8658	</desc>
8659	</param>
8660	<param name="progress" type="IProgress" dir="return">
8661	<desc>Progress object to track the operation completion.</desc>
8662	</param>
8663	</method>
8664
8665	<method name="copyToGuest">
8666	<desc>
8667	Copies files/directories from host to the guest.
8668
8669	<result name="VBOX_E_IPRT_ERROR">
8670	Error while copying.
8671	</result>
8672
8673	</desc>
8674	<param name="source" type="wstring" dir="in">
8675	<desc>
8676	Source file on the host to copy.
8677	</desc>
8678	</param>
8679	<param name="dest" type="wstring" dir="in">
8680	<desc>
8681	Destination path on the guest.
8682	</desc>
8683	</param>
8684	<param name="userName" type="wstring" dir="in">
8685	<desc>
8686	User name under which the copy command will be executed; the
8687	user has to exist and have the appropriate rights to write to
8688	the destination path.
8689	</desc>
8690	</param>
8691	<param name="password" type="wstring" dir="in">
8692	<desc>
8693	Password of the user account specified.
8694	</desc>
8695	</param>
8696	<param name="flags" type="unsigned long" dir="in">
8697	<desc>
8698	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8699	</desc>
8700	</param>
8701	<param name="progress" type="IProgress" dir="return">
8702	<desc>Progress object to track the operation completion.</desc>
8703	</param>
8704	</method>
8705
8706	<method name="directoryClose">
8707	<desc>
8708	Closes a formerly opened guest directory.
8709
8710	<result name="VBOX_E_IPRT_ERROR">
8711	Error while closing directory.
8712	</result>
8713
8714	</desc>
8715	<param name="handle" type="unsigned long" dir="in">
8716	<desc>
8717	Handle of opened directory to close.
8718	</desc>
8719	</param>
8720	</method>
8721
8722	<method name="directoryCreate">
8723	<desc>
8724	Creates a directory on the guest.
8725
8726	<result name="VBOX_E_IPRT_ERROR">
8727	Error while creating directory.
8728	</result>
8729
8730	</desc>
8731	<param name="directory" type="wstring" dir="in">
8732	<desc>
8733	Directory to create.
8734	</desc>
8735	</param>
8736	<param name="userName" type="wstring" dir="in">
8737	<desc>
8738	User name under which the directory creation will be executed; the
8739	user has to exist and have the appropriate rights to create the
8740	desired directory.
8741	</desc>
8742	</param>
8743	<param name="password" type="wstring" dir="in">
8744	<desc>
8745	Password of the user account specified.
8746	</desc>
8747	</param>
8748	<param name="mode" type="unsigned long" dir="in">
8749	<desc>
8750	File mode.
8751	</desc>
8752	</param>
8753	<param name="flags" type="unsigned long" dir="in">
8754	<desc>
8755	<link to="DirectoryCreateFlag"/> flags.
8756	</desc>
8757	</param>
8758	</method>
8759
8760	<method name="directoryOpen">
8761	<desc>
8762	Opens a directory on the guest.
8763
8764	<result name="VBOX_E_IPRT_ERROR">
8765	Error while opening / reading directory.
8766	</result>
8767
8768	</desc>
8769	<param name="directory" type="wstring" dir="in">
8770	<desc>
8771	Directory to read.
8772	</desc>
8773	</param>
8774	<param name="filter" type="wstring" dir="in">
8775	<desc>
8776	Directory filter (DOS style wildcards). Set to empty
8777	string if no filter required.
8778	</desc>
8779	</param>
8780	<param name="flags" type="unsigned long" dir="in">
8781	<desc>
8782	<link to="DirectoryOpenFlag"/> flags.
8783	</desc>
8784	</param>
8785	<param name="userName" type="wstring" dir="in">
8786	<desc>
8787	User name under which the directory reading will be performed; the
8788	user has to exist and have the appropriate rights to access / read the
8789	desired directory.
8790	</desc>
8791	</param>
8792	<param name="password" type="wstring" dir="in">
8793	<desc>
8794	Password of the user account specified.
8795	</desc>
8796	</param>
8797	<param name="handle" type="unsigned long" dir="return">
8798	<desc>
8799	Handle of opened directory returned by openDirectory.
8800	</desc>
8801	</param>
8802	</method>
8803
8804	<method name="directoryRead">
8805	<desc>
8806	Reads the next directory entry of an opened guest directory.
8807
8808	<result name="VBOX_E_IPRT_ERROR">
8809	Error while opening / reading directory.
8810	</result>
8811
8812	</desc>
8813	<param name="handle" type="unsigned long" dir="in">
8814	<desc>
8815	Handle of opened directory returned by openDirectory.
8816	</desc>
8817	</param>
8818	<param name="entry" type="IGuestDirEntry" dir="return">
8819	<desc>
8820	Information about next directory entry on success.
8821	</desc>
8822	</param>
8823	</method>
8824
8825	<method name="fileExists">
8826	<desc>
8827	Checks if the specified file name exists and is a regular file.
8828
8829	<result name="VBOX_E_IPRT_ERROR">
8830	Error while looking up information.
8831	</result>
8832
8833	</desc>
8834	<param name="file" type="wstring" dir="in">
8835	<desc>
8836	Full path of file to check.
8837	</desc>
8838	</param>
8839	<param name="userName" type="wstring" dir="in">
8840	<desc>
8841	User name under which the lookup will be performed; the
8842	user has to exist and have the appropriate rights to access / read the
8843	desired directory.
8844	</desc>
8845	</param>
8846	<param name="password" type="wstring" dir="in">
8847	<desc>
8848	Password of the user account specified.
8849	</desc>
8850	</param>
8851	<param name="exists" type="boolean" dir="return">
8852	<desc>
8853	True if it's a regular file, false if it isn't (or doesn't exist).
8854	</desc>
8855	</param>
8856	</method>
8857
8858	<method name="setProcessInput">
8859	<desc>
8860	Sends input into a formerly started process.
8861
8862	<result name="VBOX_E_IPRT_ERROR">
8863	Could not send input.
8864	</result>
8865
8866	</desc>
8867	<param name="pid" type="unsigned long" dir="in">
8868	<desc>
8869	Process id returned by earlier <link to="#executeProcess"/> call.
8870	</desc>
8871	</param>
8872	<param name="flags" type="unsigned long" dir="in">
8873	<desc>
8874	<link to="ProcessInputFlag"/> flags.
8875	</desc>
8876	</param>
8877	<param name="timeoutMS" type="unsigned long" dir="in">
8878	<desc>
8879	The maximum timeout value (in msec) to wait for getting the
8880	data transfered to the guest. Pass 0 for an infinite timeout.
8881	</desc>
8882	</param>
8883	<param name="data" type="octet" dir="in" safearray="yes">
8884	<desc>
8885	Buffer of input data to send to the started process to.
8886	</desc>
8887	</param>
8888	<param name="written" type="unsigned long" dir="return">
8889	<desc>
8890	Number of bytes written.
8891	</desc>
8892	</param>
8893	</method>
8894
8895	<method name="updateGuestAdditions">
8896	<desc>
8897	Updates already installed Guest Additions in a VM
8898	(Windows guests only).
8899
8900	<result name="VBOX_E_IPRT_ERROR">
8901	Error while updating.
8902	</result>
8903
8904	</desc>
8905	<param name="source" type="wstring" dir="in">
8906	<desc>
8907	Path to the Guest Additions .ISO file to use for the upate.
8908	</desc>
8909	</param>
8910	<param name="flags" type="unsigned long" dir="in">
8911	<desc>
8912	<link to="AdditionsUpdateFlag"/> flags.
8913	</desc>
8914	</param>
8915	<param name="progress" type="IProgress" dir="return">
8916	<desc>Progress object to track the operation completion.</desc>
8917	</param>
8918	</method>
8919
8920	</interface>
8921
8922
8923	<!--
8924	// IProgress
8925	/////////////////////////////////////////////////////////////////////////
8926	-->
8927
8928	<interface
8929	name="IProgress" extends="$unknown"
8930	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
8931	wsmap="managed"
8932	>
8933	<desc>
8934	The IProgress interface is used to track and control
8935	asynchronous tasks within VirtualBox.
8936
8937	An instance of this is returned every time VirtualBox starts
8938	an asynchronous task (in other words, a separate thread) which
8939	continues to run after a method call returns. For example,
8940	<link to="IConsole::saveState" />, which saves the state of
8941	a running virtual machine, can take a long time to complete.
8942	To be able to display a progress bar, a user interface such as
8943	the VirtualBox graphical user interface can use the IProgress
8944	object returned by that method.
8945
8946	Note that IProgress is a "read-only" interface in the sense
8947	that only the VirtualBox internals behind the Main API can
8948	create and manipulate progress objects, whereas client code
8949	can only use the IProgress object to monitor a task's
8950	progress and, if <link to="#cancelable" /> is @c true,
8951	cancel the task by calling <link to="#cancel" />.
8952
8953	A task represented by IProgress consists of either one or
8954	several sub-operations that run sequentially, one by one (see
8955	<link to="#operation" /> and <link to="#operationCount" />).
8956	Every operation is identified by a number (starting from 0)
8957	and has a separate description.
8958
8959	You can find the individual percentage of completion of the current
8960	operation in <link to="#operationPercent" /> and the
8961	percentage of completion of the task as a whole
8962	in <link to="#percent" />.
8963
8964	Similarly, you can wait for the completion of a particular
8965	operation via <link to="#waitForOperationCompletion" /> or
8966	for the completion of the whole task via
8967	<link to="#waitForCompletion" />.
8968	</desc>
8969
8970	<attribute name="id" type="uuid" mod="string" readonly="yes">
8971	<desc>ID of the task.</desc>
8972	</attribute>
8973
8974	<attribute name="description" type="wstring" readonly="yes">
8975	<desc>Description of the task.</desc>
8976	</attribute>
8977
8978	<attribute name="initiator" type="$unknown" readonly="yes">
8979	<desc>Initiator of the task.</desc>
8980	</attribute>
8981
8982	<attribute name="cancelable" type="boolean" readonly="yes">
8983	<desc>Whether the task can be interrupted.</desc>
8984	</attribute>
8985
8986	<attribute name="percent" type="unsigned long" readonly="yes">
8987	<desc>
8988	Current progress value of the task as a whole, in percent.
8989	This value depends on how many operations are already complete.
8990	Returns 100 if <link to="#completed" /> is @c true.
8991	</desc>
8992	</attribute>
8993
8994	<attribute name="timeRemaining" type="long" readonly="yes">
8995	<desc>
8996	Estimated remaining time until the task completes, in
8997	seconds. Returns 0 once the task has completed; returns -1
8998	if the remaining time cannot be computed, in particular if
8999	the current progress is 0.
9000
9001	Even if a value is returned, the estimate will be unreliable
9002	for low progress values. It will become more reliable as the
9003	task progresses; it is not recommended to display an ETA
9004	before at least 20% of a task have completed.
9005	</desc>
9006	</attribute>
9007
9008	<attribute name="completed" type="boolean" readonly="yes">
9009	<desc>Whether the task has been completed.</desc>
9010	</attribute>
9011
9012	<attribute name="canceled" type="boolean" readonly="yes">
9013	<desc>Whether the task has been canceled.</desc>
9014	</attribute>
9015
9016	<attribute name="resultCode" type="long" readonly="yes">
9017	<desc>
9018	Result code of the progress task.
9019	Valid only if <link to="#completed"/> is @c true.
9020	</desc>
9021	</attribute>
9022
9023	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9024	<desc>
9025	Extended information about the unsuccessful result of the
9026	progress operation. May be @c null if no extended information
9027	is available.
9028	Valid only if <link to="#completed"/> is @c true and
9029	<link to="#resultCode"/> indicates a failure.
9030	</desc>
9031	</attribute>
9032
9033	<attribute name="operationCount" type="unsigned long" readonly="yes">
9034	<desc>
9035	Number of sub-operations this task is divided into.
9036	Every task consists of at least one suboperation.
9037	</desc>
9038	</attribute>
9039
9040	<attribute name="operation" type="unsigned long" readonly="yes">
9041	<desc>Number of the sub-operation being currently executed.</desc>
9042	</attribute>
9043
9044	<attribute name="operationDescription" type="wstring" readonly="yes">
9045	<desc>
9046	Description of the sub-operation being currently executed.
9047	</desc>
9048	</attribute>
9049
9050	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9051	<desc>Progress value of the current sub-operation only, in percent.</desc>
9052	</attribute>
9053
9054	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9055	<desc>Weight value of the current sub-operation only.</desc>
9056	</attribute>
9057
9058	<attribute name="timeout" type="unsigned long">
9059	<desc>
9060	When non-zero, this specifies the number of milliseconds after which
9061	the operation will automatically be canceled. This can only be set on
9062	cancelable objects.
9063	</desc>
9064	</attribute>
9065
9066	<method name="setCurrentOperationProgress">
9067	<desc>Internal method, not to be called externally.</desc>
9068	<param name="percent" type="unsigned long" dir="in" />
9069	</method>
9070	<method name="setNextOperation">
9071	<desc>Internal method, not to be called externally.</desc>
9072	<param name="nextOperationDescription" type="wstring" dir="in" />
9073	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9074	</method>
9075
9076	<method name="waitForCompletion">
9077	<desc>
9078	Waits until the task is done (including all sub-operations)
9079	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9080
9081	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9082	thread are not processed while waiting. Neglecting event queues may
9083	have dire consequences (degrade performance, resource hogs,
9084	deadlocks, etc.), this is specially so for the main thread on
9085	platforms using XPCOM. Callers are adviced wait for short periods
9086	and service their event queues between calls, or to create a worker
9087	thread to do the waiting.
9088
9089	<result name="VBOX_E_IPRT_ERROR">
9090	Failed to wait for task completion.
9091	</result>
9092	</desc>
9093
9094	<param name="timeout" type="long" dir="in">
9095	<desc>
9096	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9097	</desc>
9098	</param>
9099	</method>
9100
9101	<method name="waitForOperationCompletion">
9102	<desc>
9103	Waits until the given operation is done with a given timeout in
9104	milliseconds; specify -1 for an indefinite wait.
9105
9106	See <link to="#waitForCompletion"> for event queue considerations.</link>
9107
9108	<result name="VBOX_E_IPRT_ERROR">
9109	Failed to wait for operation completion.
9110	</result>
9111
9112	</desc>
9113	<param name="operation" type="unsigned long" dir="in">
9114	<desc>
9115	Number of the operation to wait for.
9116	Must be less than <link to="#operationCount"/>.
9117	</desc>
9118	</param>
9119	<param name="timeout" type="long" dir="in">
9120	<desc>
9121	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9122	</desc>
9123	</param>
9124	</method>
9125
9126	<method name="waitForAsyncProgressCompletion">
9127	<desc>
9128	Waits until the other task is completed (including all
9129	sub-operations) and forward all changes from the other progress to
9130	this progress. This means sub-operation number, description, percent
9131	and so on.
9132
9133	You have to take care on setting up at least the same count on
9134	sub-operations in this progress object like there are in the other
9135	progress object.
9136
9137	If the other progress object supports cancel and this object gets any
9138	cancel request (when here enabled as well), it will be forwarded to
9139	the other progress object.
9140
9141	If there is an error in the other progress, this error isn't
9142	automatically transfered to this progress object. So you have to
9143	check any operation error within the other progress object, after
9144	this method returns.
9145	</desc>
9146
9147	<param name="pProgressAsync" type="IProgress" dir="in">
9148	<desc>
9149	The progress object of the asynchrony process.
9150	</desc>
9151	</param>
9152	</method>
9153
9154	<method name="cancel">
9155	<desc>
9156	Cancels the task.
9157	<note>
9158	If <link to="#cancelable"/> is @c false, then this method will fail.
9159	</note>
9160
9161	<result name="VBOX_E_INVALID_OBJECT_STATE">
9162	Operation cannot be canceled.
9163	</result>
9164
9165	</desc>
9166	</method>
9167
9168	</interface>
9169
9170	<!--
9171	// ISnapshot
9172	/////////////////////////////////////////////////////////////////////////
9173	-->
9174
9175	<interface
9176	name="ISnapshot" extends="$unknown"
9177	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
9178	wsmap="managed"
9179	>
9180	<desc>
9181	The ISnapshot interface represents a snapshot of the virtual
9182	machine.
9183
9184	Together with the differencing media that are created
9185	when a snapshot is taken, a machine can be brought back to
9186	the exact state it was in when the snapshot was taken.
9187
9188	The ISnapshot interface has no methods, only attributes; snapshots
9189	are controlled through methods of the <link to="IConsole" /> interface
9190	which also manage the media associated with the snapshot.
9191	The following operations exist:
9192
9193	<ul>
9194	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9195	by creating new, empty differencing images for the machine's
9196	media and saving the VM settings and (if the VM is running)
9197	the current VM state in the snapshot.
9198
9199	The differencing images will then receive all data written to
9200	the machine's media, while their parent (base) images
9201	remain unmodified after the snapshot has been taken (see
9202	<link to="IMedium" /> for details about differencing images).
9203	This simplifies restoring a machine to the state of a snapshot:
9204	only the differencing images need to be deleted.
9205
9206	The current machine state is not changed by taking a snapshot
9207	except that <link to="IMachine::currentSnapshot" /> is set to
9208	the newly created snapshot, which is also added to the machine's
9209	snapshots tree.
9210	</li>
9211
9212	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9213	the state of a previous snapshot by deleting the differencing
9214	image of each of the machine's media and setting the machine's
9215	settings and state to the state that was saved in the snapshot (if any).
9216
9217	This destroys the machine's current state. After calling this,
9218	<link to="IMachine::currentSnapshot" /> points to the snapshot
9219	that was restored.
9220	</li>
9221
9222	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9223	without affecting the current machine state.
9224
9225	This does not change the current machine state, but instead frees the
9226	resources allocated when the snapshot was taken: the settings and machine
9227	state file are deleted (if any), and the snapshot's differencing image for
9228	each of the machine's media gets merged with its parent image.
9229
9230	Neither the current machine state nor other snapshots are affected
9231	by this operation, except that parent media will be modified
9232	to contain the disk data associated with the snapshot being deleted.
9233
9234	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9235	attribute is set to the current snapshot's parent or NULL if it
9236	has no parent. Otherwise the attribute is unchanged.
9237	</li>
9238	</ul>
9239
9240	Each snapshot contains a copy of virtual machine's settings (hardware
9241	configuration etc.). This copy is contained in an immutable (read-only)
9242	instance of <link to="IMachine" /> which is available from the snapshot's
9243	<link to="#machine" /> attribute. When restoring the snapshot, these
9244	settings are copied back to the original machine.
9245
9246	In addition, if the machine was running when the
9247	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9248	the current VM state is saved in the snapshot (similarly to what happens
9249	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9250	because when restoring it, the VM will be running.
9251
9252	If the machine was in <link to="MachineState_Saved">saved</link> saved,
9253	the snapshot receives a copy of the execution state file
9254	(<link to="IMachine::stateFilePath"/>).
9255
9256	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9257	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9258	it then contains a so-called "zero execution state", representing a
9259	machine that is powered off.
9260	</desc>
9261
9262	<attribute name="id" type="uuid" mod="string" readonly="yes">
9263	<desc>UUID of the snapshot.</desc>
9264	</attribute>
9265
9266	<attribute name="name" type="wstring">
9267	<desc>Short name of the snapshot.
9268	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9269	be called implicitly.</note>
9270	</desc>
9271	</attribute>
9272
9273	<attribute name="description" type="wstring">
9274	<desc>Optional description of the snapshot.
9275	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9276	be called implicitly.</note>
9277	</desc>
9278	</attribute>
9279
9280	<attribute name="timeStamp" type="long long" readonly="yes">
9281	<desc>
9282	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9283	</desc>
9284	</attribute>
9285
9286	<attribute name="online" type="boolean" readonly="yes">
9287	<desc>
9288	@c true if this snapshot is an online snapshot and @c false otherwise.
9289
9290	When this attribute is @c true, the
9291	<link to="IMachine::stateFilePath"/> attribute of the
9292	<link to="#machine"/> object associated with this snapshot
9293	will point to the saved state file. Otherwise, it will be
9294	an empty string.
9295	</desc>
9296	</attribute>
9297
9298	<attribute name="machine" type="IMachine" readonly="yes">
9299	<desc>
9300	Virtual machine this snapshot is taken on. This object
9301	stores all settings the machine had when taking this snapshot.
9302	<note>
9303	The returned machine object is immutable, i.e. no
9304	any settings can be changed.
9305	</note>
9306	</desc>
9307	</attribute>
9308
9309	<attribute name="parent" type="ISnapshot" readonly="yes">
9310	<desc>
9311	Parent snapshot (a snapshot this one is based on), or
9312	@c null if the snapshot has no parent (i.e. is the first snapshot).
9313	</desc>
9314	</attribute>
9315
9316	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
9317	<desc>
9318	Child snapshots (all snapshots having this one as a parent).
9319	By inspecting this attribute starting with a machine's root snapshot
9320	(which can be obtained by calling <link to="IMachine::findSnapshot" />
9321	with a @c null UUID), a machine's snapshots tree can be iterated over.
9322	</desc>
9323	</attribute>
9324
9325	</interface>
9326
9327
9328	<!--
9329	// IMedium
9330	/////////////////////////////////////////////////////////////////////////
9331	-->
9332
9333	<enum
9334	name="MediumState"
9335	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9336	>
9337	<desc>
9338	Virtual medium state.
9339	<see><link to="IMedium"/></see>
9340	</desc>
9341
9342	<const name="NotCreated" value="0">
9343	<desc>
9344	Associated medium storage does not exist (either was not created yet or
9345	was deleted).
9346	</desc>
9347	</const>
9348	<const name="Created" value="1">
9349	<desc>
9350	Associated storage exists and accessible; this gets set if the
9351	accessibility check performed by <link to="IMedium::refreshState" />
9352	was successful.
9353	</desc>
9354	</const>
9355	<const name="LockedRead" value="2">
9356	<desc>
9357	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
9358	no data modification is possible.
9359	</desc>
9360	</const>
9361	<const name="LockedWrite" value="3">
9362	<desc>
9363	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
9364	no concurrent data reading or modification is possible.
9365	</desc>
9366	</const>
9367	<const name="Inaccessible" value="4">
9368	<desc>
9369	Medium accessibility check (see <link to="IMedium::refreshState" />) has
9370	not yet been performed, or else, associated medium storage is not
9371	accessible. In the first case, <link to="IMedium::lastAccessError"/>
9372	is empty, in the second case, it describes the error that occurred.
9373	</desc>
9374	</const>
9375	<const name="Creating" value="5">
9376	<desc>
9377	Associated medium storage is being created.
9378	</desc>
9379	</const>
9380	<const name="Deleting" value="6">
9381	<desc>
9382	Associated medium storage is being deleted.
9383	</desc>
9384	</const>
9385	</enum>
9386
9387	<enum
9388	name="MediumType"
9389	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
9390	>
9391	<desc>
9392	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
9393	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
9394	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
9395	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
9396	</desc>
9397
9398	<const name="Normal" value="0">
9399	<desc>
9400	Normal medium (attached directly or indirectly, preserved
9401	when taking snapshots).
9402	</desc>
9403	</const>
9404	<const name="Immutable" value="1">
9405	<desc>
9406	Immutable medium (attached indirectly, changes are wiped out
9407	the next time the virtual machine is started).
9408	</desc>
9409	</const>
9410	<const name="Writethrough" value="2">
9411	<desc>
9412	Write through medium (attached directly, ignored when
9413	taking snapshots).
9414	</desc>
9415	</const>
9416	<const name="Shareable" value="3">
9417	<desc>
9418	Allow using this medium concurrently by several machines.
9419	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
9420	</desc>
9421	</const>
9422	<const name="Readonly" value="4">
9423	<desc>
9424	A readonly medium, which can of course be used by several machines.
9425	<note>Present and accepted since VirtualBox 4.0.</note>
9426	</desc>
9427	</const>
9428	<const name="MultiAttach" value="5">
9429	<desc>
9430	A medium which is is indirectly attached, so that one base medium can
9431	be used for several VMs which have their own differencing medium to
9432	store their modifications. In some sense a variant of Immutable
9433	with unset AutoReset flag in each differencing medium.
9434	<note>Present and accepted since VirtualBox 4.0.</note>
9435	</desc>
9436	</const>
9437	</enum>
9438
9439	<enum
9440	name="MediumVariant"
9441	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9442	>
9443	<desc>
9444	Virtual medium image variant. More than one flag may be set.
9445	<see><link to="IMedium"/></see>
9446	</desc>
9447
9448	<const name="Standard" value="0">
9449	<desc>
9450	No particular variant requested, results in using the backend default.
9451	</desc>
9452	</const>
9453	<const name="VmdkSplit2G" value="0x01">
9454	<desc>
9455	VMDK image split in chunks of less than 2GByte.
9456	</desc>
9457	</const>
9458	<const name="VmdkStreamOptimized" value="0x04">
9459	<desc>
9460	VMDK streamOptimized image. Special import/export format which is
9461	read-only/append-only.
9462	</desc>
9463	</const>
9464	<const name="VmdkESX" value="0x08">
9465	<desc>
9466	VMDK format variant used on ESX products.
9467	</desc>
9468	</const>
9469	<const name="Fixed" value="0x10000">
9470	<desc>
9471	Fixed image. Only allowed for base images.
9472	</desc>
9473	</const>
9474	<const name="Diff" value="0x20000">
9475	<desc>
9476	Differencing image. Only allowed for child images.
9477	</desc>
9478	</const>
9479	</enum>
9480
9481	<interface
9482	name="IMediumAttachment" extends="$unknown"
9483	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
9484	wsmap="struct"
9485	>
9486	<desc>
9487	The IMediumAttachment interface links storage media to virtual machines.
9488	For each medium (<link to="IMedium"/>) which has been attached to a
9489	storage controller (<link to="IStorageController"/>) of a machine
9490	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
9491	method, one instance of IMediumAttachment is added to the machine's
9492	<link to="IMachine::mediumAttachments"/> array attribute.
9493
9494	Each medium attachment specifies the storage controller as well as a
9495	port and device number and the IMedium instance representing a virtual
9496	hard disk or floppy or DVD image.
9497
9498	For removable media (DVDs or floppies), there are two additional
9499	options. For one, the IMedium instance can be @c null to represent
9500	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
9501	secondly, the medium can be one of the pseudo-media for host drives
9502	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
9503
9504	<h3>Attaching Hard Disks</h3>
9505
9506	Hard disks are attached to virtual machines using the
9507	<link to="IMachine::attachDevice"/> method and detached using the
9508	<link to="IMachine::detachDevice"/> method. Depending on a medium's
9509	type (see <link to="IMedium::type" />), hard disks are attached either
9510	<i>directly</i> or <i>indirectly</i>.
9511
9512	When a hard disk is being attached directly, it is associated with the
9513	virtual machine and used for hard disk operations when the machine is
9514	running. When a hard disk is being attached indirectly, a new differencing
9515	hard disk linked to it is implicitly created and this differencing hard
9516	disk is associated with the machine and used for hard disk operations.
9517	This also means that if <link to="IMachine::attachDevice"/> performs
9518	a direct attachment then the same hard disk will be returned in response
9519	to the subsequent <link to="IMachine::getMedium"/> call; however if
9520	an indirect attachment is performed then
9521	<link to="IMachine::getMedium"/> will return the implicitly created
9522	differencing hard disk, not the original one passed to <link
9523	to="IMachine::attachDevice"/>. In detail:
9524
9525	<ul>
9526	<li><b>Normal base</b> hard disks that do not have children (i.e.
9527	differencing hard disks linked to them) and that are not already
9528	attached to virtual machines in snapshots are attached <b>directly</b>.
9529	Otherwise, they are attached <b>indirectly</b> because having
9530	dependent children or being part of the snapshot makes it impossible
9531	to modify hard disk contents without breaking the integrity of the
9532	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
9533	quickly determine the kind of the attachment for the given hard
9534	disk. Note that if a normal base hard disk is to be indirectly
9535	attached to a virtual machine with snapshots then a special
9536	procedure called <i>smart attachment</i> is performed (see below).</li>
9537	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9538	they are attached <b>directly</b> if they do not have children and are
9539	not attached to virtual machines in snapshots, and <b>indirectly</b>
9540	otherwise. Note that the smart attachment procedure is never performed
9541	for differencing hard disks.</li>
9542	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9543	they are designed to be non-writable. If an immutable hard disk is
9544	attached to a virtual machine with snapshots then a special
9545	procedure called smart attachment is performed (see below).</li>
9546	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9547	also as designed. This also means that writethrough hard disks cannot
9548	have other hard disks linked to them at all.</li>
9549	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9550	also as designed. This also means that shareable hard disks cannot
9551	have other hard disks linked to them at all. They behave almost
9552	like writethrough hard disks, except that shareable hard disks can
9553	be attached to several virtual machines which are running, allowing
9554	concurrent accesses. You need special cluster software running in
9555	the virtual machines to make use of such disks.</li>
9556	</ul>
9557
9558	Note that the same hard disk, regardless of its type, may be attached to
9559	more than one virtual machine at a time. In this case, the machine that is
9560	started first gains exclusive access to the hard disk and attempts to
9561	start other machines having this hard disk attached will fail until the
9562	first machine is powered down.
9563
9564	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9565	that the given hard disk remains associated with the given machine after a
9566	successful <link to="IMachine::detachDevice"/> call until
9567	<link to="IMachine::saveSettings"/> is called to save all changes to
9568	machine settings to disk. This deferring is necessary to guarantee that
9569	the hard disk configuration may be restored at any time by a call to
9570	<link to="IMachine::discardSettings"/> before the settings
9571	are saved (committed).
9572
9573	Note that if <link to="IMachine::discardSettings"/> is called after
9574	indirectly attaching some hard disks to the machine but before a call to
9575	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9576	all differencing hard disks implicitly created by
9577	<link to="IMachine::attachDevice"/> for these indirect attachments.
9578	Such implicitly created hard disks will also be immediately deleted when
9579	detached explicitly using the <link to="IMachine::detachDevice"/>
9580	call if it is made before <link to="IMachine::saveSettings"/>. This
9581	implicit deletion is safe because newly created differencing hard
9582	disks do not contain any user data.
9583
9584	However, keep in mind that detaching differencing hard disks that were
9585	implicitly created by <link to="IMachine::attachDevice"/>
9586	before the last <link to="IMachine::saveSettings"/> call will
9587	<b>not</b> implicitly delete them as they may already contain some data
9588	(for example, as a result of virtual machine execution). If these hard
9589	disks are no more necessary, the caller can always delete them explicitly
9590	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
9591	from this machine by the <link to="IMachine::saveSettings"/> call.
9592
9593	<h3>Smart Attachment</h3>
9594
9595	When normal base or immutable hard disks are indirectly attached to a
9596	virtual machine then some additional steps are performed to make sure the
9597	virtual machine will have the most recent "view" of the hard disk being
9598	attached. These steps include walking through the machine's snapshots
9599	starting from the current one and going through ancestors up to the first
9600	snapshot. Hard disks attached to the virtual machine in all
9601	of the encountered snapshots are checked whether they are descendants of
9602	the given normal base or immutable hard disk. The first found child (which
9603	is the differencing hard disk) will be used instead of the normal base or
9604	immutable hard disk as a parent for creating a new differencing hard disk
9605	that will be actually attached to the machine. And only if no descendants
9606	are found or if the virtual machine does not have any snapshots then the
9607	normal base or immutable hard disk will be used itself as a parent for
9608	this differencing hard disk.
9609
9610	It is easier to explain what smart attachment does using the
9611	following example:
9612	<pre>
9613	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9614
9615	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9616	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9617	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9618	Snapshot 4 (none) Snapshot 4 (none)
9619	CurState (none) CurState (D3->D2.vdi)
9620
9621	NOT
9622	...
9623	CurState (D3->B.vdi)
9624	</pre>
9625	The first column is the virtual machine configuration before the base hard
9626	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9627	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9628	mean that the hard disk that is actually attached to the machine is a
9629	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9630	another hard disk, <tt>B.vdi</tt>.
9631
9632	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9633	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9634	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9635	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9636	it cannot be attached directly and needs an indirect attachment (i.e.
9637	implicit creation of a new differencing hard disk). Due to the smart
9638	attachment procedure, the new differencing hard disk
9639	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9640	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9641	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9642	machine.
9643
9644	Note that if there is more than one descendant hard disk of the given base
9645	hard disk found in a snapshot, and there is an exact device, channel and
9646	bus match, then this exact match will be used. Otherwise, the youngest
9647	descendant will be picked up.
9648
9649	There is one more important aspect of the smart attachment procedure which
9650	is not related to snapshots at all. Before walking through the snapshots
9651	as described above, the backup copy of the current list of hard disk
9652	attachment is searched for descendants. This backup copy is created when
9653	the hard disk configuration is changed for the first time after the last
9654	<link to="IMachine::saveSettings"/> call and used by
9655	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9656	changes. When such a descendant is found in this backup copy, it will be
9657	simply re-attached back, without creating a new differencing hard disk for
9658	it. This optimization is necessary to make it possible to re-attach the
9659	base or immutable hard disk to a different bus, channel or device slot
9660	without losing the contents of the differencing hard disk actually
9661	attached to the machine in place of it.
9662
9663	</desc>
9664
9665	<attribute name="medium" type="IMedium" readonly="yes">
9666	<desc>Medium object associated with this attachment; it
9667	can be @c null for removable devices.</desc>
9668	</attribute>
9669
9670	<attribute name="controller" type="wstring" readonly="yes">
9671	<desc>Name of the storage controller of this attachment; this
9672	refers to one of the controllers in <link to="IMachine::storageControllers" />
9673	by name.</desc>
9674	</attribute>
9675
9676	<attribute name="port" type="long" readonly="yes">
9677	<desc>Port number of this attachment.
9678	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9679	</desc>
9680	</attribute>
9681
9682	<attribute name="device" type="long" readonly="yes">
9683	<desc>Device slot number of this attachment.
9684	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9685	</desc>
9686	</attribute>
9687
9688	<attribute name="type" type="DeviceType" readonly="yes">
9689	<desc>Device type of this attachment.</desc>
9690	</attribute>
9691
9692	<attribute name="passthrough" type="boolean" readonly="yes">
9693	<desc>Pass I/O requests through to a device on the host.</desc>
9694	</attribute>
9695
9696	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
9697	<desc>The bandwidth group this medium attachment is assigned to.</desc>
9698	</attribute>
9699
9700	</interface>
9701
9702	<interface
9703	name="IMedium" extends="$unknown"
9704	uuid="f55ce3ec-b856-4d07-ae33-826072b332c3"
9705	wsmap="managed"
9706	>
9707	<desc>
9708	The IMedium interface represents virtual storage for a machine's
9709	hard disks, CD/DVD or floppy drives. It will typically represent
9710	a disk image on the host, for example a VDI or VMDK file representing
9711	a virtual hard disk, or an ISO or RAW file representing virtual
9712	removable media, but can also point to a network location (e.g.
9713	for iSCSI targets).
9714
9715	Instances of IMedium are connected to virtual machines by way of medium
9716	attachments, which link the storage medium to a particular device slot
9717	of a storage controller of the virtual machine.
9718	In the VirtualBox API, virtual storage is therefore always represented
9719	by the following chain of object links:
9720
9721	<ul>
9722	<li><link to="IMachine::storageControllers"/> contains an array of
9723	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9724	these are instances of <link to="IStorageController"/>).</li>
9725	<li><link to="IMachine::mediumAttachments"/> contains an array of
9726	medium attachments (instances of <link to="IMediumAttachment"/>
9727	created by <link to="IMachine::attachDevice" />),
9728	each containing a storage controller from the above array, a
9729	port/device specification, and an instance of IMedium representing
9730	the medium storage (image file).
9731
9732	For removable media, the storage medium is optional; a medium
9733	attachment with no medium represents a CD/DVD or floppy drive
9734	with no medium inserted. By contrast, hard disk attachments
9735	will always have an IMedium object attached.</li>
9736	<li>Each IMedium in turn points to a storage unit (such as a file
9737	on the host computer or a network resource) that holds actual
9738	data. This location is represented by the <link to="#location"/>
9739	attribute.</li>
9740	</ul>
9741
9742	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
9743	new hard disk media can be created with the VirtualBox API using the
9744	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
9745	disks (see below) are usually implicitly created by VirtualBox as
9746	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
9747	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
9748	should be created with external tools and then opened from within VirtualBox.
9749
9750	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9751	drive. In that case the <link to="#id" /> attribute contains the UUID of
9752	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9753
9754	<h3>Media registries</h3>
9755
9756	When a medium has been opened or created using one of the aforementioned
9757	APIs, it becomes "known" to VirtualBox. Known media can be attached
9758	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
9759	They also appear in the global
9760	<link to="IVirtualBox::hardDisks" />,
9761	<link to="IVirtualBox::DVDImages" /> and
9762	<link to="IVirtualBox::floppyImages" /> arrays.
9763
9764	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
9765	in the VirtualBox.xml file, which was shared between all machines and made
9766	transporting machines and their media from one host to another difficult.
9767
9768	Starting with VirtualBox 4.0, media are only added to a registry when they are
9769	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
9770	backwards compatibility, which registry a medium is added to depends on which
9771	VirtualBox version created a machine:
9772
9773	<ul>
9774	<li>If the medium has first been attached to a machine which was created by
9775	VirtualBox 4.0 or later, it is added to that machine's media registry in
9776	the machine XML settings file. This way all information about a machine's
9777	media attachments is contained in a single file and can be transported
9778	easily.</li>
9779	<li>For older media attachments (i.e. if the medium was first attached to a
9780	machine which was created with a VirtualBox version before 4.0), media
9781	continue to be registered in the global VirtualBox settings file, for
9782	backwards compatibility.</li>
9783	</ul>
9784
9785	See <link to="IVirtualBox::openMedium" /> for more information.
9786
9787	Media are removed from media registries by the <link to="IMedium::close"/>,
9788	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
9789
9790	<h3>Accessibility checks</h3>
9791
9792	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9793	method is called explicitly on a medium. This is done to make the VirtualBox object
9794	ready for serving requests as fast as possible and let the end-user
9795	application decide if it needs to check media accessibility right away or not.
9796
9797	As a result, when VirtualBox starts up (e.g. the VirtualBox
9798	object gets created for the first time), all known media are in the
9799	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9800	attribute is an empty string because no actual accessibility check has
9801	been made yet.
9802
9803	After calling <link to="#refreshState" />, a medium is considered
9804	<i>accessible</i> if its storage unit can be read. In that case, the
9805	<link to="#state"/> attribute has a value of "Created". If the storage
9806	unit cannot be read (for example, because it is located on a disconnected
9807	network resource, or was accidentally deleted outside VirtualBox),
9808	the medium is considered <i>inaccessible</i>, which is indicated by the
9809	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9810	obtained by reading the <link to="#lastAccessError"/> attribute.
9811
9812	<h3>Medium types</h3>
9813
9814	There are five types of medium behavior which are stored in the
9815	<link to="#type"/> attribute (see <link to="MediumType" />) and
9816	which define the medium's behavior with attachments and snapshots.
9817
9818	All media can be also divided in two groups: <i>base</i> media and
9819	<i>differencing</i> media. A base medium contains all sectors of the
9820	medium data in its own storage and therefore can be used independently.
9821	In contrast, a differencing medium is a "delta" to some other medium and
9822	contains only those sectors which differ from that other medium, which is
9823	then called a <i>parent</i>. The differencing medium is said to be
9824	<i>linked to</i> that parent. The parent may be itself a differencing
9825	medium, thus forming a chain of linked media. The last element in that
9826	chain must always be a base medium. Note that several differencing
9827	media may be linked to the same parent medium.
9828
9829	Differencing media can be distinguished from base media by querying the
9830	<link to="#parent"/> attribute: base media do not have parents they would
9831	depend on, so the value of this attribute is always @c null for them.
9832	Using this attribute, it is possible to walk up the medium tree (from the
9833	child medium to its parent). It is also possible to walk down the tree
9834	using the <link to="#children"/> attribute.
9835
9836	Note that the type of all differencing media is "normal"; all other
9837	values are meaningless for them. Base media may be of any type.
9838
9839	<h3>Automatic composition of the file name part</h3>
9840
9841	Another extension to the <link to="IMedium::location"/> attribute is that
9842	there is a possibility to cause VirtualBox to compose a unique value for
9843	the file name part of the location using the UUID of the hard disk. This
9844	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9845	e.g. before the storage unit is created, and works as follows. You set the
9846	value of the <link to="IMedium::location"/> attribute to a location
9847	specification which only contains the path specification but not the file
9848	name part and ends with either a forward slash or a backslash character.
9849	In response, VirtualBox will generate a new UUID for the hard disk and
9850	compose the file name using the following pattern:
9851	<pre>
9852	<path>/{<uuid>}.<ext>
9853	</pre>
9854	where <tt><path></tt> is the supplied path specification,
9855	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9856	is the default extension for the storage format of this hard disk. After
9857	that, you may call any of the methods that create a new hard disk storage
9858	unit and they will use the generated UUID and file name.
9859	</desc>
9860
9861	<attribute name="id" type="uuid" mod="string" readonly="yes">
9862	<desc>
9863	UUID of the medium. For a newly created medium, this value is a randomly
9864	generated UUID.
9865
9866	<note>
9867	For media in one of MediumState_NotCreated, MediumState_Creating or
9868	MediumState_Deleting states, the value of this property is undefined
9869	and will most likely be an empty UUID.
9870	</note>
9871	</desc>
9872	</attribute>
9873
9874	<attribute name="description" type="wstring">
9875	<desc>
9876	Optional description of the medium. For a newly created medium the value
9877	of this attribute is an empty string.
9878
9879	Medium types that don't support this attribute will return E_NOTIMPL in
9880	attempt to get or set this attribute's value.
9881
9882	<note>
9883	For some storage types, reading this attribute may return an outdated
9884	(last known) value when <link to="#state"/> is <link
9885	to="MediumState_Inaccessible"/> or <link
9886	to="MediumState_LockedWrite"/> because the value of this attribute is
9887	stored within the storage unit itself. Also note that changing the
9888	attribute value is not possible in such case, as well as when the
9889	medium is the <link to="MediumState_LockedRead"/> state.
9890	</note>
9891	</desc>
9892	</attribute>
9893
9894	<attribute name="state" type="MediumState" readonly="yes">
9895	<desc>
9896	Returns the current medium state, which is the last state set by
9897	the accessibility check performed by <link to="#refreshState"/>.
9898	If that method has not yet been called on the medium, the state
9899	is "Inaccessible"; as opposed to truly inaccessible media, the
9900	value of <link to="#lastAccessError"/> will be an empty string in
9901	that case.
9902
9903	<note>As of version 3.1, this no longer performs an accessibility check
9904	automatically; call <link to="#refreshState"/> for that.
9905	</note>
9906	</desc>
9907	</attribute>
9908
9909	<attribute name="variant" type="unsigned long" readonly="yes">
9910	<desc>
9911	Returns the storage format variant information for this medium
9912	as a combination of the flags described at <link to="MediumVariant" />.
9913	Before <link to="#refreshState"/> is called this method returns
9914	an undefined value.
9915	</desc>
9916	</attribute>
9917
9918	<attribute name="location" type="wstring">
9919	<desc>
9920	Location of the storage unit holding medium data.
9921
9922	The format of the location string is medium type specific. For medium
9923	types using regular files in a host's file system, the location
9924	string is the full file name.
9925
9926	Some medium types may support changing the storage unit location by
9927	simply changing the value of this property. If this operation is not
9928	supported, the implementation will return E_NOTIMPL in attempt to set
9929	this attribute's value.
9930
9931	When setting a value of the location attribute which is a regular file
9932	in the host's file system, the given file name may be either relative to
9933	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9934	absolute. Note that if the given location specification does not contain
9935	the file extension part then a proper default extension will be
9936	automatically appended by the implementation depending on the medium type.
9937	</desc>
9938	</attribute>
9939
9940	<attribute name="name" type="wstring" readonly="yes">
9941	<desc>
9942	Name of the storage unit holding medium data.
9943
9944	The returned string is a short version of the <link to="#location"/>
9945	attribute that is suitable for representing the medium in situations
9946	where the full location specification is too long (such as lists
9947	and comboboxes in GUI frontends). This string is also used by frontends
9948	to sort the media list alphabetically when needed.
9949
9950	For example, for locations that are regular files in the host's file
9951	system, the value of this attribute is just the file name (+ extension),
9952	without the path specification.
9953
9954	Note that as opposed to the <link to="#location"/> attribute, the name
9955	attribute will not necessary be unique for a list of media of the
9956	given type and format.
9957	</desc>
9958	</attribute>
9959
9960	<attribute name="deviceType" type="DeviceType" readonly="yes">
9961	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9962	medium.</desc>
9963	</attribute>
9964
9965	<attribute name="hostDrive" type="boolean" readonly="yes">
9966	<desc>True if this corresponds to a drive on the host.</desc>
9967	</attribute>
9968
9969	<attribute name="size" type="long long" readonly="yes">
9970	<desc>
9971	Physical size of the storage unit used to hold medium data (in bytes).
9972
9973	<note>
9974	For media whose <link to="#state"/> is <link
9975	to="MediumState_Inaccessible"/>, the value of this property is the
9976	last known size. For <link to="MediumState_NotCreated"/> media,
9977	the returned value is zero.
9978	</note>
9979	</desc>
9980	</attribute>
9981
9982	<attribute name="format" type="wstring" readonly="yes">
9983	<desc>
9984	Storage format of this medium.
9985
9986	The value of this attribute is a string that specifies a backend used
9987	to store medium data. The storage format is defined when you create a
9988	new medium or automatically detected when you open an existing medium,
9989	and cannot be changed later.
9990
9991	The list of all storage formats supported by this VirtualBox
9992	installation can be obtained using
9993	<link to="ISystemProperties::mediumFormats"/>.
9994	</desc>
9995	</attribute>
9996
9997	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9998	<desc>
9999	Storage medium format object corresponding to this medium.
10000
10001	The value of this attribute is a reference to the medium format object
10002	that specifies the backend properties used to store medium data. The
10003	storage format is defined when you create a new medium or automatically
10004	detected when you open an existing medium, and cannot be changed later.
10005
10006	<note>@c null is returned if there is no associated medium format
10007	object. This can e.g. happen for medium objects representing host
10008	drives and other special medium objects.</note>
10009	</desc>
10010	</attribute>
10011
10012	<attribute name="type" type="MediumType">
10013	<desc>
10014	Type (role) of this medium.
10015
10016	The following constraints apply when changing the value of this
10017	attribute:
10018	<ul>
10019	<li>If a medium is attached to a virtual machine (either in the
10020	current state or in one of the snapshots), its type cannot be
10021	changed.
10022	</li>
10023	<li>As long as the medium has children, its type cannot be set
10024	to <link to="MediumType_Writethrough"/>.
10025	</li>
10026	<li>The type of all differencing media is
10027	<link to="MediumType_Normal"/> and cannot be changed.
10028	</li>
10029	</ul>
10030
10031	The type of a newly created or opened medium is set to
10032	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10033	which have a type of <link to="MediumType_Writethrough"/>.
10034	</desc>
10035	</attribute>
10036
10037	<attribute name="parent" type="IMedium" readonly="yes">
10038	<desc>
10039	Parent of this medium (the medium this medium is directly based
10040	on).
10041
10042	Only differencing media have parents. For base (non-differencing)
10043	media, @c null is returned.
10044	</desc>
10045	</attribute>
10046
10047	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10048	<desc>
10049	Children of this medium (all differencing media directly based
10050	on this medium). A @c null array is returned if this medium
10051	does not have any children.
10052	</desc>
10053	</attribute>
10054
10055	<attribute name="base" type="IMedium" readonly="yes">
10056	<desc>
10057	Base medium of this medium.
10058
10059	If this is a differencing medium, its base medium is the medium
10060	the given medium branch starts from. For all other types of media, this
10061	property returns the medium object itself (i.e. the same object this
10062	property is read on).
10063	</desc>
10064	</attribute>
10065
10066	<attribute name="readOnly" type="boolean" readonly="yes">
10067	<desc>
10068	Returns @c true if this medium is read-only and @c false otherwise.
10069
10070	A medium is considered to be read-only when its contents cannot be
10071	modified without breaking the integrity of other parties that depend on
10072	this medium such as its child media or snapshots of virtual machines
10073	where this medium is attached to these machines. If there are no
10074	children and no such snapshots then there is no dependency and the
10075	medium is not read-only.
10076
10077	The value of this attribute can be used to determine the kind of the
10078	attachment that will take place when attaching this medium to a
10079	virtual machine. If the value is @c false then the medium will
10080	be attached directly. If the value is @c true then the medium
10081	will be attached indirectly by creating a new differencing child
10082	medium for that. See the interface description for more information.
10083
10084	Note that all <link to="MediumType_Immutable">Immutable</link> media
10085	are always read-only while all
10086	<link to="MediumType_Writethrough">Writethrough</link> media are
10087	always not.
10088
10089	<note>
10090	The read-only condition represented by this attribute is related to
10091	the medium type and usage, not to the current
10092	<link to="IMedium::state">medium state</link> and not to the read-only
10093	state of the storage unit.
10094	</note>
10095	</desc>
10096	</attribute>
10097
10098	<attribute name="logicalSize" type="long long" readonly="yes">
10099	<desc>
10100	Logical size of this medium (in bytes), as reported to the
10101	guest OS running inside the virtual machine this medium is
10102	attached to. The logical size is defined when the medium is created
10103	and cannot be changed later.
10104
10105	<note>
10106	Reading this property on a differencing medium will return the size
10107	of its <link to="#base"/> medium.
10108	</note>
10109	<note>
10110	For media whose state is <link to="#state"/> is <link
10111	to="MediumState_Inaccessible"/>, the value of this property is the
10112	last known logical size. For <link to="MediumState_NotCreated"/>
10113	media, the returned value is zero.
10114	</note>
10115	</desc>
10116	</attribute>
10117
10118	<attribute name="autoReset" type="boolean">
10119	<desc>
10120	Whether this differencing medium will be automatically reset each
10121	time a virtual machine it is attached to is powered up. This
10122	attribute is automatically set to @c true for the last
10123	differencing image of an "immutable" medium (see
10124	<link to="MediumType" />).
10125
10126	See <link to="#reset"/> for more information about resetting
10127	differencing media.
10128
10129	<note>
10130	Reading this property on a base (non-differencing) medium will
10131	always @c false. Changing the value of this property in this
10132	case is not supported.
10133	</note>
10134
10135	<result name="VBOX_E_NOT_SUPPORTED">
10136	This is not a differencing medium (when changing the attribute
10137	value).
10138	</result>
10139	</desc>
10140	</attribute>
10141
10142	<attribute name="lastAccessError" type="wstring" readonly="yes">
10143	<desc>
10144	Text message that represents the result of the last accessibility
10145	check performed by <link to="#refreshState"/>.
10146
10147	An empty string is returned if the last accessibility check
10148	was successful or has not yet been called. As a result, if
10149	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10150	then <link to="#refreshState"/> has yet to be called; this is the
10151	default value of media after VirtualBox initialization.
10152	A non-empty string indicates a failure and should normally describe
10153	a reason of the failure (for example, a file read error).
10154	</desc>
10155	</attribute>
10156
10157	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10158	<desc>
10159	Array of UUIDs of all machines this medium is attached to.
10160
10161	A @c null array is returned if this medium is not attached to any
10162	machine or to any machine's snapshot.
10163
10164	<note>
10165	The returned array will include a machine even if this medium is not
10166	attached to that machine in the current state but attached to it in
10167	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10168	details.
10169	</note>
10170	</desc>
10171	</attribute>
10172
10173	<method name="setIDs">
10174	<desc>
10175	Changes the UUID and parent UUID for a hard disk medium.
10176	</desc>
10177	<param name="setImageId" type="boolean" dir="in">
10178	<desc>
10179	Select whether a new image UUID is set or not.
10180	</desc>
10181	</param>
10182	<param name="imageId" type="uuid" mod="string" dir="in">
10183	<desc>
10184	New UUID for the image. If an empty string is passed, then a new
10185	UUID is automatically created, provided that @a setImageId is @c true.
10186	Specifying a zero UUID is not allowed.
10187	</desc>
10188	</param>
10189	<param name="setParentId" type="boolean" dir="in">
10190	<desc>
10191	Select whether a new parent UUID is set or not.
10192	</desc>
10193	</param>
10194	<param name="parentId" type="uuid" mod="string" dir="in">
10195	<desc>
10196	New parent UUID for the image. If an empty string is passed, then a
10197	new UUID is automatically created, provided @a setParentId is
10198	@c true. A zero UUID is valid.
10199	</desc>
10200	</param>
10201	<result name="E_INVALIDARG">
10202	Invalid parameter combination.
10203	</result>
10204	<result name="VBOX_E_NOT_SUPPORTED">
10205	Medium is not a hard disk medium.
10206	</result>
10207	</method>
10208
10209	<method name="refreshState">
10210	<desc>
10211	If the current medium state (see <link to="MediumState"/>) is one of
10212	"Created", "Inaccessible" or "LockedRead", then this performs an
10213	accessibility check on the medium and sets the value of the <link to="#state"/>
10214	attribute accordingly; that value is also returned for convenience.
10215
10216	For all other state values, this does not perform a refresh but returns
10217	the state only.
10218
10219	The refresh, if performed, may take a long time (several seconds or even
10220	minutes, depending on the storage unit location and format) because it performs an
10221	accessibility check of the storage unit. This check may cause a significant
10222	delay if the storage unit of the given medium is, for example, a file located
10223	on a network share which is not currently accessible due to connectivity
10224	problems. In that case, the call will not return until a timeout
10225	interval defined by the host OS for this operation expires. For this reason,
10226	it is recommended to never read this attribute on the main UI thread to avoid
10227	making the UI unresponsive.
10228
10229	If the last known state of the medium is "Created" and the accessibility
10230	check fails, then the state would be set to "Inaccessible", and
10231	<link to="#lastAccessError"/> may be used to get more details about the
10232	failure. If the state of the medium is "LockedRead", then it remains the
10233	same, and a non-empty value of <link to="#lastAccessError"/> will
10234	indicate a failed accessibility check in this case.
10235
10236	Note that not all medium states are applicable to all medium types.
10237	</desc>
10238	<param name="state" type="MediumState" dir="return">
10239	<desc>
10240	New medium state.
10241	</desc>
10242	</param>
10243	</method>
10244
10245	<method name="getSnapshotIds">
10246	<desc>
10247	Returns an array of UUIDs of all snapshots of the given machine where
10248	this medium is attached to.
10249
10250	If the medium is attached to the machine in the current state, then the
10251	first element in the array will always be the ID of the queried machine
10252	(i.e. the value equal to the @c machineId argument), followed by
10253	snapshot IDs (if any).
10254
10255	If the medium is not attached to the machine in the current state, then
10256	the array will contain only snapshot IDs.
10257
10258	The returned array may be @c null if this medium is not attached
10259	to the given machine at all, neither in the current state nor in one of
10260	the snapshots.
10261	</desc>
10262	<param name="machineId" type="uuid" mod="string" dir="in">
10263	<desc>
10264	UUID of the machine to query.
10265	</desc>
10266	</param>
10267	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
10268	<desc>
10269	Array of snapshot UUIDs of the given machine using this medium.
10270	</desc>
10271	</param>
10272	</method>
10273
10274	<method name="lockRead">
10275	<desc>
10276	Locks this medium for reading.
10277
10278	A read lock is shared: many clients can simultaneously lock the
10279	same medium for reading unless it is already locked for writing (see
10280	<link to="#lockWrite"/>) in which case an error is returned.
10281
10282	When the medium is locked for reading, it cannot be modified
10283	from within VirtualBox. This means that any method that changes
10284	the properties of this medium or contents of the storage unit
10285	will return an error (unless explicitly stated otherwise). That
10286	includes an attempt to start a virtual machine that wants to
10287	write to the the medium.
10288
10289	When the virtual machine is started up, it locks for reading all
10290	media it uses in read-only mode. If some medium cannot be locked
10291	for reading, the startup procedure will fail.
10292	A medium is typically locked for reading while it is used by a running
10293	virtual machine but has a depending differencing image that receives
10294	the actual write operations. This way one base medium can have
10295	multiple child differencing images which can be written to
10296	simultaneously. Read-only media such as DVD and floppy images are
10297	also locked for reading only (so they can be in use by multiple
10298	machines simultaneously).
10299
10300	A medium is also locked for reading when it is the source of a
10301	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10302
10303	The medium locked for reading must be unlocked using the <link
10304	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
10305	can be nested and must be followed by the same number of paired
10306	<link to="#unlockRead"/> calls.
10307
10308	This method sets the medium state (see <link to="#state"/>) to
10309	"LockedRead" on success. The medium's previous state must be
10310	one of "Created", "Inaccessible" or "LockedRead".
10311
10312	Locking an inaccessible medium is not an error; this method performs
10313	a logical lock that prevents modifications of this medium through
10314	the VirtualBox API, not a physical file-system lock of the underlying
10315	storage unit.
10316
10317	This method returns the current state of the medium
10318	<i>before</i> the operation.
10319
10320	<result name="VBOX_E_INVALID_OBJECT_STATE">
10321	Invalid medium state (e.g. not created, locked, inaccessible,
10322	creating, deleting).
10323	</result>
10324
10325	</desc>
10326	<param name="state" type="MediumState" dir="return">
10327	<desc>
10328	State of the medium after the operation.
10329	</desc>
10330	</param>
10331	</method>
10332
10333	<method name="unlockRead">
10334	<desc>
10335	Cancels the read lock previously set by <link to="#lockRead"/>.
10336
10337	For both success and failure, this method returns the current state
10338	of the medium <i>after</i> the operation.
10339
10340	See <link to="#lockRead"/> for more details.
10341
10342	<result name="VBOX_E_INVALID_OBJECT_STATE">
10343	Medium not locked for reading.
10344	</result>
10345
10346	</desc>
10347	<param name="state" type="MediumState" dir="return">
10348	<desc>
10349	State of the medium after the operation.
10350	</desc>
10351	</param>
10352	</method>
10353
10354	<method name="lockWrite">
10355	<desc>
10356	Locks this medium for writing.
10357
10358	A write lock, as opposed to <link to="#lockRead"/>, is
10359	exclusive: there may be only one client holding a write lock,
10360	and there may be no read locks while the write lock is held.
10361	As a result, read-locking fails if a write lock is held, and
10362	write-locking fails if either a read or another write lock is held.
10363
10364	When a medium is locked for writing, it cannot be modified
10365	from within VirtualBox, and it is not guaranteed that the values
10366	of its properties are up-to-date. Any method that changes the
10367	properties of this medium or contents of the storage unit will
10368	return an error (unless explicitly stated otherwise).
10369
10370	When a virtual machine is started up, it locks for writing all
10371	media it uses to write data to. If any medium could not be locked
10372	for writing, the startup procedure will fail. If a medium has
10373	differencing images, then while the machine is running, only
10374	the last ("leaf") differencing image is locked for writing,
10375	whereas its parents are locked for reading only.
10376
10377	A medium is also locked for writing when it is the target of a
10378	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10379
10380	The medium locked for writing must be unlocked using the <link
10381	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
10382
10383	This method sets the medium state (see <link to="#state"/>) to
10384	"LockedWrite" on success. The medium's previous state must be
10385	either "Created" or "Inaccessible".
10386
10387	Locking an inaccessible medium is not an error; this method performs
10388	a logical lock that prevents modifications of this medium through
10389	the VirtualBox API, not a physical file-system lock of the underlying
10390	storage unit.
10391
10392	For both, success and failure, this method returns the current
10393	state of the medium <i>before</i> the operation.
10394
10395	<result name="VBOX_E_INVALID_OBJECT_STATE">
10396	Invalid medium state (e.g. not created, locked, inaccessible,
10397	creating, deleting).
10398	</result>
10399
10400	</desc>
10401	<param name="state" type="MediumState" dir="return">
10402	<desc>
10403	State of the medium after the operation.
10404	</desc>
10405	</param>
10406	</method>
10407
10408	<method name="unlockWrite">
10409	<desc>
10410	Cancels the write lock previously set by <link to="#lockWrite"/>.
10411
10412	For both success and failure, this method returns the current
10413	state of the medium <i>after</i> the operation.
10414
10415	See <link to="#lockWrite"/> for more details.
10416
10417	<result name="VBOX_E_INVALID_OBJECT_STATE">
10418	Medium not locked for writing.
10419	</result>
10420
10421	</desc>
10422	<param name="state" type="MediumState" dir="return">
10423	<desc>
10424	State of the medium after the operation.
10425	</desc>
10426	</param>
10427	</method>
10428
10429	<method name="close">
10430	<desc>
10431	Closes this medium.
10432
10433	The medium must not be attached to any known virtual machine
10434	and must not have any known child media, otherwise the
10435	operation will fail.
10436
10437	When the medium is successfully closed, it is removed from
10438	the list of registered media, but its storage unit is not
10439	deleted. In particular, this means that this medium can
10440	later be opened again using the <link to="IVirtualBox::openMedium"/>
10441	call.
10442
10443	Note that after this method successfully returns, the given medium
10444	object becomes uninitialized. This means that any attempt
10445	to call any of its methods or attributes will fail with the
10446	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10447
10448	<result name="VBOX_E_INVALID_OBJECT_STATE">
10449	Invalid medium state (other than not created, created or
10450	inaccessible).
10451	</result>
10452	<result name="VBOX_E_OBJECT_IN_USE">
10453	Medium attached to virtual machine.
10454	</result>
10455	<result name="VBOX_E_FILE_ERROR">
10456	Settings file not accessible.
10457	</result>
10458	<result name="VBOX_E_XML_ERROR">
10459	Could not parse the settings file.
10460	</result>
10461
10462	</desc>
10463	</method>
10464
10465	<!-- property methods -->
10466
10467	<method name="getProperty" const="yes">
10468	<desc>
10469	Returns the value of the custom medium property with the given name.
10470
10471	The list of all properties supported by the given medium format can
10472	be obtained with <link to="IMediumFormat::describeProperties"/>.
10473
10474	<note>If this method returns an empty string in @a value, the requested
10475	property is supported but currently not assigned any value.</note>
10476
10477	<result name="VBOX_E_OBJECT_NOT_FOUND">
10478	Requested property does not exist (not supported by the format).
10479	</result>
10480	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10481	</desc>
10482	<param name="name" type="wstring" dir="in">
10483	<desc>Name of the property to get.</desc>
10484	</param>
10485	<param name="value" type="wstring" dir="return">
10486	<desc>Current property value.</desc>
10487	</param>
10488	</method>
10489
10490	<method name="setProperty">
10491	<desc>
10492	Sets the value of the custom medium property with the given name.
10493
10494	The list of all properties supported by the given medium format can
10495	be obtained with <link to="IMediumFormat::describeProperties"/>.
10496
10497	<note>Setting the property value to @c null or an empty string is
10498	equivalent to deleting the existing value. A default value (if it is
10499	defined for this property) will be used by the format backend in this
10500	case.</note>
10501
10502	<result name="VBOX_E_OBJECT_NOT_FOUND">
10503	Requested property does not exist (not supported by the format).
10504	</result>
10505	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10506	</desc>
10507	<param name="name" type="wstring" dir="in">
10508	<desc>Name of the property to set.</desc>
10509	</param>
10510	<param name="value" type="wstring" dir="in">
10511	<desc>Property value to set.</desc>
10512	</param>
10513	</method>
10514
10515	<method name="getProperties" const="yes">
10516	<desc>
10517	Returns values for a group of properties in one call.
10518
10519	The names of the properties to get are specified using the @a names
10520	argument which is a list of comma-separated property names or
10521	an empty string if all properties are to be returned.
10522	<note>Currently the value of this argument is ignored and the method
10523	always returns all existing properties.</note>
10524
10525	The list of all properties supported by the given medium format can
10526	be obtained with <link to="IMediumFormat::describeProperties"/>.
10527
10528	The method returns two arrays, the array of property names corresponding
10529	to the @a names argument and the current values of these properties.
10530	Both arrays have the same number of elements with each element at the
10531	given index in the first array corresponds to an element at the same
10532	index in the second array.
10533
10534	For properties that do not have assigned values, an empty string is
10535	returned at the appropriate index in the @a returnValues array.
10536
10537	</desc>
10538	<param name="names" type="wstring" dir="in">
10539	<desc>
10540	Names of properties to get.
10541	</desc>
10542	</param>
10543	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10544	<desc>Names of returned properties.</desc>
10545	</param>
10546	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10547	<desc>Values of returned properties.</desc>
10548	</param>
10549	</method>
10550
10551	<method name="setProperties">
10552	<desc>
10553	Sets values for a group of properties in one call.
10554
10555	The names of the properties to set are passed in the @a names
10556	array along with the new values for them in the @a values array. Both
10557	arrays have the same number of elements with each element at the given
10558	index in the first array corresponding to an element at the same index
10559	in the second array.
10560
10561	If there is at least one property name in @a names that is not valid,
10562	the method will fail before changing the values of any other properties
10563	from the @a names array.
10564
10565	Using this method over <link to="#setProperty"/> is preferred if you
10566	need to set several properties at once since it is more efficient.
10567
10568	The list of all properties supported by the given medium format can
10569	be obtained with <link to="IMediumFormat::describeProperties"/>.
10570
10571	Setting the property value to @c null or an empty string is equivalent
10572	to deleting the existing value. A default value (if it is defined for
10573	this property) will be used by the format backend in this case.
10574	</desc>
10575	<param name="names" type="wstring" safearray="yes" dir="in">
10576	<desc>Names of properties to set.</desc>
10577	</param>
10578	<param name="values" type="wstring" safearray="yes" dir="in">
10579	<desc>Values of properties to set.</desc>
10580	</param>
10581	</method>
10582
10583	<!-- storage methods -->
10584
10585	<method name="createBaseStorage">
10586	<desc>
10587	Starts creating a hard disk storage unit (fixed/dynamic, according
10588	to the variant flags) in in the background. The previous storage unit
10589	created for this object, if any, must first be deleted using
10590	<link to="#deleteStorage"/>, otherwise the operation will fail.
10591
10592	Before the operation starts, the medium is placed in
10593	<link to="MediumState_Creating"/> state. If the create operation
10594	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10595	state.
10596
10597	After the returned progress object reports that the operation has
10598	successfully completed, the medium state will be set to <link
10599	to="MediumState_Created"/>, the medium will be remembered by this
10600	VirtualBox installation and may be attached to virtual machines.
10601
10602	<result name="VBOX_E_NOT_SUPPORTED">
10603	The variant of storage creation operation is not supported. See <link
10604	to="IMediumFormat::capabilities"/>.
10605	</result>
10606	</desc>
10607	<param name="logicalSize" type="long long" dir="in">
10608	<desc>Maximum logical size of the medium in bytes.</desc>
10609	</param>
10610	<param name="variant" type="unsigned long" dir="in">
10611	<desc>Exact image variant which should be created (as a combination of
10612	<link to="MediumVariant" /> flags).</desc>
10613	</param>
10614	<param name="progress" type="IProgress" dir="return">
10615	<desc>Progress object to track the operation completion.</desc>
10616	</param>
10617	</method>
10618
10619	<method name="deleteStorage">
10620	<desc>
10621	Starts deleting the storage unit of this medium.
10622
10623	The medium must not be attached to any known virtual machine and must
10624	not have any known child media, otherwise the operation will fail.
10625	It will also fail if there is no storage unit to delete or if deletion
10626	is already in progress, or if the medium is being in use (locked for
10627	read or for write) or inaccessible. Therefore, the only valid state for
10628	this operation to succeed is <link to="MediumState_Created"/>.
10629
10630	Before the operation starts, the medium is placed in
10631	<link to="MediumState_Deleting"/> state and gets removed from the list
10632	of remembered hard disks (media registry). If the delete operation
10633	fails, the medium will be remembered again and placed back to
10634	<link to="MediumState_Created"/> state.
10635
10636	After the returned progress object reports that the operation is
10637	complete, the medium state will be set to
10638	<link to="MediumState_NotCreated"/> and you will be able to use one of
10639	the storage creation methods to create it again.
10640
10641	<see><link to="#close"/></see>
10642
10643	<result name="VBOX_E_OBJECT_IN_USE">
10644	Medium is attached to a virtual machine.
10645	</result>
10646	<result name="VBOX_E_NOT_SUPPORTED">
10647	Storage deletion is not allowed because neither of storage creation
10648	operations are supported. See
10649	<link to="IMediumFormat::capabilities"/>.
10650	</result>
10651
10652	<note>
10653	If the deletion operation fails, it is not guaranteed that the storage
10654	unit still exists. You may check the <link to="IMedium::state"/> value
10655	to answer this question.
10656	</note>
10657	</desc>
10658	<param name="progress" type="IProgress" dir="return">
10659	<desc>Progress object to track the operation completion.</desc>
10660	</param>
10661	</method>
10662
10663	<!-- diff methods -->
10664
10665	<method name="createDiffStorage">
10666	<desc>
10667	Starts creating an empty differencing storage unit based on this
10668	medium in the format and at the location defined by the @a target
10669	argument.
10670
10671	The target medium must be in <link to="MediumState_NotCreated"/>
10672	state (i.e. must not have an existing storage unit). Upon successful
10673	completion, this operation will set the type of the target medium to
10674	<link to="MediumType_Normal"/> and create a storage unit necessary to
10675	represent the differencing medium data in the given format (according
10676	to the storage format of the target object).
10677
10678	After the returned progress object reports that the operation is
10679	successfully complete, the target medium gets remembered by this
10680	VirtualBox installation and may be attached to virtual machines.
10681
10682	<note>
10683	The medium will be set to <link to="MediumState_LockedRead"/>
10684	state for the duration of this operation.
10685	</note>
10686	<result name="VBOX_E_OBJECT_IN_USE">
10687	Medium not in @c NotCreated state.
10688	</result>
10689	</desc>
10690	<param name="target" type="IMedium" dir="in">
10691	<desc>Target medium.</desc>
10692	</param>
10693	<param name="variant" type="unsigned long" dir="in">
10694	<desc>Exact image variant which should be created (as a combination of
10695	<link to="MediumVariant" /> flags).</desc>
10696	</param>
10697	<param name="progress" type="IProgress" dir="return">
10698	<desc>Progress object to track the operation completion.</desc>
10699	</param>
10700	</method>
10701
10702	<method name="mergeTo">
10703	<desc>
10704	Starts merging the contents of this medium and all intermediate
10705	differencing media in the chain to the given target medium.
10706
10707	The target medium must be either a descendant of this medium or
10708	its ancestor (otherwise this method will immediately return a failure).
10709	It follows that there are two logical directions of the merge operation:
10710	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10711	ancestor (<i>backward merge</i>). Let us consider the following medium
10712	chain:
10713
10714	<pre>Base <- Diff_1 <- Diff_2</pre>
10715
10716	Here, calling this method on the <tt>Base</tt> medium object with
10717	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10718	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10719	merge. Note that in both cases the contents of the resulting medium
10720	will be the same, the only difference is the medium object that takes
10721	the result of the merge operation. In case of the forward merge in the
10722	above example, the result will be written to <tt>Diff_2</tt>; in case of
10723	the backward merge, the result will be written to <tt>Base</tt>. In
10724	other words, the result of the operation is always stored in the target
10725	medium.
10726
10727	Upon successful operation completion, the storage units of all media in
10728	the chain between this (source) medium and the target medium, including
10729	the source medium itself, will be automatically deleted and the
10730	relevant medium objects (including this medium) will become
10731	uninitialized. This means that any attempt to call any of
10732	their methods or attributes will fail with the
10733	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10734	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10735	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10736	Note that <tt>Diff_2</tt> in this case will become a base medium
10737	itself since it will no longer be based on any other medium.
10738
10739	Considering the above, all of the following conditions must be met in
10740	order for the merge operation to succeed:
10741	<ul>
10742	<li>
10743	Neither this (source) medium nor any intermediate
10744	differencing medium in the chain between it and the target
10745	medium is attached to any virtual machine.
10746	</li>
10747	<li>
10748	Neither the source medium nor the target medium is an
10749	<link to="MediumType_Immutable"/> medium.
10750	</li>
10751	<li>
10752	The part of the medium tree from the source medium to the
10753	target medium is a linear chain, i.e. all medium in this
10754	chain have exactly one child which is the next medium in this
10755	chain. The only exception from this rule is the target medium in
10756	the forward merge operation; it is allowed to have any number of
10757	child media because the merge operation will not change its
10758	logical contents (as it is seen by the guest OS or by children).
10759	</li>
10760	<li>
10761	None of the involved media are in
10762	<link to="MediumState_LockedRead"/> or
10763	<link to="MediumState_LockedWrite"/> state.
10764	</li>
10765	</ul>
10766
10767	<note>
10768	This (source) medium and all intermediates will be placed to <link
10769	to="MediumState_Deleting"/> state and the target medium will be
10770	placed to <link to="MediumState_LockedWrite"/> state and for the
10771	duration of this operation.
10772	</note>
10773	</desc>
10774	<param name="target" type="IMedium" dir="in">
10775	<desc>Target medium.</desc>
10776	</param>
10777	<param name="progress" type="IProgress" dir="return">
10778	<desc>Progress object to track the operation completion.</desc>
10779	</param>
10780	</method>
10781
10782	<!-- clone method -->
10783
10784	<method name="cloneTo">
10785	<desc>
10786	Starts creating a clone of this medium in the format and at the
10787	location defined by the @a target argument.
10788
10789	The target medium must be either in <link to="MediumState_NotCreated"/>
10790	state (i.e. must not have an existing storage unit) or in
10791	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10792	big enough to hold the data or else the copy will be partial). Upon
10793	successful completion, the cloned medium will contain exactly the
10794	same sector data as the medium being cloned, except that in the
10795	first case a new UUID for the clone will be randomly generated, and in
10796	the second case the UUID will remain unchanged.
10797
10798	The @a parent argument defines which medium will be the parent
10799	of the clone. Passing a @c null reference indicates that the clone will
10800	be a base image, i.e. completely independent. It is possible to specify
10801	an arbitrary medium for this parameter, including the parent of the
10802	medium which is being cloned. Even cloning to a child of the source
10803	medium is possible. Note that when cloning to an existing image, the
10804	@a parent irgument is ignored.
10805
10806	After the returned progress object reports that the operation is
10807	successfully complete, the target medium gets remembered by this
10808	VirtualBox installation and may be attached to virtual machines.
10809
10810	<note>
10811	This medium will be placed to <link to="MediumState_LockedRead"/>
10812	state for the duration of this operation.
10813	</note>
10814	<result name="E_NOTIMPL">
10815	The specified cloning variant is not supported at the moment.
10816	</result>
10817	</desc>
10818	<param name="target" type="IMedium" dir="in">
10819	<desc>Target medium.</desc>
10820	</param>
10821	<param name="variant" type="unsigned long" dir="in">
10822	<desc>Exact image variant which should be created (as a combination of
10823	<link to="MediumVariant" /> flags).</desc>
10824	</param>
10825	<param name="parent" type="IMedium" dir="in">
10826	<desc>Parent of the cloned medium.</desc>
10827	</param>
10828	<param name="progress" type="IProgress" dir="return">
10829	<desc>Progress object to track the operation completion.</desc>
10830	</param>
10831	</method>
10832
10833	<!-- other methods -->
10834
10835	<method name="compact">
10836	<desc>
10837	Starts compacting of this medium. This means that the medium is
10838	transformed into a possibly more compact storage representation.
10839	This potentially creates temporary images, which can require a
10840	substantial amount of additional disk space.
10841
10842	This medium will be placed to <link to="MediumState_LockedWrite"/>
10843	state and all its parent media (if any) will be placed to
10844	<link to="MediumState_LockedRead"/> state for the duration of this
10845	operation.
10846
10847	Please note that the results can be either returned straight away,
10848	or later as the result of the background operation via the object
10849	returned via the @a progress parameter.
10850
10851	<result name="VBOX_E_NOT_SUPPORTED">
10852	Medium format does not support compacting (but potentially
10853	needs it).
10854	</result>
10855	</desc>
10856	<param name="progress" type="IProgress" dir="return">
10857	<desc>Progress object to track the operation completion.</desc>
10858	</param>
10859	</method>
10860
10861	<method name="resize">
10862	<desc>
10863	Starts resizing this medium. This means that the nominal size of the
10864	medium is set to the new value. Both increasing and decreasing the
10865	size is possible, and there are no safety checks, since VirtualBox
10866	does not make any assumptions about the medium contents.
10867
10868	Resizing usually needs additional disk space, and possibly also
10869	some temporary disk space. Note that resize does not create a full
10870	temporary copy of the medium, so the additional disk space requirement
10871	is usually much lower than using the clone operation.
10872
10873	This medium will be placed to <link to="MediumState_LockedWrite"/>
10874	state for the duration of this operation.
10875
10876	Please note that the results can be either returned straight away,
10877	or later as the result of the background operation via the object
10878	returned via the @a progress parameter.
10879
10880	<result name="VBOX_E_NOT_SUPPORTED">
10881	Medium format does not support resizing.
10882	</result>
10883	</desc>
10884	<param name="logicalSize" type="long long" dir="in">
10885	<desc>New nominal capacity of the medium in bytes.</desc>
10886	</param>
10887	<param name="progress" type="IProgress" dir="return">
10888	<desc>Progress object to track the operation completion.</desc>
10889	</param>
10890	</method>
10891
10892	<method name="reset">
10893	<desc>
10894	Starts erasing the contents of this differencing medium.
10895
10896	This operation will reset the differencing medium to its initial
10897	state when it does not contain any sector data and any read operation is
10898	redirected to its parent medium. This automatically gets called
10899	during VM power-up for every medium whose <link to="#autoReset" />
10900	attribute is @c true.
10901
10902	The medium will be write-locked for the duration of this operation (see
10903	<link to="#lockWrite" />).
10904
10905	<result name="VBOX_E_NOT_SUPPORTED">
10906	This is not a differencing medium.
10907	</result>
10908	<result name="VBOX_E_INVALID_OBJECT_STATE">
10909	Medium is not in <link to="MediumState_Created"/> or
10910	<link to="MediumState_Inaccessible"/> state.
10911	</result>
10912	</desc>
10913	<param name="progress" type="IProgress" dir="return">
10914	<desc>Progress object to track the operation completion.</desc>
10915	</param>
10916	</method>
10917
10918	</interface>
10919
10920
10921	<!--
10922	// IMediumFormat
10923	/////////////////////////////////////////////////////////////////////////
10924	-->
10925
10926	<enum
10927	name="DataType"
10928	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10929	>
10930	<const name="Int32" value="0"/>
10931	<const name="Int8" value="1"/>
10932	<const name="String" value="2"/>
10933	</enum>
10934
10935	<enum
10936	name="DataFlags"
10937	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10938	>
10939	<const name="None" value="0x00"/>
10940	<const name="Mandatory" value="0x01"/>
10941	<const name="Expert" value="0x02"/>
10942	<const name="Array" value="0x04"/>
10943	<const name="FlagMask" value="0x07"/>
10944	</enum>
10945
10946	<enum
10947	name="MediumFormatCapabilities"
10948	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10949	>
10950	<desc>
10951	Medium format capability flags.
10952	</desc>
10953
10954	<const name="Uuid" value="0x01">
10955	<desc>
10956	Supports UUIDs as expected by VirtualBox code.
10957	</desc>
10958	</const>
10959
10960	<const name="CreateFixed" value="0x02">
10961	<desc>
10962	Supports creating fixed size images, allocating all space instantly.
10963	</desc>
10964	</const>
10965
10966	<const name="CreateDynamic" value="0x04">
10967	<desc>
10968	Supports creating dynamically growing images, allocating space on
10969	demand.
10970	</desc>
10971	</const>
10972
10973	<const name="CreateSplit2G" value="0x08">
10974	<desc>
10975	Supports creating images split in chunks of a bit less than 2 GBytes.
10976	</desc>
10977	</const>
10978
10979	<const name="Differencing" value="0x10">
10980	<desc>
10981	Supports being used as a format for differencing media (see <link
10982	to="IMedium::createDiffStorage"/>).
10983	</desc>
10984	</const>
10985
10986	<const name="Asynchronous" value="0x20">
10987	<desc>
10988	Supports asynchronous I/O operations for at least some configurations.
10989	</desc>
10990	</const>
10991
10992	<const name="File" value="0x40">
10993	<desc>
10994	The format backend operates on files (the <link to="IMedium::location"/>
10995	attribute of the medium specifies a file used to store medium
10996	data; for a list of supported file extensions see
10997	<link to="IMediumFormat::describeFileExtensions"/>).
10998	</desc>
10999	</const>
11000
11001	<const name="Properties" value="0x80">
11002	<desc>
11003	The format backend uses the property interface to configure the storage
11004	location and properties (the <link to="IMediumFormat::describeProperties"/>
11005	method is used to get access to properties supported by the given medium format).
11006	</desc>
11007	</const>
11008
11009	<const name="TcpNetworking" value="0x100">
11010	<desc>
11011	The format backend uses the TCP networking interface for network access.
11012	</desc>
11013	</const>
11014
11015	<const name="VFS" value="0x200">
11016	<desc>
11017	The format backend supports virtual filesystem functionality.
11018	</desc>
11019	</const>
11020
11021	<const name="CapabilityMask" value="0x3FF"/>
11022	</enum>
11023
11024	<interface
11025	name="IMediumFormat" extends="$unknown"
11026	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11027	wsmap="managed"
11028	>
11029	<desc>
11030	The IMediumFormat interface represents a medium format.
11031
11032	Each medium format has an associated backend which is used to handle
11033	media stored in this format. This interface provides information
11034	about the properties of the associated backend.
11035
11036	Each medium format is identified by a string represented by the
11037	<link to="#id"/> attribute. This string is used in calls like
11038	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11039	format.
11040
11041	The list of all supported medium formats can be obtained using
11042	<link to="ISystemProperties::mediumFormats"/>.
11043
11044	<see><link to="IMedium"/></see>
11045	</desc>
11046
11047	<attribute name="id" type="wstring" readonly="yes">
11048	<desc>
11049	Identifier of this format.
11050
11051	The format identifier is a non-@c null non-empty ASCII string. Note that
11052	this string is case-insensitive. This means that, for example, all of
11053	the following strings:
11054	<pre>
11055	"VDI"
11056	"vdi"
11057	"VdI"</pre>
11058	refer to the same medium format.
11059
11060	This string is used in methods of other interfaces where it is necessary
11061	to specify a medium format, such as
11062	<link to="IVirtualBox::createHardDisk"/>.
11063	</desc>
11064	</attribute>
11065
11066	<attribute name="name" type="wstring" readonly="yes">
11067	<desc>
11068	Human readable description of this format.
11069
11070	Mainly for use in file open dialogs.
11071	</desc>
11072	</attribute>
11073
11074	<attribute name="capabilities" type="unsigned long" readonly="yes">
11075	<desc>
11076	Capabilities of the format as a set of bit flags.
11077
11078	For the meaning of individual capability flags see
11079	<link to="MediumFormatCapabilities"/>.
11080	</desc>
11081	</attribute>
11082
11083	<method name="describeFileExtensions">
11084	<desc>
11085	Returns two arrays describing the supported file extensions.
11086
11087	The first array contains the supported extensions and the seconds one
11088	the type each extension supports. Both have the same size.
11089
11090	Note that some backends do not work on files, so this array may be
11091	empty.
11092
11093	<see><link to="IMediumFormat::capabilities"/></see>
11094	</desc>
11095	<param name="extensions" type="wstring" safearray="yes" dir="out">
11096	<desc>The array of supported extensions.</desc>
11097	</param>
11098	<param name="type" type="DeviceType" safearray="yes" dir="out">
11099	<desc>The array which indicates the device type for every given extension.</desc>
11100	</param>
11101	</method>
11102
11103	<method name="describeProperties" const="yes">
11104	<desc>
11105	Returns several arrays describing the properties supported by this
11106	format.
11107
11108	An element with the given index in each array describes one
11109	property. Thus, the number of elements in each returned array is the
11110	same and corresponds to the number of supported properties.
11111
11112	The returned arrays are filled in only if the
11113	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11114	All arguments must be non-@c null.
11115
11116	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11117	</desc>
11118
11119	<param name="names" type="wstring" safearray="yes" dir="out">
11120	<desc>Array of property names.</desc>
11121	</param>
11122	<param name="description" type="wstring" safearray="yes" dir="out">
11123	<desc>Array of property descriptions.</desc>
11124	</param>
11125	<param name="types" type="DataType" safearray="yes" dir="out">
11126	<desc>Array of property types.</desc>
11127	</param>
11128	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11129	<desc>Array of property flags.</desc>
11130	</param>
11131	<param name="defaults" type="wstring" safearray="yes" dir="out">
11132	<desc>Array of default property values.</desc>
11133	</param>
11134	</method>
11135
11136	</interface>
11137
11138
11139	<!--
11140	// IKeyboard
11141	/////////////////////////////////////////////////////////////////////////
11142	-->
11143
11144	<interface
11145	name="IKeyboard" extends="$unknown"
11146	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11147	wsmap="managed"
11148	>
11149	<desc>
11150	The IKeyboard interface represents the virtual machine's keyboard. Used
11151	in <link to="IConsole::keyboard"/>.
11152
11153	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11154	to the virtual machine.
11155
11156	</desc>
11157	<method name="putScancode">
11158	<desc>Sends a scancode to the keyboard.
11159
11160	<result name="VBOX_E_IPRT_ERROR">
11161	Could not send scan code to virtual keyboard.
11162	</result>
11163
11164	</desc>
11165	<param name="scancode" type="long" dir="in"/>
11166	</method>
11167
11168	<method name="putScancodes">
11169	<desc>Sends an array of scancodes to the keyboard.
11170
11171	<result name="VBOX_E_IPRT_ERROR">
11172	Could not send all scan codes to virtual keyboard.
11173	</result>
11174
11175	</desc>
11176	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11177	<param name="codesStored" type="unsigned long" dir="return"/>
11178	</method>
11179
11180	<method name="putCAD">
11181	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11182	function is nothing special, it is just a convenience function
11183	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11184
11185	<result name="VBOX_E_IPRT_ERROR">
11186	Could not send all scan codes to virtual keyboard.
11187	</result>
11188
11189	</desc>
11190	</method>
11191
11192	<attribute name="eventSource" type="IEventSource" readonly="yes">
11193	<desc>
11194	Event source for keyboard events.
11195	</desc>
11196	</attribute>
11197
11198	</interface>
11199
11200
11201	<!--
11202	// IMouse
11203	/////////////////////////////////////////////////////////////////////////
11204	-->
11205
11206	<enum
11207	name="MouseButtonState"
11208	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
11209	>
11210	<desc>
11211	Mouse button state.
11212	</desc>
11213
11214	<const name="LeftButton" value="0x01"/>
11215	<const name="RightButton" value="0x02"/>
11216	<const name="MiddleButton" value="0x04"/>
11217	<const name="WheelUp" value="0x08"/>
11218	<const name="WheelDown" value="0x10"/>
11219	<const name="XButton1" value="0x20"/>
11220	<const name="XButton2" value="0x40"/>
11221	<const name="MouseStateMask" value="0x7F"/>
11222	</enum>
11223
11224	<interface
11225	name="IMouse" extends="$unknown"
11226	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
11227	wsmap="managed"
11228	>
11229	<desc>
11230	The IMouse interface represents the virtual machine's mouse. Used in
11231	<link to="IConsole::mouse"/>.
11232
11233	Through this interface, the virtual machine's virtual mouse can be
11234	controlled.
11235	</desc>
11236
11237	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11238	<desc>
11239	Whether the guest OS supports absolute mouse pointer positioning
11240	or not.
11241	<note>
11242	You can use the <link to="IMouseCapabilityChangedEvent"/>
11243	event to be instantly informed about changes of this attribute
11244	during virtual machine execution.
11245	</note>
11246	<see><link to="#putMouseEventAbsolute"/></see>
11247	</desc>
11248	</attribute>
11249
11250	<attribute name="relativeSupported" type="boolean" readonly="yes">
11251	<desc>
11252	Whether the guest OS supports relative mouse pointer positioning
11253	or not.
11254	<note>
11255	You can use the <link to="IMouseCapabilityChangedEvent"/>
11256	event to be instantly informed about changes of this attribute
11257	during virtual machine execution.
11258	</note>
11259	<see><link to="#putMouseEvent"/></see>
11260	</desc>
11261	</attribute>
11262
11263	<attribute name="needsHostCursor" type="boolean" readonly="yes">
11264	<desc>
11265	Whether the guest OS can currently switch to drawing it's own mouse
11266	cursor on demand.
11267	<note>
11268	You can use the <link to="IMouseCapabilityChangedEvent"/>
11269	event to be instantly informed about changes of this attribute
11270	during virtual machine execution.
11271	</note>
11272	<see><link to="#putMouseEvent"/></see>
11273	</desc>
11274	</attribute>
11275
11276	<method name="putMouseEvent">
11277	<desc>
11278	Initiates a mouse event using relative pointer movements
11279	along x and y axis.
11280
11281	<result name="E_ACCESSDENIED">
11282	Console not powered up.
11283	</result>
11284	<result name="VBOX_E_IPRT_ERROR">
11285	Could not send mouse event to virtual mouse.
11286	</result>
11287
11288	</desc>
11289
11290	<param name="dx" type="long" dir="in">
11291	<desc>
11292	Amount of pixels the mouse should move to the right.
11293	Negative values move the mouse to the left.
11294	</desc>
11295	</param>
11296	<param name="dy" type="long" dir="in">
11297	<desc>
11298	Amount of pixels the mouse should move downwards.
11299	Negative values move the mouse upwards.
11300	</desc>
11301	</param>
11302	<param name="dz" type="long" dir="in">
11303	<desc>
11304	Amount of mouse wheel moves.
11305	Positive values describe clockwise wheel rotations,
11306	negative values describe counterclockwise rotations.
11307	</desc>
11308	</param>
11309	<param name="dw" type="long" dir="in">
11310	<desc>
11311	Amount of horizontal mouse wheel moves.
11312	Positive values describe a movement to the left,
11313	negative values describe a movement to the right.
11314	</desc>
11315	</param>
11316	<param name="buttonState" type="long" dir="in">
11317	<desc>
11318	The current state of mouse buttons. Every bit represents
11319	a mouse button as follows:
11320	<table>
11321	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11322	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11323	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11324	</table>
11325	A value of <tt>1</tt> means the corresponding button is pressed.
11326	otherwise it is released.
11327	</desc>
11328	</param>
11329	</method>
11330
11331	<method name="putMouseEventAbsolute">
11332	<desc>
11333	Positions the mouse pointer using absolute x and y coordinates.
11334	These coordinates are expressed in pixels and
11335	start from <tt>[1,1]</tt> which corresponds to the top left
11336	corner of the virtual display.
11337
11338	<result name="E_ACCESSDENIED">
11339	Console not powered up.
11340	</result>
11341	<result name="VBOX_E_IPRT_ERROR">
11342	Could not send mouse event to virtual mouse.
11343	</result>
11344
11345	<note>
11346	This method will have effect only if absolute mouse
11347	positioning is supported by the guest OS.
11348	</note>
11349
11350	<see><link to="#absoluteSupported"/></see>
11351	</desc>
11352
11353	<param name="x" type="long" dir="in">
11354	<desc>
11355	X coordinate of the pointer in pixels, starting from @c 1.
11356	</desc>
11357	</param>
11358	<param name="y" type="long" dir="in">
11359	<desc>
11360	Y coordinate of the pointer in pixels, starting from @c 1.
11361	</desc>
11362	</param>
11363	<param name="dz" type="long" dir="in">
11364	<desc>
11365	Amount of mouse wheel moves.
11366	Positive values describe clockwise wheel rotations,
11367	negative values describe counterclockwise rotations.
11368	</desc>
11369	</param>
11370	<param name="dw" type="long" dir="in">
11371	<desc>
11372	Amount of horizontal mouse wheel moves.
11373	Positive values describe a movement to the left,
11374	negative values describe a movement to the right.
11375	</desc>
11376	</param>
11377	<param name="buttonState" type="long" dir="in">
11378	<desc>
11379	The current state of mouse buttons. Every bit represents
11380	a mouse button as follows:
11381	<table>
11382	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11383	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11384	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11385	</table>
11386	A value of @c 1 means the corresponding button is pressed.
11387	otherwise it is released.
11388	</desc>
11389	</param>
11390	</method>
11391
11392	<attribute name="eventSource" type="IEventSource" readonly="yes">
11393	<desc>
11394	Event source for mouse events.
11395	</desc>
11396	</attribute>
11397
11398	</interface>
11399
11400	<!--
11401	// IDisplay
11402	/////////////////////////////////////////////////////////////////////////
11403	-->
11404
11405	<enum
11406	name="FramebufferPixelFormat"
11407	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11408	>
11409	<desc>
11410	Format of the video memory buffer. Constants represented by this enum can
11411	be used to test for particular values of <link
11412	to="IFramebuffer::pixelFormat"/>. See also <link
11413	to="IFramebuffer::requestResize"/>.
11414
11415	See also www.fourcc.org for more information about FOURCC pixel formats.
11416	</desc>
11417
11418	<const name="Opaque" value="0">
11419	<desc>
11420	Unknown buffer format (the user may not assume any particular format of
11421	the buffer).
11422	</desc>
11423	</const>
11424	<const name="FOURCC_RGB" value="0x32424752">
11425	<desc>
11426	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11427	bit layout).
11428	</desc>
11429	</const>
11430	</enum>
11431
11432	<interface
11433	name="IFramebuffer" extends="$unknown"
11434	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11435	wsmap="suppress"
11436	>
11437	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11438	<desc>Address of the start byte of the frame buffer.</desc>
11439	</attribute>
11440
11441	<attribute name="width" type="unsigned long" readonly="yes">
11442	<desc>Frame buffer width, in pixels.</desc>
11443	</attribute>
11444
11445	<attribute name="height" type="unsigned long" readonly="yes">
11446	<desc>Frame buffer height, in pixels.</desc>
11447	</attribute>
11448
11449	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11450	<desc>
11451	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11452	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11453	are: 8, 15, 16, 24 and 32.
11454	</desc>
11455	</attribute>
11456
11457	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11458	<desc>
11459	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11460	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11461	size of the scan line must be aligned to 32 bits.
11462	</desc>
11463	</attribute>
11464
11465	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11466	<desc>
11467	Frame buffer pixel format. It's either one of the values defined by <link
11468	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11469	<note>
11470	This attribute must never return <link
11471	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11472	<link to="#address"/> points to must be always known.
11473	</note>
11474	</desc>
11475	</attribute>
11476
11477	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11478	<desc>
11479	Defines whether this frame buffer uses the virtual video card's memory
11480	buffer (guest VRAM) directly or not. See <link
11481	to="IFramebuffer::requestResize"/> for more information.
11482	</desc>
11483	</attribute>
11484
11485	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11486	<desc>
11487	Hint from the frame buffer about how much of the standard
11488	screen height it wants to use for itself. This information is
11489	exposed to the guest through the VESA BIOS and VMMDev interface
11490	so that it can use it for determining its video mode table. It
11491	is not guaranteed that the guest respects the value.
11492	</desc>
11493	</attribute>
11494
11495	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11496	<desc>
11497	An alpha-blended overlay which is superposed over the frame buffer.
11498	The initial purpose is to allow the display of icons providing
11499	information about the VM state, including disk activity, in front
11500	ends which do not have other means of doing that. The overlay is
11501	designed to controlled exclusively by IDisplay. It has no locking
11502	of its own, and any changes made to it are not guaranteed to be
11503	visible until the affected portion of IFramebuffer is updated. The
11504	overlay can be created lazily the first time it is requested. This
11505	attribute can also return @c null to signal that the overlay is not
11506	implemented.
11507	</desc>
11508	</attribute>
11509
11510	<attribute name="winId" type="long long" readonly="yes">
11511	<desc>
11512	Platform-dependent identifier of the window where context of this
11513	frame buffer is drawn, or zero if there's no such window.
11514	</desc>
11515	</attribute>
11516
11517	<method name="lock">
11518	<desc>
11519	Locks the frame buffer.
11520	Gets called by the IDisplay object where this frame buffer is
11521	bound to.
11522	</desc>
11523	</method>
11524
11525	<method name="unlock">
11526	<desc>
11527	Unlocks the frame buffer.
11528	Gets called by the IDisplay object where this frame buffer is
11529	bound to.
11530	</desc>
11531	</method>
11532
11533	<method name="notifyUpdate">
11534	<desc>
11535	Informs about an update.
11536	Gets called by the display object where this buffer is
11537	registered.
11538	</desc>
11539	<param name="x" type="unsigned long" dir="in"/>
11540	<param name="y" type="unsigned long" dir="in"/>
11541	<param name="width" type="unsigned long" dir="in"/>
11542	<param name="height" type="unsigned long" dir="in"/>
11543	</method>
11544
11545	<method name="requestResize">
11546	<desc>
11547	Requests a size and pixel format change.
11548
11549	There are two modes of working with the video buffer of the virtual
11550	machine. The <i>indirect</i> mode implies that the IFramebuffer
11551	implementation allocates a memory buffer for the requested display mode
11552	and provides it to the virtual machine. In <i>direct</i> mode, the
11553	IFramebuffer implementation uses the memory buffer allocated and owned
11554	by the virtual machine. This buffer represents the video memory of the
11555	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11556	usually faster because the implementation gets a raw pointer to the
11557	guest VRAM buffer which it can directly use for visualizing the contents
11558	of the virtual display, as opposed to the indirect mode where the
11559	contents of guest VRAM are copied to the memory buffer provided by
11560	the implementation every time a display update occurs.
11561
11562	It is important to note that the direct mode is really fast only when
11563	the implementation uses the given guest VRAM buffer directly, for
11564	example, by blitting it to the window representing the virtual machine's
11565	display, which saves at least one copy operation comparing to the
11566	indirect mode. However, using the guest VRAM buffer directly is not
11567	always possible: the format and the color depth of this buffer may be
11568	not supported by the target window, or it may be unknown (opaque) as in
11569	case of text or non-linear multi-plane VGA video modes. In this case,
11570	the indirect mode (that is always available) should be used as a
11571	fallback: when the guest VRAM contents are copied to the
11572	implementation-provided memory buffer, color and format conversion is
11573	done automatically by the underlying code.
11574
11575	The @a pixelFormat parameter defines whether the direct mode is
11576	available or not. If @a pixelFormat is <link
11577	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11578	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11579	@a bytesPerLine parameters must be ignored and the implementation must use
11580	the indirect mode (where it provides its own buffer in one of the
11581	supported formats). In all other cases, @a pixelFormat together with
11582	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11583	buffer pointed to by the @a VRAM parameter and the implementation is
11584	free to choose which mode to use. To indicate that this frame buffer uses
11585	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11586	attribute must return @c true and <link to="#address"/> must
11587	return exactly the same address that is passed in the @a VRAM parameter
11588	of this method; otherwise it is assumed that the indirect strategy is
11589	chosen.
11590
11591	The @a width and @a height parameters represent the size of the
11592	requested display mode in both modes. In case of indirect mode, the
11593	provided memory buffer should be big enough to store data of the given
11594	display mode. In case of direct mode, it is guaranteed that the given
11595	@a VRAM buffer contains enough space to represent the display mode of the
11596	given size. Note that this frame buffer's <link to="#width"/> and <link
11597	to="#height"/> attributes must return exactly the same values as
11598	passed to this method after the resize is completed (see below).
11599
11600	The @a finished output parameter determines if the implementation has
11601	finished resizing the frame buffer or not. If, for some reason, the
11602	resize cannot be finished immediately during this call, @a finished
11603	must be set to @c false, and the implementation must call
11604	<link to="IDisplay::resizeCompleted"/> after it has returned from
11605	this method as soon as possible. If @a finished is @c false, the
11606	machine will not call any frame buffer methods until
11607	<link to="IDisplay::resizeCompleted"/> is called.
11608
11609	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11610	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11611	this frame buffer must return exactly the same values as specified in the
11612	parameters of this method, after the resize is completed. If the
11613	indirect mode is chosen, these attributes must return values describing
11614	the format of the implementation's own memory buffer <link
11615	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11616	value must always correlate with <link to="#pixelFormat"/>. Note that
11617	the <link to="#pixelFormat"/> attribute must never return <link
11618	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11619
11620	<note>
11621	This method is called by the IDisplay object under the
11622	<link to="#lock"/> provided by this IFramebuffer
11623	implementation. If this method returns @c false in @a finished, then
11624	this lock is not released until
11625	<link to="IDisplay::resizeCompleted"/> is called.
11626	</note>
11627	</desc>
11628	<param name="screenId" type="unsigned long" dir="in">
11629	<desc>
11630	Logical screen number. Must be used in the corresponding call to
11631	<link to="IDisplay::resizeCompleted"/> if this call is made.
11632	</desc>
11633	</param>
11634	<param name="pixelFormat" type="unsigned long" dir="in">
11635	<desc>
11636	Pixel format of the memory buffer pointed to by @a VRAM.
11637	See also <link to="FramebufferPixelFormat"/>.
11638	</desc>
11639	</param>
11640	<param name="VRAM" type="octet" mod="ptr" dir="in">
11641	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11642	</param>
11643	<param name="bitsPerPixel" type="unsigned long" dir="in">
11644	<desc>Color depth, bits per pixel.</desc>
11645	</param>
11646	<param name="bytesPerLine" type="unsigned long" dir="in">
11647	<desc>Size of one scan line, in bytes.</desc>
11648	</param>
11649	<param name="width" type="unsigned long" dir="in">
11650	<desc>Width of the guest display, in pixels.</desc>
11651	</param>
11652	<param name="height" type="unsigned long" dir="in">
11653	<desc>Height of the guest display, in pixels.</desc>
11654	</param>
11655	<param name="finished" type="boolean" dir="return">
11656	<desc>
11657	Can the VM start using the new frame buffer immediately
11658	after this method returns or it should wait for
11659	<link to="IDisplay::resizeCompleted"/>.
11660	</desc>
11661	</param>
11662	</method>
11663
11664	<method name="videoModeSupported">
11665	<desc>
11666	Returns whether the frame buffer implementation is willing to
11667	support a given video mode. In case it is not able to render
11668	the video mode (or for some reason not willing), it should
11669	return @c false. Usually this method is called when the guest
11670	asks the VMM device whether a given video mode is supported
11671	so the information returned is directly exposed to the guest.
11672	It is important that this method returns very quickly.
11673	</desc>
11674	<param name="width" type="unsigned long" dir="in"/>
11675	<param name="height" type="unsigned long" dir="in"/>
11676	<param name="bpp" type="unsigned long" dir="in"/>
11677	<param name="supported" type="boolean" dir="return"/>
11678	</method>
11679
11680	<method name="getVisibleRegion">
11681	<desc>
11682	Returns the visible region of this frame buffer.
11683
11684	If the @a rectangles parameter is @c null then the value of the
11685	@a count parameter is ignored and the number of elements necessary to
11686	describe the current visible region is returned in @a countCopied.
11687
11688	If @a rectangles is not @c null but @a count is less
11689	than the required number of elements to store region data, the method
11690	will report a failure. If @a count is equal or greater than the
11691	required number of elements, then the actual number of elements copied
11692	to the provided array will be returned in @a countCopied.
11693
11694	<note>
11695	The address of the provided array must be in the process space of
11696	this IFramebuffer object.
11697	</note>
11698	<note>
11699	Method not yet implemented.
11700	</note>
11701	</desc>
11702	<param name="rectangles" type="octet" mod="ptr" dir="in">
11703	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11704	</param>
11705	<param name="count" type="unsigned long" dir="in">
11706	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11707	</param>
11708	<param name="countCopied" type="unsigned long" dir="return">
11709	<desc>Number of elements copied to the @a rectangles array.</desc>
11710	</param>
11711	</method>
11712
11713	<method name="setVisibleRegion">
11714	<desc>
11715	Suggests a new visible region to this frame buffer. This region
11716	represents the area of the VM display which is a union of regions of
11717	all top-level windows of the guest operating system running inside the
11718	VM (if the Guest Additions for this system support this
11719	functionality). This information may be used by the frontends to
11720	implement the seamless desktop integration feature.
11721
11722	<note>
11723	The address of the provided array must be in the process space of
11724	this IFramebuffer object.
11725	</note>
11726	<note>
11727	The IFramebuffer implementation must make a copy of the provided
11728	array of rectangles.
11729	</note>
11730	<note>
11731	Method not yet implemented.
11732	</note>
11733	</desc>
11734	<param name="rectangles" type="octet" mod="ptr" dir="in">
11735	<desc>Pointer to the @c RTRECT array.</desc>
11736	</param>
11737	<param name="count" type="unsigned long" dir="in">
11738	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11739	</param>
11740	</method>
11741
11742	<method name="processVHWACommand">
11743	<desc>
11744	Posts a Video HW Acceleration Command to the frame buffer for processing.
11745	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11746	are posted from quest to the host to be processed by the host hardware.
11747
11748	<note>
11749	The address of the provided command must be in the process space of
11750	this IFramebuffer object.
11751	</note>
11752	</desc>
11753
11754	<param name="command" type="octet" mod="ptr" dir="in">
11755	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11756	</param>
11757	</method>
11758
11759	</interface>
11760
11761	<interface
11762	name="IFramebufferOverlay" extends="IFramebuffer"
11763	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11764	wsmap="suppress"
11765	>
11766	<desc>
11767	The IFramebufferOverlay interface represents an alpha blended overlay
11768	for displaying status icons above an IFramebuffer. It is always created
11769	not visible, so that it must be explicitly shown. It only covers a
11770	portion of the IFramebuffer, determined by its width, height and
11771	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11772	that order) format, and may be written to directly. Do re-read the
11773	width though, after setting it, as it may be adjusted (increased) to
11774	make it more suitable for the front end.
11775	</desc>
11776	<attribute name="x" type="unsigned long" readonly="yes">
11777	<desc>X position of the overlay, relative to the frame buffer.</desc>
11778	</attribute>
11779
11780	<attribute name="y" type="unsigned long" readonly="yes">
11781	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11782	</attribute>
11783
11784	<attribute name="visible" type="boolean" readonly="no">
11785	<desc>
11786	Whether the overlay is currently visible.
11787	</desc>
11788	</attribute>
11789
11790	<attribute name="alpha" type="unsigned long" readonly="no">
11791	<desc>
11792	The global alpha value for the overlay. This may or may not be
11793	supported by a given front end.
11794	</desc>
11795	</attribute>
11796
11797	<method name="move">
11798	<desc>
11799	Changes the overlay's position relative to the IFramebuffer.
11800	</desc>
11801	<param name="x" type="unsigned long" dir="in"/>
11802	<param name="y" type="unsigned long" dir="in"/>
11803	</method>
11804
11805	</interface>
11806
11807	<interface
11808	name="IDisplay" extends="$unknown"
11809	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11810	wsmap="managed"
11811	>
11812	<desc>
11813	The IDisplay interface represents the virtual machine's display.
11814
11815	The object implementing this interface is contained in each
11816	<link to="IConsole::display"/> attribute and represents the visual
11817	output of the virtual machine.
11818
11819	The virtual display supports pluggable output targets represented by the
11820	IFramebuffer interface. Examples of the output target are a window on
11821	the host computer or an RDP session's display on a remote computer.
11822	</desc>
11823	<method name="getScreenResolution">
11824	<desc>Queries display width, height and color depth for given screen.</desc>
11825	<param name="screenId" type="unsigned long" dir="in"/>
11826	<param name="width" type="unsigned long" dir="out"/>
11827	<param name="height" type="unsigned long" dir="out"/>
11828	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11829	</method>
11830
11831	<method name="setFramebuffer">
11832	<desc>
11833	Sets the framebuffer for given screen.
11834	</desc>
11835	<param name="screenId" type="unsigned long" dir="in"/>
11836	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11837	</method>
11838
11839	<method name="getFramebuffer">
11840	<desc>
11841	Queries the framebuffer for given screen.
11842	</desc>
11843	<param name="screenId" type="unsigned long" dir="in"/>
11844	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11845	<param name="xOrigin" type="long" dir="out"/>
11846	<param name="yOrigin" type="long" dir="out"/>
11847	</method>
11848
11849	<method name="setVideoModeHint">
11850	<desc>
11851	Asks VirtualBox to request the given video mode from
11852	the guest. This is just a hint and it cannot be guaranteed
11853	that the requested resolution will be used. Guest Additions
11854	are required for the request to be seen by guests. The caller
11855	should issue the request and wait for a resolution change and
11856	after a timeout retry.
11857
11858	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11859	parameters means that the corresponding values should be taken from the
11860	current video mode (i.e. left unchanged).
11861
11862	If the guest OS supports multi-monitor configuration then the @a display
11863	parameter specifies the number of the guest display to send the hint to:
11864	@c 0 is the primary display, @c 1 is the first secondary and
11865	so on. If the multi-monitor configuration is not supported, @a display
11866	must be @c 0.
11867
11868	<result name="E_INVALIDARG">
11869	The @a display is not associated with any monitor.
11870	</result>
11871
11872	</desc>
11873	<param name="width" type="unsigned long" dir="in"/>
11874	<param name="height" type="unsigned long" dir="in"/>
11875	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11876	<param name="display" type="unsigned long" dir="in"/>
11877	</method>
11878
11879	<method name="setSeamlessMode">
11880	<desc>
11881	Enables or disables seamless guest display rendering (seamless desktop
11882	integration) mode.
11883	<note>
11884	Calling this method has no effect if <link
11885	to="IGuest::getFacilityStatus"/> with facility <link to="AdditionsFacilityType::Seamless"/>
11886	does not return <link to="AdditionsFacilityStatus::Active"/>.
11887	</note>
11888	</desc>
11889	<param name="enabled" type="boolean" dir="in"/>
11890	</method>
11891
11892	<method name="takeScreenShot">
11893	<desc>
11894	Takes a screen shot of the requested size and copies it to the
11895	32-bpp buffer allocated by the caller and pointed to by @a address.
11896	A pixel consists of 4 bytes in order: B, G, R, 0.
11897
11898	<note>This API can be used only locally by a VM process through the
11899	COM/XPCOM C++ API as it requires pointer support. It is not
11900	available for scripting langages, Java or any webservice clients.
11901	Unless you are writing a new VM frontend use
11902	<link to="#takeScreenShotToArray" />.
11903	</note>
11904
11905	<result name="E_NOTIMPL">
11906	Feature not implemented.
11907	</result>
11908	<result name="VBOX_E_IPRT_ERROR">
11909	Could not take a screenshot.
11910	</result>
11911
11912	</desc>
11913	<param name="screenId" type="unsigned long" dir="in"/>
11914	<param name="address" type="octet" mod="ptr" dir="in"/>
11915	<param name="width" type="unsigned long" dir="in"/>
11916	<param name="height" type="unsigned long" dir="in"/>
11917	</method>
11918
11919	<method name="takeScreenShotToArray">
11920	<desc>
11921	Takes a guest screen shot of the requested size and returns it as
11922	an array of bytes in uncompressed 32-bit RGBA format.
11923	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11924
11925	This API is slow, but could be the only option to get guest screenshot
11926	for scriptable languages not allowed to manipulate with addresses
11927	directly.
11928
11929	<result name="E_NOTIMPL">
11930	Feature not implemented.
11931	</result>
11932	<result name="VBOX_E_IPRT_ERROR">
11933	Could not take a screenshot.
11934	</result>
11935	</desc>
11936	<param name="screenId" type="unsigned long" dir="in">
11937	<desc>
11938	Monitor to take screenshot from.
11939	</desc>
11940	</param>
11941	<param name="width" type="unsigned long" dir="in">
11942	<desc>
11943	Desired image width.
11944	</desc>
11945	</param>
11946	<param name="height" type="unsigned long" dir="in">
11947	<desc>
11948	Desired image height.
11949	</desc>
11950	</param>
11951	<param name="screenData" type="octet" dir="return" safearray="yes">
11952	<desc>
11953	Array with resulting screen data.
11954	</desc>
11955	</param>
11956	</method>
11957
11958	<method name="takeScreenShotPNGToArray">
11959	<desc>
11960	Takes a guest screen shot of the requested size and returns it as
11961	PNG image in array.
11962
11963	<result name="E_NOTIMPL">
11964	Feature not implemented.
11965	</result>
11966	<result name="VBOX_E_IPRT_ERROR">
11967	Could not take a screenshot.
11968	</result>
11969	</desc>
11970	<param name="screenId" type="unsigned long" dir="in">
11971	<desc>
11972	Monitor to take the screenshot from.
11973	</desc>
11974	</param>
11975	<param name="width" type="unsigned long" dir="in">
11976	<desc>
11977	Desired image width.
11978	</desc>
11979	</param>
11980	<param name="height" type="unsigned long" dir="in">
11981	<desc>
11982	Desired image height.
11983	</desc>
11984	</param>
11985	<param name="screenData" type="octet" dir="return" safearray="yes">
11986	<desc>
11987	Array with resulting screen data.
11988	</desc>
11989	</param>
11990	</method>
11991
11992	<method name="drawToScreen">
11993	<desc>
11994	Draws a 32-bpp image of the specified size from the given buffer
11995	to the given point on the VM display.
11996
11997	<result name="E_NOTIMPL">
11998	Feature not implemented.
11999	</result>
12000	<result name="VBOX_E_IPRT_ERROR">
12001	Could not draw to screen.
12002	</result>
12003
12004	</desc>
12005	<param name="screenId" type="unsigned long" dir="in">
12006	<desc>
12007	Monitor to take the screenshot from.
12008	</desc>
12009	</param>
12010	<param name="address" type="octet" mod="ptr" dir="in">
12011	<desc>
12012	Address to store the screenshot to
12013	</desc>
12014	</param>
12015	<param name="x" type="unsigned long" dir="in">
12016	<desc>
12017	Relative to the screen top left corner.
12018	</desc>
12019	</param>
12020	<param name="y" type="unsigned long" dir="in">
12021	<desc>
12022	Relative to the screen top left corner.
12023	</desc>
12024	</param>
12025	<param name="width" type="unsigned long" dir="in">
12026	<desc>
12027	Desired image width.
12028	</desc>
12029	</param>
12030	<param name="height" type="unsigned long" dir="in">
12031	<desc>
12032	Desired image height.
12033	</desc>
12034	</param>
12035	</method>
12036
12037	<method name="invalidateAndUpdate">
12038	<desc>
12039	Does a full invalidation of the VM display and instructs the VM
12040	to update it.
12041
12042	<result name="VBOX_E_IPRT_ERROR">
12043	Could not invalidate and update screen.
12044	</result>
12045
12046	</desc>
12047	</method>
12048
12049	<method name="resizeCompleted">
12050	<desc>
12051	Signals that a framebuffer has completed the resize operation.
12052
12053	<result name="VBOX_E_NOT_SUPPORTED">
12054	Operation only valid for external frame buffers.
12055	</result>
12056
12057	</desc>
12058	<param name="screenId" type="unsigned long" dir="in"/>
12059	</method>
12060
12061	<method name="completeVHWACommand">
12062	<desc>
12063	Signals that the Video HW Acceleration command has completed.
12064	</desc>
12065
12066	<param name="command" type="octet" mod="ptr" dir="in">
12067	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12068	</param>
12069	</method>
12070
12071	</interface>
12072
12073	<!--
12074	// INetworkAdapter
12075	/////////////////////////////////////////////////////////////////////////
12076	-->
12077
12078	<enum
12079	name="NetworkAttachmentType"
12080	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12081	>
12082	<desc>
12083	Network attachment type.
12084	</desc>
12085
12086	<const name="Null" value="0">
12087	<desc>Null value, also means "not attached".</desc>
12088	</const>
12089	<const name="NAT" value="1"/>
12090	<const name="Bridged" value="2"/>
12091	<const name="Internal" value="3"/>
12092	<const name="HostOnly" value="4"/>
12093	<const name="Generic" value="5"/>
12094	</enum>
12095
12096	<enum
12097	name="NetworkAdapterType"
12098	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12099	>
12100	<desc>
12101	Network adapter type.
12102	</desc>
12103
12104	<const name="Null" value="0">
12105	<desc>Null value (never used by the API).</desc>
12106	</const>
12107	<const name="Am79C970A" value="1">
12108	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12109	</const>
12110	<const name="Am79C973" value="2">
12111	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12112	</const>
12113	<const name="I82540EM" value="3">
12114	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12115	</const>
12116	<const name="I82543GC" value="4">
12117	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12118	</const>
12119	<const name="I82545EM" value="5">
12120	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12121	</const>
12122	<const name="Virtio" value="6">
12123	<desc>Virtio network device.</desc>
12124	</const>
12125	</enum>
12126
12127	<enum
12128	name="NetworkAdapterPromiscModePolicy"
12129	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12130	>
12131	<desc>
12132	The promiscuous mode policy of an interface.
12133	</desc>
12134
12135	<const name="Deny" value="1">
12136	<desc>Deny promiscuous mode requests.</desc>
12137	</const>
12138	<const name="AllowNetwork" value="2">
12139	<desc>
12140	Allow promicuous mode, but restrict the scope it to the internal
12141	network so that it only applies to other VMs.
12142	</desc>
12143	</const>
12144	<const name="AllowAll" value="3">
12145	<desc>
12146	Allow promicuous mode, include unrelated traffic going over the wire
12147	and internally on the host.
12148	</desc>
12149	</const>
12150	</enum>
12151
12152	<interface
12153	name="INetworkAdapter" extends="$unknown"
12154	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12155	wsmap="managed"
12156	>
12157	<desc>
12158	Represents a virtual network adapter that is attached to a virtual machine.
12159	Each virtual machine has a fixed number of network adapter slots with one
12160	instance of this attached to each of them. Call
12161	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12162	is attached to a given slot in a given machine.
12163
12164	Each network adapter can be in one of five attachment modes, which are
12165	represented by the <link to="NetworkAttachmentType" /> enumeration;
12166	see the <link to="#attachmentType" /> attribute.
12167	</desc>
12168
12169	<attribute name="adapterType" type="NetworkAdapterType">
12170	<desc>
12171	Type of the virtual network adapter. Depending on this value,
12172	VirtualBox will provide a different virtual network hardware
12173	to the guest.
12174	</desc>
12175	</attribute>
12176
12177	<attribute name="slot" type="unsigned long" readonly="yes">
12178	<desc>
12179	Slot number this adapter is plugged into. Corresponds to
12180	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12181	to obtain this instance.
12182	</desc>
12183	</attribute>
12184
12185	<attribute name="enabled" type="boolean">
12186	<desc>
12187	Flag whether the network adapter is present in the
12188	guest system. If disabled, the virtual guest hardware will
12189	not contain this network adapter. Can only be changed when
12190	the VM is not running.
12191	</desc>
12192	</attribute>
12193
12194	<attribute name="MACAddress" type="wstring">
12195	<desc>
12196	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
12197	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
12198	</desc>
12199	</attribute>
12200
12201	<attribute name="attachmentType" type="NetworkAttachmentType">
12202	<desc>
12203	Sets/Gets network attachment type of this network adapter.
12204	</desc>
12205	</attribute>
12206
12207	<attribute name="bridgedInterface" type="wstring">
12208	<desc>
12209	Name of the network interface the VM should be bridged to.
12210	</desc>
12211	</attribute>
12212
12213	<attribute name="hostOnlyInterface" type="wstring">
12214	<desc>
12215	Name of the host only network interface the VM is attached to.
12216	</desc>
12217	</attribute>
12218
12219	<attribute name="internalNetwork" type="wstring">
12220	<desc>
12221	Name of the internal network the VM is attached to.
12222	</desc>
12223	</attribute>
12224
12225	<attribute name="NATNetwork" type="wstring">
12226	<desc>
12227	Name of the NAT network the VM is attached to.
12228	</desc>
12229	</attribute>
12230
12231	<attribute name="genericDriver" type="wstring">
12232	<desc>
12233	Name of the driver to use for the "Generic" network attachment type.
12234	</desc>
12235	</attribute>
12236
12237	<attribute name="cableConnected" type="boolean">
12238	<desc>
12239	Flag whether the adapter reports the cable as connected or not.
12240	It can be used to report offline situations to a VM.
12241	</desc>
12242	</attribute>
12243
12244	<attribute name="lineSpeed" type="unsigned long">
12245	<desc>
12246	Line speed reported by custom drivers, in units of 1 kbps.
12247	</desc>
12248	</attribute>
12249
12250	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
12251	<desc>
12252	The promiscuous mode policy of the network adapter when attached to an
12253	internal network, host only network or a bridge.
12254	</desc>
12255	</attribute>
12256
12257	<attribute name="traceEnabled" type="boolean">
12258	<desc>
12259	Flag whether network traffic from/to the network card should be traced.
12260	Can only be toggled when the VM is turned off.
12261	</desc>
12262	</attribute>
12263
12264	<attribute name="traceFile" type="wstring">
12265	<desc>
12266	Filename where a network trace will be stored. If not set, VBox-pid.pcap
12267	will be used.
12268	</desc>
12269	</attribute>
12270
12271	<attribute name="natDriver" type="INATEngine" readonly="yes">
12272	<desc>
12273	Points to the NAT engine which handles the network address translation
12274	for this interface. This is active only when the interface actually uses
12275	NAT.
12276	</desc>
12277	</attribute>
12278
12279	<attribute name="bootPriority" type="unsigned long">
12280	<desc>
12281	Network boot priority of the adapter. Priority 1 is highest. If not set,
12282	the priority is considered to be at the lowest possible setting.
12283	</desc>
12284	</attribute>
12285
12286	<attribute name="bandwidthGroup" type="IBandwidthGroup">
12287	<desc>The bandwidth group this network adapter is assigned to.</desc>
12288	</attribute>
12289
12290	<!-- property methods -->
12291
12292	<method name="getProperty" const="yes">
12293	<desc>
12294	Returns the value of the network attachment property with the given name.
12295
12296	If the requested data @a key does not exist, this function will
12297	succeed and return an empty string in the @a value argument.
12298
12299	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12300	</desc>
12301	<param name="key" type="wstring" dir="in">
12302	<desc>Name of the property to get.</desc>
12303	</param>
12304	<param name="value" type="wstring" dir="return">
12305	<desc>Current property value.</desc>
12306	</param>
12307	</method>
12308
12309	<method name="setProperty">
12310	<desc>
12311	Sets the value of the network attachment property with the given name.
12312
12313	Setting the property value to @c null or an empty string is equivalent
12314	to deleting the existing value.
12315
12316	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12317	</desc>
12318	<param name="key" type="wstring" dir="in">
12319	<desc>Name of the property to set.</desc>
12320	</param>
12321	<param name="value" type="wstring" dir="in">
12322	<desc>Property value to set.</desc>
12323	</param>
12324	</method>
12325
12326	<method name="getProperties" const="yes">
12327	<desc>
12328	Returns values for a group of properties in one call.
12329
12330	The names of the properties to get are specified using the @a names
12331	argument which is a list of comma-separated property names or
12332	an empty string if all properties are to be returned.
12333	<note>Currently the value of this argument is ignored and the method
12334	always returns all existing properties.</note>
12335
12336	The method returns two arrays, the array of property names corresponding
12337	to the @a names argument and the current values of these properties.
12338	Both arrays have the same number of elements with each element at the
12339	given index in the first array corresponds to an element at the same
12340	index in the second array.
12341	</desc>
12342	<param name="names" type="wstring" dir="in">
12343	<desc>
12344	Names of properties to get.
12345	</desc>
12346	</param>
12347	<param name="returnNames" type="wstring" safearray="yes" dir="out">
12348	<desc>Names of returned properties.</desc>
12349	</param>
12350	<param name="returnValues" type="wstring" safearray="yes" dir="return">
12351	<desc>Values of returned properties.</desc>
12352	</param>
12353	</method>
12354
12355	</interface>
12356
12357
12358	<!--
12359	// ISerialPort
12360	/////////////////////////////////////////////////////////////////////////
12361	-->
12362
12363	<enum
12364	name="PortMode"
12365	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
12366	>
12367	<desc>
12368	The PortMode enumeration represents possible communication modes for
12369	the virtual serial port device.
12370	</desc>
12371
12372	<const name="Disconnected" value="0">
12373	<desc>Virtual device is not attached to any real host device.</desc>
12374	</const>
12375	<const name="HostPipe" value="1">
12376	<desc>Virtual device is attached to a host pipe.</desc>
12377	</const>
12378	<const name="HostDevice" value="2">
12379	<desc>Virtual device is attached to a host device.</desc>
12380	</const>
12381	<const name="RawFile" value="3">
12382	<desc>Virtual device is attached to a raw file.</desc>
12383	</const>
12384	</enum>
12385
12386	<interface
12387	name="ISerialPort" extends="$unknown"
12388	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
12389	wsmap="managed"
12390	>
12391
12392	<desc>
12393	The ISerialPort interface represents the virtual serial port device.
12394
12395	The virtual serial port device acts like an ordinary serial port
12396	inside the virtual machine. This device communicates to the real
12397	serial port hardware in one of two modes: host pipe or host device.
12398
12399	In host pipe mode, the #path attribute specifies the path to the pipe on
12400	the host computer that represents a serial port. The #server attribute
12401	determines if this pipe is created by the virtual machine process at
12402	machine startup or it must already exist before starting machine
12403	execution.
12404
12405	In host device mode, the #path attribute specifies the name of the
12406	serial port device on the host computer.
12407
12408	There is also a third communication mode: the disconnected mode. In this
12409	mode, the guest OS running inside the virtual machine will be able to
12410	detect the serial port, but all port write operations will be discarded
12411	and all port read operations will return no data.
12412
12413	<see><link to="IMachine::getSerialPort"/></see>
12414	</desc>
12415
12416	<attribute name="slot" type="unsigned long" readonly="yes">
12417	<desc>
12418	Slot number this serial port is plugged into. Corresponds to
12419	the value you pass to <link to="IMachine::getSerialPort"/>
12420	to obtain this instance.
12421	</desc>
12422	</attribute>
12423
12424	<attribute name="enabled" type="boolean">
12425	<desc>
12426	Flag whether the serial port is enabled. If disabled,
12427	the serial port will not be reported to the guest OS.
12428	</desc>
12429	</attribute>
12430
12431	<attribute name="IOBase" type="unsigned long">
12432	<desc>Base I/O address of the serial port.</desc>
12433	</attribute>
12434
12435	<attribute name="IRQ" type="unsigned long">
12436	<desc>IRQ number of the serial port.</desc>
12437	</attribute>
12438
12439	<attribute name="hostMode" type="PortMode">
12440	<desc>
12441	How is this port connected to the host.
12442	<note>
12443	Changing this attribute may fail if the conditions for
12444	<link to="#path"/> are not met.
12445	</note>
12446	</desc>
12447	</attribute>
12448
12449	<attribute name="server" type="boolean">
12450	<desc>
12451	Flag whether this serial port acts as a server (creates a new pipe on
12452	the host) or as a client (uses the existing pipe). This attribute is
12453	used only when <link to="#hostMode"/> is PortMode_HostPipe.
12454	</desc>
12455	</attribute>
12456
12457	<attribute name="path" type="wstring">
12458	<desc>
12459	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
12460	PortMode_HostPipe, or the host serial device name when
12461	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
12462	cases, setting a @c null or empty string as the attribute's value
12463	is an error. Otherwise, the value of this property is ignored.
12464	</desc>
12465	</attribute>
12466
12467	</interface>
12468
12469	<!--
12470	// IParallelPort
12471	/////////////////////////////////////////////////////////////////////////
12472	-->
12473
12474	<interface
12475	name="IParallelPort" extends="$unknown"
12476	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
12477	wsmap="managed"
12478	>
12479
12480	<desc>
12481	The IParallelPort interface represents the virtual parallel port device.
12482
12483	The virtual parallel port device acts like an ordinary parallel port
12484	inside the virtual machine. This device communicates to the real
12485	parallel port hardware using the name of the parallel device on the host
12486	computer specified in the #path attribute.
12487
12488	Each virtual parallel port device is assigned a base I/O address and an
12489	IRQ number that will be reported to the guest operating system and used
12490	to operate the given parallel port from within the virtual machine.
12491
12492	<see><link to="IMachine::getParallelPort"/></see>
12493	</desc>
12494
12495	<attribute name="slot" type="unsigned long" readonly="yes">
12496	<desc>
12497	Slot number this parallel port is plugged into. Corresponds to
12498	the value you pass to <link to="IMachine::getParallelPort"/>
12499	to obtain this instance.
12500	</desc>
12501	</attribute>
12502
12503	<attribute name="enabled" type="boolean">
12504	<desc>
12505	Flag whether the parallel port is enabled. If disabled,
12506	the parallel port will not be reported to the guest OS.
12507	</desc>
12508	</attribute>
12509
12510	<attribute name="IOBase" type="unsigned long">
12511	<desc>Base I/O address of the parallel port.</desc>
12512	</attribute>
12513
12514	<attribute name="IRQ" type="unsigned long">
12515	<desc>IRQ number of the parallel port.</desc>
12516	</attribute>
12517
12518	<attribute name="path" type="wstring">
12519	<desc>
12520	Host parallel device name. If this parallel port is enabled, setting a
12521	@c null or an empty string as this attribute's value will result in
12522	an error.
12523	</desc>
12524	</attribute>
12525
12526	</interface>
12527
12528
12529	<!--
12530	// IMachineDebugger
12531	/////////////////////////////////////////////////////////////////////////
12532	-->
12533
12534	<interface
12535	name="IMachineDebugger" extends="$unknown"
12536	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
12537	wsmap="suppress"
12538	>
12539	<method name="dumpGuestCore">
12540	<desc>
12541	Takes a core dump of the guest.
12542
12543	See include/VBox/dbgfcorefmt.h for details on the file format.
12544	</desc>
12545	<param name="filename" type="wstring" dir="in">
12546	<desc>
12547	The name of the output file. The file must not exist.
12548	</desc>
12549	</param>
12550	<param name="compression" type="wstring" dir="in">
12551	<desc>
12552	Reserved for future compression method indicator.
12553	</desc>
12554	</param>
12555	</method>
12556
12557	<method name="dumpHostProcessCore">
12558	<desc>
12559	Takes a core dump of the VM process on the host.
12560
12561	This feature is not implemented in the 4.0.0 release but it may show up
12562	in a dot release.
12563	</desc>
12564	<param name="filename" type="wstring" dir="in">
12565	<desc>
12566	The name of the output file. The file must not exist.
12567	</desc>
12568	</param>
12569	<param name="compression" type="wstring" dir="in">
12570	<desc>
12571	Reserved for future compression method indicator.
12572	</desc>
12573	</param>
12574	</method>
12575
12576	<method name="info">
12577	<desc>
12578	Interfaces with the info dumpers (DBGFInfo).
12579
12580	This feature is not implemented in the 4.0.0 release but it may show up
12581	in a dot release.
12582	</desc>
12583	<param name="name" type="wstring" dir="in">
12584	<desc>
12585	The name of the info item.
12586	</desc>
12587	</param>
12588	<param name="args" type="wstring" dir="in">
12589	<desc>
12590	Arguments to the info dumper.
12591	</desc>
12592	</param>
12593	<param name="info" type="wstring" dir="return">
12594	<desc>
12595	The into string.
12596	</desc>
12597	</param>
12598	</method>
12599
12600	<method name="injectNMI">
12601	<desc>
12602	Inject an NMI into a running VT-x/AMD-V VM.
12603	</desc>
12604	</method>
12605
12606	<method name="modifyLogGroups">
12607	<desc>
12608	Modifies the group settings of the debug logger.
12609
12610	This feature is not implemented in the 4.0.0 release but may show up
12611	in a dot release.
12612	</desc>
12613	<param name="settings" type="wstring" dir="in">
12614	<desc>The group settings string. See iprt/log.h for details.</desc>
12615	</param>
12616	</method>
12617
12618	<method name="modifyLogFlags">
12619	<desc>
12620	Modifies the debug logger flags.
12621
12622	This feature is not implemented in the 4.0.0 release but may show up
12623	in a dot release.
12624	</desc>
12625	<param name="settings" type="wstring" dir="in">
12626	<desc>The flags settings string. See iprt/log.h for details.</desc>
12627	</param>
12628	</method>
12629
12630	<method name="modifyLogDestinations">
12631	<desc>
12632	Modifies the debug logger destinations.
12633
12634	This feature is not implemented in the 4.0.0 release but may show up
12635	in a dot release.
12636	</desc>
12637	<param name="settings" type="wstring" dir="in">
12638	<desc>The destination settings string. See iprt/log.h for details.</desc>
12639	</param>
12640	</method>
12641
12642	<method name="readPhysicalMemory">
12643	<desc>
12644	Reads guest physical memory, no side effects (MMIO++).
12645
12646	This feature is not implemented in the 4.0.0 release but may show up
12647	in a dot release.
12648	</desc>
12649	<param name="address" type="long long" dir="in">
12650	<desc>The guest physical address.</desc>
12651	</param>
12652	<param name="size" type="unsigned long" dir="in">
12653	<desc>The number of bytes to read.</desc>
12654	</param>
12655	<param name="bytes" type="octet" safearray="yes" dir="return">
12656	<desc>The bytes read.</desc>
12657	</param>
12658	</method>
12659
12660	<method name="writePhysicalMemory">
12661	<desc>
12662	Writes guest physical memory, access handles (MMIO++) are ignored.
12663
12664	This feature is not implemented in the 4.0.0 release but may show up
12665	in a dot release.
12666	</desc>
12667	<param name="address" type="long long" dir="in">
12668	<desc>The guest physical address.</desc>
12669	</param>
12670	<param name="size" type="unsigned long" dir="in">
12671	<desc>The number of bytes to read.</desc>
12672	</param>
12673	<param name="bytes" type="octet" safearray="yes" dir="in">
12674	<desc>The bytes to write.</desc>
12675	</param>
12676	</method>
12677
12678	<method name="readVirtualMemory">
12679	<desc>
12680	Reads guest virtual memory, no side effects (MMIO++).
12681
12682	This feature is not implemented in the 4.0.0 release but may show up
12683	in a dot release.
12684	</desc>
12685	<param name="cpuId" type="unsigned long" dir="in">
12686	<desc>The identifier of the Virtual CPU.</desc>
12687	</param>
12688	<param name="address" type="long long" dir="in">
12689	<desc>The guest virtual address.</desc>
12690	</param>
12691	<param name="size" type="unsigned long" dir="in">
12692	<desc>The number of bytes to read.</desc>
12693	</param>
12694	<param name="bytes" type="octet" safearray="yes" dir="return">
12695	<desc>The bytes read.</desc>
12696	</param>
12697	</method>
12698
12699	<method name="writeVirtualMemory">
12700	<desc>
12701	Writes guest virtual memory, access handles (MMIO++) are ignored.
12702
12703	This feature is not implemented in the 4.0.0 release but may show up
12704	in a dot release.
12705	</desc>
12706	<param name="cpuId" type="unsigned long" dir="in">
12707	<desc>The identifier of the Virtual CPU.</desc>
12708	</param>
12709	<param name="address" type="long long" dir="in">
12710	<desc>The guest virtual address.</desc>
12711	</param>
12712	<param name="size" type="unsigned long" dir="in">
12713	<desc>The number of bytes to read.</desc>
12714	</param>
12715	<param name="bytes" type="octet" safearray="yes" dir="in">
12716	<desc>The bytes to write.</desc>
12717	</param>
12718	</method>
12719
12720	<method name="detectOS">
12721	<desc>
12722	Tries to (re-)detect the guest OS kernel.
12723
12724	This feature is not implemented in the 4.0.0 release but may show up
12725	in a dot release.
12726	</desc>
12727	<param name="os" type="wstring" dir="return">
12728	<desc>
12729	The detected OS kernel on success.
12730	</desc>
12731	</param>
12732	</method>
12733
12734	<method name="getRegister">
12735	<desc>
12736	Gets one register.
12737
12738	This feature is not implemented in the 4.0.0 release but may show up
12739	in a dot release.
12740	</desc>
12741	<param name="cpuId" type="unsigned long" dir="in">
12742	<desc>The identifier of the Virtual CPU.</desc>
12743	</param>
12744	<param name="name" type="wstring" dir="in">
12745	<desc>The register name, case is ignored.</desc>
12746	</param>
12747	<param name="value" type="wstring" dir="return">
12748	<desc>
12749	The register value. This is usually a hex value (always 0x prefixed)
12750	but other format may be used for floating point registers (TBD).
12751	</desc>
12752	</param>
12753	</method>
12754
12755	<method name="getRegisters">
12756	<desc>
12757	Gets all the registers for the given CPU.
12758
12759	This feature is not implemented in the 4.0.0 release but may show up
12760	in a dot release.
12761	</desc>
12762	<param name="cpuId" type="unsigned long" dir="in">
12763	<desc>The identifier of the Virtual CPU.</desc>
12764	</param>
12765	<param name="names" type="wstring" dir="out" safearray="yes">
12766	<desc>Array containing the lowercase register names.</desc>
12767	</param>
12768	<param name="values" type="wstring" dir="out" safearray="yes">
12769	<desc>
12770	Array paralell to the names holding the register values as if the
12771	register was returned by <link to="IMachineDebugger::getRegister"/>.
12772	</desc>
12773	</param>
12774	</method>
12775
12776	<method name="setRegister">
12777	<desc>
12778	Gets one register.
12779
12780	This feature is not implemented in the 4.0.0 release but may show up
12781	in a dot release.
12782	</desc>
12783	<param name="cpuId" type="unsigned long" dir="in">
12784	<desc>The identifier of the Virtual CPU.</desc>
12785	</param>
12786	<param name="name" type="wstring" dir="in">
12787	<desc>The register name, case is ignored.</desc>
12788	</param>
12789	<param name="value" type="wstring" dir="in">
12790	<desc>
12791	The new register value. Hexadecimal, decimal and octal formattings
12792	are supported in addition to any special formattings returned by
12793	the getters.
12794	</desc>
12795	</param>
12796	</method>
12797
12798	<method name="setRegisters">
12799	<desc>
12800	Sets zero or more registers atomically.
12801
12802	This feature is not implemented in the 4.0.0 release but may show up
12803	in a dot release.
12804	</desc>
12805	<param name="cpuId" type="unsigned long" dir="in">
12806	<desc>The identifier of the Virtual CPU.</desc>
12807	</param>
12808	<param name="names" type="wstring" dir="in" safearray="yes">
12809	<desc>Array containing the register names, case ignored.</desc>
12810	</param>
12811	<param name="values" type="wstring" dir="in" safearray="yes">
12812	<desc>
12813	Array paralell to the names holding the register values. See
12814	<link to="IMachineDebugger::setRegister"/> for formatting
12815	guidelines.
12816	</desc>
12817	</param>
12818	</method>
12819
12820	<method name="dumpGuestStack">
12821	<desc>
12822	Produce a simple stack dump using the current guest state.
12823
12824	This feature is not implemented in the 4.0.0 release but may show up
12825	in a dot release.
12826	</desc>
12827	<param name="cpuId" type="unsigned long" dir="in">
12828	<desc>The identifier of the Virtual CPU.</desc>
12829	</param>
12830	<param name="stack" type="wstring" dir="return">
12831	<desc>String containing the formatted stack dump.</desc>
12832	</param>
12833	</method>
12834
12835	<method name="resetStats">
12836	<desc>
12837	Reset VM statistics.
12838	</desc>
12839	<param name="pattern" type="wstring" dir="in">
12840	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12841	</param>
12842	</method>
12843
12844	<method name="dumpStats">
12845	<desc>
12846	Dumps VM statistics.
12847	</desc>
12848	<param name="pattern" type="wstring" dir="in">
12849	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12850	</param>
12851	</method>
12852
12853	<method name="getStats">
12854	<desc>
12855	Get the VM statistics in a XMLish format.
12856	</desc>
12857	<param name="pattern" type="wstring" dir="in">
12858	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12859	</param>
12860	<param name="withDescriptions" type="boolean" dir="in">
12861	<desc>Whether to include the descriptions.</desc>
12862	</param>
12863	<param name="stats" type="wstring" dir="out">
12864	<desc>The XML document containing the statistics.</desc>
12865	</param>
12866	</method>
12867
12868	<attribute name="singlestep" type="boolean">
12869	<desc>Switch for enabling singlestepping.</desc>
12870	</attribute>
12871
12872	<attribute name="recompileUser" type="boolean">
12873	<desc>Switch for forcing code recompilation for user mode code.</desc>
12874	</attribute>
12875
12876	<attribute name="recompileSupervisor" type="boolean">
12877	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12878	</attribute>
12879
12880	<attribute name="PATMEnabled" type="boolean">
12881	<desc>Switch for enabling and disabling the PATM component.</desc>
12882	</attribute>
12883
12884	<attribute name="CSAMEnabled" type="boolean">
12885	<desc>Switch for enabling and disabling the CSAM component.</desc>
12886	</attribute>
12887
12888	<attribute name="logEnabled" type="boolean">
12889	<desc>Switch for enabling and disabling the debug logger.</desc>
12890	</attribute>
12891
12892	<attribute name="logFlags" type="wstring" readonly="yes">
12893	<desc>The debug logger flags.</desc>
12894	</attribute>
12895
12896	<attribute name="logGroups" type="wstring" readonly="yes">
12897	<desc>The debug logger's group settings.</desc>
12898	</attribute>
12899
12900	<attribute name="logDestinations" type="wstring" readonly="yes">
12901	<desc>The debug logger's destination settings.</desc>
12902	</attribute>
12903
12904	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12905	<desc>
12906	Flag indicating whether the VM is currently making use of CPU hardware
12907	virtualization extensions.
12908	</desc>
12909	</attribute>
12910
12911	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12912	<desc>
12913	Flag indicating whether the VM is currently making use of the nested paging
12914	CPU hardware virtualization extension.
12915	</desc>
12916	</attribute>
12917
12918	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12919	<desc>
12920	Flag indicating whether the VM is currently making use of the VPID
12921	VT-x extension.
12922	</desc>
12923	</attribute>
12924
12925	<attribute name="OSName" type="wstring" readonly="yes">
12926	<desc>
12927	Query the guest OS kernel name as detected by the DBGF.
12928
12929	This feature is not implemented in the 4.0.0 release but may show up
12930	in a dot release.
12931	</desc>
12932	</attribute>
12933
12934	<attribute name="OSVersion" type="wstring" readonly="yes">
12935	<desc>
12936	Query the guest OS kernel version string as detected by the DBGF.
12937
12938	This feature is not implemented in the 4.0.0 release but may show up
12939	in a dot release.
12940	</desc>
12941	</attribute>
12942
12943	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12944	<desc>
12945	Flag indicating whether the VM is currently making use of the Physical
12946	Address Extension CPU feature.
12947	</desc>
12948	</attribute>
12949
12950	<attribute name="virtualTimeRate" type="unsigned long">
12951	<desc>
12952	The rate at which the virtual time runs expressed as a percentage.
12953	The accepted range is 2% to 20000%.
12954	</desc>
12955	</attribute>
12956
12957	<attribute name="VM" type="long long" readonly="yes">
12958	<desc>
12959	Gets the VM handle. This is only for internal use while
12960	we carve the details of this interface.
12961	</desc>
12962	</attribute>
12963
12964	</interface>
12965
12966	<!--
12967	// IUSBController
12968	/////////////////////////////////////////////////////////////////////////
12969	-->
12970
12971	<interface
12972	name="IUSBController" extends="$unknown"
12973	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12974	wsmap="managed"
12975	>
12976	<attribute name="enabled" type="boolean">
12977	<desc>
12978	Flag whether the USB controller is present in the
12979	guest system. If disabled, the virtual guest hardware will
12980	not contain any USB controller. Can only be changed when
12981	the VM is powered off.
12982	</desc>
12983	</attribute>
12984
12985	<attribute name="enabledEhci" type="boolean">
12986	<desc>
12987	Flag whether the USB EHCI controller is present in the
12988	guest system. If disabled, the virtual guest hardware will
12989	not contain a USB EHCI controller. Can only be changed when
12990	the VM is powered off.
12991	</desc>
12992	</attribute>
12993
12994	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12995	<desc>
12996	Flag whether there is an USB proxy available.
12997	</desc>
12998	</attribute>
12999
13000	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13001	<desc>
13002	USB standard version which the controller implements.
13003	This is a BCD which means that the major version is in the
13004	high byte and minor version is in the low byte.
13005	</desc>
13006	</attribute>
13007
13008	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13009	<desc>
13010	List of USB device filters associated with the machine.
13011
13012	If the machine is currently running, these filters are activated
13013	every time a new (supported) USB device is attached to the host
13014	computer that was not ignored by global filters
13015	(<link to="IHost::USBDeviceFilters"/>).
13016
13017	These filters are also activated when the machine is powered up.
13018	They are run against a list of all currently available USB
13019	devices (in states
13020	<link to="USBDeviceState_Available"/>,
13021	<link to="USBDeviceState_Busy"/>,
13022	<link to="USBDeviceState_Held"/>) that were not previously
13023	ignored by global filters.
13024
13025	If at least one filter matches the USB device in question, this
13026	device is automatically captured (attached to) the virtual USB
13027	controller of this machine.
13028
13029	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13030	</desc>
13031	</attribute>
13032
13033	<method name="createDeviceFilter">
13034	<desc>
13035	Creates a new USB device filter. All attributes except
13036	the filter name are set to empty (any match),
13037	<i>active</i> is @c false (the filter is not active).
13038
13039	The created filter can then be added to the list of filters using
13040	<link to="#insertDeviceFilter"/>.
13041
13042	<result name="VBOX_E_INVALID_VM_STATE">
13043	The virtual machine is not mutable.
13044	</result>
13045
13046	<see><link to="#deviceFilters"/></see>
13047	</desc>
13048	<param name="name" type="wstring" dir="in">
13049	<desc>
13050	Filter name. See <link to="IUSBDeviceFilter::name"/>
13051	for more info.
13052	</desc>
13053	</param>
13054	<param name="filter" type="IUSBDeviceFilter" dir="return">
13055	<desc>Created filter object.</desc>
13056	</param>
13057	</method>
13058
13059	<method name="insertDeviceFilter">
13060	<desc>
13061	Inserts the given USB device to the specified position
13062	in the list of filters.
13063
13064	Positions are numbered starting from <tt>0</tt>. If the specified
13065	position is equal to or greater than the number of elements in
13066	the list, the filter is added to the end of the collection.
13067
13068	<note>
13069	Duplicates are not allowed, so an attempt to insert a
13070	filter that is already in the collection, will return an
13071	error.
13072	</note>
13073
13074	<result name="VBOX_E_INVALID_VM_STATE">
13075	Virtual machine is not mutable.
13076	</result>
13077	<result name="E_INVALIDARG">
13078	USB device filter not created within this VirtualBox instance.
13079	</result>
13080	<result name="VBOX_E_INVALID_OBJECT_STATE">
13081	USB device filter already in list.
13082	</result>
13083
13084	<see><link to="#deviceFilters"/></see>
13085	</desc>
13086	<param name="position" type="unsigned long" dir="in">
13087	<desc>Position to insert the filter to.</desc>
13088	</param>
13089	<param name="filter" type="IUSBDeviceFilter" dir="in">
13090	<desc>USB device filter to insert.</desc>
13091	</param>
13092	</method>
13093
13094	<method name="removeDeviceFilter">
13095	<desc>
13096	Removes a USB device filter from the specified position in the
13097	list of filters.
13098
13099	Positions are numbered starting from <tt>0</tt>. Specifying a
13100	position equal to or greater than the number of elements in
13101	the list will produce an error.
13102
13103	<see><link to="#deviceFilters"/></see>
13104
13105	<result name="VBOX_E_INVALID_VM_STATE">
13106	Virtual machine is not mutable.
13107	</result>
13108	<result name="E_INVALIDARG">
13109	USB device filter list empty or invalid @a position.
13110	</result>
13111
13112	</desc>
13113	<param name="position" type="unsigned long" dir="in">
13114	<desc>Position to remove the filter from.</desc>
13115	</param>
13116	<param name="filter" type="IUSBDeviceFilter" dir="return">
13117	<desc>Removed USB device filter.</desc>
13118	</param>
13119	</method>
13120
13121	</interface>
13122
13123
13124	<!--
13125	// IUSBDevice
13126	/////////////////////////////////////////////////////////////////////////
13127	-->
13128
13129	<interface
13130	name="IUSBDevice" extends="$unknown"
13131	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13132	wsmap="managed"
13133	>
13134	<desc>
13135	The IUSBDevice interface represents a virtual USB device attached to the
13136	virtual machine.
13137
13138	A collection of objects implementing this interface is stored in the
13139	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13140	attached to a running virtual machine's USB controller.
13141	</desc>
13142
13143	<attribute name="id" type="uuid" mod="string" readonly="yes">
13144	<desc>
13145	Unique USB device ID. This ID is built from #vendorId,
13146	#productId, #revision and #serialNumber.
13147	</desc>
13148	</attribute>
13149
13150	<attribute name="vendorId" type="unsigned short" readonly="yes">
13151	<desc>Vendor ID.</desc>
13152	</attribute>
13153
13154	<attribute name="productId" type="unsigned short" readonly="yes">
13155	<desc>Product ID.</desc>
13156	</attribute>
13157
13158	<attribute name="revision" type="unsigned short" readonly="yes">
13159	<desc>
13160	Product revision number. This is a packed BCD represented as
13161	unsigned short. The high byte is the integer part and the low
13162	byte is the decimal.
13163	</desc>
13164	</attribute>
13165
13166	<attribute name="manufacturer" type="wstring" readonly="yes">
13167	<desc>Manufacturer string.</desc>
13168	</attribute>
13169
13170	<attribute name="product" type="wstring" readonly="yes">
13171	<desc>Product string.</desc>
13172	</attribute>
13173
13174	<attribute name="serialNumber" type="wstring" readonly="yes">
13175	<desc>Serial number string.</desc>
13176	</attribute>
13177
13178	<attribute name="address" type="wstring" readonly="yes">
13179	<desc>Host specific address of the device.</desc>
13180	</attribute>
13181
13182	<attribute name="port" type="unsigned short" readonly="yes">
13183	<desc>
13184	Host USB port number the device is physically
13185	connected to.
13186	</desc>
13187	</attribute>
13188
13189	<attribute name="version" type="unsigned short" readonly="yes">
13190	<desc>
13191	The major USB version of the device - 1 or 2.
13192	</desc>
13193	</attribute>
13194
13195	<attribute name="portVersion" type="unsigned short" readonly="yes">
13196	<desc>
13197	The major USB version of the host USB port the device is
13198	physically connected to - 1 or 2. For devices not connected to
13199	anything this will have the same value as the version attribute.
13200	</desc>
13201	</attribute>
13202
13203	<attribute name="remote" type="boolean" readonly="yes">
13204	<desc>
13205	Whether the device is physically connected to a remote VRDE
13206	client or to a local host machine.
13207	</desc>
13208	</attribute>
13209
13210	</interface>
13211
13212
13213	<!--
13214	// IUSBDeviceFilter
13215	/////////////////////////////////////////////////////////////////////////
13216	-->
13217
13218	<interface
13219	name="IUSBDeviceFilter" extends="$unknown"
13220	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
13221	wsmap="managed"
13222	>
13223	<desc>
13224	The IUSBDeviceFilter interface represents an USB device filter used
13225	to perform actions on a group of USB devices.
13226
13227	This type of filters is used by running virtual machines to
13228	automatically capture selected USB devices once they are physically
13229	attached to the host computer.
13230
13231	A USB device is matched to the given device filter if and only if all
13232	attributes of the device match the corresponding attributes of the
13233	filter (that is, attributes are joined together using the logical AND
13234	operation). On the other hand, all together, filters in the list of
13235	filters carry the semantics of the logical OR operation. So if it is
13236	desirable to create a match like "this vendor id OR this product id",
13237	one needs to create two filters and specify "any match" (see below)
13238	for unused attributes.
13239
13240	All filter attributes used for matching are strings. Each string
13241	is an expression representing a set of values of the corresponding
13242	device attribute, that will match the given filter. Currently, the
13243	following filtering expressions are supported:
13244
13245	<ul>
13246	<li><i>Interval filters</i>. Used to specify valid intervals for
13247	integer device attributes (Vendor ID, Product ID and Revision).
13248	The format of the string is:
13249
13250	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
13251
13252	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
13253	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
13254	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
13255	is omitted before a dash (<tt>-</tt>), the minimum possible integer
13256	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
13257	possible integer is assumed.
13258	</li>
13259	<li><i>Boolean filters</i>. Used to specify acceptable values for
13260	boolean device attributes. The format of the string is:
13261
13262	<tt>true\|false\|yes\|no\|0\|1</tt>
13263
13264	</li>
13265	<li><i>Exact match</i>. Used to specify a single value for the given
13266	device attribute. Any string that doesn't start with <tt>int:</tt>
13267	represents the exact match. String device attributes are compared to
13268	this string including case of symbols. Integer attributes are first
13269	converted to a string (see individual filter attributes) and then
13270	compared ignoring case.
13271
13272	</li>
13273	<li><i>Any match</i>. Any value of the corresponding device attribute
13274	will match the given filter. An empty or @c null string is
13275	used to construct this type of filtering expressions.
13276
13277	</li>
13278	</ul>
13279
13280	<note>
13281	On the Windows host platform, interval filters are not currently
13282	available. Also all string filter attributes
13283	(<link to="#manufacturer"/>, <link to="#product"/>,
13284	<link to="#serialNumber"/>) are ignored, so they behave as
13285	<i>any match</i> no matter what string expression is specified.
13286	</note>
13287
13288	<see><link to="IUSBController::deviceFilters"/>,
13289	<link to="IHostUSBDeviceFilter"/></see>
13290	</desc>
13291
13292	<attribute name="name" type="wstring">
13293	<desc>
13294	Visible name for this filter.
13295	This name is used to visually distinguish one filter from another,
13296	so it can neither be @c null nor an empty string.
13297	</desc>
13298	</attribute>
13299
13300	<attribute name="active" type="boolean">
13301	<desc>Whether this filter active or has been temporarily disabled.</desc>
13302	</attribute>
13303
13304	<attribute name="vendorId" type="wstring">
13305	<desc>
13306	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
13307	The string representation for the <i>exact matching</i>
13308	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
13309	(including leading zeroes).
13310	</desc>
13311	</attribute>
13312
13313	<attribute name="productId" type="wstring">
13314	<desc>
13315	<link to="IUSBDevice::productId">Product ID</link> filter.
13316	The string representation for the <i>exact matching</i>
13317	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
13318	(including leading zeroes).
13319	</desc>
13320	</attribute>
13321
13322	<attribute name="revision" type="wstring">
13323	<desc>
13324	<link to="IUSBDevice::productId">Product revision number</link>
13325	filter. The string representation for the <i>exact matching</i>
13326	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
13327	of the integer part of the revision, and <tt>F</tt> is the
13328	decimal digit of its fractional part (including leading and
13329	trailing zeros).
13330	Note that for interval filters, it's best to use the hexadecimal
13331	form, because the revision is stored as a 16 bit packed BCD value;
13332	so the expression <tt>int:0x0100-0x0199</tt> will match any
13333	revision from <tt>1.0</tt> to <tt>1.99</tt>.
13334	</desc>
13335	</attribute>
13336
13337	<attribute name="manufacturer" type="wstring">
13338	<desc>
13339	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
13340	</desc>
13341	</attribute>
13342
13343	<attribute name="product" type="wstring">
13344	<desc>
13345	<link to="IUSBDevice::product">Product</link> filter.
13346	</desc>
13347	</attribute>
13348
13349	<attribute name="serialNumber" type="wstring">
13350	<desc>
13351	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
13352	</desc>
13353	</attribute>
13354
13355	<attribute name="port" type="wstring">
13356	<desc>
13357	<link to="IUSBDevice::port">Host USB port</link> filter.
13358	</desc>
13359	</attribute>
13360
13361	<attribute name="remote" type="wstring">
13362	<desc>
13363	<link to="IUSBDevice::remote">Remote state</link> filter.
13364	<note>
13365	This filter makes sense only for machine USB filters,
13366	i.e. it is ignored by IHostUSBDeviceFilter objects.
13367	</note>
13368	</desc>
13369	</attribute>
13370
13371	<attribute name="maskedInterfaces" type="unsigned long">
13372	<desc>
13373	This is an advanced option for hiding one or more USB interfaces
13374	from the guest. The value is a bit mask where the bits that are set
13375	means the corresponding USB interface should be hidden, masked off
13376	if you like.
13377	This feature only works on Linux hosts.
13378	</desc>
13379	</attribute>
13380
13381	</interface>
13382
13383
13384	<!--
13385	// IHostUSBDevice
13386	/////////////////////////////////////////////////////////////////////////
13387	-->
13388
13389	<enum
13390	name="USBDeviceState"
13391	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
13392	>
13393	<desc>
13394	USB device state. This enumeration represents all possible states
13395	of the USB device physically attached to the host computer regarding
13396	its state on the host computer and availability to guest computers
13397	(all currently running virtual machines).
13398
13399	Once a supported USB device is attached to the host, global USB
13400	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
13401	either ignore the device, or put it to USBDeviceState_Held state, or do
13402	nothing. Unless the device is ignored by global filters, filters of all
13403	currently running guests (<link to="IUSBController::deviceFilters"/>) are
13404	activated that can put it to USBDeviceState_Captured state.
13405
13406	If the device was ignored by global filters, or didn't match
13407	any filters at all (including guest ones), it is handled by the host
13408	in a normal way. In this case, the device state is determined by
13409	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
13410	or USBDeviceState_Available, depending on the current device usage.
13411
13412	Besides auto-capturing based on filters, the device can be manually
13413	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
13414	state is USBDeviceState_Busy, USBDeviceState_Available or
13415	USBDeviceState_Held.
13416
13417	<note>
13418	Due to differences in USB stack implementations in Linux and Win32,
13419	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
13420	only to the Linux version of the product. This also means that (<link
13421	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
13422	device state is USBDeviceState_Held.
13423	</note>
13424
13425	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
13426	</desc>
13427
13428	<const name="NotSupported" value="0">
13429	<desc>
13430	Not supported by the VirtualBox server, not available to guests.
13431	</desc>
13432	</const>
13433	<const name="Unavailable" value="1">
13434	<desc>
13435	Being used by the host computer exclusively,
13436	not available to guests.
13437	</desc>
13438	</const>
13439	<const name="Busy" value="2">
13440	<desc>
13441	Being used by the host computer, potentially available to guests.
13442	</desc>
13443	</const>
13444	<const name="Available" value="3">
13445	<desc>
13446	Not used by the host computer, available to guests (the host computer
13447	can also start using the device at any time).
13448	</desc>
13449	</const>
13450	<const name="Held" value="4">
13451	<desc>
13452	Held by the VirtualBox server (ignored by the host computer),
13453	available to guests.
13454	</desc>
13455	</const>
13456	<const name="Captured" value="5">
13457	<desc>
13458	Captured by one of the guest computers, not available
13459	to anybody else.
13460	</desc>
13461	</const>
13462	</enum>
13463
13464	<interface
13465	name="IHostUSBDevice" extends="IUSBDevice"
13466	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
13467	wsmap="managed"
13468	>
13469	<desc>
13470	The IHostUSBDevice interface represents a physical USB device attached
13471	to the host computer.
13472
13473	Besides properties inherited from IUSBDevice, this interface adds the
13474	<link to="#state"/> property that holds the current state of the USB
13475	device.
13476
13477	<see><link to="IHost::USBDevices"/>,
13478	<link to="IHost::USBDeviceFilters"/></see>
13479	</desc>
13480
13481	<attribute name="state" type="USBDeviceState" readonly="yes">
13482	<desc>
13483	Current state of the device.
13484	</desc>
13485	</attribute>
13486
13487	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
13488
13489	</interface>
13490
13491
13492	<!--
13493	// IHostUSBDeviceFilter
13494	/////////////////////////////////////////////////////////////////////////
13495	-->
13496
13497	<enum
13498	name="USBDeviceFilterAction"
13499	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
13500	>
13501	<desc>
13502	Actions for host USB device filters.
13503	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
13504	</desc>
13505
13506	<const name="Null" value="0">
13507	<desc>Null value (never used by the API).</desc>
13508	</const>
13509	<const name="Ignore" value="1">
13510	<desc>Ignore the matched USB device.</desc>
13511	</const>
13512	<const name="Hold" value="2">
13513	<desc>Hold the matched USB device.</desc>
13514	</const>
13515	</enum>
13516
13517	<interface
13518	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
13519	uuid="4cc70246-d74a-400f-8222-3900489c0374"
13520	wsmap="managed"
13521	>
13522	<desc>
13523	The IHostUSBDeviceFilter interface represents a global filter for a
13524	physical USB device used by the host computer. Used indirectly in
13525	<link to="IHost::USBDeviceFilters"/>.
13526
13527	Using filters of this type, the host computer determines the initial
13528	state of the USB device after it is physically attached to the
13529	host's USB controller.
13530
13531	<note>
13532	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
13533	filters, because it makes sense only for
13534	<link to="IUSBController::deviceFilters">machine USB filters</link>.
13535	</note>
13536
13537	<see><link to="IHost::USBDeviceFilters"/></see>
13538	</desc>
13539
13540	<attribute name="action" type="USBDeviceFilterAction">
13541	<desc>
13542	Action performed by the host when an attached USB device
13543	matches this filter.
13544	</desc>
13545	</attribute>
13546
13547	</interface>
13548
13549	<!--
13550	// IAudioAdapter
13551	/////////////////////////////////////////////////////////////////////////
13552	-->
13553
13554	<enum
13555	name="AudioDriverType"
13556	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
13557	>
13558	<desc>
13559	Host audio driver type.
13560	</desc>
13561
13562	<const name="Null" value="0">
13563	<desc>Null value, also means "dummy audio driver".</desc>
13564	</const>
13565	<const name="WinMM" value="1">
13566	<desc>Windows multimedia (Windows hosts only).</desc>
13567	</const>
13568	<const name="OSS" value="2">
13569	<desc>Open Sound System (Linux hosts only).</desc>
13570	</const>
13571	<const name="ALSA" value="3">
13572	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
13573	</const>
13574	<const name="DirectSound" value="4">
13575	<desc>DirectSound (Windows hosts only).</desc>
13576	</const>
13577	<const name="CoreAudio" value="5">
13578	<desc>CoreAudio (Mac hosts only).</desc>
13579	</const>
13580	<const name="MMPM" value="6">
13581	<desc>Reserved for historical reasons.</desc>
13582	</const>
13583	<const name="Pulse" value="7">
13584	<desc>PulseAudio (Linux hosts only).</desc>
13585	</const>
13586	<const name="SolAudio" value="8">
13587	<desc>Solaris audio (Solaris hosts only).</desc>
13588	</const>
13589	</enum>
13590
13591	<enum
13592	name="AudioControllerType"
13593	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
13594	>
13595	<desc>
13596	Virtual audio controller type.
13597	</desc>
13598
13599	<const name="AC97" value="0"/>
13600	<const name="SB16" value="1"/>
13601	<const name="HDA" value="2"/>
13602	</enum>
13603
13604	<interface
13605	name="IAudioAdapter" extends="$unknown"
13606	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
13607	wsmap="managed"
13608	>
13609	<desc>
13610	The IAudioAdapter interface represents the virtual audio adapter of
13611	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
13612	</desc>
13613	<attribute name="enabled" type="boolean">
13614	<desc>
13615	Flag whether the audio adapter is present in the
13616	guest system. If disabled, the virtual guest hardware will
13617	not contain any audio adapter. Can only be changed when
13618	the VM is not running.
13619	</desc>
13620	</attribute>
13621	<attribute name="audioController" type="AudioControllerType">
13622	<desc>
13623	The audio hardware we emulate.
13624	</desc>
13625	</attribute>
13626	<attribute name="audioDriver" type="AudioDriverType">
13627	<desc>
13628	Audio driver the adapter is connected to. This setting
13629	can only be changed when the VM is not running.
13630	</desc>
13631	</attribute>
13632	</interface>
13633
13634	<enum
13635	name="AuthType"
13636	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
13637	>
13638	<desc>
13639	VirtualBox authentication type.
13640	</desc>
13641
13642	<const name="Null" value="0">
13643	<desc>Null value, also means "no authentication".</desc>
13644	</const>
13645	<const name="External" value="1"/>
13646	<const name="Guest" value="2"/>
13647	</enum>
13648
13649	<!--
13650	// IVRDEServer
13651	/////////////////////////////////////////////////////////////////////////
13652	-->
13653
13654	<interface
13655	name="IVRDEServer" extends="$unknown"
13656	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
13657	wsmap="managed"
13658	>
13659	<attribute name="enabled" type="boolean">
13660	<desc>VRDE server status.</desc>
13661	</attribute>
13662
13663	<attribute name="authType" type="AuthType">
13664	<desc>VRDE authentication method.</desc>
13665	</attribute>
13666
13667	<attribute name="authTimeout" type="unsigned long">
13668	<desc>Timeout for guest authentication. Milliseconds.</desc>
13669	</attribute>
13670
13671	<attribute name="allowMultiConnection" type="boolean">
13672	<desc>
13673	Flag whether multiple simultaneous connections to the VM are permitted.
13674	Note that this will be replaced by a more powerful mechanism in the future.
13675	</desc>
13676	</attribute>
13677
13678	<attribute name="reuseSingleConnection" type="boolean">
13679	<desc>
13680	Flag whether the existing connection must be dropped and a new connection
13681	must be established by the VRDE server, when a new client connects in single
13682	connection mode.
13683	</desc>
13684	</attribute>
13685
13686	<attribute name="VRDEExtPack" type="wstring">
13687	<desc>
13688	The name of Extension Pack providing VRDE for this VM. Overrides
13689	<link to="ISystemProperties::defaultVRDEExtPack"/>.
13690	</desc>
13691	</attribute>
13692
13693	<attribute name="authLibrary" type="wstring">
13694	<desc>
13695	Library used for authentication of RDP clients by this VM. Overrides
13696	<link to="ISystemProperties::VRDEAuthLibrary"/>.
13697	</desc>
13698	</attribute>
13699
13700	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
13701	<desc>
13702	Array of names of properties, which are supported by this VRDE server.
13703	</desc>
13704	</attribute>
13705
13706	<method name="setVRDEProperty">
13707	<desc>
13708	Sets a VRDE specific property string.
13709
13710	If you pass @c null or empty string as a key @a value, the given @a key
13711	will be deleted.
13712
13713	</desc>
13714	<param name="key" type="wstring" dir="in">
13715	<desc>Name of the key to set.</desc>
13716	</param>
13717	<param name="value" type="wstring" dir="in">
13718	<desc>Value to assign to the key.</desc>
13719	</param>
13720	</method>
13721
13722	<method name="getVRDEProperty" const="yes">
13723	<desc>
13724	Returns a VRDE specific property string.
13725
13726	If the requested data @a key does not exist, this function will
13727	succeed and return an empty string in the @a value argument.
13728
13729	</desc>
13730	<param name="key" type="wstring" dir="in">
13731	<desc>Name of the key to get.</desc>
13732	</param>
13733	<param name="value" type="wstring" dir="return">
13734	<desc>Value of the requested key.</desc>
13735	</param>
13736	</method>
13737
13738	</interface>
13739
13740
13741	<!--
13742	// ISharedFolder
13743	/////////////////////////////////////////////////////////////////////////
13744	-->
13745
13746	<interface
13747	name="ISharedFolder" extends="$unknown"
13748	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
13749	wsmap="struct"
13750	>
13751	<desc>
13752	The ISharedFolder interface represents a folder in the host computer's
13753	file system accessible from the guest OS running inside a virtual
13754	machine using an associated logical name.
13755
13756	There are three types of shared folders:
13757	<ul>
13758	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13759	folders available to all virtual machines.</li>
13760	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13761	VM-specific shared folders available to the given virtual machine at
13762	startup.</li>
13763	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13764	VM-specific shared folders created in the session context (for
13765	example, when the virtual machine is running) and automatically
13766	discarded when the session is closed (the VM is powered off).</li>
13767	</ul>
13768
13769	Logical names of shared folders must be unique within the given scope
13770	(global, permanent or transient). However, they do not need to be unique
13771	across scopes. In this case, the definition of the shared folder in a
13772	more specific scope takes precedence over definitions in all other
13773	scopes. The order of precedence is (more specific to more general):
13774	<ol>
13775	<li>Transient definitions</li>
13776	<li>Permanent definitions</li>
13777	<li>Global definitions</li>
13778	</ol>
13779
13780	For example, if MyMachine has a shared folder named
13781	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13782	transient shared folder named <tt>C_DRIVE</tt> (that points
13783	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13784	of <tt>C_DRIVE</tt> in the guest OS so
13785	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13786	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13787	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13788	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13789	to <tt>C:\\</tt> if it still exists.
13790
13791	Note that permanent and transient shared folders of different machines
13792	are in different name spaces, so they don't overlap and don't need to
13793	have unique logical names.
13794
13795	<note>
13796	Global shared folders are not implemented in the current version of the
13797	product.
13798	</note>
13799	</desc>
13800
13801	<attribute name="name" type="wstring" readonly="yes">
13802	<desc>Logical name of the shared folder.</desc>
13803	</attribute>
13804
13805	<attribute name="hostPath" type="wstring" readonly="yes">
13806	<desc>Full path to the shared folder in the host file system.</desc>
13807	</attribute>
13808
13809	<attribute name="accessible" type="boolean" readonly="yes">
13810	<desc>
13811	Whether the folder defined by the host path is currently
13812	accessible or not.
13813	For example, the folder can be inaccessible if it is placed
13814	on the network share that is not available by the time
13815	this property is read.
13816	</desc>
13817	</attribute>
13818
13819	<attribute name="writable" type="boolean" readonly="yes">
13820	<desc>
13821	Whether the folder defined by the host path is writable or
13822	not.
13823	</desc>
13824	</attribute>
13825
13826	<attribute name="autoMount" type="boolean" readonly="yes">
13827	<desc>
13828	Whether the folder gets automatically mounted by the guest or not.
13829	</desc>
13830	</attribute>
13831
13832	<attribute name="lastAccessError" type="wstring" readonly="yes">
13833	<desc>
13834	Text message that represents the result of the last accessibility
13835	check.
13836
13837	Accessibility checks are performed each time the <link to="#accessible"/>
13838	attribute is read. An empty string is returned if the last
13839	accessibility check was successful. A non-empty string indicates a
13840	failure and should normally describe a reason of the failure (for
13841	example, a file read error).
13842	</desc>
13843	</attribute>
13844
13845	</interface>
13846
13847	<!--
13848	// ISession
13849	/////////////////////////////////////////////////////////////////////////
13850	-->
13851
13852	<interface
13853	name="IInternalSessionControl" extends="$unknown"
13854	uuid="0bdda5da-67c8-47be-a610-b83a7fa3e8b6"
13855	internal="yes"
13856	wsmap="suppress"
13857	>
13858	<method name="getPID">
13859	<desc>PID of the process that has created this Session object.
13860	</desc>
13861	<param name="pid" type="unsigned long" dir="return"/>
13862	</method>
13863
13864	<method name="getRemoteConsole">
13865	<desc>
13866	Returns the console object suitable for remote control.
13867
13868	<result name="VBOX_E_INVALID_VM_STATE">
13869	Session state prevents operation.
13870	</result>
13871	<result name="VBOX_E_INVALID_OBJECT_STATE">
13872	Session type prevents operation.
13873	</result>
13874
13875	</desc>
13876	<param name="console" type="IConsole" dir="return"/>
13877	</method>
13878
13879	<method name="assignMachine">
13880	<desc>
13881	Assigns the machine object associated with this direct-type
13882	session or informs the session that it will be a remote one
13883	(if @a machine == @c null).
13884
13885	<result name="VBOX_E_INVALID_VM_STATE">
13886	Session state prevents operation.
13887	</result>
13888	<result name="VBOX_E_INVALID_OBJECT_STATE">
13889	Session type prevents operation.
13890	</result>
13891
13892	</desc>
13893	<param name="machine" type="IMachine" dir="in"/>
13894	</method>
13895
13896	<method name="assignRemoteMachine">
13897	<desc>
13898	Assigns the machine and the (remote) console object associated with
13899	this remote-type session.
13900
13901	<result name="VBOX_E_INVALID_VM_STATE">
13902	Session state prevents operation.
13903	</result>
13904
13905	</desc>
13906	<param name="machine" type="IMachine" dir="in"/>
13907	<param name="console" type="IConsole" dir="in"/>
13908	</method>
13909
13910	<method name="updateMachineState">
13911	<desc>
13912	Updates the machine state in the VM process.
13913	Must be called only in certain cases
13914	(see the method implementation).
13915
13916	<result name="VBOX_E_INVALID_VM_STATE">
13917	Session state prevents operation.
13918	</result>
13919	<result name="VBOX_E_INVALID_OBJECT_STATE">
13920	Session type prevents operation.
13921	</result>
13922
13923	</desc>
13924	<param name="aMachineState" type="MachineState" dir="in"/>
13925	</method>
13926
13927	<method name="uninitialize">
13928	<desc>
13929	Uninitializes (closes) this session. Used by VirtualBox to close
13930	the corresponding remote session when the direct session dies
13931	or gets closed.
13932
13933	<result name="VBOX_E_INVALID_VM_STATE">
13934	Session state prevents operation.
13935	</result>
13936
13937	</desc>
13938	</method>
13939
13940	<method name="onNetworkAdapterChange">
13941	<desc>
13942	Triggered when settings of a network adapter of the
13943	associated virtual machine have changed.
13944
13945	<result name="VBOX_E_INVALID_VM_STATE">
13946	Session state prevents operation.
13947	</result>
13948	<result name="VBOX_E_INVALID_OBJECT_STATE">
13949	Session type prevents operation.
13950	</result>
13951
13952	</desc>
13953	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13954	<param name="changeAdapter" type="boolean" dir="in"/>
13955	</method>
13956
13957	<method name="onSerialPortChange">
13958	<desc>
13959	Triggered when settings of a serial port of the
13960	associated virtual machine have changed.
13961
13962	<result name="VBOX_E_INVALID_VM_STATE">
13963	Session state prevents operation.
13964	</result>
13965	<result name="VBOX_E_INVALID_OBJECT_STATE">
13966	Session type prevents operation.
13967	</result>
13968
13969	</desc>
13970	<param name="serialPort" type="ISerialPort" dir="in"/>
13971	</method>
13972
13973	<method name="onParallelPortChange">
13974	<desc>
13975	Triggered when settings of a parallel port of the
13976	associated virtual machine have changed.
13977
13978	<result name="VBOX_E_INVALID_VM_STATE">
13979	Session state prevents operation.
13980	</result>
13981	<result name="VBOX_E_INVALID_OBJECT_STATE">
13982	Session type prevents operation.
13983	</result>
13984
13985	</desc>
13986	<param name="parallelPort" type="IParallelPort" dir="in"/>
13987	</method>
13988
13989	<method name="onStorageControllerChange">
13990	<desc>
13991	Triggered when settings of a storage controller of the
13992	associated virtual machine have changed.
13993
13994	<result name="VBOX_E_INVALID_VM_STATE">
13995	Session state prevents operation.
13996	</result>
13997	<result name="VBOX_E_INVALID_OBJECT_STATE">
13998	Session type prevents operation.
13999	</result>
14000
14001	</desc>
14002	</method>
14003
14004	<method name="onMediumChange">
14005	<desc>
14006	Triggered when attached media of the
14007	associated virtual machine have changed.
14008
14009	<result name="VBOX_E_INVALID_VM_STATE">
14010	Session state prevents operation.
14011	</result>
14012	<result name="VBOX_E_INVALID_OBJECT_STATE">
14013	Session type prevents operation.
14014	</result>
14015
14016	</desc>
14017
14018	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
14019	<param name="force" type="boolean" dir="in"/>
14020	</method>
14021
14022	<method name="onStorageDeviceChange">
14023	<desc>
14024	Triggered when attached storage devices of the
14025	associated virtual machine have changed.
14026
14027	<result name="VBOX_E_INVALID_VM_STATE">
14028	Session state prevents operation.
14029	</result>
14030	<result name="VBOX_E_INVALID_OBJECT_STATE">
14031	Session type prevents operation.
14032	</result>
14033
14034	</desc>
14035
14036	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
14037	<param name="remove" type="boolean" dir="in">
14038	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14039	</param>
14040	</method>
14041
14042	<method name="onCPUChange">
14043	<desc>
14044	Notification when a CPU changes.
14045	</desc>
14046	<param name="cpu" type="unsigned long" dir="in">
14047	<desc>The CPU which changed</desc>
14048	</param>
14049	<param name="add" type="boolean" dir="in">
14050	<desc>Flag whether the CPU was added or removed</desc>
14051	</param>
14052	</method>
14053
14054	<method name="onCPUExecutionCapChange">
14055	<desc>
14056	Notification when the CPU execution cap changes.
14057	</desc>
14058	<param name="executionCap" type="unsigned long" dir="in">
14059	<desc>The new CPU execution cap value. (1-100)</desc>
14060	</param>
14061	</method>
14062
14063	<method name="onVRDEServerChange">
14064	<desc>
14065	Triggered when settings of the VRDE server object of the
14066	associated virtual machine have changed.
14067
14068	<result name="VBOX_E_INVALID_VM_STATE">
14069	Session state prevents operation.
14070	</result>
14071	<result name="VBOX_E_INVALID_OBJECT_STATE">
14072	Session type prevents operation.
14073	</result>
14074
14075	</desc>
14076	<param name="restart" type="boolean" dir="in">
14077	<desc>Flag whether the server must be restarted</desc>
14078	</param>
14079	</method>
14080
14081	<method name="onUSBControllerChange">
14082	<desc>
14083	Triggered when settings of the USB controller object of the
14084	associated virtual machine have changed.
14085
14086	<result name="VBOX_E_INVALID_VM_STATE">
14087	Session state prevents operation.
14088	</result>
14089	<result name="VBOX_E_INVALID_OBJECT_STATE">
14090	Session type prevents operation.
14091	</result>
14092
14093	</desc>
14094	</method>
14095
14096	<method name="onSharedFolderChange">
14097	<desc>
14098	Triggered when a permanent (global or machine) shared folder has been
14099	created or removed.
14100	<note>
14101	We don't pass shared folder parameters in this notification because
14102	the order in which parallel notifications are delivered is not defined,
14103	therefore it could happen that these parameters were outdated by the
14104	time of processing this notification.
14105	</note>
14106
14107	<result name="VBOX_E_INVALID_VM_STATE">
14108	Session state prevents operation.
14109	</result>
14110	<result name="VBOX_E_INVALID_OBJECT_STATE">
14111	Session type prevents operation.
14112	</result>
14113
14114	</desc>
14115	<param name="global" type="boolean" dir="in"/>
14116	</method>
14117
14118	<method name="onUSBDeviceAttach">
14119	<desc>
14120	Triggered when a request to capture a USB device (as a result
14121	of matched USB filters or direct call to
14122	<link to="IConsole::attachUSBDevice"/>) has completed.
14123	A @c null @a error object means success, otherwise it
14124	describes a failure.
14125
14126	<result name="VBOX_E_INVALID_VM_STATE">
14127	Session state prevents operation.
14128	</result>
14129	<result name="VBOX_E_INVALID_OBJECT_STATE">
14130	Session type prevents operation.
14131	</result>
14132
14133	</desc>
14134	<param name="device" type="IUSBDevice" dir="in"/>
14135	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14136	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14137	</method>
14138
14139	<method name="onUSBDeviceDetach">
14140	<desc>
14141	Triggered when a request to release the USB device (as a result
14142	of machine termination or direct call to
14143	<link to="IConsole::detachUSBDevice"/>) has completed.
14144	A @c null @a error object means success, otherwise it
14145	describes a failure.
14146
14147	<result name="VBOX_E_INVALID_VM_STATE">
14148	Session state prevents operation.
14149	</result>
14150	<result name="VBOX_E_INVALID_OBJECT_STATE">
14151	Session type prevents operation.
14152	</result>
14153
14154	</desc>
14155	<param name="id" type="uuid" mod="string" dir="in"/>
14156	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14157	</method>
14158
14159	<method name="onShowWindow">
14160	<desc>
14161	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14162	<link to="IMachine::showConsoleWindow"/> in order to notify
14163	console listeners
14164	<link to="ICanShowWindowEvent"/>
14165	and <link to="IShowWindowEvent"/>.
14166
14167	<result name="VBOX_E_INVALID_OBJECT_STATE">
14168	Session type prevents operation.
14169	</result>
14170
14171	</desc>
14172	<param name="check" type="boolean" dir="in"/>
14173	<param name="canShow" type="boolean" dir="out"/>
14174	<param name="winId" type="long long" dir="out"/>
14175	</method>
14176
14177	<method name="onBandwidthGroupChange">
14178	<desc>
14179	Notification when one of the bandwidth groups change.
14180	</desc>
14181	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
14182	<desc>The bandwidth group which changed.</desc>
14183	</param>
14184	</method>
14185
14186	<method name="accessGuestProperty">
14187	<desc>
14188	Called by <link to="IMachine::getGuestProperty"/> and by
14189	<link to="IMachine::setGuestProperty"/> in order to read and
14190	modify guest properties.
14191
14192	<result name="VBOX_E_INVALID_VM_STATE">
14193	Machine session is not open.
14194	</result>
14195	<result name="VBOX_E_INVALID_OBJECT_STATE">
14196	Session type is not direct.
14197	</result>
14198
14199	</desc>
14200	<param name="name" type="wstring" dir="in"/>
14201	<param name="value" type="wstring" dir="in"/>
14202	<param name="flags" type="wstring" dir="in"/>
14203	<param name="isSetter" type="boolean" dir="in"/>
14204	<param name="retValue" type="wstring" dir="out"/>
14205	<param name="retTimestamp" type="long long" dir="out"/>
14206	<param name="retFlags" type="wstring" dir="out"/>
14207	</method>
14208
14209	<method name="enumerateGuestProperties" const="yes">
14210	<desc>
14211	Return a list of the guest properties matching a set of patterns along
14212	with their values, time stamps and flags.
14213
14214	<result name="VBOX_E_INVALID_VM_STATE">
14215	Machine session is not open.
14216	</result>
14217	<result name="VBOX_E_INVALID_OBJECT_STATE">
14218	Session type is not direct.
14219	</result>
14220
14221	</desc>
14222	<param name="patterns" type="wstring" dir="in">
14223	<desc>
14224	The patterns to match the properties against as a comma-separated
14225	string. If this is empty, all properties currently set will be
14226	returned.
14227	</desc>
14228	</param>
14229	<param name="key" type="wstring" dir="out" safearray="yes">
14230	<desc>
14231	The key names of the properties returned.
14232	</desc>
14233	</param>
14234	<param name="value" type="wstring" dir="out" safearray="yes">
14235	<desc>
14236	The values of the properties returned. The array entries match the
14237	corresponding entries in the @a key array.
14238	</desc>
14239	</param>
14240	<param name="timestamp" type="long long" dir="out" safearray="yes">
14241	<desc>
14242	The time stamps of the properties returned. The array entries match
14243	the corresponding entries in the @a key array.
14244	</desc>
14245	</param>
14246	<param name="flags" type="wstring" dir="out" safearray="yes">
14247	<desc>
14248	The flags of the properties returned. The array entries match the
14249	corresponding entries in the @a key array.
14250	</desc>
14251	</param>
14252	</method>
14253
14254	<method name="onlineMergeMedium">
14255	<desc>
14256	Triggers online merging of a hard disk. Used internally when deleting
14257	a snapshot while a VM referring to the same hard disk chain is running.
14258
14259	<result name="VBOX_E_INVALID_VM_STATE">
14260	Machine session is not open.
14261	</result>
14262	<result name="VBOX_E_INVALID_OBJECT_STATE">
14263	Session type is not direct.
14264	</result>
14265
14266	</desc>
14267	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14268	<desc>The medium attachment to identify the medium chain.</desc>
14269	</param>
14270	<param name="sourceIdx" type="unsigned long" dir="in">
14271	<desc>The index of the source image in the chain.
14272	Redundant, but drastically reduces IPC.</desc>
14273	</param>
14274	<param name="targetIdx" type="unsigned long" dir="in">
14275	<desc>The index of the target image in the chain.
14276	Redundant, but drastically reduces IPC.</desc>
14277	</param>
14278	<param name="source" type="IMedium" dir="in">
14279	<desc>Merge source medium.</desc>
14280	</param>
14281	<param name="target" type="IMedium" dir="in">
14282	<desc>Merge target medium.</desc>
14283	</param>
14284	<param name="mergeForward" type="boolean" dir="in">
14285	<desc>Merge direction.</desc>
14286	</param>
14287	<param name="parentForTarget" type="IMedium" dir="in">
14288	<desc>For forward merges: new parent for target medium.</desc>
14289	</param>
14290	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
14291	<desc>For backward merges: list of media which need their parent UUID
14292	updated.</desc>
14293	</param>
14294	<param name="progress" type="IProgress" dir="in">
14295	<desc>
14296	Progress object for this operation.
14297	</desc>
14298	</param>
14299	</method>
14300
14301	</interface>
14302
14303	<interface
14304	name="ISession" extends="$unknown"
14305	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
14306	wsmap="managed"
14307	>
14308	<desc>
14309	The ISession interface represents a client process and allows for locking
14310	virtual machines (represented by IMachine objects) to prevent conflicting
14311	changes to the machine.
14312
14313	Any caller wishing to manipulate a virtual machine needs to create a session
14314	object first, which lives in its own process space. Such session objects are
14315	then associated with <link to="IMachine" /> objects living in the VirtualBox
14316	server process to coordinate such changes.
14317
14318	There are two typical scenarios in which sessions are used:
14319
14320	<ul>
14321	<li>To alter machine settings or control a running virtual machine, one
14322	needs to lock a machine for a given session (client process) by calling
14323	<link to="IMachine::lockMachine"/>.
14324
14325	Whereas multiple sessions may control a running virtual machine, only
14326	one process can obtain a write lock on the machine to prevent conflicting
14327	changes. A write lock is also needed if a process wants to actually run a
14328	virtual machine in its own context, such as the VirtualBox GUI or
14329	VBoxHeadless front-ends. They must also lock a machine for their own
14330	sessions before they are allowed to power up the virtual machine.
14331
14332	As a result, no machine settings can be altered while another process is
14333	already using it, either because that process is modifying machine settings
14334	or because the machine is running.
14335	</li>
14336	<li>
14337	To start a VM using one of the existing VirtualBox front-ends (e.g. the
14338	VirtualBox GUI or VBoxHeadless), one would use
14339	<link to="IMachine::launchVMProcess"/>, which also takes a session object
14340	as its first parameter. This session then identifies the caller and lets the
14341	caller control the started machine (for example, pause machine execution or
14342	power it down) as well as be notified about machine execution state changes.
14343	</li>
14344	</ul>
14345
14346	How sessions objects are created in a client process depends on whether you use
14347	the Main API via COM or via the webservice:
14348
14349	<ul>
14350	<li>When using the COM API directly, an object of the Session class from the
14351	VirtualBox type library needs to be created. In regular COM C++ client code,
14352	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
14353	This object will then act as a local session object in further calls to open
14354	a session.
14355	</li>
14356
14357	<li>In the webservice, the session manager (IWebsessionManager) instead creates
14358	a session object automatically whenever <link to="IWebsessionManager::logon" />
14359	is called. A managed object reference to that session object can be retrieved by
14360	calling <link to="IWebsessionManager::getSessionObject" />.
14361	</li>
14362	</ul>
14363	</desc>
14364
14365	<attribute name="state" type="SessionState" readonly="yes">
14366	<desc>Current state of this session.</desc>
14367	</attribute>
14368
14369	<attribute name="type" type="SessionType" readonly="yes">
14370	<desc>
14371	Type of this session. The value of this attribute is valid only
14372	if the session currently has a machine locked (i.e. its
14373	<link to="#state" /> is Locked), otherwise an error will be returned.
14374	</desc>
14375	</attribute>
14376
14377	<attribute name="machine" type="IMachine" readonly="yes">
14378	<desc>Machine object associated with this session.</desc>
14379	</attribute>
14380
14381	<attribute name="console" type="IConsole" readonly="yes">
14382	<desc>Console object associated with this session.</desc>
14383	</attribute>
14384
14385	<method name="unlockMachine">
14386	<desc>
14387	Unlocks a machine that was previously locked for the current session.
14388
14389	Calling this method is required every time a machine has been locked
14390	for a particular session using the <link to="IMachine::launchVMProcess" />
14391	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
14392	the machine will be set to <link to="MachineState_Aborted" /> on the
14393	server, and changes made to the machine settings will be lost.
14394
14395	Generally, it is recommended to unlock all machines explicitly
14396	before terminating the application (regardless of the reason for
14397	the termination).
14398
14399	<note>
14400	Do not expect the session state (<link to="ISession::state" />
14401	to return to "Unlocked" immediately after you invoke this method,
14402	particularly if you have started a new VM process. The session
14403	state will automatically return to "Unlocked" once the VM is no
14404	longer executing, which can of course take a very long time.
14405	</note>
14406
14407	<result name="E_UNEXPECTED">
14408	Session is not locked.
14409	</result>
14410
14411	</desc>
14412	</method>
14413
14414	</interface>
14415
14416	<!--
14417	// IStorageController
14418	/////////////////////////////////////////////////////////////////////////
14419	-->
14420
14421	<enum
14422	name="StorageBus"
14423	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
14424	>
14425	<desc>
14426	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
14427	see <link to="IStorageController::bus" />.
14428	</desc>
14429	<const name="Null" value="0">
14430	<desc>@c null value. Never used by the API.</desc>
14431	</const>
14432	<const name="IDE" value="1"/>
14433	<const name="SATA" value="2"/>
14434	<const name="SCSI" value="3"/>
14435	<const name="Floppy" value="4"/>
14436	<const name="SAS" value="5"/>
14437	</enum>
14438
14439	<enum
14440	name="StorageControllerType"
14441	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
14442	>
14443	<desc>
14444	The exact variant of storage controller hardware presented
14445	to the guest; see <link to="IStorageController::controllerType" />.
14446	</desc>
14447
14448	<const name="Null" value="0">
14449	<desc>@c null value. Never used by the API.</desc>
14450	</const>
14451	<const name="LsiLogic" value="1">
14452	<desc>A SCSI controller of the LsiLogic variant.</desc>
14453	</const>
14454	<const name="BusLogic" value="2">
14455	<desc>A SCSI controller of the BusLogic variant.</desc>
14456	</const>
14457	<const name="IntelAhci" value="3">
14458	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
14459	</const>
14460	<const name="PIIX3" value="4">
14461	<desc>An IDE controller of the PIIX3 variant.</desc>
14462	</const>
14463	<const name="PIIX4" value="5">
14464	<desc>An IDE controller of the PIIX4 variant.</desc>
14465	</const>
14466	<const name="ICH6" value="6">
14467	<desc>An IDE controller of the ICH6 variant.</desc>
14468	</const>
14469	<const name="I82078" value="7">
14470	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
14471	</const>
14472	<const name="LsiLogicSas" value="8">
14473	<desc>A variant of the LsiLogic controller using SAS.</desc>
14474	</const>
14475	</enum>
14476
14477	<enum
14478	name="ChipsetType"
14479	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
14480	>
14481	<desc>
14482	Type of emulated chipset (mostly southbridge).
14483	</desc>
14484
14485	<const name="Null" value="0">
14486	<desc>@c null value. Never used by the API.</desc>
14487	</const>
14488	<const name="PIIX3" value="1">
14489	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
14490	</const>
14491	<const name="ICH9" value="2">
14492	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
14493	</const>
14494	</enum>
14495
14496	<interface
14497	name="IStorageController" extends="$unknown"
14498	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
14499	wsmap="managed"
14500	>
14501	<desc>
14502	Represents a storage controller that is attached to a virtual machine
14503	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
14504	attached to storage controllers in a real computer, virtual drives
14505	(represented by <link to="IMediumAttachment" />) are attached to virtual
14506	storage controllers, represented by this interface.
14507
14508	As opposed to physical hardware, VirtualBox has a very generic concept
14509	of a storage controller, and for purposes of the Main API, all virtual
14510	storage is attached to virtual machines via instances of this interface.
14511	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
14512	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
14513	is used, certain sub-types may be available and can be selected in
14514	<link to="#controllerType" />.
14515
14516	Depending on these settings, the guest operating system might see
14517	significantly different virtual hardware.
14518	</desc>
14519
14520	<attribute name="name" type="wstring" readonly="yes">
14521	<desc>
14522	Name of the storage controller, as originally specified with
14523	<link to="IMachine::addStorageController" />. This then uniquely
14524	identifies this controller with other method calls such as
14525	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
14526	</desc>
14527	</attribute>
14528
14529	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
14530	<desc>
14531	Maximum number of devices which can be attached to one port.
14532	</desc>
14533	</attribute>
14534
14535	<attribute name="minPortCount" type="unsigned long" readonly="yes">
14536	<desc>
14537	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
14538	</desc>
14539	</attribute>
14540
14541	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
14542	<desc>
14543	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
14544	</desc>
14545	</attribute>
14546
14547	<attribute name="instance" type="unsigned long">
14548	<desc>
14549	The instance number of the device in the running VM.
14550	</desc>
14551	</attribute>
14552
14553	<attribute name="portCount" type="unsigned long">
14554	<desc>
14555	The number of currently usable ports on the controller.
14556	The minimum and maximum number of ports for one controller are
14557	stored in <link to="IStorageController::minPortCount"/>
14558	and <link to="IStorageController::maxPortCount"/>.
14559	</desc>
14560	</attribute>
14561
14562	<attribute name="bus" type="StorageBus" readonly="yes">
14563	<desc>
14564	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
14565	</desc>
14566	</attribute>
14567
14568	<attribute name="controllerType" type="StorageControllerType">
14569	<desc>
14570	The exact variant of storage controller hardware presented
14571	to the guest.
14572	Depending on this value, VirtualBox will provide a different
14573	virtual storage controller hardware to the guest.
14574	For SATA, SAS and floppy controllers, only one variant is
14575	available, but for IDE and SCSI, there are several.
14576
14577	For SCSI controllers, the default type is LsiLogic.
14578	</desc>
14579	</attribute>
14580
14581	<attribute name="useHostIOCache" type="boolean">
14582	<desc>
14583	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
14584	caches and use synchronous file APIs on the host. This was the only option in the API before
14585	VirtualBox 3.2 and is still the default for IDE controllers.
14586
14587	If false, the host I/O cache will be disabled for image files attached to this storage controller.
14588	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
14589	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
14590	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
14591	virtual machines are running at the same time to prevent I/O cache related hangs.
14592	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
14593	</desc>
14594	</attribute>
14595
14596	<attribute name="bootable" type="boolean" readonly="yes">
14597	<desc>
14598	Returns whether it is possible to boot from disks attached to this controller.
14599	</desc>
14600	</attribute>
14601
14602	<method name="getIDEEmulationPort">
14603	<desc>
14604	Gets the corresponding port number which is emulated as an IDE device.
14605	Works only with SATA controllers.
14606
14607	<result name="E_INVALIDARG">
14608	The @a devicePosition is not in the range 0 to 3.
14609	</result>
14610	<result name="E_NOTIMPL">
14611	The storage controller type is not SATAIntelAhci.
14612	</result>
14613
14614	</desc>
14615	<param name="devicePosition" type="long" dir="in"/>
14616	<param name="portNumber" type="long" dir="return"/>
14617	</method>
14618
14619	<method name="setIDEEmulationPort">
14620	<desc>
14621	Sets the port number which is emulated as an IDE device.
14622	Works only with SATA controllers.
14623
14624	<result name="E_INVALIDARG">
14625	The @a devicePosition is not in the range 0 to 3 or the
14626	@a portNumber is not in the range 0 to 29.
14627	</result>
14628	<result name="E_NOTIMPL">
14629	The storage controller type is not SATAIntelAhci.
14630	</result>
14631
14632	</desc>
14633	<param name="devicePosition" type="long" dir="in"/>
14634	<param name="portNumber" type="long" dir="in"/>
14635	</method>
14636
14637	</interface>
14638
14639	<if target="wsdl">
14640
14641	<!--
14642	// IManagedObjectRef
14643	/////////////////////////////////////////////////////////////////////////
14644	-->
14645
14646	<interface
14647	name="IManagedObjectRef" extends="$unknown"
14648	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
14649	internal="yes"
14650	wsmap="managed"
14651	wscpp="hardcoded"
14652	>
14653	<desc>
14654	Managed object reference.
14655
14656	Only within the webservice, a managed object reference (which is really
14657	an opaque number) allows a webservice client to address an object
14658	that lives in the address space of the webservice server.
14659
14660	Behind each managed object reference, there is a COM object that lives
14661	in the webservice server's address space. The COM object is not freed
14662	until the managed object reference is released, either by an explicit
14663	call to <link to="IManagedObjectRef::release" /> or by logging off from
14664	the webservice (<link to="IWebsessionManager::logoff" />), which releases
14665	all objects created during the webservice session.
14666
14667	Whenever a method call of the VirtualBox API returns a COM object, the
14668	webservice representation of that method will instead return a
14669	managed object reference, which can then be used to invoke methods
14670	on that object.
14671	</desc>
14672
14673	<method name="getInterfaceName">
14674	<desc>
14675	Returns the name of the interface that this managed object represents,
14676	for example, "IMachine", as a string.
14677	</desc>
14678	<param name="return" type="wstring" dir="return"/>
14679	</method>
14680
14681	<method name="release">
14682	<desc>
14683	Releases this managed object reference and frees the resources that
14684	were allocated for it in the webservice server process. After calling
14685	this method, the identifier of the reference can no longer be used.
14686	</desc>
14687	</method>
14688
14689	</interface>
14690
14691	<!--
14692	// IWebsessionManager
14693	/////////////////////////////////////////////////////////////////////////
14694	-->
14695
14696	<interface
14697	name="IWebsessionManager" extends="$unknown"
14698	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
14699	internal="yes"
14700	wsmap="global"
14701	wscpp="hardcoded"
14702	>
14703	<desc>
14704	Websession manager. This provides essential services
14705	to webservice clients.
14706	</desc>
14707	<method name="logon">
14708	<desc>
14709	Logs a new client onto the webservice and returns a managed object reference to
14710	the IVirtualBox instance, which the client can then use as a basis to further
14711	queries, since all calls to the VirtualBox API are based on the IVirtualBox
14712	interface, in one way or the other.
14713	</desc>
14714	<param name="username" type="wstring" dir="in"/>
14715	<param name="password" type="wstring" dir="in"/>
14716	<param name="return" type="IVirtualBox" dir="return"/>
14717	</method>
14718
14719	<method name="getSessionObject">
14720	<desc>
14721	Returns a managed object reference to the internal ISession object that was created
14722	for this web service session when the client logged on.
14723
14724	<see><link to="ISession"/></see>
14725	</desc>
14726	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14727	<param name="return" type="ISession" dir="return"/>
14728	</method>
14729
14730	<method name="logoff">
14731	<desc>
14732	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
14733	and destroys all resources associated with the session (most importantly, all
14734	managed objects created in the server while the session was active).
14735	</desc>
14736	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14737	</method>
14738
14739	</interface>
14740
14741	</if>
14742
14743	<!--
14744	// IPerformanceCollector & friends
14745	/////////////////////////////////////////////////////////////////////////
14746	-->
14747
14748	<interface
14749	name="IPerformanceMetric" extends="$unknown"
14750	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14751	>
14752	<desc>
14753	The IPerformanceMetric interface represents parameters of the given
14754	performance metric.
14755	</desc>
14756
14757	<attribute name="metricName" type="wstring" readonly="yes">
14758	<desc>
14759	Name of the metric.
14760	</desc>
14761	</attribute>
14762
14763	<attribute name="object" type="$unknown" readonly="yes">
14764	<desc>
14765	Object this metric belongs to.
14766	</desc>
14767	</attribute>
14768
14769	<attribute name="description" type="wstring" readonly="yes">
14770	<desc>
14771	Textual description of the metric.
14772	</desc>
14773	</attribute>
14774
14775	<attribute name="period" type="unsigned long" readonly="yes">
14776	<desc>
14777	Time interval between samples, measured in seconds.
14778	</desc>
14779	</attribute>
14780
14781	<attribute name="count" type="unsigned long" readonly="yes">
14782	<desc>
14783	Number of recent samples retained by the performance collector for this
14784	metric.
14785
14786	When the collected sample count exceeds this number, older samples
14787	are discarded.
14788	</desc>
14789	</attribute>
14790
14791	<attribute name="unit" type="wstring" readonly="yes">
14792	<desc>
14793	Unit of measurement.
14794	</desc>
14795	</attribute>
14796
14797	<attribute name="minimumValue" type="long" readonly="yes">
14798	<desc>
14799	Minimum possible value of this metric.
14800	</desc>
14801	</attribute>
14802
14803	<attribute name="maximumValue" type="long" readonly="yes">
14804	<desc>
14805	Maximum possible value of this metric.
14806	</desc>
14807	</attribute>
14808	</interface>
14809
14810	<interface
14811	name="IPerformanceCollector" extends="$unknown"
14812	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14813	wsmap="managed"
14814	>
14815	<desc>
14816	The IPerformanceCollector interface represents a service that collects
14817	and stores performance metrics data.
14818
14819	Performance metrics are associated with objects of interfaces like IHost
14820	and IMachine. Each object has a distinct set of performance metrics. The
14821	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14822
14823	Metric data is collected at the specified intervals and is retained
14824	internally. The interval and the number of retained samples can be set
14825	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14826	and collection settings are not persistent, they are discarded as soon as
14827	VBoxSVC process terminates. Moreover, metric settings and data associated
14828	with a particular VM only exist while VM is running. They disappear as
14829	soon as VM shuts down. It is not possible to set up metrics for machines
14830	that are powered off. One needs to start VM first, then set up metric
14831	collection parameters.
14832
14833	Metrics are organized hierarchically, with each level separated by a
14834	slash (/) character. Generally, the scheme for metric names is like this:
14835
14836	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14837
14838	"Category/Metric" together form the base metric name. A base metric is
14839	the smallest unit for which a sampling interval and the number of
14840	retained samples can be set. Only base metrics can be enabled and
14841	disabled. All sub-metrics are collected when their base metric is
14842	collected. Collected values for any set of sub-metrics can be queried
14843	with <link to="IPerformanceCollector::queryMetricsData" />.
14844
14845	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14846	category, "Load" metric, "User" submetric, "average" aggregate. An
14847	aggregate function is computed over all retained data. Valid aggregate
14848	functions are:
14849
14850	<ul>
14851	<li>avg -- average</li>
14852	<li>min -- minimum</li>
14853	<li>max -- maximum</li>
14854	</ul>
14855
14856	When setting up metric parameters, querying metric data, enabling or
14857	disabling metrics wildcards can be used in metric names to specify a
14858	subset of metrics. For example, to select all CPU-related metrics
14859	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14860	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14861
14862	The valid names for base metrics are:
14863
14864	<ul>
14865	<li>CPU/Load</li>
14866	<li>CPU/MHz</li>
14867	<li>RAM/Usage</li>
14868	<li>RAM/VMM</li>
14869	</ul>
14870
14871	The general sequence for collecting and retrieving the metrics is:
14872	<ul>
14873	<li>
14874	Obtain an instance of IPerformanceCollector with
14875	<link to="IVirtualBox::performanceCollector" />
14876	</li>
14877	<li>
14878	Allocate and populate an array with references to objects the metrics
14879	will be collected for. Use references to IHost and IMachine objects.
14880	</li>
14881	<li>
14882	Allocate and populate an array with base metric names the data will
14883	be collected for.
14884	</li>
14885	<li>
14886	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14887	the metric data will be collected and stored.
14888	</li>
14889	<li>
14890	Wait for the data to get collected.
14891	</li>
14892	<li>
14893	Allocate and populate an array with references to objects the metric
14894	values will be queried for. You can re-use the object array used for
14895	setting base metrics.
14896	</li>
14897	<li>
14898	Allocate and populate an array with metric names the data will be
14899	collected for. Note that metric names differ from base metric names.
14900	</li>
14901	<li>
14902	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14903	that have been collected so far are returned. Note that the values
14904	are still retained internally and data collection continues.
14905	</li>
14906	</ul>
14907
14908	For an example of usage refer to the following files in VirtualBox SDK:
14909	<ul>
14910	<li>
14911	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14912	</li>
14913	<li>
14914	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14915	</li>
14916	</ul>
14917	</desc>
14918
14919	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14920	<desc>
14921	Array of unique names of metrics.
14922
14923	This array represents all metrics supported by the performance
14924	collector. Individual objects do not necessarily support all of them.
14925	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14926	list of supported metrics for a particular object.
14927	</desc>
14928	</attribute>
14929
14930	<method name="getMetrics">
14931	<desc>
14932	Returns parameters of specified metrics for a set of objects.
14933	<note>
14934	@c Null metrics array means all metrics. @c Null object array means
14935	all existing objects.
14936	</note>
14937	</desc>
14938	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14939	<desc>
14940	Metric name filter. Currently, only a comma-separated list of metrics
14941	is supported.
14942	</desc>
14943	</param>
14944	<param name="objects" type="$unknown" dir="in" safearray="yes">
14945	<desc>
14946	Set of objects to return metric parameters for.
14947	</desc>
14948	</param>
14949	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14950	<desc>
14951	Array of returned metric parameters.
14952	</desc>
14953	</param>
14954	</method>
14955
14956	<method name="setupMetrics">
14957	<desc>
14958	Sets parameters of specified base metrics for a set of objects. Returns
14959	an array of <link to="IPerformanceMetric" /> describing the metrics
14960	have been affected.
14961	<note>
14962	@c Null or empty metric name array means all metrics. @c Null or
14963	empty object array means all existing objects. If metric name array
14964	contains a single element and object array contains many, the single
14965	metric name array element is applied to each object array element to
14966	form metric/object pairs.
14967	</note>
14968	</desc>
14969	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14970	<desc>
14971	Metric name filter. Comma-separated list of metrics with wildcard
14972	support.
14973	</desc>
14974	</param>
14975	<param name="objects" type="$unknown" dir="in" safearray="yes">
14976	<desc>
14977	Set of objects to setup metric parameters for.
14978	</desc>
14979	</param>
14980	<param name="period" type="unsigned long" dir="in">
14981	<desc>
14982	Time interval in seconds between two consecutive samples of
14983	performance data.
14984	</desc>
14985	</param>
14986	<param name="count" type="unsigned long" dir="in">
14987	<desc>
14988	Number of samples to retain in performance data history. Older
14989	samples get discarded.
14990	</desc>
14991	</param>
14992	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14993	<desc>
14994	Array of metrics that have been modified by the call to this method.
14995	</desc>
14996	</param>
14997	</method>
14998
14999	<method name="enableMetrics">
15000	<desc>
15001	Turns on collecting specified base metrics. Returns an array of
15002	<link to="IPerformanceMetric" /> describing the metrics have been
15003	affected.
15004	<note>
15005	@c Null or empty metric name array means all metrics. @c Null or
15006	empty object array means all existing objects. If metric name array
15007	contains a single element and object array contains many, the single
15008	metric name array element is applied to each object array element to
15009	form metric/object pairs.
15010	</note>
15011	</desc>
15012	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15013	<desc>
15014	Metric name filter. Comma-separated list of metrics with wildcard
15015	support.
15016	</desc>
15017	</param>
15018	<param name="objects" type="$unknown" dir="in" safearray="yes">
15019	<desc>
15020	Set of objects to enable metrics for.
15021	</desc>
15022	</param>
15023	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15024	<desc>
15025	Array of metrics that have been modified by the call to this method.
15026	</desc>
15027	</param>
15028	</method>
15029
15030	<method name="disableMetrics">
15031	<desc>
15032	Turns off collecting specified base metrics. Returns an array of
15033	<link to="IPerformanceMetric" /> describing the metrics have been
15034	affected.
15035	<note>
15036	@c Null or empty metric name array means all metrics. @c Null or
15037	empty object array means all existing objects. If metric name array
15038	contains a single element and object array contains many, the single
15039	metric name array element is applied to each object array element to
15040	form metric/object pairs.
15041	</note>
15042	</desc>
15043	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15044	<desc>
15045	Metric name filter. Comma-separated list of metrics with wildcard
15046	support.
15047	</desc>
15048	</param>
15049	<param name="objects" type="$unknown" dir="in" safearray="yes">
15050	<desc>
15051	Set of objects to disable metrics for.
15052	</desc>
15053	</param>
15054	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15055	<desc>
15056	Array of metrics that have been modified by the call to this method.
15057	</desc>
15058	</param>
15059	</method>
15060
15061	<method name="queryMetricsData">
15062	<desc>
15063	Queries collected metrics data for a set of objects.
15064
15065	The data itself and related metric information are returned in seven
15066	parallel and one flattened array of arrays. Elements of
15067	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15068	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15069	the same index describe one set of values corresponding to a single
15070	metric.
15071
15072	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15073	start and length of a sub-array is indicated by
15074	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15075	value for metric <tt>metricNames[i]</tt> is at
15076	<tt>returnData[returnIndices[i]]</tt>.
15077
15078	<note>
15079	@c Null or empty metric name array means all metrics. @c Null or
15080	empty object array means all existing objects. If metric name array
15081	contains a single element and object array contains many, the single
15082	metric name array element is applied to each object array element to
15083	form metric/object pairs.
15084	</note>
15085	<note>
15086	Data collection continues behind the scenes after call to @c
15087	queryMetricsData. The return data can be seen as the snapshot of the
15088	current state at the time of @c queryMetricsData call. The internally
15089	kept metric values are not cleared by the call. This makes possible
15090	querying different subsets of metrics or aggregates with subsequent
15091	calls. If periodic querying is needed it is highly suggested to query
15092	the values with @c interval*count period to avoid confusion. This way
15093	a completely new set of data values will be provided by each query.
15094	</note>
15095	</desc>
15096	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15097	<desc>
15098	Metric name filter. Comma-separated list of metrics with wildcard
15099	support.
15100	</desc>
15101	</param>
15102	<param name="objects" type="$unknown" dir="in" safearray="yes">
15103	<desc>
15104	Set of objects to query metrics for.
15105	</desc>
15106	</param>
15107	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15108	<desc>
15109	Names of metrics returned in @c returnData.
15110	</desc>
15111	</param>
15112	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15113	<desc>
15114	Objects associated with metrics returned in @c returnData.
15115	</desc>
15116	</param>
15117	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15118	<desc>
15119	Units of measurement for each returned metric.
15120	</desc>
15121	</param>
15122	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15123	<desc>
15124	Divisor that should be applied to return values in order to get
15125	floating point values. For example:
15126	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15127	will retrieve the floating point value of i-th sample of the first
15128	metric.
15129	</desc>
15130	</param>
15131	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15132	<desc>
15133	Sequence numbers of the first elements of value sequences of
15134	particular metrics returned in @c returnData. For aggregate metrics
15135	it is the sequence number of the sample the aggregate started
15136	calculation from.
15137	</desc>
15138	</param>
15139	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15140	<desc>
15141	Indices of the first elements of value sequences of particular
15142	metrics returned in @c returnData.
15143	</desc>
15144	</param>
15145	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15146	<desc>
15147	Lengths of value sequences of particular metrics.
15148	</desc>
15149	</param>
15150	<param name="returnData" type="long" dir="return" safearray="yes">
15151	<desc>
15152	Flattened array of all metric data containing sequences of values for
15153	each metric.
15154	</desc>
15155	</param>
15156	</method>
15157
15158	</interface>
15159
15160	<enum
15161	name="NATAliasMode"
15162	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
15163	>
15164	<desc></desc>
15165	<const name="AliasLog" value="0x1">
15166	<desc></desc>
15167	</const>
15168	<const name="AliasProxyOnly" value="0x02">
15169	<desc></desc>
15170	</const>
15171	<const name="AliasUseSamePorts" value="0x04">
15172	<desc></desc>
15173	</const>
15174	</enum>
15175
15176	<enum
15177	name="NATProtocol"
15178	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
15179	>
15180	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
15181	<const name="UDP" value="0">
15182	<desc>Port-forwarding uses UDP protocol.</desc>
15183	</const>
15184	<const name="TCP" value="1">
15185	<desc>Port-forwarding uses TCP protocol.</desc>
15186	</const>
15187	</enum>
15188
15189	<interface
15190	name="INATEngine" extends="$unknown"
15191	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
15192	wsmap="managed"
15193	>
15194	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
15195	allows for changing NAT behavior such as port-forwarding rules. This interface is
15196	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
15197	<attribute name="network" type="wstring">
15198	<desc>The network attribute of the NAT engine (the same value is used with built-in
15199	DHCP server to fill corresponding fields of DHCP leases).</desc>
15200	</attribute>
15201	<attribute name="hostIP" type="wstring">
15202	<desc>IP of host interface to bind all opened sockets to.
15203	<note>Changing this does not change binding of port forwarding.</note>
15204	</desc>
15205	</attribute>
15206	<attribute name="tftpPrefix" type="wstring">
15207	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
15208	the corresponding fields of DHCP leases.</desc>
15209	</attribute>
15210	<attribute name="tftpBootFile" type="wstring">
15211	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
15212	the corresponding fields of DHCP leases.</desc>
15213	</attribute>
15214	<attribute name="tftpNextServer" type="wstring">
15215	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
15216	the corresponding fields of DHCP leases.
15217	<note>The preferred form is IPv4 addresses.</note>
15218	</desc>
15219	</attribute>
15220	<attribute name="aliasMode" type="unsigned long">
15221	<desc></desc>
15222	</attribute>
15223	<attribute name="dnsPassDomain" type="boolean">
15224	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
15225	</attribute>
15226	<attribute name="dnsProxy" type="boolean">
15227	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15228	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
15229	</attribute>
15230	<attribute name="dnsUseHostResolver" type="boolean">
15231	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15232	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
15233	</attribute>
15234	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
15235	<desc>Array of NAT port-forwarding rules in string representation, in the following
15236	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
15237	</attribute>
15238	<method name="setNetworkSettings">
15239	<desc>Sets network configuration of the NAT engine.</desc>
15240	<param name="mtu" type="unsigned long" dir="in">
15241	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
15242	</param>
15243	<param name="sockSnd" type="unsigned long" dir="in">
15244	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
15245	</param>
15246	<param name="sockRcv" type="unsigned long" dir="in">
15247	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
15248	</param>
15249	<param name="TcpWndSnd" type="unsigned long" dir="in">
15250	<desc>Initial size of the NAT engine's sending TCP window in bytes when
15251	establishing a new TCP connection.</desc>
15252	</param>
15253	<param name="TcpWndRcv" type="unsigned long" dir="in">
15254	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
15255	establishing a new TCP connection.</desc>
15256	</param>
15257	</method>
15258	<method name="getNetworkSettings">
15259	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
15260	for parameter descriptions.</desc>
15261	<param name="mtu" type="unsigned long" dir="out" />
15262	<param name="sockSnd" type="unsigned long" dir="out" />
15263	<param name="sockRcv" type="unsigned long" dir="out" />
15264	<param name="TcpWndSnd" type="unsigned long" dir="out" />
15265	<param name="TcpWndRcv" type="unsigned long" dir="out" />
15266	</method>
15267	<method name="addRedirect">
15268	<desc>Adds a new NAT port-forwarding rule.</desc>
15269	<param name="name" type="wstring" dir="in">
15270	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
15271	auto-generates one using the other parameters.</desc>
15272	</param>
15273	<param name="proto" type="NATProtocol" dir="in">
15274	<desc>Protocol handled with the rule.</desc>
15275	</param>
15276	<param name="hostIp" type="wstring" dir="in">
15277	<desc>IP of the host interface to which the rule should apply. An empty ip address is
15278	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
15279	</param>
15280	<param name="hostPort" type="unsigned short" dir="in">
15281	<desc>The port number to listen on.</desc>
15282	</param>
15283	<param name="guestIp" type="wstring" dir="in">
15284	<desc>The IP address of the guest which the NAT engine will forward matching packets
15285	to. An empty IP address is acceptable, in which case the NAT engine will forward
15286	packets to the first DHCP lease (x.x.x.15).</desc>
15287	</param>
15288	<param name="guestPort" type="unsigned short" dir="in">
15289	<desc>The port number to forward.</desc>
15290	</param>
15291	</method>
15292	<method name="removeRedirect">
15293	<desc>Removes a port-forwarding rule that was previously registered.</desc>
15294	<param name="name" type="wstring" dir="in">
15295	<desc>The name of the rule to delete.</desc>
15296	</param>
15297	</method>
15298	</interface>
15299
15300	<!--
15301	// IExtPackManager
15302	/////////////////////////////////////////////////////////////////////////
15303	-->
15304
15305	<interface
15306	name="IExtPackPlugIn" extends="$unknown"
15307	uuid="58000040-e718-4746-bbce-4b86d96da461"
15308	wsmap="suppress"
15309	>
15310	<desc>
15311	Interface for keeping information about a plug-in that ships with an
15312	extension pack.
15313	</desc>
15314	<attribute name="name" type="wstring" readonly="yes">
15315	<desc>The plug-in name.</desc>
15316	</attribute>
15317	<attribute name="description" type="wstring" readonly="yes">
15318	<desc>The plug-in description.</desc>
15319	</attribute>
15320	<attribute name="frontend" type="wstring" readonly="yes">
15321	<desc>
15322	The name of the frontend or component name this plug-in plugs into.
15323	</desc>
15324	</attribute>
15325	<attribute name="modulePath" type="wstring" readonly="yes">
15326	<desc> The module path. </desc>
15327	</attribute>
15328	</interface>
15329
15330	<interface
15331	name="IExtPackBase" extends="$unknown"
15332	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
15333	wsmap="suppress"
15334	>
15335	<desc>
15336	Interface for querying information about an extension pack as well as
15337	accessing COM objects within it.
15338	</desc>
15339	<attribute name="name" type="wstring" readonly="yes">
15340	<desc>The extension pack name. This is unique.</desc>
15341	</attribute>
15342	<attribute name="description" type="wstring" readonly="yes">
15343	<desc>The extension pack description.</desc>
15344	</attribute>
15345	<attribute name="version" type="wstring" readonly="yes">
15346	<desc>
15347	The extension pack version string. This is on the same form as
15348	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
15349	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
15350	or "1.2.3_BETA1-r45678-OSE"
15351	</desc>
15352	</attribute>
15353	<attribute name="revision" type="unsigned long" readonly="yes">
15354	<desc>The extension pack internal revision number.</desc>
15355	</attribute>
15356	<attribute name="VRDEModule" type="wstring" readonly="yes">
15357	<desc>The name of the VRDE module if the extension pack sports one.</desc>
15358	</attribute>
15359	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
15360	<desc>Plug-ins provided by this extension pack.</desc>
15361	</attribute>
15362	<attribute name="usable" type="boolean" readonly="yes">
15363	<desc>
15364	Indicates whether the extension pack is usable or not.
15365
15366	There are a number of reasons why an extension pack might be unusable,
15367	typical examples would be broken installation/file or that it is
15368	incompatible with the current VirtualBox version.
15369	</desc>
15370	</attribute>
15371	<attribute name="whyUnusable" type="wstring" readonly="yes">
15372	<desc>
15373	String indicating why the extension pack is not usable. This is an
15374	empty string if usable and always a non-empty string if not usable.
15375	</desc>
15376	</attribute>
15377	<attribute name="showLicense" type="boolean" readonly="yes">
15378	<desc>Whether to show the license before installation</desc>
15379	</attribute>
15380	<attribute name="license" type="wstring" readonly="yes">
15381	<desc>
15382	The default HTML license text for the extension pack. Same as
15383	calling <link to="#queryLicense">queryLicense</link> with
15384	preferredLocale and preferredLanguage as empty strings and format set
15385	to html.
15386	</desc>
15387	</attribute>
15388
15389	<method name="queryLicense">
15390	<desc>
15391	Full feature version of the license attribute.
15392	</desc>
15393	<param name="preferredLocale" type="wstring" dir="in">
15394	<desc>
15395	The preferred license locale. Pass an empty string to get the default
15396	license.
15397	</desc>
15398	</param>
15399	<param name="preferredLanguage" type="wstring" dir="in">
15400	<desc>
15401	The preferred license language. Pass an empty string to get the
15402	default language for the locale.
15403	</desc>
15404	</param>
15405	<param name="format" type="wstring" dir="in">
15406	<desc>
15407	The license format: html, rtf or txt. If a license is present there
15408	will always be an HTML of it, the rich text format (RTF) and plain
15409	text (txt) versions are optional. If
15410	</desc>
15411	</param>
15412	<param name="licenseText" type="wstring" dir="return">
15413	<desc>The license text.</desc>
15414	</param>
15415	</method>
15416
15417	</interface>
15418
15419	<interface
15420	name="IExtPack" extends="IExtPackBase"
15421	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
15422	wsmap="suppress"
15423	>
15424	<desc>
15425	Interface for querying information about an extension pack as well as
15426	accessing COM objects within it.
15427	</desc>
15428	<method name="queryObject">
15429	<desc>
15430	Queries the IUnknown interface to an object in the extension pack
15431	main module. This allows plug-ins and others to talk directly to an
15432	extension pack.
15433	</desc>
15434	<param name="objUuid" type="wstring" dir="in">
15435	<desc>The object ID. What exactly this is </desc>
15436	</param>
15437	<param name="returnInterface" type="$unknown" dir="return">
15438	<desc>The queried interface.</desc>
15439	</param>
15440	</method>
15441	</interface>
15442
15443	<interface
15444	name="IExtPackFile" extends="IExtPackBase"
15445	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
15446	wsmap="suppress"
15447	>
15448	<desc>
15449	Extension pack file (aka tarball, .vbox-extpack) representation returned
15450	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
15451	extension pack information with the addition of the file name.
15452	</desc>
15453	<attribute name="filePath" type="wstring" readonly="yes">
15454	<desc>
15455	The path to the extension pack file.
15456	</desc>
15457	</attribute>
15458
15459	<method name="install">
15460	<desc>
15461	Install the extension pack.
15462	</desc>
15463	<param name="replace" type="boolean" dir="in">
15464	<desc>
15465	Set this to automatically uninstall any existing extension pack with
15466	the same name as the one being installed.
15467	</desc>
15468	</param>
15469	<param name="displayInfo" type="wstring" dir="in">
15470	<desc>
15471	Platform specific display information. Reserved for future hacks.
15472	</desc>
15473	</param>
15474	<param name="progess" type="IProgress" dir="return">
15475	<desc>
15476	Progress object for the operation.
15477	</desc>
15478	</param>
15479	</method>
15480	</interface>
15481
15482	<interface
15483	name="IExtPackManager" extends="$unknown"
15484	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
15485	wsmap="suppress"
15486	>
15487	<desc>
15488	Interface for managing VirtualBox Extension Packs.
15489
15490	TODO: Describe extension packs, how they are managed and how to create
15491	one.
15492	</desc>
15493
15494	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
15495	<desc>
15496	List of the installed extension packs.
15497	</desc>
15498	</attribute>
15499
15500	<method name="find">
15501	<desc>
15502	Returns the extension pack with the specified name if found.
15503
15504	<result name="VBOX_E_OBJECT_NOT_FOUND">
15505	No extension pack matching @a name was found.
15506	</result>
15507	</desc>
15508	<param name="name" type="wstring" dir="in">
15509	<desc>The name of the extension pack to locate.</desc>
15510	</param>
15511	<param name="returnData" type="IExtPack" dir="return">
15512	<desc>The extension pack if found.</desc>
15513	</param>
15514	</method>
15515
15516	<method name="openExtPackFile">
15517	<desc>
15518	Attempts to open an extension pack file in preparation for
15519	installation.
15520	</desc>
15521	<param name="path" type="wstring" dir="in">
15522	<desc>The path of the extension pack tarball.</desc>
15523	</param>
15524	<param name="file" type="IExtPackFile" dir="return">
15525	<desc>The interface of the extension pack file object.</desc>
15526	</param>
15527	</method>
15528
15529	<method name="uninstall">
15530	<desc>Uninstalls an extension pack, removing all related files.</desc>
15531	<param name="name" type="wstring" dir="in">
15532	<desc>The name of the extension pack to uninstall.</desc>
15533	</param>
15534	<param name="forcedRemoval" type="boolean" dir="in">
15535	<desc>
15536	Forced removal of the extension pack. This means that the uninstall
15537	hook will not be called.
15538	</desc>
15539	</param>
15540	<param name="displayInfo" type="wstring" dir="in">
15541	<desc>
15542	Platform specific display information. Reserved for future hacks.
15543	</desc>
15544	</param>
15545	<param name="progess" type="IProgress" dir="return">
15546	<desc>
15547	Progress object for the operation.
15548	</desc>
15549	</param>
15550	</method>
15551
15552	<method name="cleanup">
15553	<desc>Cleans up failed installs and uninstalls</desc>
15554	</method>
15555
15556	<method name="queryAllPlugInsForFrontend">
15557	<desc>
15558	Gets the path to all the plug-in modules for a given frontend.
15559
15560	This is a convenience method that is intended to simplify the plug-in
15561	loading process for a frontend.
15562	</desc>
15563	<param name="frontendName" type="wstring" dir="in">
15564	<desc>The name of the frontend or component.</desc>
15565	</param>
15566	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
15567	<desc>Array containing the plug-in modules (full paths).</desc>
15568	</param>
15569	</method>
15570
15571	<method name="isExtPackUsable">
15572	<desc>Check if the given extension pack is loaded and usable.</desc>
15573	<param name="name" type="wstring" dir="in">
15574	<desc>The name of the extension pack to check for.</desc>
15575	</param>
15576	<param name="usable" type="boolean" dir="return">
15577	<desc>Is the given extension pack loaded and usable.</desc>
15578	</param>
15579	</method>
15580
15581	</interface>
15582
15583	<!--
15584	// BandwidthGroupType
15585	/////////////////////////////////////////////////////////////////////////
15586	-->
15587	<enum
15588	name="BandwidthGroupType"
15589	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
15590
15591	<desc>
15592	Type of a bandwidth control group.
15593	</desc>
15594
15595	<const name="Null" value="0">
15596	<desc>
15597	Null type, must be first.
15598	</desc>
15599	</const>
15600
15601	<const name="Disk" value="1">
15602	<desc>
15603	The bandwidth group controls disk I/O.
15604	</desc>
15605	</const>
15606
15607	<const name="Network" value="2">
15608	<desc>
15609	The bandwidth group controls network I/O.
15610	</desc>
15611	</const>
15612
15613	</enum>
15614
15615	<!--
15616	// IBandwidthGroup
15617	/////////////////////////////////////////////////////////////////////////
15618	-->
15619	<interface
15620	name="IBandwidthGroup" extends="$unknown"
15621	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
15622	wsmap="managed"
15623	>
15624	<desc>Represents one bandwidth group.</desc>
15625
15626	<attribute name="name" type="wstring" readonly="yes">
15627	<desc>Name of the group.</desc>
15628	</attribute>
15629
15630	<attribute name="type" type="BandwidthGroupType" readonly="yes">
15631	<desc>Type of the group.</desc>
15632	</attribute>
15633
15634	<attribute name="reference" type="unsigned long" readonly="yes">
15635	<desc>How many devices/medium attachements use this group.</desc>
15636	</attribute>
15637
15638	<attribute name="maxMbPerSec" type="unsigned long">
15639	<desc>The maximum number of MBytes which can be transfered by all
15640	entities attached to this group during one second.</desc>
15641	</attribute>
15642
15643	</interface>
15644
15645	<!--
15646	// IBandwidthControl
15647	/////////////////////////////////////////////////////////////////////////
15648	-->
15649	<interface
15650	name="IBandwidthControl" extends="$unknown"
15651	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
15652	wsmap="managed"
15653	>
15654	<desc>
15655	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
15656	This includes network and disk I/O.
15657	</desc>
15658
15659	<attribute name="numGroups" type="unsigned long" readonly="yes">
15660	<desc>
15661	The current number of existing bandwidth groups managed.
15662	</desc>
15663	</attribute>
15664
15665	<method name="createBandwidthGroup">
15666	<desc>
15667	Creates a new bandwidth group.
15668	</desc>
15669
15670	<param name="name" type="wstring" dir="in">
15671	<desc>Name of the bandwidth group.</desc>
15672	</param>
15673	<param name="type" type="BandwidthGroupType" dir="in">
15674	<desc>The type of the bandwidth group (network or disk).</desc>
15675	</param>
15676	<param name="maxMbPerSec" type="unsigned long" dir="in">
15677	<desc>The maximum number of MBytes which can be transfered by all
15678	entities attached to this group during one second.</desc>
15679	</param>
15680	</method>
15681
15682	<method name="deleteBandwidthGroup">
15683	<desc>
15684	Deletes a new bandwidth group.
15685	</desc>
15686
15687	<param name="name" type="wstring" dir="in">
15688	<desc>Name of the bandwidth group to delete.</desc>
15689	</param>
15690	</method>
15691
15692	<method name="getBandwidthGroup" const="yes">
15693	<desc>
15694	Get a bandwidth group by name.
15695	</desc>
15696
15697	<param name="name" type="wstring" dir="in">
15698	<desc>Name of the bandwidth group to get.</desc>
15699	</param>
15700	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
15701	<desc>Where to store the bandwidth group on success.</desc>
15702	</param>
15703	</method>
15704
15705	<method name="getAllBandwidthGroups" const="yes">
15706	<desc>
15707	Get all managed bandwidth groups.
15708	</desc>
15709
15710	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
15711	<desc>The array of managed bandwidth groups.</desc>
15712	</param>
15713	</method>
15714	</interface>
15715
15716	<!--
15717	// IVirtualBoxClient
15718	/////////////////////////////////////////////////////////////////////////
15719	-->
15720
15721	<interface
15722	name="IVirtualBoxClient" extends="$unknown"
15723	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
15724	wsmap="suppress"
15725	>
15726	<desc>
15727	Convenience interface for client applications. Treat this as a
15728	singleton, i.e. never create more than one instance of this interface.
15729
15730	At the moment only available for clients of the local API (not usable
15731	via the webservice). Once the session logic is redesigned this might
15732	change.
15733	</desc>
15734
15735	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
15736	<desc>
15737	Reference to the server-side API root object.
15738	</desc>
15739	</attribute>
15740
15741	<attribute name="session" type="ISession" readonly="yes">
15742	<desc>
15743	Create a new session object and return the reference to it.
15744	</desc>
15745	</attribute>
15746
15747	<attribute name="eventSource" type="IEventSource" readonly="yes">
15748	<desc>
15749	Event source for VirtualBoxClient events.
15750	</desc>
15751	</attribute>
15752
15753	</interface>
15754
15755	<!--
15756	// Events
15757	/////////////////////////////////////////////////////////////////////////
15758	-->
15759	<enum
15760	name="VBoxEventType"
15761	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
15762	>
15763
15764	<desc>
15765	Type of an event.
15766	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15767	</desc>
15768
15769	<const name="Invalid" value="0">
15770	<desc>
15771	Invalid event, must be first.
15772	</desc>
15773	</const>
15774
15775	<const name="Any" value="1">
15776	<desc>
15777	Wildcard for all events.
15778	Events of this type are never delivered, and only used in
15779	<link to="IEventSource::registerListener"/> call to simplify registration.
15780	</desc>
15781	</const>
15782
15783	<const name="Vetoable" value="2">
15784	<desc>
15785	Wildcard for all vetoable events. Events of this type are never delivered, and only
15786	used in <link to="IEventSource::registerListener"/> call to simplify registration.
15787	</desc>
15788	</const>
15789
15790	<const name="MachineEvent" value="3">
15791	<desc>
15792	Wildcard for all machine events. Events of this type are never delivered, and only used in
15793	<link to="IEventSource::registerListener"/> call to simplify registration.
15794	</desc>
15795	</const>
15796
15797	<const name="SnapshotEvent" value="4">
15798	<desc>
15799	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
15800	<link to="IEventSource::registerListener"/> call to simplify registration.
15801	</desc>
15802	</const>
15803
15804	<const name="InputEvent" value="5">
15805	<desc>
15806	Wildcard for all input device (keyboard, mouse) events.
15807	Events of this type are never delivered, and only used in
15808	<link to="IEventSource::registerListener"/> call to simplify registration.
15809	</desc>
15810	</const>
15811
15812	<const name="LastWildcard" value="31">
15813	<desc>
15814	Last wildcard.
15815	</desc>
15816	</const>
15817
15818	<const name="OnMachineStateChanged" value="32">
15819	<desc>
15820	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
15821	</desc>
15822	</const>
15823	<const name="OnMachineDataChanged" value="33">
15824	<desc>
15825	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
15826	</desc>
15827	</const>
15828	<const name="OnExtraDataChanged" value="34">
15829	<desc>
15830	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
15831	</desc>
15832	</const>
15833	<const name="OnExtraDataCanChange" value="35">
15834	<desc>
15835	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
15836	</desc>
15837	</const>
15838	<const name="OnMediumRegistered" value="36">
15839	<desc>
15840	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
15841	</desc>
15842	</const>
15843	<const name="OnMachineRegistered" value="37">
15844	<desc>
15845	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
15846	</desc>
15847	</const>
15848	<const name="OnSessionStateChanged" value="38">
15849	<desc>
15850	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
15851	</desc>
15852	</const>
15853	<const name="OnSnapshotTaken" value="39">
15854	<desc>
15855	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
15856	</desc>
15857	</const>
15858	<const name="OnSnapshotDeleted" value="40">
15859	<desc>
15860	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
15861	</desc>
15862	</const>
15863	<const name="OnSnapshotChanged" value="41">
15864	<desc>
15865	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
15866	</desc>
15867	</const>
15868	<const name="OnGuestPropertyChanged" value="42">
15869	<desc>
15870	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
15871	</desc>
15872	</const>
15873	<!-- Console events -->
15874	<const name="OnMousePointerShapeChanged" value="43">
15875	<desc>
15876	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
15877	</desc>
15878	</const>
15879	<const name="OnMouseCapabilityChanged" value="44">
15880	<desc>
15881	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
15882	</desc>
15883	</const>
15884	<const name="OnKeyboardLedsChanged" value="45">
15885	<desc>
15886	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
15887	</desc>
15888	</const>
15889	<const name="OnStateChanged" value="46">
15890	<desc>
15891	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
15892	</desc>
15893	</const>
15894	<const name="OnAdditionsStateChanged" value="47">
15895	<desc>
15896	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
15897	</desc>
15898	</const>
15899	<const name="OnNetworkAdapterChanged" value="48">
15900	<desc>
15901	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
15902	</desc>
15903	</const>
15904	<const name="OnSerialPortChanged" value="49">
15905	<desc>
15906	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
15907	</desc>
15908	</const>
15909	<const name="OnParallelPortChanged" value="50">
15910	<desc>
15911	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
15912	</desc>
15913	</const>
15914	<const name="OnStorageControllerChanged" value="51">
15915	<desc>
15916	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
15917	</desc>
15918	</const>
15919	<const name="OnMediumChanged" value="52">
15920	<desc>
15921	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
15922	</desc>
15923	</const>
15924	<const name="OnVRDEServerChanged" value="53">
15925	<desc>
15926	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
15927	</desc>
15928	</const>
15929	<const name="OnUSBControllerChanged" value="54">
15930	<desc>
15931	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
15932	</desc>
15933	</const>
15934	<const name="OnUSBDeviceStateChanged" value="55">
15935	<desc>
15936	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
15937	</desc>
15938	</const>
15939	<const name="OnSharedFolderChanged" value="56">
15940	<desc>
15941	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
15942	</desc>
15943	</const>
15944	<const name="OnRuntimeError" value="57">
15945	<desc>
15946	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
15947	</desc>
15948	</const>
15949	<const name="OnCanShowWindow" value="58">
15950	<desc>
15951	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
15952	</desc>
15953	</const>
15954	<const name="OnShowWindow" value="59">
15955	<desc>
15956	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
15957	</desc>
15958	</const>
15959	<const name="OnCPUChanged" value="60">
15960	<desc>
15961	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
15962	</desc>
15963	</const>
15964	<const name="OnVRDEServerInfoChanged" value="61">
15965	<desc>
15966	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
15967	</desc>
15968	</const>
15969	<const name="OnEventSourceChanged" value="62">
15970	<desc>
15971	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
15972	</desc>
15973	</const>
15974	<const name="OnCPUExecutionCapChanged" value="63">
15975	<desc>
15976	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
15977	</desc>
15978	</const>
15979	<const name="OnGuestKeyboard" value="64">
15980	<desc>
15981	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
15982	</desc>
15983	</const>
15984	<const name="OnGuestMouse" value="65">
15985	<desc>
15986	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
15987	</desc>
15988	</const>
15989	<const name="OnNATRedirect" value="66">
15990	<desc>
15991	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
15992	</desc>
15993	</const>
15994	<const name="OnHostPciDevicePlug" value="67">
15995	<desc>
15996	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
15997	</desc>
15998	</const>
15999	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16000	<desc>
16001	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16002	</desc>
16003	</const>
16004	<const name="OnBandwidthGroupChanged" value="69">
16005	<desc>
16006	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16007	</desc>
16008	</const>
16009	<const name="OnGuestMonitorChanged" value="70">
16010	<desc>
16011	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16012	</desc>
16013	</const>
16014	<const name="OnStorageDeviceChanged" value="71">
16015	<desc>
16016	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16017	</desc>
16018	</const>
16019
16020	<!-- Last event marker -->
16021	<const name="Last" value="72">
16022	<desc>
16023	Must be last event, used for iterations and structures relying on numerical event values.
16024	</desc>
16025	</const>
16026
16027	</enum>
16028
16029	<interface
16030	name="IEventSource" extends="$unknown"
16031	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16032	wsmap="managed"
16033	>
16034	<desc>
16035	Event source. Generally, any object which could generate events can be an event source,
16036	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16037	an event source can work with listeners in either active or passive mode. In active mode it is up to
16038	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16039	event source keeps track of pending events for each listener and returns available events on demand.
16040
16041	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16042	</desc>
16043
16044	<method name="createListener">
16045	<desc>
16046	Creates a new listener object, useful for passive mode.
16047	</desc>
16048	<param name="listener" type="IEventListener" dir="return"/>
16049	</method>
16050
16051	<method name="createAggregator">
16052	<desc>
16053	Creates an aggregator event source, collecting events from multiple sources.
16054	This way a single listener can listen for events coming from multiple sources,
16055	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16056	</desc>
16057	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16058	<desc>
16059	Subordinate event source this one aggregatres.
16060	</desc>
16061	</param>
16062	<param name="result" type="IEventSource" dir="return">
16063	<desc>
16064	Event source aggregating passed sources.
16065	</desc>
16066	</param>
16067	</method>
16068
16069	<method name="registerListener">
16070	<desc>
16071	Register an event listener.
16072
16073	<note>
16074	To avoid system overload, the VirtualBox server process checks if passive event
16075	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16076	current implementation, if more than 500 pending events are detected for a passive
16077	event listener, it is forcefully unregistered by the system, and further
16078	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16079	</note>
16080	</desc>
16081	<param name="listener" type="IEventListener" dir="in">
16082	<desc>Listener to register.</desc>
16083	</param>
16084	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16085	<desc>
16086	Event types listener is interested in. One can use wildcards like -
16087	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16088	than one event.
16089	</desc>
16090	</param>
16091	<param name="active" type="boolean" dir="in">
16092	<desc>
16093	Which mode this listener is operating in.
16094	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16095	In passive mode, an internal event queue is created for this this IEventListener.
16096	For each event coming in, it is added to queues for all interested registered passive
16097	listeners. It is then up to the external code to call the listener's
16098	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16099	external code must call <link to="#eventProcessed" />.
16100	</desc>
16101	</param>
16102	</method>
16103
16104	<method name="unregisterListener">
16105	<desc>
16106	Unregister an event listener. If listener is passive, and some waitable events are still
16107	in queue they are marked as processed automatically.
16108	</desc>
16109	<param name="listener" type="IEventListener" dir="in">
16110	<desc>Listener to unregister.</desc>
16111	</param>
16112	</method>
16113
16114	<method name="fireEvent">
16115	<desc>
16116	Fire an event for this source.
16117	</desc>
16118	<param name="event" type="IEvent" dir="in">
16119	<desc>Event to deliver.</desc>
16120	</param>
16121	<param name="timeout" type="long" dir="in">
16122	<desc>
16123	Maximum time to wait for event processing (if event is waitable), in ms;
16124	0 = no wait, -1 = indefinite wait.
16125	</desc>
16126	</param>
16127	<param name="result" type="boolean" dir="return">
16128	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16129	</param>
16130	</method>
16131
16132	<method name="getEvent">
16133	<desc>
16134	Get events from this peer's event queue (for passive mode). Calling this method
16135	regularly is required for passive event listeners to avoid system overload;
16136	see <link to="IEventSource::registerListener" /> for details.
16137
16138	<result name="VBOX_E_OBJECT_NOT_FOUND">
16139	Listener is not registered, or autounregistered.
16140	</result>
16141	</desc>
16142	<param name="listener" type="IEventListener" dir="in">
16143	<desc>Which listener to get data for.</desc>
16144	</param>
16145	<param name="timeout" type="long" dir="in">
16146	<desc>
16147	Maximum time to wait for events, in ms;
16148	0 = no wait, -1 = indefinite wait.
16149	</desc>
16150	</param>
16151	<param name="event" type="IEvent" dir="return">
16152	<desc>Event retrieved, or null if none available.</desc>
16153	</param>
16154	</method>
16155
16156	<method name="eventProcessed">
16157	<desc>
16158	Must be called for waitable events after a particular listener finished its
16159	event processing. When all listeners of a particular event have called this
16160	method, the system will then call <link to="IEvent::setProcessed" />.
16161	</desc>
16162	<param name="listener" type="IEventListener" dir="in">
16163	<desc>Which listener processed event.</desc>
16164	</param>
16165	<param name="event" type="IEvent" dir="in">
16166	<desc>Which event.</desc>
16167	</param>
16168	</method>
16169
16170	</interface>
16171
16172	<interface
16173	name="IEventListener" extends="$unknown"
16174	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
16175	wsmap="managed"
16176	>
16177	<desc>
16178	Event listener. An event listener can work in either active or passive mode, depending on the way
16179	it was registered.
16180	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16181	</desc>
16182
16183	<method name="handleEvent">
16184	<desc>
16185	Handle event callback for active listeners. It is not called for
16186	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
16187	and having received acknowledgement from all passive listeners via
16188	<link to="IEventSource::eventProcessed"/>, the event is marked as
16189	processed and <link to="IEvent::waitProcessed"/> will return
16190	immediately.
16191	</desc>
16192	<param name="event" type="IEvent" dir="in">
16193	<desc>Event available.</desc>
16194	</param>
16195	</method>
16196
16197	</interface>
16198
16199	<interface
16200	name="IEvent" extends="$unknown"
16201	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
16202	wsmap="managed"
16203	>
16204	<desc>
16205	Abstract parent interface for VirtualBox events. Actual events will typically implement
16206	a more specific interface which derives from this (see below).
16207
16208	<b>Introduction to VirtualBox events</b>
16209
16210	Generally speaking, an event (represented by this interface) signals that something
16211	happened, while an event listener (see <link to="IEventListener" />) represents an
16212	entity that is interested in certain events. In order for this to work with
16213	unidirectional protocols (i.e. web services), the concepts of passive and active
16214	listener are used.
16215
16216	Event consumers can register themselves as listeners, providing an array of
16217	events they are interested in (see <link to="IEventSource::registerListener" />).
16218	When an event triggers, the listener is notified about the event. The exact
16219	mechanism of the notification depends on whether the listener was registered as
16220	an active or passive listener:
16221
16222	<ul>
16223	<li>An active listener is very similar to a callback: it is a function invoked
16224	by the API. As opposed to the callbacks that were used in the API before
16225	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
16226	</li>
16227
16228	<li>Passive listeners are somewhat trickier to implement, but do not require
16229	a client function to be callable, which is not an option with scripting
16230	languages or web service clients. Internally the <link to="IEventSource" />
16231	implementation maintains an event queue for each passive listener, and
16232	newly arrived events are put in this queue. When the listener calls
16233	<link to="IEventSource::getEvent"/>, first element from its internal event
16234	queue is returned. When the client completes processing of an event,
16235	the <link to="IEventSource::eventProcessed" /> function must be called,
16236	acknowledging that the event was processed. It supports implementing
16237	waitable events. On passive listener unregistration, all events from its
16238	queue are auto-acknowledged.
16239	</li>
16240	</ul>
16241
16242	Waitable events are useful in situations where the event generator wants to track
16243	delivery or a party wants to wait until all listeners have completed the event. A
16244	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
16245	listeners might veto a certain action, and thus the event producer has to make
16246	sure that all listeners have processed the event and not vetoed before taking
16247	the action.
16248
16249	A given event may have both passive and active listeners at the same time.
16250
16251	<b>Using events</b>
16252
16253	Any VirtualBox object capable of producing externally visible events provides an
16254	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
16255	This event source object is notified by VirtualBox once something has happened, so
16256	consumers may register event listeners with this event source. To register a listener,
16257	an object implementing the <link to="IEventListener" /> interface must be provided.
16258	For active listeners, such an object is typically created by the consumer, while for
16259	passive listeners <link to="IEventSource::createListener" /> should be used. Please
16260	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
16261
16262	Once created, the listener must be registered to listen for the desired events
16263	(see <link to="IEventSource::registerListener" />), providing an array of
16264	<link to="VBoxEventType" /> enums. Those elements can either be the individual
16265	event IDs or wildcards matching multiple event IDs.
16266
16267	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
16268	called automatically when the event is triggered, while passive listeners have to call
16269	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
16270	an event processing loop.
16271
16272	The IEvent interface is an abstract parent interface for all such VirtualBox events
16273	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
16274	or the event processing loop is to check the <link to="#type" /> attribute of the event and
16275	then cast to the appropriate specific interface using @c QueryInterface().
16276	</desc>
16277
16278	<attribute name="type" readonly="yes" type="VBoxEventType">
16279	<desc>
16280	Event type.
16281	</desc>
16282	</attribute>
16283
16284	<attribute name="source" readonly="yes" type="IEventSource">
16285	<desc>
16286	Source of this event.
16287	</desc>
16288	</attribute>
16289
16290	<attribute name="waitable" readonly="yes" type="boolean">
16291	<desc>
16292	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
16293	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
16294	as no additional overhead associated with waitability imposed.
16295	Waitable events are needed when one need to be able to wait for particular event processed,
16296	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
16297	until all consumers confirmed events.
16298	</desc>
16299	</attribute>
16300
16301	<method name="setProcessed">
16302	<desc>
16303	Internal method called by the system when all listeners of a particular event have called
16304	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
16305	</desc>
16306	</method>
16307
16308	<method name="waitProcessed">
16309	<desc>
16310	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
16311	described semantics, for non-waitable returns true immediately.
16312	</desc>
16313	<param name="timeout" type="long" dir="in">
16314	<desc>
16315	Maximum time to wait for event processeing, in ms;
16316	0 = no wait, -1 = indefinite wait.
16317	</desc>
16318	</param>
16319	<param name="result" type="boolean" dir="return">
16320	<desc>If this event was processed before timeout.</desc>
16321	</param>
16322	</method>
16323	</interface>
16324
16325
16326	<interface
16327	name="IReusableEvent" extends="IEvent"
16328	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
16329	wsmap="managed"
16330	>
16331	<desc>Base abstract interface for all reusable events.</desc>
16332
16333	<attribute name="generation" readonly="yes" type="unsigned long">
16334	<desc>Current generation of event, incremented on reuse.</desc>
16335	</attribute>
16336
16337	<method name="reuse">
16338	<desc>
16339	Marks an event as reused, increments 'generation', fields shall no
16340	longer be considered valid.
16341	</desc>
16342	</method>
16343	</interface>
16344
16345	<interface
16346	name="IMachineEvent" extends="IEvent"
16347	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
16348	wsmap="managed" id="MachineEvent"
16349	>
16350	<desc>Base abstract interface for all machine events.</desc>
16351
16352	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
16353	<desc>ID of the machine this event relates to.</desc>
16354	</attribute>
16355
16356	</interface>
16357
16358	<interface
16359	name="IMachineStateChangedEvent" extends="IMachineEvent"
16360	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
16361	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
16362	>
16363	<desc>Machine state change event.</desc>
16364
16365	<attribute name="state" readonly="yes" type="MachineState">
16366	<desc>New execution state.</desc>
16367	</attribute>
16368	</interface>
16369
16370	<interface
16371	name="IMachineDataChangedEvent" extends="IMachineEvent"
16372	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
16373	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
16374	>
16375	<desc>
16376	Any of the settings of the given machine has changed.
16377	</desc>
16378	</interface>
16379
16380	<interface
16381	name="IMediumRegisteredEvent" extends="IEvent"
16382	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
16383	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
16384	>
16385	<desc>
16386	The given medium was registered or unregistered
16387	within this VirtualBox installation.
16388	</desc>
16389
16390	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
16391	<desc>ID of the medium this event relates to.</desc>
16392	</attribute>
16393
16394	<attribute name="mediumType" readonly="yes" type="DeviceType">
16395	<desc>Type of the medium this event relates to.</desc>
16396	</attribute>
16397
16398	<attribute name="registered" type="boolean" readonly="yes">
16399	<desc>
16400	If @c true, the medium was registered, otherwise it was
16401	unregistered.
16402	</desc>
16403	</attribute>
16404	</interface>
16405
16406	<interface
16407	name="IMachineRegisteredEvent" extends="IMachineEvent"
16408	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
16409	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
16410	>
16411	<desc>
16412	The given machine was registered or unregistered
16413	within this VirtualBox installation.
16414	</desc>
16415
16416	<attribute name="registered" type="boolean" readonly="yes">
16417	<desc>
16418	If @c true, the machine was registered, otherwise it was
16419	unregistered.
16420	</desc>
16421	</attribute>
16422	</interface>
16423
16424	<interface
16425	name="ISessionStateChangedEvent" extends="IMachineEvent"
16426	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
16427	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
16428	>
16429	<desc>
16430	The state of the session for the given machine was changed.
16431	<see><link to="IMachine::sessionState"/></see>
16432	</desc>
16433
16434	<attribute name="state" type="SessionState" readonly="yes">
16435	<desc>
16436	New session state.
16437	</desc>
16438	</attribute>
16439	</interface>
16440
16441	<interface
16442	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
16443	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
16444	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
16445	>
16446	<desc>
16447	Notification when a guest property has changed.
16448	</desc>
16449
16450	<attribute name="name" readonly="yes" type="wstring">
16451	<desc>
16452	The name of the property that has changed.
16453	</desc>
16454	</attribute>
16455
16456	<attribute name="value" readonly="yes" type="wstring">
16457	<desc>
16458	The new property value.
16459	</desc>
16460	</attribute>
16461
16462	<attribute name="flags" readonly="yes" type="wstring">
16463	<desc>
16464	The new property flags.
16465	</desc>
16466	</attribute>
16467
16468	</interface>
16469
16470	<interface
16471	name="ISnapshotEvent" extends="IMachineEvent"
16472	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
16473	wsmap="managed" id="SnapshotEvent"
16474	>
16475	<desc>Base interface for all snapshot events.</desc>
16476
16477	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
16478	<desc>ID of the snapshot this event relates to.</desc>
16479	</attribute>
16480
16481	</interface>
16482
16483	<interface
16484	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
16485	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
16486	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
16487	>
16488	<desc>
16489	A new snapshot of the machine has been taken.
16490	<see><link to="ISnapshot"/></see>
16491	</desc>
16492	</interface>
16493
16494	<interface
16495	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
16496	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
16497	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
16498	>
16499	<desc>
16500	Snapshot of the given machine has been deleted.
16501
16502	<note>
16503	This notification is delivered <b>after</b> the snapshot
16504	object has been uninitialized on the server (so that any
16505	attempt to call its methods will return an error).
16506	</note>
16507
16508	<see><link to="ISnapshot"/></see>
16509	</desc>
16510	</interface>
16511
16512	<interface
16513	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
16514	uuid="07541941-8079-447a-a33e-47a69c7980db"
16515	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
16516	>
16517	<desc>
16518	Snapshot properties (name and/or description) have been changed.
16519	<see><link to="ISnapshot"/></see>
16520	</desc>
16521	</interface>
16522
16523	<interface
16524	name="IMousePointerShapeChangedEvent" extends="IEvent"
16525	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
16526	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
16527	>
16528	<desc>
16529	Notification when the guest mouse pointer shape has
16530	changed. The new shape data is given.
16531	</desc>
16532
16533	<attribute name="visible" type="boolean" readonly="yes">
16534	<desc>
16535	Flag whether the pointer is visible.
16536	</desc>
16537	</attribute>
16538	<attribute name="alpha" type="boolean" readonly="yes">
16539	<desc>
16540	Flag whether the pointer has an alpha channel.
16541	</desc>
16542	</attribute>
16543	<attribute name="xhot" type="unsigned long" readonly="yes">
16544	<desc>
16545	The pointer hot spot X coordinate.
16546	</desc>
16547	</attribute>
16548	<attribute name="yhot" type="unsigned long" readonly="yes">
16549	<desc>
16550	The pointer hot spot Y coordinate.
16551	</desc>
16552	</attribute>
16553	<attribute name="width" type="unsigned long" readonly="yes">
16554	<desc>
16555	Width of the pointer shape in pixels.
16556	</desc>
16557	</attribute>
16558	<attribute name="height" type="unsigned long" readonly="yes">
16559	<desc>
16560	Height of the pointer shape in pixels.
16561	</desc>
16562	</attribute>
16563	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
16564	<desc>
16565	Shape buffer arrays.
16566
16567	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
16568	followed by a 32-bpp XOR (color) mask.
16569
16570	For pointers without alpha channel the XOR mask pixels are 32
16571	bit values: (lsb)BGR0(msb). For pointers with alpha channel
16572	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
16573
16574	An AND mask is used for pointers with alpha channel, so if the
16575	callback does not support alpha, the pointer could be
16576	displayed as a normal color pointer.
16577
16578	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
16579	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
16580	height</tt>. The padding bits at the end of each scanline are
16581	undefined.
16582
16583	The XOR mask follows the AND mask on the next 4-byte aligned
16584	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
16585	Bytes in the gap between the AND and the XOR mask are undefined.
16586	The XOR mask scanlines have no gap between them and the size of
16587	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
16588
16589	<note>
16590	If @a shape is 0, only the pointer visibility is changed.
16591	</note>
16592	</desc>
16593	</attribute>
16594	</interface>
16595
16596	<interface
16597	name="IMouseCapabilityChangedEvent" extends="IEvent"
16598	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
16599	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
16600	>
16601	<desc>
16602	Notification when the mouse capabilities reported by the
16603	guest have changed. The new capabilities are passed.
16604	</desc>
16605	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
16606	<desc>
16607	Supports absolute coordinates.
16608	</desc>
16609	</attribute>
16610	<attribute name="supportsRelative" type="boolean" readonly="yes">
16611	<desc>
16612	Supports relative coordinates.
16613	</desc>
16614	</attribute>
16615	<attribute name="needsHostCursor" type="boolean" readonly="yes">
16616	<desc>
16617	If host cursor is needed.
16618	</desc>
16619	</attribute>
16620	</interface>
16621
16622	<interface
16623	name="IKeyboardLedsChangedEvent" extends="IEvent"
16624	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
16625	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
16626	>
16627	<desc>
16628	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
16629	to alter the state of the keyboard LEDs.
16630	</desc>
16631	<attribute name="numLock" type="boolean" readonly="yes">
16632	<desc>
16633	NumLock status.
16634	</desc>
16635	</attribute>
16636	<attribute name="capsLock" type="boolean" readonly="yes">
16637	<desc>
16638	CapsLock status.
16639	</desc>
16640	</attribute>
16641	<attribute name="scrollLock" type="boolean" readonly="yes">
16642	<desc>
16643	ScrollLock status.
16644	</desc>
16645	</attribute>
16646	</interface>
16647
16648	<interface
16649	name="IStateChangedEvent" extends="IEvent"
16650	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
16651	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
16652	>
16653	<desc>
16654	Notification when the execution state of the machine has changed.
16655	The new state is given.
16656	</desc>
16657	<attribute name="state" type="MachineState" readonly="yes">
16658	<desc>
16659	New machine state.
16660	</desc>
16661	</attribute>
16662	</interface>
16663
16664	<interface
16665	name="IAdditionsStateChangedEvent" extends="IEvent"
16666	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
16667	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
16668	>
16669	<desc>
16670	Notification when a Guest Additions property changes.
16671	Interested callees should query IGuest attributes to
16672	find out what has changed.
16673	</desc>
16674	</interface>
16675
16676	<interface
16677	name="INetworkAdapterChangedEvent" extends="IEvent"
16678	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
16679	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
16680	>
16681	<desc>
16682	Notification when a property of one of the
16683	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
16684	changes. Interested callees should use INetworkAdapter methods and
16685	attributes to find out what has changed.
16686	</desc>
16687	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
16688	<desc>
16689	Network adapter that is subject to change.
16690	</desc>
16691	</attribute>
16692	</interface>
16693
16694	<interface
16695	name="ISerialPortChangedEvent" extends="IEvent"
16696	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
16697	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
16698	>
16699	<desc>
16700	Notification when a property of one of the
16701	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
16702	Interested callees should use ISerialPort methods and attributes
16703	to find out what has changed.
16704	</desc>
16705	<attribute name="serialPort" type="ISerialPort" readonly="yes">
16706	<desc>
16707	Serial port that is subject to change.
16708	</desc>
16709	</attribute>
16710	</interface>
16711
16712	<interface
16713	name="IParallelPortChangedEvent" extends="IEvent"
16714	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
16715	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
16716	>
16717	<desc>
16718	Notification when a property of one of the
16719	virtual <link to="IMachine::getParallelPort">parallel ports</link>
16720	changes. Interested callees should use ISerialPort methods and
16721	attributes to find out what has changed.
16722	</desc>
16723	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
16724	<desc>
16725	Parallel port that is subject to change.
16726	</desc>
16727	</attribute>
16728	</interface>
16729
16730	<interface
16731	name="IStorageControllerChangedEvent" extends="IEvent"
16732	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
16733	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
16734	>
16735	<desc>
16736	Notification when a
16737	<link to="IMachine::mediumAttachments">medium attachment</link>
16738	changes.
16739	</desc>
16740	</interface>
16741
16742	<interface
16743	name="IMediumChangedEvent" extends="IEvent"
16744	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
16745	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
16746	>
16747	<desc>
16748	Notification when a
16749	<link to="IMachine::mediumAttachments">medium attachment</link>
16750	changes.
16751	</desc>
16752	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
16753	<desc>
16754	Medium attachment that is subject to change.
16755	</desc>
16756	</attribute>
16757	</interface>
16758
16759	<interface
16760	name="ICPUChangedEvent" extends="IEvent"
16761	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
16762	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
16763	>
16764	<desc>
16765	Notification when a CPU changes.
16766	</desc>
16767	<attribute name="cpu" type="unsigned long" readonly="yes">
16768	<desc>
16769	The CPU which changed.
16770	</desc>
16771	</attribute>
16772	<attribute name="add" type="boolean" readonly="yes">
16773	<desc>
16774	Flag whether the CPU was added or removed.
16775	</desc>
16776	</attribute>
16777	</interface>
16778
16779	<interface
16780	name="ICPUExecutionCapChangedEvent" extends="IEvent"
16781	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
16782	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
16783	>
16784	<desc>
16785	Notification when the CPU execution cap changes.
16786	</desc>
16787	<attribute name="executionCap" type="unsigned long" readonly="yes">
16788	<desc>
16789	The new CPU execution cap value. (1-100)
16790	</desc>
16791	</attribute>
16792	</interface>
16793
16794	<interface
16795	name="IGuestKeyboardEvent" extends="IEvent"
16796	uuid="88394258-7006-40d4-b339-472ee3801844"
16797	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
16798	>
16799	<desc>
16800	Notification when guest keyboard event happens.
16801	</desc>
16802	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
16803	<desc>
16804	Array of scancodes.
16805	</desc>
16806	</attribute>
16807	</interface>
16808
16809	<interface
16810	name="IGuestMouseEvent" extends="IReusableEvent"
16811	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
16812	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
16813	>
16814	<desc>
16815	Notification when guest mouse event happens.
16816	</desc>
16817
16818	<attribute name="absolute" type="boolean" readonly="yes">
16819	<desc>
16820	If this event is relative or absolute.
16821	</desc>
16822	</attribute>
16823
16824	<attribute name="x" type="long" readonly="yes">
16825	<desc>
16826	New X position, or X delta.
16827	</desc>
16828	</attribute>
16829
16830	<attribute name="y" type="long" readonly="yes">
16831	<desc>
16832	New Y position, or Y delta.
16833	</desc>
16834	</attribute>
16835
16836	<attribute name="z" type="long" readonly="yes">
16837	<desc>
16838	Z delta.
16839	</desc>
16840	</attribute>
16841
16842	<attribute name="w" type="long" readonly="yes">
16843	<desc>
16844	W delta.
16845	</desc>
16846	</attribute>
16847
16848	<attribute name="buttons" type="long" readonly="yes">
16849	<desc>
16850	Button state bitmask.
16851	</desc>
16852	</attribute>
16853
16854	</interface>
16855
16856
16857	<interface
16858	name="IVRDEServerChangedEvent" extends="IEvent"
16859	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
16860	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
16861	>
16862	<desc>
16863	Notification when a property of the
16864	<link to="IMachine::VRDEServer">VRDE server</link> changes.
16865	Interested callees should use IVRDEServer methods and attributes to
16866	find out what has changed.
16867	</desc>
16868	</interface>
16869
16870	<interface
16871	name="IVRDEServerInfoChangedEvent" extends="IEvent"
16872	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
16873	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
16874	>
16875	<desc>
16876	Notification when the status of the VRDE server changes. Interested callees
16877	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
16878	attributes to find out what is the current status.
16879	</desc>
16880	</interface>
16881
16882	<interface
16883	name="IUSBControllerChangedEvent" extends="IEvent"
16884	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
16885	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
16886	>
16887	<desc>
16888	Notification when a property of the virtual
16889	<link to="IMachine::USBController">USB controller</link> changes.
16890	Interested callees should use IUSBController methods and attributes to
16891	find out what has changed.
16892	</desc>
16893	</interface>
16894
16895	<interface
16896	name="IUSBDeviceStateChangedEvent" extends="IEvent"
16897	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
16898	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
16899	>
16900	<desc>
16901	Notification when a USB device is attached to or detached from
16902	the virtual USB controller.
16903
16904	This notification is sent as a result of the indirect
16905	request to attach the device because it matches one of the
16906	machine USB filters, or as a result of the direct request
16907	issued by <link to="IConsole::attachUSBDevice"/> or
16908	<link to="IConsole::detachUSBDevice"/>.
16909
16910	This notification is sent in case of both a succeeded and a
16911	failed request completion. When the request succeeds, the
16912	@a error parameter is @c null, and the given device has been
16913	already added to (when @a attached is @c true) or removed from
16914	(when @a attached is @c false) the collection represented by
16915	<link to="IConsole::USBDevices"/>. On failure, the collection
16916	doesn't change and the @a error parameter represents the error
16917	message describing the failure.
16918	</desc>
16919	<attribute name="device" type="IUSBDevice" readonly="yes">
16920	<desc>
16921	Device that is subject to state change.
16922	</desc>
16923	</attribute>
16924	<attribute name="attached" type="boolean" readonly="yes">
16925	<desc>
16926	@c true if the device was attached and @c false otherwise.
16927	</desc>
16928	</attribute>
16929	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
16930	<desc>
16931	@c null on success or an error message object on failure.
16932	</desc>
16933	</attribute>
16934	</interface>
16935
16936	<interface
16937	name="ISharedFolderChangedEvent" extends="IEvent"
16938	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
16939	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
16940	>
16941	<desc>
16942	Notification when a shared folder is added or removed.
16943	The @a scope argument defines one of three scopes:
16944	<link to="IVirtualBox::sharedFolders">global shared folders</link>
16945	(<link to="Scope_Global">Global</link>),
16946	<link to="IMachine::sharedFolders">permanent shared folders</link> of
16947	the machine (<link to="Scope_Machine">Machine</link>) or <link
16948	to="IConsole::sharedFolders">transient shared folders</link> of the
16949	machine (<link to="Scope_Session">Session</link>). Interested callees
16950	should use query the corresponding collections to find out what has
16951	changed.
16952	</desc>
16953	<attribute name="scope" type="Scope" readonly="yes">
16954	<desc>
16955	Scope of the notification.
16956	</desc>
16957	</attribute>
16958	</interface>
16959
16960	<interface
16961	name="IRuntimeErrorEvent" extends="IEvent"
16962	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
16963	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
16964	>
16965	<desc>
16966	Notification when an error happens during the virtual
16967	machine execution.
16968
16969	There are three kinds of runtime errors:
16970	<ul>
16971	<li><i>fatal</i></li>
16972	<li><i>non-fatal with retry</i></li>
16973	<li><i>non-fatal warnings</i></li>
16974	</ul>
16975
16976	<b>Fatal</b> errors are indicated by the @a fatal parameter set
16977	to @c true. In case of fatal errors, the virtual machine
16978	execution is always paused before calling this notification, and
16979	the notification handler is supposed either to immediately save
16980	the virtual machine state using <link to="IConsole::saveState"/>
16981	or power it off using <link to="IConsole::powerDown"/>.
16982	Resuming the execution can lead to unpredictable results.
16983
16984	<b>Non-fatal</b> errors and warnings are indicated by the
16985	@a fatal parameter set to @c false. If the virtual machine
16986	is in the Paused state by the time the error notification is
16987	received, it means that the user can <i>try to resume</i> the machine
16988	execution after attempting to solve the problem that caused the
16989	error. In this case, the notification handler is supposed
16990	to show an appropriate message to the user (depending on the
16991	value of the @a id parameter) that offers several actions such
16992	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
16993	wants to retry, the notification handler should continue
16994	the machine execution using the <link to="IConsole::resume"/>
16995	call. If the machine execution is not Paused during this
16996	notification, then it means this notification is a <i>warning</i>
16997	(for example, about a fatal condition that can happen very soon);
16998	no immediate action is required from the user, the machine
16999	continues its normal execution.
17000
17001	Note that in either case the notification handler
17002	<b>must not</b> perform any action directly on a thread
17003	where this notification is called. Everything it is allowed to
17004	do is to post a message to another thread that will then talk
17005	to the user and take the corresponding action.
17006
17007	Currently, the following error identifiers are known:
17008	<ul>
17009	<li><tt>"HostMemoryLow"</tt></li>
17010	<li><tt>"HostAudioNotResponding"</tt></li>
17011	<li><tt>"VDIStorageFull"</tt></li>
17012	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17013	</ul>
17014	</desc>
17015	<attribute name="fatal" type="boolean" readonly="yes">
17016	<desc>
17017	Whether the error is fatal or not.
17018	</desc>
17019	</attribute>
17020	<attribute name="id" type="wstring" readonly="yes">
17021	<desc>
17022	Error identifier.
17023	</desc>
17024	</attribute>
17025	<attribute name="message" type="wstring" readonly="yes">
17026	<desc>
17027	Optional error message.
17028	</desc>
17029	</attribute>
17030	</interface>
17031
17032
17033	<interface
17034	name="IEventSourceChangedEvent" extends="IEvent"
17035	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17036	waitable="yes"
17037	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17038	>
17039	<desc>
17040	Notification when an event source state changes (listener added or removed).
17041	</desc>
17042
17043	<attribute name="listener" type="IEventListener" readonly="yes">
17044	<desc>
17045	Event listener which has changed.
17046	</desc>
17047	</attribute>
17048
17049	<attribute name="add" type="boolean" readonly="yes">
17050	<desc>
17051	Flag whether listener was added or removed.
17052	</desc>
17053	</attribute>
17054	</interface>
17055
17056	<interface
17057	name="IExtraDataChangedEvent" extends="IEvent"
17058	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17059	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17060	>
17061	<desc>
17062	Notification when machine specific or global extra data
17063	has changed.
17064	</desc>
17065	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17066	<desc>
17067	ID of the machine this event relates to.
17068	Null for global extra data changes.
17069	</desc>
17070	</attribute>
17071	<attribute name="key" type="wstring" readonly="yes">
17072	<desc>
17073	Extra data key that has changed.
17074	</desc>
17075	</attribute>
17076	<attribute name="value" type="wstring" readonly="yes">
17077	<desc>
17078	Extra data value for the given key.
17079	</desc>
17080	</attribute>
17081	</interface>
17082
17083	<interface
17084	name="IVetoEvent" extends="IEvent"
17085	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17086	wsmap="managed"
17087	>
17088	<desc>Base abstract interface for veto events.</desc>
17089
17090	<method name="addVeto">
17091	<desc>
17092	Adds a veto on this event.
17093	</desc>
17094	<param name="reason" type="wstring" dir="in">
17095	<desc>
17096	Reason for veto, could be null or empty string.
17097	</desc>
17098	</param>
17099	</method>
17100
17101	<method name="isVetoed">
17102	<desc>
17103	If this event was vetoed.
17104	</desc>
17105	<param name="result" type="boolean" dir="return">
17106	<desc>
17107	Reason for veto.
17108	</desc>
17109	</param>
17110	</method>
17111
17112	<method name="getVetos">
17113	<desc>
17114	Current veto reason list, if size is 0 - no veto.
17115	</desc>
17116	<param name="result" type="wstring" dir="return" safearray="yes">
17117	<desc>
17118	Array of reasons for veto provided by different event handlers.
17119	</desc>
17120	</param>
17121	</method>
17122
17123	</interface>
17124
17125	<interface
17126	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17127	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17128	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17129	waitable="true"
17130	>
17131	<desc>
17132	Notification when someone tries to change extra data for
17133	either the given machine or (if @c null) global extra data.
17134	This gives the chance to veto against changes.
17135	</desc>
17136	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17137	<desc>
17138	ID of the machine this event relates to.
17139	Null for global extra data changes.
17140	</desc>
17141	</attribute>
17142	<attribute name="key" type="wstring" readonly="yes">
17143	<desc>
17144	Extra data key that has changed.
17145	</desc>
17146	</attribute>
17147	<attribute name="value" type="wstring" readonly="yes">
17148	<desc>
17149	Extra data value for the given key.
17150	</desc>
17151	</attribute>
17152	</interface>
17153
17154	<interface
17155	name="ICanShowWindowEvent" extends="IVetoEvent"
17156	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
17157	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
17158	waitable="true"
17159	>
17160	<desc>
17161	Notification when a call to
17162	<link to="IMachine::canShowConsoleWindow"/> is made by a
17163	front-end to check if a subsequent call to
17164	<link to="IMachine::showConsoleWindow"/> can succeed.
17165
17166	The callee should give an answer appropriate to the current
17167	machine state using event veto. This answer must
17168	remain valid at least until the next
17169	<link to="IConsole::state">machine state</link> change.
17170	</desc>
17171	</interface>
17172
17173	<interface
17174	name="IShowWindowEvent" extends="IEvent"
17175	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
17176	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
17177	waitable="true"
17178	>
17179	<desc>
17180	Notification when a call to
17181	<link to="IMachine::showConsoleWindow"/>
17182	requests the console window to be activated and brought to
17183	foreground on the desktop of the host PC.
17184
17185	This notification should cause the VM console process to
17186	perform the requested action as described above. If it is
17187	impossible to do it at a time of this notification, this
17188	method should return a failure.
17189
17190	Note that many modern window managers on many platforms
17191	implement some sort of focus stealing prevention logic, so
17192	that it may be impossible to activate a window without the
17193	help of the currently active application (which is supposedly
17194	an initiator of this notification). In this case, this method
17195	must return a non-zero identifier that represents the
17196	top-level window of the VM console process. The caller, if it
17197	represents a currently active process, is responsible to use
17198	this identifier (in a platform-dependent manner) to perform
17199	actual window activation.
17200
17201	This method must set @a winId to zero if it has performed all
17202	actions necessary to complete the request and the console
17203	window is now active and in foreground, to indicate that no
17204	further action is required on the caller's side.
17205	</desc>
17206	<attribute name="winId" type="long long">
17207	<desc>
17208	Platform-dependent identifier of the top-level VM console
17209	window, or zero if this method has performed all actions
17210	necessary to implement the <i>show window</i> semantics for
17211	the given platform and/or this VirtualBox front-end.
17212	</desc>
17213	</attribute>
17214	</interface>
17215
17216	<interface
17217	name="INATRedirectEvent" extends="IMachineEvent"
17218	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
17219	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
17220	>
17221	<desc>
17222	Notification when NAT redirect rule added or removed.
17223	</desc>
17224	<attribute name="slot" type="unsigned long" readonly="yes">
17225	<desc>
17226	Adapter which NAT attached to.
17227	</desc>
17228	</attribute>
17229	<attribute name="remove" type="boolean" readonly="yes">
17230	<desc>
17231	Whether rule remove or add.
17232	</desc>
17233	</attribute>
17234	<attribute name="name" type="wstring" readonly="yes">
17235	<desc>
17236	Name of the rule.
17237	</desc>
17238	</attribute>
17239	<attribute name="proto" type="NATProtocol" readonly="yes">
17240	<desc>
17241	Protocol (TCP or UDP) of the redirect rule.
17242	</desc>
17243	</attribute>
17244	<attribute name="hostIp" type="wstring" readonly="yes">
17245	<desc>
17246	Host ip address to bind socket on.
17247	</desc>
17248	</attribute>
17249	<attribute name="hostPort" type="long" readonly="yes">
17250	<desc>
17251	Host port to bind socket on.
17252	</desc>
17253	</attribute>
17254	<attribute name="guestIp" type="wstring" readonly="yes">
17255	<desc>
17256	Guest ip address to redirect to.
17257	</desc>
17258	</attribute>
17259	<attribute name="guestPort" type="long" readonly="yes">
17260	<desc>
17261	Guest port to redirect to.
17262	</desc>
17263	</attribute>
17264	</interface>
17265
17266	<interface
17267	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
17268	waitable="yes"
17269	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
17270	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
17271	>
17272	<desc>
17273	Notification when host PCI device is plugged/unplugged. Plugging
17274	usually takes place on VM startup, unplug - when
17275	<link to="IMachine::detachHostPciDevice"/> is called.
17276
17277	<see><link to="IMachine::detachHostPciDevice"/></see>
17278
17279	</desc>
17280
17281	<attribute name="plugged" type="boolean" readonly="yes">
17282	<desc>
17283	If device successfully plugged or unplugged.
17284	</desc>
17285	</attribute>
17286
17287	<attribute name="success" type="boolean" readonly="yes">
17288	<desc>
17289	If operation was successful, if false - 'message' attribute
17290	may be of interest.
17291	</desc>
17292	</attribute>
17293
17294	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
17295	<desc>
17296	Attachment info for this device.
17297	</desc>
17298	</attribute>
17299
17300	<attribute name="message" type="wstring" readonly="yes">
17301	<desc>
17302	Optional error message.
17303	</desc>
17304	</attribute>
17305
17306	</interface>
17307
17308	<interface
17309	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
17310	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
17311	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
17312	>
17313	<desc>
17314	Notification when VBoxSVC becomes unavailable (due to a crash or similar
17315	unexpected circumstances) or available again.
17316	</desc>
17317
17318	<attribute name="available" type="boolean" readonly="yes">
17319	<desc>
17320	Whether VBoxSVC is available now.
17321	</desc>
17322	</attribute>
17323	</interface>
17324
17325	<interface
17326	name="IBandwidthGroupChangedEvent" extends="IEvent"
17327	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
17328	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
17329	>
17330	<desc>
17331	Notification when one of the bandwidth groups changed
17332	</desc>
17333	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
17334	<desc>
17335	The changed bandwidth group.
17336	</desc>
17337	</attribute>
17338	</interface>
17339
17340	<enum
17341	name="GuestMonitorChangedEventType"
17342	uuid="ef172985-7e36-4297-95be-e46396968d66"
17343	>
17344
17345	<desc>
17346	How the guest monitor has been changed.
17347	</desc>
17348
17349	<const name="Enabled" value="0">
17350	<desc>
17351	The guest monitor has been enabled by the guest.
17352	</desc>
17353	</const>
17354
17355	<const name="Disabled" value="1">
17356	<desc>
17357	The guest monitor has been disabled by the guest.
17358	</desc>
17359	</const>
17360
17361	<const name="NewOrigin" value="2">
17362	<desc>
17363	The guest monitor origin has changed in the guest.
17364	</desc>
17365	</const>
17366	</enum>
17367
17368	<interface
17369	name="IGuestMonitorChangedEvent" extends="IEvent"
17370	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
17371	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
17372	>
17373	<desc>
17374	Notification when the guest enables one of its monitors.
17375	</desc>
17376
17377	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
17378	<desc>
17379	What was changed for this guest monitor.
17380	</desc>
17381	</attribute>
17382
17383	<attribute name="screenId" type="unsigned long" readonly="yes">
17384	<desc>
17385	The monitor which was changed.
17386	</desc>
17387	</attribute>
17388
17389	<attribute name="originX" type="unsigned long" readonly="yes">
17390	<desc>
17391	Physical X origin relative to the primary screen.
17392	Valid for Enabled and NewOrigin.
17393	</desc>
17394	</attribute>
17395
17396	<attribute name="originY" type="unsigned long" readonly="yes">
17397	<desc>
17398	Physical Y origin relative to the primary screen.
17399	Valid for Enabled and NewOrigin.
17400	</desc>
17401	</attribute>
17402
17403	<attribute name="width" type="unsigned long" readonly="yes">
17404	<desc>
17405	Width of the screen.
17406	Valid for Enabled.
17407	</desc>
17408	</attribute>
17409
17410	<attribute name="height" type="unsigned long" readonly="yes">
17411	<desc>
17412	Height of the screen.
17413	Valid for Enabled.
17414	</desc>
17415	</attribute>
17416
17417	</interface>
17418
17419	<interface
17420	name="IStorageDeviceChangedEvent" extends="IEvent"
17421	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
17422	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
17423	>
17424	<desc>
17425	Notification when a
17426	<link to="IMachine::mediumAttachments">storage device</link>
17427	is attached or removed.
17428	</desc>
17429	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
17430	<desc>
17431	Storage device that is subject to change.
17432	</desc>
17433	</attribute>
17434	<attribute name="removed" type="boolean" readonly="yes">
17435	<desc>
17436	Flag whether the device was removed or added to the VM.
17437	</desc>
17438	</attribute>
17439	</interface>
17440
17441	<module name="VBoxSVC" context="LocalServer">
17442	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
17443	namespace="virtualbox.org">
17444	<interface name="IVirtualBox" default="yes"/>
17445	</class>
17446	</module>
17447
17448	<module name="VBoxC" context="InprocServer" threadingModel="Free">
17449	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
17450	namespace="virtualbox.org">
17451	<interface name="IVirtualBoxClient" default="yes"/>
17452	</class>
17453
17454	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
17455	namespace="virtualbox.org">
17456	<interface name="ISession" default="yes"/>
17457	</class>
17458	</module>
17459
17460	</library>
17461
17462	</idl>
17463
17464	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format