VirtualBox.xidl@ 34011

Last change on this file since 34011 was 34011, checked in by vboxsync, 14 years ago
Burn fix
Property svn:eol-style set to `native`
File size: 574.6 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2010 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). Note that when pointers representing input
275	arguments (such as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum name="SettingsVersion"
388	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
389	>
390	<desc>Settings version of VirtualBox settings files. This is written to
391	the "version" attribute of the root "VirtualBox" element in the settings
392	file XML and indicates which VirtualBox version wrote the file.
393	</desc>
394
395	<const name="Null" value="0">
396	<desc>Null value, indicates invalid version.</desc>
397	</const>
398	<const name="v1_0" value="1">
399	<desc>Legacy settings version, not currently supported.</desc>
400	</const>
401	<const name="v1_1" value="2">
402	<desc>Legacy settings version, not currently supported.</desc>
403	</const>
404	<const name="v1_2" value="3">
405	<desc>Legacy settings version, not currently supported.</desc>
406	</const>
407	<const name="v1_3pre" value="4">
408	<desc>Legacy settings version, not currently supported.</desc>
409	</const>
410	<const name="v1_3" value="5">
411	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
412	<!--
413	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
414	-->
415	</const>
416	<const name="v1_4" value="6">
417	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
418	<!--
419	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
420	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
421	-->
422	</const>
423	<const name="v1_5" value="7">
424	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
425	<!-- 2008-09-04: 2.0.0 released
426	2008-11-20: settings version 1.5 introduced
427	2008-12-17: 2.1.0 released
428	Machine changes:
429	guest OS identifiers changed;
430	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
431	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
432	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
433	-->
434	</const>
435	<const name="v1_6" value="8">
436	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
437	<!-- 2008-12-17: 2.1.0 released
438	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
439	2009-04-08: 2.2.0 released
440	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
441	-->
442	</const>
443	<const name="v1_7" value="9">
444	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
445	<!-- 2008-12-17: 2.1.0 released
446	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
447	2009-04-08: 2.2.0 released
448	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
449	Machine changes: HardDiskAttachments is now StorageControllers (done)
450	-->
451	</const>
452	<const name="v1_8" value="10">
453	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
454	<!-- Machine additions: Display/@accelerate2DVideo (done)
455	-->
456	</const>
457	<const name="v1_9" value="11">
458	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
459	<!-- The big storage controller / DVD / Floppy rework (done)
460	-->
461	</const>
462	<const name="v1_10" value="12">
463	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
464	<!-- Machine changes: RTC localOrUTC (done)
465	CPU hot-plug support
466	-->
467	</const>
468	<const name="v1_11" value="13">
469	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
470	<!-- Machine changes: HD Audio controller, per-machine disk registries,
471	/@format attribute for DVD and floppy images.
472	-->
473	</const>
474	<const name="Future" value="99999">
475	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
476	</const>
477	</enum>
478
479	<enum
480	name="AccessMode"
481	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
482	>
483	<desc>
484	Access mode for opening files.
485	</desc>
486
487	<const name="ReadOnly" value="1"/>
488	<const name="ReadWrite" value="2"/>
489	</enum>
490
491	<enum
492	name="MachineState"
493	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
494	>
495	<desc>
496	Virtual machine execution state.
497
498	This enumeration represents possible values of the <link
499	to="IMachine::state"/> attribute.
500
501	Below is the basic virtual machine state diagram. It shows how the state
502	changes during virtual machine execution. The text in square braces shows
503	a method of the IConsole interface that performs the given state
504	transition.
505
506	<pre>
507	+---------[powerDown()] <- Stuck <--[failure]-+
508	V \|
509	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
510	\| \| \| \| V \|
511	\| Aborted -----+ +--> Running --[pause()]--> Paused
512	\| \| ^ \| ^ \|
513	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
514	\| ^ \| \| \| \|
515	\| \| +-----------------------------------------+-\|-------------------+ +
516	\| \| \| \| \|
517	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
518	\| \| \| \|
519	\| +-------- Saving <--------[saveState()]<----------+---------------------+
520	\| \| \|
521	+-------------- Stopping -------[powerDown()]<----------+---------------------+
522	</pre>
523
524	Note that states to the right from PoweredOff, Aborted and Saved in the
525	above diagram are called <i>online VM states</i>. These states
526	represent the virtual machine which is being executed in a dedicated
527	process (usually with a GUI window attached to it where you can see the
528	activity of the virtual machine and interact with it). There are two
529	special pseudo-states, FirstOnline and LastOnline, that can be used in
530	relational expressions to detect if the given machine state is online or
531	not:
532
533	<pre>
534	if (machine.GetState() >= MachineState_FirstOnline &&
535	machine.GetState() <= MachineState_LastOnline)
536	{
537	...the machine is being executed...
538	}
539	</pre>
540
541	When the virtual machine is in one of the online VM states (that is, being
542	executed), only a few machine settings can be modified. Methods working
543	with such settings contain an explicit note about that. An attempt to
544	change any oter setting or perform a modifying operation during this time
545	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
546
547	All online states except Running, Paused and Stuck are transitional: they
548	represent temporary conditions of the virtual machine that will last as
549	long as the operation that initiated such a condition.
550
551	The Stuck state is a special case. It means that execution of the machine
552	has reached the "Guru Meditation" condition. This condition indicates an
553	internal VMM (virtual machine manager) failure which may happen as a
554	result of either an unhandled low-level virtual hardware exception or one
555	of the recompiler exceptions (such as the <i>too-many-traps</i>
556	condition).
557
558	Note also that any online VM state may transit to the Aborted state. This
559	happens if the process that is executing the virtual machine terminates
560	unexpectedly (for example, crashes). Other than that, the Aborted state is
561	equivalent to PoweredOff.
562
563	There are also a few additional state diagrams that do not deal with
564	virtual machine execution and therefore are shown separately. The states
565	shown on these diagrams are called <i>offline VM states</i> (this includes
566	PoweredOff, Aborted and Saved too).
567
568	The first diagram shows what happens when a lengthy setup operation is
569	being executed (such as <link to="IMachine::attachDevice"/>).
570
571	<pre>
572	+----------------------------------(same state as before the call)------+
573	\| \|
574	+-> PoweredOff --+ \|
575	\| \| \|
576	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
577	\| \|
578	+-> Saved -------+
579	</pre>
580
581	The next two diagrams demonstrate the process of taking a snapshot of a
582	powered off virtual machine, restoring the state to that as of a snapshot
583	or deleting a snapshot, respectively.
584
585	<pre>
586	+----------------------------------(same state as before the call)------+
587	\| \|
588	+-> PoweredOff --+ \|
589	\| +-->[takeSnapshot()] -------------------> Saving ------+
590	+-> Aborted -----+
591
592	+-> PoweredOff --+
593	\| \|
594	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
595	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
596	+-> Saved -------+ \|
597	\| \|
598	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
599	</pre>
600
601	Note that the Saving state is present in both the offline state group and
602	online state group. Currently, the only way to determine what group is
603	assumed in a particular case is to remember the previous machine state: if
604	it was Running or Paused, then Saving is an online state, otherwise it is
605	an offline state. This inconsistency may be removed in one of the future
606	versions of VirtualBox by adding a new state.
607
608	<note internal="yes">
609	For whoever decides to touch this enum: In order to keep the
610	comparisons involving FirstOnline and LastOnline pseudo-states valid,
611	the numeric values of these states must be correspondingly updated if
612	needed: for any online VM state, the condition
613	<tt>FirstOnline <= state <= LastOnline</tt> must be
614	@c true. The same relates to transient states for which
615	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
616	@c true.
617	</note>
618	</desc>
619
620	<const name="Null" value="0">
621	<desc>Null value (never used by the API).</desc>
622	</const>
623	<const name="PoweredOff" value="1">
624	<desc>
625	The machine is not running and has no saved execution state; it has
626	either never been started or been shut down successfully.
627	</desc>
628	</const>
629	<const name="Saved" value="2">
630	<desc>
631	The machine is not currently running, but the execution state of the machine
632	has been saved to an external file when it was running, from where
633	it can be resumed.
634	</desc>
635	</const>
636	<const name="Teleported" value="3">
637	<desc>
638	The machine was teleported to a different host (or process) and then
639	powered off. Take care when powering it on again may corrupt resources
640	it shares with the teleportation target (e.g. disk and network).
641	</desc>
642	</const>
643	<const name="Aborted" value="4">
644	<desc>
645	The process running the machine has terminated abnormally. This may
646	indicate a crash of the VM process in host execution context, or
647	the VM process has been terminated externally.
648	</desc>
649	</const>
650	<const name="Running" value="5">
651	<desc>
652	The machine is currently being executed.
653	<note internal="yes">
654	For whoever decides to touch this enum: In order to keep the
655	comparisons in the old source code valid, this state must immediately
656	precede the Paused state.
657	TODO: Lift this spectacularly wonderful restriction.
658	</note>
659	</desc>
660	</const>
661	<const name="Paused" value="6">
662	<desc>
663	Execution of the machine has been paused.
664	<note internal="yes">
665	For whoever decides to touch this enum: In order to keep the
666	comparisons in the old source code valid, this state must immediately
667	follow the Running state.
668	TODO: Lift this spectacularly wonderful restriction.
669	</note>
670	</desc>
671	</const>
672	<const name="Stuck" value="7">
673	<desc>
674	Execution of the machine has reached the "Guru Meditation"
675	condition. This indicates a severe error in the hypervisor itself.
676	<note internal="yes">
677	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
678	"Guru", perhaps? Or are there some other VMM states that are
679	intended to be lumped in here as well?
680	</note>
681	</desc>
682	</const>
683	<const name="Teleporting" value="8">
684	<desc>
685	The machine is about to be teleported to a different host or process.
686	It is possible to pause a machine in this state, but it will go to the
687	@c TeleportingPausedVM state and it will not be
688	possible to resume it again unless the teleportation fails.
689	</desc>
690	</const>
691	<const name="LiveSnapshotting" value="9">
692	<desc>
693	A live snapshot is being taken. The machine is running normally, but
694	some of the runtime configuration options are inaccessible. Also, if
695	paused while in this state it will transition to
696	@c Saving and it will not be resume the
697	execution until the snapshot operation has completed.
698	</desc>
699	</const>
700	<const name="Starting" value="10">
701	<desc>
702	Machine is being started after powering it on from a
703	zero execution state.
704	</desc>
705	</const>
706	<const name="Stopping" value="11">
707	<desc>
708	Machine is being normally stopped powering it off, or after the guest OS
709	has initiated a shutdown sequence.
710	</desc>
711	</const>
712	<const name="Saving" value="12">
713	<desc>
714	Machine is saving its execution state to a file, or an online
715	snapshot of the machine is being taken.
716	</desc>
717	</const>
718	<const name="Restoring" value="13">
719	<desc>
720	Execution state of the machine is being restored from a file
721	after powering it on from the saved execution state.
722	</desc>
723	</const>
724	<const name="TeleportingPausedVM" value="14">
725	<desc>
726	The machine is being teleported to another host or process, but it is
727	not running. This is the paused variant of the
728	@c state.
729	</desc>
730	</const>
731	<const name="TeleportingIn" value="15">
732	<desc>
733	Teleporting the machine state in from another host or process.
734	</desc>
735	</const>
736	<const name="FaultTolerantSyncing" value="16">
737	<desc>
738	The machine is being synced with a fault tolerant VM running elsewhere.
739	</desc>
740	</const>
741	<const name="DeletingSnapshotOnline" value="17">
742	<desc>
743	Like @c DeletingSnapshot, but the merging of media is ongoing in
744	the background while the machine is running.
745	</desc>
746	</const>
747	<const name="DeletingSnapshotPaused" value="18">
748	<desc>
749	Like @c DeletingSnapshotOnline, but the machine was paused when the
750	merging of differencing media was started.
751	</desc>
752	</const>
753	<const name="RestoringSnapshot" value="19">
754	<desc>
755	A machine snapshot is being restored; this typically does not take long.
756	</desc>
757	</const>
758	<const name="DeletingSnapshot" value="20">
759	<desc>
760	A machine snapshot is being deleted; this can take a long time since this
761	may require merging differencing media. This value indicates that the
762	machine is not running while the snapshot is being deleted.
763	</desc>
764	</const>
765	<const name="SettingUp" value="21">
766	<desc>
767	Lengthy setup operation is in progress.
768	</desc>
769	</const>
770
771	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
772	<desc>
773	Pseudo-state: first online state (for use in relational expressions).
774	</desc>
775	</const>
776	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
777	<desc>
778	Pseudo-state: last online state (for use in relational expressions).
779	</desc>
780	</const>
781
782	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
783	<desc>
784	Pseudo-state: first transient state (for use in relational expressions).
785	</desc>
786	</const>
787	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
788	<desc>
789	Pseudo-state: last transient state (for use in relational expressions).
790	</desc>
791	</const>
792
793	</enum>
794
795	<enum
796	name="SessionState"
797	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
798	>
799	<desc>
800	Session state. This enumeration represents possible values of
801	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
802	attributes.
803	</desc>
804
805	<const name="Null" value="0">
806	<desc>Null value (never used by the API).</desc>
807	</const>
808	<const name="Unlocked" value="1">
809	<desc>
810	In <link to="IMachine::sessionState"/>, this means that the machine
811	is not locked for any sessions.
812
813	In <link to="ISession::state"/>, this means that no machine is
814	currently locked for this session.
815	</desc>
816	</const>
817	<const name="Locked" value="2">
818	<desc>
819	In <link to="IMachine::sessionState"/>, this means that the machine
820	is currently locked for a session, whose process identifier can
821	then be found in the <link to="IMachine::sessionPid" /> attribute.
822
823	In <link to="ISession::state"/>, this means that a machine is
824	currently locked for this session, and the mutable machine object
825	can be found in the <link to="ISession::machine"/> attribute
826	(see <link to="IMachine::lockMachine" /> for details).
827	</desc>
828	</const>
829	<const name="Spawning" value="3">
830	<desc>
831	A new process is being spawned for the machine as a result of
832	<link to="IMachine::launchVMProcess"/> call. This state also occurs
833	as a short transient state during an <link to="IMachine::lockMachine"/>
834	call.
835	</desc>
836	</const>
837	<const name="Unlocking" value="4">
838	<desc>
839	The session is being unlocked.
840	</desc>
841	</const>
842	</enum>
843
844	<enum
845	name="CPUPropertyType"
846	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
847	>
848	<desc>
849	Virtual CPU property type. This enumeration represents possible values of the
850	IMachine get- and setCPUProperty methods.
851	</desc>
852	<const name="Null" value="0">
853	<desc>Null value (never used by the API).</desc>
854	</const>
855	<const name="PAE" value="1">
856	<desc>
857	This setting determines whether VirtualBox will expose the Physical Address
858	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
859	is not available, it will not be reported.
860	</desc>
861	</const>
862	<const name="Synthetic" value="2">
863	<desc>
864	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
865	teleporting between host systems that differ significantly.
866	</desc>
867	</const>
868	</enum>
869
870
871	<enum
872	name="HWVirtExPropertyType"
873	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
874	>
875	<desc>
876	Hardware virtualization property type. This enumeration represents possible values
877	for the <link to="IMachine::getHWVirtExProperty"/> and
878	<link to="IMachine::setHWVirtExProperty"/> methods.
879	</desc>
880	<const name="Null" value="0">
881	<desc>Null value (never used by the API).</desc>
882	</const>
883	<const name="Enabled" value="1">
884	<desc>
885	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
886	such extensions are not available, they will not be used.
887	</desc>
888	</const>
889	<const name="Exclusive" value="2">
890	<desc>
891	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
892	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
893	feature of the host. To share these with other hypervisors, you must disable this property.
894	</desc>
895	</const>
896	<const name="VPID" value="3">
897	<desc>
898	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
899	</desc>
900	</const>
901	<const name="NestedPaging" value="4">
902	<desc>
903	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
904	</desc>
905	</const>
906	<const name="LargePages" value="5">
907	<desc>
908	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
909	</desc>
910	</const>
911	<const name="Force" value="6">
912	<desc>
913	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
914	not set, there will be an automatic fallback to software virtualization.
915	</desc>
916	</const>
917	</enum>
918
919	<enum
920	name="FaultToleranceState"
921	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
922	>
923	<desc>
924	Used with <link to="IMachine::faultToleranceState" />.
925	</desc>
926	<const name="Inactive" value="1">
927	<desc>No fault tolerance enabled.</desc>
928	</const>
929	<const name="Master" value="2">
930	<desc>Fault tolerant master VM.</desc>
931	</const>
932	<const name="Standby" value="3">
933	<desc>Fault tolerant standby VM.</desc>
934	</const>
935	</enum>
936
937	<enum
938	name="LockType"
939	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
940	>
941	<desc>
942	Used with <link to="IMachine::lockMachine" />.
943	</desc>
944	<const name="Write" value="2">
945	<desc>Lock the machine for writing.</desc>
946	</const>
947	<const name="Shared" value="1">
948	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
949	</const>
950	</enum>
951
952	<enum
953	name="SessionType"
954	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
955	>
956	<desc>
957	Session type. This enumeration represents possible values of the
958	<link to="ISession::type"/> attribute.
959	</desc>
960
961	<const name="Null" value="0">
962	<desc>Null value (never used by the API).</desc>
963	</const>
964	<const name="WriteLock" value="1">
965	<desc>
966	Session has acquired an exclusive write lock on a machine
967	using <link to="IMachine::lockMachine"/>.
968	</desc>
969	</const>
970	<const name="Remote" value="2">
971	<desc>
972	Session has launched a VM process using
973	<link to="IMachine::launchVMProcess"/>
974	</desc>
975	</const>
976	<const name="Shared" value="3">
977	<desc>
978	Session has obtained a link to another session using
979	<link to="IMachine::lockMachine"/>
980	</desc>
981	</const>
982	</enum>
983
984	<enum
985	name="DeviceType"
986	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
987	>
988	<desc>
989	Device type.
990	</desc>
991	<const name="Null" value="0">
992	<desc>
993	Null value, may also mean "no device" (not allowed for
994	<link to="IConsole::getDeviceActivity"/>).
995	</desc>
996	</const>
997	<const name="Floppy" value="1">
998	<desc>Floppy device.</desc>
999	</const>
1000	<const name="DVD" value="2">
1001	<desc>CD/DVD-ROM device.</desc>
1002	</const>
1003	<const name="HardDisk" value="3">
1004	<desc>Hard disk device.</desc>
1005	</const>
1006	<const name="Network" value="4">
1007	<desc>Network device.</desc>
1008	</const>
1009	<const name="USB" value="5">
1010	<desc>USB device.</desc>
1011	</const>
1012	<const name="SharedFolder" value="6">
1013	<desc>Shared folder device.</desc>
1014	</const>
1015	</enum>
1016
1017	<enum
1018	name="DeviceActivity"
1019	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1020	>
1021	<desc>
1022	Device activity for <link to="IConsole::getDeviceActivity"/>.
1023	</desc>
1024
1025	<const name="Null" value="0"/>
1026	<const name="Idle" value="1"/>
1027	<const name="Reading" value="2"/>
1028	<const name="Writing" value="3"/>
1029	</enum>
1030
1031	<enum
1032	name="ClipboardMode"
1033	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1034	>
1035	<desc>
1036	Host-Guest clipboard interchange mode.
1037	</desc>
1038
1039	<const name="Disabled" value="0"/>
1040	<const name="HostToGuest" value="1"/>
1041	<const name="GuestToHost" value="2"/>
1042	<const name="Bidirectional" value="3"/>
1043	</enum>
1044
1045	<enum
1046	name="Scope"
1047	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1048	>
1049	<desc>
1050	Scope of the operation.
1051
1052	A generic enumeration used in various methods to define the action or
1053	argument scope.
1054	</desc>
1055
1056	<const name="Global" value="0"/>
1057	<const name="Machine" value="1"/>
1058	<const name="Session" value="2"/>
1059	</enum>
1060
1061	<enum
1062	name="BIOSBootMenuMode"
1063	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1064	>
1065	<desc>
1066	BIOS boot menu mode.
1067	</desc>
1068
1069	<const name="Disabled" value="0"/>
1070	<const name="MenuOnly" value="1"/>
1071	<const name="MessageAndMenu" value="2"/>
1072	</enum>
1073
1074	<enum
1075	name="ProcessorFeature"
1076	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1077	>
1078	<desc>
1079	CPU features.
1080	</desc>
1081
1082	<const name="HWVirtEx" value="0"/>
1083	<const name="PAE" value="1"/>
1084	<const name="LongMode" value="2"/>
1085	<const name="NestedPaging" value="3"/>
1086	</enum>
1087
1088	<enum
1089	name="FirmwareType"
1090	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1091	>
1092	<desc>
1093	Firmware type.
1094	</desc>
1095	<const name="BIOS" value="1">
1096	<desc>BIOS Firmware.</desc>
1097	</const>
1098	<const name="EFI" value="2">
1099	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1100	</const>
1101	<const name="EFI32" value="3">
1102	<desc>Efi firmware, 32-bit.</desc>
1103	</const>
1104	<const name="EFI64" value="4">
1105	<desc>Efi firmware, 64-bit.</desc>
1106	</const>
1107	<const name="EFIDUAL" value="5">
1108	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1109	</const>
1110	</enum>
1111
1112	<enum
1113	name="PointingHidType"
1114	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1115	>
1116	<desc>
1117	Type of pointing device used in a virtual machine.
1118	</desc>
1119	<const name="None" value="1">
1120	<desc>No mouse.</desc>
1121	</const>
1122	<const name="PS2Mouse" value="2">
1123	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1124	</const>
1125	<const name="USBMouse" value="3">
1126	<desc>USB mouse (relative pointer).</desc>
1127	</const>
1128	<const name="USBTablet" value="4">
1129	<desc>USB tablet (absolute pointer).</desc>
1130	</const>
1131	<const name="ComboMouse" value="5">
1132	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1133	Using of such device can have negative performance implications. </desc>
1134	</const>
1135	</enum>
1136
1137	<enum
1138	name="KeyboardHidType"
1139	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1140	>
1141	<desc>
1142	Type of keyboard device used in a virtual machine.
1143	</desc>
1144	<const name="None" value="1">
1145	<desc>No keyboard.</desc>
1146	</const>
1147	<const name="PS2Keyboard" value="2">
1148	<desc>PS/2 keyboard.</desc>
1149	</const>
1150	<const name="USBKeyboard" value="3">
1151	<desc>USB keyboard.</desc>
1152	</const>
1153	<const name="ComboKeyboard" value="4">
1154	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1155	Using of such device can have negative performance implications. </desc>
1156	</const>
1157	</enum>
1158
1159	<!--
1160	// IVirtualBoxErrorInfo
1161	/////////////////////////////////////////////////////////////////////////
1162	-->
1163
1164	<interface
1165	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1166	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1167	supportsErrorInfo="no"
1168	wsmap="managed"
1169	>
1170	<desc>
1171	The IVirtualBoxErrorInfo interface represents extended error information.
1172
1173	Extended error information can be set by VirtualBox components after
1174	unsuccessful or partially successful method invocation. This information
1175	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1176	and then shown to the client in addition to the plain 32-bit result code.
1177
1178	In MS COM, this interface extends the IErrorInfo interface,
1179	in XPCOM, it extends the nsIException interface. In both cases,
1180	it provides a set of common attributes to retrieve error
1181	information.
1182
1183	Sometimes invocation of some component's method may involve methods of
1184	other components that may also fail (independently of this method's
1185	failure), or a series of non-fatal errors may precede a fatal error that
1186	causes method failure. In cases like that, it may be desirable to preserve
1187	information about all errors happened during method invocation and deliver
1188	it to the caller. The <link to="#next"/> attribute is intended
1189	specifically for this purpose and allows to represent a chain of errors
1190	through a single IVirtualBoxErrorInfo object set after method invocation.
1191
1192	Note that errors are stored to a chain in the reverse order, i.e. the
1193	initial error object you query right after method invocation is the last
1194	error set by the callee, the object it points to in the @a next attribute
1195	is the previous error and so on, up to the first error (which is the last
1196	in the chain).
1197	</desc>
1198
1199	<attribute name="resultCode" type="long" readonly="yes">
1200	<desc>
1201	Result code of the error.
1202	Usually, it will be the same as the result code returned
1203	by the method that provided this error information, but not
1204	always. For example, on Win32, CoCreateInstance() will most
1205	likely return E_NOINTERFACE upon unsuccessful component
1206	instantiation attempt, but not the value the component factory
1207	returned. Value is typed 'long', not 'result',
1208	to make interface usable from scripting languages.
1209	<note>
1210	In MS COM, there is no equivalent.
1211	In XPCOM, it is the same as nsIException::result.
1212	</note>
1213	</desc>
1214	</attribute>
1215
1216	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1217	<desc>
1218	UUID of the interface that defined the error.
1219	<note>
1220	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1221	data type.
1222	In XPCOM, there is no equivalent.
1223	</note>
1224	</desc>
1225	</attribute>
1226
1227	<attribute name="component" type="wstring" readonly="yes">
1228	<desc>
1229	Name of the component that generated the error.
1230	<note>
1231	In MS COM, it is the same as IErrorInfo::GetSource.
1232	In XPCOM, there is no equivalent.
1233	</note>
1234	</desc>
1235	</attribute>
1236
1237	<attribute name="text" type="wstring" readonly="yes">
1238	<desc>
1239	Text description of the error.
1240	<note>
1241	In MS COM, it is the same as IErrorInfo::GetDescription.
1242	In XPCOM, it is the same as nsIException::message.
1243	</note>
1244	</desc>
1245	</attribute>
1246
1247	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1248	<desc>
1249	Next error object if there is any, or @c null otherwise.
1250	<note>
1251	In MS COM, there is no equivalent.
1252	In XPCOM, it is the same as nsIException::inner.
1253	</note>
1254	</desc>
1255	</attribute>
1256
1257	</interface>
1258
1259	<!--
1260	// IVirtualBox
1261	/////////////////////////////////////////////////////////////////////////
1262	-->
1263
1264	<interface
1265	name="IDHCPServer" extends="$unknown"
1266	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1267	wsmap="managed"
1268	>
1269	<desc>
1270	The IDHCPServer interface represents the vbox dhcp server configuration.
1271
1272	To enumerate all the dhcp servers on the host, use the
1273	<link to="IVirtualBox::DHCPServers"/> attribute.
1274	</desc>
1275
1276	<attribute name="enabled" type="boolean">
1277	<desc>
1278	specifies if the dhcp server is enabled
1279	</desc>
1280	</attribute>
1281
1282	<attribute name="IPAddress" type="wstring" readonly="yes">
1283	<desc>
1284	specifies server IP
1285	</desc>
1286	</attribute>
1287
1288	<attribute name="networkMask" type="wstring" readonly="yes">
1289	<desc>
1290	specifies server network mask
1291	</desc>
1292	</attribute>
1293
1294	<attribute name="networkName" type="wstring" readonly="yes">
1295	<desc>
1296	specifies internal network name the server is used for
1297	</desc>
1298	</attribute>
1299
1300	<attribute name="lowerIP" type="wstring" readonly="yes">
1301	<desc>
1302	specifies from IP address in server address range
1303	</desc>
1304	</attribute>
1305
1306	<attribute name="upperIP" type="wstring" readonly="yes">
1307	<desc>
1308	specifies to IP address in server address range
1309	</desc>
1310	</attribute>
1311
1312	<method name="setConfiguration">
1313	<desc>
1314	configures the server
1315	<result name="E_INVALIDARG">
1316	invalid configuration supplied
1317	</result>
1318	</desc>
1319	<param name="IPAddress" type="wstring" dir="in">
1320	<desc>
1321	server IP address
1322	</desc>
1323	</param>
1324	<param name="networkMask" type="wstring" dir="in">
1325	<desc>
1326	server network mask
1327	</desc>
1328	</param>
1329	<param name="FromIPAddress" type="wstring" dir="in">
1330	<desc>
1331	server From IP address for address range
1332	</desc>
1333	</param>
1334	<param name="ToIPAddress" type="wstring" dir="in">
1335	<desc>
1336	server To IP address for address range
1337	</desc>
1338	</param>
1339	</method>
1340
1341	<method name="start">
1342	<desc>
1343	Starts DHCP server process.
1344	<result name="E_FAIL">
1345	Failed to start the process.
1346	</result>
1347	</desc>
1348	<param name="networkName" type="wstring" dir="in">
1349	<desc>
1350	Name of internal network DHCP server should attach to.
1351	</desc>
1352	</param>
1353	<param name="trunkName" type="wstring" dir="in">
1354	<desc>
1355	Name of internal network trunk.
1356	</desc>
1357	</param>
1358	<param name="trunkType" type="wstring" dir="in">
1359	<desc>
1360	Type of internal network trunk.
1361	</desc>
1362	</param>
1363	</method>
1364
1365	<method name="stop">
1366	<desc>
1367	Stops DHCP server process.
1368	<result name="E_FAIL">
1369	Failed to stop the process.
1370	</result>
1371	</desc>
1372	</method>
1373	</interface>
1374
1375	<interface
1376	name="IVirtualBox" extends="$unknown"
1377	uuid="e03d6527-9b72-43b5-b87f-88f1033d3866"
1378	wsmap="managed"
1379	>
1380	<desc>
1381	The IVirtualBox interface represents the main interface exposed by the
1382	product that provides virtual machine management.
1383
1384	An instance of IVirtualBox is required for the product to do anything
1385	useful. Even though the interface does not expose this, internally,
1386	IVirtualBox is implemented as a singleton and actually lives in the
1387	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1388	IVirtualBox can track the state of all virtual machines on a particular
1389	host, regardless of which frontend started them.
1390
1391	To enumerate all the virtual machines on the host, use the
1392	<link to="IVirtualBox::machines"/> attribute.
1393	</desc>
1394
1395	<attribute name="version" type="wstring" readonly="yes">
1396	<desc>
1397	A string representing the version number of the product. The
1398	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1399	last number represents the build number and will frequently change.
1400	</desc>
1401	</attribute>
1402
1403	<attribute name="revision" type="unsigned long" readonly="yes">
1404	<desc>
1405	The internal build revision number of the product.
1406	</desc>
1407	</attribute>
1408
1409	<attribute name="packageType" type="wstring" readonly="yes">
1410	<desc>
1411	A string representing the package type of this product. The
1412	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1413	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1414	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1415	this.
1416	</desc>
1417	</attribute>
1418
1419	<attribute name="homeFolder" type="wstring" readonly="yes">
1420	<desc>
1421	Full path to the directory where the global settings file,
1422	<tt>VirtualBox.xml</tt>, is stored.
1423
1424	In this version of VirtualBox, the value of this property is
1425	always <tt><user_dir>/.VirtualBox</tt> (where
1426	<tt><user_dir></tt> is the path to the user directory,
1427	as determined by the host OS), and cannot be changed.
1428
1429	This path is also used as the base to resolve relative paths in
1430	places where relative paths are allowed (unless otherwise
1431	expressly indicated).
1432	</desc>
1433	</attribute>
1434
1435	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1436	<desc>
1437	Full name of the global settings file.
1438	The value of this property corresponds to the value of
1439	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1440	</desc>
1441	</attribute>
1442
1443	<attribute name="host" type="IHost" readonly="yes">
1444	<desc>Associated host object.</desc>
1445	</attribute>
1446
1447	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1448	<desc>Associated system information object.</desc>
1449	</attribute>
1450
1451	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1452	<desc>
1453	Array of machine objects registered within this VirtualBox instance.
1454	</desc>
1455	</attribute>
1456
1457	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1458	<desc>
1459	Array of medium objects known to this VirtualBox installation.
1460
1461	This array contains only base media. All differencing
1462	media of the given base medium can be enumerated using
1463	<link to="IMedium::children"/>.
1464	</desc>
1465	</attribute>
1466
1467	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1468	<desc>
1469	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1470	</desc>
1471	</attribute>
1472
1473	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1474	<desc>
1475	Array of floppy image objects currently in use by this VirtualBox instance.
1476	</desc>
1477	</attribute>
1478
1479	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1480
1481	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1482
1483	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1484	<desc>
1485	Collection of global shared folders. Global shared folders are
1486	available to all virtual machines.
1487
1488	New shared folders are added to the collection using
1489	<link to="#createSharedFolder"/>. Existing shared folders can be
1490	removed using <link to="#removeSharedFolder"/>.
1491
1492	<note>
1493	In the current version of the product, global shared folders are not
1494	implemented and therefore this collection is always empty.
1495	</note>
1496	</desc>
1497	</attribute>
1498
1499	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1500	<desc>
1501	Associated performance collector object.
1502	</desc>
1503	</attribute>
1504
1505	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1506	<desc>
1507	DHCP servers.
1508	</desc>
1509	</attribute>
1510
1511	<attribute name="eventSource" type="IEventSource" readonly="yes">
1512	<desc>
1513	Event source for VirtualBox events.
1514	</desc>
1515	</attribute>
1516
1517	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1518	<desc>
1519	The extension pack manager.
1520	</desc>
1521	</attribute>
1522
1523
1524	<method name="composeMachineFilename">
1525	<desc>
1526	Returns a recommended full path of the settings file name for a new virtual
1527	machine.
1528
1529	This API serves two purposes:
1530
1531	<ul>
1532	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1533	for the @a settingsFile argument there, which means that API should use
1534	a recommended default file name.</li>
1535
1536	<li>It can be called manually by a client software before creating a machine,
1537	e.g. if that client wants to pre-create the machine directory to create
1538	virtual hard disks in that directory together with the new machine
1539	settings file. In that case, the file name should be stripped from the
1540	full settings file path returned by this function to obtain the
1541	machine directory.</li>
1542	</ul>
1543
1544	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1545	details about the machine name.
1546
1547	If @a baseFolder is a @c null or empty string (which is recommended), the
1548	default machine settings folder
1549	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1550	a base folder for the created machine, resulting in a file name like
1551	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1552	will be used.
1553
1554	This method does not access the host disks. In particular, it does not check
1555	for whether a machine of this name already exists.
1556	</desc>
1557	<param name="name" type="wstring" dir="in">
1558	<desc>Suggested machine name.</desc>
1559	</param>
1560	<param name="baseFolder" type="wstring" dir="in">
1561	<desc>Base machine folder (optional).</desc>
1562	</param>
1563	<param name="file" type="wstring" dir="return">
1564	<desc>Fully qualified path where the machine would be created.</desc>
1565	</param>
1566	</method>
1567
1568	<method name="createMachine">
1569	<desc>
1570	Creates a new virtual machine by creating a machine settings file at
1571	the given location.
1572
1573	VirtualBox machine settings files use a custom XML dialect. Starting
1574	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1575	and machine files can be created at arbitrary locations.
1576
1577	However, it is is recommended that machines be created in the default
1578	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1579	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1580	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1581	is called automatically to have such a recommended name composed based
1582	on the machine name given in the @a name argument.
1583
1584	If the resulting settings file already exists, this method will fail,
1585	unless @a forceOverwrite is set.
1586
1587	The new machine is created unregistered, with the initial configuration
1588	set according to the specified guest OS type. A typical sequence of
1589	actions to create a new virtual machine is as follows:
1590
1591	<ol>
1592	<li>
1593	Call this method to have a new machine created. The returned machine
1594	object will be "mutable" allowing to change any machine property.
1595	</li>
1596
1597	<li>
1598	Configure the machine using the appropriate attributes and methods.
1599	</li>
1600
1601	<li>
1602	Call <link to="IMachine::saveSettings" /> to write the settings
1603	to the machine's XML settings file. The configuration of the newly
1604	created machine will not be saved to disk until this method is
1605	called.
1606	</li>
1607
1608	<li>
1609	Call <link to="#registerMachine" /> to add the machine to the list
1610	of machines known to VirtualBox.
1611	</li>
1612	</ol>
1613
1614	The specified guest OS type identifier must match an ID of one of known
1615	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1616	array.
1617
1618	Optionally, you may specify an UUID of to assign to the created machine.
1619	However, this is not recommended and you should normally pass an empty
1620	(@c null) UUID to this method so that a new UUID will be automatically
1621	generated for every created machine. You can use UUID
1622	00000000-0000-0000-0000-000000000000 as @c null value.
1623
1624	<note>
1625	There is no way to change the name of the settings file or
1626	subfolder of the created machine directly.
1627	</note>
1628
1629	<result name="VBOX_E_OBJECT_NOT_FOUND">
1630	@a osTypeId is invalid.
1631	</result>
1632	<result name="VBOX_E_FILE_ERROR">
1633	Resulting settings file name is invalid or the settings file already
1634	exists or could not be created due to an I/O error.
1635	</result>
1636	<result name="E_INVALIDARG">
1637	@a name is empty or @c null.
1638	</result>
1639	</desc>
1640
1641	<param name="settingsFile" type="wstring" dir="in">
1642	<desc>Fully qualified path where the settings file should be created,
1643	or NULL for a default folder and file based on the @a name argument
1644	(see <link to="#composeMachineFilename" />).</desc>
1645	</param>
1646	<param name="name" type="wstring" dir="in">
1647	<desc>Machine name.</desc>
1648	</param>
1649	<param name="osTypeId" type="wstring" dir="in">
1650	<desc>Guest OS Type ID.</desc>
1651	</param>
1652	<param name="id" type="uuid" mod="string" dir="in">
1653	<desc>Machine UUID (optional).</desc>
1654	</param>
1655	<param name="forceOverwrite" type="boolean" dir="in">
1656	<desc>If true, an existing machine settings file will be overwritten.</desc>
1657	</param>
1658	<param name="machine" type="IMachine" dir="return">
1659	<desc>Created machine object.</desc>
1660	</param>
1661	</method>
1662
1663	<method name="openMachine">
1664	<desc>
1665	Opens a virtual machine from the existing settings file.
1666	The opened machine remains unregistered until you call
1667	<link to="#registerMachine"/>.
1668
1669	The specified settings file name must be fully qualified.
1670	The file must exist and be a valid machine XML settings file
1671	whose contents will be used to construct the machine object.
1672
1673	<result name="VBOX_E_FILE_ERROR">
1674	Settings file name invalid, not found or sharing violation.
1675	</result>
1676	</desc>
1677	<param name="settingsFile" type="wstring" dir="in">
1678	<desc>
1679	Name of the machine settings file.
1680	</desc>
1681	</param>
1682	<param name="machine" type="IMachine" dir="return">
1683	<desc>Opened machine object.</desc>
1684	</param>
1685	<note>
1686	<link to="IMachine::settingsModified"/> will return
1687	@c false for the created machine, until any of machine settings
1688	are changed.
1689	</note>
1690	</method>
1691
1692	<method name="registerMachine">
1693	<desc>
1694
1695	Registers the machine previously created using
1696	<link to="#createMachine"/> or opened using
1697	<link to="#openMachine"/> within this VirtualBox installation. After
1698	successful method invocation, the
1699	<link to="IMachineRegisteredEvent"/> event is fired.
1700
1701	<note>
1702	This method implicitly calls <link to="IMachine::saveSettings"/>
1703	to save all current machine settings before registering it.
1704	</note>
1705
1706	<result name="VBOX_E_OBJECT_NOT_FOUND">
1707	No matching virtual machine found.
1708	</result>
1709	<result name="VBOX_E_INVALID_OBJECT_STATE">
1710	Virtual machine was not created within this VirtualBox instance.
1711	</result>
1712
1713	</desc>
1714	<param name="machine" type="IMachine" dir="in"/>
1715	</method>
1716
1717	<method name="findMachine">
1718	<desc>
1719	Attempts to find a virtual machine given its name or UUID.
1720
1721	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1722	cannot safely be determined.</note>
1723
1724	<result name="VBOX_E_OBJECT_NOT_FOUND">
1725	Could not find registered machine matching @a nameOrId.
1726	</result>
1727
1728	</desc>
1729	<param name="nameOrId" type="wstring" dir="in">
1730	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1731	</param>
1732	<param name="machine" type="IMachine" dir="return">
1733	<desc>Machine object, if found.</desc>
1734	</param>
1735	</method>
1736
1737	<method name="createAppliance">
1738	<desc>
1739	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1740	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1741	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1742	</desc>
1743	<param name="appliance" type="IAppliance" dir="return">
1744	<desc>New appliance.</desc>
1745	</param>
1746	</method>
1747
1748	<method name="createHardDisk">
1749	<desc>
1750	Creates a new base medium object that will use the given storage
1751	format and location for medium data.
1752
1753	Note that the actual storage unit is not created by this method. In
1754	order to do it, and before you are able to attach the created medium
1755	to virtual machines, you must call one of the following methods to
1756	allocate a format-specific storage unit at the specified location:
1757	<ul>
1758	<li><link to="IMedium::createBaseStorage"/></li>
1759	<li><link to="IMedium::createDiffStorage"/></li>
1760	</ul>
1761
1762	Some medium attributes, such as <link to="IMedium::id"/>, may
1763	remain uninitialized until the medium storage unit is successfully
1764	created by one of the above methods.
1765
1766	After the storage unit is successfully created, it will be
1767	accessible through the <link to="#findMedium"/> method and can
1768	be found in the <link to="#hardDisks"/> array.
1769
1770	The list of all storage formats supported by this VirtualBox
1771	installation can be obtained using
1772	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1773	attribute is empty or @c null then the default storage format
1774	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1775	be used for creating a storage unit of the medium.
1776
1777	Note that the format of the location string is storage format specific.
1778	See <link to="IMedium::location"/> and IMedium for more details.
1779
1780	<result name="VBOX_E_OBJECT_NOT_FOUND">
1781	@a format identifier is invalid. See
1782	<link to="ISystemProperties::mediumFormats"/>.
1783	</result>
1784	<result name="VBOX_E_FILE_ERROR">
1785	@a location is a not valid file name (for file-based formats only).
1786	</result>
1787	</desc>
1788	<param name="format" type="wstring" dir="in">
1789	<desc>
1790	Identifier of the storage format to use for the new medium.
1791	</desc>
1792	</param>
1793	<param name="location" type="wstring" dir="in">
1794	<desc>
1795	Location of the storage unit for the new medium.
1796	</desc>
1797	</param>
1798	<param name="medium" type="IMedium" dir="return">
1799	<desc>Created medium object.</desc>
1800	</param>
1801	</method>
1802
1803	<method name="openMedium">
1804	<desc>
1805	Opens a medium from an existing storage location.
1806
1807	Once a medium has been opened, it can be passed to other VirtualBox
1808	methods, in particular to <link to="IMachine::attachDevice" />.
1809
1810	Depending on the given device type, the file at the storage location
1811	must be in one of the media formats understood by VirtualBox:
1812
1813	<ul>
1814	<li>With a "HardDisk" device type, the file must be a hard disk image
1815	in one of the formats supported by VirtualBox (see
1816	<link to="ISystemProperties::mediumFormats" />).
1817	After this method succeeds, if the medium is a base medium, it
1818	will be added to the <link to="#hardDisks"/> array attribute. </li>
1819	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1820	After this method succeeds, the medium will be added to the
1821	<link to="#DVDImages"/> array attribute.</li>
1822	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1823	After this method succeeds, the medium will be added to the
1824	<link to="#floppyImages"/> array attribute.</li>
1825	</ul>
1826
1827	After having been opened, the medium can be found by the <link to="#findMedium"/>
1828	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1829
1830	The UUID of the newly opened medium will either be retrieved from the
1831	storage location, if the format supports it (e.g. for hard disk images),
1832	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1833	If for some reason you need to change the medium's UUID, use
1834	<link to="IMedium::setIDs" />.
1835
1836	If a differencing hard disk medium is to be opened by this method, the
1837	operation will succeed only if its parent medium and all ancestors,
1838	if any, are already known to this VirtualBox installation (for example,
1839	were opened by this method before).
1840
1841	This method attempts to guess the storage format of the specified medium
1842	by reading medium data at the specified location.
1843
1844	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1845	the image is opened for read/write access and must have according permissions,
1846	as VirtualBox may actually write status information into the disk's metadata
1847	sections.
1848
1849	Note that write access is required for all typical hard disk usage in VirtualBox,
1850	since VirtualBox may need to write metadata such as a UUID into the image.
1851	The only exception is opening a source image temporarily for copying and
1852	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1853	again soon.
1854
1855	The format of the location string is storage format specific. See
1856	<link to="IMedium::location"/> and IMedium for more details.
1857
1858	Prior to VirtualBox 4.0, opening a medium added it to a global media
1859	registry in the VirtualBox.xml file, which was shared between all machines
1860	and made transporting machines and their media from one host to another
1861	difficult.
1862
1863	Starting with VirtualBox 4.0, media are only added to a registry when
1864	they are attached to a machine. Machines created with VirtualBox 4.0
1865	or later can have their own media registry. As a result, a medium attached
1866	to such a machine will be remembered in that machine's XML settings file.
1867	Media attached to older machines will continue to be added to the global
1868	registry.
1869
1870	<result name="VBOX_E_FILE_ERROR">
1871	Invalid medium storage file location or could not find the medium
1872	at the specified location.
1873	</result>
1874	<result name="VBOX_E_IPRT_ERROR">
1875	Could not get medium storage format.
1876	</result>
1877	<result name="E_INVALIDARG">
1878	Invalid medium storage format.
1879	</result>
1880	<result name="VBOX_E_INVALID_OBJECT_STATE">
1881	Medium has already been added to a media registry.
1882	</result>
1883	</desc>
1884	<param name="location" type="wstring" dir="in">
1885	<desc>
1886	Location of the storage unit that contains medium data in one of
1887	the supported storage formats.
1888	</desc>
1889	</param>
1890	<param name="deviceType" type="DeviceType" dir="in">
1891	<desc>
1892	Must be one of "HardDisk", "DVD" or "Floppy".
1893	</desc>
1894	</param>
1895	<param name="accessMode" type="AccessMode" dir="in">
1896	<desc>Whether to open the image in read/write or read-only mode. For
1897	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1898	</param>
1899	<param name="medium" type="IMedium" dir="return">
1900	<desc>Opened medium object.</desc>
1901	</param>
1902	</method>
1903
1904	<method name="findMedium">
1905	<desc>
1906	Returns a medium of the given type that uses the given fully qualified
1907	location or UUID to store medium data.
1908
1909	The given medium must be known to this VirtualBox installation, i.e.
1910	it must be previously created by <link to="#createHardDisk"/> or opened
1911	by <link to="#openMedium"/>.
1912
1913	The search is done by comparing the value of the @a location argument to
1914	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1915	attributes of each known medium.
1916
1917	On case sensitive file systems, a case sensitive comparison is performed,
1918	otherwise the case of symbols in the file path is ignored.
1919
1920	<result name="VBOX_E_OBJECT_NOT_FOUND">
1921	No medium object matching @a location found.
1922	</result>
1923	</desc>
1924	<param name="location" type="wstring" dir="in">
1925	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1926	</param>
1927	<param name="type" type="DeviceType" dir="in">
1928	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1929	</param>
1930	<param name="medium" type="IMedium" dir="return">
1931	<desc>Medium object, if found.</desc>
1932	</param>
1933	</method>
1934
1935	<method name="getGuestOSType">
1936	<desc>
1937	Returns an object describing the specified guest OS type.
1938
1939	The requested guest OS type is specified using a string which is a
1940	mnemonic identifier of the guest operating system, such as
1941	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1942	particular virtual machine can be read or set using the
1943	<link to="IMachine::OSTypeId"/> attribute.
1944
1945	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1946	available guest OS type objects. Each object has an
1947	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1948	the guest OS this object describes.
1949
1950	<result name="E_INVALIDARG">
1951	@a id is not a valid Guest OS type.
1952	</result>
1953
1954	</desc>
1955	<param name="id" type="uuid" mod="string" dir="in">
1956	<desc>Guest OS type ID string.</desc>
1957	</param>
1958	<param name="type" type="IGuestOSType" dir="return">
1959	<desc>Guest OS type object.</desc>
1960	</param>
1961	</method>
1962
1963	<method name="createSharedFolder">
1964	<desc>
1965	Creates a new global shared folder by associating the given logical
1966	name with the given host path, adds it to the collection of shared
1967	folders and starts sharing it. Refer to the description of
1968	<link to="ISharedFolder"/> to read more about logical names.
1969	<note>
1970	In the current implementation, this operation is not
1971	implemented.
1972	</note>
1973	</desc>
1974	<param name="name" type="wstring" dir="in">
1975	<desc>Unique logical name of the shared folder.</desc>
1976	</param>
1977	<param name="hostPath" type="wstring" dir="in">
1978	<desc>Full path to the shared folder in the host file system.</desc>
1979	</param>
1980	<param name="writable" type="boolean" dir="in">
1981	<desc>Whether the share is writable or readonly</desc>
1982	</param>
1983	<param name="automount" type="boolean" dir="in">
1984	<desc>Whether the share gets automatically mounted by the guest
1985	or not.</desc>
1986	</param>
1987	</method>
1988
1989	<method name="removeSharedFolder">
1990	<desc>
1991	Removes the global shared folder with the given name previously
1992	created by <link to="#createSharedFolder"/> from the collection of
1993	shared folders and stops sharing it.
1994	<note>
1995	In the current implementation, this operation is not
1996	implemented.
1997	</note>
1998	</desc>
1999	<param name="name" type="wstring" dir="in">
2000	<desc>Logical name of the shared folder to remove.</desc>
2001	</param>
2002	</method>
2003
2004	<method name="getExtraDataKeys">
2005	<desc>
2006	Returns an array representing the global extra data keys which currently
2007	have values defined.
2008	</desc>
2009	<param name="value" type="wstring" dir="return" safearray="yes">
2010	<desc>Array of extra data keys.</desc>
2011	</param>
2012	</method>
2013
2014	<method name="getExtraData">
2015	<desc>
2016	Returns associated global extra data.
2017
2018	If the requested data @a key does not exist, this function will
2019	succeed and return an empty string in the @a value argument.
2020
2021	<result name="VBOX_E_FILE_ERROR">
2022	Settings file not accessible.
2023	</result>
2024	<result name="VBOX_E_XML_ERROR">
2025	Could not parse the settings file.
2026	</result>
2027
2028	</desc>
2029	<param name="key" type="wstring" dir="in">
2030	<desc>Name of the data key to get.</desc>
2031	</param>
2032	<param name="value" type="wstring" dir="return">
2033	<desc>Value of the requested data key.</desc>
2034	</param>
2035	</method>
2036
2037	<method name="setExtraData">
2038	<desc>
2039	Sets associated global extra data.
2040
2041	If you pass @c null or empty string as a key @a value, the given @a key
2042	will be deleted.
2043
2044	<note>
2045	Before performing the actual data change, this method will ask all
2046	registered event listener using the
2047	<link to="IExtraDataCanChangeEvent"/>
2048	notification for a permission. If one of the listeners refuses the
2049	new value, the change will not be performed.
2050	</note>
2051	<note>
2052	On success, the
2053	<link to="IExtraDataChangedEvent"/> notification
2054	is called to inform all registered listeners about a successful data
2055	change.
2056	</note>
2057
2058	<result name="VBOX_E_FILE_ERROR">
2059	Settings file not accessible.
2060	</result>
2061	<result name="VBOX_E_XML_ERROR">
2062	Could not parse the settings file.
2063	</result>
2064	<result name="E_ACCESSDENIED">
2065	Modification request refused.
2066	</result>
2067
2068	</desc>
2069	<param name="key" type="wstring" dir="in">
2070	<desc>Name of the data key to set.</desc>
2071	</param>
2072	<param name="value" type="wstring" dir="in">
2073	<desc>Value to assign to the key.</desc>
2074	</param>
2075	</method>
2076
2077	<!--method name="createDHCPServerForInterface">
2078	<desc>
2079	Creates a dhcp server settings to be used for the given interface
2080	<result name="E_INVALIDARG">
2081	Host network interface @a name already exists.
2082	</result>
2083	</desc>
2084	<param name="interface" type="IHostNetworkInterface" dir="in">
2085	<desc>Network Interface</desc>
2086	</param>
2087	<param name="server" type="IDHCPServer" dir="out">
2088	<desc>Dhcp server settings</desc>
2089	</param>
2090	</method-->
2091
2092	<method name="createDHCPServer">
2093	<desc>
2094	Creates a dhcp server settings to be used for the given internal network name
2095	<result name="E_INVALIDARG">
2096	Host network interface @a name already exists.
2097	</result>
2098	</desc>
2099	<param name="name" type="wstring" dir="in">
2100	<desc>server name</desc>
2101	</param>
2102	<param name="server" type="IDHCPServer" dir="return">
2103	<desc>Dhcp server settings</desc>
2104	</param>
2105	</method>
2106
2107	<method name="findDHCPServerByNetworkName">
2108	<desc>
2109	Searches a dhcp server settings to be used for the given internal network name
2110	<result name="E_INVALIDARG">
2111	Host network interface @a name already exists.
2112	</result>
2113
2114	</desc>
2115	<param name="name" type="wstring" dir="in">
2116	<desc>server name</desc>
2117	</param>
2118	<param name="server" type="IDHCPServer" dir="return">
2119	<desc>Dhcp server settings</desc>
2120	</param>
2121	</method>
2122
2123	<!--method name="findDHCPServerForInterface">
2124	<desc>
2125	Searches a dhcp server settings to be used for the given interface
2126	<result name="E_INVALIDARG">
2127	Host network interface @a name already exists.
2128	</result>
2129	</desc>
2130	<param name="interface" type="IHostNetworkInterface" dir="in">
2131	<desc>Network Interface</desc>
2132	</param>
2133	<param name="server" type="IDHCPServer" dir="out">
2134	<desc>Dhcp server settings</desc>
2135	</param>
2136	</method-->
2137
2138	<method name="removeDHCPServer">
2139	<desc>
2140	Removes the dhcp server settings
2141	<result name="E_INVALIDARG">
2142	Host network interface @a name already exists.
2143	</result>
2144	</desc>
2145	<param name="server" type="IDHCPServer" dir="in">
2146	<desc>Dhcp server settings to be removed</desc>
2147	</param>
2148	</method>
2149
2150
2151	<method name="checkFirmwarePresent">
2152	<desc>
2153	Check if this VirtualBox installation has a firmware
2154	of the given type available, either system-wide or per-user.
2155	Optionally, this may return a hint where this firmware can be
2156	downloaded from.
2157	</desc>
2158	<param name="firmwareType" type="FirmwareType" dir="in">
2159	<desc>
2160	Type of firmware to check.
2161	</desc>
2162	</param>
2163	<param name="version" type="wstring" dir="in">
2164	<desc>Expected version number, usually empty string (presently ignored).</desc>
2165	</param>
2166
2167	<param name="url" type="wstring" dir="out">
2168	<desc>
2169	Suggested URL to download this firmware from.
2170	</desc>
2171	</param>
2172
2173	<param name="file" type="wstring" dir="out">
2174	<desc>
2175	Filename of firmware, only valid if result == TRUE.
2176	</desc>
2177	</param>
2178
2179	<param name="result" type="boolean" dir="return">
2180	<desc>If firmware of this type and version is available.</desc>
2181	</param>
2182	</method>
2183
2184	<method name="VRDERegisterLibrary">
2185	<desc>
2186	Appends a VRDE library to this VirtualBox installation.
2187
2188	The library implements a VirtualBox Remote Desktop Extension (VRDE),
2189	which is used to remotely connect to the virtual machines.
2190
2191	The system library extension (".DLL" or ".so") must be omitted.
2192	The library must reside in the VirtualBox installation directory.
2193	</desc>
2194	<param name="name" type="wstring" dir="in">
2195	<desc>The library name.</desc>
2196	</param>
2197	</method>
2198
2199	<method name="VRDEUnregisterLibrary">
2200	<desc>
2201	Removes a VRDE library from this VirtualBox installation.
2202	</desc>
2203	<param name="name" type="wstring" dir="in">
2204	<desc>The library name.</desc>
2205	</param>
2206	</method>
2207
2208	<method name="VRDEListLibraries">
2209	<desc>
2210	List registered libraries.
2211	</desc>
2212	<param name="names" type="wstring" dir="return" safearray="yes">
2213	<desc>Array of names of the libraries.</desc>
2214	</param>
2215	</method>
2216
2217	<method name="VRDEIsLibraryRegistered">
2218	<desc>
2219	Check if the library is registered.
2220	</desc>
2221	<param name="name" type="wstring" dir="in">
2222	<desc>The library name.</desc>
2223	</param>
2224	<param name="registered" type="boolean" dir="return">
2225	<desc>Whether the library is registered.</desc>
2226	</param>
2227	</method>
2228
2229	</interface>
2230
2231	<!--
2232	// IVFSExplorer
2233	/////////////////////////////////////////////////////////////////////////
2234	-->
2235
2236	<enum
2237	name="VFSType"
2238	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2239	>
2240	<desc>
2241	Virtual file systems supported by VFSExplorer.
2242	</desc>
2243
2244	<const name="File" value="1" />
2245	<const name="Cloud" value="2" />
2246	<const name="S3" value="3" />
2247	<const name="WebDav" value="4" />
2248	</enum>
2249
2250	<enum
2251	name="VFSFileType"
2252	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2253	>
2254	<desc>
2255	File types known by VFSExplorer.
2256	</desc>
2257
2258	<const name="Unknown" value="1" />
2259	<const name="Fifo" value="2" />
2260	<const name="DevChar" value="3" />
2261	<const name="Directory" value="4" />
2262	<const name="DevBlock" value="5" />
2263	<const name="File" value="6" />
2264	<const name="SymLink" value="7" />
2265	<const name="Socket" value="8" />
2266	<const name="WhiteOut" value="9" />
2267	</enum>
2268
2269	<interface
2270	name="IVFSExplorer" extends="$unknown"
2271	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2272	wsmap="managed"
2273	>
2274	<desc>
2275	The VFSExplorer interface unifies access to different file system
2276	types. This includes local file systems as well remote file systems like
2277	S3. For a list of supported types see <link to="VFSType" />.
2278	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2279	</desc>
2280
2281	<attribute name="path" type="wstring" readonly="yes">
2282	<desc>Returns the current path in the virtual file system.</desc>
2283	</attribute>
2284
2285	<attribute name="type" type="VFSType" readonly="yes">
2286	<desc>Returns the file system type which is currently in use.</desc>
2287	</attribute>
2288
2289	<method name="update">
2290	<desc>Updates the internal list of files/directories from the
2291	current directory level. Use <link to="#entryList" /> to get the full list
2292	after a call to this method.</desc>
2293
2294	<param name="aProgress" type="IProgress" dir="return">
2295	<desc>Progress object to track the operation completion.</desc>
2296	</param>
2297	</method>
2298
2299	<method name="cd">
2300	<desc>Change the current directory level.</desc>
2301
2302	<param name="aDir" type="wstring" dir="in">
2303	<desc>The name of the directory to go in.</desc>
2304	</param>
2305
2306	<param name="aProgress" type="IProgress" dir="return">
2307	<desc>Progress object to track the operation completion.</desc>
2308	</param>
2309	</method>
2310
2311	<method name="cdUp">
2312	<desc>Go one directory upwards from the current directory level.</desc>
2313
2314	<param name="aProgress" type="IProgress" dir="return">
2315	<desc>Progress object to track the operation completion.</desc>
2316	</param>
2317	</method>
2318
2319	<method name="entryList">
2320	<desc>Returns a list of files/directories after a call to <link
2321	to="#update" />. The user is responsible for keeping this internal
2322	list up do date.</desc>
2323
2324	<param name="aNames" type="wstring" safearray="yes" dir="out">
2325	<desc>The list of names for the entries.</desc>
2326	</param>
2327
2328	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2329	<desc>The list of types for the entries.</desc>
2330	</param>
2331
2332	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2333	<desc>The list of sizes (in bytes) for the entries.</desc>
2334	</param>
2335
2336	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2337	<desc>The list of file modes (in octal form) for the entries.</desc>
2338	</param>
2339	</method>
2340
2341	<method name="exists">
2342	<desc>Checks if the given file list exists in the current directory
2343	level.</desc>
2344
2345	<param name="aNames" type="wstring" safearray="yes" dir="in">
2346	<desc>The names to check.</desc>
2347	</param>
2348
2349	<param name="aExists" type="wstring" safearray="yes" dir="return">
2350	<desc>The names which exist.</desc>
2351	</param>
2352	</method>
2353
2354	<method name="remove">
2355	<desc>Deletes the given files in the current directory level.</desc>
2356
2357	<param name="aNames" type="wstring" safearray="yes" dir="in">
2358	<desc>The names to remove.</desc>
2359	</param>
2360
2361	<param name="aProgress" type="IProgress" dir="return">
2362	<desc>Progress object to track the operation completion.</desc>
2363	</param>
2364	</method>
2365
2366	</interface>
2367
2368	<!--
2369	// IAppliance
2370	/////////////////////////////////////////////////////////////////////////
2371	-->
2372
2373	<interface
2374	name="IAppliance" extends="$unknown"
2375	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2376	wsmap="managed"
2377	>
2378	<desc>
2379	Represents a platform-independent appliance in OVF format. An instance of this is returned
2380	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2381	virtual machines within an appliance with VirtualBox.
2382
2383	The OVF standard suggests two different physical file formats:
2384
2385	<ol>
2386	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2387	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2388	this descriptor file references other files such as disk images, as OVF appliances typically
2389	do, those additional files must be in the same directory as the descriptor file.</li>
2390
2391	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2392	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2393	files and optionally other files.
2394
2395	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2396	be added with a later version.</li>
2397	</ol>
2398
2399	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2400	<link to="IMachine" /> involves the following sequence of API calls:
2401
2402	<ol>
2403	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2404	</li>
2405
2406	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2407	would like to import. So long as this file is syntactically valid, this will succeed
2408	and fill the appliance object with the parsed data from the OVF file.
2409	</li>
2410
2411	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2412	contents of the IAppliance attributes accordingly. These can be inspected by a
2413	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2414	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2415	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2416	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2417	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2418	The GUI can then give the user the option to confirm and/or change these suggestions.
2419	</li>
2420
2421	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2422	virtual system (machine) to override the suggestions made by the interpret() routine.
2423	</li>
2424
2425	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2426	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2427	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2428	can be found in the <link to="#machines" /> array attribute.
2429	</li>
2430	</ol>
2431
2432	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2433
2434	<ol>
2435	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2436	an empty IAppliance object.
2437	</li>
2438
2439	<li>For each machine you would like to export, call <link to="IMachine::export" />
2440	with the IAppliance object you just created. Each such call creates one instance of
2441	<link to="IVirtualSystemDescription" /> inside the appliance.
2442	</li>
2443
2444	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2445	virtual system (machine) to override the suggestions made by the export() routine.
2446	</li>
2447
2448	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2449	file written.</li>
2450	</ol>
2451
2452	</desc>
2453
2454	<attribute name="path" type="wstring" readonly="yes">
2455	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2456	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2457	<link to="#write" /> (for export).
2458	This attribute is empty until one of these methods has been called.
2459	</desc>
2460	</attribute>
2461
2462	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2463	<desc>
2464	Array of virtual disk definitions. One such description exists for each
2465	disk definition in the OVF; each string array item represents one such piece of
2466	disk information, with the information fields separated by tab (\t) characters.
2467
2468	The caller should be prepared for additional fields being appended to
2469	this string in future versions of VirtualBox and therefore check for
2470	the number of tabs in the strings returned.
2471
2472	In the current version, the following eight fields are returned per string
2473	in the array:
2474
2475	<ol>
2476	<li>Disk ID (unique string identifier given to disk)</li>
2477
2478	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2479
2480	<li>Populated size (optional unsigned integer indicating the current size of the
2481	disk; can be approximate; -1 if unspecified)</li>
2482
2483	<li>Format (string identifying the disk format, typically
2484	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2485
2486	<li>Reference (where to find the disk image, typically a file name; if empty,
2487	then the disk should be created on import)</li>
2488
2489	<li>Image size (optional unsigned integer indicating the size of the image,
2490	which need not necessarily be the same as the values specified above, since
2491	the image may be compressed or sparse; -1 if not specified)</li>
2492
2493	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2494	presently unsupported and always -1)</li>
2495
2496	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2497	</ol>
2498	</desc>
2499	</attribute>
2500
2501	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2502	<desc> Array of virtual system descriptions. One such description is created
2503	for each virtual system (machine) found in the OVF.
2504	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2505	(for export) has been called.
2506	</desc>
2507	</attribute>
2508
2509	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2510	<desc>
2511	Contains the UUIDs of the machines created from the information in this appliances. This is only
2512	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2513	succeeded.
2514	</desc>
2515	</attribute>
2516
2517	<method name="read">
2518	<desc>
2519	Reads an OVF file into the appliance object.
2520
2521	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2522	mere fact that this method returns successfully does not mean that VirtualBox supports all
2523	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2524	</desc>
2525	<param name="file" type="wstring" dir="in">
2526	<desc>
2527	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2528	on whether the appliance is distributed as a set of files or as a single file, respectively).
2529	</desc>
2530	</param>
2531	<param name="aProgress" type="IProgress" dir="return">
2532	<desc>Progress object to track the operation completion.</desc>
2533	</param>
2534	</method>
2535
2536	<method name="interpret">
2537	<desc>
2538	Interprets the OVF data that was read when the appliance was constructed. After
2539	calling this method, one can inspect the
2540	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2541	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2542	the appliance.
2543
2544	Calling this method is the second step of importing an appliance into VirtualBox;
2545	see <link to="IAppliance" /> for an overview.
2546
2547	After calling this method, one should call <link to="#getWarnings" /> to find out
2548	if problems were encountered during the processing which might later lead to
2549	errors.
2550	</desc>
2551	</method>
2552
2553	<method name="importMachines">
2554	<desc>
2555	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2556	and other interfaces that match the information contained in the appliance as
2557	closely as possible, as represented by the import instructions in the
2558	<link to="#virtualSystemDescriptions" /> array.
2559
2560	Calling this method is the final step of importing an appliance into VirtualBox;
2561	see <link to="IAppliance" /> for an overview.
2562
2563	Since importing the appliance will most probably involve copying and converting
2564	disk images, which can take a long time, this method operates asynchronously and
2565	returns an IProgress object to allow the caller to monitor the progress.
2566
2567	After the import succeeded, the UUIDs of the IMachine instances created can be
2568	retrieved from the <link to="#machines" /> array attribute.
2569	</desc>
2570
2571	<param name="aProgress" type="IProgress" dir="return">
2572	<desc>Progress object to track the operation completion.</desc>
2573	</param>
2574	</method>
2575
2576	<method name="createVFSExplorer">
2577	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2578
2579	<param name="aUri" type="wstring" dir="in">
2580	<desc>The URI describing the file system to use.</desc>
2581	</param>
2582
2583	<param name="aExplorer" type="IVFSExplorer" dir="return">
2584	<desc></desc>
2585	</param>
2586	</method>
2587
2588	<method name="write">
2589	<desc>
2590	Writes the contents of the appliance exports into a new OVF file.
2591
2592	Calling this method is the final step of exporting an appliance from VirtualBox;
2593	see <link to="IAppliance" /> for an overview.
2594
2595	Since exporting the appliance will most probably involve copying and converting
2596	disk images, which can take a long time, this method operates asynchronously and
2597	returns an IProgress object to allow the caller to monitor the progress.
2598	</desc>
2599	<param name="format" type="wstring" dir="in">
2600	<desc>
2601	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2602	future versions of VirtualBox may support additional formats.
2603	</desc>
2604	</param>
2605	<param name="manifest" type="boolean" dir="in">
2606	<desc>
2607	Indicate if the optional manifest file (.mf) should be written. The manifest file
2608	is used for integrity checks prior import.
2609	</desc>
2610	</param>
2611	<param name="path" type="wstring" dir="in">
2612	<desc>
2613	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2614	on whether the appliance is distributed as a set of files or as a single file, respectively).
2615	</desc>
2616	</param>
2617	<param name="progress" type="IProgress" dir="return">
2618	<desc>Progress object to track the operation completion.</desc>
2619	</param>
2620	</method>
2621
2622	<method name="getWarnings">
2623	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2624
2625	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2626	<desc></desc>
2627	</param>
2628	</method>
2629
2630	</interface>
2631
2632	<enum
2633	name="VirtualSystemDescriptionType"
2634	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2635	>
2636	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2637	a configuration value.</desc>
2638
2639	<const name="Ignore" value="1" />
2640	<const name="OS" value="2" />
2641	<const name="Name" value="3" />
2642	<const name="Product" value="4" />
2643	<const name="Vendor" value="5" />
2644	<const name="Version" value="6" />
2645	<const name="ProductUrl" value="7" />
2646	<const name="VendorUrl" value="8" />
2647	<const name="Description" value="9" />
2648	<const name="License" value="10" />
2649	<const name="Miscellaneous" value="11" />
2650	<const name="CPU" value="12" />
2651	<const name="Memory" value="13" />
2652	<const name="HardDiskControllerIDE" value="14" />
2653	<const name="HardDiskControllerSATA" value="15" />
2654	<const name="HardDiskControllerSCSI" value="16" />
2655	<const name="HardDiskControllerSAS" value="17" />
2656	<const name="HardDiskImage" value="18" />
2657	<const name="Floppy" value="19" />
2658	<const name="CDROM" value="20" />
2659	<const name="NetworkAdapter" value="21" />
2660	<const name="USBController" value="22" />
2661	<const name="SoundCard" value="23" />
2662
2663	</enum>
2664
2665	<enum
2666	name="VirtualSystemDescriptionValueType"
2667	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2668	>
2669	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2670	type to fetch.</desc>
2671
2672	<const name="Reference" value="1" />
2673	<const name="Original" value="2" />
2674	<const name="Auto" value="3" />
2675	<const name="ExtraConfig" value="4" />
2676
2677	</enum>
2678
2679	<interface
2680	name="IVirtualSystemDescription" extends="$unknown"
2681	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2682	wsmap="managed"
2683	>
2684
2685	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2686	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2687	<link to="IAppliance::interpret" /> has been called, that array contains information
2688	about how the virtual systems described in the OVF should best be imported into
2689	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2690	import an OVF into VirtualBox.
2691	</desc>
2692
2693	<attribute name="count" type="unsigned long" readonly="yes">
2694	<desc>Return the number of virtual system description entries.</desc>
2695	</attribute>
2696
2697	<method name="getDescription">
2698	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2699	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2700
2701	The list below identifies the value sets that are possible depending on the
2702	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2703	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2704	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2705	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2706	the @a aExtraConfigValues[] array item may also be used.
2707
2708	<ul>
2709	<li>
2710	"OS": the guest operating system type. There must be exactly one such array item on import. The
2711	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2712	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2713	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2714	</li>
2715	<li>
2716	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2717	if none is present on import, then an automatic name will be created from the operating system
2718	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2719	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2720	<link to="IMachine" /> name that does not exist yet.
2721	</li>
2722	<li>
2723	"Description": an arbitrary description.
2724	</li>
2725	<li>
2726	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2727	code to display such a license for agreement; the Main API does not enforce any such policy.
2728	</li>
2729	<li>
2730	Miscellaneous: reserved for future use.
2731	</li>
2732	<li>
2733	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2734	</li>
2735	<li>
2736	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2737	is present on import, then VirtualBox will set a meaningful default based on the operating system
2738	type.
2739	</li>
2740	<li>
2741	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2742	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2743	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2744	writes into the OVF.
2745	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2746	type can use to specify which hard disk controller a virtual disk should be connected to.
2747	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2748	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2749	its virtual machines supports four channels (primary master, primary slave, secondary master,
2750	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2751	</li>
2752	<li>
2753	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2754	has no value in @a aOvfValues[] or @a aVBoxValues[].
2755	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2756	</li>
2757	<li>
2758	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2759	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2760	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2761	whereas VirtualBox considers it a class of storage controllers of its own; see
2762	<link to="StorageControllerType" />).
2763	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2764	</li>
2765	<li>
2766	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2767	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2768
2769	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2770	a path since the image file should be in the same location as the OVF file itself), whereas the
2771	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2772	hard disk image. This means that on import the image will be copied and converted from the
2773	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2774
2775	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2776	format: "controller=<index>;channel=<c>"
2777	In this string, <index> must be an integer specifying the hard disk controller to connect
2778	the image to. That number must be the index of an array item with one of the hard disk controller
2779	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2780	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2781	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2782	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2783	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2784	</li>
2785	<li>
2786	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2787	attachment information as with "HardDiskImage" items.
2788	</li>
2789	<li>
2790	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2791	attachment information as with "HardDiskImage" items.
2792	</li>
2793	<li>
2794	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2795	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2796	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2797	</li>
2798	<li>
2799	"USBController": a USB controller. There can be at most one such item. If and only if such an
2800	item ispresent, USB support will be enabled for the new virtual machine.
2801	</li>
2802	<li>
2803	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2804	present, sound support will be enabled for the new virtual machine. Note that the virtual
2805	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2806	may be different from the virtual soundcard expected by the appliance.
2807	</li>
2808	</ul>
2809
2810	</desc>
2811
2812	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2813	<desc></desc>
2814	</param>
2815
2816	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2817	<desc></desc>
2818	</param>
2819
2820	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2821	<desc></desc>
2822	</param>
2823
2824	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2825	<desc></desc>
2826	</param>
2827
2828	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2829	<desc></desc>
2830	</param>
2831
2832	</method>
2833
2834	<method name="getDescriptionByType">
2835	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2836	should be returned.</desc>
2837
2838	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2839	<desc></desc>
2840	</param>
2841
2842	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2843	<desc></desc>
2844	</param>
2845
2846	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2847	<desc></desc>
2848	</param>
2849
2850	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2859	<desc></desc>
2860	</param>
2861
2862	</method>
2863
2864	<method name="getValuesByType">
2865	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2866	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2867	values.</desc>
2868
2869	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2870	<desc></desc>
2871	</param>
2872
2873	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2874	<desc></desc>
2875	</param>
2876
2877	<param name="aValues" type="wstring" dir="return" safearray="yes">
2878	<desc></desc>
2879	</param>
2880
2881	</method>
2882
2883	<method name="setFinalValues">
2884	<desc>
2885	This method allows the appliance's user to change the configuration for the virtual
2886	system descriptions. For each array item returned from <link to="#getDescription" />,
2887	you must pass in one boolean value and one configuration value.
2888
2889	Each item in the boolean array determines whether the particular configuration item
2890	should be enabled.
2891	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2892	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2893	and SoundCard.
2894
2895	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2896	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2897	the configuration remains unchanged. Please see the documentation for getDescription()
2898	for valid configuration values for the individual array item types. If the
2899	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2900	</desc>
2901
2902	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2903	<desc></desc>
2904	</param>
2905
2906	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2907	<desc></desc>
2908	</param>
2909
2910	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2911	<desc></desc>
2912	</param>
2913	</method>
2914
2915	<method name="addDescription">
2916	<desc>
2917	This method adds an additional description entry to the stack of already
2918	available descriptions for this virtual system. This is handy for writing
2919	values which aren't directly supported by VirtualBox. One example would
2920	be the License type of <link to="VirtualSystemDescriptionType" />.
2921	</desc>
2922
2923	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2924	<desc></desc>
2925	</param>
2926
2927	<param name="aVBoxValue" type="wstring" dir="in">
2928	<desc></desc>
2929	</param>
2930
2931	<param name="aExtraConfigValue" type="wstring" dir="in">
2932	<desc></desc>
2933	</param>
2934	</method>
2935	</interface>
2936
2937
2938	<!--
2939	// IMachine
2940	/////////////////////////////////////////////////////////////////////////
2941	-->
2942
2943	<interface
2944	name="IInternalMachineControl" extends="$unknown"
2945	uuid="476126af-e223-4490-a8a0-b1f1575be013"
2946	internal="yes"
2947	wsmap="suppress"
2948	>
2949	<method name="setRemoveSavedStateFile">
2950	<desc>
2951	Updates the flag whether the saved state file is removed on a
2952	machine state change from Saved to PoweredOff.
2953	</desc>
2954	<param name="aRemove" type="boolean" dir="in"/>
2955	</method>
2956
2957	<method name="updateState">
2958	<desc>
2959	Updates the VM state.
2960	<note>
2961	This operation will also update the settings file with the correct
2962	information about the saved state file and delete this file from disk
2963	when appropriate.
2964	</note>
2965	</desc>
2966	<param name="state" type="MachineState" dir="in"/>
2967	</method>
2968
2969	<method name="getIPCId">
2970	<param name="id" type="wstring" dir="return"/>
2971	</method>
2972
2973	<method name="beginPowerUp">
2974	<desc>
2975	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2976	gives it the progress object that should be part of any pending
2977	<link to="IMachine::launchVMProcess"/> operations. The progress
2978	object may be called back to reflect an early cancelation, so some care
2979	have to be taken with respect to any cancelation callbacks. The console
2980	object will call <link to="IInternalMachineControl::endPowerUp"/>
2981	to signal the completion of the progress object.
2982	</desc>
2983	<param name="aProgress" type="IProgress" dir="in" />
2984	</method>
2985
2986	<method name="endPowerUp">
2987	<desc>
2988	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2989	This method may query status information from the progress object it
2990	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2991	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2992	call in order to complete that progress object.
2993	</desc>
2994	<param name="result" type="long" dir="in"/>
2995	</method>
2996
2997	<method name="runUSBDeviceFilters">
2998	<desc>
2999	Asks the server to run USB devices filters of the associated
3000	machine against the given USB device and tell if there is
3001	a match.
3002	<note>
3003	Intended to be used only for remote USB devices. Local
3004	ones don't require to call this method (this is done
3005	implicitly by the Host and USBProxyService).
3006	</note>
3007	</desc>
3008	<param name="device" type="IUSBDevice" dir="in"/>
3009	<param name="matched" type="boolean" dir="out"/>
3010	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3011	</method>
3012
3013	<method name="captureUSBDevice">
3014	<desc>
3015	Requests a capture of the given host USB device.
3016	When the request is completed, the VM process will
3017	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3018	notification.
3019	</desc>
3020	<param name="id" type="uuid" mod="string" dir="in"/>
3021	</method>
3022
3023	<method name="detachUSBDevice">
3024	<desc>
3025	Notification that a VM is going to detach (@a done = @c false) or has
3026	already detached (@a done = @c true) the given USB device.
3027	When the @a done = @c true request is completed, the VM process will
3028	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3029	notification.
3030	<note>
3031	In the @a done = @c true case, the server must run its own filters
3032	and filters of all VMs but this one on the detached device
3033	as if it were just attached to the host computer.
3034	</note>
3035	</desc>
3036	<param name="id" type="uuid" mod="string" dir="in"/>
3037	<param name="done" type="boolean" dir="in"/>
3038	</method>
3039
3040	<method name="autoCaptureUSBDevices">
3041	<desc>
3042	Requests a capture all matching USB devices attached to the host.
3043	When the request is completed, the VM process will
3044	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3045	notification per every captured device.
3046	</desc>
3047	</method>
3048
3049	<method name="detachAllUSBDevices">
3050	<desc>
3051	Notification that a VM that is being powered down. The done
3052	parameter indicates whether which stage of the power down
3053	we're at. When @a done = @c false the VM is announcing its
3054	intentions, while when @a done = @c true the VM is reporting
3055	what it has done.
3056	<note>
3057	In the @a done = @c true case, the server must run its own filters
3058	and filters of all VMs but this one on all detach devices as
3059	if they were just attached to the host computer.
3060	</note>
3061	</desc>
3062	<param name="done" type="boolean" dir="in"/>
3063	</method>
3064
3065	<method name="onSessionEnd">
3066	<desc>
3067	Triggered by the given session object when the session is about
3068	to close normally.
3069	</desc>
3070	<param name="session" type="ISession" dir="in">
3071	<desc>Session that is being closed</desc>
3072	</param>
3073	<param name="progress" type="IProgress" dir="return">
3074	<desc>
3075	Used to wait until the corresponding machine is actually
3076	dissociated from the given session on the server.
3077	Returned only when this session is a direct one.
3078	</desc>
3079	</param>
3080	</method>
3081
3082	<method name="beginSavingState">
3083	<desc>
3084	Called by the VM process to inform the server it wants to
3085	save the current state and stop the VM execution.
3086	</desc>
3087	<param name="progress" type="IProgress" dir="out">
3088	<desc>
3089	Progress object created by VBoxSVC to wait until
3090	the state is saved.
3091	</desc>
3092	</param>
3093	<param name="stateFilePath" type="wstring" dir="out">
3094	<desc>
3095	File path the VM process must save the execution state to.
3096	</desc>
3097	</param>
3098	</method>
3099
3100	<method name="endSavingState">
3101	<desc>
3102	Called by the VM process to inform the server that saving
3103	the state previously requested by #beginSavingState is either
3104	successfully finished or there was a failure.
3105
3106	<result name="VBOX_E_FILE_ERROR">
3107	Settings file not accessible.
3108	</result>
3109	<result name="VBOX_E_XML_ERROR">
3110	Could not parse the settings file.
3111	</result>
3112
3113	</desc>
3114
3115	<param name="result" type="long" dir="in">
3116	<desc>@c S_OK to indicate success.
3117	</desc>
3118	</param>
3119	<param name="errMsg" type="wstring" dir="in">
3120	<desc>@c human readable error message in case of failure.
3121	</desc>
3122	</param>
3123	</method>
3124
3125	<method name="adoptSavedState">
3126	<desc>
3127	Gets called by IConsole::adoptSavedState.
3128	<result name="VBOX_E_FILE_ERROR">
3129	Invalid saved state file path.
3130	</result>
3131	</desc>
3132	<param name="savedStateFile" type="wstring" dir="in">
3133	<desc>Path to the saved state file to adopt.</desc>
3134	</param>
3135	</method>
3136
3137	<method name="beginTakingSnapshot">
3138	<desc>
3139	Called from the VM process to request from the server to perform the
3140	server-side actions of creating a snapshot (creating differencing images
3141	and the snapshot object).
3142
3143	<result name="VBOX_E_FILE_ERROR">
3144	Settings file not accessible.
3145	</result>
3146	<result name="VBOX_E_XML_ERROR">
3147	Could not parse the settings file.
3148	</result>
3149	</desc>
3150	<param name="initiator" type="IConsole" dir="in">
3151	<desc>The console object that initiated this call.</desc>
3152	</param>
3153	<param name="name" type="wstring" dir="in">
3154	<desc>Snapshot name.</desc>
3155	</param>
3156	<param name="description" type="wstring" dir="in">
3157	<desc>Snapshot description.</desc>
3158	</param>
3159	<param name="consoleProgress" type="IProgress" dir="in">
3160	<desc>
3161	Progress object created by the VM process tracking the
3162	snapshot's progress. This has the following sub-operations:
3163	<ul>
3164	<li>setting up (weight 1);</li>
3165	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3166	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3167	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3168	<li>finishing up (weight 1)</li>
3169	</ul>
3170	</desc>
3171	</param>
3172	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3173	<desc>
3174	Whether this is an online snapshot (i.e. the machine is running).
3175	</desc>
3176	</param>
3177	<param name="stateFilePath" type="wstring" dir="out">
3178	<desc>
3179	File path the VM process must save the execution state to.
3180	</desc>
3181	</param>
3182	</method>
3183
3184	<method name="endTakingSnapshot">
3185	<desc>
3186	Called by the VM process to inform the server that the snapshot
3187	previously requested by #beginTakingSnapshot is either
3188	successfully taken or there was a failure.
3189	</desc>
3190
3191	<param name="success" type="boolean" dir="in">
3192	<desc>@c true to indicate success and @c false otherwise</desc>
3193	</param>
3194	</method>
3195
3196	<method name="deleteSnapshot">
3197	<desc>
3198	Gets called by IConsole::deleteSnapshot.
3199	<result name="VBOX_E_INVALID_OBJECT_STATE">
3200	Snapshot has more than one child snapshot.
3201	</result>
3202	</desc>
3203	<param name="initiator" type="IConsole" dir="in">
3204	<desc>The console object that initiated this call.</desc>
3205	</param>
3206	<param name="id" type="uuid" mod="string" dir="in">
3207	<desc>UUID of the snapshot to delete.</desc>
3208	</param>
3209	<param name="machineState" type="MachineState" dir="out">
3210	<desc>New machine state after this operation is started.</desc>
3211	</param>
3212	<param name="progress" type="IProgress" dir="return">
3213	<desc>Progress object to track the operation completion.</desc>
3214	</param>
3215	</method>
3216
3217	<method name="finishOnlineMergeMedium">
3218	<desc>
3219	Gets called by IConsole::onlineMergeMedium.
3220	</desc>
3221	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3222	<desc>The medium attachment which needs to be cleaned up.</desc>
3223	</param>
3224	<param name="source" type="IMedium" dir="in">
3225	<desc>Merge source medium.</desc>
3226	</param>
3227	<param name="target" type="IMedium" dir="in">
3228	<desc>Merge target medium.</desc>
3229	</param>
3230	<param name="mergeForward" type="boolean" dir="in">
3231	<desc>Merge direction.</desc>
3232	</param>
3233	<param name="parentForTarget" type="IMedium" dir="in">
3234	<desc>For forward merges: new parent for target medium.</desc>
3235	</param>
3236	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3237	<desc>For backward merges: list of media which need their parent UUID
3238	updated.</desc>
3239	</param>
3240	</method>
3241
3242	<method name="restoreSnapshot">
3243	<desc>
3244	Gets called by IConsole::RestoreSnapshot.
3245	</desc>
3246	<param name="initiator" type="IConsole" dir="in">
3247	<desc>The console object that initiated this call.</desc>
3248	</param>
3249	<param name="snapshot" type="ISnapshot" dir="in">
3250	<desc>The snapshot to restore the VM state from.</desc>
3251	</param>
3252	<param name="machineState" type="MachineState" dir="out">
3253	<desc>New machine state after this operation is started.</desc>
3254	</param>
3255	<param name="progress" type="IProgress" dir="return">
3256	<desc>Progress object to track the operation completion.</desc>
3257	</param>
3258	</method>
3259
3260	<method name="pullGuestProperties">
3261	<desc>
3262	Get the list of the guest properties matching a set of patterns along
3263	with their values, time stamps and flags and give responsibility for
3264	managing properties to the console.
3265	</desc>
3266	<param name="name" type="wstring" dir="out" safearray="yes">
3267	<desc>
3268	The names of the properties returned.
3269	</desc>
3270	</param>
3271	<param name="value" type="wstring" dir="out" safearray="yes">
3272	<desc>
3273	The values of the properties returned. The array entries match the
3274	corresponding entries in the @a name array.
3275	</desc>
3276	</param>
3277	<param name="timestamp" type="long long" dir="out" safearray="yes">
3278	<desc>
3279	The time stamps of the properties returned. The array entries match
3280	the corresponding entries in the @a name array.
3281	</desc>
3282	</param>
3283	<param name="flags" type="wstring" dir="out" safearray="yes">
3284	<desc>
3285	The flags of the properties returned. The array entries match the
3286	corresponding entries in the @a name array.
3287	</desc>
3288	</param>
3289	</method>
3290
3291	<method name="pushGuestProperty">
3292	<desc>
3293	Update a single guest property in IMachine.
3294	</desc>
3295	<param name="name" type="wstring" dir="in">
3296	<desc>
3297	The name of the property to be updated.
3298	</desc>
3299	</param>
3300	<param name="value" type="wstring" dir="in">
3301	<desc>
3302	The value of the property.
3303	</desc>
3304	</param>
3305	<param name="timestamp" type="long long" dir="in">
3306	<desc>
3307	The timestamp of the property.
3308	</desc>
3309	</param>
3310	<param name="flags" type="wstring" dir="in">
3311	<desc>
3312	The flags of the property.
3313	</desc>
3314	</param>
3315	</method>
3316
3317	<method name="lockMedia">
3318	<desc>
3319	Locks all media attached to the machine for writing and parents of
3320	attached differencing media (if any) for reading. This operation is
3321	atomic so that if it fails no media is actually locked.
3322
3323	This method is intended to be called when the machine is in Starting or
3324	Restoring state. The locked media will be automatically unlocked when
3325	the machine is powered off or crashed.
3326	</desc>
3327	</method>
3328	<method name="unlockMedia">
3329	<desc>
3330	Unlocks all media previously locked using
3331	<link to="IInternalMachineControl::lockMedia"/>.
3332
3333	This method is intended to be used with teleportation so that it is
3334	possible to teleport between processes on the same machine.
3335	</desc>
3336	</method>
3337	</interface>
3338
3339	<interface
3340	name="IBIOSSettings" extends="$unknown"
3341	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3342	wsmap="managed"
3343	>
3344	<desc>
3345	The IBIOSSettings interface represents BIOS settings of the virtual
3346	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3347	</desc>
3348	<attribute name="logoFadeIn" type="boolean">
3349	<desc>Fade in flag for BIOS logo animation.</desc>
3350	</attribute>
3351
3352	<attribute name="logoFadeOut" type="boolean">
3353	<desc>Fade out flag for BIOS logo animation.</desc>
3354	</attribute>
3355
3356	<attribute name="logoDisplayTime" type="unsigned long">
3357	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3358	</attribute>
3359
3360	<attribute name="logoImagePath" type="wstring">
3361	<desc>
3362	Local file system path for external BIOS splash image. Empty string
3363	means the default image is shown on boot.
3364	</desc>
3365	</attribute>
3366
3367	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3368	<desc>Mode of the BIOS boot device menu.</desc>
3369	</attribute>
3370
3371	<attribute name="ACPIEnabled" type="boolean">
3372	<desc>ACPI support flag.</desc>
3373	</attribute>
3374
3375	<attribute name="IOAPICEnabled" type="boolean">
3376	<desc>
3377	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3378	and support IRQs above 15.
3379	</desc>
3380	</attribute>
3381
3382	<attribute name="timeOffset" type="long long">
3383	<desc>
3384	Offset in milliseconds from the host system time. This allows for
3385	guests running with a different system date/time than the host.
3386	It is equivalent to setting the system date/time in the BIOS except
3387	it is not an absolute value but a relative one. Guest Additions
3388	time synchronization honors this offset.
3389	</desc>
3390	</attribute>
3391
3392	<attribute name="PXEDebugEnabled" type="boolean">
3393	<desc>
3394	PXE debug logging flag. If set, VirtualBox will write extensive
3395	PXE trace information to the release log.
3396	</desc>
3397	</attribute>
3398
3399	</interface>
3400
3401	<enum name="CleanupMode"
3402	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441">
3403	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3404	</desc>
3405	<const name="UnregisterOnly" value="1">
3406	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3407	</const>
3408	<const name="DetachAllReturnNone" value="2">
3409	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3410	</const>
3411	<const name="DetachAllReturnHardDisksOnly" value="3">
3412	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3413	</const>
3414	<const name="Full" value="4">
3415	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3416	</const>
3417	</enum>
3418
3419	<interface
3420	name="IMachine" extends="$unknown"
3421	uuid="7c05b1c3-c325-46cd-820d-47648d13b7f2"
3422	wsmap="managed"
3423	>
3424	<desc>
3425	The IMachine interface represents a virtual machine, or guest, created
3426	in VirtualBox.
3427
3428	This interface is used in two contexts. First of all, a collection of
3429	objects implementing this interface is stored in the
3430	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3431	machines that are currently registered with this VirtualBox
3432	installation. Also, once a session has been opened for the given virtual
3433	machine (e.g. the virtual machine is running), the machine object
3434	associated with the open session can be queried from the session object;
3435	see <link to="ISession"/> for details.
3436
3437	The main role of this interface is to expose the settings of the virtual
3438	machine and provide methods to change various aspects of the virtual
3439	machine's configuration. For machine objects stored in the
3440	<link to="IVirtualBox::machines"/> collection, all attributes are
3441	read-only unless explicitly stated otherwise in individual attribute
3442	and method descriptions.
3443
3444	In order to change a machine setting, a session for this machine must be
3445	opened using one of the <link to="IMachine::lockMachine" /> or
3446	<link to="IMachine::launchVMProcess"/> methods. After the
3447	machine has been successfully locked for a session, a mutable machine object
3448	needs to be queried from the session object and then the desired settings
3449	changes can be applied to the returned object using IMachine attributes and
3450	methods. See the <link to="ISession"/> interface description for more
3451	information about sessions.
3452
3453	Note that IMachine does not provide methods to control virtual machine
3454	execution (such as start the machine, or power it down) -- these methods
3455	are grouped in a separate interface called <link to="IConsole" />.
3456
3457	<see>ISession, IConsole</see>
3458	</desc>
3459
3460	<attribute name="parent" type="IVirtualBox" readonly="yes">
3461	<desc>Associated parent object.</desc>
3462	</attribute>
3463
3464	<attribute name="accessible" type="boolean" readonly="yes">
3465	<desc>
3466	Whether this virtual machine is currently accessible or not.
3467
3468	A machine is always deemed accessible unless it is registered <i>and</i>
3469	its settings file cannot be read or parsed (either because the file itself
3470	is unavailable or has invalid XML contents).
3471
3472	Every time this property is read, the accessibility state of
3473	this machine is re-evaluated. If the returned value is @c false,
3474	the <link to="#accessError"/> property may be used to get the
3475	detailed error information describing the reason of
3476	inaccessibility, including XML error messages.
3477
3478	When the machine is inaccessible, only the following properties
3479	can be used on it:
3480	<ul>
3481	<li><link to="#parent"/></li>
3482	<li><link to="#id"/></li>
3483	<li><link to="#settingsFilePath"/></li>
3484	<li><link to="#accessible"/></li>
3485	<li><link to="#accessError"/></li>
3486	</ul>
3487
3488	An attempt to access any other property or method will return
3489	an error.
3490
3491	The only possible action you can perform on an inaccessible
3492	machine is to unregister it using the
3493	<link to="IMachine::unregister"/> call (or, to check
3494	for the accessibility state once more by querying this
3495	property).
3496
3497	<note>
3498	In the current implementation, once this property returns
3499	@c true, the machine will never become inaccessible
3500	later, even if its settings file cannot be successfully
3501	read/written any more (at least, until the VirtualBox
3502	server is restarted). This limitation may be removed in
3503	future releases.
3504	</note>
3505	</desc>
3506	</attribute>
3507
3508	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3509	<desc>
3510	Error information describing the reason of machine
3511	inaccessibility.
3512
3513	Reading this property is only valid after the last call to
3514	<link to="#accessible"/> returned @c false (i.e. the
3515	machine is currently inaccessible). Otherwise, a @c null
3516	IVirtualBoxErrorInfo object will be returned.
3517	</desc>
3518	</attribute>
3519
3520	<attribute name="name" type="wstring">
3521	<desc>
3522	Name of the virtual machine.
3523
3524	Besides being used for human-readable identification purposes
3525	everywhere in VirtualBox, the virtual machine name is also used
3526	as a name of the machine's settings file and as a name of the
3527	subdirectory this settings file resides in. Thus, every time you
3528	change the value of this property, the settings file will be
3529	renamed once you call <link to="#saveSettings"/> to confirm the
3530	change. The containing subdirectory will be also renamed, but
3531	only if it has exactly the same name as the settings file
3532	itself prior to changing this property (for backward compatibility
3533	with previous API releases). The above implies the following
3534	limitations:
3535	<ul>
3536	<li>The machine name cannot be empty.</li>
3537	<li>The machine name can contain only characters that are valid
3538	file name characters according to the rules of the file
3539	system used to store VirtualBox configuration.</li>
3540	<li>You cannot have two or more machines with the same name
3541	if they use the same subdirectory for storing the machine
3542	settings files.</li>
3543	<li>You cannot change the name of the machine if it is running,
3544	or if any file in the directory containing the settings file
3545	is being used by another running machine or by any other
3546	process in the host operating system at a time when
3547	<link to="#saveSettings"/> is called.
3548	</li>
3549	</ul>
3550	If any of the above limitations are hit, <link to="#saveSettings"/>
3551	will return an appropriate error message explaining the exact
3552	reason and the changes you made to this machine will not be saved.
3553
3554	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3555	file is recommended, but not enforced. (Previous versions always
3556	used a generic ".xml" extension.)
3557	</desc>
3558	</attribute>
3559
3560	<attribute name="description" type="wstring">
3561	<desc>
3562	Description of the virtual machine.
3563
3564	The description attribute can contain any text and is
3565	typically used to describe the hardware and software
3566	configuration of the virtual machine in detail (i.e. network
3567	settings, versions of the installed software and so on).
3568	</desc>
3569	</attribute>
3570
3571	<attribute name="id" type="uuid" mod="string" readonly="yes">
3572	<desc>UUID of the virtual machine.</desc>
3573	</attribute>
3574
3575	<attribute name="OSTypeId" type="wstring">
3576	<desc>
3577	User-defined identifier of the Guest OS type.
3578	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3579	an IGuestOSType object representing details about the given
3580	Guest OS type.
3581	<note>
3582	This value may differ from the value returned by
3583	<link to="IGuest::OSTypeId"/> if Guest Additions are
3584	installed to the guest OS.
3585	</note>
3586	</desc>
3587	</attribute>
3588
3589	<attribute name="HardwareVersion" type="wstring">
3590	<desc>Hardware version identifier. Internal use only for now.</desc>
3591	</attribute>
3592
3593	<attribute name="hardwareUUID" type="uuid" mod="string">
3594	<desc>
3595	The UUID presented to the guest via memory tables, hardware and guest
3596	properties. For most VMs this is the same as the @a id, but for VMs
3597	which have been cloned or teleported it may be the same as the source
3598	VM. This latter is because the guest shouldn't notice that it was
3599	cloned or teleported.
3600	</desc>
3601	</attribute>
3602
3603	<attribute name="CPUCount" type="unsigned long">
3604	<desc>Number of virtual CPUs in the VM.</desc>
3605	</attribute>
3606
3607	<attribute name="CPUHotPlugEnabled" type="boolean">
3608	<desc>
3609	This setting determines whether VirtualBox allows CPU
3610	hotplugging for this machine.</desc>
3611	</attribute>
3612
3613	<attribute name="CPUExecutionCap" type="unsigned long">
3614	<desc>
3615	Means to limit the number of CPU cycles a guest can use. The unit
3616	is percentage of host CPU cycles per second. The valid range
3617	is 1 - 100. 100 (the default) implies no limit.
3618	</desc>
3619	</attribute>
3620
3621	<attribute name="memorySize" type="unsigned long">
3622	<desc>System memory size in megabytes.</desc>
3623	</attribute>
3624
3625	<attribute name="memoryBalloonSize" type="unsigned long">
3626	<desc>Memory balloon size in megabytes.</desc>
3627	</attribute>
3628
3629	<attribute name="PageFusionEnabled" type="boolean">
3630	<desc>
3631	This setting determines whether VirtualBox allows page
3632	fusion for this machine (64 bits host only).
3633	</desc>
3634	</attribute>
3635
3636	<attribute name="VRAMSize" type="unsigned long">
3637	<desc>Video memory size in megabytes.</desc>
3638	</attribute>
3639
3640	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3641	<desc>
3642	This setting determines whether VirtualBox allows this machine to make
3643	use of the 3D graphics support available on the host.</desc>
3644	</attribute>
3645
3646	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3647	<desc>
3648	This setting determines whether VirtualBox allows this machine to make
3649	use of the 2D video acceleration support available on the host.</desc>
3650	</attribute>
3651
3652	<attribute name="monitorCount" type="unsigned long">
3653	<desc>
3654	Number of virtual monitors.
3655	<note>
3656	Only effective on Windows XP and later guests with
3657	Guest Additions installed.
3658	</note>
3659	</desc>
3660	</attribute>
3661
3662	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3663	<desc>Object containing all BIOS settings.</desc>
3664	</attribute>
3665
3666	<attribute name="firmwareType" type="FirmwareType">
3667	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3668	bootstrap in this VM.</desc>
3669	</attribute>
3670
3671	<attribute name="pointingHidType" type="PointingHidType">
3672	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3673	The default is typically "PS2Mouse" but can vary depending on the
3674	requirements of the guest operating system.</desc>
3675	</attribute>
3676
3677	<attribute name="keyboardHidType" type="KeyboardHidType">
3678	<desc>Type of keyboard HID used in this VM.
3679	The default is typically "PS2Keyboard" but can vary depending on the
3680	requirements of the guest operating system.</desc>
3681	</attribute>
3682
3683	<attribute name="hpetEnabled" type="boolean">
3684	<desc>This attribute controls if High Precision Event Timer (HPET) is
3685	enabled in this VM. Use this property if you want to provide guests
3686	with additional time source, or if guest requires HPET to function correctly.
3687	Default is false.</desc>
3688	</attribute>
3689
3690	<attribute name="chipsetType" type="ChipsetType">
3691	<desc>Chipset type used in this VM.</desc>
3692	</attribute>
3693
3694	<attribute name="snapshotFolder" type="wstring">
3695	<desc>
3696	Full path to the directory used to store snapshot data
3697	(differencing media and saved state files) of this machine.
3698
3699	The initial value of this property is
3700	<tt><</tt><link to="#settingsFilePath">
3701	path_to_settings_file</link><tt>>/<</tt>
3702	<link to="#id">machine_uuid</link>
3703	<tt>></tt>.
3704
3705	Currently, it is an error to try to change this property on
3706	a machine that has snapshots (because this would require to
3707	move possibly large files to a different location).
3708	A separate method will be available for this purpose later.
3709
3710	<note>
3711	Setting this property to @c null or to an empty string will restore
3712	the initial value.
3713	</note>
3714	<note>
3715	When setting this property, the specified path can be
3716	absolute (full path) or relative to the directory where the
3717	<link to="#settingsFilePath">machine settings file</link>
3718	is located. When reading this property, a full path is
3719	always returned.
3720	</note>
3721	<note>
3722	The specified path may not exist, it will be created
3723	when necessary.
3724	</note>
3725	</desc>
3726	</attribute>
3727
3728	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3729	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3730	</attribute>
3731
3732	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3733	<desc>Array of media attached to this machine.</desc>
3734	</attribute>
3735
3736	<attribute name="USBController" type="IUSBController" readonly="yes">
3737	<desc>
3738	Associated USB controller object.
3739
3740	<note>
3741	If USB functionality is not available in the given edition of
3742	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3743	</note>
3744	</desc>
3745	</attribute>
3746
3747	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3748	<desc>Associated audio adapter, always present.</desc>
3749	</attribute>
3750
3751	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3752	<desc>Array of storage controllers attached to this machine.</desc>
3753	</attribute>
3754
3755	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3756	<desc>
3757	Full name of the file containing machine settings data.
3758	</desc>
3759	</attribute>
3760
3761	<attribute name="settingsModified" type="boolean" readonly="yes">
3762	<desc>
3763	Whether the settings of this machine have been modified
3764	(but neither yet saved nor discarded).
3765	<note>
3766	Reading this property is only valid on instances returned
3767	by <link to="ISession::machine"/> and on new machines
3768	created by <link to="IVirtualBox::createMachine"/> or opened
3769	by <link to="IVirtualBox::openMachine"/> but not
3770	yet registered, or on unregistered machines after calling
3771	<link to="IMachine::unregister"/>. For all other
3772	cases, the settings can never be modified.
3773	</note>
3774	<note>
3775	For newly created unregistered machines, the value of this
3776	property is always @c true until <link to="#saveSettings"/>
3777	is called (no matter if any machine settings have been
3778	changed after the creation or not). For opened machines
3779	the value is set to @c false (and then follows to normal rules).
3780	</note>
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="sessionState" type="SessionState" readonly="yes">
3785	<desc>Current session state for this machine.</desc>
3786	</attribute>
3787
3788	<attribute name="sessionType" type="wstring" readonly="yes">
3789	<desc>
3790	Type of the session. If <link to="#sessionState"/> is
3791	Spawning or Locked, this attribute contains the
3792	same value as passed to the
3793	<link to="IMachine::launchVMProcess"/> method in the
3794	@a type parameter. If the session was used with
3795	<link to="IMachine::lockMachine" />, or if
3796	<link to="#sessionState"/> is SessionClosed, the value of this
3797	attribute is an empty string.
3798	</desc>
3799	</attribute>
3800
3801	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3802	<desc>
3803	Identifier of the session process. This attribute contains the
3804	platform-dependent identifier of the process whose session was
3805	used with <link to="IMachine::lockMachine" /> call. The returned
3806	value is only valid if <link to="#sessionState"/> is Locked or
3807	Unlocking by the time this property is read.
3808	</desc>
3809	</attribute>
3810
3811	<attribute name="state" type="MachineState" readonly="yes">
3812	<desc>Current execution state of this machine.</desc>
3813	</attribute>
3814
3815	<attribute name="lastStateChange" type="long long" readonly="yes">
3816	<desc>
3817	Time stamp of the last execution state change,
3818	in milliseconds since 1970-01-01 UTC.
3819	</desc>
3820	</attribute>
3821
3822	<attribute name="stateFilePath" type="wstring" readonly="yes">
3823	<desc>
3824	Full path to the file that stores the execution state of
3825	the machine when it is in the <link to="MachineState_Saved"/> state.
3826	<note>
3827	When the machine is not in the Saved state, this attribute is
3828	an empty string.
3829	</note>
3830	</desc>
3831	</attribute>
3832
3833	<attribute name="logFolder" type="wstring" readonly="yes">
3834	<desc>
3835	Full path to the folder that stores a set of rotated log files
3836	recorded during machine execution. The most recent log file is
3837	named <tt>VBox.log</tt>, the previous log file is
3838	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3839	in the current version).
3840	</desc>
3841	</attribute>
3842
3843	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3844	<desc>
3845	Current snapshot of this machine. This is @c null if the machine
3846	currently has no snapshots. If it is not @c null, then it was
3847	set by one of <link to="IConsole::takeSnapshot" />,
3848	<link to="IConsole::deleteSnapshot" />
3849	or <link to="IConsole::restoreSnapshot" />, depending on which
3850	was called last. See <link to="ISnapshot"/> for details.
3851	</desc>
3852	</attribute>
3853
3854	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3855	<desc>
3856	Number of snapshots taken on this machine. Zero means the
3857	machine doesn't have any snapshots.
3858	</desc>
3859	</attribute>
3860
3861	<attribute name="currentStateModified" type="boolean" readonly="yes">
3862	<desc>
3863	Returns @c true if the current state of the machine is not
3864	identical to the state stored in the current snapshot.
3865
3866	The current state is identical to the current snapshot only
3867	directly after one of the following calls are made:
3868
3869	<ul>
3870	<li><link to="IConsole::restoreSnapshot"/>
3871	</li>
3872	<li><link to="IConsole::takeSnapshot"/> (issued on a
3873	"powered off" or "saved" machine, for which
3874	<link to="#settingsModified"/> returns @c false)
3875	</li>
3876	</ul>
3877
3878	The current state remains identical until one of the following
3879	happens:
3880	<ul>
3881	<li>settings of the machine are changed</li>
3882	<li>the saved state is deleted</li>
3883	<li>the current snapshot is deleted</li>
3884	<li>an attempt to execute the machine is made</li>
3885	</ul>
3886
3887	<note>
3888	For machines that don't have snapshots, this property is
3889	always @c false.
3890	</note>
3891	</desc>
3892	</attribute>
3893
3894	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3895	<desc>
3896	Collection of shared folders for this machine (permanent shared
3897	folders). These folders are shared automatically at machine startup
3898	and available only to the guest OS installed within this machine.
3899
3900	New shared folders are added to the collection using
3901	<link to="#createSharedFolder"/>. Existing shared folders can be
3902	removed using <link to="#removeSharedFolder"/>.
3903	</desc>
3904	</attribute>
3905
3906	<attribute name="clipboardMode" type="ClipboardMode">
3907	<desc>
3908	Synchronization mode between the host OS clipboard
3909	and the guest OS clipboard.
3910	</desc>
3911	</attribute>
3912
3913	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3914	<desc>
3915	A comma-separated list of simple glob patterns. Changes to guest
3916	properties whose name matches one of the patterns will generate an
3917	<link to="IGuestPropertyChangedEvent"/> signal.
3918	</desc>
3919	</attribute>
3920
3921	<attribute name="teleporterEnabled" type="boolean">
3922	<desc>
3923	When set to @a true, the virtual machine becomes a target teleporter
3924	the next time it is powered on. This can only set to @a true when the
3925	VM is in the @a PoweredOff or @a Aborted state.
3926
3927	<!-- This property is automatically set to @a false when the VM is powered
3928	on. (bird: This doesn't work yet ) -->
3929	</desc>
3930	</attribute>
3931
3932	<attribute name="teleporterPort" type="unsigned long">
3933	<desc>
3934	The TCP port the target teleporter will listen for incoming
3935	teleportations on.
3936
3937	0 means the port is automatically selected upon power on. The actual
3938	value can be read from this property while the machine is waiting for
3939	incoming teleportations.
3940	</desc>
3941	</attribute>
3942
3943	<attribute name="teleporterAddress" type="wstring">
3944	<desc>
3945	The address the target teleporter will listen on. If set to an empty
3946	string, it will listen on all addresses.
3947	</desc>
3948	</attribute>
3949
3950	<attribute name="teleporterPassword" type="wstring">
3951	<desc>
3952	The password to check for on the target teleporter. This is just a
3953	very basic measure to prevent simple hacks and operators accidentally
3954	beaming a virtual machine to the wrong place.
3955	</desc>
3956	</attribute>
3957
3958	<attribute name="faultToleranceState" type="FaultToleranceState">
3959	<desc>
3960	Fault tolerance state; disabled, source or target.
3961	This property can be changed at any time. If you change it for a running
3962	VM, then the fault tolerance address and port must be set beforehand.
3963	</desc>
3964	</attribute>
3965
3966	<attribute name="faultTolerancePort" type="unsigned long">
3967	<desc>
3968	The TCP port the fault tolerance source or target will use for
3969	communication.
3970	</desc>
3971	</attribute>
3972
3973	<attribute name="faultToleranceAddress" type="wstring">
3974	<desc>
3975	The address the fault tolerance source or target.
3976	</desc>
3977	</attribute>
3978
3979	<attribute name="faultTolerancePassword" type="wstring">
3980	<desc>
3981	The password to check for on the standby VM. This is just a
3982	very basic measure to prevent simple hacks and operators accidentally
3983	choosing the wrong standby VM.
3984	</desc>
3985	</attribute>
3986
3987	<attribute name="faultToleranceSyncInterval" type="unsigned long">
3988	<desc>
3989	The interval in ms used for syncing the state between source and target.
3990	</desc>
3991	</attribute>
3992
3993	<attribute name="RTCUseUTC" type="boolean">
3994	<desc>
3995	When set to @a true, the RTC device of the virtual machine will run
3996	in UTC time, otherwise in local time. Especially Unix guests prefer
3997	the time in UTC.
3998	</desc>
3999	</attribute>
4000
4001	<attribute name="ioCacheEnabled" type="boolean">
4002	<desc>
4003	When set to @a true, the builtin I/O cache of the virtual machine
4004	will be enabled.
4005	</desc>
4006	</attribute>
4007
4008	<attribute name="ioCacheSize" type="unsigned long">
4009	<desc>
4010	Maximum size of the I/O cache in MB.
4011	</desc>
4012	</attribute>
4013
4014	<method name="lockMachine">
4015	<desc>
4016	Locks the machine for the given session to enable the caller
4017	to make changes to the machine or start the VM or control
4018	VM execution.
4019
4020	There are two ways to lock a machine for such uses:
4021
4022	<ul>
4023	<li>If you want to make changes to the machine settings,
4024	you must obtain an exclusive write lock on the machine
4025	by setting @a lockType to @c Write.
4026
4027	This will only succeed if no other process has locked
4028	the machine to prevent conflicting changes. Only after
4029	an exclusive write lock has been obtained using this method, one
4030	can change all VM settings or execute the VM in the process
4031	space of the session object. (Note that the latter is only of
4032	interest if you actually want to write a new front-end for
4033	virtual machines; but this API gets called internally by
4034	the existing front-ends such as VBoxHeadless and the VirtualBox
4035	GUI to acquire a write lock on the machine that they are running.)
4036
4037	On success, write-locking the machine for a session creates
4038	a second copy of the IMachine object. It is this second object
4039	upon which changes can be made; in VirtualBox terminology, the
4040	second copy is "mutable". It is only this second, mutable machine
4041	object upon which you can call methods that change the
4042	machine state. After having called this method, you can
4043	obtain this second, mutable machine object using the
4044	<link to="ISession::machine" /> attribute.
4045	</li>
4046	<li>If you only want to check the machine state or control
4047	machine execution without actually changing machine
4048	settings (e.g. to get access to VM statistics or take
4049	a snapshot or save the machine state), then set the
4050	@a lockType argument to @c Shared.
4051
4052	If no other session has obtained a lock, you will obtain an
4053	exclusive write lock as described above. However, if another
4054	session has already obtained such a lock, then a link to that
4055	existing session will be established which allows you
4056	to control that existing session.
4057
4058	To find out which type of lock was obtained, you can
4059	inspect <link to="ISession::type" />, which will have been
4060	set to either @c WriteLock or @c Shared.
4061	</li>
4062	</ul>
4063
4064	In either case, you can get access to the <link to="IConsole" />
4065	object which controls VM execution.
4066
4067	Also in all of the above cases, one must always call
4068	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4069	the machine's state will eventually be set to "Aborted".
4070
4071	To change settings on a machine, the following sequence is typically
4072	performed:
4073
4074	<ol>
4075	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4076
4077	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4078
4079	<li>Change the settings of the machine by invoking IMachine methods.</li>
4080
4081	<li>Call <link to="IMachine::saveSettings" />.</li>
4082
4083	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4084	</ol>
4085
4086	<result name="E_UNEXPECTED">
4087	Virtual machine not registered.
4088	</result>
4089	<result name="E_ACCESSDENIED">
4090	Process not started by OpenRemoteSession.
4091	</result>
4092	<result name="VBOX_E_INVALID_OBJECT_STATE">
4093	Session already open or being opened.
4094	</result>
4095	<result name="VBOX_E_VM_ERROR">
4096	Failed to assign machine to session.
4097	</result>
4098	</desc>
4099	<param name="session" type="ISession" dir="in">
4100	<desc>
4101	Session object for which the machine will be locked.
4102	</desc>
4103	</param>
4104	<param name="lockType" type="LockType" dir="in">
4105	<desc>
4106	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4107	If set to @c Shared, then either acquire an exclusive write lock or establish
4108	a link to an existing session.
4109	</desc>
4110	</param>
4111	</method>
4112
4113	<method name="launchVMProcess">
4114	<desc>
4115	Spawns a new process that will execute the virtual machine and obtains a shared
4116	lock on the machine for the calling session.
4117
4118	If launching the VM succeeds, the new VM process will create its own session
4119	and write-lock the machine for it, preventing conflicting changes from other
4120	processes. If the machine is already locked (because it is already running or
4121	because another session has a write lock), launching the VM process will therefore
4122	fail. Reversely, future attempts to obtain a write lock will also fail while the
4123	machine is running.
4124
4125	The caller's session object remains separate from the session opened by the new
4126	VM process. It receives its own <link to="IConsole" /> object which can be used
4127	to control machine execution, but it cannot be used to change all VM settings
4128	which would be available after a <link to="#lockMachine" /> call.
4129
4130	The caller must eventually release the session's shared lock by calling
4131	<link to="ISession::unlockMachine" /> on the local session object once this call
4132	has returned. However, the session's state (see <link to="ISession::state" />)
4133	will not return to "Unlocked" until the remote session has also unlocked
4134	the machine (i.e. the machine has stopped running).
4135
4136	Launching a VM process can take some time (a new VM is started in a new process,
4137	for which memory and other resources need to be set up). Because of this,
4138	an <link to="IProgress" /> object is returned to allow the caller to wait
4139	for this asynchronous operation to be completed. Until then, the caller's
4140	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4141	and <link to="ISession::console" /> attributes cannot be accessed.
4142	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4143	similar calls to wait for completion. Completion is signalled when the VM
4144	is powered on. If launching the VM fails, error messages can be queried
4145	via the progress object, if available.
4146
4147	The progress object will have at least 2 sub-operations. The first
4148	operation covers the period up to the new VM process calls powerUp.
4149	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4150	progress object. Because <link to="IConsole::powerUp"/> may require
4151	some extra sub-operations, the <link to="IProgress::operationCount"/>
4152	may change at the completion of operation.
4153
4154	For details on the teleportation progress operation, see
4155	<link to="IConsole::powerUp"/>.
4156
4157	The @a environment argument is a string containing definitions of
4158	environment variables in the following format:
4159	@code
4160	NAME[=VALUE]\n
4161	NAME[=VALUE]\n
4162	...
4163	@endcode
4164	where <tt>\\n</tt> is the new line character. These environment
4165	variables will be appended to the environment of the VirtualBox server
4166	process. If an environment variable exists both in the server process
4167	and in this list, the value from this list takes precedence over the
4168	server's variable. If the value of the environment variable is
4169	omitted, this variable will be removed from the resulting environment.
4170	If the environment string is @c null or empty, the server environment
4171	is inherited by the started process as is.
4172
4173	<result name="E_UNEXPECTED">
4174	Virtual machine not registered.
4175	</result>
4176	<result name="E_INVALIDARG">
4177	Invalid session type @a type.
4178	</result>
4179	<result name="VBOX_E_OBJECT_NOT_FOUND">
4180	No machine matching @a machineId found.
4181	</result>
4182	<result name="VBOX_E_INVALID_OBJECT_STATE">
4183	Session already open or being opened.
4184	</result>
4185	<result name="VBOX_E_IPRT_ERROR">
4186	Launching process for machine failed.
4187	</result>
4188	<result name="VBOX_E_VM_ERROR">
4189	Failed to assign machine to session.
4190	</result>
4191	</desc>
4192	<param name="session" type="ISession" dir="in">
4193	<desc>
4194	Client session object to which the VM process will be connected (this
4195	must be in "Unlocked" state).
4196	</desc>
4197	</param>
4198	<param name="type" type="wstring" dir="in">
4199	<desc>
4200	Front-end to use for the new VM process. The following are currently supported:
4201	<ul>
4202	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4203	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4204	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4205	</ul>
4206	</desc>
4207	</param>
4208	<param name="environment" type="wstring" dir="in">
4209	<desc>
4210	Environment to pass to the VM process.
4211	</desc>
4212	</param>
4213	<param name="progress" type="IProgress" dir="return">
4214	<desc>Progress object to track the operation completion.</desc>
4215	</param>
4216	</method>
4217
4218	<method name="setBootOrder">
4219	<desc>
4220	Puts the given device to the specified position in
4221	the boot order.
4222
4223	To indicate that no device is associated with the given position,
4224	<link to="DeviceType_Null"/> should be used.
4225
4226	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4227
4228	<result name="E_INVALIDARG">
4229	Boot @a position out of range.
4230	</result>
4231	<result name="E_NOTIMPL">
4232	Booting from USB @a device currently not supported.
4233	</result>
4234
4235	</desc>
4236	<param name="position" type="unsigned long" dir="in">
4237	<desc>
4238	Position in the boot order (@c 1 to the total number of
4239	devices the machine can boot from, as returned by
4240	<link to="ISystemProperties::maxBootPosition"/>).
4241	</desc>
4242	</param>
4243	<param name="device" type="DeviceType" dir="in">
4244	<desc>
4245	The type of the device used to boot at the given position.
4246	</desc>
4247	</param>
4248	</method>
4249
4250	<method name="getBootOrder" const="yes">
4251	<desc>
4252	Returns the device type that occupies the specified
4253	position in the boot order.
4254
4255	@todo [remove?]
4256	If the machine can have more than one device of the returned type
4257	(such as hard disks), then a separate method should be used to
4258	retrieve the individual device that occupies the given position.
4259
4260	If here are no devices at the given position, then
4261	<link to="DeviceType_Null"/> is returned.
4262
4263	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4264
4265	<result name="E_INVALIDARG">
4266	Boot @a position out of range.
4267	</result>
4268
4269	</desc>
4270	<param name="position" type="unsigned long" dir="in">
4271	<desc>
4272	Position in the boot order (@c 1 to the total number of
4273	devices the machine can boot from, as returned by
4274	<link to="ISystemProperties::maxBootPosition"/>).
4275	</desc>
4276	</param>
4277	<param name="device" type="DeviceType" dir="return">
4278	<desc>
4279	Device at the given position.
4280	</desc>
4281	</param>
4282	</method>
4283
4284	<method name="attachDevice">
4285	<desc>
4286	Attaches a device and optionally mounts a medium to the given storage
4287	controller (<link to="IStorageController" />, identified by @a name),
4288	at the indicated port and device.
4289
4290	This method is intended for managing storage devices in general while a
4291	machine is powered off. It can be used to attach and detach fixed
4292	and removeable media. The following kind of media can be attached
4293	to a machine:
4294
4295	<ul>
4296	<li>For fixed and removable media, you can pass in a medium that was
4297	previously opened using <link to="IVirtualBox::openMedium" />.
4298	</li>
4299
4300	<li>Only for storage devices supporting removable media (such as
4301	DVDs and floppies), you can also specify a null pointer to
4302	indicate an empty drive or one of the medium objects listed
4303	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4304	arrays to indicate a host drive.
4305	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4306	to change the media while the machine is running.
4307	</li>
4308	</ul>
4309
4310	In a VM's default configuration of virtual machines, the secondary
4311	master of the IDE controller is used for a CD/DVD drive.
4312
4313	After calling this returns successfully, a new instance of
4314	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4315	attachments (see <link to="IMachine::mediumAttachments"/>).
4316
4317	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4318	information about attaching media.
4319
4320	The specified device slot must not have a device attached to it,
4321	or this method will fail.
4322
4323	<note>
4324	You cannot attach a device to a newly created machine until
4325	this machine's settings are saved to disk using
4326	<link to="#saveSettings"/>.
4327	</note>
4328	<note>
4329	If the medium is being attached indirectly, a new differencing medium
4330	will implicitly be created for it and attached instead. If the
4331	changes made to the machine settings (including this indirect
4332	attachment) are later cancelled using <link to="#discardSettings"/>,
4333	this implicitly created differencing medium will implicitly
4334	be deleted.
4335	</note>
4336
4337	<result name="E_INVALIDARG">
4338	SATA device, SATA port, IDE port or IDE slot out of range, or
4339	file or UUID not found.
4340	</result>
4341	<result name="VBOX_E_INVALID_OBJECT_STATE">
4342	Machine must be registered before media can be attached.
4343	</result>
4344	<result name="VBOX_E_INVALID_VM_STATE">
4345	Invalid machine state.
4346	</result>
4347	<result name="VBOX_E_OBJECT_IN_USE">
4348	A medium is already attached to this or another virtual machine.
4349	</result>
4350
4351	</desc>
4352	<param name="name" type="wstring" dir="in">
4353	<desc>Name of the storage controller to attach the device to.</desc>
4354	</param>
4355	<param name="controllerPort" type="long" dir="in">
4356	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4357	the primary controller and 1 specifies the secondary controller.
4358	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4359	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4360	</param>
4361	<param name="device" type="long" dir="in">
4362	<desc>Device slot in the given port to attach the device to. This is only
4363	relevant for IDE controllers, for which 0 specifies the master device and
4364	1 specifies the slave device. For all other controller types, this must
4365	be 0.</desc>
4366	</param>
4367	<param name="type" type="DeviceType" dir="in">
4368	<desc>Device type of the attached device. For media opened by
4369	<link to="IVirtualBox::openMedium" />, this must match the device type
4370	specified there.</desc>
4371	</param>
4372	<param name="medium" type="IMedium" dir="in">
4373	<desc>Medium to mount or NULL for an empty drive.</desc>
4374	</param>
4375	</method>
4376
4377	<method name="detachDevice">
4378	<desc>
4379	Detaches the device attached to a device slot of the specified bus.
4380
4381	Detaching the device from the virtual machine is deferred. This means
4382	that the medium remains associated with the machine when this method
4383	returns and gets actually de-associated only after a successful
4384	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4385	for more detailed information about attaching media.
4386
4387	<note>
4388	You cannot detach a device from a running machine.
4389	</note>
4390	<note>
4391	Detaching differencing media implicitly created by <link
4392	to="#attachDevice"/> for the indirect attachment using this
4393	method will <b>not</b> implicitly delete them. The
4394	<link to="IMedium::deleteStorage"/> operation should be
4395	explicitly performed by the caller after the medium is successfully
4396	detached and the settings are saved with
4397	<link to="#saveSettings"/>, if it is the desired action.
4398	</note>
4399
4400	<result name="VBOX_E_INVALID_VM_STATE">
4401	Attempt to detach medium from a running virtual machine.
4402	</result>
4403	<result name="VBOX_E_OBJECT_NOT_FOUND">
4404	No medium attached to given slot/bus.
4405	</result>
4406	<result name="VBOX_E_NOT_SUPPORTED">
4407	Medium format does not support storage deletion.
4408	</result>
4409
4410	</desc>
4411	<param name="name" type="wstring" dir="in">
4412	<desc>Name of the storage controller to detach the medium from.</desc>
4413	</param>
4414	<param name="controllerPort" type="long" dir="in">
4415	<desc>Port number to detach the medium from.</desc>
4416	</param>
4417	<param name="device" type="long" dir="in">
4418	<desc>Device slot number to detach the medium from.</desc>
4419	</param>
4420	</method>
4421
4422	<method name="passthroughDevice">
4423	<desc>
4424	Sets the passthrough mode of an existing DVD device. Changing the
4425	setting while the VM is running is forbidden. The setting is only used
4426	if at VM start the device is configured as a host DVD drive, in all
4427	other cases it is ignored. The device must already exist; see
4428	<link to="IMachine::attachDevice"/> for how to attach a new device.
4429
4430	The @a controllerPort and @a device parameters specify the device slot and
4431	have have the same meaning as with <link to="IMachine::attachDevice" />.
4432
4433	<result name="E_INVALIDARG">
4434	SATA device, SATA port, IDE port or IDE slot out of range.
4435	</result>
4436	<result name="VBOX_E_INVALID_OBJECT_STATE">
4437	Attempt to modify an unregistered virtual machine.
4438	</result>
4439	<result name="VBOX_E_INVALID_VM_STATE">
4440	Invalid machine state.
4441	</result>
4442
4443	</desc>
4444	<param name="name" type="wstring" dir="in">
4445	<desc>Name of the storage controller.</desc>
4446	</param>
4447	<param name="controllerPort" type="long" dir="in">
4448	<desc>Storage controller port.</desc>
4449	</param>
4450	<param name="device" type="long" dir="in">
4451	<desc>Device slot in the given port.</desc>
4452	</param>
4453	<param name="passthrough" type="boolean" dir="in">
4454	<desc>New value for the passthrough setting.</desc>
4455	</param>
4456	</method>
4457
4458	<method name="mountMedium">
4459	<desc>
4460	Mounts a medium (<link to="IMedium" />, identified
4461	by the given UUID @a id) to the given storage controller
4462	(<link to="IStorageController" />, identified by @a name),
4463	at the indicated port and device. The device must already exist;
4464	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4465
4466	This method is intended only for managing removable media, where the
4467	device is fixed but media is changeable at runtime (such as DVDs
4468	and floppies). It cannot be used for fixed media such as hard disks.
4469
4470	The @a controllerPort and @a device parameters specify the device slot and
4471	have have the same meaning as with <link to="IMachine::attachDevice" />.
4472
4473	The specified device slot can have a medium mounted, which will be
4474	unmounted first. Specifying a zero UUID (or an empty string) for
4475	@a medium does just an unmount.
4476
4477	See <link to="IMedium"/> for more detailed information about
4478	attaching media.
4479
4480	<result name="E_INVALIDARG">
4481	SATA device, SATA port, IDE port or IDE slot out of range.
4482	</result>
4483	<result name="VBOX_E_INVALID_OBJECT_STATE">
4484	Attempt to attach medium to an unregistered virtual machine.
4485	</result>
4486	<result name="VBOX_E_INVALID_VM_STATE">
4487	Invalid machine state.
4488	</result>
4489	<result name="VBOX_E_OBJECT_IN_USE">
4490	Medium already attached to this or another virtual machine.
4491	</result>
4492
4493	</desc>
4494	<param name="name" type="wstring" dir="in">
4495	<desc>Name of the storage controller to attach the medium to.</desc>
4496	</param>
4497	<param name="controllerPort" type="long" dir="in">
4498	<desc>Port to attach the medium to.</desc>
4499	</param>
4500	<param name="device" type="long" dir="in">
4501	<desc>Device slot in the given port to attach the medium to.</desc>
4502	</param>
4503	<param name="medium" type="IMedium" dir="in">
4504	<desc>Medium to mount or NULL for an empty drive.</desc>
4505	</param>
4506	<param name="force" type="boolean" dir="in">
4507	<desc>Allows to force unmount/mount of a medium which is locked by
4508	the device slot in the given port to attach the medium to.</desc>
4509	</param>
4510	</method>
4511
4512	<method name="getMedium" const="yes">
4513	<desc>
4514	Returns the virtual medium attached to a device slot of the specified
4515	bus.
4516
4517	Note that if the medium was indirectly attached by
4518	<link to="#mountMedium"/> to the given device slot then this
4519	method will return not the same object as passed to the
4520	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4521	more detailed information about mounting a medium.
4522
4523	<result name="VBOX_E_OBJECT_NOT_FOUND">
4524	No medium attached to given slot/bus.
4525	</result>
4526
4527	</desc>
4528	<param name="name" type="wstring" dir="in">
4529	<desc>Name of the storage controller the medium is attached to.</desc>
4530	</param>
4531	<param name="controllerPort" type="long" dir="in">
4532	<desc>Port to query.</desc>
4533	</param>
4534	<param name="device" type="long" dir="in">
4535	<desc>Device slot in the given port to query.</desc>
4536	</param>
4537	<param name="medium" type="IMedium" dir="return">
4538	<desc>Attached medium object.</desc>
4539	</param>
4540	</method>
4541
4542	<method name="getMediumAttachmentsOfController" const="yes">
4543	<desc>
4544	Returns an array of medium attachments which are attached to the
4545	the controller with the given name.
4546
4547	<result name="VBOX_E_OBJECT_NOT_FOUND">
4548	A storage controller with given name doesn't exist.
4549	</result>
4550	</desc>
4551	<param name="name" type="wstring" dir="in"/>
4552	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4553	</method>
4554
4555	<method name="getMediumAttachment" const="yes">
4556	<desc>
4557	Returns a medium attachment which corresponds to the controller with
4558	the given name, on the given port and device slot.
4559
4560	<result name="VBOX_E_OBJECT_NOT_FOUND">
4561	No attachment exists for the given controller/port/device combination.
4562	</result>
4563	</desc>
4564	<param name="name" type="wstring" dir="in"/>
4565	<param name="controllerPort" type="long" dir="in"/>
4566	<param name="device" type="long" dir="in"/>
4567	<param name="attachment" type="IMediumAttachment" dir="return"/>
4568	</method>
4569
4570	<method name="getNetworkAdapter" const="yes">
4571	<desc>
4572	Returns the network adapter associated with the given slot.
4573	Slots are numbered sequentially, starting with zero. The total
4574	number of adapters per machine is defined by the
4575	<link to="ISystemProperties::networkAdapterCount"/> property,
4576	so the maximum slot number is one less than that property's value.
4577
4578	<result name="E_INVALIDARG">
4579	Invalid @a slot number.
4580	</result>
4581
4582	</desc>
4583	<param name="slot" type="unsigned long" dir="in"/>
4584	<param name="adapter" type="INetworkAdapter" dir="return"/>
4585	</method>
4586
4587	<method name="addStorageController">
4588	<desc>
4589	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4590	machine and returns it as an instance of
4591	<link to="IStorageController" />.
4592
4593	@a name identifies the controller for subsequent calls such as
4594	<link to="#getStorageControllerByName" />,
4595	<link to="#getStorageControllerByInstance" />,
4596	<link to="#removeStorageController" />,
4597	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4598
4599	After the controller has been added, you can set its exact
4600	type by setting the <link to="IStorageController::controllerType" />.
4601
4602	<result name="VBOX_E_OBJECT_IN_USE">
4603	A storage controller with given name exists already.
4604	</result>
4605	<result name="E_INVALIDARG">
4606	Invalid @a controllerType.
4607	</result>
4608	</desc>
4609	<param name="name" type="wstring" dir="in"/>
4610	<param name="connectionType" type="StorageBus" dir="in"/>
4611	<param name="controller" type="IStorageController" dir="return"/>
4612	</method>
4613
4614	<method name="getStorageControllerByName" const="yes">
4615	<desc>
4616	Returns a storage controller with the given name.
4617
4618	<result name="VBOX_E_OBJECT_NOT_FOUND">
4619	A storage controller with given name doesn't exist.
4620	</result>
4621	</desc>
4622	<param name="name" type="wstring" dir="in"/>
4623	<param name="storageController" type="IStorageController" dir="return"/>
4624	</method>
4625
4626	<method name="getStorageControllerByInstance" const="yes">
4627	<desc>
4628	Returns a storage controller with the given instance number.
4629
4630	<result name="VBOX_E_OBJECT_NOT_FOUND">
4631	A storage controller with given instance number doesn't exist.
4632	</result>
4633	</desc>
4634	<param name="instance" type="unsigned long" dir="in"/>
4635	<param name="storageController" type="IStorageController" dir="return"/>
4636	</method>
4637
4638	<method name="removeStorageController">
4639	<desc>
4640	Removes a storage controller from the machine.
4641
4642	<result name="VBOX_E_OBJECT_NOT_FOUND">
4643	A storage controller with given name doesn't exist.
4644	</result>
4645	</desc>
4646	<param name="name" type="wstring" dir="in"/>
4647	</method>
4648
4649	<method name="setStorageControllerBootable">
4650	<desc>
4651	Sets the bootable flag of the storage controller with the given name.
4652
4653	<result name="VBOX_E_OBJECT_NOT_FOUND">
4654	A storage controller with given name doesn't exist.
4655	</result>
4656	<result name="VBOX_E_OBJECT_IN_USE">
4657	Another storage controller is marked as bootable already.
4658	</result>
4659	</desc>
4660	<param name="name" type="wstring" dir="in"/>
4661	<param name="bootable" type="boolean" dir="in"/>
4662	</method>
4663
4664	<method name="getSerialPort" const="yes">
4665	<desc>
4666	Returns the serial port associated with the given slot.
4667	Slots are numbered sequentially, starting with zero. The total
4668	number of serial ports per machine is defined by the
4669	<link to="ISystemProperties::serialPortCount"/> property,
4670	so the maximum slot number is one less than that property's value.
4671
4672	<result name="E_INVALIDARG">
4673	Invalid @a slot number.
4674	</result>
4675
4676	</desc>
4677	<param name="slot" type="unsigned long" dir="in"/>
4678	<param name="port" type="ISerialPort" dir="return"/>
4679	</method>
4680
4681	<method name="getParallelPort" const="yes">
4682	<desc>
4683	Returns the parallel port associated with the given slot.
4684	Slots are numbered sequentially, starting with zero. The total
4685	number of parallel ports per machine is defined by the
4686	<link to="ISystemProperties::parallelPortCount"/> property,
4687	so the maximum slot number is one less than that property's value.
4688
4689	<result name="E_INVALIDARG">
4690	Invalid @a slot number.
4691	</result>
4692
4693	</desc>
4694	<param name="slot" type="unsigned long" dir="in"/>
4695	<param name="port" type="IParallelPort" dir="return"/>
4696	</method>
4697
4698	<method name="getExtraDataKeys">
4699	<desc>
4700	Returns an array representing the machine-specific extra data keys
4701	which currently have values defined.
4702	</desc>
4703	<param name="value" type="wstring" dir="return" safearray="yes">
4704	<desc>Array of extra data keys.</desc>
4705	</param>
4706	</method>
4707
4708	<method name="getExtraData">
4709	<desc>
4710	Returns associated machine-specific extra data.
4711
4712	If the requested data @a key does not exist, this function will
4713	succeed and return an empty string in the @a value argument.
4714
4715	<result name="VBOX_E_FILE_ERROR">
4716	Settings file not accessible.
4717	</result>
4718	<result name="VBOX_E_XML_ERROR">
4719	Could not parse the settings file.
4720	</result>
4721
4722	</desc>
4723	<param name="key" type="wstring" dir="in">
4724	<desc>Name of the data key to get.</desc>
4725	</param>
4726	<param name="value" type="wstring" dir="return">
4727	<desc>Value of the requested data key.</desc>
4728	</param>
4729	</method>
4730
4731	<method name="setExtraData">
4732	<desc>
4733	Sets associated machine-specific extra data.
4734
4735	If you pass @c null or an empty string as a key @a value, the given
4736	@a key will be deleted.
4737
4738	<note>
4739	Before performing the actual data change, this method will ask all
4740	registered listeners using the
4741	<link to="IExtraDataCanChangeEvent"/>
4742	notification for a permission. If one of the listeners refuses the
4743	new value, the change will not be performed.
4744	</note>
4745	<note>
4746	On success, the
4747	<link to="IExtraDataChangedEvent"/> notification
4748	is called to inform all registered listeners about a successful data
4749	change.
4750	</note>
4751	<note>
4752	This method can be called outside the machine session and therefore
4753	it's a caller's responsibility to handle possible race conditions
4754	when several clients change the same key at the same time.
4755	</note>
4756
4757	<result name="VBOX_E_FILE_ERROR">
4758	Settings file not accessible.
4759	</result>
4760	<result name="VBOX_E_XML_ERROR">
4761	Could not parse the settings file.
4762	</result>
4763
4764	</desc>
4765	<param name="key" type="wstring" dir="in">
4766	<desc>Name of the data key to set.</desc>
4767	</param>
4768	<param name="value" type="wstring" dir="in">
4769	<desc>Value to assign to the key.</desc>
4770	</param>
4771	</method>
4772
4773	<method name="getCPUProperty" const="yes">
4774	<desc>
4775	Returns the virtual CPU boolean value of the specified property.
4776
4777	<result name="E_INVALIDARG">
4778	Invalid property.
4779	</result>
4780
4781	</desc>
4782	<param name="property" type="CPUPropertyType" dir="in">
4783	<desc>
4784	Property type to query.
4785	</desc>
4786	</param>
4787	<param name="value" type="boolean" dir="return">
4788	<desc>
4789	Property value.
4790	</desc>
4791	</param>
4792	</method>
4793
4794	<method name="setCPUProperty">
4795	<desc>
4796	Sets the virtual CPU boolean value of the specified property.
4797
4798	<result name="E_INVALIDARG">
4799	Invalid property.
4800	</result>
4801
4802	</desc>
4803	<param name="property" type="CPUPropertyType" dir="in">
4804	<desc>
4805	Property type to query.
4806	</desc>
4807	</param>
4808	<param name="value" type="boolean" dir="in">
4809	<desc>
4810	Property value.
4811	</desc>
4812	</param>
4813	</method>
4814
4815	<method name="getCPUIDLeaf" const="yes">
4816	<desc>
4817	Returns the virtual CPU cpuid information for the specified leaf.
4818
4819	Currently supported index values for cpuid:
4820	Standard CPUID leafs: 0 - 0xA
4821	Extended CPUID leafs: 0x80000000 - 0x8000000A
4822
4823	See the Intel and AMD programmer's manuals for detailed information
4824	about the cpuid instruction and its leafs.
4825	<result name="E_INVALIDARG">
4826	Invalid id.
4827	</result>
4828
4829	</desc>
4830	<param name="id" type="unsigned long" dir="in">
4831	<desc>
4832	CPUID leaf index.
4833	</desc>
4834	</param>
4835	<param name="valEax" type="unsigned long" dir="out">
4836	<desc>
4837	CPUID leaf value for register eax.
4838	</desc>
4839	</param>
4840	<param name="valEbx" type="unsigned long" dir="out">
4841	<desc>
4842	CPUID leaf value for register ebx.
4843	</desc>
4844	</param>
4845	<param name="valEcx" type="unsigned long" dir="out">
4846	<desc>
4847	CPUID leaf value for register ecx.
4848	</desc>
4849	</param>
4850	<param name="valEdx" type="unsigned long" dir="out">
4851	<desc>
4852	CPUID leaf value for register edx.
4853	</desc>
4854	</param>
4855	</method>
4856
4857	<method name="setCPUIDLeaf">
4858	<desc>
4859	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
4860	are not passed unmodified. VirtualBox clears features that it doesn't support.
4861
4862	Currently supported index values for cpuid:
4863	Standard CPUID leafs: 0 - 0xA
4864	Extended CPUID leafs: 0x80000000 - 0x8000000A
4865
4866	See the Intel and AMD programmer's manuals for detailed information
4867	about the cpuid instruction and its leafs.
4868
4869	Do not use this method unless you know exactly what you're doing. Misuse can lead to
4870	random crashes inside VMs.
4871	<result name="E_INVALIDARG">
4872	Invalid id.
4873	</result>
4874
4875	</desc>
4876	<param name="id" type="unsigned long" dir="in">
4877	<desc>
4878	CPUID leaf index.
4879	</desc>
4880	</param>
4881	<param name="valEax" type="unsigned long" dir="in">
4882	<desc>
4883	CPUID leaf value for register eax.
4884	</desc>
4885	</param>
4886	<param name="valEbx" type="unsigned long" dir="in">
4887	<desc>
4888	CPUID leaf value for register ebx.
4889	</desc>
4890	</param>
4891	<param name="valEcx" type="unsigned long" dir="in">
4892	<desc>
4893	CPUID leaf value for register ecx.
4894	</desc>
4895	</param>
4896	<param name="valEdx" type="unsigned long" dir="in">
4897	<desc>
4898	CPUID leaf value for register edx.
4899	</desc>
4900	</param>
4901	</method>
4902
4903	<method name="removeCPUIDLeaf">
4904	<desc>
4905	Removes the virtual CPU cpuid leaf for the specified index
4906
4907	<result name="E_INVALIDARG">
4908	Invalid id.
4909	</result>
4910
4911	</desc>
4912	<param name="id" type="unsigned long" dir="in">
4913	<desc>
4914	CPUID leaf index.
4915	</desc>
4916	</param>
4917	</method>
4918
4919	<method name="removeAllCPUIDLeaves">
4920	<desc>
4921	Removes all the virtual CPU cpuid leaves
4922	</desc>
4923	</method>
4924
4925	<method name="getHWVirtExProperty" const="yes">
4926	<desc>
4927	Returns the value of the specified hardware virtualization boolean property.
4928
4929	<result name="E_INVALIDARG">
4930	Invalid property.
4931	</result>
4932
4933	</desc>
4934	<param name="property" type="HWVirtExPropertyType" dir="in">
4935	<desc>
4936	Property type to query.
4937	</desc>
4938	</param>
4939	<param name="value" type="boolean" dir="return">
4940	<desc>
4941	Property value.
4942	</desc>
4943	</param>
4944	</method>
4945
4946	<method name="setHWVirtExProperty">
4947	<desc>
4948	Sets a new value for the specified hardware virtualization boolean property.
4949
4950	<result name="E_INVALIDARG">
4951	Invalid property.
4952	</result>
4953
4954	</desc>
4955	<param name="property" type="HWVirtExPropertyType" dir="in">
4956	<desc>
4957	Property type to set.
4958	</desc>
4959	</param>
4960	<param name="value" type="boolean" dir="in">
4961	<desc>
4962	New property value.
4963	</desc>
4964	</param>
4965	</method>
4966
4967	<method name="saveSettings">
4968	<desc>
4969	Saves any changes to machine settings made since the session
4970	has been opened or a new machine has been created, or since the
4971	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
4972	For registered machines, new settings become visible to all
4973	other VirtualBox clients after successful invocation of this
4974	method.
4975	<note>
4976	The method sends <link to="IMachineDataChangedEvent"/>
4977	notification event after the configuration has been successfully
4978	saved (only for registered machines).
4979	</note>
4980	<note>
4981	Calling this method is only valid on instances returned
4982	by <link to="ISession::machine"/> and on new machines
4983	created by <link to="IVirtualBox::createMachine"/> but not
4984	yet registered, or on unregistered machines after calling
4985	<link to="IMachine::unregister"/>.
4986	</note>
4987
4988	<result name="VBOX_E_FILE_ERROR">
4989	Settings file not accessible.
4990	</result>
4991	<result name="VBOX_E_XML_ERROR">
4992	Could not parse the settings file.
4993	</result>
4994	<result name="E_ACCESSDENIED">
4995	Modification request refused.
4996	</result>
4997
4998	</desc>
4999	</method>
5000
5001	<method name="discardSettings">
5002	<desc>
5003	Discards any changes to the machine settings made since the session
5004	has been opened or since the last call to <link to="#saveSettings"/>
5005	or <link to="#discardSettings"/>.
5006	<note>
5007	Calling this method is only valid on instances returned
5008	by <link to="ISession::machine"/> and on new machines
5009	created by <link to="IVirtualBox::createMachine"/> or
5010	opened by <link to="IVirtualBox::openMachine"/> but not
5011	yet registered, or on unregistered machines after calling
5012	<link to="IMachine::unregister"/>.
5013	</note>
5014
5015	<result name="VBOX_E_INVALID_VM_STATE">
5016	Virtual machine is not mutable.
5017	</result>
5018
5019	</desc>
5020	</method>
5021
5022	<method name="unregister">
5023	<desc>
5024	Unregisters the machine, which must have been previously registered using
5025	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5026	cleanup before the machine is unregistered.
5027
5028	This method does not delete any files. It only changes the machine configuration and
5029	the list of registered machines in the VirtualBox object. To delete the files which
5030	belonged to the machine, including the XML file of the machine itself, call
5031	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5032	from this method.
5033
5034	How thoroughly this method cleans up the machine configuration before unregistering
5035	the machine depends on the @a cleanupMode argument.
5036
5037	<ul>
5038	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5039	cleanup will be performed. The call will fail if the machine is in "Saved" state
5040	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5041	It is the responsibility of the caller to delete all such configuration in this mode.
5042	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5043	which it replaces.</li>
5044	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5045	state or if it has snapshots or media attached. All media attached to the current machine
5046	state or in snapshots will be detached. No medium objects will be returned; all of the
5047	machine's media will remain open.</li>
5048	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5049	except that all the hard disk medium objects which were detached from the machine will
5050	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5051	API for closing and deletion.</li>
5052	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5053	that all media will be returned in the array, including removeable media like DVDs and
5054	floppies. This might be useful if the user wants to inspect in detail which media were
5055	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5056	in that case because users will typically want to preserve ISO and RAW image files.</li>
5057	</ul>
5058
5059	This API does not verify whether the media files returned in the array are still
5060	attached to other machines (i.e. shared between several machines). If such a shared
5061	image is passed to <link to="#delete" /> however, closing the image will fail there
5062	and the image will be silently skipped.
5063
5064	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5065	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5066	deleted with all its saved states and hard disk images, but images for removeable
5067	drives (such as ISO and RAW files) will remain on disk.
5068
5069	The call will fail if the machine is currently locked (see <link to="ISession" />).
5070	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5071	before unregistering it.
5072
5073	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5074	is fired.
5075
5076	<note>
5077	If the given machine is inaccessible (see <link to="#accessible"/>), it
5078	will be unregistered and fully uninitialized right afterwards. As a result,
5079	the returned machine object will be unusable and an attempt to call
5080	<b>any</b> method will return the "Object not ready" error.
5081	</note>
5082
5083	<result name="VBOX_E_INVALID_OBJECT_STATE">
5084	Machine is currently locked for a session.
5085	</result>
5086	</desc>
5087
5088	<param name="cleanupMode" type="CleanupMode" dir="in">
5089	<desc>How to clean up after the machine has been unregistered.</desc>
5090	</param>
5091	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5092	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5093	</param>
5094	</method>
5095
5096	<method name="delete">
5097	<desc>
5098	Deletes the files associated with this machine from disk. If medium objects are passed
5099	in with the @a aMedia argument, they are closed and, if closing was successful, their
5100	storage files are deleted as well. For convenience, this array of media files can be
5101	the same as the one returned from a previous <link to="#unregister" /> call.
5102
5103	This method must only be called on machines which are either write-locked (i.e. on instances
5104	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5105	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5106	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5107
5108	The following files will be deleted by this method:
5109	<ul>
5110	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5111	argument other than "UnregisterOnly", this will delete all saved state files that
5112	the machine had in use; possibly one if the machine was in "Saved" state and one
5113	for each online snapshot that the machine had.</li>
5114	<li>On each medium object passed in the @a aMedia array, this will call
5115	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5116	medium's storage on disk. Since the close() call will fail if the medium is still
5117	in use, e.g. because it is still attached to a second machine; in that case the
5118	storage will not be deleted.</li>
5119	<li>Finally, the machine's own XML file will be deleted.</li>
5120	</ul>
5121
5122	Since deleting large disk image files can be a time-consuming I/O operation, this
5123	method operates asynchronously and returns an IProgress object to allow the caller
5124	to monitor the progress. There will be one sub-operation for each file that is
5125	being deleted (saved state or medium storage file).
5126
5127	<note>
5128	<link to="#settingsModified"/> will return @c true after this
5129	method successfully returns.
5130	</note>
5131
5132	<result name="VBOX_E_INVALID_VM_STATE">
5133	Machine is registered but not write-locked.
5134	</result>
5135	<result name="VBOX_E_IPRT_ERROR">
5136	Could not delete the settings file.
5137	</result>
5138	</desc>
5139	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5140	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5141	</param>
5142	<param name="aProgress" type="IProgress" dir="return">
5143	<desc>Progress object to track the operation completion.</desc>
5144	</param>
5145	</method>
5146
5147	<method name="export">
5148	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5149	steps required to export VirtualBox machines to OVF.
5150	</desc>
5151
5152	<param name="aAppliance" type="IAppliance" dir="in">
5153	<desc>Appliance to export this machine to.</desc>
5154	</param>
5155	<param name="location" type="wstring" dir="in">
5156	<desc>The target location.</desc>
5157	</param>
5158	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5159	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5160	</param>
5161	</method >
5162
5163	<method name="findSnapshot">
5164	<desc>
5165	Returns a snapshot of this machine with the given name or UUID.
5166
5167	Returns a snapshot of this machine with the given UUID.
5168	A @c null argument can be used to obtain the first snapshot
5169	taken on this machine. This is useful if you want to traverse
5170	the whole tree of snapshots starting from the root.
5171
5172	<result name="VBOX_E_OBJECT_NOT_FOUND">
5173	Virtual machine has no snapshots or snapshot not found.
5174	</result>
5175
5176	</desc>
5177	<param name="nameOrId" type="wstring" dir="in">
5178	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5179	</param>
5180	<param name="snapshot" type="ISnapshot" dir="return">
5181	<desc>Snapshot object with the given name.</desc>
5182	</param>
5183	</method>
5184
5185	<method name="createSharedFolder">
5186	<desc>
5187	Creates a new permanent shared folder by associating the given logical
5188	name with the given host path, adds it to the collection of shared
5189	folders and starts sharing it. Refer to the description of
5190	<link to="ISharedFolder"/> to read more about logical names.
5191
5192	<result name="VBOX_E_OBJECT_IN_USE">
5193	Shared folder already exists.
5194	</result>
5195	<result name="VBOX_E_FILE_ERROR">
5196	Shared folder @a hostPath not accessible.
5197	</result>
5198
5199	</desc>
5200	<param name="name" type="wstring" dir="in">
5201	<desc>Unique logical name of the shared folder.</desc>
5202	</param>
5203	<param name="hostPath" type="wstring" dir="in">
5204	<desc>Full path to the shared folder in the host file system.</desc>
5205	</param>
5206	<param name="writable" type="boolean" dir="in">
5207	<desc>Whether the share is writable or readonly.</desc>
5208	</param>
5209	<param name="automount" type="boolean" dir="in">
5210	<desc>Whether the share gets automatically mounted by the guest
5211	or not.</desc>
5212	</param>
5213	</method>
5214
5215	<method name="removeSharedFolder">
5216	<desc>
5217	Removes the permanent shared folder with the given name previously
5218	created by <link to="#createSharedFolder"/> from the collection of
5219	shared folders and stops sharing it.
5220
5221	<result name="VBOX_E_INVALID_VM_STATE">
5222	Virtual machine is not mutable.
5223	</result>
5224	<result name="VBOX_E_OBJECT_NOT_FOUND">
5225	Shared folder @a name does not exist.
5226	</result>
5227
5228	</desc>
5229	<param name="name" type="wstring" dir="in">
5230	<desc>Logical name of the shared folder to remove.</desc>
5231	</param>
5232	</method>
5233
5234	<method name="canShowConsoleWindow">
5235	<desc>
5236	Returns @c true if the VM console process can activate the
5237	console window and bring it to foreground on the desktop of
5238	the host PC.
5239	<note>
5240	This method will fail if a session for this machine is not
5241	currently open.
5242	</note>
5243
5244	<result name="VBOX_E_INVALID_VM_STATE">
5245	Machine session is not open.
5246	</result>
5247
5248	</desc>
5249	<param name="canShow" type="boolean" dir="return">
5250	<desc>
5251	@c true if the console window can be shown and @c false otherwise.
5252	</desc>
5253	</param>
5254	</method>
5255
5256	<method name="showConsoleWindow">
5257	<desc>
5258	Activates the console window and brings it to foreground on
5259	the desktop of the host PC. Many modern window managers on
5260	many platforms implement some sort of focus stealing
5261	prevention logic, so that it may be impossible to activate
5262	a window without the help of the currently active
5263	application. In this case, this method will return a non-zero
5264	identifier that represents the top-level window of the VM
5265	console process. The caller, if it represents a currently
5266	active process, is responsible to use this identifier (in a
5267	platform-dependent manner) to perform actual window
5268	activation.
5269	<note>
5270	This method will fail if a session for this machine is not
5271	currently open.
5272	</note>
5273
5274	<result name="VBOX_E_INVALID_VM_STATE">
5275	Machine session is not open.
5276	</result>
5277
5278	</desc>
5279	<param name="winId" type="long long" dir="return">
5280	<desc>
5281	Platform-dependent identifier of the top-level VM console
5282	window, or zero if this method has performed all actions
5283	necessary to implement the <i>show window</i> semantics for
5284	the given platform and/or VirtualBox front-end.
5285	</desc>
5286	</param>
5287	</method>
5288
5289	<method name="getGuestProperty" const="yes">
5290	<desc>
5291	Reads an entry from the machine's guest property store.
5292
5293	<result name="VBOX_E_INVALID_VM_STATE">
5294	Machine session is not open.
5295	</result>
5296
5297	</desc>
5298	<param name="name" type="wstring" dir="in">
5299	<desc>
5300	The name of the property to read.
5301	</desc>
5302	</param>
5303	<param name="value" type="wstring" dir="out">
5304	<desc>
5305	The value of the property. If the property does not exist then this
5306	will be empty.
5307	</desc>
5308	</param>
5309	<param name="timestamp" type="long long" dir="out">
5310	<desc>
5311	The time at which the property was last modified, as seen by the
5312	server process.
5313	</desc>
5314	</param>
5315	<param name="flags" type="wstring" dir="out">
5316	<desc>
5317	Additional property parameters, passed as a comma-separated list of
5318	"name=value" type entries.
5319	</desc>
5320	</param>
5321	</method>
5322
5323	<method name="getGuestPropertyValue" const="yes">
5324	<desc>
5325	Reads a value from the machine's guest property store.
5326
5327	<result name="VBOX_E_INVALID_VM_STATE">
5328	Machine session is not open.
5329	</result>
5330
5331	</desc>
5332	<param name="property" type="wstring" dir="in">
5333	<desc>
5334	The name of the property to read.
5335	</desc>
5336	</param>
5337	<param name="value" type="wstring" dir="return">
5338	<desc>
5339	The value of the property. If the property does not exist then this
5340	will be empty.
5341	</desc>
5342	</param>
5343	</method>
5344
5345	<method name="getGuestPropertyTimestamp" const="yes">
5346	<desc>
5347	Reads a property timestamp from the machine's guest property store.
5348
5349	<result name="VBOX_E_INVALID_VM_STATE">
5350	Machine session is not open.
5351	</result>
5352
5353	</desc>
5354	<param name="property" type="wstring" dir="in">
5355	<desc>
5356	The name of the property to read.
5357	</desc>
5358	</param>
5359	<param name="value" type="long long" dir="return">
5360	<desc>
5361	The timestamp. If the property does not exist then this will be
5362	empty.
5363	</desc>
5364	</param>
5365	</method>
5366
5367	<method name="setGuestProperty">
5368	<desc>
5369	Sets, changes or deletes an entry in the machine's guest property
5370	store.
5371
5372	<result name="E_ACCESSDENIED">
5373	Property cannot be changed.
5374	</result>
5375	<result name="E_INVALIDARG">
5376	Invalid @a flags.
5377	</result>
5378	<result name="VBOX_E_INVALID_VM_STATE">
5379	Virtual machine is not mutable or session not open.
5380	</result>
5381	<result name="VBOX_E_INVALID_OBJECT_STATE">
5382	Cannot set transient property when machine not running.
5383	</result>
5384
5385	</desc>
5386	<param name="property" type="wstring" dir="in">
5387	<desc>
5388	The name of the property to set, change or delete.
5389	</desc>
5390	</param>
5391	<param name="value" type="wstring" dir="in">
5392	<desc>
5393	The new value of the property to set, change or delete. If the
5394	property does not yet exist and value is non-empty, it will be
5395	created. If the value is @c null or empty, the property will be
5396	deleted if it exists.
5397	</desc>
5398	</param>
5399	<param name="flags" type="wstring" dir="in">
5400	<desc>
5401	Additional property parameters, passed as a comma-separated list of
5402	"name=value" type entries.
5403	</desc>
5404	</param>
5405	</method>
5406
5407	<method name="setGuestPropertyValue">
5408	<desc>
5409	Sets, changes or deletes a value in the machine's guest property
5410	store. The flags field will be left unchanged or created empty for a
5411	new property.
5412
5413	<result name="E_ACCESSDENIED">
5414	Property cannot be changed.
5415	</result>
5416	<result name="VBOX_E_INVALID_VM_STATE">
5417	Virtual machine is not mutable or session not open.
5418	</result>
5419	<result name="VBOX_E_INVALID_OBJECT_STATE">
5420	Cannot set transient property when machine not running.
5421	</result>
5422	</desc>
5423
5424	<param name="property" type="wstring" dir="in">
5425	<desc>
5426	The name of the property to set, change or delete.
5427	</desc>
5428	</param>
5429	<param name="value" type="wstring" dir="in">
5430	<desc>
5431	The new value of the property to set, change or delete. If the
5432	property does not yet exist and value is non-empty, it will be
5433	created. If the value is @c null or empty, the property will be
5434	deleted if it exists.
5435	</desc>
5436	</param>
5437	</method>
5438
5439	<method name="enumerateGuestProperties">
5440	<desc>
5441	Return a list of the guest properties matching a set of patterns along
5442	with their values, time stamps and flags.
5443	</desc>
5444	<param name="patterns" type="wstring" dir="in">
5445	<desc>
5446	The patterns to match the properties against, separated by '\|'
5447	characters. If this is empty or @c null, all properties will match.
5448	</desc>
5449	</param>
5450	<param name="name" type="wstring" dir="out" safearray="yes">
5451	<desc>
5452	The names of the properties returned.
5453	</desc>
5454	</param>
5455	<param name="value" type="wstring" dir="out" safearray="yes">
5456	<desc>
5457	The values of the properties returned. The array entries match the
5458	corresponding entries in the @a name array.
5459	</desc>
5460	</param>
5461	<param name="timestamp" type="long long" dir="out" safearray="yes">
5462	<desc>
5463	The time stamps of the properties returned. The array entries match
5464	the corresponding entries in the @a name array.
5465	</desc>
5466	</param>
5467	<param name="flags" type="wstring" dir="out" safearray="yes">
5468	<desc>
5469	The flags of the properties returned. The array entries match the
5470	corresponding entries in the @a name array.
5471	</desc>
5472	</param>
5473	</method>
5474
5475	<method name="querySavedGuestSize">
5476	<desc>
5477	Returns the guest dimensions from the saved state.
5478	</desc>
5479	<param name="screenId" type="unsigned long" dir="in">
5480	<desc>
5481	Saved guest screen to query info from.
5482	</desc>
5483	</param>
5484	<param name="width" type="unsigned long" dir="out">
5485	<desc>
5486	Guest width at the time of the saved state was taken.
5487	</desc>
5488	</param>
5489	<param name="height" type="unsigned long" dir="out">
5490	<desc>
5491	Guest height at the time of the saved state was taken.
5492	</desc>
5493	</param>
5494	</method>
5495
5496	<method name="querySavedThumbnailSize">
5497	<desc>
5498	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5499	</desc>
5500	<param name="screenId" type="unsigned long" dir="in">
5501	<desc>
5502	Saved guest screen to query info from.
5503	</desc>
5504	</param>
5505	<param name="size" type="unsigned long" dir="out">
5506	<desc>
5507	Size of buffer required to store the bitmap.
5508	</desc>
5509	</param>
5510	<param name="width" type="unsigned long" dir="out">
5511	<desc>
5512	Bitmap width.
5513	</desc>
5514	</param>
5515	<param name="height" type="unsigned long" dir="out">
5516	<desc>
5517	Bitmap height.
5518	</desc>
5519	</param>
5520	</method>
5521
5522	<method name="readSavedThumbnailToArray">
5523	<desc>
5524	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5525	</desc>
5526	<param name="screenId" type="unsigned long" dir="in">
5527	<desc>
5528	Saved guest screen to read from.
5529	</desc>
5530	</param>
5531	<param name="BGR" type="boolean" dir="in">
5532	<desc>
5533	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5534	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5535	</desc>
5536	</param>
5537	<param name="width" type="unsigned long" dir="out">
5538	<desc>
5539	Bitmap width.
5540	</desc>
5541	</param>
5542	<param name="height" type="unsigned long" dir="out">
5543	<desc>
5544	Bitmap height.
5545	</desc>
5546	</param>
5547	<param name="data" type="octet" safearray="yes" dir="return">
5548	<desc>
5549	Array with resulting bitmap data.
5550	</desc>
5551	</param>
5552	</method>
5553
5554	<method name="readSavedThumbnailPNGToArray">
5555	<desc>
5556	Thumbnail in PNG format is retrieved to an array of bytes.
5557	</desc>
5558	<param name="screenId" type="unsigned long" dir="in">
5559	<desc>
5560	Saved guest screen to read from.
5561	</desc>
5562	</param>
5563	<param name="width" type="unsigned long" dir="out">
5564	<desc>
5565	Image width.
5566	</desc>
5567	</param>
5568	<param name="height" type="unsigned long" dir="out">
5569	<desc>
5570	Image height.
5571	</desc>
5572	</param>
5573	<param name="data" type="octet" dir="return" safearray="yes">
5574	<desc>
5575	Array with resulting PNG data.
5576	</desc>
5577	</param>
5578	</method>
5579
5580	<method name="querySavedScreenshotPNGSize">
5581	<desc>
5582	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5583	</desc>
5584	<param name="screenId" type="unsigned long" dir="in">
5585	<desc>
5586	Saved guest screen to query info from.
5587	</desc>
5588	</param>
5589	<param name="size" type="unsigned long" dir="out">
5590	<desc>
5591	Size of buffer required to store the PNG binary data.
5592	</desc>
5593	</param>
5594	<param name="width" type="unsigned long" dir="out">
5595	<desc>
5596	Image width.
5597	</desc>
5598	</param>
5599	<param name="height" type="unsigned long" dir="out">
5600	<desc>
5601	Image height.
5602	</desc>
5603	</param>
5604	</method>
5605
5606	<method name="readSavedScreenshotPNGToArray">
5607	<desc>
5608	Screenshot in PNG format is retrieved to an array of bytes.
5609	</desc>
5610	<param name="screenId" type="unsigned long" dir="in">
5611	<desc>
5612	Saved guest screen to read from.
5613	</desc>
5614	</param>
5615	<param name="width" type="unsigned long" dir="out">
5616	<desc>
5617	Image width.
5618	</desc>
5619	</param>
5620	<param name="height" type="unsigned long" dir="out">
5621	<desc>
5622	Image height.
5623	</desc>
5624	</param>
5625	<param name="data" type="octet" dir="return" safearray="yes">
5626	<desc>
5627	Array with resulting PNG data.
5628	</desc>
5629	</param>
5630	</method>
5631
5632	<method name="hotPlugCPU">
5633	<desc>
5634	Plugs a CPU into the machine.
5635	</desc>
5636	<param name="cpu" type="unsigned long" dir="in">
5637	<desc>
5638	The CPU id to insert.
5639	</desc>
5640	</param>
5641	</method>
5642
5643	<method name="hotUnplugCPU">
5644	<desc>
5645	Removes a CPU from the machine.
5646	</desc>
5647	<param name="cpu" type="unsigned long" dir="in">
5648	<desc>
5649	The CPU id to remove.
5650	</desc>
5651	</param>
5652	</method>
5653
5654	<method name="getCPUStatus">
5655	<desc>
5656	Returns the current status of the given CPU.
5657	</desc>
5658	<param name="cpu" type="unsigned long" dir="in">
5659	<desc>
5660	The CPU id to check for.
5661	</desc>
5662	</param>
5663	<param name="attached" type="boolean" dir="return">
5664	<desc>
5665	Status of the CPU.
5666	</desc>
5667	</param>
5668	</method>
5669
5670	<method name="queryLogFilename">
5671	<desc>
5672	Queries for the VM log file name of an given index. Returns an empty
5673	string if a log file with that index doesn't exists.
5674	</desc>
5675	<param name="idx" type="unsigned long" dir="in">
5676	<desc>
5677	Which log file name to query. 0=current log file.
5678	</desc>
5679	</param>
5680	<param name="filename" type="wstring" dir="return">
5681	<desc>
5682	On return the full path to the log file or an empty string on error.
5683	</desc>
5684	</param>
5685	</method>
5686
5687	<method name="readLog">
5688	<desc>
5689	Reads the VM log file. The chunk size is limited, so even if you
5690	ask for a big piece there might be less data returned.
5691	</desc>
5692	<param name="idx" type="unsigned long" dir="in">
5693	<desc>
5694	Which log file to read. 0=current log file.
5695	</desc>
5696	</param>
5697	<param name="offset" type="long long" dir="in">
5698	<desc>
5699	Offset in the log file.
5700	</desc>
5701	</param>
5702	<param name="size" type="long long" dir="in">
5703	<desc>
5704	Chunk size to read in the log file.
5705	</desc>
5706	</param>
5707	<param name="data" type="octet" dir="return" safearray="yes">
5708	<desc>
5709	Data read from the log file. A data size of 0 means end of file
5710	if the requested chunk size was not 0. This is the unprocessed
5711	file data, i.e. the line ending style depends on the platform of
5712	the system the server is running on.
5713	</desc>
5714	</param>
5715	</method>
5716	</interface>
5717
5718	<!--
5719	// IConsole
5720	/////////////////////////////////////////////////////////////////////////
5721	-->
5722
5723	<interface
5724	name="IVRDEServerInfo" extends="$unknown"
5725	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5726	wsmap="struct"
5727	>
5728	<desc>
5729	Contains information about the remote desktop (VRDE) server capabilities and status.
5730	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5731	</desc>
5732
5733	<attribute name="active" type="boolean" readonly="yes">
5734	<desc>
5735	Whether the remote desktop connection is active.
5736	</desc>
5737	</attribute>
5738
5739	<attribute name="port" type="long" readonly="yes">
5740	<desc>
5741	VRDE server port number. If this property is equal to <tt>0</tt>, then
5742	the VRDE server failed to start, usually because there are no free IP
5743	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5744	server has not yet been started.
5745	</desc>
5746	</attribute>
5747
5748	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5749	<desc>
5750	How many times a client connected.
5751	</desc>
5752	</attribute>
5753
5754	<attribute name="beginTime" type="long long" readonly="yes">
5755	<desc>
5756	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5757	</desc>
5758	</attribute>
5759
5760	<attribute name="endTime" type="long long" readonly="yes">
5761	<desc>
5762	When the last connection was terminated or the current time, if
5763	connection is still active, in milliseconds since 1970-01-01 UTC.
5764	</desc>
5765	</attribute>
5766
5767	<attribute name="bytesSent" type="long long" readonly="yes">
5768	<desc>
5769	How many bytes were sent in last or current, if still active, connection.
5770	</desc>
5771	</attribute>
5772
5773	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5774	<desc>
5775	How many bytes were sent in all connections.
5776	</desc>
5777	</attribute>
5778
5779	<attribute name="bytesReceived" type="long long" readonly="yes">
5780	<desc>
5781	How many bytes were received in last or current, if still active, connection.
5782	</desc>
5783	</attribute>
5784
5785	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5786	<desc>
5787	How many bytes were received in all connections.
5788	</desc>
5789	</attribute>
5790
5791	<attribute name="user" type="wstring" readonly="yes">
5792	<desc>
5793	Login user name supplied by the client.
5794	</desc>
5795	</attribute>
5796
5797	<attribute name="domain" type="wstring" readonly="yes">
5798	<desc>
5799	Login domain name supplied by the client.
5800	</desc>
5801	</attribute>
5802
5803	<attribute name="clientName" type="wstring" readonly="yes">
5804	<desc>
5805	The client name supplied by the client.
5806	</desc>
5807	</attribute>
5808
5809	<attribute name="clientIP" type="wstring" readonly="yes">
5810	<desc>
5811	The IP address of the client.
5812	</desc>
5813	</attribute>
5814
5815	<attribute name="clientVersion" type="unsigned long" readonly="yes">
5816	<desc>
5817	The client software version number.
5818	</desc>
5819	</attribute>
5820
5821	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
5822	<desc>
5823	Public key exchange method used when connection was established.
5824	Values: 0 - RDP4 public key exchange scheme.
5825	1 - X509 certificates were sent to client.
5826	</desc>
5827	</attribute>
5828
5829	</interface>
5830
5831	<interface
5832	name="IConsole" extends="$unknown"
5833	uuid="3c4a453e-d27b-44a2-b59d-dda6e1835e57"
5834	wsmap="managed"
5835	>
5836	<desc>
5837	The IConsole interface represents an interface to control virtual
5838	machine execution.
5839
5840	A console object gets created when a machine has been locked for a
5841	particular session (client process) using <link to="IMachine::lockMachine" />
5842	or <link to="IMachine::launchVMProcess"/>. The console object can
5843	then be found in the session's <link to="ISession::console" /> attribute.
5844
5845	Methods of the IConsole interface allow the caller to query the current
5846	virtual machine execution state, pause the machine or power it down, save
5847	the machine state or take a snapshot, attach and detach removable media
5848	and so on.
5849
5850	<see>ISession</see>
5851	</desc>
5852
5853	<attribute name="machine" type="IMachine" readonly="yes">
5854	<desc>
5855	Machine object for this console session.
5856	<note>
5857	This is a convenience property, it has the same value as
5858	<link to="ISession::machine"/> of the corresponding session
5859	object.
5860	</note>
5861	</desc>
5862	</attribute>
5863
5864	<attribute name="state" type="MachineState" readonly="yes">
5865	<desc>
5866	Current execution state of the machine.
5867	<note>
5868	This property always returns the same value as the corresponding
5869	property of the IMachine object for this console session.
5870	For the process that owns (executes) the VM, this is the
5871	preferable way of querying the VM state, because no IPC
5872	calls are made.
5873	</note>
5874	</desc>
5875	</attribute>
5876
5877	<attribute name="guest" type="IGuest" readonly="yes">
5878	<desc>Guest object.</desc>
5879	</attribute>
5880
5881	<attribute name="keyboard" type="IKeyboard" readonly="yes">
5882	<desc>
5883	Virtual keyboard object.
5884	<note>
5885	If the machine is not running, any attempt to use
5886	the returned object will result in an error.
5887	</note>
5888	</desc>
5889	</attribute>
5890
5891	<attribute name="mouse" type="IMouse" readonly="yes">
5892	<desc>
5893	Virtual mouse object.
5894	<note>
5895	If the machine is not running, any attempt to use
5896	the returned object will result in an error.
5897	</note>
5898	</desc>
5899	</attribute>
5900
5901	<attribute name="display" type="IDisplay" readonly="yes">
5902	<desc>Virtual display object.
5903	<note>
5904	If the machine is not running, any attempt to use
5905	the returned object will result in an error.
5906	</note>
5907	</desc>
5908	</attribute>
5909
5910	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
5911	<desc>Debugging interface.</desc>
5912	</attribute>
5913
5914	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
5915	<desc>
5916	Collection of USB devices currently attached to the virtual
5917	USB controller.
5918	<note>
5919	The collection is empty if the machine is not running.
5920	</note>
5921	</desc>
5922	</attribute>
5923
5924	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
5925	<desc>
5926	List of USB devices currently attached to the remote VRDE client.
5927	Once a new device is physically attached to the remote host computer,
5928	it appears in this list and remains there until detached.
5929	</desc>
5930	</attribute>
5931
5932	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
5933	<desc>
5934	Collection of shared folders for the current session. These folders
5935	are called transient shared folders because they are available to the
5936	guest OS running inside the associated virtual machine only for the
5937	duration of the session (as opposed to
5938	<link to="IMachine::sharedFolders"/> which represent permanent shared
5939	folders). When the session is closed (e.g. the machine is powered down),
5940	these folders are automatically discarded.
5941
5942	New shared folders are added to the collection using
5943	<link to="#createSharedFolder"/>. Existing shared folders can be
5944	removed using <link to="#removeSharedFolder"/>.
5945	</desc>
5946	</attribute>
5947
5948	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
5949	<desc>
5950	Interface that provides information on Remote Desktop Extension (VRDE) connection.
5951	</desc>
5952	</attribute>
5953
5954	<attribute name="eventSource" type="IEventSource" readonly="yes">
5955	<desc>
5956	Event source for console events.
5957	</desc>
5958	</attribute>
5959
5960	<method name="powerUp">
5961	<desc>
5962	Starts the virtual machine execution using the current machine
5963	state (that is, its current execution state, current settings and
5964	current storage devices).
5965
5966	<note>
5967	This method is only useful for front-ends that want to actually
5968	execute virtual machines in their own process (like the VirtualBox
5969	or VBoxSDL front-ends). Unless you are intending to write such a
5970	front-end, do not call this method. If you simply want to
5971	start virtual machine execution using one of the existing front-ends
5972	(for example the VirtualBox GUI or headless server), use
5973	<link to="IMachine::launchVMProcess"/> instead; these
5974	front-ends will power up the machine automatically for you.
5975	</note>
5976
5977	If the machine is powered off or aborted, the execution will
5978	start from the beginning (as if the real hardware were just
5979	powered on).
5980
5981	If the machine is in the <link to="MachineState_Saved"/> state,
5982	it will continue its execution the point where the state has
5983	been saved.
5984
5985	If the machine <link to="IMachine::teleporterEnabled"/> property is
5986	enabled on the machine being powered up, the machine will wait for an
5987	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
5988	state. The returned progress object will have at least three
5989	operations where the last three are defined as: (1) powering up and
5990	starting TCP server, (2) waiting for incoming teleportations, and
5991	(3) perform teleportation. These operations will be reflected as the
5992	last three operations of the progress objected returned by
5993	<link to="IMachine::launchVMProcess"/> as well.
5994
5995	<see>#saveState</see>
5996
5997	<result name="VBOX_E_INVALID_VM_STATE">
5998	Virtual machine already running.
5999	</result>
6000	<result name="VBOX_E_HOST_ERROR">
6001	Host interface does not exist or name not set.
6002	</result>
6003	<result name="VBOX_E_FILE_ERROR">
6004	Invalid saved state file.
6005	</result>
6006	</desc>
6007	<param name="progress" type="IProgress" dir="return">
6008	<desc>Progress object to track the operation completion.</desc>
6009	</param>
6010	</method>
6011
6012	<method name="powerUpPaused">
6013	<desc>
6014	Identical to powerUp except that the VM will enter the
6015	<link to="MachineState_Paused"/> state, instead of
6016	<link to="MachineState_Running"/>.
6017
6018	<see>#powerUp</see>
6019	<result name="VBOX_E_INVALID_VM_STATE">
6020	Virtual machine already running.
6021	</result>
6022	<result name="VBOX_E_HOST_ERROR">
6023	Host interface does not exist or name not set.
6024	</result>
6025	<result name="VBOX_E_FILE_ERROR">
6026	Invalid saved state file.
6027	</result>
6028	</desc>
6029	<param name="progress" type="IProgress" dir="return">
6030	<desc>Progress object to track the operation completion.</desc>
6031	</param>
6032	</method>
6033
6034	<method name="powerDown">
6035	<desc>
6036	Initiates the power down procedure to stop the virtual machine
6037	execution.
6038
6039	The completion of the power down procedure is tracked using the returned
6040	IProgress object. After the operation is complete, the machine will go
6041	to the PoweredOff state.
6042	<result name="VBOX_E_INVALID_VM_STATE">
6043	Virtual machine must be Running, Paused or Stuck to be powered down.
6044	</result>
6045	</desc>
6046	<param name="progress" type="IProgress" dir="return">
6047	<desc>Progress object to track the operation completion.</desc>
6048	</param>
6049	</method>
6050
6051	<method name="reset">
6052	<desc>Resets the virtual machine.
6053	<result name="VBOX_E_INVALID_VM_STATE">
6054	Virtual machine not in Running state.
6055	</result>
6056	<result name="VBOX_E_VM_ERROR">
6057	Virtual machine error in reset operation.
6058	</result>
6059	</desc>
6060	</method>
6061
6062	<method name="pause">
6063	<desc>Pauses the virtual machine execution.
6064	<result name="VBOX_E_INVALID_VM_STATE">
6065	Virtual machine not in Running state.
6066	</result>
6067	<result name="VBOX_E_VM_ERROR">
6068	Virtual machine error in suspend operation.
6069	</result>
6070	</desc>
6071	</method>
6072
6073	<method name="resume">
6074	<desc>Resumes the virtual machine execution.
6075	<result name="VBOX_E_INVALID_VM_STATE">
6076	Virtual machine not in Paused state.
6077	</result>
6078	<result name="VBOX_E_VM_ERROR">
6079	Virtual machine error in resume operation.
6080	</result>
6081	</desc>
6082	</method>
6083
6084	<method name="powerButton">
6085	<desc>Sends the ACPI power button event to the guest.
6086	<result name="VBOX_E_INVALID_VM_STATE">
6087	Virtual machine not in Running state.
6088	</result>
6089	<result name="VBOX_E_PDM_ERROR">
6090	Controlled power off failed.
6091	</result>
6092	</desc>
6093	</method>
6094
6095	<method name="sleepButton">
6096	<desc>Sends the ACPI sleep button event to the guest.
6097	<result name="VBOX_E_INVALID_VM_STATE">
6098	Virtual machine not in Running state.
6099	</result>
6100	<result name="VBOX_E_PDM_ERROR">
6101	Sending sleep button event failed.
6102	</result>
6103	</desc>
6104	</method>
6105
6106	<method name="getPowerButtonHandled">
6107	<desc>Checks if the last power button event was handled by guest.
6108	<result name="VBOX_E_PDM_ERROR">
6109	Checking if the event was handled by the guest OS failed.
6110	</result>
6111	</desc>
6112	<param name="handled" type="boolean" dir="return"/>
6113	</method>
6114
6115	<method name="getGuestEnteredACPIMode">
6116	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6117	G1 (sleeping). If this method returns @c false, the guest will
6118	most likely not respond to external ACPI events.
6119	<result name="VBOX_E_INVALID_VM_STATE">
6120	Virtual machine not in Running state.
6121	</result>
6122	</desc>
6123	<param name="entered" type="boolean" dir="return"/>
6124	</method>
6125
6126	<method name="saveState">
6127	<desc>
6128	Saves the current execution state of a running virtual machine
6129	and stops its execution.
6130
6131	After this operation completes, the machine will go to the
6132	Saved state. Next time it is powered up, this state will
6133	be restored and the machine will continue its execution from
6134	the place where it was saved.
6135
6136	This operation differs from taking a snapshot to the effect
6137	that it doesn't create new differencing media. Also, once
6138	the machine is powered up from the state saved using this method,
6139	the saved state is deleted, so it will be impossible to return
6140	to this state later.
6141
6142	<note>
6143	On success, this method implicitly calls
6144	<link to="IMachine::saveSettings"/> to save all current machine
6145	settings (including runtime changes to the DVD medium, etc.).
6146	Together with the impossibility to change any VM settings when it is
6147	in the Saved state, this guarantees adequate hardware
6148	configuration of the machine when it is restored from the saved
6149	state file.
6150	</note>
6151
6152	<note>
6153	The machine must be in the Running or Paused state, otherwise
6154	the operation will fail.
6155	</note>
6156	<result name="VBOX_E_INVALID_VM_STATE">
6157	Virtual machine state neither Running nor Paused.
6158	</result>
6159	<result name="VBOX_E_FILE_ERROR">
6160	Failed to create directory for saved state file.
6161	</result>
6162
6163	<see><link to="#takeSnapshot"/></see>
6164	</desc>
6165	<param name="progress" type="IProgress" dir="return">
6166	<desc>Progress object to track the operation completion.</desc>
6167	</param>
6168	</method>
6169
6170	<method name="adoptSavedState">
6171	<desc>
6172	Associates the given saved state file to the virtual machine.
6173
6174	On success, the machine will go to the Saved state. Next time it is
6175	powered up, it will be restored from the adopted saved state and
6176	continue execution from the place where the saved state file was
6177	created.
6178
6179	The specified saved state file path may be absolute or relative to the
6180	folder the VM normally saves the state to (usually,
6181	<link to="IMachine::snapshotFolder"/>).
6182
6183	<note>
6184	It's a caller's responsibility to make sure the given saved state
6185	file is compatible with the settings of this virtual machine that
6186	represent its virtual hardware (memory size, storage disk configuration
6187	etc.). If there is a mismatch, the behavior of the virtual machine
6188	is undefined.
6189	</note>
6190	<result name="VBOX_E_INVALID_VM_STATE">
6191	Virtual machine state neither PoweredOff nor Aborted.
6192	</result>
6193	</desc>
6194	<param name="savedStateFile" type="wstring" dir="in">
6195	<desc>Path to the saved state file to adopt.</desc>
6196	</param>
6197	</method>
6198
6199	<method name="discardSavedState">
6200	<desc>
6201	Forcibly resets the machine to "Powered Off" state if it is
6202	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6203	Next time the machine is powered up, a clean boot will occur.
6204	<note>
6205	This operation is equivalent to resetting or powering off
6206	the machine without doing a proper shutdown of the guest
6207	operating system; as with resetting a running phyiscal
6208	computer, it can can lead to data loss.
6209	</note>
6210	If @a fRemoveFile is @c true, the file in the machine directory
6211	into which the machine state was saved is also deleted. If
6212	this is @c false, then the state can be recovered and later
6213	re-inserted into a machine using <link to="#adoptSavedState" />.
6214	The location of the file can be found in the
6215	<link to="IMachine::stateFilePath" /> attribute.
6216	<result name="VBOX_E_INVALID_VM_STATE">
6217	Virtual machine not in state Saved.
6218	</result>
6219	</desc>
6220	<param name="fRemoveFile" type="boolean" dir="in" >
6221	<desc>Whether to also remove the saved state file.</desc>
6222	</param>
6223	</method>
6224
6225	<method name="getDeviceActivity">
6226	<desc>
6227	Gets the current activity type of a given device or device group.
6228	<result name="E_INVALIDARG">
6229	Invalid device type.
6230	</result>
6231	</desc>
6232	<param name="type" type="DeviceType" dir="in"/>
6233	<param name="activity" type="DeviceActivity" dir="return"/>
6234	</method>
6235
6236	<method name="attachUSBDevice">
6237	<desc>
6238	Attaches a host USB device with the given UUID to the
6239	USB controller of the virtual machine.
6240
6241	The device needs to be in one of the following states:
6242	<link to="USBDeviceState_Busy"/>,
6243	<link to="USBDeviceState_Available"/> or
6244	<link to="USBDeviceState_Held"/>,
6245	otherwise an error is immediately returned.
6246
6247	When the device state is
6248	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6249	be returned if the host computer refuses to release it for some reason.
6250
6251	<see>IUSBController::deviceFilters, USBDeviceState</see>
6252	<result name="VBOX_E_INVALID_VM_STATE">
6253	Virtual machine state neither Running nor Paused.
6254	</result>
6255	<result name="VBOX_E_PDM_ERROR">
6256	Virtual machine does not have a USB controller.
6257	</result>
6258	</desc>
6259	<param name="id" type="uuid" mod="string" dir="in">
6260	<desc>UUID of the host USB device to attach.</desc>
6261	</param>
6262	</method>
6263
6264	<method name="detachUSBDevice">
6265	<desc>
6266	Detaches an USB device with the given UUID from the USB controller
6267	of the virtual machine.
6268
6269	After this method succeeds, the VirtualBox server re-initiates
6270	all USB filters as if the device were just physically attached
6271	to the host, but filters of this machine are ignored to avoid
6272	a possible automatic re-attachment.
6273
6274	<see>IUSBController::deviceFilters, USBDeviceState</see>
6275
6276	<result name="VBOX_E_PDM_ERROR">
6277	Virtual machine does not have a USB controller.
6278	</result>
6279	<result name="E_INVALIDARG">
6280	USB device not attached to this virtual machine.
6281	</result>
6282	</desc>
6283	<param name="id" type="uuid" mod="string" dir="in">
6284	<desc>UUID of the USB device to detach.</desc>
6285	</param>
6286	<param name="device" type="IUSBDevice" dir="return">
6287	<desc>Detached USB device.</desc>
6288	</param>
6289	</method>
6290
6291	<method name="findUSBDeviceByAddress">
6292	<desc>
6293	Searches for a USB device with the given host address.
6294
6295	<result name="VBOX_E_OBJECT_NOT_FOUND">
6296	Given @c name does not correspond to any USB device.
6297	</result>
6298
6299	<see>IUSBDevice::address</see>
6300	</desc>
6301	<param name="name" type="wstring" dir="in">
6302	<desc>
6303	Address of the USB device (as assigned by the host) to
6304	search for.
6305	</desc>
6306	</param>
6307	<param name="device" type="IUSBDevice" dir="return">
6308	<desc>Found USB device object.</desc>
6309	</param>
6310	</method>
6311
6312	<method name="findUSBDeviceById">
6313	<desc>
6314	Searches for a USB device with the given UUID.
6315
6316	<result name="VBOX_E_OBJECT_NOT_FOUND">
6317	Given @c id does not correspond to any USB device.
6318	</result>
6319
6320	<see>IUSBDevice::id</see>
6321	</desc>
6322	<param name="id" type="uuid" mod="string" dir="in">
6323	<desc>UUID of the USB device to search for.</desc>
6324	</param>
6325	<param name="device" type="IUSBDevice" dir="return">
6326	<desc>Found USB device object.</desc>
6327	</param>
6328	</method>
6329
6330	<method name="createSharedFolder">
6331	<desc>
6332	Creates a transient new shared folder by associating the given logical
6333	name with the given host path, adds it to the collection of shared
6334	folders and starts sharing it. Refer to the description of
6335	<link to="ISharedFolder"/> to read more about logical names.
6336
6337	<result name="VBOX_E_INVALID_VM_STATE">
6338	Virtual machine in Saved state or currently changing state.
6339	</result>
6340	<result name="VBOX_E_FILE_ERROR">
6341	Shared folder already exists or not accessible.
6342	</result>
6343	</desc>
6344	<param name="name" type="wstring" dir="in">
6345	<desc>Unique logical name of the shared folder.</desc>
6346	</param>
6347	<param name="hostPath" type="wstring" dir="in">
6348	<desc>Full path to the shared folder in the host file system.</desc>
6349	</param>
6350	<param name="writable" type="boolean" dir="in">
6351	<desc>Whether the share is writable or readonly</desc>
6352	</param>
6353	<param name="automount" type="boolean" dir="in">
6354	<desc>Whether the share gets automatically mounted by the guest
6355	or not.</desc>
6356	</param>
6357	</method>
6358
6359	<method name="removeSharedFolder">
6360	<desc>
6361	Removes a transient shared folder with the given name previously
6362	created by <link to="#createSharedFolder"/> from the collection of
6363	shared folders and stops sharing it.
6364	<result name="VBOX_E_INVALID_VM_STATE">
6365	Virtual machine in Saved state or currently changing state.
6366	</result>
6367	<result name="VBOX_E_FILE_ERROR">
6368	Shared folder does not exists.
6369	</result>
6370	</desc>
6371	<param name="name" type="wstring" dir="in">
6372	<desc>Logical name of the shared folder to remove.</desc>
6373	</param>
6374	</method>
6375
6376	<method name="takeSnapshot">
6377	<desc>
6378	Saves the current execution state
6379	and all settings of the machine and creates differencing images
6380	for all normal (non-independent) media.
6381	See <link to="ISnapshot" /> for an introduction to snapshots.
6382
6383	This method can be called for a PoweredOff, Saved (see
6384	<link to="#saveState"/>), Running or
6385	Paused virtual machine. When the machine is PoweredOff, an
6386	offline snapshot is created. When the machine is Running a live
6387	snapshot is created, and an online snapshot is is created when Paused.
6388
6389	The taken snapshot is always based on the
6390	<link to="IMachine::currentSnapshot">current snapshot</link>
6391	of the associated virtual machine and becomes a new current snapshot.
6392
6393	<note>
6394	This method implicitly calls <link to="IMachine::saveSettings"/> to
6395	save all current machine settings before taking an offline snapshot.
6396	</note>
6397
6398	<result name="VBOX_E_INVALID_VM_STATE">
6399	Virtual machine currently changing state.
6400	</result>
6401	</desc>
6402	<param name="name" type="wstring" dir="in">
6403	<desc>Short name for the snapshot.</desc>
6404	</param>
6405	<param name="description" type="wstring" dir="in">
6406	<desc>Optional description of the snapshot.</desc>
6407	</param>
6408	<param name="progress" type="IProgress" dir="return">
6409	<desc>Progress object to track the operation completion.</desc>
6410	</param>
6411	</method>
6412
6413	<method name="deleteSnapshot">
6414	<desc>
6415	Starts deleting the specified snapshot asynchronously.
6416	See <link to="ISnapshot" /> for an introduction to snapshots.
6417
6418	The execution state and settings of the associated machine stored in
6419	the snapshot will be deleted. The contents of all differencing media of
6420	this snapshot will be merged with the contents of their dependent child
6421	media to keep the medium chain valid (in other words, all changes
6422	represented by media being deleted will be propagated to their child
6423	medium). After that, this snapshot's differencing medium will be
6424	deleted. The parent of this snapshot will become a new parent for all
6425	its child snapshots.
6426
6427	If the deleted snapshot is the current one, its parent snapshot will
6428	become a new current snapshot. The current machine state is not directly
6429	affected in this case, except that currently attached differencing
6430	media based on media of the deleted snapshot will be also merged as
6431	described above.
6432
6433	If the deleted snapshot is the first or current snapshot, then the
6434	respective IMachine attributes will be adjusted. Deleting the current
6435	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6436	to make all current machine settings permanent.
6437
6438	Deleting a snapshot has the following preconditions:
6439
6440	<ul>
6441	<li>Child media of all normal media of the deleted snapshot
6442	must be accessible (see <link to="IMedium::state"/>) for this
6443	operation to succeed. In particular, this means that all virtual
6444	machines whose media are directly or indirectly based on the
6445	media of deleted snapshot must be powered off.</li>
6446
6447	<li>You cannot delete the snapshot if a medium attached to it has
6448	more than once child medium (differencing images) because otherwise
6449	merging would be impossible. This might be the case if there is
6450	more than one child snapshot or differencing images were created
6451	for other reason (e.g. implicitly because of multiple machine
6452	attachments).</li>
6453	</ul>
6454
6455
6456	The virtual machine's <link to="IMachine::state">state</link> is
6457	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6458	"DeletingSnapshotPaused" while this operation is in progress.
6459
6460	<note>
6461	Merging medium contents can be very time and disk space
6462	consuming, if these media are big in size and have many
6463	children. However, if the snapshot being deleted is the last
6464	(head) snapshot on the branch, the operation will be rather
6465	quick.
6466	</note>
6467	<result name="VBOX_E_INVALID_VM_STATE">
6468	The running virtual machine prevents deleting this snapshot. This
6469	happens only in very specific situations, usually snapshots can be
6470	deleted without trouble while a VM is running. The error message
6471	text explains the reason for the failure.
6472	</result>
6473	</desc>
6474	<param name="id" type="uuid" mod="string" dir="in">
6475	<desc>UUID of the snapshot to delete.</desc>
6476	</param>
6477	<param name="progress" type="IProgress" dir="return">
6478	<desc>Progress object to track the operation completion.</desc>
6479	</param>
6480	</method>
6481
6482	<method name="restoreSnapshot">
6483	<desc>
6484	Starts resetting the machine's current state to the state contained
6485	in the given snapshot, asynchronously. All current settings of the
6486	machine will be reset and changes stored in differencing media
6487	will be lost.
6488	See <link to="ISnapshot" /> for an introduction to snapshots.
6489
6490	After this operation is successfully completed, new empty differencing
6491	media are created for all normal media of the machine.
6492
6493	If the given snapshot is an online snapshot, the machine will go to
6494	the <link to="MachineState_Saved"> saved state</link>, so that the
6495	next time it is powered on, the execution state will be restored
6496	from the state of the snapshot.
6497
6498	<note>
6499	The machine must not be running, otherwise the operation will fail.
6500	</note>
6501
6502	<note>
6503	If the machine state is <link to="MachineState_Saved">Saved</link>
6504	prior to this operation, the saved state file will be implicitly
6505	deleted (as if <link to="IConsole::discardSavedState"/> were
6506	called).
6507	</note>
6508
6509	<result name="VBOX_E_INVALID_VM_STATE">
6510	Virtual machine is running.
6511	</result>
6512	</desc>
6513	<param name="snapshot" type="ISnapshot" dir="in">
6514	<desc>The snapshot to restore the VM state from.</desc>
6515	</param>
6516	<param name="progress" type="IProgress" dir="return">
6517	<desc>Progress object to track the operation completion.</desc>
6518	</param>
6519	</method>
6520
6521	<method name="teleport">
6522	<desc>
6523	Teleport the VM to a different host machine or process.
6524
6525	TODO explain the details.
6526
6527	<result name="VBOX_E_INVALID_VM_STATE">
6528	Virtual machine not running or paused.
6529	</result>
6530	</desc>
6531	<param name="hostname" type="wstring" dir="in">
6532	<desc>The name or IP of the host to teleport to.</desc>
6533	</param>
6534	<param name="tcpport" type="unsigned long" dir="in">
6535	<desc>The TCP port to connect to (1..65535).</desc>
6536	</param>
6537	<param name="password" type="wstring" dir="in">
6538	<desc>The password.</desc>
6539	</param>
6540	<param name="maxDowntime" type="unsigned long" dir="in">
6541	<desc>
6542	The maximum allowed downtime given as milliseconds. 0 is not a valid
6543	value. Recommended value: 250 ms.
6544
6545	The higher the value is, the greater the chance for a successful
6546	teleportation. A small value may easily result in the teleportation
6547	process taking hours and eventually fail.
6548
6549	<note>
6550	The current implementation treats this a guideline, not as an
6551	absolute rule.
6552	</note>
6553	</desc>
6554	</param>
6555	<param name="progress" type="IProgress" dir="return">
6556	<desc>Progress object to track the operation completion.</desc>
6557	</param>
6558	</method>
6559
6560	</interface>
6561
6562	<!--
6563	// IHost
6564	/////////////////////////////////////////////////////////////////////////
6565	-->
6566
6567	<enum
6568	name="HostNetworkInterfaceMediumType"
6569	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6570	>
6571	<desc>
6572	Type of encapsulation. Ethernet encapsulation includes both wired and
6573	wireless Ethernet connections.
6574	<see>IHostNetworkInterface</see>
6575	</desc>
6576
6577	<const name="Unknown" value="0">
6578	<desc>
6579	The type of interface cannot be determined.
6580	</desc>
6581	</const>
6582	<const name="Ethernet" value="1">
6583	<desc>
6584	Ethernet frame encapsulation.
6585	</desc>
6586	</const>
6587	<const name="PPP" value="2">
6588	<desc>
6589	Point-to-point protocol encapsulation.
6590	</desc>
6591	</const>
6592	<const name="SLIP" value="3">
6593	<desc>
6594	Serial line IP encapsulation.
6595	</desc>
6596	</const>
6597	</enum>
6598
6599	<enum
6600	name="HostNetworkInterfaceStatus"
6601	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6602	>
6603	<desc>
6604	Current status of the interface.
6605	<see>IHostNetworkInterface</see>
6606	</desc>
6607
6608	<const name="Unknown" value="0">
6609	<desc>
6610	The state of interface cannot be determined.
6611	</desc>
6612	</const>
6613	<const name="Up" value="1">
6614	<desc>
6615	The interface is fully operational.
6616	</desc>
6617	</const>
6618	<const name="Down" value="2">
6619	<desc>
6620	The interface is not functioning.
6621	</desc>
6622	</const>
6623	</enum>
6624
6625	<enum
6626	name="HostNetworkInterfaceType"
6627	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6628	>
6629	<desc>
6630	Network interface type.
6631	</desc>
6632	<const name="Bridged" value="1"/>
6633	<const name="HostOnly" value="2"/>
6634	</enum>
6635
6636	<interface
6637	name="IHostNetworkInterface" extends="$unknown"
6638	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6639	wsmap="managed"
6640	>
6641	<desc>
6642	Represents one of host's network interfaces. IP V6 address and network
6643	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6644	separated by colons.
6645	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6646	</desc>
6647	<attribute name="name" type="wstring" readonly="yes">
6648	<desc>Returns the host network interface name.</desc>
6649	</attribute>
6650
6651	<attribute name="id" type="uuid" mod="string" readonly="yes">
6652	<desc>Returns the interface UUID.</desc>
6653	</attribute>
6654
6655	<attribute name="networkName" type="wstring" readonly="yes">
6656	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6657	</attribute>
6658
6659	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6660	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6661	</attribute>
6662
6663	<attribute name="IPAddress" type="wstring" readonly="yes">
6664	<desc>Returns the IP V4 address of the interface.</desc>
6665	</attribute>
6666
6667	<attribute name="networkMask" type="wstring" readonly="yes">
6668	<desc>Returns the network mask of the interface.</desc>
6669	</attribute>
6670
6671	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6672	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6673	</attribute>
6674
6675	<attribute name="IPV6Address" type="wstring" readonly="yes">
6676	<desc>Returns the IP V6 address of the interface.</desc>
6677	</attribute>
6678
6679	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6680	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6681	</attribute>
6682
6683	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6684	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6685	</attribute>
6686
6687	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6688	<desc>Type of protocol encapsulation used.</desc>
6689	</attribute>
6690
6691	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6692	<desc>Status of the interface.</desc>
6693	</attribute>
6694
6695	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6696	<desc>specifies the host interface type.</desc>
6697	</attribute>
6698
6699	<method name="enableStaticIpConfig">
6700	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6701	<param name="IPAddress" type="wstring" dir="in">
6702	<desc>
6703	IP address.
6704	</desc>
6705	</param>
6706	<param name="networkMask" type="wstring" dir="in">
6707	<desc>
6708	network mask.
6709	</desc>
6710	</param>
6711	</method>
6712
6713	<method name="enableStaticIpConfigV6">
6714	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6715	<param name="IPV6Address" type="wstring" dir="in">
6716	<desc>
6717	IP address.
6718	</desc>
6719	</param>
6720	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6721	<desc>
6722	network mask.
6723	</desc>
6724	</param>
6725	</method>
6726
6727	<method name="enableDynamicIpConfig">
6728	<desc>enables the dynamic IP configuration.</desc>
6729	</method>
6730
6731	<method name="dhcpRediscover">
6732	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6733	</method>
6734
6735	</interface>
6736
6737	<interface
6738	name="IHost" extends="$unknown"
6739	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6740	wsmap="managed"
6741	>
6742	<desc>
6743	The IHost interface represents the physical machine that this VirtualBox
6744	installation runs on.
6745
6746	An object implementing this interface is returned by the
6747	<link to="IVirtualBox::host" /> attribute. This interface contains
6748	read-only information about the host's physical hardware (such as what
6749	processors and disks are available, what the host operating system is,
6750	and so on) and also allows for manipulating some of the host's hardware,
6751	such as global USB device filters and host interface networking.
6752
6753	</desc>
6754	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6755	<desc>List of DVD drives available on the host.</desc>
6756	</attribute>
6757
6758	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6759	<desc>List of floppy drives available on the host.</desc>
6760	</attribute>
6761
6762	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6763	<desc>
6764	List of USB devices currently attached to the host.
6765	Once a new device is physically attached to the host computer,
6766	it appears in this list and remains there until detached.
6767
6768	<note>
6769	If USB functionality is not available in the given edition of
6770	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6771	</note>
6772	</desc>
6773	</attribute>
6774
6775	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6776	<desc>
6777	List of USB device filters in action.
6778	When a new device is physically attached to the host computer,
6779	filters from this list are applied to it (in order they are stored
6780	in the list). The first matched filter will determine the
6781	<link to="IHostUSBDeviceFilter::action">action</link>
6782	performed on the device.
6783
6784	Unless the device is ignored by these filters, filters of all
6785	currently running virtual machines
6786	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6787
6788	<note>
6789	If USB functionality is not available in the given edition of
6790	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6791	</note>
6792
6793	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6794	</desc>
6795	</attribute>
6796
6797	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
6798	<desc>List of host network interfaces currently defined on the host.</desc>
6799	</attribute>
6800
6801	<attribute name="processorCount" type="unsigned long" readonly="yes">
6802	<desc>Number of (logical) CPUs installed in the host system.</desc>
6803	</attribute>
6804
6805	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
6806	<desc>Number of (logical) CPUs online in the host system.</desc>
6807	</attribute>
6808
6809	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
6810	<desc>Number of physical processor cores installed in the host system.</desc>
6811	</attribute>
6812
6813	<method name="getProcessorSpeed">
6814	<desc>Query the (approximate) maximum speed of a specified host CPU in
6815	Megahertz.
6816	</desc>
6817	<param name="cpuId" type="unsigned long" dir="in">
6818	<desc>
6819	Identifier of the CPU.
6820	</desc>
6821	</param>
6822	<param name="speed" type="unsigned long" dir="return">
6823	<desc>
6824	Speed value. 0 is returned if value is not known or @a cpuId is
6825	invalid.
6826	</desc>
6827	</param>
6828	</method>
6829
6830	<method name="getProcessorFeature">
6831	<desc>Query whether a CPU feature is supported or not.</desc>
6832	<param name="feature" type="ProcessorFeature" dir="in">
6833	<desc>
6834	CPU Feature identifier.
6835	</desc>
6836	</param>
6837	<param name="supported" type="boolean" dir="return">
6838	<desc>
6839	Feature is supported or not.
6840	</desc>
6841	</param>
6842	</method>
6843
6844	<method name="getProcessorDescription">
6845	<desc>Query the model string of a specified host CPU.
6846	</desc>
6847	<param name="cpuId" type="unsigned long" dir="in">
6848	<desc>
6849	Identifier of the CPU.
6850	<note>
6851	The current implementation might not necessarily return the
6852	description for this exact CPU.
6853	</note>
6854	</desc>
6855	</param>
6856	<param name="description" type="wstring" dir="return">
6857	<desc>
6858	Model string. An empty string is returned if value is not known or
6859	@a cpuId is invalid.
6860	</desc>
6861	</param>
6862	</method>
6863
6864	<method name="getProcessorCPUIDLeaf">
6865	<desc>
6866	Returns the CPU cpuid information for the specified leaf.
6867	</desc>
6868	<param name="cpuId" type="unsigned long" dir="in">
6869	<desc>
6870	Identifier of the CPU. The CPU most be online.
6871	<note>
6872	The current implementation might not necessarily return the
6873	description for this exact CPU.
6874	</note>
6875	</desc>
6876	</param>
6877	<param name="leaf" type="unsigned long" dir="in">
6878	<desc>
6879	CPUID leaf index (eax).
6880	</desc>
6881	</param>
6882	<param name="subLeaf" type="unsigned long" dir="in">
6883	<desc>
6884	CPUID leaf sub index (ecx). This currently only applies to cache
6885	information on Intel CPUs. Use 0 if retrieving values for
6886	<link to="IMachine::setCPUIDLeaf"/>.
6887	</desc>
6888	</param>
6889	<param name="valEax" type="unsigned long" dir="out">
6890	<desc>
6891	CPUID leaf value for register eax.
6892	</desc>
6893	</param>
6894	<param name="valEbx" type="unsigned long" dir="out">
6895	<desc>
6896	CPUID leaf value for register ebx.
6897	</desc>
6898	</param>
6899	<param name="valEcx" type="unsigned long" dir="out">
6900	<desc>
6901	CPUID leaf value for register ecx.
6902	</desc>
6903	</param>
6904	<param name="valEdx" type="unsigned long" dir="out">
6905	<desc>
6906	CPUID leaf value for register edx.
6907	</desc>
6908	</param>
6909	</method>
6910
6911	<attribute name="memorySize" type="unsigned long" readonly="yes">
6912	<desc>Amount of system memory in megabytes installed in the host system.</desc>
6913	</attribute>
6914
6915	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
6916	<desc>Available system memory in the host system.</desc>
6917	</attribute>
6918
6919	<attribute name="operatingSystem" type="wstring" readonly="yes">
6920	<desc>Name of the host system's operating system.</desc>
6921	</attribute>
6922
6923	<attribute name="OSVersion" type="wstring" readonly="yes">
6924	<desc>Host operating system's version string.</desc>
6925	</attribute>
6926
6927	<attribute name="UTCTime" type="long long" readonly="yes">
6928	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
6929	</attribute>
6930
6931	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
6932	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
6933	</attribute>
6934
6935	<method name="createHostOnlyNetworkInterface">
6936	<desc>
6937	Creates a new adapter for Host Only Networking.
6938	<result name="E_INVALIDARG">
6939	Host network interface @a name already exists.
6940	</result>
6941	</desc>
6942	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
6943	<desc>
6944	Created host interface object.
6945	</desc>
6946	</param>
6947	<param name="progress" type="IProgress" dir="return">
6948	<desc>
6949	Progress object to track the operation completion.
6950	</desc>
6951	</param>
6952	</method>
6953
6954	<method name="removeHostOnlyNetworkInterface">
6955	<desc>
6956	Removes the given Host Only Networking interface.
6957	<result name="VBOX_E_OBJECT_NOT_FOUND">
6958	No host network interface matching @a id found.
6959	</result>
6960	</desc>
6961	<param name="id" type="uuid" mod="string" dir="in">
6962	<desc>
6963	Adapter GUID.
6964	</desc>
6965	</param>
6966	<param name="progress" type="IProgress" dir="return">
6967	<desc>
6968	Progress object to track the operation completion.
6969	</desc>
6970	</param>
6971	</method>
6972
6973	<method name="createUSBDeviceFilter">
6974	<desc>
6975	Creates a new USB device filter. All attributes except
6976	the filter name are set to empty (any match),
6977	<i>active</i> is @c false (the filter is not active).
6978
6979	The created filter can be added to the list of filters using
6980	<link to="#insertUSBDeviceFilter"/>.
6981
6982	<see>#USBDeviceFilters</see>
6983	</desc>
6984	<param name="name" type="wstring" dir="in">
6985	<desc>
6986	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
6987	</desc>
6988	</param>
6989	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
6990	<desc>Created filter object.</desc>
6991	</param>
6992	</method>
6993
6994	<method name="insertUSBDeviceFilter">
6995	<desc>
6996	Inserts the given USB device to the specified position
6997	in the list of filters.
6998
6999	Positions are numbered starting from @c 0. If the specified
7000	position is equal to or greater than the number of elements in
7001	the list, the filter is added at the end of the collection.
7002
7003	<note>
7004	Duplicates are not allowed, so an attempt to insert a
7005	filter already in the list is an error.
7006	</note>
7007	<note>
7008	If USB functionality is not available in the given edition of
7009	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7010	</note>
7011
7012	<see>#USBDeviceFilters</see>
7013
7014	<result name="VBOX_E_INVALID_OBJECT_STATE">
7015	USB device filter is not created within this VirtualBox instance.
7016	</result>
7017	<result name="E_INVALIDARG">
7018	USB device filter already in list.
7019	</result>
7020
7021	</desc>
7022	<param name="position" type="unsigned long" dir="in">
7023	<desc>Position to insert the filter to.</desc>
7024	</param>
7025	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7026	<desc>USB device filter to insert.</desc>
7027	</param>
7028	</method>
7029
7030	<method name="removeUSBDeviceFilter">
7031	<desc>
7032	Removes a USB device filter from the specified position in the
7033	list of filters.
7034
7035	Positions are numbered starting from @c 0. Specifying a
7036	position equal to or greater than the number of elements in
7037	the list will produce an error.
7038
7039	<note>
7040	If USB functionality is not available in the given edition of
7041	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7042	</note>
7043
7044	<see>#USBDeviceFilters</see>
7045
7046	<result name="E_INVALIDARG">
7047	USB device filter list empty or invalid @a position.
7048	</result>
7049
7050	</desc>
7051	<param name="position" type="unsigned long" dir="in">
7052	<desc>Position to remove the filter from.</desc>
7053	</param>
7054	</method>
7055
7056	<method name="findHostDVDDrive">
7057	<desc>
7058	Searches for a host DVD drive with the given @c name.
7059
7060	<result name="VBOX_E_OBJECT_NOT_FOUND">
7061	Given @c name does not correspond to any host drive.
7062	</result>
7063
7064	</desc>
7065	<param name="name" type="wstring" dir="in">
7066	<desc>Name of the host drive to search for</desc>
7067	</param>
7068	<param name="drive" type="IMedium" dir="return">
7069	<desc>Found host drive object</desc>
7070	</param>
7071	</method>
7072
7073	<method name="findHostFloppyDrive">
7074	<desc>
7075	Searches for a host floppy drive with the given @c name.
7076
7077	<result name="VBOX_E_OBJECT_NOT_FOUND">
7078	Given @c name does not correspond to any host floppy drive.
7079	</result>
7080
7081	</desc>
7082	<param name="name" type="wstring" dir="in">
7083	<desc>Name of the host floppy drive to search for</desc>
7084	</param>
7085	<param name="drive" type="IMedium" dir="return">
7086	<desc>Found host floppy drive object</desc>
7087	</param>
7088	</method>
7089
7090	<method name="findHostNetworkInterfaceByName">
7091	<desc>
7092	Searches through all host network interfaces for an interface with
7093	the given @c name.
7094	<note>
7095	The method returns an error if the given @c name does not
7096	correspond to any host network interface.
7097	</note>
7098	</desc>
7099	<param name="name" type="wstring" dir="in">
7100	<desc>Name of the host network interface to search for.</desc>
7101	</param>
7102	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7103	<desc>Found host network interface object.</desc>
7104	</param>
7105	</method>
7106	<method name="findHostNetworkInterfaceById">
7107	<desc>
7108	Searches through all host network interfaces for an interface with
7109	the given GUID.
7110	<note>
7111	The method returns an error if the given GUID does not
7112	correspond to any host network interface.
7113	</note>
7114	</desc>
7115	<param name="id" type="uuid" mod="string" dir="in">
7116	<desc>GUID of the host network interface to search for.</desc>
7117	</param>
7118	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7119	<desc>Found host network interface object.</desc>
7120	</param>
7121	</method>
7122	<method name="findHostNetworkInterfacesOfType">
7123	<desc>
7124	Searches through all host network interfaces and returns a list of interfaces of the specified type
7125	</desc>
7126	<param name="type" type="HostNetworkInterfaceType" dir="in">
7127	<desc>type of the host network interfaces to search for.</desc>
7128	</param>
7129	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7130	<desc>Found host network interface objects.</desc>
7131	</param>
7132	</method>
7133
7134	<method name="findUSBDeviceById">
7135	<desc>
7136	Searches for a USB device with the given UUID.
7137
7138	<result name="VBOX_E_OBJECT_NOT_FOUND">
7139	Given @c id does not correspond to any USB device.
7140	</result>
7141
7142	<see>IHostUSBDevice::id</see>
7143	</desc>
7144	<param name="id" type="uuid" mod="string" dir="in">
7145	<desc>UUID of the USB device to search for.</desc>
7146	</param>
7147	<param name="device" type="IHostUSBDevice" dir="return">
7148	<desc>Found USB device object.</desc>
7149	</param>
7150	</method>
7151
7152	<method name="findUSBDeviceByAddress">
7153	<desc>
7154	Searches for a USB device with the given host address.
7155
7156	<result name="VBOX_E_OBJECT_NOT_FOUND">
7157	Given @c name does not correspond to any USB device.
7158	</result>
7159
7160	<see>IHostUSBDevice::address</see>
7161	</desc>
7162	<param name="name" type="wstring" dir="in">
7163	<desc>
7164	Address of the USB device (as assigned by the host) to
7165	search for.
7166	</desc>
7167	</param>
7168	<param name="device" type="IHostUSBDevice" dir="return">
7169	<desc>Found USB device object.</desc>
7170	</param>
7171	</method>
7172
7173	</interface>
7174
7175	<!--
7176	// ISystemProperties
7177	/////////////////////////////////////////////////////////////////////////
7178	-->
7179
7180	<interface
7181	name="ISystemProperties"
7182	extends="$unknown"
7183	uuid="9a949843-b237-46d4-8fcf-c83dcd9121ef"
7184	wsmap="managed"
7185	>
7186	<desc>
7187	The ISystemProperties interface represents global properties of the given
7188	VirtualBox installation.
7189
7190	These properties define limits and default values for various attributes
7191	and parameters. Most of the properties are read-only, but some can be
7192	changed by a user.
7193	</desc>
7194
7195	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7196	<desc>Minimum guest system memory in Megabytes.</desc>
7197	</attribute>
7198
7199	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7200	<desc>Maximum guest system memory in Megabytes.</desc>
7201	</attribute>
7202
7203	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7204	<desc>Minimum guest video memory in Megabytes.</desc>
7205	</attribute>
7206
7207	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7208	<desc>Maximum guest video memory in Megabytes.</desc>
7209	</attribute>
7210
7211	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7212	<desc>Minimum CPU count.</desc>
7213	</attribute>
7214
7215	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7216	<desc>Maximum CPU count.</desc>
7217	</attribute>
7218
7219	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7220	<desc>Maximum of monitors which could be connected.</desc>
7221	</attribute>
7222
7223	<attribute name="infoVDSize" type="long long" readonly="yes">
7224	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7225	does not reflect the limits of any virtual disk image format.</desc>
7226	</attribute>
7227
7228	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7229	<desc>
7230	Number of network adapters associated with every
7231	<link to="IMachine"/> instance.
7232	</desc>
7233	</attribute>
7234
7235	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7236	<desc>
7237	Number of serial ports associated with every
7238	<link to="IMachine"/> instance.
7239	</desc>
7240	</attribute>
7241
7242	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7243	<desc>
7244	Number of parallel ports associated with every
7245	<link to="IMachine"/> instance.
7246	</desc>
7247	</attribute>
7248
7249	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7250	<desc>
7251	Maximum device position in the boot order. This value corresponds
7252	to the total number of devices a machine can boot from, to make it
7253	possible to include all possible devices to the boot list.
7254	<see><link to="IMachine::setBootOrder"/></see>
7255	</desc>
7256	</attribute>
7257
7258	<attribute name="defaultMachineFolder" type="wstring">
7259	<desc>
7260	Full path to the default directory used to create new or open
7261	existing machines when a machine settings file name contains no
7262	path.
7263
7264	Starting with VirtualBox 4.0, by default, this attribute contains
7265	the full path of folder named "VirtualBox VMs" in the user's
7266	home directory, which depends on the host platform.
7267
7268	When setting this attribute, a full path must be specified.
7269	Setting this property to @c null or an empty string or the
7270	special value "Machines" (for compatibility reasons) will restore
7271	that default value.
7272
7273	If the folder specified herein does not exist, it will be created
7274	automatically as needed.
7275
7276	<see>
7277	<link to="IVirtualBox::createMachine"/>,
7278	<link to="IVirtualBox::openMachine"/>
7279	</see>
7280	</desc>
7281	</attribute>
7282
7283	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7284	<desc>
7285	List of all medium storage formats supported by this VirtualBox
7286	installation.
7287
7288	Keep in mind that the medium format identifier
7289	(<link to="IMediumFormat::id"/>) used in other API calls like
7290	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7291	medium format is a case-insensitive string. This means that, for
7292	example, all of the following strings:
7293	<pre>
7294	"VDI"
7295	"vdi"
7296	"VdI"</pre>
7297	refer to the same medium format.
7298
7299	Note that the virtual medium framework is backend-based, therefore
7300	the list of supported formats depends on what backends are currently
7301	installed.
7302
7303	<see>
7304	<link to="IMediumFormat"/>,
7305	</see>
7306	</desc>
7307	</attribute>
7308
7309	<attribute name="defaultHardDiskFormat" type="wstring">
7310	<desc>
7311	Identifier of the default medium format used by VirtualBox.
7312
7313	The medium format set by this attribute is used by VirtualBox
7314	when the medium format was not specified explicitly. One example is
7315	<link to="IVirtualBox::createHardDisk"/> with the empty
7316	format argument. A more complex example is implicit creation of
7317	differencing media when taking a snapshot of a virtual machine:
7318	this operation will try to use a format of the parent medium first
7319	and if this format does not support differencing media the default
7320	format specified by this argument will be used.
7321
7322	The list of supported medium formats may be obtained by the
7323	<link to="#mediumFormats"/> call. Note that the default medium
7324	format must have a capability to create differencing media;
7325	otherwise operations that create media implicitly may fail
7326	unexpectedly.
7327
7328	The initial value of this property is <tt>"VDI"</tt> in the current
7329	version of the VirtualBox product, but may change in the future.
7330
7331	<note>
7332	Setting this property to @c null or empty string will restore the
7333	initial value.
7334	</note>
7335
7336	<see>
7337	<link to="#mediumFormats"/>,
7338	<link to="IMediumFormat::id"/>,
7339	<link to="IVirtualBox::createHardDisk"/>
7340	</see>
7341	</desc>
7342	</attribute>
7343
7344	<attribute name="freeDiskSpaceWarning" type="long long">
7345	<desc>Issue a warning if the free disk space is below (or in some disk
7346	intensive operation is expected to go below) the given size in
7347	bytes.</desc>
7348	</attribute>
7349
7350	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7351	<desc>Issue a warning if the free disk space is below (or in some disk
7352	intensive operation is expected to go below) the given percentage.</desc>
7353	</attribute>
7354
7355	<attribute name="freeDiskSpaceError" type="long long">
7356	<desc>Issue an error if the free disk space is below (or in some disk
7357	intensive operation is expected to go below) the given size in
7358	bytes.</desc>
7359	</attribute>
7360
7361	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7362	<desc>Issue an error if the free disk space is below (or in some disk
7363	intensive operation is expected to go below) the given percentage.</desc>
7364	</attribute>
7365
7366	<attribute name="VRDEAuthLibrary" type="wstring">
7367	<desc>
7368	Library that provides authentication for Remote Desktop clients. The library
7369	is used if a virtual machine's authentication type is set to "external"
7370	in the VM RemoteDisplay configuration.
7371
7372	The system library extension (".DLL" or ".so") must be omitted.
7373	A full path can be specified; if not, then the library must reside on the
7374	system's default library path.
7375
7376	The default value of this property is <tt>"VRDPAuth"</tt>. There is a library
7377	of that name in one of the default VirtualBox library directories.
7378
7379	For details about VirtualBox authentication libraries and how to implement
7380	them, please refer to the VirtualBox manual.
7381
7382	<note>
7383	Setting this property to @c null or empty string will restore the
7384	initial value.
7385	</note>
7386	</desc>
7387	</attribute>
7388
7389	<attribute name="webServiceAuthLibrary" type="wstring">
7390	<desc>
7391	Library that provides authentication for webservice clients. The library
7392	is used if a virtual machine's authentication type is set to "external"
7393	in the VM RemoteDisplay configuration and will be called from
7394	within the <link to="IWebsessionManager::logon" /> implementation.
7395
7396	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7397	there is no per-VM setting for this, as the webservice is a global
7398	resource (if it is running). Only for this setting (for the webservice),
7399	setting this value to a literal <tt>"null"</tt> string disables authentication,
7400	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7401	no matter what user name and password are supplied.
7402
7403	The initial value of this property is <tt>"VRDPAuth"</tt>,
7404	meaning that the webservice will use the same authentication
7405	library that is used by default for VRDE (again, see
7406	<link to="ISystemProperties::VRDEAuthLibrary" />).
7407	The format and calling convention of authentication libraries
7408	is the same for the webservice as it is for VRDE.
7409
7410	<note>
7411	Setting this property to @c null or empty string will restore the
7412	initial value.
7413	</note>
7414	</desc>
7415	</attribute>
7416
7417	<attribute name="defaultVRDELibrary" type="wstring">
7418	<desc>
7419	Default VRDE library.
7420
7421	The default value of this property is an empty string, which means that the
7422	VRDE is not available.
7423
7424	For details about VirtualBox Remote Desktop Extension and how to implement
7425	it, please refer to the VirtualBox SDK.
7426	</desc>
7427	</attribute>
7428
7429	<attribute name="LogHistoryCount" type="unsigned long">
7430	<desc>
7431	This value specifies how many old release log files are kept.
7432	</desc>
7433	</attribute>
7434
7435	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7436	<desc>This value hold the default audio driver for the current
7437	system.</desc>
7438	</attribute>
7439
7440	<method name="getMaxDevicesPerPortForStorageBus">
7441	<desc>Returns the maximum number of devices which can be attached to a port
7442	for the given storage bus.</desc>
7443
7444	<param name="bus" type="StorageBus" dir="in">
7445	<desc>The storage bus type to get the value for.</desc>
7446	</param>
7447
7448	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7449	<desc>The maximum number of devices which can eb attached to the port for the given
7450	storage bus.</desc>
7451	</param>
7452	</method>
7453
7454	<method name="getMinPortCountForStorageBus">
7455	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7456
7457	<param name="bus" type="StorageBus" dir="in">
7458	<desc>The storage bus type to get the value for.</desc>
7459	</param>
7460
7461	<param name="minPortCount" type="unsigned long" dir="return">
7462	<desc>The minimum number of ports for the given storage bus.</desc>
7463	</param>
7464	</method>
7465
7466	<method name="getMaxPortCountForStorageBus">
7467	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7468
7469	<param name="bus" type="StorageBus" dir="in">
7470	<desc>The storage bus type to get the value for.</desc>
7471	</param>
7472
7473	<param name="maxPortCount" type="unsigned long" dir="return">
7474	<desc>The maximum number of ports for the given storage bus.</desc>
7475	</param>
7476	</method>
7477
7478	<method name="getMaxInstancesOfStorageBus">
7479	<desc>Returns the maximum number of storage bus instances which
7480	can be configured for each VM. This corresponds to the number of
7481	storage controllers one can have. Value may depend on chipset type
7482	used.</desc>
7483
7484	<param name="chipset" type="ChipsetType" dir="in">
7485	<desc>The chipset type to get the value for.</desc>
7486	</param>
7487
7488	<param name="bus" type="StorageBus" dir="in">
7489	<desc>The storage bus type to get the value for.</desc>
7490	</param>
7491
7492	<param name="maxInstances" type="unsigned long" dir="return">
7493	<desc>The maximum number of instances for the given storage bus.</desc>
7494	</param>
7495	</method>
7496
7497	<method name="getDeviceTypesForStorageBus">
7498	<desc>Returns list of all the supported device types
7499	(<link to="DeviceType"/>) for the given type of storage
7500	bus.</desc>
7501
7502	<param name="bus" type="StorageBus" dir="in">
7503	<desc>The storage bus type to get the value for.</desc>
7504	</param>
7505
7506	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7507	<desc>The list of all supported device types for the given storage bus.</desc>
7508	</param>
7509	</method>
7510
7511	<method name="getDefaultIoCacheSettingForStorageController">
7512	<desc>Returns the default I/O cache setting for the
7513	given storage controller</desc>
7514
7515	<param name="controllerType" type="StorageControllerType" dir="in">
7516	<desc>The storage controller to the setting for.</desc>
7517	</param>
7518
7519	<param name="enabled" type="boolean" dir="return">
7520	<desc>Returned flag indicating the default value</desc>
7521	</param>
7522	</method>
7523	</interface>
7524
7525	<!--
7526	// IGuest
7527	/////////////////////////////////////////////////////////////////////////
7528	-->
7529
7530	<interface
7531	name="IGuestOSType" extends="$unknown"
7532	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7533	wsmap="struct"
7534	>
7535	<desc>
7536	</desc>
7537
7538	<attribute name="familyId" type="wstring" readonly="yes">
7539	<desc>Guest OS family identifier string.</desc>
7540	</attribute>
7541
7542	<attribute name="familyDescription" type="wstring" readonly="yes">
7543	<desc>Human readable description of the guest OS family.</desc>
7544	</attribute>
7545
7546	<attribute name="id" type="wstring" readonly="yes">
7547	<desc>Guest OS identifier string.</desc>
7548	</attribute>
7549
7550	<attribute name="description" type="wstring" readonly="yes">
7551	<desc>Human readable description of the guest OS.</desc>
7552	</attribute>
7553
7554	<attribute name="is64Bit" type="boolean" readonly="yes">
7555	<desc>Returns @c true if the given OS is 64-bit</desc>
7556	</attribute>
7557
7558	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7559	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7560	</attribute>
7561
7562	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7563	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7564	</attribute>
7565
7566	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7567	<desc>Recommended RAM size in Megabytes.</desc>
7568	</attribute>
7569
7570	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7571	<desc>Recommended video RAM size in Megabytes.</desc>
7572	</attribute>
7573
7574	<attribute name="recommendedHDD" type="long long" readonly="yes">
7575	<desc>Recommended hard disk size in bytes.</desc>
7576	</attribute>
7577
7578	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7579	<desc>Returns recommended network adapter for this OS type.</desc>
7580	</attribute>
7581
7582	<attribute name="recommendedPae" type="boolean" readonly="yes">
7583	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7584	</attribute>
7585
7586	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7587	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7588	</attribute>
7589
7590	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7591	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7592	</attribute>
7593
7594	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7595	<desc>Recommended storage controller type for HD drives.</desc>
7596	</attribute>
7597
7598	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7599	<desc>Recommended storage bus type for HD drives.</desc>
7600	</attribute>
7601
7602	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7603	<desc>Recommended firmware type.</desc>
7604	</attribute>
7605
7606	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7607	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7608	</attribute>
7609
7610	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7611	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7612	</attribute>
7613
7614	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7615	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7616	</attribute>
7617
7618	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7619	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7620	</attribute>
7621
7622	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7623	<desc>Recommended chipset type.</desc>
7624	</attribute>
7625
7626	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7627	<desc>Recommended audio type.</desc>
7628	</attribute>
7629
7630	</interface>
7631
7632	<enum
7633	name="AdditionsRunLevelType"
7634	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7635	>
7636	<desc>
7637	Guest Additions run level type.
7638	</desc>
7639
7640	<const name="None" value="0">
7641	<desc>Guest Additions are not loaded.</desc>
7642	</const>
7643	<const name="System" value="1">
7644	<desc>Guest drivers are loaded.</desc>
7645	</const>
7646	<const name="Userland" value="2">
7647	<desc>Common components (such as application services) are loaded.</desc>
7648	</const>
7649	<const name="Desktop" value="3">
7650	<desc>Per-user desktop components are loaded.</desc>
7651	</const>
7652	</enum>
7653
7654	<enum
7655	name="ExecuteProcessFlag"
7656	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7657	>
7658	<desc>
7659	Guest process execution flags.
7660	</desc>
7661
7662	<const name="None" value="0">
7663	<desc>No flag set.</desc>
7664	</const>
7665
7666	<const name="WaitForProcessStartOnly" value="1">
7667	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
7668	process itself then uses an infinite timeout.</desc>
7669	</const>
7670
7671	<const name="IgnoreOrphanedProcesses" value="2">
7672	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7673	</const>
7674	</enum>
7675
7676	<enum
7677	name="ProcessInputFlag"
7678	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7679	>
7680	<desc>
7681	Guest process input flags.
7682	</desc>
7683
7684	<const name="None" value="0">
7685	<desc>No flag set.</desc>
7686	</const>
7687	<const name="EndOfFile" value="1">
7688	<desc>End of file (input) reached.</desc>
7689	</const>
7690	</enum>
7691
7692	<enum
7693	name="CopyFileFlag"
7694	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7695	>
7696	<desc>
7697	Host/Guest copy flags.
7698	</desc>
7699
7700	<const name="None" value="0">
7701	<desc>No flag set.</desc>
7702	</const>
7703
7704	<const name="Recursive" value="1">
7705	<desc>Copy directories recursively.</desc>
7706	</const>
7707
7708	<const name="Update" value="2">
7709	<desc>Copy only when the source file is newer than the destination file or when the destination file is missing.</desc>
7710	</const>
7711
7712	<const name="FollowLinks" value="4">
7713	<desc>Follow symbolic links.</desc>
7714	</const>
7715	</enum>
7716
7717	<enum
7718	name="CreateDirectoryFlag"
7719	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
7720	>
7721	<desc>
7722	Directory creation flags.
7723	</desc>
7724
7725	<const name="None" value="0">
7726	<desc>No flag set.</desc>
7727	</const>
7728
7729	<const name="Parents" value="1">
7730	<desc>No error if existing, make parent directories as needed.</desc>
7731	</const>
7732	</enum>
7733
7734	<interface
7735	name="IGuest" extends="$unknown"
7736	uuid="1039b0cc-9bc1-4c6d-8d12-864aa48aa5b9"
7737	wsmap="managed"
7738	>
7739	<desc>
7740	The IGuest interface represents information about the operating system
7741	running inside the virtual machine. Used in
7742	<link to="IConsole::guest"/>.
7743
7744	IGuest provides information about the guest operating system, whether
7745	Guest Additions are installed and other OS-specific virtual machine
7746	properties.
7747	</desc>
7748
7749	<attribute name="OSTypeId" type="wstring" readonly="yes">
7750	<desc>
7751	Identifier of the Guest OS type as reported by the Guest
7752	Additions.
7753	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7754	an IGuestOSType object representing details about the given
7755	Guest OS type.
7756	<note>
7757	If Guest Additions are not installed, this value will be
7758	the same as <link to="IMachine::OSTypeId"/>.
7759	</note>
7760	</desc>
7761	</attribute>
7762
7763	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
7764	<desc>
7765	Current run level of the Guest Additions.
7766	</desc>
7767	</attribute>
7768
7769	<attribute name="additionsVersion" type="wstring" readonly="yes">
7770	<desc>
7771	Version of the Guest Additions including the revision (3 decimal numbers
7772	separated by dots + revision number) installed on the guest or empty
7773	when the Additions are not installed.
7774	</desc>
7775	</attribute>
7776
7777	<attribute name="supportsSeamless" type="boolean" readonly="yes">
7778	<desc>
7779	Flag whether seamless guest display rendering (seamless desktop
7780	integration) is supported.
7781	</desc>
7782	</attribute>
7783
7784	<attribute name="supportsGraphics" type="boolean" readonly="yes">
7785	<desc>
7786	Flag whether the guest is in graphics mode. If it is not, then
7787	seamless rendering will not work, resize hints are not immediately
7788	acted on and guest display resizes are probably not initiated by
7789	the guest additions.
7790	</desc>
7791	</attribute>
7792
7793	<attribute name="memoryBalloonSize" type="unsigned long">
7794	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
7795	</attribute>
7796
7797	<attribute name="statisticsUpdateInterval" type="unsigned long">
7798	<desc>Interval to update guest statistics in seconds.</desc>
7799	</attribute>
7800
7801	<method name="internalGetStatistics">
7802	<desc>
7803	Internal method; do not use as it might change at any time
7804	</desc>
7805	<param name="cpuUser" type="unsigned long" dir="out">
7806	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
7807	</param>
7808	<param name="cpuKernel" type="unsigned long" dir="out">
7809	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
7810	</param>
7811	<param name="cpuIdle" type="unsigned long" dir="out">
7812	<desc>Percentage of processor time spent idling as seen by the guest</desc>
7813	</param>
7814	<param name="memTotal" type="unsigned long" dir="out">
7815	<desc>Total amount of physical guest RAM</desc>
7816	</param>
7817	<param name="memFree" type="unsigned long" dir="out">
7818	<desc>Free amount of physical guest RAM</desc>
7819	</param>
7820	<param name="memBalloon" type="unsigned long" dir="out">
7821	<desc>Amount of ballooned physical guest RAM</desc>
7822	</param>
7823	<param name="memShared" type="unsigned long" dir="out">
7824	<desc>Amount of shared physical guest RAM</desc>
7825	</param>
7826	<param name="memCache" type="unsigned long" dir="out">
7827	<desc>Total amount of guest (disk) cache memory</desc>
7828	</param>
7829	<param name="pagedTotal" type="unsigned long" dir="out">
7830	<desc>Total amount of space in the page file</desc>
7831	</param>
7832	<param name="memAllocTotal" type="unsigned long" dir="out">
7833	<desc>Total amount of memory allocated by the hypervisor</desc>
7834	</param>
7835	<param name="memFreeTotal" type="unsigned long" dir="out">
7836	<desc>Total amount of free memory available in the hypervisor</desc>
7837	</param>
7838	<param name="memBalloonTotal" type="unsigned long" dir="out">
7839	<desc>Total amount of memory ballooned by the hypervisor</desc>
7840	</param>
7841	<param name="memSharedTotal" type="unsigned long" dir="out">
7842	<desc>Total amount of shared memory in the hypervisor</desc>
7843	</param>
7844	</method>
7845
7846	<method name="getAdditionsStatus">
7847	<desc>
7848	Retrieve the current status of a certain Guest Additions run level.
7849
7850	<result name="VBOX_E_NOT_SUPPORTED">
7851	Wrong status level specified.
7852	</result>
7853
7854	</desc>
7855	<param name="level" type="AdditionsRunLevelType" dir="in">
7856	<desc>Status level to check</desc>
7857	</param>
7858	<param name="active" type="boolean" dir="return">
7859	<desc>Flag whether the status level has been reached or not</desc>
7860	</param>
7861	</method>
7862
7863	<method name="setCredentials">
7864	<desc>
7865	Store login credentials that can be queried by guest operating
7866	systems with Additions installed. The credentials are transient
7867	to the session and the guest may also choose to erase them. Note
7868	that the caller cannot determine whether the guest operating system
7869	has queried or made use of the credentials.
7870
7871	<result name="VBOX_E_VM_ERROR">
7872	VMM device is not available.
7873	</result>
7874
7875	</desc>
7876	<param name="userName" type="wstring" dir="in">
7877	<desc>User name string, can be empty</desc>
7878	</param>
7879	<param name="password" type="wstring" dir="in">
7880	<desc>Password string, can be empty</desc>
7881	</param>
7882	<param name="domain" type="wstring" dir="in">
7883	<desc>Domain name (guest logon scheme specific), can be empty</desc>
7884	</param>
7885	<param name="allowInteractiveLogon" type="boolean" dir="in">
7886	<desc>
7887	Flag whether the guest should alternatively allow the user to
7888	interactively specify different credentials. This flag might
7889	not be supported by all versions of the Additions.
7890	</desc>
7891	</param>
7892	</method>
7893
7894	<method name="executeProcess">
7895	<desc>
7896	Executes an existing program inside the guest VM.
7897
7898	<result name="VBOX_E_IPRT_ERROR">
7899	Could not execute process.
7900	</result>
7901
7902	</desc>
7903	<param name="execName" type="wstring" dir="in">
7904	<desc>
7905	Full path name of the command to execute on the guest; the
7906	commands has to exists in the guest VM in order to be executed.
7907	</desc>
7908	</param>
7909	<param name="flags" type="unsigned long" dir="in">
7910	<desc>
7911	Execution flags - currently not supported and therefore
7912	has to be set to 0.
7913	</desc>
7914	</param>
7915	<param name="arguments" type="wstring" safearray="yes" dir="in">
7916	<desc>
7917	Array of arguments passed to the execution command.
7918	</desc>
7919	</param>
7920	<param name="environment" type="wstring" safearray="yes" dir="in">
7921	<desc>
7922	Environment variables that can be set while the command is being
7923	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
7924	variable just set its name ("NAME") without a value.
7925	</desc>
7926	</param>
7927	<param name="userName" type="wstring" dir="in">
7928	<desc>
7929	User name under which the command will be executed; has to exist
7930	and have the appropriate rights to execute programs in the VM.
7931	</desc>
7932	</param>
7933	<param name="password" type="wstring" dir="in">
7934	<desc>
7935	Password of the user account specified.
7936	</desc>
7937	</param>
7938	<param name="timeoutMS" type="unsigned long" dir="in">
7939	<desc>
7940	The maximum timeout value (in msec) to wait for finished program
7941	execution. Pass 0 for an infinite timeout.
7942	</desc>
7943	</param>
7944	<param name="pid" type="unsigned long" dir="out">
7945	<desc>
7946	The PID (process ID) of the started command for later reference.
7947	</desc>
7948	</param>
7949	<param name="progress" type="IProgress" dir="return">
7950	<desc>Progress object to track the operation completion.</desc>
7951	</param>
7952	</method>
7953
7954	<method name="getProcessOutput">
7955	<desc>
7956	Retrieves output of a formerly started process.
7957
7958	<result name="VBOX_E_IPRT_ERROR">
7959	Could not retrieve output.
7960	</result>
7961
7962	</desc>
7963	<param name="pid" type="unsigned long" dir="in">
7964	<desc>
7965	Process id returned by earlier executeProcess() call.
7966	</desc>
7967	</param>
7968	<param name="flags" type="unsigned long" dir="in">
7969	<desc>
7970	Flags describing which output to retrieve.
7971	</desc>
7972	</param>
7973	<param name="timeoutMS" type="unsigned long" dir="in">
7974	<desc>
7975	The maximum timeout value (in msec) to wait for output
7976	data. Pass 0 for an infinite timeout.
7977	</desc>
7978	</param>
7979	<param name="size" type="long long" dir="in">
7980	<desc>
7981	Size in bytes to read in the buffer.
7982	</desc>
7983	</param>
7984	<param name="data" type="octet" dir="return" safearray="yes">
7985	<desc>
7986	Buffer for retrieving the actual output. A data size of 0 means end of file
7987	if the requested size was not 0. This is the unprocessed
7988	output data, i.e. the line ending style depends on the platform of
7989	the system the server is running on.
7990	</desc>
7991	</param>
7992	</method>
7993
7994	<method name="getProcessStatus">
7995	<desc>
7996	Retrieves status, exit code and the exit reason of a formerly started process.
7997
7998	<result name="VBOX_E_IPRT_ERROR">
7999	Process with specified PID was not found.
8000	</result>
8001
8002	</desc>
8003	<param name="pid" type="unsigned long" dir="in">
8004	<desc>
8005	Process id returned by earlier executeProcess() call.
8006	</desc>
8007	</param>
8008	<param name="exitcode" type="unsigned long" dir="out">
8009	<desc>
8010	The exit code (if available).
8011	</desc>
8012	</param>
8013	<param name="flags" type="unsigned long" dir="out">
8014	<desc>
8015	Additional flags of process status. Not used at the moment and
8016	must be set to 0.
8017	</desc>
8018	</param>
8019	<param name="reason" type="unsigned long" dir="return">
8020	<desc>
8021	The current process status.
8022	</desc>
8023	</param>
8024	</method>
8025
8026	<method name="copyToGuest">
8027	<desc>
8028	Copies files/directories from host to the guest.
8029
8030	<result name="VBOX_E_IPRT_ERROR">
8031	Error while copying.
8032	</result>
8033
8034	</desc>
8035	<param name="source" type="wstring" dir="in">
8036	<desc>
8037	Source file on the host to copy.
8038	</desc>
8039	</param>
8040	<param name="dest" type="wstring" dir="in">
8041	<desc>
8042	Destination path on the guest.
8043	</desc>
8044	</param>
8045	<param name="userName" type="wstring" dir="in">
8046	<desc>
8047	User name under which the copy command will be executed; the
8048	user has to exist and have the appropriate rights to write to
8049	the destination path.
8050	</desc>
8051	</param>
8052	<param name="password" type="wstring" dir="in">
8053	<desc>
8054	Password of the user account specified.
8055	</desc>
8056	</param>
8057	<param name="flags" type="unsigned long" dir="in">
8058	<desc>
8059	Copy flags.
8060	</desc>
8061	</param>
8062	<param name="progress" type="IProgress" dir="return">
8063	<desc>Progress object to track the operation completion.</desc>
8064	</param>
8065	</method>
8066
8067	<method name="createDirectory">
8068	<desc>
8069	Creates a directory on the guest.
8070
8071	<result name="VBOX_E_IPRT_ERROR">
8072	Error while creating directory.
8073	</result>
8074
8075	</desc>
8076	<param name="directory" type="wstring" dir="in">
8077	<desc>
8078	Directory to create.
8079	</desc>
8080	</param>
8081	<param name="userName" type="wstring" dir="in">
8082	<desc>
8083	User name under which the directory creation will be executed; the
8084	user has to exist and have the appropriate rights to create the
8085	desired directory.
8086	</desc>
8087	</param>
8088	<param name="password" type="wstring" dir="in">
8089	<desc>
8090	Password of the user account specified.
8091	</desc>
8092	</param>
8093	<param name="mode" type="unsigned long" dir="in">
8094	<desc>
8095	File mode.
8096	</desc>
8097	</param>
8098	<param name="flags" type="unsigned long" dir="in">
8099	<desc>
8100	Additional flags. Not used at the moment and must be set to 0.
8101	</desc>
8102	</param>
8103	<param name="progress" type="IProgress" dir="return">
8104	<desc>Progress object to track the operation completion.</desc>
8105	</param>
8106	</method>
8107
8108	<method name="setProcessInput">
8109	<desc>
8110	Sends input into a formerly started process.
8111
8112	<result name="VBOX_E_IPRT_ERROR">
8113	Could not send input.
8114	</result>
8115
8116	</desc>
8117	<param name="pid" type="unsigned long" dir="in">
8118	<desc>
8119	Process id returned by earlier executeProcess() call.
8120	</desc>
8121	</param>
8122	<param name="flags" type="unsigned long" dir="in">
8123	<desc>
8124	Not used, must be set to zero.
8125	</desc>
8126	</param>
8127	<param name="data" type="octet" dir="in" safearray="yes">
8128	<desc>
8129	Buffer of input data to send to the started process to.
8130	</desc>
8131	</param>
8132	<param name="written" type="unsigned long" dir="return">
8133	<desc>
8134	Number of bytes written.
8135	</desc>
8136	</param>
8137	</method>
8138
8139	<method name="updateGuestAdditions">
8140	<desc>
8141	Updates already installed Guest Additions in a VM
8142	(Windows guests only).
8143
8144	<result name="VBOX_E_IPRT_ERROR">
8145	Error while updating.
8146	</result>
8147
8148	</desc>
8149	<param name="source" type="wstring" dir="in">
8150	<desc>
8151	Path to the Guest Additions .ISO file to use for the upate.
8152	</desc>
8153	</param>
8154	<param name="flags" type="unsigned long" dir="in">
8155	<desc>
8156	Additional flags for update process. Not used at the moment and
8157	must be set to 0.
8158	</desc>
8159	</param>
8160	<param name="progress" type="IProgress" dir="return">
8161	<desc>Progress object to track the operation completion.</desc>
8162	</param>
8163	</method>
8164
8165	</interface>
8166
8167
8168	<!--
8169	// IProgress
8170	/////////////////////////////////////////////////////////////////////////
8171	-->
8172
8173	<interface
8174	name="IProgress" extends="$unknown"
8175	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8176	wsmap="managed"
8177	>
8178	<desc>
8179	The IProgress interface is used to track and control
8180	asynchronous tasks within VirtualBox.
8181
8182	An instance of this is returned every time VirtualBox starts
8183	an asynchronous task (in other words, a separate thread) which
8184	continues to run after a method call returns. For example,
8185	<link to="IConsole::saveState" />, which saves the state of
8186	a running virtual machine, can take a long time to complete.
8187	To be able to display a progress bar, a user interface such as
8188	the VirtualBox graphical user interface can use the IProgress
8189	object returned by that method.
8190
8191	Note that IProgress is a "read-only" interface in the sense
8192	that only the VirtualBox internals behind the Main API can
8193	create and manipulate progress objects, whereas client code
8194	can only use the IProgress object to monitor a task's
8195	progress and, if <link to="#cancelable" /> is @c true,
8196	cancel the task by calling <link to="#cancel" />.
8197
8198	A task represented by IProgress consists of either one or
8199	several sub-operations that run sequentially, one by one (see
8200	<link to="#operation" /> and <link to="#operationCount" />).
8201	Every operation is identified by a number (starting from 0)
8202	and has a separate description.
8203
8204	You can find the individual percentage of completion of the current
8205	operation in <link to="#operationPercent" /> and the
8206	percentage of completion of the task as a whole
8207	in <link to="#percent" />.
8208
8209	Similarly, you can wait for the completion of a particular
8210	operation via <link to="#waitForOperationCompletion" /> or
8211	for the completion of the whole task via
8212	<link to="#waitForCompletion" />.
8213	</desc>
8214
8215	<attribute name="id" type="uuid" mod="string" readonly="yes">
8216	<desc>ID of the task.</desc>
8217	</attribute>
8218
8219	<attribute name="description" type="wstring" readonly="yes">
8220	<desc>Description of the task.</desc>
8221	</attribute>
8222
8223	<attribute name="initiator" type="$unknown" readonly="yes">
8224	<desc>Initiator of the task.</desc>
8225	</attribute>
8226
8227	<attribute name="cancelable" type="boolean" readonly="yes">
8228	<desc>Whether the task can be interrupted.</desc>
8229	</attribute>
8230
8231	<attribute name="percent" type="unsigned long" readonly="yes">
8232	<desc>
8233	Current progress value of the task as a whole, in percent.
8234	This value depends on how many operations are already complete.
8235	Returns 100 if <link to="#completed" /> is @c true.
8236	</desc>
8237	</attribute>
8238
8239	<attribute name="timeRemaining" type="long" readonly="yes">
8240	<desc>
8241	Estimated remaining time until the task completes, in
8242	seconds. Returns 0 once the task has completed; returns -1
8243	if the remaining time cannot be computed, in particular if
8244	the current progress is 0.
8245
8246	Even if a value is returned, the estimate will be unreliable
8247	for low progress values. It will become more reliable as the
8248	task progresses; it is not recommended to display an ETA
8249	before at least 20% of a task have completed.
8250	</desc>
8251	</attribute>
8252
8253	<attribute name="completed" type="boolean" readonly="yes">
8254	<desc>Whether the task has been completed.</desc>
8255	</attribute>
8256
8257	<attribute name="canceled" type="boolean" readonly="yes">
8258	<desc>Whether the task has been canceled.</desc>
8259	</attribute>
8260
8261	<attribute name="resultCode" type="long" readonly="yes">
8262	<desc>
8263	Result code of the progress task.
8264	Valid only if <link to="#completed"/> is @c true.
8265	</desc>
8266	</attribute>
8267
8268	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8269	<desc>
8270	Extended information about the unsuccessful result of the
8271	progress operation. May be @c null if no extended information
8272	is available.
8273	Valid only if <link to="#completed"/> is @c true and
8274	<link to="#resultCode"/> indicates a failure.
8275	</desc>
8276	</attribute>
8277
8278	<attribute name="operationCount" type="unsigned long" readonly="yes">
8279	<desc>
8280	Number of sub-operations this task is divided into.
8281	Every task consists of at least one suboperation.
8282	</desc>
8283	</attribute>
8284
8285	<attribute name="operation" type="unsigned long" readonly="yes">
8286	<desc>Number of the sub-operation being currently executed.</desc>
8287	</attribute>
8288
8289	<attribute name="operationDescription" type="wstring" readonly="yes">
8290	<desc>
8291	Description of the sub-operation being currently executed.
8292	</desc>
8293	</attribute>
8294
8295	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8296	<desc>Progress value of the current sub-operation only, in percent.</desc>
8297	</attribute>
8298
8299	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8300	<desc>Weight value of the current sub-operation only.</desc>
8301	</attribute>
8302
8303	<attribute name="timeout" type="unsigned long">
8304	<desc>
8305	When non-zero, this specifies the number of milliseconds after which
8306	the operation will automatically be canceled. This can only be set on
8307	cancelable objects.
8308	</desc>
8309	</attribute>
8310
8311	<method name="setCurrentOperationProgress">
8312	<desc>Internal method, not to be called externally.</desc>
8313	<param name="percent" type="unsigned long" dir="in" />
8314	</method>
8315	<method name="setNextOperation">
8316	<desc>Internal method, not to be called externally.</desc>
8317	<param name="nextOperationDescription" type="wstring" dir="in" />
8318	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8319	</method>
8320
8321	<method name="waitForCompletion">
8322	<desc>
8323	Waits until the task is done (including all sub-operations)
8324	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8325
8326	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8327	thread are not processed while waiting. Neglecting event queues may
8328	have dire consequences (degrade performance, resource hogs,
8329	deadlocks, etc.), this is specially so for the main thread on
8330	platforms using XPCOM. Callers are adviced wait for short periods
8331	and service their event queues between calls, or to create a worker
8332	thread to do the waiting.
8333
8334	<result name="VBOX_E_IPRT_ERROR">
8335	Failed to wait for task completion.
8336	</result>
8337	</desc>
8338
8339	<param name="timeout" type="long" dir="in">
8340	<desc>
8341	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8342	</desc>
8343	</param>
8344	</method>
8345
8346	<method name="waitForOperationCompletion">
8347	<desc>
8348	Waits until the given operation is done with a given timeout in
8349	milliseconds; specify -1 for an indefinite wait.
8350
8351	See <link to="#waitForCompletion"> for event queue considerations.</link>
8352
8353	<result name="VBOX_E_IPRT_ERROR">
8354	Failed to wait for operation completion.
8355	</result>
8356
8357	</desc>
8358	<param name="operation" type="unsigned long" dir="in">
8359	<desc>
8360	Number of the operation to wait for.
8361	Must be less than <link to="#operationCount"/>.
8362	</desc>
8363	</param>
8364	<param name="timeout" type="long" dir="in">
8365	<desc>
8366	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8367	</desc>
8368	</param>
8369	</method>
8370
8371	<method name="cancel">
8372	<desc>
8373	Cancels the task.
8374	<note>
8375	If <link to="#cancelable"/> is @c false, then this method will fail.
8376	</note>
8377
8378	<result name="VBOX_E_INVALID_OBJECT_STATE">
8379	Operation cannot be canceled.
8380	</result>
8381
8382	</desc>
8383	</method>
8384
8385	</interface>
8386
8387	<!--
8388	// ISnapshot
8389	/////////////////////////////////////////////////////////////////////////
8390	-->
8391
8392	<interface
8393	name="ISnapshot" extends="$unknown"
8394	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8395	wsmap="managed"
8396	>
8397	<desc>
8398	The ISnapshot interface represents a snapshot of the virtual
8399	machine.
8400
8401	Together with the differencing media that are created
8402	when a snapshot is taken, a machine can be brought back to
8403	the exact state it was in when the snapshot was taken.
8404
8405	The ISnapshot interface has no methods, only attributes; snapshots
8406	are controlled through methods of the <link to="IConsole" /> interface
8407	which also manage the media associated with the snapshot.
8408	The following operations exist:
8409
8410	<ul>
8411	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8412	by creating new, empty differencing images for the machine's
8413	media and saving the VM settings and (if the VM is running)
8414	the current VM state in the snapshot.
8415
8416	The differencing images will then receive all data written to
8417	the machine's media, while their parent (base) images
8418	remain unmodified after the snapshot has been taken (see
8419	<link to="IMedium" /> for details about differencing images).
8420	This simplifies restoring a machine to the state of a snapshot:
8421	only the differencing images need to be deleted.
8422
8423	The current machine state is not changed by taking a snapshot.
8424	If the machine is running, it will resume execution after the
8425	snapshot has been taken. After calling this,
8426	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8427	just created.
8428	</li>
8429
8430	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8431	the state of a previous snapshot by deleting the differencing
8432	image of each of the machine's media and setting the machine's
8433	settings and state to the state that was saved in the snapshot (if any).
8434
8435	This destroys the machine's current state. After calling this,
8436	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8437	restored.
8438	</li>
8439
8440	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8441	without affecting the current machine state.
8442
8443	This does not change the current machine state, but instead frees the
8444	resources allocated when the snapshot was taken: the settings and machine
8445	state file are deleted (if any), and the snapshot's differencing image for
8446	each of the machine's media gets merged with its parent image.
8447
8448	Neither the current machine state nor other snapshots are affected
8449	by this operation, except that parent media will be modified
8450	to contain the disk data associated with the snapshot being deleted.
8451
8452	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8453	attribute is set to the current snapshot's parent or NULL if it
8454	has no parent. Otherwise the attribute is unchanged.
8455	</li>
8456	</ul>
8457
8458	Each snapshot contains the settings of the virtual machine (hardware
8459	configuration etc.). In addition, if the machine was running when the
8460	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8461	the current VM state is saved in the snapshot (similarly to what happens
8462	when a VM's state is saved). The snapshot is then said to
8463	be <i>online</i> because when restoring it, the VM will be running.
8464
8465	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8466	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8467
8468	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8469	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8470	it then contains a so-called "zero execution state", representing a
8471	machine that is powered off.
8472	</desc>
8473
8474	<attribute name="id" type="uuid" mod="string" readonly="yes">
8475	<desc>UUID of the snapshot.</desc>
8476	</attribute>
8477
8478	<attribute name="name" type="wstring">
8479	<desc>Short name of the snapshot.</desc>
8480	</attribute>
8481
8482	<attribute name="description" type="wstring">
8483	<desc>Optional description of the snapshot.</desc>
8484	</attribute>
8485
8486	<attribute name="timeStamp" type="long long" readonly="yes">
8487	<desc>
8488	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8489	</desc>
8490	</attribute>
8491
8492	<attribute name="online" type="boolean" readonly="yes">
8493	<desc>
8494	@c true if this snapshot is an online snapshot and @c false otherwise.
8495
8496	When this attribute is @c true, the
8497	<link to="IMachine::stateFilePath"/> attribute of the
8498	<link to="#machine"/> object associated with this snapshot
8499	will point to the saved state file. Otherwise, it will be
8500	an empty string.
8501	</desc>
8502	</attribute>
8503
8504	<attribute name="machine" type="IMachine" readonly="yes">
8505	<desc>
8506	Virtual machine this snapshot is taken on. This object
8507	stores all settings the machine had when taking this snapshot.
8508	<note>
8509	The returned machine object is immutable, i.e. no
8510	any settings can be changed.
8511	</note>
8512	</desc>
8513	</attribute>
8514
8515	<attribute name="parent" type="ISnapshot" readonly="yes">
8516	<desc>
8517	Parent snapshot (a snapshot this one is based on), or
8518	@c null if the snapshot has no parent (i.e. is the first snapshot).
8519	</desc>
8520	</attribute>
8521
8522	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8523	<desc>
8524	Child snapshots (all snapshots having this one as a parent).
8525	</desc>
8526	</attribute>
8527
8528	</interface>
8529
8530
8531	<!--
8532	// IMedium
8533	/////////////////////////////////////////////////////////////////////////
8534	-->
8535
8536	<enum
8537	name="MediumState"
8538	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8539	>
8540	<desc>
8541	Virtual medium state.
8542	<see>IMedium</see>
8543	</desc>
8544
8545	<const name="NotCreated" value="0">
8546	<desc>
8547	Associated medium storage does not exist (either was not created yet or
8548	was deleted).
8549	</desc>
8550	</const>
8551	<const name="Created" value="1">
8552	<desc>
8553	Associated storage exists and accessible; this gets set if the
8554	accessibility check performed by <link to="IMedium::refreshState" />
8555	was successful.
8556	</desc>
8557	</const>
8558	<const name="LockedRead" value="2">
8559	<desc>
8560	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8561	no data modification is possible.
8562	</desc>
8563	</const>
8564	<const name="LockedWrite" value="3">
8565	<desc>
8566	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8567	no concurrent data reading or modification is possible.
8568	</desc>
8569	</const>
8570	<const name="Inaccessible" value="4">
8571	<desc>
8572	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8573	not yet been performed, or else, associated medium storage is not
8574	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8575	is empty, in the second case, it describes the error that occurred.
8576	</desc>
8577	</const>
8578	<const name="Creating" value="5">
8579	<desc>
8580	Associated medium storage is being created.
8581	</desc>
8582	</const>
8583	<const name="Deleting" value="6">
8584	<desc>
8585	Associated medium storage is being deleted.
8586	</desc>
8587	</const>
8588	</enum>
8589
8590	<enum
8591	name="MediumType"
8592	uuid="19388a99-8e70-4bd4-9a95-90cbc513ef6d"
8593	>
8594	<desc>
8595	Virtual medium type.
8596	<see>IMedium</see>
8597	</desc>
8598
8599	<const name="Normal" value="0">
8600	<desc>
8601	Normal medium (attached directly or indirectly, preserved
8602	when taking snapshots).
8603	</desc>
8604	</const>
8605	<const name="Immutable" value="1">
8606	<desc>
8607	Immutable medium (attached indirectly, changes are wiped out
8608	the next time the virtual machine is started).
8609	</desc>
8610	</const>
8611	<const name="Writethrough" value="2">
8612	<desc>
8613	Write through medium (attached directly, ignored when
8614	taking snapshots).
8615	</desc>
8616	</const>
8617	<const name="Shareable" value="3">
8618	<desc>
8619	Allow using this medium concurrently by several machines.
8620	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8621	</desc>
8622	</const>
8623	<const name="Readonly" value="4">
8624	<desc>
8625	A readonly medium, which can of course be used by several machines.
8626	<note>Present and accepted since VirtualBox 4.0.</note>
8627	</desc>
8628	</const>
8629	</enum>
8630
8631	<enum
8632	name="MediumVariant"
8633	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8634	>
8635	<desc>
8636	Virtual medium image variant. More than one flag may be set.
8637	<see>IMedium</see>
8638	</desc>
8639
8640	<const name="Standard" value="0">
8641	<desc>
8642	No particular variant requested, results in using the backend default.
8643	</desc>
8644	</const>
8645	<const name="VmdkSplit2G" value="0x01">
8646	<desc>
8647	VMDK image split in chunks of less than 2GByte.
8648	</desc>
8649	</const>
8650	<const name="VmdkStreamOptimized" value="0x04">
8651	<desc>
8652	VMDK streamOptimized image. Special import/export format which is
8653	read-only/append-only.
8654	</desc>
8655	</const>
8656	<const name="VmdkESX" value="0x08">
8657	<desc>
8658	VMDK format variant used on ESX products.
8659	</desc>
8660	</const>
8661	<const name="Fixed" value="0x10000">
8662	<desc>
8663	Fixed image. Only allowed for base images.
8664	</desc>
8665	</const>
8666	<const name="Diff" value="0x20000">
8667	<desc>
8668	Differencing image. Only allowed for child images.
8669	</desc>
8670	</const>
8671	</enum>
8672
8673	<interface
8674	name="IMediumAttachment" extends="$unknown"
8675	uuid="c29452cc-ca72-404b-9261-cfc514f1e412"
8676	wsmap="struct"
8677	>
8678	<desc>
8679	The IMediumAttachment interface links storage media to virtual machines.
8680	For each medium (<link to="IMedium"/>) which has been attached to a
8681	storage controller (<link to="IStorageController"/>) of a machine
8682	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8683	method, one instance of IMediumAttachment is added to the machine's
8684	<link to="IMachine::mediumAttachments"/> array attribute.
8685
8686	Each medium attachment specifies the storage controller as well as a
8687	port and device number and the IMedium instance representing a virtual
8688	hard disk or floppy or DVD image.
8689
8690	For removeable media (DVDs or floppies), there are two additional
8691	options. For one, the IMedium instance can be @c null to represent
8692	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8693	secondly, the medium can be one of the pseudo-media for host drives
8694	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8695	</desc>
8696
8697	<attribute name="medium" type="IMedium" readonly="yes">
8698	<desc>Medium object associated with this attachment; it
8699	can be @c null for removable devices.</desc>
8700	</attribute>
8701
8702	<attribute name="controller" type="wstring" readonly="yes">
8703	<desc>Name of the storage controller of this attachment; this
8704	refers to one of the controllers in <link to="IMachine::storageControllers" />
8705	by name.</desc>
8706	</attribute>
8707
8708	<attribute name="port" type="long" readonly="yes">
8709	<desc>Port number of this attachment.
8710	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8711	</desc>
8712	</attribute>
8713
8714	<attribute name="device" type="long" readonly="yes">
8715	<desc>Device slot number of this attachment.
8716	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8717	</desc>
8718	</attribute>
8719
8720	<attribute name="type" type="DeviceType" readonly="yes">
8721	<desc>Device type of this attachment.</desc>
8722	</attribute>
8723
8724	<attribute name="passthrough" type="boolean" readonly="yes">
8725	<desc>Pass I/O requests through to a device on the host.</desc>
8726	</attribute>
8727
8728	<attribute name="bandwidthLimit" type="unsigned long">
8729	<desc>
8730	Maximum throughput allowed for this medium attachment, in units of 1 mbps.
8731	A zero value means uncapped/unlimited.
8732	</desc>
8733	</attribute>
8734
8735	</interface>
8736
8737	<interface
8738	name="IMedium" extends="$unknown"
8739	uuid="bfcf5b8c-5155-4f24-9414-9457054b16db"
8740	wsmap="managed"
8741	>
8742	<desc>
8743	The IMedium interface represents virtual storage for a machine's
8744	hard disks, CD/DVD or floppy drives. It will typically represent
8745	a disk image on the host, for example a VDI or VMDK file representing
8746	a virtual hard disk, or an ISO or RAW file representing virtual
8747	removable media, but can also point to a network location (e.g.
8748	for iSCSI targets).
8749
8750	Instances of IMedium are connected to virtual machines by way of
8751	medium attachments (see <link to="IMediumAttachment" />), which link
8752	the storage medium to a particular device slot of a storage controller
8753	of the virtual machine.
8754	In the VirtualBox API, virtual storage is therefore always represented
8755	by the following chain of object links:
8756
8757	<ul>
8758	<li><link to="IMachine::storageControllers"/> contains an array of
8759	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
8760	these are instances of <link to="IStorageController"/>).</li>
8761	<li><link to="IMachine::mediumAttachments"/> contains an array of
8762	medium attachments (instances of <link to="IMediumAttachment"/>),
8763	each containing a storage controller from the above array, a
8764	port/device specification, and an instance of IMedium representing
8765	the medium storage (image file).
8766
8767	For removable media, the storage medium is optional; a medium
8768	attachment with no medium represents a CD/DVD or floppy drive
8769	with no medium inserted. By contrast, hard disk attachments
8770	will always have an IMedium object attached.</li>
8771	<li>Each IMedium in turn points to a storage unit (such as a file
8772	on the host computer or a network resource) that holds actual
8773	data. This location is represented by the <link to="#location"/>
8774	attribute.</li>
8775	</ul>
8776
8777	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
8778	new hard disk media can be created with the VirtualBox API using the
8779	<link to="IVirtualBox::createHardDisk"/> method.
8780
8781	CD/DVD and floppy images (ISO and RAW files) are usually created outside
8782	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
8783	type in a regular file.
8784
8785	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
8786	drive; in that case the <link to="#id" /> attribute contains the UUID of
8787	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
8788
8789	<h3>Known media</h3>
8790
8791	When an existing medium is opened and attached to a virtual machine, it
8792	is automatically added to a media registry. If the medium has first
8793	been attached to a machine which was created by VirtualBox 4.0 or later,
8794	it is added to that machine's media registry (in the machine XML settings
8795	file; this way all information about a machine's media attachments is
8796	contained in a single file). For older media attachments (i.e. if the
8797	medium was first attached to a machine which was created with a VirtualBox
8798	version before 4.0), media continue to be registered in the global
8799	VirtualBox settings file, for backwards compatibility.
8800
8801	See <link to="IVirtualBox::openMedium" /> for more information.
8802
8803	All known media can be enumerated using
8804	<link to="IVirtualBox::hardDisks"/>,
8805	<link to="IVirtualBox::DVDImages"/> and
8806	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
8807	quickly found using the <link to="IVirtualBox::findMedium"/> method.
8808
8809	Only known media can be attached to virtual machines.
8810
8811	Removing known media from the media registry is performed when the given
8812	medium is closed using the <link to="#close"/> method or when its
8813	associated storage unit is deleted.
8814
8815	<h3>Accessibility checks</h3>
8816
8817	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
8818	method is called explicitly on a medium. This is done to make the VirtualBox object
8819	ready for serving requests as fast as possible and let the end-user
8820	application decide if it needs to check media accessibility right away or not.
8821
8822	As a result, when VirtualBox starts up (e.g. the VirtualBox
8823	object gets created for the first time), all known media are in the
8824	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
8825	attribute is an empty string because no actual accessibility check has
8826	been made yet.
8827
8828	After calling <link to="#refreshState" />, a medium is considered
8829	<i>accessible</i> if its storage unit can be read. In that case, the
8830	<link to="#state"/> attribute has a value of "Created". If the storage
8831	unit cannot be read (for example, because it is located on a disconnected
8832	network resource, or was accidentally deleted outside VirtualBox),
8833	the medium is considered <i>inaccessible</i>, which is indicated by the
8834	"Inaccessible" state. The exact reason why the medium is inaccessible can be
8835	obtained by reading the <link to="#lastAccessError"/> attribute.
8836
8837	<h3>Medium types</h3>
8838
8839	There are four types of medium behavior (see <link to="MediumType" />):
8840	"normal", "immutable", "writethrough" and "shareable", represented by the
8841	<link to="#type"/> attribute. The type of the medium defines how the
8842	medium is attached to a virtual machine and what happens when a
8843	<link to="ISnapshot">snapshot</link> of the virtual machine with the
8844	attached medium is taken. At the moment DVD and floppy media are always
8845	of type "writethrough".
8846
8847	All media can be also divided in two groups: <i>base</i> media and
8848	<i>differencing</i> media. A base medium contains all sectors of the
8849	medium data in its own storage and therefore can be used independently.
8850	In contrast, a differencing medium is a "delta" to some other medium and
8851	contains only those sectors which differ from that other medium, which is
8852	then called a <i>parent</i>. The differencing medium is said to be
8853	<i>linked to</i> that parent. The parent may be itself a differencing
8854	medium, thus forming a chain of linked media. The last element in that
8855	chain must always be a base medium. Note that several differencing
8856	media may be linked to the same parent medium.
8857
8858	Differencing media can be distinguished from base media by querying the
8859	<link to="#parent"/> attribute: base media do not have parents they would
8860	depend on, so the value of this attribute is always @c null for them.
8861	Using this attribute, it is possible to walk up the medium tree (from the
8862	child medium to its parent). It is also possible to walk down the tree
8863	using the <link to="#children"/> attribute.
8864
8865	Note that the type of all differencing media is "normal"; all other
8866	values are meaningless for them. Base media may be of any type.
8867
8868	<h3>Creating hard disks</h3>
8869
8870	New base hard disks are created using
8871	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
8872	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
8873	disks are usually implicitly created by VirtualBox when needed but may
8874	also be created explicitly using <link to="#createDiffStorage"/>.
8875
8876	After the hard disk is successfully created (including the storage unit)
8877	or opened, it becomes a known hard disk (remembered in the internal media
8878	registry). Known hard disks can be attached to a virtual machine, accessed
8879	through <link to="IVirtualBox::findMedium"/> or enumerated using the
8880	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
8881
8882	The following methods, besides <link to="IMedium::close"/>,
8883	automatically remove the hard disk from the media registry:
8884	<ul>
8885	<li><link to="#deleteStorage"/></li>
8886	<li><link to="#mergeTo"/></li>
8887	</ul>
8888
8889	If the storage unit of the hard disk is a regular file in the host's
8890	file system then the rules stated in the description of the
8891	<link to="IMedium::location"/> attribute apply when setting its value.
8892
8893	<h4>Automatic composition of the file name part</h4>
8894
8895	Another extension to the <link to="IMedium::location"/> attribute is that
8896	there is a possibility to cause VirtualBox to compose a unique value for
8897	the file name part of the location using the UUID of the hard disk. This
8898	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
8899	e.g. before the storage unit is created, and works as follows. You set the
8900	value of the <link to="IMedium::location"/> attribute to a location
8901	specification which only contains the path specification but not the file
8902	name part and ends with either a forward slash or a backslash character.
8903	In response, VirtualBox will generate a new UUID for the hard disk and
8904	compose the file name using the following pattern:
8905	<pre>
8906	<path>/{<uuid>}.<ext>
8907	</pre>
8908	where <tt><path></tt> is the supplied path specification,
8909	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
8910	is the default extension for the storage format of this hard disk. After
8911	that, you may call any of the methods that create a new hard disk storage
8912	unit and they will use the generated UUID and file name.
8913
8914	<h3>Attaching Hard Disks</h3>
8915
8916	Hard disks are attached to virtual machines using the
8917	<link to="IMachine::attachDevice"/> method and detached using the
8918	<link to="IMachine::detachDevice"/> method. Depending on their
8919	<link to="#type"/>, hard disks are attached either
8920	<i>directly</i> or <i>indirectly</i>.
8921
8922	When a hard disk is being attached directly, it is associated with the
8923	virtual machine and used for hard disk operations when the machine is
8924	running. When a hard disk is being attached indirectly, a new differencing
8925	hard disk linked to it is implicitly created and this differencing hard
8926	disk is associated with the machine and used for hard disk operations.
8927	This also means that if <link to="IMachine::attachDevice"/> performs
8928	a direct attachment then the same hard disk will be returned in response
8929	to the subsequent <link to="IMachine::getMedium"/> call; however if
8930	an indirect attachment is performed then
8931	<link to="IMachine::getMedium"/> will return the implicitly created
8932	differencing hard disk, not the original one passed to <link
8933	to="IMachine::attachDevice"/>. In detail:
8934
8935	<ul>
8936	<li><b>Normal base</b> hard disks that do not have children (i.e.
8937	differencing hard disks linked to them) and that are not already
8938	attached to virtual machines in snapshots are attached <b>directly</b>.
8939	Otherwise, they are attached <b>indirectly</b> because having
8940	dependent children or being part of the snapshot makes it impossible
8941	to modify hard disk contents without breaking the integrity of the
8942	dependent party. The <link to="#readOnly"/> attribute allows to
8943	quickly determine the kind of the attachment for the given hard
8944	disk. Note that if a normal base hard disk is to be indirectly
8945	attached to a virtual machine with snapshots then a special
8946	procedure called <i>smart attachment</i> is performed (see below).</li>
8947	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
8948	they are attached <b>directly</b> if they do not have children and are
8949	not attached to virtual machines in snapshots, and <b>indirectly</b>
8950	otherwise. Note that the smart attachment procedure is never performed
8951	for differencing hard disks.</li>
8952	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
8953	they are designed to be non-writable. If an immutable hard disk is
8954	attached to a virtual machine with snapshots then a special
8955	procedure called smart attachment is performed (see below).</li>
8956	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
8957	also as designed. This also means that writethrough hard disks cannot
8958	have other hard disks linked to them at all.</li>
8959	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
8960	also as designed. This also means that shareable hard disks cannot
8961	have other hard disks linked to them at all. They behave almost
8962	like writethrough hard disks, except that shareable hard disks can
8963	be attached to several virtual machines which are running, allowing
8964	concurrent accesses. You need special cluster software running in
8965	the virtual machines to make use of such disks.</li>
8966	</ul>
8967
8968	Note that the same hard disk, regardless of its type, may be attached to
8969	more than one virtual machine at a time. In this case, the machine that is
8970	started first gains exclusive access to the hard disk and attempts to
8971	start other machines having this hard disk attached will fail until the
8972	first machine is powered down.
8973
8974	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
8975	that the given hard disk remains associated with the given machine after a
8976	successful <link to="IMachine::detachDevice"/> call until
8977	<link to="IMachine::saveSettings"/> is called to save all changes to
8978	machine settings to disk. This deferring is necessary to guarantee that
8979	the hard disk configuration may be restored at any time by a call to
8980	<link to="IMachine::discardSettings"/> before the settings
8981	are saved (committed).
8982
8983	Note that if <link to="IMachine::discardSettings"/> is called after
8984	indirectly attaching some hard disks to the machine but before a call to
8985	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
8986	all differencing hard disks implicitly created by
8987	<link to="IMachine::attachDevice"/> for these indirect attachments.
8988	Such implicitly created hard disks will also be immediately deleted when
8989	detached explicitly using the <link to="IMachine::detachDevice"/>
8990	call if it is made before <link to="IMachine::saveSettings"/>. This
8991	implicit deletion is safe because newly created differencing hard
8992	disks do not contain any user data.
8993
8994	However, keep in mind that detaching differencing hard disks that were
8995	implicitly created by <link to="IMachine::attachDevice"/>
8996	before the last <link to="IMachine::saveSettings"/> call will
8997	<b>not</b> implicitly delete them as they may already contain some data
8998	(for example, as a result of virtual machine execution). If these hard
8999	disks are no more necessary, the caller can always delete them explicitly
9000	using <link to="#deleteStorage"/> after they are actually de-associated
9001	from this machine by the <link to="IMachine::saveSettings"/> call.
9002
9003	<h3>Smart Attachment</h3>
9004
9005	When normal base or immutable hard disks are indirectly attached to a
9006	virtual machine then some additional steps are performed to make sure the
9007	virtual machine will have the most recent "view" of the hard disk being
9008	attached. These steps include walking through the machine's snapshots
9009	starting from the current one and going through ancestors up to the first
9010	snapshot. Hard disks attached to the virtual machine in all
9011	of the encountered snapshots are checked whether they are descendants of
9012	the given normal base or immutable hard disk. The first found child (which
9013	is the differencing hard disk) will be used instead of the normal base or
9014	immutable hard disk as a parent for creating a new differencing hard disk
9015	that will be actually attached to the machine. And only if no descendants
9016	are found or if the virtual machine does not have any snapshots then the
9017	normal base or immutable hard disk will be used itself as a parent for
9018	this differencing hard disk.
9019
9020	It is easier to explain what smart attachment does using the
9021	following example:
9022	<pre>
9023	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9024
9025	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9026	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9027	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9028	Snapshot 4 (none) Snapshot 4 (none)
9029	CurState (none) CurState (D3->D2.vdi)
9030
9031	NOT
9032	...
9033	CurState (D3->B.vdi)
9034	</pre>
9035	The first column is the virtual machine configuration before the base hard
9036	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9037	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9038	mean that the hard disk that is actually attached to the machine is a
9039	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9040	another hard disk, <tt>B.vdi</tt>.
9041
9042	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9043	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9044	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9045	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9046	it cannot be attached directly and needs an indirect attachment (i.e.
9047	implicit creation of a new differencing hard disk). Due to the smart
9048	attachment procedure, the new differencing hard disk
9049	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9050	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9051	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9052	machine.
9053
9054	Note that if there is more than one descendant hard disk of the given base
9055	hard disk found in a snapshot, and there is an exact device, channel and
9056	bus match, then this exact match will be used. Otherwise, the youngest
9057	descendant will be picked up.
9058
9059	There is one more important aspect of the smart attachment procedure which
9060	is not related to snapshots at all. Before walking through the snapshots
9061	as described above, the backup copy of the current list of hard disk
9062	attachment is searched for descendants. This backup copy is created when
9063	the hard disk configuration is changed for the first time after the last
9064	<link to="IMachine::saveSettings"/> call and used by
9065	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9066	changes. When such a descendant is found in this backup copy, it will be
9067	simply re-attached back, without creating a new differencing hard disk for
9068	it. This optimization is necessary to make it possible to re-attach the
9069	base or immutable hard disk to a different bus, channel or device slot
9070	without losing the contents of the differencing hard disk actually
9071	attached to the machine in place of it.
9072	</desc>
9073
9074	<attribute name="id" type="uuid" mod="string" readonly="yes">
9075	<desc>
9076	UUID of the medium. For a newly created medium, this value is a randomly
9077	generated UUID.
9078
9079	<note>
9080	For media in one of MediumState_NotCreated, MediumState_Creating or
9081	MediumState_Deleting states, the value of this property is undefined
9082	and will most likely be an empty UUID.
9083	</note>
9084	</desc>
9085	</attribute>
9086
9087	<attribute name="description" type="wstring">
9088	<desc>
9089	Optional description of the medium. For a newly created medium the value
9090	of this attribute is an empty string.
9091
9092	Medium types that don't support this attribute will return E_NOTIMPL in
9093	attempt to get or set this attribute's value.
9094
9095	<note>
9096	For some storage types, reading this attribute may return an outdated
9097	(last known) value when <link to="#state"/> is <link
9098	to="MediumState_Inaccessible"/> or <link
9099	to="MediumState_LockedWrite"/> because the value of this attribute is
9100	stored within the storage unit itself. Also note that changing the
9101	attribute value is not possible in such case, as well as when the
9102	medium is the <link to="MediumState_LockedRead"/> state.
9103	</note>
9104	</desc>
9105	</attribute>
9106
9107	<attribute name="state" type="MediumState" readonly="yes">
9108	<desc>
9109	Returns the current medium state, which is the last state set by
9110	the accessibility check performed by <link to="#refreshState"/>.
9111	If that method has not yet been called on the medium, the state
9112	is "Inaccessible"; as opposed to truly inaccessible media, the
9113	value of <link to="#lastAccessError"/> will be an empty string in
9114	that case.
9115
9116	<note>As of version 3.1, this no longer performs an accessibility check
9117	automatically; call <link to="#refreshState"/> for that.
9118	</note>
9119	</desc>
9120	</attribute>
9121
9122	<attribute name="variant" type="MediumVariant" readonly="yes">
9123	<desc>
9124	Returns the storage format variant information for this medium.
9125	Before <link to="#refreshState"/> is called this method returns
9126	an undefined value.
9127	</desc>
9128	</attribute>
9129
9130	<attribute name="location" type="wstring">
9131	<desc>
9132	Location of the storage unit holding medium data.
9133
9134	The format of the location string is medium type specific. For medium
9135	types using regular files in a host's file system, the location
9136	string is the full file name.
9137
9138	Some medium types may support changing the storage unit location by
9139	simply changing the value of this property. If this operation is not
9140	supported, the implementation will return E_NOTIMPL in attempt to set
9141	this attribute's value.
9142
9143	When setting a value of the location attribute which is a regular file
9144	in the host's file system, the given file name may be either relative to
9145	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9146	absolute. Note that if the given location specification does not contain
9147	the file extension part then a proper default extension will be
9148	automatically appended by the implementation depending on the medium type.
9149	</desc>
9150	</attribute>
9151
9152	<attribute name="name" type="wstring" readonly="yes">
9153	<desc>
9154	Name of the storage unit holding medium data.
9155
9156	The returned string is a short version of the <link to="#location"/>
9157	attribute that is suitable for representing the medium in situations
9158	where the full location specification is too long (such as lists
9159	and comboboxes in GUI frontends). This string is also used by frontends
9160	to sort the media list alphabetically when needed.
9161
9162	For example, for locations that are regular files in the host's file
9163	system, the value of this attribute is just the file name (+ extension),
9164	without the path specification.
9165
9166	Note that as opposed to the <link to="#location"/> attribute, the name
9167	attribute will not necessary be unique for a list of media of the
9168	given type and format.
9169	</desc>
9170	</attribute>
9171
9172	<attribute name="deviceType" type="DeviceType" readonly="yes">
9173	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9174	medium.</desc>
9175	</attribute>
9176
9177	<attribute name="hostDrive" type="boolean" readonly="yes">
9178	<desc>True if this corresponds to a drive on the host.</desc>
9179	</attribute>
9180
9181	<attribute name="size" type="long long" readonly="yes">
9182	<desc>
9183	Physical size of the storage unit used to hold medium data (in bytes).
9184
9185	<note>
9186	For media whose <link to="#state"/> is <link
9187	to="MediumState_Inaccessible"/>, the value of this property is the
9188	last known size. For <link to="MediumState_NotCreated"/> media,
9189	the returned value is zero.
9190	</note>
9191	</desc>
9192	</attribute>
9193
9194	<attribute name="format" type="wstring" readonly="yes">
9195	<desc>
9196	Storage format of this medium.
9197
9198	The value of this attribute is a string that specifies a backend used
9199	to store medium data. The storage format is defined when you create a
9200	new medium or automatically detected when you open an existing medium,
9201	and cannot be changed later.
9202
9203	The list of all storage formats supported by this VirtualBox
9204	installation can be obtained using
9205	<link to="ISystemProperties::mediumFormats"/>.
9206	</desc>
9207	</attribute>
9208
9209	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9210	<desc>
9211	Storage medium format object corresponding to this medium.
9212
9213	The value of this attribute is a reference to the medium format object
9214	that specifies the backend properties used to store medium data. The
9215	storage format is defined when you create a new medium or automatically
9216	detected when you open an existing medium, and cannot be changed later.
9217
9218	<note>@c null is returned if there is no associated medium format
9219	object. This can e.g. happen for medium objects representing host
9220	drives and other special medium objects.</note>
9221	</desc>
9222	</attribute>
9223
9224	<attribute name="type" type="MediumType">
9225	<desc>
9226	Type (role) of this medium.
9227
9228	The following constraints apply when changing the value of this
9229	attribute:
9230	<ul>
9231	<li>If a medium is attached to a virtual machine (either in the
9232	current state or in one of the snapshots), its type cannot be
9233	changed.
9234	</li>
9235	<li>As long as the medium has children, its type cannot be set
9236	to <link to="MediumType_Writethrough"/>.
9237	</li>
9238	<li>The type of all differencing media is
9239	<link to="MediumType_Normal"/> and cannot be changed.
9240	</li>
9241	</ul>
9242
9243	The type of a newly created or opened medium is set to
9244	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9245	which have a type of <link to="MediumType_Writethrough"/>.
9246	</desc>
9247	</attribute>
9248
9249	<attribute name="parent" type="IMedium" readonly="yes">
9250	<desc>
9251	Parent of this medium (the medium this medium is directly based
9252	on).
9253
9254	Only differencing media have parents. For base (non-differencing)
9255	media, @c null is returned.
9256	</desc>
9257	</attribute>
9258
9259	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9260	<desc>
9261	Children of this medium (all differencing media directly based
9262	on this medium). A @c null array is returned if this medium
9263	does not have any children.
9264	</desc>
9265	</attribute>
9266
9267	<attribute name="base" type="IMedium" readonly="yes">
9268	<desc>
9269	Base medium of this medium.
9270
9271	If this is a differencing medium, its base medium is the medium
9272	the given medium branch starts from. For all other types of media, this
9273	property returns the medium object itself (i.e. the same object this
9274	property is read on).
9275	</desc>
9276	</attribute>
9277
9278	<attribute name="readOnly" type="boolean" readonly="yes">
9279	<desc>
9280	Returns @c true if this medium is read-only and @c false otherwise.
9281
9282	A medium is considered to be read-only when its contents cannot be
9283	modified without breaking the integrity of other parties that depend on
9284	this medium such as its child media or snapshots of virtual machines
9285	where this medium is attached to these machines. If there are no
9286	children and no such snapshots then there is no dependency and the
9287	medium is not read-only.
9288
9289	The value of this attribute can be used to determine the kind of the
9290	attachment that will take place when attaching this medium to a
9291	virtual machine. If the value is @c false then the medium will
9292	be attached directly. If the value is @c true then the medium
9293	will be attached indirectly by creating a new differencing child
9294	medium for that. See the interface description for more information.
9295
9296	Note that all <link to="MediumType_Immutable">Immutable</link> media
9297	are always read-only while all
9298	<link to="MediumType_Writethrough">Writethrough</link> media are
9299	always not.
9300
9301	<note>
9302	The read-only condition represented by this attribute is related to
9303	the medium type and usage, not to the current
9304	<link to="IMedium::state">medium state</link> and not to the read-only
9305	state of the storage unit.
9306	</note>
9307	</desc>
9308	</attribute>
9309
9310	<attribute name="logicalSize" type="long long" readonly="yes">
9311	<desc>
9312	Logical size of this medium (in bytes), as reported to the
9313	guest OS running inside the virtual machine this medium is
9314	attached to. The logical size is defined when the medium is created
9315	and cannot be changed later.
9316
9317	<note>
9318	Reading this property on a differencing medium will return the size
9319	of its <link to="#base"/> medium.
9320	</note>
9321	<note>
9322	For media whose state is <link to="#state"/> is <link
9323	to="MediumState_Inaccessible"/>, the value of this property is the
9324	last known logical size. For <link to="MediumState_NotCreated"/>
9325	media, the returned value is zero.
9326	</note>
9327	</desc>
9328	</attribute>
9329
9330	<attribute name="autoReset" type="boolean">
9331	<desc>
9332	Whether this differencing medium will be automatically reset each
9333	time a virtual machine it is attached to is powered up. This
9334	attribute is automatically set to @c true for the last
9335	differencing image of an "immutable" medium (see
9336	<link to="MediumType" />).
9337
9338	See <link to="#reset"/> for more information about resetting
9339	differencing media.
9340
9341	<note>
9342	Reading this property on a base (non-differencing) medium will
9343	always @c false. Changing the value of this property in this
9344	case is not supported.
9345	</note>
9346
9347	<result name="VBOX_E_NOT_SUPPORTED">
9348	This is not a differencing medium (when changing the attribute
9349	value).
9350	</result>
9351	</desc>
9352	</attribute>
9353
9354	<attribute name="lastAccessError" type="wstring" readonly="yes">
9355	<desc>
9356	Text message that represents the result of the last accessibility
9357	check performed by <link to="#refreshState"/>.
9358
9359	An empty string is returned if the last accessibility check
9360	was successful or has not yet been called. As a result, if
9361	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9362	then <link to="#refreshState"/> has yet to be called; this is the
9363	default value of media after VirtualBox initialization.
9364	A non-empty string indicates a failure and should normally describe
9365	a reason of the failure (for example, a file read error).
9366	</desc>
9367	</attribute>
9368
9369	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9370	<desc>
9371	Array of UUIDs of all machines this medium is attached to.
9372
9373	A @c null array is returned if this medium is not attached to any
9374	machine or to any machine's snapshot.
9375
9376	<note>
9377	The returned array will include a machine even if this medium is not
9378	attached to that machine in the current state but attached to it in
9379	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9380	details.
9381	</note>
9382	</desc>
9383	</attribute>
9384
9385	<method name="setIDs">
9386	<desc>
9387	Changes the UUID and parent UUID for a hard disk medium.
9388	</desc>
9389	<param name="setImageId" type="boolean" dir="in">
9390	<desc>
9391	Select whether a new image UUID is set or not.
9392	</desc>
9393	</param>
9394	<param name="imageId" type="uuid" mod="string" dir="in">
9395	<desc>
9396	New UUID for the image. If an empty string is passed, then a new
9397	UUID is automatically created, provided that @a setImageId is @c true.
9398	Specifying a zero UUID is not allowed.
9399	</desc>
9400	</param>
9401	<param name="setParentId" type="boolean" dir="in">
9402	<desc>
9403	Select whether a new parent UUID is set or not.
9404	</desc>
9405	</param>
9406	<param name="parentId" type="uuid" mod="string" dir="in">
9407	<desc>
9408	New parent UUID for the image. If an empty string is passed, then a
9409	new UUID is automatically created, provided @a setParentId is
9410	@c true. A zero UUID is valid.
9411	</desc>
9412	</param>
9413	<result name="E_INVALIDARG">
9414	Invalid parameter combination.
9415	</result>
9416	<result name="VBOX_E_NOT_SUPPORTED">
9417	Medium is not a hard disk medium.
9418	</result>
9419	</method>
9420
9421	<method name="refreshState">
9422	<desc>
9423	If the current medium state (see <link to="MediumState"/>) is one of
9424	"Created", "Inaccessible" or "LockedRead", then this performs an
9425	accessibility check on the medium and sets the value of the <link to="#state"/>
9426	attribute accordingly; that value is also returned for convenience.
9427
9428	For all other state values, this does not perform a refresh but returns
9429	the state only.
9430
9431	The refresh, if performed, may take a long time (several seconds or even
9432	minutes, depending on the storage unit location and format) because it performs an
9433	accessibility check of the storage unit. This check may cause a significant
9434	delay if the storage unit of the given medium is, for example, a file located
9435	on a network share which is not currently accessible due to connectivity
9436	problems. In that case, the call will not return until a timeout
9437	interval defined by the host OS for this operation expires. For this reason,
9438	it is recommended to never read this attribute on the main UI thread to avoid
9439	making the UI unresponsive.
9440
9441	If the last known state of the medium is "Created" and the accessibility
9442	check fails, then the state would be set to "Inaccessible", and
9443	<link to="#lastAccessError"/> may be used to get more details about the
9444	failure. If the state of the medium is "LockedRead", then it remains the
9445	same, and a non-empty value of <link to="#lastAccessError"/> will
9446	indicate a failed accessibility check in this case.
9447
9448	Note that not all medium states are applicable to all medium types.
9449	</desc>
9450	<param name="state" type="MediumState" dir="return">
9451	<desc>
9452	New medium state.
9453	</desc>
9454	</param>
9455	</method>
9456
9457	<method name="getSnapshotIds">
9458	<desc>
9459	Returns an array of UUIDs of all snapshots of the given machine where
9460	this medium is attached to.
9461
9462	If the medium is attached to the machine in the current state, then the
9463	first element in the array will always be the ID of the queried machine
9464	(i.e. the value equal to the @c machineId argument), followed by
9465	snapshot IDs (if any).
9466
9467	If the medium is not attached to the machine in the current state, then
9468	the array will contain only snapshot IDs.
9469
9470	The returned array may be @c null if this medium is not attached
9471	to the given machine at all, neither in the current state nor in one of
9472	the snapshots.
9473	</desc>
9474	<param name="machineId" type="uuid" mod="string" dir="in">
9475	<desc>
9476	UUID of the machine to query.
9477	</desc>
9478	</param>
9479	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9480	<desc>
9481	Array of snapshot UUIDs of the given machine using this medium.
9482	</desc>
9483	</param>
9484	</method>
9485
9486	<method name="lockRead">
9487	<desc>
9488	Locks this medium for reading.
9489
9490	A read lock is shared: many clients can simultaneously lock the
9491	same medium for reading unless it is already locked for writing (see
9492	<link to="#lockWrite"/>) in which case an error is returned.
9493
9494	When the medium is locked for reading, it cannot be modified
9495	from within VirtualBox. This means that any method that changes
9496	the properties of this medium or contents of the storage unit
9497	will return an error (unless explicitly stated otherwise). That
9498	includes an attempt to start a virtual machine that wants to
9499	write to the the medium.
9500
9501	When the virtual machine is started up, it locks for reading all
9502	media it uses in read-only mode. If some medium cannot be locked
9503	for reading, the startup procedure will fail.
9504	A medium is typically locked for reading while it is used by a running
9505	virtual machine but has a depending differencing image that receives
9506	the actual write operations. This way one base medium can have
9507	multiple child differencing images which can be written to
9508	simultaneously. Read-only media such as DVD and floppy images are
9509	also locked for reading only (so they can be in use by multiple
9510	machines simultaneously).
9511
9512	A medium is also locked for reading when it is the source of a
9513	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9514
9515	The medium locked for reading must be unlocked using the <link
9516	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9517	can be nested and must be followed by the same number of paired
9518	<link to="#unlockRead"/> calls.
9519
9520	This method sets the medium state (see <link to="#state"/>) to
9521	"LockedRead" on success. The medium's previous state must be
9522	one of "Created", "Inaccessible" or "LockedRead".
9523
9524	Locking an inaccessible medium is not an error; this method performs
9525	a logical lock that prevents modifications of this medium through
9526	the VirtualBox API, not a physical file-system lock of the underlying
9527	storage unit.
9528
9529	This method returns the current state of the medium
9530	<i>before</i> the operation.
9531
9532	<result name="VBOX_E_INVALID_OBJECT_STATE">
9533	Invalid medium state (e.g. not created, locked, inaccessible,
9534	creating, deleting).
9535	</result>
9536
9537	</desc>
9538	<param name="state" type="MediumState" dir="return">
9539	<desc>
9540	State of the medium after the operation.
9541	</desc>
9542	</param>
9543	</method>
9544
9545	<method name="unlockRead">
9546	<desc>
9547	Cancels the read lock previously set by <link to="#lockRead"/>.
9548
9549	For both success and failure, this method returns the current state
9550	of the medium <i>after</i> the operation.
9551
9552	See <link to="#lockRead"/> for more details.
9553
9554	<result name="VBOX_E_INVALID_OBJECT_STATE">
9555	Medium not locked for reading.
9556	</result>
9557
9558	</desc>
9559	<param name="state" type="MediumState" dir="return">
9560	<desc>
9561	State of the medium after the operation.
9562	</desc>
9563	</param>
9564	</method>
9565
9566	<method name="lockWrite">
9567	<desc>
9568	Locks this medium for writing.
9569
9570	A write lock, as opposed to <link to="#lockRead"/>, is
9571	exclusive: there may be only one client holding a write lock,
9572	and there may be no read locks while the write lock is held.
9573	As a result, read-locking fails if a write lock is held, and
9574	write-locking fails if either a read or another write lock is held.
9575
9576	When a medium is locked for writing, it cannot be modified
9577	from within VirtualBox, and it is not guaranteed that the values
9578	of its properties are up-to-date. Any method that changes the
9579	properties of this medium or contents of the storage unit will
9580	return an error (unless explicitly stated otherwise).
9581
9582	When a virtual machine is started up, it locks for writing all
9583	media it uses to write data to. If any medium could not be locked
9584	for writing, the startup procedure will fail. If a medium has
9585	differencing images, then while the machine is running, only
9586	the last ("leaf") differencing image is locked for writing,
9587	whereas its parents are locked for reading only.
9588
9589	A medium is also locked for writing when it is the target of a
9590	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9591
9592	The medium locked for writing must be unlocked using the <link
9593	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9594
9595	This method sets the medium state (see <link to="#state"/>) to
9596	"LockedWrite" on success. The medium's previous state must be
9597	either "Created" or "Inaccessible".
9598
9599	Locking an inaccessible medium is not an error; this method performs
9600	a logical lock that prevents modifications of this medium through
9601	the VirtualBox API, not a physical file-system lock of the underlying
9602	storage unit.
9603
9604	For both, success and failure, this method returns the current
9605	state of the medium <i>before</i> the operation.
9606
9607	<result name="VBOX_E_INVALID_OBJECT_STATE">
9608	Invalid medium state (e.g. not created, locked, inaccessible,
9609	creating, deleting).
9610	</result>
9611
9612	</desc>
9613	<param name="state" type="MediumState" dir="return">
9614	<desc>
9615	State of the medium after the operation.
9616	</desc>
9617	</param>
9618	</method>
9619
9620	<method name="unlockWrite">
9621	<desc>
9622	Cancels the write lock previously set by <link to="#lockWrite"/>.
9623
9624	For both success and failure, this method returns the current
9625	state of the medium <i>after</i> the operation.
9626
9627	See <link to="#lockWrite"/> for more details.
9628
9629	<result name="VBOX_E_INVALID_OBJECT_STATE">
9630	Medium not locked for writing.
9631	</result>
9632
9633	</desc>
9634	<param name="state" type="MediumState" dir="return">
9635	<desc>
9636	State of the medium after the operation.
9637	</desc>
9638	</param>
9639	</method>
9640
9641	<method name="close">
9642	<desc>
9643	Closes this medium.
9644
9645	The medium must not be attached to any known virtual machine
9646	and must not have any known child media, otherwise the
9647	operation will fail.
9648
9649	When the medium is successfully closed, it is removed from
9650	the list of registered media, but its storage unit is not
9651	deleted. In particular, this means that this medium can
9652	later be opened again using the <link to="IVirtualBox::openMedium"/>
9653	call.
9654
9655	Note that after this method successfully returns, the given medium
9656	object becomes uninitialized. This means that any attempt
9657	to call any of its methods or attributes will fail with the
9658	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9659
9660	<result name="VBOX_E_INVALID_OBJECT_STATE">
9661	Invalid medium state (other than not created, created or
9662	inaccessible).
9663	</result>
9664	<result name="VBOX_E_OBJECT_IN_USE">
9665	Medium attached to virtual machine.
9666	</result>
9667	<result name="VBOX_E_FILE_ERROR">
9668	Settings file not accessible.
9669	</result>
9670	<result name="VBOX_E_XML_ERROR">
9671	Could not parse the settings file.
9672	</result>
9673
9674	</desc>
9675	</method>
9676
9677	<!-- storage methods -->
9678
9679	<method name="getProperty">
9680	<desc>
9681	Returns the value of the custom medium property with the given name.
9682
9683	The list of all properties supported by the given medium format can
9684	be obtained with <link to="IMediumFormat::describeProperties"/>.
9685
9686	Note that if this method returns an empty string in @a value, the
9687	requested property is supported but currently not assigned any value.
9688
9689	<result name="VBOX_E_OBJECT_NOT_FOUND">
9690	Requested property does not exist (not supported by the format).
9691	</result>
9692	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9693	</desc>
9694	<param name="name" type="wstring" dir="in">
9695	<desc>Name of the property to get.</desc>
9696	</param>
9697	<param name="value" type="wstring" dir="return">
9698	<desc>Current property value.</desc>
9699	</param>
9700	</method>
9701
9702	<method name="setProperty">
9703	<desc>
9704	Sets the value of the custom medium property with the given name.
9705
9706	The list of all properties supported by the given medium format can
9707	be obtained with <link to="IMediumFormat::describeProperties"/>.
9708
9709	Note that setting the property value to @c null or an empty string is
9710	equivalent to deleting the existing value. A default value (if it is
9711	defined for this property) will be used by the format backend in this
9712	case.
9713
9714	<result name="VBOX_E_OBJECT_NOT_FOUND">
9715	Requested property does not exist (not supported by the format).
9716	</result>
9717	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9718	</desc>
9719	<param name="name" type="wstring" dir="in">
9720	<desc>Name of the property to set.</desc>
9721	</param>
9722	<param name="value" type="wstring" dir="in">
9723	<desc>Property value to set.</desc>
9724	</param>
9725	</method>
9726
9727	<method name="getProperties">
9728	<desc>
9729	Returns values for a group of properties in one call.
9730
9731	The names of the properties to get are specified using the @a names
9732	argument which is a list of comma-separated property names or
9733	an empty string if all properties are to be returned. Note that currently
9734	the value of this argument is ignored and the method always returns all
9735	existing properties.
9736
9737	The list of all properties supported by the given medium format can
9738	be obtained with <link to="IMediumFormat::describeProperties"/>.
9739
9740	The method returns two arrays, the array of property names corresponding
9741	to the @a names argument and the current values of these properties.
9742	Both arrays have the same number of elements with each elemend at the
9743	given index in the first array corresponds to an element at the same
9744	index in the second array.
9745
9746	Note that for properties that do not have assigned values,
9747	an empty string is returned at the appropriate index in the
9748	@a returnValues array.
9749
9750	</desc>
9751	<param name="names" type="wstring" dir="in">
9752	<desc>
9753	Names of properties to get.
9754	</desc>
9755	</param>
9756	<param name="returnNames" type="wstring" safearray="yes" dir="out">
9757	<desc>Names of returned properties.</desc>
9758	</param>
9759	<param name="returnValues" type="wstring" safearray="yes" dir="return">
9760	<desc>Values of returned properties.</desc>
9761	</param>
9762	</method>
9763
9764	<method name="setProperties">
9765	<desc>
9766	Sets values for a group of properties in one call.
9767
9768	The names of the properties to set are passed in the @a names
9769	array along with the new values for them in the @a values array. Both
9770	arrays have the same number of elements with each elemend at the given
9771	index in the first array corresponding to an element at the same index
9772	in the second array.
9773
9774	If there is at least one property name in @a names that is not valid,
9775	the method will fail before changing the values of any other properties
9776	from the @a names array.
9777
9778	Using this method over <link to="#setProperty"/> is preferred if you
9779	need to set several properties at once since it will result into less
9780	IPC calls.
9781
9782	The list of all properties supported by the given medium format can
9783	be obtained with <link to="IMediumFormat::describeProperties"/>.
9784
9785	Note that setting the property value to @c null or an empty string is
9786	equivalent to deleting the existing value. A default value (if it is
9787	defined for this property) will be used by the format backend in this
9788	case.
9789	</desc>
9790	<param name="names" type="wstring" safearray="yes" dir="in">
9791	<desc>Names of properties to set.</desc>
9792	</param>
9793	<param name="values" type="wstring" safearray="yes" dir="in">
9794	<desc>Values of properties to set.</desc>
9795	</param>
9796	</method>
9797
9798	<!-- storage methods -->
9799
9800	<method name="createBaseStorage">
9801	<desc>
9802	Starts creating a hard disk storage unit (fixed/dynamic, according
9803	to the variant flags) in in the background. The previous storage unit
9804	created for this object, if any, must first be deleted using
9805	<link to="#deleteStorage"/>, otherwise the operation will fail.
9806
9807	Before the operation starts, the medium is placed in
9808	<link to="MediumState_Creating"/> state. If the create operation
9809	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
9810	state.
9811
9812	After the returned progress object reports that the operation has
9813	successfully completed, the medium state will be set to <link
9814	to="MediumState_Created"/>, the medium will be remembered by this
9815	VirtualBox installation and may be attached to virtual machines.
9816
9817	<result name="VBOX_E_NOT_SUPPORTED">
9818	The variant of storage creation operation is not supported. See <link
9819	to="IMediumFormat::capabilities"/>.
9820	</result>
9821	</desc>
9822	<param name="logicalSize" type="long long" dir="in">
9823	<desc>Maximum logical size of the medium in bytes.</desc>
9824	</param>
9825	<param name="variant" type="MediumVariant" dir="in">
9826	<desc>Exact image variant which should be created.</desc>
9827	</param>
9828	<param name="progress" type="IProgress" dir="return">
9829	<desc>Progress object to track the operation completion.</desc>
9830	</param>
9831	</method>
9832
9833	<method name="deleteStorage">
9834	<desc>
9835	Starts deleting the storage unit of this medium.
9836
9837	The medium must not be attached to any known virtual machine and must
9838	not have any known child media, otherwise the operation will fail.
9839	It will also fail if there is no storage unit to delete or if deletion
9840	is already in progress, or if the medium is being in use (locked for
9841	read or for write) or inaccessible. Therefore, the only valid state for
9842	this operation to succeed is <link to="MediumState_Created"/>.
9843
9844	Before the operation starts, the medium is placed in
9845	<link to="MediumState_Deleting"/> state and gets removed from the list
9846	of remembered hard disks (media registry). If the delete operation
9847	fails, the medium will be remembered again and placed back to
9848	<link to="MediumState_Created"/> state.
9849
9850	After the returned progress object reports that the operation is
9851	complete, the medium state will be set to
9852	<link to="MediumState_NotCreated"/> and you will be able to use one of
9853	the storage creation methods to create it again.
9854
9855	<see>#close()</see>
9856
9857	<result name="VBOX_E_OBJECT_IN_USE">
9858	Medium is attached to a virtual machine.
9859	</result>
9860	<result name="VBOX_E_NOT_SUPPORTED">
9861	Storage deletion is not allowed because neither of storage creation
9862	operations are supported. See
9863	<link to="IMediumFormat::capabilities"/>.
9864	</result>
9865
9866	<note>
9867	If the deletion operation fails, it is not guaranteed that the storage
9868	unit still exists. You may check the <link to="IMedium::state"/> value
9869	to answer this question.
9870	</note>
9871	</desc>
9872	<param name="progress" type="IProgress" dir="return">
9873	<desc>Progress object to track the operation completion.</desc>
9874	</param>
9875	</method>
9876
9877	<!-- diff methods -->
9878
9879	<method name="createDiffStorage">
9880	<desc>
9881	Starts creating an empty differencing storage unit based on this
9882	medium in the format and at the location defined by the @a target
9883	argument.
9884
9885	The target medium must be in <link to="MediumState_NotCreated"/>
9886	state (i.e. must not have an existing storage unit). Upon successful
9887	completion, this operation will set the type of the target medium to
9888	<link to="MediumType_Normal"/> and create a storage unit necessary to
9889	represent the differencing medium data in the given format (according
9890	to the storage format of the target object).
9891
9892	After the returned progress object reports that the operation is
9893	successfully complete, the target medium gets remembered by this
9894	VirtualBox installation and may be attached to virtual machines.
9895
9896	<note>
9897	The medium will be set to <link to="MediumState_LockedRead"/>
9898	state for the duration of this operation.
9899	</note>
9900	<result name="VBOX_E_OBJECT_IN_USE">
9901	Medium not in @c NotCreated state.
9902	</result>
9903	</desc>
9904	<param name="target" type="IMedium" dir="in">
9905	<desc>Target medium.</desc>
9906	</param>
9907	<param name="variant" type="MediumVariant" dir="in">
9908	<desc>Exact image variant which should be created.</desc>
9909	</param>
9910	<param name="progress" type="IProgress" dir="return">
9911	<desc>Progress object to track the operation completion.</desc>
9912	</param>
9913	</method>
9914
9915	<method name="mergeTo">
9916	<desc>
9917	Starts merging the contents of this medium and all intermediate
9918	differencing media in the chain to the given target medium.
9919
9920	The target medium must be either a descendant of this medium or
9921	its ancestor (otherwise this method will immediately return a failure).
9922	It follows that there are two logical directions of the merge operation:
9923	from ancestor to descendant (<i>forward merge</i>) and from descendant to
9924	ancestor (<i>backward merge</i>). Let us consider the following medium
9925	chain:
9926
9927	<pre>Base <- Diff_1 <- Diff_2</pre>
9928
9929	Here, calling this method on the <tt>Base</tt> medium object with
9930	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
9931	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
9932	merge. Note that in both cases the contents of the resulting medium
9933	will be the same, the only difference is the medium object that takes
9934	the result of the merge operation. In case of the forward merge in the
9935	above example, the result will be written to <tt>Diff_2</tt>; in case of
9936	the backward merge, the result will be written to <tt>Base</tt>. In
9937	other words, the result of the operation is always stored in the target
9938	medium.
9939
9940	Upon successful operation completion, the storage units of all media in
9941	the chain between this (source) medium and the target medium, including
9942	the source medium itself, will be automatically deleted and the
9943	relevant medium objects (including this medium) will become
9944	uninitialized. This means that any attempt to call any of
9945	their methods or attributes will fail with the
9946	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
9947	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
9948	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
9949	Note that <tt>Diff_2</tt> in this case will become a base medium
9950	itself since it will no longer be based on any other medium.
9951
9952	Considering the above, all of the following conditions must be met in
9953	order for the merge operation to succeed:
9954	<ul>
9955	<li>
9956	Neither this (source) medium nor any intermediate
9957	differencing medium in the chain between it and the target
9958	medium is attached to any virtual machine.
9959	</li>
9960	<li>
9961	Neither the source medium nor the target medium is an
9962	<link to="MediumType_Immutable"/> medium.
9963	</li>
9964	<li>
9965	The part of the medium tree from the source medium to the
9966	target medium is a linear chain, i.e. all medium in this
9967	chain have exactly one child which is the next medium in this
9968	chain. The only exception from this rule is the target medium in
9969	the forward merge operation; it is allowed to have any number of
9970	child media because the merge operation will not change its
9971	logical contents (as it is seen by the guest OS or by children).
9972	</li>
9973	<li>
9974	None of the involved media are in
9975	<link to="MediumState_LockedRead"/> or
9976	<link to="MediumState_LockedWrite"/> state.
9977	</li>
9978	</ul>
9979
9980	<note>
9981	This (source) medium and all intermediates will be placed to <link
9982	to="MediumState_Deleting"/> state and the target medium will be
9983	placed to <link to="MediumState_LockedWrite"/> state and for the
9984	duration of this operation.
9985	</note>
9986	</desc>
9987	<param name="target" type="IMedium" dir="in">
9988	<desc>Target medium.</desc>
9989	</param>
9990	<param name="progress" type="IProgress" dir="return">
9991	<desc>Progress object to track the operation completion.</desc>
9992	</param>
9993	</method>
9994
9995	<!-- clone method -->
9996
9997	<method name="cloneTo">
9998	<desc>
9999	Starts creating a clone of this medium in the format and at the
10000	location defined by the @a target argument.
10001
10002	The target medium must be either in <link to="MediumState_NotCreated"/>
10003	state (i.e. must not have an existing storage unit) or in
10004	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10005	big enough to hold the data or else the copy will be partial). Upon
10006	successful completion, the cloned medium will contain exactly the
10007	same sector data as the medium being cloned, except that in the
10008	first case a new UUID for the clone will be randomly generated, and in
10009	the second case the UUID will remain unchanged.
10010
10011	The @a parent argument defines which medium will be the parent
10012	of the clone. Passing a @c null reference indicates that the clone will
10013	be a base image, i.e. completely independent. It is possible to specify
10014	an arbitrary medium for this parameter, including the parent of the
10015	medium which is being cloned. Even cloning to a child of the source
10016	medium is possible. Note that when cloning to an existing image, the
10017	@a parent irgument is ignored.
10018
10019	After the returned progress object reports that the operation is
10020	successfully complete, the target medium gets remembered by this
10021	VirtualBox installation and may be attached to virtual machines.
10022
10023	<note>
10024	This medium will be placed to <link to="MediumState_LockedRead"/>
10025	state for the duration of this operation.
10026	</note>
10027	<result name="E_NOTIMPL">
10028	The specified cloning variant is not supported at the moment.
10029	</result>
10030	</desc>
10031	<param name="target" type="IMedium" dir="in">
10032	<desc>Target medium.</desc>
10033	</param>
10034	<param name="variant" type="MediumVariant" dir="in">
10035	<desc>Exact image variant which should be created.</desc>
10036	</param>
10037	<param name="parent" type="IMedium" dir="in">
10038	<desc>Parent of the cloned medium.</desc>
10039	</param>
10040	<param name="progress" type="IProgress" dir="return">
10041	<desc>Progress object to track the operation completion.</desc>
10042	</param>
10043	</method>
10044
10045	<!-- other methods -->
10046
10047	<method name="compact">
10048	<desc>
10049	Starts compacting of this medium. This means that the medium is
10050	transformed into a possibly more compact storage representation.
10051	This potentially creates temporary images, which can require a
10052	substantial amount of additional disk space.
10053
10054	This medium will be placed to <link to="MediumState_LockedWrite"/>
10055	state and all its parent media (if any) will be placed to
10056	<link to="MediumState_LockedRead"/> state for the duration of this
10057	operation.
10058
10059	Please note that the results can be either returned straight away,
10060	or later as the result of the background operation via the object
10061	returned via the @a progress parameter.
10062
10063	<result name="VBOX_E_NOT_SUPPORTED">
10064	Medium format does not support compacting (but potentially
10065	needs it).
10066	</result>
10067	</desc>
10068	<param name="progress" type="IProgress" dir="return">
10069	<desc>Progress object to track the operation completion.</desc>
10070	</param>
10071	</method>
10072
10073	<method name="resize">
10074	<desc>
10075	Starts resizing this medium. This means that the nominal size of the
10076	medium is set to the new value. Both increasing and decreasing the
10077	size is possible, and there are no safety checks, since VirtualBox
10078	does not make any assumptions about the medium contents.
10079
10080	Resizing usually needs additional disk space, and possibly also
10081	some temporary disk space. Note that resize does not create a full
10082	temporary copy of the medium, so the additional disk space requirement
10083	is usually much lower than using the clone operation.
10084
10085	This medium will be placed to <link to="MediumState_LockedWrite"/>
10086	state for the duration of this operation.
10087
10088	Please note that the results can be either returned straight away,
10089	or later as the result of the background operation via the object
10090	returned via the @a progress parameter.
10091
10092	<result name="VBOX_E_NOT_SUPPORTED">
10093	Medium format does not support resizing.
10094	</result>
10095	</desc>
10096	<param name="logicalSize" type="long long" dir="in">
10097	<desc>New nominal capacity of the medium in bytes.</desc>
10098	</param>
10099	<param name="progress" type="IProgress" dir="return">
10100	<desc>Progress object to track the operation completion.</desc>
10101	</param>
10102	</method>
10103
10104	<method name="reset">
10105	<desc>
10106	Starts erasing the contents of this differencing medium.
10107
10108	This operation will reset the differencing medium to its initial
10109	state when it does not contain any sector data and any read operation is
10110	redirected to its parent medium. This automatically gets called
10111	during VM power-up for every medium whose <link to="#autoReset" />
10112	attribute is @c true.
10113
10114	The medium will be write-locked for the duration of this operation (see
10115	<link to="#lockWrite" />).
10116
10117	<result name="VBOX_E_NOT_SUPPORTED">
10118	This is not a differencing medium.
10119	</result>
10120	<result name="VBOX_E_INVALID_OBJECT_STATE">
10121	Medium is not in <link to="MediumState_Created"/> or
10122	<link to="MediumState_Inaccessible"/> state.
10123	</result>
10124	</desc>
10125	<param name="progress" type="IProgress" dir="return">
10126	<desc>Progress object to track the operation completion.</desc>
10127	</param>
10128	</method>
10129
10130	</interface>
10131
10132
10133	<!--
10134	// IMediumFormat
10135	/////////////////////////////////////////////////////////////////////////
10136	-->
10137
10138	<enum
10139	name="DataType"
10140	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10141	>
10142	<const name="Int32" value="0"/>
10143	<const name="Int8" value="1"/>
10144	<const name="String" value="2"/>
10145	</enum>
10146
10147	<enum
10148	name="DataFlags"
10149	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10150	>
10151	<const name="None" value="0x00"/>
10152	<const name="Mandatory" value="0x01"/>
10153	<const name="Expert" value="0x02"/>
10154	<const name="Array" value="0x04"/>
10155	<const name="FlagMask" value="0x07"/>
10156	</enum>
10157
10158	<enum
10159	name="MediumFormatCapabilities"
10160	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10161	>
10162	<desc>
10163	Medium format capability flags.
10164	</desc>
10165
10166	<const name="Uuid" value="0x01">
10167	<desc>
10168	Supports UUIDs as expected by VirtualBox code.
10169	</desc>
10170	</const>
10171
10172	<const name="CreateFixed" value="0x02">
10173	<desc>
10174	Supports creating fixed size images, allocating all space instantly.
10175	</desc>
10176	</const>
10177
10178	<const name="CreateDynamic" value="0x04">
10179	<desc>
10180	Supports creating dynamically growing images, allocating space on
10181	demand.
10182	</desc>
10183	</const>
10184
10185	<const name="CreateSplit2G" value="0x08">
10186	<desc>
10187	Supports creating images split in chunks of a bit less than 2 GBytes.
10188	</desc>
10189	</const>
10190
10191	<const name="Differencing" value="0x10">
10192	<desc>
10193	Supports being used as a format for differencing media (see <link
10194	to="IMedium::createDiffStorage"/>).
10195	</desc>
10196	</const>
10197
10198	<const name="Asynchronous" value="0x20">
10199	<desc>
10200	Supports asynchronous I/O operations for at least some configurations.
10201	</desc>
10202	</const>
10203
10204	<const name="File" value="0x40">
10205	<desc>
10206	The format backend operates on files (the <link to="IMedium::location"/>
10207	attribute of the medium specifies a file used to store medium
10208	data; for a list of supported file extensions see
10209	<link to="IMediumFormat::describeFileExtensions"/>).
10210	</desc>
10211	</const>
10212
10213	<const name="Properties" value="0x80">
10214	<desc>
10215	The format backend uses the property interface to configure the storage
10216	location and properties (the <link to="IMediumFormat::describeProperties"/>
10217	method is used to get access to properties supported by the given medium format).
10218	</desc>
10219	</const>
10220
10221	<const name="TcpNetworking" value="0x100">
10222	<desc>
10223	The format backend uses the TCP networking interface for network access.
10224	</desc>
10225	</const>
10226
10227	<const name="VFS" value="0x200">
10228	<desc>
10229	The format backend supports virtual filesystem functionality.
10230	</desc>
10231	</const>
10232
10233	<const name="CapabilityMask" value="0x3FF"/>
10234	</enum>
10235
10236	<interface
10237	name="IMediumFormat" extends="$unknown"
10238	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10239	wsmap="managed"
10240	>
10241	<desc>
10242	The IMediumFormat interface represents a medium format.
10243
10244	Each medium format has an associated backend which is used to handle
10245	media stored in this format. This interface provides information
10246	about the properties of the associated backend.
10247
10248	Each medium format is identified by a string represented by the
10249	<link to="#id"/> attribute. This string is used in calls like
10250	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10251	format.
10252
10253	The list of all supported medium formats can be obtained using
10254	<link to="ISystemProperties::mediumFormats"/>.
10255
10256	<see>IMedium</see>
10257	</desc>
10258
10259	<attribute name="id" type="wstring" readonly="yes">
10260	<desc>
10261	Identifier of this format.
10262
10263	The format identifier is a non-@c null non-empty ASCII string. Note that
10264	this string is case-insensitive. This means that, for example, all of
10265	the following strings:
10266	<pre>
10267	"VDI"
10268	"vdi"
10269	"VdI"</pre>
10270	refer to the same medium format.
10271
10272	This string is used in methods of other interfaces where it is necessary
10273	to specify a medium format, such as
10274	<link to="IVirtualBox::createHardDisk"/>.
10275	</desc>
10276	</attribute>
10277
10278	<attribute name="name" type="wstring" readonly="yes">
10279	<desc>
10280	Human readable description of this format.
10281
10282	Mainly for use in file open dialogs.
10283	</desc>
10284	</attribute>
10285
10286	<attribute name="capabilities" type="unsigned long" readonly="yes">
10287	<desc>
10288	Capabilities of the format as a set of bit flags.
10289
10290	For the meaning of individual capability flags see
10291	<link to="MediumFormatCapabilities"/>.
10292	</desc>
10293	</attribute>
10294
10295	<method name="describeFileExtensions">
10296	<desc>
10297	Returns two arrays describing the supported file extensions.
10298
10299	The first array contains the supported extensions and the seconds one
10300	the type each extension supports. Both have the same size.
10301
10302	Note that some backends do not work on files, so this array may be
10303	empty.
10304
10305	<see>IMediumFormat::capabilities</see>
10306	</desc>
10307	<param name="extensions" type="wstring" safearray="yes" dir="out">
10308	<desc>The array of supported extensions.</desc>
10309	</param>
10310	<param name="type" type="DeviceType" safearray="yes" dir="out">
10311	<desc>The array which indicates the device type for every given extension.</desc>
10312	</param>
10313	</method>
10314
10315	<method name="describeProperties">
10316	<desc>
10317	Returns several arrays describing the properties supported by this
10318	format.
10319
10320	An element with the given index in each array describes one
10321	property. Thus, the number of elements in each returned array is the
10322	same and corresponds to the number of supported properties.
10323
10324	The returned arrays are filled in only if the
10325	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10326	All arguments must be non-@c null.
10327
10328	<see>DataType</see>
10329	<see>DataFlags</see>
10330	</desc>
10331
10332	<param name="names" type="wstring" safearray="yes" dir="out">
10333	<desc>Array of property names.</desc>
10334	</param>
10335	<param name="description" type="wstring" safearray="yes" dir="out">
10336	<desc>Array of property descriptions.</desc>
10337	</param>
10338	<param name="types" type="DataType" safearray="yes" dir="out">
10339	<desc>Array of property types.</desc>
10340	</param>
10341	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10342	<desc>Array of property flags.</desc>
10343	</param>
10344	<param name="defaults" type="wstring" safearray="yes" dir="out">
10345	<desc>Array of default property values.</desc>
10346	</param>
10347	</method>
10348
10349	</interface>
10350
10351
10352	<!--
10353	// IKeyboard
10354	/////////////////////////////////////////////////////////////////////////
10355	-->
10356
10357	<interface
10358	name="IKeyboard" extends="$unknown"
10359	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10360	wsmap="managed"
10361	>
10362	<desc>
10363	The IKeyboard interface represents the virtual machine's keyboard. Used
10364	in <link to="IConsole::keyboard"/>.
10365
10366	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10367	to the virtual machine.
10368
10369	</desc>
10370	<method name="putScancode">
10371	<desc>Sends a scancode to the keyboard.
10372
10373	<result name="VBOX_E_IPRT_ERROR">
10374	Could not send scan code to virtual keyboard.
10375	</result>
10376
10377	</desc>
10378	<param name="scancode" type="long" dir="in"/>
10379	</method>
10380
10381	<method name="putScancodes">
10382	<desc>Sends an array of scancodes to the keyboard.
10383
10384	<result name="VBOX_E_IPRT_ERROR">
10385	Could not send all scan codes to virtual keyboard.
10386	</result>
10387
10388	</desc>
10389	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10390	<param name="codesStored" type="unsigned long" dir="return"/>
10391	</method>
10392
10393	<method name="putCAD">
10394	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10395	function is nothing special, it is just a convenience function
10396	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10397
10398	<result name="VBOX_E_IPRT_ERROR">
10399	Could not send all scan codes to virtual keyboard.
10400	</result>
10401
10402	</desc>
10403	</method>
10404
10405	<attribute name="eventSource" type="IEventSource" readonly="yes">
10406	<desc>
10407	Event source for keyboard events.
10408	</desc>
10409	</attribute>
10410
10411	</interface>
10412
10413
10414	<!--
10415	// IMouse
10416	/////////////////////////////////////////////////////////////////////////
10417	-->
10418
10419	<enum
10420	name="MouseButtonState"
10421	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10422	>
10423	<desc>
10424	Mouse button state.
10425	</desc>
10426
10427	<const name="LeftButton" value="0x01"/>
10428	<const name="RightButton" value="0x02"/>
10429	<const name="MiddleButton" value="0x04"/>
10430	<const name="WheelUp" value="0x08"/>
10431	<const name="WheelDown" value="0x10"/>
10432	<const name="XButton1" value="0x20"/>
10433	<const name="XButton2" value="0x40"/>
10434	<const name="MouseStateMask" value="0x7F"/>
10435	</enum>
10436
10437	<interface
10438	name="IMouse" extends="$unknown"
10439	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10440	wsmap="managed"
10441	>
10442	<desc>
10443	The IMouse interface represents the virtual machine's mouse. Used in
10444	<link to="IConsole::mouse"/>.
10445
10446	Through this interface, the virtual machine's virtual mouse can be
10447	controlled.
10448	</desc>
10449
10450	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10451	<desc>
10452	Whether the guest OS supports absolute mouse pointer positioning
10453	or not.
10454	<note>
10455	You can use the <link to="IMouseCapabilityChangedEvent"/>
10456	event to be instantly informed about changes of this attribute
10457	during virtual machine execution.
10458	</note>
10459	<see><link to="#putMouseEventAbsolute"/></see>
10460	</desc>
10461	</attribute>
10462
10463	<attribute name="relativeSupported" type="boolean" readonly="yes">
10464	<desc>
10465	Whether the guest OS supports relative mouse pointer positioning
10466	or not.
10467	<note>
10468	You can use the <link to="IMouseCapabilityChangedEvent"/>
10469	event to be instantly informed about changes of this attribute
10470	during virtual machine execution.
10471	</note>
10472	<see><link to="#putMouseEvent"/></see>
10473	</desc>
10474	</attribute>
10475
10476	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10477	<desc>
10478	Whether the guest OS can currently switch to drawing it's own mouse
10479	cursor on demand.
10480	<note>
10481	You can use the <link to="IMouseCapabilityChangedEvent"/>
10482	event to be instantly informed about changes of this attribute
10483	during virtual machine execution.
10484	</note>
10485	<see><link to="#putMouseEvent"/></see>
10486	</desc>
10487	</attribute>
10488
10489	<method name="putMouseEvent">
10490	<desc>
10491	Initiates a mouse event using relative pointer movements
10492	along x and y axis.
10493
10494	<result name="E_ACCESSDENIED">
10495	Console not powered up.
10496	</result>
10497	<result name="VBOX_E_IPRT_ERROR">
10498	Could not send mouse event to virtual mouse.
10499	</result>
10500
10501	</desc>
10502
10503	<param name="dx" type="long" dir="in">
10504	<desc>
10505	Amount of pixels the mouse should move to the right.
10506	Negative values move the mouse to the left.
10507	</desc>
10508	</param>
10509	<param name="dy" type="long" dir="in">
10510	<desc>
10511	Amount of pixels the mouse should move downwards.
10512	Negative values move the mouse upwards.
10513	</desc>
10514	</param>
10515	<param name="dz" type="long" dir="in">
10516	<desc>
10517	Amount of mouse wheel moves.
10518	Positive values describe clockwise wheel rotations,
10519	negative values describe counterclockwise rotations.
10520	</desc>
10521	</param>
10522	<param name="dw" type="long" dir="in">
10523	<desc>
10524	Amount of horizontal mouse wheel moves.
10525	Positive values describe a movement to the left,
10526	negative values describe a movement to the right.
10527	</desc>
10528	</param>
10529	<param name="buttonState" type="long" dir="in">
10530	<desc>
10531	The current state of mouse buttons. Every bit represents
10532	a mouse button as follows:
10533	<table>
10534	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10535	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10536	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10537	</table>
10538	A value of <tt>1</tt> means the corresponding button is pressed.
10539	otherwise it is released.
10540	</desc>
10541	</param>
10542	</method>
10543
10544	<method name="putMouseEventAbsolute">
10545	<desc>
10546	Positions the mouse pointer using absolute x and y coordinates.
10547	These coordinates are expressed in pixels and
10548	start from <tt>[1,1]</tt> which corresponds to the top left
10549	corner of the virtual display.
10550
10551	<result name="E_ACCESSDENIED">
10552	Console not powered up.
10553	</result>
10554	<result name="VBOX_E_IPRT_ERROR">
10555	Could not send mouse event to virtual mouse.
10556	</result>
10557
10558	<note>
10559	This method will have effect only if absolute mouse
10560	positioning is supported by the guest OS.
10561	</note>
10562
10563	<see><link to="#absoluteSupported"/></see>
10564	</desc>
10565
10566	<param name="x" type="long" dir="in">
10567	<desc>
10568	X coordinate of the pointer in pixels, starting from @c 1.
10569	</desc>
10570	</param>
10571	<param name="y" type="long" dir="in">
10572	<desc>
10573	Y coordinate of the pointer in pixels, starting from @c 1.
10574	</desc>
10575	</param>
10576	<param name="dz" type="long" dir="in">
10577	<desc>
10578	Amount of mouse wheel moves.
10579	Positive values describe clockwise wheel rotations,
10580	negative values describe counterclockwise rotations.
10581	</desc>
10582	</param>
10583	<param name="dw" type="long" dir="in">
10584	<desc>
10585	Amount of horizontal mouse wheel moves.
10586	Positive values describe a movement to the left,
10587	negative values describe a movement to the right.
10588	</desc>
10589	</param>
10590	<param name="buttonState" type="long" dir="in">
10591	<desc>
10592	The current state of mouse buttons. Every bit represents
10593	a mouse button as follows:
10594	<table>
10595	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10596	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10597	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10598	</table>
10599	A value of @c 1 means the corresponding button is pressed.
10600	otherwise it is released.
10601	</desc>
10602	</param>
10603	</method>
10604
10605	<attribute name="eventSource" type="IEventSource" readonly="yes">
10606	<desc>
10607	Event source for mouse events.
10608	</desc>
10609	</attribute>
10610
10611	</interface>
10612
10613	<!--
10614	// IDisplay
10615	/////////////////////////////////////////////////////////////////////////
10616	-->
10617
10618	<enum
10619	name="FramebufferPixelFormat"
10620	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10621	>
10622	<desc>
10623	Format of the video memory buffer. Constants represented by this enum can
10624	be used to test for particular values of <link
10625	to="IFramebuffer::pixelFormat"/>. See also <link
10626	to="IFramebuffer::requestResize"/>.
10627
10628	See also www.fourcc.org for more information about FOURCC pixel formats.
10629	</desc>
10630
10631	<const name="Opaque" value="0">
10632	<desc>
10633	Unknown buffer format (the user may not assume any particular format of
10634	the buffer).
10635	</desc>
10636	</const>
10637	<const name="FOURCC_RGB" value="0x32424752">
10638	<desc>
10639	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10640	bit layout).
10641	</desc>
10642	</const>
10643	</enum>
10644
10645	<interface
10646	name="IFramebuffer" extends="$unknown"
10647	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10648	wsmap="suppress"
10649	>
10650	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10651	<desc>Address of the start byte of the frame buffer.</desc>
10652	</attribute>
10653
10654	<attribute name="width" type="unsigned long" readonly="yes">
10655	<desc>Frame buffer width, in pixels.</desc>
10656	</attribute>
10657
10658	<attribute name="height" type="unsigned long" readonly="yes">
10659	<desc>Frame buffer height, in pixels.</desc>
10660	</attribute>
10661
10662	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10663	<desc>
10664	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10665	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10666	are: 8, 15, 16, 24 and 32.
10667	</desc>
10668	</attribute>
10669
10670	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10671	<desc>
10672	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10673	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10674	size of the scan line must be aligned to 32 bits.
10675	</desc>
10676	</attribute>
10677
10678	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10679	<desc>
10680	Frame buffer pixel format. It's either one of the values defined by <link
10681	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10682	<note>
10683	This attribute must never return <link
10684	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10685	<link to="#address"/> points to must be always known.
10686	</note>
10687	</desc>
10688	</attribute>
10689
10690	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10691	<desc>
10692	Defines whether this frame buffer uses the virtual video card's memory
10693	buffer (guest VRAM) directly or not. See <link
10694	to="IFramebuffer::requestResize"/> for more information.
10695	</desc>
10696	</attribute>
10697
10698	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10699	<desc>
10700	Hint from the frame buffer about how much of the standard
10701	screen height it wants to use for itself. This information is
10702	exposed to the guest through the VESA BIOS and VMMDev interface
10703	so that it can use it for determining its video mode table. It
10704	is not guaranteed that the guest respects the value.
10705	</desc>
10706	</attribute>
10707
10708	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10709	<desc>
10710	An alpha-blended overlay which is superposed over the frame buffer.
10711	The initial purpose is to allow the display of icons providing
10712	information about the VM state, including disk activity, in front
10713	ends which do not have other means of doing that. The overlay is
10714	designed to controlled exclusively by IDisplay. It has no locking
10715	of its own, and any changes made to it are not guaranteed to be
10716	visible until the affected portion of IFramebuffer is updated. The
10717	overlay can be created lazily the first time it is requested. This
10718	attribute can also return @c null to signal that the overlay is not
10719	implemented.
10720	</desc>
10721	</attribute>
10722
10723	<attribute name="winId" type="long long" readonly="yes">
10724	<desc>
10725	Platform-dependent identifier of the window where context of this
10726	frame buffer is drawn, or zero if there's no such window.
10727	</desc>
10728	</attribute>
10729
10730	<method name="lock">
10731	<desc>
10732	Locks the frame buffer.
10733	Gets called by the IDisplay object where this frame buffer is
10734	bound to.
10735	</desc>
10736	</method>
10737
10738	<method name="unlock">
10739	<desc>
10740	Unlocks the frame buffer.
10741	Gets called by the IDisplay object where this frame buffer is
10742	bound to.
10743	</desc>
10744	</method>
10745
10746	<method name="notifyUpdate">
10747	<desc>
10748	Informs about an update.
10749	Gets called by the display object where this buffer is
10750	registered.
10751	</desc>
10752	<param name="x" type="unsigned long" dir="in"/>
10753	<param name="y" type="unsigned long" dir="in"/>
10754	<param name="width" type="unsigned long" dir="in"/>
10755	<param name="height" type="unsigned long" dir="in"/>
10756	</method>
10757
10758	<method name="requestResize">
10759	<desc>
10760	Requests a size and pixel format change.
10761
10762	There are two modes of working with the video buffer of the virtual
10763	machine. The <i>indirect</i> mode implies that the IFramebuffer
10764	implementation allocates a memory buffer for the requested display mode
10765	and provides it to the virtual machine. In <i>direct</i> mode, the
10766	IFramebuffer implementation uses the memory buffer allocated and owned
10767	by the virtual machine. This buffer represents the video memory of the
10768	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
10769	usually faster because the implementation gets a raw pointer to the
10770	guest VRAM buffer which it can directly use for visualizing the contents
10771	of the virtual display, as opposed to the indirect mode where the
10772	contents of guest VRAM are copied to the memory buffer provided by
10773	the implementation every time a display update occurs.
10774
10775	It is important to note that the direct mode is really fast only when
10776	the implementation uses the given guest VRAM buffer directly, for
10777	example, by blitting it to the window representing the virtual machine's
10778	display, which saves at least one copy operation comparing to the
10779	indirect mode. However, using the guest VRAM buffer directly is not
10780	always possible: the format and the color depth of this buffer may be
10781	not supported by the target window, or it may be unknown (opaque) as in
10782	case of text or non-linear multi-plane VGA video modes. In this case,
10783	the indirect mode (that is always available) should be used as a
10784	fallback: when the guest VRAM contents are copied to the
10785	implementation-provided memory buffer, color and format conversion is
10786	done automatically by the underlying code.
10787
10788	The @a pixelFormat parameter defines whether the direct mode is
10789	available or not. If @a pixelFormat is <link
10790	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
10791	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
10792	@a bytesPerLine parameters must be ignored and the implementation must use
10793	the indirect mode (where it provides its own buffer in one of the
10794	supported formats). In all other cases, @a pixelFormat together with
10795	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
10796	buffer pointed to by the @a VRAM parameter and the implementation is
10797	free to choose which mode to use. To indicate that this frame buffer uses
10798	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
10799	attribute must return @c true and <link to="#address"/> must
10800	return exactly the same address that is passed in the @a VRAM parameter
10801	of this method; otherwise it is assumed that the indirect strategy is
10802	chosen.
10803
10804	The @a width and @a height parameters represent the size of the
10805	requested display mode in both modes. In case of indirect mode, the
10806	provided memory buffer should be big enough to store data of the given
10807	display mode. In case of direct mode, it is guaranteed that the given
10808	@a VRAM buffer contains enough space to represent the display mode of the
10809	given size. Note that this frame buffer's <link to="#width"/> and <link
10810	to="#height"/> attributes must return exactly the same values as
10811	passed to this method after the resize is completed (see below).
10812
10813	The @a finished output parameter determines if the implementation has
10814	finished resizing the frame buffer or not. If, for some reason, the
10815	resize cannot be finished immediately during this call, @a finished
10816	must be set to @c false, and the implementation must call
10817	<link to="IDisplay::resizeCompleted"/> after it has returned from
10818	this method as soon as possible. If @a finished is @c false, the
10819	machine will not call any frame buffer methods until
10820	<link to="IDisplay::resizeCompleted"/> is called.
10821
10822	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
10823	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
10824	this frame buffer must return exactly the same values as specified in the
10825	parameters of this method, after the resize is completed. If the
10826	indirect mode is chosen, these attributes must return values describing
10827	the format of the implementation's own memory buffer <link
10828	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
10829	value must always correlate with <link to="#pixelFormat"/>. Note that
10830	the <link to="#pixelFormat"/> attribute must never return <link
10831	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
10832
10833	<note>
10834	This method is called by the IDisplay object under the
10835	<link to="#lock"/> provided by this IFramebuffer
10836	implementation. If this method returns @c false in @a finished, then
10837	this lock is not released until
10838	<link to="IDisplay::resizeCompleted"/> is called.
10839	</note>
10840	</desc>
10841	<param name="screenId" type="unsigned long" dir="in">
10842	<desc>
10843	Logical screen number. Must be used in the corresponding call to
10844	<link to="IDisplay::resizeCompleted"/> if this call is made.
10845	</desc>
10846	</param>
10847	<param name="pixelFormat" type="unsigned long" dir="in">
10848	<desc>
10849	Pixel format of the memory buffer pointed to by @a VRAM.
10850	See also <link to="FramebufferPixelFormat"/>.
10851	</desc>
10852	</param>
10853	<param name="VRAM" type="octet" mod="ptr" dir="in">
10854	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
10855	</param>
10856	<param name="bitsPerPixel" type="unsigned long" dir="in">
10857	<desc>Color depth, bits per pixel.</desc>
10858	</param>
10859	<param name="bytesPerLine" type="unsigned long" dir="in">
10860	<desc>Size of one scan line, in bytes.</desc>
10861	</param>
10862	<param name="width" type="unsigned long" dir="in">
10863	<desc>Width of the guest display, in pixels.</desc>
10864	</param>
10865	<param name="height" type="unsigned long" dir="in">
10866	<desc>Height of the guest display, in pixels.</desc>
10867	</param>
10868	<param name="finished" type="boolean" dir="return">
10869	<desc>
10870	Can the VM start using the new frame buffer immediately
10871	after this method returns or it should wait for
10872	<link to="IDisplay::resizeCompleted"/>.
10873	</desc>
10874	</param>
10875	</method>
10876
10877	<method name="videoModeSupported">
10878	<desc>
10879	Returns whether the frame buffer implementation is willing to
10880	support a given video mode. In case it is not able to render
10881	the video mode (or for some reason not willing), it should
10882	return @c false. Usually this method is called when the guest
10883	asks the VMM device whether a given video mode is supported
10884	so the information returned is directly exposed to the guest.
10885	It is important that this method returns very quickly.
10886	</desc>
10887	<param name="width" type="unsigned long" dir="in"/>
10888	<param name="height" type="unsigned long" dir="in"/>
10889	<param name="bpp" type="unsigned long" dir="in"/>
10890	<param name="supported" type="boolean" dir="return"/>
10891	</method>
10892
10893	<method name="getVisibleRegion">
10894	<desc>
10895	Returns the visible region of this frame buffer.
10896
10897	If the @a rectangles parameter is @c null then the value of the
10898	@a count parameter is ignored and the number of elements necessary to
10899	describe the current visible region is returned in @a countCopied.
10900
10901	If @a rectangles is not @c null but @a count is less
10902	than the required number of elements to store region data, the method
10903	will report a failure. If @a count is equal or greater than the
10904	required number of elements, then the actual number of elements copied
10905	to the provided array will be returned in @a countCopied.
10906
10907	<note>
10908	The address of the provided array must be in the process space of
10909	this IFramebuffer object.
10910	</note>
10911	<note>
10912	Method not yet implemented.
10913	</note>
10914	</desc>
10915	<param name="rectangles" type="octet" mod="ptr" dir="in">
10916	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
10917	</param>
10918	<param name="count" type="unsigned long" dir="in">
10919	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10920	</param>
10921	<param name="countCopied" type="unsigned long" dir="return">
10922	<desc>Number of elements copied to the @a rectangles array.</desc>
10923	</param>
10924	</method>
10925
10926	<method name="setVisibleRegion">
10927	<desc>
10928	Suggests a new visible region to this frame buffer. This region
10929	represents the area of the VM display which is a union of regions of
10930	all top-level windows of the guest operating system running inside the
10931	VM (if the Guest Additions for this system support this
10932	functionality). This information may be used by the frontends to
10933	implement the seamless desktop integration feature.
10934
10935	<note>
10936	The address of the provided array must be in the process space of
10937	this IFramebuffer object.
10938	</note>
10939	<note>
10940	The IFramebuffer implementation must make a copy of the provided
10941	array of rectangles.
10942	</note>
10943	<note>
10944	Method not yet implemented.
10945	</note>
10946	</desc>
10947	<param name="rectangles" type="octet" mod="ptr" dir="in">
10948	<desc>Pointer to the @c RTRECT array.</desc>
10949	</param>
10950	<param name="count" type="unsigned long" dir="in">
10951	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
10952	</param>
10953	</method>
10954
10955	<method name="processVHWACommand">
10956	<desc>
10957	Posts a Video HW Acceleration Command to the frame buffer for processing.
10958	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
10959	are posted from quest to the host to be processed by the host hardware.
10960
10961	<note>
10962	The address of the provided command must be in the process space of
10963	this IFramebuffer object.
10964	</note>
10965	</desc>
10966
10967	<param name="command" type="octet" mod="ptr" dir="in">
10968	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
10969	</param>
10970	</method>
10971
10972	</interface>
10973
10974	<interface
10975	name="IFramebufferOverlay" extends="IFramebuffer"
10976	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
10977	wsmap="suppress"
10978	>
10979	<desc>
10980	The IFramebufferOverlay interface represents an alpha blended overlay
10981	for displaying status icons above an IFramebuffer. It is always created
10982	not visible, so that it must be explicitly shown. It only covers a
10983	portion of the IFramebuffer, determined by its width, height and
10984	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
10985	that order) format, and may be written to directly. Do re-read the
10986	width though, after setting it, as it may be adjusted (increased) to
10987	make it more suitable for the front end.
10988	</desc>
10989	<attribute name="x" type="unsigned long" readonly="yes">
10990	<desc>X position of the overlay, relative to the frame buffer.</desc>
10991	</attribute>
10992
10993	<attribute name="y" type="unsigned long" readonly="yes">
10994	<desc>Y position of the overlay, relative to the frame buffer.</desc>
10995	</attribute>
10996
10997	<attribute name="visible" type="boolean" readonly="no">
10998	<desc>
10999	Whether the overlay is currently visible.
11000	</desc>
11001	</attribute>
11002
11003	<attribute name="alpha" type="unsigned long" readonly="no">
11004	<desc>
11005	The global alpha value for the overlay. This may or may not be
11006	supported by a given front end.
11007	</desc>
11008	</attribute>
11009
11010	<method name="move">
11011	<desc>
11012	Changes the overlay's position relative to the IFramebuffer.
11013	</desc>
11014	<param name="x" type="unsigned long" dir="in"/>
11015	<param name="y" type="unsigned long" dir="in"/>
11016	</method>
11017
11018	</interface>
11019
11020	<interface
11021	name="IDisplay" extends="$unknown"
11022	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11023	wsmap="managed"
11024	>
11025	<desc>
11026	The IDisplay interface represents the virtual machine's display.
11027
11028	The object implementing this interface is contained in each
11029	<link to="IConsole::display"/> attribute and represents the visual
11030	output of the virtual machine.
11031
11032	The virtual display supports pluggable output targets represented by the
11033	IFramebuffer interface. Examples of the output target are a window on
11034	the host computer or an RDP session's display on a remote computer.
11035	</desc>
11036	<method name="getScreenResolution">
11037	<desc>Queries display width, height and color depth for given screen.</desc>
11038	<param name="screenId" type="unsigned long" dir="in"/>
11039	<param name="width" type="unsigned long" dir="out"/>
11040	<param name="height" type="unsigned long" dir="out"/>
11041	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11042	</method>
11043
11044	<method name="setFramebuffer">
11045	<desc>
11046	Sets the framebuffer for given screen.
11047	</desc>
11048	<param name="screenId" type="unsigned long" dir="in"/>
11049	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11050	</method>
11051
11052	<method name="getFramebuffer">
11053	<desc>
11054	Queries the framebuffer for given screen.
11055	</desc>
11056	<param name="screenId" type="unsigned long" dir="in"/>
11057	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11058	<param name="xOrigin" type="long" dir="out"/>
11059	<param name="yOrigin" type="long" dir="out"/>
11060	</method>
11061
11062	<method name="setVideoModeHint">
11063	<desc>
11064	Asks VirtualBox to request the given video mode from
11065	the guest. This is just a hint and it cannot be guaranteed
11066	that the requested resolution will be used. Guest Additions
11067	are required for the request to be seen by guests. The caller
11068	should issue the request and wait for a resolution change and
11069	after a timeout retry.
11070
11071	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11072	parameters means that the corresponding values should be taken from the
11073	current video mode (i.e. left unchanged).
11074
11075	If the guest OS supports multi-monitor configuration then the @a display
11076	parameter specifies the number of the guest display to send the hint to:
11077	@c 0 is the primary display, @c 1 is the first secondary and
11078	so on. If the multi-monitor configuration is not supported, @a display
11079	must be @c 0.
11080
11081	<result name="E_INVALIDARG">
11082	The @a display is not associated with any monitor.
11083	</result>
11084
11085	</desc>
11086	<param name="width" type="unsigned long" dir="in"/>
11087	<param name="height" type="unsigned long" dir="in"/>
11088	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11089	<param name="display" type="unsigned long" dir="in"/>
11090	</method>
11091
11092	<method name="setSeamlessMode">
11093	<desc>
11094	Enables or disables seamless guest display rendering (seamless desktop
11095	integration) mode.
11096	<note>
11097	Calling this method has no effect if <link
11098	to="IGuest::supportsSeamless"/> returns @c false.
11099	</note>
11100	</desc>
11101	<param name="enabled" type="boolean" dir="in"/>
11102	</method>
11103
11104	<method name="takeScreenShot">
11105	<desc>
11106	Takes a screen shot of the requested size and copies it to the
11107	32-bpp buffer allocated by the caller and pointed to by @a address.
11108	A pixel consists of 4 bytes in order: B, G, R, 0.
11109
11110	<note>This API can be used only by the COM/XPCOM C++ API as it
11111	requires pointer support. Use <link to="#takeScreenShotToArray" />
11112	with other language bindings.
11113	</note>
11114
11115	<result name="E_NOTIMPL">
11116	Feature not implemented.
11117	</result>
11118	<result name="VBOX_E_IPRT_ERROR">
11119	Could not take a screenshot.
11120	</result>
11121
11122	</desc>
11123	<param name="screenId" type="unsigned long" dir="in"/>
11124	<param name="address" type="octet" mod="ptr" dir="in"/>
11125	<param name="width" type="unsigned long" dir="in"/>
11126	<param name="height" type="unsigned long" dir="in"/>
11127	</method>
11128
11129	<method name="takeScreenShotToArray">
11130	<desc>
11131	Takes a guest screen shot of the requested size and returns it as
11132	an array of bytes in uncompressed 32-bit RGBA format.
11133	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11134
11135	This API is slow, but could be the only option to get guest screenshot
11136	for scriptable languages not allowed to manipulate with addresses
11137	directly.
11138
11139	<result name="E_NOTIMPL">
11140	Feature not implemented.
11141	</result>
11142	<result name="VBOX_E_IPRT_ERROR">
11143	Could not take a screenshot.
11144	</result>
11145	</desc>
11146	<param name="screenId" type="unsigned long" dir="in">
11147	<desc>
11148	Monitor to take screenshot from.
11149	</desc>
11150	</param>
11151	<param name="width" type="unsigned long" dir="in">
11152	<desc>
11153	Desired image width.
11154	</desc>
11155	</param>
11156	<param name="height" type="unsigned long" dir="in">
11157	<desc>
11158	Desired image height.
11159	</desc>
11160	</param>
11161	<param name="screenData" type="octet" dir="return" safearray="yes">
11162	<desc>
11163	Array with resulting screen data.
11164	</desc>
11165	</param>
11166	</method>
11167
11168	<method name="takeScreenShotPNGToArray">
11169	<desc>
11170	Takes a guest screen shot of the requested size and returns it as
11171	PNG image in array.
11172
11173	<result name="E_NOTIMPL">
11174	Feature not implemented.
11175	</result>
11176	<result name="VBOX_E_IPRT_ERROR">
11177	Could not take a screenshot.
11178	</result>
11179	</desc>
11180	<param name="screenId" type="unsigned long" dir="in">
11181	<desc>
11182	Monitor to take the screenshot from.
11183	</desc>
11184	</param>
11185	<param name="width" type="unsigned long" dir="in">
11186	<desc>
11187	Desired image width.
11188	</desc>
11189	</param>
11190	<param name="height" type="unsigned long" dir="in">
11191	<desc>
11192	Desired image height.
11193	</desc>
11194	</param>
11195	<param name="screenData" type="octet" dir="return" safearray="yes">
11196	<desc>
11197	Array with resulting screen data.
11198	</desc>
11199	</param>
11200	</method>
11201
11202	<method name="drawToScreen">
11203	<desc>
11204	Draws a 32-bpp image of the specified size from the given buffer
11205	to the given point on the VM display.
11206
11207	<result name="E_NOTIMPL">
11208	Feature not implemented.
11209	</result>
11210	<result name="VBOX_E_IPRT_ERROR">
11211	Could not draw to screen.
11212	</result>
11213
11214	</desc>
11215	<param name="screenId" type="unsigned long" dir="in">
11216	<desc>
11217	Monitor to take the screenshot from.
11218	</desc>
11219	</param>
11220	<param name="address" type="octet" mod="ptr" dir="in">
11221	<desc>
11222	Address to store the screenshot to
11223	</desc>
11224	</param>
11225	<param name="x" type="unsigned long" dir="in">
11226	<desc>
11227	Relative to the screen top left corner.
11228	</desc>
11229	</param>
11230	<param name="y" type="unsigned long" dir="in">
11231	<desc>
11232	Relative to the screen top left corner.
11233	</desc>
11234	</param>
11235	<param name="width" type="unsigned long" dir="in">
11236	<desc>
11237	Desired image width.
11238	</desc>
11239	</param>
11240	<param name="height" type="unsigned long" dir="in">
11241	<desc>
11242	Desired image height.
11243	</desc>
11244	</param>
11245	</method>
11246
11247	<method name="invalidateAndUpdate">
11248	<desc>
11249	Does a full invalidation of the VM display and instructs the VM
11250	to update it.
11251
11252	<result name="VBOX_E_IPRT_ERROR">
11253	Could not invalidate and update screen.
11254	</result>
11255
11256	</desc>
11257	</method>
11258
11259	<method name="resizeCompleted">
11260	<desc>
11261	Signals that a framebuffer has completed the resize operation.
11262
11263	<result name="VBOX_E_NOT_SUPPORTED">
11264	Operation only valid for external frame buffers.
11265	</result>
11266
11267	</desc>
11268	<param name="screenId" type="unsigned long" dir="in"/>
11269	</method>
11270
11271	<method name="completeVHWACommand">
11272	<desc>
11273	Signals that the Video HW Acceleration command has completed.
11274	</desc>
11275
11276	<param name="command" type="octet" mod="ptr" dir="in">
11277	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11278	</param>
11279	</method>
11280
11281	</interface>
11282
11283	<!--
11284	// INetworkAdapter
11285	/////////////////////////////////////////////////////////////////////////
11286	-->
11287
11288	<enum
11289	name="NetworkAttachmentType"
11290	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11291	>
11292	<desc>
11293	Network attachment type.
11294	</desc>
11295
11296	<const name="Null" value="0">
11297	<desc>Null value, also means "not attached".</desc>
11298	</const>
11299	<const name="NAT" value="1"/>
11300	<const name="Bridged" value="2"/>
11301	<const name="Internal" value="3"/>
11302	<const name="HostOnly" value="4"/>
11303	<const name="VDE" value="5"/>
11304	</enum>
11305
11306	<enum
11307	name="NetworkAdapterType"
11308	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11309	>
11310	<desc>
11311	Network adapter type.
11312	</desc>
11313
11314	<const name="Null" value="0">
11315	<desc>Null value (never used by the API).</desc>
11316	</const>
11317	<const name="Am79C970A" value="1">
11318	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11319	</const>
11320	<const name="Am79C973" value="2">
11321	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11322	</const>
11323	<const name="I82540EM" value="3">
11324	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11325	</const>
11326	<const name="I82543GC" value="4">
11327	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11328	</const>
11329	<const name="I82545EM" value="5">
11330	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11331	</const>
11332	<const name="Virtio" value="6">
11333	<desc>Virtio network device.</desc>
11334	</const>
11335	</enum>
11336
11337	<interface
11338	name="INetworkAdapter" extends="$unknown"
11339	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11340	wsmap="managed"
11341	>
11342	<desc>
11343	Represents a virtual network adapter that is attached to a virtual machine.
11344	Each virtual machine has a fixed number of network adapter slots with one
11345	instance of this attached to each of them. Call
11346	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11347	is attached to a given slot in a given machine.
11348
11349	Each network adapter can be in one of five attachment modes, which are
11350	represented by the <link to="NetworkAttachmentType" /> enumeration;
11351	see the <link to="#attachmentType" /> attribute.
11352	</desc>
11353
11354	<attribute name="adapterType" type="NetworkAdapterType">
11355	<desc>
11356	Type of the virtual network adapter. Depending on this value,
11357	VirtualBox will provide a different virtual network hardware
11358	to the guest.
11359	</desc>
11360	</attribute>
11361
11362	<attribute name="slot" type="unsigned long" readonly="yes">
11363	<desc>
11364	Slot number this adapter is plugged into. Corresponds to
11365	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11366	to obtain this instance.
11367	</desc>
11368	</attribute>
11369
11370	<attribute name="enabled" type="boolean">
11371	<desc>
11372	Flag whether the network adapter is present in the
11373	guest system. If disabled, the virtual guest hardware will
11374	not contain this network adapter. Can only be changed when
11375	the VM is not running.
11376	</desc>
11377	</attribute>
11378
11379	<attribute name="MACAddress" type="wstring">
11380	<desc>
11381	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11382	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11383	</desc>
11384	</attribute>
11385
11386	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11387
11388	<attribute name="hostInterface" type="wstring">
11389	<desc>
11390	Name of the host network interface the VM is attached to.
11391	</desc>
11392	</attribute>
11393
11394	<attribute name="internalNetwork" type="wstring">
11395	<desc>
11396	Name of the internal network the VM is attached to.
11397	</desc>
11398	</attribute>
11399
11400	<attribute name="NATNetwork" type="wstring">
11401	<desc>
11402	Name of the NAT network the VM is attached to.
11403	</desc>
11404	</attribute>
11405
11406	<attribute name="VDENetwork" type="wstring">
11407	<desc>
11408	Name of the VDE switch the VM is attached to.
11409	</desc>
11410	</attribute>
11411
11412	<attribute name="cableConnected" type="boolean">
11413	<desc>
11414	Flag whether the adapter reports the cable as connected or not.
11415	It can be used to report offline situations to a VM.
11416	</desc>
11417	</attribute>
11418
11419	<attribute name="lineSpeed" type="unsigned long">
11420	<desc>
11421	Line speed reported by custom drivers, in units of 1 kbps.
11422	</desc>
11423	</attribute>
11424
11425	<attribute name="traceEnabled" type="boolean">
11426	<desc>
11427	Flag whether network traffic from/to the network card should be traced.
11428	Can only be toggled when the VM is turned off.
11429	</desc>
11430	</attribute>
11431
11432	<attribute name="traceFile" type="wstring">
11433	<desc>
11434	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11435	will be used.
11436	</desc>
11437	</attribute>
11438
11439	<attribute name="natDriver" type="INATEngine" readonly="yes">
11440	<desc>
11441	Points to the NAT engine which handles the network address translation
11442	for this interface. This is active only when the interface actually uses
11443	NAT (see <link to="#attachToNAT" />).
11444	</desc>
11445	</attribute>
11446
11447	<attribute name="bootPriority" type="unsigned long">
11448	<desc>
11449	Network boot priority of the adapter. Priority 1 is highest. If not set,
11450	the priority is considered to be at the lowest possible setting.
11451	</desc>
11452	</attribute>
11453
11454	<attribute name="bandwidthLimit" type="unsigned long">
11455	<desc>
11456	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11457	A zero value means uncapped/unlimited.
11458	</desc>
11459	</attribute>
11460
11461	<method name="attachToNAT">
11462	<desc>
11463	Attach the network adapter to the Network Address Translation (NAT) interface.
11464	</desc>
11465	</method>
11466
11467	<method name="attachToBridgedInterface">
11468	<desc>
11469	Attach the network adapter to a bridged host interface.
11470	</desc>
11471	</method>
11472
11473	<method name="attachToInternalNetwork">
11474	<desc>
11475	Attach the network adapter to an internal network.
11476	</desc>
11477	</method>
11478
11479	<method name="attachToHostOnlyInterface">
11480	<desc>
11481	Attach the network adapter to the host-only network.
11482	</desc>
11483	</method>
11484
11485	<method name="attachToVDE">
11486	<desc>
11487	Attach the network adapter to a VDE network.
11488	</desc>
11489	</method>
11490
11491	<method name="detach">
11492	<desc>
11493	Detach the network adapter
11494	</desc>
11495	</method>
11496	</interface>
11497
11498
11499	<!--
11500	// ISerialPort
11501	/////////////////////////////////////////////////////////////////////////
11502	-->
11503
11504	<enum
11505	name="PortMode"
11506	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11507	>
11508	<desc>
11509	The PortMode enumeration represents possible communication modes for
11510	the virtual serial port device.
11511	</desc>
11512
11513	<const name="Disconnected" value="0">
11514	<desc>Virtual device is not attached to any real host device.</desc>
11515	</const>
11516	<const name="HostPipe" value="1">
11517	<desc>Virtual device is attached to a host pipe.</desc>
11518	</const>
11519	<const name="HostDevice" value="2">
11520	<desc>Virtual device is attached to a host device.</desc>
11521	</const>
11522	<const name="RawFile" value="3">
11523	<desc>Virtual device is attached to a raw file.</desc>
11524	</const>
11525	</enum>
11526
11527	<interface
11528	name="ISerialPort" extends="$unknown"
11529	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11530	wsmap="managed"
11531	>
11532
11533	<desc>
11534	The ISerialPort interface represents the virtual serial port device.
11535
11536	The virtual serial port device acts like an ordinary serial port
11537	inside the virtual machine. This device communicates to the real
11538	serial port hardware in one of two modes: host pipe or host device.
11539
11540	In host pipe mode, the #path attribute specifies the path to the pipe on
11541	the host computer that represents a serial port. The #server attribute
11542	determines if this pipe is created by the virtual machine process at
11543	machine startup or it must already exist before starting machine
11544	execution.
11545
11546	In host device mode, the #path attribute specifies the name of the
11547	serial port device on the host computer.
11548
11549	There is also a third communication mode: the disconnected mode. In this
11550	mode, the guest OS running inside the virtual machine will be able to
11551	detect the serial port, but all port write operations will be discarded
11552	and all port read operations will return no data.
11553
11554	<see>IMachine::getSerialPort</see>
11555	</desc>
11556
11557	<attribute name="slot" type="unsigned long" readonly="yes">
11558	<desc>
11559	Slot number this serial port is plugged into. Corresponds to
11560	the value you pass to <link to="IMachine::getSerialPort"/>
11561	to obtain this instance.
11562	</desc>
11563	</attribute>
11564
11565	<attribute name="enabled" type="boolean">
11566	<desc>
11567	Flag whether the serial port is enabled. If disabled,
11568	the serial port will not be reported to the guest OS.
11569	</desc>
11570	</attribute>
11571
11572	<attribute name="IOBase" type="unsigned long">
11573	<desc>Base I/O address of the serial port.</desc>
11574	</attribute>
11575
11576	<attribute name="IRQ" type="unsigned long">
11577	<desc>IRQ number of the serial port.</desc>
11578	</attribute>
11579
11580	<attribute name="hostMode" type="PortMode">
11581	<desc>
11582	How is this port connected to the host.
11583	<note>
11584	Changing this attribute may fail if the conditions for
11585	<link to="#path"/> are not met.
11586	</note>
11587	</desc>
11588	</attribute>
11589
11590	<attribute name="server" type="boolean">
11591	<desc>
11592	Flag whether this serial port acts as a server (creates a new pipe on
11593	the host) or as a client (uses the existing pipe). This attribute is
11594	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11595	</desc>
11596	</attribute>
11597
11598	<attribute name="path" type="wstring">
11599	<desc>
11600	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11601	PortMode_HostPipe, or the host serial device name when
11602	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11603	cases, setting a @c null or empty string as the attribute's value
11604	is an error. Otherwise, the value of this property is ignored.
11605	</desc>
11606	</attribute>
11607
11608	</interface>
11609
11610	<!--
11611	// IParallelPort
11612	/////////////////////////////////////////////////////////////////////////
11613	-->
11614
11615	<interface
11616	name="IParallelPort" extends="$unknown"
11617	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11618	wsmap="managed"
11619	>
11620
11621	<desc>
11622	The IParallelPort interface represents the virtual parallel port device.
11623
11624	The virtual parallel port device acts like an ordinary parallel port
11625	inside the virtual machine. This device communicates to the real
11626	parallel port hardware using the name of the parallel device on the host
11627	computer specified in the #path attribute.
11628
11629	Each virtual parallel port device is assigned a base I/O address and an
11630	IRQ number that will be reported to the guest operating system and used
11631	to operate the given parallel port from within the virtual machine.
11632
11633	<see>IMachine::getParallelPort</see>
11634	</desc>
11635
11636	<attribute name="slot" type="unsigned long" readonly="yes">
11637	<desc>
11638	Slot number this parallel port is plugged into. Corresponds to
11639	the value you pass to <link to="IMachine::getParallelPort"/>
11640	to obtain this instance.
11641	</desc>
11642	</attribute>
11643
11644	<attribute name="enabled" type="boolean">
11645	<desc>
11646	Flag whether the parallel port is enabled. If disabled,
11647	the parallel port will not be reported to the guest OS.
11648	</desc>
11649	</attribute>
11650
11651	<attribute name="IOBase" type="unsigned long">
11652	<desc>Base I/O address of the parallel port.</desc>
11653	</attribute>
11654
11655	<attribute name="IRQ" type="unsigned long">
11656	<desc>IRQ number of the parallel port.</desc>
11657	</attribute>
11658
11659	<attribute name="path" type="wstring">
11660	<desc>
11661	Host parallel device name. If this parallel port is enabled, setting a
11662	@c null or an empty string as this attribute's value will result into
11663	an error.
11664	</desc>
11665	</attribute>
11666
11667	</interface>
11668
11669
11670	<!--
11671	// IMachineDebugger
11672	/////////////////////////////////////////////////////////////////////////
11673	-->
11674
11675	<interface
11676	name="IMachineDebugger" extends="$unknown"
11677	uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0"
11678	wsmap="suppress"
11679	>
11680	<method name="resetStats">
11681	<desc>
11682	Reset VM statistics.
11683	</desc>
11684	<param name="pattern" type="wstring" dir="in">
11685	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11686	</param>
11687	</method>
11688
11689	<method name="dumpStats">
11690	<desc>
11691	Dumps VM statistics.
11692	</desc>
11693	<param name="pattern" type="wstring" dir="in">
11694	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11695	</param>
11696	</method>
11697
11698	<method name="getStats">
11699	<desc>
11700	Get the VM statistics in a XMLish format.
11701	</desc>
11702	<param name="pattern" type="wstring" dir="in">
11703	<desc>The selection pattern. A bit similar to filename globbing.</desc>
11704	</param>
11705	<param name="withDescriptions" type="boolean" dir="in">
11706	<desc>Whether to include the descriptions.</desc>
11707	</param>
11708	<param name="stats" type="wstring" dir="out">
11709	<desc>The XML document containing the statistics.</desc>
11710	</param>
11711	</method>
11712
11713	<method name="injectNMI">
11714	<desc>
11715	Inject an NMI into a running VT-x/AMD-V VM.
11716	</desc>
11717	</method>
11718
11719	<attribute name="singlestep" type="boolean">
11720	<desc>Switch for enabling singlestepping.</desc>
11721	</attribute>
11722
11723	<attribute name="recompileUser" type="boolean">
11724	<desc>Switch for forcing code recompilation for user mode code.</desc>
11725	</attribute>
11726
11727	<attribute name="recompileSupervisor" type="boolean">
11728	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
11729	</attribute>
11730
11731	<attribute name="PATMEnabled" type="boolean">
11732	<desc>Switch for enabling and disabling the PATM component.</desc>
11733	</attribute>
11734
11735	<attribute name="CSAMEnabled" type="boolean">
11736	<desc>Switch for enabling and disabling the CSAM component.</desc>
11737	</attribute>
11738
11739	<attribute name="logEnabled" type="boolean">
11740	<desc>Switch for enabling and disabling logging.</desc>
11741	</attribute>
11742
11743	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
11744	<desc>
11745	Flag indicating whether the VM is currently making use of CPU hardware
11746	virtualization extensions.
11747	</desc>
11748	</attribute>
11749
11750	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
11751	<desc>
11752	Flag indicating whether the VM is currently making use of the nested paging
11753	CPU hardware virtualization extension.
11754	</desc>
11755	</attribute>
11756
11757	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
11758	<desc>
11759	Flag indicating whether the VM is currently making use of the VPID
11760	VT-x extension.
11761	</desc>
11762	</attribute>
11763
11764	<attribute name="PAEEnabled" type="boolean" readonly="yes">
11765	<desc>
11766	Flag indicating whether the VM is currently making use of the Physical
11767	Address Extension CPU feature.
11768	</desc>
11769	</attribute>
11770
11771	<attribute name="virtualTimeRate" type="unsigned long">
11772	<desc>
11773	The rate at which the virtual time runs expressed as a percentage.
11774	The accepted range is 2% to 20000%.
11775	</desc>
11776	</attribute>
11777
11778	<!-- @todo method for setting log flags, groups and destination! -->
11779
11780	<attribute name="VM" type="long long" readonly="yes">
11781	<desc>
11782	Gets the VM handle. This is only for internal use while
11783	we carve the details of this interface.
11784	</desc>
11785	</attribute>
11786
11787	</interface>
11788
11789	<!--
11790	// IUSBController
11791	/////////////////////////////////////////////////////////////////////////
11792	-->
11793
11794	<interface
11795	name="IUSBController" extends="$unknown"
11796	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
11797	wsmap="managed"
11798	>
11799	<attribute name="enabled" type="boolean">
11800	<desc>
11801	Flag whether the USB controller is present in the
11802	guest system. If disabled, the virtual guest hardware will
11803	not contain any USB controller. Can only be changed when
11804	the VM is powered off.
11805	</desc>
11806	</attribute>
11807
11808	<attribute name="enabledEhci" type="boolean">
11809	<desc>
11810	Flag whether the USB EHCI controller is present in the
11811	guest system. If disabled, the virtual guest hardware will
11812	not contain a USB EHCI controller. Can only be changed when
11813	the VM is powered off.
11814	</desc>
11815	</attribute>
11816
11817	<attribute name="proxyAvailable" type="boolean" readonly="yes">
11818	<desc>
11819	Flag whether there is an USB proxy available.
11820	</desc>
11821	</attribute>
11822
11823	<attribute name="USBStandard" type="unsigned short" readonly="yes">
11824	<desc>
11825	USB standard version which the controller implements.
11826	This is a BCD which means that the major version is in the
11827	high byte and minor version is in the low byte.
11828	</desc>
11829	</attribute>
11830
11831	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
11832	<desc>
11833	List of USB device filters associated with the machine.
11834
11835	If the machine is currently running, these filters are activated
11836	every time a new (supported) USB device is attached to the host
11837	computer that was not ignored by global filters
11838	(<link to="IHost::USBDeviceFilters"/>).
11839
11840	These filters are also activated when the machine is powered up.
11841	They are run against a list of all currently available USB
11842	devices (in states
11843	<link to="USBDeviceState_Available"/>,
11844	<link to="USBDeviceState_Busy"/>,
11845	<link to="USBDeviceState_Held"/>) that were not previously
11846	ignored by global filters.
11847
11848	If at least one filter matches the USB device in question, this
11849	device is automatically captured (attached to) the virtual USB
11850	controller of this machine.
11851
11852	<see>IUSBDeviceFilter, ::IUSBController</see>
11853	</desc>
11854	</attribute>
11855
11856	<method name="createDeviceFilter">
11857	<desc>
11858	Creates a new USB device filter. All attributes except
11859	the filter name are set to empty (any match),
11860	<i>active</i> is @c false (the filter is not active).
11861
11862	The created filter can then be added to the list of filters using
11863	<link to="#insertDeviceFilter"/>.
11864
11865	<result name="VBOX_E_INVALID_VM_STATE">
11866	The virtual machine is not mutable.
11867	</result>
11868
11869	<see>#deviceFilters</see>
11870	</desc>
11871	<param name="name" type="wstring" dir="in">
11872	<desc>
11873	Filter name. See <link to="IUSBDeviceFilter::name"/>
11874	for more info.
11875	</desc>
11876	</param>
11877	<param name="filter" type="IUSBDeviceFilter" dir="return">
11878	<desc>Created filter object.</desc>
11879	</param>
11880	</method>
11881
11882	<method name="insertDeviceFilter">
11883	<desc>
11884	Inserts the given USB device to the specified position
11885	in the list of filters.
11886
11887	Positions are numbered starting from <tt>0</tt>. If the specified
11888	position is equal to or greater than the number of elements in
11889	the list, the filter is added to the end of the collection.
11890
11891	<note>
11892	Duplicates are not allowed, so an attempt to insert a
11893	filter that is already in the collection, will return an
11894	error.
11895	</note>
11896
11897	<result name="VBOX_E_INVALID_VM_STATE">
11898	Virtual machine is not mutable.
11899	</result>
11900	<result name="E_INVALIDARG">
11901	USB device filter not created within this VirtualBox instance.
11902	</result>
11903	<result name="VBOX_E_INVALID_OBJECT_STATE">
11904	USB device filter already in list.
11905	</result>
11906
11907	<see>#deviceFilters</see>
11908	</desc>
11909	<param name="position" type="unsigned long" dir="in">
11910	<desc>Position to insert the filter to.</desc>
11911	</param>
11912	<param name="filter" type="IUSBDeviceFilter" dir="in">
11913	<desc>USB device filter to insert.</desc>
11914	</param>
11915	</method>
11916
11917	<method name="removeDeviceFilter">
11918	<desc>
11919	Removes a USB device filter from the specified position in the
11920	list of filters.
11921
11922	Positions are numbered starting from <tt>0</tt>. Specifying a
11923	position equal to or greater than the number of elements in
11924	the list will produce an error.
11925
11926	<see>#deviceFilters</see>
11927
11928	<result name="VBOX_E_INVALID_VM_STATE">
11929	Virtual machine is not mutable.
11930	</result>
11931	<result name="E_INVALIDARG">
11932	USB device filter list empty or invalid @a position.
11933	</result>
11934
11935	</desc>
11936	<param name="position" type="unsigned long" dir="in">
11937	<desc>Position to remove the filter from.</desc>
11938	</param>
11939	<param name="filter" type="IUSBDeviceFilter" dir="return">
11940	<desc>Removed USB device filter.</desc>
11941	</param>
11942	</method>
11943
11944	</interface>
11945
11946
11947	<!--
11948	// IUSBDevice
11949	/////////////////////////////////////////////////////////////////////////
11950	-->
11951
11952	<interface
11953	name="IUSBDevice" extends="$unknown"
11954	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
11955	wsmap="managed"
11956	>
11957	<desc>
11958	The IUSBDevice interface represents a virtual USB device attached to the
11959	virtual machine.
11960
11961	A collection of objects implementing this interface is stored in the
11962	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
11963	attached to a running virtual machine's USB controller.
11964	</desc>
11965
11966	<attribute name="id" type="uuid" mod="string" readonly="yes">
11967	<desc>
11968	Unique USB device ID. This ID is built from #vendorId,
11969	#productId, #revision and #serialNumber.
11970	</desc>
11971	</attribute>
11972
11973	<attribute name="vendorId" type="unsigned short" readonly="yes">
11974	<desc>Vendor ID.</desc>
11975	</attribute>
11976
11977	<attribute name="productId" type="unsigned short" readonly="yes">
11978	<desc>Product ID.</desc>
11979	</attribute>
11980
11981	<attribute name="revision" type="unsigned short" readonly="yes">
11982	<desc>
11983	Product revision number. This is a packed BCD represented as
11984	unsigned short. The high byte is the integer part and the low
11985	byte is the decimal.
11986	</desc>
11987	</attribute>
11988
11989	<attribute name="manufacturer" type="wstring" readonly="yes">
11990	<desc>Manufacturer string.</desc>
11991	</attribute>
11992
11993	<attribute name="product" type="wstring" readonly="yes">
11994	<desc>Product string.</desc>
11995	</attribute>
11996
11997	<attribute name="serialNumber" type="wstring" readonly="yes">
11998	<desc>Serial number string.</desc>
11999	</attribute>
12000
12001	<attribute name="address" type="wstring" readonly="yes">
12002	<desc>Host specific address of the device.</desc>
12003	</attribute>
12004
12005	<attribute name="port" type="unsigned short" readonly="yes">
12006	<desc>
12007	Host USB port number the device is physically
12008	connected to.
12009	</desc>
12010	</attribute>
12011
12012	<attribute name="version" type="unsigned short" readonly="yes">
12013	<desc>
12014	The major USB version of the device - 1 or 2.
12015	</desc>
12016	</attribute>
12017
12018	<attribute name="portVersion" type="unsigned short" readonly="yes">
12019	<desc>
12020	The major USB version of the host USB port the device is
12021	physically connected to - 1 or 2. For devices not connected to
12022	anything this will have the same value as the version attribute.
12023	</desc>
12024	</attribute>
12025
12026	<attribute name="remote" type="boolean" readonly="yes">
12027	<desc>
12028	Whether the device is physically connected to a remote VRDE
12029	client or to a local host machine.
12030	</desc>
12031	</attribute>
12032
12033	</interface>
12034
12035
12036	<!--
12037	// IUSBDeviceFilter
12038	/////////////////////////////////////////////////////////////////////////
12039	-->
12040
12041	<interface
12042	name="IUSBDeviceFilter" extends="$unknown"
12043	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12044	wsmap="managed"
12045	>
12046	<desc>
12047	The IUSBDeviceFilter interface represents an USB device filter used
12048	to perform actions on a group of USB devices.
12049
12050	This type of filters is used by running virtual machines to
12051	automatically capture selected USB devices once they are physically
12052	attached to the host computer.
12053
12054	A USB device is matched to the given device filter if and only if all
12055	attributes of the device match the corresponding attributes of the
12056	filter (that is, attributes are joined together using the logical AND
12057	operation). On the other hand, all together, filters in the list of
12058	filters carry the semantics of the logical OR operation. So if it is
12059	desirable to create a match like "this vendor id OR this product id",
12060	one needs to create two filters and specify "any match" (see below)
12061	for unused attributes.
12062
12063	All filter attributes used for matching are strings. Each string
12064	is an expression representing a set of values of the corresponding
12065	device attribute, that will match the given filter. Currently, the
12066	following filtering expressions are supported:
12067
12068	<ul>
12069	<li><i>Interval filters</i>. Used to specify valid intervals for
12070	integer device attributes (Vendor ID, Product ID and Revision).
12071	The format of the string is:
12072
12073	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12074
12075	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12076	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12077	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12078	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12079	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12080	possible integer is assumed.
12081	</li>
12082	<li><i>Boolean filters</i>. Used to specify acceptable values for
12083	boolean device attributes. The format of the string is:
12084
12085	<tt>true\|false\|yes\|no\|0\|1</tt>
12086
12087	</li>
12088	<li><i>Exact match</i>. Used to specify a single value for the given
12089	device attribute. Any string that doesn't start with <tt>int:</tt>
12090	represents the exact match. String device attributes are compared to
12091	this string including case of symbols. Integer attributes are first
12092	converted to a string (see individual filter attributes) and then
12093	compared ignoring case.
12094
12095	</li>
12096	<li><i>Any match</i>. Any value of the corresponding device attribute
12097	will match the given filter. An empty or @c null string is
12098	used to construct this type of filtering expressions.
12099
12100	</li>
12101	</ul>
12102
12103	<note>
12104	On the Windows host platform, interval filters are not currently
12105	available. Also all string filter attributes
12106	(<link to="#manufacturer"/>, <link to="#product"/>,
12107	<link to="#serialNumber"/>) are ignored, so they behave as
12108	<i>any match</i> no matter what string expression is specified.
12109	</note>
12110
12111	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12112	</desc>
12113
12114	<attribute name="name" type="wstring">
12115	<desc>
12116	Visible name for this filter.
12117	This name is used to visually distinguish one filter from another,
12118	so it can neither be @c null nor an empty string.
12119	</desc>
12120	</attribute>
12121
12122	<attribute name="active" type="boolean">
12123	<desc>Whether this filter active or has been temporarily disabled.</desc>
12124	</attribute>
12125
12126	<attribute name="vendorId" type="wstring">
12127	<desc>
12128	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12129	The string representation for the <i>exact matching</i>
12130	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12131	(including leading zeroes).
12132	</desc>
12133	</attribute>
12134
12135	<attribute name="productId" type="wstring">
12136	<desc>
12137	<link to="IUSBDevice::productId">Product ID</link> filter.
12138	The string representation for the <i>exact matching</i>
12139	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12140	(including leading zeroes).
12141	</desc>
12142	</attribute>
12143
12144	<attribute name="revision" type="wstring">
12145	<desc>
12146	<link to="IUSBDevice::productId">Product revision number</link>
12147	filter. The string representation for the <i>exact matching</i>
12148	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12149	of the integer part of the revision, and <tt>F</tt> is the
12150	decimal digit of its fractional part (including leading and
12151	trailing zeros).
12152	Note that for interval filters, it's best to use the hexadecimal
12153	form, because the revision is stored as a 16 bit packed BCD value;
12154	so the expression <tt>int:0x0100-0x0199</tt> will match any
12155	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12156	</desc>
12157	</attribute>
12158
12159	<attribute name="manufacturer" type="wstring">
12160	<desc>
12161	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12162	</desc>
12163	</attribute>
12164
12165	<attribute name="product" type="wstring">
12166	<desc>
12167	<link to="IUSBDevice::product">Product</link> filter.
12168	</desc>
12169	</attribute>
12170
12171	<attribute name="serialNumber" type="wstring">
12172	<desc>
12173	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12174	</desc>
12175	</attribute>
12176
12177	<attribute name="port" type="wstring">
12178	<desc>
12179	<link to="IUSBDevice::port">Host USB port</link> filter.
12180	</desc>
12181	</attribute>
12182
12183	<attribute name="remote" type="wstring">
12184	<desc>
12185	<link to="IUSBDevice::remote">Remote state</link> filter.
12186	<note>
12187	This filter makes sense only for machine USB filters,
12188	i.e. it is ignored by IHostUSBDeviceFilter objects.
12189	</note>
12190	</desc>
12191	</attribute>
12192
12193	<attribute name="maskedInterfaces" type="unsigned long">
12194	<desc>
12195	This is an advanced option for hiding one or more USB interfaces
12196	from the guest. The value is a bit mask where the bits that are set
12197	means the corresponding USB interface should be hidden, masked off
12198	if you like.
12199	This feature only works on Linux hosts.
12200	</desc>
12201	</attribute>
12202
12203	</interface>
12204
12205
12206	<!--
12207	// IHostUSBDevice
12208	/////////////////////////////////////////////////////////////////////////
12209	-->
12210
12211	<enum
12212	name="USBDeviceState"
12213	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12214	>
12215	<desc>
12216	USB device state. This enumeration represents all possible states
12217	of the USB device physically attached to the host computer regarding
12218	its state on the host computer and availability to guest computers
12219	(all currently running virtual machines).
12220
12221	Once a supported USB device is attached to the host, global USB
12222	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12223	either ignore the device, or put it to USBDeviceState_Held state, or do
12224	nothing. Unless the device is ignored by global filters, filters of all
12225	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12226	activated that can put it to USBDeviceState_Captured state.
12227
12228	If the device was ignored by global filters, or didn't match
12229	any filters at all (including guest ones), it is handled by the host
12230	in a normal way. In this case, the device state is determined by
12231	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12232	or USBDeviceState_Available, depending on the current device usage.
12233
12234	Besides auto-capturing based on filters, the device can be manually
12235	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12236	state is USBDeviceState_Busy, USBDeviceState_Available or
12237	USBDeviceState_Held.
12238
12239	<note>
12240	Due to differences in USB stack implementations in Linux and Win32,
12241	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12242	only to the Linux version of the product. This also means that (<link
12243	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12244	device state is USBDeviceState_Held.
12245	</note>
12246
12247	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12248	</desc>
12249
12250	<const name="NotSupported" value="0">
12251	<desc>
12252	Not supported by the VirtualBox server, not available to guests.
12253	</desc>
12254	</const>
12255	<const name="Unavailable" value="1">
12256	<desc>
12257	Being used by the host computer exclusively,
12258	not available to guests.
12259	</desc>
12260	</const>
12261	<const name="Busy" value="2">
12262	<desc>
12263	Being used by the host computer, potentially available to guests.
12264	</desc>
12265	</const>
12266	<const name="Available" value="3">
12267	<desc>
12268	Not used by the host computer, available to guests (the host computer
12269	can also start using the device at any time).
12270	</desc>
12271	</const>
12272	<const name="Held" value="4">
12273	<desc>
12274	Held by the VirtualBox server (ignored by the host computer),
12275	available to guests.
12276	</desc>
12277	</const>
12278	<const name="Captured" value="5">
12279	<desc>
12280	Captured by one of the guest computers, not available
12281	to anybody else.
12282	</desc>
12283	</const>
12284	</enum>
12285
12286	<interface
12287	name="IHostUSBDevice" extends="IUSBDevice"
12288	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12289	wsmap="managed"
12290	>
12291	<desc>
12292	The IHostUSBDevice interface represents a physical USB device attached
12293	to the host computer.
12294
12295	Besides properties inherited from IUSBDevice, this interface adds the
12296	<link to="#state"/> property that holds the current state of the USB
12297	device.
12298
12299	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12300	</desc>
12301
12302	<attribute name="state" type="USBDeviceState" readonly="yes">
12303	<desc>
12304	Current state of the device.
12305	</desc>
12306	</attribute>
12307
12308	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12309
12310	</interface>
12311
12312
12313	<!--
12314	// IHostUSBDeviceFilter
12315	/////////////////////////////////////////////////////////////////////////
12316	-->
12317
12318	<enum
12319	name="USBDeviceFilterAction"
12320	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12321	>
12322	<desc>
12323	Actions for host USB device filters.
12324	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12325	</desc>
12326
12327	<const name="Null" value="0">
12328	<desc>Null value (never used by the API).</desc>
12329	</const>
12330	<const name="Ignore" value="1">
12331	<desc>Ignore the matched USB device.</desc>
12332	</const>
12333	<const name="Hold" value="2">
12334	<desc>Hold the matched USB device.</desc>
12335	</const>
12336	</enum>
12337
12338	<interface
12339	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12340	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12341	wsmap="managed"
12342	>
12343	<desc>
12344	The IHostUSBDeviceFilter interface represents a global filter for a
12345	physical USB device used by the host computer. Used indirectly in
12346	<link to="IHost::USBDeviceFilters"/>.
12347
12348	Using filters of this type, the host computer determines the initial
12349	state of the USB device after it is physically attached to the
12350	host's USB controller.
12351
12352	<note>
12353	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12354	filters, because it makes sense only for
12355	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12356	</note>
12357
12358	<see>IHost::USBDeviceFilters</see>
12359	</desc>
12360
12361	<attribute name="action" type="USBDeviceFilterAction">
12362	<desc>
12363	Action performed by the host when an attached USB device
12364	matches this filter.
12365	</desc>
12366	</attribute>
12367
12368	</interface>
12369
12370	<!--
12371	// IAudioAdapter
12372	/////////////////////////////////////////////////////////////////////////
12373	-->
12374
12375	<enum
12376	name="AudioDriverType"
12377	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12378	>
12379	<desc>
12380	Host audio driver type.
12381	</desc>
12382
12383	<const name="Null" value="0">
12384	<desc>Null value, also means "dummy audio driver".</desc>
12385	</const>
12386	<const name="WinMM" value="1">
12387	<desc>Windows multimedia (Windows hosts only).</desc>
12388	</const>
12389	<const name="OSS" value="2">
12390	<desc>Open Sound System (Linux hosts only).</desc>
12391	</const>
12392	<const name="ALSA" value="3">
12393	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12394	</const>
12395	<const name="DirectSound" value="4">
12396	<desc>DirectSound (Windows hosts only).</desc>
12397	</const>
12398	<const name="CoreAudio" value="5">
12399	<desc>CoreAudio (Mac hosts only).</desc>
12400	</const>
12401	<const name="MMPM" value="6">
12402	<desc>Reserved for historical reasons.</desc>
12403	</const>
12404	<const name="Pulse" value="7">
12405	<desc>PulseAudio (Linux hosts only).</desc>
12406	</const>
12407	<const name="SolAudio" value="8">
12408	<desc>Solaris audio (Solaris hosts only).</desc>
12409	</const>
12410	</enum>
12411
12412	<enum
12413	name="AudioControllerType"
12414	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12415	>
12416	<desc>
12417	Virtual audio controller type.
12418	</desc>
12419
12420	<const name="AC97" value="0"/>
12421	<const name="SB16" value="1"/>
12422	<const name="HDA" value="2"/>
12423	</enum>
12424
12425	<interface
12426	name="IAudioAdapter" extends="$unknown"
12427	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
12428	wsmap="managed"
12429	>
12430	<desc>
12431	The IAudioAdapter interface represents the virtual audio adapter of
12432	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
12433	</desc>
12434	<attribute name="enabled" type="boolean">
12435	<desc>
12436	Flag whether the audio adapter is present in the
12437	guest system. If disabled, the virtual guest hardware will
12438	not contain any audio adapter. Can only be changed when
12439	the VM is not running.
12440	</desc>
12441	</attribute>
12442	<attribute name="audioController" type="AudioControllerType">
12443	<desc>
12444	The audio hardware we emulate.
12445	</desc>
12446	</attribute>
12447	<attribute name="audioDriver" type="AudioDriverType">
12448	<desc>
12449	Audio driver the adapter is connected to. This setting
12450	can only be changed when the VM is not running.
12451	</desc>
12452	</attribute>
12453	</interface>
12454
12455	<enum
12456	name="AuthType"
12457	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
12458	>
12459	<desc>
12460	VirtualBox authentication type.
12461	</desc>
12462
12463	<const name="Null" value="0">
12464	<desc>Null value, also means "no authentication".</desc>
12465	</const>
12466	<const name="External" value="1"/>
12467	<const name="Guest" value="2"/>
12468	</enum>
12469
12470	<!--
12471	// IVRDEServer
12472	/////////////////////////////////////////////////////////////////////////
12473	-->
12474
12475	<interface
12476	name="IVRDEServer" extends="$unknown"
12477	uuid="f68a6b34-6f09-4040-8de1-e8d746c4a9ea"
12478	wsmap="managed"
12479	>
12480	<attribute name="enabled" type="boolean">
12481	<desc>VRDE server status.</desc>
12482	</attribute>
12483
12484	<attribute name="authType" type="AuthType">
12485	<desc>VRDE authentication method.</desc>
12486	</attribute>
12487
12488	<attribute name="authTimeout" type="unsigned long">
12489	<desc>Timeout for guest authentication. Milliseconds.</desc>
12490	</attribute>
12491
12492	<attribute name="allowMultiConnection" type="boolean">
12493	<desc>
12494	Flag whether multiple simultaneous connections to the VM are permitted.
12495	Note that this will be replaced by a more powerful mechanism in the future.
12496	</desc>
12497	</attribute>
12498
12499	<attribute name="reuseSingleConnection" type="boolean">
12500	<desc>
12501	Flag whether the existing connection must be dropped and a new connection
12502	must be established by the VRDE server, when a new client connects in single
12503	connection mode.
12504	</desc>
12505	</attribute>
12506
12507	<attribute name="videoChannel" type="boolean">
12508	<desc>
12509	Flag whether video redirectiron channel is enabled.
12510	</desc>
12511	</attribute>
12512
12513	<attribute name="videoChannelQuality" type="unsigned long">
12514	<desc>
12515	Image quality in percents.
12516	</desc>
12517	</attribute>
12518
12519	<attribute name="VRDELibrary" type="wstring">
12520	<desc>
12521	VRDE library used by this VM. Overrides
12522	<link to="ISystemProperties::defaultVRDELibrary"/>.
12523	</desc>
12524	</attribute>
12525
12526	<method name="setVRDEProperty">
12527	<desc>
12528	Sets a VRDE specific property string.
12529
12530	If you pass @c null or empty string as a key @a value, the given @a key
12531	will be deleted.
12532
12533	</desc>
12534	<param name="key" type="wstring" dir="in">
12535	<desc>Name of the key to set.</desc>
12536	</param>
12537	<param name="value" type="wstring" dir="in">
12538	<desc>Value to assign to the key.</desc>
12539	</param>
12540	</method>
12541
12542	<method name="getVRDEProperty">
12543	<desc>
12544	Returns a VRDE specific property string.
12545
12546	If the requested data @a key does not exist, this function will
12547	succeed and return an empty string in the @a value argument.
12548
12549	</desc>
12550	<param name="key" type="wstring" dir="in">
12551	<desc>Name of the key to get.</desc>
12552	</param>
12553	<param name="value" type="wstring" dir="return">
12554	<desc>Value of the requested key.</desc>
12555	</param>
12556	</method>
12557
12558	</interface>
12559
12560
12561	<!--
12562	// ISharedFolder
12563	/////////////////////////////////////////////////////////////////////////
12564	-->
12565
12566	<interface
12567	name="ISharedFolder" extends="$unknown"
12568	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
12569	wsmap="struct"
12570	>
12571	<desc>
12572	The ISharedFolder interface represents a folder in the host computer's
12573	file system accessible from the guest OS running inside a virtual
12574	machine using an associated logical name.
12575
12576	There are three types of shared folders:
12577	<ul>
12578	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
12579	folders available to all virtual machines.</li>
12580	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
12581	VM-specific shared folders available to the given virtual machine at
12582	startup.</li>
12583	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
12584	VM-specific shared folders created in the session context (for
12585	example, when the virtual machine is running) and automatically
12586	discarded when the session is closed (the VM is powered off).</li>
12587	</ul>
12588
12589	Logical names of shared folders must be unique within the given scope
12590	(global, permanent or transient). However, they do not need to be unique
12591	across scopes. In this case, the definition of the shared folder in a
12592	more specific scope takes precedence over definitions in all other
12593	scopes. The order of precedence is (more specific to more general):
12594	<ol>
12595	<li>Transient definitions</li>
12596	<li>Permanent definitions</li>
12597	<li>Global definitions</li>
12598	</ol>
12599
12600	For example, if MyMachine has a shared folder named
12601	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
12602	transient shared folder named <tt>C_DRIVE</tt> (that points
12603	to <tt>C:\\\\WINDOWS</tt>) will change the definition
12604	of <tt>C_DRIVE</tt> in the guest OS so
12605	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
12606	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
12607	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
12608	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
12609	to <tt>C:\\</tt> if it still exists.
12610
12611	Note that permanent and transient shared folders of different machines
12612	are in different name spaces, so they don't overlap and don't need to
12613	have unique logical names.
12614
12615	<note>
12616	Global shared folders are not implemented in the current version of the
12617	product.
12618	</note>
12619	</desc>
12620
12621	<attribute name="name" type="wstring" readonly="yes">
12622	<desc>Logical name of the shared folder.</desc>
12623	</attribute>
12624
12625	<attribute name="hostPath" type="wstring" readonly="yes">
12626	<desc>Full path to the shared folder in the host file system.</desc>
12627	</attribute>
12628
12629	<attribute name="accessible" type="boolean" readonly="yes">
12630	<desc>
12631	Whether the folder defined by the host path is currently
12632	accessible or not.
12633	For example, the folder can be inaccessible if it is placed
12634	on the network share that is not available by the time
12635	this property is read.
12636	</desc>
12637	</attribute>
12638
12639	<attribute name="writable" type="boolean" readonly="yes">
12640	<desc>
12641	Whether the folder defined by the host path is writable or
12642	not.
12643	</desc>
12644	</attribute>
12645
12646	<attribute name="autoMount" type="boolean" readonly="yes">
12647	<desc>
12648	Whether the folder gets automatically mounted by the guest or not.
12649	</desc>
12650	</attribute>
12651
12652	<attribute name="lastAccessError" type="wstring" readonly="yes">
12653	<desc>
12654	Text message that represents the result of the last accessibility
12655	check.
12656
12657	Accessibility checks are performed each time the <link to="#accessible"/>
12658	attribute is read. An empty string is returned if the last
12659	accessibility check was successful. A non-empty string indicates a
12660	failure and should normally describe a reason of the failure (for
12661	example, a file read error).
12662	</desc>
12663	</attribute>
12664
12665	</interface>
12666
12667	<!--
12668	// ISession
12669	/////////////////////////////////////////////////////////////////////////
12670	-->
12671
12672	<interface
12673	name="IInternalSessionControl" extends="$unknown"
12674	uuid="06ef98a7-f7c0-45ba-bf99-9aca7a4d5530"
12675	internal="yes"
12676	wsmap="suppress"
12677	>
12678	<method name="getPID">
12679	<desc>PID of the process that has created this Session object.
12680	</desc>
12681	<param name="pid" type="unsigned long" dir="return"/>
12682	</method>
12683
12684	<method name="getRemoteConsole">
12685	<desc>
12686	Returns the console object suitable for remote control.
12687
12688	<result name="VBOX_E_INVALID_VM_STATE">
12689	Session state prevents operation.
12690	</result>
12691	<result name="VBOX_E_INVALID_OBJECT_STATE">
12692	Session type prevents operation.
12693	</result>
12694
12695	</desc>
12696	<param name="console" type="IConsole" dir="return"/>
12697	</method>
12698
12699	<method name="assignMachine">
12700	<desc>
12701	Assigns the machine object associated with this direct-type
12702	session or informs the session that it will be a remote one
12703	(if @a machine == @c null).
12704
12705	<result name="VBOX_E_INVALID_VM_STATE">
12706	Session state prevents operation.
12707	</result>
12708	<result name="VBOX_E_INVALID_OBJECT_STATE">
12709	Session type prevents operation.
12710	</result>
12711
12712	</desc>
12713	<param name="machine" type="IMachine" dir="in"/>
12714	</method>
12715
12716	<method name="assignRemoteMachine">
12717	<desc>
12718	Assigns the machine and the (remote) console object associated with
12719	this remote-type session.
12720
12721	<result name="VBOX_E_INVALID_VM_STATE">
12722	Session state prevents operation.
12723	</result>
12724
12725	</desc>
12726	<param name="machine" type="IMachine" dir="in"/>
12727	<param name="console" type="IConsole" dir="in"/>
12728	</method>
12729
12730	<method name="updateMachineState">
12731	<desc>
12732	Updates the machine state in the VM process.
12733	Must be called only in certain cases
12734	(see the method implementation).
12735
12736	<result name="VBOX_E_INVALID_VM_STATE">
12737	Session state prevents operation.
12738	</result>
12739	<result name="VBOX_E_INVALID_OBJECT_STATE">
12740	Session type prevents operation.
12741	</result>
12742
12743	</desc>
12744	<param name="aMachineState" type="MachineState" dir="in"/>
12745	</method>
12746
12747	<method name="uninitialize">
12748	<desc>
12749	Uninitializes (closes) this session. Used by VirtualBox to close
12750	the corresponding remote session when the direct session dies
12751	or gets closed.
12752
12753	<result name="VBOX_E_INVALID_VM_STATE">
12754	Session state prevents operation.
12755	</result>
12756
12757	</desc>
12758	</method>
12759
12760	<method name="onNetworkAdapterChange">
12761	<desc>
12762	Triggered when settings of a network adapter of the
12763	associated virtual machine have changed.
12764
12765	<result name="VBOX_E_INVALID_VM_STATE">
12766	Session state prevents operation.
12767	</result>
12768	<result name="VBOX_E_INVALID_OBJECT_STATE">
12769	Session type prevents operation.
12770	</result>
12771
12772	</desc>
12773	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
12774	<param name="changeAdapter" type="boolean" dir="in"/>
12775	</method>
12776
12777	<method name="onSerialPortChange">
12778	<desc>
12779	Triggered when settings of a serial port of the
12780	associated virtual machine have changed.
12781
12782	<result name="VBOX_E_INVALID_VM_STATE">
12783	Session state prevents operation.
12784	</result>
12785	<result name="VBOX_E_INVALID_OBJECT_STATE">
12786	Session type prevents operation.
12787	</result>
12788
12789	</desc>
12790	<param name="serialPort" type="ISerialPort" dir="in"/>
12791	</method>
12792
12793	<method name="onParallelPortChange">
12794	<desc>
12795	Triggered when settings of a parallel port of the
12796	associated virtual machine have changed.
12797
12798	<result name="VBOX_E_INVALID_VM_STATE">
12799	Session state prevents operation.
12800	</result>
12801	<result name="VBOX_E_INVALID_OBJECT_STATE">
12802	Session type prevents operation.
12803	</result>
12804
12805	</desc>
12806	<param name="parallelPort" type="IParallelPort" dir="in"/>
12807	</method>
12808
12809	<method name="onStorageControllerChange">
12810	<desc>
12811	Triggered when settings of a storage controller of the
12812	associated virtual machine have changed.
12813
12814	<result name="VBOX_E_INVALID_VM_STATE">
12815	Session state prevents operation.
12816	</result>
12817	<result name="VBOX_E_INVALID_OBJECT_STATE">
12818	Session type prevents operation.
12819	</result>
12820
12821	</desc>
12822	</method>
12823
12824	<method name="onMediumChange">
12825	<desc>
12826	Triggered when attached media of the
12827	associated virtual machine have changed.
12828
12829	<result name="VBOX_E_INVALID_VM_STATE">
12830	Session state prevents operation.
12831	</result>
12832	<result name="VBOX_E_INVALID_OBJECT_STATE">
12833	Session type prevents operation.
12834	</result>
12835
12836	</desc>
12837
12838	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
12839	<param name="force" type="boolean" dir="in"/>
12840	</method>
12841
12842	<method name="onCPUChange">
12843	<desc>
12844	Notification when a CPU changes.
12845	</desc>
12846	<param name="cpu" type="unsigned long" dir="in">
12847	<desc>The CPU which changed</desc>
12848	</param>
12849	<param name="add" type="boolean" dir="in">
12850	<desc>Flag whether the CPU was added or removed</desc>
12851	</param>
12852	</method>
12853
12854	<method name="onCPUExecutionCapChange">
12855	<desc>
12856	Notification when the CPU execution cap changes.
12857	</desc>
12858	<param name="executionCap" type="unsigned long" dir="in">
12859	<desc>The new CPU execution cap value. (1-100)</desc>
12860	</param>
12861	</method>
12862
12863	<method name="onVRDEServerChange">
12864	<desc>
12865	Triggered when settings of the VRDE server object of the
12866	associated virtual machine have changed.
12867
12868	<result name="VBOX_E_INVALID_VM_STATE">
12869	Session state prevents operation.
12870	</result>
12871	<result name="VBOX_E_INVALID_OBJECT_STATE">
12872	Session type prevents operation.
12873	</result>
12874
12875	</desc>
12876	<param name="restart" type="boolean" dir="in">
12877	<desc>Flag whether the server must be restarted</desc>
12878	</param>
12879	</method>
12880
12881	<method name="onUSBControllerChange">
12882	<desc>
12883	Triggered when settings of the USB controller object of the
12884	associated virtual machine have changed.
12885
12886	<result name="VBOX_E_INVALID_VM_STATE">
12887	Session state prevents operation.
12888	</result>
12889	<result name="VBOX_E_INVALID_OBJECT_STATE">
12890	Session type prevents operation.
12891	</result>
12892
12893	</desc>
12894	</method>
12895
12896	<method name="onSharedFolderChange">
12897	<desc>
12898	Triggered when a permanent (global or machine) shared folder has been
12899	created or removed.
12900	<note>
12901	We don't pass shared folder parameters in this notification because
12902	the order in which parallel notifications are delivered is not defined,
12903	therefore it could happen that these parameters were outdated by the
12904	time of processing this notification.
12905	</note>
12906
12907	<result name="VBOX_E_INVALID_VM_STATE">
12908	Session state prevents operation.
12909	</result>
12910	<result name="VBOX_E_INVALID_OBJECT_STATE">
12911	Session type prevents operation.
12912	</result>
12913
12914	</desc>
12915	<param name="global" type="boolean" dir="in"/>
12916	</method>
12917
12918	<method name="onUSBDeviceAttach">
12919	<desc>
12920	Triggered when a request to capture a USB device (as a result
12921	of matched USB filters or direct call to
12922	<link to="IConsole::attachUSBDevice"/>) has completed.
12923	A @c null @a error object means success, otherwise it
12924	describes a failure.
12925
12926	<result name="VBOX_E_INVALID_VM_STATE">
12927	Session state prevents operation.
12928	</result>
12929	<result name="VBOX_E_INVALID_OBJECT_STATE">
12930	Session type prevents operation.
12931	</result>
12932
12933	</desc>
12934	<param name="device" type="IUSBDevice" dir="in"/>
12935	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12936	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
12937	</method>
12938
12939	<method name="onUSBDeviceDetach">
12940	<desc>
12941	Triggered when a request to release the USB device (as a result
12942	of machine termination or direct call to
12943	<link to="IConsole::detachUSBDevice"/>) has completed.
12944	A @c null @a error object means success, otherwise it
12945	describes a failure.
12946
12947	<result name="VBOX_E_INVALID_VM_STATE">
12948	Session state prevents operation.
12949	</result>
12950	<result name="VBOX_E_INVALID_OBJECT_STATE">
12951	Session type prevents operation.
12952	</result>
12953
12954	</desc>
12955	<param name="id" type="uuid" mod="string" dir="in"/>
12956	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
12957	</method>
12958
12959	<method name="onShowWindow">
12960	<desc>
12961	Called by <link to="IMachine::canShowConsoleWindow"/> and by
12962	<link to="IMachine::showConsoleWindow"/> in order to notify
12963	console listeners
12964	<link to="ICanShowWindowEvent"/>
12965	and <link to="IShowWindowEvent"/>.
12966
12967	<result name="VBOX_E_INVALID_OBJECT_STATE">
12968	Session type prevents operation.
12969	</result>
12970
12971	</desc>
12972	<param name="check" type="boolean" dir="in"/>
12973	<param name="canShow" type="boolean" dir="out"/>
12974	<param name="winId" type="long long" dir="out"/>
12975	</method>
12976
12977	<method name="accessGuestProperty">
12978	<desc>
12979	Called by <link to="IMachine::getGuestProperty"/> and by
12980	<link to="IMachine::setGuestProperty"/> in order to read and
12981	modify guest properties.
12982
12983	<result name="VBOX_E_INVALID_VM_STATE">
12984	Machine session is not open.
12985	</result>
12986	<result name="VBOX_E_INVALID_OBJECT_STATE">
12987	Session type is not direct.
12988	</result>
12989
12990	</desc>
12991	<param name="name" type="wstring" dir="in"/>
12992	<param name="value" type="wstring" dir="in"/>
12993	<param name="flags" type="wstring" dir="in"/>
12994	<param name="isSetter" type="boolean" dir="in"/>
12995	<param name="retValue" type="wstring" dir="out"/>
12996	<param name="retTimestamp" type="long long" dir="out"/>
12997	<param name="retFlags" type="wstring" dir="out"/>
12998	</method>
12999
13000	<method name="enumerateGuestProperties">
13001	<desc>
13002	Return a list of the guest properties matching a set of patterns along
13003	with their values, time stamps and flags.
13004
13005	<result name="VBOX_E_INVALID_VM_STATE">
13006	Machine session is not open.
13007	</result>
13008	<result name="VBOX_E_INVALID_OBJECT_STATE">
13009	Session type is not direct.
13010	</result>
13011
13012	</desc>
13013	<param name="patterns" type="wstring" dir="in">
13014	<desc>
13015	The patterns to match the properties against as a comma-separated
13016	string. If this is empty, all properties currently set will be
13017	returned.
13018	</desc>
13019	</param>
13020	<param name="key" type="wstring" dir="out" safearray="yes">
13021	<desc>
13022	The key names of the properties returned.
13023	</desc>
13024	</param>
13025	<param name="value" type="wstring" dir="out" safearray="yes">
13026	<desc>
13027	The values of the properties returned. The array entries match the
13028	corresponding entries in the @a key array.
13029	</desc>
13030	</param>
13031	<param name="timestamp" type="long long" dir="out" safearray="yes">
13032	<desc>
13033	The time stamps of the properties returned. The array entries match
13034	the corresponding entries in the @a key array.
13035	</desc>
13036	</param>
13037	<param name="flags" type="wstring" dir="out" safearray="yes">
13038	<desc>
13039	The flags of the properties returned. The array entries match the
13040	corresponding entries in the @a key array.
13041	</desc>
13042	</param>
13043	</method>
13044
13045	<method name="onlineMergeMedium">
13046	<desc>
13047	Triggers online merging of a hard disk. Used internally when deleting
13048	a snapshot while a VM referring to the same hard disk chain is running.
13049
13050	<result name="VBOX_E_INVALID_VM_STATE">
13051	Machine session is not open.
13052	</result>
13053	<result name="VBOX_E_INVALID_OBJECT_STATE">
13054	Session type is not direct.
13055	</result>
13056
13057	</desc>
13058	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13059	<desc>The medium attachment to identify the medium chain.</desc>
13060	</param>
13061	<param name="sourceIdx" type="unsigned long" dir="in">
13062	<desc>The index of the source image in the chain.
13063	Redundant, but drastically reduces IPC.</desc>
13064	</param>
13065	<param name="targetIdx" type="unsigned long" dir="in">
13066	<desc>The index of the target image in the chain.
13067	Redundant, but drastically reduces IPC.</desc>
13068	</param>
13069	<param name="source" type="IMedium" dir="in">
13070	<desc>Merge source medium.</desc>
13071	</param>
13072	<param name="target" type="IMedium" dir="in">
13073	<desc>Merge target medium.</desc>
13074	</param>
13075	<param name="mergeForward" type="boolean" dir="in">
13076	<desc>Merge direction.</desc>
13077	</param>
13078	<param name="parentForTarget" type="IMedium" dir="in">
13079	<desc>For forward merges: new parent for target medium.</desc>
13080	</param>
13081	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13082	<desc>For backward merges: list of media which need their parent UUID
13083	updated.</desc>
13084	</param>
13085	<param name="progress" type="IProgress" dir="in">
13086	<desc>
13087	Progress object for this operation.
13088	</desc>
13089	</param>
13090	</method>
13091
13092	</interface>
13093
13094	<interface
13095	name="ISession" extends="$unknown"
13096	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13097	wsmap="managed"
13098	>
13099	<desc>
13100	The ISession interface represents a client process and allows for locking
13101	virtual machines (represented by IMachine objects) to prevent conflicting
13102	changes to the machine.
13103
13104	Any caller wishing to manipulate a virtual machine needs to create a session
13105	object first, which lives in its own process space. Such session objects are
13106	then associated with <link to="IMachine" /> objects living in the VirtualBox
13107	server process to coordinate such changes.
13108
13109	There are two typical scenarios in which sessions are used:
13110
13111	<ul>
13112	<li>To alter machine settings or control a running virtual machine, one
13113	needs to lock a machine for a given session (client process) by calling
13114	<link to="IMachine::lockMachine"/>.
13115
13116	Whereas multiple sessions may control a running virtual machine, only
13117	one process can obtain a write lock on the machine to prevent conflicting
13118	changes. A write lock is also needed if a process wants to actually run a
13119	virtual machine in its own context, such as the VirtualBox GUI or
13120	VBoxHeadless front-ends. They must also lock a machine for their own
13121	sessions before they are allowed to power up the virtual machine.
13122
13123	As a result, no machine settings can be altered while another process is
13124	already using it, either because that process is modifying machine settings
13125	or because the machine is running.
13126	</li>
13127	<li>
13128	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13129	VirtualBox GUI or VBoxHeadless), one would use
13130	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13131	as its first parameter. This session then identifies the caller and lets the
13132	caller control the started machine (for example, pause machine execution or
13133	power it down) as well as be notified about machine execution state changes.
13134	</li>
13135	</ul>
13136
13137	How sessions objects are created in a client process depends on whether you use
13138	the Main API via COM or via the webservice:
13139
13140	<ul>
13141	<li>When using the COM API directly, an object of the Session class from the
13142	VirtualBox type library needs to be created. In regular COM C++ client code,
13143	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13144	This object will then act as a local session object in further calls to open
13145	a session.
13146	</li>
13147
13148	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13149	a session object automatically whenever <link to="IWebsessionManager::logon" />
13150	is called. A managed object reference to that session object can be retrieved by
13151	calling <link to="IWebsessionManager::getSessionObject" />.
13152	</li>
13153	</ul>
13154	</desc>
13155
13156	<attribute name="state" type="SessionState" readonly="yes">
13157	<desc>Current state of this session.</desc>
13158	</attribute>
13159
13160	<attribute name="type" type="SessionType" readonly="yes">
13161	<desc>
13162	Type of this session. The value of this attribute is valid only
13163	if the session currently has a machine locked (i.e. its
13164	<link to="#state" /> is Locked), otherwise an error will be returned.
13165	</desc>
13166	</attribute>
13167
13168	<attribute name="machine" type="IMachine" readonly="yes">
13169	<desc>Machine object associated with this session.</desc>
13170	</attribute>
13171
13172	<attribute name="console" type="IConsole" readonly="yes">
13173	<desc>Console object associated with this session.</desc>
13174	</attribute>
13175
13176	<method name="unlockMachine">
13177	<desc>
13178	Unlocks a machine that was previously locked for the current session.
13179
13180	Calling this method is required every time a machine has been locked
13181	for a particular session using the <link to="IMachine::launchVMProcess" />
13182	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13183	the machine will be set to <link to="MachineState_Aborted" /> on the
13184	server, and changes made to the machine settings will be lost.
13185
13186	Generally, it is recommended to unlock all machines explicitly
13187	before terminating the application (regardless of the reason for
13188	the termination).
13189
13190	<note>
13191	Do not expect the session state (<link to="ISession::state" />
13192	to return to "Unlocked" immediately after you invoke this method,
13193	particularly if you have started a new VM process. The session
13194	state will automatically return to "Unlocked" once the VM is no
13195	longer executing, which can of course take a very long time.
13196	</note>
13197
13198	<result name="E_UNEXPECTED">
13199	Session is not locked.
13200	</result>
13201
13202	</desc>
13203	</method>
13204
13205	</interface>
13206
13207	<!--
13208	// IStorageController
13209	/////////////////////////////////////////////////////////////////////////
13210	-->
13211
13212	<enum
13213	name="StorageBus"
13214	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13215	>
13216	<desc>
13217	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13218	see <link to="IStorageController::bus" />.
13219	</desc>
13220	<const name="Null" value="0">
13221	<desc>@c null value. Never used by the API.</desc>
13222	</const>
13223	<const name="IDE" value="1"/>
13224	<const name="SATA" value="2"/>
13225	<const name="SCSI" value="3"/>
13226	<const name="Floppy" value="4"/>
13227	<const name="SAS" value="5"/>
13228	</enum>
13229
13230	<enum
13231	name="StorageControllerType"
13232	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13233	>
13234	<desc>
13235	The exact variant of storage controller hardware presented
13236	to the guest; see <link to="IStorageController::controllerType" />.
13237	</desc>
13238
13239	<const name="Null" value="0">
13240	<desc>@c null value. Never used by the API.</desc>
13241	</const>
13242	<const name="LsiLogic" value="1">
13243	<desc>A SCSI controller of the LsiLogic variant.</desc>
13244	</const>
13245	<const name="BusLogic" value="2">
13246	<desc>A SCSI controller of the BusLogic variant.</desc>
13247	</const>
13248	<const name="IntelAhci" value="3">
13249	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13250	</const>
13251	<const name="PIIX3" value="4">
13252	<desc>An IDE controller of the PIIX3 variant.</desc>
13253	</const>
13254	<const name="PIIX4" value="5">
13255	<desc>An IDE controller of the PIIX4 variant.</desc>
13256	</const>
13257	<const name="ICH6" value="6">
13258	<desc>An IDE controller of the ICH6 variant.</desc>
13259	</const>
13260	<const name="I82078" value="7">
13261	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13262	</const>
13263	<const name="LsiLogicSas" value="8">
13264	<desc>A variant of the LsiLogic controller using SAS.</desc>
13265	</const>
13266	</enum>
13267
13268	<enum
13269	name="ChipsetType"
13270	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13271	>
13272	<desc>
13273	Type of emulated chipset (mostly southbridge).
13274	</desc>
13275
13276	<const name="Null" value="0">
13277	<desc>@c null value. Never used by the API.</desc>
13278	</const>
13279	<const name="PIIX3" value="1">
13280	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13281	</const>
13282	<const name="ICH9" value="2">
13283	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13284	</const>
13285	</enum>
13286
13287	<interface
13288	name="IStorageController" extends="$unknown"
13289	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
13290	wsmap="managed"
13291	>
13292	<desc>
13293	Represents a storage controller that is attached to a virtual machine
13294	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13295	attached to storage controllers in a real computer, virtual drives
13296	(represented by <link to="IMediumAttachment" />) are attached to virtual
13297	storage controllers, represented by this interface.
13298
13299	As opposed to physical hardware, VirtualBox has a very generic concept
13300	of a storage controller, and for purposes of the Main API, all virtual
13301	storage is attached to virtual machines via instances of this interface.
13302	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13303	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13304	is used, certain sub-types may be available and can be selected in
13305	<link to="#controllerType" />.
13306
13307	Depending on these settings, the guest operating system might see
13308	significantly different virtual hardware.
13309	</desc>
13310
13311	<attribute name="name" type="wstring" readonly="yes">
13312	<desc>
13313	Name of the storage controller, as originally specified with
13314	<link to="IMachine::addStorageController" />. This then uniquely
13315	identifies this controller with other method calls such as
13316	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13317	</desc>
13318	</attribute>
13319
13320	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13321	<desc>
13322	Maximum number of devices which can be attached to one port.
13323	</desc>
13324	</attribute>
13325
13326	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13327	<desc>
13328	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13329	</desc>
13330	</attribute>
13331
13332	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13333	<desc>
13334	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13335	</desc>
13336	</attribute>
13337
13338	<attribute name="instance" type="unsigned long">
13339	<desc>
13340	The instance number of the device in the running VM.
13341	</desc>
13342	</attribute>
13343
13344	<attribute name="portCount" type="unsigned long">
13345	<desc>
13346	The number of currently usable ports on the controller.
13347	The minimum and maximum number of ports for one controller are
13348	stored in <link to="IStorageController::minPortCount"/>
13349	and <link to="IStorageController::maxPortCount"/>.
13350	</desc>
13351	</attribute>
13352
13353	<attribute name="bus" type="StorageBus" readonly="yes">
13354	<desc>
13355	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13356	</desc>
13357	</attribute>
13358
13359	<attribute name="controllerType" type="StorageControllerType">
13360	<desc>
13361	The exact variant of storage controller hardware presented
13362	to the guest.
13363	Depending on this value, VirtualBox will provide a different
13364	virtual storage controller hardware to the guest.
13365	For SATA, SAS and floppy controllers, only one variant is
13366	available, but for IDE and SCSI, there are several.
13367
13368	For SCSI controllers, the default type is LsiLogic.
13369	</desc>
13370	</attribute>
13371
13372	<attribute name="useHostIOCache" type="boolean">
13373	<desc>
13374	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13375	caches and use synchronous file APIs on the host. This was the only option in the API before
13376	VirtualBox 3.2 and is still the default for IDE controllers.
13377
13378	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13379	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13380	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13381	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13382	virtual machines are running at the same time to prevent I/O cache related hangs.
13383	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13384	</desc>
13385	</attribute>
13386
13387	<attribute name="bootable" type="boolean" readonly="yes">
13388	<desc>
13389	Returns whether it is possible to boot from disks attached to this controller.
13390	</desc>
13391	</attribute>
13392
13393	<method name="getIDEEmulationPort">
13394	<desc>
13395	Gets the corresponding port number which is emulated as an IDE device.
13396	Works only with SATA controllers.
13397
13398	<result name="E_INVALIDARG">
13399	The @a devicePosition is not in the range 0 to 3.
13400	</result>
13401	<result name="E_NOTIMPL">
13402	The storage controller type is not SATAIntelAhci.
13403	</result>
13404
13405	</desc>
13406	<param name="devicePosition" type="long" dir="in"/>
13407	<param name="portNumber" type="long" dir="return"/>
13408	</method>
13409
13410	<method name="setIDEEmulationPort">
13411	<desc>
13412	Sets the port number which is emulated as an IDE device.
13413	Works only with SATA controllers.
13414
13415	<result name="E_INVALIDARG">
13416	The @a devicePosition is not in the range 0 to 3 or the
13417	@a portNumber is not in the range 0 to 29.
13418	</result>
13419	<result name="E_NOTIMPL">
13420	The storage controller type is not SATAIntelAhci.
13421	</result>
13422
13423	</desc>
13424	<param name="devicePosition" type="long" dir="in"/>
13425	<param name="portNumber" type="long" dir="in"/>
13426	</method>
13427
13428	</interface>
13429
13430	<if target="wsdl">
13431
13432	<!--
13433	// IManagedObjectRef
13434	/////////////////////////////////////////////////////////////////////////
13435	-->
13436
13437	<interface
13438	name="IManagedObjectRef" extends="$unknown"
13439	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
13440	internal="yes"
13441	wsmap="managed"
13442	wscpp="hardcoded"
13443	>
13444	<desc>
13445	Managed object reference.
13446
13447	Only within the webservice, a managed object reference (which is really
13448	an opaque number) allows a webservice client to address an object
13449	that lives in the address space of the webservice server.
13450
13451	Behind each managed object reference, there is a COM object that lives
13452	in the webservice server's address space. The COM object is not freed
13453	until the managed object reference is released, either by an explicit
13454	call to <link to="IManagedObjectRef::release" /> or by logging off from
13455	the webservice (<link to="IWebsessionManager::logoff" />), which releases
13456	all objects created during the webservice session.
13457
13458	Whenever a method call of the VirtualBox API returns a COM object, the
13459	webservice representation of that method will instead return a
13460	managed object reference, which can then be used to invoke methods
13461	on that object.
13462	</desc>
13463
13464	<method name="getInterfaceName">
13465	<desc>
13466	Returns the name of the interface that this managed object represents,
13467	for example, "IMachine", as a string.
13468	</desc>
13469	<param name="return" type="wstring" dir="return"/>
13470	</method>
13471
13472	<method name="release">
13473	<desc>
13474	Releases this managed object reference and frees the resources that
13475	were allocated for it in the webservice server process. After calling
13476	this method, the identifier of the reference can no longer be used.
13477	</desc>
13478	</method>
13479
13480	</interface>
13481
13482	<!--
13483	// IWebsessionManager
13484	/////////////////////////////////////////////////////////////////////////
13485	-->
13486
13487	<interface
13488	name="IWebsessionManager" extends="$unknown"
13489	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
13490	internal="yes"
13491	wsmap="global"
13492	wscpp="hardcoded"
13493	>
13494	<desc>
13495	Websession manager. This provides essential services
13496	to webservice clients.
13497	</desc>
13498	<method name="logon">
13499	<desc>
13500	Logs a new client onto the webservice and returns a managed object reference to
13501	the IVirtualBox instance, which the client can then use as a basis to further
13502	queries, since all calls to the VirtualBox API are based on the IVirtualBox
13503	interface, in one way or the other.
13504	</desc>
13505	<param name="username" type="wstring" dir="in"/>
13506	<param name="password" type="wstring" dir="in"/>
13507	<param name="return" type="IVirtualBox" dir="return"/>
13508	</method>
13509
13510	<method name="getSessionObject">
13511	<desc>
13512	Returns a managed object reference to the internal ISession object that was created
13513	for this web service session when the client logged on.
13514
13515	<see>ISession</see>
13516	</desc>
13517	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13518	<param name="return" type="ISession" dir="return"/>
13519	</method>
13520
13521	<method name="logoff">
13522	<desc>
13523	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
13524	and destroys all resources associated with the session (most importantly, all
13525	managed objects created in the server while the session was active).
13526	</desc>
13527	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
13528	</method>
13529
13530	</interface>
13531
13532	</if>
13533
13534	<!--
13535	// IPerformanceCollector & friends
13536	/////////////////////////////////////////////////////////////////////////
13537	-->
13538
13539	<interface
13540	name="IPerformanceMetric" extends="$unknown"
13541	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
13542	>
13543	<desc>
13544	The IPerformanceMetric interface represents parameters of the given
13545	performance metric.
13546	</desc>
13547
13548	<attribute name="metricName" type="wstring" readonly="yes">
13549	<desc>
13550	Name of the metric.
13551	</desc>
13552	</attribute>
13553
13554	<attribute name="object" type="$unknown" readonly="yes">
13555	<desc>
13556	Object this metric belongs to.
13557	</desc>
13558	</attribute>
13559
13560	<attribute name="description" type="wstring" readonly="yes">
13561	<desc>
13562	Textual description of the metric.
13563	</desc>
13564	</attribute>
13565
13566	<attribute name="period" type="unsigned long" readonly="yes">
13567	<desc>
13568	Time interval between samples, measured in seconds.
13569	</desc>
13570	</attribute>
13571
13572	<attribute name="count" type="unsigned long" readonly="yes">
13573	<desc>
13574	Number of recent samples retained by the performance collector for this
13575	metric.
13576
13577	When the collected sample count exceeds this number, older samples
13578	are discarded.
13579	</desc>
13580	</attribute>
13581
13582	<attribute name="unit" type="wstring" readonly="yes">
13583	<desc>
13584	Unit of measurement.
13585	</desc>
13586	</attribute>
13587
13588	<attribute name="minimumValue" type="long" readonly="yes">
13589	<desc>
13590	Minimum possible value of this metric.
13591	</desc>
13592	</attribute>
13593
13594	<attribute name="maximumValue" type="long" readonly="yes">
13595	<desc>
13596	Maximum possible value of this metric.
13597	</desc>
13598	</attribute>
13599	</interface>
13600
13601	<interface
13602	name="IPerformanceCollector" extends="$unknown"
13603	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
13604	wsmap="managed"
13605	>
13606	<desc>
13607	The IPerformanceCollector interface represents a service that collects
13608	and stores performance metrics data.
13609
13610	Performance metrics are associated with objects of interfaces like IHost
13611	and IMachine. Each object has a distinct set of performance metrics. The
13612	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
13613
13614	Metric data is collected at the specified intervals and is retained
13615	internally. The interval and the number of retained samples can be set
13616	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
13617	and collection settings are not persistent, they are discarded as soon as
13618	VBoxSVC process terminates. Moreover, metric settings and data associated
13619	with a particular VM only exist while VM is running. They disappear as
13620	soon as VM shuts down. It is not possible to set up metrics for machines
13621	that are powered off. One needs to start VM first, then set up metric
13622	collection parameters.
13623
13624	Metrics are organized hierarchically, with each level separated by a
13625	slash (/) character. Generally, the scheme for metric names is like this:
13626
13627	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
13628
13629	"Category/Metric" together form the base metric name. A base metric is
13630	the smallest unit for which a sampling interval and the number of
13631	retained samples can be set. Only base metrics can be enabled and
13632	disabled. All sub-metrics are collected when their base metric is
13633	collected. Collected values for any set of sub-metrics can be queried
13634	with <link to="IPerformanceCollector::queryMetricsData" />.
13635
13636	For example "CPU/Load/User:avg" metric name stands for the "CPU"
13637	category, "Load" metric, "User" submetric, "average" aggregate. An
13638	aggregate function is computed over all retained data. Valid aggregate
13639	functions are:
13640
13641	<ul>
13642	<li>avg -- average</li>
13643	<li>min -- minimum</li>
13644	<li>max -- maximum</li>
13645	</ul>
13646
13647	When setting up metric parameters, querying metric data, enabling or
13648	disabling metrics wildcards can be used in metric names to specify a
13649	subset of metrics. For example, to select all CPU-related metrics
13650	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
13651	so on. To query metric values without aggregates <tt>*:</tt> can be used.
13652
13653	The valid names for base metrics are:
13654
13655	<ul>
13656	<li>CPU/Load</li>
13657	<li>CPU/MHz</li>
13658	<li>RAM/Usage</li>
13659	</ul>
13660
13661	The general sequence for collecting and retrieving the metrics is:
13662	<ul>
13663	<li>
13664	Obtain an instance of IPerformanceCollector with
13665	<link to="IVirtualBox::performanceCollector" />
13666	</li>
13667	<li>
13668	Allocate and populate an array with references to objects the metrics
13669	will be collected for. Use references to IHost and IMachine objects.
13670	</li>
13671	<li>
13672	Allocate and populate an array with base metric names the data will
13673	be collected for.
13674	</li>
13675	<li>
13676	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
13677	the metric data will be collected and stored.
13678	</li>
13679	<li>
13680	Wait for the data to get collected.
13681	</li>
13682	<li>
13683	Allocate and populate an array with references to objects the metric
13684	values will be queried for. You can re-use the object array used for
13685	setting base metrics.
13686	</li>
13687	<li>
13688	Allocate and populate an array with metric names the data will be
13689	collected for. Note that metric names differ from base metric names.
13690	</li>
13691	<li>
13692	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
13693	that have been collected so far are returned. Note that the values
13694	are still retained internally and data collection continues.
13695	</li>
13696	</ul>
13697
13698	For an example of usage refer to the following files in VirtualBox SDK:
13699	<ul>
13700	<li>
13701	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
13702	</li>
13703	<li>
13704	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
13705	</li>
13706	</ul>
13707	</desc>
13708
13709	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
13710	<desc>
13711	Array of unique names of metrics.
13712
13713	This array represents all metrics supported by the performance
13714	collector. Individual objects do not necessarily support all of them.
13715	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
13716	list of supported metrics for a particular object.
13717	</desc>
13718	</attribute>
13719
13720	<method name="getMetrics">
13721	<desc>
13722	Returns parameters of specified metrics for a set of objects.
13723	<note>
13724	@c Null metrics array means all metrics. @c Null object array means
13725	all existing objects.
13726	</note>
13727	</desc>
13728	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13729	<desc>
13730	Metric name filter. Currently, only a comma-separated list of metrics
13731	is supported.
13732	</desc>
13733	</param>
13734	<param name="objects" type="$unknown" dir="in" safearray="yes">
13735	<desc>
13736	Set of objects to return metric parameters for.
13737	</desc>
13738	</param>
13739	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
13740	<desc>
13741	Array of returned metric parameters.
13742	</desc>
13743	</param>
13744	</method>
13745
13746	<method name="setupMetrics">
13747	<desc>
13748	Sets parameters of specified base metrics for a set of objects. Returns
13749	an array of <link to="IPerformanceMetric" /> describing the metrics
13750	have been affected.
13751	<note>
13752	@c Null or empty metric name array means all metrics. @c Null or
13753	empty object array means all existing objects. If metric name array
13754	contains a single element and object array contains many, the single
13755	metric name array element is applied to each object array element to
13756	form metric/object pairs.
13757	</note>
13758	</desc>
13759	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13760	<desc>
13761	Metric name filter. Comma-separated list of metrics with wildcard
13762	support.
13763	</desc>
13764	</param>
13765	<param name="objects" type="$unknown" dir="in" safearray="yes">
13766	<desc>
13767	Set of objects to setup metric parameters for.
13768	</desc>
13769	</param>
13770	<param name="period" type="unsigned long" dir="in">
13771	<desc>
13772	Time interval in seconds between two consecutive samples of
13773	performance data.
13774	</desc>
13775	</param>
13776	<param name="count" type="unsigned long" dir="in">
13777	<desc>
13778	Number of samples to retain in performance data history. Older
13779	samples get discarded.
13780	</desc>
13781	</param>
13782	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13783	<desc>
13784	Array of metrics that have been modified by the call to this method.
13785	</desc>
13786	</param>
13787	</method>
13788
13789	<method name="enableMetrics">
13790	<desc>
13791	Turns on collecting specified base metrics. Returns an array of
13792	<link to="IPerformanceMetric" /> describing the metrics have been
13793	affected.
13794	<note>
13795	@c Null or empty metric name array means all metrics. @c Null or
13796	empty object array means all existing objects. If metric name array
13797	contains a single element and object array contains many, the single
13798	metric name array element is applied to each object array element to
13799	form metric/object pairs.
13800	</note>
13801	</desc>
13802	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13803	<desc>
13804	Metric name filter. Comma-separated list of metrics with wildcard
13805	support.
13806	</desc>
13807	</param>
13808	<param name="objects" type="$unknown" dir="in" safearray="yes">
13809	<desc>
13810	Set of objects to enable metrics for.
13811	</desc>
13812	</param>
13813	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13814	<desc>
13815	Array of metrics that have been modified by the call to this method.
13816	</desc>
13817	</param>
13818	</method>
13819
13820	<method name="disableMetrics">
13821	<desc>
13822	Turns off collecting specified base metrics. Returns an array of
13823	<link to="IPerformanceMetric" /> describing the metrics have been
13824	affected.
13825	<note>
13826	@c Null or empty metric name array means all metrics. @c Null or
13827	empty object array means all existing objects. If metric name array
13828	contains a single element and object array contains many, the single
13829	metric name array element is applied to each object array element to
13830	form metric/object pairs.
13831	</note>
13832	</desc>
13833	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13834	<desc>
13835	Metric name filter. Comma-separated list of metrics with wildcard
13836	support.
13837	</desc>
13838	</param>
13839	<param name="objects" type="$unknown" dir="in" safearray="yes">
13840	<desc>
13841	Set of objects to disable metrics for.
13842	</desc>
13843	</param>
13844	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
13845	<desc>
13846	Array of metrics that have been modified by the call to this method.
13847	</desc>
13848	</param>
13849	</method>
13850
13851	<method name="queryMetricsData">
13852	<desc>
13853	Queries collected metrics data for a set of objects.
13854
13855	The data itself and related metric information are returned in seven
13856	parallel and one flattened array of arrays. Elements of
13857	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
13858	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
13859	the same index describe one set of values corresponding to a single
13860	metric.
13861
13862	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
13863	start and length of a sub-array is indicated by
13864	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
13865	value for metric <tt>metricNames[i]</tt> is at
13866	<tt>returnData[returnIndices[i]]</tt>.
13867
13868	<note>
13869	@c Null or empty metric name array means all metrics. @c Null or
13870	empty object array means all existing objects. If metric name array
13871	contains a single element and object array contains many, the single
13872	metric name array element is applied to each object array element to
13873	form metric/object pairs.
13874	</note>
13875	<note>
13876	Data collection continues behind the scenes after call to @c
13877	queryMetricsData. The return data can be seen as the snapshot of the
13878	current state at the time of @c queryMetricsData call. The internally
13879	kept metric values are not cleared by the call. This makes possible
13880	querying different subsets of metrics or aggregates with subsequent
13881	calls. If periodic querying is needed it is highly suggested to query
13882	the values with @c interval*count period to avoid confusion. This way
13883	a completely new set of data values will be provided by each query.
13884	</note>
13885	</desc>
13886	<param name="metricNames" type="wstring" dir="in" safearray="yes">
13887	<desc>
13888	Metric name filter. Comma-separated list of metrics with wildcard
13889	support.
13890	</desc>
13891	</param>
13892	<param name="objects" type="$unknown" dir="in" safearray="yes">
13893	<desc>
13894	Set of objects to query metrics for.
13895	</desc>
13896	</param>
13897	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
13898	<desc>
13899	Names of metrics returned in @c returnData.
13900	</desc>
13901	</param>
13902	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
13903	<desc>
13904	Objects associated with metrics returned in @c returnData.
13905	</desc>
13906	</param>
13907	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
13908	<desc>
13909	Units of measurement for each returned metric.
13910	</desc>
13911	</param>
13912	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
13913	<desc>
13914	Divisor that should be applied to return values in order to get
13915	floating point values. For example:
13916	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
13917	will retrieve the floating point value of i-th sample of the first
13918	metric.
13919	</desc>
13920	</param>
13921	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
13922	<desc>
13923	Sequence numbers of the first elements of value sequences of
13924	particular metrics returned in @c returnData. For aggregate metrics
13925	it is the sequence number of the sample the aggregate started
13926	calculation from.
13927	</desc>
13928	</param>
13929	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
13930	<desc>
13931	Indices of the first elements of value sequences of particular
13932	metrics returned in @c returnData.
13933	</desc>
13934	</param>
13935	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
13936	<desc>
13937	Lengths of value sequences of particular metrics.
13938	</desc>
13939	</param>
13940	<param name="returnData" type="long" dir="return" safearray="yes">
13941	<desc>
13942	Flattened array of all metric data containing sequences of values for
13943	each metric.
13944	</desc>
13945	</param>
13946	</method>
13947
13948	</interface>
13949	<enum
13950	name="NATAliasMode"
13951	uuid="67772168-50d9-11df-9669-7fb714ee4fa1">
13952	<desc></desc>
13953	<const name="AliasLog" value="0x1">
13954	<desc></desc>
13955	</const>
13956	<const name="AliasProxyOnly" value="0x02">
13957	<desc></desc>
13958	</const>
13959	<const name="AliasUseSamePorts" value="0x04">
13960	<desc></desc>
13961	</const>
13962	</enum>
13963	<enum
13964	name="NATProtocol"
13965	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
13966	>
13967	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
13968	<const name="UDP" value="0">
13969	<desc>Port-forwarding uses UDP protocol.</desc>
13970	</const>
13971	<const name="TCP" value="1">
13972	<desc>Port-forwarding uses TCP protocol.</desc>
13973	</const>
13974	</enum>
13975
13976	<interface
13977	name="INATEngine" extends="$unknown"
13978	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
13979	wsmap="managed"
13980	>
13981	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
13982	allows for changing NAT behavior such as port-forwarding rules. This interface is
13983	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
13984	<attribute name="network" type="wstring">
13985	<desc>The network attribute of the NAT engine (the same value is used with built-in
13986	DHCP server to fill corresponding fields of DHCP leases).</desc>
13987	</attribute>
13988	<attribute name="hostIP" type="wstring">
13989	<desc>IP of host interface to bind all opened sockets to.
13990	<note>Changing this does not change binding of port forwarding.</note>
13991	</desc>
13992	</attribute>
13993	<attribute name="tftpPrefix" type="wstring">
13994	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
13995	the corresponding fields of DHCP leases.</desc>
13996	</attribute>
13997	<attribute name="tftpBootFile" type="wstring">
13998	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
13999	the corresponding fields of DHCP leases.</desc>
14000	</attribute>
14001	<attribute name="tftpNextServer" type="wstring">
14002	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14003	the corresponding fields of DHCP leases.
14004	<note>The preferred form is IPv4 addresses.</note>
14005	</desc>
14006	</attribute>
14007	<attribute name="aliasMode" type="unsigned long">
14008	<desc></desc>
14009	</attribute>
14010	<attribute name="dnsPassDomain" type="boolean">
14011	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14012	</attribute>
14013	<attribute name="dnsProxy" type="boolean">
14014	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14015	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14016	</attribute>
14017	<attribute name="dnsUseHostResolver" type="boolean">
14018	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14019	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14020	</attribute>
14021	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14022	<desc>Array of NAT port-forwarding rules in string representation, in the following
14023	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14024	</attribute>
14025	<method name="setNetworkSettings">
14026	<desc>Sets network configuration of the NAT engine.</desc>
14027	<param name="mtu" type="unsigned long" dir="in">
14028	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14029	</param>
14030	<param name="sockSnd" type="unsigned long" dir="in">
14031	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14032	</param>
14033	<param name="sockRcv" type="unsigned long" dir="in">
14034	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14035	</param>
14036	<param name="TcpWndSnd" type="unsigned long" dir="in">
14037	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14038	establishing a new TCP connection.</desc>
14039	</param>
14040	<param name="TcpWndRcv" type="unsigned long" dir="in">
14041	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14042	establishing a new TCP connection.</desc>
14043	</param>
14044	</method>
14045	<method name="getNetworkSettings">
14046	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14047	for parameter descriptions.</desc>
14048	<param name="mtu" type="unsigned long" dir="out" />
14049	<param name="sockSnd" type="unsigned long" dir="out" />
14050	<param name="sockRcv" type="unsigned long" dir="out" />
14051	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14052	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14053	</method>
14054	<method name="addRedirect">
14055	<desc>Adds a new NAT port-forwarding rule.</desc>
14056	<param name="name" type="wstring" dir="in">
14057	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14058	auto-generates one using the other parameters.</desc>
14059	</param>
14060	<param name="proto" type="NATProtocol" dir="in">
14061	<desc>Protocol handled with the rule.</desc>
14062	</param>
14063	<param name="hostIp" type="wstring" dir="in">
14064	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14065	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14066	</param>
14067	<param name="hostPort" type="unsigned short" dir="in">
14068	<desc>The port number to listen on.</desc>
14069	</param>
14070	<param name="guestIp" type="wstring" dir="in">
14071	<desc>The IP address of the guest which the NAT engine will forward matching packets
14072	to. An empty IP address is acceptable, in which case the NAT engine will forward
14073	packets to the first DHCP lease (x.x.x.15).</desc>
14074	</param>
14075	<param name="guestPort" type="unsigned short" dir="in">
14076	<desc>The port number to forward.</desc>
14077	</param>
14078	</method>
14079	<method name="removeRedirect">
14080	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14081	<param name="name" type="wstring" dir="in">
14082	<desc>The name of the rule to delete.</desc>
14083	</param>
14084	</method>
14085	</interface>
14086
14087	<!--
14088	// IExtPackManager
14089	/////////////////////////////////////////////////////////////////////////
14090	-->
14091
14092	<interface
14093	name="IExtPack" extends="$unknown"
14094	uuid="ab26b24e-d46c-4d09-aa44-e5092d2fe9ae"
14095	wsmap="suppress"
14096	>
14097	<desc>
14098	Interface for querying interfaces and information relating to an
14099	extension pack. The extension pack specific interfaces can be queried
14100	via the IUnknown::QueryInterface method.
14101	</desc>
14102	<attribute name="name" type="wstring" readonly="yes">
14103	<desc>The extension pack name. This is unique.</desc>
14104	</attribute>
14105	<attribute name="description" type="wstring" readonly="yes">
14106	<desc>The extension pack description.</desc>
14107	</attribute>
14108	<attribute name="version" type="wstring" readonly="yes">
14109	<desc>
14110	The extension pack version string. This is on the same form as
14111	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14112	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14113	or "1.2.3_BETA1-r45678-OSE"
14114	</desc>
14115	</attribute>
14116	<attribute name="revision" type="unsigned long" readonly="yes">
14117	<desc>The extension pack internal revision number.</desc>
14118	</attribute>
14119	<attribute name="usable" type="boolean" readonly="yes">
14120	<desc>
14121	Indicates whether the extension pack is usable or not. An
14122	extension pack that is not compatible with the current VirtualBox
14123	version will be flagged as not usable.
14124	</desc>
14125	</attribute>
14126	<attribute name="whyUnusable" type="wstring" readonly="yes">
14127	<desc>
14128	String indicating why the extension pack is not usable. This is an
14129	empty string if usable and always a non-empty string if not usable.
14130	</desc>
14131	</attribute>
14132	</interface>
14133
14134	<interface
14135	name="IExtPackManager" extends="$unknown"
14136	uuid="ba1fbfca-53f1-471c-b5a1-416386f0f52b"
14137	wsmap="suppress"
14138	>
14139	<desc>
14140	Interface for managing VirtualBox Extension Packs.
14141
14142	TODO: Describe extension packs, how they are managed and how to create
14143	one.
14144	</desc>
14145
14146	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14147	<desc>
14148	List of the installed extension packs.
14149	</desc>
14150	</attribute>
14151
14152	<method name="find">
14153	<desc>
14154	Returns the extension pack with the specified name if found.
14155
14156	<result name="VBOX_E_OBJECT_NOT_FOUND">
14157	No extension pack matching @a name was found.
14158	</result>
14159	</desc>
14160	<param name="name" type="wstring" dir="in">
14161	<desc>The name of the extension pack to locate.</desc>
14162	</param>
14163	<param name="returnData" type="IExtPack" dir="return">
14164	<desc>The extension pack if found.</desc>
14165	</param>
14166	</method>
14167
14168	<method name="install">
14169	<param name="path" type="wstring" dir="in">
14170	<desc>The path of the extension pack tarball.</desc>
14171	</param>
14172	<param name="name" type="wstring" dir="out">
14173	<desc>The name of the installed extension pack.</desc>
14174	</param>
14175	</method>
14176
14177	<method name="uninstall">
14178	<desc>Uninstalls an extension pack, removing all related files.</desc>
14179	<param name="name" type="wstring" dir="in">
14180	<desc>The name of the extension pack to uninstall.</desc>
14181	</param>
14182	<param name="forcedRemoval" type="boolean" dir="in">
14183	<desc>
14184	Forced removal of the extension pack. This means that the uninstall
14185	hook will not be called.
14186	</desc>
14187	</param>
14188	</method>
14189	</interface>
14190
14191	<!--
14192	// Events
14193	/////////////////////////////////////////////////////////////////////////
14194	-->
14195	<enum
14196	name="VBoxEventType"
14197	uuid="e085d0b1-05e6-4f40-a709-b7266fbdb236">
14198
14199	<desc>
14200	Type of an event.
14201	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14202	</desc>
14203
14204	<const name="Invalid" value="0">
14205	<desc>
14206	Invalid event, must be first.
14207	</desc>
14208	</const>
14209
14210	<const name="Any" value="1">
14211	<desc>
14212	Wildcard for all events.
14213	Events of this type are never delivered, and only used in
14214	registerListener() call to simplify registration.
14215	</desc>
14216	</const>
14217
14218	<const name="Vetoable" value="2">
14219	<desc>
14220	Wildcard for all vetoable events. Events of this type are never delivered, and only
14221	used in registerListener() call to simplify registration.
14222	</desc>
14223	</const>
14224
14225	<const name="MachineEvent" value="3">
14226	<desc>
14227	Wildcard for all machine events. Events of this type are never delivered, and only used in
14228	registerListener() call to simplify registration.
14229	</desc>
14230	</const>
14231
14232	<const name="SnapshotEvent" value="4">
14233	<desc>
14234	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
14235	registerListener() call to simplify registration.
14236	</desc>
14237	</const>
14238
14239	<const name="InputEvent" value="5">
14240	<desc>
14241	Wildcard for all input device (keyboard, mouse) events.
14242	Events of this type are never delivered, and only used in
14243	registerListener() call to simplify registration.
14244	</desc>
14245	</const>
14246
14247	<const name="LastWildcard" value="31">
14248	<desc>
14249	Last wildcard.
14250	</desc>
14251	</const>
14252
14253	<const name="OnMachineStateChanged" value="32">
14254	<desc>
14255	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
14256	</desc>
14257	</const>
14258	<const name="OnMachineDataChanged" value="33">
14259	<desc>
14260	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
14261	</desc>
14262	</const>
14263	<const name="OnExtraDataChanged" value="34">
14264	<desc>
14265	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
14266	</desc>
14267	</const>
14268	<const name="OnExtraDataCanChange" value="35">
14269	<desc>
14270	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
14271	</desc>
14272	</const>
14273	<const name="OnMediumRegistered" value="36">
14274	<desc>
14275	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
14276	</desc>
14277	</const>
14278	<const name="OnMachineRegistered" value="37">
14279	<desc>
14280	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
14281	</desc>
14282	</const>
14283	<const name="OnSessionStateChanged" value="38">
14284	<desc>
14285	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
14286	</desc>
14287	</const>
14288	<const name="OnSnapshotTaken" value="39">
14289	<desc>
14290	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
14291	</desc>
14292	</const>
14293	<const name="OnSnapshotDeleted" value="40">
14294	<desc>
14295	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
14296	</desc>
14297	</const>
14298	<const name="OnSnapshotChanged" value="41">
14299	<desc>
14300	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
14301	</desc>
14302	</const>
14303	<const name="OnGuestPropertyChanged" value="42">
14304	<desc>
14305	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
14306	</desc>
14307	</const>
14308	<!-- Console events -->
14309	<const name="OnMousePointerShapeChanged" value="43">
14310	<desc>
14311	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
14312	</desc>
14313	</const>
14314	<const name="OnMouseCapabilityChanged" value="44">
14315	<desc>
14316	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
14317	</desc>
14318	</const>
14319	<const name="OnKeyboardLedsChanged" value="45">
14320	<desc>
14321	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
14322	</desc>
14323	</const>
14324	<const name="OnStateChanged" value="46">
14325	<desc>
14326	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
14327	</desc>
14328	</const>
14329	<const name="OnAdditionsStateChanged" value="47">
14330	<desc>
14331	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
14332	</desc>
14333	</const>
14334	<const name="OnNetworkAdapterChanged" value="48">
14335	<desc>
14336	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
14337	</desc>
14338	</const>
14339	<const name="OnSerialPortChanged" value="49">
14340	<desc>
14341	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
14342	</desc>
14343	</const>
14344	<const name="OnParallelPortChanged" value="50">
14345	<desc>
14346	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
14347	</desc>
14348	</const>
14349	<const name="OnStorageControllerChanged" value="51">
14350	<desc>
14351	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
14352	</desc>
14353	</const>
14354	<const name="OnMediumChanged" value="52">
14355	<desc>
14356	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
14357	</desc>
14358	</const>
14359	<const name="OnVRDEServerChanged" value="53">
14360	<desc>
14361	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
14362	</desc>
14363	</const>
14364	<const name="OnUSBControllerChanged" value="54">
14365	<desc>
14366	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
14367	</desc>
14368	</const>
14369	<const name="OnUSBDeviceStateChanged" value="55">
14370	<desc>
14371	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
14372	</desc>
14373	</const>
14374	<const name="OnSharedFolderChanged" value="56">
14375	<desc>
14376	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
14377	</desc>
14378	</const>
14379	<const name="OnRuntimeError" value="57">
14380	<desc>
14381	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
14382	</desc>
14383	</const>
14384	<const name="OnCanShowWindow" value="58">
14385	<desc>
14386	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
14387	</desc>
14388	</const>
14389	<const name="OnShowWindow" value="59">
14390	<desc>
14391	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
14392	</desc>
14393	</const>
14394	<const name="OnCPUChanged" value="60">
14395	<desc>
14396	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
14397	</desc>
14398	</const>
14399	<const name="OnVRDEServerInfoChanged" value="61">
14400	<desc>
14401	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
14402	</desc>
14403	</const>
14404	<const name="OnEventSourceChanged" value="62">
14405	<desc>
14406	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
14407	</desc>
14408	</const>
14409	<const name="OnCPUExecutionCapChanged" value="63">
14410	<desc>
14411	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
14412	</desc>
14413	</const>
14414	<const name="OnGuestKeyboardEvent" value="64">
14415	<desc>
14416	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
14417	</desc>
14418	</const>
14419	<const name="OnGuestMouseEvent" value="65">
14420	<desc>
14421	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
14422	</desc>
14423	</const>
14424	<const name="OnNATRedirectEvent" value="66">
14425	<desc>
14426	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
14427	</desc>
14428	</const>
14429	<!-- Last event marker -->
14430	<const name="Last" value="67">
14431	<desc>
14432	Must be last event, used for iterations and structures relying on numerical event values.
14433	</desc>
14434	</const>
14435
14436	</enum>
14437
14438	<interface
14439	name="IEventSource" extends="$unknown"
14440	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
14441	wsmap="managed"
14442	>
14443	<desc>
14444	Event source. Generally, any object which could generate events can be an event source,
14445	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
14446	an event source can work with listeners in either active or passive mode. In active mode it is up to
14447	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
14448	event source keeps track of pending events for each listener and returns available events on demand.
14449
14450	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14451	</desc>
14452
14453	<method name="createListener">
14454	<desc>
14455	Creates a new listener object, useful for passive mode.
14456	</desc>
14457	<param name="listener" type="IEventListener" dir="return"/>
14458	</method>
14459
14460	<method name="createAggregator">
14461	<desc>
14462	Creates a aggregator event source, collecting events from multiple sources.
14463	This way single listener can listen for events coming from multiple sources,
14464	using single blocking getEvent() of this aggregator.
14465	</desc>
14466	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
14467	<desc>
14468	Subordinate event source this one aggregatres.
14469	</desc>
14470	</param>
14471	<param name="result" type="IEventSource" dir="return"/>
14472	</method>
14473
14474	<method name="registerListener">
14475	<desc>
14476	Register an event listener.
14477
14478	<note>
14479	To avoid system overload, the VirtualBox server process checks if passive event
14480	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
14481	current implementation, if more than 500 pending events are detected for a passive
14482	event listener, it is forcefully unregistered by the system, and further
14483	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
14484	</note>
14485	</desc>
14486	<param name="listener" type="IEventListener" dir="in">
14487	<desc>Listener to register.</desc>
14488	</param>
14489	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
14490	<desc>
14491	Event types listener is interested in. One can use wildcards like -
14492	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
14493	than one event.
14494	</desc>
14495	</param>
14496	<param name="active" type="boolean" dir="in">
14497	<desc>
14498	Which mode this listener is operating in.
14499	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
14500	In passive mode, an internal event queue is created for this this IEventListener.
14501	For each event coming in, it is added to queues for all interested registered passive
14502	listeners. It is then up to the external code to call the listener's
14503	<link to="IEventListener::handleEvent" /> method. When done with an event, the
14504	external code must call <link to="#eventProcessed" />.
14505	</desc>
14506	</param>
14507	</method>
14508
14509	<method name="unregisterListener">
14510	<desc>
14511	Unregister an event listener. If listener is passive, and some waitable events are still
14512	in queue they are marked as processed automatically.
14513	</desc>
14514	<param name="listener" type="IEventListener" dir="in">
14515	<desc>Listener to unregister.</desc>
14516	</param>
14517	</method>
14518
14519	<method name="fireEvent">
14520	<desc>
14521	Fire an event for this source.
14522	</desc>
14523	<param name="event" type="IEvent" dir="in">
14524	<desc>Event to deliver.</desc>
14525	</param>
14526	<param name="timeout" type="long" dir="in">
14527	<desc>
14528	Maximum time to wait for event processing (if event is waitable), in ms;
14529	0 = no wait, -1 = indefinite wait.
14530	</desc>
14531	</param>
14532	<param name="result" type="boolean" dir="return">
14533	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
14534	</param>
14535	</method>
14536
14537	<method name="getEvent">
14538	<desc>
14539	Get events from this peer's event queue (for passive mode). Calling this method
14540	regularly is required for passive event listeners to avoid system overload;
14541	see <link to="IEventSource::registerListener" /> for details.
14542
14543	<result name="VBOX_E_OBJECT_NOT_FOUND">
14544	Listener is not registered, or autounregistered.
14545	</result>
14546	</desc>
14547	<param name="listener" type="IEventListener" dir="in">
14548	<desc>Which listener to get data for.</desc>
14549	</param>
14550	<param name="timeout" type="long" dir="in">
14551	<desc>
14552	Maximum time to wait for events, in ms;
14553	0 = no wait, -1 = indefinite wait.
14554	</desc>
14555	</param>
14556	<param name="event" type="IEvent" dir="return">
14557	<desc>Event retrieved, or null if none available.</desc>
14558	</param>
14559	</method>
14560
14561	<method name="eventProcessed">
14562	<desc>
14563	Must be called for waitable events after a particular listener finished its
14564	event processing. When all listeners of a particular event have called this
14565	method, the system will then call <link to="IEvent::setProcessed" />.
14566	</desc>
14567	<param name="listener" type="IEventListener" dir="in">
14568	<desc>Which listener processed event.</desc>
14569	</param>
14570	<param name="event" type="IEvent" dir="in">
14571	<desc>Which event.</desc>
14572	</param>
14573	</method>
14574
14575	</interface>
14576
14577	<interface
14578	name="IEventListener" extends="$unknown"
14579	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
14580	wsmap="managed"
14581	>
14582	<desc>
14583	Event listener. An event listener can work in either active or passive mode, depending on the way
14584	it was registered.
14585	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
14586	</desc>
14587
14588	<method name="handleEvent">
14589	<desc>
14590	Handle event callback (called directly by IEventSource in active mode, or could be
14591	called by event processor thread in passive mode).
14592	</desc>
14593	<param name="event" type="IEvent" dir="in">
14594	<desc>Event available.</desc>
14595	</param>
14596	</method>
14597
14598	</interface>
14599
14600	<interface
14601	name="IEvent" extends="$unknown"
14602	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
14603	wsmap="managed"
14604	>
14605	<desc>
14606	Abstract parent interface for VirtualBox events. Actual events will typically implement
14607	a more specific interface which derives from this (see below).
14608
14609	<b>Introduction to VirtualBox events</b>
14610
14611	Generally speaking, an event (represented by this interface) signals that something
14612	happened, while an event listener (see <link to="IEventListener" />) represents an
14613	entity that is interested in certain events. In order for this to work with
14614	unidirectional protocols (i.e. web services), the concepts of passive and active
14615	listener are used.
14616
14617	Event consumers can register themselves as listeners, providing an array of
14618	events they are interested in (see <link to="IEventSource::registerListener" />).
14619	When an event triggers, the listener is notified about the event. The exact
14620	mechanism of the notification depends on whether the listener was registered as
14621	an active or passive listener:
14622
14623	<ul>
14624	<li>An active listener is very similar to a callback: it is a function invoked
14625	by the API. As opposed to the callbacks that were used in the API before
14626	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
14627	</li>
14628
14629	<li>Passive listeners are somewhat trickier to implement, but do not require
14630	a client function to be callable, which is not an option with scripting
14631	languages or web service clients. Internally the <link to="IEventSource" />
14632	implementation maintains an event queue for each passive listener, and
14633	newly arrived events are put in this queue. When the listener calls
14634	<link to="IEventSource::getEvent"/>, first element from its internal event
14635	queue is returned. When the client completes processing of an event,
14636	the <link to="IEventSource::eventProcessed" /> function must be called,
14637	acknowledging that the event was processed. It supports implementing
14638	waitable events. On passive listener unregistration, all events from its
14639	queue are auto-acknowledged.
14640	</li>
14641	</ul>
14642
14643	Waitable events are useful in situations where the event generator wants to track
14644	delivery or a party wants to wait until all listeners have completed the event. A
14645	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
14646	listeners might veto a certain action, and thus the event producer has to make
14647	sure that all listeners have processed the event and not vetoed before taking
14648	the action.
14649
14650	A given event may have both passive and active listeners at the same time.
14651
14652	<b>Using events</b>
14653
14654	Any VirtualBox object capable of producing externally visible events provides an
14655	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
14656	This event source object is notified by VirtualBox once something has happened, so
14657	consumers may register event listeners with this event source. To register a listener,
14658	an object implementing the <link to="IEventListener" /> interface must be provided.
14659	For active listeners, such an object is typically created by the consumer, while for
14660	passive listeners <link to="IEventSource::createListener" /> should be used. Please
14661	note that a listener created with @c createListener() must not be used as an active listener.
14662
14663	Once created, the listener must be registered to listen for the desired events
14664	(see <link to="IEventSource::registerListener" />), providing an array of
14665	<link to="VBoxEventType" /> enums. Those elements can either be the individual
14666	event IDs or wildcards matching multiple event IDs.
14667
14668	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
14669	called automatically when the event is triggered, while passive listeners have to call
14670	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
14671	an event processing loop.
14672
14673	The IEvent interface is an abstract parent interface for all such VirtualBox events
14674	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
14675	or the event processing loop is to check the <link to="#type" /> attribute of the event and
14676	then cast to the appropriate specific interface using @c QueryInterface().
14677	</desc>
14678
14679	<attribute name="type" readonly="yes" type="VBoxEventType">
14680	<desc>
14681	Event type.
14682	</desc>
14683	</attribute>
14684
14685	<attribute name="source" readonly="yes" type="IEventSource">
14686	<desc>
14687	Source of this event.
14688	</desc>
14689	</attribute>
14690
14691	<attribute name="waitable" readonly="yes" type="boolean">
14692	<desc>
14693	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
14694	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
14695	as no additional overhead associated with waitability imposed.
14696	Waitable events are needed when one need to be able to wait for particular event processed,
14697	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
14698	until all consumers confirmed events.
14699	</desc>
14700	</attribute>
14701
14702	<method name="setProcessed">
14703	<desc>
14704	Internal method called by the system when all listeners of a particular event have called
14705	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
14706	</desc>
14707	</method>
14708
14709	<method name="waitProcessed">
14710	<desc>
14711	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
14712	described semantics, for non-waitable returns true immediately.
14713	</desc>
14714	<param name="timeout" type="long" dir="in">
14715	<desc>
14716	Maximum time to wait for event processeing, in ms;
14717	0 = no wait, -1 = indefinite wait.
14718	</desc>
14719	</param>
14720	<param name="result" type="boolean" dir="return">
14721	<desc>If this event was processed before timeout.</desc>
14722	</param>
14723	</method>
14724	</interface>
14725
14726
14727	<interface
14728	name="IReusableEvent" extends="IEvent"
14729	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
14730	wsmap="managed"
14731	>
14732	<desc>Base abstract interface for all reusable events.</desc>
14733
14734	<attribute name="generation" readonly="yes" type="unsigned long">
14735	<desc>Current generation of event, incremented on reuse.</desc>
14736	</attribute>
14737
14738	<method name="reuse">
14739	<desc>
14740	Marks an event as reused, increments 'generation', fields shall no
14741	longer be considered valid.
14742	</desc>
14743	</method>
14744	</interface>
14745
14746	<interface
14747	name="IMachineEvent" extends="IEvent"
14748	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
14749	wsmap="managed" id="MachineEvent"
14750	>
14751	<desc>Base abstract interface for all machine events.</desc>
14752
14753	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
14754	<desc>ID of the machine this event relates to.</desc>
14755	</attribute>
14756
14757	</interface>
14758
14759	<interface
14760	name="IMachineStateChangedEvent" extends="IMachineEvent"
14761	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
14762	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
14763	>
14764	<desc>Machine state change event.</desc>
14765
14766	<attribute name="state" readonly="yes" type="MachineState">
14767	<desc>New execution state.</desc>
14768	</attribute>
14769	</interface>
14770
14771	<interface
14772	name="IMachineDataChangedEvent" extends="IMachineEvent"
14773	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
14774	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
14775	>
14776	<desc>
14777	Any of the settings of the given machine has changed.
14778	</desc>
14779	</interface>
14780
14781	<interface
14782	name="IMediumRegisteredEvent" extends="IEvent"
14783	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
14784	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
14785	>
14786	<desc>
14787	The given medium was registered or unregistered
14788	within this VirtualBox installation.
14789	</desc>
14790
14791	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
14792	<desc>ID of the medium this event relates to.</desc>
14793	</attribute>
14794
14795	<attribute name="mediumType" readonly="yes" type="DeviceType">
14796	<desc>Type of the medium this event relates to.</desc>
14797	</attribute>
14798
14799	<attribute name="registered" type="boolean" readonly="yes">
14800	<desc>
14801	If @c true, the medium was registered, otherwise it was
14802	unregistered.
14803	</desc>
14804	</attribute>
14805	</interface>
14806
14807	<interface
14808	name="IMachineRegisteredEvent" extends="IMachineEvent"
14809	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
14810	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
14811	>
14812	<desc>
14813	The given machine was registered or unregistered
14814	within this VirtualBox installation.
14815	</desc>
14816
14817	<attribute name="registered" type="boolean" readonly="yes">
14818	<desc>
14819	If @c true, the machine was registered, otherwise it was
14820	unregistered.
14821	</desc>
14822	</attribute>
14823	</interface>
14824
14825	<interface
14826	name="ISessionStateChangedEvent" extends="IMachineEvent"
14827	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
14828	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
14829	>
14830	<desc>
14831	The state of the session for the given machine was changed.
14832	<see>IMachine::sessionState</see>
14833	</desc>
14834
14835	<attribute name="state" type="SessionState" readonly="yes">
14836	<desc>
14837	New session state.
14838	</desc>
14839	</attribute>
14840	</interface>
14841
14842	<interface
14843	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
14844	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
14845	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
14846	>
14847	<desc>
14848	Notification when a guest property has changed.
14849	</desc>
14850
14851	<attribute name="name" readonly="yes" type="wstring">
14852	<desc>
14853	The name of the property that has changed.
14854	</desc>
14855	</attribute>
14856
14857	<attribute name="value" readonly="yes" type="wstring">
14858	<desc>
14859	The new property value.
14860	</desc>
14861	</attribute>
14862
14863	<attribute name="flags" readonly="yes" type="wstring">
14864	<desc>
14865	The new property flags.
14866	</desc>
14867	</attribute>
14868
14869	</interface>
14870
14871	<interface
14872	name="ISnapshotEvent" extends="IMachineEvent"
14873	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
14874	wsmap="managed" id="SnapshotEvent"
14875	>
14876	<desc>Base interface for all snapshot events.</desc>
14877
14878	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
14879	<desc>ID of the snapshot this event relates to.</desc>
14880	</attribute>
14881
14882	</interface>
14883
14884	<interface
14885	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
14886	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
14887	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
14888	>
14889	<desc>
14890	A new snapshot of the machine has been taken.
14891	<see>ISnapshot</see>
14892	</desc>
14893	</interface>
14894
14895	<interface
14896	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
14897	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
14898	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
14899	>
14900	<desc>
14901	Snapshot of the given machine has been deleted.
14902
14903	<note>
14904	This notification is delivered <b>after</b> the snapshot
14905	object has been uninitialized on the server (so that any
14906	attempt to call its methods will return an error).
14907	</note>
14908
14909	<see>ISnapshot</see>
14910	</desc>
14911	</interface>
14912
14913	<interface
14914	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
14915	uuid="07541941-8079-447a-a33e-47a69c7980db"
14916	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
14917	>
14918	<desc>
14919	Snapshot properties (name and/or description) have been changed.
14920	<see>ISnapshot</see>
14921	</desc>
14922	</interface>
14923
14924	<interface
14925	name="IMousePointerShapeChangedEvent" extends="IEvent"
14926	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
14927	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
14928	>
14929	<desc>
14930	Notification when the guest mouse pointer shape has
14931	changed. The new shape data is given.
14932	</desc>
14933
14934	<attribute name="visible" type="boolean" readonly="yes">
14935	<desc>
14936	Flag whether the pointer is visible.
14937	</desc>
14938	</attribute>
14939	<attribute name="alpha" type="boolean" readonly="yes">
14940	<desc>
14941	Flag whether the pointer has an alpha channel.
14942	</desc>
14943	</attribute>
14944	<attribute name="xhot" type="unsigned long" readonly="yes">
14945	<desc>
14946	The pointer hot spot X coordinate.
14947	</desc>
14948	</attribute>
14949	<attribute name="yhot" type="unsigned long" readonly="yes">
14950	<desc>
14951	The pointer hot spot Y coordinate.
14952	</desc>
14953	</attribute>
14954	<attribute name="width" type="unsigned long" readonly="yes">
14955	<desc>
14956	Width of the pointer shape in pixels.
14957	</desc>
14958	</attribute>
14959	<attribute name="height" type="unsigned long" readonly="yes">
14960	<desc>
14961	Height of the pointer shape in pixels.
14962	</desc>
14963	</attribute>
14964	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
14965	<desc>
14966	Shape buffer arrays.
14967
14968	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
14969	followed by a 32-bpp XOR (color) mask.
14970
14971	For pointers without alpha channel the XOR mask pixels are 32
14972	bit values: (lsb)BGR0(msb). For pointers with alpha channel
14973	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
14974
14975	An AND mask is used for pointers with alpha channel, so if the
14976	callback does not support alpha, the pointer could be
14977	displayed as a normal color pointer.
14978
14979	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
14980	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
14981	height</tt>. The padding bits at the end of each scanline are
14982	undefined.
14983
14984	The XOR mask follows the AND mask on the next 4-byte aligned
14985	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
14986	Bytes in the gap between the AND and the XOR mask are undefined.
14987	The XOR mask scanlines have no gap between them and the size of
14988	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
14989
14990	<note>
14991	If @a shape is 0, only the pointer visibility is changed.
14992	</note>
14993	</desc>
14994	</attribute>
14995	</interface>
14996
14997	<interface
14998	name="IMouseCapabilityChangedEvent" extends="IEvent"
14999	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
15000	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
15001	>
15002	<desc>
15003	Notification when the mouse capabilities reported by the
15004	guest have changed. The new capabilities are passed.
15005	</desc>
15006	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
15007	<desc>
15008	Supports absolute coordinates.
15009	</desc>
15010	</attribute>
15011	<attribute name="supportsRelative" type="boolean" readonly="yes">
15012	<desc>
15013	Supports relative coordinates.
15014	</desc>
15015	</attribute>
15016	<attribute name="needsHostCursor" type="boolean" readonly="yes">
15017	<desc>
15018	If host cursor is needed.
15019	</desc>
15020	</attribute>
15021	</interface>
15022
15023	<interface
15024	name="IKeyboardLedsChangedEvent" extends="IEvent"
15025	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
15026	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
15027	>
15028	<desc>
15029	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
15030	to alter the state of the keyboard LEDs.
15031	</desc>
15032	<attribute name="numLock" type="boolean" readonly="yes">
15033	<desc>
15034	NumLock status.
15035	</desc>
15036	</attribute>
15037	<attribute name="capsLock" type="boolean" readonly="yes">
15038	<desc>
15039	CapsLock status.
15040	</desc>
15041	</attribute>
15042	<attribute name="scrollLock" type="boolean" readonly="yes">
15043	<desc>
15044	ScrollLock status.
15045	</desc>
15046	</attribute>
15047	</interface>
15048
15049	<interface
15050	name="IStateChangedEvent" extends="IEvent"
15051	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
15052	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
15053	>
15054	<desc>
15055	Notification when the execution state of the machine has changed.
15056	The new state is given.
15057	</desc>
15058	<attribute name="state" type="MachineState" readonly="yes">
15059	<desc>
15060	New machine state.
15061	</desc>
15062	</attribute>
15063	</interface>
15064
15065	<interface
15066	name="IAdditionsStateChangedEvent" extends="IEvent"
15067	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
15068	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
15069	>
15070	<desc>
15071	Notification when a Guest Additions property changes.
15072	Interested callees should query IGuest attributes to
15073	find out what has changed.
15074	</desc>
15075	</interface>
15076
15077	<interface
15078	name="INetworkAdapterChangedEvent" extends="IEvent"
15079	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
15080	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
15081	>
15082	<desc>
15083	Notification when a property of one of the
15084	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
15085	changes. Interested callees should use INetworkAdapter methods and
15086	attributes to find out what has changed.
15087	</desc>
15088	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
15089	<desc>
15090	Network adapter that is subject to change.
15091	</desc>
15092	</attribute>
15093	</interface>
15094
15095	<interface
15096	name="ISerialPortChangedEvent" extends="IEvent"
15097	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
15098	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
15099	>
15100	<desc>
15101	Notification when a property of one of the
15102	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
15103	Interested callees should use ISerialPort methods and attributes
15104	to find out what has changed.
15105	</desc>
15106	<attribute name="serialPort" type="ISerialPort" readonly="yes">
15107	<desc>
15108	Serial port that is subject to change.
15109	</desc>
15110	</attribute>
15111	</interface>
15112
15113	<interface
15114	name="IParallelPortChangedEvent" extends="IEvent"
15115	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
15116	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
15117	>
15118	<desc>
15119	Notification when a property of one of the
15120	virtual <link to="IMachine::getParallelPort">parallel ports</link>
15121	changes. Interested callees should use ISerialPort methods and
15122	attributes to find out what has changed.
15123	</desc>
15124	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
15125	<desc>
15126	Parallel port that is subject to change.
15127	</desc>
15128	</attribute>
15129	</interface>
15130
15131	<interface
15132	name="IStorageControllerChangedEvent" extends="IEvent"
15133	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
15134	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
15135	>
15136	<desc>
15137	Notification when a
15138	<link to="IMachine::mediumAttachments">medium attachment</link>
15139	changes.
15140	</desc>
15141	</interface>
15142
15143	<interface
15144	name="IMediumChangedEvent" extends="IEvent"
15145	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
15146	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
15147	>
15148	<desc>
15149	Notification when a
15150	<link to="IMachine::mediumAttachments">medium attachment</link>
15151	changes.
15152	</desc>
15153	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
15154	<desc>
15155	Medium attachment that is subject to change.
15156	</desc>
15157	</attribute>
15158	</interface>
15159
15160	<interface
15161	name="ICPUChangedEvent" extends="IEvent"
15162	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
15163	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
15164	>
15165	<desc>
15166	Notification when a CPU changes.
15167	</desc>
15168	<attribute name="cpu" type="unsigned long" readonly="yes">
15169	<desc>
15170	The CPU which changed.
15171	</desc>
15172	</attribute>
15173	<attribute name="add" type="boolean" readonly="yes">
15174	<desc>
15175	Flag whether the CPU was added or removed.
15176	</desc>
15177	</attribute>
15178	</interface>
15179
15180	<interface
15181	name="ICPUExecutionCapChangedEvent" extends="IEvent"
15182	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
15183	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
15184	>
15185	<desc>
15186	Notification when the CPU execution cap changes.
15187	</desc>
15188	<attribute name="executionCap" type="unsigned long" readonly="yes">
15189	<desc>
15190	The new CPU execution cap value. (1-100)
15191	</desc>
15192	</attribute>
15193	</interface>
15194
15195	<interface
15196	name="IGuestKeyboardEvent" extends="IEvent"
15197	uuid="88394258-7006-40d4-b339-472ee3801844"
15198	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboardEvent"
15199	>
15200	<desc>
15201	Notification when guest keyboard event happens.
15202	</desc>
15203	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
15204	<desc>
15205	Array of scancodes.
15206	</desc>
15207	</attribute>
15208	</interface>
15209
15210	<interface
15211	name="IGuestMouseEvent" extends="IReusableEvent"
15212	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
15213	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouseEvent"
15214	>
15215	<desc>
15216	Notification when guest mouse event happens.
15217	</desc>
15218
15219	<attribute name="absolute" type="boolean" readonly="yes">
15220	<desc>
15221	If this event is relative or absolute.
15222	</desc>
15223	</attribute>
15224
15225	<attribute name="x" type="long" readonly="yes">
15226	<desc>
15227	New X position, or X delta.
15228	</desc>
15229	</attribute>
15230
15231	<attribute name="y" type="long" readonly="yes">
15232	<desc>
15233	New Y position, or Y delta.
15234	</desc>
15235	</attribute>
15236
15237	<attribute name="z" type="long" readonly="yes">
15238	<desc>
15239	Z delta.
15240	</desc>
15241	</attribute>
15242
15243	<attribute name="w" type="long" readonly="yes">
15244	<desc>
15245	W delta.
15246	</desc>
15247	</attribute>
15248
15249	<attribute name="buttons" type="long" readonly="yes">
15250	<desc>
15251	Button state bitmask.
15252	</desc>
15253	</attribute>
15254
15255	</interface>
15256
15257
15258	<interface
15259	name="IVRDEServerChangedEvent" extends="IEvent"
15260	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
15261	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
15262	>
15263	<desc>
15264	Notification when a property of the
15265	<link to="IMachine::VRDEServer">VRDE server</link> changes.
15266	Interested callees should use IVRDEServer methods and attributes to
15267	find out what has changed.
15268	</desc>
15269	</interface>
15270
15271	<interface
15272	name="IVRDEServerInfoChangedEvent" extends="IEvent"
15273	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
15274	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
15275	>
15276	<desc>
15277	Notification when the status of the VRDE server changes. Interested callees
15278	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
15279	attributes to find out what is the current status.
15280	</desc>
15281	</interface>
15282
15283	<interface
15284	name="IUSBControllerChangedEvent" extends="IEvent"
15285	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
15286	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
15287	>
15288	<desc>
15289	Notification when a property of the virtual
15290	<link to="IMachine::USBController">USB controller</link> changes.
15291	Interested callees should use IUSBController methods and attributes to
15292	find out what has changed.
15293	</desc>
15294	</interface>
15295
15296	<interface
15297	name="IUSBDeviceStateChangedEvent" extends="IEvent"
15298	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
15299	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
15300	>
15301	<desc>
15302	Notification when a USB device is attached to or detached from
15303	the virtual USB controller.
15304
15305	This notification is sent as a result of the indirect
15306	request to attach the device because it matches one of the
15307	machine USB filters, or as a result of the direct request
15308	issued by <link to="IConsole::attachUSBDevice"/> or
15309	<link to="IConsole::detachUSBDevice"/>.
15310
15311	This notification is sent in case of both a succeeded and a
15312	failed request completion. When the request succeeds, the
15313	@a error parameter is @c null, and the given device has been
15314	already added to (when @a attached is @c true) or removed from
15315	(when @a attached is @c false) the collection represented by
15316	<link to="IConsole::USBDevices"/>. On failure, the collection
15317	doesn't change and the @a error parameter represents the error
15318	message describing the failure.
15319	</desc>
15320	<attribute name="device" type="IUSBDevice" readonly="yes">
15321	<desc>
15322	Device that is subject to state change.
15323	</desc>
15324	</attribute>
15325	<attribute name="attached" type="boolean" readonly="yes">
15326	<desc>
15327	@c true if the device was attached and @c false otherwise.
15328	</desc>
15329	</attribute>
15330	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
15331	<desc>
15332	@c null on success or an error message object on failure.
15333	</desc>
15334	</attribute>
15335	</interface>
15336
15337	<interface
15338	name="ISharedFolderChangedEvent" extends="IEvent"
15339	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
15340	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
15341	>
15342	<desc>
15343	Notification when a shared folder is added or removed.
15344	The @a scope argument defines one of three scopes:
15345	<link to="IVirtualBox::sharedFolders">global shared folders</link>
15346	(<link to="Scope_Global">Global</link>),
15347	<link to="IMachine::sharedFolders">permanent shared folders</link> of
15348	the machine (<link to="Scope_Machine">Machine</link>) or <link
15349	to="IConsole::sharedFolders">transient shared folders</link> of the
15350	machine (<link to="Scope_Session">Session</link>). Interested callees
15351	should use query the corresponding collections to find out what has
15352	changed.
15353	</desc>
15354	<attribute name="scope" type="Scope" readonly="yes">
15355	<desc>
15356	Scope of the notification.
15357	</desc>
15358	</attribute>
15359	</interface>
15360
15361	<interface
15362	name="IRuntimeErrorEvent" extends="IEvent"
15363	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
15364	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
15365	>
15366	<desc>
15367	Notification when an error happens during the virtual
15368	machine execution.
15369
15370	There are three kinds of runtime errors:
15371	<ul>
15372	<li><i>fatal</i></li>
15373	<li><i>non-fatal with retry</i></li>
15374	<li><i>non-fatal warnings</i></li>
15375	</ul>
15376
15377	<b>Fatal</b> errors are indicated by the @a fatal parameter set
15378	to @c true. In case of fatal errors, the virtual machine
15379	execution is always paused before calling this notification, and
15380	the notification handler is supposed either to immediately save
15381	the virtual machine state using <link to="IConsole::saveState"/>
15382	or power it off using <link to="IConsole::powerDown"/>.
15383	Resuming the execution can lead to unpredictable results.
15384
15385	<b>Non-fatal</b> errors and warnings are indicated by the
15386	@a fatal parameter set to @c false. If the virtual machine
15387	is in the Paused state by the time the error notification is
15388	received, it means that the user can <i>try to resume</i> the machine
15389	execution after attempting to solve the problem that caused the
15390	error. In this case, the notification handler is supposed
15391	to show an appropriate message to the user (depending on the
15392	value of the @a id parameter) that offers several actions such
15393	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
15394	wants to retry, the notification handler should continue
15395	the machine execution using the <link to="IConsole::resume"/>
15396	call. If the machine execution is not Paused during this
15397	notification, then it means this notification is a <i>warning</i>
15398	(for example, about a fatal condition that can happen very soon);
15399	no immediate action is required from the user, the machine
15400	continues its normal execution.
15401
15402	Note that in either case the notification handler
15403	<b>must not</b> perform any action directly on a thread
15404	where this notification is called. Everything it is allowed to
15405	do is to post a message to another thread that will then talk
15406	to the user and take the corresponding action.
15407
15408	Currently, the following error identifiers are known:
15409	<ul>
15410	<li><tt>"HostMemoryLow"</tt></li>
15411	<li><tt>"HostAudioNotResponding"</tt></li>
15412	<li><tt>"VDIStorageFull"</tt></li>
15413	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
15414	</ul>
15415	</desc>
15416	<attribute name="fatal" type="boolean" readonly="yes">
15417	<desc>
15418	Whether the error is fatal or not.
15419	</desc>
15420	</attribute>
15421	<attribute name="id" type="wstring" readonly="yes">
15422	<desc>
15423	Error identifier.
15424	</desc>
15425	</attribute>
15426	<attribute name="message" type="wstring" readonly="yes">
15427	<desc>
15428	Optional error message.
15429	</desc>
15430	</attribute>
15431	</interface>
15432
15433
15434	<interface
15435	name="IEventSourceChangedEvent" extends="IEvent"
15436	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
15437	waitable="yes"
15438	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
15439	>
15440	<desc>
15441	Notification when an event source state changes (listener added or removed).
15442	</desc>
15443
15444	<attribute name="listener" type="IEventListener" readonly="yes">
15445	<desc>
15446	Event listener which has changed.
15447	</desc>
15448	</attribute>
15449
15450	<attribute name="add" type="boolean" readonly="yes">
15451	<desc>
15452	Flag whether listener was added or removed.
15453	</desc>
15454	</attribute>
15455	</interface>
15456
15457	<interface
15458	name="IExtraDataChangedEvent" extends="IEvent"
15459	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
15460	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
15461	>
15462	<desc>
15463	Notification when machine specific or global extra data
15464	has changed.
15465	</desc>
15466	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15467	<desc>
15468	ID of the machine this event relates to.
15469	Null for global extra data changes.
15470	</desc>
15471	</attribute>
15472	<attribute name="key" type="wstring" readonly="yes">
15473	<desc>
15474	Extra data key that has changed.
15475	</desc>
15476	</attribute>
15477	<attribute name="value" type="wstring" readonly="yes">
15478	<desc>
15479	Extra data value for the given key.
15480	</desc>
15481	</attribute>
15482	</interface>
15483
15484	<interface
15485	name="IVetoEvent" extends="IEvent"
15486	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
15487	wsmap="managed"
15488	>
15489	<desc>Base abstract interface for veto events.</desc>
15490
15491	<method name="addVeto">
15492	<desc>
15493	Adds a veto on this event.
15494	</desc>
15495	<param name="reason" type="wstring" dir="in">
15496	<desc>
15497	Reason for veto, could be null or empty string.
15498	</desc>
15499	</param>
15500	</method>
15501
15502	<method name="isVetoed">
15503	<desc>
15504	If this event was vetoed.
15505	</desc>
15506	<param name="result" type="boolean" dir="return">
15507	<desc>
15508	Reason for veto.
15509	</desc>
15510	</param>
15511	</method>
15512
15513	<method name="getVetos">
15514	<desc>
15515	Current veto reason list, if size is 0 - no veto.
15516	</desc>
15517	<param name="result" type="wstring" dir="return" safearray="yes">
15518	<desc>
15519	Array of reasons for veto provided by different event handlers.
15520	</desc>
15521	</param>
15522	</method>
15523
15524	</interface>
15525
15526	<interface
15527	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
15528	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
15529	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
15530	waitable="true"
15531	>
15532	<desc>
15533	Notification when someone tries to change extra data for
15534	either the given machine or (if @c null) global extra data.
15535	This gives the chance to veto against changes.
15536	</desc>
15537	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
15538	<desc>
15539	ID of the machine this event relates to.
15540	Null for global extra data changes.
15541	</desc>
15542	</attribute>
15543	<attribute name="key" type="wstring" readonly="yes">
15544	<desc>
15545	Extra data key that has changed.
15546	</desc>
15547	</attribute>
15548	<attribute name="value" type="wstring" readonly="yes">
15549	<desc>
15550	Extra data value for the given key.
15551	</desc>
15552	</attribute>
15553	</interface>
15554
15555	<interface
15556	name="ICanShowWindowEvent" extends="IVetoEvent"
15557	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
15558	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
15559	waitable="true"
15560	>
15561	<desc>
15562	Notification when a call to
15563	<link to="IMachine::canShowConsoleWindow"/> is made by a
15564	front-end to check if a subsequent call to
15565	<link to="IMachine::showConsoleWindow"/> can succeed.
15566
15567	The callee should give an answer appropriate to the current
15568	machine state using event veto. This answer must
15569	remain valid at least until the next
15570	<link to="IConsole::state">machine state</link> change.
15571	</desc>
15572	</interface>
15573
15574	<interface
15575	name="IShowWindowEvent" extends="IEvent"
15576	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
15577	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
15578	waitable="true"
15579	>
15580	<desc>
15581	Notification when a call to
15582	<link to="IMachine::showConsoleWindow"/>
15583	requests the console window to be activated and brought to
15584	foreground on the desktop of the host PC.
15585
15586	This notification should cause the VM console process to
15587	perform the requested action as described above. If it is
15588	impossible to do it at a time of this notification, this
15589	method should return a failure.
15590
15591	Note that many modern window managers on many platforms
15592	implement some sort of focus stealing prevention logic, so
15593	that it may be impossible to activate a window without the
15594	help of the currently active application (which is supposedly
15595	an initiator of this notification). In this case, this method
15596	must return a non-zero identifier that represents the
15597	top-level window of the VM console process. The caller, if it
15598	represents a currently active process, is responsible to use
15599	this identifier (in a platform-dependent manner) to perform
15600	actual window activation.
15601
15602	This method must set @a winId to zero if it has performed all
15603	actions necessary to complete the request and the console
15604	window is now active and in foreground, to indicate that no
15605	further action is required on the caller's side.
15606	</desc>
15607	<attribute name="winId" type="long long">
15608	<desc>
15609	Platform-dependent identifier of the top-level VM console
15610	window, or zero if this method has performed all actions
15611	necessary to implement the <i>show window</i> semantics for
15612	the given platform and/or this VirtualBox front-end.
15613	</desc>
15614	</attribute>
15615	</interface>
15616
15617	<interface
15618	name="INATRedirectEvent" extends="IMachineEvent"
15619	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
15620	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirectEvent"
15621	>
15622	<desc>
15623	Notification when NAT redirect rule added or removed.
15624	</desc>
15625	<attribute name="slot" type="unsigned long" readonly="yes">
15626	<desc>
15627	Adapter which NAT attached to.
15628	</desc>
15629	</attribute>
15630	<attribute name="remove" type="boolean" readonly="yes">
15631	<desc>
15632	Whether rule remove or add.
15633	</desc>
15634	</attribute>
15635	<attribute name="name" type="wstring" readonly="yes">
15636	<desc>
15637	Name of the rule.
15638	</desc>
15639	</attribute>
15640	<attribute name="proto" type="NATProtocol" readonly="yes">
15641	<desc>
15642	Protocol (TCP or UDP) of the redirect rule.
15643	</desc>
15644	</attribute>
15645	<attribute name="hostIp" type="wstring" readonly="yes">
15646	<desc>
15647	Host ip address to bind socket on.
15648	</desc>
15649	</attribute>
15650	<attribute name="hostPort" type="long" readonly="yes">
15651	<desc>
15652	Host port to bind socket on.
15653	</desc>
15654	</attribute>
15655	<attribute name="guestIp" type="wstring" readonly="yes">
15656	<desc>
15657	Guest ip address to redirect to.
15658	</desc>
15659	</attribute>
15660	<attribute name="guestPort" type="long" readonly="yes">
15661	<desc>
15662	Guest port to redirect to.
15663	</desc>
15664	</attribute>
15665	</interface>
15666
15667	<module name="VBoxSVC" context="LocalServer">
15668	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
15669	namespace="virtualbox.org">
15670	<interface name="IVirtualBox" default="yes"/>
15671	</class>
15672	</module>
15673
15674	<module name="VBoxC" context="InprocServer" threadingModel="Free">
15675	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
15676	namespace="virtualbox.org">
15677	<interface name="ISession" default="yes"/>
15678	</class>
15679
15680	<class name="Console" uuid="577230FF-164F-4CAC-8548-312D8275A4A7"
15681	namespace="virtualbox.org">
15682	<interface name="IConsole" default="yes"/>
15683	</class>
15684	</module>
15685
15686	</library>
15687
15688	</idl>
15689
15690	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format