VirtualBox.xidl@ 34514

Last change on this file since 34514 was 34514, checked in by vboxsync, 14 years ago
Main: s/out/return
Property svn:eol-style set to `native`
File size: 583.7 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2010 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). Note that when pointers representing input
275	arguments (such as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
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="Future" value="99999">
484	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
485	</const>
486	</enum>
487
488	<enum
489	name="AccessMode"
490	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
491	>
492	<desc>
493	Access mode for opening files.
494	</desc>
495
496	<const name="ReadOnly" value="1"/>
497	<const name="ReadWrite" value="2"/>
498	</enum>
499
500	<enum
501	name="MachineState"
502	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
503	>
504	<desc>
505	Virtual machine execution state.
506
507	This enumeration represents possible values of the <link
508	to="IMachine::state"/> attribute.
509
510	Below is the basic virtual machine state diagram. It shows how the state
511	changes during virtual machine execution. The text in square braces shows
512	a method of the IConsole interface that performs the given state
513	transition.
514
515	<pre>
516	+---------[powerDown()] <- Stuck <--[failure]-+
517	V \|
518	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
519	\| \| \| \| V \|
520	\| Aborted -----+ +--> Running --[pause()]--> Paused
521	\| \| ^ \| ^ \|
522	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
523	\| ^ \| \| \| \|
524	\| \| +-----------------------------------------+-\|-------------------+ +
525	\| \| \| \| \|
526	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
527	\| \| \| \|
528	\| +-------- Saving <--------[saveState()]<----------+---------------------+
529	\| \| \|
530	+-------------- Stopping -------[powerDown()]<----------+---------------------+
531	</pre>
532
533	Note that states to the right from PoweredOff, Aborted and Saved in the
534	above diagram are called <i>online VM states</i>. These states
535	represent the virtual machine which is being executed in a dedicated
536	process (usually with a GUI window attached to it where you can see the
537	activity of the virtual machine and interact with it). There are two
538	special pseudo-states, FirstOnline and LastOnline, that can be used in
539	relational expressions to detect if the given machine state is online or
540	not:
541
542	<pre>
543	if (machine.GetState() >= MachineState_FirstOnline &&
544	machine.GetState() <= MachineState_LastOnline)
545	{
546	...the machine is being executed...
547	}
548	</pre>
549
550	When the virtual machine is in one of the online VM states (that is, being
551	executed), only a few machine settings can be modified. Methods working
552	with such settings contain an explicit note about that. An attempt to
553	change any oter setting or perform a modifying operation during this time
554	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
555
556	All online states except Running, Paused and Stuck are transitional: they
557	represent temporary conditions of the virtual machine that will last as
558	long as the operation that initiated such a condition.
559
560	The Stuck state is a special case. It means that execution of the machine
561	has reached the "Guru Meditation" condition. This condition indicates an
562	internal VMM (virtual machine manager) failure which may happen as a
563	result of either an unhandled low-level virtual hardware exception or one
564	of the recompiler exceptions (such as the <i>too-many-traps</i>
565	condition).
566
567	Note also that any online VM state may transit to the Aborted state. This
568	happens if the process that is executing the virtual machine terminates
569	unexpectedly (for example, crashes). Other than that, the Aborted state is
570	equivalent to PoweredOff.
571
572	There are also a few additional state diagrams that do not deal with
573	virtual machine execution and therefore are shown separately. The states
574	shown on these diagrams are called <i>offline VM states</i> (this includes
575	PoweredOff, Aborted and Saved too).
576
577	The first diagram shows what happens when a lengthy setup operation is
578	being executed (such as <link to="IMachine::attachDevice"/>).
579
580	<pre>
581	+----------------------------------(same state as before the call)------+
582	\| \|
583	+-> PoweredOff --+ \|
584	\| \| \|
585	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
586	\| \|
587	+-> Saved -------+
588	</pre>
589
590	The next two diagrams demonstrate the process of taking a snapshot of a
591	powered off virtual machine, restoring the state to that as of a snapshot
592	or deleting a snapshot, respectively.
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| +-->[takeSnapshot()] -------------------> Saving ------+
599	+-> Aborted -----+
600
601	+-> PoweredOff --+
602	\| \|
603	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
604	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
605	+-> Saved -------+ \|
606	\| \|
607	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
608	</pre>
609
610	Note that the Saving state is present in both the offline state group and
611	online state group. Currently, the only way to determine what group is
612	assumed in a particular case is to remember the previous machine state: if
613	it was Running or Paused, then Saving is an online state, otherwise it is
614	an offline state. This inconsistency may be removed in one of the future
615	versions of VirtualBox by adding a new state.
616
617	<note internal="yes">
618	For whoever decides to touch this enum: In order to keep the
619	comparisons involving FirstOnline and LastOnline pseudo-states valid,
620	the numeric values of these states must be correspondingly updated if
621	needed: for any online VM state, the condition
622	<tt>FirstOnline <= state <= LastOnline</tt> must be
623	@c true. The same relates to transient states for which
624	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
625	@c true.
626	</note>
627	</desc>
628
629	<const name="Null" value="0">
630	<desc>Null value (never used by the API).</desc>
631	</const>
632	<const name="PoweredOff" value="1">
633	<desc>
634	The machine is not running and has no saved execution state; it has
635	either never been started or been shut down successfully.
636	</desc>
637	</const>
638	<const name="Saved" value="2">
639	<desc>
640	The machine is not currently running, but the execution state of the machine
641	has been saved to an external file when it was running, from where
642	it can be resumed.
643	</desc>
644	</const>
645	<const name="Teleported" value="3">
646	<desc>
647	The machine was teleported to a different host (or process) and then
648	powered off. Take care when powering it on again may corrupt resources
649	it shares with the teleportation target (e.g. disk and network).
650	</desc>
651	</const>
652	<const name="Aborted" value="4">
653	<desc>
654	The process running the machine has terminated abnormally. This may
655	indicate a crash of the VM process in host execution context, or
656	the VM process has been terminated externally.
657	</desc>
658	</const>
659	<const name="Running" value="5">
660	<desc>
661	The machine is currently being executed.
662	<note internal="yes">
663	For whoever decides to touch this enum: In order to keep the
664	comparisons in the old source code valid, this state must immediately
665	precede the Paused state.
666	TODO: Lift this spectacularly wonderful restriction.
667	</note>
668	</desc>
669	</const>
670	<const name="Paused" value="6">
671	<desc>
672	Execution of the machine has been paused.
673	<note internal="yes">
674	For whoever decides to touch this enum: In order to keep the
675	comparisons in the old source code valid, this state must immediately
676	follow the Running state.
677	TODO: Lift this spectacularly wonderful restriction.
678	</note>
679	</desc>
680	</const>
681	<const name="Stuck" value="7">
682	<desc>
683	Execution of the machine has reached the "Guru Meditation"
684	condition. This indicates a severe error in the hypervisor itself.
685	<note internal="yes">
686	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
687	"Guru", perhaps? Or are there some other VMM states that are
688	intended to be lumped in here as well?
689	</note>
690	</desc>
691	</const>
692	<const name="Teleporting" value="8">
693	<desc>
694	The machine is about to be teleported to a different host or process.
695	It is possible to pause a machine in this state, but it will go to the
696	@c TeleportingPausedVM state and it will not be
697	possible to resume it again unless the teleportation fails.
698	</desc>
699	</const>
700	<const name="LiveSnapshotting" value="9">
701	<desc>
702	A live snapshot is being taken. The machine is running normally, but
703	some of the runtime configuration options are inaccessible. Also, if
704	paused while in this state it will transition to
705	@c Saving and it will not be resume the
706	execution until the snapshot operation has completed.
707	</desc>
708	</const>
709	<const name="Starting" value="10">
710	<desc>
711	Machine is being started after powering it on from a
712	zero execution state.
713	</desc>
714	</const>
715	<const name="Stopping" value="11">
716	<desc>
717	Machine is being normally stopped powering it off, or after the guest OS
718	has initiated a shutdown sequence.
719	</desc>
720	</const>
721	<const name="Saving" value="12">
722	<desc>
723	Machine is saving its execution state to a file, or an online
724	snapshot of the machine is being taken.
725	</desc>
726	</const>
727	<const name="Restoring" value="13">
728	<desc>
729	Execution state of the machine is being restored from a file
730	after powering it on from the saved execution state.
731	</desc>
732	</const>
733	<const name="TeleportingPausedVM" value="14">
734	<desc>
735	The machine is being teleported to another host or process, but it is
736	not running. This is the paused variant of the
737	@c state.
738	</desc>
739	</const>
740	<const name="TeleportingIn" value="15">
741	<desc>
742	Teleporting the machine state in from another host or process.
743	</desc>
744	</const>
745	<const name="FaultTolerantSyncing" value="16">
746	<desc>
747	The machine is being synced with a fault tolerant VM running elsewhere.
748	</desc>
749	</const>
750	<const name="DeletingSnapshotOnline" value="17">
751	<desc>
752	Like @c DeletingSnapshot, but the merging of media is ongoing in
753	the background while the machine is running.
754	</desc>
755	</const>
756	<const name="DeletingSnapshotPaused" value="18">
757	<desc>
758	Like @c DeletingSnapshotOnline, but the machine was paused when the
759	merging of differencing media was started.
760	</desc>
761	</const>
762	<const name="RestoringSnapshot" value="19">
763	<desc>
764	A machine snapshot is being restored; this typically does not take long.
765	</desc>
766	</const>
767	<const name="DeletingSnapshot" value="20">
768	<desc>
769	A machine snapshot is being deleted; this can take a long time since this
770	may require merging differencing media. This value indicates that the
771	machine is not running while the snapshot is being deleted.
772	</desc>
773	</const>
774	<const name="SettingUp" value="21">
775	<desc>
776	Lengthy setup operation is in progress.
777	</desc>
778	</const>
779
780	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
781	<desc>
782	Pseudo-state: first online state (for use in relational expressions).
783	</desc>
784	</const>
785	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
786	<desc>
787	Pseudo-state: last online state (for use in relational expressions).
788	</desc>
789	</const>
790
791	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
792	<desc>
793	Pseudo-state: first transient state (for use in relational expressions).
794	</desc>
795	</const>
796	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
797	<desc>
798	Pseudo-state: last transient state (for use in relational expressions).
799	</desc>
800	</const>
801
802	</enum>
803
804	<enum
805	name="SessionState"
806	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
807	>
808	<desc>
809	Session state. This enumeration represents possible values of
810	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
811	attributes.
812	</desc>
813
814	<const name="Null" value="0">
815	<desc>Null value (never used by the API).</desc>
816	</const>
817	<const name="Unlocked" value="1">
818	<desc>
819	In <link to="IMachine::sessionState"/>, this means that the machine
820	is not locked for any sessions.
821
822	In <link to="ISession::state"/>, this means that no machine is
823	currently locked for this session.
824	</desc>
825	</const>
826	<const name="Locked" value="2">
827	<desc>
828	In <link to="IMachine::sessionState"/>, this means that the machine
829	is currently locked for a session, whose process identifier can
830	then be found in the <link to="IMachine::sessionPid" /> attribute.
831
832	In <link to="ISession::state"/>, this means that a machine is
833	currently locked for this session, and the mutable machine object
834	can be found in the <link to="ISession::machine"/> attribute
835	(see <link to="IMachine::lockMachine" /> for details).
836	</desc>
837	</const>
838	<const name="Spawning" value="3">
839	<desc>
840	A new process is being spawned for the machine as a result of
841	<link to="IMachine::launchVMProcess"/> call. This state also occurs
842	as a short transient state during an <link to="IMachine::lockMachine"/>
843	call.
844	</desc>
845	</const>
846	<const name="Unlocking" value="4">
847	<desc>
848	The session is being unlocked.
849	</desc>
850	</const>
851	</enum>
852
853	<enum
854	name="CPUPropertyType"
855	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
856	>
857	<desc>
858	Virtual CPU property type. This enumeration represents possible values of the
859	IMachine get- and setCPUProperty methods.
860	</desc>
861	<const name="Null" value="0">
862	<desc>Null value (never used by the API).</desc>
863	</const>
864	<const name="PAE" value="1">
865	<desc>
866	This setting determines whether VirtualBox will expose the Physical Address
867	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
868	is not available, it will not be reported.
869	</desc>
870	</const>
871	<const name="Synthetic" value="2">
872	<desc>
873	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
874	teleporting between host systems that differ significantly.
875	</desc>
876	</const>
877	</enum>
878
879
880	<enum
881	name="HWVirtExPropertyType"
882	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
883	>
884	<desc>
885	Hardware virtualization property type. This enumeration represents possible values
886	for the <link to="IMachine::getHWVirtExProperty"/> and
887	<link to="IMachine::setHWVirtExProperty"/> methods.
888	</desc>
889	<const name="Null" value="0">
890	<desc>Null value (never used by the API).</desc>
891	</const>
892	<const name="Enabled" value="1">
893	<desc>
894	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
895	such extensions are not available, they will not be used.
896	</desc>
897	</const>
898	<const name="Exclusive" value="2">
899	<desc>
900	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
901	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
902	feature of the host. To share these with other hypervisors, you must disable this property.
903	</desc>
904	</const>
905	<const name="VPID" value="3">
906	<desc>
907	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
908	</desc>
909	</const>
910	<const name="NestedPaging" value="4">
911	<desc>
912	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
913	</desc>
914	</const>
915	<const name="LargePages" value="5">
916	<desc>
917	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
918	</desc>
919	</const>
920	<const name="Force" value="6">
921	<desc>
922	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
923	not set, there will be an automatic fallback to software virtualization.
924	</desc>
925	</const>
926	</enum>
927
928	<enum
929	name="FaultToleranceState"
930	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
931	>
932	<desc>
933	Used with <link to="IMachine::faultToleranceState" />.
934	</desc>
935	<const name="Inactive" value="1">
936	<desc>No fault tolerance enabled.</desc>
937	</const>
938	<const name="Master" value="2">
939	<desc>Fault tolerant master VM.</desc>
940	</const>
941	<const name="Standby" value="3">
942	<desc>Fault tolerant standby VM.</desc>
943	</const>
944	</enum>
945
946	<enum
947	name="LockType"
948	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
949	>
950	<desc>
951	Used with <link to="IMachine::lockMachine" />.
952	</desc>
953	<const name="Write" value="2">
954	<desc>Lock the machine for writing.</desc>
955	</const>
956	<const name="Shared" value="1">
957	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
958	</const>
959	</enum>
960
961	<enum
962	name="SessionType"
963	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
964	>
965	<desc>
966	Session type. This enumeration represents possible values of the
967	<link to="ISession::type"/> attribute.
968	</desc>
969
970	<const name="Null" value="0">
971	<desc>Null value (never used by the API).</desc>
972	</const>
973	<const name="WriteLock" value="1">
974	<desc>
975	Session has acquired an exclusive write lock on a machine
976	using <link to="IMachine::lockMachine"/>.
977	</desc>
978	</const>
979	<const name="Remote" value="2">
980	<desc>
981	Session has launched a VM process using
982	<link to="IMachine::launchVMProcess"/>
983	</desc>
984	</const>
985	<const name="Shared" value="3">
986	<desc>
987	Session has obtained a link to another session using
988	<link to="IMachine::lockMachine"/>
989	</desc>
990	</const>
991	</enum>
992
993	<enum
994	name="DeviceType"
995	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
996	>
997	<desc>
998	Device type.
999	</desc>
1000	<const name="Null" value="0">
1001	<desc>
1002	Null value, may also mean "no device" (not allowed for
1003	<link to="IConsole::getDeviceActivity"/>).
1004	</desc>
1005	</const>
1006	<const name="Floppy" value="1">
1007	<desc>Floppy device.</desc>
1008	</const>
1009	<const name="DVD" value="2">
1010	<desc>CD/DVD-ROM device.</desc>
1011	</const>
1012	<const name="HardDisk" value="3">
1013	<desc>Hard disk device.</desc>
1014	</const>
1015	<const name="Network" value="4">
1016	<desc>Network device.</desc>
1017	</const>
1018	<const name="USB" value="5">
1019	<desc>USB device.</desc>
1020	</const>
1021	<const name="SharedFolder" value="6">
1022	<desc>Shared folder device.</desc>
1023	</const>
1024	</enum>
1025
1026	<enum
1027	name="DeviceActivity"
1028	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1029	>
1030	<desc>
1031	Device activity for <link to="IConsole::getDeviceActivity"/>.
1032	</desc>
1033
1034	<const name="Null" value="0"/>
1035	<const name="Idle" value="1"/>
1036	<const name="Reading" value="2"/>
1037	<const name="Writing" value="3"/>
1038	</enum>
1039
1040	<enum
1041	name="ClipboardMode"
1042	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1043	>
1044	<desc>
1045	Host-Guest clipboard interchange mode.
1046	</desc>
1047
1048	<const name="Disabled" value="0"/>
1049	<const name="HostToGuest" value="1"/>
1050	<const name="GuestToHost" value="2"/>
1051	<const name="Bidirectional" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="Scope"
1056	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1057	>
1058	<desc>
1059	Scope of the operation.
1060
1061	A generic enumeration used in various methods to define the action or
1062	argument scope.
1063	</desc>
1064
1065	<const name="Global" value="0"/>
1066	<const name="Machine" value="1"/>
1067	<const name="Session" value="2"/>
1068	</enum>
1069
1070	<enum
1071	name="BIOSBootMenuMode"
1072	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1073	>
1074	<desc>
1075	BIOS boot menu mode.
1076	</desc>
1077
1078	<const name="Disabled" value="0"/>
1079	<const name="MenuOnly" value="1"/>
1080	<const name="MessageAndMenu" value="2"/>
1081	</enum>
1082
1083	<enum
1084	name="ProcessorFeature"
1085	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1086	>
1087	<desc>
1088	CPU features.
1089	</desc>
1090
1091	<const name="HWVirtEx" value="0"/>
1092	<const name="PAE" value="1"/>
1093	<const name="LongMode" value="2"/>
1094	<const name="NestedPaging" value="3"/>
1095	</enum>
1096
1097	<enum
1098	name="FirmwareType"
1099	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1100	>
1101	<desc>
1102	Firmware type.
1103	</desc>
1104	<const name="BIOS" value="1">
1105	<desc>BIOS Firmware.</desc>
1106	</const>
1107	<const name="EFI" value="2">
1108	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1109	</const>
1110	<const name="EFI32" value="3">
1111	<desc>Efi firmware, 32-bit.</desc>
1112	</const>
1113	<const name="EFI64" value="4">
1114	<desc>Efi firmware, 64-bit.</desc>
1115	</const>
1116	<const name="EFIDUAL" value="5">
1117	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1118	</const>
1119	</enum>
1120
1121	<enum
1122	name="PointingHidType"
1123	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1124	>
1125	<desc>
1126	Type of pointing device used in a virtual machine.
1127	</desc>
1128	<const name="None" value="1">
1129	<desc>No mouse.</desc>
1130	</const>
1131	<const name="PS2Mouse" value="2">
1132	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1133	</const>
1134	<const name="USBMouse" value="3">
1135	<desc>USB mouse (relative pointer).</desc>
1136	</const>
1137	<const name="USBTablet" value="4">
1138	<desc>USB tablet (absolute pointer).</desc>
1139	</const>
1140	<const name="ComboMouse" value="5">
1141	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1142	Using of such device can have negative performance implications. </desc>
1143	</const>
1144	</enum>
1145
1146	<enum
1147	name="KeyboardHidType"
1148	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1149	>
1150	<desc>
1151	Type of keyboard device used in a virtual machine.
1152	</desc>
1153	<const name="None" value="1">
1154	<desc>No keyboard.</desc>
1155	</const>
1156	<const name="PS2Keyboard" value="2">
1157	<desc>PS/2 keyboard.</desc>
1158	</const>
1159	<const name="USBKeyboard" value="3">
1160	<desc>USB keyboard.</desc>
1161	</const>
1162	<const name="ComboKeyboard" value="4">
1163	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1164	Using of such device can have negative performance implications. </desc>
1165	</const>
1166	</enum>
1167
1168	<!--
1169	// IVirtualBoxErrorInfo
1170	/////////////////////////////////////////////////////////////////////////
1171	-->
1172
1173	<interface
1174	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1175	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1176	supportsErrorInfo="no"
1177	wsmap="managed"
1178	>
1179	<desc>
1180	The IVirtualBoxErrorInfo interface represents extended error information.
1181
1182	Extended error information can be set by VirtualBox components after
1183	unsuccessful or partially successful method invocation. This information
1184	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1185	and then shown to the client in addition to the plain 32-bit result code.
1186
1187	In MS COM, this interface extends the IErrorInfo interface,
1188	in XPCOM, it extends the nsIException interface. In both cases,
1189	it provides a set of common attributes to retrieve error
1190	information.
1191
1192	Sometimes invocation of some component's method may involve methods of
1193	other components that may also fail (independently of this method's
1194	failure), or a series of non-fatal errors may precede a fatal error that
1195	causes method failure. In cases like that, it may be desirable to preserve
1196	information about all errors happened during method invocation and deliver
1197	it to the caller. The <link to="#next"/> attribute is intended
1198	specifically for this purpose and allows to represent a chain of errors
1199	through a single IVirtualBoxErrorInfo object set after method invocation.
1200
1201	Note that errors are stored to a chain in the reverse order, i.e. the
1202	initial error object you query right after method invocation is the last
1203	error set by the callee, the object it points to in the @a next attribute
1204	is the previous error and so on, up to the first error (which is the last
1205	in the chain).
1206	</desc>
1207
1208	<attribute name="resultCode" type="long" readonly="yes">
1209	<desc>
1210	Result code of the error.
1211	Usually, it will be the same as the result code returned
1212	by the method that provided this error information, but not
1213	always. For example, on Win32, CoCreateInstance() will most
1214	likely return E_NOINTERFACE upon unsuccessful component
1215	instantiation attempt, but not the value the component factory
1216	returned. Value is typed 'long', not 'result',
1217	to make interface usable from scripting languages.
1218	<note>
1219	In MS COM, there is no equivalent.
1220	In XPCOM, it is the same as nsIException::result.
1221	</note>
1222	</desc>
1223	</attribute>
1224
1225	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1226	<desc>
1227	UUID of the interface that defined the error.
1228	<note>
1229	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1230	data type.
1231	In XPCOM, there is no equivalent.
1232	</note>
1233	</desc>
1234	</attribute>
1235
1236	<attribute name="component" type="wstring" readonly="yes">
1237	<desc>
1238	Name of the component that generated the error.
1239	<note>
1240	In MS COM, it is the same as IErrorInfo::GetSource.
1241	In XPCOM, there is no equivalent.
1242	</note>
1243	</desc>
1244	</attribute>
1245
1246	<attribute name="text" type="wstring" readonly="yes">
1247	<desc>
1248	Text description of the error.
1249	<note>
1250	In MS COM, it is the same as IErrorInfo::GetDescription.
1251	In XPCOM, it is the same as nsIException::message.
1252	</note>
1253	</desc>
1254	</attribute>
1255
1256	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1257	<desc>
1258	Next error object if there is any, or @c null otherwise.
1259	<note>
1260	In MS COM, there is no equivalent.
1261	In XPCOM, it is the same as nsIException::inner.
1262	</note>
1263	</desc>
1264	</attribute>
1265
1266	</interface>
1267
1268	<!--
1269	// IVirtualBox
1270	/////////////////////////////////////////////////////////////////////////
1271	-->
1272
1273	<interface
1274	name="IDHCPServer" extends="$unknown"
1275	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1276	wsmap="managed"
1277	>
1278	<desc>
1279	The IDHCPServer interface represents the vbox dhcp server configuration.
1280
1281	To enumerate all the dhcp servers on the host, use the
1282	<link to="IVirtualBox::DHCPServers"/> attribute.
1283	</desc>
1284
1285	<attribute name="enabled" type="boolean">
1286	<desc>
1287	specifies if the dhcp server is enabled
1288	</desc>
1289	</attribute>
1290
1291	<attribute name="IPAddress" type="wstring" readonly="yes">
1292	<desc>
1293	specifies server IP
1294	</desc>
1295	</attribute>
1296
1297	<attribute name="networkMask" type="wstring" readonly="yes">
1298	<desc>
1299	specifies server network mask
1300	</desc>
1301	</attribute>
1302
1303	<attribute name="networkName" type="wstring" readonly="yes">
1304	<desc>
1305	specifies internal network name the server is used for
1306	</desc>
1307	</attribute>
1308
1309	<attribute name="lowerIP" type="wstring" readonly="yes">
1310	<desc>
1311	specifies from IP address in server address range
1312	</desc>
1313	</attribute>
1314
1315	<attribute name="upperIP" type="wstring" readonly="yes">
1316	<desc>
1317	specifies to IP address in server address range
1318	</desc>
1319	</attribute>
1320
1321	<method name="setConfiguration">
1322	<desc>
1323	configures the server
1324	<result name="E_INVALIDARG">
1325	invalid configuration supplied
1326	</result>
1327	</desc>
1328	<param name="IPAddress" type="wstring" dir="in">
1329	<desc>
1330	server IP address
1331	</desc>
1332	</param>
1333	<param name="networkMask" type="wstring" dir="in">
1334	<desc>
1335	server network mask
1336	</desc>
1337	</param>
1338	<param name="FromIPAddress" type="wstring" dir="in">
1339	<desc>
1340	server From IP address for address range
1341	</desc>
1342	</param>
1343	<param name="ToIPAddress" type="wstring" dir="in">
1344	<desc>
1345	server To IP address for address range
1346	</desc>
1347	</param>
1348	</method>
1349
1350	<method name="start">
1351	<desc>
1352	Starts DHCP server process.
1353	<result name="E_FAIL">
1354	Failed to start the process.
1355	</result>
1356	</desc>
1357	<param name="networkName" type="wstring" dir="in">
1358	<desc>
1359	Name of internal network DHCP server should attach to.
1360	</desc>
1361	</param>
1362	<param name="trunkName" type="wstring" dir="in">
1363	<desc>
1364	Name of internal network trunk.
1365	</desc>
1366	</param>
1367	<param name="trunkType" type="wstring" dir="in">
1368	<desc>
1369	Type of internal network trunk.
1370	</desc>
1371	</param>
1372	</method>
1373
1374	<method name="stop">
1375	<desc>
1376	Stops DHCP server process.
1377	<result name="E_FAIL">
1378	Failed to stop the process.
1379	</result>
1380	</desc>
1381	</method>
1382	</interface>
1383
1384	<interface
1385	name="IVirtualBox" extends="$unknown"
1386	uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff"
1387	wsmap="managed"
1388	>
1389	<desc>
1390	The IVirtualBox interface represents the main interface exposed by the
1391	product that provides virtual machine management.
1392
1393	An instance of IVirtualBox is required for the product to do anything
1394	useful. Even though the interface does not expose this, internally,
1395	IVirtualBox is implemented as a singleton and actually lives in the
1396	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1397	IVirtualBox can track the state of all virtual machines on a particular
1398	host, regardless of which frontend started them.
1399
1400	To enumerate all the virtual machines on the host, use the
1401	<link to="IVirtualBox::machines"/> attribute.
1402	</desc>
1403
1404	<attribute name="version" type="wstring" readonly="yes">
1405	<desc>
1406	A string representing the version number of the product. The
1407	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1408	last number represents the build number and will frequently change.
1409	</desc>
1410	</attribute>
1411
1412	<attribute name="revision" type="unsigned long" readonly="yes">
1413	<desc>
1414	The internal build revision number of the product.
1415	</desc>
1416	</attribute>
1417
1418	<attribute name="packageType" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the package type of this product. The
1421	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1422	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1423	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1424	this.
1425	</desc>
1426	</attribute>
1427
1428	<attribute name="homeFolder" type="wstring" readonly="yes">
1429	<desc>
1430	Full path to the directory where the global settings file,
1431	<tt>VirtualBox.xml</tt>, is stored.
1432
1433	In this version of VirtualBox, the value of this property is
1434	always <tt><user_dir>/.VirtualBox</tt> (where
1435	<tt><user_dir></tt> is the path to the user directory,
1436	as determined by the host OS), and cannot be changed.
1437
1438	This path is also used as the base to resolve relative paths in
1439	places where relative paths are allowed (unless otherwise
1440	expressly indicated).
1441	</desc>
1442	</attribute>
1443
1444	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1445	<desc>
1446	Full name of the global settings file.
1447	The value of this property corresponds to the value of
1448	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1449	</desc>
1450	</attribute>
1451
1452	<attribute name="host" type="IHost" readonly="yes">
1453	<desc>Associated host object.</desc>
1454	</attribute>
1455
1456	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1457	<desc>Associated system information object.</desc>
1458	</attribute>
1459
1460	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1461	<desc>
1462	Array of machine objects registered within this VirtualBox instance.
1463	</desc>
1464	</attribute>
1465
1466	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1467	<desc>
1468	Array of medium objects known to this VirtualBox installation.
1469
1470	This array contains only base media. All differencing
1471	media of the given base medium can be enumerated using
1472	<link to="IMedium::children"/>.
1473	</desc>
1474	</attribute>
1475
1476	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1477	<desc>
1478	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1479	</desc>
1480	</attribute>
1481
1482	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1483	<desc>
1484	Array of floppy image objects currently in use by this VirtualBox instance.
1485	</desc>
1486	</attribute>
1487
1488	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1489
1490	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1491
1492	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1493	<desc>
1494	Collection of global shared folders. Global shared folders are
1495	available to all virtual machines.
1496
1497	New shared folders are added to the collection using
1498	<link to="#createSharedFolder"/>. Existing shared folders can be
1499	removed using <link to="#removeSharedFolder"/>.
1500
1501	<note>
1502	In the current version of the product, global shared folders are not
1503	implemented and therefore this collection is always empty.
1504	</note>
1505	</desc>
1506	</attribute>
1507
1508	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1509	<desc>
1510	Associated performance collector object.
1511	</desc>
1512	</attribute>
1513
1514	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1515	<desc>
1516	DHCP servers.
1517	</desc>
1518	</attribute>
1519
1520	<attribute name="eventSource" type="IEventSource" readonly="yes">
1521	<desc>
1522	Event source for VirtualBox events.
1523	</desc>
1524	</attribute>
1525
1526	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1527	<desc>
1528	The extension pack manager.
1529	</desc>
1530	</attribute>
1531
1532
1533	<method name="composeMachineFilename">
1534	<desc>
1535	Returns a recommended full path of the settings file name for a new virtual
1536	machine.
1537
1538	This API serves two purposes:
1539
1540	<ul>
1541	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1542	for the @a settingsFile argument there, which means that API should use
1543	a recommended default file name.</li>
1544
1545	<li>It can be called manually by a client software before creating a machine,
1546	e.g. if that client wants to pre-create the machine directory to create
1547	virtual hard disks in that directory together with the new machine
1548	settings file. In that case, the file name should be stripped from the
1549	full settings file path returned by this function to obtain the
1550	machine directory.</li>
1551	</ul>
1552
1553	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1554	details about the machine name.
1555
1556	If @a baseFolder is a @c null or empty string (which is recommended), the
1557	default machine settings folder
1558	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1559	a base folder for the created machine, resulting in a file name like
1560	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1561	will be used.
1562
1563	This method does not access the host disks. In particular, it does not check
1564	for whether a machine of this name already exists.
1565	</desc>
1566	<param name="name" type="wstring" dir="in">
1567	<desc>Suggested machine name.</desc>
1568	</param>
1569	<param name="baseFolder" type="wstring" dir="in">
1570	<desc>Base machine folder (optional).</desc>
1571	</param>
1572	<param name="file" type="wstring" dir="return">
1573	<desc>Fully qualified path where the machine would be created.</desc>
1574	</param>
1575	</method>
1576
1577	<method name="createMachine">
1578	<desc>
1579	Creates a new virtual machine by creating a machine settings file at
1580	the given location.
1581
1582	VirtualBox machine settings files use a custom XML dialect. Starting
1583	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1584	and machine files can be created at arbitrary locations.
1585
1586	However, it is is recommended that machines be created in the default
1587	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1588	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1589	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1590	is called automatically to have such a recommended name composed based
1591	on the machine name given in the @a name argument.
1592
1593	If the resulting settings file already exists, this method will fail,
1594	unless @a forceOverwrite is set.
1595
1596	The new machine is created unregistered, with the initial configuration
1597	set according to the specified guest OS type. A typical sequence of
1598	actions to create a new virtual machine is as follows:
1599
1600	<ol>
1601	<li>
1602	Call this method to have a new machine created. The returned machine
1603	object will be "mutable" allowing to change any machine property.
1604	</li>
1605
1606	<li>
1607	Configure the machine using the appropriate attributes and methods.
1608	</li>
1609
1610	<li>
1611	Call <link to="IMachine::saveSettings" /> to write the settings
1612	to the machine's XML settings file. The configuration of the newly
1613	created machine will not be saved to disk until this method is
1614	called.
1615	</li>
1616
1617	<li>
1618	Call <link to="#registerMachine" /> to add the machine to the list
1619	of machines known to VirtualBox.
1620	</li>
1621	</ol>
1622
1623	The specified guest OS type identifier must match an ID of one of known
1624	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1625	array.
1626
1627	Optionally, you may specify an UUID of to assign to the created machine.
1628	However, this is not recommended and you should normally pass an empty
1629	(@c null) UUID to this method so that a new UUID will be automatically
1630	generated for every created machine. You can use UUID
1631	00000000-0000-0000-0000-000000000000 as @c null value.
1632
1633	<note>
1634	There is no way to change the name of the settings file or
1635	subfolder of the created machine directly.
1636	</note>
1637
1638	<result name="VBOX_E_OBJECT_NOT_FOUND">
1639	@a osTypeId is invalid.
1640	</result>
1641	<result name="VBOX_E_FILE_ERROR">
1642	Resulting settings file name is invalid or the settings file already
1643	exists or could not be created due to an I/O error.
1644	</result>
1645	<result name="E_INVALIDARG">
1646	@a name is empty or @c null.
1647	</result>
1648	</desc>
1649
1650	<param name="settingsFile" type="wstring" dir="in">
1651	<desc>Fully qualified path where the settings file should be created,
1652	or NULL for a default folder and file based on the @a name argument
1653	(see <link to="#composeMachineFilename" />).</desc>
1654	</param>
1655	<param name="name" type="wstring" dir="in">
1656	<desc>Machine name.</desc>
1657	</param>
1658	<param name="osTypeId" type="wstring" dir="in">
1659	<desc>Guest OS Type ID.</desc>
1660	</param>
1661	<param name="id" type="uuid" mod="string" dir="in">
1662	<desc>Machine UUID (optional).</desc>
1663	</param>
1664	<param name="forceOverwrite" type="boolean" dir="in">
1665	<desc>If true, an existing machine settings file will be overwritten.</desc>
1666	</param>
1667	<param name="machine" type="IMachine" dir="return">
1668	<desc>Created machine object.</desc>
1669	</param>
1670	</method>
1671
1672	<method name="openMachine">
1673	<desc>
1674	Opens a virtual machine from the existing settings file.
1675	The opened machine remains unregistered until you call
1676	<link to="#registerMachine"/>.
1677
1678	The specified settings file name must be fully qualified.
1679	The file must exist and be a valid machine XML settings file
1680	whose contents will be used to construct the machine object.
1681
1682	<result name="VBOX_E_FILE_ERROR">
1683	Settings file name invalid, not found or sharing violation.
1684	</result>
1685	</desc>
1686	<param name="settingsFile" type="wstring" dir="in">
1687	<desc>
1688	Name of the machine settings file.
1689	</desc>
1690	</param>
1691	<param name="machine" type="IMachine" dir="return">
1692	<desc>Opened machine object.</desc>
1693	</param>
1694	<note>
1695	<link to="IMachine::settingsModified"/> will return
1696	@c false for the created machine, until any of machine settings
1697	are changed.
1698	</note>
1699	</method>
1700
1701	<method name="registerMachine">
1702	<desc>
1703
1704	Registers the machine previously created using
1705	<link to="#createMachine"/> or opened using
1706	<link to="#openMachine"/> within this VirtualBox installation. After
1707	successful method invocation, the
1708	<link to="IMachineRegisteredEvent"/> event is fired.
1709
1710	<note>
1711	This method implicitly calls <link to="IMachine::saveSettings"/>
1712	to save all current machine settings before registering it.
1713	</note>
1714
1715	<result name="VBOX_E_OBJECT_NOT_FOUND">
1716	No matching virtual machine found.
1717	</result>
1718	<result name="VBOX_E_INVALID_OBJECT_STATE">
1719	Virtual machine was not created within this VirtualBox instance.
1720	</result>
1721
1722	</desc>
1723	<param name="machine" type="IMachine" dir="in"/>
1724	</method>
1725
1726	<method name="findMachine">
1727	<desc>
1728	Attempts to find a virtual machine given its name or UUID.
1729
1730	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1731	cannot safely be determined.</note>
1732
1733	<result name="VBOX_E_OBJECT_NOT_FOUND">
1734	Could not find registered machine matching @a nameOrId.
1735	</result>
1736
1737	</desc>
1738	<param name="nameOrId" type="wstring" dir="in">
1739	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1740	</param>
1741	<param name="machine" type="IMachine" dir="return">
1742	<desc>Machine object, if found.</desc>
1743	</param>
1744	</method>
1745
1746	<method name="createAppliance">
1747	<desc>
1748	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1749	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1750	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1751	</desc>
1752	<param name="appliance" type="IAppliance" dir="return">
1753	<desc>New appliance.</desc>
1754	</param>
1755	</method>
1756
1757	<method name="createHardDisk">
1758	<desc>
1759	Creates a new base medium object that will use the given storage
1760	format and location for medium data.
1761
1762	Note that the actual storage unit is not created by this method. In
1763	order to do it, and before you are able to attach the created medium
1764	to virtual machines, you must call one of the following methods to
1765	allocate a format-specific storage unit at the specified location:
1766	<ul>
1767	<li><link to="IMedium::createBaseStorage"/></li>
1768	<li><link to="IMedium::createDiffStorage"/></li>
1769	</ul>
1770
1771	Some medium attributes, such as <link to="IMedium::id"/>, may
1772	remain uninitialized until the medium storage unit is successfully
1773	created by one of the above methods.
1774
1775	After the storage unit is successfully created, it will be
1776	accessible through the <link to="#findMedium"/> method and can
1777	be found in the <link to="#hardDisks"/> array.
1778
1779	The list of all storage formats supported by this VirtualBox
1780	installation can be obtained using
1781	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1782	attribute is empty or @c null then the default storage format
1783	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1784	be used for creating a storage unit of the medium.
1785
1786	Note that the format of the location string is storage format specific.
1787	See <link to="IMedium::location"/> and IMedium for more details.
1788
1789	<result name="VBOX_E_OBJECT_NOT_FOUND">
1790	@a format identifier is invalid. See
1791	<link to="ISystemProperties::mediumFormats"/>.
1792	</result>
1793	<result name="VBOX_E_FILE_ERROR">
1794	@a location is a not valid file name (for file-based formats only).
1795	</result>
1796	</desc>
1797	<param name="format" type="wstring" dir="in">
1798	<desc>
1799	Identifier of the storage format to use for the new medium.
1800	</desc>
1801	</param>
1802	<param name="location" type="wstring" dir="in">
1803	<desc>
1804	Location of the storage unit for the new medium.
1805	</desc>
1806	</param>
1807	<param name="medium" type="IMedium" dir="return">
1808	<desc>Created medium object.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="openMedium">
1813	<desc>
1814	Opens a medium from an existing storage location.
1815
1816	Once a medium has been opened, it can be passed to other VirtualBox
1817	methods, in particular to <link to="IMachine::attachDevice" />.
1818
1819	Depending on the given device type, the file at the storage location
1820	must be in one of the media formats understood by VirtualBox:
1821
1822	<ul>
1823	<li>With a "HardDisk" device type, the file must be a hard disk image
1824	in one of the formats supported by VirtualBox (see
1825	<link to="ISystemProperties::mediumFormats" />).
1826	After this method succeeds, if the medium is a base medium, it
1827	will be added to the <link to="#hardDisks"/> array attribute. </li>
1828	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1829	After this method succeeds, the medium will be added to the
1830	<link to="#DVDImages"/> array attribute.</li>
1831	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1832	After this method succeeds, the medium will be added to the
1833	<link to="#floppyImages"/> array attribute.</li>
1834	</ul>
1835
1836	After having been opened, the medium can be found by the <link to="#findMedium"/>
1837	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1838
1839	The UUID of the newly opened medium will either be retrieved from the
1840	storage location, if the format supports it (e.g. for hard disk images),
1841	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1842	If for some reason you need to change the medium's UUID, use
1843	<link to="IMedium::setIDs" />.
1844
1845	If a differencing hard disk medium is to be opened by this method, the
1846	operation will succeed only if its parent medium and all ancestors,
1847	if any, are already known to this VirtualBox installation (for example,
1848	were opened by this method before).
1849
1850	This method attempts to guess the storage format of the specified medium
1851	by reading medium data at the specified location.
1852
1853	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1854	the image is opened for read/write access and must have according permissions,
1855	as VirtualBox may actually write status information into the disk's metadata
1856	sections.
1857
1858	Note that write access is required for all typical hard disk usage in VirtualBox,
1859	since VirtualBox may need to write metadata such as a UUID into the image.
1860	The only exception is opening a source image temporarily for copying and
1861	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1862	again soon.
1863
1864	The format of the location string is storage format specific. See
1865	<link to="IMedium::location"/> and IMedium for more details.
1866
1867	Prior to VirtualBox 4.0, opening a medium added it to a global media
1868	registry in the VirtualBox.xml file, which was shared between all machines
1869	and made transporting machines and their media from one host to another
1870	difficult.
1871
1872	Starting with VirtualBox 4.0, media are only added to a registry when
1873	they are attached to a machine. Machines created with VirtualBox 4.0
1874	or later can have their own media registry. As a result, a medium attached
1875	to such a machine will be remembered in that machine's XML settings file.
1876	Media attached to older machines will continue to be added to the global
1877	registry.
1878
1879	<result name="VBOX_E_FILE_ERROR">
1880	Invalid medium storage file location or could not find the medium
1881	at the specified location.
1882	</result>
1883	<result name="VBOX_E_IPRT_ERROR">
1884	Could not get medium storage format.
1885	</result>
1886	<result name="E_INVALIDARG">
1887	Invalid medium storage format.
1888	</result>
1889	<result name="VBOX_E_INVALID_OBJECT_STATE">
1890	Medium has already been added to a media registry.
1891	</result>
1892	</desc>
1893	<param name="location" type="wstring" dir="in">
1894	<desc>
1895	Location of the storage unit that contains medium data in one of
1896	the supported storage formats.
1897	</desc>
1898	</param>
1899	<param name="deviceType" type="DeviceType" dir="in">
1900	<desc>
1901	Must be one of "HardDisk", "DVD" or "Floppy".
1902	</desc>
1903	</param>
1904	<param name="accessMode" type="AccessMode" dir="in">
1905	<desc>Whether to open the image in read/write or read-only mode. For
1906	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1907	</param>
1908	<param name="medium" type="IMedium" dir="return">
1909	<desc>Opened medium object.</desc>
1910	</param>
1911	</method>
1912
1913	<method name="findMedium">
1914	<desc>
1915	Returns a medium of the given type that uses the given fully qualified
1916	location or UUID to store medium data.
1917
1918	The given medium must be known to this VirtualBox installation, i.e.
1919	it must be previously created by <link to="#createHardDisk"/> or opened
1920	by <link to="#openMedium"/>.
1921
1922	The search is done by comparing the value of the @a location argument to
1923	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1924	attributes of each known medium.
1925
1926	On case sensitive file systems, a case sensitive comparison is performed,
1927	otherwise the case of symbols in the file path is ignored.
1928
1929	<result name="VBOX_E_OBJECT_NOT_FOUND">
1930	No medium object matching @a location found.
1931	</result>
1932	</desc>
1933	<param name="location" type="wstring" dir="in">
1934	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1935	</param>
1936	<param name="type" type="DeviceType" dir="in">
1937	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1938	</param>
1939	<param name="medium" type="IMedium" dir="return">
1940	<desc>Medium object, if found.</desc>
1941	</param>
1942	</method>
1943
1944	<method name="getGuestOSType">
1945	<desc>
1946	Returns an object describing the specified guest OS type.
1947
1948	The requested guest OS type is specified using a string which is a
1949	mnemonic identifier of the guest operating system, such as
1950	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1951	particular virtual machine can be read or set using the
1952	<link to="IMachine::OSTypeId"/> attribute.
1953
1954	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1955	available guest OS type objects. Each object has an
1956	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1957	the guest OS this object describes.
1958
1959	<result name="E_INVALIDARG">
1960	@a id is not a valid Guest OS type.
1961	</result>
1962
1963	</desc>
1964	<param name="id" type="uuid" mod="string" dir="in">
1965	<desc>Guest OS type ID string.</desc>
1966	</param>
1967	<param name="type" type="IGuestOSType" dir="return">
1968	<desc>Guest OS type object.</desc>
1969	</param>
1970	</method>
1971
1972	<method name="createSharedFolder">
1973	<desc>
1974	Creates a new global shared folder by associating the given logical
1975	name with the given host path, adds it to the collection of shared
1976	folders and starts sharing it. Refer to the description of
1977	<link to="ISharedFolder"/> to read more about logical names.
1978	<note>
1979	In the current implementation, this operation is not
1980	implemented.
1981	</note>
1982	</desc>
1983	<param name="name" type="wstring" dir="in">
1984	<desc>Unique logical name of the shared folder.</desc>
1985	</param>
1986	<param name="hostPath" type="wstring" dir="in">
1987	<desc>Full path to the shared folder in the host file system.</desc>
1988	</param>
1989	<param name="writable" type="boolean" dir="in">
1990	<desc>Whether the share is writable or readonly</desc>
1991	</param>
1992	<param name="automount" type="boolean" dir="in">
1993	<desc>Whether the share gets automatically mounted by the guest
1994	or not.</desc>
1995	</param>
1996	</method>
1997
1998	<method name="removeSharedFolder">
1999	<desc>
2000	Removes the global shared folder with the given name previously
2001	created by <link to="#createSharedFolder"/> from the collection of
2002	shared folders and stops sharing it.
2003	<note>
2004	In the current implementation, this operation is not
2005	implemented.
2006	</note>
2007	</desc>
2008	<param name="name" type="wstring" dir="in">
2009	<desc>Logical name of the shared folder to remove.</desc>
2010	</param>
2011	</method>
2012
2013	<method name="getExtraDataKeys">
2014	<desc>
2015	Returns an array representing the global extra data keys which currently
2016	have values defined.
2017	</desc>
2018	<param name="value" type="wstring" dir="return" safearray="yes">
2019	<desc>Array of extra data keys.</desc>
2020	</param>
2021	</method>
2022
2023	<method name="getExtraData">
2024	<desc>
2025	Returns associated global extra data.
2026
2027	If the requested data @a key does not exist, this function will
2028	succeed and return an empty string in the @a value argument.
2029
2030	<result name="VBOX_E_FILE_ERROR">
2031	Settings file not accessible.
2032	</result>
2033	<result name="VBOX_E_XML_ERROR">
2034	Could not parse the settings file.
2035	</result>
2036
2037	</desc>
2038	<param name="key" type="wstring" dir="in">
2039	<desc>Name of the data key to get.</desc>
2040	</param>
2041	<param name="value" type="wstring" dir="return">
2042	<desc>Value of the requested data key.</desc>
2043	</param>
2044	</method>
2045
2046	<method name="setExtraData">
2047	<desc>
2048	Sets associated global extra data.
2049
2050	If you pass @c null or empty string as a key @a value, the given @a key
2051	will be deleted.
2052
2053	<note>
2054	Before performing the actual data change, this method will ask all
2055	registered event listener using the
2056	<link to="IExtraDataCanChangeEvent"/>
2057	notification for a permission. If one of the listeners refuses the
2058	new value, the change will not be performed.
2059	</note>
2060	<note>
2061	On success, the
2062	<link to="IExtraDataChangedEvent"/> notification
2063	is called to inform all registered listeners about a successful data
2064	change.
2065	</note>
2066
2067	<result name="VBOX_E_FILE_ERROR">
2068	Settings file not accessible.
2069	</result>
2070	<result name="VBOX_E_XML_ERROR">
2071	Could not parse the settings file.
2072	</result>
2073	<result name="E_ACCESSDENIED">
2074	Modification request refused.
2075	</result>
2076
2077	</desc>
2078	<param name="key" type="wstring" dir="in">
2079	<desc>Name of the data key to set.</desc>
2080	</param>
2081	<param name="value" type="wstring" dir="in">
2082	<desc>Value to assign to the key.</desc>
2083	</param>
2084	</method>
2085
2086	<!--method name="createDHCPServerForInterface">
2087	<desc>
2088	Creates a dhcp server settings to be used for the given interface
2089	<result name="E_INVALIDARG">
2090	Host network interface @a name already exists.
2091	</result>
2092	</desc>
2093	<param name="interface" type="IHostNetworkInterface" dir="in">
2094	<desc>Network Interface</desc>
2095	</param>
2096	<param name="server" type="IDHCPServer" dir="out">
2097	<desc>Dhcp server settings</desc>
2098	</param>
2099	</method-->
2100
2101	<method name="createDHCPServer">
2102	<desc>
2103	Creates a dhcp server settings to be used for the given internal network name
2104	<result name="E_INVALIDARG">
2105	Host network interface @a name already exists.
2106	</result>
2107	</desc>
2108	<param name="name" type="wstring" dir="in">
2109	<desc>server name</desc>
2110	</param>
2111	<param name="server" type="IDHCPServer" dir="return">
2112	<desc>Dhcp server settings</desc>
2113	</param>
2114	</method>
2115
2116	<method name="findDHCPServerByNetworkName">
2117	<desc>
2118	Searches a dhcp server settings to be used for the given internal network name
2119	<result name="E_INVALIDARG">
2120	Host network interface @a name already exists.
2121	</result>
2122
2123	</desc>
2124	<param name="name" type="wstring" dir="in">
2125	<desc>server name</desc>
2126	</param>
2127	<param name="server" type="IDHCPServer" dir="return">
2128	<desc>Dhcp server settings</desc>
2129	</param>
2130	</method>
2131
2132	<!--method name="findDHCPServerForInterface">
2133	<desc>
2134	Searches a dhcp server settings to be used for the given interface
2135	<result name="E_INVALIDARG">
2136	Host network interface @a name already exists.
2137	</result>
2138	</desc>
2139	<param name="interface" type="IHostNetworkInterface" dir="in">
2140	<desc>Network Interface</desc>
2141	</param>
2142	<param name="server" type="IDHCPServer" dir="out">
2143	<desc>Dhcp server settings</desc>
2144	</param>
2145	</method-->
2146
2147	<method name="removeDHCPServer">
2148	<desc>
2149	Removes the dhcp server settings
2150	<result name="E_INVALIDARG">
2151	Host network interface @a name already exists.
2152	</result>
2153	</desc>
2154	<param name="server" type="IDHCPServer" dir="in">
2155	<desc>Dhcp server settings to be removed</desc>
2156	</param>
2157	</method>
2158
2159
2160	<method name="checkFirmwarePresent">
2161	<desc>
2162	Check if this VirtualBox installation has a firmware
2163	of the given type available, either system-wide or per-user.
2164	Optionally, this may return a hint where this firmware can be
2165	downloaded from.
2166	</desc>
2167	<param name="firmwareType" type="FirmwareType" dir="in">
2168	<desc>
2169	Type of firmware to check.
2170	</desc>
2171	</param>
2172	<param name="version" type="wstring" dir="in">
2173	<desc>Expected version number, usually empty string (presently ignored).</desc>
2174	</param>
2175
2176	<param name="url" type="wstring" dir="out">
2177	<desc>
2178	Suggested URL to download this firmware from.
2179	</desc>
2180	</param>
2181
2182	<param name="file" type="wstring" dir="out">
2183	<desc>
2184	Filename of firmware, only valid if result == TRUE.
2185	</desc>
2186	</param>
2187
2188	<param name="result" type="boolean" dir="return">
2189	<desc>If firmware of this type and version is available.</desc>
2190	</param>
2191	</method>
2192
2193	</interface>
2194
2195	<!--
2196	// IVFSExplorer
2197	/////////////////////////////////////////////////////////////////////////
2198	-->
2199
2200	<enum
2201	name="VFSType"
2202	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2203	>
2204	<desc>
2205	Virtual file systems supported by VFSExplorer.
2206	</desc>
2207
2208	<const name="File" value="1" />
2209	<const name="Cloud" value="2" />
2210	<const name="S3" value="3" />
2211	<const name="WebDav" value="4" />
2212	</enum>
2213
2214	<enum
2215	name="VFSFileType"
2216	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2217	>
2218	<desc>
2219	File types known by VFSExplorer.
2220	</desc>
2221
2222	<const name="Unknown" value="1" />
2223	<const name="Fifo" value="2" />
2224	<const name="DevChar" value="3" />
2225	<const name="Directory" value="4" />
2226	<const name="DevBlock" value="5" />
2227	<const name="File" value="6" />
2228	<const name="SymLink" value="7" />
2229	<const name="Socket" value="8" />
2230	<const name="WhiteOut" value="9" />
2231	</enum>
2232
2233	<interface
2234	name="IVFSExplorer" extends="$unknown"
2235	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2236	wsmap="managed"
2237	>
2238	<desc>
2239	The VFSExplorer interface unifies access to different file system
2240	types. This includes local file systems as well remote file systems like
2241	S3. For a list of supported types see <link to="VFSType" />.
2242	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2243	</desc>
2244
2245	<attribute name="path" type="wstring" readonly="yes">
2246	<desc>Returns the current path in the virtual file system.</desc>
2247	</attribute>
2248
2249	<attribute name="type" type="VFSType" readonly="yes">
2250	<desc>Returns the file system type which is currently in use.</desc>
2251	</attribute>
2252
2253	<method name="update">
2254	<desc>Updates the internal list of files/directories from the
2255	current directory level. Use <link to="#entryList" /> to get the full list
2256	after a call to this method.</desc>
2257
2258	<param name="aProgress" type="IProgress" dir="return">
2259	<desc>Progress object to track the operation completion.</desc>
2260	</param>
2261	</method>
2262
2263	<method name="cd">
2264	<desc>Change the current directory level.</desc>
2265
2266	<param name="aDir" type="wstring" dir="in">
2267	<desc>The name of the directory to go in.</desc>
2268	</param>
2269
2270	<param name="aProgress" type="IProgress" dir="return">
2271	<desc>Progress object to track the operation completion.</desc>
2272	</param>
2273	</method>
2274
2275	<method name="cdUp">
2276	<desc>Go one directory upwards from the current directory level.</desc>
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="entryList">
2284	<desc>Returns a list of files/directories after a call to <link
2285	to="#update" />. The user is responsible for keeping this internal
2286	list up do date.</desc>
2287
2288	<param name="aNames" type="wstring" safearray="yes" dir="out">
2289	<desc>The list of names for the entries.</desc>
2290	</param>
2291
2292	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2293	<desc>The list of types for the entries.</desc>
2294	</param>
2295
2296	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2297	<desc>The list of sizes (in bytes) for the entries.</desc>
2298	</param>
2299
2300	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2301	<desc>The list of file modes (in octal form) for the entries.</desc>
2302	</param>
2303	</method>
2304
2305	<method name="exists">
2306	<desc>Checks if the given file list exists in the current directory
2307	level.</desc>
2308
2309	<param name="aNames" type="wstring" safearray="yes" dir="in">
2310	<desc>The names to check.</desc>
2311	</param>
2312
2313	<param name="aExists" type="wstring" safearray="yes" dir="return">
2314	<desc>The names which exist.</desc>
2315	</param>
2316	</method>
2317
2318	<method name="remove">
2319	<desc>Deletes the given files in the current directory level.</desc>
2320
2321	<param name="aNames" type="wstring" safearray="yes" dir="in">
2322	<desc>The names to remove.</desc>
2323	</param>
2324
2325	<param name="aProgress" type="IProgress" dir="return">
2326	<desc>Progress object to track the operation completion.</desc>
2327	</param>
2328	</method>
2329
2330	</interface>
2331
2332	<!--
2333	// IAppliance
2334	/////////////////////////////////////////////////////////////////////////
2335	-->
2336
2337	<interface
2338	name="IAppliance" extends="$unknown"
2339	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2340	wsmap="managed"
2341	>
2342	<desc>
2343	Represents a platform-independent appliance in OVF format. An instance of this is returned
2344	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2345	virtual machines within an appliance with VirtualBox.
2346
2347	The OVF standard suggests two different physical file formats:
2348
2349	<ol>
2350	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2351	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2352	this descriptor file references other files such as disk images, as OVF appliances typically
2353	do, those additional files must be in the same directory as the descriptor file.</li>
2354
2355	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2356	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2357	files and optionally other files.
2358
2359	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2360	be added with a later version.</li>
2361	</ol>
2362
2363	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2364	<link to="IMachine" /> involves the following sequence of API calls:
2365
2366	<ol>
2367	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2368	</li>
2369
2370	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2371	would like to import. So long as this file is syntactically valid, this will succeed
2372	and fill the appliance object with the parsed data from the OVF file.
2373	</li>
2374
2375	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2376	contents of the IAppliance attributes accordingly. These can be inspected by a
2377	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2378	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2379	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2380	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2381	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2382	The GUI can then give the user the option to confirm and/or change these suggestions.
2383	</li>
2384
2385	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2386	virtual system (machine) to override the suggestions made by the interpret() routine.
2387	</li>
2388
2389	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2390	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2391	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2392	can be found in the <link to="#machines" /> array attribute.
2393	</li>
2394	</ol>
2395
2396	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2397
2398	<ol>
2399	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2400	an empty IAppliance object.
2401	</li>
2402
2403	<li>For each machine you would like to export, call <link to="IMachine::export" />
2404	with the IAppliance object you just created. Each such call creates one instance of
2405	<link to="IVirtualSystemDescription" /> inside the appliance.
2406	</li>
2407
2408	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2409	virtual system (machine) to override the suggestions made by the export() routine.
2410	</li>
2411
2412	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2413	file written.</li>
2414	</ol>
2415
2416	</desc>
2417
2418	<attribute name="path" type="wstring" readonly="yes">
2419	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2420	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2421	<link to="#write" /> (for export).
2422	This attribute is empty until one of these methods has been called.
2423	</desc>
2424	</attribute>
2425
2426	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2427	<desc>
2428	Array of virtual disk definitions. One such description exists for each
2429	disk definition in the OVF; each string array item represents one such piece of
2430	disk information, with the information fields separated by tab (\t) characters.
2431
2432	The caller should be prepared for additional fields being appended to
2433	this string in future versions of VirtualBox and therefore check for
2434	the number of tabs in the strings returned.
2435
2436	In the current version, the following eight fields are returned per string
2437	in the array:
2438
2439	<ol>
2440	<li>Disk ID (unique string identifier given to disk)</li>
2441
2442	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2443
2444	<li>Populated size (optional unsigned integer indicating the current size of the
2445	disk; can be approximate; -1 if unspecified)</li>
2446
2447	<li>Format (string identifying the disk format, typically
2448	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2449
2450	<li>Reference (where to find the disk image, typically a file name; if empty,
2451	then the disk should be created on import)</li>
2452
2453	<li>Image size (optional unsigned integer indicating the size of the image,
2454	which need not necessarily be the same as the values specified above, since
2455	the image may be compressed or sparse; -1 if not specified)</li>
2456
2457	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2458	presently unsupported and always -1)</li>
2459
2460	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2461	</ol>
2462	</desc>
2463	</attribute>
2464
2465	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2466	<desc> Array of virtual system descriptions. One such description is created
2467	for each virtual system (machine) found in the OVF.
2468	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2469	(for export) has been called.
2470	</desc>
2471	</attribute>
2472
2473	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2474	<desc>
2475	Contains the UUIDs of the machines created from the information in this appliances. This is only
2476	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2477	succeeded.
2478	</desc>
2479	</attribute>
2480
2481	<method name="read">
2482	<desc>
2483	Reads an OVF file into the appliance object.
2484
2485	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2486	mere fact that this method returns successfully does not mean that VirtualBox supports all
2487	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2488	</desc>
2489	<param name="file" type="wstring" dir="in">
2490	<desc>
2491	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2492	on whether the appliance is distributed as a set of files or as a single file, respectively).
2493	</desc>
2494	</param>
2495	<param name="aProgress" type="IProgress" dir="return">
2496	<desc>Progress object to track the operation completion.</desc>
2497	</param>
2498	</method>
2499
2500	<method name="interpret">
2501	<desc>
2502	Interprets the OVF data that was read when the appliance was constructed. After
2503	calling this method, one can inspect the
2504	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2505	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2506	the appliance.
2507
2508	Calling this method is the second step of importing an appliance into VirtualBox;
2509	see <link to="IAppliance" /> for an overview.
2510
2511	After calling this method, one should call <link to="#getWarnings" /> to find out
2512	if problems were encountered during the processing which might later lead to
2513	errors.
2514	</desc>
2515	</method>
2516
2517	<method name="importMachines">
2518	<desc>
2519	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2520	and other interfaces that match the information contained in the appliance as
2521	closely as possible, as represented by the import instructions in the
2522	<link to="#virtualSystemDescriptions" /> array.
2523
2524	Calling this method is the final step of importing an appliance into VirtualBox;
2525	see <link to="IAppliance" /> for an overview.
2526
2527	Since importing the appliance will most probably involve copying and converting
2528	disk images, which can take a long time, this method operates asynchronously and
2529	returns an IProgress object to allow the caller to monitor the progress.
2530
2531	After the import succeeded, the UUIDs of the IMachine instances created can be
2532	retrieved from the <link to="#machines" /> array attribute.
2533	</desc>
2534
2535	<param name="aProgress" type="IProgress" dir="return">
2536	<desc>Progress object to track the operation completion.</desc>
2537	</param>
2538	</method>
2539
2540	<method name="createVFSExplorer">
2541	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2542
2543	<param name="aUri" type="wstring" dir="in">
2544	<desc>The URI describing the file system to use.</desc>
2545	</param>
2546
2547	<param name="aExplorer" type="IVFSExplorer" dir="return">
2548	<desc></desc>
2549	</param>
2550	</method>
2551
2552	<method name="write">
2553	<desc>
2554	Writes the contents of the appliance exports into a new OVF file.
2555
2556	Calling this method is the final step of exporting an appliance from VirtualBox;
2557	see <link to="IAppliance" /> for an overview.
2558
2559	Since exporting the appliance will most probably involve copying and converting
2560	disk images, which can take a long time, this method operates asynchronously and
2561	returns an IProgress object to allow the caller to monitor the progress.
2562	</desc>
2563	<param name="format" type="wstring" dir="in">
2564	<desc>
2565	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2566	future versions of VirtualBox may support additional formats.
2567	</desc>
2568	</param>
2569	<param name="manifest" type="boolean" dir="in">
2570	<desc>
2571	Indicate if the optional manifest file (.mf) should be written. The manifest file
2572	is used for integrity checks prior import.
2573	</desc>
2574	</param>
2575	<param name="path" type="wstring" dir="in">
2576	<desc>
2577	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2578	on whether the appliance is distributed as a set of files or as a single file, respectively).
2579	</desc>
2580	</param>
2581	<param name="progress" type="IProgress" dir="return">
2582	<desc>Progress object to track the operation completion.</desc>
2583	</param>
2584	</method>
2585
2586	<method name="getWarnings">
2587	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2588
2589	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2590	<desc></desc>
2591	</param>
2592	</method>
2593
2594	</interface>
2595
2596	<enum
2597	name="VirtualSystemDescriptionType"
2598	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2599	>
2600	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2601	a configuration value.</desc>
2602
2603	<const name="Ignore" value="1" />
2604	<const name="OS" value="2" />
2605	<const name="Name" value="3" />
2606	<const name="Product" value="4" />
2607	<const name="Vendor" value="5" />
2608	<const name="Version" value="6" />
2609	<const name="ProductUrl" value="7" />
2610	<const name="VendorUrl" value="8" />
2611	<const name="Description" value="9" />
2612	<const name="License" value="10" />
2613	<const name="Miscellaneous" value="11" />
2614	<const name="CPU" value="12" />
2615	<const name="Memory" value="13" />
2616	<const name="HardDiskControllerIDE" value="14" />
2617	<const name="HardDiskControllerSATA" value="15" />
2618	<const name="HardDiskControllerSCSI" value="16" />
2619	<const name="HardDiskControllerSAS" value="17" />
2620	<const name="HardDiskImage" value="18" />
2621	<const name="Floppy" value="19" />
2622	<const name="CDROM" value="20" />
2623	<const name="NetworkAdapter" value="21" />
2624	<const name="USBController" value="22" />
2625	<const name="SoundCard" value="23" />
2626
2627	</enum>
2628
2629	<enum
2630	name="VirtualSystemDescriptionValueType"
2631	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2632	>
2633	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2634	type to fetch.</desc>
2635
2636	<const name="Reference" value="1" />
2637	<const name="Original" value="2" />
2638	<const name="Auto" value="3" />
2639	<const name="ExtraConfig" value="4" />
2640
2641	</enum>
2642
2643	<interface
2644	name="IVirtualSystemDescription" extends="$unknown"
2645	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2646	wsmap="managed"
2647	>
2648
2649	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2650	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2651	<link to="IAppliance::interpret" /> has been called, that array contains information
2652	about how the virtual systems described in the OVF should best be imported into
2653	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2654	import an OVF into VirtualBox.
2655	</desc>
2656
2657	<attribute name="count" type="unsigned long" readonly="yes">
2658	<desc>Return the number of virtual system description entries.</desc>
2659	</attribute>
2660
2661	<method name="getDescription">
2662	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2663	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2664
2665	The list below identifies the value sets that are possible depending on the
2666	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2667	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2668	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2669	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2670	the @a aExtraConfigValues[] array item may also be used.
2671
2672	<ul>
2673	<li>
2674	"OS": the guest operating system type. There must be exactly one such array item on import. The
2675	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2676	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2677	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2678	</li>
2679	<li>
2680	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2681	if none is present on import, then an automatic name will be created from the operating system
2682	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2683	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2684	<link to="IMachine" /> name that does not exist yet.
2685	</li>
2686	<li>
2687	"Description": an arbitrary description.
2688	</li>
2689	<li>
2690	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2691	code to display such a license for agreement; the Main API does not enforce any such policy.
2692	</li>
2693	<li>
2694	Miscellaneous: reserved for future use.
2695	</li>
2696	<li>
2697	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2698	</li>
2699	<li>
2700	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2701	is present on import, then VirtualBox will set a meaningful default based on the operating system
2702	type.
2703	</li>
2704	<li>
2705	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2706	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2707	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2708	writes into the OVF.
2709	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2710	type can use to specify which hard disk controller a virtual disk should be connected to.
2711	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2712	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2713	its virtual machines supports four channels (primary master, primary slave, secondary master,
2714	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2715	</li>
2716	<li>
2717	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2718	has no value in @a aOvfValues[] or @a aVBoxValues[].
2719	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2720	</li>
2721	<li>
2722	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2723	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2724	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2725	whereas VirtualBox considers it a class of storage controllers of its own; see
2726	<link to="StorageControllerType" />).
2727	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2728	</li>
2729	<li>
2730	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2731	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2732
2733	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2734	a path since the image file should be in the same location as the OVF file itself), whereas the
2735	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2736	hard disk image. This means that on import the image will be copied and converted from the
2737	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2738
2739	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2740	format: "controller=<index>;channel=<c>"
2741	In this string, <index> must be an integer specifying the hard disk controller to connect
2742	the image to. That number must be the index of an array item with one of the hard disk controller
2743	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2744	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2745	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2746	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2747	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2748	</li>
2749	<li>
2750	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2751	attachment information as with "HardDiskImage" items.
2752	</li>
2753	<li>
2754	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2755	attachment information as with "HardDiskImage" items.
2756	</li>
2757	<li>
2758	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2759	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2760	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2761	</li>
2762	<li>
2763	"USBController": a USB controller. There can be at most one such item. If and only if such an
2764	item ispresent, USB support will be enabled for the new virtual machine.
2765	</li>
2766	<li>
2767	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2768	present, sound support will be enabled for the new virtual machine. Note that the virtual
2769	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2770	may be different from the virtual soundcard expected by the appliance.
2771	</li>
2772	</ul>
2773
2774	</desc>
2775
2776	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2777	<desc></desc>
2778	</param>
2779
2780	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2781	<desc></desc>
2782	</param>
2783
2784	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2785	<desc></desc>
2786	</param>
2787
2788	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2789	<desc></desc>
2790	</param>
2791
2792	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2793	<desc></desc>
2794	</param>
2795
2796	</method>
2797
2798	<method name="getDescriptionByType">
2799	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2800	should be returned.</desc>
2801
2802	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2803	<desc></desc>
2804	</param>
2805
2806	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2807	<desc></desc>
2808	</param>
2809
2810	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2811	<desc></desc>
2812	</param>
2813
2814	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2815	<desc></desc>
2816	</param>
2817
2818	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2819	<desc></desc>
2820	</param>
2821
2822	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2823	<desc></desc>
2824	</param>
2825
2826	</method>
2827
2828	<method name="getValuesByType">
2829	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2830	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2831	values.</desc>
2832
2833	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2834	<desc></desc>
2835	</param>
2836
2837	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2838	<desc></desc>
2839	</param>
2840
2841	<param name="aValues" type="wstring" dir="return" safearray="yes">
2842	<desc></desc>
2843	</param>
2844
2845	</method>
2846
2847	<method name="setFinalValues">
2848	<desc>
2849	This method allows the appliance's user to change the configuration for the virtual
2850	system descriptions. For each array item returned from <link to="#getDescription" />,
2851	you must pass in one boolean value and one configuration value.
2852
2853	Each item in the boolean array determines whether the particular configuration item
2854	should be enabled.
2855	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2856	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2857	and SoundCard.
2858
2859	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2860	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2861	the configuration remains unchanged. Please see the documentation for getDescription()
2862	for valid configuration values for the individual array item types. If the
2863	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2864	</desc>
2865
2866	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2871	<desc></desc>
2872	</param>
2873
2874	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2875	<desc></desc>
2876	</param>
2877	</method>
2878
2879	<method name="addDescription">
2880	<desc>
2881	This method adds an additional description entry to the stack of already
2882	available descriptions for this virtual system. This is handy for writing
2883	values which aren't directly supported by VirtualBox. One example would
2884	be the License type of <link to="VirtualSystemDescriptionType" />.
2885	</desc>
2886
2887	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2888	<desc></desc>
2889	</param>
2890
2891	<param name="aVBoxValue" type="wstring" dir="in">
2892	<desc></desc>
2893	</param>
2894
2895	<param name="aExtraConfigValue" type="wstring" dir="in">
2896	<desc></desc>
2897	</param>
2898	</method>
2899	</interface>
2900
2901
2902	<!--
2903	// IMachine
2904	/////////////////////////////////////////////////////////////////////////
2905	-->
2906
2907	<interface
2908	name="IInternalMachineControl" extends="$unknown"
2909	uuid="476126af-e223-4490-a8a0-b1f1575be013"
2910	internal="yes"
2911	wsmap="suppress"
2912	>
2913	<method name="setRemoveSavedStateFile">
2914	<desc>
2915	Updates the flag whether the saved state file is removed on a
2916	machine state change from Saved to PoweredOff.
2917	</desc>
2918	<param name="aRemove" type="boolean" dir="in"/>
2919	</method>
2920
2921	<method name="updateState">
2922	<desc>
2923	Updates the VM state.
2924	<note>
2925	This operation will also update the settings file with the correct
2926	information about the saved state file and delete this file from disk
2927	when appropriate.
2928	</note>
2929	</desc>
2930	<param name="state" type="MachineState" dir="in"/>
2931	</method>
2932
2933	<method name="getIPCId">
2934	<param name="id" type="wstring" dir="return"/>
2935	</method>
2936
2937	<method name="beginPowerUp">
2938	<desc>
2939	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2940	gives it the progress object that should be part of any pending
2941	<link to="IMachine::launchVMProcess"/> operations. The progress
2942	object may be called back to reflect an early cancelation, so some care
2943	have to be taken with respect to any cancelation callbacks. The console
2944	object will call <link to="IInternalMachineControl::endPowerUp"/>
2945	to signal the completion of the progress object.
2946	</desc>
2947	<param name="aProgress" type="IProgress" dir="in" />
2948	</method>
2949
2950	<method name="endPowerUp">
2951	<desc>
2952	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2953	This method may query status information from the progress object it
2954	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2955	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2956	call in order to complete that progress object.
2957	</desc>
2958	<param name="result" type="long" dir="in"/>
2959	</method>
2960
2961	<method name="runUSBDeviceFilters">
2962	<desc>
2963	Asks the server to run USB devices filters of the associated
2964	machine against the given USB device and tell if there is
2965	a match.
2966	<note>
2967	Intended to be used only for remote USB devices. Local
2968	ones don't require to call this method (this is done
2969	implicitly by the Host and USBProxyService).
2970	</note>
2971	</desc>
2972	<param name="device" type="IUSBDevice" dir="in"/>
2973	<param name="matched" type="boolean" dir="out"/>
2974	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
2975	</method>
2976
2977	<method name="captureUSBDevice">
2978	<desc>
2979	Requests a capture of the given host USB device.
2980	When the request is completed, the VM process will
2981	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
2982	notification.
2983	</desc>
2984	<param name="id" type="uuid" mod="string" dir="in"/>
2985	</method>
2986
2987	<method name="detachUSBDevice">
2988	<desc>
2989	Notification that a VM is going to detach (@a done = @c false) or has
2990	already detached (@a done = @c true) the given USB device.
2991	When the @a done = @c true request is completed, the VM process will
2992	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
2993	notification.
2994	<note>
2995	In the @a done = @c true case, the server must run its own filters
2996	and filters of all VMs but this one on the detached device
2997	as if it were just attached to the host computer.
2998	</note>
2999	</desc>
3000	<param name="id" type="uuid" mod="string" dir="in"/>
3001	<param name="done" type="boolean" dir="in"/>
3002	</method>
3003
3004	<method name="autoCaptureUSBDevices">
3005	<desc>
3006	Requests a capture all matching USB devices attached to the host.
3007	When the request is completed, the VM process will
3008	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3009	notification per every captured device.
3010	</desc>
3011	</method>
3012
3013	<method name="detachAllUSBDevices">
3014	<desc>
3015	Notification that a VM that is being powered down. The done
3016	parameter indicates whether which stage of the power down
3017	we're at. When @a done = @c false the VM is announcing its
3018	intentions, while when @a done = @c true the VM is reporting
3019	what it has done.
3020	<note>
3021	In the @a done = @c true case, the server must run its own filters
3022	and filters of all VMs but this one on all detach devices as
3023	if they were just attached to the host computer.
3024	</note>
3025	</desc>
3026	<param name="done" type="boolean" dir="in"/>
3027	</method>
3028
3029	<method name="onSessionEnd">
3030	<desc>
3031	Triggered by the given session object when the session is about
3032	to close normally.
3033	</desc>
3034	<param name="session" type="ISession" dir="in">
3035	<desc>Session that is being closed</desc>
3036	</param>
3037	<param name="progress" type="IProgress" dir="return">
3038	<desc>
3039	Used to wait until the corresponding machine is actually
3040	dissociated from the given session on the server.
3041	Returned only when this session is a direct one.
3042	</desc>
3043	</param>
3044	</method>
3045
3046	<method name="beginSavingState">
3047	<desc>
3048	Called by the VM process to inform the server it wants to
3049	save the current state and stop the VM execution.
3050	</desc>
3051	<param name="progress" type="IProgress" dir="out">
3052	<desc>
3053	Progress object created by VBoxSVC to wait until
3054	the state is saved.
3055	</desc>
3056	</param>
3057	<param name="stateFilePath" type="wstring" dir="out">
3058	<desc>
3059	File path the VM process must save the execution state to.
3060	</desc>
3061	</param>
3062	</method>
3063
3064	<method name="endSavingState">
3065	<desc>
3066	Called by the VM process to inform the server that saving
3067	the state previously requested by #beginSavingState is either
3068	successfully finished or there was a failure.
3069
3070	<result name="VBOX_E_FILE_ERROR">
3071	Settings file not accessible.
3072	</result>
3073	<result name="VBOX_E_XML_ERROR">
3074	Could not parse the settings file.
3075	</result>
3076
3077	</desc>
3078
3079	<param name="result" type="long" dir="in">
3080	<desc>@c S_OK to indicate success.
3081	</desc>
3082	</param>
3083	<param name="errMsg" type="wstring" dir="in">
3084	<desc>@c human readable error message in case of failure.
3085	</desc>
3086	</param>
3087	</method>
3088
3089	<method name="adoptSavedState">
3090	<desc>
3091	Gets called by IConsole::adoptSavedState.
3092	<result name="VBOX_E_FILE_ERROR">
3093	Invalid saved state file path.
3094	</result>
3095	</desc>
3096	<param name="savedStateFile" type="wstring" dir="in">
3097	<desc>Path to the saved state file to adopt.</desc>
3098	</param>
3099	</method>
3100
3101	<method name="beginTakingSnapshot">
3102	<desc>
3103	Called from the VM process to request from the server to perform the
3104	server-side actions of creating a snapshot (creating differencing images
3105	and the snapshot object).
3106
3107	<result name="VBOX_E_FILE_ERROR">
3108	Settings file not accessible.
3109	</result>
3110	<result name="VBOX_E_XML_ERROR">
3111	Could not parse the settings file.
3112	</result>
3113	</desc>
3114	<param name="initiator" type="IConsole" dir="in">
3115	<desc>The console object that initiated this call.</desc>
3116	</param>
3117	<param name="name" type="wstring" dir="in">
3118	<desc>Snapshot name.</desc>
3119	</param>
3120	<param name="description" type="wstring" dir="in">
3121	<desc>Snapshot description.</desc>
3122	</param>
3123	<param name="consoleProgress" type="IProgress" dir="in">
3124	<desc>
3125	Progress object created by the VM process tracking the
3126	snapshot's progress. This has the following sub-operations:
3127	<ul>
3128	<li>setting up (weight 1);</li>
3129	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3130	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3131	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3132	<li>finishing up (weight 1)</li>
3133	</ul>
3134	</desc>
3135	</param>
3136	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3137	<desc>
3138	Whether this is an online snapshot (i.e. the machine is running).
3139	</desc>
3140	</param>
3141	<param name="stateFilePath" type="wstring" dir="out">
3142	<desc>
3143	File path the VM process must save the execution state to.
3144	</desc>
3145	</param>
3146	</method>
3147
3148	<method name="endTakingSnapshot">
3149	<desc>
3150	Called by the VM process to inform the server that the snapshot
3151	previously requested by #beginTakingSnapshot is either
3152	successfully taken or there was a failure.
3153	</desc>
3154
3155	<param name="success" type="boolean" dir="in">
3156	<desc>@c true to indicate success and @c false otherwise</desc>
3157	</param>
3158	</method>
3159
3160	<method name="deleteSnapshot">
3161	<desc>
3162	Gets called by IConsole::deleteSnapshot.
3163	<result name="VBOX_E_INVALID_OBJECT_STATE">
3164	Snapshot has more than one child snapshot.
3165	</result>
3166	</desc>
3167	<param name="initiator" type="IConsole" dir="in">
3168	<desc>The console object that initiated this call.</desc>
3169	</param>
3170	<param name="id" type="uuid" mod="string" dir="in">
3171	<desc>UUID of the snapshot to delete.</desc>
3172	</param>
3173	<param name="machineState" type="MachineState" dir="out">
3174	<desc>New machine state after this operation is started.</desc>
3175	</param>
3176	<param name="progress" type="IProgress" dir="return">
3177	<desc>Progress object to track the operation completion.</desc>
3178	</param>
3179	</method>
3180
3181	<method name="finishOnlineMergeMedium">
3182	<desc>
3183	Gets called by IConsole::onlineMergeMedium.
3184	</desc>
3185	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3186	<desc>The medium attachment which needs to be cleaned up.</desc>
3187	</param>
3188	<param name="source" type="IMedium" dir="in">
3189	<desc>Merge source medium.</desc>
3190	</param>
3191	<param name="target" type="IMedium" dir="in">
3192	<desc>Merge target medium.</desc>
3193	</param>
3194	<param name="mergeForward" type="boolean" dir="in">
3195	<desc>Merge direction.</desc>
3196	</param>
3197	<param name="parentForTarget" type="IMedium" dir="in">
3198	<desc>For forward merges: new parent for target medium.</desc>
3199	</param>
3200	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3201	<desc>For backward merges: list of media which need their parent UUID
3202	updated.</desc>
3203	</param>
3204	</method>
3205
3206	<method name="restoreSnapshot">
3207	<desc>
3208	Gets called by IConsole::RestoreSnapshot.
3209	</desc>
3210	<param name="initiator" type="IConsole" dir="in">
3211	<desc>The console object that initiated this call.</desc>
3212	</param>
3213	<param name="snapshot" type="ISnapshot" dir="in">
3214	<desc>The snapshot to restore the VM state from.</desc>
3215	</param>
3216	<param name="machineState" type="MachineState" dir="out">
3217	<desc>New machine state after this operation is started.</desc>
3218	</param>
3219	<param name="progress" type="IProgress" dir="return">
3220	<desc>Progress object to track the operation completion.</desc>
3221	</param>
3222	</method>
3223
3224	<method name="pullGuestProperties">
3225	<desc>
3226	Get the list of the guest properties matching a set of patterns along
3227	with their values, time stamps and flags and give responsibility for
3228	managing properties to the console.
3229	</desc>
3230	<param name="name" type="wstring" dir="out" safearray="yes">
3231	<desc>
3232	The names of the properties returned.
3233	</desc>
3234	</param>
3235	<param name="value" type="wstring" dir="out" safearray="yes">
3236	<desc>
3237	The values of the properties returned. The array entries match the
3238	corresponding entries in the @a name array.
3239	</desc>
3240	</param>
3241	<param name="timestamp" type="long long" dir="out" safearray="yes">
3242	<desc>
3243	The time stamps of the properties returned. The array entries match
3244	the corresponding entries in the @a name array.
3245	</desc>
3246	</param>
3247	<param name="flags" type="wstring" dir="out" safearray="yes">
3248	<desc>
3249	The flags of the properties returned. The array entries match the
3250	corresponding entries in the @a name array.
3251	</desc>
3252	</param>
3253	</method>
3254
3255	<method name="pushGuestProperty">
3256	<desc>
3257	Update a single guest property in IMachine.
3258	</desc>
3259	<param name="name" type="wstring" dir="in">
3260	<desc>
3261	The name of the property to be updated.
3262	</desc>
3263	</param>
3264	<param name="value" type="wstring" dir="in">
3265	<desc>
3266	The value of the property.
3267	</desc>
3268	</param>
3269	<param name="timestamp" type="long long" dir="in">
3270	<desc>
3271	The timestamp of the property.
3272	</desc>
3273	</param>
3274	<param name="flags" type="wstring" dir="in">
3275	<desc>
3276	The flags of the property.
3277	</desc>
3278	</param>
3279	</method>
3280
3281	<method name="lockMedia">
3282	<desc>
3283	Locks all media attached to the machine for writing and parents of
3284	attached differencing media (if any) for reading. This operation is
3285	atomic so that if it fails no media is actually locked.
3286
3287	This method is intended to be called when the machine is in Starting or
3288	Restoring state. The locked media will be automatically unlocked when
3289	the machine is powered off or crashed.
3290	</desc>
3291	</method>
3292	<method name="unlockMedia">
3293	<desc>
3294	Unlocks all media previously locked using
3295	<link to="IInternalMachineControl::lockMedia"/>.
3296
3297	This method is intended to be used with teleportation so that it is
3298	possible to teleport between processes on the same machine.
3299	</desc>
3300	</method>
3301	</interface>
3302
3303	<interface
3304	name="IBIOSSettings" extends="$unknown"
3305	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3306	wsmap="managed"
3307	>
3308	<desc>
3309	The IBIOSSettings interface represents BIOS settings of the virtual
3310	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3311	</desc>
3312	<attribute name="logoFadeIn" type="boolean">
3313	<desc>Fade in flag for BIOS logo animation.</desc>
3314	</attribute>
3315
3316	<attribute name="logoFadeOut" type="boolean">
3317	<desc>Fade out flag for BIOS logo animation.</desc>
3318	</attribute>
3319
3320	<attribute name="logoDisplayTime" type="unsigned long">
3321	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3322	</attribute>
3323
3324	<attribute name="logoImagePath" type="wstring">
3325	<desc>
3326	Local file system path for external BIOS splash image. Empty string
3327	means the default image is shown on boot.
3328	</desc>
3329	</attribute>
3330
3331	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3332	<desc>Mode of the BIOS boot device menu.</desc>
3333	</attribute>
3334
3335	<attribute name="ACPIEnabled" type="boolean">
3336	<desc>ACPI support flag.</desc>
3337	</attribute>
3338
3339	<attribute name="IOAPICEnabled" type="boolean">
3340	<desc>
3341	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3342	and support IRQs above 15.
3343	</desc>
3344	</attribute>
3345
3346	<attribute name="timeOffset" type="long long">
3347	<desc>
3348	Offset in milliseconds from the host system time. This allows for
3349	guests running with a different system date/time than the host.
3350	It is equivalent to setting the system date/time in the BIOS except
3351	it is not an absolute value but a relative one. Guest Additions
3352	time synchronization honors this offset.
3353	</desc>
3354	</attribute>
3355
3356	<attribute name="PXEDebugEnabled" type="boolean">
3357	<desc>
3358	PXE debug logging flag. If set, VirtualBox will write extensive
3359	PXE trace information to the release log.
3360	</desc>
3361	</attribute>
3362
3363	</interface>
3364
3365	<enum
3366	name="CleanupMode"
3367	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3368	>
3369	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3370	</desc>
3371	<const name="UnregisterOnly" value="1">
3372	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3373	</const>
3374	<const name="DetachAllReturnNone" value="2">
3375	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3376	</const>
3377	<const name="DetachAllReturnHardDisksOnly" value="3">
3378	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3379	</const>
3380	<const name="Full" value="4">
3381	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3382	</const>
3383	</enum>
3384
3385	<interface
3386	name="IEventContext" extends="$unknown"
3387	uuid="7563F4E7-1583-40F7-B4C4-C9BA02CB0AE3"
3388	wsmap="managed"
3389	>
3390	<desc>
3391	Placeholder class for event contexts.
3392	</desc>
3393	</interface>
3394
3395
3396	<interface
3397	name="IPciAddress" extends="$unknown"
3398	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3399	wsmap="struct"
3400	>
3401
3402	<desc>
3403	Address on the PCI bus.
3404	</desc>
3405
3406	<attribute name="bus" type="short">
3407	<desc>
3408	Bus number.
3409	</desc>
3410	</attribute>
3411
3412	<attribute name="device" type="short">
3413	<desc>
3414	Device number.
3415	</desc>
3416	</attribute>
3417
3418	<attribute name="devFunction" type="short">
3419	<desc>
3420	Device function number.
3421	</desc>
3422	</attribute>
3423
3424	<method name="asLong">
3425	<desc>
3426	Convert PCI address into long.
3427	</desc>
3428	<param name="result" type="long" dir="return" />
3429	</method>
3430
3431	<method name="fromLong">
3432	<desc>
3433	Make PCI address from long.
3434	</desc>
3435	<param name="number" type="long" dir="in" />
3436	</method>
3437	</interface>
3438
3439	<interface
3440	name="IPciDeviceAttachment" extends="$unknown"
3441	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3442	wsmap="struct"
3443	>
3444
3445	<desc>
3446	Information about PCI attachments.
3447	</desc>
3448
3449	<attribute name="name" type="wstring" readonly="yes">
3450	<desc>
3451	Device name.
3452	</desc>
3453	</attribute>
3454
3455	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3456	<desc>
3457	If this is physical or virtual device.
3458	</desc>
3459	</attribute>
3460
3461	<attribute name="hostAddress" type="long" readonly="yes">
3462	<desc>
3463	Address of device on the host, applicable only to host devices.
3464	</desc>
3465	</attribute>
3466
3467	<attribute name="guestAddress" type="long" readonly="yes">
3468	<desc>
3469	Address of device on the guest.
3470	</desc>
3471	</attribute>
3472
3473	</interface>
3474
3475
3476	<interface
3477	name="IMachine" extends="$unknown"
3478	uuid="711cbb73-75af-463c-af17-8b7860c01fe8"
3479	wsmap="managed"
3480	>
3481	<desc>
3482	The IMachine interface represents a virtual machine, or guest, created
3483	in VirtualBox.
3484
3485	This interface is used in two contexts. First of all, a collection of
3486	objects implementing this interface is stored in the
3487	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3488	machines that are currently registered with this VirtualBox
3489	installation. Also, once a session has been opened for the given virtual
3490	machine (e.g. the virtual machine is running), the machine object
3491	associated with the open session can be queried from the session object;
3492	see <link to="ISession"/> for details.
3493
3494	The main role of this interface is to expose the settings of the virtual
3495	machine and provide methods to change various aspects of the virtual
3496	machine's configuration. For machine objects stored in the
3497	<link to="IVirtualBox::machines"/> collection, all attributes are
3498	read-only unless explicitly stated otherwise in individual attribute
3499	and method descriptions.
3500
3501	In order to change a machine setting, a session for this machine must be
3502	opened using one of the <link to="IMachine::lockMachine" /> or
3503	<link to="IMachine::launchVMProcess"/> methods. After the
3504	machine has been successfully locked for a session, a mutable machine object
3505	needs to be queried from the session object and then the desired settings
3506	changes can be applied to the returned object using IMachine attributes and
3507	methods. See the <link to="ISession"/> interface description for more
3508	information about sessions.
3509
3510	Note that IMachine does not provide methods to control virtual machine
3511	execution (such as start the machine, or power it down) -- these methods
3512	are grouped in a separate interface called <link to="IConsole" />.
3513
3514	<see>ISession, IConsole</see>
3515	</desc>
3516
3517	<attribute name="parent" type="IVirtualBox" readonly="yes">
3518	<desc>Associated parent object.</desc>
3519	</attribute>
3520
3521	<attribute name="accessible" type="boolean" readonly="yes">
3522	<desc>
3523	Whether this virtual machine is currently accessible or not.
3524
3525	A machine is always deemed accessible unless it is registered <i>and</i>
3526	its settings file cannot be read or parsed (either because the file itself
3527	is unavailable or has invalid XML contents).
3528
3529	Every time this property is read, the accessibility state of
3530	this machine is re-evaluated. If the returned value is @c false,
3531	the <link to="#accessError"/> property may be used to get the
3532	detailed error information describing the reason of
3533	inaccessibility, including XML error messages.
3534
3535	When the machine is inaccessible, only the following properties
3536	can be used on it:
3537	<ul>
3538	<li><link to="#parent"/></li>
3539	<li><link to="#id"/></li>
3540	<li><link to="#settingsFilePath"/></li>
3541	<li><link to="#accessible"/></li>
3542	<li><link to="#accessError"/></li>
3543	</ul>
3544
3545	An attempt to access any other property or method will return
3546	an error.
3547
3548	The only possible action you can perform on an inaccessible
3549	machine is to unregister it using the
3550	<link to="IMachine::unregister"/> call (or, to check
3551	for the accessibility state once more by querying this
3552	property).
3553
3554	<note>
3555	In the current implementation, once this property returns
3556	@c true, the machine will never become inaccessible
3557	later, even if its settings file cannot be successfully
3558	read/written any more (at least, until the VirtualBox
3559	server is restarted). This limitation may be removed in
3560	future releases.
3561	</note>
3562	</desc>
3563	</attribute>
3564
3565	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3566	<desc>
3567	Error information describing the reason of machine
3568	inaccessibility.
3569
3570	Reading this property is only valid after the last call to
3571	<link to="#accessible"/> returned @c false (i.e. the
3572	machine is currently inaccessible). Otherwise, a @c null
3573	IVirtualBoxErrorInfo object will be returned.
3574	</desc>
3575	</attribute>
3576
3577	<attribute name="name" type="wstring">
3578	<desc>
3579	Name of the virtual machine.
3580
3581	Besides being used for human-readable identification purposes
3582	everywhere in VirtualBox, the virtual machine name is also used
3583	as a name of the machine's settings file and as a name of the
3584	subdirectory this settings file resides in. Thus, every time you
3585	change the value of this property, the settings file will be
3586	renamed once you call <link to="#saveSettings"/> to confirm the
3587	change. The containing subdirectory will be also renamed, but
3588	only if it has exactly the same name as the settings file
3589	itself prior to changing this property (for backward compatibility
3590	with previous API releases). The above implies the following
3591	limitations:
3592	<ul>
3593	<li>The machine name cannot be empty.</li>
3594	<li>The machine name can contain only characters that are valid
3595	file name characters according to the rules of the file
3596	system used to store VirtualBox configuration.</li>
3597	<li>You cannot have two or more machines with the same name
3598	if they use the same subdirectory for storing the machine
3599	settings files.</li>
3600	<li>You cannot change the name of the machine if it is running,
3601	or if any file in the directory containing the settings file
3602	is being used by another running machine or by any other
3603	process in the host operating system at a time when
3604	<link to="#saveSettings"/> is called.
3605	</li>
3606	</ul>
3607	If any of the above limitations are hit, <link to="#saveSettings"/>
3608	will return an appropriate error message explaining the exact
3609	reason and the changes you made to this machine will not be saved.
3610
3611	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3612	file is recommended, but not enforced. (Previous versions always
3613	used a generic ".xml" extension.)
3614	</desc>
3615	</attribute>
3616
3617	<attribute name="description" type="wstring">
3618	<desc>
3619	Description of the virtual machine.
3620
3621	The description attribute can contain any text and is
3622	typically used to describe the hardware and software
3623	configuration of the virtual machine in detail (i.e. network
3624	settings, versions of the installed software and so on).
3625	</desc>
3626	</attribute>
3627
3628	<attribute name="id" type="uuid" mod="string" readonly="yes">
3629	<desc>UUID of the virtual machine.</desc>
3630	</attribute>
3631
3632	<attribute name="OSTypeId" type="wstring">
3633	<desc>
3634	User-defined identifier of the Guest OS type.
3635	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3636	an IGuestOSType object representing details about the given
3637	Guest OS type.
3638	<note>
3639	This value may differ from the value returned by
3640	<link to="IGuest::OSTypeId"/> if Guest Additions are
3641	installed to the guest OS.
3642	</note>
3643	</desc>
3644	</attribute>
3645
3646	<attribute name="HardwareVersion" type="wstring">
3647	<desc>Hardware version identifier. Internal use only for now.</desc>
3648	</attribute>
3649
3650	<attribute name="hardwareUUID" type="uuid" mod="string">
3651	<desc>
3652	The UUID presented to the guest via memory tables, hardware and guest
3653	properties. For most VMs this is the same as the @a id, but for VMs
3654	which have been cloned or teleported it may be the same as the source
3655	VM. This latter is because the guest shouldn't notice that it was
3656	cloned or teleported.
3657	</desc>
3658	</attribute>
3659
3660	<attribute name="CPUCount" type="unsigned long">
3661	<desc>Number of virtual CPUs in the VM.</desc>
3662	</attribute>
3663
3664	<attribute name="CPUHotPlugEnabled" type="boolean">
3665	<desc>
3666	This setting determines whether VirtualBox allows CPU
3667	hotplugging for this machine.</desc>
3668	</attribute>
3669
3670	<attribute name="CPUExecutionCap" type="unsigned long">
3671	<desc>
3672	Means to limit the number of CPU cycles a guest can use. The unit
3673	is percentage of host CPU cycles per second. The valid range
3674	is 1 - 100. 100 (the default) implies no limit.
3675	</desc>
3676	</attribute>
3677
3678	<attribute name="memorySize" type="unsigned long">
3679	<desc>System memory size in megabytes.</desc>
3680	</attribute>
3681
3682	<attribute name="memoryBalloonSize" type="unsigned long">
3683	<desc>Memory balloon size in megabytes.</desc>
3684	</attribute>
3685
3686	<attribute name="PageFusionEnabled" type="boolean">
3687	<desc>
3688	This setting determines whether VirtualBox allows page
3689	fusion for this machine (64 bits host only).
3690	</desc>
3691	</attribute>
3692
3693	<attribute name="VRAMSize" type="unsigned long">
3694	<desc>Video memory size in megabytes.</desc>
3695	</attribute>
3696
3697	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3698	<desc>
3699	This setting determines whether VirtualBox allows this machine to make
3700	use of the 3D graphics support available on the host.</desc>
3701	</attribute>
3702
3703	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3704	<desc>
3705	This setting determines whether VirtualBox allows this machine to make
3706	use of the 2D video acceleration support available on the host.</desc>
3707	</attribute>
3708
3709	<attribute name="monitorCount" type="unsigned long">
3710	<desc>
3711	Number of virtual monitors.
3712	<note>
3713	Only effective on Windows XP and later guests with
3714	Guest Additions installed.
3715	</note>
3716	</desc>
3717	</attribute>
3718
3719	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3720	<desc>Object containing all BIOS settings.</desc>
3721	</attribute>
3722
3723	<attribute name="firmwareType" type="FirmwareType">
3724	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3725	bootstrap in this VM.</desc>
3726	</attribute>
3727
3728	<attribute name="pointingHidType" type="PointingHidType">
3729	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3730	The default is typically "PS2Mouse" but can vary depending on the
3731	requirements of the guest operating system.</desc>
3732	</attribute>
3733
3734	<attribute name="keyboardHidType" type="KeyboardHidType">
3735	<desc>Type of keyboard HID used in this VM.
3736	The default is typically "PS2Keyboard" but can vary depending on the
3737	requirements of the guest operating system.</desc>
3738	</attribute>
3739
3740	<attribute name="hpetEnabled" type="boolean">
3741	<desc>This attribute controls if High Precision Event Timer (HPET) is
3742	enabled in this VM. Use this property if you want to provide guests
3743	with additional time source, or if guest requires HPET to function correctly.
3744	Default is false.</desc>
3745	</attribute>
3746
3747	<attribute name="chipsetType" type="ChipsetType">
3748	<desc>Chipset type used in this VM.</desc>
3749	</attribute>
3750
3751	<attribute name="snapshotFolder" type="wstring">
3752	<desc>
3753	Full path to the directory used to store snapshot data
3754	(differencing media and saved state files) of this machine.
3755
3756	The initial value of this property is
3757	<tt><</tt><link to="#settingsFilePath">
3758	path_to_settings_file</link><tt>>/<</tt>
3759	<link to="#id">machine_uuid</link>
3760	<tt>></tt>.
3761
3762	Currently, it is an error to try to change this property on
3763	a machine that has snapshots (because this would require to
3764	move possibly large files to a different location).
3765	A separate method will be available for this purpose later.
3766
3767	<note>
3768	Setting this property to @c null or to an empty string will restore
3769	the initial value.
3770	</note>
3771	<note>
3772	When setting this property, the specified path can be
3773	absolute (full path) or relative to the directory where the
3774	<link to="#settingsFilePath">machine settings file</link>
3775	is located. When reading this property, a full path is
3776	always returned.
3777	</note>
3778	<note>
3779	The specified path may not exist, it will be created
3780	when necessary.
3781	</note>
3782	</desc>
3783	</attribute>
3784
3785	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3786	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3787	</attribute>
3788
3789	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3790	<desc>Array of media attached to this machine.</desc>
3791	</attribute>
3792
3793	<attribute name="USBController" type="IUSBController" readonly="yes">
3794	<desc>
3795	Associated USB controller object.
3796
3797	<note>
3798	If USB functionality is not available in the given edition of
3799	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3800	</note>
3801	</desc>
3802	</attribute>
3803
3804	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3805	<desc>Associated audio adapter, always present.</desc>
3806	</attribute>
3807
3808	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3809	<desc>Array of storage controllers attached to this machine.</desc>
3810	</attribute>
3811
3812	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3813	<desc>
3814	Full name of the file containing machine settings data.
3815	</desc>
3816	</attribute>
3817
3818	<attribute name="settingsModified" type="boolean" readonly="yes">
3819	<desc>
3820	Whether the settings of this machine have been modified
3821	(but neither yet saved nor discarded).
3822	<note>
3823	Reading this property is only valid on instances returned
3824	by <link to="ISession::machine"/> and on new machines
3825	created by <link to="IVirtualBox::createMachine"/> or opened
3826	by <link to="IVirtualBox::openMachine"/> but not
3827	yet registered, or on unregistered machines after calling
3828	<link to="IMachine::unregister"/>. For all other
3829	cases, the settings can never be modified.
3830	</note>
3831	<note>
3832	For newly created unregistered machines, the value of this
3833	property is always @c true until <link to="#saveSettings"/>
3834	is called (no matter if any machine settings have been
3835	changed after the creation or not). For opened machines
3836	the value is set to @c false (and then follows to normal rules).
3837	</note>
3838	</desc>
3839	</attribute>
3840
3841	<attribute name="sessionState" type="SessionState" readonly="yes">
3842	<desc>Current session state for this machine.</desc>
3843	</attribute>
3844
3845	<attribute name="sessionType" type="wstring" readonly="yes">
3846	<desc>
3847	Type of the session. If <link to="#sessionState"/> is
3848	Spawning or Locked, this attribute contains the
3849	same value as passed to the
3850	<link to="IMachine::launchVMProcess"/> method in the
3851	@a type parameter. If the session was used with
3852	<link to="IMachine::lockMachine" />, or if
3853	<link to="#sessionState"/> is SessionClosed, the value of this
3854	attribute is an empty string.
3855	</desc>
3856	</attribute>
3857
3858	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3859	<desc>
3860	Identifier of the session process. This attribute contains the
3861	platform-dependent identifier of the process whose session was
3862	used with <link to="IMachine::lockMachine" /> call. The returned
3863	value is only valid if <link to="#sessionState"/> is Locked or
3864	Unlocking by the time this property is read.
3865	</desc>
3866	</attribute>
3867
3868	<attribute name="state" type="MachineState" readonly="yes">
3869	<desc>Current execution state of this machine.</desc>
3870	</attribute>
3871
3872	<attribute name="lastStateChange" type="long long" readonly="yes">
3873	<desc>
3874	Time stamp of the last execution state change,
3875	in milliseconds since 1970-01-01 UTC.
3876	</desc>
3877	</attribute>
3878
3879	<attribute name="stateFilePath" type="wstring" readonly="yes">
3880	<desc>
3881	Full path to the file that stores the execution state of
3882	the machine when it is in the <link to="MachineState_Saved"/> state.
3883	<note>
3884	When the machine is not in the Saved state, this attribute is
3885	an empty string.
3886	</note>
3887	</desc>
3888	</attribute>
3889
3890	<attribute name="logFolder" type="wstring" readonly="yes">
3891	<desc>
3892	Full path to the folder that stores a set of rotated log files
3893	recorded during machine execution. The most recent log file is
3894	named <tt>VBox.log</tt>, the previous log file is
3895	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3896	in the current version).
3897	</desc>
3898	</attribute>
3899
3900	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3901	<desc>
3902	Current snapshot of this machine. This is @c null if the machine
3903	currently has no snapshots. If it is not @c null, then it was
3904	set by one of <link to="IConsole::takeSnapshot" />,
3905	<link to="IConsole::deleteSnapshot" />
3906	or <link to="IConsole::restoreSnapshot" />, depending on which
3907	was called last. See <link to="ISnapshot"/> for details.
3908	</desc>
3909	</attribute>
3910
3911	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3912	<desc>
3913	Number of snapshots taken on this machine. Zero means the
3914	machine doesn't have any snapshots.
3915	</desc>
3916	</attribute>
3917
3918	<attribute name="currentStateModified" type="boolean" readonly="yes">
3919	<desc>
3920	Returns @c true if the current state of the machine is not
3921	identical to the state stored in the current snapshot.
3922
3923	The current state is identical to the current snapshot only
3924	directly after one of the following calls are made:
3925
3926	<ul>
3927	<li><link to="IConsole::restoreSnapshot"/>
3928	</li>
3929	<li><link to="IConsole::takeSnapshot"/> (issued on a
3930	"powered off" or "saved" machine, for which
3931	<link to="#settingsModified"/> returns @c false)
3932	</li>
3933	</ul>
3934
3935	The current state remains identical until one of the following
3936	happens:
3937	<ul>
3938	<li>settings of the machine are changed</li>
3939	<li>the saved state is deleted</li>
3940	<li>the current snapshot is deleted</li>
3941	<li>an attempt to execute the machine is made</li>
3942	</ul>
3943
3944	<note>
3945	For machines that don't have snapshots, this property is
3946	always @c false.
3947	</note>
3948	</desc>
3949	</attribute>
3950
3951	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3952	<desc>
3953	Collection of shared folders for this machine (permanent shared
3954	folders). These folders are shared automatically at machine startup
3955	and available only to the guest OS installed within this machine.
3956
3957	New shared folders are added to the collection using
3958	<link to="#createSharedFolder"/>. Existing shared folders can be
3959	removed using <link to="#removeSharedFolder"/>.
3960	</desc>
3961	</attribute>
3962
3963	<attribute name="clipboardMode" type="ClipboardMode">
3964	<desc>
3965	Synchronization mode between the host OS clipboard
3966	and the guest OS clipboard.
3967	</desc>
3968	</attribute>
3969
3970	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3971	<desc>
3972	A comma-separated list of simple glob patterns. Changes to guest
3973	properties whose name matches one of the patterns will generate an
3974	<link to="IGuestPropertyChangedEvent"/> signal.
3975	</desc>
3976	</attribute>
3977
3978	<attribute name="teleporterEnabled" type="boolean">
3979	<desc>
3980	When set to @a true, the virtual machine becomes a target teleporter
3981	the next time it is powered on. This can only set to @a true when the
3982	VM is in the @a PoweredOff or @a Aborted state.
3983
3984	<!-- This property is automatically set to @a false when the VM is powered
3985	on. (bird: This doesn't work yet ) -->
3986	</desc>
3987	</attribute>
3988
3989	<attribute name="teleporterPort" type="unsigned long">
3990	<desc>
3991	The TCP port the target teleporter will listen for incoming
3992	teleportations on.
3993
3994	0 means the port is automatically selected upon power on. The actual
3995	value can be read from this property while the machine is waiting for
3996	incoming teleportations.
3997	</desc>
3998	</attribute>
3999
4000	<attribute name="teleporterAddress" type="wstring">
4001	<desc>
4002	The address the target teleporter will listen on. If set to an empty
4003	string, it will listen on all addresses.
4004	</desc>
4005	</attribute>
4006
4007	<attribute name="teleporterPassword" type="wstring">
4008	<desc>
4009	The password to check for on the target teleporter. This is just a
4010	very basic measure to prevent simple hacks and operators accidentally
4011	beaming a virtual machine to the wrong place.
4012	</desc>
4013	</attribute>
4014
4015	<attribute name="faultToleranceState" type="FaultToleranceState">
4016	<desc>
4017	Fault tolerance state; disabled, source or target.
4018	This property can be changed at any time. If you change it for a running
4019	VM, then the fault tolerance address and port must be set beforehand.
4020	</desc>
4021	</attribute>
4022
4023	<attribute name="faultTolerancePort" type="unsigned long">
4024	<desc>
4025	The TCP port the fault tolerance source or target will use for
4026	communication.
4027	</desc>
4028	</attribute>
4029
4030	<attribute name="faultToleranceAddress" type="wstring">
4031	<desc>
4032	The address the fault tolerance source or target.
4033	</desc>
4034	</attribute>
4035
4036	<attribute name="faultTolerancePassword" type="wstring">
4037	<desc>
4038	The password to check for on the standby VM. This is just a
4039	very basic measure to prevent simple hacks and operators accidentally
4040	choosing the wrong standby VM.
4041	</desc>
4042	</attribute>
4043
4044	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4045	<desc>
4046	The interval in ms used for syncing the state between source and target.
4047	</desc>
4048	</attribute>
4049
4050	<attribute name="RTCUseUTC" type="boolean">
4051	<desc>
4052	When set to @a true, the RTC device of the virtual machine will run
4053	in UTC time, otherwise in local time. Especially Unix guests prefer
4054	the time in UTC.
4055	</desc>
4056	</attribute>
4057
4058	<attribute name="ioCacheEnabled" type="boolean">
4059	<desc>
4060	When set to @a true, the builtin I/O cache of the virtual machine
4061	will be enabled.
4062	</desc>
4063	</attribute>
4064
4065	<attribute name="ioCacheSize" type="unsigned long">
4066	<desc>
4067	Maximum size of the I/O cache in MB.
4068	</desc>
4069	</attribute>
4070
4071	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4072	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4073	attached to the machine use IConsole::attachedPciDevices attribute, as
4074	this attribute is intended to list only devices additional to what
4075	described in virtual hardware config. Usually, this list keeps host's
4076	physical devices assigned to the particular machine.
4077	</desc>
4078	</attribute>
4079
4080	<method name="lockMachine">
4081	<desc>
4082	Locks the machine for the given session to enable the caller
4083	to make changes to the machine or start the VM or control
4084	VM execution.
4085
4086	There are two ways to lock a machine for such uses:
4087
4088	<ul>
4089	<li>If you want to make changes to the machine settings,
4090	you must obtain an exclusive write lock on the machine
4091	by setting @a lockType to @c Write.
4092
4093	This will only succeed if no other process has locked
4094	the machine to prevent conflicting changes. Only after
4095	an exclusive write lock has been obtained using this method, one
4096	can change all VM settings or execute the VM in the process
4097	space of the session object. (Note that the latter is only of
4098	interest if you actually want to write a new front-end for
4099	virtual machines; but this API gets called internally by
4100	the existing front-ends such as VBoxHeadless and the VirtualBox
4101	GUI to acquire a write lock on the machine that they are running.)
4102
4103	On success, write-locking the machine for a session creates
4104	a second copy of the IMachine object. It is this second object
4105	upon which changes can be made; in VirtualBox terminology, the
4106	second copy is "mutable". It is only this second, mutable machine
4107	object upon which you can call methods that change the
4108	machine state. After having called this method, you can
4109	obtain this second, mutable machine object using the
4110	<link to="ISession::machine" /> attribute.
4111	</li>
4112	<li>If you only want to check the machine state or control
4113	machine execution without actually changing machine
4114	settings (e.g. to get access to VM statistics or take
4115	a snapshot or save the machine state), then set the
4116	@a lockType argument to @c Shared.
4117
4118	If no other session has obtained a lock, you will obtain an
4119	exclusive write lock as described above. However, if another
4120	session has already obtained such a lock, then a link to that
4121	existing session will be established which allows you
4122	to control that existing session.
4123
4124	To find out which type of lock was obtained, you can
4125	inspect <link to="ISession::type" />, which will have been
4126	set to either @c WriteLock or @c Shared.
4127	</li>
4128	</ul>
4129
4130	In either case, you can get access to the <link to="IConsole" />
4131	object which controls VM execution.
4132
4133	Also in all of the above cases, one must always call
4134	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4135	the machine's state will eventually be set to "Aborted".
4136
4137	To change settings on a machine, the following sequence is typically
4138	performed:
4139
4140	<ol>
4141	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4142
4143	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4144
4145	<li>Change the settings of the machine by invoking IMachine methods.</li>
4146
4147	<li>Call <link to="IMachine::saveSettings" />.</li>
4148
4149	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4150	</ol>
4151
4152	<result name="E_UNEXPECTED">
4153	Virtual machine not registered.
4154	</result>
4155	<result name="E_ACCESSDENIED">
4156	Process not started by OpenRemoteSession.
4157	</result>
4158	<result name="VBOX_E_INVALID_OBJECT_STATE">
4159	Session already open or being opened.
4160	</result>
4161	<result name="VBOX_E_VM_ERROR">
4162	Failed to assign machine to session.
4163	</result>
4164	</desc>
4165	<param name="session" type="ISession" dir="in">
4166	<desc>
4167	Session object for which the machine will be locked.
4168	</desc>
4169	</param>
4170	<param name="lockType" type="LockType" dir="in">
4171	<desc>
4172	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4173	If set to @c Shared, then either acquire an exclusive write lock or establish
4174	a link to an existing session.
4175	</desc>
4176	</param>
4177	</method>
4178
4179	<method name="launchVMProcess">
4180	<desc>
4181	Spawns a new process that will execute the virtual machine and obtains a shared
4182	lock on the machine for the calling session.
4183
4184	If launching the VM succeeds, the new VM process will create its own session
4185	and write-lock the machine for it, preventing conflicting changes from other
4186	processes. If the machine is already locked (because it is already running or
4187	because another session has a write lock), launching the VM process will therefore
4188	fail. Reversely, future attempts to obtain a write lock will also fail while the
4189	machine is running.
4190
4191	The caller's session object remains separate from the session opened by the new
4192	VM process. It receives its own <link to="IConsole" /> object which can be used
4193	to control machine execution, but it cannot be used to change all VM settings
4194	which would be available after a <link to="#lockMachine" /> call.
4195
4196	The caller must eventually release the session's shared lock by calling
4197	<link to="ISession::unlockMachine" /> on the local session object once this call
4198	has returned. However, the session's state (see <link to="ISession::state" />)
4199	will not return to "Unlocked" until the remote session has also unlocked
4200	the machine (i.e. the machine has stopped running).
4201
4202	Launching a VM process can take some time (a new VM is started in a new process,
4203	for which memory and other resources need to be set up). Because of this,
4204	an <link to="IProgress" /> object is returned to allow the caller to wait
4205	for this asynchronous operation to be completed. Until then, the caller's
4206	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4207	and <link to="ISession::console" /> attributes cannot be accessed.
4208	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4209	similar calls to wait for completion. Completion is signalled when the VM
4210	is powered on. If launching the VM fails, error messages can be queried
4211	via the progress object, if available.
4212
4213	The progress object will have at least 2 sub-operations. The first
4214	operation covers the period up to the new VM process calls powerUp.
4215	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4216	progress object. Because <link to="IConsole::powerUp"/> may require
4217	some extra sub-operations, the <link to="IProgress::operationCount"/>
4218	may change at the completion of operation.
4219
4220	For details on the teleportation progress operation, see
4221	<link to="IConsole::powerUp"/>.
4222
4223	The @a environment argument is a string containing definitions of
4224	environment variables in the following format:
4225	@code
4226	NAME[=VALUE]\n
4227	NAME[=VALUE]\n
4228	...
4229	@endcode
4230	where <tt>\\n</tt> is the new line character. These environment
4231	variables will be appended to the environment of the VirtualBox server
4232	process. If an environment variable exists both in the server process
4233	and in this list, the value from this list takes precedence over the
4234	server's variable. If the value of the environment variable is
4235	omitted, this variable will be removed from the resulting environment.
4236	If the environment string is @c null or empty, the server environment
4237	is inherited by the started process as is.
4238
4239	<result name="E_UNEXPECTED">
4240	Virtual machine not registered.
4241	</result>
4242	<result name="E_INVALIDARG">
4243	Invalid session type @a type.
4244	</result>
4245	<result name="VBOX_E_OBJECT_NOT_FOUND">
4246	No machine matching @a machineId found.
4247	</result>
4248	<result name="VBOX_E_INVALID_OBJECT_STATE">
4249	Session already open or being opened.
4250	</result>
4251	<result name="VBOX_E_IPRT_ERROR">
4252	Launching process for machine failed.
4253	</result>
4254	<result name="VBOX_E_VM_ERROR">
4255	Failed to assign machine to session.
4256	</result>
4257	</desc>
4258	<param name="session" type="ISession" dir="in">
4259	<desc>
4260	Client session object to which the VM process will be connected (this
4261	must be in "Unlocked" state).
4262	</desc>
4263	</param>
4264	<param name="type" type="wstring" dir="in">
4265	<desc>
4266	Front-end to use for the new VM process. The following are currently supported:
4267	<ul>
4268	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4269	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4270	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4271	</ul>
4272	</desc>
4273	</param>
4274	<param name="environment" type="wstring" dir="in">
4275	<desc>
4276	Environment to pass to the VM process.
4277	</desc>
4278	</param>
4279	<param name="progress" type="IProgress" dir="return">
4280	<desc>Progress object to track the operation completion.</desc>
4281	</param>
4282	</method>
4283
4284	<method name="setBootOrder">
4285	<desc>
4286	Puts the given device to the specified position in
4287	the boot order.
4288
4289	To indicate that no device is associated with the given position,
4290	<link to="DeviceType_Null"/> should be used.
4291
4292	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4293
4294	<result name="E_INVALIDARG">
4295	Boot @a position out of range.
4296	</result>
4297	<result name="E_NOTIMPL">
4298	Booting from USB @a device currently not supported.
4299	</result>
4300
4301	</desc>
4302	<param name="position" type="unsigned long" dir="in">
4303	<desc>
4304	Position in the boot order (@c 1 to the total number of
4305	devices the machine can boot from, as returned by
4306	<link to="ISystemProperties::maxBootPosition"/>).
4307	</desc>
4308	</param>
4309	<param name="device" type="DeviceType" dir="in">
4310	<desc>
4311	The type of the device used to boot at the given position.
4312	</desc>
4313	</param>
4314	</method>
4315
4316	<method name="getBootOrder" const="yes">
4317	<desc>
4318	Returns the device type that occupies the specified
4319	position in the boot order.
4320
4321	@todo [remove?]
4322	If the machine can have more than one device of the returned type
4323	(such as hard disks), then a separate method should be used to
4324	retrieve the individual device that occupies the given position.
4325
4326	If here are no devices at the given position, then
4327	<link to="DeviceType_Null"/> is returned.
4328
4329	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4330
4331	<result name="E_INVALIDARG">
4332	Boot @a position out of range.
4333	</result>
4334
4335	</desc>
4336	<param name="position" type="unsigned long" dir="in">
4337	<desc>
4338	Position in the boot order (@c 1 to the total number of
4339	devices the machine can boot from, as returned by
4340	<link to="ISystemProperties::maxBootPosition"/>).
4341	</desc>
4342	</param>
4343	<param name="device" type="DeviceType" dir="return">
4344	<desc>
4345	Device at the given position.
4346	</desc>
4347	</param>
4348	</method>
4349
4350	<method name="attachDevice">
4351	<desc>
4352	Attaches a device and optionally mounts a medium to the given storage
4353	controller (<link to="IStorageController" />, identified by @a name),
4354	at the indicated port and device.
4355
4356	This method is intended for managing storage devices in general while a
4357	machine is powered off. It can be used to attach and detach fixed
4358	and removeable media. The following kind of media can be attached
4359	to a machine:
4360
4361	<ul>
4362	<li>For fixed and removable media, you can pass in a medium that was
4363	previously opened using <link to="IVirtualBox::openMedium" />.
4364	</li>
4365
4366	<li>Only for storage devices supporting removable media (such as
4367	DVDs and floppies), you can also specify a null pointer to
4368	indicate an empty drive or one of the medium objects listed
4369	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4370	arrays to indicate a host drive.
4371	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4372	to change the media while the machine is running.
4373	</li>
4374	</ul>
4375
4376	In a VM's default configuration of virtual machines, the secondary
4377	master of the IDE controller is used for a CD/DVD drive.
4378
4379	After calling this returns successfully, a new instance of
4380	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4381	attachments (see <link to="IMachine::mediumAttachments"/>).
4382
4383	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4384	information about attaching media.
4385
4386	The specified device slot must not have a device attached to it,
4387	or this method will fail.
4388
4389	<note>
4390	You cannot attach a device to a newly created machine until
4391	this machine's settings are saved to disk using
4392	<link to="#saveSettings"/>.
4393	</note>
4394	<note>
4395	If the medium is being attached indirectly, a new differencing medium
4396	will implicitly be created for it and attached instead. If the
4397	changes made to the machine settings (including this indirect
4398	attachment) are later cancelled using <link to="#discardSettings"/>,
4399	this implicitly created differencing medium will implicitly
4400	be deleted.
4401	</note>
4402
4403	<result name="E_INVALIDARG">
4404	SATA device, SATA port, IDE port or IDE slot out of range, or
4405	file or UUID not found.
4406	</result>
4407	<result name="VBOX_E_INVALID_OBJECT_STATE">
4408	Machine must be registered before media can be attached.
4409	</result>
4410	<result name="VBOX_E_INVALID_VM_STATE">
4411	Invalid machine state.
4412	</result>
4413	<result name="VBOX_E_OBJECT_IN_USE">
4414	A medium is already attached to this or another virtual machine.
4415	</result>
4416
4417	</desc>
4418	<param name="name" type="wstring" dir="in">
4419	<desc>Name of the storage controller to attach the device to.</desc>
4420	</param>
4421	<param name="controllerPort" type="long" dir="in">
4422	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4423	the primary controller and 1 specifies the secondary controller.
4424	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4425	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4426	</param>
4427	<param name="device" type="long" dir="in">
4428	<desc>Device slot in the given port to attach the device to. This is only
4429	relevant for IDE controllers, for which 0 specifies the master device and
4430	1 specifies the slave device. For all other controller types, this must
4431	be 0.</desc>
4432	</param>
4433	<param name="type" type="DeviceType" dir="in">
4434	<desc>Device type of the attached device. For media opened by
4435	<link to="IVirtualBox::openMedium" />, this must match the device type
4436	specified there.</desc>
4437	</param>
4438	<param name="medium" type="IMedium" dir="in">
4439	<desc>Medium to mount or NULL for an empty drive.</desc>
4440	</param>
4441	</method>
4442
4443	<method name="detachDevice">
4444	<desc>
4445	Detaches the device attached to a device slot of the specified bus.
4446
4447	Detaching the device from the virtual machine is deferred. This means
4448	that the medium remains associated with the machine when this method
4449	returns and gets actually de-associated only after a successful
4450	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4451	for more detailed information about attaching media.
4452
4453	<note>
4454	You cannot detach a device from a running machine.
4455	</note>
4456	<note>
4457	Detaching differencing media implicitly created by <link
4458	to="#attachDevice"/> for the indirect attachment using this
4459	method will <b>not</b> implicitly delete them. The
4460	<link to="IMedium::deleteStorage"/> operation should be
4461	explicitly performed by the caller after the medium is successfully
4462	detached and the settings are saved with
4463	<link to="#saveSettings"/>, if it is the desired action.
4464	</note>
4465
4466	<result name="VBOX_E_INVALID_VM_STATE">
4467	Attempt to detach medium from a running virtual machine.
4468	</result>
4469	<result name="VBOX_E_OBJECT_NOT_FOUND">
4470	No medium attached to given slot/bus.
4471	</result>
4472	<result name="VBOX_E_NOT_SUPPORTED">
4473	Medium format does not support storage deletion.
4474	</result>
4475
4476	</desc>
4477	<param name="name" type="wstring" dir="in">
4478	<desc>Name of the storage controller to detach the medium from.</desc>
4479	</param>
4480	<param name="controllerPort" type="long" dir="in">
4481	<desc>Port number to detach the medium from.</desc>
4482	</param>
4483	<param name="device" type="long" dir="in">
4484	<desc>Device slot number to detach the medium from.</desc>
4485	</param>
4486	</method>
4487
4488	<method name="passthroughDevice">
4489	<desc>
4490	Sets the passthrough mode of an existing DVD device. Changing the
4491	setting while the VM is running is forbidden. The setting is only used
4492	if at VM start the device is configured as a host DVD drive, in all
4493	other cases it is ignored. The device must already exist; see
4494	<link to="IMachine::attachDevice"/> for how to attach a new device.
4495
4496	The @a controllerPort and @a device parameters specify the device slot and
4497	have have the same meaning as with <link to="IMachine::attachDevice" />.
4498
4499	<result name="E_INVALIDARG">
4500	SATA device, SATA port, IDE port or IDE slot out of range.
4501	</result>
4502	<result name="VBOX_E_INVALID_OBJECT_STATE">
4503	Attempt to modify an unregistered virtual machine.
4504	</result>
4505	<result name="VBOX_E_INVALID_VM_STATE">
4506	Invalid machine state.
4507	</result>
4508
4509	</desc>
4510	<param name="name" type="wstring" dir="in">
4511	<desc>Name of the storage controller.</desc>
4512	</param>
4513	<param name="controllerPort" type="long" dir="in">
4514	<desc>Storage controller port.</desc>
4515	</param>
4516	<param name="device" type="long" dir="in">
4517	<desc>Device slot in the given port.</desc>
4518	</param>
4519	<param name="passthrough" type="boolean" dir="in">
4520	<desc>New value for the passthrough setting.</desc>
4521	</param>
4522	</method>
4523
4524	<method name="mountMedium">
4525	<desc>
4526	Mounts a medium (<link to="IMedium" />, identified
4527	by the given UUID @a id) to the given storage controller
4528	(<link to="IStorageController" />, identified by @a name),
4529	at the indicated port and device. The device must already exist;
4530	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4531
4532	This method is intended only for managing removable media, where the
4533	device is fixed but media is changeable at runtime (such as DVDs
4534	and floppies). It cannot be used for fixed media such as hard disks.
4535
4536	The @a controllerPort and @a device parameters specify the device slot and
4537	have have the same meaning as with <link to="IMachine::attachDevice" />.
4538
4539	The specified device slot can have a medium mounted, which will be
4540	unmounted first. Specifying a zero UUID (or an empty string) for
4541	@a medium does just an unmount.
4542
4543	See <link to="IMedium"/> for more detailed information about
4544	attaching media.
4545
4546	<result name="E_INVALIDARG">
4547	SATA device, SATA port, IDE port or IDE slot out of range.
4548	</result>
4549	<result name="VBOX_E_INVALID_OBJECT_STATE">
4550	Attempt to attach medium to an unregistered virtual machine.
4551	</result>
4552	<result name="VBOX_E_INVALID_VM_STATE">
4553	Invalid machine state.
4554	</result>
4555	<result name="VBOX_E_OBJECT_IN_USE">
4556	Medium already attached to this or another virtual machine.
4557	</result>
4558
4559	</desc>
4560	<param name="name" type="wstring" dir="in">
4561	<desc>Name of the storage controller to attach the medium to.</desc>
4562	</param>
4563	<param name="controllerPort" type="long" dir="in">
4564	<desc>Port to attach the medium to.</desc>
4565	</param>
4566	<param name="device" type="long" dir="in">
4567	<desc>Device slot in the given port to attach the medium to.</desc>
4568	</param>
4569	<param name="medium" type="IMedium" dir="in">
4570	<desc>Medium to mount or NULL for an empty drive.</desc>
4571	</param>
4572	<param name="force" type="boolean" dir="in">
4573	<desc>Allows to force unmount/mount of a medium which is locked by
4574	the device slot in the given port to attach the medium to.</desc>
4575	</param>
4576	</method>
4577
4578	<method name="getMedium" const="yes">
4579	<desc>
4580	Returns the virtual medium attached to a device slot of the specified
4581	bus.
4582
4583	Note that if the medium was indirectly attached by
4584	<link to="#mountMedium"/> to the given device slot then this
4585	method will return not the same object as passed to the
4586	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4587	more detailed information about mounting a medium.
4588
4589	<result name="VBOX_E_OBJECT_NOT_FOUND">
4590	No medium attached to given slot/bus.
4591	</result>
4592
4593	</desc>
4594	<param name="name" type="wstring" dir="in">
4595	<desc>Name of the storage controller the medium is attached to.</desc>
4596	</param>
4597	<param name="controllerPort" type="long" dir="in">
4598	<desc>Port to query.</desc>
4599	</param>
4600	<param name="device" type="long" dir="in">
4601	<desc>Device slot in the given port to query.</desc>
4602	</param>
4603	<param name="medium" type="IMedium" dir="return">
4604	<desc>Attached medium object.</desc>
4605	</param>
4606	</method>
4607
4608	<method name="getMediumAttachmentsOfController" const="yes">
4609	<desc>
4610	Returns an array of medium attachments which are attached to the
4611	the controller with the given name.
4612
4613	<result name="VBOX_E_OBJECT_NOT_FOUND">
4614	A storage controller with given name doesn't exist.
4615	</result>
4616	</desc>
4617	<param name="name" type="wstring" dir="in"/>
4618	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4619	</method>
4620
4621	<method name="getMediumAttachment" const="yes">
4622	<desc>
4623	Returns a medium attachment which corresponds to the controller with
4624	the given name, on the given port and device slot.
4625
4626	<result name="VBOX_E_OBJECT_NOT_FOUND">
4627	No attachment exists for the given controller/port/device combination.
4628	</result>
4629	</desc>
4630	<param name="name" type="wstring" dir="in"/>
4631	<param name="controllerPort" type="long" dir="in"/>
4632	<param name="device" type="long" dir="in"/>
4633	<param name="attachment" type="IMediumAttachment" dir="return"/>
4634	</method>
4635
4636	<method name="attachHostPciDevice">
4637	<desc>
4638	Attaches host PCI device with the given (host) PCI address to the
4639	PCI bus of the virtual machine. Please note, that this operation
4640	is two phase, as real attachment will happen when VM will start,
4641	and most information will be delivered as IHostPciDevicePlugEvent
4642	on IVirtualBox event source.
4643	<note>
4644	Not yet implemented.
4645	</note>
4646
4647	<see>IHostPciDevicePlugEvent</see>
4648
4649	<result name="VBOX_E_INVALID_VM_STATE">
4650	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4651	</result>
4652	<result name="VBOX_E_PDM_ERROR">
4653	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4654	</result>
4655	<result name="VBOX_E_NOT_SUPPORTED">
4656	Hardware or host OS doesn't allow PCI device passthrought.
4657	</result>
4658	</desc>
4659	<param name="hostAddress" type="long" dir="in">
4660	<desc>Address of the host PCI device.</desc>
4661	</param>
4662	<param name="desiredGuestAddress" type="long" dir="in">
4663	<desc>Desired position of this device on guest PCI bus.</desc>
4664	</param>
4665	<param name="eventContext" type="IEventContext" dir="in">
4666	<desc>Context passed into IHostPciDevicePlugEvent event.</desc>
4667	</param>
4668	<param name="tryToUnbind" type="boolean" dir="in">
4669	<desc>If VMM shall try to unbind existing drivers from the
4670	device before attaching it to the guest.</desc>
4671	</param>
4672	</method>
4673
4674	<method name="detachHostPciDevice">
4675	<desc>
4676	Detach host PCI device from the virtual machine.
4677	Also HostPciDevicePlugEvent on IVirtualBox event source
4678	will be delivered.
4679
4680	<note>
4681	Not yet implemented.
4682	</note>
4683
4684	<see>IHostPciDevicePlugEvent</see>
4685
4686	<result name="VBOX_E_INVALID_VM_STATE">
4687	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4688	</result>
4689	<result name="VBOX_E_OBJECT_NOT_FOUND">
4690	This host device is not attached to this machine.
4691	</result>
4692	<result name="VBOX_E_PDM_ERROR">
4693	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4694	</result>
4695	<result name="VBOX_E_NOT_SUPPORTED">
4696	Hardware or host OS doesn't allow PCI device passthrought.
4697	</result>
4698	</desc>
4699	<param name="hostAddress" type="long" dir="in">
4700	<desc>Address of the host PCI device.</desc>
4701	</param>
4702	</method>
4703
4704	<method name="getNetworkAdapter" const="yes">
4705	<desc>
4706	Returns the network adapter associated with the given slot.
4707	Slots are numbered sequentially, starting with zero. The total
4708	number of adapters per machine is defined by the
4709	<link to="ISystemProperties::networkAdapterCount"/> property,
4710	so the maximum slot number is one less than that property's value.
4711
4712	<result name="E_INVALIDARG">
4713	Invalid @a slot number.
4714	</result>
4715
4716	</desc>
4717	<param name="slot" type="unsigned long" dir="in"/>
4718	<param name="adapter" type="INetworkAdapter" dir="return"/>
4719	</method>
4720
4721	<method name="addStorageController">
4722	<desc>
4723	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4724	machine and returns it as an instance of
4725	<link to="IStorageController" />.
4726
4727	@a name identifies the controller for subsequent calls such as
4728	<link to="#getStorageControllerByName" />,
4729	<link to="#getStorageControllerByInstance" />,
4730	<link to="#removeStorageController" />,
4731	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4732
4733	After the controller has been added, you can set its exact
4734	type by setting the <link to="IStorageController::controllerType" />.
4735
4736	<result name="VBOX_E_OBJECT_IN_USE">
4737	A storage controller with given name exists already.
4738	</result>
4739	<result name="E_INVALIDARG">
4740	Invalid @a controllerType.
4741	</result>
4742	</desc>
4743	<param name="name" type="wstring" dir="in"/>
4744	<param name="connectionType" type="StorageBus" dir="in"/>
4745	<param name="controller" type="IStorageController" dir="return"/>
4746	</method>
4747
4748	<method name="getStorageControllerByName" const="yes">
4749	<desc>
4750	Returns a storage controller with the given name.
4751
4752	<result name="VBOX_E_OBJECT_NOT_FOUND">
4753	A storage controller with given name doesn't exist.
4754	</result>
4755	</desc>
4756	<param name="name" type="wstring" dir="in"/>
4757	<param name="storageController" type="IStorageController" dir="return"/>
4758	</method>
4759
4760	<method name="getStorageControllerByInstance" const="yes">
4761	<desc>
4762	Returns a storage controller with the given instance number.
4763
4764	<result name="VBOX_E_OBJECT_NOT_FOUND">
4765	A storage controller with given instance number doesn't exist.
4766	</result>
4767	</desc>
4768	<param name="instance" type="unsigned long" dir="in"/>
4769	<param name="storageController" type="IStorageController" dir="return"/>
4770	</method>
4771
4772	<method name="removeStorageController">
4773	<desc>
4774	Removes a storage controller from the machine.
4775
4776	<result name="VBOX_E_OBJECT_NOT_FOUND">
4777	A storage controller with given name doesn't exist.
4778	</result>
4779	</desc>
4780	<param name="name" type="wstring" dir="in"/>
4781	</method>
4782
4783	<method name="setStorageControllerBootable">
4784	<desc>
4785	Sets the bootable flag of the storage controller with the given name.
4786
4787	<result name="VBOX_E_OBJECT_NOT_FOUND">
4788	A storage controller with given name doesn't exist.
4789	</result>
4790	<result name="VBOX_E_OBJECT_IN_USE">
4791	Another storage controller is marked as bootable already.
4792	</result>
4793	</desc>
4794	<param name="name" type="wstring" dir="in"/>
4795	<param name="bootable" type="boolean" dir="in"/>
4796	</method>
4797
4798	<method name="getSerialPort" const="yes">
4799	<desc>
4800	Returns the serial port associated with the given slot.
4801	Slots are numbered sequentially, starting with zero. The total
4802	number of serial ports per machine is defined by the
4803	<link to="ISystemProperties::serialPortCount"/> property,
4804	so the maximum slot number is one less than that property's value.
4805
4806	<result name="E_INVALIDARG">
4807	Invalid @a slot number.
4808	</result>
4809
4810	</desc>
4811	<param name="slot" type="unsigned long" dir="in"/>
4812	<param name="port" type="ISerialPort" dir="return"/>
4813	</method>
4814
4815	<method name="getParallelPort" const="yes">
4816	<desc>
4817	Returns the parallel port associated with the given slot.
4818	Slots are numbered sequentially, starting with zero. The total
4819	number of parallel ports per machine is defined by the
4820	<link to="ISystemProperties::parallelPortCount"/> property,
4821	so the maximum slot number is one less than that property's value.
4822
4823	<result name="E_INVALIDARG">
4824	Invalid @a slot number.
4825	</result>
4826
4827	</desc>
4828	<param name="slot" type="unsigned long" dir="in"/>
4829	<param name="port" type="IParallelPort" dir="return"/>
4830	</method>
4831
4832	<method name="getExtraDataKeys">
4833	<desc>
4834	Returns an array representing the machine-specific extra data keys
4835	which currently have values defined.
4836	</desc>
4837	<param name="value" type="wstring" dir="return" safearray="yes">
4838	<desc>Array of extra data keys.</desc>
4839	</param>
4840	</method>
4841
4842	<method name="getExtraData">
4843	<desc>
4844	Returns associated machine-specific extra data.
4845
4846	If the requested data @a key does not exist, this function will
4847	succeed and return an empty string in the @a value argument.
4848
4849	<result name="VBOX_E_FILE_ERROR">
4850	Settings file not accessible.
4851	</result>
4852	<result name="VBOX_E_XML_ERROR">
4853	Could not parse the settings file.
4854	</result>
4855
4856	</desc>
4857	<param name="key" type="wstring" dir="in">
4858	<desc>Name of the data key to get.</desc>
4859	</param>
4860	<param name="value" type="wstring" dir="return">
4861	<desc>Value of the requested data key.</desc>
4862	</param>
4863	</method>
4864
4865	<method name="setExtraData">
4866	<desc>
4867	Sets associated machine-specific extra data.
4868
4869	If you pass @c null or an empty string as a key @a value, the given
4870	@a key will be deleted.
4871
4872	<note>
4873	Before performing the actual data change, this method will ask all
4874	registered listeners using the
4875	<link to="IExtraDataCanChangeEvent"/>
4876	notification for a permission. If one of the listeners refuses the
4877	new value, the change will not be performed.
4878	</note>
4879	<note>
4880	On success, the
4881	<link to="IExtraDataChangedEvent"/> notification
4882	is called to inform all registered listeners about a successful data
4883	change.
4884	</note>
4885	<note>
4886	This method can be called outside the machine session and therefore
4887	it's a caller's responsibility to handle possible race conditions
4888	when several clients change the same key at the same time.
4889	</note>
4890
4891	<result name="VBOX_E_FILE_ERROR">
4892	Settings file not accessible.
4893	</result>
4894	<result name="VBOX_E_XML_ERROR">
4895	Could not parse the settings file.
4896	</result>
4897
4898	</desc>
4899	<param name="key" type="wstring" dir="in">
4900	<desc>Name of the data key to set.</desc>
4901	</param>
4902	<param name="value" type="wstring" dir="in">
4903	<desc>Value to assign to the key.</desc>
4904	</param>
4905	</method>
4906
4907	<method name="getCPUProperty" const="yes">
4908	<desc>
4909	Returns the virtual CPU boolean value of the specified property.
4910
4911	<result name="E_INVALIDARG">
4912	Invalid property.
4913	</result>
4914
4915	</desc>
4916	<param name="property" type="CPUPropertyType" dir="in">
4917	<desc>
4918	Property type to query.
4919	</desc>
4920	</param>
4921	<param name="value" type="boolean" dir="return">
4922	<desc>
4923	Property value.
4924	</desc>
4925	</param>
4926	</method>
4927
4928	<method name="setCPUProperty">
4929	<desc>
4930	Sets the virtual CPU boolean value of the specified property.
4931
4932	<result name="E_INVALIDARG">
4933	Invalid property.
4934	</result>
4935
4936	</desc>
4937	<param name="property" type="CPUPropertyType" dir="in">
4938	<desc>
4939	Property type to query.
4940	</desc>
4941	</param>
4942	<param name="value" type="boolean" dir="in">
4943	<desc>
4944	Property value.
4945	</desc>
4946	</param>
4947	</method>
4948
4949	<method name="getCPUIDLeaf" const="yes">
4950	<desc>
4951	Returns the virtual CPU cpuid information for the specified leaf.
4952
4953	Currently supported index values for cpuid:
4954	Standard CPUID leafs: 0 - 0xA
4955	Extended CPUID leafs: 0x80000000 - 0x8000000A
4956
4957	See the Intel and AMD programmer's manuals for detailed information
4958	about the cpuid instruction and its leafs.
4959	<result name="E_INVALIDARG">
4960	Invalid id.
4961	</result>
4962
4963	</desc>
4964	<param name="id" type="unsigned long" dir="in">
4965	<desc>
4966	CPUID leaf index.
4967	</desc>
4968	</param>
4969	<param name="valEax" type="unsigned long" dir="out">
4970	<desc>
4971	CPUID leaf value for register eax.
4972	</desc>
4973	</param>
4974	<param name="valEbx" type="unsigned long" dir="out">
4975	<desc>
4976	CPUID leaf value for register ebx.
4977	</desc>
4978	</param>
4979	<param name="valEcx" type="unsigned long" dir="out">
4980	<desc>
4981	CPUID leaf value for register ecx.
4982	</desc>
4983	</param>
4984	<param name="valEdx" type="unsigned long" dir="out">
4985	<desc>
4986	CPUID leaf value for register edx.
4987	</desc>
4988	</param>
4989	</method>
4990
4991	<method name="setCPUIDLeaf">
4992	<desc>
4993	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
4994	are not passed unmodified. VirtualBox clears features that it doesn't support.
4995
4996	Currently supported index values for cpuid:
4997	Standard CPUID leafs: 0 - 0xA
4998	Extended CPUID leafs: 0x80000000 - 0x8000000A
4999
5000	See the Intel and AMD programmer's manuals for detailed information
5001	about the cpuid instruction and its leafs.
5002
5003	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5004	random crashes inside VMs.
5005	<result name="E_INVALIDARG">
5006	Invalid id.
5007	</result>
5008
5009	</desc>
5010	<param name="id" type="unsigned long" dir="in">
5011	<desc>
5012	CPUID leaf index.
5013	</desc>
5014	</param>
5015	<param name="valEax" type="unsigned long" dir="in">
5016	<desc>
5017	CPUID leaf value for register eax.
5018	</desc>
5019	</param>
5020	<param name="valEbx" type="unsigned long" dir="in">
5021	<desc>
5022	CPUID leaf value for register ebx.
5023	</desc>
5024	</param>
5025	<param name="valEcx" type="unsigned long" dir="in">
5026	<desc>
5027	CPUID leaf value for register ecx.
5028	</desc>
5029	</param>
5030	<param name="valEdx" type="unsigned long" dir="in">
5031	<desc>
5032	CPUID leaf value for register edx.
5033	</desc>
5034	</param>
5035	</method>
5036
5037	<method name="removeCPUIDLeaf">
5038	<desc>
5039	Removes the virtual CPU cpuid leaf for the specified index
5040
5041	<result name="E_INVALIDARG">
5042	Invalid id.
5043	</result>
5044
5045	</desc>
5046	<param name="id" type="unsigned long" dir="in">
5047	<desc>
5048	CPUID leaf index.
5049	</desc>
5050	</param>
5051	</method>
5052
5053	<method name="removeAllCPUIDLeaves">
5054	<desc>
5055	Removes all the virtual CPU cpuid leaves
5056	</desc>
5057	</method>
5058
5059	<method name="getHWVirtExProperty" const="yes">
5060	<desc>
5061	Returns the value of the specified hardware virtualization boolean property.
5062
5063	<result name="E_INVALIDARG">
5064	Invalid property.
5065	</result>
5066
5067	</desc>
5068	<param name="property" type="HWVirtExPropertyType" dir="in">
5069	<desc>
5070	Property type to query.
5071	</desc>
5072	</param>
5073	<param name="value" type="boolean" dir="return">
5074	<desc>
5075	Property value.
5076	</desc>
5077	</param>
5078	</method>
5079
5080	<method name="setHWVirtExProperty">
5081	<desc>
5082	Sets a new value for the specified hardware virtualization boolean property.
5083
5084	<result name="E_INVALIDARG">
5085	Invalid property.
5086	</result>
5087
5088	</desc>
5089	<param name="property" type="HWVirtExPropertyType" dir="in">
5090	<desc>
5091	Property type to set.
5092	</desc>
5093	</param>
5094	<param name="value" type="boolean" dir="in">
5095	<desc>
5096	New property value.
5097	</desc>
5098	</param>
5099	</method>
5100
5101	<method name="saveSettings">
5102	<desc>
5103	Saves any changes to machine settings made since the session
5104	has been opened or a new machine has been created, or since the
5105	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5106	For registered machines, new settings become visible to all
5107	other VirtualBox clients after successful invocation of this
5108	method.
5109	<note>
5110	The method sends <link to="IMachineDataChangedEvent"/>
5111	notification event after the configuration has been successfully
5112	saved (only for registered machines).
5113	</note>
5114	<note>
5115	Calling this method is only valid on instances returned
5116	by <link to="ISession::machine"/> and on new machines
5117	created by <link to="IVirtualBox::createMachine"/> but not
5118	yet registered, or on unregistered machines after calling
5119	<link to="IMachine::unregister"/>.
5120	</note>
5121
5122	<result name="VBOX_E_FILE_ERROR">
5123	Settings file not accessible.
5124	</result>
5125	<result name="VBOX_E_XML_ERROR">
5126	Could not parse the settings file.
5127	</result>
5128	<result name="E_ACCESSDENIED">
5129	Modification request refused.
5130	</result>
5131
5132	</desc>
5133	</method>
5134
5135	<method name="discardSettings">
5136	<desc>
5137	Discards any changes to the machine settings made since the session
5138	has been opened or since the last call to <link to="#saveSettings"/>
5139	or <link to="#discardSettings"/>.
5140	<note>
5141	Calling this method is only valid on instances returned
5142	by <link to="ISession::machine"/> and on new machines
5143	created by <link to="IVirtualBox::createMachine"/> or
5144	opened by <link to="IVirtualBox::openMachine"/> but not
5145	yet registered, or on unregistered machines after calling
5146	<link to="IMachine::unregister"/>.
5147	</note>
5148
5149	<result name="VBOX_E_INVALID_VM_STATE">
5150	Virtual machine is not mutable.
5151	</result>
5152
5153	</desc>
5154	</method>
5155
5156	<method name="unregister">
5157	<desc>
5158	Unregisters the machine, which must have been previously registered using
5159	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5160	cleanup before the machine is unregistered.
5161
5162	This method does not delete any files. It only changes the machine configuration and
5163	the list of registered machines in the VirtualBox object. To delete the files which
5164	belonged to the machine, including the XML file of the machine itself, call
5165	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5166	from this method.
5167
5168	How thoroughly this method cleans up the machine configuration before unregistering
5169	the machine depends on the @a cleanupMode argument.
5170
5171	<ul>
5172	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5173	cleanup will be performed. The call will fail if the machine is in "Saved" state
5174	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5175	It is the responsibility of the caller to delete all such configuration in this mode.
5176	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5177	which it replaces.</li>
5178	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5179	state or if it has snapshots or media attached. All media attached to the current machine
5180	state or in snapshots will be detached. No medium objects will be returned; all of the
5181	machine's media will remain open.</li>
5182	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5183	except that all the hard disk medium objects which were detached from the machine will
5184	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5185	API for closing and deletion.</li>
5186	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5187	that all media will be returned in the array, including removeable media like DVDs and
5188	floppies. This might be useful if the user wants to inspect in detail which media were
5189	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5190	in that case because users will typically want to preserve ISO and RAW image files.</li>
5191	</ul>
5192
5193	This API does not verify whether the media files returned in the array are still
5194	attached to other machines (i.e. shared between several machines). If such a shared
5195	image is passed to <link to="#delete" /> however, closing the image will fail there
5196	and the image will be silently skipped.
5197
5198	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5199	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5200	deleted with all its saved states and hard disk images, but images for removeable
5201	drives (such as ISO and RAW files) will remain on disk.
5202
5203	The call will fail if the machine is currently locked (see <link to="ISession" />).
5204	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5205	before unregistering it.
5206
5207	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5208	is fired.
5209
5210	<note>
5211	If the given machine is inaccessible (see <link to="#accessible"/>), it
5212	will be unregistered and fully uninitialized right afterwards. As a result,
5213	the returned machine object will be unusable and an attempt to call
5214	<b>any</b> method will return the "Object not ready" error.
5215	</note>
5216
5217	<result name="VBOX_E_INVALID_OBJECT_STATE">
5218	Machine is currently locked for a session.
5219	</result>
5220	</desc>
5221
5222	<param name="cleanupMode" type="CleanupMode" dir="in">
5223	<desc>How to clean up after the machine has been unregistered.</desc>
5224	</param>
5225	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5226	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5227	</param>
5228	</method>
5229
5230	<method name="delete">
5231	<desc>
5232	Deletes the files associated with this machine from disk. If medium objects are passed
5233	in with the @a aMedia argument, they are closed and, if closing was successful, their
5234	storage files are deleted as well. For convenience, this array of media files can be
5235	the same as the one returned from a previous <link to="#unregister" /> call.
5236
5237	This method must only be called on machines which are either write-locked (i.e. on instances
5238	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5239	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5240	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5241
5242	The following files will be deleted by this method:
5243	<ul>
5244	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5245	argument other than "UnregisterOnly", this will delete all saved state files that
5246	the machine had in use; possibly one if the machine was in "Saved" state and one
5247	for each online snapshot that the machine had.</li>
5248	<li>On each medium object passed in the @a aMedia array, this will call
5249	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5250	medium's storage on disk. Since the close() call will fail if the medium is still
5251	in use, e.g. because it is still attached to a second machine; in that case the
5252	storage will not be deleted.</li>
5253	<li>Finally, the machine's own XML file will be deleted.</li>
5254	</ul>
5255
5256	Since deleting large disk image files can be a time-consuming I/O operation, this
5257	method operates asynchronously and returns an IProgress object to allow the caller
5258	to monitor the progress. There will be one sub-operation for each file that is
5259	being deleted (saved state or medium storage file).
5260
5261	<note>
5262	<link to="#settingsModified"/> will return @c true after this
5263	method successfully returns.
5264	</note>
5265
5266	<result name="VBOX_E_INVALID_VM_STATE">
5267	Machine is registered but not write-locked.
5268	</result>
5269	<result name="VBOX_E_IPRT_ERROR">
5270	Could not delete the settings file.
5271	</result>
5272	</desc>
5273	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5274	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5275	</param>
5276	<param name="aProgress" type="IProgress" dir="return">
5277	<desc>Progress object to track the operation completion.</desc>
5278	</param>
5279	</method>
5280
5281	<method name="export">
5282	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5283	steps required to export VirtualBox machines to OVF.
5284	</desc>
5285
5286	<param name="aAppliance" type="IAppliance" dir="in">
5287	<desc>Appliance to export this machine to.</desc>
5288	</param>
5289	<param name="location" type="wstring" dir="in">
5290	<desc>The target location.</desc>
5291	</param>
5292	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5293	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5294	</param>
5295	</method >
5296
5297	<method name="findSnapshot">
5298	<desc>
5299	Returns a snapshot of this machine with the given name or UUID.
5300
5301	Returns a snapshot of this machine with the given UUID.
5302	A @c null argument can be used to obtain the first snapshot
5303	taken on this machine. This is useful if you want to traverse
5304	the whole tree of snapshots starting from the root.
5305
5306	<result name="VBOX_E_OBJECT_NOT_FOUND">
5307	Virtual machine has no snapshots or snapshot not found.
5308	</result>
5309
5310	</desc>
5311	<param name="nameOrId" type="wstring" dir="in">
5312	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5313	</param>
5314	<param name="snapshot" type="ISnapshot" dir="return">
5315	<desc>Snapshot object with the given name.</desc>
5316	</param>
5317	</method>
5318
5319	<method name="createSharedFolder">
5320	<desc>
5321	Creates a new permanent shared folder by associating the given logical
5322	name with the given host path, adds it to the collection of shared
5323	folders and starts sharing it. Refer to the description of
5324	<link to="ISharedFolder"/> to read more about logical names.
5325
5326	<result name="VBOX_E_OBJECT_IN_USE">
5327	Shared folder already exists.
5328	</result>
5329	<result name="VBOX_E_FILE_ERROR">
5330	Shared folder @a hostPath not accessible.
5331	</result>
5332
5333	</desc>
5334	<param name="name" type="wstring" dir="in">
5335	<desc>Unique logical name of the shared folder.</desc>
5336	</param>
5337	<param name="hostPath" type="wstring" dir="in">
5338	<desc>Full path to the shared folder in the host file system.</desc>
5339	</param>
5340	<param name="writable" type="boolean" dir="in">
5341	<desc>Whether the share is writable or readonly.</desc>
5342	</param>
5343	<param name="automount" type="boolean" dir="in">
5344	<desc>Whether the share gets automatically mounted by the guest
5345	or not.</desc>
5346	</param>
5347	</method>
5348
5349	<method name="removeSharedFolder">
5350	<desc>
5351	Removes the permanent shared folder with the given name previously
5352	created by <link to="#createSharedFolder"/> from the collection of
5353	shared folders and stops sharing it.
5354
5355	<result name="VBOX_E_INVALID_VM_STATE">
5356	Virtual machine is not mutable.
5357	</result>
5358	<result name="VBOX_E_OBJECT_NOT_FOUND">
5359	Shared folder @a name does not exist.
5360	</result>
5361
5362	</desc>
5363	<param name="name" type="wstring" dir="in">
5364	<desc>Logical name of the shared folder to remove.</desc>
5365	</param>
5366	</method>
5367
5368	<method name="canShowConsoleWindow">
5369	<desc>
5370	Returns @c true if the VM console process can activate the
5371	console window and bring it to foreground on the desktop of
5372	the host PC.
5373	<note>
5374	This method will fail if a session for this machine is not
5375	currently open.
5376	</note>
5377
5378	<result name="VBOX_E_INVALID_VM_STATE">
5379	Machine session is not open.
5380	</result>
5381
5382	</desc>
5383	<param name="canShow" type="boolean" dir="return">
5384	<desc>
5385	@c true if the console window can be shown and @c false otherwise.
5386	</desc>
5387	</param>
5388	</method>
5389
5390	<method name="showConsoleWindow">
5391	<desc>
5392	Activates the console window and brings it to foreground on
5393	the desktop of the host PC. Many modern window managers on
5394	many platforms implement some sort of focus stealing
5395	prevention logic, so that it may be impossible to activate
5396	a window without the help of the currently active
5397	application. In this case, this method will return a non-zero
5398	identifier that represents the top-level window of the VM
5399	console process. The caller, if it represents a currently
5400	active process, is responsible to use this identifier (in a
5401	platform-dependent manner) to perform actual window
5402	activation.
5403	<note>
5404	This method will fail if a session for this machine is not
5405	currently open.
5406	</note>
5407
5408	<result name="VBOX_E_INVALID_VM_STATE">
5409	Machine session is not open.
5410	</result>
5411
5412	</desc>
5413	<param name="winId" type="long long" dir="return">
5414	<desc>
5415	Platform-dependent identifier of the top-level VM console
5416	window, or zero if this method has performed all actions
5417	necessary to implement the <i>show window</i> semantics for
5418	the given platform and/or VirtualBox front-end.
5419	</desc>
5420	</param>
5421	</method>
5422
5423	<method name="getGuestProperty" const="yes">
5424	<desc>
5425	Reads an entry from the machine's guest property store.
5426
5427	<result name="VBOX_E_INVALID_VM_STATE">
5428	Machine session is not open.
5429	</result>
5430
5431	</desc>
5432	<param name="name" type="wstring" dir="in">
5433	<desc>
5434	The name of the property to read.
5435	</desc>
5436	</param>
5437	<param name="value" type="wstring" dir="out">
5438	<desc>
5439	The value of the property. If the property does not exist then this
5440	will be empty.
5441	</desc>
5442	</param>
5443	<param name="timestamp" type="long long" dir="out">
5444	<desc>
5445	The time at which the property was last modified, as seen by the
5446	server process.
5447	</desc>
5448	</param>
5449	<param name="flags" type="wstring" dir="out">
5450	<desc>
5451	Additional property parameters, passed as a comma-separated list of
5452	"name=value" type entries.
5453	</desc>
5454	</param>
5455	</method>
5456
5457	<method name="getGuestPropertyValue" const="yes">
5458	<desc>
5459	Reads a value from the machine's guest property store.
5460
5461	<result name="VBOX_E_INVALID_VM_STATE">
5462	Machine session is not open.
5463	</result>
5464
5465	</desc>
5466	<param name="property" type="wstring" dir="in">
5467	<desc>
5468	The name of the property to read.
5469	</desc>
5470	</param>
5471	<param name="value" type="wstring" dir="return">
5472	<desc>
5473	The value of the property. If the property does not exist then this
5474	will be empty.
5475	</desc>
5476	</param>
5477	</method>
5478
5479	<method name="getGuestPropertyTimestamp" const="yes">
5480	<desc>
5481	Reads a property timestamp from the machine's guest property store.
5482
5483	<result name="VBOX_E_INVALID_VM_STATE">
5484	Machine session is not open.
5485	</result>
5486
5487	</desc>
5488	<param name="property" type="wstring" dir="in">
5489	<desc>
5490	The name of the property to read.
5491	</desc>
5492	</param>
5493	<param name="value" type="long long" dir="return">
5494	<desc>
5495	The timestamp. If the property does not exist then this will be
5496	empty.
5497	</desc>
5498	</param>
5499	</method>
5500
5501	<method name="setGuestProperty">
5502	<desc>
5503	Sets, changes or deletes an entry in the machine's guest property
5504	store.
5505
5506	<result name="E_ACCESSDENIED">
5507	Property cannot be changed.
5508	</result>
5509	<result name="E_INVALIDARG">
5510	Invalid @a flags.
5511	</result>
5512	<result name="VBOX_E_INVALID_VM_STATE">
5513	Virtual machine is not mutable or session not open.
5514	</result>
5515	<result name="VBOX_E_INVALID_OBJECT_STATE">
5516	Cannot set transient property when machine not running.
5517	</result>
5518
5519	</desc>
5520	<param name="property" type="wstring" dir="in">
5521	<desc>
5522	The name of the property to set, change or delete.
5523	</desc>
5524	</param>
5525	<param name="value" type="wstring" dir="in">
5526	<desc>
5527	The new value of the property to set, change or delete. If the
5528	property does not yet exist and value is non-empty, it will be
5529	created. If the value is @c null or empty, the property will be
5530	deleted if it exists.
5531	</desc>
5532	</param>
5533	<param name="flags" type="wstring" dir="in">
5534	<desc>
5535	Additional property parameters, passed as a comma-separated list of
5536	"name=value" type entries.
5537	</desc>
5538	</param>
5539	</method>
5540
5541	<method name="setGuestPropertyValue">
5542	<desc>
5543	Sets, changes or deletes a value in the machine's guest property
5544	store. The flags field will be left unchanged or created empty for a
5545	new property.
5546
5547	<result name="E_ACCESSDENIED">
5548	Property cannot be changed.
5549	</result>
5550	<result name="VBOX_E_INVALID_VM_STATE">
5551	Virtual machine is not mutable or session not open.
5552	</result>
5553	<result name="VBOX_E_INVALID_OBJECT_STATE">
5554	Cannot set transient property when machine not running.
5555	</result>
5556	</desc>
5557
5558	<param name="property" type="wstring" dir="in">
5559	<desc>
5560	The name of the property to set, change or delete.
5561	</desc>
5562	</param>
5563	<param name="value" type="wstring" dir="in">
5564	<desc>
5565	The new value of the property to set, change or delete. If the
5566	property does not yet exist and value is non-empty, it will be
5567	created. If the value is @c null or empty, the property will be
5568	deleted if it exists.
5569	</desc>
5570	</param>
5571	</method>
5572
5573	<method name="enumerateGuestProperties">
5574	<desc>
5575	Return a list of the guest properties matching a set of patterns along
5576	with their values, time stamps and flags.
5577	</desc>
5578	<param name="patterns" type="wstring" dir="in">
5579	<desc>
5580	The patterns to match the properties against, separated by '\|'
5581	characters. If this is empty or @c null, all properties will match.
5582	</desc>
5583	</param>
5584	<param name="name" type="wstring" dir="out" safearray="yes">
5585	<desc>
5586	The names of the properties returned.
5587	</desc>
5588	</param>
5589	<param name="value" type="wstring" dir="out" safearray="yes">
5590	<desc>
5591	The values of the properties returned. The array entries match the
5592	corresponding entries in the @a name array.
5593	</desc>
5594	</param>
5595	<param name="timestamp" type="long long" dir="out" safearray="yes">
5596	<desc>
5597	The time stamps of the properties returned. The array entries match
5598	the corresponding entries in the @a name array.
5599	</desc>
5600	</param>
5601	<param name="flags" type="wstring" dir="out" safearray="yes">
5602	<desc>
5603	The flags of the properties returned. The array entries match the
5604	corresponding entries in the @a name array.
5605	</desc>
5606	</param>
5607	</method>
5608
5609	<method name="querySavedGuestSize">
5610	<desc>
5611	Returns the guest dimensions from the saved state.
5612	</desc>
5613	<param name="screenId" type="unsigned long" dir="in">
5614	<desc>
5615	Saved guest screen to query info from.
5616	</desc>
5617	</param>
5618	<param name="width" type="unsigned long" dir="out">
5619	<desc>
5620	Guest width at the time of the saved state was taken.
5621	</desc>
5622	</param>
5623	<param name="height" type="unsigned long" dir="out">
5624	<desc>
5625	Guest height at the time of the saved state was taken.
5626	</desc>
5627	</param>
5628	</method>
5629
5630	<method name="querySavedThumbnailSize">
5631	<desc>
5632	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5633	</desc>
5634	<param name="screenId" type="unsigned long" dir="in">
5635	<desc>
5636	Saved guest screen to query info from.
5637	</desc>
5638	</param>
5639	<param name="size" type="unsigned long" dir="out">
5640	<desc>
5641	Size of buffer required to store the bitmap.
5642	</desc>
5643	</param>
5644	<param name="width" type="unsigned long" dir="out">
5645	<desc>
5646	Bitmap width.
5647	</desc>
5648	</param>
5649	<param name="height" type="unsigned long" dir="out">
5650	<desc>
5651	Bitmap height.
5652	</desc>
5653	</param>
5654	</method>
5655
5656	<method name="readSavedThumbnailToArray">
5657	<desc>
5658	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5659	</desc>
5660	<param name="screenId" type="unsigned long" dir="in">
5661	<desc>
5662	Saved guest screen to read from.
5663	</desc>
5664	</param>
5665	<param name="BGR" type="boolean" dir="in">
5666	<desc>
5667	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5668	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5669	</desc>
5670	</param>
5671	<param name="width" type="unsigned long" dir="out">
5672	<desc>
5673	Bitmap width.
5674	</desc>
5675	</param>
5676	<param name="height" type="unsigned long" dir="out">
5677	<desc>
5678	Bitmap height.
5679	</desc>
5680	</param>
5681	<param name="data" type="octet" safearray="yes" dir="return">
5682	<desc>
5683	Array with resulting bitmap data.
5684	</desc>
5685	</param>
5686	</method>
5687
5688	<method name="readSavedThumbnailPNGToArray">
5689	<desc>
5690	Thumbnail in PNG format is retrieved to an array of bytes.
5691	</desc>
5692	<param name="screenId" type="unsigned long" dir="in">
5693	<desc>
5694	Saved guest screen to read from.
5695	</desc>
5696	</param>
5697	<param name="width" type="unsigned long" dir="out">
5698	<desc>
5699	Image width.
5700	</desc>
5701	</param>
5702	<param name="height" type="unsigned long" dir="out">
5703	<desc>
5704	Image height.
5705	</desc>
5706	</param>
5707	<param name="data" type="octet" dir="return" safearray="yes">
5708	<desc>
5709	Array with resulting PNG data.
5710	</desc>
5711	</param>
5712	</method>
5713
5714	<method name="querySavedScreenshotPNGSize">
5715	<desc>
5716	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5717	</desc>
5718	<param name="screenId" type="unsigned long" dir="in">
5719	<desc>
5720	Saved guest screen to query info from.
5721	</desc>
5722	</param>
5723	<param name="size" type="unsigned long" dir="out">
5724	<desc>
5725	Size of buffer required to store the PNG binary data.
5726	</desc>
5727	</param>
5728	<param name="width" type="unsigned long" dir="out">
5729	<desc>
5730	Image width.
5731	</desc>
5732	</param>
5733	<param name="height" type="unsigned long" dir="out">
5734	<desc>
5735	Image height.
5736	</desc>
5737	</param>
5738	</method>
5739
5740	<method name="readSavedScreenshotPNGToArray">
5741	<desc>
5742	Screenshot in PNG format is retrieved to an array of bytes.
5743	</desc>
5744	<param name="screenId" type="unsigned long" dir="in">
5745	<desc>
5746	Saved guest screen to read from.
5747	</desc>
5748	</param>
5749	<param name="width" type="unsigned long" dir="out">
5750	<desc>
5751	Image width.
5752	</desc>
5753	</param>
5754	<param name="height" type="unsigned long" dir="out">
5755	<desc>
5756	Image height.
5757	</desc>
5758	</param>
5759	<param name="data" type="octet" dir="return" safearray="yes">
5760	<desc>
5761	Array with resulting PNG data.
5762	</desc>
5763	</param>
5764	</method>
5765
5766	<method name="hotPlugCPU">
5767	<desc>
5768	Plugs a CPU into the machine.
5769	</desc>
5770	<param name="cpu" type="unsigned long" dir="in">
5771	<desc>
5772	The CPU id to insert.
5773	</desc>
5774	</param>
5775	</method>
5776
5777	<method name="hotUnplugCPU">
5778	<desc>
5779	Removes a CPU from the machine.
5780	</desc>
5781	<param name="cpu" type="unsigned long" dir="in">
5782	<desc>
5783	The CPU id to remove.
5784	</desc>
5785	</param>
5786	</method>
5787
5788	<method name="getCPUStatus">
5789	<desc>
5790	Returns the current status of the given CPU.
5791	</desc>
5792	<param name="cpu" type="unsigned long" dir="in">
5793	<desc>
5794	The CPU id to check for.
5795	</desc>
5796	</param>
5797	<param name="attached" type="boolean" dir="return">
5798	<desc>
5799	Status of the CPU.
5800	</desc>
5801	</param>
5802	</method>
5803
5804	<method name="queryLogFilename">
5805	<desc>
5806	Queries for the VM log file name of an given index. Returns an empty
5807	string if a log file with that index doesn't exists.
5808	</desc>
5809	<param name="idx" type="unsigned long" dir="in">
5810	<desc>
5811	Which log file name to query. 0=current log file.
5812	</desc>
5813	</param>
5814	<param name="filename" type="wstring" dir="return">
5815	<desc>
5816	On return the full path to the log file or an empty string on error.
5817	</desc>
5818	</param>
5819	</method>
5820
5821	<method name="readLog">
5822	<desc>
5823	Reads the VM log file. The chunk size is limited, so even if you
5824	ask for a big piece there might be less data returned.
5825	</desc>
5826	<param name="idx" type="unsigned long" dir="in">
5827	<desc>
5828	Which log file to read. 0=current log file.
5829	</desc>
5830	</param>
5831	<param name="offset" type="long long" dir="in">
5832	<desc>
5833	Offset in the log file.
5834	</desc>
5835	</param>
5836	<param name="size" type="long long" dir="in">
5837	<desc>
5838	Chunk size to read in the log file.
5839	</desc>
5840	</param>
5841	<param name="data" type="octet" dir="return" safearray="yes">
5842	<desc>
5843	Data read from the log file. A data size of 0 means end of file
5844	if the requested chunk size was not 0. This is the unprocessed
5845	file data, i.e. the line ending style depends on the platform of
5846	the system the server is running on.
5847	</desc>
5848	</param>
5849	</method>
5850	</interface>
5851
5852	<!--
5853	// IConsole
5854	/////////////////////////////////////////////////////////////////////////
5855	-->
5856
5857	<interface
5858	name="IVRDEServerInfo" extends="$unknown"
5859	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5860	wsmap="struct"
5861	>
5862	<desc>
5863	Contains information about the remote desktop (VRDE) server capabilities and status.
5864	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5865	</desc>
5866
5867	<attribute name="active" type="boolean" readonly="yes">
5868	<desc>
5869	Whether the remote desktop connection is active.
5870	</desc>
5871	</attribute>
5872
5873	<attribute name="port" type="long" readonly="yes">
5874	<desc>
5875	VRDE server port number. If this property is equal to <tt>0</tt>, then
5876	the VRDE server failed to start, usually because there are no free IP
5877	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5878	server has not yet been started.
5879	</desc>
5880	</attribute>
5881
5882	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5883	<desc>
5884	How many times a client connected.
5885	</desc>
5886	</attribute>
5887
5888	<attribute name="beginTime" type="long long" readonly="yes">
5889	<desc>
5890	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5891	</desc>
5892	</attribute>
5893
5894	<attribute name="endTime" type="long long" readonly="yes">
5895	<desc>
5896	When the last connection was terminated or the current time, if
5897	connection is still active, in milliseconds since 1970-01-01 UTC.
5898	</desc>
5899	</attribute>
5900
5901	<attribute name="bytesSent" type="long long" readonly="yes">
5902	<desc>
5903	How many bytes were sent in last or current, if still active, connection.
5904	</desc>
5905	</attribute>
5906
5907	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5908	<desc>
5909	How many bytes were sent in all connections.
5910	</desc>
5911	</attribute>
5912
5913	<attribute name="bytesReceived" type="long long" readonly="yes">
5914	<desc>
5915	How many bytes were received in last or current, if still active, connection.
5916	</desc>
5917	</attribute>
5918
5919	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5920	<desc>
5921	How many bytes were received in all connections.
5922	</desc>
5923	</attribute>
5924
5925	<attribute name="user" type="wstring" readonly="yes">
5926	<desc>
5927	Login user name supplied by the client.
5928	</desc>
5929	</attribute>
5930
5931	<attribute name="domain" type="wstring" readonly="yes">
5932	<desc>
5933	Login domain name supplied by the client.
5934	</desc>
5935	</attribute>
5936
5937	<attribute name="clientName" type="wstring" readonly="yes">
5938	<desc>
5939	The client name supplied by the client.
5940	</desc>
5941	</attribute>
5942
5943	<attribute name="clientIP" type="wstring" readonly="yes">
5944	<desc>
5945	The IP address of the client.
5946	</desc>
5947	</attribute>
5948
5949	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5950	<desc>
5951	The client software version number.
5952	</desc>
5953	</attribute>
5954
5955	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5956	<desc>
5957	Public key exchange method used when connection was established.
5958	Values: 0 - RDP4 public key exchange scheme.
5959	1 - X509 certificates were sent to client.
5960	</desc>
5961	</attribute>
5962
5963	</interface>
5964
5965	<interface
5966	name="IConsole" extends="$unknown"
5967	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
5968	wsmap="managed"
5969	>
5970	<desc>
5971	The IConsole interface represents an interface to control virtual
5972	machine execution.
5973
5974	A console object gets created when a machine has been locked for a
5975	particular session (client process) using <link to="IMachine::lockMachine" />
5976	or <link to="IMachine::launchVMProcess"/>. The console object can
5977	then be found in the session's <link to="ISession::console" /> attribute.
5978
5979	Methods of the IConsole interface allow the caller to query the current
5980	virtual machine execution state, pause the machine or power it down, save
5981	the machine state or take a snapshot, attach and detach removable media
5982	and so on.
5983
5984	<see>ISession</see>
5985	</desc>
5986
5987	<attribute name="machine" type="IMachine" readonly="yes">
5988	<desc>
5989	Machine object for this console session.
5990	<note>
5991	This is a convenience property, it has the same value as
5992	<link to="ISession::machine"/> of the corresponding session
5993	object.
5994	</note>
5995	</desc>
5996	</attribute>
5997
5998	<attribute name="state" type="MachineState" readonly="yes">
5999	<desc>
6000	Current execution state of the machine.
6001	<note>
6002	This property always returns the same value as the corresponding
6003	property of the IMachine object for this console session.
6004	For the process that owns (executes) the VM, this is the
6005	preferable way of querying the VM state, because no IPC
6006	calls are made.
6007	</note>
6008	</desc>
6009	</attribute>
6010
6011	<attribute name="guest" type="IGuest" readonly="yes">
6012	<desc>Guest object.</desc>
6013	</attribute>
6014
6015	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6016	<desc>
6017	Virtual keyboard object.
6018	<note>
6019	If the machine is not running, any attempt to use
6020	the returned object will result in an error.
6021	</note>
6022	</desc>
6023	</attribute>
6024
6025	<attribute name="mouse" type="IMouse" readonly="yes">
6026	<desc>
6027	Virtual mouse object.
6028	<note>
6029	If the machine is not running, any attempt to use
6030	the returned object will result in an error.
6031	</note>
6032	</desc>
6033	</attribute>
6034
6035	<attribute name="display" type="IDisplay" readonly="yes">
6036	<desc>Virtual display object.
6037	<note>
6038	If the machine is not running, any attempt to use
6039	the returned object will result in an error.
6040	</note>
6041	</desc>
6042	</attribute>
6043
6044	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6045	<desc>Debugging interface.</desc>
6046	</attribute>
6047
6048	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6049	<desc>
6050	Collection of USB devices currently attached to the virtual
6051	USB controller.
6052	<note>
6053	The collection is empty if the machine is not running.
6054	</note>
6055	</desc>
6056	</attribute>
6057
6058	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6059	<desc>
6060	List of USB devices currently attached to the remote VRDE client.
6061	Once a new device is physically attached to the remote host computer,
6062	it appears in this list and remains there until detached.
6063	</desc>
6064	</attribute>
6065
6066	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6067	<desc>
6068	Collection of shared folders for the current session. These folders
6069	are called transient shared folders because they are available to the
6070	guest OS running inside the associated virtual machine only for the
6071	duration of the session (as opposed to
6072	<link to="IMachine::sharedFolders"/> which represent permanent shared
6073	folders). When the session is closed (e.g. the machine is powered down),
6074	these folders are automatically discarded.
6075
6076	New shared folders are added to the collection using
6077	<link to="#createSharedFolder"/>. Existing shared folders can be
6078	removed using <link to="#removeSharedFolder"/>.
6079	</desc>
6080	</attribute>
6081
6082	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6083	<desc>
6084	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6085	</desc>
6086	</attribute>
6087
6088	<attribute name="eventSource" type="IEventSource" readonly="yes">
6089	<desc>
6090	Event source for console events.
6091	</desc>
6092	</attribute>
6093
6094	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6095	<desc>Array of PCI devices attached to this machine.</desc>
6096	</attribute>
6097
6098	<method name="powerUp">
6099	<desc>
6100	Starts the virtual machine execution using the current machine
6101	state (that is, its current execution state, current settings and
6102	current storage devices).
6103
6104	<note>
6105	This method is only useful for front-ends that want to actually
6106	execute virtual machines in their own process (like the VirtualBox
6107	or VBoxSDL front-ends). Unless you are intending to write such a
6108	front-end, do not call this method. If you simply want to
6109	start virtual machine execution using one of the existing front-ends
6110	(for example the VirtualBox GUI or headless server), use
6111	<link to="IMachine::launchVMProcess"/> instead; these
6112	front-ends will power up the machine automatically for you.
6113	</note>
6114
6115	If the machine is powered off or aborted, the execution will
6116	start from the beginning (as if the real hardware were just
6117	powered on).
6118
6119	If the machine is in the <link to="MachineState_Saved"/> state,
6120	it will continue its execution the point where the state has
6121	been saved.
6122
6123	If the machine <link to="IMachine::teleporterEnabled"/> property is
6124	enabled on the machine being powered up, the machine will wait for an
6125	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6126	state. The returned progress object will have at least three
6127	operations where the last three are defined as: (1) powering up and
6128	starting TCP server, (2) waiting for incoming teleportations, and
6129	(3) perform teleportation. These operations will be reflected as the
6130	last three operations of the progress objected returned by
6131	<link to="IMachine::launchVMProcess"/> as well.
6132
6133	<see>#saveState</see>
6134
6135	<result name="VBOX_E_INVALID_VM_STATE">
6136	Virtual machine already running.
6137	</result>
6138	<result name="VBOX_E_HOST_ERROR">
6139	Host interface does not exist or name not set.
6140	</result>
6141	<result name="VBOX_E_FILE_ERROR">
6142	Invalid saved state file.
6143	</result>
6144	</desc>
6145	<param name="progress" type="IProgress" dir="return">
6146	<desc>Progress object to track the operation completion.</desc>
6147	</param>
6148	</method>
6149
6150	<method name="powerUpPaused">
6151	<desc>
6152	Identical to powerUp except that the VM will enter the
6153	<link to="MachineState_Paused"/> state, instead of
6154	<link to="MachineState_Running"/>.
6155
6156	<see>#powerUp</see>
6157	<result name="VBOX_E_INVALID_VM_STATE">
6158	Virtual machine already running.
6159	</result>
6160	<result name="VBOX_E_HOST_ERROR">
6161	Host interface does not exist or name not set.
6162	</result>
6163	<result name="VBOX_E_FILE_ERROR">
6164	Invalid saved state file.
6165	</result>
6166	</desc>
6167	<param name="progress" type="IProgress" dir="return">
6168	<desc>Progress object to track the operation completion.</desc>
6169	</param>
6170	</method>
6171
6172	<method name="powerDown">
6173	<desc>
6174	Initiates the power down procedure to stop the virtual machine
6175	execution.
6176
6177	The completion of the power down procedure is tracked using the returned
6178	IProgress object. After the operation is complete, the machine will go
6179	to the PoweredOff state.
6180	<result name="VBOX_E_INVALID_VM_STATE">
6181	Virtual machine must be Running, Paused or Stuck to be powered down.
6182	</result>
6183	</desc>
6184	<param name="progress" type="IProgress" dir="return">
6185	<desc>Progress object to track the operation completion.</desc>
6186	</param>
6187	</method>
6188
6189	<method name="reset">
6190	<desc>Resets the virtual machine.
6191	<result name="VBOX_E_INVALID_VM_STATE">
6192	Virtual machine not in Running state.
6193	</result>
6194	<result name="VBOX_E_VM_ERROR">
6195	Virtual machine error in reset operation.
6196	</result>
6197	</desc>
6198	</method>
6199
6200	<method name="pause">
6201	<desc>Pauses the virtual machine execution.
6202	<result name="VBOX_E_INVALID_VM_STATE">
6203	Virtual machine not in Running state.
6204	</result>
6205	<result name="VBOX_E_VM_ERROR">
6206	Virtual machine error in suspend operation.
6207	</result>
6208	</desc>
6209	</method>
6210
6211	<method name="resume">
6212	<desc>Resumes the virtual machine execution.
6213	<result name="VBOX_E_INVALID_VM_STATE">
6214	Virtual machine not in Paused state.
6215	</result>
6216	<result name="VBOX_E_VM_ERROR">
6217	Virtual machine error in resume operation.
6218	</result>
6219	</desc>
6220	</method>
6221
6222	<method name="powerButton">
6223	<desc>Sends the ACPI power button event to the guest.
6224	<result name="VBOX_E_INVALID_VM_STATE">
6225	Virtual machine not in Running state.
6226	</result>
6227	<result name="VBOX_E_PDM_ERROR">
6228	Controlled power off failed.
6229	</result>
6230	</desc>
6231	</method>
6232
6233	<method name="sleepButton">
6234	<desc>Sends the ACPI sleep button event to the guest.
6235	<result name="VBOX_E_INVALID_VM_STATE">
6236	Virtual machine not in Running state.
6237	</result>
6238	<result name="VBOX_E_PDM_ERROR">
6239	Sending sleep button event failed.
6240	</result>
6241	</desc>
6242	</method>
6243
6244	<method name="getPowerButtonHandled">
6245	<desc>Checks if the last power button event was handled by guest.
6246	<result name="VBOX_E_PDM_ERROR">
6247	Checking if the event was handled by the guest OS failed.
6248	</result>
6249	</desc>
6250	<param name="handled" type="boolean" dir="return"/>
6251	</method>
6252
6253	<method name="getGuestEnteredACPIMode">
6254	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6255	G1 (sleeping). If this method returns @c false, the guest will
6256	most likely not respond to external ACPI events.
6257	<result name="VBOX_E_INVALID_VM_STATE">
6258	Virtual machine not in Running state.
6259	</result>
6260	</desc>
6261	<param name="entered" type="boolean" dir="return"/>
6262	</method>
6263
6264	<method name="saveState">
6265	<desc>
6266	Saves the current execution state of a running virtual machine
6267	and stops its execution.
6268
6269	After this operation completes, the machine will go to the
6270	Saved state. Next time it is powered up, this state will
6271	be restored and the machine will continue its execution from
6272	the place where it was saved.
6273
6274	This operation differs from taking a snapshot to the effect
6275	that it doesn't create new differencing media. Also, once
6276	the machine is powered up from the state saved using this method,
6277	the saved state is deleted, so it will be impossible to return
6278	to this state later.
6279
6280	<note>
6281	On success, this method implicitly calls
6282	<link to="IMachine::saveSettings"/> to save all current machine
6283	settings (including runtime changes to the DVD medium, etc.).
6284	Together with the impossibility to change any VM settings when it is
6285	in the Saved state, this guarantees adequate hardware
6286	configuration of the machine when it is restored from the saved
6287	state file.
6288	</note>
6289
6290	<note>
6291	The machine must be in the Running or Paused state, otherwise
6292	the operation will fail.
6293	</note>
6294	<result name="VBOX_E_INVALID_VM_STATE">
6295	Virtual machine state neither Running nor Paused.
6296	</result>
6297	<result name="VBOX_E_FILE_ERROR">
6298	Failed to create directory for saved state file.
6299	</result>
6300
6301	<see><link to="#takeSnapshot"/></see>
6302	</desc>
6303	<param name="progress" type="IProgress" dir="return">
6304	<desc>Progress object to track the operation completion.</desc>
6305	</param>
6306	</method>
6307
6308	<method name="adoptSavedState">
6309	<desc>
6310	Associates the given saved state file to the virtual machine.
6311
6312	On success, the machine will go to the Saved state. Next time it is
6313	powered up, it will be restored from the adopted saved state and
6314	continue execution from the place where the saved state file was
6315	created.
6316
6317	The specified saved state file path may be absolute or relative to the
6318	folder the VM normally saves the state to (usually,
6319	<link to="IMachine::snapshotFolder"/>).
6320
6321	<note>
6322	It's a caller's responsibility to make sure the given saved state
6323	file is compatible with the settings of this virtual machine that
6324	represent its virtual hardware (memory size, storage disk configuration
6325	etc.). If there is a mismatch, the behavior of the virtual machine
6326	is undefined.
6327	</note>
6328	<result name="VBOX_E_INVALID_VM_STATE">
6329	Virtual machine state neither PoweredOff nor Aborted.
6330	</result>
6331	</desc>
6332	<param name="savedStateFile" type="wstring" dir="in">
6333	<desc>Path to the saved state file to adopt.</desc>
6334	</param>
6335	</method>
6336
6337	<method name="discardSavedState">
6338	<desc>
6339	Forcibly resets the machine to "Powered Off" state if it is
6340	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6341	Next time the machine is powered up, a clean boot will occur.
6342	<note>
6343	This operation is equivalent to resetting or powering off
6344	the machine without doing a proper shutdown of the guest
6345	operating system; as with resetting a running phyiscal
6346	computer, it can can lead to data loss.
6347	</note>
6348	If @a fRemoveFile is @c true, the file in the machine directory
6349	into which the machine state was saved is also deleted. If
6350	this is @c false, then the state can be recovered and later
6351	re-inserted into a machine using <link to="#adoptSavedState" />.
6352	The location of the file can be found in the
6353	<link to="IMachine::stateFilePath" /> attribute.
6354	<result name="VBOX_E_INVALID_VM_STATE">
6355	Virtual machine not in state Saved.
6356	</result>
6357	</desc>
6358	<param name="fRemoveFile" type="boolean" dir="in" >
6359	<desc>Whether to also remove the saved state file.</desc>
6360	</param>
6361	</method>
6362
6363	<method name="getDeviceActivity">
6364	<desc>
6365	Gets the current activity type of a given device or device group.
6366	<result name="E_INVALIDARG">
6367	Invalid device type.
6368	</result>
6369	</desc>
6370	<param name="type" type="DeviceType" dir="in"/>
6371	<param name="activity" type="DeviceActivity" dir="return"/>
6372	</method>
6373
6374	<method name="attachUSBDevice">
6375	<desc>
6376	Attaches a host USB device with the given UUID to the
6377	USB controller of the virtual machine.
6378
6379	The device needs to be in one of the following states:
6380	<link to="USBDeviceState_Busy"/>,
6381	<link to="USBDeviceState_Available"/> or
6382	<link to="USBDeviceState_Held"/>,
6383	otherwise an error is immediately returned.
6384
6385	When the device state is
6386	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6387	be returned if the host computer refuses to release it for some reason.
6388
6389	<see>IUSBController::deviceFilters, USBDeviceState</see>
6390	<result name="VBOX_E_INVALID_VM_STATE">
6391	Virtual machine state neither Running nor Paused.
6392	</result>
6393	<result name="VBOX_E_PDM_ERROR">
6394	Virtual machine does not have a USB controller.
6395	</result>
6396	</desc>
6397	<param name="id" type="uuid" mod="string" dir="in">
6398	<desc>UUID of the host USB device to attach.</desc>
6399	</param>
6400	</method>
6401
6402	<method name="detachUSBDevice">
6403	<desc>
6404	Detaches an USB device with the given UUID from the USB controller
6405	of the virtual machine.
6406
6407	After this method succeeds, the VirtualBox server re-initiates
6408	all USB filters as if the device were just physically attached
6409	to the host, but filters of this machine are ignored to avoid
6410	a possible automatic re-attachment.
6411
6412	<see>IUSBController::deviceFilters, USBDeviceState</see>
6413
6414	<result name="VBOX_E_PDM_ERROR">
6415	Virtual machine does not have a USB controller.
6416	</result>
6417	<result name="E_INVALIDARG">
6418	USB device not attached to this virtual machine.
6419	</result>
6420	</desc>
6421	<param name="id" type="uuid" mod="string" dir="in">
6422	<desc>UUID of the USB device to detach.</desc>
6423	</param>
6424	<param name="device" type="IUSBDevice" dir="return">
6425	<desc>Detached USB device.</desc>
6426	</param>
6427	</method>
6428
6429	<method name="findUSBDeviceByAddress">
6430	<desc>
6431	Searches for a USB device with the given host address.
6432
6433	<result name="VBOX_E_OBJECT_NOT_FOUND">
6434	Given @c name does not correspond to any USB device.
6435	</result>
6436
6437	<see>IUSBDevice::address</see>
6438	</desc>
6439	<param name="name" type="wstring" dir="in">
6440	<desc>
6441	Address of the USB device (as assigned by the host) to
6442	search for.
6443	</desc>
6444	</param>
6445	<param name="device" type="IUSBDevice" dir="return">
6446	<desc>Found USB device object.</desc>
6447	</param>
6448	</method>
6449
6450	<method name="findUSBDeviceById">
6451	<desc>
6452	Searches for a USB device with the given UUID.
6453
6454	<result name="VBOX_E_OBJECT_NOT_FOUND">
6455	Given @c id does not correspond to any USB device.
6456	</result>
6457
6458	<see>IUSBDevice::id</see>
6459	</desc>
6460	<param name="id" type="uuid" mod="string" dir="in">
6461	<desc>UUID of the USB device to search for.</desc>
6462	</param>
6463	<param name="device" type="IUSBDevice" dir="return">
6464	<desc>Found USB device object.</desc>
6465	</param>
6466	</method>
6467
6468	<method name="createSharedFolder">
6469	<desc>
6470	Creates a transient new shared folder by associating the given logical
6471	name with the given host path, adds it to the collection of shared
6472	folders and starts sharing it. Refer to the description of
6473	<link to="ISharedFolder"/> to read more about logical names.
6474
6475	<result name="VBOX_E_INVALID_VM_STATE">
6476	Virtual machine in Saved state or currently changing state.
6477	</result>
6478	<result name="VBOX_E_FILE_ERROR">
6479	Shared folder already exists or not accessible.
6480	</result>
6481	</desc>
6482	<param name="name" type="wstring" dir="in">
6483	<desc>Unique logical name of the shared folder.</desc>
6484	</param>
6485	<param name="hostPath" type="wstring" dir="in">
6486	<desc>Full path to the shared folder in the host file system.</desc>
6487	</param>
6488	<param name="writable" type="boolean" dir="in">
6489	<desc>Whether the share is writable or readonly</desc>
6490	</param>
6491	<param name="automount" type="boolean" dir="in">
6492	<desc>Whether the share gets automatically mounted by the guest
6493	or not.</desc>
6494	</param>
6495	</method>
6496
6497	<method name="removeSharedFolder">
6498	<desc>
6499	Removes a transient shared folder with the given name previously
6500	created by <link to="#createSharedFolder"/> from the collection of
6501	shared folders and stops sharing it.
6502	<result name="VBOX_E_INVALID_VM_STATE">
6503	Virtual machine in Saved state or currently changing state.
6504	</result>
6505	<result name="VBOX_E_FILE_ERROR">
6506	Shared folder does not exists.
6507	</result>
6508	</desc>
6509	<param name="name" type="wstring" dir="in">
6510	<desc>Logical name of the shared folder to remove.</desc>
6511	</param>
6512	</method>
6513
6514	<method name="takeSnapshot">
6515	<desc>
6516	Saves the current execution state
6517	and all settings of the machine and creates differencing images
6518	for all normal (non-independent) media.
6519	See <link to="ISnapshot" /> for an introduction to snapshots.
6520
6521	This method can be called for a PoweredOff, Saved (see
6522	<link to="#saveState"/>), Running or
6523	Paused virtual machine. When the machine is PoweredOff, an
6524	offline snapshot is created. When the machine is Running a live
6525	snapshot is created, and an online snapshot is is created when Paused.
6526
6527	The taken snapshot is always based on the
6528	<link to="IMachine::currentSnapshot">current snapshot</link>
6529	of the associated virtual machine and becomes a new current snapshot.
6530
6531	<note>
6532	This method implicitly calls <link to="IMachine::saveSettings"/> to
6533	save all current machine settings before taking an offline snapshot.
6534	</note>
6535
6536	<result name="VBOX_E_INVALID_VM_STATE">
6537	Virtual machine currently changing state.
6538	</result>
6539	</desc>
6540	<param name="name" type="wstring" dir="in">
6541	<desc>Short name for the snapshot.</desc>
6542	</param>
6543	<param name="description" type="wstring" dir="in">
6544	<desc>Optional description of the snapshot.</desc>
6545	</param>
6546	<param name="progress" type="IProgress" dir="return">
6547	<desc>Progress object to track the operation completion.</desc>
6548	</param>
6549	</method>
6550
6551	<method name="deleteSnapshot">
6552	<desc>
6553	Starts deleting the specified snapshot asynchronously.
6554	See <link to="ISnapshot" /> for an introduction to snapshots.
6555
6556	The execution state and settings of the associated machine stored in
6557	the snapshot will be deleted. The contents of all differencing media of
6558	this snapshot will be merged with the contents of their dependent child
6559	media to keep the medium chain valid (in other words, all changes
6560	represented by media being deleted will be propagated to their child
6561	medium). After that, this snapshot's differencing medium will be
6562	deleted. The parent of this snapshot will become a new parent for all
6563	its child snapshots.
6564
6565	If the deleted snapshot is the current one, its parent snapshot will
6566	become a new current snapshot. The current machine state is not directly
6567	affected in this case, except that currently attached differencing
6568	media based on media of the deleted snapshot will be also merged as
6569	described above.
6570
6571	If the deleted snapshot is the first or current snapshot, then the
6572	respective IMachine attributes will be adjusted. Deleting the current
6573	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6574	to make all current machine settings permanent.
6575
6576	Deleting a snapshot has the following preconditions:
6577
6578	<ul>
6579	<li>Child media of all normal media of the deleted snapshot
6580	must be accessible (see <link to="IMedium::state"/>) for this
6581	operation to succeed. In particular, this means that all virtual
6582	machines whose media are directly or indirectly based on the
6583	media of deleted snapshot must be powered off.</li>
6584
6585	<li>You cannot delete the snapshot if a medium attached to it has
6586	more than once child medium (differencing images) because otherwise
6587	merging would be impossible. This might be the case if there is
6588	more than one child snapshot or differencing images were created
6589	for other reason (e.g. implicitly because of multiple machine
6590	attachments).</li>
6591	</ul>
6592
6593
6594	The virtual machine's <link to="IMachine::state">state</link> is
6595	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6596	"DeletingSnapshotPaused" while this operation is in progress.
6597
6598	<note>
6599	Merging medium contents can be very time and disk space
6600	consuming, if these media are big in size and have many
6601	children. However, if the snapshot being deleted is the last
6602	(head) snapshot on the branch, the operation will be rather
6603	quick.
6604	</note>
6605	<result name="VBOX_E_INVALID_VM_STATE">
6606	The running virtual machine prevents deleting this snapshot. This
6607	happens only in very specific situations, usually snapshots can be
6608	deleted without trouble while a VM is running. The error message
6609	text explains the reason for the failure.
6610	</result>
6611	</desc>
6612	<param name="id" type="uuid" mod="string" dir="in">
6613	<desc>UUID of the snapshot to delete.</desc>
6614	</param>
6615	<param name="progress" type="IProgress" dir="return">
6616	<desc>Progress object to track the operation completion.</desc>
6617	</param>
6618	</method>
6619
6620	<method name="restoreSnapshot">
6621	<desc>
6622	Starts resetting the machine's current state to the state contained
6623	in the given snapshot, asynchronously. All current settings of the
6624	machine will be reset and changes stored in differencing media
6625	will be lost.
6626	See <link to="ISnapshot" /> for an introduction to snapshots.
6627
6628	After this operation is successfully completed, new empty differencing
6629	media are created for all normal media of the machine.
6630
6631	If the given snapshot is an online snapshot, the machine will go to
6632	the <link to="MachineState_Saved"> saved state</link>, so that the
6633	next time it is powered on, the execution state will be restored
6634	from the state of the snapshot.
6635
6636	<note>
6637	The machine must not be running, otherwise the operation will fail.
6638	</note>
6639
6640	<note>
6641	If the machine state is <link to="MachineState_Saved">Saved</link>
6642	prior to this operation, the saved state file will be implicitly
6643	deleted (as if <link to="IConsole::discardSavedState"/> were
6644	called).
6645	</note>
6646
6647	<result name="VBOX_E_INVALID_VM_STATE">
6648	Virtual machine is running.
6649	</result>
6650	</desc>
6651	<param name="snapshot" type="ISnapshot" dir="in">
6652	<desc>The snapshot to restore the VM state from.</desc>
6653	</param>
6654	<param name="progress" type="IProgress" dir="return">
6655	<desc>Progress object to track the operation completion.</desc>
6656	</param>
6657	</method>
6658
6659	<method name="teleport">
6660	<desc>
6661	Teleport the VM to a different host machine or process.
6662
6663	TODO explain the details.
6664
6665	<result name="VBOX_E_INVALID_VM_STATE">
6666	Virtual machine not running or paused.
6667	</result>
6668	</desc>
6669	<param name="hostname" type="wstring" dir="in">
6670	<desc>The name or IP of the host to teleport to.</desc>
6671	</param>
6672	<param name="tcpport" type="unsigned long" dir="in">
6673	<desc>The TCP port to connect to (1..65535).</desc>
6674	</param>
6675	<param name="password" type="wstring" dir="in">
6676	<desc>The password.</desc>
6677	</param>
6678	<param name="maxDowntime" type="unsigned long" dir="in">
6679	<desc>
6680	The maximum allowed downtime given as milliseconds. 0 is not a valid
6681	value. Recommended value: 250 ms.
6682
6683	The higher the value is, the greater the chance for a successful
6684	teleportation. A small value may easily result in the teleportation
6685	process taking hours and eventually fail.
6686
6687	<note>
6688	The current implementation treats this a guideline, not as an
6689	absolute rule.
6690	</note>
6691	</desc>
6692	</param>
6693	<param name="progress" type="IProgress" dir="return">
6694	<desc>Progress object to track the operation completion.</desc>
6695	</param>
6696	</method>
6697
6698	</interface>
6699
6700	<!--
6701	// IHost
6702	/////////////////////////////////////////////////////////////////////////
6703	-->
6704
6705	<enum
6706	name="HostNetworkInterfaceMediumType"
6707	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6708	>
6709	<desc>
6710	Type of encapsulation. Ethernet encapsulation includes both wired and
6711	wireless Ethernet connections.
6712	<see>IHostNetworkInterface</see>
6713	</desc>
6714
6715	<const name="Unknown" value="0">
6716	<desc>
6717	The type of interface cannot be determined.
6718	</desc>
6719	</const>
6720	<const name="Ethernet" value="1">
6721	<desc>
6722	Ethernet frame encapsulation.
6723	</desc>
6724	</const>
6725	<const name="PPP" value="2">
6726	<desc>
6727	Point-to-point protocol encapsulation.
6728	</desc>
6729	</const>
6730	<const name="SLIP" value="3">
6731	<desc>
6732	Serial line IP encapsulation.
6733	</desc>
6734	</const>
6735	</enum>
6736
6737	<enum
6738	name="HostNetworkInterfaceStatus"
6739	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6740	>
6741	<desc>
6742	Current status of the interface.
6743	<see>IHostNetworkInterface</see>
6744	</desc>
6745
6746	<const name="Unknown" value="0">
6747	<desc>
6748	The state of interface cannot be determined.
6749	</desc>
6750	</const>
6751	<const name="Up" value="1">
6752	<desc>
6753	The interface is fully operational.
6754	</desc>
6755	</const>
6756	<const name="Down" value="2">
6757	<desc>
6758	The interface is not functioning.
6759	</desc>
6760	</const>
6761	</enum>
6762
6763	<enum
6764	name="HostNetworkInterfaceType"
6765	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6766	>
6767	<desc>
6768	Network interface type.
6769	</desc>
6770	<const name="Bridged" value="1"/>
6771	<const name="HostOnly" value="2"/>
6772	</enum>
6773
6774	<interface
6775	name="IHostNetworkInterface" extends="$unknown"
6776	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6777	wsmap="managed"
6778	>
6779	<desc>
6780	Represents one of host's network interfaces. IP V6 address and network
6781	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6782	separated by colons.
6783	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6784	</desc>
6785	<attribute name="name" type="wstring" readonly="yes">
6786	<desc>Returns the host network interface name.</desc>
6787	</attribute>
6788
6789	<attribute name="id" type="uuid" mod="string" readonly="yes">
6790	<desc>Returns the interface UUID.</desc>
6791	</attribute>
6792
6793	<attribute name="networkName" type="wstring" readonly="yes">
6794	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6795	</attribute>
6796
6797	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6798	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6799	</attribute>
6800
6801	<attribute name="IPAddress" type="wstring" readonly="yes">
6802	<desc>Returns the IP V4 address of the interface.</desc>
6803	</attribute>
6804
6805	<attribute name="networkMask" type="wstring" readonly="yes">
6806	<desc>Returns the network mask of the interface.</desc>
6807	</attribute>
6808
6809	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6810	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6811	</attribute>
6812
6813	<attribute name="IPV6Address" type="wstring" readonly="yes">
6814	<desc>Returns the IP V6 address of the interface.</desc>
6815	</attribute>
6816
6817	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6818	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6819	</attribute>
6820
6821	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6822	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6823	</attribute>
6824
6825	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6826	<desc>Type of protocol encapsulation used.</desc>
6827	</attribute>
6828
6829	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6830	<desc>Status of the interface.</desc>
6831	</attribute>
6832
6833	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6834	<desc>specifies the host interface type.</desc>
6835	</attribute>
6836
6837	<method name="enableStaticIpConfig">
6838	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6839	<param name="IPAddress" type="wstring" dir="in">
6840	<desc>
6841	IP address.
6842	</desc>
6843	</param>
6844	<param name="networkMask" type="wstring" dir="in">
6845	<desc>
6846	network mask.
6847	</desc>
6848	</param>
6849	</method>
6850
6851	<method name="enableStaticIpConfigV6">
6852	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6853	<param name="IPV6Address" type="wstring" dir="in">
6854	<desc>
6855	IP address.
6856	</desc>
6857	</param>
6858	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6859	<desc>
6860	network mask.
6861	</desc>
6862	</param>
6863	</method>
6864
6865	<method name="enableDynamicIpConfig">
6866	<desc>enables the dynamic IP configuration.</desc>
6867	</method>
6868
6869	<method name="dhcpRediscover">
6870	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6871	</method>
6872
6873	</interface>
6874
6875	<interface
6876	name="IHost" extends="$unknown"
6877	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6878	wsmap="managed"
6879	>
6880	<desc>
6881	The IHost interface represents the physical machine that this VirtualBox
6882	installation runs on.
6883
6884	An object implementing this interface is returned by the
6885	<link to="IVirtualBox::host" /> attribute. This interface contains
6886	read-only information about the host's physical hardware (such as what
6887	processors and disks are available, what the host operating system is,
6888	and so on) and also allows for manipulating some of the host's hardware,
6889	such as global USB device filters and host interface networking.
6890
6891	</desc>
6892	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6893	<desc>List of DVD drives available on the host.</desc>
6894	</attribute>
6895
6896	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6897	<desc>List of floppy drives available on the host.</desc>
6898	</attribute>
6899
6900	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6901	<desc>
6902	List of USB devices currently attached to the host.
6903	Once a new device is physically attached to the host computer,
6904	it appears in this list and remains there until detached.
6905
6906	<note>
6907	If USB functionality is not available in the given edition of
6908	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6909	</note>
6910	</desc>
6911	</attribute>
6912
6913	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6914	<desc>
6915	List of USB device filters in action.
6916	When a new device is physically attached to the host computer,
6917	filters from this list are applied to it (in order they are stored
6918	in the list). The first matched filter will determine the
6919	<link to="IHostUSBDeviceFilter::action">action</link>
6920	performed on the device.
6921
6922	Unless the device is ignored by these filters, filters of all
6923	currently running virtual machines
6924	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6925
6926	<note>
6927	If USB functionality is not available in the given edition of
6928	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6929	</note>
6930
6931	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6932	</desc>
6933	</attribute>
6934
6935	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6936	<desc>List of host network interfaces currently defined on the host.</desc>
6937	</attribute>
6938
6939	<attribute name="processorCount" type="unsigned long" readonly="yes">
6940	<desc>Number of (logical) CPUs installed in the host system.</desc>
6941	</attribute>
6942
6943	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6944	<desc>Number of (logical) CPUs online in the host system.</desc>
6945	</attribute>
6946
6947	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6948	<desc>Number of physical processor cores installed in the host system.</desc>
6949	</attribute>
6950
6951	<method name="getProcessorSpeed">
6952	<desc>Query the (approximate) maximum speed of a specified host CPU in
6953	Megahertz.
6954	</desc>
6955	<param name="cpuId" type="unsigned long" dir="in">
6956	<desc>
6957	Identifier of the CPU.
6958	</desc>
6959	</param>
6960	<param name="speed" type="unsigned long" dir="return">
6961	<desc>
6962	Speed value. 0 is returned if value is not known or @a cpuId is
6963	invalid.
6964	</desc>
6965	</param>
6966	</method>
6967
6968	<method name="getProcessorFeature">
6969	<desc>Query whether a CPU feature is supported or not.</desc>
6970	<param name="feature" type="ProcessorFeature" dir="in">
6971	<desc>
6972	CPU Feature identifier.
6973	</desc>
6974	</param>
6975	<param name="supported" type="boolean" dir="return">
6976	<desc>
6977	Feature is supported or not.
6978	</desc>
6979	</param>
6980	</method>
6981
6982	<method name="getProcessorDescription">
6983	<desc>Query the model string of a specified host CPU.
6984	</desc>
6985	<param name="cpuId" type="unsigned long" dir="in">
6986	<desc>
6987	Identifier of the CPU.
6988	<note>
6989	The current implementation might not necessarily return the
6990	description for this exact CPU.
6991	</note>
6992	</desc>
6993	</param>
6994	<param name="description" type="wstring" dir="return">
6995	<desc>
6996	Model string. An empty string is returned if value is not known or
6997	@a cpuId is invalid.
6998	</desc>
6999	</param>
7000	</method>
7001
7002	<method name="getProcessorCPUIDLeaf">
7003	<desc>
7004	Returns the CPU cpuid information for the specified leaf.
7005	</desc>
7006	<param name="cpuId" type="unsigned long" dir="in">
7007	<desc>
7008	Identifier of the CPU. The CPU most be online.
7009	<note>
7010	The current implementation might not necessarily return the
7011	description for this exact CPU.
7012	</note>
7013	</desc>
7014	</param>
7015	<param name="leaf" type="unsigned long" dir="in">
7016	<desc>
7017	CPUID leaf index (eax).
7018	</desc>
7019	</param>
7020	<param name="subLeaf" type="unsigned long" dir="in">
7021	<desc>
7022	CPUID leaf sub index (ecx). This currently only applies to cache
7023	information on Intel CPUs. Use 0 if retrieving values for
7024	<link to="IMachine::setCPUIDLeaf"/>.
7025	</desc>
7026	</param>
7027	<param name="valEax" type="unsigned long" dir="out">
7028	<desc>
7029	CPUID leaf value for register eax.
7030	</desc>
7031	</param>
7032	<param name="valEbx" type="unsigned long" dir="out">
7033	<desc>
7034	CPUID leaf value for register ebx.
7035	</desc>
7036	</param>
7037	<param name="valEcx" type="unsigned long" dir="out">
7038	<desc>
7039	CPUID leaf value for register ecx.
7040	</desc>
7041	</param>
7042	<param name="valEdx" type="unsigned long" dir="out">
7043	<desc>
7044	CPUID leaf value for register edx.
7045	</desc>
7046	</param>
7047	</method>
7048
7049	<attribute name="memorySize" type="unsigned long" readonly="yes">
7050	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7051	</attribute>
7052
7053	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7054	<desc>Available system memory in the host system.</desc>
7055	</attribute>
7056
7057	<attribute name="operatingSystem" type="wstring" readonly="yes">
7058	<desc>Name of the host system's operating system.</desc>
7059	</attribute>
7060
7061	<attribute name="OSVersion" type="wstring" readonly="yes">
7062	<desc>Host operating system's version string.</desc>
7063	</attribute>
7064
7065	<attribute name="UTCTime" type="long long" readonly="yes">
7066	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7067	</attribute>
7068
7069	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7070	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7071	</attribute>
7072
7073	<method name="createHostOnlyNetworkInterface">
7074	<desc>
7075	Creates a new adapter for Host Only Networking.
7076	<result name="E_INVALIDARG">
7077	Host network interface @a name already exists.
7078	</result>
7079	</desc>
7080	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7081	<desc>
7082	Created host interface object.
7083	</desc>
7084	</param>
7085	<param name="progress" type="IProgress" dir="return">
7086	<desc>
7087	Progress object to track the operation completion.
7088	</desc>
7089	</param>
7090	</method>
7091
7092	<method name="removeHostOnlyNetworkInterface">
7093	<desc>
7094	Removes the given Host Only Networking interface.
7095	<result name="VBOX_E_OBJECT_NOT_FOUND">
7096	No host network interface matching @a id found.
7097	</result>
7098	</desc>
7099	<param name="id" type="uuid" mod="string" dir="in">
7100	<desc>
7101	Adapter GUID.
7102	</desc>
7103	</param>
7104	<param name="progress" type="IProgress" dir="return">
7105	<desc>
7106	Progress object to track the operation completion.
7107	</desc>
7108	</param>
7109	</method>
7110
7111	<method name="createUSBDeviceFilter">
7112	<desc>
7113	Creates a new USB device filter. All attributes except
7114	the filter name are set to empty (any match),
7115	<i>active</i> is @c false (the filter is not active).
7116
7117	The created filter can be added to the list of filters using
7118	<link to="#insertUSBDeviceFilter"/>.
7119
7120	<see>#USBDeviceFilters</see>
7121	</desc>
7122	<param name="name" type="wstring" dir="in">
7123	<desc>
7124	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7125	</desc>
7126	</param>
7127	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7128	<desc>Created filter object.</desc>
7129	</param>
7130	</method>
7131
7132	<method name="insertUSBDeviceFilter">
7133	<desc>
7134	Inserts the given USB device to the specified position
7135	in the list of filters.
7136
7137	Positions are numbered starting from @c 0. If the specified
7138	position is equal to or greater than the number of elements in
7139	the list, the filter is added at the end of the collection.
7140
7141	<note>
7142	Duplicates are not allowed, so an attempt to insert a
7143	filter already in the list is an error.
7144	</note>
7145	<note>
7146	If USB functionality is not available in the given edition of
7147	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7148	</note>
7149
7150	<see>#USBDeviceFilters</see>
7151
7152	<result name="VBOX_E_INVALID_OBJECT_STATE">
7153	USB device filter is not created within this VirtualBox instance.
7154	</result>
7155	<result name="E_INVALIDARG">
7156	USB device filter already in list.
7157	</result>
7158
7159	</desc>
7160	<param name="position" type="unsigned long" dir="in">
7161	<desc>Position to insert the filter to.</desc>
7162	</param>
7163	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7164	<desc>USB device filter to insert.</desc>
7165	</param>
7166	</method>
7167
7168	<method name="removeUSBDeviceFilter">
7169	<desc>
7170	Removes a USB device filter from the specified position in the
7171	list of filters.
7172
7173	Positions are numbered starting from @c 0. Specifying a
7174	position equal to or greater than the number of elements in
7175	the list will produce an error.
7176
7177	<note>
7178	If USB functionality is not available in the given edition of
7179	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7180	</note>
7181
7182	<see>#USBDeviceFilters</see>
7183
7184	<result name="E_INVALIDARG">
7185	USB device filter list empty or invalid @a position.
7186	</result>
7187
7188	</desc>
7189	<param name="position" type="unsigned long" dir="in">
7190	<desc>Position to remove the filter from.</desc>
7191	</param>
7192	</method>
7193
7194	<method name="findHostDVDDrive">
7195	<desc>
7196	Searches for a host DVD drive with the given @c name.
7197
7198	<result name="VBOX_E_OBJECT_NOT_FOUND">
7199	Given @c name does not correspond to any host drive.
7200	</result>
7201
7202	</desc>
7203	<param name="name" type="wstring" dir="in">
7204	<desc>Name of the host drive to search for</desc>
7205	</param>
7206	<param name="drive" type="IMedium" dir="return">
7207	<desc>Found host drive object</desc>
7208	</param>
7209	</method>
7210
7211	<method name="findHostFloppyDrive">
7212	<desc>
7213	Searches for a host floppy drive with the given @c name.
7214
7215	<result name="VBOX_E_OBJECT_NOT_FOUND">
7216	Given @c name does not correspond to any host floppy drive.
7217	</result>
7218
7219	</desc>
7220	<param name="name" type="wstring" dir="in">
7221	<desc>Name of the host floppy drive to search for</desc>
7222	</param>
7223	<param name="drive" type="IMedium" dir="return">
7224	<desc>Found host floppy drive object</desc>
7225	</param>
7226	</method>
7227
7228	<method name="findHostNetworkInterfaceByName">
7229	<desc>
7230	Searches through all host network interfaces for an interface with
7231	the given @c name.
7232	<note>
7233	The method returns an error if the given @c name does not
7234	correspond to any host network interface.
7235	</note>
7236	</desc>
7237	<param name="name" type="wstring" dir="in">
7238	<desc>Name of the host network interface to search for.</desc>
7239	</param>
7240	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7241	<desc>Found host network interface object.</desc>
7242	</param>
7243	</method>
7244	<method name="findHostNetworkInterfaceById">
7245	<desc>
7246	Searches through all host network interfaces for an interface with
7247	the given GUID.
7248	<note>
7249	The method returns an error if the given GUID does not
7250	correspond to any host network interface.
7251	</note>
7252	</desc>
7253	<param name="id" type="uuid" mod="string" dir="in">
7254	<desc>GUID of the host network interface to search for.</desc>
7255	</param>
7256	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7257	<desc>Found host network interface object.</desc>
7258	</param>
7259	</method>
7260	<method name="findHostNetworkInterfacesOfType">
7261	<desc>
7262	Searches through all host network interfaces and returns a list of interfaces of the specified type
7263	</desc>
7264	<param name="type" type="HostNetworkInterfaceType" dir="in">
7265	<desc>type of the host network interfaces to search for.</desc>
7266	</param>
7267	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7268	<desc>Found host network interface objects.</desc>
7269	</param>
7270	</method>
7271
7272	<method name="findUSBDeviceById">
7273	<desc>
7274	Searches for a USB device with the given UUID.
7275
7276	<result name="VBOX_E_OBJECT_NOT_FOUND">
7277	Given @c id does not correspond to any USB device.
7278	</result>
7279
7280	<see>IHostUSBDevice::id</see>
7281	</desc>
7282	<param name="id" type="uuid" mod="string" dir="in">
7283	<desc>UUID of the USB device to search for.</desc>
7284	</param>
7285	<param name="device" type="IHostUSBDevice" dir="return">
7286	<desc>Found USB device object.</desc>
7287	</param>
7288	</method>
7289
7290	<method name="findUSBDeviceByAddress">
7291	<desc>
7292	Searches for a USB device with the given host address.
7293
7294	<result name="VBOX_E_OBJECT_NOT_FOUND">
7295	Given @c name does not correspond to any USB device.
7296	</result>
7297
7298	<see>IHostUSBDevice::address</see>
7299	</desc>
7300	<param name="name" type="wstring" dir="in">
7301	<desc>
7302	Address of the USB device (as assigned by the host) to
7303	search for.
7304	</desc>
7305	</param>
7306	<param name="device" type="IHostUSBDevice" dir="return">
7307	<desc>Found USB device object.</desc>
7308	</param>
7309	</method>
7310
7311	</interface>
7312
7313	<!--
7314	// ISystemProperties
7315	/////////////////////////////////////////////////////////////////////////
7316	-->
7317
7318	<interface
7319	name="ISystemProperties"
7320	extends="$unknown"
7321	uuid="51c81048-b261-4fa2-a44e-fd756f0db589"
7322	wsmap="managed"
7323	>
7324	<desc>
7325	The ISystemProperties interface represents global properties of the given
7326	VirtualBox installation.
7327
7328	These properties define limits and default values for various attributes
7329	and parameters. Most of the properties are read-only, but some can be
7330	changed by a user.
7331	</desc>
7332
7333	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7334	<desc>Minimum guest system memory in Megabytes.</desc>
7335	</attribute>
7336
7337	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7338	<desc>Maximum guest system memory in Megabytes.</desc>
7339	</attribute>
7340
7341	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7342	<desc>Minimum guest video memory in Megabytes.</desc>
7343	</attribute>
7344
7345	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7346	<desc>Maximum guest video memory in Megabytes.</desc>
7347	</attribute>
7348
7349	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7350	<desc>Minimum CPU count.</desc>
7351	</attribute>
7352
7353	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7354	<desc>Maximum CPU count.</desc>
7355	</attribute>
7356
7357	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7358	<desc>Maximum of monitors which could be connected.</desc>
7359	</attribute>
7360
7361	<attribute name="infoVDSize" type="long long" readonly="yes">
7362	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7363	does not reflect the limits of any virtual disk image format.</desc>
7364	</attribute>
7365
7366	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7367	<desc>
7368	Number of network adapters associated with every
7369	<link to="IMachine"/> instance.
7370	</desc>
7371	</attribute>
7372
7373	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7374	<desc>
7375	Number of serial ports associated with every
7376	<link to="IMachine"/> instance.
7377	</desc>
7378	</attribute>
7379
7380	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7381	<desc>
7382	Number of parallel ports associated with every
7383	<link to="IMachine"/> instance.
7384	</desc>
7385	</attribute>
7386
7387	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7388	<desc>
7389	Maximum device position in the boot order. This value corresponds
7390	to the total number of devices a machine can boot from, to make it
7391	possible to include all possible devices to the boot list.
7392	<see><link to="IMachine::setBootOrder"/></see>
7393	</desc>
7394	</attribute>
7395
7396	<attribute name="defaultMachineFolder" type="wstring">
7397	<desc>
7398	Full path to the default directory used to create new or open
7399	existing machines when a machine settings file name contains no
7400	path.
7401
7402	Starting with VirtualBox 4.0, by default, this attribute contains
7403	the full path of folder named "VirtualBox VMs" in the user's
7404	home directory, which depends on the host platform.
7405
7406	When setting this attribute, a full path must be specified.
7407	Setting this property to @c null or an empty string or the
7408	special value "Machines" (for compatibility reasons) will restore
7409	that default value.
7410
7411	If the folder specified herein does not exist, it will be created
7412	automatically as needed.
7413
7414	<see>
7415	<link to="IVirtualBox::createMachine"/>,
7416	<link to="IVirtualBox::openMachine"/>
7417	</see>
7418	</desc>
7419	</attribute>
7420
7421	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7422	<desc>
7423	List of all medium storage formats supported by this VirtualBox
7424	installation.
7425
7426	Keep in mind that the medium format identifier
7427	(<link to="IMediumFormat::id"/>) used in other API calls like
7428	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7429	medium format is a case-insensitive string. This means that, for
7430	example, all of the following strings:
7431	<pre>
7432	"VDI"
7433	"vdi"
7434	"VdI"</pre>
7435	refer to the same medium format.
7436
7437	Note that the virtual medium framework is backend-based, therefore
7438	the list of supported formats depends on what backends are currently
7439	installed.
7440
7441	<see>
7442	<link to="IMediumFormat"/>,
7443	</see>
7444	</desc>
7445	</attribute>
7446
7447	<attribute name="defaultHardDiskFormat" type="wstring">
7448	<desc>
7449	Identifier of the default medium format used by VirtualBox.
7450
7451	The medium format set by this attribute is used by VirtualBox
7452	when the medium format was not specified explicitly. One example is
7453	<link to="IVirtualBox::createHardDisk"/> with the empty
7454	format argument. A more complex example is implicit creation of
7455	differencing media when taking a snapshot of a virtual machine:
7456	this operation will try to use a format of the parent medium first
7457	and if this format does not support differencing media the default
7458	format specified by this argument will be used.
7459
7460	The list of supported medium formats may be obtained by the
7461	<link to="#mediumFormats"/> call. Note that the default medium
7462	format must have a capability to create differencing media;
7463	otherwise operations that create media implicitly may fail
7464	unexpectedly.
7465
7466	The initial value of this property is <tt>"VDI"</tt> in the current
7467	version of the VirtualBox product, but may change in the future.
7468
7469	<note>
7470	Setting this property to @c null or empty string will restore the
7471	initial value.
7472	</note>
7473
7474	<see>
7475	<link to="#mediumFormats"/>,
7476	<link to="IMediumFormat::id"/>,
7477	<link to="IVirtualBox::createHardDisk"/>
7478	</see>
7479	</desc>
7480	</attribute>
7481
7482	<attribute name="freeDiskSpaceWarning" type="long long">
7483	<desc>Issue a warning if the free disk space is below (or in some disk
7484	intensive operation is expected to go below) the given size in
7485	bytes.</desc>
7486	</attribute>
7487
7488	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7489	<desc>Issue a warning if the free disk space is below (or in some disk
7490	intensive operation is expected to go below) the given percentage.</desc>
7491	</attribute>
7492
7493	<attribute name="freeDiskSpaceError" type="long long">
7494	<desc>Issue an error if the free disk space is below (or in some disk
7495	intensive operation is expected to go below) the given size in
7496	bytes.</desc>
7497	</attribute>
7498
7499	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7500	<desc>Issue an error if the free disk space is below (or in some disk
7501	intensive operation is expected to go below) the given percentage.</desc>
7502	</attribute>
7503
7504	<attribute name="VRDEAuthLibrary" type="wstring">
7505	<desc>
7506	Library that provides authentication for Remote Desktop clients. The library
7507	is used if a virtual machine's authentication type is set to "external"
7508	in the VM RemoteDisplay configuration.
7509
7510	The system library extension (".DLL" or ".so") must be omitted.
7511	A full path can be specified; if not, then the library must reside on the
7512	system's default library path.
7513
7514	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7515	of that name in one of the default VirtualBox library directories.
7516
7517	For details about VirtualBox authentication libraries and how to implement
7518	them, please refer to the VirtualBox manual.
7519
7520	<note>
7521	Setting this property to @c null or empty string will restore the
7522	initial value.
7523	</note>
7524	</desc>
7525	</attribute>
7526
7527	<attribute name="webServiceAuthLibrary" type="wstring">
7528	<desc>
7529	Library that provides authentication for webservice clients. The library
7530	is used if a virtual machine's authentication type is set to "external"
7531	in the VM RemoteDisplay configuration and will be called from
7532	within the <link to="IWebsessionManager::logon" /> implementation.
7533
7534	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7535	there is no per-VM setting for this, as the webservice is a global
7536	resource (if it is running). Only for this setting (for the webservice),
7537	setting this value to a literal <tt>"null"</tt> string disables authentication,
7538	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7539	no matter what user name and password are supplied.
7540
7541	The initial value of this property is <tt>"VRDPAuth"</tt>,
7542	meaning that the webservice will use the same authentication
7543	library that is used by default for VRDE (again, see
7544	<link to="ISystemProperties::VRDEAuthLibrary" />).
7545	The format and calling convention of authentication libraries
7546	is the same for the webservice as it is for VRDE.
7547
7548	<note>
7549	Setting this property to @c null or empty string will restore the
7550	initial value.
7551	</note>
7552	</desc>
7553	</attribute>
7554
7555	<attribute name="defaultVRDEExtPack" type="wstring">
7556	<desc>
7557	The name of the extension pack providing the default VRDE.
7558
7559	This attribute is for choosing between multiple extension packs
7560	providing VRDE. If only one is installed, it will automatically be the
7561	default one. The attribute value can be empty if no VRDE extension
7562	pack is installed.
7563
7564	For details about VirtualBox Remote Desktop Extension and how to
7565	implement one, please refer to the VirtualBox SDK.
7566	</desc>
7567	</attribute>
7568
7569	<attribute name="LogHistoryCount" type="unsigned long">
7570	<desc>
7571	This value specifies how many old release log files are kept.
7572	</desc>
7573	</attribute>
7574
7575	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7576	<desc>This value hold the default audio driver for the current
7577	system.</desc>
7578	</attribute>
7579
7580	<method name="getMaxDevicesPerPortForStorageBus">
7581	<desc>Returns the maximum number of devices which can be attached to a port
7582	for the given storage bus.</desc>
7583
7584	<param name="bus" type="StorageBus" dir="in">
7585	<desc>The storage bus type to get the value for.</desc>
7586	</param>
7587
7588	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7589	<desc>The maximum number of devices which can eb attached to the port for the given
7590	storage bus.</desc>
7591	</param>
7592	</method>
7593
7594	<method name="getMinPortCountForStorageBus">
7595	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7596
7597	<param name="bus" type="StorageBus" dir="in">
7598	<desc>The storage bus type to get the value for.</desc>
7599	</param>
7600
7601	<param name="minPortCount" type="unsigned long" dir="return">
7602	<desc>The minimum number of ports for the given storage bus.</desc>
7603	</param>
7604	</method>
7605
7606	<method name="getMaxPortCountForStorageBus">
7607	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7608
7609	<param name="bus" type="StorageBus" dir="in">
7610	<desc>The storage bus type to get the value for.</desc>
7611	</param>
7612
7613	<param name="maxPortCount" type="unsigned long" dir="return">
7614	<desc>The maximum number of ports for the given storage bus.</desc>
7615	</param>
7616	</method>
7617
7618	<method name="getMaxInstancesOfStorageBus">
7619	<desc>Returns the maximum number of storage bus instances which
7620	can be configured for each VM. This corresponds to the number of
7621	storage controllers one can have. Value may depend on chipset type
7622	used.</desc>
7623
7624	<param name="chipset" type="ChipsetType" dir="in">
7625	<desc>The chipset type to get the value for.</desc>
7626	</param>
7627
7628	<param name="bus" type="StorageBus" dir="in">
7629	<desc>The storage bus type to get the value for.</desc>
7630	</param>
7631
7632	<param name="maxInstances" type="unsigned long" dir="return">
7633	<desc>The maximum number of instances for the given storage bus.</desc>
7634	</param>
7635	</method>
7636
7637	<method name="getDeviceTypesForStorageBus">
7638	<desc>Returns list of all the supported device types
7639	(<link to="DeviceType"/>) for the given type of storage
7640	bus.</desc>
7641
7642	<param name="bus" type="StorageBus" dir="in">
7643	<desc>The storage bus type to get the value for.</desc>
7644	</param>
7645
7646	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7647	<desc>The list of all supported device types for the given storage bus.</desc>
7648	</param>
7649	</method>
7650
7651	<method name="getDefaultIoCacheSettingForStorageController">
7652	<desc>Returns the default I/O cache setting for the
7653	given storage controller</desc>
7654
7655	<param name="controllerType" type="StorageControllerType" dir="in">
7656	<desc>The storage controller to the setting for.</desc>
7657	</param>
7658
7659	<param name="enabled" type="boolean" dir="return">
7660	<desc>Returned flag indicating the default value</desc>
7661	</param>
7662	</method>
7663	</interface>
7664
7665	<!--
7666	// IGuest
7667	/////////////////////////////////////////////////////////////////////////
7668	-->
7669
7670	<interface
7671	name="IGuestOSType" extends="$unknown"
7672	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7673	wsmap="struct"
7674	>
7675	<desc>
7676	</desc>
7677
7678	<attribute name="familyId" type="wstring" readonly="yes">
7679	<desc>Guest OS family identifier string.</desc>
7680	</attribute>
7681
7682	<attribute name="familyDescription" type="wstring" readonly="yes">
7683	<desc>Human readable description of the guest OS family.</desc>
7684	</attribute>
7685
7686	<attribute name="id" type="wstring" readonly="yes">
7687	<desc>Guest OS identifier string.</desc>
7688	</attribute>
7689
7690	<attribute name="description" type="wstring" readonly="yes">
7691	<desc>Human readable description of the guest OS.</desc>
7692	</attribute>
7693
7694	<attribute name="is64Bit" type="boolean" readonly="yes">
7695	<desc>Returns @c true if the given OS is 64-bit</desc>
7696	</attribute>
7697
7698	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7699	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7700	</attribute>
7701
7702	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7703	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7704	</attribute>
7705
7706	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7707	<desc>Recommended RAM size in Megabytes.</desc>
7708	</attribute>
7709
7710	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7711	<desc>Recommended video RAM size in Megabytes.</desc>
7712	</attribute>
7713
7714	<attribute name="recommendedHDD" type="long long" readonly="yes">
7715	<desc>Recommended hard disk size in bytes.</desc>
7716	</attribute>
7717
7718	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7719	<desc>Returns recommended network adapter for this OS type.</desc>
7720	</attribute>
7721
7722	<attribute name="recommendedPae" type="boolean" readonly="yes">
7723	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7724	</attribute>
7725
7726	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7727	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7728	</attribute>
7729
7730	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7731	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7732	</attribute>
7733
7734	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7735	<desc>Recommended storage controller type for HD drives.</desc>
7736	</attribute>
7737
7738	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7739	<desc>Recommended storage bus type for HD drives.</desc>
7740	</attribute>
7741
7742	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7743	<desc>Recommended firmware type.</desc>
7744	</attribute>
7745
7746	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7747	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7748	</attribute>
7749
7750	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7751	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7752	</attribute>
7753
7754	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7755	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7756	</attribute>
7757
7758	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7759	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7760	</attribute>
7761
7762	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7763	<desc>Recommended chipset type.</desc>
7764	</attribute>
7765
7766	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7767	<desc>Recommended audio type.</desc>
7768	</attribute>
7769
7770	</interface>
7771
7772	<enum
7773	name="AdditionsRunLevelType"
7774	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7775	>
7776	<desc>
7777	Guest Additions run level type.
7778	</desc>
7779
7780	<const name="None" value="0">
7781	<desc>Guest Additions are not loaded.</desc>
7782	</const>
7783	<const name="System" value="1">
7784	<desc>Guest drivers are loaded.</desc>
7785	</const>
7786	<const name="Userland" value="2">
7787	<desc>Common components (such as application services) are loaded.</desc>
7788	</const>
7789	<const name="Desktop" value="3">
7790	<desc>Per-user desktop components are loaded.</desc>
7791	</const>
7792	</enum>
7793
7794	<enum
7795	name="AdditionsUpdateFlag"
7796	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
7797	>
7798	<desc>
7799	Guest Additions update flags.
7800	</desc>
7801
7802	<const name="None" value="0">
7803	<desc>No flag set.</desc>
7804	</const>
7805	<const name="WaitForUpdateStartOnly" value="1">
7806	<desc>Only wait for the update process being started and do not
7807	wait while peforming the actual update.</desc>
7808	</const>
7809	</enum>
7810
7811	<enum
7812	name="ExecuteProcessFlag"
7813	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7814	>
7815	<desc>
7816	Guest process execution flags.
7817	</desc>
7818
7819	<const name="None" value="0">
7820	<desc>No flag set.</desc>
7821	</const>
7822
7823	<const name="WaitForProcessStartOnly" value="1">
7824	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
7825	process itself then uses an infinite timeout.</desc>
7826	</const>
7827
7828	<const name="IgnoreOrphanedProcesses" value="2">
7829	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7830	</const>
7831	</enum>
7832
7833	<enum
7834	name="ProcessInputFlag"
7835	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7836	>
7837	<desc>
7838	Guest process input flags.
7839	</desc>
7840
7841	<const name="None" value="0">
7842	<desc>No flag set.</desc>
7843	</const>
7844	<const name="EndOfFile" value="1">
7845	<desc>End of file (input) reached.</desc>
7846	</const>
7847	</enum>
7848
7849	<enum
7850	name="CopyFileFlag"
7851	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7852	>
7853	<desc>
7854	Host/Guest copy flags.
7855	</desc>
7856
7857	<const name="None" value="0">
7858	<desc>No flag set.</desc>
7859	</const>
7860
7861	<const name="Recursive" value="1">
7862	<desc>Copy directories recursively.</desc>
7863	</const>
7864
7865	<const name="Update" value="2">
7866	<desc>Copy only when the source file is newer than the destination file or when the destination file is missing.</desc>
7867	</const>
7868
7869	<const name="FollowLinks" value="4">
7870	<desc>Follow symbolic links.</desc>
7871	</const>
7872	</enum>
7873
7874	<enum
7875	name="CreateDirectoryFlag"
7876	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
7877	>
7878	<desc>
7879	Directory creation flags.
7880	</desc>
7881
7882	<const name="None" value="0">
7883	<desc>No flag set.</desc>
7884	</const>
7885
7886	<const name="Parents" value="1">
7887	<desc>No error if existing, make parent directories as needed.</desc>
7888	</const>
7889	</enum>
7890
7891	<interface
7892	name="IGuest" extends="$unknown"
7893	uuid="1039b0cc-9bc1-4c6d-8d12-864aa48aa5b9"
7894	wsmap="managed"
7895	>
7896	<desc>
7897	The IGuest interface represents information about the operating system
7898	running inside the virtual machine. Used in
7899	<link to="IConsole::guest"/>.
7900
7901	IGuest provides information about the guest operating system, whether
7902	Guest Additions are installed and other OS-specific virtual machine
7903	properties.
7904	</desc>
7905
7906	<attribute name="OSTypeId" type="wstring" readonly="yes">
7907	<desc>
7908	Identifier of the Guest OS type as reported by the Guest
7909	Additions.
7910	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7911	an IGuestOSType object representing details about the given
7912	Guest OS type.
7913	<note>
7914	If Guest Additions are not installed, this value will be
7915	the same as <link to="IMachine::OSTypeId"/>.
7916	</note>
7917	</desc>
7918	</attribute>
7919
7920	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
7921	<desc>
7922	Current run level of the Guest Additions.
7923	</desc>
7924	</attribute>
7925
7926	<attribute name="additionsVersion" type="wstring" readonly="yes">
7927	<desc>
7928	Version of the Guest Additions including the revision (3 decimal numbers
7929	separated by dots + revision number) installed on the guest or empty
7930	when the Additions are not installed.
7931	</desc>
7932	</attribute>
7933
7934	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7935	<desc>
7936	Flag whether seamless guest display rendering (seamless desktop
7937	integration) is supported.
7938	</desc>
7939	</attribute>
7940
7941	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7942	<desc>
7943	Flag whether the guest is in graphics mode. If it is not, then
7944	seamless rendering will not work, resize hints are not immediately
7945	acted on and guest display resizes are probably not initiated by
7946	the guest additions.
7947	</desc>
7948	</attribute>
7949
7950	<attribute name="memoryBalloonSize" type="unsigned long">
7951	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7952	</attribute>
7953
7954	<attribute name="statisticsUpdateInterval" type="unsigned long">
7955	<desc>Interval to update guest statistics in seconds.</desc>
7956	</attribute>
7957
7958	<method name="internalGetStatistics">
7959	<desc>
7960	Internal method; do not use as it might change at any time
7961	</desc>
7962	<param name="cpuUser" type="unsigned long" dir="out">
7963	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7964	</param>
7965	<param name="cpuKernel" type="unsigned long" dir="out">
7966	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7967	</param>
7968	<param name="cpuIdle" type="unsigned long" dir="out">
7969	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7970	</param>
7971	<param name="memTotal" type="unsigned long" dir="out">
7972	<desc>Total amount of physical guest RAM</desc>
7973	</param>
7974	<param name="memFree" type="unsigned long" dir="out">
7975	<desc>Free amount of physical guest RAM</desc>
7976	</param>
7977	<param name="memBalloon" type="unsigned long" dir="out">
7978	<desc>Amount of ballooned physical guest RAM</desc>
7979	</param>
7980	<param name="memShared" type="unsigned long" dir="out">
7981	<desc>Amount of shared physical guest RAM</desc>
7982	</param>
7983	<param name="memCache" type="unsigned long" dir="out">
7984	<desc>Total amount of guest (disk) cache memory</desc>
7985	</param>
7986	<param name="pagedTotal" type="unsigned long" dir="out">
7987	<desc>Total amount of space in the page file</desc>
7988	</param>
7989	<param name="memAllocTotal" type="unsigned long" dir="out">
7990	<desc>Total amount of memory allocated by the hypervisor</desc>
7991	</param>
7992	<param name="memFreeTotal" type="unsigned long" dir="out">
7993	<desc>Total amount of free memory available in the hypervisor</desc>
7994	</param>
7995	<param name="memBalloonTotal" type="unsigned long" dir="out">
7996	<desc>Total amount of memory ballooned by the hypervisor</desc>
7997	</param>
7998	<param name="memSharedTotal" type="unsigned long" dir="out">
7999	<desc>Total amount of shared memory in the hypervisor</desc>
8000	</param>
8001	</method>
8002
8003	<method name="getAdditionsStatus">
8004	<desc>
8005	Retrieve the current status of a certain Guest Additions run level.
8006
8007	<result name="VBOX_E_NOT_SUPPORTED">
8008	Wrong status level specified.
8009	</result>
8010
8011	</desc>
8012	<param name="level" type="AdditionsRunLevelType" dir="in">
8013	<desc>Status level to check</desc>
8014	</param>
8015	<param name="active" type="boolean" dir="return">
8016	<desc>Flag whether the status level has been reached or not</desc>
8017	</param>
8018	</method>
8019
8020	<method name="setCredentials">
8021	<desc>
8022	Store login credentials that can be queried by guest operating
8023	systems with Additions installed. The credentials are transient
8024	to the session and the guest may also choose to erase them. Note
8025	that the caller cannot determine whether the guest operating system
8026	has queried or made use of the credentials.
8027
8028	<result name="VBOX_E_VM_ERROR">
8029	VMM device is not available.
8030	</result>
8031
8032	</desc>
8033	<param name="userName" type="wstring" dir="in">
8034	<desc>User name string, can be empty</desc>
8035	</param>
8036	<param name="password" type="wstring" dir="in">
8037	<desc>Password string, can be empty</desc>
8038	</param>
8039	<param name="domain" type="wstring" dir="in">
8040	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8041	</param>
8042	<param name="allowInteractiveLogon" type="boolean" dir="in">
8043	<desc>
8044	Flag whether the guest should alternatively allow the user to
8045	interactively specify different credentials. This flag might
8046	not be supported by all versions of the Additions.
8047	</desc>
8048	</param>
8049	</method>
8050
8051	<method name="executeProcess">
8052	<desc>
8053	Executes an existing program inside the guest VM.
8054
8055	<result name="VBOX_E_IPRT_ERROR">
8056	Could not execute process.
8057	</result>
8058
8059	</desc>
8060	<param name="execName" type="wstring" dir="in">
8061	<desc>
8062	Full path name of the command to execute on the guest; the
8063	commands has to exists in the guest VM in order to be executed.
8064	</desc>
8065	</param>
8066	<param name="flags" type="unsigned long" dir="in">
8067	<desc>
8068	Execution flags - currently not supported and therefore
8069	has to be set to 0.
8070	</desc>
8071	</param>
8072	<param name="arguments" type="wstring" safearray="yes" dir="in">
8073	<desc>
8074	Array of arguments passed to the execution command.
8075	</desc>
8076	</param>
8077	<param name="environment" type="wstring" safearray="yes" dir="in">
8078	<desc>
8079	Environment variables that can be set while the command is being
8080	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8081	variable just set its name ("NAME") without a value.
8082	</desc>
8083	</param>
8084	<param name="userName" type="wstring" dir="in">
8085	<desc>
8086	User name under which the command will be executed; has to exist
8087	and have the appropriate rights to execute programs in the VM.
8088	</desc>
8089	</param>
8090	<param name="password" type="wstring" dir="in">
8091	<desc>
8092	Password of the user account specified.
8093	</desc>
8094	</param>
8095	<param name="timeoutMS" type="unsigned long" dir="in">
8096	<desc>
8097	The maximum timeout value (in msec) to wait for finished program
8098	execution. Pass 0 for an infinite timeout.
8099	</desc>
8100	</param>
8101	<param name="pid" type="unsigned long" dir="out">
8102	<desc>
8103	The PID (process ID) of the started command for later reference.
8104	</desc>
8105	</param>
8106	<param name="progress" type="IProgress" dir="return">
8107	<desc>Progress object to track the operation completion.</desc>
8108	</param>
8109	</method>
8110
8111	<method name="getProcessOutput">
8112	<desc>
8113	Retrieves output of a formerly started process.
8114
8115	<result name="VBOX_E_IPRT_ERROR">
8116	Could not retrieve output.
8117	</result>
8118
8119	</desc>
8120	<param name="pid" type="unsigned long" dir="in">
8121	<desc>
8122	Process id returned by earlier executeProcess() call.
8123	</desc>
8124	</param>
8125	<param name="flags" type="unsigned long" dir="in">
8126	<desc>
8127	Flags describing which output to retrieve.
8128	</desc>
8129	</param>
8130	<param name="timeoutMS" type="unsigned long" dir="in">
8131	<desc>
8132	The maximum timeout value (in msec) to wait for output
8133	data. Pass 0 for an infinite timeout.
8134	</desc>
8135	</param>
8136	<param name="size" type="long long" dir="in">
8137	<desc>
8138	Size in bytes to read in the buffer.
8139	</desc>
8140	</param>
8141	<param name="data" type="octet" dir="return" safearray="yes">
8142	<desc>
8143	Buffer for retrieving the actual output. A data size of 0 means end of file
8144	if the requested size was not 0. This is the unprocessed
8145	output data, i.e. the line ending style depends on the platform of
8146	the system the server is running on.
8147	</desc>
8148	</param>
8149	</method>
8150
8151	<method name="getProcessStatus">
8152	<desc>
8153	Retrieves status, exit code and the exit reason of a formerly started process.
8154
8155	<result name="VBOX_E_IPRT_ERROR">
8156	Process with specified PID was not found.
8157	</result>
8158
8159	</desc>
8160	<param name="pid" type="unsigned long" dir="in">
8161	<desc>
8162	Process id returned by earlier executeProcess() call.
8163	</desc>
8164	</param>
8165	<param name="exitcode" type="unsigned long" dir="out">
8166	<desc>
8167	The exit code (if available).
8168	</desc>
8169	</param>
8170	<param name="flags" type="unsigned long" dir="out">
8171	<desc>
8172	Additional flags of process status. Not used at the moment and
8173	must be set to 0.
8174	</desc>
8175	</param>
8176	<param name="reason" type="unsigned long" dir="return">
8177	<desc>
8178	The current process status.
8179	</desc>
8180	</param>
8181	</method>
8182
8183	<method name="copyToGuest">
8184	<desc>
8185	Copies files/directories from host to the guest.
8186
8187	<result name="VBOX_E_IPRT_ERROR">
8188	Error while copying.
8189	</result>
8190
8191	</desc>
8192	<param name="source" type="wstring" dir="in">
8193	<desc>
8194	Source file on the host to copy.
8195	</desc>
8196	</param>
8197	<param name="dest" type="wstring" dir="in">
8198	<desc>
8199	Destination path on the guest.
8200	</desc>
8201	</param>
8202	<param name="userName" type="wstring" dir="in">
8203	<desc>
8204	User name under which the copy command will be executed; the
8205	user has to exist and have the appropriate rights to write to
8206	the destination path.
8207	</desc>
8208	</param>
8209	<param name="password" type="wstring" dir="in">
8210	<desc>
8211	Password of the user account specified.
8212	</desc>
8213	</param>
8214	<param name="flags" type="unsigned long" dir="in">
8215	<desc>
8216	Copy flags. Not used at the moment and must be set to 0.
8217	</desc>
8218	</param>
8219	<param name="progress" type="IProgress" dir="return">
8220	<desc>Progress object to track the operation completion.</desc>
8221	</param>
8222	</method>
8223
8224	<method name="createDirectory">
8225	<desc>
8226	Creates a directory on the guest.
8227
8228	<result name="VBOX_E_IPRT_ERROR">
8229	Error while creating directory.
8230	</result>
8231
8232	</desc>
8233	<param name="directory" type="wstring" dir="in">
8234	<desc>
8235	Directory to create.
8236	</desc>
8237	</param>
8238	<param name="userName" type="wstring" dir="in">
8239	<desc>
8240	User name under which the directory creation will be executed; the
8241	user has to exist and have the appropriate rights to create the
8242	desired directory.
8243	</desc>
8244	</param>
8245	<param name="password" type="wstring" dir="in">
8246	<desc>
8247	Password of the user account specified.
8248	</desc>
8249	</param>
8250	<param name="mode" type="unsigned long" dir="in">
8251	<desc>
8252	File mode.
8253	</desc>
8254	</param>
8255	<param name="flags" type="unsigned long" dir="in">
8256	<desc>
8257	Additional flags. Not used at the moment and must be set to 0.
8258	</desc>
8259	</param>
8260	<param name="progress" type="IProgress" dir="return">
8261	<desc>Progress object to track the operation completion.</desc>
8262	</param>
8263	</method>
8264
8265	<method name="setProcessInput">
8266	<desc>
8267	Sends input into a formerly started process.
8268
8269	<result name="VBOX_E_IPRT_ERROR">
8270	Could not send input.
8271	</result>
8272
8273	</desc>
8274	<param name="pid" type="unsigned long" dir="in">
8275	<desc>
8276	Process id returned by earlier executeProcess() call.
8277	</desc>
8278	</param>
8279	<param name="flags" type="unsigned long" dir="in">
8280	<desc>
8281	Not used, must be set to zero.
8282	</desc>
8283	</param>
8284	<param name="data" type="octet" dir="in" safearray="yes">
8285	<desc>
8286	Buffer of input data to send to the started process to.
8287	</desc>
8288	</param>
8289	<param name="written" type="unsigned long" dir="return">
8290	<desc>
8291	Number of bytes written.
8292	</desc>
8293	</param>
8294	</method>
8295
8296	<method name="updateGuestAdditions">
8297	<desc>
8298	Updates already installed Guest Additions in a VM
8299	(Windows guests only).
8300
8301	<result name="VBOX_E_IPRT_ERROR">
8302	Error while updating.
8303	</result>
8304
8305	</desc>
8306	<param name="source" type="wstring" dir="in">
8307	<desc>
8308	Path to the Guest Additions .ISO file to use for the upate.
8309	</desc>
8310	</param>
8311	<param name="flags" type="unsigned long" dir="in">
8312	<desc>
8313	Flags for Guest Additions update.
8314	</desc>
8315	</param>
8316	<param name="progress" type="IProgress" dir="return">
8317	<desc>Progress object to track the operation completion.</desc>
8318	</param>
8319	</method>
8320
8321	</interface>
8322
8323
8324	<!--
8325	// IProgress
8326	/////////////////////////////////////////////////////////////////////////
8327	-->
8328
8329	<interface
8330	name="IProgress" extends="$unknown"
8331	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8332	wsmap="managed"
8333	>
8334	<desc>
8335	The IProgress interface is used to track and control
8336	asynchronous tasks within VirtualBox.
8337
8338	An instance of this is returned every time VirtualBox starts
8339	an asynchronous task (in other words, a separate thread) which
8340	continues to run after a method call returns. For example,
8341	<link to="IConsole::saveState" />, which saves the state of
8342	a running virtual machine, can take a long time to complete.
8343	To be able to display a progress bar, a user interface such as
8344	the VirtualBox graphical user interface can use the IProgress
8345	object returned by that method.
8346
8347	Note that IProgress is a "read-only" interface in the sense
8348	that only the VirtualBox internals behind the Main API can
8349	create and manipulate progress objects, whereas client code
8350	can only use the IProgress object to monitor a task's
8351	progress and, if <link to="#cancelable" /> is @c true,
8352	cancel the task by calling <link to="#cancel" />.
8353
8354	A task represented by IProgress consists of either one or
8355	several sub-operations that run sequentially, one by one (see
8356	<link to="#operation" /> and <link to="#operationCount" />).
8357	Every operation is identified by a number (starting from 0)
8358	and has a separate description.
8359
8360	You can find the individual percentage of completion of the current
8361	operation in <link to="#operationPercent" /> and the
8362	percentage of completion of the task as a whole
8363	in <link to="#percent" />.
8364
8365	Similarly, you can wait for the completion of a particular
8366	operation via <link to="#waitForOperationCompletion" /> or
8367	for the completion of the whole task via
8368	<link to="#waitForCompletion" />.
8369	</desc>
8370
8371	<attribute name="id" type="uuid" mod="string" readonly="yes">
8372	<desc>ID of the task.</desc>
8373	</attribute>
8374
8375	<attribute name="description" type="wstring" readonly="yes">
8376	<desc>Description of the task.</desc>
8377	</attribute>
8378
8379	<attribute name="initiator" type="$unknown" readonly="yes">
8380	<desc>Initiator of the task.</desc>
8381	</attribute>
8382
8383	<attribute name="cancelable" type="boolean" readonly="yes">
8384	<desc>Whether the task can be interrupted.</desc>
8385	</attribute>
8386
8387	<attribute name="percent" type="unsigned long" readonly="yes">
8388	<desc>
8389	Current progress value of the task as a whole, in percent.
8390	This value depends on how many operations are already complete.
8391	Returns 100 if <link to="#completed" /> is @c true.
8392	</desc>
8393	</attribute>
8394
8395	<attribute name="timeRemaining" type="long" readonly="yes">
8396	<desc>
8397	Estimated remaining time until the task completes, in
8398	seconds. Returns 0 once the task has completed; returns -1
8399	if the remaining time cannot be computed, in particular if
8400	the current progress is 0.
8401
8402	Even if a value is returned, the estimate will be unreliable
8403	for low progress values. It will become more reliable as the
8404	task progresses; it is not recommended to display an ETA
8405	before at least 20% of a task have completed.
8406	</desc>
8407	</attribute>
8408
8409	<attribute name="completed" type="boolean" readonly="yes">
8410	<desc>Whether the task has been completed.</desc>
8411	</attribute>
8412
8413	<attribute name="canceled" type="boolean" readonly="yes">
8414	<desc>Whether the task has been canceled.</desc>
8415	</attribute>
8416
8417	<attribute name="resultCode" type="long" readonly="yes">
8418	<desc>
8419	Result code of the progress task.
8420	Valid only if <link to="#completed"/> is @c true.
8421	</desc>
8422	</attribute>
8423
8424	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8425	<desc>
8426	Extended information about the unsuccessful result of the
8427	progress operation. May be @c null if no extended information
8428	is available.
8429	Valid only if <link to="#completed"/> is @c true and
8430	<link to="#resultCode"/> indicates a failure.
8431	</desc>
8432	</attribute>
8433
8434	<attribute name="operationCount" type="unsigned long" readonly="yes">
8435	<desc>
8436	Number of sub-operations this task is divided into.
8437	Every task consists of at least one suboperation.
8438	</desc>
8439	</attribute>
8440
8441	<attribute name="operation" type="unsigned long" readonly="yes">
8442	<desc>Number of the sub-operation being currently executed.</desc>
8443	</attribute>
8444
8445	<attribute name="operationDescription" type="wstring" readonly="yes">
8446	<desc>
8447	Description of the sub-operation being currently executed.
8448	</desc>
8449	</attribute>
8450
8451	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8452	<desc>Progress value of the current sub-operation only, in percent.</desc>
8453	</attribute>
8454
8455	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8456	<desc>Weight value of the current sub-operation only.</desc>
8457	</attribute>
8458
8459	<attribute name="timeout" type="unsigned long">
8460	<desc>
8461	When non-zero, this specifies the number of milliseconds after which
8462	the operation will automatically be canceled. This can only be set on
8463	cancelable objects.
8464	</desc>
8465	</attribute>
8466
8467	<method name="setCurrentOperationProgress">
8468	<desc>Internal method, not to be called externally.</desc>
8469	<param name="percent" type="unsigned long" dir="in" />
8470	</method>
8471	<method name="setNextOperation">
8472	<desc>Internal method, not to be called externally.</desc>
8473	<param name="nextOperationDescription" type="wstring" dir="in" />
8474	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8475	</method>
8476
8477	<method name="waitForCompletion">
8478	<desc>
8479	Waits until the task is done (including all sub-operations)
8480	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8481
8482	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8483	thread are not processed while waiting. Neglecting event queues may
8484	have dire consequences (degrade performance, resource hogs,
8485	deadlocks, etc.), this is specially so for the main thread on
8486	platforms using XPCOM. Callers are adviced wait for short periods
8487	and service their event queues between calls, or to create a worker
8488	thread to do the waiting.
8489
8490	<result name="VBOX_E_IPRT_ERROR">
8491	Failed to wait for task completion.
8492	</result>
8493	</desc>
8494
8495	<param name="timeout" type="long" dir="in">
8496	<desc>
8497	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8498	</desc>
8499	</param>
8500	</method>
8501
8502	<method name="waitForOperationCompletion">
8503	<desc>
8504	Waits until the given operation is done with a given timeout in
8505	milliseconds; specify -1 for an indefinite wait.
8506
8507	See <link to="#waitForCompletion"> for event queue considerations.</link>
8508
8509	<result name="VBOX_E_IPRT_ERROR">
8510	Failed to wait for operation completion.
8511	</result>
8512
8513	</desc>
8514	<param name="operation" type="unsigned long" dir="in">
8515	<desc>
8516	Number of the operation to wait for.
8517	Must be less than <link to="#operationCount"/>.
8518	</desc>
8519	</param>
8520	<param name="timeout" type="long" dir="in">
8521	<desc>
8522	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8523	</desc>
8524	</param>
8525	</method>
8526
8527	<method name="cancel">
8528	<desc>
8529	Cancels the task.
8530	<note>
8531	If <link to="#cancelable"/> is @c false, then this method will fail.
8532	</note>
8533
8534	<result name="VBOX_E_INVALID_OBJECT_STATE">
8535	Operation cannot be canceled.
8536	</result>
8537
8538	</desc>
8539	</method>
8540
8541	</interface>
8542
8543	<!--
8544	// ISnapshot
8545	/////////////////////////////////////////////////////////////////////////
8546	-->
8547
8548	<interface
8549	name="ISnapshot" extends="$unknown"
8550	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8551	wsmap="managed"
8552	>
8553	<desc>
8554	The ISnapshot interface represents a snapshot of the virtual
8555	machine.
8556
8557	Together with the differencing media that are created
8558	when a snapshot is taken, a machine can be brought back to
8559	the exact state it was in when the snapshot was taken.
8560
8561	The ISnapshot interface has no methods, only attributes; snapshots
8562	are controlled through methods of the <link to="IConsole" /> interface
8563	which also manage the media associated with the snapshot.
8564	The following operations exist:
8565
8566	<ul>
8567	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8568	by creating new, empty differencing images for the machine's
8569	media and saving the VM settings and (if the VM is running)
8570	the current VM state in the snapshot.
8571
8572	The differencing images will then receive all data written to
8573	the machine's media, while their parent (base) images
8574	remain unmodified after the snapshot has been taken (see
8575	<link to="IMedium" /> for details about differencing images).
8576	This simplifies restoring a machine to the state of a snapshot:
8577	only the differencing images need to be deleted.
8578
8579	The current machine state is not changed by taking a snapshot.
8580	If the machine is running, it will resume execution after the
8581	snapshot has been taken. After calling this,
8582	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8583	just created.
8584	</li>
8585
8586	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8587	the state of a previous snapshot by deleting the differencing
8588	image of each of the machine's media and setting the machine's
8589	settings and state to the state that was saved in the snapshot (if any).
8590
8591	This destroys the machine's current state. After calling this,
8592	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8593	restored.
8594	</li>
8595
8596	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8597	without affecting the current machine state.
8598
8599	This does not change the current machine state, but instead frees the
8600	resources allocated when the snapshot was taken: the settings and machine
8601	state file are deleted (if any), and the snapshot's differencing image for
8602	each of the machine's media gets merged with its parent image.
8603
8604	Neither the current machine state nor other snapshots are affected
8605	by this operation, except that parent media will be modified
8606	to contain the disk data associated with the snapshot being deleted.
8607
8608	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8609	attribute is set to the current snapshot's parent or NULL if it
8610	has no parent. Otherwise the attribute is unchanged.
8611	</li>
8612	</ul>
8613
8614	Each snapshot contains the settings of the virtual machine (hardware
8615	configuration etc.). In addition, if the machine was running when the
8616	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8617	the current VM state is saved in the snapshot (similarly to what happens
8618	when a VM's state is saved). The snapshot is then said to
8619	be <i>online</i> because when restoring it, the VM will be running.
8620
8621	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8622	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8623
8624	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8625	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8626	it then contains a so-called "zero execution state", representing a
8627	machine that is powered off.
8628	</desc>
8629
8630	<attribute name="id" type="uuid" mod="string" readonly="yes">
8631	<desc>UUID of the snapshot.</desc>
8632	</attribute>
8633
8634	<attribute name="name" type="wstring">
8635	<desc>Short name of the snapshot.</desc>
8636	</attribute>
8637
8638	<attribute name="description" type="wstring">
8639	<desc>Optional description of the snapshot.</desc>
8640	</attribute>
8641
8642	<attribute name="timeStamp" type="long long" readonly="yes">
8643	<desc>
8644	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8645	</desc>
8646	</attribute>
8647
8648	<attribute name="online" type="boolean" readonly="yes">
8649	<desc>
8650	@c true if this snapshot is an online snapshot and @c false otherwise.
8651
8652	When this attribute is @c true, the
8653	<link to="IMachine::stateFilePath"/> attribute of the
8654	<link to="#machine"/> object associated with this snapshot
8655	will point to the saved state file. Otherwise, it will be
8656	an empty string.
8657	</desc>
8658	</attribute>
8659
8660	<attribute name="machine" type="IMachine" readonly="yes">
8661	<desc>
8662	Virtual machine this snapshot is taken on. This object
8663	stores all settings the machine had when taking this snapshot.
8664	<note>
8665	The returned machine object is immutable, i.e. no
8666	any settings can be changed.
8667	</note>
8668	</desc>
8669	</attribute>
8670
8671	<attribute name="parent" type="ISnapshot" readonly="yes">
8672	<desc>
8673	Parent snapshot (a snapshot this one is based on), or
8674	@c null if the snapshot has no parent (i.e. is the first snapshot).
8675	</desc>
8676	</attribute>
8677
8678	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8679	<desc>
8680	Child snapshots (all snapshots having this one as a parent).
8681	</desc>
8682	</attribute>
8683
8684	</interface>
8685
8686
8687	<!--
8688	// IMedium
8689	/////////////////////////////////////////////////////////////////////////
8690	-->
8691
8692	<enum
8693	name="MediumState"
8694	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8695	>
8696	<desc>
8697	Virtual medium state.
8698	<see>IMedium</see>
8699	</desc>
8700
8701	<const name="NotCreated" value="0">
8702	<desc>
8703	Associated medium storage does not exist (either was not created yet or
8704	was deleted).
8705	</desc>
8706	</const>
8707	<const name="Created" value="1">
8708	<desc>
8709	Associated storage exists and accessible; this gets set if the
8710	accessibility check performed by <link to="IMedium::refreshState" />
8711	was successful.
8712	</desc>
8713	</const>
8714	<const name="LockedRead" value="2">
8715	<desc>
8716	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8717	no data modification is possible.
8718	</desc>
8719	</const>
8720	<const name="LockedWrite" value="3">
8721	<desc>
8722	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8723	no concurrent data reading or modification is possible.
8724	</desc>
8725	</const>
8726	<const name="Inaccessible" value="4">
8727	<desc>
8728	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8729	not yet been performed, or else, associated medium storage is not
8730	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8731	is empty, in the second case, it describes the error that occurred.
8732	</desc>
8733	</const>
8734	<const name="Creating" value="5">
8735	<desc>
8736	Associated medium storage is being created.
8737	</desc>
8738	</const>
8739	<const name="Deleting" value="6">
8740	<desc>
8741	Associated medium storage is being deleted.
8742	</desc>
8743	</const>
8744	</enum>
8745
8746	<enum
8747	name="MediumType"
8748	uuid="19388a99-8e70-4bd4-9a95-90cbc513ef6d"
8749	>
8750	<desc>
8751	Virtual medium type.
8752	<see>IMedium</see>
8753	</desc>
8754
8755	<const name="Normal" value="0">
8756	<desc>
8757	Normal medium (attached directly or indirectly, preserved
8758	when taking snapshots).
8759	</desc>
8760	</const>
8761	<const name="Immutable" value="1">
8762	<desc>
8763	Immutable medium (attached indirectly, changes are wiped out
8764	the next time the virtual machine is started).
8765	</desc>
8766	</const>
8767	<const name="Writethrough" value="2">
8768	<desc>
8769	Write through medium (attached directly, ignored when
8770	taking snapshots).
8771	</desc>
8772	</const>
8773	<const name="Shareable" value="3">
8774	<desc>
8775	Allow using this medium concurrently by several machines.
8776	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8777	</desc>
8778	</const>
8779	<const name="Readonly" value="4">
8780	<desc>
8781	A readonly medium, which can of course be used by several machines.
8782	<note>Present and accepted since VirtualBox 4.0.</note>
8783	</desc>
8784	</const>
8785	</enum>
8786
8787	<enum
8788	name="MediumVariant"
8789	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8790	>
8791	<desc>
8792	Virtual medium image variant. More than one flag may be set.
8793	<see>IMedium</see>
8794	</desc>
8795
8796	<const name="Standard" value="0">
8797	<desc>
8798	No particular variant requested, results in using the backend default.
8799	</desc>
8800	</const>
8801	<const name="VmdkSplit2G" value="0x01">
8802	<desc>
8803	VMDK image split in chunks of less than 2GByte.
8804	</desc>
8805	</const>
8806	<const name="VmdkStreamOptimized" value="0x04">
8807	<desc>
8808	VMDK streamOptimized image. Special import/export format which is
8809	read-only/append-only.
8810	</desc>
8811	</const>
8812	<const name="VmdkESX" value="0x08">
8813	<desc>
8814	VMDK format variant used on ESX products.
8815	</desc>
8816	</const>
8817	<const name="Fixed" value="0x10000">
8818	<desc>
8819	Fixed image. Only allowed for base images.
8820	</desc>
8821	</const>
8822	<const name="Diff" value="0x20000">
8823	<desc>
8824	Differencing image. Only allowed for child images.
8825	</desc>
8826	</const>
8827	</enum>
8828
8829	<interface
8830	name="IMediumAttachment" extends="$unknown"
8831	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8832	wsmap="struct"
8833	>
8834	<desc>
8835	The IMediumAttachment interface links storage media to virtual machines.
8836	For each medium (<link to="IMedium"/>) which has been attached to a
8837	storage controller (<link to="IStorageController"/>) of a machine
8838	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8839	method, one instance of IMediumAttachment is added to the machine's
8840	<link to="IMachine::mediumAttachments"/> array attribute.
8841
8842	Each medium attachment specifies the storage controller as well as a
8843	port and device number and the IMedium instance representing a virtual
8844	hard disk or floppy or DVD image.
8845
8846	For removeable media (DVDs or floppies), there are two additional
8847	options. For one, the IMedium instance can be @c null to represent
8848	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8849	secondly, the medium can be one of the pseudo-media for host drives
8850	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8851	</desc>
8852
8853	<attribute name="medium" type="IMedium" readonly="yes">
8854	<desc>Medium object associated with this attachment; it
8855	can be @c null for removable devices.</desc>
8856	</attribute>
8857
8858	<attribute name="controller" type="wstring" readonly="yes">
8859	<desc>Name of the storage controller of this attachment; this
8860	refers to one of the controllers in <link to="IMachine::storageControllers" />
8861	by name.</desc>
8862	</attribute>
8863
8864	<attribute name="port" type="long" readonly="yes">
8865	<desc>Port number of this attachment.
8866	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8867	</desc>
8868	</attribute>
8869
8870	<attribute name="device" type="long" readonly="yes">
8871	<desc>Device slot number of this attachment.
8872	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8873	</desc>
8874	</attribute>
8875
8876	<attribute name="type" type="DeviceType" readonly="yes">
8877	<desc>Device type of this attachment.</desc>
8878	</attribute>
8879
8880	<attribute name="passthrough" type="boolean" readonly="yes">
8881	<desc>Pass I/O requests through to a device on the host.</desc>
8882	</attribute>
8883
8884	<attribute name="bandwidthLimit" type="unsigned long">
8885	<desc>
8886	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8887	A zero value means uncapped/unlimited.
8888	</desc>
8889	</attribute>
8890
8891	</interface>
8892
8893	<interface
8894	name="IMedium" extends="$unknown"
8895	uuid="bfcf5b8c-5155-4f24-9414-9457054b16db"
8896	wsmap="managed"
8897	>
8898	<desc>
8899	The IMedium interface represents virtual storage for a machine's
8900	hard disks, CD/DVD or floppy drives. It will typically represent
8901	a disk image on the host, for example a VDI or VMDK file representing
8902	a virtual hard disk, or an ISO or RAW file representing virtual
8903	removable media, but can also point to a network location (e.g.
8904	for iSCSI targets).
8905
8906	Instances of IMedium are connected to virtual machines by way of
8907	medium attachments (see <link to="IMediumAttachment" />), which link
8908	the storage medium to a particular device slot of a storage controller
8909	of the virtual machine.
8910	In the VirtualBox API, virtual storage is therefore always represented
8911	by the following chain of object links:
8912
8913	<ul>
8914	<li><link to="IMachine::storageControllers"/> contains an array of
8915	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8916	these are instances of <link to="IStorageController"/>).</li>
8917	<li><link to="IMachine::mediumAttachments"/> contains an array of
8918	medium attachments (instances of <link to="IMediumAttachment"/>),
8919	each containing a storage controller from the above array, a
8920	port/device specification, and an instance of IMedium representing
8921	the medium storage (image file).
8922
8923	For removable media, the storage medium is optional; a medium
8924	attachment with no medium represents a CD/DVD or floppy drive
8925	with no medium inserted. By contrast, hard disk attachments
8926	will always have an IMedium object attached.</li>
8927	<li>Each IMedium in turn points to a storage unit (such as a file
8928	on the host computer or a network resource) that holds actual
8929	data. This location is represented by the <link to="#location"/>
8930	attribute.</li>
8931	</ul>
8932
8933	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8934	new hard disk media can be created with the VirtualBox API using the
8935	<link to="IVirtualBox::createHardDisk"/> method.
8936
8937	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8938	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8939	type in a regular file.
8940
8941	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8942	drive; in that case the <link to="#id" /> attribute contains the UUID of
8943	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8944
8945	<h3>Known media</h3>
8946
8947	When an existing medium is opened and attached to a virtual machine, it
8948	is automatically added to a media registry. If the medium has first
8949	been attached to a machine which was created by VirtualBox 4.0 or later,
8950	it is added to that machine's media registry (in the machine XML settings
8951	file; this way all information about a machine's media attachments is
8952	contained in a single file). For older media attachments (i.e. if the
8953	medium was first attached to a machine which was created with a VirtualBox
8954	version before 4.0), media continue to be registered in the global
8955	VirtualBox settings file, for backwards compatibility.
8956
8957	See <link to="IVirtualBox::openMedium" /> for more information.
8958
8959	All known media can be enumerated using
8960	<link to="IVirtualBox::hardDisks"/>,
8961	<link to="IVirtualBox::DVDImages"/> and
8962	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8963	quickly found using the <link to="IVirtualBox::findMedium"/> method.
8964
8965	Only known media can be attached to virtual machines.
8966
8967	Removing known media from the media registry is performed when the given
8968	medium is closed using the <link to="#close"/> method or when its
8969	associated storage unit is deleted.
8970
8971	<h3>Accessibility checks</h3>
8972
8973	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8974	method is called explicitly on a medium. This is done to make the VirtualBox object
8975	ready for serving requests as fast as possible and let the end-user
8976	application decide if it needs to check media accessibility right away or not.
8977
8978	As a result, when VirtualBox starts up (e.g. the VirtualBox
8979	object gets created for the first time), all known media are in the
8980	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8981	attribute is an empty string because no actual accessibility check has
8982	been made yet.
8983
8984	After calling <link to="#refreshState" />, a medium is considered
8985	<i>accessible</i> if its storage unit can be read. In that case, the
8986	<link to="#state"/> attribute has a value of "Created". If the storage
8987	unit cannot be read (for example, because it is located on a disconnected
8988	network resource, or was accidentally deleted outside VirtualBox),
8989	the medium is considered <i>inaccessible</i>, which is indicated by the
8990	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8991	obtained by reading the <link to="#lastAccessError"/> attribute.
8992
8993	<h3>Medium types</h3>
8994
8995	There are four types of medium behavior (see <link to="MediumType" />):
8996	"normal", "immutable", "writethrough" and "shareable", represented by the
8997	<link to="#type"/> attribute. The type of the medium defines how the
8998	medium is attached to a virtual machine and what happens when a
8999	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9000	attached medium is taken. At the moment DVD and floppy media are always
9001	of type "writethrough".
9002
9003	All media can be also divided in two groups: <i>base</i> media and
9004	<i>differencing</i> media. A base medium contains all sectors of the
9005	medium data in its own storage and therefore can be used independently.
9006	In contrast, a differencing medium is a "delta" to some other medium and
9007	contains only those sectors which differ from that other medium, which is
9008	then called a <i>parent</i>. The differencing medium is said to be
9009	<i>linked to</i> that parent. The parent may be itself a differencing
9010	medium, thus forming a chain of linked media. The last element in that
9011	chain must always be a base medium. Note that several differencing
9012	media may be linked to the same parent medium.
9013
9014	Differencing media can be distinguished from base media by querying the
9015	<link to="#parent"/> attribute: base media do not have parents they would
9016	depend on, so the value of this attribute is always @c null for them.
9017	Using this attribute, it is possible to walk up the medium tree (from the
9018	child medium to its parent). It is also possible to walk down the tree
9019	using the <link to="#children"/> attribute.
9020
9021	Note that the type of all differencing media is "normal"; all other
9022	values are meaningless for them. Base media may be of any type.
9023
9024	<h3>Creating hard disks</h3>
9025
9026	New base hard disks are created using
9027	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9028	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
9029	disks are usually implicitly created by VirtualBox when needed but may
9030	also be created explicitly using <link to="#createDiffStorage"/>.
9031
9032	After the hard disk is successfully created (including the storage unit)
9033	or opened, it becomes a known hard disk (remembered in the internal media
9034	registry). Known hard disks can be attached to a virtual machine, accessed
9035	through <link to="IVirtualBox::findMedium"/> or enumerated using the
9036	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9037
9038	The following methods, besides <link to="IMedium::close"/>,
9039	automatically remove the hard disk from the media registry:
9040	<ul>
9041	<li><link to="#deleteStorage"/></li>
9042	<li><link to="#mergeTo"/></li>
9043	</ul>
9044
9045	If the storage unit of the hard disk is a regular file in the host's
9046	file system then the rules stated in the description of the
9047	<link to="IMedium::location"/> attribute apply when setting its value.
9048
9049	<h4>Automatic composition of the file name part</h4>
9050
9051	Another extension to the <link to="IMedium::location"/> attribute is that
9052	there is a possibility to cause VirtualBox to compose a unique value for
9053	the file name part of the location using the UUID of the hard disk. This
9054	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9055	e.g. before the storage unit is created, and works as follows. You set the
9056	value of the <link to="IMedium::location"/> attribute to a location
9057	specification which only contains the path specification but not the file
9058	name part and ends with either a forward slash or a backslash character.
9059	In response, VirtualBox will generate a new UUID for the hard disk and
9060	compose the file name using the following pattern:
9061	<pre>
9062	<path>/{<uuid>}.<ext>
9063	</pre>
9064	where <tt><path></tt> is the supplied path specification,
9065	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9066	is the default extension for the storage format of this hard disk. After
9067	that, you may call any of the methods that create a new hard disk storage
9068	unit and they will use the generated UUID and file name.
9069
9070	<h3>Attaching Hard Disks</h3>
9071
9072	Hard disks are attached to virtual machines using the
9073	<link to="IMachine::attachDevice"/> method and detached using the
9074	<link to="IMachine::detachDevice"/> method. Depending on their
9075	<link to="#type"/>, hard disks are attached either
9076	<i>directly</i> or <i>indirectly</i>.
9077
9078	When a hard disk is being attached directly, it is associated with the
9079	virtual machine and used for hard disk operations when the machine is
9080	running. When a hard disk is being attached indirectly, a new differencing
9081	hard disk linked to it is implicitly created and this differencing hard
9082	disk is associated with the machine and used for hard disk operations.
9083	This also means that if <link to="IMachine::attachDevice"/> performs
9084	a direct attachment then the same hard disk will be returned in response
9085	to the subsequent <link to="IMachine::getMedium"/> call; however if
9086	an indirect attachment is performed then
9087	<link to="IMachine::getMedium"/> will return the implicitly created
9088	differencing hard disk, not the original one passed to <link
9089	to="IMachine::attachDevice"/>. In detail:
9090
9091	<ul>
9092	<li><b>Normal base</b> hard disks that do not have children (i.e.
9093	differencing hard disks linked to them) and that are not already
9094	attached to virtual machines in snapshots are attached <b>directly</b>.
9095	Otherwise, they are attached <b>indirectly</b> because having
9096	dependent children or being part of the snapshot makes it impossible
9097	to modify hard disk contents without breaking the integrity of the
9098	dependent party. The <link to="#readOnly"/> attribute allows to
9099	quickly determine the kind of the attachment for the given hard
9100	disk. Note that if a normal base hard disk is to be indirectly
9101	attached to a virtual machine with snapshots then a special
9102	procedure called <i>smart attachment</i> is performed (see below).</li>
9103	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9104	they are attached <b>directly</b> if they do not have children and are
9105	not attached to virtual machines in snapshots, and <b>indirectly</b>
9106	otherwise. Note that the smart attachment procedure is never performed
9107	for differencing hard disks.</li>
9108	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9109	they are designed to be non-writable. If an immutable hard disk is
9110	attached to a virtual machine with snapshots then a special
9111	procedure called smart attachment is performed (see below).</li>
9112	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9113	also as designed. This also means that writethrough hard disks cannot
9114	have other hard disks linked to them at all.</li>
9115	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9116	also as designed. This also means that shareable hard disks cannot
9117	have other hard disks linked to them at all. They behave almost
9118	like writethrough hard disks, except that shareable hard disks can
9119	be attached to several virtual machines which are running, allowing
9120	concurrent accesses. You need special cluster software running in
9121	the virtual machines to make use of such disks.</li>
9122	</ul>
9123
9124	Note that the same hard disk, regardless of its type, may be attached to
9125	more than one virtual machine at a time. In this case, the machine that is
9126	started first gains exclusive access to the hard disk and attempts to
9127	start other machines having this hard disk attached will fail until the
9128	first machine is powered down.
9129
9130	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9131	that the given hard disk remains associated with the given machine after a
9132	successful <link to="IMachine::detachDevice"/> call until
9133	<link to="IMachine::saveSettings"/> is called to save all changes to
9134	machine settings to disk. This deferring is necessary to guarantee that
9135	the hard disk configuration may be restored at any time by a call to
9136	<link to="IMachine::discardSettings"/> before the settings
9137	are saved (committed).
9138
9139	Note that if <link to="IMachine::discardSettings"/> is called after
9140	indirectly attaching some hard disks to the machine but before a call to
9141	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9142	all differencing hard disks implicitly created by
9143	<link to="IMachine::attachDevice"/> for these indirect attachments.
9144	Such implicitly created hard disks will also be immediately deleted when
9145	detached explicitly using the <link to="IMachine::detachDevice"/>
9146	call if it is made before <link to="IMachine::saveSettings"/>. This
9147	implicit deletion is safe because newly created differencing hard
9148	disks do not contain any user data.
9149
9150	However, keep in mind that detaching differencing hard disks that were
9151	implicitly created by <link to="IMachine::attachDevice"/>
9152	before the last <link to="IMachine::saveSettings"/> call will
9153	<b>not</b> implicitly delete them as they may already contain some data
9154	(for example, as a result of virtual machine execution). If these hard
9155	disks are no more necessary, the caller can always delete them explicitly
9156	using <link to="#deleteStorage"/> after they are actually de-associated
9157	from this machine by the <link to="IMachine::saveSettings"/> call.
9158
9159	<h3>Smart Attachment</h3>
9160
9161	When normal base or immutable hard disks are indirectly attached to a
9162	virtual machine then some additional steps are performed to make sure the
9163	virtual machine will have the most recent "view" of the hard disk being
9164	attached. These steps include walking through the machine's snapshots
9165	starting from the current one and going through ancestors up to the first
9166	snapshot. Hard disks attached to the virtual machine in all
9167	of the encountered snapshots are checked whether they are descendants of
9168	the given normal base or immutable hard disk. The first found child (which
9169	is the differencing hard disk) will be used instead of the normal base or
9170	immutable hard disk as a parent for creating a new differencing hard disk
9171	that will be actually attached to the machine. And only if no descendants
9172	are found or if the virtual machine does not have any snapshots then the
9173	normal base or immutable hard disk will be used itself as a parent for
9174	this differencing hard disk.
9175
9176	It is easier to explain what smart attachment does using the
9177	following example:
9178	<pre>
9179	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9180
9181	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9182	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9183	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9184	Snapshot 4 (none) Snapshot 4 (none)
9185	CurState (none) CurState (D3->D2.vdi)
9186
9187	NOT
9188	...
9189	CurState (D3->B.vdi)
9190	</pre>
9191	The first column is the virtual machine configuration before the base hard
9192	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9193	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9194	mean that the hard disk that is actually attached to the machine is a
9195	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9196	another hard disk, <tt>B.vdi</tt>.
9197
9198	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9199	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9200	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9201	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9202	it cannot be attached directly and needs an indirect attachment (i.e.
9203	implicit creation of a new differencing hard disk). Due to the smart
9204	attachment procedure, the new differencing hard disk
9205	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9206	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9207	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9208	machine.
9209
9210	Note that if there is more than one descendant hard disk of the given base
9211	hard disk found in a snapshot, and there is an exact device, channel and
9212	bus match, then this exact match will be used. Otherwise, the youngest
9213	descendant will be picked up.
9214
9215	There is one more important aspect of the smart attachment procedure which
9216	is not related to snapshots at all. Before walking through the snapshots
9217	as described above, the backup copy of the current list of hard disk
9218	attachment is searched for descendants. This backup copy is created when
9219	the hard disk configuration is changed for the first time after the last
9220	<link to="IMachine::saveSettings"/> call and used by
9221	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9222	changes. When such a descendant is found in this backup copy, it will be
9223	simply re-attached back, without creating a new differencing hard disk for
9224	it. This optimization is necessary to make it possible to re-attach the
9225	base or immutable hard disk to a different bus, channel or device slot
9226	without losing the contents of the differencing hard disk actually
9227	attached to the machine in place of it.
9228	</desc>
9229
9230	<attribute name="id" type="uuid" mod="string" readonly="yes">
9231	<desc>
9232	UUID of the medium. For a newly created medium, this value is a randomly
9233	generated UUID.
9234
9235	<note>
9236	For media in one of MediumState_NotCreated, MediumState_Creating or
9237	MediumState_Deleting states, the value of this property is undefined
9238	and will most likely be an empty UUID.
9239	</note>
9240	</desc>
9241	</attribute>
9242
9243	<attribute name="description" type="wstring">
9244	<desc>
9245	Optional description of the medium. For a newly created medium the value
9246	of this attribute is an empty string.
9247
9248	Medium types that don't support this attribute will return E_NOTIMPL in
9249	attempt to get or set this attribute's value.
9250
9251	<note>
9252	For some storage types, reading this attribute may return an outdated
9253	(last known) value when <link to="#state"/> is <link
9254	to="MediumState_Inaccessible"/> or <link
9255	to="MediumState_LockedWrite"/> because the value of this attribute is
9256	stored within the storage unit itself. Also note that changing the
9257	attribute value is not possible in such case, as well as when the
9258	medium is the <link to="MediumState_LockedRead"/> state.
9259	</note>
9260	</desc>
9261	</attribute>
9262
9263	<attribute name="state" type="MediumState" readonly="yes">
9264	<desc>
9265	Returns the current medium state, which is the last state set by
9266	the accessibility check performed by <link to="#refreshState"/>.
9267	If that method has not yet been called on the medium, the state
9268	is "Inaccessible"; as opposed to truly inaccessible media, the
9269	value of <link to="#lastAccessError"/> will be an empty string in
9270	that case.
9271
9272	<note>As of version 3.1, this no longer performs an accessibility check
9273	automatically; call <link to="#refreshState"/> for that.
9274	</note>
9275	</desc>
9276	</attribute>
9277
9278	<attribute name="variant" type="MediumVariant" readonly="yes">
9279	<desc>
9280	Returns the storage format variant information for this medium.
9281	Before <link to="#refreshState"/> is called this method returns
9282	an undefined value.
9283	</desc>
9284	</attribute>
9285
9286	<attribute name="location" type="wstring">
9287	<desc>
9288	Location of the storage unit holding medium data.
9289
9290	The format of the location string is medium type specific. For medium
9291	types using regular files in a host's file system, the location
9292	string is the full file name.
9293
9294	Some medium types may support changing the storage unit location by
9295	simply changing the value of this property. If this operation is not
9296	supported, the implementation will return E_NOTIMPL in attempt to set
9297	this attribute's value.
9298
9299	When setting a value of the location attribute which is a regular file
9300	in the host's file system, the given file name may be either relative to
9301	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9302	absolute. Note that if the given location specification does not contain
9303	the file extension part then a proper default extension will be
9304	automatically appended by the implementation depending on the medium type.
9305	</desc>
9306	</attribute>
9307
9308	<attribute name="name" type="wstring" readonly="yes">
9309	<desc>
9310	Name of the storage unit holding medium data.
9311
9312	The returned string is a short version of the <link to="#location"/>
9313	attribute that is suitable for representing the medium in situations
9314	where the full location specification is too long (such as lists
9315	and comboboxes in GUI frontends). This string is also used by frontends
9316	to sort the media list alphabetically when needed.
9317
9318	For example, for locations that are regular files in the host's file
9319	system, the value of this attribute is just the file name (+ extension),
9320	without the path specification.
9321
9322	Note that as opposed to the <link to="#location"/> attribute, the name
9323	attribute will not necessary be unique for a list of media of the
9324	given type and format.
9325	</desc>
9326	</attribute>
9327
9328	<attribute name="deviceType" type="DeviceType" readonly="yes">
9329	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9330	medium.</desc>
9331	</attribute>
9332
9333	<attribute name="hostDrive" type="boolean" readonly="yes">
9334	<desc>True if this corresponds to a drive on the host.</desc>
9335	</attribute>
9336
9337	<attribute name="size" type="long long" readonly="yes">
9338	<desc>
9339	Physical size of the storage unit used to hold medium data (in bytes).
9340
9341	<note>
9342	For media whose <link to="#state"/> is <link
9343	to="MediumState_Inaccessible"/>, the value of this property is the
9344	last known size. For <link to="MediumState_NotCreated"/> media,
9345	the returned value is zero.
9346	</note>
9347	</desc>
9348	</attribute>
9349
9350	<attribute name="format" type="wstring" readonly="yes">
9351	<desc>
9352	Storage format of this medium.
9353
9354	The value of this attribute is a string that specifies a backend used
9355	to store medium data. The storage format is defined when you create a
9356	new medium or automatically detected when you open an existing medium,
9357	and cannot be changed later.
9358
9359	The list of all storage formats supported by this VirtualBox
9360	installation can be obtained using
9361	<link to="ISystemProperties::mediumFormats"/>.
9362	</desc>
9363	</attribute>
9364
9365	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9366	<desc>
9367	Storage medium format object corresponding to this medium.
9368
9369	The value of this attribute is a reference to the medium format object
9370	that specifies the backend properties used to store medium data. The
9371	storage format is defined when you create a new medium or automatically
9372	detected when you open an existing medium, and cannot be changed later.
9373
9374	<note>@c null is returned if there is no associated medium format
9375	object. This can e.g. happen for medium objects representing host
9376	drives and other special medium objects.</note>
9377	</desc>
9378	</attribute>
9379
9380	<attribute name="type" type="MediumType">
9381	<desc>
9382	Type (role) of this medium.
9383
9384	The following constraints apply when changing the value of this
9385	attribute:
9386	<ul>
9387	<li>If a medium is attached to a virtual machine (either in the
9388	current state or in one of the snapshots), its type cannot be
9389	changed.
9390	</li>
9391	<li>As long as the medium has children, its type cannot be set
9392	to <link to="MediumType_Writethrough"/>.
9393	</li>
9394	<li>The type of all differencing media is
9395	<link to="MediumType_Normal"/> and cannot be changed.
9396	</li>
9397	</ul>
9398
9399	The type of a newly created or opened medium is set to
9400	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9401	which have a type of <link to="MediumType_Writethrough"/>.
9402	</desc>
9403	</attribute>
9404
9405	<attribute name="parent" type="IMedium" readonly="yes">
9406	<desc>
9407	Parent of this medium (the medium this medium is directly based
9408	on).
9409
9410	Only differencing media have parents. For base (non-differencing)
9411	media, @c null is returned.
9412	</desc>
9413	</attribute>
9414
9415	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9416	<desc>
9417	Children of this medium (all differencing media directly based
9418	on this medium). A @c null array is returned if this medium
9419	does not have any children.
9420	</desc>
9421	</attribute>
9422
9423	<attribute name="base" type="IMedium" readonly="yes">
9424	<desc>
9425	Base medium of this medium.
9426
9427	If this is a differencing medium, its base medium is the medium
9428	the given medium branch starts from. For all other types of media, this
9429	property returns the medium object itself (i.e. the same object this
9430	property is read on).
9431	</desc>
9432	</attribute>
9433
9434	<attribute name="readOnly" type="boolean" readonly="yes">
9435	<desc>
9436	Returns @c true if this medium is read-only and @c false otherwise.
9437
9438	A medium is considered to be read-only when its contents cannot be
9439	modified without breaking the integrity of other parties that depend on
9440	this medium such as its child media or snapshots of virtual machines
9441	where this medium is attached to these machines. If there are no
9442	children and no such snapshots then there is no dependency and the
9443	medium is not read-only.
9444
9445	The value of this attribute can be used to determine the kind of the
9446	attachment that will take place when attaching this medium to a
9447	virtual machine. If the value is @c false then the medium will
9448	be attached directly. If the value is @c true then the medium
9449	will be attached indirectly by creating a new differencing child
9450	medium for that. See the interface description for more information.
9451
9452	Note that all <link to="MediumType_Immutable">Immutable</link> media
9453	are always read-only while all
9454	<link to="MediumType_Writethrough">Writethrough</link> media are
9455	always not.
9456
9457	<note>
9458	The read-only condition represented by this attribute is related to
9459	the medium type and usage, not to the current
9460	<link to="IMedium::state">medium state</link> and not to the read-only
9461	state of the storage unit.
9462	</note>
9463	</desc>
9464	</attribute>
9465
9466	<attribute name="logicalSize" type="long long" readonly="yes">
9467	<desc>
9468	Logical size of this medium (in bytes), as reported to the
9469	guest OS running inside the virtual machine this medium is
9470	attached to. The logical size is defined when the medium is created
9471	and cannot be changed later.
9472
9473	<note>
9474	Reading this property on a differencing medium will return the size
9475	of its <link to="#base"/> medium.
9476	</note>
9477	<note>
9478	For media whose state is <link to="#state"/> is <link
9479	to="MediumState_Inaccessible"/>, the value of this property is the
9480	last known logical size. For <link to="MediumState_NotCreated"/>
9481	media, the returned value is zero.
9482	</note>
9483	</desc>
9484	</attribute>
9485
9486	<attribute name="autoReset" type="boolean">
9487	<desc>
9488	Whether this differencing medium will be automatically reset each
9489	time a virtual machine it is attached to is powered up. This
9490	attribute is automatically set to @c true for the last
9491	differencing image of an "immutable" medium (see
9492	<link to="MediumType" />).
9493
9494	See <link to="#reset"/> for more information about resetting
9495	differencing media.
9496
9497	<note>
9498	Reading this property on a base (non-differencing) medium will
9499	always @c false. Changing the value of this property in this
9500	case is not supported.
9501	</note>
9502
9503	<result name="VBOX_E_NOT_SUPPORTED">
9504	This is not a differencing medium (when changing the attribute
9505	value).
9506	</result>
9507	</desc>
9508	</attribute>
9509
9510	<attribute name="lastAccessError" type="wstring" readonly="yes">
9511	<desc>
9512	Text message that represents the result of the last accessibility
9513	check performed by <link to="#refreshState"/>.
9514
9515	An empty string is returned if the last accessibility check
9516	was successful or has not yet been called. As a result, if
9517	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9518	then <link to="#refreshState"/> has yet to be called; this is the
9519	default value of media after VirtualBox initialization.
9520	A non-empty string indicates a failure and should normally describe
9521	a reason of the failure (for example, a file read error).
9522	</desc>
9523	</attribute>
9524
9525	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9526	<desc>
9527	Array of UUIDs of all machines this medium is attached to.
9528
9529	A @c null array is returned if this medium is not attached to any
9530	machine or to any machine's snapshot.
9531
9532	<note>
9533	The returned array will include a machine even if this medium is not
9534	attached to that machine in the current state but attached to it in
9535	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9536	details.
9537	</note>
9538	</desc>
9539	</attribute>
9540
9541	<method name="setIDs">
9542	<desc>
9543	Changes the UUID and parent UUID for a hard disk medium.
9544	</desc>
9545	<param name="setImageId" type="boolean" dir="in">
9546	<desc>
9547	Select whether a new image UUID is set or not.
9548	</desc>
9549	</param>
9550	<param name="imageId" type="uuid" mod="string" dir="in">
9551	<desc>
9552	New UUID for the image. If an empty string is passed, then a new
9553	UUID is automatically created, provided that @a setImageId is @c true.
9554	Specifying a zero UUID is not allowed.
9555	</desc>
9556	</param>
9557	<param name="setParentId" type="boolean" dir="in">
9558	<desc>
9559	Select whether a new parent UUID is set or not.
9560	</desc>
9561	</param>
9562	<param name="parentId" type="uuid" mod="string" dir="in">
9563	<desc>
9564	New parent UUID for the image. If an empty string is passed, then a
9565	new UUID is automatically created, provided @a setParentId is
9566	@c true. A zero UUID is valid.
9567	</desc>
9568	</param>
9569	<result name="E_INVALIDARG">
9570	Invalid parameter combination.
9571	</result>
9572	<result name="VBOX_E_NOT_SUPPORTED">
9573	Medium is not a hard disk medium.
9574	</result>
9575	</method>
9576
9577	<method name="refreshState">
9578	<desc>
9579	If the current medium state (see <link to="MediumState"/>) is one of
9580	"Created", "Inaccessible" or "LockedRead", then this performs an
9581	accessibility check on the medium and sets the value of the <link to="#state"/>
9582	attribute accordingly; that value is also returned for convenience.
9583
9584	For all other state values, this does not perform a refresh but returns
9585	the state only.
9586
9587	The refresh, if performed, may take a long time (several seconds or even
9588	minutes, depending on the storage unit location and format) because it performs an
9589	accessibility check of the storage unit. This check may cause a significant
9590	delay if the storage unit of the given medium is, for example, a file located
9591	on a network share which is not currently accessible due to connectivity
9592	problems. In that case, the call will not return until a timeout
9593	interval defined by the host OS for this operation expires. For this reason,
9594	it is recommended to never read this attribute on the main UI thread to avoid
9595	making the UI unresponsive.
9596
9597	If the last known state of the medium is "Created" and the accessibility
9598	check fails, then the state would be set to "Inaccessible", and
9599	<link to="#lastAccessError"/> may be used to get more details about the
9600	failure. If the state of the medium is "LockedRead", then it remains the
9601	same, and a non-empty value of <link to="#lastAccessError"/> will
9602	indicate a failed accessibility check in this case.
9603
9604	Note that not all medium states are applicable to all medium types.
9605	</desc>
9606	<param name="state" type="MediumState" dir="return">
9607	<desc>
9608	New medium state.
9609	</desc>
9610	</param>
9611	</method>
9612
9613	<method name="getSnapshotIds">
9614	<desc>
9615	Returns an array of UUIDs of all snapshots of the given machine where
9616	this medium is attached to.
9617
9618	If the medium is attached to the machine in the current state, then the
9619	first element in the array will always be the ID of the queried machine
9620	(i.e. the value equal to the @c machineId argument), followed by
9621	snapshot IDs (if any).
9622
9623	If the medium is not attached to the machine in the current state, then
9624	the array will contain only snapshot IDs.
9625
9626	The returned array may be @c null if this medium is not attached
9627	to the given machine at all, neither in the current state nor in one of
9628	the snapshots.
9629	</desc>
9630	<param name="machineId" type="uuid" mod="string" dir="in">
9631	<desc>
9632	UUID of the machine to query.
9633	</desc>
9634	</param>
9635	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9636	<desc>
9637	Array of snapshot UUIDs of the given machine using this medium.
9638	</desc>
9639	</param>
9640	</method>
9641
9642	<method name="lockRead">
9643	<desc>
9644	Locks this medium for reading.
9645
9646	A read lock is shared: many clients can simultaneously lock the
9647	same medium for reading unless it is already locked for writing (see
9648	<link to="#lockWrite"/>) in which case an error is returned.
9649
9650	When the medium is locked for reading, it cannot be modified
9651	from within VirtualBox. This means that any method that changes
9652	the properties of this medium or contents of the storage unit
9653	will return an error (unless explicitly stated otherwise). That
9654	includes an attempt to start a virtual machine that wants to
9655	write to the the medium.
9656
9657	When the virtual machine is started up, it locks for reading all
9658	media it uses in read-only mode. If some medium cannot be locked
9659	for reading, the startup procedure will fail.
9660	A medium is typically locked for reading while it is used by a running
9661	virtual machine but has a depending differencing image that receives
9662	the actual write operations. This way one base medium can have
9663	multiple child differencing images which can be written to
9664	simultaneously. Read-only media such as DVD and floppy images are
9665	also locked for reading only (so they can be in use by multiple
9666	machines simultaneously).
9667
9668	A medium is also locked for reading when it is the source of a
9669	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9670
9671	The medium locked for reading must be unlocked using the <link
9672	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9673	can be nested and must be followed by the same number of paired
9674	<link to="#unlockRead"/> calls.
9675
9676	This method sets the medium state (see <link to="#state"/>) to
9677	"LockedRead" on success. The medium's previous state must be
9678	one of "Created", "Inaccessible" or "LockedRead".
9679
9680	Locking an inaccessible medium is not an error; this method performs
9681	a logical lock that prevents modifications of this medium through
9682	the VirtualBox API, not a physical file-system lock of the underlying
9683	storage unit.
9684
9685	This method returns the current state of the medium
9686	<i>before</i> the operation.
9687
9688	<result name="VBOX_E_INVALID_OBJECT_STATE">
9689	Invalid medium state (e.g. not created, locked, inaccessible,
9690	creating, deleting).
9691	</result>
9692
9693	</desc>
9694	<param name="state" type="MediumState" dir="return">
9695	<desc>
9696	State of the medium after the operation.
9697	</desc>
9698	</param>
9699	</method>
9700
9701	<method name="unlockRead">
9702	<desc>
9703	Cancels the read lock previously set by <link to="#lockRead"/>.
9704
9705	For both success and failure, this method returns the current state
9706	of the medium <i>after</i> the operation.
9707
9708	See <link to="#lockRead"/> for more details.
9709
9710	<result name="VBOX_E_INVALID_OBJECT_STATE">
9711	Medium not locked for reading.
9712	</result>
9713
9714	</desc>
9715	<param name="state" type="MediumState" dir="return">
9716	<desc>
9717	State of the medium after the operation.
9718	</desc>
9719	</param>
9720	</method>
9721
9722	<method name="lockWrite">
9723	<desc>
9724	Locks this medium for writing.
9725
9726	A write lock, as opposed to <link to="#lockRead"/>, is
9727	exclusive: there may be only one client holding a write lock,
9728	and there may be no read locks while the write lock is held.
9729	As a result, read-locking fails if a write lock is held, and
9730	write-locking fails if either a read or another write lock is held.
9731
9732	When a medium is locked for writing, it cannot be modified
9733	from within VirtualBox, and it is not guaranteed that the values
9734	of its properties are up-to-date. Any method that changes the
9735	properties of this medium or contents of the storage unit will
9736	return an error (unless explicitly stated otherwise).
9737
9738	When a virtual machine is started up, it locks for writing all
9739	media it uses to write data to. If any medium could not be locked
9740	for writing, the startup procedure will fail. If a medium has
9741	differencing images, then while the machine is running, only
9742	the last ("leaf") differencing image is locked for writing,
9743	whereas its parents are locked for reading only.
9744
9745	A medium is also locked for writing when it is the target of a
9746	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9747
9748	The medium locked for writing must be unlocked using the <link
9749	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9750
9751	This method sets the medium state (see <link to="#state"/>) to
9752	"LockedWrite" on success. The medium's previous state must be
9753	either "Created" or "Inaccessible".
9754
9755	Locking an inaccessible medium is not an error; this method performs
9756	a logical lock that prevents modifications of this medium through
9757	the VirtualBox API, not a physical file-system lock of the underlying
9758	storage unit.
9759
9760	For both, success and failure, this method returns the current
9761	state of the medium <i>before</i> the operation.
9762
9763	<result name="VBOX_E_INVALID_OBJECT_STATE">
9764	Invalid medium state (e.g. not created, locked, inaccessible,
9765	creating, deleting).
9766	</result>
9767
9768	</desc>
9769	<param name="state" type="MediumState" dir="return">
9770	<desc>
9771	State of the medium after the operation.
9772	</desc>
9773	</param>
9774	</method>
9775
9776	<method name="unlockWrite">
9777	<desc>
9778	Cancels the write lock previously set by <link to="#lockWrite"/>.
9779
9780	For both success and failure, this method returns the current
9781	state of the medium <i>after</i> the operation.
9782
9783	See <link to="#lockWrite"/> for more details.
9784
9785	<result name="VBOX_E_INVALID_OBJECT_STATE">
9786	Medium not locked for writing.
9787	</result>
9788
9789	</desc>
9790	<param name="state" type="MediumState" dir="return">
9791	<desc>
9792	State of the medium after the operation.
9793	</desc>
9794	</param>
9795	</method>
9796
9797	<method name="close">
9798	<desc>
9799	Closes this medium.
9800
9801	The medium must not be attached to any known virtual machine
9802	and must not have any known child media, otherwise the
9803	operation will fail.
9804
9805	When the medium is successfully closed, it is removed from
9806	the list of registered media, but its storage unit is not
9807	deleted. In particular, this means that this medium can
9808	later be opened again using the <link to="IVirtualBox::openMedium"/>
9809	call.
9810
9811	Note that after this method successfully returns, the given medium
9812	object becomes uninitialized. This means that any attempt
9813	to call any of its methods or attributes will fail with the
9814	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9815
9816	<result name="VBOX_E_INVALID_OBJECT_STATE">
9817	Invalid medium state (other than not created, created or
9818	inaccessible).
9819	</result>
9820	<result name="VBOX_E_OBJECT_IN_USE">
9821	Medium attached to virtual machine.
9822	</result>
9823	<result name="VBOX_E_FILE_ERROR">
9824	Settings file not accessible.
9825	</result>
9826	<result name="VBOX_E_XML_ERROR">
9827	Could not parse the settings file.
9828	</result>
9829
9830	</desc>
9831	</method>
9832
9833	<!-- storage methods -->
9834
9835	<method name="getProperty">
9836	<desc>
9837	Returns the value of the custom medium property with the given name.
9838
9839	The list of all properties supported by the given medium format can
9840	be obtained with <link to="IMediumFormat::describeProperties"/>.
9841
9842	Note that if this method returns an empty string in @a value, the
9843	requested property is supported but currently not assigned any value.
9844
9845	<result name="VBOX_E_OBJECT_NOT_FOUND">
9846	Requested property does not exist (not supported by the format).
9847	</result>
9848	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9849	</desc>
9850	<param name="name" type="wstring" dir="in">
9851	<desc>Name of the property to get.</desc>
9852	</param>
9853	<param name="value" type="wstring" dir="return">
9854	<desc>Current property value.</desc>
9855	</param>
9856	</method>
9857
9858	<method name="setProperty">
9859	<desc>
9860	Sets the value of the custom medium property with the given name.
9861
9862	The list of all properties supported by the given medium format can
9863	be obtained with <link to="IMediumFormat::describeProperties"/>.
9864
9865	Note that setting the property value to @c null or an empty string is
9866	equivalent to deleting the existing value. A default value (if it is
9867	defined for this property) will be used by the format backend in this
9868	case.
9869
9870	<result name="VBOX_E_OBJECT_NOT_FOUND">
9871	Requested property does not exist (not supported by the format).
9872	</result>
9873	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9874	</desc>
9875	<param name="name" type="wstring" dir="in">
9876	<desc>Name of the property to set.</desc>
9877	</param>
9878	<param name="value" type="wstring" dir="in">
9879	<desc>Property value to set.</desc>
9880	</param>
9881	</method>
9882
9883	<method name="getProperties">
9884	<desc>
9885	Returns values for a group of properties in one call.
9886
9887	The names of the properties to get are specified using the @a names
9888	argument which is a list of comma-separated property names or
9889	an empty string if all properties are to be returned. Note that currently
9890	the value of this argument is ignored and the method always returns all
9891	existing properties.
9892
9893	The list of all properties supported by the given medium format can
9894	be obtained with <link to="IMediumFormat::describeProperties"/>.
9895
9896	The method returns two arrays, the array of property names corresponding
9897	to the @a names argument and the current values of these properties.
9898	Both arrays have the same number of elements with each elemend at the
9899	given index in the first array corresponds to an element at the same
9900	index in the second array.
9901
9902	Note that for properties that do not have assigned values,
9903	an empty string is returned at the appropriate index in the
9904	@a returnValues array.
9905
9906	</desc>
9907	<param name="names" type="wstring" dir="in">
9908	<desc>
9909	Names of properties to get.
9910	</desc>
9911	</param>
9912	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9913	<desc>Names of returned properties.</desc>
9914	</param>
9915	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9916	<desc>Values of returned properties.</desc>
9917	</param>
9918	</method>
9919
9920	<method name="setProperties">
9921	<desc>
9922	Sets values for a group of properties in one call.
9923
9924	The names of the properties to set are passed in the @a names
9925	array along with the new values for them in the @a values array. Both
9926	arrays have the same number of elements with each elemend at the given
9927	index in the first array corresponding to an element at the same index
9928	in the second array.
9929
9930	If there is at least one property name in @a names that is not valid,
9931	the method will fail before changing the values of any other properties
9932	from the @a names array.
9933
9934	Using this method over <link to="#setProperty"/> is preferred if you
9935	need to set several properties at once since it will result into less
9936	IPC calls.
9937
9938	The list of all properties supported by the given medium format can
9939	be obtained with <link to="IMediumFormat::describeProperties"/>.
9940
9941	Note that setting the property value to @c null or an empty string is
9942	equivalent to deleting the existing value. A default value (if it is
9943	defined for this property) will be used by the format backend in this
9944	case.
9945	</desc>
9946	<param name="names" type="wstring" safearray="yes" dir="in">
9947	<desc>Names of properties to set.</desc>
9948	</param>
9949	<param name="values" type="wstring" safearray="yes" dir="in">
9950	<desc>Values of properties to set.</desc>
9951	</param>
9952	</method>
9953
9954	<!-- storage methods -->
9955
9956	<method name="createBaseStorage">
9957	<desc>
9958	Starts creating a hard disk storage unit (fixed/dynamic, according
9959	to the variant flags) in in the background. The previous storage unit
9960	created for this object, if any, must first be deleted using
9961	<link to="#deleteStorage"/>, otherwise the operation will fail.
9962
9963	Before the operation starts, the medium is placed in
9964	<link to="MediumState_Creating"/> state. If the create operation
9965	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9966	state.
9967
9968	After the returned progress object reports that the operation has
9969	successfully completed, the medium state will be set to <link
9970	to="MediumState_Created"/>, the medium will be remembered by this
9971	VirtualBox installation and may be attached to virtual machines.
9972
9973	<result name="VBOX_E_NOT_SUPPORTED">
9974	The variant of storage creation operation is not supported. See <link
9975	to="IMediumFormat::capabilities"/>.
9976	</result>
9977	</desc>
9978	<param name="logicalSize" type="long long" dir="in">
9979	<desc>Maximum logical size of the medium in bytes.</desc>
9980	</param>
9981	<param name="variant" type="MediumVariant" dir="in">
9982	<desc>Exact image variant which should be created.</desc>
9983	</param>
9984	<param name="progress" type="IProgress" dir="return">
9985	<desc>Progress object to track the operation completion.</desc>
9986	</param>
9987	</method>
9988
9989	<method name="deleteStorage">
9990	<desc>
9991	Starts deleting the storage unit of this medium.
9992
9993	The medium must not be attached to any known virtual machine and must
9994	not have any known child media, otherwise the operation will fail.
9995	It will also fail if there is no storage unit to delete or if deletion
9996	is already in progress, or if the medium is being in use (locked for
9997	read or for write) or inaccessible. Therefore, the only valid state for
9998	this operation to succeed is <link to="MediumState_Created"/>.
9999
10000	Before the operation starts, the medium is placed in
10001	<link to="MediumState_Deleting"/> state and gets removed from the list
10002	of remembered hard disks (media registry). If the delete operation
10003	fails, the medium will be remembered again and placed back to
10004	<link to="MediumState_Created"/> state.
10005
10006	After the returned progress object reports that the operation is
10007	complete, the medium state will be set to
10008	<link to="MediumState_NotCreated"/> and you will be able to use one of
10009	the storage creation methods to create it again.
10010
10011	<see>#close()</see>
10012
10013	<result name="VBOX_E_OBJECT_IN_USE">
10014	Medium is attached to a virtual machine.
10015	</result>
10016	<result name="VBOX_E_NOT_SUPPORTED">
10017	Storage deletion is not allowed because neither of storage creation
10018	operations are supported. See
10019	<link to="IMediumFormat::capabilities"/>.
10020	</result>
10021
10022	<note>
10023	If the deletion operation fails, it is not guaranteed that the storage
10024	unit still exists. You may check the <link to="IMedium::state"/> value
10025	to answer this question.
10026	</note>
10027	</desc>
10028	<param name="progress" type="IProgress" dir="return">
10029	<desc>Progress object to track the operation completion.</desc>
10030	</param>
10031	</method>
10032
10033	<!-- diff methods -->
10034
10035	<method name="createDiffStorage">
10036	<desc>
10037	Starts creating an empty differencing storage unit based on this
10038	medium in the format and at the location defined by the @a target
10039	argument.
10040
10041	The target medium must be in <link to="MediumState_NotCreated"/>
10042	state (i.e. must not have an existing storage unit). Upon successful
10043	completion, this operation will set the type of the target medium to
10044	<link to="MediumType_Normal"/> and create a storage unit necessary to
10045	represent the differencing medium data in the given format (according
10046	to the storage format of the target object).
10047
10048	After the returned progress object reports that the operation is
10049	successfully complete, the target medium gets remembered by this
10050	VirtualBox installation and may be attached to virtual machines.
10051
10052	<note>
10053	The medium will be set to <link to="MediumState_LockedRead"/>
10054	state for the duration of this operation.
10055	</note>
10056	<result name="VBOX_E_OBJECT_IN_USE">
10057	Medium not in @c NotCreated state.
10058	</result>
10059	</desc>
10060	<param name="target" type="IMedium" dir="in">
10061	<desc>Target medium.</desc>
10062	</param>
10063	<param name="variant" type="MediumVariant" dir="in">
10064	<desc>Exact image variant which should be created.</desc>
10065	</param>
10066	<param name="progress" type="IProgress" dir="return">
10067	<desc>Progress object to track the operation completion.</desc>
10068	</param>
10069	</method>
10070
10071	<method name="mergeTo">
10072	<desc>
10073	Starts merging the contents of this medium and all intermediate
10074	differencing media in the chain to the given target medium.
10075
10076	The target medium must be either a descendant of this medium or
10077	its ancestor (otherwise this method will immediately return a failure).
10078	It follows that there are two logical directions of the merge operation:
10079	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10080	ancestor (<i>backward merge</i>). Let us consider the following medium
10081	chain:
10082
10083	<pre>Base <- Diff_1 <- Diff_2</pre>
10084
10085	Here, calling this method on the <tt>Base</tt> medium object with
10086	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10087	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10088	merge. Note that in both cases the contents of the resulting medium
10089	will be the same, the only difference is the medium object that takes
10090	the result of the merge operation. In case of the forward merge in the
10091	above example, the result will be written to <tt>Diff_2</tt>; in case of
10092	the backward merge, the result will be written to <tt>Base</tt>. In
10093	other words, the result of the operation is always stored in the target
10094	medium.
10095
10096	Upon successful operation completion, the storage units of all media in
10097	the chain between this (source) medium and the target medium, including
10098	the source medium itself, will be automatically deleted and the
10099	relevant medium objects (including this medium) will become
10100	uninitialized. This means that any attempt to call any of
10101	their methods or attributes will fail with the
10102	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10103	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10104	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10105	Note that <tt>Diff_2</tt> in this case will become a base medium
10106	itself since it will no longer be based on any other medium.
10107
10108	Considering the above, all of the following conditions must be met in
10109	order for the merge operation to succeed:
10110	<ul>
10111	<li>
10112	Neither this (source) medium nor any intermediate
10113	differencing medium in the chain between it and the target
10114	medium is attached to any virtual machine.
10115	</li>
10116	<li>
10117	Neither the source medium nor the target medium is an
10118	<link to="MediumType_Immutable"/> medium.
10119	</li>
10120	<li>
10121	The part of the medium tree from the source medium to the
10122	target medium is a linear chain, i.e. all medium in this
10123	chain have exactly one child which is the next medium in this
10124	chain. The only exception from this rule is the target medium in
10125	the forward merge operation; it is allowed to have any number of
10126	child media because the merge operation will not change its
10127	logical contents (as it is seen by the guest OS or by children).
10128	</li>
10129	<li>
10130	None of the involved media are in
10131	<link to="MediumState_LockedRead"/> or
10132	<link to="MediumState_LockedWrite"/> state.
10133	</li>
10134	</ul>
10135
10136	<note>
10137	This (source) medium and all intermediates will be placed to <link
10138	to="MediumState_Deleting"/> state and the target medium will be
10139	placed to <link to="MediumState_LockedWrite"/> state and for the
10140	duration of this operation.
10141	</note>
10142	</desc>
10143	<param name="target" type="IMedium" dir="in">
10144	<desc>Target medium.</desc>
10145	</param>
10146	<param name="progress" type="IProgress" dir="return">
10147	<desc>Progress object to track the operation completion.</desc>
10148	</param>
10149	</method>
10150
10151	<!-- clone method -->
10152
10153	<method name="cloneTo">
10154	<desc>
10155	Starts creating a clone of this medium in the format and at the
10156	location defined by the @a target argument.
10157
10158	The target medium must be either in <link to="MediumState_NotCreated"/>
10159	state (i.e. must not have an existing storage unit) or in
10160	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10161	big enough to hold the data or else the copy will be partial). Upon
10162	successful completion, the cloned medium will contain exactly the
10163	same sector data as the medium being cloned, except that in the
10164	first case a new UUID for the clone will be randomly generated, and in
10165	the second case the UUID will remain unchanged.
10166
10167	The @a parent argument defines which medium will be the parent
10168	of the clone. Passing a @c null reference indicates that the clone will
10169	be a base image, i.e. completely independent. It is possible to specify
10170	an arbitrary medium for this parameter, including the parent of the
10171	medium which is being cloned. Even cloning to a child of the source
10172	medium is possible. Note that when cloning to an existing image, the
10173	@a parent irgument is ignored.
10174
10175	After the returned progress object reports that the operation is
10176	successfully complete, the target medium gets remembered by this
10177	VirtualBox installation and may be attached to virtual machines.
10178
10179	<note>
10180	This medium will be placed to <link to="MediumState_LockedRead"/>
10181	state for the duration of this operation.
10182	</note>
10183	<result name="E_NOTIMPL">
10184	The specified cloning variant is not supported at the moment.
10185	</result>
10186	</desc>
10187	<param name="target" type="IMedium" dir="in">
10188	<desc>Target medium.</desc>
10189	</param>
10190	<param name="variant" type="MediumVariant" dir="in">
10191	<desc>Exact image variant which should be created.</desc>
10192	</param>
10193	<param name="parent" type="IMedium" dir="in">
10194	<desc>Parent of the cloned medium.</desc>
10195	</param>
10196	<param name="progress" type="IProgress" dir="return">
10197	<desc>Progress object to track the operation completion.</desc>
10198	</param>
10199	</method>
10200
10201	<!-- other methods -->
10202
10203	<method name="compact">
10204	<desc>
10205	Starts compacting of this medium. This means that the medium is
10206	transformed into a possibly more compact storage representation.
10207	This potentially creates temporary images, which can require a
10208	substantial amount of additional disk space.
10209
10210	This medium will be placed to <link to="MediumState_LockedWrite"/>
10211	state and all its parent media (if any) will be placed to
10212	<link to="MediumState_LockedRead"/> state for the duration of this
10213	operation.
10214
10215	Please note that the results can be either returned straight away,
10216	or later as the result of the background operation via the object
10217	returned via the @a progress parameter.
10218
10219	<result name="VBOX_E_NOT_SUPPORTED">
10220	Medium format does not support compacting (but potentially
10221	needs it).
10222	</result>
10223	</desc>
10224	<param name="progress" type="IProgress" dir="return">
10225	<desc>Progress object to track the operation completion.</desc>
10226	</param>
10227	</method>
10228
10229	<method name="resize">
10230	<desc>
10231	Starts resizing this medium. This means that the nominal size of the
10232	medium is set to the new value. Both increasing and decreasing the
10233	size is possible, and there are no safety checks, since VirtualBox
10234	does not make any assumptions about the medium contents.
10235
10236	Resizing usually needs additional disk space, and possibly also
10237	some temporary disk space. Note that resize does not create a full
10238	temporary copy of the medium, so the additional disk space requirement
10239	is usually much lower than using the clone operation.
10240
10241	This medium will be placed to <link to="MediumState_LockedWrite"/>
10242	state for the duration of this operation.
10243
10244	Please note that the results can be either returned straight away,
10245	or later as the result of the background operation via the object
10246	returned via the @a progress parameter.
10247
10248	<result name="VBOX_E_NOT_SUPPORTED">
10249	Medium format does not support resizing.
10250	</result>
10251	</desc>
10252	<param name="logicalSize" type="long long" dir="in">
10253	<desc>New nominal capacity of the medium in bytes.</desc>
10254	</param>
10255	<param name="progress" type="IProgress" dir="return">
10256	<desc>Progress object to track the operation completion.</desc>
10257	</param>
10258	</method>
10259
10260	<method name="reset">
10261	<desc>
10262	Starts erasing the contents of this differencing medium.
10263
10264	This operation will reset the differencing medium to its initial
10265	state when it does not contain any sector data and any read operation is
10266	redirected to its parent medium. This automatically gets called
10267	during VM power-up for every medium whose <link to="#autoReset" />
10268	attribute is @c true.
10269
10270	The medium will be write-locked for the duration of this operation (see
10271	<link to="#lockWrite" />).
10272
10273	<result name="VBOX_E_NOT_SUPPORTED">
10274	This is not a differencing medium.
10275	</result>
10276	<result name="VBOX_E_INVALID_OBJECT_STATE">
10277	Medium is not in <link to="MediumState_Created"/> or
10278	<link to="MediumState_Inaccessible"/> state.
10279	</result>
10280	</desc>
10281	<param name="progress" type="IProgress" dir="return">
10282	<desc>Progress object to track the operation completion.</desc>
10283	</param>
10284	</method>
10285
10286	</interface>
10287
10288
10289	<!--
10290	// IMediumFormat
10291	/////////////////////////////////////////////////////////////////////////
10292	-->
10293
10294	<enum
10295	name="DataType"
10296	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10297	>
10298	<const name="Int32" value="0"/>
10299	<const name="Int8" value="1"/>
10300	<const name="String" value="2"/>
10301	</enum>
10302
10303	<enum
10304	name="DataFlags"
10305	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10306	>
10307	<const name="None" value="0x00"/>
10308	<const name="Mandatory" value="0x01"/>
10309	<const name="Expert" value="0x02"/>
10310	<const name="Array" value="0x04"/>
10311	<const name="FlagMask" value="0x07"/>
10312	</enum>
10313
10314	<enum
10315	name="MediumFormatCapabilities"
10316	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10317	>
10318	<desc>
10319	Medium format capability flags.
10320	</desc>
10321
10322	<const name="Uuid" value="0x01">
10323	<desc>
10324	Supports UUIDs as expected by VirtualBox code.
10325	</desc>
10326	</const>
10327
10328	<const name="CreateFixed" value="0x02">
10329	<desc>
10330	Supports creating fixed size images, allocating all space instantly.
10331	</desc>
10332	</const>
10333
10334	<const name="CreateDynamic" value="0x04">
10335	<desc>
10336	Supports creating dynamically growing images, allocating space on
10337	demand.
10338	</desc>
10339	</const>
10340
10341	<const name="CreateSplit2G" value="0x08">
10342	<desc>
10343	Supports creating images split in chunks of a bit less than 2 GBytes.
10344	</desc>
10345	</const>
10346
10347	<const name="Differencing" value="0x10">
10348	<desc>
10349	Supports being used as a format for differencing media (see <link
10350	to="IMedium::createDiffStorage"/>).
10351	</desc>
10352	</const>
10353
10354	<const name="Asynchronous" value="0x20">
10355	<desc>
10356	Supports asynchronous I/O operations for at least some configurations.
10357	</desc>
10358	</const>
10359
10360	<const name="File" value="0x40">
10361	<desc>
10362	The format backend operates on files (the <link to="IMedium::location"/>
10363	attribute of the medium specifies a file used to store medium
10364	data; for a list of supported file extensions see
10365	<link to="IMediumFormat::describeFileExtensions"/>).
10366	</desc>
10367	</const>
10368
10369	<const name="Properties" value="0x80">
10370	<desc>
10371	The format backend uses the property interface to configure the storage
10372	location and properties (the <link to="IMediumFormat::describeProperties"/>
10373	method is used to get access to properties supported by the given medium format).
10374	</desc>
10375	</const>
10376
10377	<const name="TcpNetworking" value="0x100">
10378	<desc>
10379	The format backend uses the TCP networking interface for network access.
10380	</desc>
10381	</const>
10382
10383	<const name="VFS" value="0x200">
10384	<desc>
10385	The format backend supports virtual filesystem functionality.
10386	</desc>
10387	</const>
10388
10389	<const name="CapabilityMask" value="0x3FF"/>
10390	</enum>
10391
10392	<interface
10393	name="IMediumFormat" extends="$unknown"
10394	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10395	wsmap="managed"
10396	>
10397	<desc>
10398	The IMediumFormat interface represents a medium format.
10399
10400	Each medium format has an associated backend which is used to handle
10401	media stored in this format. This interface provides information
10402	about the properties of the associated backend.
10403
10404	Each medium format is identified by a string represented by the
10405	<link to="#id"/> attribute. This string is used in calls like
10406	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10407	format.
10408
10409	The list of all supported medium formats can be obtained using
10410	<link to="ISystemProperties::mediumFormats"/>.
10411
10412	<see>IMedium</see>
10413	</desc>
10414
10415	<attribute name="id" type="wstring" readonly="yes">
10416	<desc>
10417	Identifier of this format.
10418
10419	The format identifier is a non-@c null non-empty ASCII string. Note that
10420	this string is case-insensitive. This means that, for example, all of
10421	the following strings:
10422	<pre>
10423	"VDI"
10424	"vdi"
10425	"VdI"</pre>
10426	refer to the same medium format.
10427
10428	This string is used in methods of other interfaces where it is necessary
10429	to specify a medium format, such as
10430	<link to="IVirtualBox::createHardDisk"/>.
10431	</desc>
10432	</attribute>
10433
10434	<attribute name="name" type="wstring" readonly="yes">
10435	<desc>
10436	Human readable description of this format.
10437
10438	Mainly for use in file open dialogs.
10439	</desc>
10440	</attribute>
10441
10442	<attribute name="capabilities" type="unsigned long" readonly="yes">
10443	<desc>
10444	Capabilities of the format as a set of bit flags.
10445
10446	For the meaning of individual capability flags see
10447	<link to="MediumFormatCapabilities"/>.
10448	</desc>
10449	</attribute>
10450
10451	<method name="describeFileExtensions">
10452	<desc>
10453	Returns two arrays describing the supported file extensions.
10454
10455	The first array contains the supported extensions and the seconds one
10456	the type each extension supports. Both have the same size.
10457
10458	Note that some backends do not work on files, so this array may be
10459	empty.
10460
10461	<see>IMediumFormat::capabilities</see>
10462	</desc>
10463	<param name="extensions" type="wstring" safearray="yes" dir="out">
10464	<desc>The array of supported extensions.</desc>
10465	</param>
10466	<param name="type" type="DeviceType" safearray="yes" dir="out">
10467	<desc>The array which indicates the device type for every given extension.</desc>
10468	</param>
10469	</method>
10470
10471	<method name="describeProperties">
10472	<desc>
10473	Returns several arrays describing the properties supported by this
10474	format.
10475
10476	An element with the given index in each array describes one
10477	property. Thus, the number of elements in each returned array is the
10478	same and corresponds to the number of supported properties.
10479
10480	The returned arrays are filled in only if the
10481	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10482	All arguments must be non-@c null.
10483
10484	<see>DataType</see>
10485	<see>DataFlags</see>
10486	</desc>
10487
10488	<param name="names" type="wstring" safearray="yes" dir="out">
10489	<desc>Array of property names.</desc>
10490	</param>
10491	<param name="description" type="wstring" safearray="yes" dir="out">
10492	<desc>Array of property descriptions.</desc>
10493	</param>
10494	<param name="types" type="DataType" safearray="yes" dir="out">
10495	<desc>Array of property types.</desc>
10496	</param>
10497	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10498	<desc>Array of property flags.</desc>
10499	</param>
10500	<param name="defaults" type="wstring" safearray="yes" dir="out">
10501	<desc>Array of default property values.</desc>
10502	</param>
10503	</method>
10504
10505	</interface>
10506
10507
10508	<!--
10509	// IKeyboard
10510	/////////////////////////////////////////////////////////////////////////
10511	-->
10512
10513	<interface
10514	name="IKeyboard" extends="$unknown"
10515	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10516	wsmap="managed"
10517	>
10518	<desc>
10519	The IKeyboard interface represents the virtual machine's keyboard. Used
10520	in <link to="IConsole::keyboard"/>.
10521
10522	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10523	to the virtual machine.
10524
10525	</desc>
10526	<method name="putScancode">
10527	<desc>Sends a scancode to the keyboard.
10528
10529	<result name="VBOX_E_IPRT_ERROR">
10530	Could not send scan code to virtual keyboard.
10531	</result>
10532
10533	</desc>
10534	<param name="scancode" type="long" dir="in"/>
10535	</method>
10536
10537	<method name="putScancodes">
10538	<desc>Sends an array of scancodes to the keyboard.
10539
10540	<result name="VBOX_E_IPRT_ERROR">
10541	Could not send all scan codes to virtual keyboard.
10542	</result>
10543
10544	</desc>
10545	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10546	<param name="codesStored" type="unsigned long" dir="return"/>
10547	</method>
10548
10549	<method name="putCAD">
10550	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10551	function is nothing special, it is just a convenience function
10552	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10553
10554	<result name="VBOX_E_IPRT_ERROR">
10555	Could not send all scan codes to virtual keyboard.
10556	</result>
10557
10558	</desc>
10559	</method>
10560
10561	<attribute name="eventSource" type="IEventSource" readonly="yes">
10562	<desc>
10563	Event source for keyboard events.
10564	</desc>
10565	</attribute>
10566
10567	</interface>
10568
10569
10570	<!--
10571	// IMouse
10572	/////////////////////////////////////////////////////////////////////////
10573	-->
10574
10575	<enum
10576	name="MouseButtonState"
10577	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10578	>
10579	<desc>
10580	Mouse button state.
10581	</desc>
10582
10583	<const name="LeftButton" value="0x01"/>
10584	<const name="RightButton" value="0x02"/>
10585	<const name="MiddleButton" value="0x04"/>
10586	<const name="WheelUp" value="0x08"/>
10587	<const name="WheelDown" value="0x10"/>
10588	<const name="XButton1" value="0x20"/>
10589	<const name="XButton2" value="0x40"/>
10590	<const name="MouseStateMask" value="0x7F"/>
10591	</enum>
10592
10593	<interface
10594	name="IMouse" extends="$unknown"
10595	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10596	wsmap="managed"
10597	>
10598	<desc>
10599	The IMouse interface represents the virtual machine's mouse. Used in
10600	<link to="IConsole::mouse"/>.
10601
10602	Through this interface, the virtual machine's virtual mouse can be
10603	controlled.
10604	</desc>
10605
10606	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10607	<desc>
10608	Whether the guest OS supports absolute mouse pointer positioning
10609	or not.
10610	<note>
10611	You can use the <link to="IMouseCapabilityChangedEvent"/>
10612	event to be instantly informed about changes of this attribute
10613	during virtual machine execution.
10614	</note>
10615	<see><link to="#putMouseEventAbsolute"/></see>
10616	</desc>
10617	</attribute>
10618
10619	<attribute name="relativeSupported" type="boolean" readonly="yes">
10620	<desc>
10621	Whether the guest OS supports relative mouse pointer positioning
10622	or not.
10623	<note>
10624	You can use the <link to="IMouseCapabilityChangedEvent"/>
10625	event to be instantly informed about changes of this attribute
10626	during virtual machine execution.
10627	</note>
10628	<see><link to="#putMouseEvent"/></see>
10629	</desc>
10630	</attribute>
10631
10632	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10633	<desc>
10634	Whether the guest OS can currently switch to drawing it's own mouse
10635	cursor on demand.
10636	<note>
10637	You can use the <link to="IMouseCapabilityChangedEvent"/>
10638	event to be instantly informed about changes of this attribute
10639	during virtual machine execution.
10640	</note>
10641	<see><link to="#putMouseEvent"/></see>
10642	</desc>
10643	</attribute>
10644
10645	<method name="putMouseEvent">
10646	<desc>
10647	Initiates a mouse event using relative pointer movements
10648	along x and y axis.
10649
10650	<result name="E_ACCESSDENIED">
10651	Console not powered up.
10652	</result>
10653	<result name="VBOX_E_IPRT_ERROR">
10654	Could not send mouse event to virtual mouse.
10655	</result>
10656
10657	</desc>
10658
10659	<param name="dx" type="long" dir="in">
10660	<desc>
10661	Amount of pixels the mouse should move to the right.
10662	Negative values move the mouse to the left.
10663	</desc>
10664	</param>
10665	<param name="dy" type="long" dir="in">
10666	<desc>
10667	Amount of pixels the mouse should move downwards.
10668	Negative values move the mouse upwards.
10669	</desc>
10670	</param>
10671	<param name="dz" type="long" dir="in">
10672	<desc>
10673	Amount of mouse wheel moves.
10674	Positive values describe clockwise wheel rotations,
10675	negative values describe counterclockwise rotations.
10676	</desc>
10677	</param>
10678	<param name="dw" type="long" dir="in">
10679	<desc>
10680	Amount of horizontal mouse wheel moves.
10681	Positive values describe a movement to the left,
10682	negative values describe a movement to the right.
10683	</desc>
10684	</param>
10685	<param name="buttonState" type="long" dir="in">
10686	<desc>
10687	The current state of mouse buttons. Every bit represents
10688	a mouse button as follows:
10689	<table>
10690	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10691	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10692	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10693	</table>
10694	A value of <tt>1</tt> means the corresponding button is pressed.
10695	otherwise it is released.
10696	</desc>
10697	</param>
10698	</method>
10699
10700	<method name="putMouseEventAbsolute">
10701	<desc>
10702	Positions the mouse pointer using absolute x and y coordinates.
10703	These coordinates are expressed in pixels and
10704	start from <tt>[1,1]</tt> which corresponds to the top left
10705	corner of the virtual display.
10706
10707	<result name="E_ACCESSDENIED">
10708	Console not powered up.
10709	</result>
10710	<result name="VBOX_E_IPRT_ERROR">
10711	Could not send mouse event to virtual mouse.
10712	</result>
10713
10714	<note>
10715	This method will have effect only if absolute mouse
10716	positioning is supported by the guest OS.
10717	</note>
10718
10719	<see><link to="#absoluteSupported"/></see>
10720	</desc>
10721
10722	<param name="x" type="long" dir="in">
10723	<desc>
10724	X coordinate of the pointer in pixels, starting from @c 1.
10725	</desc>
10726	</param>
10727	<param name="y" type="long" dir="in">
10728	<desc>
10729	Y coordinate of the pointer in pixels, starting from @c 1.
10730	</desc>
10731	</param>
10732	<param name="dz" type="long" dir="in">
10733	<desc>
10734	Amount of mouse wheel moves.
10735	Positive values describe clockwise wheel rotations,
10736	negative values describe counterclockwise rotations.
10737	</desc>
10738	</param>
10739	<param name="dw" type="long" dir="in">
10740	<desc>
10741	Amount of horizontal mouse wheel moves.
10742	Positive values describe a movement to the left,
10743	negative values describe a movement to the right.
10744	</desc>
10745	</param>
10746	<param name="buttonState" type="long" dir="in">
10747	<desc>
10748	The current state of mouse buttons. Every bit represents
10749	a mouse button as follows:
10750	<table>
10751	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10752	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10753	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10754	</table>
10755	A value of @c 1 means the corresponding button is pressed.
10756	otherwise it is released.
10757	</desc>
10758	</param>
10759	</method>
10760
10761	<attribute name="eventSource" type="IEventSource" readonly="yes">
10762	<desc>
10763	Event source for mouse events.
10764	</desc>
10765	</attribute>
10766
10767	</interface>
10768
10769	<!--
10770	// IDisplay
10771	/////////////////////////////////////////////////////////////////////////
10772	-->
10773
10774	<enum
10775	name="FramebufferPixelFormat"
10776	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10777	>
10778	<desc>
10779	Format of the video memory buffer. Constants represented by this enum can
10780	be used to test for particular values of <link
10781	to="IFramebuffer::pixelFormat"/>. See also <link
10782	to="IFramebuffer::requestResize"/>.
10783
10784	See also www.fourcc.org for more information about FOURCC pixel formats.
10785	</desc>
10786
10787	<const name="Opaque" value="0">
10788	<desc>
10789	Unknown buffer format (the user may not assume any particular format of
10790	the buffer).
10791	</desc>
10792	</const>
10793	<const name="FOURCC_RGB" value="0x32424752">
10794	<desc>
10795	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10796	bit layout).
10797	</desc>
10798	</const>
10799	</enum>
10800
10801	<interface
10802	name="IFramebuffer" extends="$unknown"
10803	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10804	wsmap="suppress"
10805	>
10806	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10807	<desc>Address of the start byte of the frame buffer.</desc>
10808	</attribute>
10809
10810	<attribute name="width" type="unsigned long" readonly="yes">
10811	<desc>Frame buffer width, in pixels.</desc>
10812	</attribute>
10813
10814	<attribute name="height" type="unsigned long" readonly="yes">
10815	<desc>Frame buffer height, in pixels.</desc>
10816	</attribute>
10817
10818	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10819	<desc>
10820	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10821	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10822	are: 8, 15, 16, 24 and 32.
10823	</desc>
10824	</attribute>
10825
10826	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10827	<desc>
10828	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10829	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10830	size of the scan line must be aligned to 32 bits.
10831	</desc>
10832	</attribute>
10833
10834	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10835	<desc>
10836	Frame buffer pixel format. It's either one of the values defined by <link
10837	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10838	<note>
10839	This attribute must never return <link
10840	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10841	<link to="#address"/> points to must be always known.
10842	</note>
10843	</desc>
10844	</attribute>
10845
10846	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10847	<desc>
10848	Defines whether this frame buffer uses the virtual video card's memory
10849	buffer (guest VRAM) directly or not. See <link
10850	to="IFramebuffer::requestResize"/> for more information.
10851	</desc>
10852	</attribute>
10853
10854	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10855	<desc>
10856	Hint from the frame buffer about how much of the standard
10857	screen height it wants to use for itself. This information is
10858	exposed to the guest through the VESA BIOS and VMMDev interface
10859	so that it can use it for determining its video mode table. It
10860	is not guaranteed that the guest respects the value.
10861	</desc>
10862	</attribute>
10863
10864	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10865	<desc>
10866	An alpha-blended overlay which is superposed over the frame buffer.
10867	The initial purpose is to allow the display of icons providing
10868	information about the VM state, including disk activity, in front
10869	ends which do not have other means of doing that. The overlay is
10870	designed to controlled exclusively by IDisplay. It has no locking
10871	of its own, and any changes made to it are not guaranteed to be
10872	visible until the affected portion of IFramebuffer is updated. The
10873	overlay can be created lazily the first time it is requested. This
10874	attribute can also return @c null to signal that the overlay is not
10875	implemented.
10876	</desc>
10877	</attribute>
10878
10879	<attribute name="winId" type="long long" readonly="yes">
10880	<desc>
10881	Platform-dependent identifier of the window where context of this
10882	frame buffer is drawn, or zero if there's no such window.
10883	</desc>
10884	</attribute>
10885
10886	<method name="lock">
10887	<desc>
10888	Locks the frame buffer.
10889	Gets called by the IDisplay object where this frame buffer is
10890	bound to.
10891	</desc>
10892	</method>
10893
10894	<method name="unlock">
10895	<desc>
10896	Unlocks the frame buffer.
10897	Gets called by the IDisplay object where this frame buffer is
10898	bound to.
10899	</desc>
10900	</method>
10901
10902	<method name="notifyUpdate">
10903	<desc>
10904	Informs about an update.
10905	Gets called by the display object where this buffer is
10906	registered.
10907	</desc>
10908	<param name="x" type="unsigned long" dir="in"/>
10909	<param name="y" type="unsigned long" dir="in"/>
10910	<param name="width" type="unsigned long" dir="in"/>
10911	<param name="height" type="unsigned long" dir="in"/>
10912	</method>
10913
10914	<method name="requestResize">
10915	<desc>
10916	Requests a size and pixel format change.
10917
10918	There are two modes of working with the video buffer of the virtual
10919	machine. The <i>indirect</i> mode implies that the IFramebuffer
10920	implementation allocates a memory buffer for the requested display mode
10921	and provides it to the virtual machine. In <i>direct</i> mode, the
10922	IFramebuffer implementation uses the memory buffer allocated and owned
10923	by the virtual machine. This buffer represents the video memory of the
10924	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10925	usually faster because the implementation gets a raw pointer to the
10926	guest VRAM buffer which it can directly use for visualizing the contents
10927	of the virtual display, as opposed to the indirect mode where the
10928	contents of guest VRAM are copied to the memory buffer provided by
10929	the implementation every time a display update occurs.
10930
10931	It is important to note that the direct mode is really fast only when
10932	the implementation uses the given guest VRAM buffer directly, for
10933	example, by blitting it to the window representing the virtual machine's
10934	display, which saves at least one copy operation comparing to the
10935	indirect mode. However, using the guest VRAM buffer directly is not
10936	always possible: the format and the color depth of this buffer may be
10937	not supported by the target window, or it may be unknown (opaque) as in
10938	case of text or non-linear multi-plane VGA video modes. In this case,
10939	the indirect mode (that is always available) should be used as a
10940	fallback: when the guest VRAM contents are copied to the
10941	implementation-provided memory buffer, color and format conversion is
10942	done automatically by the underlying code.
10943
10944	The @a pixelFormat parameter defines whether the direct mode is
10945	available or not. If @a pixelFormat is <link
10946	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10947	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10948	@a bytesPerLine parameters must be ignored and the implementation must use
10949	the indirect mode (where it provides its own buffer in one of the
10950	supported formats). In all other cases, @a pixelFormat together with
10951	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10952	buffer pointed to by the @a VRAM parameter and the implementation is
10953	free to choose which mode to use. To indicate that this frame buffer uses
10954	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10955	attribute must return @c true and <link to="#address"/> must
10956	return exactly the same address that is passed in the @a VRAM parameter
10957	of this method; otherwise it is assumed that the indirect strategy is
10958	chosen.
10959
10960	The @a width and @a height parameters represent the size of the
10961	requested display mode in both modes. In case of indirect mode, the
10962	provided memory buffer should be big enough to store data of the given
10963	display mode. In case of direct mode, it is guaranteed that the given
10964	@a VRAM buffer contains enough space to represent the display mode of the
10965	given size. Note that this frame buffer's <link to="#width"/> and <link
10966	to="#height"/> attributes must return exactly the same values as
10967	passed to this method after the resize is completed (see below).
10968
10969	The @a finished output parameter determines if the implementation has
10970	finished resizing the frame buffer or not. If, for some reason, the
10971	resize cannot be finished immediately during this call, @a finished
10972	must be set to @c false, and the implementation must call
10973	<link to="IDisplay::resizeCompleted"/> after it has returned from
10974	this method as soon as possible. If @a finished is @c false, the
10975	machine will not call any frame buffer methods until
10976	<link to="IDisplay::resizeCompleted"/> is called.
10977
10978	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10979	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10980	this frame buffer must return exactly the same values as specified in the
10981	parameters of this method, after the resize is completed. If the
10982	indirect mode is chosen, these attributes must return values describing
10983	the format of the implementation's own memory buffer <link
10984	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10985	value must always correlate with <link to="#pixelFormat"/>. Note that
10986	the <link to="#pixelFormat"/> attribute must never return <link
10987	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10988
10989	<note>
10990	This method is called by the IDisplay object under the
10991	<link to="#lock"/> provided by this IFramebuffer
10992	implementation. If this method returns @c false in @a finished, then
10993	this lock is not released until
10994	<link to="IDisplay::resizeCompleted"/> is called.
10995	</note>
10996	</desc>
10997	<param name="screenId" type="unsigned long" dir="in">
10998	<desc>
10999	Logical screen number. Must be used in the corresponding call to
11000	<link to="IDisplay::resizeCompleted"/> if this call is made.
11001	</desc>
11002	</param>
11003	<param name="pixelFormat" type="unsigned long" dir="in">
11004	<desc>
11005	Pixel format of the memory buffer pointed to by @a VRAM.
11006	See also <link to="FramebufferPixelFormat"/>.
11007	</desc>
11008	</param>
11009	<param name="VRAM" type="octet" mod="ptr" dir="in">
11010	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11011	</param>
11012	<param name="bitsPerPixel" type="unsigned long" dir="in">
11013	<desc>Color depth, bits per pixel.</desc>
11014	</param>
11015	<param name="bytesPerLine" type="unsigned long" dir="in">
11016	<desc>Size of one scan line, in bytes.</desc>
11017	</param>
11018	<param name="width" type="unsigned long" dir="in">
11019	<desc>Width of the guest display, in pixels.</desc>
11020	</param>
11021	<param name="height" type="unsigned long" dir="in">
11022	<desc>Height of the guest display, in pixels.</desc>
11023	</param>
11024	<param name="finished" type="boolean" dir="return">
11025	<desc>
11026	Can the VM start using the new frame buffer immediately
11027	after this method returns or it should wait for
11028	<link to="IDisplay::resizeCompleted"/>.
11029	</desc>
11030	</param>
11031	</method>
11032
11033	<method name="videoModeSupported">
11034	<desc>
11035	Returns whether the frame buffer implementation is willing to
11036	support a given video mode. In case it is not able to render
11037	the video mode (or for some reason not willing), it should
11038	return @c false. Usually this method is called when the guest
11039	asks the VMM device whether a given video mode is supported
11040	so the information returned is directly exposed to the guest.
11041	It is important that this method returns very quickly.
11042	</desc>
11043	<param name="width" type="unsigned long" dir="in"/>
11044	<param name="height" type="unsigned long" dir="in"/>
11045	<param name="bpp" type="unsigned long" dir="in"/>
11046	<param name="supported" type="boolean" dir="return"/>
11047	</method>
11048
11049	<method name="getVisibleRegion">
11050	<desc>
11051	Returns the visible region of this frame buffer.
11052
11053	If the @a rectangles parameter is @c null then the value of the
11054	@a count parameter is ignored and the number of elements necessary to
11055	describe the current visible region is returned in @a countCopied.
11056
11057	If @a rectangles is not @c null but @a count is less
11058	than the required number of elements to store region data, the method
11059	will report a failure. If @a count is equal or greater than the
11060	required number of elements, then the actual number of elements copied
11061	to the provided array will be returned in @a countCopied.
11062
11063	<note>
11064	The address of the provided array must be in the process space of
11065	this IFramebuffer object.
11066	</note>
11067	<note>
11068	Method not yet implemented.
11069	</note>
11070	</desc>
11071	<param name="rectangles" type="octet" mod="ptr" dir="in">
11072	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11073	</param>
11074	<param name="count" type="unsigned long" dir="in">
11075	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11076	</param>
11077	<param name="countCopied" type="unsigned long" dir="return">
11078	<desc>Number of elements copied to the @a rectangles array.</desc>
11079	</param>
11080	</method>
11081
11082	<method name="setVisibleRegion">
11083	<desc>
11084	Suggests a new visible region to this frame buffer. This region
11085	represents the area of the VM display which is a union of regions of
11086	all top-level windows of the guest operating system running inside the
11087	VM (if the Guest Additions for this system support this
11088	functionality). This information may be used by the frontends to
11089	implement the seamless desktop integration feature.
11090
11091	<note>
11092	The address of the provided array must be in the process space of
11093	this IFramebuffer object.
11094	</note>
11095	<note>
11096	The IFramebuffer implementation must make a copy of the provided
11097	array of rectangles.
11098	</note>
11099	<note>
11100	Method not yet implemented.
11101	</note>
11102	</desc>
11103	<param name="rectangles" type="octet" mod="ptr" dir="in">
11104	<desc>Pointer to the @c RTRECT array.</desc>
11105	</param>
11106	<param name="count" type="unsigned long" dir="in">
11107	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11108	</param>
11109	</method>
11110
11111	<method name="processVHWACommand">
11112	<desc>
11113	Posts a Video HW Acceleration Command to the frame buffer for processing.
11114	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11115	are posted from quest to the host to be processed by the host hardware.
11116
11117	<note>
11118	The address of the provided command must be in the process space of
11119	this IFramebuffer object.
11120	</note>
11121	</desc>
11122
11123	<param name="command" type="octet" mod="ptr" dir="in">
11124	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11125	</param>
11126	</method>
11127
11128	</interface>
11129
11130	<interface
11131	name="IFramebufferOverlay" extends="IFramebuffer"
11132	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11133	wsmap="suppress"
11134	>
11135	<desc>
11136	The IFramebufferOverlay interface represents an alpha blended overlay
11137	for displaying status icons above an IFramebuffer. It is always created
11138	not visible, so that it must be explicitly shown. It only covers a
11139	portion of the IFramebuffer, determined by its width, height and
11140	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11141	that order) format, and may be written to directly. Do re-read the
11142	width though, after setting it, as it may be adjusted (increased) to
11143	make it more suitable for the front end.
11144	</desc>
11145	<attribute name="x" type="unsigned long" readonly="yes">
11146	<desc>X position of the overlay, relative to the frame buffer.</desc>
11147	</attribute>
11148
11149	<attribute name="y" type="unsigned long" readonly="yes">
11150	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11151	</attribute>
11152
11153	<attribute name="visible" type="boolean" readonly="no">
11154	<desc>
11155	Whether the overlay is currently visible.
11156	</desc>
11157	</attribute>
11158
11159	<attribute name="alpha" type="unsigned long" readonly="no">
11160	<desc>
11161	The global alpha value for the overlay. This may or may not be
11162	supported by a given front end.
11163	</desc>
11164	</attribute>
11165
11166	<method name="move">
11167	<desc>
11168	Changes the overlay's position relative to the IFramebuffer.
11169	</desc>
11170	<param name="x" type="unsigned long" dir="in"/>
11171	<param name="y" type="unsigned long" dir="in"/>
11172	</method>
11173
11174	</interface>
11175
11176	<interface
11177	name="IDisplay" extends="$unknown"
11178	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11179	wsmap="managed"
11180	>
11181	<desc>
11182	The IDisplay interface represents the virtual machine's display.
11183
11184	The object implementing this interface is contained in each
11185	<link to="IConsole::display"/> attribute and represents the visual
11186	output of the virtual machine.
11187
11188	The virtual display supports pluggable output targets represented by the
11189	IFramebuffer interface. Examples of the output target are a window on
11190	the host computer or an RDP session's display on a remote computer.
11191	</desc>
11192	<method name="getScreenResolution">
11193	<desc>Queries display width, height and color depth for given screen.</desc>
11194	<param name="screenId" type="unsigned long" dir="in"/>
11195	<param name="width" type="unsigned long" dir="out"/>
11196	<param name="height" type="unsigned long" dir="out"/>
11197	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11198	</method>
11199
11200	<method name="setFramebuffer">
11201	<desc>
11202	Sets the framebuffer for given screen.
11203	</desc>
11204	<param name="screenId" type="unsigned long" dir="in"/>
11205	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11206	</method>
11207
11208	<method name="getFramebuffer">
11209	<desc>
11210	Queries the framebuffer for given screen.
11211	</desc>
11212	<param name="screenId" type="unsigned long" dir="in"/>
11213	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11214	<param name="xOrigin" type="long" dir="out"/>
11215	<param name="yOrigin" type="long" dir="out"/>
11216	</method>
11217
11218	<method name="setVideoModeHint">
11219	<desc>
11220	Asks VirtualBox to request the given video mode from
11221	the guest. This is just a hint and it cannot be guaranteed
11222	that the requested resolution will be used. Guest Additions
11223	are required for the request to be seen by guests. The caller
11224	should issue the request and wait for a resolution change and
11225	after a timeout retry.
11226
11227	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11228	parameters means that the corresponding values should be taken from the
11229	current video mode (i.e. left unchanged).
11230
11231	If the guest OS supports multi-monitor configuration then the @a display
11232	parameter specifies the number of the guest display to send the hint to:
11233	@c 0 is the primary display, @c 1 is the first secondary and
11234	so on. If the multi-monitor configuration is not supported, @a display
11235	must be @c 0.
11236
11237	<result name="E_INVALIDARG">
11238	The @a display is not associated with any monitor.
11239	</result>
11240
11241	</desc>
11242	<param name="width" type="unsigned long" dir="in"/>
11243	<param name="height" type="unsigned long" dir="in"/>
11244	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11245	<param name="display" type="unsigned long" dir="in"/>
11246	</method>
11247
11248	<method name="setSeamlessMode">
11249	<desc>
11250	Enables or disables seamless guest display rendering (seamless desktop
11251	integration) mode.
11252	<note>
11253	Calling this method has no effect if <link
11254	to="IGuest::supportsSeamless"/> returns @c false.
11255	</note>
11256	</desc>
11257	<param name="enabled" type="boolean" dir="in"/>
11258	</method>
11259
11260	<method name="takeScreenShot">
11261	<desc>
11262	Takes a screen shot of the requested size and copies it to the
11263	32-bpp buffer allocated by the caller and pointed to by @a address.
11264	A pixel consists of 4 bytes in order: B, G, R, 0.
11265
11266	<note>This API can be used only by the COM/XPCOM C++ API as it
11267	requires pointer support. Use <link to="#takeScreenShotToArray" />
11268	with other language bindings.
11269	</note>
11270
11271	<result name="E_NOTIMPL">
11272	Feature not implemented.
11273	</result>
11274	<result name="VBOX_E_IPRT_ERROR">
11275	Could not take a screenshot.
11276	</result>
11277
11278	</desc>
11279	<param name="screenId" type="unsigned long" dir="in"/>
11280	<param name="address" type="octet" mod="ptr" dir="in"/>
11281	<param name="width" type="unsigned long" dir="in"/>
11282	<param name="height" type="unsigned long" dir="in"/>
11283	</method>
11284
11285	<method name="takeScreenShotToArray">
11286	<desc>
11287	Takes a guest screen shot of the requested size and returns it as
11288	an array of bytes in uncompressed 32-bit RGBA format.
11289	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11290
11291	This API is slow, but could be the only option to get guest screenshot
11292	for scriptable languages not allowed to manipulate with addresses
11293	directly.
11294
11295	<result name="E_NOTIMPL">
11296	Feature not implemented.
11297	</result>
11298	<result name="VBOX_E_IPRT_ERROR">
11299	Could not take a screenshot.
11300	</result>
11301	</desc>
11302	<param name="screenId" type="unsigned long" dir="in">
11303	<desc>
11304	Monitor to take screenshot from.
11305	</desc>
11306	</param>
11307	<param name="width" type="unsigned long" dir="in">
11308	<desc>
11309	Desired image width.
11310	</desc>
11311	</param>
11312	<param name="height" type="unsigned long" dir="in">
11313	<desc>
11314	Desired image height.
11315	</desc>
11316	</param>
11317	<param name="screenData" type="octet" dir="return" safearray="yes">
11318	<desc>
11319	Array with resulting screen data.
11320	</desc>
11321	</param>
11322	</method>
11323
11324	<method name="takeScreenShotPNGToArray">
11325	<desc>
11326	Takes a guest screen shot of the requested size and returns it as
11327	PNG image in array.
11328
11329	<result name="E_NOTIMPL">
11330	Feature not implemented.
11331	</result>
11332	<result name="VBOX_E_IPRT_ERROR">
11333	Could not take a screenshot.
11334	</result>
11335	</desc>
11336	<param name="screenId" type="unsigned long" dir="in">
11337	<desc>
11338	Monitor to take the screenshot from.
11339	</desc>
11340	</param>
11341	<param name="width" type="unsigned long" dir="in">
11342	<desc>
11343	Desired image width.
11344	</desc>
11345	</param>
11346	<param name="height" type="unsigned long" dir="in">
11347	<desc>
11348	Desired image height.
11349	</desc>
11350	</param>
11351	<param name="screenData" type="octet" dir="return" safearray="yes">
11352	<desc>
11353	Array with resulting screen data.
11354	</desc>
11355	</param>
11356	</method>
11357
11358	<method name="drawToScreen">
11359	<desc>
11360	Draws a 32-bpp image of the specified size from the given buffer
11361	to the given point on the VM display.
11362
11363	<result name="E_NOTIMPL">
11364	Feature not implemented.
11365	</result>
11366	<result name="VBOX_E_IPRT_ERROR">
11367	Could not draw to screen.
11368	</result>
11369
11370	</desc>
11371	<param name="screenId" type="unsigned long" dir="in">
11372	<desc>
11373	Monitor to take the screenshot from.
11374	</desc>
11375	</param>
11376	<param name="address" type="octet" mod="ptr" dir="in">
11377	<desc>
11378	Address to store the screenshot to
11379	</desc>
11380	</param>
11381	<param name="x" type="unsigned long" dir="in">
11382	<desc>
11383	Relative to the screen top left corner.
11384	</desc>
11385	</param>
11386	<param name="y" type="unsigned long" dir="in">
11387	<desc>
11388	Relative to the screen top left corner.
11389	</desc>
11390	</param>
11391	<param name="width" type="unsigned long" dir="in">
11392	<desc>
11393	Desired image width.
11394	</desc>
11395	</param>
11396	<param name="height" type="unsigned long" dir="in">
11397	<desc>
11398	Desired image height.
11399	</desc>
11400	</param>
11401	</method>
11402
11403	<method name="invalidateAndUpdate">
11404	<desc>
11405	Does a full invalidation of the VM display and instructs the VM
11406	to update it.
11407
11408	<result name="VBOX_E_IPRT_ERROR">
11409	Could not invalidate and update screen.
11410	</result>
11411
11412	</desc>
11413	</method>
11414
11415	<method name="resizeCompleted">
11416	<desc>
11417	Signals that a framebuffer has completed the resize operation.
11418
11419	<result name="VBOX_E_NOT_SUPPORTED">
11420	Operation only valid for external frame buffers.
11421	</result>
11422
11423	</desc>
11424	<param name="screenId" type="unsigned long" dir="in"/>
11425	</method>
11426
11427	<method name="completeVHWACommand">
11428	<desc>
11429	Signals that the Video HW Acceleration command has completed.
11430	</desc>
11431
11432	<param name="command" type="octet" mod="ptr" dir="in">
11433	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11434	</param>
11435	</method>
11436
11437	</interface>
11438
11439	<!--
11440	// INetworkAdapter
11441	/////////////////////////////////////////////////////////////////////////
11442	-->
11443
11444	<enum
11445	name="NetworkAttachmentType"
11446	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11447	>
11448	<desc>
11449	Network attachment type.
11450	</desc>
11451
11452	<const name="Null" value="0">
11453	<desc>Null value, also means "not attached".</desc>
11454	</const>
11455	<const name="NAT" value="1"/>
11456	<const name="Bridged" value="2"/>
11457	<const name="Internal" value="3"/>
11458	<const name="HostOnly" value="4"/>
11459	<const name="VDE" value="5"/>
11460	</enum>
11461
11462	<enum
11463	name="NetworkAdapterType"
11464	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11465	>
11466	<desc>
11467	Network adapter type.
11468	</desc>
11469
11470	<const name="Null" value="0">
11471	<desc>Null value (never used by the API).</desc>
11472	</const>
11473	<const name="Am79C970A" value="1">
11474	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11475	</const>
11476	<const name="Am79C973" value="2">
11477	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11478	</const>
11479	<const name="I82540EM" value="3">
11480	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11481	</const>
11482	<const name="I82543GC" value="4">
11483	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11484	</const>
11485	<const name="I82545EM" value="5">
11486	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11487	</const>
11488	<const name="Virtio" value="6">
11489	<desc>Virtio network device.</desc>
11490	</const>
11491	</enum>
11492
11493	<interface
11494	name="INetworkAdapter" extends="$unknown"
11495	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11496	wsmap="managed"
11497	>
11498	<desc>
11499	Represents a virtual network adapter that is attached to a virtual machine.
11500	Each virtual machine has a fixed number of network adapter slots with one
11501	instance of this attached to each of them. Call
11502	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11503	is attached to a given slot in a given machine.
11504
11505	Each network adapter can be in one of five attachment modes, which are
11506	represented by the <link to="NetworkAttachmentType" /> enumeration;
11507	see the <link to="#attachmentType" /> attribute.
11508	</desc>
11509
11510	<attribute name="adapterType" type="NetworkAdapterType">
11511	<desc>
11512	Type of the virtual network adapter. Depending on this value,
11513	VirtualBox will provide a different virtual network hardware
11514	to the guest.
11515	</desc>
11516	</attribute>
11517
11518	<attribute name="slot" type="unsigned long" readonly="yes">
11519	<desc>
11520	Slot number this adapter is plugged into. Corresponds to
11521	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11522	to obtain this instance.
11523	</desc>
11524	</attribute>
11525
11526	<attribute name="enabled" type="boolean">
11527	<desc>
11528	Flag whether the network adapter is present in the
11529	guest system. If disabled, the virtual guest hardware will
11530	not contain this network adapter. Can only be changed when
11531	the VM is not running.
11532	</desc>
11533	</attribute>
11534
11535	<attribute name="MACAddress" type="wstring">
11536	<desc>
11537	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11538	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11539	</desc>
11540	</attribute>
11541
11542	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11543
11544	<attribute name="hostInterface" type="wstring">
11545	<desc>
11546	Name of the host network interface the VM is attached to.
11547	</desc>
11548	</attribute>
11549
11550	<attribute name="internalNetwork" type="wstring">
11551	<desc>
11552	Name of the internal network the VM is attached to.
11553	</desc>
11554	</attribute>
11555
11556	<attribute name="NATNetwork" type="wstring">
11557	<desc>
11558	Name of the NAT network the VM is attached to.
11559	</desc>
11560	</attribute>
11561
11562	<attribute name="VDENetwork" type="wstring">
11563	<desc>
11564	Name of the VDE switch the VM is attached to.
11565	</desc>
11566	</attribute>
11567
11568	<attribute name="cableConnected" type="boolean">
11569	<desc>
11570	Flag whether the adapter reports the cable as connected or not.
11571	It can be used to report offline situations to a VM.
11572	</desc>
11573	</attribute>
11574
11575	<attribute name="lineSpeed" type="unsigned long">
11576	<desc>
11577	Line speed reported by custom drivers, in units of 1 kbps.
11578	</desc>
11579	</attribute>
11580
11581	<attribute name="traceEnabled" type="boolean">
11582	<desc>
11583	Flag whether network traffic from/to the network card should be traced.
11584	Can only be toggled when the VM is turned off.
11585	</desc>
11586	</attribute>
11587
11588	<attribute name="traceFile" type="wstring">
11589	<desc>
11590	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11591	will be used.
11592	</desc>
11593	</attribute>
11594
11595	<attribute name="natDriver" type="INATEngine" readonly="yes">
11596	<desc>
11597	Points to the NAT engine which handles the network address translation
11598	for this interface. This is active only when the interface actually uses
11599	NAT (see <link to="#attachToNAT" />).
11600	</desc>
11601	</attribute>
11602
11603	<attribute name="bootPriority" type="unsigned long">
11604	<desc>
11605	Network boot priority of the adapter. Priority 1 is highest. If not set,
11606	the priority is considered to be at the lowest possible setting.
11607	</desc>
11608	</attribute>
11609
11610	<attribute name="bandwidthLimit" type="unsigned long">
11611	<desc>
11612	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11613	A zero value means uncapped/unlimited.
11614	</desc>
11615	</attribute>
11616
11617	<method name="attachToNAT">
11618	<desc>
11619	Attach the network adapter to the Network Address Translation (NAT) interface.
11620	</desc>
11621	</method>
11622
11623	<method name="attachToBridgedInterface">
11624	<desc>
11625	Attach the network adapter to a bridged host interface.
11626	</desc>
11627	</method>
11628
11629	<method name="attachToInternalNetwork">
11630	<desc>
11631	Attach the network adapter to an internal network.
11632	</desc>
11633	</method>
11634
11635	<method name="attachToHostOnlyInterface">
11636	<desc>
11637	Attach the network adapter to the host-only network.
11638	</desc>
11639	</method>
11640
11641	<method name="attachToVDE">
11642	<desc>
11643	Attach the network adapter to a VDE network.
11644	</desc>
11645	</method>
11646
11647	<method name="detach">
11648	<desc>
11649	Detach the network adapter
11650	</desc>
11651	</method>
11652	</interface>
11653
11654
11655	<!--
11656	// ISerialPort
11657	/////////////////////////////////////////////////////////////////////////
11658	-->
11659
11660	<enum
11661	name="PortMode"
11662	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11663	>
11664	<desc>
11665	The PortMode enumeration represents possible communication modes for
11666	the virtual serial port device.
11667	</desc>
11668
11669	<const name="Disconnected" value="0">
11670	<desc>Virtual device is not attached to any real host device.</desc>
11671	</const>
11672	<const name="HostPipe" value="1">
11673	<desc>Virtual device is attached to a host pipe.</desc>
11674	</const>
11675	<const name="HostDevice" value="2">
11676	<desc>Virtual device is attached to a host device.</desc>
11677	</const>
11678	<const name="RawFile" value="3">
11679	<desc>Virtual device is attached to a raw file.</desc>
11680	</const>
11681	</enum>
11682
11683	<interface
11684	name="ISerialPort" extends="$unknown"
11685	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11686	wsmap="managed"
11687	>
11688
11689	<desc>
11690	The ISerialPort interface represents the virtual serial port device.
11691
11692	The virtual serial port device acts like an ordinary serial port
11693	inside the virtual machine. This device communicates to the real
11694	serial port hardware in one of two modes: host pipe or host device.
11695
11696	In host pipe mode, the #path attribute specifies the path to the pipe on
11697	the host computer that represents a serial port. The #server attribute
11698	determines if this pipe is created by the virtual machine process at
11699	machine startup or it must already exist before starting machine
11700	execution.
11701
11702	In host device mode, the #path attribute specifies the name of the
11703	serial port device on the host computer.
11704
11705	There is also a third communication mode: the disconnected mode. In this
11706	mode, the guest OS running inside the virtual machine will be able to
11707	detect the serial port, but all port write operations will be discarded
11708	and all port read operations will return no data.
11709
11710	<see>IMachine::getSerialPort</see>
11711	</desc>
11712
11713	<attribute name="slot" type="unsigned long" readonly="yes">
11714	<desc>
11715	Slot number this serial port is plugged into. Corresponds to
11716	the value you pass to <link to="IMachine::getSerialPort"/>
11717	to obtain this instance.
11718	</desc>
11719	</attribute>
11720
11721	<attribute name="enabled" type="boolean">
11722	<desc>
11723	Flag whether the serial port is enabled. If disabled,
11724	the serial port will not be reported to the guest OS.
11725	</desc>
11726	</attribute>
11727
11728	<attribute name="IOBase" type="unsigned long">
11729	<desc>Base I/O address of the serial port.</desc>
11730	</attribute>
11731
11732	<attribute name="IRQ" type="unsigned long">
11733	<desc>IRQ number of the serial port.</desc>
11734	</attribute>
11735
11736	<attribute name="hostMode" type="PortMode">
11737	<desc>
11738	How is this port connected to the host.
11739	<note>
11740	Changing this attribute may fail if the conditions for
11741	<link to="#path"/> are not met.
11742	</note>
11743	</desc>
11744	</attribute>
11745
11746	<attribute name="server" type="boolean">
11747	<desc>
11748	Flag whether this serial port acts as a server (creates a new pipe on
11749	the host) or as a client (uses the existing pipe). This attribute is
11750	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11751	</desc>
11752	</attribute>
11753
11754	<attribute name="path" type="wstring">
11755	<desc>
11756	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11757	PortMode_HostPipe, or the host serial device name when
11758	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11759	cases, setting a @c null or empty string as the attribute's value
11760	is an error. Otherwise, the value of this property is ignored.
11761	</desc>
11762	</attribute>
11763
11764	</interface>
11765
11766	<!--
11767	// IParallelPort
11768	/////////////////////////////////////////////////////////////////////////
11769	-->
11770
11771	<interface
11772	name="IParallelPort" extends="$unknown"
11773	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11774	wsmap="managed"
11775	>
11776
11777	<desc>
11778	The IParallelPort interface represents the virtual parallel port device.
11779
11780	The virtual parallel port device acts like an ordinary parallel port
11781	inside the virtual machine. This device communicates to the real
11782	parallel port hardware using the name of the parallel device on the host
11783	computer specified in the #path attribute.
11784
11785	Each virtual parallel port device is assigned a base I/O address and an
11786	IRQ number that will be reported to the guest operating system and used
11787	to operate the given parallel port from within the virtual machine.
11788
11789	<see>IMachine::getParallelPort</see>
11790	</desc>
11791
11792	<attribute name="slot" type="unsigned long" readonly="yes">
11793	<desc>
11794	Slot number this parallel port is plugged into. Corresponds to
11795	the value you pass to <link to="IMachine::getParallelPort"/>
11796	to obtain this instance.
11797	</desc>
11798	</attribute>
11799
11800	<attribute name="enabled" type="boolean">
11801	<desc>
11802	Flag whether the parallel port is enabled. If disabled,
11803	the parallel port will not be reported to the guest OS.
11804	</desc>
11805	</attribute>
11806
11807	<attribute name="IOBase" type="unsigned long">
11808	<desc>Base I/O address of the parallel port.</desc>
11809	</attribute>
11810
11811	<attribute name="IRQ" type="unsigned long">
11812	<desc>IRQ number of the parallel port.</desc>
11813	</attribute>
11814
11815	<attribute name="path" type="wstring">
11816	<desc>
11817	Host parallel device name. If this parallel port is enabled, setting a
11818	@c null or an empty string as this attribute's value will result into
11819	an error.
11820	</desc>
11821	</attribute>
11822
11823	</interface>
11824
11825
11826	<!--
11827	// IMachineDebugger
11828	/////////////////////////////////////////////////////////////////////////
11829	-->
11830
11831	<interface
11832	name="IMachineDebugger" extends="$unknown"
11833	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11834	wsmap="suppress"
11835	>
11836	<method name="resetStats">
11837	<desc>
11838	Reset VM statistics.
11839	</desc>
11840	<param name="pattern" type="wstring" dir="in">
11841	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11842	</param>
11843	</method>
11844
11845	<method name="dumpStats">
11846	<desc>
11847	Dumps VM statistics.
11848	</desc>
11849	<param name="pattern" type="wstring" dir="in">
11850	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11851	</param>
11852	</method>
11853
11854	<method name="getStats">
11855	<desc>
11856	Get the VM statistics in a XMLish format.
11857	</desc>
11858	<param name="pattern" type="wstring" dir="in">
11859	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11860	</param>
11861	<param name="withDescriptions" type="boolean" dir="in">
11862	<desc>Whether to include the descriptions.</desc>
11863	</param>
11864	<param name="stats" type="wstring" dir="out">
11865	<desc>The XML document containing the statistics.</desc>
11866	</param>
11867	</method>
11868
11869	<method name="injectNMI">
11870	<desc>
11871	Inject an NMI into a running VT-x/AMD-V VM.
11872	</desc>
11873	</method>
11874
11875	<attribute name="singlestep" type="boolean">
11876	<desc>Switch for enabling singlestepping.</desc>
11877	</attribute>
11878
11879	<attribute name="recompileUser" type="boolean">
11880	<desc>Switch for forcing code recompilation for user mode code.</desc>
11881	</attribute>
11882
11883	<attribute name="recompileSupervisor" type="boolean">
11884	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11885	</attribute>
11886
11887	<attribute name="PATMEnabled" type="boolean">
11888	<desc>Switch for enabling and disabling the PATM component.</desc>
11889	</attribute>
11890
11891	<attribute name="CSAMEnabled" type="boolean">
11892	<desc>Switch for enabling and disabling the CSAM component.</desc>
11893	</attribute>
11894
11895	<attribute name="logEnabled" type="boolean">
11896	<desc>Switch for enabling and disabling logging.</desc>
11897	</attribute>
11898
11899	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11900	<desc>
11901	Flag indicating whether the VM is currently making use of CPU hardware
11902	virtualization extensions.
11903	</desc>
11904	</attribute>
11905
11906	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11907	<desc>
11908	Flag indicating whether the VM is currently making use of the nested paging
11909	CPU hardware virtualization extension.
11910	</desc>
11911	</attribute>
11912
11913	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11914	<desc>
11915	Flag indicating whether the VM is currently making use of the VPID
11916	VT-x extension.
11917	</desc>
11918	</attribute>
11919
11920	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11921	<desc>
11922	Flag indicating whether the VM is currently making use of the Physical
11923	Address Extension CPU feature.
11924	</desc>
11925	</attribute>
11926
11927	<attribute name="virtualTimeRate" type="unsigned long">
11928	<desc>
11929	The rate at which the virtual time runs expressed as a percentage.
11930	The accepted range is 2% to 20000%.
11931	</desc>
11932	</attribute>
11933
11934	<!-- @todo method for setting log flags, groups and destination! -->
11935
11936	<attribute name="VM" type="long long" readonly="yes">
11937	<desc>
11938	Gets the VM handle. This is only for internal use while
11939	we carve the details of this interface.
11940	</desc>
11941	</attribute>
11942
11943	</interface>
11944
11945	<!--
11946	// IUSBController
11947	/////////////////////////////////////////////////////////////////////////
11948	-->
11949
11950	<interface
11951	name="IUSBController" extends="$unknown"
11952	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11953	wsmap="managed"
11954	>
11955	<attribute name="enabled" type="boolean">
11956	<desc>
11957	Flag whether the USB controller is present in the
11958	guest system. If disabled, the virtual guest hardware will
11959	not contain any USB controller. Can only be changed when
11960	the VM is powered off.
11961	</desc>
11962	</attribute>
11963
11964	<attribute name="enabledEhci" type="boolean">
11965	<desc>
11966	Flag whether the USB EHCI controller is present in the
11967	guest system. If disabled, the virtual guest hardware will
11968	not contain a USB EHCI controller. Can only be changed when
11969	the VM is powered off.
11970	</desc>
11971	</attribute>
11972
11973	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11974	<desc>
11975	Flag whether there is an USB proxy available.
11976	</desc>
11977	</attribute>
11978
11979	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11980	<desc>
11981	USB standard version which the controller implements.
11982	This is a BCD which means that the major version is in the
11983	high byte and minor version is in the low byte.
11984	</desc>
11985	</attribute>
11986
11987	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11988	<desc>
11989	List of USB device filters associated with the machine.
11990
11991	If the machine is currently running, these filters are activated
11992	every time a new (supported) USB device is attached to the host
11993	computer that was not ignored by global filters
11994	(<link to="IHost::USBDeviceFilters"/>).
11995
11996	These filters are also activated when the machine is powered up.
11997	They are run against a list of all currently available USB
11998	devices (in states
11999	<link to="USBDeviceState_Available"/>,
12000	<link to="USBDeviceState_Busy"/>,
12001	<link to="USBDeviceState_Held"/>) that were not previously
12002	ignored by global filters.
12003
12004	If at least one filter matches the USB device in question, this
12005	device is automatically captured (attached to) the virtual USB
12006	controller of this machine.
12007
12008	<see>IUSBDeviceFilter, ::IUSBController</see>
12009	</desc>
12010	</attribute>
12011
12012	<method name="createDeviceFilter">
12013	<desc>
12014	Creates a new USB device filter. All attributes except
12015	the filter name are set to empty (any match),
12016	<i>active</i> is @c false (the filter is not active).
12017
12018	The created filter can then be added to the list of filters using
12019	<link to="#insertDeviceFilter"/>.
12020
12021	<result name="VBOX_E_INVALID_VM_STATE">
12022	The virtual machine is not mutable.
12023	</result>
12024
12025	<see>#deviceFilters</see>
12026	</desc>
12027	<param name="name" type="wstring" dir="in">
12028	<desc>
12029	Filter name. See <link to="IUSBDeviceFilter::name"/>
12030	for more info.
12031	</desc>
12032	</param>
12033	<param name="filter" type="IUSBDeviceFilter" dir="return">
12034	<desc>Created filter object.</desc>
12035	</param>
12036	</method>
12037
12038	<method name="insertDeviceFilter">
12039	<desc>
12040	Inserts the given USB device to the specified position
12041	in the list of filters.
12042
12043	Positions are numbered starting from <tt>0</tt>. If the specified
12044	position is equal to or greater than the number of elements in
12045	the list, the filter is added to the end of the collection.
12046
12047	<note>
12048	Duplicates are not allowed, so an attempt to insert a
12049	filter that is already in the collection, will return an
12050	error.
12051	</note>
12052
12053	<result name="VBOX_E_INVALID_VM_STATE">
12054	Virtual machine is not mutable.
12055	</result>
12056	<result name="E_INVALIDARG">
12057	USB device filter not created within this VirtualBox instance.
12058	</result>
12059	<result name="VBOX_E_INVALID_OBJECT_STATE">
12060	USB device filter already in list.
12061	</result>
12062
12063	<see>#deviceFilters</see>
12064	</desc>
12065	<param name="position" type="unsigned long" dir="in">
12066	<desc>Position to insert the filter to.</desc>
12067	</param>
12068	<param name="filter" type="IUSBDeviceFilter" dir="in">
12069	<desc>USB device filter to insert.</desc>
12070	</param>
12071	</method>
12072
12073	<method name="removeDeviceFilter">
12074	<desc>
12075	Removes a USB device filter from the specified position in the
12076	list of filters.
12077
12078	Positions are numbered starting from <tt>0</tt>. Specifying a
12079	position equal to or greater than the number of elements in
12080	the list will produce an error.
12081
12082	<see>#deviceFilters</see>
12083
12084	<result name="VBOX_E_INVALID_VM_STATE">
12085	Virtual machine is not mutable.
12086	</result>
12087	<result name="E_INVALIDARG">
12088	USB device filter list empty or invalid @a position.
12089	</result>
12090
12091	</desc>
12092	<param name="position" type="unsigned long" dir="in">
12093	<desc>Position to remove the filter from.</desc>
12094	</param>
12095	<param name="filter" type="IUSBDeviceFilter" dir="return">
12096	<desc>Removed USB device filter.</desc>
12097	</param>
12098	</method>
12099
12100	</interface>
12101
12102
12103	<!--
12104	// IUSBDevice
12105	/////////////////////////////////////////////////////////////////////////
12106	-->
12107
12108	<interface
12109	name="IUSBDevice" extends="$unknown"
12110	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12111	wsmap="managed"
12112	>
12113	<desc>
12114	The IUSBDevice interface represents a virtual USB device attached to the
12115	virtual machine.
12116
12117	A collection of objects implementing this interface is stored in the
12118	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12119	attached to a running virtual machine's USB controller.
12120	</desc>
12121
12122	<attribute name="id" type="uuid" mod="string" readonly="yes">
12123	<desc>
12124	Unique USB device ID. This ID is built from #vendorId,
12125	#productId, #revision and #serialNumber.
12126	</desc>
12127	</attribute>
12128
12129	<attribute name="vendorId" type="unsigned short" readonly="yes">
12130	<desc>Vendor ID.</desc>
12131	</attribute>
12132
12133	<attribute name="productId" type="unsigned short" readonly="yes">
12134	<desc>Product ID.</desc>
12135	</attribute>
12136
12137	<attribute name="revision" type="unsigned short" readonly="yes">
12138	<desc>
12139	Product revision number. This is a packed BCD represented as
12140	unsigned short. The high byte is the integer part and the low
12141	byte is the decimal.
12142	</desc>
12143	</attribute>
12144
12145	<attribute name="manufacturer" type="wstring" readonly="yes">
12146	<desc>Manufacturer string.</desc>
12147	</attribute>
12148
12149	<attribute name="product" type="wstring" readonly="yes">
12150	<desc>Product string.</desc>
12151	</attribute>
12152
12153	<attribute name="serialNumber" type="wstring" readonly="yes">
12154	<desc>Serial number string.</desc>
12155	</attribute>
12156
12157	<attribute name="address" type="wstring" readonly="yes">
12158	<desc>Host specific address of the device.</desc>
12159	</attribute>
12160
12161	<attribute name="port" type="unsigned short" readonly="yes">
12162	<desc>
12163	Host USB port number the device is physically
12164	connected to.
12165	</desc>
12166	</attribute>
12167
12168	<attribute name="version" type="unsigned short" readonly="yes">
12169	<desc>
12170	The major USB version of the device - 1 or 2.
12171	</desc>
12172	</attribute>
12173
12174	<attribute name="portVersion" type="unsigned short" readonly="yes">
12175	<desc>
12176	The major USB version of the host USB port the device is
12177	physically connected to - 1 or 2. For devices not connected to
12178	anything this will have the same value as the version attribute.
12179	</desc>
12180	</attribute>
12181
12182	<attribute name="remote" type="boolean" readonly="yes">
12183	<desc>
12184	Whether the device is physically connected to a remote VRDE
12185	client or to a local host machine.
12186	</desc>
12187	</attribute>
12188
12189	</interface>
12190
12191
12192	<!--
12193	// IUSBDeviceFilter
12194	/////////////////////////////////////////////////////////////////////////
12195	-->
12196
12197	<interface
12198	name="IUSBDeviceFilter" extends="$unknown"
12199	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12200	wsmap="managed"
12201	>
12202	<desc>
12203	The IUSBDeviceFilter interface represents an USB device filter used
12204	to perform actions on a group of USB devices.
12205
12206	This type of filters is used by running virtual machines to
12207	automatically capture selected USB devices once they are physically
12208	attached to the host computer.
12209
12210	A USB device is matched to the given device filter if and only if all
12211	attributes of the device match the corresponding attributes of the
12212	filter (that is, attributes are joined together using the logical AND
12213	operation). On the other hand, all together, filters in the list of
12214	filters carry the semantics of the logical OR operation. So if it is
12215	desirable to create a match like "this vendor id OR this product id",
12216	one needs to create two filters and specify "any match" (see below)
12217	for unused attributes.
12218
12219	All filter attributes used for matching are strings. Each string
12220	is an expression representing a set of values of the corresponding
12221	device attribute, that will match the given filter. Currently, the
12222	following filtering expressions are supported:
12223
12224	<ul>
12225	<li><i>Interval filters</i>. Used to specify valid intervals for
12226	integer device attributes (Vendor ID, Product ID and Revision).
12227	The format of the string is:
12228
12229	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12230
12231	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12232	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12233	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12234	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12235	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12236	possible integer is assumed.
12237	</li>
12238	<li><i>Boolean filters</i>. Used to specify acceptable values for
12239	boolean device attributes. The format of the string is:
12240
12241	<tt>true\|false\|yes\|no\|0\|1</tt>
12242
12243	</li>
12244	<li><i>Exact match</i>. Used to specify a single value for the given
12245	device attribute. Any string that doesn't start with <tt>int:</tt>
12246	represents the exact match. String device attributes are compared to
12247	this string including case of symbols. Integer attributes are first
12248	converted to a string (see individual filter attributes) and then
12249	compared ignoring case.
12250
12251	</li>
12252	<li><i>Any match</i>. Any value of the corresponding device attribute
12253	will match the given filter. An empty or @c null string is
12254	used to construct this type of filtering expressions.
12255
12256	</li>
12257	</ul>
12258
12259	<note>
12260	On the Windows host platform, interval filters are not currently
12261	available. Also all string filter attributes
12262	(<link to="#manufacturer"/>, <link to="#product"/>,
12263	<link to="#serialNumber"/>) are ignored, so they behave as
12264	<i>any match</i> no matter what string expression is specified.
12265	</note>
12266
12267	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12268	</desc>
12269
12270	<attribute name="name" type="wstring">
12271	<desc>
12272	Visible name for this filter.
12273	This name is used to visually distinguish one filter from another,
12274	so it can neither be @c null nor an empty string.
12275	</desc>
12276	</attribute>
12277
12278	<attribute name="active" type="boolean">
12279	<desc>Whether this filter active or has been temporarily disabled.</desc>
12280	</attribute>
12281
12282	<attribute name="vendorId" type="wstring">
12283	<desc>
12284	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12285	The string representation for the <i>exact matching</i>
12286	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12287	(including leading zeroes).
12288	</desc>
12289	</attribute>
12290
12291	<attribute name="productId" type="wstring">
12292	<desc>
12293	<link to="IUSBDevice::productId">Product ID</link> filter.
12294	The string representation for the <i>exact matching</i>
12295	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12296	(including leading zeroes).
12297	</desc>
12298	</attribute>
12299
12300	<attribute name="revision" type="wstring">
12301	<desc>
12302	<link to="IUSBDevice::productId">Product revision number</link>
12303	filter. The string representation for the <i>exact matching</i>
12304	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12305	of the integer part of the revision, and <tt>F</tt> is the
12306	decimal digit of its fractional part (including leading and
12307	trailing zeros).
12308	Note that for interval filters, it's best to use the hexadecimal
12309	form, because the revision is stored as a 16 bit packed BCD value;
12310	so the expression <tt>int:0x0100-0x0199</tt> will match any
12311	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12312	</desc>
12313	</attribute>
12314
12315	<attribute name="manufacturer" type="wstring">
12316	<desc>
12317	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12318	</desc>
12319	</attribute>
12320
12321	<attribute name="product" type="wstring">
12322	<desc>
12323	<link to="IUSBDevice::product">Product</link> filter.
12324	</desc>
12325	</attribute>
12326
12327	<attribute name="serialNumber" type="wstring">
12328	<desc>
12329	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12330	</desc>
12331	</attribute>
12332
12333	<attribute name="port" type="wstring">
12334	<desc>
12335	<link to="IUSBDevice::port">Host USB port</link> filter.
12336	</desc>
12337	</attribute>
12338
12339	<attribute name="remote" type="wstring">
12340	<desc>
12341	<link to="IUSBDevice::remote">Remote state</link> filter.
12342	<note>
12343	This filter makes sense only for machine USB filters,
12344	i.e. it is ignored by IHostUSBDeviceFilter objects.
12345	</note>
12346	</desc>
12347	</attribute>
12348
12349	<attribute name="maskedInterfaces" type="unsigned long">
12350	<desc>
12351	This is an advanced option for hiding one or more USB interfaces
12352	from the guest. The value is a bit mask where the bits that are set
12353	means the corresponding USB interface should be hidden, masked off
12354	if you like.
12355	This feature only works on Linux hosts.
12356	</desc>
12357	</attribute>
12358
12359	</interface>
12360
12361
12362	<!--
12363	// IHostUSBDevice
12364	/////////////////////////////////////////////////////////////////////////
12365	-->
12366
12367	<enum
12368	name="USBDeviceState"
12369	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12370	>
12371	<desc>
12372	USB device state. This enumeration represents all possible states
12373	of the USB device physically attached to the host computer regarding
12374	its state on the host computer and availability to guest computers
12375	(all currently running virtual machines).
12376
12377	Once a supported USB device is attached to the host, global USB
12378	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12379	either ignore the device, or put it to USBDeviceState_Held state, or do
12380	nothing. Unless the device is ignored by global filters, filters of all
12381	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12382	activated that can put it to USBDeviceState_Captured state.
12383
12384	If the device was ignored by global filters, or didn't match
12385	any filters at all (including guest ones), it is handled by the host
12386	in a normal way. In this case, the device state is determined by
12387	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12388	or USBDeviceState_Available, depending on the current device usage.
12389
12390	Besides auto-capturing based on filters, the device can be manually
12391	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12392	state is USBDeviceState_Busy, USBDeviceState_Available or
12393	USBDeviceState_Held.
12394
12395	<note>
12396	Due to differences in USB stack implementations in Linux and Win32,
12397	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12398	only to the Linux version of the product. This also means that (<link
12399	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12400	device state is USBDeviceState_Held.
12401	</note>
12402
12403	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12404	</desc>
12405
12406	<const name="NotSupported" value="0">
12407	<desc>
12408	Not supported by the VirtualBox server, not available to guests.
12409	</desc>
12410	</const>
12411	<const name="Unavailable" value="1">
12412	<desc>
12413	Being used by the host computer exclusively,
12414	not available to guests.
12415	</desc>
12416	</const>
12417	<const name="Busy" value="2">
12418	<desc>
12419	Being used by the host computer, potentially available to guests.
12420	</desc>
12421	</const>
12422	<const name="Available" value="3">
12423	<desc>
12424	Not used by the host computer, available to guests (the host computer
12425	can also start using the device at any time).
12426	</desc>
12427	</const>
12428	<const name="Held" value="4">
12429	<desc>
12430	Held by the VirtualBox server (ignored by the host computer),
12431	available to guests.
12432	</desc>
12433	</const>
12434	<const name="Captured" value="5">
12435	<desc>
12436	Captured by one of the guest computers, not available
12437	to anybody else.
12438	</desc>
12439	</const>
12440	</enum>
12441
12442	<interface
12443	name="IHostUSBDevice" extends="IUSBDevice"
12444	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12445	wsmap="managed"
12446	>
12447	<desc>
12448	The IHostUSBDevice interface represents a physical USB device attached
12449	to the host computer.
12450
12451	Besides properties inherited from IUSBDevice, this interface adds the
12452	<link to="#state"/> property that holds the current state of the USB
12453	device.
12454
12455	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12456	</desc>
12457
12458	<attribute name="state" type="USBDeviceState" readonly="yes">
12459	<desc>
12460	Current state of the device.
12461	</desc>
12462	</attribute>
12463
12464	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12465
12466	</interface>
12467
12468
12469	<!--
12470	// IHostUSBDeviceFilter
12471	/////////////////////////////////////////////////////////////////////////
12472	-->
12473
12474	<enum
12475	name="USBDeviceFilterAction"
12476	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12477	>
12478	<desc>
12479	Actions for host USB device filters.
12480	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12481	</desc>
12482
12483	<const name="Null" value="0">
12484	<desc>Null value (never used by the API).</desc>
12485	</const>
12486	<const name="Ignore" value="1">
12487	<desc>Ignore the matched USB device.</desc>
12488	</const>
12489	<const name="Hold" value="2">
12490	<desc>Hold the matched USB device.</desc>
12491	</const>
12492	</enum>
12493
12494	<interface
12495	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12496	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12497	wsmap="managed"
12498	>
12499	<desc>
12500	The IHostUSBDeviceFilter interface represents a global filter for a
12501	physical USB device used by the host computer. Used indirectly in
12502	<link to="IHost::USBDeviceFilters"/>.
12503
12504	Using filters of this type, the host computer determines the initial
12505	state of the USB device after it is physically attached to the
12506	host's USB controller.
12507
12508	<note>
12509	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12510	filters, because it makes sense only for
12511	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12512	</note>
12513
12514	<see>IHost::USBDeviceFilters</see>
12515	</desc>
12516
12517	<attribute name="action" type="USBDeviceFilterAction">
12518	<desc>
12519	Action performed by the host when an attached USB device
12520	matches this filter.
12521	</desc>
12522	</attribute>
12523
12524	</interface>
12525
12526	<!--
12527	// IAudioAdapter
12528	/////////////////////////////////////////////////////////////////////////
12529	-->
12530
12531	<enum
12532	name="AudioDriverType"
12533	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12534	>
12535	<desc>
12536	Host audio driver type.
12537	</desc>
12538
12539	<const name="Null" value="0">
12540	<desc>Null value, also means "dummy audio driver".</desc>
12541	</const>
12542	<const name="WinMM" value="1">
12543	<desc>Windows multimedia (Windows hosts only).</desc>
12544	</const>
12545	<const name="OSS" value="2">
12546	<desc>Open Sound System (Linux hosts only).</desc>
12547	</const>
12548	<const name="ALSA" value="3">
12549	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12550	</const>
12551	<const name="DirectSound" value="4">
12552	<desc>DirectSound (Windows hosts only).</desc>
12553	</const>
12554	<const name="CoreAudio" value="5">
12555	<desc>CoreAudio (Mac hosts only).</desc>
12556	</const>
12557	<const name="MMPM" value="6">
12558	<desc>Reserved for historical reasons.</desc>
12559	</const>
12560	<const name="Pulse" value="7">
12561	<desc>PulseAudio (Linux hosts only).</desc>
12562	</const>
12563	<const name="SolAudio" value="8">
12564	<desc>Solaris audio (Solaris hosts only).</desc>
12565	</const>
12566	</enum>
12567
12568	<enum
12569	name="AudioControllerType"
12570	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12571	>
12572	<desc>
12573	Virtual audio controller type.
12574	</desc>
12575
12576	<const name="AC97" value="0"/>
12577	<const name="SB16" value="1"/>
12578	<const name="HDA" value="2"/>
12579	</enum>
12580
12581	<interface
12582	name="IAudioAdapter" extends="$unknown"
12583	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12584	wsmap="managed"
12585	>
12586	<desc>
12587	The IAudioAdapter interface represents the virtual audio adapter of
12588	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12589	</desc>
12590	<attribute name="enabled" type="boolean">
12591	<desc>
12592	Flag whether the audio adapter is present in the
12593	guest system. If disabled, the virtual guest hardware will
12594	not contain any audio adapter. Can only be changed when
12595	the VM is not running.
12596	</desc>
12597	</attribute>
12598	<attribute name="audioController" type="AudioControllerType">
12599	<desc>
12600	The audio hardware we emulate.
12601	</desc>
12602	</attribute>
12603	<attribute name="audioDriver" type="AudioDriverType">
12604	<desc>
12605	Audio driver the adapter is connected to. This setting
12606	can only be changed when the VM is not running.
12607	</desc>
12608	</attribute>
12609	</interface>
12610
12611	<enum
12612	name="AuthType"
12613	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
12614	>
12615	<desc>
12616	VirtualBox authentication type.
12617	</desc>
12618
12619	<const name="Null" value="0">
12620	<desc>Null value, also means "no authentication".</desc>
12621	</const>
12622	<const name="External" value="1"/>
12623	<const name="Guest" value="2"/>
12624	</enum>
12625
12626	<!--
12627	// IVRDEServer
12628	/////////////////////////////////////////////////////////////////////////
12629	-->
12630
12631	<interface
12632	name="IVRDEServer" extends="$unknown"
12633	uuid="468ab3d3-4808-489e-a301-05d60e959fbc"
12634	wsmap="managed"
12635	>
12636	<attribute name="enabled" type="boolean">
12637	<desc>VRDE server status.</desc>
12638	</attribute>
12639
12640	<attribute name="authType" type="AuthType">
12641	<desc>VRDE authentication method.</desc>
12642	</attribute>
12643
12644	<attribute name="authTimeout" type="unsigned long">
12645	<desc>Timeout for guest authentication. Milliseconds.</desc>
12646	</attribute>
12647
12648	<attribute name="allowMultiConnection" type="boolean">
12649	<desc>
12650	Flag whether multiple simultaneous connections to the VM are permitted.
12651	Note that this will be replaced by a more powerful mechanism in the future.
12652	</desc>
12653	</attribute>
12654
12655	<attribute name="reuseSingleConnection" type="boolean">
12656	<desc>
12657	Flag whether the existing connection must be dropped and a new connection
12658	must be established by the VRDE server, when a new client connects in single
12659	connection mode.
12660	</desc>
12661	</attribute>
12662
12663	<attribute name="videoChannel" type="boolean">
12664	<desc>
12665	Flag whether video redirectiron channel is enabled.
12666	</desc>
12667	</attribute>
12668
12669	<attribute name="videoChannelQuality" type="unsigned long">
12670	<desc>
12671	Image quality in percents.
12672	</desc>
12673	</attribute>
12674
12675	<attribute name="VRDEExtPack" type="wstring">
12676	<desc>
12677	The name of Extension Pack providing VRDE for this VM. Overrides
12678	<link to="ISystemProperties::defaultVRDEExtPack"/>.
12679	</desc>
12680	</attribute>
12681
12682	<method name="setVRDEProperty">
12683	<desc>
12684	Sets a VRDE specific property string.
12685
12686	If you pass @c null or empty string as a key @a value, the given @a key
12687	will be deleted.
12688
12689	</desc>
12690	<param name="key" type="wstring" dir="in">
12691	<desc>Name of the key to set.</desc>
12692	</param>
12693	<param name="value" type="wstring" dir="in">
12694	<desc>Value to assign to the key.</desc>
12695	</param>
12696	</method>
12697
12698	<method name="getVRDEProperty">
12699	<desc>
12700	Returns a VRDE specific property string.
12701
12702	If the requested data @a key does not exist, this function will
12703	succeed and return an empty string in the @a value argument.
12704
12705	</desc>
12706	<param name="key" type="wstring" dir="in">
12707	<desc>Name of the key to get.</desc>
12708	</param>
12709	<param name="value" type="wstring" dir="return">
12710	<desc>Value of the requested key.</desc>
12711	</param>
12712	</method>
12713
12714	</interface>
12715
12716
12717	<!--
12718	// ISharedFolder
12719	/////////////////////////////////////////////////////////////////////////
12720	-->
12721
12722	<interface
12723	name="ISharedFolder" extends="$unknown"
12724	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12725	wsmap="struct"
12726	>
12727	<desc>
12728	The ISharedFolder interface represents a folder in the host computer's
12729	file system accessible from the guest OS running inside a virtual
12730	machine using an associated logical name.
12731
12732	There are three types of shared folders:
12733	<ul>
12734	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12735	folders available to all virtual machines.</li>
12736	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12737	VM-specific shared folders available to the given virtual machine at
12738	startup.</li>
12739	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12740	VM-specific shared folders created in the session context (for
12741	example, when the virtual machine is running) and automatically
12742	discarded when the session is closed (the VM is powered off).</li>
12743	</ul>
12744
12745	Logical names of shared folders must be unique within the given scope
12746	(global, permanent or transient). However, they do not need to be unique
12747	across scopes. In this case, the definition of the shared folder in a
12748	more specific scope takes precedence over definitions in all other
12749	scopes. The order of precedence is (more specific to more general):
12750	<ol>
12751	<li>Transient definitions</li>
12752	<li>Permanent definitions</li>
12753	<li>Global definitions</li>
12754	</ol>
12755
12756	For example, if MyMachine has a shared folder named
12757	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12758	transient shared folder named <tt>C_DRIVE</tt> (that points
12759	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12760	of <tt>C_DRIVE</tt> in the guest OS so
12761	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12762	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12763	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12764	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12765	to <tt>C:\\</tt> if it still exists.
12766
12767	Note that permanent and transient shared folders of different machines
12768	are in different name spaces, so they don't overlap and don't need to
12769	have unique logical names.
12770
12771	<note>
12772	Global shared folders are not implemented in the current version of the
12773	product.
12774	</note>
12775	</desc>
12776
12777	<attribute name="name" type="wstring" readonly="yes">
12778	<desc>Logical name of the shared folder.</desc>
12779	</attribute>
12780
12781	<attribute name="hostPath" type="wstring" readonly="yes">
12782	<desc>Full path to the shared folder in the host file system.</desc>
12783	</attribute>
12784
12785	<attribute name="accessible" type="boolean" readonly="yes">
12786	<desc>
12787	Whether the folder defined by the host path is currently
12788	accessible or not.
12789	For example, the folder can be inaccessible if it is placed
12790	on the network share that is not available by the time
12791	this property is read.
12792	</desc>
12793	</attribute>
12794
12795	<attribute name="writable" type="boolean" readonly="yes">
12796	<desc>
12797	Whether the folder defined by the host path is writable or
12798	not.
12799	</desc>
12800	</attribute>
12801
12802	<attribute name="autoMount" type="boolean" readonly="yes">
12803	<desc>
12804	Whether the folder gets automatically mounted by the guest or not.
12805	</desc>
12806	</attribute>
12807
12808	<attribute name="lastAccessError" type="wstring" readonly="yes">
12809	<desc>
12810	Text message that represents the result of the last accessibility
12811	check.
12812
12813	Accessibility checks are performed each time the <link to="#accessible"/>
12814	attribute is read. An empty string is returned if the last
12815	accessibility check was successful. A non-empty string indicates a
12816	failure and should normally describe a reason of the failure (for
12817	example, a file read error).
12818	</desc>
12819	</attribute>
12820
12821	</interface>
12822
12823	<!--
12824	// ISession
12825	/////////////////////////////////////////////////////////////////////////
12826	-->
12827
12828	<interface
12829	name="IInternalSessionControl" extends="$unknown"
12830	uuid="06ef98a7-f7c0-45ba-bf99-9aca7a4d5530"
12831	internal="yes"
12832	wsmap="suppress"
12833	>
12834	<method name="getPID">
12835	<desc>PID of the process that has created this Session object.
12836	</desc>
12837	<param name="pid" type="unsigned long" dir="return"/>
12838	</method>
12839
12840	<method name="getRemoteConsole">
12841	<desc>
12842	Returns the console object suitable for remote control.
12843
12844	<result name="VBOX_E_INVALID_VM_STATE">
12845	Session state prevents operation.
12846	</result>
12847	<result name="VBOX_E_INVALID_OBJECT_STATE">
12848	Session type prevents operation.
12849	</result>
12850
12851	</desc>
12852	<param name="console" type="IConsole" dir="return"/>
12853	</method>
12854
12855	<method name="assignMachine">
12856	<desc>
12857	Assigns the machine object associated with this direct-type
12858	session or informs the session that it will be a remote one
12859	(if @a machine == @c null).
12860
12861	<result name="VBOX_E_INVALID_VM_STATE">
12862	Session state prevents operation.
12863	</result>
12864	<result name="VBOX_E_INVALID_OBJECT_STATE">
12865	Session type prevents operation.
12866	</result>
12867
12868	</desc>
12869	<param name="machine" type="IMachine" dir="in"/>
12870	</method>
12871
12872	<method name="assignRemoteMachine">
12873	<desc>
12874	Assigns the machine and the (remote) console object associated with
12875	this remote-type session.
12876
12877	<result name="VBOX_E_INVALID_VM_STATE">
12878	Session state prevents operation.
12879	</result>
12880
12881	</desc>
12882	<param name="machine" type="IMachine" dir="in"/>
12883	<param name="console" type="IConsole" dir="in"/>
12884	</method>
12885
12886	<method name="updateMachineState">
12887	<desc>
12888	Updates the machine state in the VM process.
12889	Must be called only in certain cases
12890	(see the method implementation).
12891
12892	<result name="VBOX_E_INVALID_VM_STATE">
12893	Session state prevents operation.
12894	</result>
12895	<result name="VBOX_E_INVALID_OBJECT_STATE">
12896	Session type prevents operation.
12897	</result>
12898
12899	</desc>
12900	<param name="aMachineState" type="MachineState" dir="in"/>
12901	</method>
12902
12903	<method name="uninitialize">
12904	<desc>
12905	Uninitializes (closes) this session. Used by VirtualBox to close
12906	the corresponding remote session when the direct session dies
12907	or gets closed.
12908
12909	<result name="VBOX_E_INVALID_VM_STATE">
12910	Session state prevents operation.
12911	</result>
12912
12913	</desc>
12914	</method>
12915
12916	<method name="onNetworkAdapterChange">
12917	<desc>
12918	Triggered when settings of a network adapter of the
12919	associated virtual machine have changed.
12920
12921	<result name="VBOX_E_INVALID_VM_STATE">
12922	Session state prevents operation.
12923	</result>
12924	<result name="VBOX_E_INVALID_OBJECT_STATE">
12925	Session type prevents operation.
12926	</result>
12927
12928	</desc>
12929	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12930	<param name="changeAdapter" type="boolean" dir="in"/>
12931	</method>
12932
12933	<method name="onSerialPortChange">
12934	<desc>
12935	Triggered when settings of a serial port of the
12936	associated virtual machine have changed.
12937
12938	<result name="VBOX_E_INVALID_VM_STATE">
12939	Session state prevents operation.
12940	</result>
12941	<result name="VBOX_E_INVALID_OBJECT_STATE">
12942	Session type prevents operation.
12943	</result>
12944
12945	</desc>
12946	<param name="serialPort" type="ISerialPort" dir="in"/>
12947	</method>
12948
12949	<method name="onParallelPortChange">
12950	<desc>
12951	Triggered when settings of a parallel port of the
12952	associated virtual machine have changed.
12953
12954	<result name="VBOX_E_INVALID_VM_STATE">
12955	Session state prevents operation.
12956	</result>
12957	<result name="VBOX_E_INVALID_OBJECT_STATE">
12958	Session type prevents operation.
12959	</result>
12960
12961	</desc>
12962	<param name="parallelPort" type="IParallelPort" dir="in"/>
12963	</method>
12964
12965	<method name="onStorageControllerChange">
12966	<desc>
12967	Triggered when settings of a storage controller of the
12968	associated virtual machine have changed.
12969
12970	<result name="VBOX_E_INVALID_VM_STATE">
12971	Session state prevents operation.
12972	</result>
12973	<result name="VBOX_E_INVALID_OBJECT_STATE">
12974	Session type prevents operation.
12975	</result>
12976
12977	</desc>
12978	</method>
12979
12980	<method name="onMediumChange">
12981	<desc>
12982	Triggered when attached media of the
12983	associated virtual machine have changed.
12984
12985	<result name="VBOX_E_INVALID_VM_STATE">
12986	Session state prevents operation.
12987	</result>
12988	<result name="VBOX_E_INVALID_OBJECT_STATE">
12989	Session type prevents operation.
12990	</result>
12991
12992	</desc>
12993
12994	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12995	<param name="force" type="boolean" dir="in"/>
12996	</method>
12997
12998	<method name="onCPUChange">
12999	<desc>
13000	Notification when a CPU changes.
13001	</desc>
13002	<param name="cpu" type="unsigned long" dir="in">
13003	<desc>The CPU which changed</desc>
13004	</param>
13005	<param name="add" type="boolean" dir="in">
13006	<desc>Flag whether the CPU was added or removed</desc>
13007	</param>
13008	</method>
13009
13010	<method name="onCPUExecutionCapChange">
13011	<desc>
13012	Notification when the CPU execution cap changes.
13013	</desc>
13014	<param name="executionCap" type="unsigned long" dir="in">
13015	<desc>The new CPU execution cap value. (1-100)</desc>
13016	</param>
13017	</method>
13018
13019	<method name="onVRDEServerChange">
13020	<desc>
13021	Triggered when settings of the VRDE server object of the
13022	associated virtual machine have changed.
13023
13024	<result name="VBOX_E_INVALID_VM_STATE">
13025	Session state prevents operation.
13026	</result>
13027	<result name="VBOX_E_INVALID_OBJECT_STATE">
13028	Session type prevents operation.
13029	</result>
13030
13031	</desc>
13032	<param name="restart" type="boolean" dir="in">
13033	<desc>Flag whether the server must be restarted</desc>
13034	</param>
13035	</method>
13036
13037	<method name="onUSBControllerChange">
13038	<desc>
13039	Triggered when settings of the USB controller object of the
13040	associated virtual machine have changed.
13041
13042	<result name="VBOX_E_INVALID_VM_STATE">
13043	Session state prevents operation.
13044	</result>
13045	<result name="VBOX_E_INVALID_OBJECT_STATE">
13046	Session type prevents operation.
13047	</result>
13048
13049	</desc>
13050	</method>
13051
13052	<method name="onSharedFolderChange">
13053	<desc>
13054	Triggered when a permanent (global or machine) shared folder has been
13055	created or removed.
13056	<note>
13057	We don't pass shared folder parameters in this notification because
13058	the order in which parallel notifications are delivered is not defined,
13059	therefore it could happen that these parameters were outdated by the
13060	time of processing this notification.
13061	</note>
13062
13063	<result name="VBOX_E_INVALID_VM_STATE">
13064	Session state prevents operation.
13065	</result>
13066	<result name="VBOX_E_INVALID_OBJECT_STATE">
13067	Session type prevents operation.
13068	</result>
13069
13070	</desc>
13071	<param name="global" type="boolean" dir="in"/>
13072	</method>
13073
13074	<method name="onUSBDeviceAttach">
13075	<desc>
13076	Triggered when a request to capture a USB device (as a result
13077	of matched USB filters or direct call to
13078	<link to="IConsole::attachUSBDevice"/>) has completed.
13079	A @c null @a error object means success, otherwise it
13080	describes a failure.
13081
13082	<result name="VBOX_E_INVALID_VM_STATE">
13083	Session state prevents operation.
13084	</result>
13085	<result name="VBOX_E_INVALID_OBJECT_STATE">
13086	Session type prevents operation.
13087	</result>
13088
13089	</desc>
13090	<param name="device" type="IUSBDevice" dir="in"/>
13091	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13092	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13093	</method>
13094
13095	<method name="onUSBDeviceDetach">
13096	<desc>
13097	Triggered when a request to release the USB device (as a result
13098	of machine termination or direct call to
13099	<link to="IConsole::detachUSBDevice"/>) has completed.
13100	A @c null @a error object means success, otherwise it
13101	describes a failure.
13102
13103	<result name="VBOX_E_INVALID_VM_STATE">
13104	Session state prevents operation.
13105	</result>
13106	<result name="VBOX_E_INVALID_OBJECT_STATE">
13107	Session type prevents operation.
13108	</result>
13109
13110	</desc>
13111	<param name="id" type="uuid" mod="string" dir="in"/>
13112	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13113	</method>
13114
13115	<method name="onShowWindow">
13116	<desc>
13117	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13118	<link to="IMachine::showConsoleWindow"/> in order to notify
13119	console listeners
13120	<link to="ICanShowWindowEvent"/>
13121	and <link to="IShowWindowEvent"/>.
13122
13123	<result name="VBOX_E_INVALID_OBJECT_STATE">
13124	Session type prevents operation.
13125	</result>
13126
13127	</desc>
13128	<param name="check" type="boolean" dir="in"/>
13129	<param name="canShow" type="boolean" dir="out"/>
13130	<param name="winId" type="long long" dir="out"/>
13131	</method>
13132
13133	<method name="accessGuestProperty">
13134	<desc>
13135	Called by <link to="IMachine::getGuestProperty"/> and by
13136	<link to="IMachine::setGuestProperty"/> in order to read and
13137	modify guest properties.
13138
13139	<result name="VBOX_E_INVALID_VM_STATE">
13140	Machine session is not open.
13141	</result>
13142	<result name="VBOX_E_INVALID_OBJECT_STATE">
13143	Session type is not direct.
13144	</result>
13145
13146	</desc>
13147	<param name="name" type="wstring" dir="in"/>
13148	<param name="value" type="wstring" dir="in"/>
13149	<param name="flags" type="wstring" dir="in"/>
13150	<param name="isSetter" type="boolean" dir="in"/>
13151	<param name="retValue" type="wstring" dir="out"/>
13152	<param name="retTimestamp" type="long long" dir="out"/>
13153	<param name="retFlags" type="wstring" dir="out"/>
13154	</method>
13155
13156	<method name="enumerateGuestProperties">
13157	<desc>
13158	Return a list of the guest properties matching a set of patterns along
13159	with their values, time stamps and flags.
13160
13161	<result name="VBOX_E_INVALID_VM_STATE">
13162	Machine session is not open.
13163	</result>
13164	<result name="VBOX_E_INVALID_OBJECT_STATE">
13165	Session type is not direct.
13166	</result>
13167
13168	</desc>
13169	<param name="patterns" type="wstring" dir="in">
13170	<desc>
13171	The patterns to match the properties against as a comma-separated
13172	string. If this is empty, all properties currently set will be
13173	returned.
13174	</desc>
13175	</param>
13176	<param name="key" type="wstring" dir="out" safearray="yes">
13177	<desc>
13178	The key names of the properties returned.
13179	</desc>
13180	</param>
13181	<param name="value" type="wstring" dir="out" safearray="yes">
13182	<desc>
13183	The values of the properties returned. The array entries match the
13184	corresponding entries in the @a key array.
13185	</desc>
13186	</param>
13187	<param name="timestamp" type="long long" dir="out" safearray="yes">
13188	<desc>
13189	The time stamps of the properties returned. The array entries match
13190	the corresponding entries in the @a key array.
13191	</desc>
13192	</param>
13193	<param name="flags" type="wstring" dir="out" safearray="yes">
13194	<desc>
13195	The flags of the properties returned. The array entries match the
13196	corresponding entries in the @a key array.
13197	</desc>
13198	</param>
13199	</method>
13200
13201	<method name="onlineMergeMedium">
13202	<desc>
13203	Triggers online merging of a hard disk. Used internally when deleting
13204	a snapshot while a VM referring to the same hard disk chain is running.
13205
13206	<result name="VBOX_E_INVALID_VM_STATE">
13207	Machine session is not open.
13208	</result>
13209	<result name="VBOX_E_INVALID_OBJECT_STATE">
13210	Session type is not direct.
13211	</result>
13212
13213	</desc>
13214	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13215	<desc>The medium attachment to identify the medium chain.</desc>
13216	</param>
13217	<param name="sourceIdx" type="unsigned long" dir="in">
13218	<desc>The index of the source image in the chain.
13219	Redundant, but drastically reduces IPC.</desc>
13220	</param>
13221	<param name="targetIdx" type="unsigned long" dir="in">
13222	<desc>The index of the target image in the chain.
13223	Redundant, but drastically reduces IPC.</desc>
13224	</param>
13225	<param name="source" type="IMedium" dir="in">
13226	<desc>Merge source medium.</desc>
13227	</param>
13228	<param name="target" type="IMedium" dir="in">
13229	<desc>Merge target medium.</desc>
13230	</param>
13231	<param name="mergeForward" type="boolean" dir="in">
13232	<desc>Merge direction.</desc>
13233	</param>
13234	<param name="parentForTarget" type="IMedium" dir="in">
13235	<desc>For forward merges: new parent for target medium.</desc>
13236	</param>
13237	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13238	<desc>For backward merges: list of media which need their parent UUID
13239	updated.</desc>
13240	</param>
13241	<param name="progress" type="IProgress" dir="in">
13242	<desc>
13243	Progress object for this operation.
13244	</desc>
13245	</param>
13246	</method>
13247
13248	</interface>
13249
13250	<interface
13251	name="ISession" extends="$unknown"
13252	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13253	wsmap="managed"
13254	>
13255	<desc>
13256	The ISession interface represents a client process and allows for locking
13257	virtual machines (represented by IMachine objects) to prevent conflicting
13258	changes to the machine.
13259
13260	Any caller wishing to manipulate a virtual machine needs to create a session
13261	object first, which lives in its own process space. Such session objects are
13262	then associated with <link to="IMachine" /> objects living in the VirtualBox
13263	server process to coordinate such changes.
13264
13265	There are two typical scenarios in which sessions are used:
13266
13267	<ul>
13268	<li>To alter machine settings or control a running virtual machine, one
13269	needs to lock a machine for a given session (client process) by calling
13270	<link to="IMachine::lockMachine"/>.
13271
13272	Whereas multiple sessions may control a running virtual machine, only
13273	one process can obtain a write lock on the machine to prevent conflicting
13274	changes. A write lock is also needed if a process wants to actually run a
13275	virtual machine in its own context, such as the VirtualBox GUI or
13276	VBoxHeadless front-ends. They must also lock a machine for their own
13277	sessions before they are allowed to power up the virtual machine.
13278
13279	As a result, no machine settings can be altered while another process is
13280	already using it, either because that process is modifying machine settings
13281	or because the machine is running.
13282	</li>
13283	<li>
13284	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13285	VirtualBox GUI or VBoxHeadless), one would use
13286	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13287	as its first parameter. This session then identifies the caller and lets the
13288	caller control the started machine (for example, pause machine execution or
13289	power it down) as well as be notified about machine execution state changes.
13290	</li>
13291	</ul>
13292
13293	How sessions objects are created in a client process depends on whether you use
13294	the Main API via COM or via the webservice:
13295
13296	<ul>
13297	<li>When using the COM API directly, an object of the Session class from the
13298	VirtualBox type library needs to be created. In regular COM C++ client code,
13299	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13300	This object will then act as a local session object in further calls to open
13301	a session.
13302	</li>
13303
13304	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13305	a session object automatically whenever <link to="IWebsessionManager::logon" />
13306	is called. A managed object reference to that session object can be retrieved by
13307	calling <link to="IWebsessionManager::getSessionObject" />.
13308	</li>
13309	</ul>
13310	</desc>
13311
13312	<attribute name="state" type="SessionState" readonly="yes">
13313	<desc>Current state of this session.</desc>
13314	</attribute>
13315
13316	<attribute name="type" type="SessionType" readonly="yes">
13317	<desc>
13318	Type of this session. The value of this attribute is valid only
13319	if the session currently has a machine locked (i.e. its
13320	<link to="#state" /> is Locked), otherwise an error will be returned.
13321	</desc>
13322	</attribute>
13323
13324	<attribute name="machine" type="IMachine" readonly="yes">
13325	<desc>Machine object associated with this session.</desc>
13326	</attribute>
13327
13328	<attribute name="console" type="IConsole" readonly="yes">
13329	<desc>Console object associated with this session.</desc>
13330	</attribute>
13331
13332	<method name="unlockMachine">
13333	<desc>
13334	Unlocks a machine that was previously locked for the current session.
13335
13336	Calling this method is required every time a machine has been locked
13337	for a particular session using the <link to="IMachine::launchVMProcess" />
13338	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13339	the machine will be set to <link to="MachineState_Aborted" /> on the
13340	server, and changes made to the machine settings will be lost.
13341
13342	Generally, it is recommended to unlock all machines explicitly
13343	before terminating the application (regardless of the reason for
13344	the termination).
13345
13346	<note>
13347	Do not expect the session state (<link to="ISession::state" />
13348	to return to "Unlocked" immediately after you invoke this method,
13349	particularly if you have started a new VM process. The session
13350	state will automatically return to "Unlocked" once the VM is no
13351	longer executing, which can of course take a very long time.
13352	</note>
13353
13354	<result name="E_UNEXPECTED">
13355	Session is not locked.
13356	</result>
13357
13358	</desc>
13359	</method>
13360
13361	</interface>
13362
13363	<!--
13364	// IStorageController
13365	/////////////////////////////////////////////////////////////////////////
13366	-->
13367
13368	<enum
13369	name="StorageBus"
13370	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13371	>
13372	<desc>
13373	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13374	see <link to="IStorageController::bus" />.
13375	</desc>
13376	<const name="Null" value="0">
13377	<desc>@c null value. Never used by the API.</desc>
13378	</const>
13379	<const name="IDE" value="1"/>
13380	<const name="SATA" value="2"/>
13381	<const name="SCSI" value="3"/>
13382	<const name="Floppy" value="4"/>
13383	<const name="SAS" value="5"/>
13384	</enum>
13385
13386	<enum
13387	name="StorageControllerType"
13388	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13389	>
13390	<desc>
13391	The exact variant of storage controller hardware presented
13392	to the guest; see <link to="IStorageController::controllerType" />.
13393	</desc>
13394
13395	<const name="Null" value="0">
13396	<desc>@c null value. Never used by the API.</desc>
13397	</const>
13398	<const name="LsiLogic" value="1">
13399	<desc>A SCSI controller of the LsiLogic variant.</desc>
13400	</const>
13401	<const name="BusLogic" value="2">
13402	<desc>A SCSI controller of the BusLogic variant.</desc>
13403	</const>
13404	<const name="IntelAhci" value="3">
13405	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13406	</const>
13407	<const name="PIIX3" value="4">
13408	<desc>An IDE controller of the PIIX3 variant.</desc>
13409	</const>
13410	<const name="PIIX4" value="5">
13411	<desc>An IDE controller of the PIIX4 variant.</desc>
13412	</const>
13413	<const name="ICH6" value="6">
13414	<desc>An IDE controller of the ICH6 variant.</desc>
13415	</const>
13416	<const name="I82078" value="7">
13417	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13418	</const>
13419	<const name="LsiLogicSas" value="8">
13420	<desc>A variant of the LsiLogic controller using SAS.</desc>
13421	</const>
13422	</enum>
13423
13424	<enum
13425	name="ChipsetType"
13426	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13427	>
13428	<desc>
13429	Type of emulated chipset (mostly southbridge).
13430	</desc>
13431
13432	<const name="Null" value="0">
13433	<desc>@c null value. Never used by the API.</desc>
13434	</const>
13435	<const name="PIIX3" value="1">
13436	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13437	</const>
13438	<const name="ICH9" value="2">
13439	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13440	</const>
13441	</enum>
13442
13443	<interface
13444	name="IStorageController" extends="$unknown"
13445	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
13446	wsmap="managed"
13447	>
13448	<desc>
13449	Represents a storage controller that is attached to a virtual machine
13450	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13451	attached to storage controllers in a real computer, virtual drives
13452	(represented by <link to="IMediumAttachment" />) are attached to virtual
13453	storage controllers, represented by this interface.
13454
13455	As opposed to physical hardware, VirtualBox has a very generic concept
13456	of a storage controller, and for purposes of the Main API, all virtual
13457	storage is attached to virtual machines via instances of this interface.
13458	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13459	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13460	is used, certain sub-types may be available and can be selected in
13461	<link to="#controllerType" />.
13462
13463	Depending on these settings, the guest operating system might see
13464	significantly different virtual hardware.
13465	</desc>
13466
13467	<attribute name="name" type="wstring" readonly="yes">
13468	<desc>
13469	Name of the storage controller, as originally specified with
13470	<link to="IMachine::addStorageController" />. This then uniquely
13471	identifies this controller with other method calls such as
13472	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13473	</desc>
13474	</attribute>
13475
13476	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13477	<desc>
13478	Maximum number of devices which can be attached to one port.
13479	</desc>
13480	</attribute>
13481
13482	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13483	<desc>
13484	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13485	</desc>
13486	</attribute>
13487
13488	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13489	<desc>
13490	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13491	</desc>
13492	</attribute>
13493
13494	<attribute name="instance" type="unsigned long">
13495	<desc>
13496	The instance number of the device in the running VM.
13497	</desc>
13498	</attribute>
13499
13500	<attribute name="portCount" type="unsigned long">
13501	<desc>
13502	The number of currently usable ports on the controller.
13503	The minimum and maximum number of ports for one controller are
13504	stored in <link to="IStorageController::minPortCount"/>
13505	and <link to="IStorageController::maxPortCount"/>.
13506	</desc>
13507	</attribute>
13508
13509	<attribute name="bus" type="StorageBus" readonly="yes">
13510	<desc>
13511	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13512	</desc>
13513	</attribute>
13514
13515	<attribute name="controllerType" type="StorageControllerType">
13516	<desc>
13517	The exact variant of storage controller hardware presented
13518	to the guest.
13519	Depending on this value, VirtualBox will provide a different
13520	virtual storage controller hardware to the guest.
13521	For SATA, SAS and floppy controllers, only one variant is
13522	available, but for IDE and SCSI, there are several.
13523
13524	For SCSI controllers, the default type is LsiLogic.
13525	</desc>
13526	</attribute>
13527
13528	<attribute name="useHostIOCache" type="boolean">
13529	<desc>
13530	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13531	caches and use synchronous file APIs on the host. This was the only option in the API before
13532	VirtualBox 3.2 and is still the default for IDE controllers.
13533
13534	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13535	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13536	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13537	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13538	virtual machines are running at the same time to prevent I/O cache related hangs.
13539	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13540	</desc>
13541	</attribute>
13542
13543	<attribute name="bootable" type="boolean" readonly="yes">
13544	<desc>
13545	Returns whether it is possible to boot from disks attached to this controller.
13546	</desc>
13547	</attribute>
13548
13549	<method name="getIDEEmulationPort">
13550	<desc>
13551	Gets the corresponding port number which is emulated as an IDE device.
13552	Works only with SATA controllers.
13553
13554	<result name="E_INVALIDARG">
13555	The @a devicePosition is not in the range 0 to 3.
13556	</result>
13557	<result name="E_NOTIMPL">
13558	The storage controller type is not SATAIntelAhci.
13559	</result>
13560
13561	</desc>
13562	<param name="devicePosition" type="long" dir="in"/>
13563	<param name="portNumber" type="long" dir="return"/>
13564	</method>
13565
13566	<method name="setIDEEmulationPort">
13567	<desc>
13568	Sets the port number which is emulated as an IDE device.
13569	Works only with SATA controllers.
13570
13571	<result name="E_INVALIDARG">
13572	The @a devicePosition is not in the range 0 to 3 or the
13573	@a portNumber is not in the range 0 to 29.
13574	</result>
13575	<result name="E_NOTIMPL">
13576	The storage controller type is not SATAIntelAhci.
13577	</result>
13578
13579	</desc>
13580	<param name="devicePosition" type="long" dir="in"/>
13581	<param name="portNumber" type="long" dir="in"/>
13582	</method>
13583
13584	</interface>
13585
13586	<if target="wsdl">
13587
13588	<!--
13589	// IManagedObjectRef
13590	/////////////////////////////////////////////////////////////////////////
13591	-->
13592
13593	<interface
13594	name="IManagedObjectRef" extends="$unknown"
13595	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13596	internal="yes"
13597	wsmap="managed"
13598	wscpp="hardcoded"
13599	>
13600	<desc>
13601	Managed object reference.
13602
13603	Only within the webservice, a managed object reference (which is really
13604	an opaque number) allows a webservice client to address an object
13605	that lives in the address space of the webservice server.
13606
13607	Behind each managed object reference, there is a COM object that lives
13608	in the webservice server's address space. The COM object is not freed
13609	until the managed object reference is released, either by an explicit
13610	call to <link to="IManagedObjectRef::release" /> or by logging off from
13611	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13612	all objects created during the webservice session.
13613
13614	Whenever a method call of the VirtualBox API returns a COM object, the
13615	webservice representation of that method will instead return a
13616	managed object reference, which can then be used to invoke methods
13617	on that object.
13618	</desc>
13619
13620	<method name="getInterfaceName">
13621	<desc>
13622	Returns the name of the interface that this managed object represents,
13623	for example, "IMachine", as a string.
13624	</desc>
13625	<param name="return" type="wstring" dir="return"/>
13626	</method>
13627
13628	<method name="release">
13629	<desc>
13630	Releases this managed object reference and frees the resources that
13631	were allocated for it in the webservice server process. After calling
13632	this method, the identifier of the reference can no longer be used.
13633	</desc>
13634	</method>
13635
13636	</interface>
13637
13638	<!--
13639	// IWebsessionManager
13640	/////////////////////////////////////////////////////////////////////////
13641	-->
13642
13643	<interface
13644	name="IWebsessionManager" extends="$unknown"
13645	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13646	internal="yes"
13647	wsmap="global"
13648	wscpp="hardcoded"
13649	>
13650	<desc>
13651	Websession manager. This provides essential services
13652	to webservice clients.
13653	</desc>
13654	<method name="logon">
13655	<desc>
13656	Logs a new client onto the webservice and returns a managed object reference to
13657	the IVirtualBox instance, which the client can then use as a basis to further
13658	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13659	interface, in one way or the other.
13660	</desc>
13661	<param name="username" type="wstring" dir="in"/>
13662	<param name="password" type="wstring" dir="in"/>
13663	<param name="return" type="IVirtualBox" dir="return"/>
13664	</method>
13665
13666	<method name="getSessionObject">
13667	<desc>
13668	Returns a managed object reference to the internal ISession object that was created
13669	for this web service session when the client logged on.
13670
13671	<see>ISession</see>
13672	</desc>
13673	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13674	<param name="return" type="ISession" dir="return"/>
13675	</method>
13676
13677	<method name="logoff">
13678	<desc>
13679	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13680	and destroys all resources associated with the session (most importantly, all
13681	managed objects created in the server while the session was active).
13682	</desc>
13683	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13684	</method>
13685
13686	</interface>
13687
13688	</if>
13689
13690	<!--
13691	// IPerformanceCollector & friends
13692	/////////////////////////////////////////////////////////////////////////
13693	-->
13694
13695	<interface
13696	name="IPerformanceMetric" extends="$unknown"
13697	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13698	>
13699	<desc>
13700	The IPerformanceMetric interface represents parameters of the given
13701	performance metric.
13702	</desc>
13703
13704	<attribute name="metricName" type="wstring" readonly="yes">
13705	<desc>
13706	Name of the metric.
13707	</desc>
13708	</attribute>
13709
13710	<attribute name="object" type="$unknown" readonly="yes">
13711	<desc>
13712	Object this metric belongs to.
13713	</desc>
13714	</attribute>
13715
13716	<attribute name="description" type="wstring" readonly="yes">
13717	<desc>
13718	Textual description of the metric.
13719	</desc>
13720	</attribute>
13721
13722	<attribute name="period" type="unsigned long" readonly="yes">
13723	<desc>
13724	Time interval between samples, measured in seconds.
13725	</desc>
13726	</attribute>
13727
13728	<attribute name="count" type="unsigned long" readonly="yes">
13729	<desc>
13730	Number of recent samples retained by the performance collector for this
13731	metric.
13732
13733	When the collected sample count exceeds this number, older samples
13734	are discarded.
13735	</desc>
13736	</attribute>
13737
13738	<attribute name="unit" type="wstring" readonly="yes">
13739	<desc>
13740	Unit of measurement.
13741	</desc>
13742	</attribute>
13743
13744	<attribute name="minimumValue" type="long" readonly="yes">
13745	<desc>
13746	Minimum possible value of this metric.
13747	</desc>
13748	</attribute>
13749
13750	<attribute name="maximumValue" type="long" readonly="yes">
13751	<desc>
13752	Maximum possible value of this metric.
13753	</desc>
13754	</attribute>
13755	</interface>
13756
13757	<interface
13758	name="IPerformanceCollector" extends="$unknown"
13759	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13760	wsmap="managed"
13761	>
13762	<desc>
13763	The IPerformanceCollector interface represents a service that collects
13764	and stores performance metrics data.
13765
13766	Performance metrics are associated with objects of interfaces like IHost
13767	and IMachine. Each object has a distinct set of performance metrics. The
13768	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13769
13770	Metric data is collected at the specified intervals and is retained
13771	internally. The interval and the number of retained samples can be set
13772	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13773	and collection settings are not persistent, they are discarded as soon as
13774	VBoxSVC process terminates. Moreover, metric settings and data associated
13775	with a particular VM only exist while VM is running. They disappear as
13776	soon as VM shuts down. It is not possible to set up metrics for machines
13777	that are powered off. One needs to start VM first, then set up metric
13778	collection parameters.
13779
13780	Metrics are organized hierarchically, with each level separated by a
13781	slash (/) character. Generally, the scheme for metric names is like this:
13782
13783	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13784
13785	"Category/Metric" together form the base metric name. A base metric is
13786	the smallest unit for which a sampling interval and the number of
13787	retained samples can be set. Only base metrics can be enabled and
13788	disabled. All sub-metrics are collected when their base metric is
13789	collected. Collected values for any set of sub-metrics can be queried
13790	with <link to="IPerformanceCollector::queryMetricsData" />.
13791
13792	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13793	category, "Load" metric, "User" submetric, "average" aggregate. An
13794	aggregate function is computed over all retained data. Valid aggregate
13795	functions are:
13796
13797	<ul>
13798	<li>avg -- average</li>
13799	<li>min -- minimum</li>
13800	<li>max -- maximum</li>
13801	</ul>
13802
13803	When setting up metric parameters, querying metric data, enabling or
13804	disabling metrics wildcards can be used in metric names to specify a
13805	subset of metrics. For example, to select all CPU-related metrics
13806	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13807	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13808
13809	The valid names for base metrics are:
13810
13811	<ul>
13812	<li>CPU/Load</li>
13813	<li>CPU/MHz</li>
13814	<li>RAM/Usage</li>
13815	</ul>
13816
13817	The general sequence for collecting and retrieving the metrics is:
13818	<ul>
13819	<li>
13820	Obtain an instance of IPerformanceCollector with
13821	<link to="IVirtualBox::performanceCollector" />
13822	</li>
13823	<li>
13824	Allocate and populate an array with references to objects the metrics
13825	will be collected for. Use references to IHost and IMachine objects.
13826	</li>
13827	<li>
13828	Allocate and populate an array with base metric names the data will
13829	be collected for.
13830	</li>
13831	<li>
13832	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13833	the metric data will be collected and stored.
13834	</li>
13835	<li>
13836	Wait for the data to get collected.
13837	</li>
13838	<li>
13839	Allocate and populate an array with references to objects the metric
13840	values will be queried for. You can re-use the object array used for
13841	setting base metrics.
13842	</li>
13843	<li>
13844	Allocate and populate an array with metric names the data will be
13845	collected for. Note that metric names differ from base metric names.
13846	</li>
13847	<li>
13848	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13849	that have been collected so far are returned. Note that the values
13850	are still retained internally and data collection continues.
13851	</li>
13852	</ul>
13853
13854	For an example of usage refer to the following files in VirtualBox SDK:
13855	<ul>
13856	<li>
13857	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13858	</li>
13859	<li>
13860	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13861	</li>
13862	</ul>
13863	</desc>
13864
13865	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13866	<desc>
13867	Array of unique names of metrics.
13868
13869	This array represents all metrics supported by the performance
13870	collector. Individual objects do not necessarily support all of them.
13871	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13872	list of supported metrics for a particular object.
13873	</desc>
13874	</attribute>
13875
13876	<method name="getMetrics">
13877	<desc>
13878	Returns parameters of specified metrics for a set of objects.
13879	<note>
13880	@c Null metrics array means all metrics. @c Null object array means
13881	all existing objects.
13882	</note>
13883	</desc>
13884	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13885	<desc>
13886	Metric name filter. Currently, only a comma-separated list of metrics
13887	is supported.
13888	</desc>
13889	</param>
13890	<param name="objects" type="$unknown" dir="in" safearray="yes">
13891	<desc>
13892	Set of objects to return metric parameters for.
13893	</desc>
13894	</param>
13895	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13896	<desc>
13897	Array of returned metric parameters.
13898	</desc>
13899	</param>
13900	</method>
13901
13902	<method name="setupMetrics">
13903	<desc>
13904	Sets parameters of specified base metrics for a set of objects. Returns
13905	an array of <link to="IPerformanceMetric" /> describing the metrics
13906	have been affected.
13907	<note>
13908	@c Null or empty metric name array means all metrics. @c Null or
13909	empty object array means all existing objects. If metric name array
13910	contains a single element and object array contains many, the single
13911	metric name array element is applied to each object array element to
13912	form metric/object pairs.
13913	</note>
13914	</desc>
13915	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13916	<desc>
13917	Metric name filter. Comma-separated list of metrics with wildcard
13918	support.
13919	</desc>
13920	</param>
13921	<param name="objects" type="$unknown" dir="in" safearray="yes">
13922	<desc>
13923	Set of objects to setup metric parameters for.
13924	</desc>
13925	</param>
13926	<param name="period" type="unsigned long" dir="in">
13927	<desc>
13928	Time interval in seconds between two consecutive samples of
13929	performance data.
13930	</desc>
13931	</param>
13932	<param name="count" type="unsigned long" dir="in">
13933	<desc>
13934	Number of samples to retain in performance data history. Older
13935	samples get discarded.
13936	</desc>
13937	</param>
13938	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13939	<desc>
13940	Array of metrics that have been modified by the call to this method.
13941	</desc>
13942	</param>
13943	</method>
13944
13945	<method name="enableMetrics">
13946	<desc>
13947	Turns on collecting specified base metrics. Returns an array of
13948	<link to="IPerformanceMetric" /> describing the metrics have been
13949	affected.
13950	<note>
13951	@c Null or empty metric name array means all metrics. @c Null or
13952	empty object array means all existing objects. If metric name array
13953	contains a single element and object array contains many, the single
13954	metric name array element is applied to each object array element to
13955	form metric/object pairs.
13956	</note>
13957	</desc>
13958	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13959	<desc>
13960	Metric name filter. Comma-separated list of metrics with wildcard
13961	support.
13962	</desc>
13963	</param>
13964	<param name="objects" type="$unknown" dir="in" safearray="yes">
13965	<desc>
13966	Set of objects to enable metrics for.
13967	</desc>
13968	</param>
13969	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13970	<desc>
13971	Array of metrics that have been modified by the call to this method.
13972	</desc>
13973	</param>
13974	</method>
13975
13976	<method name="disableMetrics">
13977	<desc>
13978	Turns off collecting specified base metrics. Returns an array of
13979	<link to="IPerformanceMetric" /> describing the metrics have been
13980	affected.
13981	<note>
13982	@c Null or empty metric name array means all metrics. @c Null or
13983	empty object array means all existing objects. If metric name array
13984	contains a single element and object array contains many, the single
13985	metric name array element is applied to each object array element to
13986	form metric/object pairs.
13987	</note>
13988	</desc>
13989	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13990	<desc>
13991	Metric name filter. Comma-separated list of metrics with wildcard
13992	support.
13993	</desc>
13994	</param>
13995	<param name="objects" type="$unknown" dir="in" safearray="yes">
13996	<desc>
13997	Set of objects to disable metrics for.
13998	</desc>
13999	</param>
14000	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14001	<desc>
14002	Array of metrics that have been modified by the call to this method.
14003	</desc>
14004	</param>
14005	</method>
14006
14007	<method name="queryMetricsData">
14008	<desc>
14009	Queries collected metrics data for a set of objects.
14010
14011	The data itself and related metric information are returned in seven
14012	parallel and one flattened array of arrays. Elements of
14013	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14014	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14015	the same index describe one set of values corresponding to a single
14016	metric.
14017
14018	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14019	start and length of a sub-array is indicated by
14020	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14021	value for metric <tt>metricNames[i]</tt> is at
14022	<tt>returnData[returnIndices[i]]</tt>.
14023
14024	<note>
14025	@c Null or empty metric name array means all metrics. @c Null or
14026	empty object array means all existing objects. If metric name array
14027	contains a single element and object array contains many, the single
14028	metric name array element is applied to each object array element to
14029	form metric/object pairs.
14030	</note>
14031	<note>
14032	Data collection continues behind the scenes after call to @c
14033	queryMetricsData. The return data can be seen as the snapshot of the
14034	current state at the time of @c queryMetricsData call. The internally
14035	kept metric values are not cleared by the call. This makes possible
14036	querying different subsets of metrics or aggregates with subsequent
14037	calls. If periodic querying is needed it is highly suggested to query
14038	the values with @c interval*count period to avoid confusion. This way
14039	a completely new set of data values will be provided by each query.
14040	</note>
14041	</desc>
14042	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14043	<desc>
14044	Metric name filter. Comma-separated list of metrics with wildcard
14045	support.
14046	</desc>
14047	</param>
14048	<param name="objects" type="$unknown" dir="in" safearray="yes">
14049	<desc>
14050	Set of objects to query metrics for.
14051	</desc>
14052	</param>
14053	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14054	<desc>
14055	Names of metrics returned in @c returnData.
14056	</desc>
14057	</param>
14058	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14059	<desc>
14060	Objects associated with metrics returned in @c returnData.
14061	</desc>
14062	</param>
14063	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14064	<desc>
14065	Units of measurement for each returned metric.
14066	</desc>
14067	</param>
14068	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14069	<desc>
14070	Divisor that should be applied to return values in order to get
14071	floating point values. For example:
14072	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14073	will retrieve the floating point value of i-th sample of the first
14074	metric.
14075	</desc>
14076	</param>
14077	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14078	<desc>
14079	Sequence numbers of the first elements of value sequences of
14080	particular metrics returned in @c returnData. For aggregate metrics
14081	it is the sequence number of the sample the aggregate started
14082	calculation from.
14083	</desc>
14084	</param>
14085	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14086	<desc>
14087	Indices of the first elements of value sequences of particular
14088	metrics returned in @c returnData.
14089	</desc>
14090	</param>
14091	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14092	<desc>
14093	Lengths of value sequences of particular metrics.
14094	</desc>
14095	</param>
14096	<param name="returnData" type="long" dir="return" safearray="yes">
14097	<desc>
14098	Flattened array of all metric data containing sequences of values for
14099	each metric.
14100	</desc>
14101	</param>
14102	</method>
14103
14104	</interface>
14105
14106	<enum
14107	name="NATAliasMode"
14108	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14109	>
14110	<desc></desc>
14111	<const name="AliasLog" value="0x1">
14112	<desc></desc>
14113	</const>
14114	<const name="AliasProxyOnly" value="0x02">
14115	<desc></desc>
14116	</const>
14117	<const name="AliasUseSamePorts" value="0x04">
14118	<desc></desc>
14119	</const>
14120	</enum>
14121
14122	<enum
14123	name="NATProtocol"
14124	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14125	>
14126	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14127	<const name="UDP" value="0">
14128	<desc>Port-forwarding uses UDP protocol.</desc>
14129	</const>
14130	<const name="TCP" value="1">
14131	<desc>Port-forwarding uses TCP protocol.</desc>
14132	</const>
14133	</enum>
14134
14135	<interface
14136	name="INATEngine" extends="$unknown"
14137	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14138	wsmap="managed"
14139	>
14140	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14141	allows for changing NAT behavior such as port-forwarding rules. This interface is
14142	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14143	<attribute name="network" type="wstring">
14144	<desc>The network attribute of the NAT engine (the same value is used with built-in
14145	DHCP server to fill corresponding fields of DHCP leases).</desc>
14146	</attribute>
14147	<attribute name="hostIP" type="wstring">
14148	<desc>IP of host interface to bind all opened sockets to.
14149	<note>Changing this does not change binding of port forwarding.</note>
14150	</desc>
14151	</attribute>
14152	<attribute name="tftpPrefix" type="wstring">
14153	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14154	the corresponding fields of DHCP leases.</desc>
14155	</attribute>
14156	<attribute name="tftpBootFile" type="wstring">
14157	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14158	the corresponding fields of DHCP leases.</desc>
14159	</attribute>
14160	<attribute name="tftpNextServer" type="wstring">
14161	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14162	the corresponding fields of DHCP leases.
14163	<note>The preferred form is IPv4 addresses.</note>
14164	</desc>
14165	</attribute>
14166	<attribute name="aliasMode" type="unsigned long">
14167	<desc></desc>
14168	</attribute>
14169	<attribute name="dnsPassDomain" type="boolean">
14170	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14171	</attribute>
14172	<attribute name="dnsProxy" type="boolean">
14173	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14174	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14175	</attribute>
14176	<attribute name="dnsUseHostResolver" type="boolean">
14177	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14178	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14179	</attribute>
14180	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14181	<desc>Array of NAT port-forwarding rules in string representation, in the following
14182	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14183	</attribute>
14184	<method name="setNetworkSettings">
14185	<desc>Sets network configuration of the NAT engine.</desc>
14186	<param name="mtu" type="unsigned long" dir="in">
14187	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14188	</param>
14189	<param name="sockSnd" type="unsigned long" dir="in">
14190	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14191	</param>
14192	<param name="sockRcv" type="unsigned long" dir="in">
14193	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14194	</param>
14195	<param name="TcpWndSnd" type="unsigned long" dir="in">
14196	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14197	establishing a new TCP connection.</desc>
14198	</param>
14199	<param name="TcpWndRcv" type="unsigned long" dir="in">
14200	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14201	establishing a new TCP connection.</desc>
14202	</param>
14203	</method>
14204	<method name="getNetworkSettings">
14205	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14206	for parameter descriptions.</desc>
14207	<param name="mtu" type="unsigned long" dir="out" />
14208	<param name="sockSnd" type="unsigned long" dir="out" />
14209	<param name="sockRcv" type="unsigned long" dir="out" />
14210	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14211	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14212	</method>
14213	<method name="addRedirect">
14214	<desc>Adds a new NAT port-forwarding rule.</desc>
14215	<param name="name" type="wstring" dir="in">
14216	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14217	auto-generates one using the other parameters.</desc>
14218	</param>
14219	<param name="proto" type="NATProtocol" dir="in">
14220	<desc>Protocol handled with the rule.</desc>
14221	</param>
14222	<param name="hostIp" type="wstring" dir="in">
14223	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14224	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14225	</param>
14226	<param name="hostPort" type="unsigned short" dir="in">
14227	<desc>The port number to listen on.</desc>
14228	</param>
14229	<param name="guestIp" type="wstring" dir="in">
14230	<desc>The IP address of the guest which the NAT engine will forward matching packets
14231	to. An empty IP address is acceptable, in which case the NAT engine will forward
14232	packets to the first DHCP lease (x.x.x.15).</desc>
14233	</param>
14234	<param name="guestPort" type="unsigned short" dir="in">
14235	<desc>The port number to forward.</desc>
14236	</param>
14237	</method>
14238	<method name="removeRedirect">
14239	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14240	<param name="name" type="wstring" dir="in">
14241	<desc>The name of the rule to delete.</desc>
14242	</param>
14243	</method>
14244	</interface>
14245
14246	<!--
14247	// IExtPackManager
14248	/////////////////////////////////////////////////////////////////////////
14249	-->
14250
14251	<interface
14252	name="IExtPackPlugIn" extends="$unknown"
14253	uuid="58000040-e718-4746-bbce-4b86d96da461"
14254	wsmap="suppress"
14255	>
14256	<desc>
14257	Interface for keeping information about a plug-in that ships with an
14258	extension pack.
14259	</desc>
14260	<attribute name="name" type="wstring" readonly="yes">
14261	<desc>The plug-in name.</desc>
14262	</attribute>
14263	<attribute name="description" type="wstring" readonly="yes">
14264	<desc>The plug-in description.</desc>
14265	</attribute>
14266	<attribute name="frontend" type="wstring" readonly="yes">
14267	<desc>
14268	The name of the frontend or component name this plug-in plugs into.
14269	</desc>
14270	</attribute>
14271	<attribute name="modulePath" type="wstring" readonly="yes">
14272	<desc> The module path. </desc>
14273	</attribute>
14274	</interface>
14275
14276	<interface
14277	name="IExtPack" extends="$unknown"
14278	uuid="94564309-5966-419a-81cc-4aec0b6dbd4d"
14279	wsmap="suppress"
14280	>
14281	<desc>
14282	Interface for querying information about an extension pack as well as
14283	accessing COM objects within it.
14284	</desc>
14285	<attribute name="name" type="wstring" readonly="yes">
14286	<desc>The extension pack name. This is unique.</desc>
14287	</attribute>
14288	<attribute name="description" type="wstring" readonly="yes">
14289	<desc>The extension pack description.</desc>
14290	</attribute>
14291	<attribute name="version" type="wstring" readonly="yes">
14292	<desc>
14293	The extension pack version string. This is on the same form as
14294	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14295	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14296	or "1.2.3_BETA1-r45678-OSE"
14297	</desc>
14298	</attribute>
14299	<attribute name="revision" type="unsigned long" readonly="yes">
14300	<desc>The extension pack internal revision number.</desc>
14301	</attribute>
14302	<attribute name="VRDEModule" type="wstring" readonly="yes">
14303	<desc>The name of the VRDE module if the extension pack sports one.</desc>
14304	</attribute>
14305	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
14306	<desc>Plug-ins provided by this extension pack.</desc>
14307	</attribute>
14308	<attribute name="usable" type="boolean" readonly="yes">
14309	<desc>
14310	Indicates whether the extension pack is usable or not. An
14311	extension pack that is not compatible with the current VirtualBox
14312	version will be flagged as not usable.
14313	</desc>
14314	</attribute>
14315	<attribute name="whyUnusable" type="wstring" readonly="yes">
14316	<desc>
14317	String indicating why the extension pack is not usable. This is an
14318	empty string if usable and always a non-empty string if not usable.
14319	</desc>
14320	</attribute>
14321	<method name="queryObject">
14322	<desc>
14323	Queries the IUnknown interface to an object in the extension pack
14324	main module. This allows plug-ins and others to talk directly to an
14325	extension pack.
14326	</desc>
14327	<param name="objUuid" type="wstring" dir="in">
14328	<desc>The object ID. What exactly this is </desc>
14329	</param>
14330	<param name="returnInterface" type="$unknown" dir="out">
14331	<desc>The queried interface.</desc>
14332	</param>
14333	</method>
14334	</interface>
14335
14336	<interface
14337	name="IExtPackManager" extends="$unknown"
14338	uuid="bc386406-2637-454b-8d55-021f9e20445a"
14339	wsmap="suppress"
14340	>
14341	<desc>
14342	Interface for managing VirtualBox Extension Packs.
14343
14344	TODO: Describe extension packs, how they are managed and how to create
14345	one.
14346	</desc>
14347
14348	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14349	<desc>
14350	List of the installed extension packs.
14351	</desc>
14352	</attribute>
14353
14354	<method name="find">
14355	<desc>
14356	Returns the extension pack with the specified name if found.
14357
14358	<result name="VBOX_E_OBJECT_NOT_FOUND">
14359	No extension pack matching @a name was found.
14360	</result>
14361	</desc>
14362	<param name="name" type="wstring" dir="in">
14363	<desc>The name of the extension pack to locate.</desc>
14364	</param>
14365	<param name="returnData" type="IExtPack" dir="return">
14366	<desc>The extension pack if found.</desc>
14367	</param>
14368	</method>
14369
14370	<method name="install">
14371	<param name="path" type="wstring" dir="in">
14372	<desc>The path of the extension pack tarball.</desc>
14373	</param>
14374	<param name="name" type="wstring" dir="return">
14375	<desc>The name of the installed extension pack.</desc>
14376	</param>
14377	</method>
14378
14379	<method name="uninstall">
14380	<desc>Uninstalls an extension pack, removing all related files.</desc>
14381	<param name="name" type="wstring" dir="in">
14382	<desc>The name of the extension pack to uninstall.</desc>
14383	</param>
14384	<param name="forcedRemoval" type="boolean" dir="in">
14385	<desc>
14386	Forced removal of the extension pack. This means that the uninstall
14387	hook will not be called.
14388	</desc>
14389	</param>
14390	</method>
14391
14392	<method name="cleanup">
14393	<desc>Cleans up failed installs and uninstalls</desc>
14394	</method>
14395
14396	<method name="QueryAllPlugInsForFrontend">
14397	<desc>
14398	Gets the path to all the plug-in modules for a given frontend.
14399
14400	This is a convenience method that is intended to simplify the plug-in
14401	loading process for a frontend.
14402	</desc>
14403	<param name="frontendName" type="wstring" dir="in">
14404	<desc>The name of the frontend or component.</desc>
14405	</param>
14406	<param name="plugInModules" type="wstring" dir="out" safearray="yes">
14407	<desc>Array containing the plug-in modules (full paths).</desc>
14408	</param>
14409	</method>
14410
14411	</interface>
14412
14413	<!--
14414	// IVirtualBoxClient
14415	/////////////////////////////////////////////////////////////////////////
14416	-->
14417
14418	<interface
14419	name="IVirtualBoxClient" extends="$unknown"
14420	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
14421	wsmap="suppress"
14422	>
14423	<desc>
14424	Convenience interface for client applications. Treat this as a
14425	singleton, i.e. never create more than one instance of this interface.
14426
14427	At the moment only available for clients of the local API (not usable
14428	via the webservice). Once the session logic is redesigned this might
14429	change.
14430	</desc>
14431
14432	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
14433	<desc>
14434	Reference to the server-side API root object.
14435	</desc>
14436	</attribute>
14437
14438	<attribute name="session" type="ISession" readonly="yes">
14439	<desc>
14440	Create a new session object and return the reference to it.
14441	</desc>
14442	</attribute>
14443
14444	<attribute name="eventSource" type="IEventSource" readonly="yes">
14445	<desc>
14446	Event source for VirtualBoxClient events.
14447	</desc>
14448	</attribute>
14449
14450	</interface>
14451
14452	<!--
14453	// Events
14454	/////////////////////////////////////////////////////////////////////////
14455	-->
14456	<enum
14457	name="VBoxEventType"
14458	uuid="BA0F90B2-3F41-4222-840D-EDD5055476A8"
14459	>
14460
14461	<desc>
14462	Type of an event.
14463	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14464	</desc>
14465
14466	<const name="Invalid" value="0">
14467	<desc>
14468	Invalid event, must be first.
14469	</desc>
14470	</const>
14471
14472	<const name="Any" value="1">
14473	<desc>
14474	Wildcard for all events.
14475	Events of this type are never delivered, and only used in
14476	registerListener() call to simplify registration.
14477	</desc>
14478	</const>
14479
14480	<const name="Vetoable" value="2">
14481	<desc>
14482	Wildcard for all vetoable events. Events of this type are never delivered, and only
14483	used in registerListener() call to simplify registration.
14484	</desc>
14485	</const>
14486
14487	<const name="MachineEvent" value="3">
14488	<desc>
14489	Wildcard for all machine events. Events of this type are never delivered, and only used in
14490	registerListener() call to simplify registration.
14491	</desc>
14492	</const>
14493
14494	<const name="SnapshotEvent" value="4">
14495	<desc>
14496	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
14497	registerListener() call to simplify registration.
14498	</desc>
14499	</const>
14500
14501	<const name="InputEvent" value="5">
14502	<desc>
14503	Wildcard for all input device (keyboard, mouse) events.
14504	Events of this type are never delivered, and only used in
14505	registerListener() call to simplify registration.
14506	</desc>
14507	</const>
14508
14509	<const name="LastWildcard" value="31">
14510	<desc>
14511	Last wildcard.
14512	</desc>
14513	</const>
14514
14515	<const name="OnMachineStateChanged" value="32">
14516	<desc>
14517	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
14518	</desc>
14519	</const>
14520	<const name="OnMachineDataChanged" value="33">
14521	<desc>
14522	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
14523	</desc>
14524	</const>
14525	<const name="OnExtraDataChanged" value="34">
14526	<desc>
14527	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
14528	</desc>
14529	</const>
14530	<const name="OnExtraDataCanChange" value="35">
14531	<desc>
14532	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
14533	</desc>
14534	</const>
14535	<const name="OnMediumRegistered" value="36">
14536	<desc>
14537	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
14538	</desc>
14539	</const>
14540	<const name="OnMachineRegistered" value="37">
14541	<desc>
14542	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
14543	</desc>
14544	</const>
14545	<const name="OnSessionStateChanged" value="38">
14546	<desc>
14547	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
14548	</desc>
14549	</const>
14550	<const name="OnSnapshotTaken" value="39">
14551	<desc>
14552	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
14553	</desc>
14554	</const>
14555	<const name="OnSnapshotDeleted" value="40">
14556	<desc>
14557	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
14558	</desc>
14559	</const>
14560	<const name="OnSnapshotChanged" value="41">
14561	<desc>
14562	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
14563	</desc>
14564	</const>
14565	<const name="OnGuestPropertyChanged" value="42">
14566	<desc>
14567	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
14568	</desc>
14569	</const>
14570	<!-- Console events -->
14571	<const name="OnMousePointerShapeChanged" value="43">
14572	<desc>
14573	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
14574	</desc>
14575	</const>
14576	<const name="OnMouseCapabilityChanged" value="44">
14577	<desc>
14578	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
14579	</desc>
14580	</const>
14581	<const name="OnKeyboardLedsChanged" value="45">
14582	<desc>
14583	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
14584	</desc>
14585	</const>
14586	<const name="OnStateChanged" value="46">
14587	<desc>
14588	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
14589	</desc>
14590	</const>
14591	<const name="OnAdditionsStateChanged" value="47">
14592	<desc>
14593	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
14594	</desc>
14595	</const>
14596	<const name="OnNetworkAdapterChanged" value="48">
14597	<desc>
14598	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
14599	</desc>
14600	</const>
14601	<const name="OnSerialPortChanged" value="49">
14602	<desc>
14603	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
14604	</desc>
14605	</const>
14606	<const name="OnParallelPortChanged" value="50">
14607	<desc>
14608	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
14609	</desc>
14610	</const>
14611	<const name="OnStorageControllerChanged" value="51">
14612	<desc>
14613	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
14614	</desc>
14615	</const>
14616	<const name="OnMediumChanged" value="52">
14617	<desc>
14618	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
14619	</desc>
14620	</const>
14621	<const name="OnVRDEServerChanged" value="53">
14622	<desc>
14623	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
14624	</desc>
14625	</const>
14626	<const name="OnUSBControllerChanged" value="54">
14627	<desc>
14628	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
14629	</desc>
14630	</const>
14631	<const name="OnUSBDeviceStateChanged" value="55">
14632	<desc>
14633	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
14634	</desc>
14635	</const>
14636	<const name="OnSharedFolderChanged" value="56">
14637	<desc>
14638	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
14639	</desc>
14640	</const>
14641	<const name="OnRuntimeError" value="57">
14642	<desc>
14643	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
14644	</desc>
14645	</const>
14646	<const name="OnCanShowWindow" value="58">
14647	<desc>
14648	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
14649	</desc>
14650	</const>
14651	<const name="OnShowWindow" value="59">
14652	<desc>
14653	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
14654	</desc>
14655	</const>
14656	<const name="OnCPUChanged" value="60">
14657	<desc>
14658	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
14659	</desc>
14660	</const>
14661	<const name="OnVRDEServerInfoChanged" value="61">
14662	<desc>
14663	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
14664	</desc>
14665	</const>
14666	<const name="OnEventSourceChanged" value="62">
14667	<desc>
14668	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
14669	</desc>
14670	</const>
14671	<const name="OnCPUExecutionCapChanged" value="63">
14672	<desc>
14673	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
14674	</desc>
14675	</const>
14676	<const name="OnGuestKeyboard" value="64">
14677	<desc>
14678	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
14679	</desc>
14680	</const>
14681	<const name="OnGuestMouse" value="65">
14682	<desc>
14683	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
14684	</desc>
14685	</const>
14686	<const name="OnNATRedirect" value="66">
14687	<desc>
14688	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
14689	</desc>
14690	</const>
14691	<const name="OnHostPciDevicePlug" value="67">
14692	<desc>
14693	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
14694	</desc>
14695	</const>
14696	<const name="OnVBoxSVCUnavailable" value="68">
14697	<desc>
14698	See <link to="IVBoxSVCUnavailableEvent">IVBoxSVCUnavailableEvent</link>.
14699	</desc>
14700	</const>
14701
14702	<!-- Last event marker -->
14703	<const name="Last" value="69">
14704	<desc>
14705	Must be last event, used for iterations and structures relying on numerical event values.
14706	</desc>
14707	</const>
14708
14709	</enum>
14710
14711	<interface
14712	name="IEventSource" extends="$unknown"
14713	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
14714	wsmap="managed"
14715	>
14716	<desc>
14717	Event source. Generally, any object which could generate events can be an event source,
14718	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
14719	an event source can work with listeners in either active or passive mode. In active mode it is up to
14720	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14721	event source keeps track of pending events for each listener and returns available events on demand.
14722
14723	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14724	</desc>
14725
14726	<method name="createListener">
14727	<desc>
14728	Creates a new listener object, useful for passive mode.
14729	</desc>
14730	<param name="listener" type="IEventListener" dir="return"/>
14731	</method>
14732
14733	<method name="createAggregator">
14734	<desc>
14735	Creates an aggregator event source, collecting events from multiple sources.
14736	This way a single listener can listen for events coming from multiple sources,
14737	using a single blocking getEvent() on the returned aggregator.
14738	</desc>
14739	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
14740	<desc>
14741	Subordinate event source this one aggregatres.
14742	</desc>
14743	</param>
14744	<param name="result" type="IEventSource" dir="return"/>
14745	</method>
14746
14747	<method name="registerListener">
14748	<desc>
14749	Register an event listener.
14750
14751	<note>
14752	To avoid system overload, the VirtualBox server process checks if passive event
14753	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14754	current implementation, if more than 500 pending events are detected for a passive
14755	event listener, it is forcefully unregistered by the system, and further
14756	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
14757	</note>
14758	</desc>
14759	<param name="listener" type="IEventListener" dir="in">
14760	<desc>Listener to register.</desc>
14761	</param>
14762	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
14763	<desc>
14764	Event types listener is interested in. One can use wildcards like -
14765	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
14766	than one event.
14767	</desc>
14768	</param>
14769	<param name="active" type="boolean" dir="in">
14770	<desc>
14771	Which mode this listener is operating in.
14772	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
14773	In passive mode, an internal event queue is created for this this IEventListener.
14774	For each event coming in, it is added to queues for all interested registered passive
14775	listeners. It is then up to the external code to call the listener's
14776	<link to="IEventListener::handleEvent" /> method. When done with an event, the
14777	external code must call <link to="#eventProcessed" />.
14778	</desc>
14779	</param>
14780	</method>
14781
14782	<method name="unregisterListener">
14783	<desc>
14784	Unregister an event listener. If listener is passive, and some waitable events are still
14785	in queue they are marked as processed automatically.
14786	</desc>
14787	<param name="listener" type="IEventListener" dir="in">
14788	<desc>Listener to unregister.</desc>
14789	</param>
14790	</method>
14791
14792	<method name="fireEvent">
14793	<desc>
14794	Fire an event for this source.
14795	</desc>
14796	<param name="event" type="IEvent" dir="in">
14797	<desc>Event to deliver.</desc>
14798	</param>
14799	<param name="timeout" type="long" dir="in">
14800	<desc>
14801	Maximum time to wait for event processing (if event is waitable), in ms;
14802	0 = no wait, -1 = indefinite wait.
14803	</desc>
14804	</param>
14805	<param name="result" type="boolean" dir="return">
14806	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14807	</param>
14808	</method>
14809
14810	<method name="getEvent">
14811	<desc>
14812	Get events from this peer's event queue (for passive mode). Calling this method
14813	regularly is required for passive event listeners to avoid system overload;
14814	see <link to="IEventSource::registerListener" /> for details.
14815
14816	<result name="VBOX_E_OBJECT_NOT_FOUND">
14817	Listener is not registered, or autounregistered.
14818	</result>
14819	</desc>
14820	<param name="listener" type="IEventListener" dir="in">
14821	<desc>Which listener to get data for.</desc>
14822	</param>
14823	<param name="timeout" type="long" dir="in">
14824	<desc>
14825	Maximum time to wait for events, in ms;
14826	0 = no wait, -1 = indefinite wait.
14827	</desc>
14828	</param>
14829	<param name="event" type="IEvent" dir="return">
14830	<desc>Event retrieved, or null if none available.</desc>
14831	</param>
14832	</method>
14833
14834	<method name="eventProcessed">
14835	<desc>
14836	Must be called for waitable events after a particular listener finished its
14837	event processing. When all listeners of a particular event have called this
14838	method, the system will then call <link to="IEvent::setProcessed" />.
14839	</desc>
14840	<param name="listener" type="IEventListener" dir="in">
14841	<desc>Which listener processed event.</desc>
14842	</param>
14843	<param name="event" type="IEvent" dir="in">
14844	<desc>Which event.</desc>
14845	</param>
14846	</method>
14847
14848	</interface>
14849
14850	<interface
14851	name="IEventListener" extends="$unknown"
14852	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14853	wsmap="managed"
14854	>
14855	<desc>
14856	Event listener. An event listener can work in either active or passive mode, depending on the way
14857	it was registered.
14858	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14859	</desc>
14860
14861	<method name="handleEvent">
14862	<desc>
14863	Handle event callback (called directly by IEventSource in active mode, or could be
14864	called by event processor thread in passive mode).
14865	</desc>
14866	<param name="event" type="IEvent" dir="in">
14867	<desc>Event available.</desc>
14868	</param>
14869	</method>
14870
14871	</interface>
14872
14873	<interface
14874	name="IEvent" extends="$unknown"
14875	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14876	wsmap="managed"
14877	>
14878	<desc>
14879	Abstract parent interface for VirtualBox events. Actual events will typically implement
14880	a more specific interface which derives from this (see below).
14881
14882	<b>Introduction to VirtualBox events</b>
14883
14884	Generally speaking, an event (represented by this interface) signals that something
14885	happened, while an event listener (see <link to="IEventListener" />) represents an
14886	entity that is interested in certain events. In order for this to work with
14887	unidirectional protocols (i.e. web services), the concepts of passive and active
14888	listener are used.
14889
14890	Event consumers can register themselves as listeners, providing an array of
14891	events they are interested in (see <link to="IEventSource::registerListener" />).
14892	When an event triggers, the listener is notified about the event. The exact
14893	mechanism of the notification depends on whether the listener was registered as
14894	an active or passive listener:
14895
14896	<ul>
14897	<li>An active listener is very similar to a callback: it is a function invoked
14898	by the API. As opposed to the callbacks that were used in the API before
14899	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
14900	</li>
14901
14902	<li>Passive listeners are somewhat trickier to implement, but do not require
14903	a client function to be callable, which is not an option with scripting
14904	languages or web service clients. Internally the <link to="IEventSource" />
14905	implementation maintains an event queue for each passive listener, and
14906	newly arrived events are put in this queue. When the listener calls
14907	<link to="IEventSource::getEvent"/>, first element from its internal event
14908	queue is returned. When the client completes processing of an event,
14909	the <link to="IEventSource::eventProcessed" /> function must be called,
14910	acknowledging that the event was processed. It supports implementing
14911	waitable events. On passive listener unregistration, all events from its
14912	queue are auto-acknowledged.
14913	</li>
14914	</ul>
14915
14916	Waitable events are useful in situations where the event generator wants to track
14917	delivery or a party wants to wait until all listeners have completed the event. A
14918	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14919	listeners might veto a certain action, and thus the event producer has to make
14920	sure that all listeners have processed the event and not vetoed before taking
14921	the action.
14922
14923	A given event may have both passive and active listeners at the same time.
14924
14925	<b>Using events</b>
14926
14927	Any VirtualBox object capable of producing externally visible events provides an
14928	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14929	This event source object is notified by VirtualBox once something has happened, so
14930	consumers may register event listeners with this event source. To register a listener,
14931	an object implementing the <link to="IEventListener" /> interface must be provided.
14932	For active listeners, such an object is typically created by the consumer, while for
14933	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14934	note that a listener created with @c createListener() must not be used as an active listener.
14935
14936	Once created, the listener must be registered to listen for the desired events
14937	(see <link to="IEventSource::registerListener" />), providing an array of
14938	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14939	event IDs or wildcards matching multiple event IDs.
14940
14941	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14942	called automatically when the event is triggered, while passive listeners have to call
14943	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14944	an event processing loop.
14945
14946	The IEvent interface is an abstract parent interface for all such VirtualBox events
14947	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14948	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14949	then cast to the appropriate specific interface using @c QueryInterface().
14950	</desc>
14951
14952	<attribute name="type" readonly="yes" type="VBoxEventType">
14953	<desc>
14954	Event type.
14955	</desc>
14956	</attribute>
14957
14958	<attribute name="source" readonly="yes" type="IEventSource">
14959	<desc>
14960	Source of this event.
14961	</desc>
14962	</attribute>
14963
14964	<attribute name="waitable" readonly="yes" type="boolean">
14965	<desc>
14966	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14967	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14968	as no additional overhead associated with waitability imposed.
14969	Waitable events are needed when one need to be able to wait for particular event processed,
14970	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14971	until all consumers confirmed events.
14972	</desc>
14973	</attribute>
14974
14975	<method name="setProcessed">
14976	<desc>
14977	Internal method called by the system when all listeners of a particular event have called
14978	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14979	</desc>
14980	</method>
14981
14982	<method name="waitProcessed">
14983	<desc>
14984	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14985	described semantics, for non-waitable returns true immediately.
14986	</desc>
14987	<param name="timeout" type="long" dir="in">
14988	<desc>
14989	Maximum time to wait for event processeing, in ms;
14990	0 = no wait, -1 = indefinite wait.
14991	</desc>
14992	</param>
14993	<param name="result" type="boolean" dir="return">
14994	<desc>If this event was processed before timeout.</desc>
14995	</param>
14996	</method>
14997	</interface>
14998
14999
15000	<interface
15001	name="IReusableEvent" extends="IEvent"
15002	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
15003	wsmap="managed"
15004	>
15005	<desc>Base abstract interface for all reusable events.</desc>
15006
15007	<attribute name="generation" readonly="yes" type="unsigned long">
15008	<desc>Current generation of event, incremented on reuse.</desc>
15009	</attribute>
15010
15011	<method name="reuse">
15012	<desc>
15013	Marks an event as reused, increments 'generation', fields shall no
15014	longer be considered valid.
15015	</desc>
15016	</method>
15017	</interface>
15018
15019	<interface
15020	name="IMachineEvent" extends="IEvent"
15021	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
15022	wsmap="managed" id="MachineEvent"
15023	>
15024	<desc>Base abstract interface for all machine events.</desc>
15025
15026	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
15027	<desc>ID of the machine this event relates to.</desc>
15028	</attribute>
15029
15030	</interface>
15031
15032	<interface
15033	name="IMachineStateChangedEvent" extends="IMachineEvent"
15034	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
15035	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
15036	>
15037	<desc>Machine state change event.</desc>
15038
15039	<attribute name="state" readonly="yes" type="MachineState">
15040	<desc>New execution state.</desc>
15041	</attribute>
15042	</interface>
15043
15044	<interface
15045	name="IMachineDataChangedEvent" extends="IMachineEvent"
15046	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
15047	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
15048	>
15049	<desc>
15050	Any of the settings of the given machine has changed.
15051	</desc>
15052	</interface>
15053
15054	<interface
15055	name="IMediumRegisteredEvent" extends="IEvent"
15056	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
15057	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
15058	>
15059	<desc>
15060	The given medium was registered or unregistered
15061	within this VirtualBox installation.
15062	</desc>
15063
15064	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
15065	<desc>ID of the medium this event relates to.</desc>
15066	</attribute>
15067
15068	<attribute name="mediumType" readonly="yes" type="DeviceType">
15069	<desc>Type of the medium this event relates to.</desc>
15070	</attribute>
15071
15072	<attribute name="registered" type="boolean" readonly="yes">
15073	<desc>
15074	If @c true, the medium was registered, otherwise it was
15075	unregistered.
15076	</desc>
15077	</attribute>
15078	</interface>
15079
15080	<interface
15081	name="IMachineRegisteredEvent" extends="IMachineEvent"
15082	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
15083	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
15084	>
15085	<desc>
15086	The given machine was registered or unregistered
15087	within this VirtualBox installation.
15088	</desc>
15089
15090	<attribute name="registered" type="boolean" readonly="yes">
15091	<desc>
15092	If @c true, the machine was registered, otherwise it was
15093	unregistered.
15094	</desc>
15095	</attribute>
15096	</interface>
15097
15098	<interface
15099	name="ISessionStateChangedEvent" extends="IMachineEvent"
15100	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
15101	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
15102	>
15103	<desc>
15104	The state of the session for the given machine was changed.
15105	<see>IMachine::sessionState</see>
15106	</desc>
15107
15108	<attribute name="state" type="SessionState" readonly="yes">
15109	<desc>
15110	New session state.
15111	</desc>
15112	</attribute>
15113	</interface>
15114
15115	<interface
15116	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
15117	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
15118	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
15119	>
15120	<desc>
15121	Notification when a guest property has changed.
15122	</desc>
15123
15124	<attribute name="name" readonly="yes" type="wstring">
15125	<desc>
15126	The name of the property that has changed.
15127	</desc>
15128	</attribute>
15129
15130	<attribute name="value" readonly="yes" type="wstring">
15131	<desc>
15132	The new property value.
15133	</desc>
15134	</attribute>
15135
15136	<attribute name="flags" readonly="yes" type="wstring">
15137	<desc>
15138	The new property flags.
15139	</desc>
15140	</attribute>
15141
15142	</interface>
15143
15144	<interface
15145	name="ISnapshotEvent" extends="IMachineEvent"
15146	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
15147	wsmap="managed" id="SnapshotEvent"
15148	>
15149	<desc>Base interface for all snapshot events.</desc>
15150
15151	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
15152	<desc>ID of the snapshot this event relates to.</desc>
15153	</attribute>
15154
15155	</interface>
15156
15157	<interface
15158	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
15159	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
15160	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
15161	>
15162	<desc>
15163	A new snapshot of the machine has been taken.
15164	<see>ISnapshot</see>
15165	</desc>
15166	</interface>
15167
15168	<interface
15169	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
15170	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
15171	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
15172	>
15173	<desc>
15174	Snapshot of the given machine has been deleted.
15175
15176	<note>
15177	This notification is delivered <b>after</b> the snapshot
15178	object has been uninitialized on the server (so that any
15179	attempt to call its methods will return an error).
15180	</note>
15181
15182	<see>ISnapshot</see>
15183	</desc>
15184	</interface>
15185
15186	<interface
15187	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
15188	uuid="07541941-8079-447a-a33e-47a69c7980db"
15189	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
15190	>
15191	<desc>
15192	Snapshot properties (name and/or description) have been changed.
15193	<see>ISnapshot</see>
15194	</desc>
15195	</interface>
15196
15197	<interface
15198	name="IMousePointerShapeChangedEvent" extends="IEvent"
15199	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
15200	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
15201	>
15202	<desc>
15203	Notification when the guest mouse pointer shape has
15204	changed. The new shape data is given.
15205	</desc>
15206
15207	<attribute name="visible" type="boolean" readonly="yes">
15208	<desc>
15209	Flag whether the pointer is visible.
15210	</desc>
15211	</attribute>
15212	<attribute name="alpha" type="boolean" readonly="yes">
15213	<desc>
15214	Flag whether the pointer has an alpha channel.
15215	</desc>
15216	</attribute>
15217	<attribute name="xhot" type="unsigned long" readonly="yes">
15218	<desc>
15219	The pointer hot spot X coordinate.
15220	</desc>
15221	</attribute>
15222	<attribute name="yhot" type="unsigned long" readonly="yes">
15223	<desc>
15224	The pointer hot spot Y coordinate.
15225	</desc>
15226	</attribute>
15227	<attribute name="width" type="unsigned long" readonly="yes">
15228	<desc>
15229	Width of the pointer shape in pixels.
15230	</desc>
15231	</attribute>
15232	<attribute name="height" type="unsigned long" readonly="yes">
15233	<desc>
15234	Height of the pointer shape in pixels.
15235	</desc>
15236	</attribute>
15237	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
15238	<desc>
15239	Shape buffer arrays.
15240
15241	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
15242	followed by a 32-bpp XOR (color) mask.
15243
15244	For pointers without alpha channel the XOR mask pixels are 32
15245	bit values: (lsb)BGR0(msb). For pointers with alpha channel
15246	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
15247
15248	An AND mask is used for pointers with alpha channel, so if the
15249	callback does not support alpha, the pointer could be
15250	displayed as a normal color pointer.
15251
15252	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
15253	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
15254	height</tt>. The padding bits at the end of each scanline are
15255	undefined.
15256
15257	The XOR mask follows the AND mask on the next 4-byte aligned
15258	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
15259	Bytes in the gap between the AND and the XOR mask are undefined.
15260	The XOR mask scanlines have no gap between them and the size of
15261	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
15262
15263	<note>
15264	If @a shape is 0, only the pointer visibility is changed.
15265	</note>
15266	</desc>
15267	</attribute>
15268	</interface>
15269
15270	<interface
15271	name="IMouseCapabilityChangedEvent" extends="IEvent"
15272	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
15273	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
15274	>
15275	<desc>
15276	Notification when the mouse capabilities reported by the
15277	guest have changed. The new capabilities are passed.
15278	</desc>
15279	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
15280	<desc>
15281	Supports absolute coordinates.
15282	</desc>
15283	</attribute>
15284	<attribute name="supportsRelative" type="boolean" readonly="yes">
15285	<desc>
15286	Supports relative coordinates.
15287	</desc>
15288	</attribute>
15289	<attribute name="needsHostCursor" type="boolean" readonly="yes">
15290	<desc>
15291	If host cursor is needed.
15292	</desc>
15293	</attribute>
15294	</interface>
15295
15296	<interface
15297	name="IKeyboardLedsChangedEvent" extends="IEvent"
15298	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
15299	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
15300	>
15301	<desc>
15302	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
15303	to alter the state of the keyboard LEDs.
15304	</desc>
15305	<attribute name="numLock" type="boolean" readonly="yes">
15306	<desc>
15307	NumLock status.
15308	</desc>
15309	</attribute>
15310	<attribute name="capsLock" type="boolean" readonly="yes">
15311	<desc>
15312	CapsLock status.
15313	</desc>
15314	</attribute>
15315	<attribute name="scrollLock" type="boolean" readonly="yes">
15316	<desc>
15317	ScrollLock status.
15318	</desc>
15319	</attribute>
15320	</interface>
15321
15322	<interface
15323	name="IStateChangedEvent" extends="IEvent"
15324	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
15325	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
15326	>
15327	<desc>
15328	Notification when the execution state of the machine has changed.
15329	The new state is given.
15330	</desc>
15331	<attribute name="state" type="MachineState" readonly="yes">
15332	<desc>
15333	New machine state.
15334	</desc>
15335	</attribute>
15336	</interface>
15337
15338	<interface
15339	name="IAdditionsStateChangedEvent" extends="IEvent"
15340	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
15341	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
15342	>
15343	<desc>
15344	Notification when a Guest Additions property changes.
15345	Interested callees should query IGuest attributes to
15346	find out what has changed.
15347	</desc>
15348	</interface>
15349
15350	<interface
15351	name="INetworkAdapterChangedEvent" extends="IEvent"
15352	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
15353	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
15354	>
15355	<desc>
15356	Notification when a property of one of the
15357	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
15358	changes. Interested callees should use INetworkAdapter methods and
15359	attributes to find out what has changed.
15360	</desc>
15361	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
15362	<desc>
15363	Network adapter that is subject to change.
15364	</desc>
15365	</attribute>
15366	</interface>
15367
15368	<interface
15369	name="ISerialPortChangedEvent" extends="IEvent"
15370	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
15371	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
15372	>
15373	<desc>
15374	Notification when a property of one of the
15375	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
15376	Interested callees should use ISerialPort methods and attributes
15377	to find out what has changed.
15378	</desc>
15379	<attribute name="serialPort" type="ISerialPort" readonly="yes">
15380	<desc>
15381	Serial port that is subject to change.
15382	</desc>
15383	</attribute>
15384	</interface>
15385
15386	<interface
15387	name="IParallelPortChangedEvent" extends="IEvent"
15388	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
15389	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
15390	>
15391	<desc>
15392	Notification when a property of one of the
15393	virtual <link to="IMachine::getParallelPort">parallel ports</link>
15394	changes. Interested callees should use ISerialPort methods and
15395	attributes to find out what has changed.
15396	</desc>
15397	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
15398	<desc>
15399	Parallel port that is subject to change.
15400	</desc>
15401	</attribute>
15402	</interface>
15403
15404	<interface
15405	name="IStorageControllerChangedEvent" extends="IEvent"
15406	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
15407	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
15408	>
15409	<desc>
15410	Notification when a
15411	<link to="IMachine::mediumAttachments">medium attachment</link>
15412	changes.
15413	</desc>
15414	</interface>
15415
15416	<interface
15417	name="IMediumChangedEvent" extends="IEvent"
15418	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
15419	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
15420	>
15421	<desc>
15422	Notification when a
15423	<link to="IMachine::mediumAttachments">medium attachment</link>
15424	changes.
15425	</desc>
15426	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
15427	<desc>
15428	Medium attachment that is subject to change.
15429	</desc>
15430	</attribute>
15431	</interface>
15432
15433	<interface
15434	name="ICPUChangedEvent" extends="IEvent"
15435	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
15436	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
15437	>
15438	<desc>
15439	Notification when a CPU changes.
15440	</desc>
15441	<attribute name="cpu" type="unsigned long" readonly="yes">
15442	<desc>
15443	The CPU which changed.
15444	</desc>
15445	</attribute>
15446	<attribute name="add" type="boolean" readonly="yes">
15447	<desc>
15448	Flag whether the CPU was added or removed.
15449	</desc>
15450	</attribute>
15451	</interface>
15452
15453	<interface
15454	name="ICPUExecutionCapChangedEvent" extends="IEvent"
15455	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
15456	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
15457	>
15458	<desc>
15459	Notification when the CPU execution cap changes.
15460	</desc>
15461	<attribute name="executionCap" type="unsigned long" readonly="yes">
15462	<desc>
15463	The new CPU execution cap value. (1-100)
15464	</desc>
15465	</attribute>
15466	</interface>
15467
15468	<interface
15469	name="IGuestKeyboardEvent" extends="IEvent"
15470	uuid="88394258-7006-40d4-b339-472ee3801844"
15471	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
15472	>
15473	<desc>
15474	Notification when guest keyboard event happens.
15475	</desc>
15476	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
15477	<desc>
15478	Array of scancodes.
15479	</desc>
15480	</attribute>
15481	</interface>
15482
15483	<interface
15484	name="IGuestMouseEvent" extends="IReusableEvent"
15485	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
15486	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
15487	>
15488	<desc>
15489	Notification when guest mouse event happens.
15490	</desc>
15491
15492	<attribute name="absolute" type="boolean" readonly="yes">
15493	<desc>
15494	If this event is relative or absolute.
15495	</desc>
15496	</attribute>
15497
15498	<attribute name="x" type="long" readonly="yes">
15499	<desc>
15500	New X position, or X delta.
15501	</desc>
15502	</attribute>
15503
15504	<attribute name="y" type="long" readonly="yes">
15505	<desc>
15506	New Y position, or Y delta.
15507	</desc>
15508	</attribute>
15509
15510	<attribute name="z" type="long" readonly="yes">
15511	<desc>
15512	Z delta.
15513	</desc>
15514	</attribute>
15515
15516	<attribute name="w" type="long" readonly="yes">
15517	<desc>
15518	W delta.
15519	</desc>
15520	</attribute>
15521
15522	<attribute name="buttons" type="long" readonly="yes">
15523	<desc>
15524	Button state bitmask.
15525	</desc>
15526	</attribute>
15527
15528	</interface>
15529
15530
15531	<interface
15532	name="IVRDEServerChangedEvent" extends="IEvent"
15533	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
15534	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
15535	>
15536	<desc>
15537	Notification when a property of the
15538	<link to="IMachine::VRDEServer">VRDE server</link> changes.
15539	Interested callees should use IVRDEServer methods and attributes to
15540	find out what has changed.
15541	</desc>
15542	</interface>
15543
15544	<interface
15545	name="IVRDEServerInfoChangedEvent" extends="IEvent"
15546	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
15547	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
15548	>
15549	<desc>
15550	Notification when the status of the VRDE server changes. Interested callees
15551	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
15552	attributes to find out what is the current status.
15553	</desc>
15554	</interface>
15555
15556	<interface
15557	name="IUSBControllerChangedEvent" extends="IEvent"
15558	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
15559	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
15560	>
15561	<desc>
15562	Notification when a property of the virtual
15563	<link to="IMachine::USBController">USB controller</link> changes.
15564	Interested callees should use IUSBController methods and attributes to
15565	find out what has changed.
15566	</desc>
15567	</interface>
15568
15569	<interface
15570	name="IUSBDeviceStateChangedEvent" extends="IEvent"
15571	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
15572	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
15573	>
15574	<desc>
15575	Notification when a USB device is attached to or detached from
15576	the virtual USB controller.
15577
15578	This notification is sent as a result of the indirect
15579	request to attach the device because it matches one of the
15580	machine USB filters, or as a result of the direct request
15581	issued by <link to="IConsole::attachUSBDevice"/> or
15582	<link to="IConsole::detachUSBDevice"/>.
15583
15584	This notification is sent in case of both a succeeded and a
15585	failed request completion. When the request succeeds, the
15586	@a error parameter is @c null, and the given device has been
15587	already added to (when @a attached is @c true) or removed from
15588	(when @a attached is @c false) the collection represented by
15589	<link to="IConsole::USBDevices"/>. On failure, the collection
15590	doesn't change and the @a error parameter represents the error
15591	message describing the failure.
15592	</desc>
15593	<attribute name="device" type="IUSBDevice" readonly="yes">
15594	<desc>
15595	Device that is subject to state change.
15596	</desc>
15597	</attribute>
15598	<attribute name="attached" type="boolean" readonly="yes">
15599	<desc>
15600	@c true if the device was attached and @c false otherwise.
15601	</desc>
15602	</attribute>
15603	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
15604	<desc>
15605	@c null on success or an error message object on failure.
15606	</desc>
15607	</attribute>
15608	</interface>
15609
15610	<interface
15611	name="ISharedFolderChangedEvent" extends="IEvent"
15612	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
15613	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
15614	>
15615	<desc>
15616	Notification when a shared folder is added or removed.
15617	The @a scope argument defines one of three scopes:
15618	<link to="IVirtualBox::sharedFolders">global shared folders</link>
15619	(<link to="Scope_Global">Global</link>),
15620	<link to="IMachine::sharedFolders">permanent shared folders</link> of
15621	the machine (<link to="Scope_Machine">Machine</link>) or <link
15622	to="IConsole::sharedFolders">transient shared folders</link> of the
15623	machine (<link to="Scope_Session">Session</link>). Interested callees
15624	should use query the corresponding collections to find out what has
15625	changed.
15626	</desc>
15627	<attribute name="scope" type="Scope" readonly="yes">
15628	<desc>
15629	Scope of the notification.
15630	</desc>
15631	</attribute>
15632	</interface>
15633
15634	<interface
15635	name="IRuntimeErrorEvent" extends="IEvent"
15636	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
15637	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
15638	>
15639	<desc>
15640	Notification when an error happens during the virtual
15641	machine execution.
15642
15643	There are three kinds of runtime errors:
15644	<ul>
15645	<li><i>fatal</i></li>
15646	<li><i>non-fatal with retry</i></li>
15647	<li><i>non-fatal warnings</i></li>
15648	</ul>
15649
15650	<b>Fatal</b> errors are indicated by the @a fatal parameter set
15651	to @c true. In case of fatal errors, the virtual machine
15652	execution is always paused before calling this notification, and
15653	the notification handler is supposed either to immediately save
15654	the virtual machine state using <link to="IConsole::saveState"/>
15655	or power it off using <link to="IConsole::powerDown"/>.
15656	Resuming the execution can lead to unpredictable results.
15657
15658	<b>Non-fatal</b> errors and warnings are indicated by the
15659	@a fatal parameter set to @c false. If the virtual machine
15660	is in the Paused state by the time the error notification is
15661	received, it means that the user can <i>try to resume</i> the machine
15662	execution after attempting to solve the problem that caused the
15663	error. In this case, the notification handler is supposed
15664	to show an appropriate message to the user (depending on the
15665	value of the @a id parameter) that offers several actions such
15666	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
15667	wants to retry, the notification handler should continue
15668	the machine execution using the <link to="IConsole::resume"/>
15669	call. If the machine execution is not Paused during this
15670	notification, then it means this notification is a <i>warning</i>
15671	(for example, about a fatal condition that can happen very soon);
15672	no immediate action is required from the user, the machine
15673	continues its normal execution.
15674
15675	Note that in either case the notification handler
15676	<b>must not</b> perform any action directly on a thread
15677	where this notification is called. Everything it is allowed to
15678	do is to post a message to another thread that will then talk
15679	to the user and take the corresponding action.
15680
15681	Currently, the following error identifiers are known:
15682	<ul>
15683	<li><tt>"HostMemoryLow"</tt></li>
15684	<li><tt>"HostAudioNotResponding"</tt></li>
15685	<li><tt>"VDIStorageFull"</tt></li>
15686	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
15687	</ul>
15688	</desc>
15689	<attribute name="fatal" type="boolean" readonly="yes">
15690	<desc>
15691	Whether the error is fatal or not.
15692	</desc>
15693	</attribute>
15694	<attribute name="id" type="wstring" readonly="yes">
15695	<desc>
15696	Error identifier.
15697	</desc>
15698	</attribute>
15699	<attribute name="message" type="wstring" readonly="yes">
15700	<desc>
15701	Optional error message.
15702	</desc>
15703	</attribute>
15704	</interface>
15705
15706
15707	<interface
15708	name="IEventSourceChangedEvent" extends="IEvent"
15709	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
15710	waitable="yes"
15711	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
15712	>
15713	<desc>
15714	Notification when an event source state changes (listener added or removed).
15715	</desc>
15716
15717	<attribute name="listener" type="IEventListener" readonly="yes">
15718	<desc>
15719	Event listener which has changed.
15720	</desc>
15721	</attribute>
15722
15723	<attribute name="add" type="boolean" readonly="yes">
15724	<desc>
15725	Flag whether listener was added or removed.
15726	</desc>
15727	</attribute>
15728	</interface>
15729
15730	<interface
15731	name="IExtraDataChangedEvent" extends="IEvent"
15732	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
15733	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
15734	>
15735	<desc>
15736	Notification when machine specific or global extra data
15737	has changed.
15738	</desc>
15739	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15740	<desc>
15741	ID of the machine this event relates to.
15742	Null for global extra data changes.
15743	</desc>
15744	</attribute>
15745	<attribute name="key" type="wstring" readonly="yes">
15746	<desc>
15747	Extra data key that has changed.
15748	</desc>
15749	</attribute>
15750	<attribute name="value" type="wstring" readonly="yes">
15751	<desc>
15752	Extra data value for the given key.
15753	</desc>
15754	</attribute>
15755	</interface>
15756
15757	<interface
15758	name="IVetoEvent" extends="IEvent"
15759	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
15760	wsmap="managed"
15761	>
15762	<desc>Base abstract interface for veto events.</desc>
15763
15764	<method name="addVeto">
15765	<desc>
15766	Adds a veto on this event.
15767	</desc>
15768	<param name="reason" type="wstring" dir="in">
15769	<desc>
15770	Reason for veto, could be null or empty string.
15771	</desc>
15772	</param>
15773	</method>
15774
15775	<method name="isVetoed">
15776	<desc>
15777	If this event was vetoed.
15778	</desc>
15779	<param name="result" type="boolean" dir="return">
15780	<desc>
15781	Reason for veto.
15782	</desc>
15783	</param>
15784	</method>
15785
15786	<method name="getVetos">
15787	<desc>
15788	Current veto reason list, if size is 0 - no veto.
15789	</desc>
15790	<param name="result" type="wstring" dir="return" safearray="yes">
15791	<desc>
15792	Array of reasons for veto provided by different event handlers.
15793	</desc>
15794	</param>
15795	</method>
15796
15797	</interface>
15798
15799	<interface
15800	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
15801	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
15802	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
15803	waitable="true"
15804	>
15805	<desc>
15806	Notification when someone tries to change extra data for
15807	either the given machine or (if @c null) global extra data.
15808	This gives the chance to veto against changes.
15809	</desc>
15810	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15811	<desc>
15812	ID of the machine this event relates to.
15813	Null for global extra data changes.
15814	</desc>
15815	</attribute>
15816	<attribute name="key" type="wstring" readonly="yes">
15817	<desc>
15818	Extra data key that has changed.
15819	</desc>
15820	</attribute>
15821	<attribute name="value" type="wstring" readonly="yes">
15822	<desc>
15823	Extra data value for the given key.
15824	</desc>
15825	</attribute>
15826	</interface>
15827
15828	<interface
15829	name="ICanShowWindowEvent" extends="IVetoEvent"
15830	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
15831	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
15832	waitable="true"
15833	>
15834	<desc>
15835	Notification when a call to
15836	<link to="IMachine::canShowConsoleWindow"/> is made by a
15837	front-end to check if a subsequent call to
15838	<link to="IMachine::showConsoleWindow"/> can succeed.
15839
15840	The callee should give an answer appropriate to the current
15841	machine state using event veto. This answer must
15842	remain valid at least until the next
15843	<link to="IConsole::state">machine state</link> change.
15844	</desc>
15845	</interface>
15846
15847	<interface
15848	name="IShowWindowEvent" extends="IEvent"
15849	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
15850	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
15851	waitable="true"
15852	>
15853	<desc>
15854	Notification when a call to
15855	<link to="IMachine::showConsoleWindow"/>
15856	requests the console window to be activated and brought to
15857	foreground on the desktop of the host PC.
15858
15859	This notification should cause the VM console process to
15860	perform the requested action as described above. If it is
15861	impossible to do it at a time of this notification, this
15862	method should return a failure.
15863
15864	Note that many modern window managers on many platforms
15865	implement some sort of focus stealing prevention logic, so
15866	that it may be impossible to activate a window without the
15867	help of the currently active application (which is supposedly
15868	an initiator of this notification). In this case, this method
15869	must return a non-zero identifier that represents the
15870	top-level window of the VM console process. The caller, if it
15871	represents a currently active process, is responsible to use
15872	this identifier (in a platform-dependent manner) to perform
15873	actual window activation.
15874
15875	This method must set @a winId to zero if it has performed all
15876	actions necessary to complete the request and the console
15877	window is now active and in foreground, to indicate that no
15878	further action is required on the caller's side.
15879	</desc>
15880	<attribute name="winId" type="long long">
15881	<desc>
15882	Platform-dependent identifier of the top-level VM console
15883	window, or zero if this method has performed all actions
15884	necessary to implement the <i>show window</i> semantics for
15885	the given platform and/or this VirtualBox front-end.
15886	</desc>
15887	</attribute>
15888	</interface>
15889
15890	<interface
15891	name="INATRedirectEvent" extends="IMachineEvent"
15892	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
15893	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
15894	>
15895	<desc>
15896	Notification when NAT redirect rule added or removed.
15897	</desc>
15898	<attribute name="slot" type="unsigned long" readonly="yes">
15899	<desc>
15900	Adapter which NAT attached to.
15901	</desc>
15902	</attribute>
15903	<attribute name="remove" type="boolean" readonly="yes">
15904	<desc>
15905	Whether rule remove or add.
15906	</desc>
15907	</attribute>
15908	<attribute name="name" type="wstring" readonly="yes">
15909	<desc>
15910	Name of the rule.
15911	</desc>
15912	</attribute>
15913	<attribute name="proto" type="NATProtocol" readonly="yes">
15914	<desc>
15915	Protocol (TCP or UDP) of the redirect rule.
15916	</desc>
15917	</attribute>
15918	<attribute name="hostIp" type="wstring" readonly="yes">
15919	<desc>
15920	Host ip address to bind socket on.
15921	</desc>
15922	</attribute>
15923	<attribute name="hostPort" type="long" readonly="yes">
15924	<desc>
15925	Host port to bind socket on.
15926	</desc>
15927	</attribute>
15928	<attribute name="guestIp" type="wstring" readonly="yes">
15929	<desc>
15930	Guest ip address to redirect to.
15931	</desc>
15932	</attribute>
15933	<attribute name="guestPort" type="long" readonly="yes">
15934	<desc>
15935	Guest port to redirect to.
15936	</desc>
15937	</attribute>
15938	</interface>
15939
15940	<interface
15941	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
15942	waitable="yes"
15943	uuid="EDD4782B-DB74-43A0-B724-2BAA36F039CC"
15944	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
15945	>
15946	<desc>
15947	Notification when host PCI device is plugged/unplugged.
15948	</desc>
15949
15950	<attribute name="plugged" type="boolean" readonly="yes">
15951	<desc>
15952	If device successfully plugged or unplugged.
15953	</desc>
15954	</attribute>
15955
15956	<attribute name="success" type="boolean" readonly="yes">
15957	<desc>
15958	If operation was successful, if false - 'message' attribute
15959	may be of interest.
15960	</desc>
15961	</attribute>
15962
15963	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
15964	<desc>
15965	Attachment info for this device.
15966	</desc>
15967	</attribute>
15968
15969	<attribute name="eventContext" type="IEventContext" readonly="yes">
15970	<desc>
15971	Context object, passed into attachHostPciDevice() and
15972	attachHostPciDevice().
15973	</desc>
15974	</attribute>
15975
15976	<attribute name="message" type="wstring" readonly="yes">
15977	<desc>
15978	Optional error message.
15979	</desc>
15980	</attribute>
15981
15982	</interface>
15983
15984	<interface
15985	name="IVBoxSVCUnavailableEvent" extends="IEvent"
15986	uuid="99f6b352-f5c1-4d15-9c32-939158da8983"
15987	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCUnavailable"
15988	>
15989	<desc>
15990	Notification when VBoxSVC becomes unavailable (due to a crash or similar
15991	unexpected circumstances).
15992	</desc>
15993	</interface>
15994
15995	<module name="VBoxSVC" context="LocalServer">
15996	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15997	namespace="virtualbox.org">
15998	<interface name="IVirtualBox" default="yes"/>
15999	</class>
16000	</module>
16001
16002	<module name="VBoxC" context="InprocServer" threadingModel="Free">
16003	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
16004	namespace="virtualbox.org">
16005	<interface name="IVirtualBoxClient" default="yes"/>
16006	</class>
16007
16008	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
16009	namespace="virtualbox.org">
16010	<interface name="ISession" default="yes"/>
16011	</class>
16012	</module>
16013
16014	</library>
16015
16016	</idl>
16017
16018	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format