VirtualBox.xidl@ 35577

Last change on this file since 35577 was 35523, checked in by vboxsync, 14 years ago
Main,VBoxManage: Implemented the progress objects for ExtPackManager::Uninstall and ExtPackFile::Install. Fixed a bug in ExtPackFile wrt cleaning up on failure.
Property svn:eol-style set to `native`
File size: 608.5 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2011 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). Note that when pointers representing input
275	arguments (such as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="Future" value="99999">
484	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
485	</const>
486	</enum>
487
488	<enum
489	name="AccessMode"
490	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
491	>
492	<desc>
493	Access mode for opening files.
494	</desc>
495
496	<const name="ReadOnly" value="1"/>
497	<const name="ReadWrite" value="2"/>
498	</enum>
499
500	<enum
501	name="MachineState"
502	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
503	>
504	<desc>
505	Virtual machine execution state.
506
507	This enumeration represents possible values of the <link
508	to="IMachine::state"/> attribute.
509
510	Below is the basic virtual machine state diagram. It shows how the state
511	changes during virtual machine execution. The text in square braces shows
512	a method of the IConsole interface that performs the given state
513	transition.
514
515	<pre>
516	+---------[powerDown()] <- Stuck <--[failure]-+
517	V \|
518	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
519	\| \| \| \| V \|
520	\| Aborted -----+ +--> Running --[pause()]--> Paused
521	\| \| ^ \| ^ \|
522	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
523	\| ^ \| \| \| \|
524	\| \| +-----------------------------------------+-\|-------------------+ +
525	\| \| \| \| \|
526	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
527	\| \| \| \|
528	\| +-------- Saving <--------[saveState()]<----------+---------------------+
529	\| \| \|
530	+-------------- Stopping -------[powerDown()]<----------+---------------------+
531	</pre>
532
533	Note that states to the right from PoweredOff, Aborted and Saved in the
534	above diagram are called <i>online VM states</i>. These states
535	represent the virtual machine which is being executed in a dedicated
536	process (usually with a GUI window attached to it where you can see the
537	activity of the virtual machine and interact with it). There are two
538	special pseudo-states, FirstOnline and LastOnline, that can be used in
539	relational expressions to detect if the given machine state is online or
540	not:
541
542	<pre>
543	if (machine.GetState() >= MachineState_FirstOnline &&
544	machine.GetState() <= MachineState_LastOnline)
545	{
546	...the machine is being executed...
547	}
548	</pre>
549
550	When the virtual machine is in one of the online VM states (that is, being
551	executed), only a few machine settings can be modified. Methods working
552	with such settings contain an explicit note about that. An attempt to
553	change any oter setting or perform a modifying operation during this time
554	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
555
556	All online states except Running, Paused and Stuck are transitional: they
557	represent temporary conditions of the virtual machine that will last as
558	long as the operation that initiated such a condition.
559
560	The Stuck state is a special case. It means that execution of the machine
561	has reached the "Guru Meditation" condition. This condition indicates an
562	internal VMM (virtual machine manager) failure which may happen as a
563	result of either an unhandled low-level virtual hardware exception or one
564	of the recompiler exceptions (such as the <i>too-many-traps</i>
565	condition).
566
567	Note also that any online VM state may transit to the Aborted state. This
568	happens if the process that is executing the virtual machine terminates
569	unexpectedly (for example, crashes). Other than that, the Aborted state is
570	equivalent to PoweredOff.
571
572	There are also a few additional state diagrams that do not deal with
573	virtual machine execution and therefore are shown separately. The states
574	shown on these diagrams are called <i>offline VM states</i> (this includes
575	PoweredOff, Aborted and Saved too).
576
577	The first diagram shows what happens when a lengthy setup operation is
578	being executed (such as <link to="IMachine::attachDevice"/>).
579
580	<pre>
581	+----------------------------------(same state as before the call)------+
582	\| \|
583	+-> PoweredOff --+ \|
584	\| \| \|
585	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
586	\| \|
587	+-> Saved -------+
588	</pre>
589
590	The next two diagrams demonstrate the process of taking a snapshot of a
591	powered off virtual machine, restoring the state to that as of a snapshot
592	or deleting a snapshot, respectively.
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| +-->[takeSnapshot()] -------------------> Saving ------+
599	+-> Aborted -----+
600
601	+-> PoweredOff --+
602	\| \|
603	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
604	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
605	+-> Saved -------+ \|
606	\| \|
607	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
608	</pre>
609
610	Note that the Saving state is present in both the offline state group and
611	online state group. Currently, the only way to determine what group is
612	assumed in a particular case is to remember the previous machine state: if
613	it was Running or Paused, then Saving is an online state, otherwise it is
614	an offline state. This inconsistency may be removed in one of the future
615	versions of VirtualBox by adding a new state.
616
617	<note internal="yes">
618	For whoever decides to touch this enum: In order to keep the
619	comparisons involving FirstOnline and LastOnline pseudo-states valid,
620	the numeric values of these states must be correspondingly updated if
621	needed: for any online VM state, the condition
622	<tt>FirstOnline <= state <= LastOnline</tt> must be
623	@c true. The same relates to transient states for which
624	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
625	@c true.
626	</note>
627	</desc>
628
629	<const name="Null" value="0">
630	<desc>Null value (never used by the API).</desc>
631	</const>
632	<const name="PoweredOff" value="1">
633	<desc>
634	The machine is not running and has no saved execution state; it has
635	either never been started or been shut down successfully.
636	</desc>
637	</const>
638	<const name="Saved" value="2">
639	<desc>
640	The machine is not currently running, but the execution state of the machine
641	has been saved to an external file when it was running, from where
642	it can be resumed.
643	</desc>
644	</const>
645	<const name="Teleported" value="3">
646	<desc>
647	The machine was teleported to a different host (or process) and then
648	powered off. Take care when powering it on again may corrupt resources
649	it shares with the teleportation target (e.g. disk and network).
650	</desc>
651	</const>
652	<const name="Aborted" value="4">
653	<desc>
654	The process running the machine has terminated abnormally. This may
655	indicate a crash of the VM process in host execution context, or
656	the VM process has been terminated externally.
657	</desc>
658	</const>
659	<const name="Running" value="5">
660	<desc>
661	The machine is currently being executed.
662	<note internal="yes">
663	For whoever decides to touch this enum: In order to keep the
664	comparisons in the old source code valid, this state must immediately
665	precede the Paused state.
666	TODO: Lift this spectacularly wonderful restriction.
667	</note>
668	</desc>
669	</const>
670	<const name="Paused" value="6">
671	<desc>
672	Execution of the machine has been paused.
673	<note internal="yes">
674	For whoever decides to touch this enum: In order to keep the
675	comparisons in the old source code valid, this state must immediately
676	follow the Running state.
677	TODO: Lift this spectacularly wonderful restriction.
678	</note>
679	</desc>
680	</const>
681	<const name="Stuck" value="7">
682	<desc>
683	Execution of the machine has reached the "Guru Meditation"
684	condition. This indicates a severe error in the hypervisor itself.
685	<note internal="yes">
686	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
687	"Guru", perhaps? Or are there some other VMM states that are
688	intended to be lumped in here as well?
689	</note>
690	</desc>
691	</const>
692	<const name="Teleporting" value="8">
693	<desc>
694	The machine is about to be teleported to a different host or process.
695	It is possible to pause a machine in this state, but it will go to the
696	@c TeleportingPausedVM state and it will not be
697	possible to resume it again unless the teleportation fails.
698	</desc>
699	</const>
700	<const name="LiveSnapshotting" value="9">
701	<desc>
702	A live snapshot is being taken. The machine is running normally, but
703	some of the runtime configuration options are inaccessible. Also, if
704	paused while in this state it will transition to
705	@c Saving and it will not be resume the
706	execution until the snapshot operation has completed.
707	</desc>
708	</const>
709	<const name="Starting" value="10">
710	<desc>
711	Machine is being started after powering it on from a
712	zero execution state.
713	</desc>
714	</const>
715	<const name="Stopping" value="11">
716	<desc>
717	Machine is being normally stopped powering it off, or after the guest OS
718	has initiated a shutdown sequence.
719	</desc>
720	</const>
721	<const name="Saving" value="12">
722	<desc>
723	Machine is saving its execution state to a file, or an online
724	snapshot of the machine is being taken.
725	</desc>
726	</const>
727	<const name="Restoring" value="13">
728	<desc>
729	Execution state of the machine is being restored from a file
730	after powering it on from the saved execution state.
731	</desc>
732	</const>
733	<const name="TeleportingPausedVM" value="14">
734	<desc>
735	The machine is being teleported to another host or process, but it is
736	not running. This is the paused variant of the
737	@c state.
738	</desc>
739	</const>
740	<const name="TeleportingIn" value="15">
741	<desc>
742	Teleporting the machine state in from another host or process.
743	</desc>
744	</const>
745	<const name="FaultTolerantSyncing" value="16">
746	<desc>
747	The machine is being synced with a fault tolerant VM running elsewhere.
748	</desc>
749	</const>
750	<const name="DeletingSnapshotOnline" value="17">
751	<desc>
752	Like @c DeletingSnapshot, but the merging of media is ongoing in
753	the background while the machine is running.
754	</desc>
755	</const>
756	<const name="DeletingSnapshotPaused" value="18">
757	<desc>
758	Like @c DeletingSnapshotOnline, but the machine was paused when the
759	merging of differencing media was started.
760	</desc>
761	</const>
762	<const name="RestoringSnapshot" value="19">
763	<desc>
764	A machine snapshot is being restored; this typically does not take long.
765	</desc>
766	</const>
767	<const name="DeletingSnapshot" value="20">
768	<desc>
769	A machine snapshot is being deleted; this can take a long time since this
770	may require merging differencing media. This value indicates that the
771	machine is not running while the snapshot is being deleted.
772	</desc>
773	</const>
774	<const name="SettingUp" value="21">
775	<desc>
776	Lengthy setup operation is in progress.
777	</desc>
778	</const>
779
780	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
781	<desc>
782	Pseudo-state: first online state (for use in relational expressions).
783	</desc>
784	</const>
785	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
786	<desc>
787	Pseudo-state: last online state (for use in relational expressions).
788	</desc>
789	</const>
790
791	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
792	<desc>
793	Pseudo-state: first transient state (for use in relational expressions).
794	</desc>
795	</const>
796	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
797	<desc>
798	Pseudo-state: last transient state (for use in relational expressions).
799	</desc>
800	</const>
801
802	</enum>
803
804	<enum
805	name="SessionState"
806	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
807	>
808	<desc>
809	Session state. This enumeration represents possible values of
810	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
811	attributes.
812	</desc>
813
814	<const name="Null" value="0">
815	<desc>Null value (never used by the API).</desc>
816	</const>
817	<const name="Unlocked" value="1">
818	<desc>
819	In <link to="IMachine::sessionState"/>, this means that the machine
820	is not locked for any sessions.
821
822	In <link to="ISession::state"/>, this means that no machine is
823	currently locked for this session.
824	</desc>
825	</const>
826	<const name="Locked" value="2">
827	<desc>
828	In <link to="IMachine::sessionState"/>, this means that the machine
829	is currently locked for a session, whose process identifier can
830	then be found in the <link to="IMachine::sessionPid" /> attribute.
831
832	In <link to="ISession::state"/>, this means that a machine is
833	currently locked for this session, and the mutable machine object
834	can be found in the <link to="ISession::machine"/> attribute
835	(see <link to="IMachine::lockMachine" /> for details).
836	</desc>
837	</const>
838	<const name="Spawning" value="3">
839	<desc>
840	A new process is being spawned for the machine as a result of
841	<link to="IMachine::launchVMProcess"/> call. This state also occurs
842	as a short transient state during an <link to="IMachine::lockMachine"/>
843	call.
844	</desc>
845	</const>
846	<const name="Unlocking" value="4">
847	<desc>
848	The session is being unlocked.
849	</desc>
850	</const>
851	</enum>
852
853	<enum
854	name="CPUPropertyType"
855	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
856	>
857	<desc>
858	Virtual CPU property type. This enumeration represents possible values of the
859	IMachine get- and setCPUProperty methods.
860	</desc>
861	<const name="Null" value="0">
862	<desc>Null value (never used by the API).</desc>
863	</const>
864	<const name="PAE" value="1">
865	<desc>
866	This setting determines whether VirtualBox will expose the Physical Address
867	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
868	is not available, it will not be reported.
869	</desc>
870	</const>
871	<const name="Synthetic" value="2">
872	<desc>
873	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
874	teleporting between host systems that differ significantly.
875	</desc>
876	</const>
877	</enum>
878
879
880	<enum
881	name="HWVirtExPropertyType"
882	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
883	>
884	<desc>
885	Hardware virtualization property type. This enumeration represents possible values
886	for the <link to="IMachine::getHWVirtExProperty"/> and
887	<link to="IMachine::setHWVirtExProperty"/> methods.
888	</desc>
889	<const name="Null" value="0">
890	<desc>Null value (never used by the API).</desc>
891	</const>
892	<const name="Enabled" value="1">
893	<desc>
894	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
895	such extensions are not available, they will not be used.
896	</desc>
897	</const>
898	<const name="Exclusive" value="2">
899	<desc>
900	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
901	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
902	feature of the host. To share these with other hypervisors, you must disable this property.
903	</desc>
904	</const>
905	<const name="VPID" value="3">
906	<desc>
907	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
908	</desc>
909	</const>
910	<const name="NestedPaging" value="4">
911	<desc>
912	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
913	</desc>
914	</const>
915	<const name="LargePages" value="5">
916	<desc>
917	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
918	</desc>
919	</const>
920	<const name="Force" value="6">
921	<desc>
922	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
923	not set, there will be an automatic fallback to software virtualization.
924	</desc>
925	</const>
926	</enum>
927
928	<enum
929	name="FaultToleranceState"
930	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
931	>
932	<desc>
933	Used with <link to="IMachine::faultToleranceState" />.
934	</desc>
935	<const name="Inactive" value="1">
936	<desc>No fault tolerance enabled.</desc>
937	</const>
938	<const name="Master" value="2">
939	<desc>Fault tolerant master VM.</desc>
940	</const>
941	<const name="Standby" value="3">
942	<desc>Fault tolerant standby VM.</desc>
943	</const>
944	</enum>
945
946	<enum
947	name="LockType"
948	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
949	>
950	<desc>
951	Used with <link to="IMachine::lockMachine" />.
952	</desc>
953	<const name="Write" value="2">
954	<desc>Lock the machine for writing.</desc>
955	</const>
956	<const name="Shared" value="1">
957	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
958	</const>
959	</enum>
960
961	<enum
962	name="SessionType"
963	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
964	>
965	<desc>
966	Session type. This enumeration represents possible values of the
967	<link to="ISession::type"/> attribute.
968	</desc>
969
970	<const name="Null" value="0">
971	<desc>Null value (never used by the API).</desc>
972	</const>
973	<const name="WriteLock" value="1">
974	<desc>
975	Session has acquired an exclusive write lock on a machine
976	using <link to="IMachine::lockMachine"/>.
977	</desc>
978	</const>
979	<const name="Remote" value="2">
980	<desc>
981	Session has launched a VM process using
982	<link to="IMachine::launchVMProcess"/>
983	</desc>
984	</const>
985	<const name="Shared" value="3">
986	<desc>
987	Session has obtained a link to another session using
988	<link to="IMachine::lockMachine"/>
989	</desc>
990	</const>
991	</enum>
992
993	<enum
994	name="DeviceType"
995	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
996	>
997	<desc>
998	Device type.
999	</desc>
1000	<const name="Null" value="0">
1001	<desc>
1002	Null value, may also mean "no device" (not allowed for
1003	<link to="IConsole::getDeviceActivity"/>).
1004	</desc>
1005	</const>
1006	<const name="Floppy" value="1">
1007	<desc>Floppy device.</desc>
1008	</const>
1009	<const name="DVD" value="2">
1010	<desc>CD/DVD-ROM device.</desc>
1011	</const>
1012	<const name="HardDisk" value="3">
1013	<desc>Hard disk device.</desc>
1014	</const>
1015	<const name="Network" value="4">
1016	<desc>Network device.</desc>
1017	</const>
1018	<const name="USB" value="5">
1019	<desc>USB device.</desc>
1020	</const>
1021	<const name="SharedFolder" value="6">
1022	<desc>Shared folder device.</desc>
1023	</const>
1024	</enum>
1025
1026	<enum
1027	name="DeviceActivity"
1028	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1029	>
1030	<desc>
1031	Device activity for <link to="IConsole::getDeviceActivity"/>.
1032	</desc>
1033
1034	<const name="Null" value="0"/>
1035	<const name="Idle" value="1"/>
1036	<const name="Reading" value="2"/>
1037	<const name="Writing" value="3"/>
1038	</enum>
1039
1040	<enum
1041	name="ClipboardMode"
1042	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1043	>
1044	<desc>
1045	Host-Guest clipboard interchange mode.
1046	</desc>
1047
1048	<const name="Disabled" value="0"/>
1049	<const name="HostToGuest" value="1"/>
1050	<const name="GuestToHost" value="2"/>
1051	<const name="Bidirectional" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="Scope"
1056	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1057	>
1058	<desc>
1059	Scope of the operation.
1060
1061	A generic enumeration used in various methods to define the action or
1062	argument scope.
1063	</desc>
1064
1065	<const name="Global" value="0"/>
1066	<const name="Machine" value="1"/>
1067	<const name="Session" value="2"/>
1068	</enum>
1069
1070	<enum
1071	name="BIOSBootMenuMode"
1072	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1073	>
1074	<desc>
1075	BIOS boot menu mode.
1076	</desc>
1077
1078	<const name="Disabled" value="0"/>
1079	<const name="MenuOnly" value="1"/>
1080	<const name="MessageAndMenu" value="2"/>
1081	</enum>
1082
1083	<enum
1084	name="ProcessorFeature"
1085	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1086	>
1087	<desc>
1088	CPU features.
1089	</desc>
1090
1091	<const name="HWVirtEx" value="0"/>
1092	<const name="PAE" value="1"/>
1093	<const name="LongMode" value="2"/>
1094	<const name="NestedPaging" value="3"/>
1095	</enum>
1096
1097	<enum
1098	name="FirmwareType"
1099	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1100	>
1101	<desc>
1102	Firmware type.
1103	</desc>
1104	<const name="BIOS" value="1">
1105	<desc>BIOS Firmware.</desc>
1106	</const>
1107	<const name="EFI" value="2">
1108	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1109	</const>
1110	<const name="EFI32" value="3">
1111	<desc>Efi firmware, 32-bit.</desc>
1112	</const>
1113	<const name="EFI64" value="4">
1114	<desc>Efi firmware, 64-bit.</desc>
1115	</const>
1116	<const name="EFIDUAL" value="5">
1117	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1118	</const>
1119	</enum>
1120
1121	<enum
1122	name="PointingHidType"
1123	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1124	>
1125	<desc>
1126	Type of pointing device used in a virtual machine.
1127	</desc>
1128	<const name="None" value="1">
1129	<desc>No mouse.</desc>
1130	</const>
1131	<const name="PS2Mouse" value="2">
1132	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1133	</const>
1134	<const name="USBMouse" value="3">
1135	<desc>USB mouse (relative pointer).</desc>
1136	</const>
1137	<const name="USBTablet" value="4">
1138	<desc>USB tablet (absolute pointer).</desc>
1139	</const>
1140	<const name="ComboMouse" value="5">
1141	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1142	Using of such device can have negative performance implications. </desc>
1143	</const>
1144	</enum>
1145
1146	<enum
1147	name="KeyboardHidType"
1148	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1149	>
1150	<desc>
1151	Type of keyboard device used in a virtual machine.
1152	</desc>
1153	<const name="None" value="1">
1154	<desc>No keyboard.</desc>
1155	</const>
1156	<const name="PS2Keyboard" value="2">
1157	<desc>PS/2 keyboard.</desc>
1158	</const>
1159	<const name="USBKeyboard" value="3">
1160	<desc>USB keyboard.</desc>
1161	</const>
1162	<const name="ComboKeyboard" value="4">
1163	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1164	Using of such device can have negative performance implications. </desc>
1165	</const>
1166	</enum>
1167
1168	<!--
1169	// IVirtualBoxErrorInfo
1170	/////////////////////////////////////////////////////////////////////////
1171	-->
1172
1173	<interface
1174	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1175	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1176	supportsErrorInfo="no"
1177	wsmap="managed"
1178	>
1179	<desc>
1180	The IVirtualBoxErrorInfo interface represents extended error information.
1181
1182	Extended error information can be set by VirtualBox components after
1183	unsuccessful or partially successful method invocation. This information
1184	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1185	and then shown to the client in addition to the plain 32-bit result code.
1186
1187	In MS COM, this interface extends the IErrorInfo interface,
1188	in XPCOM, it extends the nsIException interface. In both cases,
1189	it provides a set of common attributes to retrieve error
1190	information.
1191
1192	Sometimes invocation of some component's method may involve methods of
1193	other components that may also fail (independently of this method's
1194	failure), or a series of non-fatal errors may precede a fatal error that
1195	causes method failure. In cases like that, it may be desirable to preserve
1196	information about all errors happened during method invocation and deliver
1197	it to the caller. The <link to="#next"/> attribute is intended
1198	specifically for this purpose and allows to represent a chain of errors
1199	through a single IVirtualBoxErrorInfo object set after method invocation.
1200
1201	Note that errors are stored to a chain in the reverse order, i.e. the
1202	initial error object you query right after method invocation is the last
1203	error set by the callee, the object it points to in the @a next attribute
1204	is the previous error and so on, up to the first error (which is the last
1205	in the chain).
1206	</desc>
1207
1208	<attribute name="resultCode" type="long" readonly="yes">
1209	<desc>
1210	Result code of the error.
1211	Usually, it will be the same as the result code returned
1212	by the method that provided this error information, but not
1213	always. For example, on Win32, CoCreateInstance() will most
1214	likely return E_NOINTERFACE upon unsuccessful component
1215	instantiation attempt, but not the value the component factory
1216	returned. Value is typed 'long', not 'result',
1217	to make interface usable from scripting languages.
1218	<note>
1219	In MS COM, there is no equivalent.
1220	In XPCOM, it is the same as nsIException::result.
1221	</note>
1222	</desc>
1223	</attribute>
1224
1225	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1226	<desc>
1227	UUID of the interface that defined the error.
1228	<note>
1229	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1230	data type.
1231	In XPCOM, there is no equivalent.
1232	</note>
1233	</desc>
1234	</attribute>
1235
1236	<attribute name="component" type="wstring" readonly="yes">
1237	<desc>
1238	Name of the component that generated the error.
1239	<note>
1240	In MS COM, it is the same as IErrorInfo::GetSource.
1241	In XPCOM, there is no equivalent.
1242	</note>
1243	</desc>
1244	</attribute>
1245
1246	<attribute name="text" type="wstring" readonly="yes">
1247	<desc>
1248	Text description of the error.
1249	<note>
1250	In MS COM, it is the same as IErrorInfo::GetDescription.
1251	In XPCOM, it is the same as nsIException::message.
1252	</note>
1253	</desc>
1254	</attribute>
1255
1256	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1257	<desc>
1258	Next error object if there is any, or @c null otherwise.
1259	<note>
1260	In MS COM, there is no equivalent.
1261	In XPCOM, it is the same as nsIException::inner.
1262	</note>
1263	</desc>
1264	</attribute>
1265
1266	</interface>
1267
1268	<!--
1269	// IVirtualBox
1270	/////////////////////////////////////////////////////////////////////////
1271	-->
1272
1273	<interface
1274	name="IDHCPServer" extends="$unknown"
1275	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1276	wsmap="managed"
1277	>
1278	<desc>
1279	The IDHCPServer interface represents the vbox dhcp server configuration.
1280
1281	To enumerate all the dhcp servers on the host, use the
1282	<link to="IVirtualBox::DHCPServers"/> attribute.
1283	</desc>
1284
1285	<attribute name="enabled" type="boolean">
1286	<desc>
1287	specifies if the dhcp server is enabled
1288	</desc>
1289	</attribute>
1290
1291	<attribute name="IPAddress" type="wstring" readonly="yes">
1292	<desc>
1293	specifies server IP
1294	</desc>
1295	</attribute>
1296
1297	<attribute name="networkMask" type="wstring" readonly="yes">
1298	<desc>
1299	specifies server network mask
1300	</desc>
1301	</attribute>
1302
1303	<attribute name="networkName" type="wstring" readonly="yes">
1304	<desc>
1305	specifies internal network name the server is used for
1306	</desc>
1307	</attribute>
1308
1309	<attribute name="lowerIP" type="wstring" readonly="yes">
1310	<desc>
1311	specifies from IP address in server address range
1312	</desc>
1313	</attribute>
1314
1315	<attribute name="upperIP" type="wstring" readonly="yes">
1316	<desc>
1317	specifies to IP address in server address range
1318	</desc>
1319	</attribute>
1320
1321	<method name="setConfiguration">
1322	<desc>
1323	configures the server
1324	<result name="E_INVALIDARG">
1325	invalid configuration supplied
1326	</result>
1327	</desc>
1328	<param name="IPAddress" type="wstring" dir="in">
1329	<desc>
1330	server IP address
1331	</desc>
1332	</param>
1333	<param name="networkMask" type="wstring" dir="in">
1334	<desc>
1335	server network mask
1336	</desc>
1337	</param>
1338	<param name="FromIPAddress" type="wstring" dir="in">
1339	<desc>
1340	server From IP address for address range
1341	</desc>
1342	</param>
1343	<param name="ToIPAddress" type="wstring" dir="in">
1344	<desc>
1345	server To IP address for address range
1346	</desc>
1347	</param>
1348	</method>
1349
1350	<method name="start">
1351	<desc>
1352	Starts DHCP server process.
1353	<result name="E_FAIL">
1354	Failed to start the process.
1355	</result>
1356	</desc>
1357	<param name="networkName" type="wstring" dir="in">
1358	<desc>
1359	Name of internal network DHCP server should attach to.
1360	</desc>
1361	</param>
1362	<param name="trunkName" type="wstring" dir="in">
1363	<desc>
1364	Name of internal network trunk.
1365	</desc>
1366	</param>
1367	<param name="trunkType" type="wstring" dir="in">
1368	<desc>
1369	Type of internal network trunk.
1370	</desc>
1371	</param>
1372	</method>
1373
1374	<method name="stop">
1375	<desc>
1376	Stops DHCP server process.
1377	<result name="E_FAIL">
1378	Failed to stop the process.
1379	</result>
1380	</desc>
1381	</method>
1382	</interface>
1383
1384	<interface
1385	name="IVirtualBox" extends="$unknown"
1386	uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff"
1387	wsmap="managed"
1388	>
1389	<desc>
1390	The IVirtualBox interface represents the main interface exposed by the
1391	product that provides virtual machine management.
1392
1393	An instance of IVirtualBox is required for the product to do anything
1394	useful. Even though the interface does not expose this, internally,
1395	IVirtualBox is implemented as a singleton and actually lives in the
1396	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1397	IVirtualBox can track the state of all virtual machines on a particular
1398	host, regardless of which frontend started them.
1399
1400	To enumerate all the virtual machines on the host, use the
1401	<link to="IVirtualBox::machines"/> attribute.
1402	</desc>
1403
1404	<attribute name="version" type="wstring" readonly="yes">
1405	<desc>
1406	A string representing the version number of the product. The
1407	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1408	last number represents the build number and will frequently change.
1409	</desc>
1410	</attribute>
1411
1412	<attribute name="revision" type="unsigned long" readonly="yes">
1413	<desc>
1414	The internal build revision number of the product.
1415	</desc>
1416	</attribute>
1417
1418	<attribute name="packageType" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the package type of this product. The
1421	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1422	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1423	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1424	this.
1425	</desc>
1426	</attribute>
1427
1428	<attribute name="homeFolder" type="wstring" readonly="yes">
1429	<desc>
1430	Full path to the directory where the global settings file,
1431	<tt>VirtualBox.xml</tt>, is stored.
1432
1433	In this version of VirtualBox, the value of this property is
1434	always <tt><user_dir>/.VirtualBox</tt> (where
1435	<tt><user_dir></tt> is the path to the user directory,
1436	as determined by the host OS), and cannot be changed.
1437
1438	This path is also used as the base to resolve relative paths in
1439	places where relative paths are allowed (unless otherwise
1440	expressly indicated).
1441	</desc>
1442	</attribute>
1443
1444	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1445	<desc>
1446	Full name of the global settings file.
1447	The value of this property corresponds to the value of
1448	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1449	</desc>
1450	</attribute>
1451
1452	<attribute name="host" type="IHost" readonly="yes">
1453	<desc>Associated host object.</desc>
1454	</attribute>
1455
1456	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1457	<desc>Associated system information object.</desc>
1458	</attribute>
1459
1460	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1461	<desc>
1462	Array of machine objects registered within this VirtualBox instance.
1463	</desc>
1464	</attribute>
1465
1466	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1467	<desc>
1468	Array of medium objects known to this VirtualBox installation.
1469
1470	This array contains only base media. All differencing
1471	media of the given base medium can be enumerated using
1472	<link to="IMedium::children"/>.
1473	</desc>
1474	</attribute>
1475
1476	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1477	<desc>
1478	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1479	</desc>
1480	</attribute>
1481
1482	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1483	<desc>
1484	Array of floppy image objects currently in use by this VirtualBox instance.
1485	</desc>
1486	</attribute>
1487
1488	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1489
1490	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1491
1492	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1493	<desc>
1494	Collection of global shared folders. Global shared folders are
1495	available to all virtual machines.
1496
1497	New shared folders are added to the collection using
1498	<link to="#createSharedFolder"/>. Existing shared folders can be
1499	removed using <link to="#removeSharedFolder"/>.
1500
1501	<note>
1502	In the current version of the product, global shared folders are not
1503	implemented and therefore this collection is always empty.
1504	</note>
1505	</desc>
1506	</attribute>
1507
1508	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1509	<desc>
1510	Associated performance collector object.
1511	</desc>
1512	</attribute>
1513
1514	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1515	<desc>
1516	DHCP servers.
1517	</desc>
1518	</attribute>
1519
1520	<attribute name="eventSource" type="IEventSource" readonly="yes">
1521	<desc>
1522	Event source for VirtualBox events.
1523	</desc>
1524	</attribute>
1525
1526	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1527	<desc>
1528	The extension pack manager.
1529	</desc>
1530	</attribute>
1531
1532
1533	<method name="composeMachineFilename">
1534	<desc>
1535	Returns a recommended full path of the settings file name for a new virtual
1536	machine.
1537
1538	This API serves two purposes:
1539
1540	<ul>
1541	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1542	for the @a settingsFile argument there, which means that API should use
1543	a recommended default file name.</li>
1544
1545	<li>It can be called manually by a client software before creating a machine,
1546	e.g. if that client wants to pre-create the machine directory to create
1547	virtual hard disks in that directory together with the new machine
1548	settings file. In that case, the file name should be stripped from the
1549	full settings file path returned by this function to obtain the
1550	machine directory.</li>
1551	</ul>
1552
1553	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1554	details about the machine name.
1555
1556	If @a baseFolder is a @c null or empty string (which is recommended), the
1557	default machine settings folder
1558	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1559	a base folder for the created machine, resulting in a file name like
1560	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1561	will be used.
1562
1563	This method does not access the host disks. In particular, it does not check
1564	for whether a machine of this name already exists.
1565	</desc>
1566	<param name="name" type="wstring" dir="in">
1567	<desc>Suggested machine name.</desc>
1568	</param>
1569	<param name="baseFolder" type="wstring" dir="in">
1570	<desc>Base machine folder (optional).</desc>
1571	</param>
1572	<param name="file" type="wstring" dir="return">
1573	<desc>Fully qualified path where the machine would be created.</desc>
1574	</param>
1575	</method>
1576
1577	<method name="createMachine">
1578	<desc>
1579	Creates a new virtual machine by creating a machine settings file at
1580	the given location.
1581
1582	VirtualBox machine settings files use a custom XML dialect. Starting
1583	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1584	and machine files can be created at arbitrary locations.
1585
1586	However, it is is recommended that machines be created in the default
1587	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1588	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1589	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1590	is called automatically to have such a recommended name composed based
1591	on the machine name given in the @a name argument.
1592
1593	If the resulting settings file already exists, this method will fail,
1594	unless @a forceOverwrite is set.
1595
1596	The new machine is created unregistered, with the initial configuration
1597	set according to the specified guest OS type. A typical sequence of
1598	actions to create a new virtual machine is as follows:
1599
1600	<ol>
1601	<li>
1602	Call this method to have a new machine created. The returned machine
1603	object will be "mutable" allowing to change any machine property.
1604	</li>
1605
1606	<li>
1607	Configure the machine using the appropriate attributes and methods.
1608	</li>
1609
1610	<li>
1611	Call <link to="IMachine::saveSettings" /> to write the settings
1612	to the machine's XML settings file. The configuration of the newly
1613	created machine will not be saved to disk until this method is
1614	called.
1615	</li>
1616
1617	<li>
1618	Call <link to="#registerMachine" /> to add the machine to the list
1619	of machines known to VirtualBox.
1620	</li>
1621	</ol>
1622
1623	The specified guest OS type identifier must match an ID of one of known
1624	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1625	array.
1626
1627	Optionally, you may specify an UUID of to assign to the created machine.
1628	However, this is not recommended and you should normally pass an empty
1629	(@c null) UUID to this method so that a new UUID will be automatically
1630	generated for every created machine. You can use UUID
1631	00000000-0000-0000-0000-000000000000 as @c null value.
1632
1633	<note>
1634	There is no way to change the name of the settings file or
1635	subfolder of the created machine directly.
1636	</note>
1637
1638	<result name="VBOX_E_OBJECT_NOT_FOUND">
1639	@a osTypeId is invalid.
1640	</result>
1641	<result name="VBOX_E_FILE_ERROR">
1642	Resulting settings file name is invalid or the settings file already
1643	exists or could not be created due to an I/O error.
1644	</result>
1645	<result name="E_INVALIDARG">
1646	@a name is empty or @c null.
1647	</result>
1648	</desc>
1649
1650	<param name="settingsFile" type="wstring" dir="in">
1651	<desc>Fully qualified path where the settings file should be created,
1652	or NULL for a default folder and file based on the @a name argument
1653	(see <link to="#composeMachineFilename" />).</desc>
1654	</param>
1655	<param name="name" type="wstring" dir="in">
1656	<desc>Machine name.</desc>
1657	</param>
1658	<param name="osTypeId" type="wstring" dir="in">
1659	<desc>Guest OS Type ID.</desc>
1660	</param>
1661	<param name="id" type="uuid" mod="string" dir="in">
1662	<desc>Machine UUID (optional).</desc>
1663	</param>
1664	<param name="forceOverwrite" type="boolean" dir="in">
1665	<desc>If true, an existing machine settings file will be overwritten.</desc>
1666	</param>
1667	<param name="machine" type="IMachine" dir="return">
1668	<desc>Created machine object.</desc>
1669	</param>
1670	</method>
1671
1672	<method name="openMachine">
1673	<desc>
1674	Opens a virtual machine from the existing settings file.
1675	The opened machine remains unregistered until you call
1676	<link to="#registerMachine"/>.
1677
1678	The specified settings file name must be fully qualified.
1679	The file must exist and be a valid machine XML settings file
1680	whose contents will be used to construct the machine object.
1681
1682	<result name="VBOX_E_FILE_ERROR">
1683	Settings file name invalid, not found or sharing violation.
1684	</result>
1685	</desc>
1686	<param name="settingsFile" type="wstring" dir="in">
1687	<desc>
1688	Name of the machine settings file.
1689	</desc>
1690	</param>
1691	<param name="machine" type="IMachine" dir="return">
1692	<desc>Opened machine object.</desc>
1693	</param>
1694	<note>
1695	<link to="IMachine::settingsModified"/> will return
1696	@c false for the created machine, until any of machine settings
1697	are changed.
1698	</note>
1699	</method>
1700
1701	<method name="registerMachine">
1702	<desc>
1703
1704	Registers the machine previously created using
1705	<link to="#createMachine"/> or opened using
1706	<link to="#openMachine"/> within this VirtualBox installation. After
1707	successful method invocation, the
1708	<link to="IMachineRegisteredEvent"/> event is fired.
1709
1710	<note>
1711	This method implicitly calls <link to="IMachine::saveSettings"/>
1712	to save all current machine settings before registering it.
1713	</note>
1714
1715	<result name="VBOX_E_OBJECT_NOT_FOUND">
1716	No matching virtual machine found.
1717	</result>
1718	<result name="VBOX_E_INVALID_OBJECT_STATE">
1719	Virtual machine was not created within this VirtualBox instance.
1720	</result>
1721
1722	</desc>
1723	<param name="machine" type="IMachine" dir="in"/>
1724	</method>
1725
1726	<method name="findMachine">
1727	<desc>
1728	Attempts to find a virtual machine given its name or UUID.
1729
1730	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1731	cannot safely be determined.</note>
1732
1733	<result name="VBOX_E_OBJECT_NOT_FOUND">
1734	Could not find registered machine matching @a nameOrId.
1735	</result>
1736
1737	</desc>
1738	<param name="nameOrId" type="wstring" dir="in">
1739	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1740	</param>
1741	<param name="machine" type="IMachine" dir="return">
1742	<desc>Machine object, if found.</desc>
1743	</param>
1744	</method>
1745
1746	<method name="createAppliance">
1747	<desc>
1748	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1749	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1750	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1751	</desc>
1752	<param name="appliance" type="IAppliance" dir="return">
1753	<desc>New appliance.</desc>
1754	</param>
1755	</method>
1756
1757	<method name="createHardDisk">
1758	<desc>
1759	Creates a new base medium object that will use the given storage
1760	format and location for medium data.
1761
1762	Note that the actual storage unit is not created by this method. In
1763	order to do it, and before you are able to attach the created medium
1764	to virtual machines, you must call one of the following methods to
1765	allocate a format-specific storage unit at the specified location:
1766	<ul>
1767	<li><link to="IMedium::createBaseStorage"/></li>
1768	<li><link to="IMedium::createDiffStorage"/></li>
1769	</ul>
1770
1771	Some medium attributes, such as <link to="IMedium::id"/>, may
1772	remain uninitialized until the medium storage unit is successfully
1773	created by one of the above methods.
1774
1775	After the storage unit is successfully created, it will be
1776	accessible through the <link to="#findMedium"/> method and can
1777	be found in the <link to="#hardDisks"/> array.
1778
1779	The list of all storage formats supported by this VirtualBox
1780	installation can be obtained using
1781	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1782	attribute is empty or @c null then the default storage format
1783	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1784	be used for creating a storage unit of the medium.
1785
1786	Note that the format of the location string is storage format specific.
1787	See <link to="IMedium::location"/> and IMedium for more details.
1788
1789	<result name="VBOX_E_OBJECT_NOT_FOUND">
1790	@a format identifier is invalid. See
1791	<link to="ISystemProperties::mediumFormats"/>.
1792	</result>
1793	<result name="VBOX_E_FILE_ERROR">
1794	@a location is a not valid file name (for file-based formats only).
1795	</result>
1796	</desc>
1797	<param name="format" type="wstring" dir="in">
1798	<desc>
1799	Identifier of the storage format to use for the new medium.
1800	</desc>
1801	</param>
1802	<param name="location" type="wstring" dir="in">
1803	<desc>
1804	Location of the storage unit for the new medium.
1805	</desc>
1806	</param>
1807	<param name="medium" type="IMedium" dir="return">
1808	<desc>Created medium object.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="openMedium">
1813	<desc>
1814	Opens a medium from an existing storage location.
1815
1816	Once a medium has been opened, it can be passed to other VirtualBox
1817	methods, in particular to <link to="IMachine::attachDevice" />.
1818
1819	Depending on the given device type, the file at the storage location
1820	must be in one of the media formats understood by VirtualBox:
1821
1822	<ul>
1823	<li>With a "HardDisk" device type, the file must be a hard disk image
1824	in one of the formats supported by VirtualBox (see
1825	<link to="ISystemProperties::mediumFormats" />).
1826	After this method succeeds, if the medium is a base medium, it
1827	will be added to the <link to="#hardDisks"/> array attribute. </li>
1828	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1829	After this method succeeds, the medium will be added to the
1830	<link to="#DVDImages"/> array attribute.</li>
1831	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1832	After this method succeeds, the medium will be added to the
1833	<link to="#floppyImages"/> array attribute.</li>
1834	</ul>
1835
1836	After having been opened, the medium can be found by the <link to="#findMedium"/>
1837	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1838
1839	The UUID of the newly opened medium will either be retrieved from the
1840	storage location, if the format supports it (e.g. for hard disk images),
1841	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1842	If for some reason you need to change the medium's UUID, use
1843	<link to="IMedium::setIDs" />.
1844
1845	If a differencing hard disk medium is to be opened by this method, the
1846	operation will succeed only if its parent medium and all ancestors,
1847	if any, are already known to this VirtualBox installation (for example,
1848	were opened by this method before).
1849
1850	This method attempts to guess the storage format of the specified medium
1851	by reading medium data at the specified location.
1852
1853	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1854	the image is opened for read/write access and must have according permissions,
1855	as VirtualBox may actually write status information into the disk's metadata
1856	sections.
1857
1858	Note that write access is required for all typical hard disk usage in VirtualBox,
1859	since VirtualBox may need to write metadata such as a UUID into the image.
1860	The only exception is opening a source image temporarily for copying and
1861	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1862	again soon.
1863
1864	The format of the location string is storage format specific. See
1865	<link to="IMedium::location"/> and IMedium for more details.
1866
1867	Prior to VirtualBox 4.0, opening a medium added it to a global media
1868	registry in the VirtualBox.xml file, which was shared between all machines
1869	and made transporting machines and their media from one host to another
1870	difficult.
1871
1872	Starting with VirtualBox 4.0, media are only added to a registry when
1873	they are attached to a machine. Machines created with VirtualBox 4.0
1874	or later can have their own media registry. As a result, a medium attached
1875	to such a machine will be remembered in that machine's XML settings file.
1876	Media attached to older machines will continue to be added to the global
1877	registry.
1878
1879	<result name="VBOX_E_FILE_ERROR">
1880	Invalid medium storage file location or could not find the medium
1881	at the specified location.
1882	</result>
1883	<result name="VBOX_E_IPRT_ERROR">
1884	Could not get medium storage format.
1885	</result>
1886	<result name="E_INVALIDARG">
1887	Invalid medium storage format.
1888	</result>
1889	<result name="VBOX_E_INVALID_OBJECT_STATE">
1890	Medium has already been added to a media registry.
1891	</result>
1892	</desc>
1893	<param name="location" type="wstring" dir="in">
1894	<desc>
1895	Location of the storage unit that contains medium data in one of
1896	the supported storage formats.
1897	</desc>
1898	</param>
1899	<param name="deviceType" type="DeviceType" dir="in">
1900	<desc>
1901	Must be one of "HardDisk", "DVD" or "Floppy".
1902	</desc>
1903	</param>
1904	<param name="accessMode" type="AccessMode" dir="in">
1905	<desc>Whether to open the image in read/write or read-only mode. For
1906	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1907	</param>
1908	<param name="medium" type="IMedium" dir="return">
1909	<desc>Opened medium object.</desc>
1910	</param>
1911	</method>
1912
1913	<method name="findMedium">
1914	<desc>
1915	Returns a medium of the given type that uses the given fully qualified
1916	location or UUID to store medium data.
1917
1918	The given medium must be known to this VirtualBox installation, i.e.
1919	it must be previously created by <link to="#createHardDisk"/> or opened
1920	by <link to="#openMedium"/>.
1921
1922	The search is done by comparing the value of the @a location argument to
1923	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1924	attributes of each known medium.
1925
1926	On case sensitive file systems, a case sensitive comparison is performed,
1927	otherwise the case of symbols in the file path is ignored.
1928
1929	<result name="VBOX_E_OBJECT_NOT_FOUND">
1930	No medium object matching @a location found.
1931	</result>
1932	</desc>
1933	<param name="location" type="wstring" dir="in">
1934	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1935	</param>
1936	<param name="type" type="DeviceType" dir="in">
1937	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1938	</param>
1939	<param name="medium" type="IMedium" dir="return">
1940	<desc>Medium object, if found.</desc>
1941	</param>
1942	</method>
1943
1944	<method name="getGuestOSType">
1945	<desc>
1946	Returns an object describing the specified guest OS type.
1947
1948	The requested guest OS type is specified using a string which is a
1949	mnemonic identifier of the guest operating system, such as
1950	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1951	particular virtual machine can be read or set using the
1952	<link to="IMachine::OSTypeId"/> attribute.
1953
1954	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1955	available guest OS type objects. Each object has an
1956	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1957	the guest OS this object describes.
1958
1959	<result name="E_INVALIDARG">
1960	@a id is not a valid Guest OS type.
1961	</result>
1962
1963	</desc>
1964	<param name="id" type="uuid" mod="string" dir="in">
1965	<desc>Guest OS type ID string.</desc>
1966	</param>
1967	<param name="type" type="IGuestOSType" dir="return">
1968	<desc>Guest OS type object.</desc>
1969	</param>
1970	</method>
1971
1972	<method name="createSharedFolder">
1973	<desc>
1974	Creates a new global shared folder by associating the given logical
1975	name with the given host path, adds it to the collection of shared
1976	folders and starts sharing it. Refer to the description of
1977	<link to="ISharedFolder"/> to read more about logical names.
1978	<note>
1979	In the current implementation, this operation is not
1980	implemented.
1981	</note>
1982	</desc>
1983	<param name="name" type="wstring" dir="in">
1984	<desc>Unique logical name of the shared folder.</desc>
1985	</param>
1986	<param name="hostPath" type="wstring" dir="in">
1987	<desc>Full path to the shared folder in the host file system.</desc>
1988	</param>
1989	<param name="writable" type="boolean" dir="in">
1990	<desc>Whether the share is writable or readonly</desc>
1991	</param>
1992	<param name="automount" type="boolean" dir="in">
1993	<desc>Whether the share gets automatically mounted by the guest
1994	or not.</desc>
1995	</param>
1996	</method>
1997
1998	<method name="removeSharedFolder">
1999	<desc>
2000	Removes the global shared folder with the given name previously
2001	created by <link to="#createSharedFolder"/> from the collection of
2002	shared folders and stops sharing it.
2003	<note>
2004	In the current implementation, this operation is not
2005	implemented.
2006	</note>
2007	</desc>
2008	<param name="name" type="wstring" dir="in">
2009	<desc>Logical name of the shared folder to remove.</desc>
2010	</param>
2011	</method>
2012
2013	<method name="getExtraDataKeys">
2014	<desc>
2015	Returns an array representing the global extra data keys which currently
2016	have values defined.
2017	</desc>
2018	<param name="value" type="wstring" dir="return" safearray="yes">
2019	<desc>Array of extra data keys.</desc>
2020	</param>
2021	</method>
2022
2023	<method name="getExtraData">
2024	<desc>
2025	Returns associated global extra data.
2026
2027	If the requested data @a key does not exist, this function will
2028	succeed and return an empty string in the @a value argument.
2029
2030	<result name="VBOX_E_FILE_ERROR">
2031	Settings file not accessible.
2032	</result>
2033	<result name="VBOX_E_XML_ERROR">
2034	Could not parse the settings file.
2035	</result>
2036
2037	</desc>
2038	<param name="key" type="wstring" dir="in">
2039	<desc>Name of the data key to get.</desc>
2040	</param>
2041	<param name="value" type="wstring" dir="return">
2042	<desc>Value of the requested data key.</desc>
2043	</param>
2044	</method>
2045
2046	<method name="setExtraData">
2047	<desc>
2048	Sets associated global extra data.
2049
2050	If you pass @c null or empty string as a key @a value, the given @a key
2051	will be deleted.
2052
2053	<note>
2054	Before performing the actual data change, this method will ask all
2055	registered event listener using the
2056	<link to="IExtraDataCanChangeEvent"/>
2057	notification for a permission. If one of the listeners refuses the
2058	new value, the change will not be performed.
2059	</note>
2060	<note>
2061	On success, the
2062	<link to="IExtraDataChangedEvent"/> notification
2063	is called to inform all registered listeners about a successful data
2064	change.
2065	</note>
2066
2067	<result name="VBOX_E_FILE_ERROR">
2068	Settings file not accessible.
2069	</result>
2070	<result name="VBOX_E_XML_ERROR">
2071	Could not parse the settings file.
2072	</result>
2073	<result name="E_ACCESSDENIED">
2074	Modification request refused.
2075	</result>
2076
2077	</desc>
2078	<param name="key" type="wstring" dir="in">
2079	<desc>Name of the data key to set.</desc>
2080	</param>
2081	<param name="value" type="wstring" dir="in">
2082	<desc>Value to assign to the key.</desc>
2083	</param>
2084	</method>
2085
2086	<!--method name="createDHCPServerForInterface">
2087	<desc>
2088	Creates a dhcp server settings to be used for the given interface
2089	<result name="E_INVALIDARG">
2090	Host network interface @a name already exists.
2091	</result>
2092	</desc>
2093	<param name="interface" type="IHostNetworkInterface" dir="in">
2094	<desc>Network Interface</desc>
2095	</param>
2096	<param name="server" type="IDHCPServer" dir="out">
2097	<desc>Dhcp server settings</desc>
2098	</param>
2099	</method-->
2100
2101	<method name="createDHCPServer">
2102	<desc>
2103	Creates a dhcp server settings to be used for the given internal network name
2104	<result name="E_INVALIDARG">
2105	Host network interface @a name already exists.
2106	</result>
2107	</desc>
2108	<param name="name" type="wstring" dir="in">
2109	<desc>server name</desc>
2110	</param>
2111	<param name="server" type="IDHCPServer" dir="return">
2112	<desc>Dhcp server settings</desc>
2113	</param>
2114	</method>
2115
2116	<method name="findDHCPServerByNetworkName">
2117	<desc>
2118	Searches a dhcp server settings to be used for the given internal network name
2119	<result name="E_INVALIDARG">
2120	Host network interface @a name already exists.
2121	</result>
2122
2123	</desc>
2124	<param name="name" type="wstring" dir="in">
2125	<desc>server name</desc>
2126	</param>
2127	<param name="server" type="IDHCPServer" dir="return">
2128	<desc>Dhcp server settings</desc>
2129	</param>
2130	</method>
2131
2132	<!--method name="findDHCPServerForInterface">
2133	<desc>
2134	Searches a dhcp server settings to be used for the given interface
2135	<result name="E_INVALIDARG">
2136	Host network interface @a name already exists.
2137	</result>
2138	</desc>
2139	<param name="interface" type="IHostNetworkInterface" dir="in">
2140	<desc>Network Interface</desc>
2141	</param>
2142	<param name="server" type="IDHCPServer" dir="out">
2143	<desc>Dhcp server settings</desc>
2144	</param>
2145	</method-->
2146
2147	<method name="removeDHCPServer">
2148	<desc>
2149	Removes the dhcp server settings
2150	<result name="E_INVALIDARG">
2151	Host network interface @a name already exists.
2152	</result>
2153	</desc>
2154	<param name="server" type="IDHCPServer" dir="in">
2155	<desc>Dhcp server settings to be removed</desc>
2156	</param>
2157	</method>
2158
2159
2160	<method name="checkFirmwarePresent">
2161	<desc>
2162	Check if this VirtualBox installation has a firmware
2163	of the given type available, either system-wide or per-user.
2164	Optionally, this may return a hint where this firmware can be
2165	downloaded from.
2166	</desc>
2167	<param name="firmwareType" type="FirmwareType" dir="in">
2168	<desc>
2169	Type of firmware to check.
2170	</desc>
2171	</param>
2172	<param name="version" type="wstring" dir="in">
2173	<desc>Expected version number, usually empty string (presently ignored).</desc>
2174	</param>
2175
2176	<param name="url" type="wstring" dir="out">
2177	<desc>
2178	Suggested URL to download this firmware from.
2179	</desc>
2180	</param>
2181
2182	<param name="file" type="wstring" dir="out">
2183	<desc>
2184	Filename of firmware, only valid if result == TRUE.
2185	</desc>
2186	</param>
2187
2188	<param name="result" type="boolean" dir="return">
2189	<desc>If firmware of this type and version is available.</desc>
2190	</param>
2191	</method>
2192
2193	</interface>
2194
2195	<!--
2196	// IVFSExplorer
2197	/////////////////////////////////////////////////////////////////////////
2198	-->
2199
2200	<enum
2201	name="VFSType"
2202	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2203	>
2204	<desc>
2205	Virtual file systems supported by VFSExplorer.
2206	</desc>
2207
2208	<const name="File" value="1" />
2209	<const name="Cloud" value="2" />
2210	<const name="S3" value="3" />
2211	<const name="WebDav" value="4" />
2212	</enum>
2213
2214	<enum
2215	name="VFSFileType"
2216	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2217	>
2218	<desc>
2219	File types known by VFSExplorer.
2220	</desc>
2221
2222	<const name="Unknown" value="1" />
2223	<const name="Fifo" value="2" />
2224	<const name="DevChar" value="3" />
2225	<const name="Directory" value="4" />
2226	<const name="DevBlock" value="5" />
2227	<const name="File" value="6" />
2228	<const name="SymLink" value="7" />
2229	<const name="Socket" value="8" />
2230	<const name="WhiteOut" value="9" />
2231	</enum>
2232
2233	<interface
2234	name="IVFSExplorer" extends="$unknown"
2235	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2236	wsmap="managed"
2237	>
2238	<desc>
2239	The VFSExplorer interface unifies access to different file system
2240	types. This includes local file systems as well remote file systems like
2241	S3. For a list of supported types see <link to="VFSType" />.
2242	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2243	</desc>
2244
2245	<attribute name="path" type="wstring" readonly="yes">
2246	<desc>Returns the current path in the virtual file system.</desc>
2247	</attribute>
2248
2249	<attribute name="type" type="VFSType" readonly="yes">
2250	<desc>Returns the file system type which is currently in use.</desc>
2251	</attribute>
2252
2253	<method name="update">
2254	<desc>Updates the internal list of files/directories from the
2255	current directory level. Use <link to="#entryList" /> to get the full list
2256	after a call to this method.</desc>
2257
2258	<param name="aProgress" type="IProgress" dir="return">
2259	<desc>Progress object to track the operation completion.</desc>
2260	</param>
2261	</method>
2262
2263	<method name="cd">
2264	<desc>Change the current directory level.</desc>
2265
2266	<param name="aDir" type="wstring" dir="in">
2267	<desc>The name of the directory to go in.</desc>
2268	</param>
2269
2270	<param name="aProgress" type="IProgress" dir="return">
2271	<desc>Progress object to track the operation completion.</desc>
2272	</param>
2273	</method>
2274
2275	<method name="cdUp">
2276	<desc>Go one directory upwards from the current directory level.</desc>
2277
2278	<param name="aProgress" type="IProgress" dir="return">
2279	<desc>Progress object to track the operation completion.</desc>
2280	</param>
2281	</method>
2282
2283	<method name="entryList">
2284	<desc>Returns a list of files/directories after a call to <link
2285	to="#update" />. The user is responsible for keeping this internal
2286	list up do date.</desc>
2287
2288	<param name="aNames" type="wstring" safearray="yes" dir="out">
2289	<desc>The list of names for the entries.</desc>
2290	</param>
2291
2292	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2293	<desc>The list of types for the entries.</desc>
2294	</param>
2295
2296	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2297	<desc>The list of sizes (in bytes) for the entries.</desc>
2298	</param>
2299
2300	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2301	<desc>The list of file modes (in octal form) for the entries.</desc>
2302	</param>
2303	</method>
2304
2305	<method name="exists">
2306	<desc>Checks if the given file list exists in the current directory
2307	level.</desc>
2308
2309	<param name="aNames" type="wstring" safearray="yes" dir="in">
2310	<desc>The names to check.</desc>
2311	</param>
2312
2313	<param name="aExists" type="wstring" safearray="yes" dir="return">
2314	<desc>The names which exist.</desc>
2315	</param>
2316	</method>
2317
2318	<method name="remove">
2319	<desc>Deletes the given files in the current directory level.</desc>
2320
2321	<param name="aNames" type="wstring" safearray="yes" dir="in">
2322	<desc>The names to remove.</desc>
2323	</param>
2324
2325	<param name="aProgress" type="IProgress" dir="return">
2326	<desc>Progress object to track the operation completion.</desc>
2327	</param>
2328	</method>
2329
2330	</interface>
2331
2332	<!--
2333	// IAppliance
2334	/////////////////////////////////////////////////////////////////////////
2335	-->
2336
2337	<interface
2338	name="IAppliance" extends="$unknown"
2339	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2340	wsmap="managed"
2341	>
2342	<desc>
2343	Represents a platform-independent appliance in OVF format. An instance of this is returned
2344	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2345	virtual machines within an appliance with VirtualBox.
2346
2347	The OVF standard suggests two different physical file formats:
2348
2349	<ol>
2350	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2351	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2352	this descriptor file references other files such as disk images, as OVF appliances typically
2353	do, those additional files must be in the same directory as the descriptor file.</li>
2354
2355	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2356	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2357	files and optionally other files.
2358
2359	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2360	be added with a later version.</li>
2361	</ol>
2362
2363	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2364	<link to="IMachine" /> involves the following sequence of API calls:
2365
2366	<ol>
2367	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2368	</li>
2369
2370	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2371	would like to import. So long as this file is syntactically valid, this will succeed
2372	and fill the appliance object with the parsed data from the OVF file.
2373	</li>
2374
2375	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2376	contents of the IAppliance attributes accordingly. These can be inspected by a
2377	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2378	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2379	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2380	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2381	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2382	The GUI can then give the user the option to confirm and/or change these suggestions.
2383	</li>
2384
2385	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2386	virtual system (machine) to override the suggestions made by the interpret() routine.
2387	</li>
2388
2389	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2390	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2391	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2392	can be found in the <link to="#machines" /> array attribute.
2393	</li>
2394	</ol>
2395
2396	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2397
2398	<ol>
2399	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2400	an empty IAppliance object.
2401	</li>
2402
2403	<li>For each machine you would like to export, call <link to="IMachine::export" />
2404	with the IAppliance object you just created. Each such call creates one instance of
2405	<link to="IVirtualSystemDescription" /> inside the appliance.
2406	</li>
2407
2408	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2409	virtual system (machine) to override the suggestions made by the export() routine.
2410	</li>
2411
2412	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2413	file written.</li>
2414	</ol>
2415
2416	</desc>
2417
2418	<attribute name="path" type="wstring" readonly="yes">
2419	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2420	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2421	<link to="#write" /> (for export).
2422	This attribute is empty until one of these methods has been called.
2423	</desc>
2424	</attribute>
2425
2426	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2427	<desc>
2428	Array of virtual disk definitions. One such description exists for each
2429	disk definition in the OVF; each string array item represents one such piece of
2430	disk information, with the information fields separated by tab (\t) characters.
2431
2432	The caller should be prepared for additional fields being appended to
2433	this string in future versions of VirtualBox and therefore check for
2434	the number of tabs in the strings returned.
2435
2436	In the current version, the following eight fields are returned per string
2437	in the array:
2438
2439	<ol>
2440	<li>Disk ID (unique string identifier given to disk)</li>
2441
2442	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2443
2444	<li>Populated size (optional unsigned integer indicating the current size of the
2445	disk; can be approximate; -1 if unspecified)</li>
2446
2447	<li>Format (string identifying the disk format, typically
2448	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2449
2450	<li>Reference (where to find the disk image, typically a file name; if empty,
2451	then the disk should be created on import)</li>
2452
2453	<li>Image size (optional unsigned integer indicating the size of the image,
2454	which need not necessarily be the same as the values specified above, since
2455	the image may be compressed or sparse; -1 if not specified)</li>
2456
2457	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2458	presently unsupported and always -1)</li>
2459
2460	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2461	</ol>
2462	</desc>
2463	</attribute>
2464
2465	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2466	<desc> Array of virtual system descriptions. One such description is created
2467	for each virtual system (machine) found in the OVF.
2468	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2469	(for export) has been called.
2470	</desc>
2471	</attribute>
2472
2473	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2474	<desc>
2475	Contains the UUIDs of the machines created from the information in this appliances. This is only
2476	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2477	succeeded.
2478	</desc>
2479	</attribute>
2480
2481	<method name="read">
2482	<desc>
2483	Reads an OVF file into the appliance object.
2484
2485	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2486	mere fact that this method returns successfully does not mean that VirtualBox supports all
2487	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2488	</desc>
2489	<param name="file" type="wstring" dir="in">
2490	<desc>
2491	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2492	on whether the appliance is distributed as a set of files or as a single file, respectively).
2493	</desc>
2494	</param>
2495	<param name="aProgress" type="IProgress" dir="return">
2496	<desc>Progress object to track the operation completion.</desc>
2497	</param>
2498	</method>
2499
2500	<method name="interpret">
2501	<desc>
2502	Interprets the OVF data that was read when the appliance was constructed. After
2503	calling this method, one can inspect the
2504	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2505	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2506	the appliance.
2507
2508	Calling this method is the second step of importing an appliance into VirtualBox;
2509	see <link to="IAppliance" /> for an overview.
2510
2511	After calling this method, one should call <link to="#getWarnings" /> to find out
2512	if problems were encountered during the processing which might later lead to
2513	errors.
2514	</desc>
2515	</method>
2516
2517	<method name="importMachines">
2518	<desc>
2519	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2520	and other interfaces that match the information contained in the appliance as
2521	closely as possible, as represented by the import instructions in the
2522	<link to="#virtualSystemDescriptions" /> array.
2523
2524	Calling this method is the final step of importing an appliance into VirtualBox;
2525	see <link to="IAppliance" /> for an overview.
2526
2527	Since importing the appliance will most probably involve copying and converting
2528	disk images, which can take a long time, this method operates asynchronously and
2529	returns an IProgress object to allow the caller to monitor the progress.
2530
2531	After the import succeeded, the UUIDs of the IMachine instances created can be
2532	retrieved from the <link to="#machines" /> array attribute.
2533	</desc>
2534
2535	<param name="aProgress" type="IProgress" dir="return">
2536	<desc>Progress object to track the operation completion.</desc>
2537	</param>
2538	</method>
2539
2540	<method name="createVFSExplorer">
2541	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2542
2543	<param name="aUri" type="wstring" dir="in">
2544	<desc>The URI describing the file system to use.</desc>
2545	</param>
2546
2547	<param name="aExplorer" type="IVFSExplorer" dir="return">
2548	<desc></desc>
2549	</param>
2550	</method>
2551
2552	<method name="write">
2553	<desc>
2554	Writes the contents of the appliance exports into a new OVF file.
2555
2556	Calling this method is the final step of exporting an appliance from VirtualBox;
2557	see <link to="IAppliance" /> for an overview.
2558
2559	Since exporting the appliance will most probably involve copying and converting
2560	disk images, which can take a long time, this method operates asynchronously and
2561	returns an IProgress object to allow the caller to monitor the progress.
2562	</desc>
2563	<param name="format" type="wstring" dir="in">
2564	<desc>
2565	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2566	future versions of VirtualBox may support additional formats.
2567	</desc>
2568	</param>
2569	<param name="manifest" type="boolean" dir="in">
2570	<desc>
2571	Indicate if the optional manifest file (.mf) should be written. The manifest file
2572	is used for integrity checks prior import.
2573	</desc>
2574	</param>
2575	<param name="path" type="wstring" dir="in">
2576	<desc>
2577	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2578	on whether the appliance is distributed as a set of files or as a single file, respectively).
2579	</desc>
2580	</param>
2581	<param name="progress" type="IProgress" dir="return">
2582	<desc>Progress object to track the operation completion.</desc>
2583	</param>
2584	</method>
2585
2586	<method name="getWarnings">
2587	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2588
2589	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2590	<desc></desc>
2591	</param>
2592	</method>
2593
2594	</interface>
2595
2596	<enum
2597	name="VirtualSystemDescriptionType"
2598	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2599	>
2600	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2601	a configuration value.</desc>
2602
2603	<const name="Ignore" value="1" />
2604	<const name="OS" value="2" />
2605	<const name="Name" value="3" />
2606	<const name="Product" value="4" />
2607	<const name="Vendor" value="5" />
2608	<const name="Version" value="6" />
2609	<const name="ProductUrl" value="7" />
2610	<const name="VendorUrl" value="8" />
2611	<const name="Description" value="9" />
2612	<const name="License" value="10" />
2613	<const name="Miscellaneous" value="11" />
2614	<const name="CPU" value="12" />
2615	<const name="Memory" value="13" />
2616	<const name="HardDiskControllerIDE" value="14" />
2617	<const name="HardDiskControllerSATA" value="15" />
2618	<const name="HardDiskControllerSCSI" value="16" />
2619	<const name="HardDiskControllerSAS" value="17" />
2620	<const name="HardDiskImage" value="18" />
2621	<const name="Floppy" value="19" />
2622	<const name="CDROM" value="20" />
2623	<const name="NetworkAdapter" value="21" />
2624	<const name="USBController" value="22" />
2625	<const name="SoundCard" value="23" />
2626
2627	</enum>
2628
2629	<enum
2630	name="VirtualSystemDescriptionValueType"
2631	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2632	>
2633	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2634	type to fetch.</desc>
2635
2636	<const name="Reference" value="1" />
2637	<const name="Original" value="2" />
2638	<const name="Auto" value="3" />
2639	<const name="ExtraConfig" value="4" />
2640
2641	</enum>
2642
2643	<interface
2644	name="IVirtualSystemDescription" extends="$unknown"
2645	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2646	wsmap="managed"
2647	>
2648
2649	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2650	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2651	<link to="IAppliance::interpret" /> has been called, that array contains information
2652	about how the virtual systems described in the OVF should best be imported into
2653	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2654	import an OVF into VirtualBox.
2655	</desc>
2656
2657	<attribute name="count" type="unsigned long" readonly="yes">
2658	<desc>Return the number of virtual system description entries.</desc>
2659	</attribute>
2660
2661	<method name="getDescription">
2662	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2663	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2664
2665	The list below identifies the value sets that are possible depending on the
2666	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2667	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2668	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2669	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2670	the @a aExtraConfigValues[] array item may also be used.
2671
2672	<ul>
2673	<li>
2674	"OS": the guest operating system type. There must be exactly one such array item on import. The
2675	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2676	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2677	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2678	</li>
2679	<li>
2680	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2681	if none is present on import, then an automatic name will be created from the operating system
2682	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2683	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2684	<link to="IMachine" /> name that does not exist yet.
2685	</li>
2686	<li>
2687	"Description": an arbitrary description.
2688	</li>
2689	<li>
2690	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2691	code to display such a license for agreement; the Main API does not enforce any such policy.
2692	</li>
2693	<li>
2694	Miscellaneous: reserved for future use.
2695	</li>
2696	<li>
2697	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2698	</li>
2699	<li>
2700	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2701	is present on import, then VirtualBox will set a meaningful default based on the operating system
2702	type.
2703	</li>
2704	<li>
2705	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2706	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2707	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2708	writes into the OVF.
2709	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2710	type can use to specify which hard disk controller a virtual disk should be connected to.
2711	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2712	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2713	its virtual machines supports four channels (primary master, primary slave, secondary master,
2714	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2715	</li>
2716	<li>
2717	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2718	has no value in @a aOvfValues[] or @a aVBoxValues[].
2719	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2720	</li>
2721	<li>
2722	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2723	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2724	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2725	whereas VirtualBox considers it a class of storage controllers of its own; see
2726	<link to="StorageControllerType" />).
2727	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2728	</li>
2729	<li>
2730	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2731	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2732
2733	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2734	a path since the image file should be in the same location as the OVF file itself), whereas the
2735	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2736	hard disk image. This means that on import the image will be copied and converted from the
2737	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2738
2739	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2740	format: "controller=<index>;channel=<c>"
2741	In this string, <index> must be an integer specifying the hard disk controller to connect
2742	the image to. That number must be the index of an array item with one of the hard disk controller
2743	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2744	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2745	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2746	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2747	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2748	</li>
2749	<li>
2750	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2751	attachment information as with "HardDiskImage" items.
2752	</li>
2753	<li>
2754	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2755	attachment information as with "HardDiskImage" items.
2756	</li>
2757	<li>
2758	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2759	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2760	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2761	</li>
2762	<li>
2763	"USBController": a USB controller. There can be at most one such item. If and only if such an
2764	item ispresent, USB support will be enabled for the new virtual machine.
2765	</li>
2766	<li>
2767	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2768	present, sound support will be enabled for the new virtual machine. Note that the virtual
2769	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2770	may be different from the virtual soundcard expected by the appliance.
2771	</li>
2772	</ul>
2773
2774	</desc>
2775
2776	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2777	<desc></desc>
2778	</param>
2779
2780	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2781	<desc></desc>
2782	</param>
2783
2784	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2785	<desc></desc>
2786	</param>
2787
2788	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2789	<desc></desc>
2790	</param>
2791
2792	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2793	<desc></desc>
2794	</param>
2795
2796	</method>
2797
2798	<method name="getDescriptionByType">
2799	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2800	should be returned.</desc>
2801
2802	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2803	<desc></desc>
2804	</param>
2805
2806	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2807	<desc></desc>
2808	</param>
2809
2810	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2811	<desc></desc>
2812	</param>
2813
2814	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2815	<desc></desc>
2816	</param>
2817
2818	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2819	<desc></desc>
2820	</param>
2821
2822	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2823	<desc></desc>
2824	</param>
2825
2826	</method>
2827
2828	<method name="getValuesByType">
2829	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2830	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2831	values.</desc>
2832
2833	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2834	<desc></desc>
2835	</param>
2836
2837	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2838	<desc></desc>
2839	</param>
2840
2841	<param name="aValues" type="wstring" dir="return" safearray="yes">
2842	<desc></desc>
2843	</param>
2844
2845	</method>
2846
2847	<method name="setFinalValues">
2848	<desc>
2849	This method allows the appliance's user to change the configuration for the virtual
2850	system descriptions. For each array item returned from <link to="#getDescription" />,
2851	you must pass in one boolean value and one configuration value.
2852
2853	Each item in the boolean array determines whether the particular configuration item
2854	should be enabled.
2855	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2856	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2857	and SoundCard.
2858
2859	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2860	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2861	the configuration remains unchanged. Please see the documentation for getDescription()
2862	for valid configuration values for the individual array item types. If the
2863	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2864	</desc>
2865
2866	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2871	<desc></desc>
2872	</param>
2873
2874	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2875	<desc></desc>
2876	</param>
2877	</method>
2878
2879	<method name="addDescription">
2880	<desc>
2881	This method adds an additional description entry to the stack of already
2882	available descriptions for this virtual system. This is handy for writing
2883	values which aren't directly supported by VirtualBox. One example would
2884	be the License type of <link to="VirtualSystemDescriptionType" />.
2885	</desc>
2886
2887	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2888	<desc></desc>
2889	</param>
2890
2891	<param name="aVBoxValue" type="wstring" dir="in">
2892	<desc></desc>
2893	</param>
2894
2895	<param name="aExtraConfigValue" type="wstring" dir="in">
2896	<desc></desc>
2897	</param>
2898	</method>
2899	</interface>
2900
2901
2902	<!--
2903	// IMachine
2904	/////////////////////////////////////////////////////////////////////////
2905	-->
2906
2907	<interface
2908	name="IInternalMachineControl" extends="$unknown"
2909	uuid="8e723ab0-812c-5662-dd8e-7ebc89637acf"
2910	internal="yes"
2911	wsmap="suppress"
2912	>
2913	<method name="setRemoveSavedStateFile">
2914	<desc>
2915	Updates the flag whether the saved state file is removed on a
2916	machine state change from Saved to PoweredOff.
2917	</desc>
2918	<param name="aRemove" type="boolean" dir="in"/>
2919	</method>
2920
2921	<method name="updateState">
2922	<desc>
2923	Updates the VM state.
2924	<note>
2925	This operation will also update the settings file with the correct
2926	information about the saved state file and delete this file from disk
2927	when appropriate.
2928	</note>
2929	</desc>
2930	<param name="state" type="MachineState" dir="in"/>
2931	</method>
2932
2933	<method name="getIPCId">
2934	<param name="id" type="wstring" dir="return"/>
2935	</method>
2936
2937	<method name="beginPowerUp">
2938	<desc>
2939	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2940	gives it the progress object that should be part of any pending
2941	<link to="IMachine::launchVMProcess"/> operations. The progress
2942	object may be called back to reflect an early cancelation, so some care
2943	have to be taken with respect to any cancelation callbacks. The console
2944	object will call <link to="IInternalMachineControl::endPowerUp"/>
2945	to signal the completion of the progress object.
2946	</desc>
2947	<param name="aProgress" type="IProgress" dir="in" />
2948	</method>
2949
2950	<method name="endPowerUp">
2951	<desc>
2952	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2953	This method may query status information from the progress object it
2954	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2955	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2956	call in order to complete that progress object.
2957	</desc>
2958	<param name="result" type="long" dir="in"/>
2959	</method>
2960
2961	<method name="beginPoweringDown">
2962	<desc>
2963	Called by the VM process to inform the server it wants to
2964	stop the VM execution and power down.
2965	</desc>
2966	<param name="progress" type="IProgress" dir="out">
2967	<desc>
2968	Progress object created by VBoxSVC to wait until
2969	the VM is powered down.
2970	</desc>
2971	</param>
2972	</method>
2973
2974	<method name="endPoweringDown">
2975	<desc>
2976	Called by the VM process to inform the server that powering
2977	down previously requested by #beginPoweringDown is either
2978	successfully finished or there was a failure.
2979
2980	<result name="VBOX_E_FILE_ERROR">
2981	Settings file not accessible.
2982	</result>
2983	<result name="VBOX_E_XML_ERROR">
2984	Could not parse the settings file.
2985	</result>
2986
2987	</desc>
2988
2989	<param name="result" type="long" dir="in">
2990	<desc>@c S_OK to indicate success.
2991	</desc>
2992	</param>
2993	<param name="errMsg" type="wstring" dir="in">
2994	<desc>@c human readable error message in case of failure.
2995	</desc>
2996	</param>
2997	</method>
2998
2999	<method name="runUSBDeviceFilters">
3000	<desc>
3001	Asks the server to run USB devices filters of the associated
3002	machine against the given USB device and tell if there is
3003	a match.
3004	<note>
3005	Intended to be used only for remote USB devices. Local
3006	ones don't require to call this method (this is done
3007	implicitly by the Host and USBProxyService).
3008	</note>
3009	</desc>
3010	<param name="device" type="IUSBDevice" dir="in"/>
3011	<param name="matched" type="boolean" dir="out"/>
3012	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3013	</method>
3014
3015	<method name="captureUSBDevice">
3016	<desc>
3017	Requests a capture of the given host USB device.
3018	When the request is completed, the VM process will
3019	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3020	notification.
3021	</desc>
3022	<param name="id" type="uuid" mod="string" dir="in"/>
3023	</method>
3024
3025	<method name="detachUSBDevice">
3026	<desc>
3027	Notification that a VM is going to detach (@a done = @c false) or has
3028	already detached (@a done = @c true) the given USB device.
3029	When the @a done = @c true request is completed, the VM process will
3030	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3031	notification.
3032	<note>
3033	In the @a done = @c true case, the server must run its own filters
3034	and filters of all VMs but this one on the detached device
3035	as if it were just attached to the host computer.
3036	</note>
3037	</desc>
3038	<param name="id" type="uuid" mod="string" dir="in"/>
3039	<param name="done" type="boolean" dir="in"/>
3040	</method>
3041
3042	<method name="autoCaptureUSBDevices">
3043	<desc>
3044	Requests a capture all matching USB devices attached to the host.
3045	When the request is completed, the VM process will
3046	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3047	notification per every captured device.
3048	</desc>
3049	</method>
3050
3051	<method name="detachAllUSBDevices">
3052	<desc>
3053	Notification that a VM that is being powered down. The done
3054	parameter indicates whether which stage of the power down
3055	we're at. When @a done = @c false the VM is announcing its
3056	intentions, while when @a done = @c true the VM is reporting
3057	what it has done.
3058	<note>
3059	In the @a done = @c true case, the server must run its own filters
3060	and filters of all VMs but this one on all detach devices as
3061	if they were just attached to the host computer.
3062	</note>
3063	</desc>
3064	<param name="done" type="boolean" dir="in"/>
3065	</method>
3066
3067	<method name="onSessionEnd">
3068	<desc>
3069	Triggered by the given session object when the session is about
3070	to close normally.
3071	</desc>
3072	<param name="session" type="ISession" dir="in">
3073	<desc>Session that is being closed</desc>
3074	</param>
3075	<param name="progress" type="IProgress" dir="return">
3076	<desc>
3077	Used to wait until the corresponding machine is actually
3078	dissociated from the given session on the server.
3079	Returned only when this session is a direct one.
3080	</desc>
3081	</param>
3082	</method>
3083
3084	<method name="beginSavingState">
3085	<desc>
3086	Called by the VM process to inform the server it wants to
3087	save the current state and stop the VM execution.
3088	</desc>
3089	<param name="progress" type="IProgress" dir="out">
3090	<desc>
3091	Progress object created by VBoxSVC to wait until
3092	the state is saved.
3093	</desc>
3094	</param>
3095	<param name="stateFilePath" type="wstring" dir="out">
3096	<desc>
3097	File path the VM process must save the execution state to.
3098	</desc>
3099	</param>
3100	</method>
3101
3102	<method name="endSavingState">
3103	<desc>
3104	Called by the VM process to inform the server that saving
3105	the state previously requested by #beginSavingState is either
3106	successfully finished or there was a failure.
3107
3108	<result name="VBOX_E_FILE_ERROR">
3109	Settings file not accessible.
3110	</result>
3111	<result name="VBOX_E_XML_ERROR">
3112	Could not parse the settings file.
3113	</result>
3114
3115	</desc>
3116
3117	<param name="result" type="long" dir="in">
3118	<desc>@c S_OK to indicate success.
3119	</desc>
3120	</param>
3121	<param name="errMsg" type="wstring" dir="in">
3122	<desc>@c human readable error message in case of failure.
3123	</desc>
3124	</param>
3125	</method>
3126
3127	<method name="adoptSavedState">
3128	<desc>
3129	Gets called by IConsole::adoptSavedState.
3130	<result name="VBOX_E_FILE_ERROR">
3131	Invalid saved state file path.
3132	</result>
3133	</desc>
3134	<param name="savedStateFile" type="wstring" dir="in">
3135	<desc>Path to the saved state file to adopt.</desc>
3136	</param>
3137	</method>
3138
3139	<method name="beginTakingSnapshot">
3140	<desc>
3141	Called from the VM process to request from the server to perform the
3142	server-side actions of creating a snapshot (creating differencing images
3143	and the snapshot object).
3144
3145	<result name="VBOX_E_FILE_ERROR">
3146	Settings file not accessible.
3147	</result>
3148	<result name="VBOX_E_XML_ERROR">
3149	Could not parse the settings file.
3150	</result>
3151	</desc>
3152	<param name="initiator" type="IConsole" dir="in">
3153	<desc>The console object that initiated this call.</desc>
3154	</param>
3155	<param name="name" type="wstring" dir="in">
3156	<desc>Snapshot name.</desc>
3157	</param>
3158	<param name="description" type="wstring" dir="in">
3159	<desc>Snapshot description.</desc>
3160	</param>
3161	<param name="consoleProgress" type="IProgress" dir="in">
3162	<desc>
3163	Progress object created by the VM process tracking the
3164	snapshot's progress. This has the following sub-operations:
3165	<ul>
3166	<li>setting up (weight 1);</li>
3167	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3168	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3169	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3170	<li>finishing up (weight 1)</li>
3171	</ul>
3172	</desc>
3173	</param>
3174	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3175	<desc>
3176	Whether this is an online snapshot (i.e. the machine is running).
3177	</desc>
3178	</param>
3179	<param name="stateFilePath" type="wstring" dir="out">
3180	<desc>
3181	File path the VM process must save the execution state to.
3182	</desc>
3183	</param>
3184	</method>
3185
3186	<method name="endTakingSnapshot">
3187	<desc>
3188	Called by the VM process to inform the server that the snapshot
3189	previously requested by #beginTakingSnapshot is either
3190	successfully taken or there was a failure.
3191	</desc>
3192
3193	<param name="success" type="boolean" dir="in">
3194	<desc>@c true to indicate success and @c false otherwise</desc>
3195	</param>
3196	</method>
3197
3198	<method name="deleteSnapshot">
3199	<desc>
3200	Gets called by IConsole::deleteSnapshot.
3201	<result name="VBOX_E_INVALID_OBJECT_STATE">
3202	Snapshot has more than one child snapshot.
3203	</result>
3204	</desc>
3205	<param name="initiator" type="IConsole" dir="in">
3206	<desc>The console object that initiated this call.</desc>
3207	</param>
3208	<param name="id" type="uuid" mod="string" dir="in">
3209	<desc>UUID of the snapshot to delete.</desc>
3210	</param>
3211	<param name="machineState" type="MachineState" dir="out">
3212	<desc>New machine state after this operation is started.</desc>
3213	</param>
3214	<param name="progress" type="IProgress" dir="return">
3215	<desc>Progress object to track the operation completion.</desc>
3216	</param>
3217	</method>
3218
3219	<method name="finishOnlineMergeMedium">
3220	<desc>
3221	Gets called by IConsole::onlineMergeMedium.
3222	</desc>
3223	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3224	<desc>The medium attachment which needs to be cleaned up.</desc>
3225	</param>
3226	<param name="source" type="IMedium" dir="in">
3227	<desc>Merge source medium.</desc>
3228	</param>
3229	<param name="target" type="IMedium" dir="in">
3230	<desc>Merge target medium.</desc>
3231	</param>
3232	<param name="mergeForward" type="boolean" dir="in">
3233	<desc>Merge direction.</desc>
3234	</param>
3235	<param name="parentForTarget" type="IMedium" dir="in">
3236	<desc>For forward merges: new parent for target medium.</desc>
3237	</param>
3238	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3239	<desc>For backward merges: list of media which need their parent UUID
3240	updated.</desc>
3241	</param>
3242	</method>
3243
3244	<method name="restoreSnapshot">
3245	<desc>
3246	Gets called by IConsole::RestoreSnapshot.
3247	</desc>
3248	<param name="initiator" type="IConsole" dir="in">
3249	<desc>The console object that initiated this call.</desc>
3250	</param>
3251	<param name="snapshot" type="ISnapshot" dir="in">
3252	<desc>The snapshot to restore the VM state from.</desc>
3253	</param>
3254	<param name="machineState" type="MachineState" dir="out">
3255	<desc>New machine state after this operation is started.</desc>
3256	</param>
3257	<param name="progress" type="IProgress" dir="return">
3258	<desc>Progress object to track the operation completion.</desc>
3259	</param>
3260	</method>
3261
3262	<method name="pullGuestProperties">
3263	<desc>
3264	Get the list of the guest properties matching a set of patterns along
3265	with their values, time stamps and flags and give responsibility for
3266	managing properties to the console.
3267	</desc>
3268	<param name="name" type="wstring" dir="out" safearray="yes">
3269	<desc>
3270	The names of the properties returned.
3271	</desc>
3272	</param>
3273	<param name="value" type="wstring" dir="out" safearray="yes">
3274	<desc>
3275	The values of the properties returned. The array entries match the
3276	corresponding entries in the @a name array.
3277	</desc>
3278	</param>
3279	<param name="timestamp" type="long long" dir="out" safearray="yes">
3280	<desc>
3281	The time stamps of the properties returned. The array entries match
3282	the corresponding entries in the @a name array.
3283	</desc>
3284	</param>
3285	<param name="flags" type="wstring" dir="out" safearray="yes">
3286	<desc>
3287	The flags of the properties returned. The array entries match the
3288	corresponding entries in the @a name array.
3289	</desc>
3290	</param>
3291	</method>
3292
3293	<method name="pushGuestProperty">
3294	<desc>
3295	Update a single guest property in IMachine.
3296	</desc>
3297	<param name="name" type="wstring" dir="in">
3298	<desc>
3299	The name of the property to be updated.
3300	</desc>
3301	</param>
3302	<param name="value" type="wstring" dir="in">
3303	<desc>
3304	The value of the property.
3305	</desc>
3306	</param>
3307	<param name="timestamp" type="long long" dir="in">
3308	<desc>
3309	The timestamp of the property.
3310	</desc>
3311	</param>
3312	<param name="flags" type="wstring" dir="in">
3313	<desc>
3314	The flags of the property.
3315	</desc>
3316	</param>
3317	</method>
3318
3319	<method name="lockMedia">
3320	<desc>
3321	Locks all media attached to the machine for writing and parents of
3322	attached differencing media (if any) for reading. This operation is
3323	atomic so that if it fails no media is actually locked.
3324
3325	This method is intended to be called when the machine is in Starting or
3326	Restoring state. The locked media will be automatically unlocked when
3327	the machine is powered off or crashed.
3328	</desc>
3329	</method>
3330	<method name="unlockMedia">
3331	<desc>
3332	Unlocks all media previously locked using
3333	<link to="IInternalMachineControl::lockMedia"/>.
3334
3335	This method is intended to be used with teleportation so that it is
3336	possible to teleport between processes on the same machine.
3337	</desc>
3338	</method>
3339	</interface>
3340
3341	<interface
3342	name="IBIOSSettings" extends="$unknown"
3343	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3344	wsmap="managed"
3345	>
3346	<desc>
3347	The IBIOSSettings interface represents BIOS settings of the virtual
3348	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3349	</desc>
3350	<attribute name="logoFadeIn" type="boolean">
3351	<desc>Fade in flag for BIOS logo animation.</desc>
3352	</attribute>
3353
3354	<attribute name="logoFadeOut" type="boolean">
3355	<desc>Fade out flag for BIOS logo animation.</desc>
3356	</attribute>
3357
3358	<attribute name="logoDisplayTime" type="unsigned long">
3359	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3360	</attribute>
3361
3362	<attribute name="logoImagePath" type="wstring">
3363	<desc>
3364	Local file system path for external BIOS splash image. Empty string
3365	means the default image is shown on boot.
3366	</desc>
3367	</attribute>
3368
3369	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3370	<desc>Mode of the BIOS boot device menu.</desc>
3371	</attribute>
3372
3373	<attribute name="ACPIEnabled" type="boolean">
3374	<desc>ACPI support flag.</desc>
3375	</attribute>
3376
3377	<attribute name="IOAPICEnabled" type="boolean">
3378	<desc>
3379	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3380	and support IRQs above 15.
3381	</desc>
3382	</attribute>
3383
3384	<attribute name="timeOffset" type="long long">
3385	<desc>
3386	Offset in milliseconds from the host system time. This allows for
3387	guests running with a different system date/time than the host.
3388	It is equivalent to setting the system date/time in the BIOS except
3389	it is not an absolute value but a relative one. Guest Additions
3390	time synchronization honors this offset.
3391	</desc>
3392	</attribute>
3393
3394	<attribute name="PXEDebugEnabled" type="boolean">
3395	<desc>
3396	PXE debug logging flag. If set, VirtualBox will write extensive
3397	PXE trace information to the release log.
3398	</desc>
3399	</attribute>
3400
3401	</interface>
3402
3403	<enum
3404	name="CleanupMode"
3405	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3406	>
3407	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3408	</desc>
3409	<const name="UnregisterOnly" value="1">
3410	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3411	</const>
3412	<const name="DetachAllReturnNone" value="2">
3413	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3414	</const>
3415	<const name="DetachAllReturnHardDisksOnly" value="3">
3416	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3417	</const>
3418	<const name="Full" value="4">
3419	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3420	</const>
3421	</enum>
3422
3423	<interface
3424	name="IEventContext" extends="$unknown"
3425	uuid="7563F4E7-1583-40F7-B4C4-C9BA02CB0AE3"
3426	wsmap="managed"
3427	>
3428	<desc>
3429	Placeholder class for event contexts.
3430	</desc>
3431	</interface>
3432
3433
3434	<interface
3435	name="IPciAddress" extends="$unknown"
3436	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3437	wsmap="struct"
3438	>
3439
3440	<desc>
3441	Address on the PCI bus.
3442	</desc>
3443
3444	<attribute name="bus" type="short">
3445	<desc>
3446	Bus number.
3447	</desc>
3448	</attribute>
3449
3450	<attribute name="device" type="short">
3451	<desc>
3452	Device number.
3453	</desc>
3454	</attribute>
3455
3456	<attribute name="devFunction" type="short">
3457	<desc>
3458	Device function number.
3459	</desc>
3460	</attribute>
3461
3462	<method name="asLong">
3463	<desc>
3464	Convert PCI address into long.
3465	</desc>
3466	<param name="result" type="long" dir="return" />
3467	</method>
3468
3469	<method name="fromLong">
3470	<desc>
3471	Make PCI address from long.
3472	</desc>
3473	<param name="number" type="long" dir="in" />
3474	</method>
3475	</interface>
3476
3477	<interface
3478	name="IPciDeviceAttachment" extends="$unknown"
3479	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3480	wsmap="struct"
3481	>
3482
3483	<desc>
3484	Information about PCI attachments.
3485	</desc>
3486
3487	<attribute name="name" type="wstring" readonly="yes">
3488	<desc>
3489	Device name.
3490	</desc>
3491	</attribute>
3492
3493	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3494	<desc>
3495	If this is physical or virtual device.
3496	</desc>
3497	</attribute>
3498
3499	<attribute name="hostAddress" type="long" readonly="yes">
3500	<desc>
3501	Address of device on the host, applicable only to host devices.
3502	</desc>
3503	</attribute>
3504
3505	<attribute name="guestAddress" type="long" readonly="yes">
3506	<desc>
3507	Address of device on the guest.
3508	</desc>
3509	</attribute>
3510
3511	</interface>
3512
3513
3514	<interface
3515	name="IMachine" extends="$unknown"
3516	uuid="662c175e-a69d-40b8-a77a-1d719d0ab062"
3517	wsmap="managed"
3518	>
3519	<desc>
3520	The IMachine interface represents a virtual machine, or guest, created
3521	in VirtualBox.
3522
3523	This interface is used in two contexts. First of all, a collection of
3524	objects implementing this interface is stored in the
3525	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3526	machines that are currently registered with this VirtualBox
3527	installation. Also, once a session has been opened for the given virtual
3528	machine (e.g. the virtual machine is running), the machine object
3529	associated with the open session can be queried from the session object;
3530	see <link to="ISession"/> for details.
3531
3532	The main role of this interface is to expose the settings of the virtual
3533	machine and provide methods to change various aspects of the virtual
3534	machine's configuration. For machine objects stored in the
3535	<link to="IVirtualBox::machines"/> collection, all attributes are
3536	read-only unless explicitly stated otherwise in individual attribute
3537	and method descriptions.
3538
3539	In order to change a machine setting, a session for this machine must be
3540	opened using one of the <link to="IMachine::lockMachine" /> or
3541	<link to="IMachine::launchVMProcess"/> methods. After the
3542	machine has been successfully locked for a session, a mutable machine object
3543	needs to be queried from the session object and then the desired settings
3544	changes can be applied to the returned object using IMachine attributes and
3545	methods. See the <link to="ISession"/> interface description for more
3546	information about sessions.
3547
3548	Note that IMachine does not provide methods to control virtual machine
3549	execution (such as start the machine, or power it down) -- these methods
3550	are grouped in a separate interface called <link to="IConsole" />.
3551
3552	<see>ISession, IConsole</see>
3553	</desc>
3554
3555	<attribute name="parent" type="IVirtualBox" readonly="yes">
3556	<desc>Associated parent object.</desc>
3557	</attribute>
3558
3559	<attribute name="accessible" type="boolean" readonly="yes">
3560	<desc>
3561	Whether this virtual machine is currently accessible or not.
3562
3563	A machine is always deemed accessible unless it is registered <i>and</i>
3564	its settings file cannot be read or parsed (either because the file itself
3565	is unavailable or has invalid XML contents).
3566
3567	Every time this property is read, the accessibility state of
3568	this machine is re-evaluated. If the returned value is @c false,
3569	the <link to="#accessError"/> property may be used to get the
3570	detailed error information describing the reason of
3571	inaccessibility, including XML error messages.
3572
3573	When the machine is inaccessible, only the following properties
3574	can be used on it:
3575	<ul>
3576	<li><link to="#parent"/></li>
3577	<li><link to="#id"/></li>
3578	<li><link to="#settingsFilePath"/></li>
3579	<li><link to="#accessible"/></li>
3580	<li><link to="#accessError"/></li>
3581	</ul>
3582
3583	An attempt to access any other property or method will return
3584	an error.
3585
3586	The only possible action you can perform on an inaccessible
3587	machine is to unregister it using the
3588	<link to="IMachine::unregister"/> call (or, to check
3589	for the accessibility state once more by querying this
3590	property).
3591
3592	<note>
3593	In the current implementation, once this property returns
3594	@c true, the machine will never become inaccessible
3595	later, even if its settings file cannot be successfully
3596	read/written any more (at least, until the VirtualBox
3597	server is restarted). This limitation may be removed in
3598	future releases.
3599	</note>
3600	</desc>
3601	</attribute>
3602
3603	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3604	<desc>
3605	Error information describing the reason of machine
3606	inaccessibility.
3607
3608	Reading this property is only valid after the last call to
3609	<link to="#accessible"/> returned @c false (i.e. the
3610	machine is currently inaccessible). Otherwise, a @c null
3611	IVirtualBoxErrorInfo object will be returned.
3612	</desc>
3613	</attribute>
3614
3615	<attribute name="name" type="wstring">
3616	<desc>
3617	Name of the virtual machine.
3618
3619	Besides being used for human-readable identification purposes
3620	everywhere in VirtualBox, the virtual machine name is also used
3621	as a name of the machine's settings file and as a name of the
3622	subdirectory this settings file resides in. Thus, every time you
3623	change the value of this property, the settings file will be
3624	renamed once you call <link to="#saveSettings"/> to confirm the
3625	change. The containing subdirectory will be also renamed, but
3626	only if it has exactly the same name as the settings file
3627	itself prior to changing this property (for backward compatibility
3628	with previous API releases). The above implies the following
3629	limitations:
3630	<ul>
3631	<li>The machine name cannot be empty.</li>
3632	<li>The machine name can contain only characters that are valid
3633	file name characters according to the rules of the file
3634	system used to store VirtualBox configuration.</li>
3635	<li>You cannot have two or more machines with the same name
3636	if they use the same subdirectory for storing the machine
3637	settings files.</li>
3638	<li>You cannot change the name of the machine if it is running,
3639	or if any file in the directory containing the settings file
3640	is being used by another running machine or by any other
3641	process in the host operating system at a time when
3642	<link to="#saveSettings"/> is called.
3643	</li>
3644	</ul>
3645	If any of the above limitations are hit, <link to="#saveSettings"/>
3646	will return an appropriate error message explaining the exact
3647	reason and the changes you made to this machine will not be saved.
3648
3649	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3650	file is recommended, but not enforced. (Previous versions always
3651	used a generic ".xml" extension.)
3652	</desc>
3653	</attribute>
3654
3655	<attribute name="description" type="wstring">
3656	<desc>
3657	Description of the virtual machine.
3658
3659	The description attribute can contain any text and is
3660	typically used to describe the hardware and software
3661	configuration of the virtual machine in detail (i.e. network
3662	settings, versions of the installed software and so on).
3663	</desc>
3664	</attribute>
3665
3666	<attribute name="id" type="uuid" mod="string" readonly="yes">
3667	<desc>UUID of the virtual machine.</desc>
3668	</attribute>
3669
3670	<attribute name="OSTypeId" type="wstring">
3671	<desc>
3672	User-defined identifier of the Guest OS type.
3673	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3674	an IGuestOSType object representing details about the given
3675	Guest OS type.
3676	<note>
3677	This value may differ from the value returned by
3678	<link to="IGuest::OSTypeId"/> if Guest Additions are
3679	installed to the guest OS.
3680	</note>
3681	</desc>
3682	</attribute>
3683
3684	<attribute name="HardwareVersion" type="wstring">
3685	<desc>Hardware version identifier. Internal use only for now.</desc>
3686	</attribute>
3687
3688	<attribute name="hardwareUUID" type="uuid" mod="string">
3689	<desc>
3690	The UUID presented to the guest via memory tables, hardware and guest
3691	properties. For most VMs this is the same as the @a id, but for VMs
3692	which have been cloned or teleported it may be the same as the source
3693	VM. This latter is because the guest shouldn't notice that it was
3694	cloned or teleported.
3695	</desc>
3696	</attribute>
3697
3698	<attribute name="CPUCount" type="unsigned long">
3699	<desc>Number of virtual CPUs in the VM.</desc>
3700	</attribute>
3701
3702	<attribute name="CPUHotPlugEnabled" type="boolean">
3703	<desc>
3704	This setting determines whether VirtualBox allows CPU
3705	hotplugging for this machine.</desc>
3706	</attribute>
3707
3708	<attribute name="CPUExecutionCap" type="unsigned long">
3709	<desc>
3710	Means to limit the number of CPU cycles a guest can use. The unit
3711	is percentage of host CPU cycles per second. The valid range
3712	is 1 - 100. 100 (the default) implies no limit.
3713	</desc>
3714	</attribute>
3715
3716	<attribute name="memorySize" type="unsigned long">
3717	<desc>System memory size in megabytes.</desc>
3718	</attribute>
3719
3720	<attribute name="memoryBalloonSize" type="unsigned long">
3721	<desc>Memory balloon size in megabytes.</desc>
3722	</attribute>
3723
3724	<attribute name="PageFusionEnabled" type="boolean">
3725	<desc>
3726	This setting determines whether VirtualBox allows page
3727	fusion for this machine (64 bits host only).
3728	</desc>
3729	</attribute>
3730
3731	<attribute name="VRAMSize" type="unsigned long">
3732	<desc>Video memory size in megabytes.</desc>
3733	</attribute>
3734
3735	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3736	<desc>
3737	This setting determines whether VirtualBox allows this machine to make
3738	use of the 3D graphics support available on the host.</desc>
3739	</attribute>
3740
3741	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3742	<desc>
3743	This setting determines whether VirtualBox allows this machine to make
3744	use of the 2D video acceleration support available on the host.</desc>
3745	</attribute>
3746
3747	<attribute name="monitorCount" type="unsigned long">
3748	<desc>
3749	Number of virtual monitors.
3750	<note>
3751	Only effective on Windows XP and later guests with
3752	Guest Additions installed.
3753	</note>
3754	</desc>
3755	</attribute>
3756
3757	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3758	<desc>Object containing all BIOS settings.</desc>
3759	</attribute>
3760
3761	<attribute name="firmwareType" type="FirmwareType">
3762	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3763	bootstrap in this VM.</desc>
3764	</attribute>
3765
3766	<attribute name="pointingHidType" type="PointingHidType">
3767	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3768	The default is typically "PS2Mouse" but can vary depending on the
3769	requirements of the guest operating system.</desc>
3770	</attribute>
3771
3772	<attribute name="keyboardHidType" type="KeyboardHidType">
3773	<desc>Type of keyboard HID used in this VM.
3774	The default is typically "PS2Keyboard" but can vary depending on the
3775	requirements of the guest operating system.</desc>
3776	</attribute>
3777
3778	<attribute name="hpetEnabled" type="boolean">
3779	<desc>This attribute controls if High Precision Event Timer (HPET) is
3780	enabled in this VM. Use this property if you want to provide guests
3781	with additional time source, or if guest requires HPET to function correctly.
3782	Default is false.</desc>
3783	</attribute>
3784
3785	<attribute name="chipsetType" type="ChipsetType">
3786	<desc>Chipset type used in this VM.</desc>
3787	</attribute>
3788
3789	<attribute name="snapshotFolder" type="wstring">
3790	<desc>
3791	Full path to the directory used to store snapshot data
3792	(differencing media and saved state files) of this machine.
3793
3794	The initial value of this property is
3795	<tt><</tt><link to="#settingsFilePath">
3796	path_to_settings_file</link><tt>>/<</tt>
3797	<link to="#id">machine_uuid</link>
3798	<tt>></tt>.
3799
3800	Currently, it is an error to try to change this property on
3801	a machine that has snapshots (because this would require to
3802	move possibly large files to a different location).
3803	A separate method will be available for this purpose later.
3804
3805	<note>
3806	Setting this property to @c null or to an empty string will restore
3807	the initial value.
3808	</note>
3809	<note>
3810	When setting this property, the specified path can be
3811	absolute (full path) or relative to the directory where the
3812	<link to="#settingsFilePath">machine settings file</link>
3813	is located. When reading this property, a full path is
3814	always returned.
3815	</note>
3816	<note>
3817	The specified path may not exist, it will be created
3818	when necessary.
3819	</note>
3820	</desc>
3821	</attribute>
3822
3823	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3824	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3825	</attribute>
3826
3827	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3828	<desc>Array of media attached to this machine.</desc>
3829	</attribute>
3830
3831	<attribute name="USBController" type="IUSBController" readonly="yes">
3832	<desc>
3833	Associated USB controller object.
3834
3835	<note>
3836	If USB functionality is not available in the given edition of
3837	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3838	</note>
3839	</desc>
3840	</attribute>
3841
3842	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3843	<desc>Associated audio adapter, always present.</desc>
3844	</attribute>
3845
3846	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3847	<desc>Array of storage controllers attached to this machine.</desc>
3848	</attribute>
3849
3850	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3851	<desc>
3852	Full name of the file containing machine settings data.
3853	</desc>
3854	</attribute>
3855
3856	<attribute name="settingsModified" type="boolean" readonly="yes">
3857	<desc>
3858	Whether the settings of this machine have been modified
3859	(but neither yet saved nor discarded).
3860	<note>
3861	Reading this property is only valid on instances returned
3862	by <link to="ISession::machine"/> and on new machines
3863	created by <link to="IVirtualBox::createMachine"/> or opened
3864	by <link to="IVirtualBox::openMachine"/> but not
3865	yet registered, or on unregistered machines after calling
3866	<link to="IMachine::unregister"/>. For all other
3867	cases, the settings can never be modified.
3868	</note>
3869	<note>
3870	For newly created unregistered machines, the value of this
3871	property is always @c true until <link to="#saveSettings"/>
3872	is called (no matter if any machine settings have been
3873	changed after the creation or not). For opened machines
3874	the value is set to @c false (and then follows to normal rules).
3875	</note>
3876	</desc>
3877	</attribute>
3878
3879	<attribute name="sessionState" type="SessionState" readonly="yes">
3880	<desc>Current session state for this machine.</desc>
3881	</attribute>
3882
3883	<attribute name="sessionType" type="wstring" readonly="yes">
3884	<desc>
3885	Type of the session. If <link to="#sessionState"/> is
3886	Spawning or Locked, this attribute contains the
3887	same value as passed to the
3888	<link to="IMachine::launchVMProcess"/> method in the
3889	@a type parameter. If the session was used with
3890	<link to="IMachine::lockMachine" />, or if
3891	<link to="#sessionState"/> is SessionClosed, the value of this
3892	attribute is an empty string.
3893	</desc>
3894	</attribute>
3895
3896	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3897	<desc>
3898	Identifier of the session process. This attribute contains the
3899	platform-dependent identifier of the process whose session was
3900	used with <link to="IMachine::lockMachine" /> call. The returned
3901	value is only valid if <link to="#sessionState"/> is Locked or
3902	Unlocking by the time this property is read.
3903	</desc>
3904	</attribute>
3905
3906	<attribute name="state" type="MachineState" readonly="yes">
3907	<desc>Current execution state of this machine.</desc>
3908	</attribute>
3909
3910	<attribute name="lastStateChange" type="long long" readonly="yes">
3911	<desc>
3912	Time stamp of the last execution state change,
3913	in milliseconds since 1970-01-01 UTC.
3914	</desc>
3915	</attribute>
3916
3917	<attribute name="stateFilePath" type="wstring" readonly="yes">
3918	<desc>
3919	Full path to the file that stores the execution state of
3920	the machine when it is in the <link to="MachineState_Saved"/> state.
3921	<note>
3922	When the machine is not in the Saved state, this attribute is
3923	an empty string.
3924	</note>
3925	</desc>
3926	</attribute>
3927
3928	<attribute name="logFolder" type="wstring" readonly="yes">
3929	<desc>
3930	Full path to the folder that stores a set of rotated log files
3931	recorded during machine execution. The most recent log file is
3932	named <tt>VBox.log</tt>, the previous log file is
3933	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3934	in the current version).
3935	</desc>
3936	</attribute>
3937
3938	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3939	<desc>
3940	Current snapshot of this machine. This is @c null if the machine
3941	currently has no snapshots. If it is not @c null, then it was
3942	set by one of <link to="IConsole::takeSnapshot" />,
3943	<link to="IConsole::deleteSnapshot" />
3944	or <link to="IConsole::restoreSnapshot" />, depending on which
3945	was called last. See <link to="ISnapshot"/> for details.
3946	</desc>
3947	</attribute>
3948
3949	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3950	<desc>
3951	Number of snapshots taken on this machine. Zero means the
3952	machine doesn't have any snapshots.
3953	</desc>
3954	</attribute>
3955
3956	<attribute name="currentStateModified" type="boolean" readonly="yes">
3957	<desc>
3958	Returns @c true if the current state of the machine is not
3959	identical to the state stored in the current snapshot.
3960
3961	The current state is identical to the current snapshot only
3962	directly after one of the following calls are made:
3963
3964	<ul>
3965	<li><link to="IConsole::restoreSnapshot"/>
3966	</li>
3967	<li><link to="IConsole::takeSnapshot"/> (issued on a
3968	"powered off" or "saved" machine, for which
3969	<link to="#settingsModified"/> returns @c false)
3970	</li>
3971	</ul>
3972
3973	The current state remains identical until one of the following
3974	happens:
3975	<ul>
3976	<li>settings of the machine are changed</li>
3977	<li>the saved state is deleted</li>
3978	<li>the current snapshot is deleted</li>
3979	<li>an attempt to execute the machine is made</li>
3980	</ul>
3981
3982	<note>
3983	For machines that don't have snapshots, this property is
3984	always @c false.
3985	</note>
3986	</desc>
3987	</attribute>
3988
3989	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3990	<desc>
3991	Collection of shared folders for this machine (permanent shared
3992	folders). These folders are shared automatically at machine startup
3993	and available only to the guest OS installed within this machine.
3994
3995	New shared folders are added to the collection using
3996	<link to="#createSharedFolder"/>. Existing shared folders can be
3997	removed using <link to="#removeSharedFolder"/>.
3998	</desc>
3999	</attribute>
4000
4001	<attribute name="clipboardMode" type="ClipboardMode">
4002	<desc>
4003	Synchronization mode between the host OS clipboard
4004	and the guest OS clipboard.
4005	</desc>
4006	</attribute>
4007
4008	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4009	<desc>
4010	A comma-separated list of simple glob patterns. Changes to guest
4011	properties whose name matches one of the patterns will generate an
4012	<link to="IGuestPropertyChangedEvent"/> signal.
4013	</desc>
4014	</attribute>
4015
4016	<attribute name="teleporterEnabled" type="boolean">
4017	<desc>
4018	When set to @a true, the virtual machine becomes a target teleporter
4019	the next time it is powered on. This can only set to @a true when the
4020	VM is in the @a PoweredOff or @a Aborted state.
4021
4022	<!-- This property is automatically set to @a false when the VM is powered
4023	on. (bird: This doesn't work yet ) -->
4024	</desc>
4025	</attribute>
4026
4027	<attribute name="teleporterPort" type="unsigned long">
4028	<desc>
4029	The TCP port the target teleporter will listen for incoming
4030	teleportations on.
4031
4032	0 means the port is automatically selected upon power on. The actual
4033	value can be read from this property while the machine is waiting for
4034	incoming teleportations.
4035	</desc>
4036	</attribute>
4037
4038	<attribute name="teleporterAddress" type="wstring">
4039	<desc>
4040	The address the target teleporter will listen on. If set to an empty
4041	string, it will listen on all addresses.
4042	</desc>
4043	</attribute>
4044
4045	<attribute name="teleporterPassword" type="wstring">
4046	<desc>
4047	The password to check for on the target teleporter. This is just a
4048	very basic measure to prevent simple hacks and operators accidentally
4049	beaming a virtual machine to the wrong place.
4050	</desc>
4051	</attribute>
4052
4053	<attribute name="faultToleranceState" type="FaultToleranceState">
4054	<desc>
4055	Fault tolerance state; disabled, source or target.
4056	This property can be changed at any time. If you change it for a running
4057	VM, then the fault tolerance address and port must be set beforehand.
4058	</desc>
4059	</attribute>
4060
4061	<attribute name="faultTolerancePort" type="unsigned long">
4062	<desc>
4063	The TCP port the fault tolerance source or target will use for
4064	communication.
4065	</desc>
4066	</attribute>
4067
4068	<attribute name="faultToleranceAddress" type="wstring">
4069	<desc>
4070	The address the fault tolerance source or target.
4071	</desc>
4072	</attribute>
4073
4074	<attribute name="faultTolerancePassword" type="wstring">
4075	<desc>
4076	The password to check for on the standby VM. This is just a
4077	very basic measure to prevent simple hacks and operators accidentally
4078	choosing the wrong standby VM.
4079	</desc>
4080	</attribute>
4081
4082	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4083	<desc>
4084	The interval in ms used for syncing the state between source and target.
4085	</desc>
4086	</attribute>
4087
4088	<attribute name="RTCUseUTC" type="boolean">
4089	<desc>
4090	When set to @a true, the RTC device of the virtual machine will run
4091	in UTC time, otherwise in local time. Especially Unix guests prefer
4092	the time in UTC.
4093	</desc>
4094	</attribute>
4095
4096	<attribute name="ioCacheEnabled" type="boolean">
4097	<desc>
4098	When set to @a true, the builtin I/O cache of the virtual machine
4099	will be enabled.
4100	</desc>
4101	</attribute>
4102
4103	<attribute name="ioCacheSize" type="unsigned long">
4104	<desc>
4105	Maximum size of the I/O cache in MB.
4106	</desc>
4107	</attribute>
4108
4109	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4110	<desc>
4111	Bandwidth control manager.
4112	</desc>
4113	</attribute>
4114
4115	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4116	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4117	attached to the machine use IConsole::attachedPciDevices attribute, as
4118	this attribute is intended to list only devices additional to what
4119	described in virtual hardware config. Usually, this list keeps host's
4120	physical devices assigned to the particular machine.
4121	</desc>
4122	</attribute>
4123
4124	<method name="lockMachine">
4125	<desc>
4126	Locks the machine for the given session to enable the caller
4127	to make changes to the machine or start the VM or control
4128	VM execution.
4129
4130	There are two ways to lock a machine for such uses:
4131
4132	<ul>
4133	<li>If you want to make changes to the machine settings,
4134	you must obtain an exclusive write lock on the machine
4135	by setting @a lockType to @c Write.
4136
4137	This will only succeed if no other process has locked
4138	the machine to prevent conflicting changes. Only after
4139	an exclusive write lock has been obtained using this method, one
4140	can change all VM settings or execute the VM in the process
4141	space of the session object. (Note that the latter is only of
4142	interest if you actually want to write a new front-end for
4143	virtual machines; but this API gets called internally by
4144	the existing front-ends such as VBoxHeadless and the VirtualBox
4145	GUI to acquire a write lock on the machine that they are running.)
4146
4147	On success, write-locking the machine for a session creates
4148	a second copy of the IMachine object. It is this second object
4149	upon which changes can be made; in VirtualBox terminology, the
4150	second copy is "mutable". It is only this second, mutable machine
4151	object upon which you can call methods that change the
4152	machine state. After having called this method, you can
4153	obtain this second, mutable machine object using the
4154	<link to="ISession::machine" /> attribute.
4155	</li>
4156	<li>If you only want to check the machine state or control
4157	machine execution without actually changing machine
4158	settings (e.g. to get access to VM statistics or take
4159	a snapshot or save the machine state), then set the
4160	@a lockType argument to @c Shared.
4161
4162	If no other session has obtained a lock, you will obtain an
4163	exclusive write lock as described above. However, if another
4164	session has already obtained such a lock, then a link to that
4165	existing session will be established which allows you
4166	to control that existing session.
4167
4168	To find out which type of lock was obtained, you can
4169	inspect <link to="ISession::type" />, which will have been
4170	set to either @c WriteLock or @c Shared.
4171	</li>
4172	</ul>
4173
4174	In either case, you can get access to the <link to="IConsole" />
4175	object which controls VM execution.
4176
4177	Also in all of the above cases, one must always call
4178	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4179	the machine's state will eventually be set to "Aborted".
4180
4181	To change settings on a machine, the following sequence is typically
4182	performed:
4183
4184	<ol>
4185	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4186
4187	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4188
4189	<li>Change the settings of the machine by invoking IMachine methods.</li>
4190
4191	<li>Call <link to="IMachine::saveSettings" />.</li>
4192
4193	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4194	</ol>
4195
4196	<result name="E_UNEXPECTED">
4197	Virtual machine not registered.
4198	</result>
4199	<result name="E_ACCESSDENIED">
4200	Process not started by OpenRemoteSession.
4201	</result>
4202	<result name="VBOX_E_INVALID_OBJECT_STATE">
4203	Session already open or being opened.
4204	</result>
4205	<result name="VBOX_E_VM_ERROR">
4206	Failed to assign machine to session.
4207	</result>
4208	</desc>
4209	<param name="session" type="ISession" dir="in">
4210	<desc>
4211	Session object for which the machine will be locked.
4212	</desc>
4213	</param>
4214	<param name="lockType" type="LockType" dir="in">
4215	<desc>
4216	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4217	If set to @c Shared, then either acquire an exclusive write lock or establish
4218	a link to an existing session.
4219	</desc>
4220	</param>
4221	</method>
4222
4223	<method name="launchVMProcess">
4224	<desc>
4225	Spawns a new process that will execute the virtual machine and obtains a shared
4226	lock on the machine for the calling session.
4227
4228	If launching the VM succeeds, the new VM process will create its own session
4229	and write-lock the machine for it, preventing conflicting changes from other
4230	processes. If the machine is already locked (because it is already running or
4231	because another session has a write lock), launching the VM process will therefore
4232	fail. Reversely, future attempts to obtain a write lock will also fail while the
4233	machine is running.
4234
4235	The caller's session object remains separate from the session opened by the new
4236	VM process. It receives its own <link to="IConsole" /> object which can be used
4237	to control machine execution, but it cannot be used to change all VM settings
4238	which would be available after a <link to="#lockMachine" /> call.
4239
4240	The caller must eventually release the session's shared lock by calling
4241	<link to="ISession::unlockMachine" /> on the local session object once this call
4242	has returned. However, the session's state (see <link to="ISession::state" />)
4243	will not return to "Unlocked" until the remote session has also unlocked
4244	the machine (i.e. the machine has stopped running).
4245
4246	Launching a VM process can take some time (a new VM is started in a new process,
4247	for which memory and other resources need to be set up). Because of this,
4248	an <link to="IProgress" /> object is returned to allow the caller to wait
4249	for this asynchronous operation to be completed. Until then, the caller's
4250	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4251	and <link to="ISession::console" /> attributes cannot be accessed.
4252	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4253	similar calls to wait for completion. Completion is signalled when the VM
4254	is powered on. If launching the VM fails, error messages can be queried
4255	via the progress object, if available.
4256
4257	The progress object will have at least 2 sub-operations. The first
4258	operation covers the period up to the new VM process calls powerUp.
4259	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4260	progress object. Because <link to="IConsole::powerUp"/> may require
4261	some extra sub-operations, the <link to="IProgress::operationCount"/>
4262	may change at the completion of operation.
4263
4264	For details on the teleportation progress operation, see
4265	<link to="IConsole::powerUp"/>.
4266
4267	The @a environment argument is a string containing definitions of
4268	environment variables in the following format:
4269	@code
4270	NAME[=VALUE]\n
4271	NAME[=VALUE]\n
4272	...
4273	@endcode
4274	where <tt>\\n</tt> is the new line character. These environment
4275	variables will be appended to the environment of the VirtualBox server
4276	process. If an environment variable exists both in the server process
4277	and in this list, the value from this list takes precedence over the
4278	server's variable. If the value of the environment variable is
4279	omitted, this variable will be removed from the resulting environment.
4280	If the environment string is @c null or empty, the server environment
4281	is inherited by the started process as is.
4282
4283	<result name="E_UNEXPECTED">
4284	Virtual machine not registered.
4285	</result>
4286	<result name="E_INVALIDARG">
4287	Invalid session type @a type.
4288	</result>
4289	<result name="VBOX_E_OBJECT_NOT_FOUND">
4290	No machine matching @a machineId found.
4291	</result>
4292	<result name="VBOX_E_INVALID_OBJECT_STATE">
4293	Session already open or being opened.
4294	</result>
4295	<result name="VBOX_E_IPRT_ERROR">
4296	Launching process for machine failed.
4297	</result>
4298	<result name="VBOX_E_VM_ERROR">
4299	Failed to assign machine to session.
4300	</result>
4301	</desc>
4302	<param name="session" type="ISession" dir="in">
4303	<desc>
4304	Client session object to which the VM process will be connected (this
4305	must be in "Unlocked" state).
4306	</desc>
4307	</param>
4308	<param name="type" type="wstring" dir="in">
4309	<desc>
4310	Front-end to use for the new VM process. The following are currently supported:
4311	<ul>
4312	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4313	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4314	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4315	</ul>
4316	</desc>
4317	</param>
4318	<param name="environment" type="wstring" dir="in">
4319	<desc>
4320	Environment to pass to the VM process.
4321	</desc>
4322	</param>
4323	<param name="progress" type="IProgress" dir="return">
4324	<desc>Progress object to track the operation completion.</desc>
4325	</param>
4326	</method>
4327
4328	<method name="setBootOrder">
4329	<desc>
4330	Puts the given device to the specified position in
4331	the boot order.
4332
4333	To indicate that no device is associated with the given position,
4334	<link to="DeviceType_Null"/> should be used.
4335
4336	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4337
4338	<result name="E_INVALIDARG">
4339	Boot @a position out of range.
4340	</result>
4341	<result name="E_NOTIMPL">
4342	Booting from USB @a device currently not supported.
4343	</result>
4344
4345	</desc>
4346	<param name="position" type="unsigned long" dir="in">
4347	<desc>
4348	Position in the boot order (@c 1 to the total number of
4349	devices the machine can boot from, as returned by
4350	<link to="ISystemProperties::maxBootPosition"/>).
4351	</desc>
4352	</param>
4353	<param name="device" type="DeviceType" dir="in">
4354	<desc>
4355	The type of the device used to boot at the given position.
4356	</desc>
4357	</param>
4358	</method>
4359
4360	<method name="getBootOrder" const="yes">
4361	<desc>
4362	Returns the device type that occupies the specified
4363	position in the boot order.
4364
4365	@todo [remove?]
4366	If the machine can have more than one device of the returned type
4367	(such as hard disks), then a separate method should be used to
4368	retrieve the individual device that occupies the given position.
4369
4370	If here are no devices at the given position, then
4371	<link to="DeviceType_Null"/> is returned.
4372
4373	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4374
4375	<result name="E_INVALIDARG">
4376	Boot @a position out of range.
4377	</result>
4378
4379	</desc>
4380	<param name="position" type="unsigned long" dir="in">
4381	<desc>
4382	Position in the boot order (@c 1 to the total number of
4383	devices the machine can boot from, as returned by
4384	<link to="ISystemProperties::maxBootPosition"/>).
4385	</desc>
4386	</param>
4387	<param name="device" type="DeviceType" dir="return">
4388	<desc>
4389	Device at the given position.
4390	</desc>
4391	</param>
4392	</method>
4393
4394	<method name="attachDevice">
4395	<desc>
4396	Attaches a device and optionally mounts a medium to the given storage
4397	controller (<link to="IStorageController" />, identified by @a name),
4398	at the indicated port and device.
4399
4400	This method is intended for managing storage devices in general while a
4401	machine is powered off. It can be used to attach and detach fixed
4402	and removeable media. The following kind of media can be attached
4403	to a machine:
4404
4405	<ul>
4406	<li>For fixed and removable media, you can pass in a medium that was
4407	previously opened using <link to="IVirtualBox::openMedium" />.
4408	</li>
4409
4410	<li>Only for storage devices supporting removable media (such as
4411	DVDs and floppies), you can also specify a null pointer to
4412	indicate an empty drive or one of the medium objects listed
4413	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4414	arrays to indicate a host drive.
4415	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4416	to change the media while the machine is running.
4417	</li>
4418	</ul>
4419
4420	In a VM's default configuration of virtual machines, the secondary
4421	master of the IDE controller is used for a CD/DVD drive.
4422
4423	After calling this returns successfully, a new instance of
4424	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4425	attachments (see <link to="IMachine::mediumAttachments"/>).
4426
4427	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4428	information about attaching media.
4429
4430	The specified device slot must not have a device attached to it,
4431	or this method will fail.
4432
4433	<note>
4434	You cannot attach a device to a newly created machine until
4435	this machine's settings are saved to disk using
4436	<link to="#saveSettings"/>.
4437	</note>
4438	<note>
4439	If the medium is being attached indirectly, a new differencing medium
4440	will implicitly be created for it and attached instead. If the
4441	changes made to the machine settings (including this indirect
4442	attachment) are later cancelled using <link to="#discardSettings"/>,
4443	this implicitly created differencing medium will implicitly
4444	be deleted.
4445	</note>
4446
4447	<result name="E_INVALIDARG">
4448	SATA device, SATA port, IDE port or IDE slot out of range, or
4449	file or UUID not found.
4450	</result>
4451	<result name="VBOX_E_INVALID_OBJECT_STATE">
4452	Machine must be registered before media can be attached.
4453	</result>
4454	<result name="VBOX_E_INVALID_VM_STATE">
4455	Invalid machine state.
4456	</result>
4457	<result name="VBOX_E_OBJECT_IN_USE">
4458	A medium is already attached to this or another virtual machine.
4459	</result>
4460
4461	</desc>
4462	<param name="name" type="wstring" dir="in">
4463	<desc>Name of the storage controller to attach the device to.</desc>
4464	</param>
4465	<param name="controllerPort" type="long" dir="in">
4466	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4467	the primary controller and 1 specifies the secondary controller.
4468	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4469	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4470	</param>
4471	<param name="device" type="long" dir="in">
4472	<desc>Device slot in the given port to attach the device to. This is only
4473	relevant for IDE controllers, for which 0 specifies the master device and
4474	1 specifies the slave device. For all other controller types, this must
4475	be 0.</desc>
4476	</param>
4477	<param name="type" type="DeviceType" dir="in">
4478	<desc>Device type of the attached device. For media opened by
4479	<link to="IVirtualBox::openMedium" />, this must match the device type
4480	specified there.</desc>
4481	</param>
4482	<param name="medium" type="IMedium" dir="in">
4483	<desc>Medium to mount or NULL for an empty drive.</desc>
4484	</param>
4485	</method>
4486
4487	<method name="detachDevice">
4488	<desc>
4489	Detaches the device attached to a device slot of the specified bus.
4490
4491	Detaching the device from the virtual machine is deferred. This means
4492	that the medium remains associated with the machine when this method
4493	returns and gets actually de-associated only after a successful
4494	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4495	for more detailed information about attaching media.
4496
4497	<note>
4498	You cannot detach a device from a running machine.
4499	</note>
4500	<note>
4501	Detaching differencing media implicitly created by <link
4502	to="#attachDevice"/> for the indirect attachment using this
4503	method will <b>not</b> implicitly delete them. The
4504	<link to="IMedium::deleteStorage"/> operation should be
4505	explicitly performed by the caller after the medium is successfully
4506	detached and the settings are saved with
4507	<link to="#saveSettings"/>, if it is the desired action.
4508	</note>
4509
4510	<result name="VBOX_E_INVALID_VM_STATE">
4511	Attempt to detach medium from a running virtual machine.
4512	</result>
4513	<result name="VBOX_E_OBJECT_NOT_FOUND">
4514	No medium attached to given slot/bus.
4515	</result>
4516	<result name="VBOX_E_NOT_SUPPORTED">
4517	Medium format does not support storage deletion.
4518	</result>
4519
4520	</desc>
4521	<param name="name" type="wstring" dir="in">
4522	<desc>Name of the storage controller to detach the medium from.</desc>
4523	</param>
4524	<param name="controllerPort" type="long" dir="in">
4525	<desc>Port number to detach the medium from.</desc>
4526	</param>
4527	<param name="device" type="long" dir="in">
4528	<desc>Device slot number to detach the medium from.</desc>
4529	</param>
4530	</method>
4531
4532	<method name="passthroughDevice">
4533	<desc>
4534	Sets the passthrough mode of an existing DVD device. Changing the
4535	setting while the VM is running is forbidden. The setting is only used
4536	if at VM start the device is configured as a host DVD drive, in all
4537	other cases it is ignored. The device must already exist; see
4538	<link to="IMachine::attachDevice"/> for how to attach a new device.
4539
4540	The @a controllerPort and @a device parameters specify the device slot and
4541	have have the same meaning as with <link to="IMachine::attachDevice" />.
4542
4543	<result name="E_INVALIDARG">
4544	SATA device, SATA port, IDE port or IDE slot out of range.
4545	</result>
4546	<result name="VBOX_E_INVALID_OBJECT_STATE">
4547	Attempt to modify an unregistered virtual machine.
4548	</result>
4549	<result name="VBOX_E_INVALID_VM_STATE">
4550	Invalid machine state.
4551	</result>
4552
4553	</desc>
4554	<param name="name" type="wstring" dir="in">
4555	<desc>Name of the storage controller.</desc>
4556	</param>
4557	<param name="controllerPort" type="long" dir="in">
4558	<desc>Storage controller port.</desc>
4559	</param>
4560	<param name="device" type="long" dir="in">
4561	<desc>Device slot in the given port.</desc>
4562	</param>
4563	<param name="passthrough" type="boolean" dir="in">
4564	<desc>New value for the passthrough setting.</desc>
4565	</param>
4566	</method>
4567
4568	<method name="setBandwidthGroupForDevice">
4569	<desc>
4570	Sets the passthrough mode of an existing DVD device. Changing the
4571	setting while the VM is running is forbidden. The setting is only used
4572	if at VM start the device is configured as a host DVD drive, in all
4573	other cases it is ignored. The device must already exist; see
4574	<link to="IMachine::attachDevice"/> for how to attach a new device.
4575
4576	The @a controllerPort and @a device parameters specify the device slot and
4577	have have the same meaning as with <link to="IMachine::attachDevice" />.
4578
4579	<result name="E_INVALIDARG">
4580	SATA device, SATA port, IDE port or IDE slot out of range.
4581	</result>
4582	<result name="VBOX_E_INVALID_OBJECT_STATE">
4583	Attempt to modify an unregistered virtual machine.
4584	</result>
4585	<result name="VBOX_E_INVALID_VM_STATE">
4586	Invalid machine state.
4587	</result>
4588
4589	</desc>
4590	<param name="name" type="wstring" dir="in">
4591	<desc>Name of the storage controller.</desc>
4592	</param>
4593	<param name="controllerPort" type="long" dir="in">
4594	<desc>Storage controller port.</desc>
4595	</param>
4596	<param name="device" type="long" dir="in">
4597	<desc>Device slot in the given port.</desc>
4598	</param>
4599	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4600	<desc>New value for the bandwidth group or NULL for no group.</desc>
4601	</param>
4602	</method>
4603
4604	<method name="mountMedium">
4605	<desc>
4606	Mounts a medium (<link to="IMedium" />, identified
4607	by the given UUID @a id) to the given storage controller
4608	(<link to="IStorageController" />, identified by @a name),
4609	at the indicated port and device. The device must already exist;
4610	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4611
4612	This method is intended only for managing removable media, where the
4613	device is fixed but media is changeable at runtime (such as DVDs
4614	and floppies). It cannot be used for fixed media such as hard disks.
4615
4616	The @a controllerPort and @a device parameters specify the device slot and
4617	have have the same meaning as with <link to="IMachine::attachDevice" />.
4618
4619	The specified device slot can have a medium mounted, which will be
4620	unmounted first. Specifying a zero UUID (or an empty string) for
4621	@a medium does just an unmount.
4622
4623	See <link to="IMedium"/> for more detailed information about
4624	attaching media.
4625
4626	<result name="E_INVALIDARG">
4627	SATA device, SATA port, IDE port or IDE slot out of range.
4628	</result>
4629	<result name="VBOX_E_INVALID_OBJECT_STATE">
4630	Attempt to attach medium to an unregistered virtual machine.
4631	</result>
4632	<result name="VBOX_E_INVALID_VM_STATE">
4633	Invalid machine state.
4634	</result>
4635	<result name="VBOX_E_OBJECT_IN_USE">
4636	Medium already attached to this or another virtual machine.
4637	</result>
4638
4639	</desc>
4640	<param name="name" type="wstring" dir="in">
4641	<desc>Name of the storage controller to attach the medium to.</desc>
4642	</param>
4643	<param name="controllerPort" type="long" dir="in">
4644	<desc>Port to attach the medium to.</desc>
4645	</param>
4646	<param name="device" type="long" dir="in">
4647	<desc>Device slot in the given port to attach the medium to.</desc>
4648	</param>
4649	<param name="medium" type="IMedium" dir="in">
4650	<desc>Medium to mount or NULL for an empty drive.</desc>
4651	</param>
4652	<param name="force" type="boolean" dir="in">
4653	<desc>Allows to force unmount/mount of a medium which is locked by
4654	the device slot in the given port to attach the medium to.</desc>
4655	</param>
4656	</method>
4657
4658	<method name="getMedium" const="yes">
4659	<desc>
4660	Returns the virtual medium attached to a device slot of the specified
4661	bus.
4662
4663	Note that if the medium was indirectly attached by
4664	<link to="#mountMedium"/> to the given device slot then this
4665	method will return not the same object as passed to the
4666	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4667	more detailed information about mounting a medium.
4668
4669	<result name="VBOX_E_OBJECT_NOT_FOUND">
4670	No medium attached to given slot/bus.
4671	</result>
4672
4673	</desc>
4674	<param name="name" type="wstring" dir="in">
4675	<desc>Name of the storage controller the medium is attached to.</desc>
4676	</param>
4677	<param name="controllerPort" type="long" dir="in">
4678	<desc>Port to query.</desc>
4679	</param>
4680	<param name="device" type="long" dir="in">
4681	<desc>Device slot in the given port to query.</desc>
4682	</param>
4683	<param name="medium" type="IMedium" dir="return">
4684	<desc>Attached medium object.</desc>
4685	</param>
4686	</method>
4687
4688	<method name="getMediumAttachmentsOfController" const="yes">
4689	<desc>
4690	Returns an array of medium attachments which are attached to the
4691	the controller with the given name.
4692
4693	<result name="VBOX_E_OBJECT_NOT_FOUND">
4694	A storage controller with given name doesn't exist.
4695	</result>
4696	</desc>
4697	<param name="name" type="wstring" dir="in"/>
4698	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4699	</method>
4700
4701	<method name="getMediumAttachment" const="yes">
4702	<desc>
4703	Returns a medium attachment which corresponds to the controller with
4704	the given name, on the given port and device slot.
4705
4706	<result name="VBOX_E_OBJECT_NOT_FOUND">
4707	No attachment exists for the given controller/port/device combination.
4708	</result>
4709	</desc>
4710	<param name="name" type="wstring" dir="in"/>
4711	<param name="controllerPort" type="long" dir="in"/>
4712	<param name="device" type="long" dir="in"/>
4713	<param name="attachment" type="IMediumAttachment" dir="return"/>
4714	</method>
4715
4716	<method name="attachHostPciDevice">
4717	<desc>
4718	Attaches host PCI device with the given (host) PCI address to the
4719	PCI bus of the virtual machine. Please note, that this operation
4720	is two phase, as real attachment will happen when VM will start,
4721	and most information will be delivered as IHostPciDevicePlugEvent
4722	on IVirtualBox event source.
4723	<note>
4724	Not yet implemented.
4725	</note>
4726
4727	<see>IHostPciDevicePlugEvent</see>
4728
4729	<result name="VBOX_E_INVALID_VM_STATE">
4730	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4731	</result>
4732	<result name="VBOX_E_PDM_ERROR">
4733	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4734	</result>
4735	<result name="VBOX_E_NOT_SUPPORTED">
4736	Hardware or host OS doesn't allow PCI device passthrought.
4737	</result>
4738	</desc>
4739	<param name="hostAddress" type="long" dir="in">
4740	<desc>Address of the host PCI device.</desc>
4741	</param>
4742	<param name="desiredGuestAddress" type="long" dir="in">
4743	<desc>Desired position of this device on guest PCI bus.</desc>
4744	</param>
4745	<param name="eventContext" type="IEventContext" dir="in">
4746	<desc>Context passed into IHostPciDevicePlugEvent event.</desc>
4747	</param>
4748	<param name="tryToUnbind" type="boolean" dir="in">
4749	<desc>If VMM shall try to unbind existing drivers from the
4750	device before attaching it to the guest.</desc>
4751	</param>
4752	</method>
4753
4754	<method name="detachHostPciDevice">
4755	<desc>
4756	Detach host PCI device from the virtual machine.
4757	Also HostPciDevicePlugEvent on IVirtualBox event source
4758	will be delivered.
4759
4760	<note>
4761	Not yet implemented.
4762	</note>
4763
4764	<see>IHostPciDevicePlugEvent</see>
4765
4766	<result name="VBOX_E_INVALID_VM_STATE">
4767	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4768	</result>
4769	<result name="VBOX_E_OBJECT_NOT_FOUND">
4770	This host device is not attached to this machine.
4771	</result>
4772	<result name="VBOX_E_PDM_ERROR">
4773	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4774	</result>
4775	<result name="VBOX_E_NOT_SUPPORTED">
4776	Hardware or host OS doesn't allow PCI device passthrought.
4777	</result>
4778	</desc>
4779	<param name="hostAddress" type="long" dir="in">
4780	<desc>Address of the host PCI device.</desc>
4781	</param>
4782	</method>
4783
4784	<method name="getNetworkAdapter" const="yes">
4785	<desc>
4786	Returns the network adapter associated with the given slot.
4787	Slots are numbered sequentially, starting with zero. The total
4788	number of adapters per machine is defined by the
4789	<link to="ISystemProperties::networkAdapterCount"/> property,
4790	so the maximum slot number is one less than that property's value.
4791
4792	<result name="E_INVALIDARG">
4793	Invalid @a slot number.
4794	</result>
4795
4796	</desc>
4797	<param name="slot" type="unsigned long" dir="in"/>
4798	<param name="adapter" type="INetworkAdapter" dir="return"/>
4799	</method>
4800
4801	<method name="addStorageController">
4802	<desc>
4803	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4804	machine and returns it as an instance of
4805	<link to="IStorageController" />.
4806
4807	@a name identifies the controller for subsequent calls such as
4808	<link to="#getStorageControllerByName" />,
4809	<link to="#getStorageControllerByInstance" />,
4810	<link to="#removeStorageController" />,
4811	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4812
4813	After the controller has been added, you can set its exact
4814	type by setting the <link to="IStorageController::controllerType" />.
4815
4816	<result name="VBOX_E_OBJECT_IN_USE">
4817	A storage controller with given name exists already.
4818	</result>
4819	<result name="E_INVALIDARG">
4820	Invalid @a controllerType.
4821	</result>
4822	</desc>
4823	<param name="name" type="wstring" dir="in"/>
4824	<param name="connectionType" type="StorageBus" dir="in"/>
4825	<param name="controller" type="IStorageController" dir="return"/>
4826	</method>
4827
4828	<method name="getStorageControllerByName" const="yes">
4829	<desc>
4830	Returns a storage controller with the given name.
4831
4832	<result name="VBOX_E_OBJECT_NOT_FOUND">
4833	A storage controller with given name doesn't exist.
4834	</result>
4835	</desc>
4836	<param name="name" type="wstring" dir="in"/>
4837	<param name="storageController" type="IStorageController" dir="return"/>
4838	</method>
4839
4840	<method name="getStorageControllerByInstance" const="yes">
4841	<desc>
4842	Returns a storage controller with the given instance number.
4843
4844	<result name="VBOX_E_OBJECT_NOT_FOUND">
4845	A storage controller with given instance number doesn't exist.
4846	</result>
4847	</desc>
4848	<param name="instance" type="unsigned long" dir="in"/>
4849	<param name="storageController" type="IStorageController" dir="return"/>
4850	</method>
4851
4852	<method name="removeStorageController">
4853	<desc>
4854	Removes a storage controller from the machine.
4855
4856	<result name="VBOX_E_OBJECT_NOT_FOUND">
4857	A storage controller with given name doesn't exist.
4858	</result>
4859	</desc>
4860	<param name="name" type="wstring" dir="in"/>
4861	</method>
4862
4863	<method name="setStorageControllerBootable">
4864	<desc>
4865	Sets the bootable flag of the storage controller with the given name.
4866
4867	<result name="VBOX_E_OBJECT_NOT_FOUND">
4868	A storage controller with given name doesn't exist.
4869	</result>
4870	<result name="VBOX_E_OBJECT_IN_USE">
4871	Another storage controller is marked as bootable already.
4872	</result>
4873	</desc>
4874	<param name="name" type="wstring" dir="in"/>
4875	<param name="bootable" type="boolean" dir="in"/>
4876	</method>
4877
4878	<method name="getSerialPort" const="yes">
4879	<desc>
4880	Returns the serial port associated with the given slot.
4881	Slots are numbered sequentially, starting with zero. The total
4882	number of serial ports per machine is defined by the
4883	<link to="ISystemProperties::serialPortCount"/> property,
4884	so the maximum slot number is one less than that property's value.
4885
4886	<result name="E_INVALIDARG">
4887	Invalid @a slot number.
4888	</result>
4889
4890	</desc>
4891	<param name="slot" type="unsigned long" dir="in"/>
4892	<param name="port" type="ISerialPort" dir="return"/>
4893	</method>
4894
4895	<method name="getParallelPort" const="yes">
4896	<desc>
4897	Returns the parallel port associated with the given slot.
4898	Slots are numbered sequentially, starting with zero. The total
4899	number of parallel ports per machine is defined by the
4900	<link to="ISystemProperties::parallelPortCount"/> property,
4901	so the maximum slot number is one less than that property's value.
4902
4903	<result name="E_INVALIDARG">
4904	Invalid @a slot number.
4905	</result>
4906
4907	</desc>
4908	<param name="slot" type="unsigned long" dir="in"/>
4909	<param name="port" type="IParallelPort" dir="return"/>
4910	</method>
4911
4912	<method name="getExtraDataKeys">
4913	<desc>
4914	Returns an array representing the machine-specific extra data keys
4915	which currently have values defined.
4916	</desc>
4917	<param name="value" type="wstring" dir="return" safearray="yes">
4918	<desc>Array of extra data keys.</desc>
4919	</param>
4920	</method>
4921
4922	<method name="getExtraData">
4923	<desc>
4924	Returns associated machine-specific extra data.
4925
4926	If the requested data @a key does not exist, this function will
4927	succeed and return an empty string in the @a value argument.
4928
4929	<result name="VBOX_E_FILE_ERROR">
4930	Settings file not accessible.
4931	</result>
4932	<result name="VBOX_E_XML_ERROR">
4933	Could not parse the settings file.
4934	</result>
4935
4936	</desc>
4937	<param name="key" type="wstring" dir="in">
4938	<desc>Name of the data key to get.</desc>
4939	</param>
4940	<param name="value" type="wstring" dir="return">
4941	<desc>Value of the requested data key.</desc>
4942	</param>
4943	</method>
4944
4945	<method name="setExtraData">
4946	<desc>
4947	Sets associated machine-specific extra data.
4948
4949	If you pass @c null or an empty string as a key @a value, the given
4950	@a key will be deleted.
4951
4952	<note>
4953	Before performing the actual data change, this method will ask all
4954	registered listeners using the
4955	<link to="IExtraDataCanChangeEvent"/>
4956	notification for a permission. If one of the listeners refuses the
4957	new value, the change will not be performed.
4958	</note>
4959	<note>
4960	On success, the
4961	<link to="IExtraDataChangedEvent"/> notification
4962	is called to inform all registered listeners about a successful data
4963	change.
4964	</note>
4965	<note>
4966	This method can be called outside the machine session and therefore
4967	it's a caller's responsibility to handle possible race conditions
4968	when several clients change the same key at the same time.
4969	</note>
4970
4971	<result name="VBOX_E_FILE_ERROR">
4972	Settings file not accessible.
4973	</result>
4974	<result name="VBOX_E_XML_ERROR">
4975	Could not parse the settings file.
4976	</result>
4977
4978	</desc>
4979	<param name="key" type="wstring" dir="in">
4980	<desc>Name of the data key to set.</desc>
4981	</param>
4982	<param name="value" type="wstring" dir="in">
4983	<desc>Value to assign to the key.</desc>
4984	</param>
4985	</method>
4986
4987	<method name="getCPUProperty" const="yes">
4988	<desc>
4989	Returns the virtual CPU boolean value of the specified property.
4990
4991	<result name="E_INVALIDARG">
4992	Invalid property.
4993	</result>
4994
4995	</desc>
4996	<param name="property" type="CPUPropertyType" dir="in">
4997	<desc>
4998	Property type to query.
4999	</desc>
5000	</param>
5001	<param name="value" type="boolean" dir="return">
5002	<desc>
5003	Property value.
5004	</desc>
5005	</param>
5006	</method>
5007
5008	<method name="setCPUProperty">
5009	<desc>
5010	Sets the virtual CPU boolean value of the specified property.
5011
5012	<result name="E_INVALIDARG">
5013	Invalid property.
5014	</result>
5015
5016	</desc>
5017	<param name="property" type="CPUPropertyType" dir="in">
5018	<desc>
5019	Property type to query.
5020	</desc>
5021	</param>
5022	<param name="value" type="boolean" dir="in">
5023	<desc>
5024	Property value.
5025	</desc>
5026	</param>
5027	</method>
5028
5029	<method name="getCPUIDLeaf" const="yes">
5030	<desc>
5031	Returns the virtual CPU cpuid information for the specified leaf.
5032
5033	Currently supported index values for cpuid:
5034	Standard CPUID leafs: 0 - 0xA
5035	Extended CPUID leafs: 0x80000000 - 0x8000000A
5036
5037	See the Intel and AMD programmer's manuals for detailed information
5038	about the cpuid instruction and its leafs.
5039	<result name="E_INVALIDARG">
5040	Invalid id.
5041	</result>
5042
5043	</desc>
5044	<param name="id" type="unsigned long" dir="in">
5045	<desc>
5046	CPUID leaf index.
5047	</desc>
5048	</param>
5049	<param name="valEax" type="unsigned long" dir="out">
5050	<desc>
5051	CPUID leaf value for register eax.
5052	</desc>
5053	</param>
5054	<param name="valEbx" type="unsigned long" dir="out">
5055	<desc>
5056	CPUID leaf value for register ebx.
5057	</desc>
5058	</param>
5059	<param name="valEcx" type="unsigned long" dir="out">
5060	<desc>
5061	CPUID leaf value for register ecx.
5062	</desc>
5063	</param>
5064	<param name="valEdx" type="unsigned long" dir="out">
5065	<desc>
5066	CPUID leaf value for register edx.
5067	</desc>
5068	</param>
5069	</method>
5070
5071	<method name="setCPUIDLeaf">
5072	<desc>
5073	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5074	are not passed unmodified. VirtualBox clears features that it doesn't support.
5075
5076	Currently supported index values for cpuid:
5077	Standard CPUID leafs: 0 - 0xA
5078	Extended CPUID leafs: 0x80000000 - 0x8000000A
5079
5080	See the Intel and AMD programmer's manuals for detailed information
5081	about the cpuid instruction and its leafs.
5082
5083	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5084	random crashes inside VMs.
5085	<result name="E_INVALIDARG">
5086	Invalid id.
5087	</result>
5088
5089	</desc>
5090	<param name="id" type="unsigned long" dir="in">
5091	<desc>
5092	CPUID leaf index.
5093	</desc>
5094	</param>
5095	<param name="valEax" type="unsigned long" dir="in">
5096	<desc>
5097	CPUID leaf value for register eax.
5098	</desc>
5099	</param>
5100	<param name="valEbx" type="unsigned long" dir="in">
5101	<desc>
5102	CPUID leaf value for register ebx.
5103	</desc>
5104	</param>
5105	<param name="valEcx" type="unsigned long" dir="in">
5106	<desc>
5107	CPUID leaf value for register ecx.
5108	</desc>
5109	</param>
5110	<param name="valEdx" type="unsigned long" dir="in">
5111	<desc>
5112	CPUID leaf value for register edx.
5113	</desc>
5114	</param>
5115	</method>
5116
5117	<method name="removeCPUIDLeaf">
5118	<desc>
5119	Removes the virtual CPU cpuid leaf for the specified index
5120
5121	<result name="E_INVALIDARG">
5122	Invalid id.
5123	</result>
5124
5125	</desc>
5126	<param name="id" type="unsigned long" dir="in">
5127	<desc>
5128	CPUID leaf index.
5129	</desc>
5130	</param>
5131	</method>
5132
5133	<method name="removeAllCPUIDLeaves">
5134	<desc>
5135	Removes all the virtual CPU cpuid leaves
5136	</desc>
5137	</method>
5138
5139	<method name="getHWVirtExProperty" const="yes">
5140	<desc>
5141	Returns the value of the specified hardware virtualization boolean property.
5142
5143	<result name="E_INVALIDARG">
5144	Invalid property.
5145	</result>
5146
5147	</desc>
5148	<param name="property" type="HWVirtExPropertyType" dir="in">
5149	<desc>
5150	Property type to query.
5151	</desc>
5152	</param>
5153	<param name="value" type="boolean" dir="return">
5154	<desc>
5155	Property value.
5156	</desc>
5157	</param>
5158	</method>
5159
5160	<method name="setHWVirtExProperty">
5161	<desc>
5162	Sets a new value for the specified hardware virtualization boolean property.
5163
5164	<result name="E_INVALIDARG">
5165	Invalid property.
5166	</result>
5167
5168	</desc>
5169	<param name="property" type="HWVirtExPropertyType" dir="in">
5170	<desc>
5171	Property type to set.
5172	</desc>
5173	</param>
5174	<param name="value" type="boolean" dir="in">
5175	<desc>
5176	New property value.
5177	</desc>
5178	</param>
5179	</method>
5180
5181	<method name="saveSettings">
5182	<desc>
5183	Saves any changes to machine settings made since the session
5184	has been opened or a new machine has been created, or since the
5185	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5186	For registered machines, new settings become visible to all
5187	other VirtualBox clients after successful invocation of this
5188	method.
5189	<note>
5190	The method sends <link to="IMachineDataChangedEvent"/>
5191	notification event after the configuration has been successfully
5192	saved (only for registered machines).
5193	</note>
5194	<note>
5195	Calling this method is only valid on instances returned
5196	by <link to="ISession::machine"/> and on new machines
5197	created by <link to="IVirtualBox::createMachine"/> but not
5198	yet registered, or on unregistered machines after calling
5199	<link to="IMachine::unregister"/>.
5200	</note>
5201
5202	<result name="VBOX_E_FILE_ERROR">
5203	Settings file not accessible.
5204	</result>
5205	<result name="VBOX_E_XML_ERROR">
5206	Could not parse the settings file.
5207	</result>
5208	<result name="E_ACCESSDENIED">
5209	Modification request refused.
5210	</result>
5211
5212	</desc>
5213	</method>
5214
5215	<method name="discardSettings">
5216	<desc>
5217	Discards any changes to the machine settings made since the session
5218	has been opened or since the last call to <link to="#saveSettings"/>
5219	or <link to="#discardSettings"/>.
5220	<note>
5221	Calling this method is only valid on instances returned
5222	by <link to="ISession::machine"/> and on new machines
5223	created by <link to="IVirtualBox::createMachine"/> or
5224	opened by <link to="IVirtualBox::openMachine"/> but not
5225	yet registered, or on unregistered machines after calling
5226	<link to="IMachine::unregister"/>.
5227	</note>
5228
5229	<result name="VBOX_E_INVALID_VM_STATE">
5230	Virtual machine is not mutable.
5231	</result>
5232
5233	</desc>
5234	</method>
5235
5236	<method name="unregister">
5237	<desc>
5238	Unregisters the machine, which must have been previously registered using
5239	<link to="IVirtualBox::registerMachine"/>, and optionally do additional
5240	cleanup before the machine is unregistered.
5241
5242	This method does not delete any files. It only changes the machine configuration and
5243	the list of registered machines in the VirtualBox object. To delete the files which
5244	belonged to the machine, including the XML file of the machine itself, call
5245	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5246	from this method.
5247
5248	How thoroughly this method cleans up the machine configuration before unregistering
5249	the machine depends on the @a cleanupMode argument.
5250
5251	<ul>
5252	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5253	cleanup will be performed. The call will fail if the machine is in "Saved" state
5254	or has any snapshots or any media attached (see <link to="IMediumAttachment" />.
5255	It is the responsibility of the caller to delete all such configuration in this mode.
5256	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5257	which it replaces.</li>
5258	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5259	state or if it has snapshots or media attached. All media attached to the current machine
5260	state or in snapshots will be detached. No medium objects will be returned; all of the
5261	machine's media will remain open.</li>
5262	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5263	except that all the hard disk medium objects which were detached from the machine will
5264	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5265	API for closing and deletion.</li>
5266	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5267	that all media will be returned in the array, including removeable media like DVDs and
5268	floppies. This might be useful if the user wants to inspect in detail which media were
5269	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5270	in that case because users will typically want to preserve ISO and RAW image files.</li>
5271	</ul>
5272
5273	This API does not verify whether the media files returned in the array are still
5274	attached to other machines (i.e. shared between several machines). If such a shared
5275	image is passed to <link to="#delete" /> however, closing the image will fail there
5276	and the image will be silently skipped.
5277
5278	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5279	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5280	deleted with all its saved states and hard disk images, but images for removeable
5281	drives (such as ISO and RAW files) will remain on disk.
5282
5283	The call will fail if the machine is currently locked (see <link to="ISession" />).
5284	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5285	before unregistering it.
5286
5287	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5288	is fired.
5289
5290	<note>
5291	If the given machine is inaccessible (see <link to="#accessible"/>), it
5292	will be unregistered and fully uninitialized right afterwards. As a result,
5293	the returned machine object will be unusable and an attempt to call
5294	<b>any</b> method will return the "Object not ready" error.
5295	</note>
5296
5297	<result name="VBOX_E_INVALID_OBJECT_STATE">
5298	Machine is currently locked for a session.
5299	</result>
5300	</desc>
5301
5302	<param name="cleanupMode" type="CleanupMode" dir="in">
5303	<desc>How to clean up after the machine has been unregistered.</desc>
5304	</param>
5305	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5306	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5307	</param>
5308	</method>
5309
5310	<method name="delete">
5311	<desc>
5312	Deletes the files associated with this machine from disk. If medium objects are passed
5313	in with the @a aMedia argument, they are closed and, if closing was successful, their
5314	storage files are deleted as well. For convenience, this array of media files can be
5315	the same as the one returned from a previous <link to="#unregister" /> call.
5316
5317	This method must only be called on machines which are either write-locked (i.e. on instances
5318	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5319	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5320	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5321
5322	The following files will be deleted by this method:
5323	<ul>
5324	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5325	argument other than "UnregisterOnly", this will delete all saved state files that
5326	the machine had in use; possibly one if the machine was in "Saved" state and one
5327	for each online snapshot that the machine had.</li>
5328	<li>On each medium object passed in the @a aMedia array, this will call
5329	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5330	medium's storage on disk. Since the close() call will fail if the medium is still
5331	in use, e.g. because it is still attached to a second machine; in that case the
5332	storage will not be deleted.</li>
5333	<li>Finally, the machine's own XML file will be deleted.</li>
5334	</ul>
5335
5336	Since deleting large disk image files can be a time-consuming I/O operation, this
5337	method operates asynchronously and returns an IProgress object to allow the caller
5338	to monitor the progress. There will be one sub-operation for each file that is
5339	being deleted (saved state or medium storage file).
5340
5341	<note>
5342	<link to="#settingsModified"/> will return @c true after this
5343	method successfully returns.
5344	</note>
5345
5346	<result name="VBOX_E_INVALID_VM_STATE">
5347	Machine is registered but not write-locked.
5348	</result>
5349	<result name="VBOX_E_IPRT_ERROR">
5350	Could not delete the settings file.
5351	</result>
5352	</desc>
5353	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5354	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5355	</param>
5356	<param name="aProgress" type="IProgress" dir="return">
5357	<desc>Progress object to track the operation completion.</desc>
5358	</param>
5359	</method>
5360
5361	<method name="export">
5362	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5363	steps required to export VirtualBox machines to OVF.
5364	</desc>
5365
5366	<param name="aAppliance" type="IAppliance" dir="in">
5367	<desc>Appliance to export this machine to.</desc>
5368	</param>
5369	<param name="location" type="wstring" dir="in">
5370	<desc>The target location.</desc>
5371	</param>
5372	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5373	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5374	</param>
5375	</method >
5376
5377	<method name="findSnapshot">
5378	<desc>
5379	Returns a snapshot of this machine with the given name or UUID.
5380
5381	Returns a snapshot of this machine with the given UUID.
5382	A @c null argument can be used to obtain the first snapshot
5383	taken on this machine. This is useful if you want to traverse
5384	the whole tree of snapshots starting from the root.
5385
5386	<result name="VBOX_E_OBJECT_NOT_FOUND">
5387	Virtual machine has no snapshots or snapshot not found.
5388	</result>
5389
5390	</desc>
5391	<param name="nameOrId" type="wstring" dir="in">
5392	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5393	</param>
5394	<param name="snapshot" type="ISnapshot" dir="return">
5395	<desc>Snapshot object with the given name.</desc>
5396	</param>
5397	</method>
5398
5399	<method name="createSharedFolder">
5400	<desc>
5401	Creates a new permanent shared folder by associating the given logical
5402	name with the given host path, adds it to the collection of shared
5403	folders and starts sharing it. Refer to the description of
5404	<link to="ISharedFolder"/> to read more about logical names.
5405
5406	<result name="VBOX_E_OBJECT_IN_USE">
5407	Shared folder already exists.
5408	</result>
5409	<result name="VBOX_E_FILE_ERROR">
5410	Shared folder @a hostPath not accessible.
5411	</result>
5412
5413	</desc>
5414	<param name="name" type="wstring" dir="in">
5415	<desc>Unique logical name of the shared folder.</desc>
5416	</param>
5417	<param name="hostPath" type="wstring" dir="in">
5418	<desc>Full path to the shared folder in the host file system.</desc>
5419	</param>
5420	<param name="writable" type="boolean" dir="in">
5421	<desc>Whether the share is writable or readonly.</desc>
5422	</param>
5423	<param name="automount" type="boolean" dir="in">
5424	<desc>Whether the share gets automatically mounted by the guest
5425	or not.</desc>
5426	</param>
5427	</method>
5428
5429	<method name="removeSharedFolder">
5430	<desc>
5431	Removes the permanent shared folder with the given name previously
5432	created by <link to="#createSharedFolder"/> from the collection of
5433	shared folders and stops sharing it.
5434
5435	<result name="VBOX_E_INVALID_VM_STATE">
5436	Virtual machine is not mutable.
5437	</result>
5438	<result name="VBOX_E_OBJECT_NOT_FOUND">
5439	Shared folder @a name does not exist.
5440	</result>
5441
5442	</desc>
5443	<param name="name" type="wstring" dir="in">
5444	<desc>Logical name of the shared folder to remove.</desc>
5445	</param>
5446	</method>
5447
5448	<method name="canShowConsoleWindow">
5449	<desc>
5450	Returns @c true if the VM console process can activate the
5451	console window and bring it to foreground on the desktop of
5452	the host PC.
5453	<note>
5454	This method will fail if a session for this machine is not
5455	currently open.
5456	</note>
5457
5458	<result name="VBOX_E_INVALID_VM_STATE">
5459	Machine session is not open.
5460	</result>
5461
5462	</desc>
5463	<param name="canShow" type="boolean" dir="return">
5464	<desc>
5465	@c true if the console window can be shown and @c false otherwise.
5466	</desc>
5467	</param>
5468	</method>
5469
5470	<method name="showConsoleWindow">
5471	<desc>
5472	Activates the console window and brings it to foreground on
5473	the desktop of the host PC. Many modern window managers on
5474	many platforms implement some sort of focus stealing
5475	prevention logic, so that it may be impossible to activate
5476	a window without the help of the currently active
5477	application. In this case, this method will return a non-zero
5478	identifier that represents the top-level window of the VM
5479	console process. The caller, if it represents a currently
5480	active process, is responsible to use this identifier (in a
5481	platform-dependent manner) to perform actual window
5482	activation.
5483	<note>
5484	This method will fail if a session for this machine is not
5485	currently open.
5486	</note>
5487
5488	<result name="VBOX_E_INVALID_VM_STATE">
5489	Machine session is not open.
5490	</result>
5491
5492	</desc>
5493	<param name="winId" type="long long" dir="return">
5494	<desc>
5495	Platform-dependent identifier of the top-level VM console
5496	window, or zero if this method has performed all actions
5497	necessary to implement the <i>show window</i> semantics for
5498	the given platform and/or VirtualBox front-end.
5499	</desc>
5500	</param>
5501	</method>
5502
5503	<method name="getGuestProperty" const="yes">
5504	<desc>
5505	Reads an entry from the machine's guest property store.
5506
5507	<result name="VBOX_E_INVALID_VM_STATE">
5508	Machine session is not open.
5509	</result>
5510
5511	</desc>
5512	<param name="name" type="wstring" dir="in">
5513	<desc>
5514	The name of the property to read.
5515	</desc>
5516	</param>
5517	<param name="value" type="wstring" dir="out">
5518	<desc>
5519	The value of the property. If the property does not exist then this
5520	will be empty.
5521	</desc>
5522	</param>
5523	<param name="timestamp" type="long long" dir="out">
5524	<desc>
5525	The time at which the property was last modified, as seen by the
5526	server process.
5527	</desc>
5528	</param>
5529	<param name="flags" type="wstring" dir="out">
5530	<desc>
5531	Additional property parameters, passed as a comma-separated list of
5532	"name=value" type entries.
5533	</desc>
5534	</param>
5535	</method>
5536
5537	<method name="getGuestPropertyValue" const="yes">
5538	<desc>
5539	Reads a value from the machine's guest property store.
5540
5541	<result name="VBOX_E_INVALID_VM_STATE">
5542	Machine session is not open.
5543	</result>
5544
5545	</desc>
5546	<param name="property" type="wstring" dir="in">
5547	<desc>
5548	The name of the property to read.
5549	</desc>
5550	</param>
5551	<param name="value" type="wstring" dir="return">
5552	<desc>
5553	The value of the property. If the property does not exist then this
5554	will be empty.
5555	</desc>
5556	</param>
5557	</method>
5558
5559	<method name="getGuestPropertyTimestamp" const="yes">
5560	<desc>
5561	Reads a property timestamp from the machine's guest property store.
5562
5563	<result name="VBOX_E_INVALID_VM_STATE">
5564	Machine session is not open.
5565	</result>
5566
5567	</desc>
5568	<param name="property" type="wstring" dir="in">
5569	<desc>
5570	The name of the property to read.
5571	</desc>
5572	</param>
5573	<param name="value" type="long long" dir="return">
5574	<desc>
5575	The timestamp. If the property does not exist then this will be
5576	empty.
5577	</desc>
5578	</param>
5579	</method>
5580
5581	<method name="setGuestProperty">
5582	<desc>
5583	Sets, changes or deletes an entry in the machine's guest property
5584	store.
5585
5586	<result name="E_ACCESSDENIED">
5587	Property cannot be changed.
5588	</result>
5589	<result name="E_INVALIDARG">
5590	Invalid @a flags.
5591	</result>
5592	<result name="VBOX_E_INVALID_VM_STATE">
5593	Virtual machine is not mutable or session not open.
5594	</result>
5595	<result name="VBOX_E_INVALID_OBJECT_STATE">
5596	Cannot set transient property when machine not running.
5597	</result>
5598
5599	</desc>
5600	<param name="property" type="wstring" dir="in">
5601	<desc>
5602	The name of the property to set, change or delete.
5603	</desc>
5604	</param>
5605	<param name="value" type="wstring" dir="in">
5606	<desc>
5607	The new value of the property to set, change or delete. If the
5608	property does not yet exist and value is non-empty, it will be
5609	created. If the value is @c null or empty, the property will be
5610	deleted if it exists.
5611	</desc>
5612	</param>
5613	<param name="flags" type="wstring" dir="in">
5614	<desc>
5615	Additional property parameters, passed as a comma-separated list of
5616	"name=value" type entries.
5617	</desc>
5618	</param>
5619	</method>
5620
5621	<method name="setGuestPropertyValue">
5622	<desc>
5623	Sets, changes or deletes a value in the machine's guest property
5624	store. The flags field will be left unchanged or created empty for a
5625	new property.
5626
5627	<result name="E_ACCESSDENIED">
5628	Property cannot be changed.
5629	</result>
5630	<result name="VBOX_E_INVALID_VM_STATE">
5631	Virtual machine is not mutable or session not open.
5632	</result>
5633	<result name="VBOX_E_INVALID_OBJECT_STATE">
5634	Cannot set transient property when machine not running.
5635	</result>
5636	</desc>
5637
5638	<param name="property" type="wstring" dir="in">
5639	<desc>
5640	The name of the property to set, change or delete.
5641	</desc>
5642	</param>
5643	<param name="value" type="wstring" dir="in">
5644	<desc>
5645	The new value of the property to set, change or delete. If the
5646	property does not yet exist and value is non-empty, it will be
5647	created. If the value is @c null or empty, the property will be
5648	deleted if it exists.
5649	</desc>
5650	</param>
5651	</method>
5652
5653	<method name="enumerateGuestProperties">
5654	<desc>
5655	Return a list of the guest properties matching a set of patterns along
5656	with their values, time stamps and flags.
5657	</desc>
5658	<param name="patterns" type="wstring" dir="in">
5659	<desc>
5660	The patterns to match the properties against, separated by '\|'
5661	characters. If this is empty or @c null, all properties will match.
5662	</desc>
5663	</param>
5664	<param name="name" type="wstring" dir="out" safearray="yes">
5665	<desc>
5666	The names of the properties returned.
5667	</desc>
5668	</param>
5669	<param name="value" type="wstring" dir="out" safearray="yes">
5670	<desc>
5671	The values of the properties returned. The array entries match the
5672	corresponding entries in the @a name array.
5673	</desc>
5674	</param>
5675	<param name="timestamp" type="long long" dir="out" safearray="yes">
5676	<desc>
5677	The time stamps of the properties returned. The array entries match
5678	the corresponding entries in the @a name array.
5679	</desc>
5680	</param>
5681	<param name="flags" type="wstring" dir="out" safearray="yes">
5682	<desc>
5683	The flags of the properties returned. The array entries match the
5684	corresponding entries in the @a name array.
5685	</desc>
5686	</param>
5687	</method>
5688
5689	<method name="querySavedGuestSize">
5690	<desc>
5691	Returns the guest dimensions from the saved state.
5692	</desc>
5693	<param name="screenId" type="unsigned long" dir="in">
5694	<desc>
5695	Saved guest screen to query info from.
5696	</desc>
5697	</param>
5698	<param name="width" type="unsigned long" dir="out">
5699	<desc>
5700	Guest width at the time of the saved state was taken.
5701	</desc>
5702	</param>
5703	<param name="height" type="unsigned long" dir="out">
5704	<desc>
5705	Guest height at the time of the saved state was taken.
5706	</desc>
5707	</param>
5708	</method>
5709
5710	<method name="querySavedThumbnailSize">
5711	<desc>
5712	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5713	</desc>
5714	<param name="screenId" type="unsigned long" dir="in">
5715	<desc>
5716	Saved guest screen to query info from.
5717	</desc>
5718	</param>
5719	<param name="size" type="unsigned long" dir="out">
5720	<desc>
5721	Size of buffer required to store the bitmap.
5722	</desc>
5723	</param>
5724	<param name="width" type="unsigned long" dir="out">
5725	<desc>
5726	Bitmap width.
5727	</desc>
5728	</param>
5729	<param name="height" type="unsigned long" dir="out">
5730	<desc>
5731	Bitmap height.
5732	</desc>
5733	</param>
5734	</method>
5735
5736	<method name="readSavedThumbnailToArray">
5737	<desc>
5738	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5739	</desc>
5740	<param name="screenId" type="unsigned long" dir="in">
5741	<desc>
5742	Saved guest screen to read from.
5743	</desc>
5744	</param>
5745	<param name="BGR" type="boolean" dir="in">
5746	<desc>
5747	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5748	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5749	</desc>
5750	</param>
5751	<param name="width" type="unsigned long" dir="out">
5752	<desc>
5753	Bitmap width.
5754	</desc>
5755	</param>
5756	<param name="height" type="unsigned long" dir="out">
5757	<desc>
5758	Bitmap height.
5759	</desc>
5760	</param>
5761	<param name="data" type="octet" safearray="yes" dir="return">
5762	<desc>
5763	Array with resulting bitmap data.
5764	</desc>
5765	</param>
5766	</method>
5767
5768	<method name="readSavedThumbnailPNGToArray">
5769	<desc>
5770	Thumbnail in PNG format is retrieved to an array of bytes.
5771	</desc>
5772	<param name="screenId" type="unsigned long" dir="in">
5773	<desc>
5774	Saved guest screen to read from.
5775	</desc>
5776	</param>
5777	<param name="width" type="unsigned long" dir="out">
5778	<desc>
5779	Image width.
5780	</desc>
5781	</param>
5782	<param name="height" type="unsigned long" dir="out">
5783	<desc>
5784	Image height.
5785	</desc>
5786	</param>
5787	<param name="data" type="octet" dir="return" safearray="yes">
5788	<desc>
5789	Array with resulting PNG data.
5790	</desc>
5791	</param>
5792	</method>
5793
5794	<method name="querySavedScreenshotPNGSize">
5795	<desc>
5796	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5797	</desc>
5798	<param name="screenId" type="unsigned long" dir="in">
5799	<desc>
5800	Saved guest screen to query info from.
5801	</desc>
5802	</param>
5803	<param name="size" type="unsigned long" dir="out">
5804	<desc>
5805	Size of buffer required to store the PNG binary data.
5806	</desc>
5807	</param>
5808	<param name="width" type="unsigned long" dir="out">
5809	<desc>
5810	Image width.
5811	</desc>
5812	</param>
5813	<param name="height" type="unsigned long" dir="out">
5814	<desc>
5815	Image height.
5816	</desc>
5817	</param>
5818	</method>
5819
5820	<method name="readSavedScreenshotPNGToArray">
5821	<desc>
5822	Screenshot in PNG format is retrieved to an array of bytes.
5823	</desc>
5824	<param name="screenId" type="unsigned long" dir="in">
5825	<desc>
5826	Saved guest screen to read from.
5827	</desc>
5828	</param>
5829	<param name="width" type="unsigned long" dir="out">
5830	<desc>
5831	Image width.
5832	</desc>
5833	</param>
5834	<param name="height" type="unsigned long" dir="out">
5835	<desc>
5836	Image height.
5837	</desc>
5838	</param>
5839	<param name="data" type="octet" dir="return" safearray="yes">
5840	<desc>
5841	Array with resulting PNG data.
5842	</desc>
5843	</param>
5844	</method>
5845
5846	<method name="hotPlugCPU">
5847	<desc>
5848	Plugs a CPU into the machine.
5849	</desc>
5850	<param name="cpu" type="unsigned long" dir="in">
5851	<desc>
5852	The CPU id to insert.
5853	</desc>
5854	</param>
5855	</method>
5856
5857	<method name="hotUnplugCPU">
5858	<desc>
5859	Removes a CPU from the machine.
5860	</desc>
5861	<param name="cpu" type="unsigned long" dir="in">
5862	<desc>
5863	The CPU id to remove.
5864	</desc>
5865	</param>
5866	</method>
5867
5868	<method name="getCPUStatus">
5869	<desc>
5870	Returns the current status of the given CPU.
5871	</desc>
5872	<param name="cpu" type="unsigned long" dir="in">
5873	<desc>
5874	The CPU id to check for.
5875	</desc>
5876	</param>
5877	<param name="attached" type="boolean" dir="return">
5878	<desc>
5879	Status of the CPU.
5880	</desc>
5881	</param>
5882	</method>
5883
5884	<method name="queryLogFilename">
5885	<desc>
5886	Queries for the VM log file name of an given index. Returns an empty
5887	string if a log file with that index doesn't exists.
5888	</desc>
5889	<param name="idx" type="unsigned long" dir="in">
5890	<desc>
5891	Which log file name to query. 0=current log file.
5892	</desc>
5893	</param>
5894	<param name="filename" type="wstring" dir="return">
5895	<desc>
5896	On return the full path to the log file or an empty string on error.
5897	</desc>
5898	</param>
5899	</method>
5900
5901	<method name="readLog">
5902	<desc>
5903	Reads the VM log file. The chunk size is limited, so even if you
5904	ask for a big piece there might be less data returned.
5905	</desc>
5906	<param name="idx" type="unsigned long" dir="in">
5907	<desc>
5908	Which log file to read. 0=current log file.
5909	</desc>
5910	</param>
5911	<param name="offset" type="long long" dir="in">
5912	<desc>
5913	Offset in the log file.
5914	</desc>
5915	</param>
5916	<param name="size" type="long long" dir="in">
5917	<desc>
5918	Chunk size to read in the log file.
5919	</desc>
5920	</param>
5921	<param name="data" type="octet" dir="return" safearray="yes">
5922	<desc>
5923	Data read from the log file. A data size of 0 means end of file
5924	if the requested chunk size was not 0. This is the unprocessed
5925	file data, i.e. the line ending style depends on the platform of
5926	the system the server is running on.
5927	</desc>
5928	</param>
5929	</method>
5930	</interface>
5931
5932	<!--
5933	// IConsole
5934	/////////////////////////////////////////////////////////////////////////
5935	-->
5936
5937	<interface
5938	name="IVRDEServerInfo" extends="$unknown"
5939	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5940	wsmap="struct"
5941	>
5942	<desc>
5943	Contains information about the remote desktop (VRDE) server capabilities and status.
5944	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5945	</desc>
5946
5947	<attribute name="active" type="boolean" readonly="yes">
5948	<desc>
5949	Whether the remote desktop connection is active.
5950	</desc>
5951	</attribute>
5952
5953	<attribute name="port" type="long" readonly="yes">
5954	<desc>
5955	VRDE server port number. If this property is equal to <tt>0</tt>, then
5956	the VRDE server failed to start, usually because there are no free IP
5957	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5958	server has not yet been started.
5959	</desc>
5960	</attribute>
5961
5962	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5963	<desc>
5964	How many times a client connected.
5965	</desc>
5966	</attribute>
5967
5968	<attribute name="beginTime" type="long long" readonly="yes">
5969	<desc>
5970	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5971	</desc>
5972	</attribute>
5973
5974	<attribute name="endTime" type="long long" readonly="yes">
5975	<desc>
5976	When the last connection was terminated or the current time, if
5977	connection is still active, in milliseconds since 1970-01-01 UTC.
5978	</desc>
5979	</attribute>
5980
5981	<attribute name="bytesSent" type="long long" readonly="yes">
5982	<desc>
5983	How many bytes were sent in last or current, if still active, connection.
5984	</desc>
5985	</attribute>
5986
5987	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5988	<desc>
5989	How many bytes were sent in all connections.
5990	</desc>
5991	</attribute>
5992
5993	<attribute name="bytesReceived" type="long long" readonly="yes">
5994	<desc>
5995	How many bytes were received in last or current, if still active, connection.
5996	</desc>
5997	</attribute>
5998
5999	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6000	<desc>
6001	How many bytes were received in all connections.
6002	</desc>
6003	</attribute>
6004
6005	<attribute name="user" type="wstring" readonly="yes">
6006	<desc>
6007	Login user name supplied by the client.
6008	</desc>
6009	</attribute>
6010
6011	<attribute name="domain" type="wstring" readonly="yes">
6012	<desc>
6013	Login domain name supplied by the client.
6014	</desc>
6015	</attribute>
6016
6017	<attribute name="clientName" type="wstring" readonly="yes">
6018	<desc>
6019	The client name supplied by the client.
6020	</desc>
6021	</attribute>
6022
6023	<attribute name="clientIP" type="wstring" readonly="yes">
6024	<desc>
6025	The IP address of the client.
6026	</desc>
6027	</attribute>
6028
6029	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6030	<desc>
6031	The client software version number.
6032	</desc>
6033	</attribute>
6034
6035	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6036	<desc>
6037	Public key exchange method used when connection was established.
6038	Values: 0 - RDP4 public key exchange scheme.
6039	1 - X509 certificates were sent to client.
6040	</desc>
6041	</attribute>
6042
6043	</interface>
6044
6045	<interface
6046	name="IConsole" extends="$unknown"
6047	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
6048	wsmap="managed"
6049	>
6050	<desc>
6051	The IConsole interface represents an interface to control virtual
6052	machine execution.
6053
6054	A console object gets created when a machine has been locked for a
6055	particular session (client process) using <link to="IMachine::lockMachine" />
6056	or <link to="IMachine::launchVMProcess"/>. The console object can
6057	then be found in the session's <link to="ISession::console" /> attribute.
6058
6059	Methods of the IConsole interface allow the caller to query the current
6060	virtual machine execution state, pause the machine or power it down, save
6061	the machine state or take a snapshot, attach and detach removable media
6062	and so on.
6063
6064	<see>ISession</see>
6065	</desc>
6066
6067	<attribute name="machine" type="IMachine" readonly="yes">
6068	<desc>
6069	Machine object for this console session.
6070	<note>
6071	This is a convenience property, it has the same value as
6072	<link to="ISession::machine"/> of the corresponding session
6073	object.
6074	</note>
6075	</desc>
6076	</attribute>
6077
6078	<attribute name="state" type="MachineState" readonly="yes">
6079	<desc>
6080	Current execution state of the machine.
6081	<note>
6082	This property always returns the same value as the corresponding
6083	property of the IMachine object for this console session.
6084	For the process that owns (executes) the VM, this is the
6085	preferable way of querying the VM state, because no IPC
6086	calls are made.
6087	</note>
6088	</desc>
6089	</attribute>
6090
6091	<attribute name="guest" type="IGuest" readonly="yes">
6092	<desc>Guest object.</desc>
6093	</attribute>
6094
6095	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6096	<desc>
6097	Virtual keyboard object.
6098	<note>
6099	If the machine is not running, any attempt to use
6100	the returned object will result in an error.
6101	</note>
6102	</desc>
6103	</attribute>
6104
6105	<attribute name="mouse" type="IMouse" readonly="yes">
6106	<desc>
6107	Virtual mouse object.
6108	<note>
6109	If the machine is not running, any attempt to use
6110	the returned object will result in an error.
6111	</note>
6112	</desc>
6113	</attribute>
6114
6115	<attribute name="display" type="IDisplay" readonly="yes">
6116	<desc>Virtual display object.
6117	<note>
6118	If the machine is not running, any attempt to use
6119	the returned object will result in an error.
6120	</note>
6121	</desc>
6122	</attribute>
6123
6124	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6125	<desc>Debugging interface.</desc>
6126	</attribute>
6127
6128	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6129	<desc>
6130	Collection of USB devices currently attached to the virtual
6131	USB controller.
6132	<note>
6133	The collection is empty if the machine is not running.
6134	</note>
6135	</desc>
6136	</attribute>
6137
6138	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6139	<desc>
6140	List of USB devices currently attached to the remote VRDE client.
6141	Once a new device is physically attached to the remote host computer,
6142	it appears in this list and remains there until detached.
6143	</desc>
6144	</attribute>
6145
6146	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6147	<desc>
6148	Collection of shared folders for the current session. These folders
6149	are called transient shared folders because they are available to the
6150	guest OS running inside the associated virtual machine only for the
6151	duration of the session (as opposed to
6152	<link to="IMachine::sharedFolders"/> which represent permanent shared
6153	folders). When the session is closed (e.g. the machine is powered down),
6154	these folders are automatically discarded.
6155
6156	New shared folders are added to the collection using
6157	<link to="#createSharedFolder"/>. Existing shared folders can be
6158	removed using <link to="#removeSharedFolder"/>.
6159	</desc>
6160	</attribute>
6161
6162	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6163	<desc>
6164	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6165	</desc>
6166	</attribute>
6167
6168	<attribute name="eventSource" type="IEventSource" readonly="yes">
6169	<desc>
6170	Event source for console events.
6171	</desc>
6172	</attribute>
6173
6174	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6175	<desc>Array of PCI devices attached to this machine.</desc>
6176	</attribute>
6177
6178	<method name="powerUp">
6179	<desc>
6180	Starts the virtual machine execution using the current machine
6181	state (that is, its current execution state, current settings and
6182	current storage devices).
6183
6184	<note>
6185	This method is only useful for front-ends that want to actually
6186	execute virtual machines in their own process (like the VirtualBox
6187	or VBoxSDL front-ends). Unless you are intending to write such a
6188	front-end, do not call this method. If you simply want to
6189	start virtual machine execution using one of the existing front-ends
6190	(for example the VirtualBox GUI or headless server), use
6191	<link to="IMachine::launchVMProcess"/> instead; these
6192	front-ends will power up the machine automatically for you.
6193	</note>
6194
6195	If the machine is powered off or aborted, the execution will
6196	start from the beginning (as if the real hardware were just
6197	powered on).
6198
6199	If the machine is in the <link to="MachineState_Saved"/> state,
6200	it will continue its execution the point where the state has
6201	been saved.
6202
6203	If the machine <link to="IMachine::teleporterEnabled"/> property is
6204	enabled on the machine being powered up, the machine will wait for an
6205	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6206	state. The returned progress object will have at least three
6207	operations where the last three are defined as: (1) powering up and
6208	starting TCP server, (2) waiting for incoming teleportations, and
6209	(3) perform teleportation. These operations will be reflected as the
6210	last three operations of the progress objected returned by
6211	<link to="IMachine::launchVMProcess"/> as well.
6212
6213	<see>#saveState</see>
6214
6215	<result name="VBOX_E_INVALID_VM_STATE">
6216	Virtual machine already running.
6217	</result>
6218	<result name="VBOX_E_HOST_ERROR">
6219	Host interface does not exist or name not set.
6220	</result>
6221	<result name="VBOX_E_FILE_ERROR">
6222	Invalid saved state file.
6223	</result>
6224	</desc>
6225	<param name="progress" type="IProgress" dir="return">
6226	<desc>Progress object to track the operation completion.</desc>
6227	</param>
6228	</method>
6229
6230	<method name="powerUpPaused">
6231	<desc>
6232	Identical to powerUp except that the VM will enter the
6233	<link to="MachineState_Paused"/> state, instead of
6234	<link to="MachineState_Running"/>.
6235
6236	<see>#powerUp</see>
6237	<result name="VBOX_E_INVALID_VM_STATE">
6238	Virtual machine already running.
6239	</result>
6240	<result name="VBOX_E_HOST_ERROR">
6241	Host interface does not exist or name not set.
6242	</result>
6243	<result name="VBOX_E_FILE_ERROR">
6244	Invalid saved state file.
6245	</result>
6246	</desc>
6247	<param name="progress" type="IProgress" dir="return">
6248	<desc>Progress object to track the operation completion.</desc>
6249	</param>
6250	</method>
6251
6252	<method name="powerDown">
6253	<desc>
6254	Initiates the power down procedure to stop the virtual machine
6255	execution.
6256
6257	The completion of the power down procedure is tracked using the returned
6258	IProgress object. After the operation is complete, the machine will go
6259	to the PoweredOff state.
6260	<result name="VBOX_E_INVALID_VM_STATE">
6261	Virtual machine must be Running, Paused or Stuck to be powered down.
6262	</result>
6263	</desc>
6264	<param name="progress" type="IProgress" dir="return">
6265	<desc>Progress object to track the operation completion.</desc>
6266	</param>
6267	</method>
6268
6269	<method name="reset">
6270	<desc>Resets the virtual machine.
6271	<result name="VBOX_E_INVALID_VM_STATE">
6272	Virtual machine not in Running state.
6273	</result>
6274	<result name="VBOX_E_VM_ERROR">
6275	Virtual machine error in reset operation.
6276	</result>
6277	</desc>
6278	</method>
6279
6280	<method name="pause">
6281	<desc>Pauses the virtual machine execution.
6282	<result name="VBOX_E_INVALID_VM_STATE">
6283	Virtual machine not in Running state.
6284	</result>
6285	<result name="VBOX_E_VM_ERROR">
6286	Virtual machine error in suspend operation.
6287	</result>
6288	</desc>
6289	</method>
6290
6291	<method name="resume">
6292	<desc>Resumes the virtual machine execution.
6293	<result name="VBOX_E_INVALID_VM_STATE">
6294	Virtual machine not in Paused state.
6295	</result>
6296	<result name="VBOX_E_VM_ERROR">
6297	Virtual machine error in resume operation.
6298	</result>
6299	</desc>
6300	</method>
6301
6302	<method name="powerButton">
6303	<desc>Sends the ACPI power button event to the guest.
6304	<result name="VBOX_E_INVALID_VM_STATE">
6305	Virtual machine not in Running state.
6306	</result>
6307	<result name="VBOX_E_PDM_ERROR">
6308	Controlled power off failed.
6309	</result>
6310	</desc>
6311	</method>
6312
6313	<method name="sleepButton">
6314	<desc>Sends the ACPI sleep button event to the guest.
6315	<result name="VBOX_E_INVALID_VM_STATE">
6316	Virtual machine not in Running state.
6317	</result>
6318	<result name="VBOX_E_PDM_ERROR">
6319	Sending sleep button event failed.
6320	</result>
6321	</desc>
6322	</method>
6323
6324	<method name="getPowerButtonHandled">
6325	<desc>Checks if the last power button event was handled by guest.
6326	<result name="VBOX_E_PDM_ERROR">
6327	Checking if the event was handled by the guest OS failed.
6328	</result>
6329	</desc>
6330	<param name="handled" type="boolean" dir="return"/>
6331	</method>
6332
6333	<method name="getGuestEnteredACPIMode">
6334	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6335	G1 (sleeping). If this method returns @c false, the guest will
6336	most likely not respond to external ACPI events.
6337	<result name="VBOX_E_INVALID_VM_STATE">
6338	Virtual machine not in Running state.
6339	</result>
6340	</desc>
6341	<param name="entered" type="boolean" dir="return"/>
6342	</method>
6343
6344	<method name="saveState">
6345	<desc>
6346	Saves the current execution state of a running virtual machine
6347	and stops its execution.
6348
6349	After this operation completes, the machine will go to the
6350	Saved state. Next time it is powered up, this state will
6351	be restored and the machine will continue its execution from
6352	the place where it was saved.
6353
6354	This operation differs from taking a snapshot to the effect
6355	that it doesn't create new differencing media. Also, once
6356	the machine is powered up from the state saved using this method,
6357	the saved state is deleted, so it will be impossible to return
6358	to this state later.
6359
6360	<note>
6361	On success, this method implicitly calls
6362	<link to="IMachine::saveSettings"/> to save all current machine
6363	settings (including runtime changes to the DVD medium, etc.).
6364	Together with the impossibility to change any VM settings when it is
6365	in the Saved state, this guarantees adequate hardware
6366	configuration of the machine when it is restored from the saved
6367	state file.
6368	</note>
6369
6370	<note>
6371	The machine must be in the Running or Paused state, otherwise
6372	the operation will fail.
6373	</note>
6374	<result name="VBOX_E_INVALID_VM_STATE">
6375	Virtual machine state neither Running nor Paused.
6376	</result>
6377	<result name="VBOX_E_FILE_ERROR">
6378	Failed to create directory for saved state file.
6379	</result>
6380
6381	<see><link to="#takeSnapshot"/></see>
6382	</desc>
6383	<param name="progress" type="IProgress" dir="return">
6384	<desc>Progress object to track the operation completion.</desc>
6385	</param>
6386	</method>
6387
6388	<method name="adoptSavedState">
6389	<desc>
6390	Associates the given saved state file to the virtual machine.
6391
6392	On success, the machine will go to the Saved state. Next time it is
6393	powered up, it will be restored from the adopted saved state and
6394	continue execution from the place where the saved state file was
6395	created.
6396
6397	The specified saved state file path may be absolute or relative to the
6398	folder the VM normally saves the state to (usually,
6399	<link to="IMachine::snapshotFolder"/>).
6400
6401	<note>
6402	It's a caller's responsibility to make sure the given saved state
6403	file is compatible with the settings of this virtual machine that
6404	represent its virtual hardware (memory size, storage disk configuration
6405	etc.). If there is a mismatch, the behavior of the virtual machine
6406	is undefined.
6407	</note>
6408	<result name="VBOX_E_INVALID_VM_STATE">
6409	Virtual machine state neither PoweredOff nor Aborted.
6410	</result>
6411	</desc>
6412	<param name="savedStateFile" type="wstring" dir="in">
6413	<desc>Path to the saved state file to adopt.</desc>
6414	</param>
6415	</method>
6416
6417	<method name="discardSavedState">
6418	<desc>
6419	Forcibly resets the machine to "Powered Off" state if it is
6420	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6421	Next time the machine is powered up, a clean boot will occur.
6422	<note>
6423	This operation is equivalent to resetting or powering off
6424	the machine without doing a proper shutdown of the guest
6425	operating system; as with resetting a running phyiscal
6426	computer, it can can lead to data loss.
6427	</note>
6428	If @a fRemoveFile is @c true, the file in the machine directory
6429	into which the machine state was saved is also deleted. If
6430	this is @c false, then the state can be recovered and later
6431	re-inserted into a machine using <link to="#adoptSavedState" />.
6432	The location of the file can be found in the
6433	<link to="IMachine::stateFilePath" /> attribute.
6434	<result name="VBOX_E_INVALID_VM_STATE">
6435	Virtual machine not in state Saved.
6436	</result>
6437	</desc>
6438	<param name="fRemoveFile" type="boolean" dir="in" >
6439	<desc>Whether to also remove the saved state file.</desc>
6440	</param>
6441	</method>
6442
6443	<method name="getDeviceActivity">
6444	<desc>
6445	Gets the current activity type of a given device or device group.
6446	<result name="E_INVALIDARG">
6447	Invalid device type.
6448	</result>
6449	</desc>
6450	<param name="type" type="DeviceType" dir="in"/>
6451	<param name="activity" type="DeviceActivity" dir="return"/>
6452	</method>
6453
6454	<method name="attachUSBDevice">
6455	<desc>
6456	Attaches a host USB device with the given UUID to the
6457	USB controller of the virtual machine.
6458
6459	The device needs to be in one of the following states:
6460	<link to="USBDeviceState_Busy"/>,
6461	<link to="USBDeviceState_Available"/> or
6462	<link to="USBDeviceState_Held"/>,
6463	otherwise an error is immediately returned.
6464
6465	When the device state is
6466	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6467	be returned if the host computer refuses to release it for some reason.
6468
6469	<see>IUSBController::deviceFilters, USBDeviceState</see>
6470	<result name="VBOX_E_INVALID_VM_STATE">
6471	Virtual machine state neither Running nor Paused.
6472	</result>
6473	<result name="VBOX_E_PDM_ERROR">
6474	Virtual machine does not have a USB controller.
6475	</result>
6476	</desc>
6477	<param name="id" type="uuid" mod="string" dir="in">
6478	<desc>UUID of the host USB device to attach.</desc>
6479	</param>
6480	</method>
6481
6482	<method name="detachUSBDevice">
6483	<desc>
6484	Detaches an USB device with the given UUID from the USB controller
6485	of the virtual machine.
6486
6487	After this method succeeds, the VirtualBox server re-initiates
6488	all USB filters as if the device were just physically attached
6489	to the host, but filters of this machine are ignored to avoid
6490	a possible automatic re-attachment.
6491
6492	<see>IUSBController::deviceFilters, USBDeviceState</see>
6493
6494	<result name="VBOX_E_PDM_ERROR">
6495	Virtual machine does not have a USB controller.
6496	</result>
6497	<result name="E_INVALIDARG">
6498	USB device not attached to this virtual machine.
6499	</result>
6500	</desc>
6501	<param name="id" type="uuid" mod="string" dir="in">
6502	<desc>UUID of the USB device to detach.</desc>
6503	</param>
6504	<param name="device" type="IUSBDevice" dir="return">
6505	<desc>Detached USB device.</desc>
6506	</param>
6507	</method>
6508
6509	<method name="findUSBDeviceByAddress">
6510	<desc>
6511	Searches for a USB device with the given host address.
6512
6513	<result name="VBOX_E_OBJECT_NOT_FOUND">
6514	Given @c name does not correspond to any USB device.
6515	</result>
6516
6517	<see>IUSBDevice::address</see>
6518	</desc>
6519	<param name="name" type="wstring" dir="in">
6520	<desc>
6521	Address of the USB device (as assigned by the host) to
6522	search for.
6523	</desc>
6524	</param>
6525	<param name="device" type="IUSBDevice" dir="return">
6526	<desc>Found USB device object.</desc>
6527	</param>
6528	</method>
6529
6530	<method name="findUSBDeviceById">
6531	<desc>
6532	Searches for a USB device with the given UUID.
6533
6534	<result name="VBOX_E_OBJECT_NOT_FOUND">
6535	Given @c id does not correspond to any USB device.
6536	</result>
6537
6538	<see>IUSBDevice::id</see>
6539	</desc>
6540	<param name="id" type="uuid" mod="string" dir="in">
6541	<desc>UUID of the USB device to search for.</desc>
6542	</param>
6543	<param name="device" type="IUSBDevice" dir="return">
6544	<desc>Found USB device object.</desc>
6545	</param>
6546	</method>
6547
6548	<method name="createSharedFolder">
6549	<desc>
6550	Creates a transient new shared folder by associating the given logical
6551	name with the given host path, adds it to the collection of shared
6552	folders and starts sharing it. Refer to the description of
6553	<link to="ISharedFolder"/> to read more about logical names.
6554
6555	<result name="VBOX_E_INVALID_VM_STATE">
6556	Virtual machine in Saved state or currently changing state.
6557	</result>
6558	<result name="VBOX_E_FILE_ERROR">
6559	Shared folder already exists or not accessible.
6560	</result>
6561	</desc>
6562	<param name="name" type="wstring" dir="in">
6563	<desc>Unique logical name of the shared folder.</desc>
6564	</param>
6565	<param name="hostPath" type="wstring" dir="in">
6566	<desc>Full path to the shared folder in the host file system.</desc>
6567	</param>
6568	<param name="writable" type="boolean" dir="in">
6569	<desc>Whether the share is writable or readonly</desc>
6570	</param>
6571	<param name="automount" type="boolean" dir="in">
6572	<desc>Whether the share gets automatically mounted by the guest
6573	or not.</desc>
6574	</param>
6575	</method>
6576
6577	<method name="removeSharedFolder">
6578	<desc>
6579	Removes a transient shared folder with the given name previously
6580	created by <link to="#createSharedFolder"/> from the collection of
6581	shared folders and stops sharing it.
6582	<result name="VBOX_E_INVALID_VM_STATE">
6583	Virtual machine in Saved state or currently changing state.
6584	</result>
6585	<result name="VBOX_E_FILE_ERROR">
6586	Shared folder does not exists.
6587	</result>
6588	</desc>
6589	<param name="name" type="wstring" dir="in">
6590	<desc>Logical name of the shared folder to remove.</desc>
6591	</param>
6592	</method>
6593
6594	<method name="takeSnapshot">
6595	<desc>
6596	Saves the current execution state
6597	and all settings of the machine and creates differencing images
6598	for all normal (non-independent) media.
6599	See <link to="ISnapshot" /> for an introduction to snapshots.
6600
6601	This method can be called for a PoweredOff, Saved (see
6602	<link to="#saveState"/>), Running or
6603	Paused virtual machine. When the machine is PoweredOff, an
6604	offline snapshot is created. When the machine is Running a live
6605	snapshot is created, and an online snapshot is is created when Paused.
6606
6607	The taken snapshot is always based on the
6608	<link to="IMachine::currentSnapshot">current snapshot</link>
6609	of the associated virtual machine and becomes a new current snapshot.
6610
6611	<note>
6612	This method implicitly calls <link to="IMachine::saveSettings"/> to
6613	save all current machine settings before taking an offline snapshot.
6614	</note>
6615
6616	<result name="VBOX_E_INVALID_VM_STATE">
6617	Virtual machine currently changing state.
6618	</result>
6619	</desc>
6620	<param name="name" type="wstring" dir="in">
6621	<desc>Short name for the snapshot.</desc>
6622	</param>
6623	<param name="description" type="wstring" dir="in">
6624	<desc>Optional description of the snapshot.</desc>
6625	</param>
6626	<param name="progress" type="IProgress" dir="return">
6627	<desc>Progress object to track the operation completion.</desc>
6628	</param>
6629	</method>
6630
6631	<method name="deleteSnapshot">
6632	<desc>
6633	Starts deleting the specified snapshot asynchronously.
6634	See <link to="ISnapshot" /> for an introduction to snapshots.
6635
6636	The execution state and settings of the associated machine stored in
6637	the snapshot will be deleted. The contents of all differencing media of
6638	this snapshot will be merged with the contents of their dependent child
6639	media to keep the medium chain valid (in other words, all changes
6640	represented by media being deleted will be propagated to their child
6641	medium). After that, this snapshot's differencing medium will be
6642	deleted. The parent of this snapshot will become a new parent for all
6643	its child snapshots.
6644
6645	If the deleted snapshot is the current one, its parent snapshot will
6646	become a new current snapshot. The current machine state is not directly
6647	affected in this case, except that currently attached differencing
6648	media based on media of the deleted snapshot will be also merged as
6649	described above.
6650
6651	If the deleted snapshot is the first or current snapshot, then the
6652	respective IMachine attributes will be adjusted. Deleting the current
6653	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6654	to make all current machine settings permanent.
6655
6656	Deleting a snapshot has the following preconditions:
6657
6658	<ul>
6659	<li>Child media of all normal media of the deleted snapshot
6660	must be accessible (see <link to="IMedium::state"/>) for this
6661	operation to succeed. In particular, this means that all virtual
6662	machines whose media are directly or indirectly based on the
6663	media of deleted snapshot must be powered off.</li>
6664
6665	<li>You cannot delete the snapshot if a medium attached to it has
6666	more than once child medium (differencing images) because otherwise
6667	merging would be impossible. This might be the case if there is
6668	more than one child snapshot or differencing images were created
6669	for other reason (e.g. implicitly because of multiple machine
6670	attachments).</li>
6671	</ul>
6672
6673
6674	The virtual machine's <link to="IMachine::state">state</link> is
6675	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6676	"DeletingSnapshotPaused" while this operation is in progress.
6677
6678	<note>
6679	Merging medium contents can be very time and disk space
6680	consuming, if these media are big in size and have many
6681	children. However, if the snapshot being deleted is the last
6682	(head) snapshot on the branch, the operation will be rather
6683	quick.
6684	</note>
6685	<result name="VBOX_E_INVALID_VM_STATE">
6686	The running virtual machine prevents deleting this snapshot. This
6687	happens only in very specific situations, usually snapshots can be
6688	deleted without trouble while a VM is running. The error message
6689	text explains the reason for the failure.
6690	</result>
6691	</desc>
6692	<param name="id" type="uuid" mod="string" dir="in">
6693	<desc>UUID of the snapshot to delete.</desc>
6694	</param>
6695	<param name="progress" type="IProgress" dir="return">
6696	<desc>Progress object to track the operation completion.</desc>
6697	</param>
6698	</method>
6699
6700	<method name="restoreSnapshot">
6701	<desc>
6702	Starts resetting the machine's current state to the state contained
6703	in the given snapshot, asynchronously. All current settings of the
6704	machine will be reset and changes stored in differencing media
6705	will be lost.
6706	See <link to="ISnapshot" /> for an introduction to snapshots.
6707
6708	After this operation is successfully completed, new empty differencing
6709	media are created for all normal media of the machine.
6710
6711	If the given snapshot is an online snapshot, the machine will go to
6712	the <link to="MachineState_Saved"> saved state</link>, so that the
6713	next time it is powered on, the execution state will be restored
6714	from the state of the snapshot.
6715
6716	<note>
6717	The machine must not be running, otherwise the operation will fail.
6718	</note>
6719
6720	<note>
6721	If the machine state is <link to="MachineState_Saved">Saved</link>
6722	prior to this operation, the saved state file will be implicitly
6723	deleted (as if <link to="IConsole::discardSavedState"/> were
6724	called).
6725	</note>
6726
6727	<result name="VBOX_E_INVALID_VM_STATE">
6728	Virtual machine is running.
6729	</result>
6730	</desc>
6731	<param name="snapshot" type="ISnapshot" dir="in">
6732	<desc>The snapshot to restore the VM state from.</desc>
6733	</param>
6734	<param name="progress" type="IProgress" dir="return">
6735	<desc>Progress object to track the operation completion.</desc>
6736	</param>
6737	</method>
6738
6739	<method name="teleport">
6740	<desc>
6741	Teleport the VM to a different host machine or process.
6742
6743	TODO explain the details.
6744
6745	<result name="VBOX_E_INVALID_VM_STATE">
6746	Virtual machine not running or paused.
6747	</result>
6748	</desc>
6749	<param name="hostname" type="wstring" dir="in">
6750	<desc>The name or IP of the host to teleport to.</desc>
6751	</param>
6752	<param name="tcpport" type="unsigned long" dir="in">
6753	<desc>The TCP port to connect to (1..65535).</desc>
6754	</param>
6755	<param name="password" type="wstring" dir="in">
6756	<desc>The password.</desc>
6757	</param>
6758	<param name="maxDowntime" type="unsigned long" dir="in">
6759	<desc>
6760	The maximum allowed downtime given as milliseconds. 0 is not a valid
6761	value. Recommended value: 250 ms.
6762
6763	The higher the value is, the greater the chance for a successful
6764	teleportation. A small value may easily result in the teleportation
6765	process taking hours and eventually fail.
6766
6767	<note>
6768	The current implementation treats this a guideline, not as an
6769	absolute rule.
6770	</note>
6771	</desc>
6772	</param>
6773	<param name="progress" type="IProgress" dir="return">
6774	<desc>Progress object to track the operation completion.</desc>
6775	</param>
6776	</method>
6777
6778	</interface>
6779
6780	<!--
6781	// IHost
6782	/////////////////////////////////////////////////////////////////////////
6783	-->
6784
6785	<enum
6786	name="HostNetworkInterfaceMediumType"
6787	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6788	>
6789	<desc>
6790	Type of encapsulation. Ethernet encapsulation includes both wired and
6791	wireless Ethernet connections.
6792	<see>IHostNetworkInterface</see>
6793	</desc>
6794
6795	<const name="Unknown" value="0">
6796	<desc>
6797	The type of interface cannot be determined.
6798	</desc>
6799	</const>
6800	<const name="Ethernet" value="1">
6801	<desc>
6802	Ethernet frame encapsulation.
6803	</desc>
6804	</const>
6805	<const name="PPP" value="2">
6806	<desc>
6807	Point-to-point protocol encapsulation.
6808	</desc>
6809	</const>
6810	<const name="SLIP" value="3">
6811	<desc>
6812	Serial line IP encapsulation.
6813	</desc>
6814	</const>
6815	</enum>
6816
6817	<enum
6818	name="HostNetworkInterfaceStatus"
6819	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6820	>
6821	<desc>
6822	Current status of the interface.
6823	<see>IHostNetworkInterface</see>
6824	</desc>
6825
6826	<const name="Unknown" value="0">
6827	<desc>
6828	The state of interface cannot be determined.
6829	</desc>
6830	</const>
6831	<const name="Up" value="1">
6832	<desc>
6833	The interface is fully operational.
6834	</desc>
6835	</const>
6836	<const name="Down" value="2">
6837	<desc>
6838	The interface is not functioning.
6839	</desc>
6840	</const>
6841	</enum>
6842
6843	<enum
6844	name="HostNetworkInterfaceType"
6845	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6846	>
6847	<desc>
6848	Network interface type.
6849	</desc>
6850	<const name="Bridged" value="1"/>
6851	<const name="HostOnly" value="2"/>
6852	</enum>
6853
6854	<interface
6855	name="IHostNetworkInterface" extends="$unknown"
6856	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6857	wsmap="managed"
6858	>
6859	<desc>
6860	Represents one of host's network interfaces. IP V6 address and network
6861	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6862	separated by colons.
6863	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6864	</desc>
6865	<attribute name="name" type="wstring" readonly="yes">
6866	<desc>Returns the host network interface name.</desc>
6867	</attribute>
6868
6869	<attribute name="id" type="uuid" mod="string" readonly="yes">
6870	<desc>Returns the interface UUID.</desc>
6871	</attribute>
6872
6873	<attribute name="networkName" type="wstring" readonly="yes">
6874	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6875	</attribute>
6876
6877	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6878	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6879	</attribute>
6880
6881	<attribute name="IPAddress" type="wstring" readonly="yes">
6882	<desc>Returns the IP V4 address of the interface.</desc>
6883	</attribute>
6884
6885	<attribute name="networkMask" type="wstring" readonly="yes">
6886	<desc>Returns the network mask of the interface.</desc>
6887	</attribute>
6888
6889	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6890	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6891	</attribute>
6892
6893	<attribute name="IPV6Address" type="wstring" readonly="yes">
6894	<desc>Returns the IP V6 address of the interface.</desc>
6895	</attribute>
6896
6897	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6898	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6899	</attribute>
6900
6901	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6902	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6903	</attribute>
6904
6905	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6906	<desc>Type of protocol encapsulation used.</desc>
6907	</attribute>
6908
6909	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6910	<desc>Status of the interface.</desc>
6911	</attribute>
6912
6913	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6914	<desc>specifies the host interface type.</desc>
6915	</attribute>
6916
6917	<method name="enableStaticIpConfig">
6918	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6919	<param name="IPAddress" type="wstring" dir="in">
6920	<desc>
6921	IP address.
6922	</desc>
6923	</param>
6924	<param name="networkMask" type="wstring" dir="in">
6925	<desc>
6926	network mask.
6927	</desc>
6928	</param>
6929	</method>
6930
6931	<method name="enableStaticIpConfigV6">
6932	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6933	<param name="IPV6Address" type="wstring" dir="in">
6934	<desc>
6935	IP address.
6936	</desc>
6937	</param>
6938	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6939	<desc>
6940	network mask.
6941	</desc>
6942	</param>
6943	</method>
6944
6945	<method name="enableDynamicIpConfig">
6946	<desc>enables the dynamic IP configuration.</desc>
6947	</method>
6948
6949	<method name="dhcpRediscover">
6950	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6951	</method>
6952
6953	</interface>
6954
6955	<interface
6956	name="IHost" extends="$unknown"
6957	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6958	wsmap="managed"
6959	>
6960	<desc>
6961	The IHost interface represents the physical machine that this VirtualBox
6962	installation runs on.
6963
6964	An object implementing this interface is returned by the
6965	<link to="IVirtualBox::host" /> attribute. This interface contains
6966	read-only information about the host's physical hardware (such as what
6967	processors and disks are available, what the host operating system is,
6968	and so on) and also allows for manipulating some of the host's hardware,
6969	such as global USB device filters and host interface networking.
6970
6971	</desc>
6972	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6973	<desc>List of DVD drives available on the host.</desc>
6974	</attribute>
6975
6976	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6977	<desc>List of floppy drives available on the host.</desc>
6978	</attribute>
6979
6980	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6981	<desc>
6982	List of USB devices currently attached to the host.
6983	Once a new device is physically attached to the host computer,
6984	it appears in this list and remains there until detached.
6985
6986	<note>
6987	If USB functionality is not available in the given edition of
6988	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6989	</note>
6990	</desc>
6991	</attribute>
6992
6993	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6994	<desc>
6995	List of USB device filters in action.
6996	When a new device is physically attached to the host computer,
6997	filters from this list are applied to it (in order they are stored
6998	in the list). The first matched filter will determine the
6999	<link to="IHostUSBDeviceFilter::action">action</link>
7000	performed on the device.
7001
7002	Unless the device is ignored by these filters, filters of all
7003	currently running virtual machines
7004	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7005
7006	<note>
7007	If USB functionality is not available in the given edition of
7008	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7009	</note>
7010
7011	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7012	</desc>
7013	</attribute>
7014
7015	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7016	<desc>List of host network interfaces currently defined on the host.</desc>
7017	</attribute>
7018
7019	<attribute name="processorCount" type="unsigned long" readonly="yes">
7020	<desc>Number of (logical) CPUs installed in the host system.</desc>
7021	</attribute>
7022
7023	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7024	<desc>Number of (logical) CPUs online in the host system.</desc>
7025	</attribute>
7026
7027	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7028	<desc>Number of physical processor cores installed in the host system.</desc>
7029	</attribute>
7030
7031	<method name="getProcessorSpeed">
7032	<desc>Query the (approximate) maximum speed of a specified host CPU in
7033	Megahertz.
7034	</desc>
7035	<param name="cpuId" type="unsigned long" dir="in">
7036	<desc>
7037	Identifier of the CPU.
7038	</desc>
7039	</param>
7040	<param name="speed" type="unsigned long" dir="return">
7041	<desc>
7042	Speed value. 0 is returned if value is not known or @a cpuId is
7043	invalid.
7044	</desc>
7045	</param>
7046	</method>
7047
7048	<method name="getProcessorFeature">
7049	<desc>Query whether a CPU feature is supported or not.</desc>
7050	<param name="feature" type="ProcessorFeature" dir="in">
7051	<desc>
7052	CPU Feature identifier.
7053	</desc>
7054	</param>
7055	<param name="supported" type="boolean" dir="return">
7056	<desc>
7057	Feature is supported or not.
7058	</desc>
7059	</param>
7060	</method>
7061
7062	<method name="getProcessorDescription">
7063	<desc>Query the model string of a specified host CPU.
7064	</desc>
7065	<param name="cpuId" type="unsigned long" dir="in">
7066	<desc>
7067	Identifier of the CPU.
7068	<note>
7069	The current implementation might not necessarily return the
7070	description for this exact CPU.
7071	</note>
7072	</desc>
7073	</param>
7074	<param name="description" type="wstring" dir="return">
7075	<desc>
7076	Model string. An empty string is returned if value is not known or
7077	@a cpuId is invalid.
7078	</desc>
7079	</param>
7080	</method>
7081
7082	<method name="getProcessorCPUIDLeaf">
7083	<desc>
7084	Returns the CPU cpuid information for the specified leaf.
7085	</desc>
7086	<param name="cpuId" type="unsigned long" dir="in">
7087	<desc>
7088	Identifier of the CPU. The CPU most be online.
7089	<note>
7090	The current implementation might not necessarily return the
7091	description for this exact CPU.
7092	</note>
7093	</desc>
7094	</param>
7095	<param name="leaf" type="unsigned long" dir="in">
7096	<desc>
7097	CPUID leaf index (eax).
7098	</desc>
7099	</param>
7100	<param name="subLeaf" type="unsigned long" dir="in">
7101	<desc>
7102	CPUID leaf sub index (ecx). This currently only applies to cache
7103	information on Intel CPUs. Use 0 if retrieving values for
7104	<link to="IMachine::setCPUIDLeaf"/>.
7105	</desc>
7106	</param>
7107	<param name="valEax" type="unsigned long" dir="out">
7108	<desc>
7109	CPUID leaf value for register eax.
7110	</desc>
7111	</param>
7112	<param name="valEbx" type="unsigned long" dir="out">
7113	<desc>
7114	CPUID leaf value for register ebx.
7115	</desc>
7116	</param>
7117	<param name="valEcx" type="unsigned long" dir="out">
7118	<desc>
7119	CPUID leaf value for register ecx.
7120	</desc>
7121	</param>
7122	<param name="valEdx" type="unsigned long" dir="out">
7123	<desc>
7124	CPUID leaf value for register edx.
7125	</desc>
7126	</param>
7127	</method>
7128
7129	<attribute name="memorySize" type="unsigned long" readonly="yes">
7130	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7131	</attribute>
7132
7133	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7134	<desc>Available system memory in the host system.</desc>
7135	</attribute>
7136
7137	<attribute name="operatingSystem" type="wstring" readonly="yes">
7138	<desc>Name of the host system's operating system.</desc>
7139	</attribute>
7140
7141	<attribute name="OSVersion" type="wstring" readonly="yes">
7142	<desc>Host operating system's version string.</desc>
7143	</attribute>
7144
7145	<attribute name="UTCTime" type="long long" readonly="yes">
7146	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7147	</attribute>
7148
7149	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7150	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7151	</attribute>
7152
7153	<method name="createHostOnlyNetworkInterface">
7154	<desc>
7155	Creates a new adapter for Host Only Networking.
7156	<result name="E_INVALIDARG">
7157	Host network interface @a name already exists.
7158	</result>
7159	</desc>
7160	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7161	<desc>
7162	Created host interface object.
7163	</desc>
7164	</param>
7165	<param name="progress" type="IProgress" dir="return">
7166	<desc>
7167	Progress object to track the operation completion.
7168	</desc>
7169	</param>
7170	</method>
7171
7172	<method name="removeHostOnlyNetworkInterface">
7173	<desc>
7174	Removes the given Host Only Networking interface.
7175	<result name="VBOX_E_OBJECT_NOT_FOUND">
7176	No host network interface matching @a id found.
7177	</result>
7178	</desc>
7179	<param name="id" type="uuid" mod="string" dir="in">
7180	<desc>
7181	Adapter GUID.
7182	</desc>
7183	</param>
7184	<param name="progress" type="IProgress" dir="return">
7185	<desc>
7186	Progress object to track the operation completion.
7187	</desc>
7188	</param>
7189	</method>
7190
7191	<method name="createUSBDeviceFilter">
7192	<desc>
7193	Creates a new USB device filter. All attributes except
7194	the filter name are set to empty (any match),
7195	<i>active</i> is @c false (the filter is not active).
7196
7197	The created filter can be added to the list of filters using
7198	<link to="#insertUSBDeviceFilter"/>.
7199
7200	<see>#USBDeviceFilters</see>
7201	</desc>
7202	<param name="name" type="wstring" dir="in">
7203	<desc>
7204	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7205	</desc>
7206	</param>
7207	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7208	<desc>Created filter object.</desc>
7209	</param>
7210	</method>
7211
7212	<method name="insertUSBDeviceFilter">
7213	<desc>
7214	Inserts the given USB device to the specified position
7215	in the list of filters.
7216
7217	Positions are numbered starting from @c 0. If the specified
7218	position is equal to or greater than the number of elements in
7219	the list, the filter is added at the end of the collection.
7220
7221	<note>
7222	Duplicates are not allowed, so an attempt to insert a
7223	filter already in the list is an error.
7224	</note>
7225	<note>
7226	If USB functionality is not available in the given edition of
7227	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7228	</note>
7229
7230	<see>#USBDeviceFilters</see>
7231
7232	<result name="VBOX_E_INVALID_OBJECT_STATE">
7233	USB device filter is not created within this VirtualBox instance.
7234	</result>
7235	<result name="E_INVALIDARG">
7236	USB device filter already in list.
7237	</result>
7238
7239	</desc>
7240	<param name="position" type="unsigned long" dir="in">
7241	<desc>Position to insert the filter to.</desc>
7242	</param>
7243	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7244	<desc>USB device filter to insert.</desc>
7245	</param>
7246	</method>
7247
7248	<method name="removeUSBDeviceFilter">
7249	<desc>
7250	Removes a USB device filter from the specified position in the
7251	list of filters.
7252
7253	Positions are numbered starting from @c 0. Specifying a
7254	position equal to or greater than the number of elements in
7255	the list will produce an error.
7256
7257	<note>
7258	If USB functionality is not available in the given edition of
7259	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7260	</note>
7261
7262	<see>#USBDeviceFilters</see>
7263
7264	<result name="E_INVALIDARG">
7265	USB device filter list empty or invalid @a position.
7266	</result>
7267
7268	</desc>
7269	<param name="position" type="unsigned long" dir="in">
7270	<desc>Position to remove the filter from.</desc>
7271	</param>
7272	</method>
7273
7274	<method name="findHostDVDDrive">
7275	<desc>
7276	Searches for a host DVD drive with the given @c name.
7277
7278	<result name="VBOX_E_OBJECT_NOT_FOUND">
7279	Given @c name does not correspond to any host drive.
7280	</result>
7281
7282	</desc>
7283	<param name="name" type="wstring" dir="in">
7284	<desc>Name of the host drive to search for</desc>
7285	</param>
7286	<param name="drive" type="IMedium" dir="return">
7287	<desc>Found host drive object</desc>
7288	</param>
7289	</method>
7290
7291	<method name="findHostFloppyDrive">
7292	<desc>
7293	Searches for a host floppy drive with the given @c name.
7294
7295	<result name="VBOX_E_OBJECT_NOT_FOUND">
7296	Given @c name does not correspond to any host floppy drive.
7297	</result>
7298
7299	</desc>
7300	<param name="name" type="wstring" dir="in">
7301	<desc>Name of the host floppy drive to search for</desc>
7302	</param>
7303	<param name="drive" type="IMedium" dir="return">
7304	<desc>Found host floppy drive object</desc>
7305	</param>
7306	</method>
7307
7308	<method name="findHostNetworkInterfaceByName">
7309	<desc>
7310	Searches through all host network interfaces for an interface with
7311	the given @c name.
7312	<note>
7313	The method returns an error if the given @c name does not
7314	correspond to any host network interface.
7315	</note>
7316	</desc>
7317	<param name="name" type="wstring" dir="in">
7318	<desc>Name of the host network interface to search for.</desc>
7319	</param>
7320	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7321	<desc>Found host network interface object.</desc>
7322	</param>
7323	</method>
7324	<method name="findHostNetworkInterfaceById">
7325	<desc>
7326	Searches through all host network interfaces for an interface with
7327	the given GUID.
7328	<note>
7329	The method returns an error if the given GUID does not
7330	correspond to any host network interface.
7331	</note>
7332	</desc>
7333	<param name="id" type="uuid" mod="string" dir="in">
7334	<desc>GUID of the host network interface to search for.</desc>
7335	</param>
7336	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7337	<desc>Found host network interface object.</desc>
7338	</param>
7339	</method>
7340	<method name="findHostNetworkInterfacesOfType">
7341	<desc>
7342	Searches through all host network interfaces and returns a list of interfaces of the specified type
7343	</desc>
7344	<param name="type" type="HostNetworkInterfaceType" dir="in">
7345	<desc>type of the host network interfaces to search for.</desc>
7346	</param>
7347	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7348	<desc>Found host network interface objects.</desc>
7349	</param>
7350	</method>
7351
7352	<method name="findUSBDeviceById">
7353	<desc>
7354	Searches for a USB device with the given UUID.
7355
7356	<result name="VBOX_E_OBJECT_NOT_FOUND">
7357	Given @c id does not correspond to any USB device.
7358	</result>
7359
7360	<see>IHostUSBDevice::id</see>
7361	</desc>
7362	<param name="id" type="uuid" mod="string" dir="in">
7363	<desc>UUID of the USB device to search for.</desc>
7364	</param>
7365	<param name="device" type="IHostUSBDevice" dir="return">
7366	<desc>Found USB device object.</desc>
7367	</param>
7368	</method>
7369
7370	<method name="findUSBDeviceByAddress">
7371	<desc>
7372	Searches for a USB device with the given host address.
7373
7374	<result name="VBOX_E_OBJECT_NOT_FOUND">
7375	Given @c name does not correspond to any USB device.
7376	</result>
7377
7378	<see>IHostUSBDevice::address</see>
7379	</desc>
7380	<param name="name" type="wstring" dir="in">
7381	<desc>
7382	Address of the USB device (as assigned by the host) to
7383	search for.
7384	</desc>
7385	</param>
7386	<param name="device" type="IHostUSBDevice" dir="return">
7387	<desc>Found USB device object.</desc>
7388	</param>
7389	</method>
7390
7391	</interface>
7392
7393	<!--
7394	// ISystemProperties
7395	/////////////////////////////////////////////////////////////////////////
7396	-->
7397
7398	<interface
7399	name="ISystemProperties"
7400	extends="$unknown"
7401	uuid="51c81048-b261-4fa2-a44e-fd756f0db589"
7402	wsmap="managed"
7403	>
7404	<desc>
7405	The ISystemProperties interface represents global properties of the given
7406	VirtualBox installation.
7407
7408	These properties define limits and default values for various attributes
7409	and parameters. Most of the properties are read-only, but some can be
7410	changed by a user.
7411	</desc>
7412
7413	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7414	<desc>Minimum guest system memory in Megabytes.</desc>
7415	</attribute>
7416
7417	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7418	<desc>Maximum guest system memory in Megabytes.</desc>
7419	</attribute>
7420
7421	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7422	<desc>Minimum guest video memory in Megabytes.</desc>
7423	</attribute>
7424
7425	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7426	<desc>Maximum guest video memory in Megabytes.</desc>
7427	</attribute>
7428
7429	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7430	<desc>Minimum CPU count.</desc>
7431	</attribute>
7432
7433	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7434	<desc>Maximum CPU count.</desc>
7435	</attribute>
7436
7437	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7438	<desc>Maximum of monitors which could be connected.</desc>
7439	</attribute>
7440
7441	<attribute name="infoVDSize" type="long long" readonly="yes">
7442	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7443	does not reflect the limits of any virtual disk image format.</desc>
7444	</attribute>
7445
7446	<attribute name="networkAdapterCount" type="unsigned long" readonly="yes">
7447	<desc>
7448	Number of network adapters associated with every
7449	<link to="IMachine"/> instance.
7450	</desc>
7451	</attribute>
7452
7453	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7454	<desc>
7455	Number of serial ports associated with every
7456	<link to="IMachine"/> instance.
7457	</desc>
7458	</attribute>
7459
7460	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7461	<desc>
7462	Number of parallel ports associated with every
7463	<link to="IMachine"/> instance.
7464	</desc>
7465	</attribute>
7466
7467	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7468	<desc>
7469	Maximum device position in the boot order. This value corresponds
7470	to the total number of devices a machine can boot from, to make it
7471	possible to include all possible devices to the boot list.
7472	<see><link to="IMachine::setBootOrder"/></see>
7473	</desc>
7474	</attribute>
7475
7476	<attribute name="defaultMachineFolder" type="wstring">
7477	<desc>
7478	Full path to the default directory used to create new or open
7479	existing machines when a machine settings file name contains no
7480	path.
7481
7482	Starting with VirtualBox 4.0, by default, this attribute contains
7483	the full path of folder named "VirtualBox VMs" in the user's
7484	home directory, which depends on the host platform.
7485
7486	When setting this attribute, a full path must be specified.
7487	Setting this property to @c null or an empty string or the
7488	special value "Machines" (for compatibility reasons) will restore
7489	that default value.
7490
7491	If the folder specified herein does not exist, it will be created
7492	automatically as needed.
7493
7494	<see>
7495	<link to="IVirtualBox::createMachine"/>,
7496	<link to="IVirtualBox::openMachine"/>
7497	</see>
7498	</desc>
7499	</attribute>
7500
7501	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7502	<desc>
7503	List of all medium storage formats supported by this VirtualBox
7504	installation.
7505
7506	Keep in mind that the medium format identifier
7507	(<link to="IMediumFormat::id"/>) used in other API calls like
7508	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7509	medium format is a case-insensitive string. This means that, for
7510	example, all of the following strings:
7511	<pre>
7512	"VDI"
7513	"vdi"
7514	"VdI"</pre>
7515	refer to the same medium format.
7516
7517	Note that the virtual medium framework is backend-based, therefore
7518	the list of supported formats depends on what backends are currently
7519	installed.
7520
7521	<see>
7522	<link to="IMediumFormat"/>,
7523	</see>
7524	</desc>
7525	</attribute>
7526
7527	<attribute name="defaultHardDiskFormat" type="wstring">
7528	<desc>
7529	Identifier of the default medium format used by VirtualBox.
7530
7531	The medium format set by this attribute is used by VirtualBox
7532	when the medium format was not specified explicitly. One example is
7533	<link to="IVirtualBox::createHardDisk"/> with the empty
7534	format argument. A more complex example is implicit creation of
7535	differencing media when taking a snapshot of a virtual machine:
7536	this operation will try to use a format of the parent medium first
7537	and if this format does not support differencing media the default
7538	format specified by this argument will be used.
7539
7540	The list of supported medium formats may be obtained by the
7541	<link to="#mediumFormats"/> call. Note that the default medium
7542	format must have a capability to create differencing media;
7543	otherwise operations that create media implicitly may fail
7544	unexpectedly.
7545
7546	The initial value of this property is <tt>"VDI"</tt> in the current
7547	version of the VirtualBox product, but may change in the future.
7548
7549	<note>
7550	Setting this property to @c null or empty string will restore the
7551	initial value.
7552	</note>
7553
7554	<see>
7555	<link to="#mediumFormats"/>,
7556	<link to="IMediumFormat::id"/>,
7557	<link to="IVirtualBox::createHardDisk"/>
7558	</see>
7559	</desc>
7560	</attribute>
7561
7562	<attribute name="freeDiskSpaceWarning" type="long long">
7563	<desc>Issue a warning if the free disk space is below (or in some disk
7564	intensive operation is expected to go below) the given size in
7565	bytes.</desc>
7566	</attribute>
7567
7568	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7569	<desc>Issue a warning if the free disk space is below (or in some disk
7570	intensive operation is expected to go below) the given percentage.</desc>
7571	</attribute>
7572
7573	<attribute name="freeDiskSpaceError" type="long long">
7574	<desc>Issue an error if the free disk space is below (or in some disk
7575	intensive operation is expected to go below) the given size in
7576	bytes.</desc>
7577	</attribute>
7578
7579	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7580	<desc>Issue an error if the free disk space is below (or in some disk
7581	intensive operation is expected to go below) the given percentage.</desc>
7582	</attribute>
7583
7584	<attribute name="VRDEAuthLibrary" type="wstring">
7585	<desc>
7586	Library that provides authentication for Remote Desktop clients. The library
7587	is used if a virtual machine's authentication type is set to "external"
7588	in the VM RemoteDisplay configuration.
7589
7590	The system library extension (".DLL" or ".so") must be omitted.
7591	A full path can be specified; if not, then the library must reside on the
7592	system's default library path.
7593
7594	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7595	of that name in one of the default VirtualBox library directories.
7596
7597	For details about VirtualBox authentication libraries and how to implement
7598	them, please refer to the VirtualBox manual.
7599
7600	<note>
7601	Setting this property to @c null or empty string will restore the
7602	initial value.
7603	</note>
7604	</desc>
7605	</attribute>
7606
7607	<attribute name="webServiceAuthLibrary" type="wstring">
7608	<desc>
7609	Library that provides authentication for webservice clients. The library
7610	is used if a virtual machine's authentication type is set to "external"
7611	in the VM RemoteDisplay configuration and will be called from
7612	within the <link to="IWebsessionManager::logon" /> implementation.
7613
7614	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7615	there is no per-VM setting for this, as the webservice is a global
7616	resource (if it is running). Only for this setting (for the webservice),
7617	setting this value to a literal <tt>"null"</tt> string disables authentication,
7618	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7619	no matter what user name and password are supplied.
7620
7621	The initial value of this property is <tt>"VBoxAuth"</tt>,
7622	meaning that the webservice will use the same authentication
7623	library that is used by default for VRDE (again, see
7624	<link to="ISystemProperties::VRDEAuthLibrary" />).
7625	The format and calling convention of authentication libraries
7626	is the same for the webservice as it is for VRDE.
7627
7628	<note>
7629	Setting this property to @c null or empty string will restore the
7630	initial value.
7631	</note>
7632	</desc>
7633	</attribute>
7634
7635	<attribute name="defaultVRDEExtPack" type="wstring">
7636	<desc>
7637	The name of the extension pack providing the default VRDE.
7638
7639	This attribute is for choosing between multiple extension packs
7640	providing VRDE. If only one is installed, it will automatically be the
7641	default one. The attribute value can be empty if no VRDE extension
7642	pack is installed.
7643
7644	For details about VirtualBox Remote Desktop Extension and how to
7645	implement one, please refer to the VirtualBox SDK.
7646	</desc>
7647	</attribute>
7648
7649	<attribute name="LogHistoryCount" type="unsigned long">
7650	<desc>
7651	This value specifies how many old release log files are kept.
7652	</desc>
7653	</attribute>
7654
7655	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7656	<desc>This value hold the default audio driver for the current
7657	system.</desc>
7658	</attribute>
7659
7660	<method name="getMaxDevicesPerPortForStorageBus">
7661	<desc>Returns the maximum number of devices which can be attached to a port
7662	for the given storage bus.</desc>
7663
7664	<param name="bus" type="StorageBus" dir="in">
7665	<desc>The storage bus type to get the value for.</desc>
7666	</param>
7667
7668	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7669	<desc>The maximum number of devices which can eb attached to the port for the given
7670	storage bus.</desc>
7671	</param>
7672	</method>
7673
7674	<method name="getMinPortCountForStorageBus">
7675	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7676
7677	<param name="bus" type="StorageBus" dir="in">
7678	<desc>The storage bus type to get the value for.</desc>
7679	</param>
7680
7681	<param name="minPortCount" type="unsigned long" dir="return">
7682	<desc>The minimum number of ports for the given storage bus.</desc>
7683	</param>
7684	</method>
7685
7686	<method name="getMaxPortCountForStorageBus">
7687	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7688
7689	<param name="bus" type="StorageBus" dir="in">
7690	<desc>The storage bus type to get the value for.</desc>
7691	</param>
7692
7693	<param name="maxPortCount" type="unsigned long" dir="return">
7694	<desc>The maximum number of ports for the given storage bus.</desc>
7695	</param>
7696	</method>
7697
7698	<method name="getMaxInstancesOfStorageBus">
7699	<desc>Returns the maximum number of storage bus instances which
7700	can be configured for each VM. This corresponds to the number of
7701	storage controllers one can have. Value may depend on chipset type
7702	used.</desc>
7703
7704	<param name="chipset" type="ChipsetType" dir="in">
7705	<desc>The chipset type to get the value for.</desc>
7706	</param>
7707
7708	<param name="bus" type="StorageBus" dir="in">
7709	<desc>The storage bus type to get the value for.</desc>
7710	</param>
7711
7712	<param name="maxInstances" type="unsigned long" dir="return">
7713	<desc>The maximum number of instances for the given storage bus.</desc>
7714	</param>
7715	</method>
7716
7717	<method name="getDeviceTypesForStorageBus">
7718	<desc>Returns list of all the supported device types
7719	(<link to="DeviceType"/>) for the given type of storage
7720	bus.</desc>
7721
7722	<param name="bus" type="StorageBus" dir="in">
7723	<desc>The storage bus type to get the value for.</desc>
7724	</param>
7725
7726	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7727	<desc>The list of all supported device types for the given storage bus.</desc>
7728	</param>
7729	</method>
7730
7731	<method name="getDefaultIoCacheSettingForStorageController">
7732	<desc>Returns the default I/O cache setting for the
7733	given storage controller</desc>
7734
7735	<param name="controllerType" type="StorageControllerType" dir="in">
7736	<desc>The storage controller to the setting for.</desc>
7737	</param>
7738
7739	<param name="enabled" type="boolean" dir="return">
7740	<desc>Returned flag indicating the default value</desc>
7741	</param>
7742	</method>
7743	</interface>
7744
7745	<!--
7746	// IGuest
7747	/////////////////////////////////////////////////////////////////////////
7748	-->
7749
7750	<interface
7751	name="IGuestOSType" extends="$unknown"
7752	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7753	wsmap="struct"
7754	>
7755	<desc>
7756	</desc>
7757
7758	<attribute name="familyId" type="wstring" readonly="yes">
7759	<desc>Guest OS family identifier string.</desc>
7760	</attribute>
7761
7762	<attribute name="familyDescription" type="wstring" readonly="yes">
7763	<desc>Human readable description of the guest OS family.</desc>
7764	</attribute>
7765
7766	<attribute name="id" type="wstring" readonly="yes">
7767	<desc>Guest OS identifier string.</desc>
7768	</attribute>
7769
7770	<attribute name="description" type="wstring" readonly="yes">
7771	<desc>Human readable description of the guest OS.</desc>
7772	</attribute>
7773
7774	<attribute name="is64Bit" type="boolean" readonly="yes">
7775	<desc>Returns @c true if the given OS is 64-bit</desc>
7776	</attribute>
7777
7778	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7779	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7780	</attribute>
7781
7782	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7783	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7784	</attribute>
7785
7786	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7787	<desc>Recommended RAM size in Megabytes.</desc>
7788	</attribute>
7789
7790	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7791	<desc>Recommended video RAM size in Megabytes.</desc>
7792	</attribute>
7793
7794	<attribute name="recommendedHDD" type="long long" readonly="yes">
7795	<desc>Recommended hard disk size in bytes.</desc>
7796	</attribute>
7797
7798	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7799	<desc>Returns recommended network adapter for this OS type.</desc>
7800	</attribute>
7801
7802	<attribute name="recommendedPae" type="boolean" readonly="yes">
7803	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7804	</attribute>
7805
7806	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7807	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7808	</attribute>
7809
7810	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7811	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7812	</attribute>
7813
7814	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7815	<desc>Recommended storage controller type for HD drives.</desc>
7816	</attribute>
7817
7818	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7819	<desc>Recommended storage bus type for HD drives.</desc>
7820	</attribute>
7821
7822	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7823	<desc>Recommended firmware type.</desc>
7824	</attribute>
7825
7826	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7827	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7828	</attribute>
7829
7830	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7831	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7832	</attribute>
7833
7834	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7835	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7836	</attribute>
7837
7838	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7839	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7840	</attribute>
7841
7842	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7843	<desc>Recommended chipset type.</desc>
7844	</attribute>
7845
7846	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7847	<desc>Recommended audio type.</desc>
7848	</attribute>
7849
7850	</interface>
7851
7852	<enum
7853	name="AdditionsRunLevelType"
7854	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7855	>
7856	<desc>
7857	Guest Additions run level type.
7858	</desc>
7859
7860	<const name="None" value="0">
7861	<desc>Guest Additions are not loaded.</desc>
7862	</const>
7863	<const name="System" value="1">
7864	<desc>Guest drivers are loaded.</desc>
7865	</const>
7866	<const name="Userland" value="2">
7867	<desc>Common components (such as application services) are loaded.</desc>
7868	</const>
7869	<const name="Desktop" value="3">
7870	<desc>Per-user desktop components are loaded.</desc>
7871	</const>
7872	</enum>
7873
7874	<enum
7875	name="AdditionsUpdateFlag"
7876	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
7877	>
7878	<desc>
7879	Guest Additions update flags.
7880	</desc>
7881
7882	<const name="None" value="0">
7883	<desc>No flag set.</desc>
7884	</const>
7885	<const name="WaitForUpdateStartOnly" value="1">
7886	<desc>Only wait for the update process being started and do not
7887	wait while peforming the actual update.</desc>
7888	</const>
7889	</enum>
7890
7891	<enum
7892	name="ExecuteProcessFlag"
7893	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7894	>
7895	<desc>
7896	Guest process execution flags.
7897	</desc>
7898
7899	<const name="None" value="0">
7900	<desc>No flag set.</desc>
7901	</const>
7902
7903	<const name="WaitForProcessStartOnly" value="1">
7904	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
7905	process itself then uses an infinite timeout.</desc>
7906	</const>
7907
7908	<const name="IgnoreOrphanedProcesses" value="2">
7909	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
7910	</const>
7911
7912	<const name="Hidden" value="4">
7913	<desc>Don't show the started process according to the guest OS guidelines.</desc>
7914	</const>
7915	</enum>
7916
7917	<enum
7918	name="ProcessInputFlag"
7919	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
7920	>
7921	<desc>
7922	Guest process input flags.
7923	</desc>
7924
7925	<const name="None" value="0">
7926	<desc>No flag set.</desc>
7927	</const>
7928	<const name="EndOfFile" value="1">
7929	<desc>End of file (input) reached.</desc>
7930	</const>
7931	</enum>
7932
7933	<enum
7934	name="CopyFileFlag"
7935	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
7936	>
7937	<desc>
7938	Host/Guest copy flags. At the moment none of these flags
7939	are implemented.
7940	</desc>
7941
7942	<const name="None" value="0">
7943	<desc>No flag set.</desc>
7944	</const>
7945
7946	<const name="Recursive" value="1">
7947	<desc>Copy directories recursively.</desc>
7948	</const>
7949
7950	<const name="Update" value="2">
7951	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
7952	</const>
7953
7954	<const name="FollowLinks" value="4">
7955	<desc>Follow symbolic links.</desc>
7956	</const>
7957	</enum>
7958
7959	<enum
7960	name="CreateDirectoryFlag"
7961	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
7962	>
7963	<desc>
7964	Directory creation flags.
7965	</desc>
7966
7967	<const name="None" value="0">
7968	<desc>No flag set.</desc>
7969	</const>
7970
7971	<const name="Parents" value="1">
7972	<desc>No error if existing, make parent directories as needed.</desc>
7973	</const>
7974	</enum>
7975
7976	<interface
7977	name="IGuest" extends="$unknown"
7978	uuid="7ce7e4d8-cdaa-4d83-a0f4-510c8ee70aea"
7979	wsmap="managed"
7980	>
7981	<desc>
7982	The IGuest interface represents information about the operating system
7983	running inside the virtual machine. Used in
7984	<link to="IConsole::guest"/>.
7985
7986	IGuest provides information about the guest operating system, whether
7987	Guest Additions are installed and other OS-specific virtual machine
7988	properties.
7989	</desc>
7990
7991	<attribute name="OSTypeId" type="wstring" readonly="yes">
7992	<desc>
7993	Identifier of the Guest OS type as reported by the Guest
7994	Additions.
7995	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
7996	an IGuestOSType object representing details about the given
7997	Guest OS type.
7998	<note>
7999	If Guest Additions are not installed, this value will be
8000	the same as <link to="IMachine::OSTypeId"/>.
8001	</note>
8002	</desc>
8003	</attribute>
8004
8005	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8006	<desc>
8007	Current run level of the Guest Additions.
8008	</desc>
8009	</attribute>
8010
8011	<attribute name="additionsVersion" type="wstring" readonly="yes">
8012	<desc>
8013	Version of the Guest Additions including the revision (3 decimal numbers
8014	separated by dots + revision number) installed on the guest or empty
8015	when the Additions are not installed.
8016	</desc>
8017	</attribute>
8018
8019	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8020	<desc>
8021	Flag whether seamless guest display rendering (seamless desktop
8022	integration) is supported.
8023	</desc>
8024	</attribute>
8025
8026	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8027	<desc>
8028	Flag whether the guest is in graphics mode. If it is not, then
8029	seamless rendering will not work, resize hints are not immediately
8030	acted on and guest display resizes are probably not initiated by
8031	the guest additions.
8032	</desc>
8033	</attribute>
8034
8035	<attribute name="memoryBalloonSize" type="unsigned long">
8036	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8037	</attribute>
8038
8039	<attribute name="statisticsUpdateInterval" type="unsigned long">
8040	<desc>Interval to update guest statistics in seconds.</desc>
8041	</attribute>
8042
8043	<method name="internalGetStatistics">
8044	<desc>
8045	Internal method; do not use as it might change at any time
8046	</desc>
8047	<param name="cpuUser" type="unsigned long" dir="out">
8048	<desc>Percentage of processor time spent in user mode as seen by the guest</desc>
8049	</param>
8050	<param name="cpuKernel" type="unsigned long" dir="out">
8051	<desc>Percentage of processor time spent in kernel mode as seen by the guest</desc>
8052	</param>
8053	<param name="cpuIdle" type="unsigned long" dir="out">
8054	<desc>Percentage of processor time spent idling as seen by the guest</desc>
8055	</param>
8056	<param name="memTotal" type="unsigned long" dir="out">
8057	<desc>Total amount of physical guest RAM</desc>
8058	</param>
8059	<param name="memFree" type="unsigned long" dir="out">
8060	<desc>Free amount of physical guest RAM</desc>
8061	</param>
8062	<param name="memBalloon" type="unsigned long" dir="out">
8063	<desc>Amount of ballooned physical guest RAM</desc>
8064	</param>
8065	<param name="memShared" type="unsigned long" dir="out">
8066	<desc>Amount of shared physical guest RAM</desc>
8067	</param>
8068	<param name="memCache" type="unsigned long" dir="out">
8069	<desc>Total amount of guest (disk) cache memory</desc>
8070	</param>
8071	<param name="pagedTotal" type="unsigned long" dir="out">
8072	<desc>Total amount of space in the page file</desc>
8073	</param>
8074	<param name="memAllocTotal" type="unsigned long" dir="out">
8075	<desc>Total amount of memory allocated by the hypervisor</desc>
8076	</param>
8077	<param name="memFreeTotal" type="unsigned long" dir="out">
8078	<desc>Total amount of free memory available in the hypervisor</desc>
8079	</param>
8080	<param name="memBalloonTotal" type="unsigned long" dir="out">
8081	<desc>Total amount of memory ballooned by the hypervisor</desc>
8082	</param>
8083	<param name="memSharedTotal" type="unsigned long" dir="out">
8084	<desc>Total amount of shared memory in the hypervisor</desc>
8085	</param>
8086	</method>
8087
8088	<method name="getAdditionsStatus">
8089	<desc>
8090	Retrieve the current status of a certain Guest Additions run level.
8091
8092	<result name="VBOX_E_NOT_SUPPORTED">
8093	Wrong status level specified.
8094	</result>
8095
8096	</desc>
8097	<param name="level" type="AdditionsRunLevelType" dir="in">
8098	<desc>Status level to check</desc>
8099	</param>
8100	<param name="active" type="boolean" dir="return">
8101	<desc>Flag whether the status level has been reached or not</desc>
8102	</param>
8103	</method>
8104
8105	<method name="setCredentials">
8106	<desc>
8107	Store login credentials that can be queried by guest operating
8108	systems with Additions installed. The credentials are transient
8109	to the session and the guest may also choose to erase them. Note
8110	that the caller cannot determine whether the guest operating system
8111	has queried or made use of the credentials.
8112
8113	<result name="VBOX_E_VM_ERROR">
8114	VMM device is not available.
8115	</result>
8116
8117	</desc>
8118	<param name="userName" type="wstring" dir="in">
8119	<desc>User name string, can be empty</desc>
8120	</param>
8121	<param name="password" type="wstring" dir="in">
8122	<desc>Password string, can be empty</desc>
8123	</param>
8124	<param name="domain" type="wstring" dir="in">
8125	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8126	</param>
8127	<param name="allowInteractiveLogon" type="boolean" dir="in">
8128	<desc>
8129	Flag whether the guest should alternatively allow the user to
8130	interactively specify different credentials. This flag might
8131	not be supported by all versions of the Additions.
8132	</desc>
8133	</param>
8134	</method>
8135
8136	<method name="executeProcess">
8137	<desc>
8138	Executes an existing program inside the guest VM.
8139
8140	<result name="VBOX_E_IPRT_ERROR">
8141	Could not execute process.
8142	</result>
8143
8144	</desc>
8145	<param name="execName" type="wstring" dir="in">
8146	<desc>
8147	Full path name of the command to execute on the guest; the
8148	commands has to exists in the guest VM in order to be executed.
8149	</desc>
8150	</param>
8151	<param name="flags" type="unsigned long" dir="in">
8152	<desc>
8153	<link to="ExecuteProcessFlag"/> flags.
8154	</desc>
8155	</param>
8156	<param name="arguments" type="wstring" safearray="yes" dir="in">
8157	<desc>
8158	Array of arguments passed to the execution command.
8159	</desc>
8160	</param>
8161	<param name="environment" type="wstring" safearray="yes" dir="in">
8162	<desc>
8163	Environment variables that can be set while the command is being
8164	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8165	variable just set its name ("NAME") without a value.
8166	</desc>
8167	</param>
8168	<param name="userName" type="wstring" dir="in">
8169	<desc>
8170	User name under which the command will be executed; has to exist
8171	and have the appropriate rights to execute programs in the VM.
8172	</desc>
8173	</param>
8174	<param name="password" type="wstring" dir="in">
8175	<desc>
8176	Password of the user account specified.
8177	</desc>
8178	</param>
8179	<param name="timeoutMS" type="unsigned long" dir="in">
8180	<desc>
8181	The maximum timeout value (in msec) to wait for finished program
8182	execution. Pass 0 for an infinite timeout.
8183	</desc>
8184	</param>
8185	<param name="pid" type="unsigned long" dir="out">
8186	<desc>
8187	The PID (process ID) of the started command for later reference.
8188	</desc>
8189	</param>
8190	<param name="progress" type="IProgress" dir="return">
8191	<desc>Progress object to track the operation completion.</desc>
8192	</param>
8193	</method>
8194
8195	<method name="getProcessOutput">
8196	<desc>
8197	Retrieves output of a formerly started process.
8198
8199	<result name="VBOX_E_IPRT_ERROR">
8200	Could not retrieve output.
8201	</result>
8202
8203	</desc>
8204	<param name="pid" type="unsigned long" dir="in">
8205	<desc>
8206	Process id returned by earlier executeProcess() call.
8207	</desc>
8208	</param>
8209	<param name="flags" type="unsigned long" dir="in">
8210	<desc>
8211	Flags describing which output to retrieve.
8212	</desc>
8213	</param>
8214	<param name="timeoutMS" type="unsigned long" dir="in">
8215	<desc>
8216	The maximum timeout value (in msec) to wait for output
8217	data. Pass 0 for an infinite timeout.
8218	</desc>
8219	</param>
8220	<param name="size" type="long long" dir="in">
8221	<desc>
8222	Size in bytes to read in the buffer.
8223	</desc>
8224	</param>
8225	<param name="data" type="octet" dir="return" safearray="yes">
8226	<desc>
8227	Buffer for retrieving the actual output. A data size of 0 means end of file
8228	if the requested size was not 0. This is the unprocessed
8229	output data, i.e. the line ending style depends on the platform of
8230	the system the server is running on.
8231	</desc>
8232	</param>
8233	</method>
8234
8235	<method name="getProcessStatus">
8236	<desc>
8237	Retrieves status, exit code and the exit reason of a formerly started process.
8238
8239	<result name="VBOX_E_IPRT_ERROR">
8240	Process with specified PID was not found.
8241	</result>
8242
8243	</desc>
8244	<param name="pid" type="unsigned long" dir="in">
8245	<desc>
8246	Process id returned by earlier executeProcess() call.
8247	</desc>
8248	</param>
8249	<param name="exitcode" type="unsigned long" dir="out">
8250	<desc>
8251	The exit code (if available).
8252	</desc>
8253	</param>
8254	<param name="flags" type="unsigned long" dir="out">
8255	<desc>
8256	Additional flags of process status. Not used at the moment and
8257	must be set to 0.
8258	</desc>
8259	</param>
8260	<param name="reason" type="unsigned long" dir="return">
8261	<desc>
8262	The current process status.
8263	</desc>
8264	</param>
8265	</method>
8266
8267	<method name="copyToGuest">
8268	<desc>
8269	Copies files/directories from host to the guest.
8270
8271	<result name="VBOX_E_IPRT_ERROR">
8272	Error while copying.
8273	</result>
8274
8275	</desc>
8276	<param name="source" type="wstring" dir="in">
8277	<desc>
8278	Source file on the host to copy.
8279	</desc>
8280	</param>
8281	<param name="dest" type="wstring" dir="in">
8282	<desc>
8283	Destination path on the guest.
8284	</desc>
8285	</param>
8286	<param name="userName" type="wstring" dir="in">
8287	<desc>
8288	User name under which the copy command will be executed; the
8289	user has to exist and have the appropriate rights to write to
8290	the destination path.
8291	</desc>
8292	</param>
8293	<param name="password" type="wstring" dir="in">
8294	<desc>
8295	Password of the user account specified.
8296	</desc>
8297	</param>
8298	<param name="flags" type="unsigned long" dir="in">
8299	<desc>
8300	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8301	</desc>
8302	</param>
8303	<param name="progress" type="IProgress" dir="return">
8304	<desc>Progress object to track the operation completion.</desc>
8305	</param>
8306	</method>
8307
8308	<method name="createDirectory">
8309	<desc>
8310	Creates a directory on the guest.
8311
8312	<result name="VBOX_E_IPRT_ERROR">
8313	Error while creating directory.
8314	</result>
8315
8316	</desc>
8317	<param name="directory" type="wstring" dir="in">
8318	<desc>
8319	Directory to create.
8320	</desc>
8321	</param>
8322	<param name="userName" type="wstring" dir="in">
8323	<desc>
8324	User name under which the directory creation will be executed; the
8325	user has to exist and have the appropriate rights to create the
8326	desired directory.
8327	</desc>
8328	</param>
8329	<param name="password" type="wstring" dir="in">
8330	<desc>
8331	Password of the user account specified.
8332	</desc>
8333	</param>
8334	<param name="mode" type="unsigned long" dir="in">
8335	<desc>
8336	File mode.
8337	</desc>
8338	</param>
8339	<param name="flags" type="unsigned long" dir="in">
8340	<desc>
8341	<link to="CreateDirectoryFlag"/> flags.
8342	</desc>
8343	</param>
8344	<param name="progress" type="IProgress" dir="return">
8345	<desc>Progress object to track the operation completion.</desc>
8346	</param>
8347	</method>
8348
8349	<method name="setProcessInput">
8350	<desc>
8351	Sends input into a formerly started process.
8352
8353	<result name="VBOX_E_IPRT_ERROR">
8354	Could not send input.
8355	</result>
8356
8357	</desc>
8358	<param name="pid" type="unsigned long" dir="in">
8359	<desc>
8360	Process id returned by earlier executeProcess() call.
8361	</desc>
8362	</param>
8363	<param name="flags" type="unsigned long" dir="in">
8364	<desc>
8365	<link to="ProcessInputFlag"/> flags.
8366	</desc>
8367	</param>
8368	<param name="timeoutMS" type="unsigned long" dir="in">
8369	<desc>
8370	The maximum timeout value (in msec) to wait for getting the
8371	data transfered to the guest. Pass 0 for an infinite timeout.
8372	</desc>
8373	</param>
8374	<param name="data" type="octet" dir="in" safearray="yes">
8375	<desc>
8376	Buffer of input data to send to the started process to.
8377	</desc>
8378	</param>
8379	<param name="written" type="unsigned long" dir="return">
8380	<desc>
8381	Number of bytes written.
8382	</desc>
8383	</param>
8384	</method>
8385
8386	<method name="updateGuestAdditions">
8387	<desc>
8388	Updates already installed Guest Additions in a VM
8389	(Windows guests only).
8390
8391	<result name="VBOX_E_IPRT_ERROR">
8392	Error while updating.
8393	</result>
8394
8395	</desc>
8396	<param name="source" type="wstring" dir="in">
8397	<desc>
8398	Path to the Guest Additions .ISO file to use for the upate.
8399	</desc>
8400	</param>
8401	<param name="flags" type="unsigned long" dir="in">
8402	<desc>
8403	<link to="AdditionsUpdateFlag"/> flags.
8404	</desc>
8405	</param>
8406	<param name="progress" type="IProgress" dir="return">
8407	<desc>Progress object to track the operation completion.</desc>
8408	</param>
8409	</method>
8410
8411	</interface>
8412
8413
8414	<!--
8415	// IProgress
8416	/////////////////////////////////////////////////////////////////////////
8417	-->
8418
8419	<interface
8420	name="IProgress" extends="$unknown"
8421	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8422	wsmap="managed"
8423	>
8424	<desc>
8425	The IProgress interface is used to track and control
8426	asynchronous tasks within VirtualBox.
8427
8428	An instance of this is returned every time VirtualBox starts
8429	an asynchronous task (in other words, a separate thread) which
8430	continues to run after a method call returns. For example,
8431	<link to="IConsole::saveState" />, which saves the state of
8432	a running virtual machine, can take a long time to complete.
8433	To be able to display a progress bar, a user interface such as
8434	the VirtualBox graphical user interface can use the IProgress
8435	object returned by that method.
8436
8437	Note that IProgress is a "read-only" interface in the sense
8438	that only the VirtualBox internals behind the Main API can
8439	create and manipulate progress objects, whereas client code
8440	can only use the IProgress object to monitor a task's
8441	progress and, if <link to="#cancelable" /> is @c true,
8442	cancel the task by calling <link to="#cancel" />.
8443
8444	A task represented by IProgress consists of either one or
8445	several sub-operations that run sequentially, one by one (see
8446	<link to="#operation" /> and <link to="#operationCount" />).
8447	Every operation is identified by a number (starting from 0)
8448	and has a separate description.
8449
8450	You can find the individual percentage of completion of the current
8451	operation in <link to="#operationPercent" /> and the
8452	percentage of completion of the task as a whole
8453	in <link to="#percent" />.
8454
8455	Similarly, you can wait for the completion of a particular
8456	operation via <link to="#waitForOperationCompletion" /> or
8457	for the completion of the whole task via
8458	<link to="#waitForCompletion" />.
8459	</desc>
8460
8461	<attribute name="id" type="uuid" mod="string" readonly="yes">
8462	<desc>ID of the task.</desc>
8463	</attribute>
8464
8465	<attribute name="description" type="wstring" readonly="yes">
8466	<desc>Description of the task.</desc>
8467	</attribute>
8468
8469	<attribute name="initiator" type="$unknown" readonly="yes">
8470	<desc>Initiator of the task.</desc>
8471	</attribute>
8472
8473	<attribute name="cancelable" type="boolean" readonly="yes">
8474	<desc>Whether the task can be interrupted.</desc>
8475	</attribute>
8476
8477	<attribute name="percent" type="unsigned long" readonly="yes">
8478	<desc>
8479	Current progress value of the task as a whole, in percent.
8480	This value depends on how many operations are already complete.
8481	Returns 100 if <link to="#completed" /> is @c true.
8482	</desc>
8483	</attribute>
8484
8485	<attribute name="timeRemaining" type="long" readonly="yes">
8486	<desc>
8487	Estimated remaining time until the task completes, in
8488	seconds. Returns 0 once the task has completed; returns -1
8489	if the remaining time cannot be computed, in particular if
8490	the current progress is 0.
8491
8492	Even if a value is returned, the estimate will be unreliable
8493	for low progress values. It will become more reliable as the
8494	task progresses; it is not recommended to display an ETA
8495	before at least 20% of a task have completed.
8496	</desc>
8497	</attribute>
8498
8499	<attribute name="completed" type="boolean" readonly="yes">
8500	<desc>Whether the task has been completed.</desc>
8501	</attribute>
8502
8503	<attribute name="canceled" type="boolean" readonly="yes">
8504	<desc>Whether the task has been canceled.</desc>
8505	</attribute>
8506
8507	<attribute name="resultCode" type="long" readonly="yes">
8508	<desc>
8509	Result code of the progress task.
8510	Valid only if <link to="#completed"/> is @c true.
8511	</desc>
8512	</attribute>
8513
8514	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8515	<desc>
8516	Extended information about the unsuccessful result of the
8517	progress operation. May be @c null if no extended information
8518	is available.
8519	Valid only if <link to="#completed"/> is @c true and
8520	<link to="#resultCode"/> indicates a failure.
8521	</desc>
8522	</attribute>
8523
8524	<attribute name="operationCount" type="unsigned long" readonly="yes">
8525	<desc>
8526	Number of sub-operations this task is divided into.
8527	Every task consists of at least one suboperation.
8528	</desc>
8529	</attribute>
8530
8531	<attribute name="operation" type="unsigned long" readonly="yes">
8532	<desc>Number of the sub-operation being currently executed.</desc>
8533	</attribute>
8534
8535	<attribute name="operationDescription" type="wstring" readonly="yes">
8536	<desc>
8537	Description of the sub-operation being currently executed.
8538	</desc>
8539	</attribute>
8540
8541	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8542	<desc>Progress value of the current sub-operation only, in percent.</desc>
8543	</attribute>
8544
8545	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8546	<desc>Weight value of the current sub-operation only.</desc>
8547	</attribute>
8548
8549	<attribute name="timeout" type="unsigned long">
8550	<desc>
8551	When non-zero, this specifies the number of milliseconds after which
8552	the operation will automatically be canceled. This can only be set on
8553	cancelable objects.
8554	</desc>
8555	</attribute>
8556
8557	<method name="setCurrentOperationProgress">
8558	<desc>Internal method, not to be called externally.</desc>
8559	<param name="percent" type="unsigned long" dir="in" />
8560	</method>
8561	<method name="setNextOperation">
8562	<desc>Internal method, not to be called externally.</desc>
8563	<param name="nextOperationDescription" type="wstring" dir="in" />
8564	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8565	</method>
8566
8567	<method name="waitForCompletion">
8568	<desc>
8569	Waits until the task is done (including all sub-operations)
8570	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8571
8572	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8573	thread are not processed while waiting. Neglecting event queues may
8574	have dire consequences (degrade performance, resource hogs,
8575	deadlocks, etc.), this is specially so for the main thread on
8576	platforms using XPCOM. Callers are adviced wait for short periods
8577	and service their event queues between calls, or to create a worker
8578	thread to do the waiting.
8579
8580	<result name="VBOX_E_IPRT_ERROR">
8581	Failed to wait for task completion.
8582	</result>
8583	</desc>
8584
8585	<param name="timeout" type="long" dir="in">
8586	<desc>
8587	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8588	</desc>
8589	</param>
8590	</method>
8591
8592	<method name="waitForOperationCompletion">
8593	<desc>
8594	Waits until the given operation is done with a given timeout in
8595	milliseconds; specify -1 for an indefinite wait.
8596
8597	See <link to="#waitForCompletion"> for event queue considerations.</link>
8598
8599	<result name="VBOX_E_IPRT_ERROR">
8600	Failed to wait for operation completion.
8601	</result>
8602
8603	</desc>
8604	<param name="operation" type="unsigned long" dir="in">
8605	<desc>
8606	Number of the operation to wait for.
8607	Must be less than <link to="#operationCount"/>.
8608	</desc>
8609	</param>
8610	<param name="timeout" type="long" dir="in">
8611	<desc>
8612	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8613	</desc>
8614	</param>
8615	</method>
8616
8617	<method name="cancel">
8618	<desc>
8619	Cancels the task.
8620	<note>
8621	If <link to="#cancelable"/> is @c false, then this method will fail.
8622	</note>
8623
8624	<result name="VBOX_E_INVALID_OBJECT_STATE">
8625	Operation cannot be canceled.
8626	</result>
8627
8628	</desc>
8629	</method>
8630
8631	</interface>
8632
8633	<!--
8634	// ISnapshot
8635	/////////////////////////////////////////////////////////////////////////
8636	-->
8637
8638	<interface
8639	name="ISnapshot" extends="$unknown"
8640	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8641	wsmap="managed"
8642	>
8643	<desc>
8644	The ISnapshot interface represents a snapshot of the virtual
8645	machine.
8646
8647	Together with the differencing media that are created
8648	when a snapshot is taken, a machine can be brought back to
8649	the exact state it was in when the snapshot was taken.
8650
8651	The ISnapshot interface has no methods, only attributes; snapshots
8652	are controlled through methods of the <link to="IConsole" /> interface
8653	which also manage the media associated with the snapshot.
8654	The following operations exist:
8655
8656	<ul>
8657	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8658	by creating new, empty differencing images for the machine's
8659	media and saving the VM settings and (if the VM is running)
8660	the current VM state in the snapshot.
8661
8662	The differencing images will then receive all data written to
8663	the machine's media, while their parent (base) images
8664	remain unmodified after the snapshot has been taken (see
8665	<link to="IMedium" /> for details about differencing images).
8666	This simplifies restoring a machine to the state of a snapshot:
8667	only the differencing images need to be deleted.
8668
8669	The current machine state is not changed by taking a snapshot.
8670	If the machine is running, it will resume execution after the
8671	snapshot has been taken. After calling this,
8672	<link to="IMachine::currentSnapshot" /> is set to the snapshot
8673	just created.
8674	</li>
8675
8676	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8677	the state of a previous snapshot by deleting the differencing
8678	image of each of the machine's media and setting the machine's
8679	settings and state to the state that was saved in the snapshot (if any).
8680
8681	This destroys the machine's current state. After calling this,
8682	<link to="IMachine::currentSnapshot" /> is set to the snapshot that was
8683	restored.
8684	</li>
8685
8686	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8687	without affecting the current machine state.
8688
8689	This does not change the current machine state, but instead frees the
8690	resources allocated when the snapshot was taken: the settings and machine
8691	state file are deleted (if any), and the snapshot's differencing image for
8692	each of the machine's media gets merged with its parent image.
8693
8694	Neither the current machine state nor other snapshots are affected
8695	by this operation, except that parent media will be modified
8696	to contain the disk data associated with the snapshot being deleted.
8697
8698	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8699	attribute is set to the current snapshot's parent or NULL if it
8700	has no parent. Otherwise the attribute is unchanged.
8701	</li>
8702	</ul>
8703
8704	Each snapshot contains the settings of the virtual machine (hardware
8705	configuration etc.). In addition, if the machine was running when the
8706	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8707	the current VM state is saved in the snapshot (similarly to what happens
8708	when a VM's state is saved). The snapshot is then said to
8709	be <i>online</i> because when restoring it, the VM will be running.
8710
8711	If the machine is saved (<link to="MachineState_Saved"/>), the snapshot
8712	receives a copy of the execution state file (<link to="IMachine::stateFilePath"/>).
8713
8714	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8715	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8716	it then contains a so-called "zero execution state", representing a
8717	machine that is powered off.
8718	</desc>
8719
8720	<attribute name="id" type="uuid" mod="string" readonly="yes">
8721	<desc>UUID of the snapshot.</desc>
8722	</attribute>
8723
8724	<attribute name="name" type="wstring">
8725	<desc>Short name of the snapshot.</desc>
8726	</attribute>
8727
8728	<attribute name="description" type="wstring">
8729	<desc>Optional description of the snapshot.</desc>
8730	</attribute>
8731
8732	<attribute name="timeStamp" type="long long" readonly="yes">
8733	<desc>
8734	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8735	</desc>
8736	</attribute>
8737
8738	<attribute name="online" type="boolean" readonly="yes">
8739	<desc>
8740	@c true if this snapshot is an online snapshot and @c false otherwise.
8741
8742	When this attribute is @c true, the
8743	<link to="IMachine::stateFilePath"/> attribute of the
8744	<link to="#machine"/> object associated with this snapshot
8745	will point to the saved state file. Otherwise, it will be
8746	an empty string.
8747	</desc>
8748	</attribute>
8749
8750	<attribute name="machine" type="IMachine" readonly="yes">
8751	<desc>
8752	Virtual machine this snapshot is taken on. This object
8753	stores all settings the machine had when taking this snapshot.
8754	<note>
8755	The returned machine object is immutable, i.e. no
8756	any settings can be changed.
8757	</note>
8758	</desc>
8759	</attribute>
8760
8761	<attribute name="parent" type="ISnapshot" readonly="yes">
8762	<desc>
8763	Parent snapshot (a snapshot this one is based on), or
8764	@c null if the snapshot has no parent (i.e. is the first snapshot).
8765	</desc>
8766	</attribute>
8767
8768	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8769	<desc>
8770	Child snapshots (all snapshots having this one as a parent).
8771	</desc>
8772	</attribute>
8773
8774	</interface>
8775
8776
8777	<!--
8778	// IMedium
8779	/////////////////////////////////////////////////////////////////////////
8780	-->
8781
8782	<enum
8783	name="MediumState"
8784	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8785	>
8786	<desc>
8787	Virtual medium state.
8788	<see>IMedium</see>
8789	</desc>
8790
8791	<const name="NotCreated" value="0">
8792	<desc>
8793	Associated medium storage does not exist (either was not created yet or
8794	was deleted).
8795	</desc>
8796	</const>
8797	<const name="Created" value="1">
8798	<desc>
8799	Associated storage exists and accessible; this gets set if the
8800	accessibility check performed by <link to="IMedium::refreshState" />
8801	was successful.
8802	</desc>
8803	</const>
8804	<const name="LockedRead" value="2">
8805	<desc>
8806	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8807	no data modification is possible.
8808	</desc>
8809	</const>
8810	<const name="LockedWrite" value="3">
8811	<desc>
8812	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8813	no concurrent data reading or modification is possible.
8814	</desc>
8815	</const>
8816	<const name="Inaccessible" value="4">
8817	<desc>
8818	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8819	not yet been performed, or else, associated medium storage is not
8820	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8821	is empty, in the second case, it describes the error that occurred.
8822	</desc>
8823	</const>
8824	<const name="Creating" value="5">
8825	<desc>
8826	Associated medium storage is being created.
8827	</desc>
8828	</const>
8829	<const name="Deleting" value="6">
8830	<desc>
8831	Associated medium storage is being deleted.
8832	</desc>
8833	</const>
8834	</enum>
8835
8836	<enum
8837	name="MediumType"
8838	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
8839	>
8840	<desc>
8841	Virtual medium type.
8842	<see>IMedium</see>
8843	</desc>
8844
8845	<const name="Normal" value="0">
8846	<desc>
8847	Normal medium (attached directly or indirectly, preserved
8848	when taking snapshots).
8849	</desc>
8850	</const>
8851	<const name="Immutable" value="1">
8852	<desc>
8853	Immutable medium (attached indirectly, changes are wiped out
8854	the next time the virtual machine is started).
8855	</desc>
8856	</const>
8857	<const name="Writethrough" value="2">
8858	<desc>
8859	Write through medium (attached directly, ignored when
8860	taking snapshots).
8861	</desc>
8862	</const>
8863	<const name="Shareable" value="3">
8864	<desc>
8865	Allow using this medium concurrently by several machines.
8866	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8867	</desc>
8868	</const>
8869	<const name="Readonly" value="4">
8870	<desc>
8871	A readonly medium, which can of course be used by several machines.
8872	<note>Present and accepted since VirtualBox 4.0.</note>
8873	</desc>
8874	</const>
8875	<const name="MultiAttach" value="5">
8876	<desc>
8877	A medium which is is indirectly attached, so that one base medium can
8878	be used for several VMs which have their own differencing medium to
8879	store their modifications. In some sense a variant of Immutable
8880	with unset AutoReset flag in each differencing medium.
8881	<note>Present and accepted since VirtualBox 4.0.</note>
8882	</desc>
8883	</const>
8884	</enum>
8885
8886	<enum
8887	name="MediumVariant"
8888	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
8889	>
8890	<desc>
8891	Virtual medium image variant. More than one flag may be set.
8892	<see>IMedium</see>
8893	</desc>
8894
8895	<const name="Standard" value="0">
8896	<desc>
8897	No particular variant requested, results in using the backend default.
8898	</desc>
8899	</const>
8900	<const name="VmdkSplit2G" value="0x01">
8901	<desc>
8902	VMDK image split in chunks of less than 2GByte.
8903	</desc>
8904	</const>
8905	<const name="VmdkStreamOptimized" value="0x04">
8906	<desc>
8907	VMDK streamOptimized image. Special import/export format which is
8908	read-only/append-only.
8909	</desc>
8910	</const>
8911	<const name="VmdkESX" value="0x08">
8912	<desc>
8913	VMDK format variant used on ESX products.
8914	</desc>
8915	</const>
8916	<const name="Fixed" value="0x10000">
8917	<desc>
8918	Fixed image. Only allowed for base images.
8919	</desc>
8920	</const>
8921	<const name="Diff" value="0x20000">
8922	<desc>
8923	Differencing image. Only allowed for child images.
8924	</desc>
8925	</const>
8926	</enum>
8927
8928	<interface
8929	name="IMediumAttachment" extends="$unknown"
8930	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
8931	wsmap="struct"
8932	>
8933	<desc>
8934	The IMediumAttachment interface links storage media to virtual machines.
8935	For each medium (<link to="IMedium"/>) which has been attached to a
8936	storage controller (<link to="IStorageController"/>) of a machine
8937	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
8938	method, one instance of IMediumAttachment is added to the machine's
8939	<link to="IMachine::mediumAttachments"/> array attribute.
8940
8941	Each medium attachment specifies the storage controller as well as a
8942	port and device number and the IMedium instance representing a virtual
8943	hard disk or floppy or DVD image.
8944
8945	For removeable media (DVDs or floppies), there are two additional
8946	options. For one, the IMedium instance can be @c null to represent
8947	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
8948	secondly, the medium can be one of the pseudo-media for host drives
8949	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
8950	</desc>
8951
8952	<attribute name="medium" type="IMedium" readonly="yes">
8953	<desc>Medium object associated with this attachment; it
8954	can be @c null for removable devices.</desc>
8955	</attribute>
8956
8957	<attribute name="controller" type="wstring" readonly="yes">
8958	<desc>Name of the storage controller of this attachment; this
8959	refers to one of the controllers in <link to="IMachine::storageControllers" />
8960	by name.</desc>
8961	</attribute>
8962
8963	<attribute name="port" type="long" readonly="yes">
8964	<desc>Port number of this attachment.
8965	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8966	</desc>
8967	</attribute>
8968
8969	<attribute name="device" type="long" readonly="yes">
8970	<desc>Device slot number of this attachment.
8971	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
8972	</desc>
8973	</attribute>
8974
8975	<attribute name="type" type="DeviceType" readonly="yes">
8976	<desc>Device type of this attachment.</desc>
8977	</attribute>
8978
8979	<attribute name="passthrough" type="boolean" readonly="yes">
8980	<desc>Pass I/O requests through to a device on the host.</desc>
8981	</attribute>
8982
8983	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
8984	<desc>The bandwidth group this medium attachment is assigned to.</desc>
8985	</attribute>
8986
8987	</interface>
8988
8989	<interface
8990	name="IMedium" extends="$unknown"
8991	uuid="9edda847-1279-4b0a-9af7-9d66251ccc18"
8992	wsmap="managed"
8993	>
8994	<desc>
8995	The IMedium interface represents virtual storage for a machine's
8996	hard disks, CD/DVD or floppy drives. It will typically represent
8997	a disk image on the host, for example a VDI or VMDK file representing
8998	a virtual hard disk, or an ISO or RAW file representing virtual
8999	removable media, but can also point to a network location (e.g.
9000	for iSCSI targets).
9001
9002	Instances of IMedium are connected to virtual machines by way of
9003	medium attachments (see <link to="IMediumAttachment" />), which link
9004	the storage medium to a particular device slot of a storage controller
9005	of the virtual machine.
9006	In the VirtualBox API, virtual storage is therefore always represented
9007	by the following chain of object links:
9008
9009	<ul>
9010	<li><link to="IMachine::storageControllers"/> contains an array of
9011	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9012	these are instances of <link to="IStorageController"/>).</li>
9013	<li><link to="IMachine::mediumAttachments"/> contains an array of
9014	medium attachments (instances of <link to="IMediumAttachment"/>),
9015	each containing a storage controller from the above array, a
9016	port/device specification, and an instance of IMedium representing
9017	the medium storage (image file).
9018
9019	For removable media, the storage medium is optional; a medium
9020	attachment with no medium represents a CD/DVD or floppy drive
9021	with no medium inserted. By contrast, hard disk attachments
9022	will always have an IMedium object attached.</li>
9023	<li>Each IMedium in turn points to a storage unit (such as a file
9024	on the host computer or a network resource) that holds actual
9025	data. This location is represented by the <link to="#location"/>
9026	attribute.</li>
9027	</ul>
9028
9029	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
9030	new hard disk media can be created with the VirtualBox API using the
9031	<link to="IVirtualBox::createHardDisk"/> method.
9032
9033	CD/DVD and floppy images (ISO and RAW files) are usually created outside
9034	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
9035	type in a regular file.
9036
9037	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9038	drive; in that case the <link to="#id" /> attribute contains the UUID of
9039	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9040
9041	<h3>Known media</h3>
9042
9043	When an existing medium is opened and attached to a virtual machine, it
9044	is automatically added to a media registry. If the medium has first
9045	been attached to a machine which was created by VirtualBox 4.0 or later,
9046	it is added to that machine's media registry (in the machine XML settings
9047	file; this way all information about a machine's media attachments is
9048	contained in a single file). For older media attachments (i.e. if the
9049	medium was first attached to a machine which was created with a VirtualBox
9050	version before 4.0), media continue to be registered in the global
9051	VirtualBox settings file, for backwards compatibility.
9052
9053	See <link to="IVirtualBox::openMedium" /> for more information.
9054
9055	All known media can be enumerated using
9056	<link to="IVirtualBox::hardDisks"/>,
9057	<link to="IVirtualBox::DVDImages"/> and
9058	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
9059	quickly found using the <link to="IVirtualBox::findMedium"/> method.
9060
9061	Only known media can be attached to virtual machines.
9062
9063	Removing known media from the media registry is performed when the given
9064	medium is closed using the <link to="#close"/> method or when its
9065	associated storage unit is deleted.
9066
9067	<h3>Accessibility checks</h3>
9068
9069	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9070	method is called explicitly on a medium. This is done to make the VirtualBox object
9071	ready for serving requests as fast as possible and let the end-user
9072	application decide if it needs to check media accessibility right away or not.
9073
9074	As a result, when VirtualBox starts up (e.g. the VirtualBox
9075	object gets created for the first time), all known media are in the
9076	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9077	attribute is an empty string because no actual accessibility check has
9078	been made yet.
9079
9080	After calling <link to="#refreshState" />, a medium is considered
9081	<i>accessible</i> if its storage unit can be read. In that case, the
9082	<link to="#state"/> attribute has a value of "Created". If the storage
9083	unit cannot be read (for example, because it is located on a disconnected
9084	network resource, or was accidentally deleted outside VirtualBox),
9085	the medium is considered <i>inaccessible</i>, which is indicated by the
9086	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9087	obtained by reading the <link to="#lastAccessError"/> attribute.
9088
9089	<h3>Medium types</h3>
9090
9091	There are four types of medium behavior (see <link to="MediumType" />):
9092	"normal", "immutable", "writethrough" and "shareable", represented by the
9093	<link to="#type"/> attribute. The type of the medium defines how the
9094	medium is attached to a virtual machine and what happens when a
9095	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9096	attached medium is taken. At the moment DVD and floppy media are always
9097	of type "writethrough".
9098
9099	All media can be also divided in two groups: <i>base</i> media and
9100	<i>differencing</i> media. A base medium contains all sectors of the
9101	medium data in its own storage and therefore can be used independently.
9102	In contrast, a differencing medium is a "delta" to some other medium and
9103	contains only those sectors which differ from that other medium, which is
9104	then called a <i>parent</i>. The differencing medium is said to be
9105	<i>linked to</i> that parent. The parent may be itself a differencing
9106	medium, thus forming a chain of linked media. The last element in that
9107	chain must always be a base medium. Note that several differencing
9108	media may be linked to the same parent medium.
9109
9110	Differencing media can be distinguished from base media by querying the
9111	<link to="#parent"/> attribute: base media do not have parents they would
9112	depend on, so the value of this attribute is always @c null for them.
9113	Using this attribute, it is possible to walk up the medium tree (from the
9114	child medium to its parent). It is also possible to walk down the tree
9115	using the <link to="#children"/> attribute.
9116
9117	Note that the type of all differencing media is "normal"; all other
9118	values are meaningless for them. Base media may be of any type.
9119
9120	<h3>Creating hard disks</h3>
9121
9122	New base hard disks are created using
9123	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9124	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
9125	disks are usually implicitly created by VirtualBox when needed but may
9126	also be created explicitly using <link to="#createDiffStorage"/>.
9127
9128	After the hard disk is successfully created (including the storage unit)
9129	or opened, it becomes a known hard disk (remembered in the internal media
9130	registry). Known hard disks can be attached to a virtual machine, accessed
9131	through <link to="IVirtualBox::findMedium"/> or enumerated using the
9132	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9133
9134	The following methods, besides <link to="IMedium::close"/>,
9135	automatically remove the hard disk from the media registry:
9136	<ul>
9137	<li><link to="#deleteStorage"/></li>
9138	<li><link to="#mergeTo"/></li>
9139	</ul>
9140
9141	If the storage unit of the hard disk is a regular file in the host's
9142	file system then the rules stated in the description of the
9143	<link to="IMedium::location"/> attribute apply when setting its value.
9144
9145	<h4>Automatic composition of the file name part</h4>
9146
9147	Another extension to the <link to="IMedium::location"/> attribute is that
9148	there is a possibility to cause VirtualBox to compose a unique value for
9149	the file name part of the location using the UUID of the hard disk. This
9150	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9151	e.g. before the storage unit is created, and works as follows. You set the
9152	value of the <link to="IMedium::location"/> attribute to a location
9153	specification which only contains the path specification but not the file
9154	name part and ends with either a forward slash or a backslash character.
9155	In response, VirtualBox will generate a new UUID for the hard disk and
9156	compose the file name using the following pattern:
9157	<pre>
9158	<path>/{<uuid>}.<ext>
9159	</pre>
9160	where <tt><path></tt> is the supplied path specification,
9161	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9162	is the default extension for the storage format of this hard disk. After
9163	that, you may call any of the methods that create a new hard disk storage
9164	unit and they will use the generated UUID and file name.
9165
9166	<h3>Attaching Hard Disks</h3>
9167
9168	Hard disks are attached to virtual machines using the
9169	<link to="IMachine::attachDevice"/> method and detached using the
9170	<link to="IMachine::detachDevice"/> method. Depending on their
9171	<link to="#type"/>, hard disks are attached either
9172	<i>directly</i> or <i>indirectly</i>.
9173
9174	When a hard disk is being attached directly, it is associated with the
9175	virtual machine and used for hard disk operations when the machine is
9176	running. When a hard disk is being attached indirectly, a new differencing
9177	hard disk linked to it is implicitly created and this differencing hard
9178	disk is associated with the machine and used for hard disk operations.
9179	This also means that if <link to="IMachine::attachDevice"/> performs
9180	a direct attachment then the same hard disk will be returned in response
9181	to the subsequent <link to="IMachine::getMedium"/> call; however if
9182	an indirect attachment is performed then
9183	<link to="IMachine::getMedium"/> will return the implicitly created
9184	differencing hard disk, not the original one passed to <link
9185	to="IMachine::attachDevice"/>. In detail:
9186
9187	<ul>
9188	<li><b>Normal base</b> hard disks that do not have children (i.e.
9189	differencing hard disks linked to them) and that are not already
9190	attached to virtual machines in snapshots are attached <b>directly</b>.
9191	Otherwise, they are attached <b>indirectly</b> because having
9192	dependent children or being part of the snapshot makes it impossible
9193	to modify hard disk contents without breaking the integrity of the
9194	dependent party. The <link to="#readOnly"/> attribute allows to
9195	quickly determine the kind of the attachment for the given hard
9196	disk. Note that if a normal base hard disk is to be indirectly
9197	attached to a virtual machine with snapshots then a special
9198	procedure called <i>smart attachment</i> is performed (see below).</li>
9199	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9200	they are attached <b>directly</b> if they do not have children and are
9201	not attached to virtual machines in snapshots, and <b>indirectly</b>
9202	otherwise. Note that the smart attachment procedure is never performed
9203	for differencing hard disks.</li>
9204	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9205	they are designed to be non-writable. If an immutable hard disk is
9206	attached to a virtual machine with snapshots then a special
9207	procedure called smart attachment is performed (see below).</li>
9208	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9209	also as designed. This also means that writethrough hard disks cannot
9210	have other hard disks linked to them at all.</li>
9211	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9212	also as designed. This also means that shareable hard disks cannot
9213	have other hard disks linked to them at all. They behave almost
9214	like writethrough hard disks, except that shareable hard disks can
9215	be attached to several virtual machines which are running, allowing
9216	concurrent accesses. You need special cluster software running in
9217	the virtual machines to make use of such disks.</li>
9218	</ul>
9219
9220	Note that the same hard disk, regardless of its type, may be attached to
9221	more than one virtual machine at a time. In this case, the machine that is
9222	started first gains exclusive access to the hard disk and attempts to
9223	start other machines having this hard disk attached will fail until the
9224	first machine is powered down.
9225
9226	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9227	that the given hard disk remains associated with the given machine after a
9228	successful <link to="IMachine::detachDevice"/> call until
9229	<link to="IMachine::saveSettings"/> is called to save all changes to
9230	machine settings to disk. This deferring is necessary to guarantee that
9231	the hard disk configuration may be restored at any time by a call to
9232	<link to="IMachine::discardSettings"/> before the settings
9233	are saved (committed).
9234
9235	Note that if <link to="IMachine::discardSettings"/> is called after
9236	indirectly attaching some hard disks to the machine but before a call to
9237	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9238	all differencing hard disks implicitly created by
9239	<link to="IMachine::attachDevice"/> for these indirect attachments.
9240	Such implicitly created hard disks will also be immediately deleted when
9241	detached explicitly using the <link to="IMachine::detachDevice"/>
9242	call if it is made before <link to="IMachine::saveSettings"/>. This
9243	implicit deletion is safe because newly created differencing hard
9244	disks do not contain any user data.
9245
9246	However, keep in mind that detaching differencing hard disks that were
9247	implicitly created by <link to="IMachine::attachDevice"/>
9248	before the last <link to="IMachine::saveSettings"/> call will
9249	<b>not</b> implicitly delete them as they may already contain some data
9250	(for example, as a result of virtual machine execution). If these hard
9251	disks are no more necessary, the caller can always delete them explicitly
9252	using <link to="#deleteStorage"/> after they are actually de-associated
9253	from this machine by the <link to="IMachine::saveSettings"/> call.
9254
9255	<h3>Smart Attachment</h3>
9256
9257	When normal base or immutable hard disks are indirectly attached to a
9258	virtual machine then some additional steps are performed to make sure the
9259	virtual machine will have the most recent "view" of the hard disk being
9260	attached. These steps include walking through the machine's snapshots
9261	starting from the current one and going through ancestors up to the first
9262	snapshot. Hard disks attached to the virtual machine in all
9263	of the encountered snapshots are checked whether they are descendants of
9264	the given normal base or immutable hard disk. The first found child (which
9265	is the differencing hard disk) will be used instead of the normal base or
9266	immutable hard disk as a parent for creating a new differencing hard disk
9267	that will be actually attached to the machine. And only if no descendants
9268	are found or if the virtual machine does not have any snapshots then the
9269	normal base or immutable hard disk will be used itself as a parent for
9270	this differencing hard disk.
9271
9272	It is easier to explain what smart attachment does using the
9273	following example:
9274	<pre>
9275	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9276
9277	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9278	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9279	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9280	Snapshot 4 (none) Snapshot 4 (none)
9281	CurState (none) CurState (D3->D2.vdi)
9282
9283	NOT
9284	...
9285	CurState (D3->B.vdi)
9286	</pre>
9287	The first column is the virtual machine configuration before the base hard
9288	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9289	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9290	mean that the hard disk that is actually attached to the machine is a
9291	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9292	another hard disk, <tt>B.vdi</tt>.
9293
9294	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9295	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9296	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9297	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9298	it cannot be attached directly and needs an indirect attachment (i.e.
9299	implicit creation of a new differencing hard disk). Due to the smart
9300	attachment procedure, the new differencing hard disk
9301	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9302	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9303	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9304	machine.
9305
9306	Note that if there is more than one descendant hard disk of the given base
9307	hard disk found in a snapshot, and there is an exact device, channel and
9308	bus match, then this exact match will be used. Otherwise, the youngest
9309	descendant will be picked up.
9310
9311	There is one more important aspect of the smart attachment procedure which
9312	is not related to snapshots at all. Before walking through the snapshots
9313	as described above, the backup copy of the current list of hard disk
9314	attachment is searched for descendants. This backup copy is created when
9315	the hard disk configuration is changed for the first time after the last
9316	<link to="IMachine::saveSettings"/> call and used by
9317	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9318	changes. When such a descendant is found in this backup copy, it will be
9319	simply re-attached back, without creating a new differencing hard disk for
9320	it. This optimization is necessary to make it possible to re-attach the
9321	base or immutable hard disk to a different bus, channel or device slot
9322	without losing the contents of the differencing hard disk actually
9323	attached to the machine in place of it.
9324	</desc>
9325
9326	<attribute name="id" type="uuid" mod="string" readonly="yes">
9327	<desc>
9328	UUID of the medium. For a newly created medium, this value is a randomly
9329	generated UUID.
9330
9331	<note>
9332	For media in one of MediumState_NotCreated, MediumState_Creating or
9333	MediumState_Deleting states, the value of this property is undefined
9334	and will most likely be an empty UUID.
9335	</note>
9336	</desc>
9337	</attribute>
9338
9339	<attribute name="description" type="wstring">
9340	<desc>
9341	Optional description of the medium. For a newly created medium the value
9342	of this attribute is an empty string.
9343
9344	Medium types that don't support this attribute will return E_NOTIMPL in
9345	attempt to get or set this attribute's value.
9346
9347	<note>
9348	For some storage types, reading this attribute may return an outdated
9349	(last known) value when <link to="#state"/> is <link
9350	to="MediumState_Inaccessible"/> or <link
9351	to="MediumState_LockedWrite"/> because the value of this attribute is
9352	stored within the storage unit itself. Also note that changing the
9353	attribute value is not possible in such case, as well as when the
9354	medium is the <link to="MediumState_LockedRead"/> state.
9355	</note>
9356	</desc>
9357	</attribute>
9358
9359	<attribute name="state" type="MediumState" readonly="yes">
9360	<desc>
9361	Returns the current medium state, which is the last state set by
9362	the accessibility check performed by <link to="#refreshState"/>.
9363	If that method has not yet been called on the medium, the state
9364	is "Inaccessible"; as opposed to truly inaccessible media, the
9365	value of <link to="#lastAccessError"/> will be an empty string in
9366	that case.
9367
9368	<note>As of version 3.1, this no longer performs an accessibility check
9369	automatically; call <link to="#refreshState"/> for that.
9370	</note>
9371	</desc>
9372	</attribute>
9373
9374	<attribute name="variant" type="unsigned long" readonly="yes">
9375	<desc>
9376	Returns the storage format variant information for this medium
9377	as a combination of the flags described at <link to="MediumVariant" />.
9378	Before <link to="#refreshState"/> is called this method returns
9379	an undefined value.
9380	</desc>
9381	</attribute>
9382
9383	<attribute name="location" type="wstring">
9384	<desc>
9385	Location of the storage unit holding medium data.
9386
9387	The format of the location string is medium type specific. For medium
9388	types using regular files in a host's file system, the location
9389	string is the full file name.
9390
9391	Some medium types may support changing the storage unit location by
9392	simply changing the value of this property. If this operation is not
9393	supported, the implementation will return E_NOTIMPL in attempt to set
9394	this attribute's value.
9395
9396	When setting a value of the location attribute which is a regular file
9397	in the host's file system, the given file name may be either relative to
9398	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9399	absolute. Note that if the given location specification does not contain
9400	the file extension part then a proper default extension will be
9401	automatically appended by the implementation depending on the medium type.
9402	</desc>
9403	</attribute>
9404
9405	<attribute name="name" type="wstring" readonly="yes">
9406	<desc>
9407	Name of the storage unit holding medium data.
9408
9409	The returned string is a short version of the <link to="#location"/>
9410	attribute that is suitable for representing the medium in situations
9411	where the full location specification is too long (such as lists
9412	and comboboxes in GUI frontends). This string is also used by frontends
9413	to sort the media list alphabetically when needed.
9414
9415	For example, for locations that are regular files in the host's file
9416	system, the value of this attribute is just the file name (+ extension),
9417	without the path specification.
9418
9419	Note that as opposed to the <link to="#location"/> attribute, the name
9420	attribute will not necessary be unique for a list of media of the
9421	given type and format.
9422	</desc>
9423	</attribute>
9424
9425	<attribute name="deviceType" type="DeviceType" readonly="yes">
9426	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9427	medium.</desc>
9428	</attribute>
9429
9430	<attribute name="hostDrive" type="boolean" readonly="yes">
9431	<desc>True if this corresponds to a drive on the host.</desc>
9432	</attribute>
9433
9434	<attribute name="size" type="long long" readonly="yes">
9435	<desc>
9436	Physical size of the storage unit used to hold medium data (in bytes).
9437
9438	<note>
9439	For media whose <link to="#state"/> is <link
9440	to="MediumState_Inaccessible"/>, the value of this property is the
9441	last known size. For <link to="MediumState_NotCreated"/> media,
9442	the returned value is zero.
9443	</note>
9444	</desc>
9445	</attribute>
9446
9447	<attribute name="format" type="wstring" readonly="yes">
9448	<desc>
9449	Storage format of this medium.
9450
9451	The value of this attribute is a string that specifies a backend used
9452	to store medium data. The storage format is defined when you create a
9453	new medium or automatically detected when you open an existing medium,
9454	and cannot be changed later.
9455
9456	The list of all storage formats supported by this VirtualBox
9457	installation can be obtained using
9458	<link to="ISystemProperties::mediumFormats"/>.
9459	</desc>
9460	</attribute>
9461
9462	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9463	<desc>
9464	Storage medium format object corresponding to this medium.
9465
9466	The value of this attribute is a reference to the medium format object
9467	that specifies the backend properties used to store medium data. The
9468	storage format is defined when you create a new medium or automatically
9469	detected when you open an existing medium, and cannot be changed later.
9470
9471	<note>@c null is returned if there is no associated medium format
9472	object. This can e.g. happen for medium objects representing host
9473	drives and other special medium objects.</note>
9474	</desc>
9475	</attribute>
9476
9477	<attribute name="type" type="MediumType">
9478	<desc>
9479	Type (role) of this medium.
9480
9481	The following constraints apply when changing the value of this
9482	attribute:
9483	<ul>
9484	<li>If a medium is attached to a virtual machine (either in the
9485	current state or in one of the snapshots), its type cannot be
9486	changed.
9487	</li>
9488	<li>As long as the medium has children, its type cannot be set
9489	to <link to="MediumType_Writethrough"/>.
9490	</li>
9491	<li>The type of all differencing media is
9492	<link to="MediumType_Normal"/> and cannot be changed.
9493	</li>
9494	</ul>
9495
9496	The type of a newly created or opened medium is set to
9497	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9498	which have a type of <link to="MediumType_Writethrough"/>.
9499	</desc>
9500	</attribute>
9501
9502	<attribute name="parent" type="IMedium" readonly="yes">
9503	<desc>
9504	Parent of this medium (the medium this medium is directly based
9505	on).
9506
9507	Only differencing media have parents. For base (non-differencing)
9508	media, @c null is returned.
9509	</desc>
9510	</attribute>
9511
9512	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9513	<desc>
9514	Children of this medium (all differencing media directly based
9515	on this medium). A @c null array is returned if this medium
9516	does not have any children.
9517	</desc>
9518	</attribute>
9519
9520	<attribute name="base" type="IMedium" readonly="yes">
9521	<desc>
9522	Base medium of this medium.
9523
9524	If this is a differencing medium, its base medium is the medium
9525	the given medium branch starts from. For all other types of media, this
9526	property returns the medium object itself (i.e. the same object this
9527	property is read on).
9528	</desc>
9529	</attribute>
9530
9531	<attribute name="readOnly" type="boolean" readonly="yes">
9532	<desc>
9533	Returns @c true if this medium is read-only and @c false otherwise.
9534
9535	A medium is considered to be read-only when its contents cannot be
9536	modified without breaking the integrity of other parties that depend on
9537	this medium such as its child media or snapshots of virtual machines
9538	where this medium is attached to these machines. If there are no
9539	children and no such snapshots then there is no dependency and the
9540	medium is not read-only.
9541
9542	The value of this attribute can be used to determine the kind of the
9543	attachment that will take place when attaching this medium to a
9544	virtual machine. If the value is @c false then the medium will
9545	be attached directly. If the value is @c true then the medium
9546	will be attached indirectly by creating a new differencing child
9547	medium for that. See the interface description for more information.
9548
9549	Note that all <link to="MediumType_Immutable">Immutable</link> media
9550	are always read-only while all
9551	<link to="MediumType_Writethrough">Writethrough</link> media are
9552	always not.
9553
9554	<note>
9555	The read-only condition represented by this attribute is related to
9556	the medium type and usage, not to the current
9557	<link to="IMedium::state">medium state</link> and not to the read-only
9558	state of the storage unit.
9559	</note>
9560	</desc>
9561	</attribute>
9562
9563	<attribute name="logicalSize" type="long long" readonly="yes">
9564	<desc>
9565	Logical size of this medium (in bytes), as reported to the
9566	guest OS running inside the virtual machine this medium is
9567	attached to. The logical size is defined when the medium is created
9568	and cannot be changed later.
9569
9570	<note>
9571	Reading this property on a differencing medium will return the size
9572	of its <link to="#base"/> medium.
9573	</note>
9574	<note>
9575	For media whose state is <link to="#state"/> is <link
9576	to="MediumState_Inaccessible"/>, the value of this property is the
9577	last known logical size. For <link to="MediumState_NotCreated"/>
9578	media, the returned value is zero.
9579	</note>
9580	</desc>
9581	</attribute>
9582
9583	<attribute name="autoReset" type="boolean">
9584	<desc>
9585	Whether this differencing medium will be automatically reset each
9586	time a virtual machine it is attached to is powered up. This
9587	attribute is automatically set to @c true for the last
9588	differencing image of an "immutable" medium (see
9589	<link to="MediumType" />).
9590
9591	See <link to="#reset"/> for more information about resetting
9592	differencing media.
9593
9594	<note>
9595	Reading this property on a base (non-differencing) medium will
9596	always @c false. Changing the value of this property in this
9597	case is not supported.
9598	</note>
9599
9600	<result name="VBOX_E_NOT_SUPPORTED">
9601	This is not a differencing medium (when changing the attribute
9602	value).
9603	</result>
9604	</desc>
9605	</attribute>
9606
9607	<attribute name="lastAccessError" type="wstring" readonly="yes">
9608	<desc>
9609	Text message that represents the result of the last accessibility
9610	check performed by <link to="#refreshState"/>.
9611
9612	An empty string is returned if the last accessibility check
9613	was successful or has not yet been called. As a result, if
9614	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9615	then <link to="#refreshState"/> has yet to be called; this is the
9616	default value of media after VirtualBox initialization.
9617	A non-empty string indicates a failure and should normally describe
9618	a reason of the failure (for example, a file read error).
9619	</desc>
9620	</attribute>
9621
9622	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9623	<desc>
9624	Array of UUIDs of all machines this medium is attached to.
9625
9626	A @c null array is returned if this medium is not attached to any
9627	machine or to any machine's snapshot.
9628
9629	<note>
9630	The returned array will include a machine even if this medium is not
9631	attached to that machine in the current state but attached to it in
9632	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9633	details.
9634	</note>
9635	</desc>
9636	</attribute>
9637
9638	<method name="setIDs">
9639	<desc>
9640	Changes the UUID and parent UUID for a hard disk medium.
9641	</desc>
9642	<param name="setImageId" type="boolean" dir="in">
9643	<desc>
9644	Select whether a new image UUID is set or not.
9645	</desc>
9646	</param>
9647	<param name="imageId" type="uuid" mod="string" dir="in">
9648	<desc>
9649	New UUID for the image. If an empty string is passed, then a new
9650	UUID is automatically created, provided that @a setImageId is @c true.
9651	Specifying a zero UUID is not allowed.
9652	</desc>
9653	</param>
9654	<param name="setParentId" type="boolean" dir="in">
9655	<desc>
9656	Select whether a new parent UUID is set or not.
9657	</desc>
9658	</param>
9659	<param name="parentId" type="uuid" mod="string" dir="in">
9660	<desc>
9661	New parent UUID for the image. If an empty string is passed, then a
9662	new UUID is automatically created, provided @a setParentId is
9663	@c true. A zero UUID is valid.
9664	</desc>
9665	</param>
9666	<result name="E_INVALIDARG">
9667	Invalid parameter combination.
9668	</result>
9669	<result name="VBOX_E_NOT_SUPPORTED">
9670	Medium is not a hard disk medium.
9671	</result>
9672	</method>
9673
9674	<method name="refreshState">
9675	<desc>
9676	If the current medium state (see <link to="MediumState"/>) is one of
9677	"Created", "Inaccessible" or "LockedRead", then this performs an
9678	accessibility check on the medium and sets the value of the <link to="#state"/>
9679	attribute accordingly; that value is also returned for convenience.
9680
9681	For all other state values, this does not perform a refresh but returns
9682	the state only.
9683
9684	The refresh, if performed, may take a long time (several seconds or even
9685	minutes, depending on the storage unit location and format) because it performs an
9686	accessibility check of the storage unit. This check may cause a significant
9687	delay if the storage unit of the given medium is, for example, a file located
9688	on a network share which is not currently accessible due to connectivity
9689	problems. In that case, the call will not return until a timeout
9690	interval defined by the host OS for this operation expires. For this reason,
9691	it is recommended to never read this attribute on the main UI thread to avoid
9692	making the UI unresponsive.
9693
9694	If the last known state of the medium is "Created" and the accessibility
9695	check fails, then the state would be set to "Inaccessible", and
9696	<link to="#lastAccessError"/> may be used to get more details about the
9697	failure. If the state of the medium is "LockedRead", then it remains the
9698	same, and a non-empty value of <link to="#lastAccessError"/> will
9699	indicate a failed accessibility check in this case.
9700
9701	Note that not all medium states are applicable to all medium types.
9702	</desc>
9703	<param name="state" type="MediumState" dir="return">
9704	<desc>
9705	New medium state.
9706	</desc>
9707	</param>
9708	</method>
9709
9710	<method name="getSnapshotIds">
9711	<desc>
9712	Returns an array of UUIDs of all snapshots of the given machine where
9713	this medium is attached to.
9714
9715	If the medium is attached to the machine in the current state, then the
9716	first element in the array will always be the ID of the queried machine
9717	(i.e. the value equal to the @c machineId argument), followed by
9718	snapshot IDs (if any).
9719
9720	If the medium is not attached to the machine in the current state, then
9721	the array will contain only snapshot IDs.
9722
9723	The returned array may be @c null if this medium is not attached
9724	to the given machine at all, neither in the current state nor in one of
9725	the snapshots.
9726	</desc>
9727	<param name="machineId" type="uuid" mod="string" dir="in">
9728	<desc>
9729	UUID of the machine to query.
9730	</desc>
9731	</param>
9732	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9733	<desc>
9734	Array of snapshot UUIDs of the given machine using this medium.
9735	</desc>
9736	</param>
9737	</method>
9738
9739	<method name="lockRead">
9740	<desc>
9741	Locks this medium for reading.
9742
9743	A read lock is shared: many clients can simultaneously lock the
9744	same medium for reading unless it is already locked for writing (see
9745	<link to="#lockWrite"/>) in which case an error is returned.
9746
9747	When the medium is locked for reading, it cannot be modified
9748	from within VirtualBox. This means that any method that changes
9749	the properties of this medium or contents of the storage unit
9750	will return an error (unless explicitly stated otherwise). That
9751	includes an attempt to start a virtual machine that wants to
9752	write to the the medium.
9753
9754	When the virtual machine is started up, it locks for reading all
9755	media it uses in read-only mode. If some medium cannot be locked
9756	for reading, the startup procedure will fail.
9757	A medium is typically locked for reading while it is used by a running
9758	virtual machine but has a depending differencing image that receives
9759	the actual write operations. This way one base medium can have
9760	multiple child differencing images which can be written to
9761	simultaneously. Read-only media such as DVD and floppy images are
9762	also locked for reading only (so they can be in use by multiple
9763	machines simultaneously).
9764
9765	A medium is also locked for reading when it is the source of a
9766	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9767
9768	The medium locked for reading must be unlocked using the <link
9769	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9770	can be nested and must be followed by the same number of paired
9771	<link to="#unlockRead"/> calls.
9772
9773	This method sets the medium state (see <link to="#state"/>) to
9774	"LockedRead" on success. The medium's previous state must be
9775	one of "Created", "Inaccessible" or "LockedRead".
9776
9777	Locking an inaccessible medium is not an error; this method performs
9778	a logical lock that prevents modifications of this medium through
9779	the VirtualBox API, not a physical file-system lock of the underlying
9780	storage unit.
9781
9782	This method returns the current state of the medium
9783	<i>before</i> the operation.
9784
9785	<result name="VBOX_E_INVALID_OBJECT_STATE">
9786	Invalid medium state (e.g. not created, locked, inaccessible,
9787	creating, deleting).
9788	</result>
9789
9790	</desc>
9791	<param name="state" type="MediumState" dir="return">
9792	<desc>
9793	State of the medium after the operation.
9794	</desc>
9795	</param>
9796	</method>
9797
9798	<method name="unlockRead">
9799	<desc>
9800	Cancels the read lock previously set by <link to="#lockRead"/>.
9801
9802	For both success and failure, this method returns the current state
9803	of the medium <i>after</i> the operation.
9804
9805	See <link to="#lockRead"/> for more details.
9806
9807	<result name="VBOX_E_INVALID_OBJECT_STATE">
9808	Medium not locked for reading.
9809	</result>
9810
9811	</desc>
9812	<param name="state" type="MediumState" dir="return">
9813	<desc>
9814	State of the medium after the operation.
9815	</desc>
9816	</param>
9817	</method>
9818
9819	<method name="lockWrite">
9820	<desc>
9821	Locks this medium for writing.
9822
9823	A write lock, as opposed to <link to="#lockRead"/>, is
9824	exclusive: there may be only one client holding a write lock,
9825	and there may be no read locks while the write lock is held.
9826	As a result, read-locking fails if a write lock is held, and
9827	write-locking fails if either a read or another write lock is held.
9828
9829	When a medium is locked for writing, it cannot be modified
9830	from within VirtualBox, and it is not guaranteed that the values
9831	of its properties are up-to-date. Any method that changes the
9832	properties of this medium or contents of the storage unit will
9833	return an error (unless explicitly stated otherwise).
9834
9835	When a virtual machine is started up, it locks for writing all
9836	media it uses to write data to. If any medium could not be locked
9837	for writing, the startup procedure will fail. If a medium has
9838	differencing images, then while the machine is running, only
9839	the last ("leaf") differencing image is locked for writing,
9840	whereas its parents are locked for reading only.
9841
9842	A medium is also locked for writing when it is the target of a
9843	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9844
9845	The medium locked for writing must be unlocked using the <link
9846	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9847
9848	This method sets the medium state (see <link to="#state"/>) to
9849	"LockedWrite" on success. The medium's previous state must be
9850	either "Created" or "Inaccessible".
9851
9852	Locking an inaccessible medium is not an error; this method performs
9853	a logical lock that prevents modifications of this medium through
9854	the VirtualBox API, not a physical file-system lock of the underlying
9855	storage unit.
9856
9857	For both, success and failure, this method returns the current
9858	state of the medium <i>before</i> the operation.
9859
9860	<result name="VBOX_E_INVALID_OBJECT_STATE">
9861	Invalid medium state (e.g. not created, locked, inaccessible,
9862	creating, deleting).
9863	</result>
9864
9865	</desc>
9866	<param name="state" type="MediumState" dir="return">
9867	<desc>
9868	State of the medium after the operation.
9869	</desc>
9870	</param>
9871	</method>
9872
9873	<method name="unlockWrite">
9874	<desc>
9875	Cancels the write lock previously set by <link to="#lockWrite"/>.
9876
9877	For both success and failure, this method returns the current
9878	state of the medium <i>after</i> the operation.
9879
9880	See <link to="#lockWrite"/> for more details.
9881
9882	<result name="VBOX_E_INVALID_OBJECT_STATE">
9883	Medium not locked for writing.
9884	</result>
9885
9886	</desc>
9887	<param name="state" type="MediumState" dir="return">
9888	<desc>
9889	State of the medium after the operation.
9890	</desc>
9891	</param>
9892	</method>
9893
9894	<method name="close">
9895	<desc>
9896	Closes this medium.
9897
9898	The medium must not be attached to any known virtual machine
9899	and must not have any known child media, otherwise the
9900	operation will fail.
9901
9902	When the medium is successfully closed, it is removed from
9903	the list of registered media, but its storage unit is not
9904	deleted. In particular, this means that this medium can
9905	later be opened again using the <link to="IVirtualBox::openMedium"/>
9906	call.
9907
9908	Note that after this method successfully returns, the given medium
9909	object becomes uninitialized. This means that any attempt
9910	to call any of its methods or attributes will fail with the
9911	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
9912
9913	<result name="VBOX_E_INVALID_OBJECT_STATE">
9914	Invalid medium state (other than not created, created or
9915	inaccessible).
9916	</result>
9917	<result name="VBOX_E_OBJECT_IN_USE">
9918	Medium attached to virtual machine.
9919	</result>
9920	<result name="VBOX_E_FILE_ERROR">
9921	Settings file not accessible.
9922	</result>
9923	<result name="VBOX_E_XML_ERROR">
9924	Could not parse the settings file.
9925	</result>
9926
9927	</desc>
9928	</method>
9929
9930	<!-- storage methods -->
9931
9932	<method name="getProperty">
9933	<desc>
9934	Returns the value of the custom medium property with the given name.
9935
9936	The list of all properties supported by the given medium format can
9937	be obtained with <link to="IMediumFormat::describeProperties"/>.
9938
9939	Note that if this method returns an empty string in @a value, the
9940	requested property is supported but currently not assigned any value.
9941
9942	<result name="VBOX_E_OBJECT_NOT_FOUND">
9943	Requested property does not exist (not supported by the format).
9944	</result>
9945	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9946	</desc>
9947	<param name="name" type="wstring" dir="in">
9948	<desc>Name of the property to get.</desc>
9949	</param>
9950	<param name="value" type="wstring" dir="return">
9951	<desc>Current property value.</desc>
9952	</param>
9953	</method>
9954
9955	<method name="setProperty">
9956	<desc>
9957	Sets the value of the custom medium property with the given name.
9958
9959	The list of all properties supported by the given medium format can
9960	be obtained with <link to="IMediumFormat::describeProperties"/>.
9961
9962	Note that setting the property value to @c null or an empty string is
9963	equivalent to deleting the existing value. A default value (if it is
9964	defined for this property) will be used by the format backend in this
9965	case.
9966
9967	<result name="VBOX_E_OBJECT_NOT_FOUND">
9968	Requested property does not exist (not supported by the format).
9969	</result>
9970	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
9971	</desc>
9972	<param name="name" type="wstring" dir="in">
9973	<desc>Name of the property to set.</desc>
9974	</param>
9975	<param name="value" type="wstring" dir="in">
9976	<desc>Property value to set.</desc>
9977	</param>
9978	</method>
9979
9980	<method name="getProperties">
9981	<desc>
9982	Returns values for a group of properties in one call.
9983
9984	The names of the properties to get are specified using the @a names
9985	argument which is a list of comma-separated property names or
9986	an empty string if all properties are to be returned. Note that currently
9987	the value of this argument is ignored and the method always returns all
9988	existing properties.
9989
9990	The list of all properties supported by the given medium format can
9991	be obtained with <link to="IMediumFormat::describeProperties"/>.
9992
9993	The method returns two arrays, the array of property names corresponding
9994	to the @a names argument and the current values of these properties.
9995	Both arrays have the same number of elements with each elemend at the
9996	given index in the first array corresponds to an element at the same
9997	index in the second array.
9998
9999	Note that for properties that do not have assigned values,
10000	an empty string is returned at the appropriate index in the
10001	@a returnValues array.
10002
10003	</desc>
10004	<param name="names" type="wstring" dir="in">
10005	<desc>
10006	Names of properties to get.
10007	</desc>
10008	</param>
10009	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10010	<desc>Names of returned properties.</desc>
10011	</param>
10012	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10013	<desc>Values of returned properties.</desc>
10014	</param>
10015	</method>
10016
10017	<method name="setProperties">
10018	<desc>
10019	Sets values for a group of properties in one call.
10020
10021	The names of the properties to set are passed in the @a names
10022	array along with the new values for them in the @a values array. Both
10023	arrays have the same number of elements with each elemend at the given
10024	index in the first array corresponding to an element at the same index
10025	in the second array.
10026
10027	If there is at least one property name in @a names that is not valid,
10028	the method will fail before changing the values of any other properties
10029	from the @a names array.
10030
10031	Using this method over <link to="#setProperty"/> is preferred if you
10032	need to set several properties at once since it will result into less
10033	IPC calls.
10034
10035	The list of all properties supported by the given medium format can
10036	be obtained with <link to="IMediumFormat::describeProperties"/>.
10037
10038	Note that setting the property value to @c null or an empty string is
10039	equivalent to deleting the existing value. A default value (if it is
10040	defined for this property) will be used by the format backend in this
10041	case.
10042	</desc>
10043	<param name="names" type="wstring" safearray="yes" dir="in">
10044	<desc>Names of properties to set.</desc>
10045	</param>
10046	<param name="values" type="wstring" safearray="yes" dir="in">
10047	<desc>Values of properties to set.</desc>
10048	</param>
10049	</method>
10050
10051	<!-- storage methods -->
10052
10053	<method name="createBaseStorage">
10054	<desc>
10055	Starts creating a hard disk storage unit (fixed/dynamic, according
10056	to the variant flags) in in the background. The previous storage unit
10057	created for this object, if any, must first be deleted using
10058	<link to="#deleteStorage"/>, otherwise the operation will fail.
10059
10060	Before the operation starts, the medium is placed in
10061	<link to="MediumState_Creating"/> state. If the create operation
10062	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10063	state.
10064
10065	After the returned progress object reports that the operation has
10066	successfully completed, the medium state will be set to <link
10067	to="MediumState_Created"/>, the medium will be remembered by this
10068	VirtualBox installation and may be attached to virtual machines.
10069
10070	<result name="VBOX_E_NOT_SUPPORTED">
10071	The variant of storage creation operation is not supported. See <link
10072	to="IMediumFormat::capabilities"/>.
10073	</result>
10074	</desc>
10075	<param name="logicalSize" type="long long" dir="in">
10076	<desc>Maximum logical size of the medium in bytes.</desc>
10077	</param>
10078	<param name="variant" type="unsigned long" dir="in">
10079	<desc>Exact image variant which should be created (as a combination of
10080	<link to="MediumVariant" /> flags).</desc>
10081	</param>
10082	<param name="progress" type="IProgress" dir="return">
10083	<desc>Progress object to track the operation completion.</desc>
10084	</param>
10085	</method>
10086
10087	<method name="deleteStorage">
10088	<desc>
10089	Starts deleting the storage unit of this medium.
10090
10091	The medium must not be attached to any known virtual machine and must
10092	not have any known child media, otherwise the operation will fail.
10093	It will also fail if there is no storage unit to delete or if deletion
10094	is already in progress, or if the medium is being in use (locked for
10095	read or for write) or inaccessible. Therefore, the only valid state for
10096	this operation to succeed is <link to="MediumState_Created"/>.
10097
10098	Before the operation starts, the medium is placed in
10099	<link to="MediumState_Deleting"/> state and gets removed from the list
10100	of remembered hard disks (media registry). If the delete operation
10101	fails, the medium will be remembered again and placed back to
10102	<link to="MediumState_Created"/> state.
10103
10104	After the returned progress object reports that the operation is
10105	complete, the medium state will be set to
10106	<link to="MediumState_NotCreated"/> and you will be able to use one of
10107	the storage creation methods to create it again.
10108
10109	<see>#close()</see>
10110
10111	<result name="VBOX_E_OBJECT_IN_USE">
10112	Medium is attached to a virtual machine.
10113	</result>
10114	<result name="VBOX_E_NOT_SUPPORTED">
10115	Storage deletion is not allowed because neither of storage creation
10116	operations are supported. See
10117	<link to="IMediumFormat::capabilities"/>.
10118	</result>
10119
10120	<note>
10121	If the deletion operation fails, it is not guaranteed that the storage
10122	unit still exists. You may check the <link to="IMedium::state"/> value
10123	to answer this question.
10124	</note>
10125	</desc>
10126	<param name="progress" type="IProgress" dir="return">
10127	<desc>Progress object to track the operation completion.</desc>
10128	</param>
10129	</method>
10130
10131	<!-- diff methods -->
10132
10133	<method name="createDiffStorage">
10134	<desc>
10135	Starts creating an empty differencing storage unit based on this
10136	medium in the format and at the location defined by the @a target
10137	argument.
10138
10139	The target medium must be in <link to="MediumState_NotCreated"/>
10140	state (i.e. must not have an existing storage unit). Upon successful
10141	completion, this operation will set the type of the target medium to
10142	<link to="MediumType_Normal"/> and create a storage unit necessary to
10143	represent the differencing medium data in the given format (according
10144	to the storage format of the target object).
10145
10146	After the returned progress object reports that the operation is
10147	successfully complete, the target medium gets remembered by this
10148	VirtualBox installation and may be attached to virtual machines.
10149
10150	<note>
10151	The medium will be set to <link to="MediumState_LockedRead"/>
10152	state for the duration of this operation.
10153	</note>
10154	<result name="VBOX_E_OBJECT_IN_USE">
10155	Medium not in @c NotCreated state.
10156	</result>
10157	</desc>
10158	<param name="target" type="IMedium" dir="in">
10159	<desc>Target medium.</desc>
10160	</param>
10161	<param name="variant" type="unsigned long" dir="in">
10162	<desc>Exact image variant which should be created (as a combination of
10163	<link to="MediumVariant" /> flags).</desc>
10164	</param>
10165	<param name="progress" type="IProgress" dir="return">
10166	<desc>Progress object to track the operation completion.</desc>
10167	</param>
10168	</method>
10169
10170	<method name="mergeTo">
10171	<desc>
10172	Starts merging the contents of this medium and all intermediate
10173	differencing media in the chain to the given target medium.
10174
10175	The target medium must be either a descendant of this medium or
10176	its ancestor (otherwise this method will immediately return a failure).
10177	It follows that there are two logical directions of the merge operation:
10178	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10179	ancestor (<i>backward merge</i>). Let us consider the following medium
10180	chain:
10181
10182	<pre>Base <- Diff_1 <- Diff_2</pre>
10183
10184	Here, calling this method on the <tt>Base</tt> medium object with
10185	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10186	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10187	merge. Note that in both cases the contents of the resulting medium
10188	will be the same, the only difference is the medium object that takes
10189	the result of the merge operation. In case of the forward merge in the
10190	above example, the result will be written to <tt>Diff_2</tt>; in case of
10191	the backward merge, the result will be written to <tt>Base</tt>. In
10192	other words, the result of the operation is always stored in the target
10193	medium.
10194
10195	Upon successful operation completion, the storage units of all media in
10196	the chain between this (source) medium and the target medium, including
10197	the source medium itself, will be automatically deleted and the
10198	relevant medium objects (including this medium) will become
10199	uninitialized. This means that any attempt to call any of
10200	their methods or attributes will fail with the
10201	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10202	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10203	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10204	Note that <tt>Diff_2</tt> in this case will become a base medium
10205	itself since it will no longer be based on any other medium.
10206
10207	Considering the above, all of the following conditions must be met in
10208	order for the merge operation to succeed:
10209	<ul>
10210	<li>
10211	Neither this (source) medium nor any intermediate
10212	differencing medium in the chain between it and the target
10213	medium is attached to any virtual machine.
10214	</li>
10215	<li>
10216	Neither the source medium nor the target medium is an
10217	<link to="MediumType_Immutable"/> medium.
10218	</li>
10219	<li>
10220	The part of the medium tree from the source medium to the
10221	target medium is a linear chain, i.e. all medium in this
10222	chain have exactly one child which is the next medium in this
10223	chain. The only exception from this rule is the target medium in
10224	the forward merge operation; it is allowed to have any number of
10225	child media because the merge operation will not change its
10226	logical contents (as it is seen by the guest OS or by children).
10227	</li>
10228	<li>
10229	None of the involved media are in
10230	<link to="MediumState_LockedRead"/> or
10231	<link to="MediumState_LockedWrite"/> state.
10232	</li>
10233	</ul>
10234
10235	<note>
10236	This (source) medium and all intermediates will be placed to <link
10237	to="MediumState_Deleting"/> state and the target medium will be
10238	placed to <link to="MediumState_LockedWrite"/> state and for the
10239	duration of this operation.
10240	</note>
10241	</desc>
10242	<param name="target" type="IMedium" dir="in">
10243	<desc>Target medium.</desc>
10244	</param>
10245	<param name="progress" type="IProgress" dir="return">
10246	<desc>Progress object to track the operation completion.</desc>
10247	</param>
10248	</method>
10249
10250	<!-- clone method -->
10251
10252	<method name="cloneTo">
10253	<desc>
10254	Starts creating a clone of this medium in the format and at the
10255	location defined by the @a target argument.
10256
10257	The target medium must be either in <link to="MediumState_NotCreated"/>
10258	state (i.e. must not have an existing storage unit) or in
10259	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10260	big enough to hold the data or else the copy will be partial). Upon
10261	successful completion, the cloned medium will contain exactly the
10262	same sector data as the medium being cloned, except that in the
10263	first case a new UUID for the clone will be randomly generated, and in
10264	the second case the UUID will remain unchanged.
10265
10266	The @a parent argument defines which medium will be the parent
10267	of the clone. Passing a @c null reference indicates that the clone will
10268	be a base image, i.e. completely independent. It is possible to specify
10269	an arbitrary medium for this parameter, including the parent of the
10270	medium which is being cloned. Even cloning to a child of the source
10271	medium is possible. Note that when cloning to an existing image, the
10272	@a parent irgument is ignored.
10273
10274	After the returned progress object reports that the operation is
10275	successfully complete, the target medium gets remembered by this
10276	VirtualBox installation and may be attached to virtual machines.
10277
10278	<note>
10279	This medium will be placed to <link to="MediumState_LockedRead"/>
10280	state for the duration of this operation.
10281	</note>
10282	<result name="E_NOTIMPL">
10283	The specified cloning variant is not supported at the moment.
10284	</result>
10285	</desc>
10286	<param name="target" type="IMedium" dir="in">
10287	<desc>Target medium.</desc>
10288	</param>
10289	<param name="variant" type="unsigned long" dir="in">
10290	<desc>Exact image variant which should be created (as a combination of
10291	<link to="MediumVariant" /> flags).</desc>
10292	</param>
10293	<param name="parent" type="IMedium" dir="in">
10294	<desc>Parent of the cloned medium.</desc>
10295	</param>
10296	<param name="progress" type="IProgress" dir="return">
10297	<desc>Progress object to track the operation completion.</desc>
10298	</param>
10299	</method>
10300
10301	<!-- other methods -->
10302
10303	<method name="compact">
10304	<desc>
10305	Starts compacting of this medium. This means that the medium is
10306	transformed into a possibly more compact storage representation.
10307	This potentially creates temporary images, which can require a
10308	substantial amount of additional disk space.
10309
10310	This medium will be placed to <link to="MediumState_LockedWrite"/>
10311	state and all its parent media (if any) will be placed to
10312	<link to="MediumState_LockedRead"/> state for the duration of this
10313	operation.
10314
10315	Please note that the results can be either returned straight away,
10316	or later as the result of the background operation via the object
10317	returned via the @a progress parameter.
10318
10319	<result name="VBOX_E_NOT_SUPPORTED">
10320	Medium format does not support compacting (but potentially
10321	needs it).
10322	</result>
10323	</desc>
10324	<param name="progress" type="IProgress" dir="return">
10325	<desc>Progress object to track the operation completion.</desc>
10326	</param>
10327	</method>
10328
10329	<method name="resize">
10330	<desc>
10331	Starts resizing this medium. This means that the nominal size of the
10332	medium is set to the new value. Both increasing and decreasing the
10333	size is possible, and there are no safety checks, since VirtualBox
10334	does not make any assumptions about the medium contents.
10335
10336	Resizing usually needs additional disk space, and possibly also
10337	some temporary disk space. Note that resize does not create a full
10338	temporary copy of the medium, so the additional disk space requirement
10339	is usually much lower than using the clone operation.
10340
10341	This medium will be placed to <link to="MediumState_LockedWrite"/>
10342	state for the duration of this operation.
10343
10344	Please note that the results can be either returned straight away,
10345	or later as the result of the background operation via the object
10346	returned via the @a progress parameter.
10347
10348	<result name="VBOX_E_NOT_SUPPORTED">
10349	Medium format does not support resizing.
10350	</result>
10351	</desc>
10352	<param name="logicalSize" type="long long" dir="in">
10353	<desc>New nominal capacity of the medium in bytes.</desc>
10354	</param>
10355	<param name="progress" type="IProgress" dir="return">
10356	<desc>Progress object to track the operation completion.</desc>
10357	</param>
10358	</method>
10359
10360	<method name="reset">
10361	<desc>
10362	Starts erasing the contents of this differencing medium.
10363
10364	This operation will reset the differencing medium to its initial
10365	state when it does not contain any sector data and any read operation is
10366	redirected to its parent medium. This automatically gets called
10367	during VM power-up for every medium whose <link to="#autoReset" />
10368	attribute is @c true.
10369
10370	The medium will be write-locked for the duration of this operation (see
10371	<link to="#lockWrite" />).
10372
10373	<result name="VBOX_E_NOT_SUPPORTED">
10374	This is not a differencing medium.
10375	</result>
10376	<result name="VBOX_E_INVALID_OBJECT_STATE">
10377	Medium is not in <link to="MediumState_Created"/> or
10378	<link to="MediumState_Inaccessible"/> state.
10379	</result>
10380	</desc>
10381	<param name="progress" type="IProgress" dir="return">
10382	<desc>Progress object to track the operation completion.</desc>
10383	</param>
10384	</method>
10385
10386	</interface>
10387
10388
10389	<!--
10390	// IMediumFormat
10391	/////////////////////////////////////////////////////////////////////////
10392	-->
10393
10394	<enum
10395	name="DataType"
10396	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10397	>
10398	<const name="Int32" value="0"/>
10399	<const name="Int8" value="1"/>
10400	<const name="String" value="2"/>
10401	</enum>
10402
10403	<enum
10404	name="DataFlags"
10405	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10406	>
10407	<const name="None" value="0x00"/>
10408	<const name="Mandatory" value="0x01"/>
10409	<const name="Expert" value="0x02"/>
10410	<const name="Array" value="0x04"/>
10411	<const name="FlagMask" value="0x07"/>
10412	</enum>
10413
10414	<enum
10415	name="MediumFormatCapabilities"
10416	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10417	>
10418	<desc>
10419	Medium format capability flags.
10420	</desc>
10421
10422	<const name="Uuid" value="0x01">
10423	<desc>
10424	Supports UUIDs as expected by VirtualBox code.
10425	</desc>
10426	</const>
10427
10428	<const name="CreateFixed" value="0x02">
10429	<desc>
10430	Supports creating fixed size images, allocating all space instantly.
10431	</desc>
10432	</const>
10433
10434	<const name="CreateDynamic" value="0x04">
10435	<desc>
10436	Supports creating dynamically growing images, allocating space on
10437	demand.
10438	</desc>
10439	</const>
10440
10441	<const name="CreateSplit2G" value="0x08">
10442	<desc>
10443	Supports creating images split in chunks of a bit less than 2 GBytes.
10444	</desc>
10445	</const>
10446
10447	<const name="Differencing" value="0x10">
10448	<desc>
10449	Supports being used as a format for differencing media (see <link
10450	to="IMedium::createDiffStorage"/>).
10451	</desc>
10452	</const>
10453
10454	<const name="Asynchronous" value="0x20">
10455	<desc>
10456	Supports asynchronous I/O operations for at least some configurations.
10457	</desc>
10458	</const>
10459
10460	<const name="File" value="0x40">
10461	<desc>
10462	The format backend operates on files (the <link to="IMedium::location"/>
10463	attribute of the medium specifies a file used to store medium
10464	data; for a list of supported file extensions see
10465	<link to="IMediumFormat::describeFileExtensions"/>).
10466	</desc>
10467	</const>
10468
10469	<const name="Properties" value="0x80">
10470	<desc>
10471	The format backend uses the property interface to configure the storage
10472	location and properties (the <link to="IMediumFormat::describeProperties"/>
10473	method is used to get access to properties supported by the given medium format).
10474	</desc>
10475	</const>
10476
10477	<const name="TcpNetworking" value="0x100">
10478	<desc>
10479	The format backend uses the TCP networking interface for network access.
10480	</desc>
10481	</const>
10482
10483	<const name="VFS" value="0x200">
10484	<desc>
10485	The format backend supports virtual filesystem functionality.
10486	</desc>
10487	</const>
10488
10489	<const name="CapabilityMask" value="0x3FF"/>
10490	</enum>
10491
10492	<interface
10493	name="IMediumFormat" extends="$unknown"
10494	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10495	wsmap="managed"
10496	>
10497	<desc>
10498	The IMediumFormat interface represents a medium format.
10499
10500	Each medium format has an associated backend which is used to handle
10501	media stored in this format. This interface provides information
10502	about the properties of the associated backend.
10503
10504	Each medium format is identified by a string represented by the
10505	<link to="#id"/> attribute. This string is used in calls like
10506	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10507	format.
10508
10509	The list of all supported medium formats can be obtained using
10510	<link to="ISystemProperties::mediumFormats"/>.
10511
10512	<see>IMedium</see>
10513	</desc>
10514
10515	<attribute name="id" type="wstring" readonly="yes">
10516	<desc>
10517	Identifier of this format.
10518
10519	The format identifier is a non-@c null non-empty ASCII string. Note that
10520	this string is case-insensitive. This means that, for example, all of
10521	the following strings:
10522	<pre>
10523	"VDI"
10524	"vdi"
10525	"VdI"</pre>
10526	refer to the same medium format.
10527
10528	This string is used in methods of other interfaces where it is necessary
10529	to specify a medium format, such as
10530	<link to="IVirtualBox::createHardDisk"/>.
10531	</desc>
10532	</attribute>
10533
10534	<attribute name="name" type="wstring" readonly="yes">
10535	<desc>
10536	Human readable description of this format.
10537
10538	Mainly for use in file open dialogs.
10539	</desc>
10540	</attribute>
10541
10542	<attribute name="capabilities" type="unsigned long" readonly="yes">
10543	<desc>
10544	Capabilities of the format as a set of bit flags.
10545
10546	For the meaning of individual capability flags see
10547	<link to="MediumFormatCapabilities"/>.
10548	</desc>
10549	</attribute>
10550
10551	<method name="describeFileExtensions">
10552	<desc>
10553	Returns two arrays describing the supported file extensions.
10554
10555	The first array contains the supported extensions and the seconds one
10556	the type each extension supports. Both have the same size.
10557
10558	Note that some backends do not work on files, so this array may be
10559	empty.
10560
10561	<see>IMediumFormat::capabilities</see>
10562	</desc>
10563	<param name="extensions" type="wstring" safearray="yes" dir="out">
10564	<desc>The array of supported extensions.</desc>
10565	</param>
10566	<param name="type" type="DeviceType" safearray="yes" dir="out">
10567	<desc>The array which indicates the device type for every given extension.</desc>
10568	</param>
10569	</method>
10570
10571	<method name="describeProperties">
10572	<desc>
10573	Returns several arrays describing the properties supported by this
10574	format.
10575
10576	An element with the given index in each array describes one
10577	property. Thus, the number of elements in each returned array is the
10578	same and corresponds to the number of supported properties.
10579
10580	The returned arrays are filled in only if the
10581	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10582	All arguments must be non-@c null.
10583
10584	<see>DataType</see>
10585	<see>DataFlags</see>
10586	</desc>
10587
10588	<param name="names" type="wstring" safearray="yes" dir="out">
10589	<desc>Array of property names.</desc>
10590	</param>
10591	<param name="description" type="wstring" safearray="yes" dir="out">
10592	<desc>Array of property descriptions.</desc>
10593	</param>
10594	<param name="types" type="DataType" safearray="yes" dir="out">
10595	<desc>Array of property types.</desc>
10596	</param>
10597	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10598	<desc>Array of property flags.</desc>
10599	</param>
10600	<param name="defaults" type="wstring" safearray="yes" dir="out">
10601	<desc>Array of default property values.</desc>
10602	</param>
10603	</method>
10604
10605	</interface>
10606
10607
10608	<!--
10609	// IKeyboard
10610	/////////////////////////////////////////////////////////////////////////
10611	-->
10612
10613	<interface
10614	name="IKeyboard" extends="$unknown"
10615	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10616	wsmap="managed"
10617	>
10618	<desc>
10619	The IKeyboard interface represents the virtual machine's keyboard. Used
10620	in <link to="IConsole::keyboard"/>.
10621
10622	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10623	to the virtual machine.
10624
10625	</desc>
10626	<method name="putScancode">
10627	<desc>Sends a scancode to the keyboard.
10628
10629	<result name="VBOX_E_IPRT_ERROR">
10630	Could not send scan code to virtual keyboard.
10631	</result>
10632
10633	</desc>
10634	<param name="scancode" type="long" dir="in"/>
10635	</method>
10636
10637	<method name="putScancodes">
10638	<desc>Sends an array of scancodes to the keyboard.
10639
10640	<result name="VBOX_E_IPRT_ERROR">
10641	Could not send all scan codes to virtual keyboard.
10642	</result>
10643
10644	</desc>
10645	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10646	<param name="codesStored" type="unsigned long" dir="return"/>
10647	</method>
10648
10649	<method name="putCAD">
10650	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10651	function is nothing special, it is just a convenience function
10652	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10653
10654	<result name="VBOX_E_IPRT_ERROR">
10655	Could not send all scan codes to virtual keyboard.
10656	</result>
10657
10658	</desc>
10659	</method>
10660
10661	<attribute name="eventSource" type="IEventSource" readonly="yes">
10662	<desc>
10663	Event source for keyboard events.
10664	</desc>
10665	</attribute>
10666
10667	</interface>
10668
10669
10670	<!--
10671	// IMouse
10672	/////////////////////////////////////////////////////////////////////////
10673	-->
10674
10675	<enum
10676	name="MouseButtonState"
10677	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10678	>
10679	<desc>
10680	Mouse button state.
10681	</desc>
10682
10683	<const name="LeftButton" value="0x01"/>
10684	<const name="RightButton" value="0x02"/>
10685	<const name="MiddleButton" value="0x04"/>
10686	<const name="WheelUp" value="0x08"/>
10687	<const name="WheelDown" value="0x10"/>
10688	<const name="XButton1" value="0x20"/>
10689	<const name="XButton2" value="0x40"/>
10690	<const name="MouseStateMask" value="0x7F"/>
10691	</enum>
10692
10693	<interface
10694	name="IMouse" extends="$unknown"
10695	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10696	wsmap="managed"
10697	>
10698	<desc>
10699	The IMouse interface represents the virtual machine's mouse. Used in
10700	<link to="IConsole::mouse"/>.
10701
10702	Through this interface, the virtual machine's virtual mouse can be
10703	controlled.
10704	</desc>
10705
10706	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10707	<desc>
10708	Whether the guest OS supports absolute mouse pointer positioning
10709	or not.
10710	<note>
10711	You can use the <link to="IMouseCapabilityChangedEvent"/>
10712	event to be instantly informed about changes of this attribute
10713	during virtual machine execution.
10714	</note>
10715	<see><link to="#putMouseEventAbsolute"/></see>
10716	</desc>
10717	</attribute>
10718
10719	<attribute name="relativeSupported" type="boolean" readonly="yes">
10720	<desc>
10721	Whether the guest OS supports relative mouse pointer positioning
10722	or not.
10723	<note>
10724	You can use the <link to="IMouseCapabilityChangedEvent"/>
10725	event to be instantly informed about changes of this attribute
10726	during virtual machine execution.
10727	</note>
10728	<see><link to="#putMouseEvent"/></see>
10729	</desc>
10730	</attribute>
10731
10732	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10733	<desc>
10734	Whether the guest OS can currently switch to drawing it's own mouse
10735	cursor on demand.
10736	<note>
10737	You can use the <link to="IMouseCapabilityChangedEvent"/>
10738	event to be instantly informed about changes of this attribute
10739	during virtual machine execution.
10740	</note>
10741	<see><link to="#putMouseEvent"/></see>
10742	</desc>
10743	</attribute>
10744
10745	<method name="putMouseEvent">
10746	<desc>
10747	Initiates a mouse event using relative pointer movements
10748	along x and y axis.
10749
10750	<result name="E_ACCESSDENIED">
10751	Console not powered up.
10752	</result>
10753	<result name="VBOX_E_IPRT_ERROR">
10754	Could not send mouse event to virtual mouse.
10755	</result>
10756
10757	</desc>
10758
10759	<param name="dx" type="long" dir="in">
10760	<desc>
10761	Amount of pixels the mouse should move to the right.
10762	Negative values move the mouse to the left.
10763	</desc>
10764	</param>
10765	<param name="dy" type="long" dir="in">
10766	<desc>
10767	Amount of pixels the mouse should move downwards.
10768	Negative values move the mouse upwards.
10769	</desc>
10770	</param>
10771	<param name="dz" type="long" dir="in">
10772	<desc>
10773	Amount of mouse wheel moves.
10774	Positive values describe clockwise wheel rotations,
10775	negative values describe counterclockwise rotations.
10776	</desc>
10777	</param>
10778	<param name="dw" type="long" dir="in">
10779	<desc>
10780	Amount of horizontal mouse wheel moves.
10781	Positive values describe a movement to the left,
10782	negative values describe a movement to the right.
10783	</desc>
10784	</param>
10785	<param name="buttonState" type="long" dir="in">
10786	<desc>
10787	The current state of mouse buttons. Every bit represents
10788	a mouse button as follows:
10789	<table>
10790	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10791	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10792	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10793	</table>
10794	A value of <tt>1</tt> means the corresponding button is pressed.
10795	otherwise it is released.
10796	</desc>
10797	</param>
10798	</method>
10799
10800	<method name="putMouseEventAbsolute">
10801	<desc>
10802	Positions the mouse pointer using absolute x and y coordinates.
10803	These coordinates are expressed in pixels and
10804	start from <tt>[1,1]</tt> which corresponds to the top left
10805	corner of the virtual display.
10806
10807	<result name="E_ACCESSDENIED">
10808	Console not powered up.
10809	</result>
10810	<result name="VBOX_E_IPRT_ERROR">
10811	Could not send mouse event to virtual mouse.
10812	</result>
10813
10814	<note>
10815	This method will have effect only if absolute mouse
10816	positioning is supported by the guest OS.
10817	</note>
10818
10819	<see><link to="#absoluteSupported"/></see>
10820	</desc>
10821
10822	<param name="x" type="long" dir="in">
10823	<desc>
10824	X coordinate of the pointer in pixels, starting from @c 1.
10825	</desc>
10826	</param>
10827	<param name="y" type="long" dir="in">
10828	<desc>
10829	Y coordinate of the pointer in pixels, starting from @c 1.
10830	</desc>
10831	</param>
10832	<param name="dz" type="long" dir="in">
10833	<desc>
10834	Amount of mouse wheel moves.
10835	Positive values describe clockwise wheel rotations,
10836	negative values describe counterclockwise rotations.
10837	</desc>
10838	</param>
10839	<param name="dw" type="long" dir="in">
10840	<desc>
10841	Amount of horizontal mouse wheel moves.
10842	Positive values describe a movement to the left,
10843	negative values describe a movement to the right.
10844	</desc>
10845	</param>
10846	<param name="buttonState" type="long" dir="in">
10847	<desc>
10848	The current state of mouse buttons. Every bit represents
10849	a mouse button as follows:
10850	<table>
10851	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10852	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10853	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10854	</table>
10855	A value of @c 1 means the corresponding button is pressed.
10856	otherwise it is released.
10857	</desc>
10858	</param>
10859	</method>
10860
10861	<attribute name="eventSource" type="IEventSource" readonly="yes">
10862	<desc>
10863	Event source for mouse events.
10864	</desc>
10865	</attribute>
10866
10867	</interface>
10868
10869	<!--
10870	// IDisplay
10871	/////////////////////////////////////////////////////////////////////////
10872	-->
10873
10874	<enum
10875	name="FramebufferPixelFormat"
10876	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
10877	>
10878	<desc>
10879	Format of the video memory buffer. Constants represented by this enum can
10880	be used to test for particular values of <link
10881	to="IFramebuffer::pixelFormat"/>. See also <link
10882	to="IFramebuffer::requestResize"/>.
10883
10884	See also www.fourcc.org for more information about FOURCC pixel formats.
10885	</desc>
10886
10887	<const name="Opaque" value="0">
10888	<desc>
10889	Unknown buffer format (the user may not assume any particular format of
10890	the buffer).
10891	</desc>
10892	</const>
10893	<const name="FOURCC_RGB" value="0x32424752">
10894	<desc>
10895	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
10896	bit layout).
10897	</desc>
10898	</const>
10899	</enum>
10900
10901	<interface
10902	name="IFramebuffer" extends="$unknown"
10903	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
10904	wsmap="suppress"
10905	>
10906	<attribute name="address" type="octet" mod="ptr" readonly="yes">
10907	<desc>Address of the start byte of the frame buffer.</desc>
10908	</attribute>
10909
10910	<attribute name="width" type="unsigned long" readonly="yes">
10911	<desc>Frame buffer width, in pixels.</desc>
10912	</attribute>
10913
10914	<attribute name="height" type="unsigned long" readonly="yes">
10915	<desc>Frame buffer height, in pixels.</desc>
10916	</attribute>
10917
10918	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
10919	<desc>
10920	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
10921	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
10922	are: 8, 15, 16, 24 and 32.
10923	</desc>
10924	</attribute>
10925
10926	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
10927	<desc>
10928	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
10929	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
10930	size of the scan line must be aligned to 32 bits.
10931	</desc>
10932	</attribute>
10933
10934	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
10935	<desc>
10936	Frame buffer pixel format. It's either one of the values defined by <link
10937	to="FramebufferPixelFormat"/> or a raw FOURCC code.
10938	<note>
10939	This attribute must never return <link
10940	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
10941	<link to="#address"/> points to must be always known.
10942	</note>
10943	</desc>
10944	</attribute>
10945
10946	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
10947	<desc>
10948	Defines whether this frame buffer uses the virtual video card's memory
10949	buffer (guest VRAM) directly or not. See <link
10950	to="IFramebuffer::requestResize"/> for more information.
10951	</desc>
10952	</attribute>
10953
10954	<attribute name="heightReduction" type="unsigned long" readonly="yes">
10955	<desc>
10956	Hint from the frame buffer about how much of the standard
10957	screen height it wants to use for itself. This information is
10958	exposed to the guest through the VESA BIOS and VMMDev interface
10959	so that it can use it for determining its video mode table. It
10960	is not guaranteed that the guest respects the value.
10961	</desc>
10962	</attribute>
10963
10964	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
10965	<desc>
10966	An alpha-blended overlay which is superposed over the frame buffer.
10967	The initial purpose is to allow the display of icons providing
10968	information about the VM state, including disk activity, in front
10969	ends which do not have other means of doing that. The overlay is
10970	designed to controlled exclusively by IDisplay. It has no locking
10971	of its own, and any changes made to it are not guaranteed to be
10972	visible until the affected portion of IFramebuffer is updated. The
10973	overlay can be created lazily the first time it is requested. This
10974	attribute can also return @c null to signal that the overlay is not
10975	implemented.
10976	</desc>
10977	</attribute>
10978
10979	<attribute name="winId" type="long long" readonly="yes">
10980	<desc>
10981	Platform-dependent identifier of the window where context of this
10982	frame buffer is drawn, or zero if there's no such window.
10983	</desc>
10984	</attribute>
10985
10986	<method name="lock">
10987	<desc>
10988	Locks the frame buffer.
10989	Gets called by the IDisplay object where this frame buffer is
10990	bound to.
10991	</desc>
10992	</method>
10993
10994	<method name="unlock">
10995	<desc>
10996	Unlocks the frame buffer.
10997	Gets called by the IDisplay object where this frame buffer is
10998	bound to.
10999	</desc>
11000	</method>
11001
11002	<method name="notifyUpdate">
11003	<desc>
11004	Informs about an update.
11005	Gets called by the display object where this buffer is
11006	registered.
11007	</desc>
11008	<param name="x" type="unsigned long" dir="in"/>
11009	<param name="y" type="unsigned long" dir="in"/>
11010	<param name="width" type="unsigned long" dir="in"/>
11011	<param name="height" type="unsigned long" dir="in"/>
11012	</method>
11013
11014	<method name="requestResize">
11015	<desc>
11016	Requests a size and pixel format change.
11017
11018	There are two modes of working with the video buffer of the virtual
11019	machine. The <i>indirect</i> mode implies that the IFramebuffer
11020	implementation allocates a memory buffer for the requested display mode
11021	and provides it to the virtual machine. In <i>direct</i> mode, the
11022	IFramebuffer implementation uses the memory buffer allocated and owned
11023	by the virtual machine. This buffer represents the video memory of the
11024	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11025	usually faster because the implementation gets a raw pointer to the
11026	guest VRAM buffer which it can directly use for visualizing the contents
11027	of the virtual display, as opposed to the indirect mode where the
11028	contents of guest VRAM are copied to the memory buffer provided by
11029	the implementation every time a display update occurs.
11030
11031	It is important to note that the direct mode is really fast only when
11032	the implementation uses the given guest VRAM buffer directly, for
11033	example, by blitting it to the window representing the virtual machine's
11034	display, which saves at least one copy operation comparing to the
11035	indirect mode. However, using the guest VRAM buffer directly is not
11036	always possible: the format and the color depth of this buffer may be
11037	not supported by the target window, or it may be unknown (opaque) as in
11038	case of text or non-linear multi-plane VGA video modes. In this case,
11039	the indirect mode (that is always available) should be used as a
11040	fallback: when the guest VRAM contents are copied to the
11041	implementation-provided memory buffer, color and format conversion is
11042	done automatically by the underlying code.
11043
11044	The @a pixelFormat parameter defines whether the direct mode is
11045	available or not. If @a pixelFormat is <link
11046	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11047	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11048	@a bytesPerLine parameters must be ignored and the implementation must use
11049	the indirect mode (where it provides its own buffer in one of the
11050	supported formats). In all other cases, @a pixelFormat together with
11051	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11052	buffer pointed to by the @a VRAM parameter and the implementation is
11053	free to choose which mode to use. To indicate that this frame buffer uses
11054	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11055	attribute must return @c true and <link to="#address"/> must
11056	return exactly the same address that is passed in the @a VRAM parameter
11057	of this method; otherwise it is assumed that the indirect strategy is
11058	chosen.
11059
11060	The @a width and @a height parameters represent the size of the
11061	requested display mode in both modes. In case of indirect mode, the
11062	provided memory buffer should be big enough to store data of the given
11063	display mode. In case of direct mode, it is guaranteed that the given
11064	@a VRAM buffer contains enough space to represent the display mode of the
11065	given size. Note that this frame buffer's <link to="#width"/> and <link
11066	to="#height"/> attributes must return exactly the same values as
11067	passed to this method after the resize is completed (see below).
11068
11069	The @a finished output parameter determines if the implementation has
11070	finished resizing the frame buffer or not. If, for some reason, the
11071	resize cannot be finished immediately during this call, @a finished
11072	must be set to @c false, and the implementation must call
11073	<link to="IDisplay::resizeCompleted"/> after it has returned from
11074	this method as soon as possible. If @a finished is @c false, the
11075	machine will not call any frame buffer methods until
11076	<link to="IDisplay::resizeCompleted"/> is called.
11077
11078	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11079	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11080	this frame buffer must return exactly the same values as specified in the
11081	parameters of this method, after the resize is completed. If the
11082	indirect mode is chosen, these attributes must return values describing
11083	the format of the implementation's own memory buffer <link
11084	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11085	value must always correlate with <link to="#pixelFormat"/>. Note that
11086	the <link to="#pixelFormat"/> attribute must never return <link
11087	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11088
11089	<note>
11090	This method is called by the IDisplay object under the
11091	<link to="#lock"/> provided by this IFramebuffer
11092	implementation. If this method returns @c false in @a finished, then
11093	this lock is not released until
11094	<link to="IDisplay::resizeCompleted"/> is called.
11095	</note>
11096	</desc>
11097	<param name="screenId" type="unsigned long" dir="in">
11098	<desc>
11099	Logical screen number. Must be used in the corresponding call to
11100	<link to="IDisplay::resizeCompleted"/> if this call is made.
11101	</desc>
11102	</param>
11103	<param name="pixelFormat" type="unsigned long" dir="in">
11104	<desc>
11105	Pixel format of the memory buffer pointed to by @a VRAM.
11106	See also <link to="FramebufferPixelFormat"/>.
11107	</desc>
11108	</param>
11109	<param name="VRAM" type="octet" mod="ptr" dir="in">
11110	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11111	</param>
11112	<param name="bitsPerPixel" type="unsigned long" dir="in">
11113	<desc>Color depth, bits per pixel.</desc>
11114	</param>
11115	<param name="bytesPerLine" type="unsigned long" dir="in">
11116	<desc>Size of one scan line, in bytes.</desc>
11117	</param>
11118	<param name="width" type="unsigned long" dir="in">
11119	<desc>Width of the guest display, in pixels.</desc>
11120	</param>
11121	<param name="height" type="unsigned long" dir="in">
11122	<desc>Height of the guest display, in pixels.</desc>
11123	</param>
11124	<param name="finished" type="boolean" dir="return">
11125	<desc>
11126	Can the VM start using the new frame buffer immediately
11127	after this method returns or it should wait for
11128	<link to="IDisplay::resizeCompleted"/>.
11129	</desc>
11130	</param>
11131	</method>
11132
11133	<method name="videoModeSupported">
11134	<desc>
11135	Returns whether the frame buffer implementation is willing to
11136	support a given video mode. In case it is not able to render
11137	the video mode (or for some reason not willing), it should
11138	return @c false. Usually this method is called when the guest
11139	asks the VMM device whether a given video mode is supported
11140	so the information returned is directly exposed to the guest.
11141	It is important that this method returns very quickly.
11142	</desc>
11143	<param name="width" type="unsigned long" dir="in"/>
11144	<param name="height" type="unsigned long" dir="in"/>
11145	<param name="bpp" type="unsigned long" dir="in"/>
11146	<param name="supported" type="boolean" dir="return"/>
11147	</method>
11148
11149	<method name="getVisibleRegion">
11150	<desc>
11151	Returns the visible region of this frame buffer.
11152
11153	If the @a rectangles parameter is @c null then the value of the
11154	@a count parameter is ignored and the number of elements necessary to
11155	describe the current visible region is returned in @a countCopied.
11156
11157	If @a rectangles is not @c null but @a count is less
11158	than the required number of elements to store region data, the method
11159	will report a failure. If @a count is equal or greater than the
11160	required number of elements, then the actual number of elements copied
11161	to the provided array will be returned in @a countCopied.
11162
11163	<note>
11164	The address of the provided array must be in the process space of
11165	this IFramebuffer object.
11166	</note>
11167	<note>
11168	Method not yet implemented.
11169	</note>
11170	</desc>
11171	<param name="rectangles" type="octet" mod="ptr" dir="in">
11172	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11173	</param>
11174	<param name="count" type="unsigned long" dir="in">
11175	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11176	</param>
11177	<param name="countCopied" type="unsigned long" dir="return">
11178	<desc>Number of elements copied to the @a rectangles array.</desc>
11179	</param>
11180	</method>
11181
11182	<method name="setVisibleRegion">
11183	<desc>
11184	Suggests a new visible region to this frame buffer. This region
11185	represents the area of the VM display which is a union of regions of
11186	all top-level windows of the guest operating system running inside the
11187	VM (if the Guest Additions for this system support this
11188	functionality). This information may be used by the frontends to
11189	implement the seamless desktop integration feature.
11190
11191	<note>
11192	The address of the provided array must be in the process space of
11193	this IFramebuffer object.
11194	</note>
11195	<note>
11196	The IFramebuffer implementation must make a copy of the provided
11197	array of rectangles.
11198	</note>
11199	<note>
11200	Method not yet implemented.
11201	</note>
11202	</desc>
11203	<param name="rectangles" type="octet" mod="ptr" dir="in">
11204	<desc>Pointer to the @c RTRECT array.</desc>
11205	</param>
11206	<param name="count" type="unsigned long" dir="in">
11207	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11208	</param>
11209	</method>
11210
11211	<method name="processVHWACommand">
11212	<desc>
11213	Posts a Video HW Acceleration Command to the frame buffer for processing.
11214	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11215	are posted from quest to the host to be processed by the host hardware.
11216
11217	<note>
11218	The address of the provided command must be in the process space of
11219	this IFramebuffer object.
11220	</note>
11221	</desc>
11222
11223	<param name="command" type="octet" mod="ptr" dir="in">
11224	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11225	</param>
11226	</method>
11227
11228	</interface>
11229
11230	<interface
11231	name="IFramebufferOverlay" extends="IFramebuffer"
11232	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11233	wsmap="suppress"
11234	>
11235	<desc>
11236	The IFramebufferOverlay interface represents an alpha blended overlay
11237	for displaying status icons above an IFramebuffer. It is always created
11238	not visible, so that it must be explicitly shown. It only covers a
11239	portion of the IFramebuffer, determined by its width, height and
11240	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11241	that order) format, and may be written to directly. Do re-read the
11242	width though, after setting it, as it may be adjusted (increased) to
11243	make it more suitable for the front end.
11244	</desc>
11245	<attribute name="x" type="unsigned long" readonly="yes">
11246	<desc>X position of the overlay, relative to the frame buffer.</desc>
11247	</attribute>
11248
11249	<attribute name="y" type="unsigned long" readonly="yes">
11250	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11251	</attribute>
11252
11253	<attribute name="visible" type="boolean" readonly="no">
11254	<desc>
11255	Whether the overlay is currently visible.
11256	</desc>
11257	</attribute>
11258
11259	<attribute name="alpha" type="unsigned long" readonly="no">
11260	<desc>
11261	The global alpha value for the overlay. This may or may not be
11262	supported by a given front end.
11263	</desc>
11264	</attribute>
11265
11266	<method name="move">
11267	<desc>
11268	Changes the overlay's position relative to the IFramebuffer.
11269	</desc>
11270	<param name="x" type="unsigned long" dir="in"/>
11271	<param name="y" type="unsigned long" dir="in"/>
11272	</method>
11273
11274	</interface>
11275
11276	<interface
11277	name="IDisplay" extends="$unknown"
11278	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11279	wsmap="managed"
11280	>
11281	<desc>
11282	The IDisplay interface represents the virtual machine's display.
11283
11284	The object implementing this interface is contained in each
11285	<link to="IConsole::display"/> attribute and represents the visual
11286	output of the virtual machine.
11287
11288	The virtual display supports pluggable output targets represented by the
11289	IFramebuffer interface. Examples of the output target are a window on
11290	the host computer or an RDP session's display on a remote computer.
11291	</desc>
11292	<method name="getScreenResolution">
11293	<desc>Queries display width, height and color depth for given screen.</desc>
11294	<param name="screenId" type="unsigned long" dir="in"/>
11295	<param name="width" type="unsigned long" dir="out"/>
11296	<param name="height" type="unsigned long" dir="out"/>
11297	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11298	</method>
11299
11300	<method name="setFramebuffer">
11301	<desc>
11302	Sets the framebuffer for given screen.
11303	</desc>
11304	<param name="screenId" type="unsigned long" dir="in"/>
11305	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11306	</method>
11307
11308	<method name="getFramebuffer">
11309	<desc>
11310	Queries the framebuffer for given screen.
11311	</desc>
11312	<param name="screenId" type="unsigned long" dir="in"/>
11313	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11314	<param name="xOrigin" type="long" dir="out"/>
11315	<param name="yOrigin" type="long" dir="out"/>
11316	</method>
11317
11318	<method name="setVideoModeHint">
11319	<desc>
11320	Asks VirtualBox to request the given video mode from
11321	the guest. This is just a hint and it cannot be guaranteed
11322	that the requested resolution will be used. Guest Additions
11323	are required for the request to be seen by guests. The caller
11324	should issue the request and wait for a resolution change and
11325	after a timeout retry.
11326
11327	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11328	parameters means that the corresponding values should be taken from the
11329	current video mode (i.e. left unchanged).
11330
11331	If the guest OS supports multi-monitor configuration then the @a display
11332	parameter specifies the number of the guest display to send the hint to:
11333	@c 0 is the primary display, @c 1 is the first secondary and
11334	so on. If the multi-monitor configuration is not supported, @a display
11335	must be @c 0.
11336
11337	<result name="E_INVALIDARG">
11338	The @a display is not associated with any monitor.
11339	</result>
11340
11341	</desc>
11342	<param name="width" type="unsigned long" dir="in"/>
11343	<param name="height" type="unsigned long" dir="in"/>
11344	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11345	<param name="display" type="unsigned long" dir="in"/>
11346	</method>
11347
11348	<method name="setSeamlessMode">
11349	<desc>
11350	Enables or disables seamless guest display rendering (seamless desktop
11351	integration) mode.
11352	<note>
11353	Calling this method has no effect if <link
11354	to="IGuest::supportsSeamless"/> returns @c false.
11355	</note>
11356	</desc>
11357	<param name="enabled" type="boolean" dir="in"/>
11358	</method>
11359
11360	<method name="takeScreenShot">
11361	<desc>
11362	Takes a screen shot of the requested size and copies it to the
11363	32-bpp buffer allocated by the caller and pointed to by @a address.
11364	A pixel consists of 4 bytes in order: B, G, R, 0.
11365
11366	<note>This API can be used only by the COM/XPCOM C++ API as it
11367	requires pointer support. Use <link to="#takeScreenShotToArray" />
11368	with other language bindings.
11369	</note>
11370
11371	<result name="E_NOTIMPL">
11372	Feature not implemented.
11373	</result>
11374	<result name="VBOX_E_IPRT_ERROR">
11375	Could not take a screenshot.
11376	</result>
11377
11378	</desc>
11379	<param name="screenId" type="unsigned long" dir="in"/>
11380	<param name="address" type="octet" mod="ptr" dir="in"/>
11381	<param name="width" type="unsigned long" dir="in"/>
11382	<param name="height" type="unsigned long" dir="in"/>
11383	</method>
11384
11385	<method name="takeScreenShotToArray">
11386	<desc>
11387	Takes a guest screen shot of the requested size and returns it as
11388	an array of bytes in uncompressed 32-bit RGBA format.
11389	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11390
11391	This API is slow, but could be the only option to get guest screenshot
11392	for scriptable languages not allowed to manipulate with addresses
11393	directly.
11394
11395	<result name="E_NOTIMPL">
11396	Feature not implemented.
11397	</result>
11398	<result name="VBOX_E_IPRT_ERROR">
11399	Could not take a screenshot.
11400	</result>
11401	</desc>
11402	<param name="screenId" type="unsigned long" dir="in">
11403	<desc>
11404	Monitor to take screenshot from.
11405	</desc>
11406	</param>
11407	<param name="width" type="unsigned long" dir="in">
11408	<desc>
11409	Desired image width.
11410	</desc>
11411	</param>
11412	<param name="height" type="unsigned long" dir="in">
11413	<desc>
11414	Desired image height.
11415	</desc>
11416	</param>
11417	<param name="screenData" type="octet" dir="return" safearray="yes">
11418	<desc>
11419	Array with resulting screen data.
11420	</desc>
11421	</param>
11422	</method>
11423
11424	<method name="takeScreenShotPNGToArray">
11425	<desc>
11426	Takes a guest screen shot of the requested size and returns it as
11427	PNG image in array.
11428
11429	<result name="E_NOTIMPL">
11430	Feature not implemented.
11431	</result>
11432	<result name="VBOX_E_IPRT_ERROR">
11433	Could not take a screenshot.
11434	</result>
11435	</desc>
11436	<param name="screenId" type="unsigned long" dir="in">
11437	<desc>
11438	Monitor to take the screenshot from.
11439	</desc>
11440	</param>
11441	<param name="width" type="unsigned long" dir="in">
11442	<desc>
11443	Desired image width.
11444	</desc>
11445	</param>
11446	<param name="height" type="unsigned long" dir="in">
11447	<desc>
11448	Desired image height.
11449	</desc>
11450	</param>
11451	<param name="screenData" type="octet" dir="return" safearray="yes">
11452	<desc>
11453	Array with resulting screen data.
11454	</desc>
11455	</param>
11456	</method>
11457
11458	<method name="drawToScreen">
11459	<desc>
11460	Draws a 32-bpp image of the specified size from the given buffer
11461	to the given point on the VM display.
11462
11463	<result name="E_NOTIMPL">
11464	Feature not implemented.
11465	</result>
11466	<result name="VBOX_E_IPRT_ERROR">
11467	Could not draw to screen.
11468	</result>
11469
11470	</desc>
11471	<param name="screenId" type="unsigned long" dir="in">
11472	<desc>
11473	Monitor to take the screenshot from.
11474	</desc>
11475	</param>
11476	<param name="address" type="octet" mod="ptr" dir="in">
11477	<desc>
11478	Address to store the screenshot to
11479	</desc>
11480	</param>
11481	<param name="x" type="unsigned long" dir="in">
11482	<desc>
11483	Relative to the screen top left corner.
11484	</desc>
11485	</param>
11486	<param name="y" type="unsigned long" dir="in">
11487	<desc>
11488	Relative to the screen top left corner.
11489	</desc>
11490	</param>
11491	<param name="width" type="unsigned long" dir="in">
11492	<desc>
11493	Desired image width.
11494	</desc>
11495	</param>
11496	<param name="height" type="unsigned long" dir="in">
11497	<desc>
11498	Desired image height.
11499	</desc>
11500	</param>
11501	</method>
11502
11503	<method name="invalidateAndUpdate">
11504	<desc>
11505	Does a full invalidation of the VM display and instructs the VM
11506	to update it.
11507
11508	<result name="VBOX_E_IPRT_ERROR">
11509	Could not invalidate and update screen.
11510	</result>
11511
11512	</desc>
11513	</method>
11514
11515	<method name="resizeCompleted">
11516	<desc>
11517	Signals that a framebuffer has completed the resize operation.
11518
11519	<result name="VBOX_E_NOT_SUPPORTED">
11520	Operation only valid for external frame buffers.
11521	</result>
11522
11523	</desc>
11524	<param name="screenId" type="unsigned long" dir="in"/>
11525	</method>
11526
11527	<method name="completeVHWACommand">
11528	<desc>
11529	Signals that the Video HW Acceleration command has completed.
11530	</desc>
11531
11532	<param name="command" type="octet" mod="ptr" dir="in">
11533	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11534	</param>
11535	</method>
11536
11537	</interface>
11538
11539	<!--
11540	// INetworkAdapter
11541	/////////////////////////////////////////////////////////////////////////
11542	-->
11543
11544	<enum
11545	name="NetworkAttachmentType"
11546	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11547	>
11548	<desc>
11549	Network attachment type.
11550	</desc>
11551
11552	<const name="Null" value="0">
11553	<desc>Null value, also means "not attached".</desc>
11554	</const>
11555	<const name="NAT" value="1"/>
11556	<const name="Bridged" value="2"/>
11557	<const name="Internal" value="3"/>
11558	<const name="HostOnly" value="4"/>
11559	<const name="VDE" value="5"/>
11560	</enum>
11561
11562	<enum
11563	name="NetworkAdapterType"
11564	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11565	>
11566	<desc>
11567	Network adapter type.
11568	</desc>
11569
11570	<const name="Null" value="0">
11571	<desc>Null value (never used by the API).</desc>
11572	</const>
11573	<const name="Am79C970A" value="1">
11574	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11575	</const>
11576	<const name="Am79C973" value="2">
11577	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11578	</const>
11579	<const name="I82540EM" value="3">
11580	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11581	</const>
11582	<const name="I82543GC" value="4">
11583	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11584	</const>
11585	<const name="I82545EM" value="5">
11586	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11587	</const>
11588	<const name="Virtio" value="6">
11589	<desc>Virtio network device.</desc>
11590	</const>
11591	</enum>
11592
11593	<interface
11594	name="INetworkAdapter" extends="$unknown"
11595	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11596	wsmap="managed"
11597	>
11598	<desc>
11599	Represents a virtual network adapter that is attached to a virtual machine.
11600	Each virtual machine has a fixed number of network adapter slots with one
11601	instance of this attached to each of them. Call
11602	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11603	is attached to a given slot in a given machine.
11604
11605	Each network adapter can be in one of five attachment modes, which are
11606	represented by the <link to="NetworkAttachmentType" /> enumeration;
11607	see the <link to="#attachmentType" /> attribute.
11608	</desc>
11609
11610	<attribute name="adapterType" type="NetworkAdapterType">
11611	<desc>
11612	Type of the virtual network adapter. Depending on this value,
11613	VirtualBox will provide a different virtual network hardware
11614	to the guest.
11615	</desc>
11616	</attribute>
11617
11618	<attribute name="slot" type="unsigned long" readonly="yes">
11619	<desc>
11620	Slot number this adapter is plugged into. Corresponds to
11621	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11622	to obtain this instance.
11623	</desc>
11624	</attribute>
11625
11626	<attribute name="enabled" type="boolean">
11627	<desc>
11628	Flag whether the network adapter is present in the
11629	guest system. If disabled, the virtual guest hardware will
11630	not contain this network adapter. Can only be changed when
11631	the VM is not running.
11632	</desc>
11633	</attribute>
11634
11635	<attribute name="MACAddress" type="wstring">
11636	<desc>
11637	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11638	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11639	</desc>
11640	</attribute>
11641
11642	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11643
11644	<attribute name="hostInterface" type="wstring">
11645	<desc>
11646	Name of the host network interface the VM is attached to.
11647	</desc>
11648	</attribute>
11649
11650	<attribute name="internalNetwork" type="wstring">
11651	<desc>
11652	Name of the internal network the VM is attached to.
11653	</desc>
11654	</attribute>
11655
11656	<attribute name="NATNetwork" type="wstring">
11657	<desc>
11658	Name of the NAT network the VM is attached to.
11659	</desc>
11660	</attribute>
11661
11662	<attribute name="VDENetwork" type="wstring">
11663	<desc>
11664	Name of the VDE switch the VM is attached to.
11665	</desc>
11666	</attribute>
11667
11668	<attribute name="cableConnected" type="boolean">
11669	<desc>
11670	Flag whether the adapter reports the cable as connected or not.
11671	It can be used to report offline situations to a VM.
11672	</desc>
11673	</attribute>
11674
11675	<attribute name="lineSpeed" type="unsigned long">
11676	<desc>
11677	Line speed reported by custom drivers, in units of 1 kbps.
11678	</desc>
11679	</attribute>
11680
11681	<attribute name="traceEnabled" type="boolean">
11682	<desc>
11683	Flag whether network traffic from/to the network card should be traced.
11684	Can only be toggled when the VM is turned off.
11685	</desc>
11686	</attribute>
11687
11688	<attribute name="traceFile" type="wstring">
11689	<desc>
11690	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11691	will be used.
11692	</desc>
11693	</attribute>
11694
11695	<attribute name="natDriver" type="INATEngine" readonly="yes">
11696	<desc>
11697	Points to the NAT engine which handles the network address translation
11698	for this interface. This is active only when the interface actually uses
11699	NAT (see <link to="#attachToNAT" />).
11700	</desc>
11701	</attribute>
11702
11703	<attribute name="bootPriority" type="unsigned long">
11704	<desc>
11705	Network boot priority of the adapter. Priority 1 is highest. If not set,
11706	the priority is considered to be at the lowest possible setting.
11707	</desc>
11708	</attribute>
11709
11710	<attribute name="bandwidthLimit" type="unsigned long">
11711	<desc>
11712	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11713	A zero value means uncapped/unlimited.
11714	</desc>
11715	</attribute>
11716
11717	<method name="attachToNAT">
11718	<desc>
11719	Attach the network adapter to the Network Address Translation (NAT) interface.
11720	</desc>
11721	</method>
11722
11723	<method name="attachToBridgedInterface">
11724	<desc>
11725	Attach the network adapter to a bridged host interface.
11726	</desc>
11727	</method>
11728
11729	<method name="attachToInternalNetwork">
11730	<desc>
11731	Attach the network adapter to an internal network.
11732	</desc>
11733	</method>
11734
11735	<method name="attachToHostOnlyInterface">
11736	<desc>
11737	Attach the network adapter to the host-only network.
11738	</desc>
11739	</method>
11740
11741	<method name="attachToVDE">
11742	<desc>
11743	Attach the network adapter to a VDE network.
11744	</desc>
11745	</method>
11746
11747	<method name="detach">
11748	<desc>
11749	Detach the network adapter
11750	</desc>
11751	</method>
11752	</interface>
11753
11754
11755	<!--
11756	// ISerialPort
11757	/////////////////////////////////////////////////////////////////////////
11758	-->
11759
11760	<enum
11761	name="PortMode"
11762	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11763	>
11764	<desc>
11765	The PortMode enumeration represents possible communication modes for
11766	the virtual serial port device.
11767	</desc>
11768
11769	<const name="Disconnected" value="0">
11770	<desc>Virtual device is not attached to any real host device.</desc>
11771	</const>
11772	<const name="HostPipe" value="1">
11773	<desc>Virtual device is attached to a host pipe.</desc>
11774	</const>
11775	<const name="HostDevice" value="2">
11776	<desc>Virtual device is attached to a host device.</desc>
11777	</const>
11778	<const name="RawFile" value="3">
11779	<desc>Virtual device is attached to a raw file.</desc>
11780	</const>
11781	</enum>
11782
11783	<interface
11784	name="ISerialPort" extends="$unknown"
11785	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11786	wsmap="managed"
11787	>
11788
11789	<desc>
11790	The ISerialPort interface represents the virtual serial port device.
11791
11792	The virtual serial port device acts like an ordinary serial port
11793	inside the virtual machine. This device communicates to the real
11794	serial port hardware in one of two modes: host pipe or host device.
11795
11796	In host pipe mode, the #path attribute specifies the path to the pipe on
11797	the host computer that represents a serial port. The #server attribute
11798	determines if this pipe is created by the virtual machine process at
11799	machine startup or it must already exist before starting machine
11800	execution.
11801
11802	In host device mode, the #path attribute specifies the name of the
11803	serial port device on the host computer.
11804
11805	There is also a third communication mode: the disconnected mode. In this
11806	mode, the guest OS running inside the virtual machine will be able to
11807	detect the serial port, but all port write operations will be discarded
11808	and all port read operations will return no data.
11809
11810	<see>IMachine::getSerialPort</see>
11811	</desc>
11812
11813	<attribute name="slot" type="unsigned long" readonly="yes">
11814	<desc>
11815	Slot number this serial port is plugged into. Corresponds to
11816	the value you pass to <link to="IMachine::getSerialPort"/>
11817	to obtain this instance.
11818	</desc>
11819	</attribute>
11820
11821	<attribute name="enabled" type="boolean">
11822	<desc>
11823	Flag whether the serial port is enabled. If disabled,
11824	the serial port will not be reported to the guest OS.
11825	</desc>
11826	</attribute>
11827
11828	<attribute name="IOBase" type="unsigned long">
11829	<desc>Base I/O address of the serial port.</desc>
11830	</attribute>
11831
11832	<attribute name="IRQ" type="unsigned long">
11833	<desc>IRQ number of the serial port.</desc>
11834	</attribute>
11835
11836	<attribute name="hostMode" type="PortMode">
11837	<desc>
11838	How is this port connected to the host.
11839	<note>
11840	Changing this attribute may fail if the conditions for
11841	<link to="#path"/> are not met.
11842	</note>
11843	</desc>
11844	</attribute>
11845
11846	<attribute name="server" type="boolean">
11847	<desc>
11848	Flag whether this serial port acts as a server (creates a new pipe on
11849	the host) or as a client (uses the existing pipe). This attribute is
11850	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11851	</desc>
11852	</attribute>
11853
11854	<attribute name="path" type="wstring">
11855	<desc>
11856	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11857	PortMode_HostPipe, or the host serial device name when
11858	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11859	cases, setting a @c null or empty string as the attribute's value
11860	is an error. Otherwise, the value of this property is ignored.
11861	</desc>
11862	</attribute>
11863
11864	</interface>
11865
11866	<!--
11867	// IParallelPort
11868	/////////////////////////////////////////////////////////////////////////
11869	-->
11870
11871	<interface
11872	name="IParallelPort" extends="$unknown"
11873	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11874	wsmap="managed"
11875	>
11876
11877	<desc>
11878	The IParallelPort interface represents the virtual parallel port device.
11879
11880	The virtual parallel port device acts like an ordinary parallel port
11881	inside the virtual machine. This device communicates to the real
11882	parallel port hardware using the name of the parallel device on the host
11883	computer specified in the #path attribute.
11884
11885	Each virtual parallel port device is assigned a base I/O address and an
11886	IRQ number that will be reported to the guest operating system and used
11887	to operate the given parallel port from within the virtual machine.
11888
11889	<see>IMachine::getParallelPort</see>
11890	</desc>
11891
11892	<attribute name="slot" type="unsigned long" readonly="yes">
11893	<desc>
11894	Slot number this parallel port is plugged into. Corresponds to
11895	the value you pass to <link to="IMachine::getParallelPort"/>
11896	to obtain this instance.
11897	</desc>
11898	</attribute>
11899
11900	<attribute name="enabled" type="boolean">
11901	<desc>
11902	Flag whether the parallel port is enabled. If disabled,
11903	the parallel port will not be reported to the guest OS.
11904	</desc>
11905	</attribute>
11906
11907	<attribute name="IOBase" type="unsigned long">
11908	<desc>Base I/O address of the parallel port.</desc>
11909	</attribute>
11910
11911	<attribute name="IRQ" type="unsigned long">
11912	<desc>IRQ number of the parallel port.</desc>
11913	</attribute>
11914
11915	<attribute name="path" type="wstring">
11916	<desc>
11917	Host parallel device name. If this parallel port is enabled, setting a
11918	@c null or an empty string as this attribute's value will result into
11919	an error.
11920	</desc>
11921	</attribute>
11922
11923	</interface>
11924
11925
11926	<!--
11927	// IMachineDebugger
11928	/////////////////////////////////////////////////////////////////////////
11929	-->
11930
11931	<interface
11932	name="IMachineDebugger" extends="$unknown"
11933	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
11934	wsmap="suppress"
11935	>
11936	<method name="dumpGuestCore">
11937	<desc>
11938	Takes a core dump of the guest.
11939
11940	See include/VBox/dbgfcorefmt.h for details on the file format.
11941	</desc>
11942	<param name="filename" type="wstring" dir="in">
11943	<desc>
11944	The name of the output file. The file must not exist.
11945	</desc>
11946	</param>
11947	<param name="compression" type="wstring" dir="in">
11948	<desc>
11949	Reserved for future compression method indicator.
11950	</desc>
11951	</param>
11952	</method>
11953
11954	<method name="dumpHostProcessCore">
11955	<desc>
11956	Takes a core dump of the VM process on the host.
11957
11958	This feature is not implemented in the 4.0.0 release but it may show up
11959	in a dot release.
11960	</desc>
11961	<param name="filename" type="wstring" dir="in">
11962	<desc>
11963	The name of the output file. The file must not exist.
11964	</desc>
11965	</param>
11966	<param name="compression" type="wstring" dir="in">
11967	<desc>
11968	Reserved for future compression method indicator.
11969	</desc>
11970	</param>
11971	</method>
11972
11973	<method name="info">
11974	<desc>
11975	Interfaces with the info dumpers (DBGFInfo).
11976
11977	This feature is not implemented in the 4.0.0 release but it may show up
11978	in a dot release.
11979	</desc>
11980	<param name="name" type="wstring" dir="in">
11981	<desc>
11982	The name of the info item.
11983	</desc>
11984	</param>
11985	<param name="args" type="wstring" dir="in">
11986	<desc>
11987	Arguments to the info dumper.
11988	</desc>
11989	</param>
11990	<param name="info" type="wstring" dir="return">
11991	<desc>
11992	The into string.
11993	</desc>
11994	</param>
11995	</method>
11996
11997	<method name="injectNMI">
11998	<desc>
11999	Inject an NMI into a running VT-x/AMD-V VM.
12000	</desc>
12001	</method>
12002
12003	<method name="modifyLogGroups">
12004	<desc>
12005	Modifies the group settings of the debug logger.
12006
12007	This feature is not implemented in the 4.0.0 release but may show up
12008	in a dot release.
12009	</desc>
12010	<param name="settings" type="wstring" dir="in">
12011	<desc>The group settings string. See iprt/log.h for details.</desc>
12012	</param>
12013	</method>
12014
12015	<method name="modifyLogFlags">
12016	<desc>
12017	Modifies the debug logger flags.
12018
12019	This feature is not implemented in the 4.0.0 release but may show up
12020	in a dot release.
12021	</desc>
12022	<param name="settings" type="wstring" dir="in">
12023	<desc>The flags settings string. See iprt/log.h for details.</desc>
12024	</param>
12025	</method>
12026
12027	<method name="modifyLogDestinations">
12028	<desc>
12029	Modifies the debug logger destinations.
12030
12031	This feature is not implemented in the 4.0.0 release but may show up
12032	in a dot release.
12033	</desc>
12034	<param name="settings" type="wstring" dir="in">
12035	<desc>The destination settings string. See iprt/log.h for details.</desc>
12036	</param>
12037	</method>
12038
12039	<method name="readPhysicalMemory">
12040	<desc>
12041	Reads guest physical memory, no side effects (MMIO++).
12042
12043	This feature is not implemented in the 4.0.0 release but may show up
12044	in a dot release.
12045	</desc>
12046	<param name="address" type="long long" dir="in">
12047	<desc>The guest physical address.</desc>
12048	</param>
12049	<param name="size" type="unsigned long" dir="in">
12050	<desc>The number of bytes to read.</desc>
12051	</param>
12052	<param name="bytes" type="octet" safearray="yes" dir="return">
12053	<desc>The bytes read.</desc>
12054	</param>
12055	</method>
12056
12057	<method name="writePhysicalMemory">
12058	<desc>
12059	Writes guest physical memory, access handles (MMIO++) are ignored.
12060
12061	This feature is not implemented in the 4.0.0 release but may show up
12062	in a dot release.
12063	</desc>
12064	<param name="address" type="long long" dir="in">
12065	<desc>The guest physical address.</desc>
12066	</param>
12067	<param name="size" type="unsigned long" dir="in">
12068	<desc>The number of bytes to read.</desc>
12069	</param>
12070	<param name="bytes" type="octet" safearray="yes" dir="in">
12071	<desc>The bytes to write.</desc>
12072	</param>
12073	</method>
12074
12075	<method name="readVirtualMemory">
12076	<desc>
12077	Reads guest virtual memory, no side effects (MMIO++).
12078
12079	This feature is not implemented in the 4.0.0 release but may show up
12080	in a dot release.
12081	</desc>
12082	<param name="cpuId" type="unsigned long" dir="in">
12083	<desc>The identifier of the Virtual CPU.</desc>
12084	</param>
12085	<param name="address" type="long long" dir="in">
12086	<desc>The guest virtual address.</desc>
12087	</param>
12088	<param name="size" type="unsigned long" dir="in">
12089	<desc>The number of bytes to read.</desc>
12090	</param>
12091	<param name="bytes" type="octet" safearray="yes" dir="return">
12092	<desc>The bytes read.</desc>
12093	</param>
12094	</method>
12095
12096	<method name="writeVirtualMemory">
12097	<desc>
12098	Writes guest virtual memory, access handles (MMIO++) are ignored.
12099
12100	This feature is not implemented in the 4.0.0 release but may show up
12101	in a dot release.
12102	</desc>
12103	<param name="cpuId" type="unsigned long" dir="in">
12104	<desc>The identifier of the Virtual CPU.</desc>
12105	</param>
12106	<param name="address" type="long long" dir="in">
12107	<desc>The guest virtual address.</desc>
12108	</param>
12109	<param name="size" type="unsigned long" dir="in">
12110	<desc>The number of bytes to read.</desc>
12111	</param>
12112	<param name="bytes" type="octet" safearray="yes" dir="in">
12113	<desc>The bytes to write.</desc>
12114	</param>
12115	</method>
12116
12117	<method name="detectOS">
12118	<desc>
12119	Tries to (re-)detect the guest OS kernel.
12120
12121	This feature is not implemented in the 4.0.0 release but may show up
12122	in a dot release.
12123	</desc>
12124	<param name="os" type="wstring" dir="return">
12125	<desc>
12126	The detected OS kernel on success.
12127	</desc>
12128	</param>
12129	</method>
12130
12131	<method name="getRegister">
12132	<desc>
12133	Gets one register.
12134
12135	This feature is not implemented in the 4.0.0 release but may show up
12136	in a dot release.
12137	</desc>
12138	<param name="cpuId" type="unsigned long" dir="in">
12139	<desc>The identifier of the Virtual CPU.</desc>
12140	</param>
12141	<param name="name" type="wstring" dir="in">
12142	<desc>The register name, case is ignored.</desc>
12143	</param>
12144	<param name="value" type="wstring" dir="return">
12145	<desc>
12146	The register value. This is usually a hex value (always 0x prefixed)
12147	but other format may be used for floating point registers (TBD).
12148	</desc>
12149	</param>
12150	</method>
12151
12152	<method name="getRegisters">
12153	<desc>
12154	Gets all the registers for the given CPU.
12155
12156	This feature is not implemented in the 4.0.0 release but may show up
12157	in a dot release.
12158	</desc>
12159	<param name="cpuId" type="unsigned long" dir="in">
12160	<desc>The identifier of the Virtual CPU.</desc>
12161	</param>
12162	<param name="names" type="wstring" dir="out" safearray="yes">
12163	<desc>Array containing the lowercase register names.</desc>
12164	</param>
12165	<param name="values" type="wstring" dir="out" safearray="yes">
12166	<desc>
12167	Array paralell to the names holding the register values as if the
12168	register was returned by <link to="IMachineDebugger::getRegister"/>.
12169	</desc>
12170	</param>
12171	</method>
12172
12173	<method name="setRegister">
12174	<desc>
12175	Gets one register.
12176
12177	This feature is not implemented in the 4.0.0 release but may show up
12178	in a dot release.
12179	</desc>
12180	<param name="cpuId" type="unsigned long" dir="in">
12181	<desc>The identifier of the Virtual CPU.</desc>
12182	</param>
12183	<param name="name" type="wstring" dir="in">
12184	<desc>The register name, case is ignored.</desc>
12185	</param>
12186	<param name="value" type="wstring" dir="in">
12187	<desc>
12188	The new register value. Hexadecimal, decimal and octal formattings
12189	are supported in addition to any special formattings returned by
12190	the getters.
12191	</desc>
12192	</param>
12193	</method>
12194
12195	<method name="setRegisters">
12196	<desc>
12197	Sets zero or more registers atomically.
12198
12199	This feature is not implemented in the 4.0.0 release but may show up
12200	in a dot release.
12201	</desc>
12202	<param name="cpuId" type="unsigned long" dir="in">
12203	<desc>The identifier of the Virtual CPU.</desc>
12204	</param>
12205	<param name="names" type="wstring" dir="in" safearray="yes">
12206	<desc>Array containing the register names, case ignored.</desc>
12207	</param>
12208	<param name="values" type="wstring" dir="in" safearray="yes">
12209	<desc>
12210	Array paralell to the names holding the register values. See
12211	<link to="IMachineDebugger::setRegister"/> for formatting
12212	guidelines.
12213	</desc>
12214	</param>
12215	</method>
12216
12217	<method name="dumpGuestStack">
12218	<desc>
12219	Produce a simple stack dump using the current guest state.
12220
12221	This feature is not implemented in the 4.0.0 release but may show up
12222	in a dot release.
12223	</desc>
12224	<param name="cpuId" type="unsigned long" dir="in">
12225	<desc>The identifier of the Virtual CPU.</desc>
12226	</param>
12227	<param name="stack" type="wstring" dir="return">
12228	<desc>String containing the formatted stack dump.</desc>
12229	</param>
12230	</method>
12231
12232	<method name="resetStats">
12233	<desc>
12234	Reset VM statistics.
12235	</desc>
12236	<param name="pattern" type="wstring" dir="in">
12237	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12238	</param>
12239	</method>
12240
12241	<method name="dumpStats">
12242	<desc>
12243	Dumps VM statistics.
12244	</desc>
12245	<param name="pattern" type="wstring" dir="in">
12246	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12247	</param>
12248	</method>
12249
12250	<method name="getStats">
12251	<desc>
12252	Get the VM statistics in a XMLish format.
12253	</desc>
12254	<param name="pattern" type="wstring" dir="in">
12255	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12256	</param>
12257	<param name="withDescriptions" type="boolean" dir="in">
12258	<desc>Whether to include the descriptions.</desc>
12259	</param>
12260	<param name="stats" type="wstring" dir="out">
12261	<desc>The XML document containing the statistics.</desc>
12262	</param>
12263	</method>
12264
12265	<attribute name="singlestep" type="boolean">
12266	<desc>Switch for enabling singlestepping.</desc>
12267	</attribute>
12268
12269	<attribute name="recompileUser" type="boolean">
12270	<desc>Switch for forcing code recompilation for user mode code.</desc>
12271	</attribute>
12272
12273	<attribute name="recompileSupervisor" type="boolean">
12274	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12275	</attribute>
12276
12277	<attribute name="PATMEnabled" type="boolean">
12278	<desc>Switch for enabling and disabling the PATM component.</desc>
12279	</attribute>
12280
12281	<attribute name="CSAMEnabled" type="boolean">
12282	<desc>Switch for enabling and disabling the CSAM component.</desc>
12283	</attribute>
12284
12285	<attribute name="logEnabled" type="boolean">
12286	<desc>Switch for enabling and disabling the debug logger.</desc>
12287	</attribute>
12288
12289	<attribute name="logFlags" type="wstring" readonly="yes">
12290	<desc>The debug logger flags.</desc>
12291	</attribute>
12292
12293	<attribute name="logGroups" type="wstring" readonly="yes">
12294	<desc>The debug logger's group settings.</desc>
12295	</attribute>
12296
12297	<attribute name="logDestinations" type="wstring" readonly="yes">
12298	<desc>The debug logger's destination settings.</desc>
12299	</attribute>
12300
12301	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12302	<desc>
12303	Flag indicating whether the VM is currently making use of CPU hardware
12304	virtualization extensions.
12305	</desc>
12306	</attribute>
12307
12308	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12309	<desc>
12310	Flag indicating whether the VM is currently making use of the nested paging
12311	CPU hardware virtualization extension.
12312	</desc>
12313	</attribute>
12314
12315	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12316	<desc>
12317	Flag indicating whether the VM is currently making use of the VPID
12318	VT-x extension.
12319	</desc>
12320	</attribute>
12321
12322	<attribute name="OSName" type="wstring" readonly="yes">
12323	<desc>
12324	Query the guest OS kernel name as detected by the DBGF.
12325
12326	This feature is not implemented in the 4.0.0 release but may show up
12327	in a dot release.
12328	</desc>
12329	</attribute>
12330
12331	<attribute name="OSVersion" type="wstring" readonly="yes">
12332	<desc>
12333	Query the guest OS kernel version string as detected by the DBGF.
12334
12335	This feature is not implemented in the 4.0.0 release but may show up
12336	in a dot release.
12337	</desc>
12338	</attribute>
12339
12340	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12341	<desc>
12342	Flag indicating whether the VM is currently making use of the Physical
12343	Address Extension CPU feature.
12344	</desc>
12345	</attribute>
12346
12347	<attribute name="virtualTimeRate" type="unsigned long">
12348	<desc>
12349	The rate at which the virtual time runs expressed as a percentage.
12350	The accepted range is 2% to 20000%.
12351	</desc>
12352	</attribute>
12353
12354	<attribute name="VM" type="long long" readonly="yes">
12355	<desc>
12356	Gets the VM handle. This is only for internal use while
12357	we carve the details of this interface.
12358	</desc>
12359	</attribute>
12360
12361	</interface>
12362
12363	<!--
12364	// IUSBController
12365	/////////////////////////////////////////////////////////////////////////
12366	-->
12367
12368	<interface
12369	name="IUSBController" extends="$unknown"
12370	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12371	wsmap="managed"
12372	>
12373	<attribute name="enabled" type="boolean">
12374	<desc>
12375	Flag whether the USB controller is present in the
12376	guest system. If disabled, the virtual guest hardware will
12377	not contain any USB controller. Can only be changed when
12378	the VM is powered off.
12379	</desc>
12380	</attribute>
12381
12382	<attribute name="enabledEhci" type="boolean">
12383	<desc>
12384	Flag whether the USB EHCI controller is present in the
12385	guest system. If disabled, the virtual guest hardware will
12386	not contain a USB EHCI controller. Can only be changed when
12387	the VM is powered off.
12388	</desc>
12389	</attribute>
12390
12391	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12392	<desc>
12393	Flag whether there is an USB proxy available.
12394	</desc>
12395	</attribute>
12396
12397	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12398	<desc>
12399	USB standard version which the controller implements.
12400	This is a BCD which means that the major version is in the
12401	high byte and minor version is in the low byte.
12402	</desc>
12403	</attribute>
12404
12405	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12406	<desc>
12407	List of USB device filters associated with the machine.
12408
12409	If the machine is currently running, these filters are activated
12410	every time a new (supported) USB device is attached to the host
12411	computer that was not ignored by global filters
12412	(<link to="IHost::USBDeviceFilters"/>).
12413
12414	These filters are also activated when the machine is powered up.
12415	They are run against a list of all currently available USB
12416	devices (in states
12417	<link to="USBDeviceState_Available"/>,
12418	<link to="USBDeviceState_Busy"/>,
12419	<link to="USBDeviceState_Held"/>) that were not previously
12420	ignored by global filters.
12421
12422	If at least one filter matches the USB device in question, this
12423	device is automatically captured (attached to) the virtual USB
12424	controller of this machine.
12425
12426	<see>IUSBDeviceFilter, ::IUSBController</see>
12427	</desc>
12428	</attribute>
12429
12430	<method name="createDeviceFilter">
12431	<desc>
12432	Creates a new USB device filter. All attributes except
12433	the filter name are set to empty (any match),
12434	<i>active</i> is @c false (the filter is not active).
12435
12436	The created filter can then be added to the list of filters using
12437	<link to="#insertDeviceFilter"/>.
12438
12439	<result name="VBOX_E_INVALID_VM_STATE">
12440	The virtual machine is not mutable.
12441	</result>
12442
12443	<see>#deviceFilters</see>
12444	</desc>
12445	<param name="name" type="wstring" dir="in">
12446	<desc>
12447	Filter name. See <link to="IUSBDeviceFilter::name"/>
12448	for more info.
12449	</desc>
12450	</param>
12451	<param name="filter" type="IUSBDeviceFilter" dir="return">
12452	<desc>Created filter object.</desc>
12453	</param>
12454	</method>
12455
12456	<method name="insertDeviceFilter">
12457	<desc>
12458	Inserts the given USB device to the specified position
12459	in the list of filters.
12460
12461	Positions are numbered starting from <tt>0</tt>. If the specified
12462	position is equal to or greater than the number of elements in
12463	the list, the filter is added to the end of the collection.
12464
12465	<note>
12466	Duplicates are not allowed, so an attempt to insert a
12467	filter that is already in the collection, will return an
12468	error.
12469	</note>
12470
12471	<result name="VBOX_E_INVALID_VM_STATE">
12472	Virtual machine is not mutable.
12473	</result>
12474	<result name="E_INVALIDARG">
12475	USB device filter not created within this VirtualBox instance.
12476	</result>
12477	<result name="VBOX_E_INVALID_OBJECT_STATE">
12478	USB device filter already in list.
12479	</result>
12480
12481	<see>#deviceFilters</see>
12482	</desc>
12483	<param name="position" type="unsigned long" dir="in">
12484	<desc>Position to insert the filter to.</desc>
12485	</param>
12486	<param name="filter" type="IUSBDeviceFilter" dir="in">
12487	<desc>USB device filter to insert.</desc>
12488	</param>
12489	</method>
12490
12491	<method name="removeDeviceFilter">
12492	<desc>
12493	Removes a USB device filter from the specified position in the
12494	list of filters.
12495
12496	Positions are numbered starting from <tt>0</tt>. Specifying a
12497	position equal to or greater than the number of elements in
12498	the list will produce an error.
12499
12500	<see>#deviceFilters</see>
12501
12502	<result name="VBOX_E_INVALID_VM_STATE">
12503	Virtual machine is not mutable.
12504	</result>
12505	<result name="E_INVALIDARG">
12506	USB device filter list empty or invalid @a position.
12507	</result>
12508
12509	</desc>
12510	<param name="position" type="unsigned long" dir="in">
12511	<desc>Position to remove the filter from.</desc>
12512	</param>
12513	<param name="filter" type="IUSBDeviceFilter" dir="return">
12514	<desc>Removed USB device filter.</desc>
12515	</param>
12516	</method>
12517
12518	</interface>
12519
12520
12521	<!--
12522	// IUSBDevice
12523	/////////////////////////////////////////////////////////////////////////
12524	-->
12525
12526	<interface
12527	name="IUSBDevice" extends="$unknown"
12528	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12529	wsmap="managed"
12530	>
12531	<desc>
12532	The IUSBDevice interface represents a virtual USB device attached to the
12533	virtual machine.
12534
12535	A collection of objects implementing this interface is stored in the
12536	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12537	attached to a running virtual machine's USB controller.
12538	</desc>
12539
12540	<attribute name="id" type="uuid" mod="string" readonly="yes">
12541	<desc>
12542	Unique USB device ID. This ID is built from #vendorId,
12543	#productId, #revision and #serialNumber.
12544	</desc>
12545	</attribute>
12546
12547	<attribute name="vendorId" type="unsigned short" readonly="yes">
12548	<desc>Vendor ID.</desc>
12549	</attribute>
12550
12551	<attribute name="productId" type="unsigned short" readonly="yes">
12552	<desc>Product ID.</desc>
12553	</attribute>
12554
12555	<attribute name="revision" type="unsigned short" readonly="yes">
12556	<desc>
12557	Product revision number. This is a packed BCD represented as
12558	unsigned short. The high byte is the integer part and the low
12559	byte is the decimal.
12560	</desc>
12561	</attribute>
12562
12563	<attribute name="manufacturer" type="wstring" readonly="yes">
12564	<desc>Manufacturer string.</desc>
12565	</attribute>
12566
12567	<attribute name="product" type="wstring" readonly="yes">
12568	<desc>Product string.</desc>
12569	</attribute>
12570
12571	<attribute name="serialNumber" type="wstring" readonly="yes">
12572	<desc>Serial number string.</desc>
12573	</attribute>
12574
12575	<attribute name="address" type="wstring" readonly="yes">
12576	<desc>Host specific address of the device.</desc>
12577	</attribute>
12578
12579	<attribute name="port" type="unsigned short" readonly="yes">
12580	<desc>
12581	Host USB port number the device is physically
12582	connected to.
12583	</desc>
12584	</attribute>
12585
12586	<attribute name="version" type="unsigned short" readonly="yes">
12587	<desc>
12588	The major USB version of the device - 1 or 2.
12589	</desc>
12590	</attribute>
12591
12592	<attribute name="portVersion" type="unsigned short" readonly="yes">
12593	<desc>
12594	The major USB version of the host USB port the device is
12595	physically connected to - 1 or 2. For devices not connected to
12596	anything this will have the same value as the version attribute.
12597	</desc>
12598	</attribute>
12599
12600	<attribute name="remote" type="boolean" readonly="yes">
12601	<desc>
12602	Whether the device is physically connected to a remote VRDE
12603	client or to a local host machine.
12604	</desc>
12605	</attribute>
12606
12607	</interface>
12608
12609
12610	<!--
12611	// IUSBDeviceFilter
12612	/////////////////////////////////////////////////////////////////////////
12613	-->
12614
12615	<interface
12616	name="IUSBDeviceFilter" extends="$unknown"
12617	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12618	wsmap="managed"
12619	>
12620	<desc>
12621	The IUSBDeviceFilter interface represents an USB device filter used
12622	to perform actions on a group of USB devices.
12623
12624	This type of filters is used by running virtual machines to
12625	automatically capture selected USB devices once they are physically
12626	attached to the host computer.
12627
12628	A USB device is matched to the given device filter if and only if all
12629	attributes of the device match the corresponding attributes of the
12630	filter (that is, attributes are joined together using the logical AND
12631	operation). On the other hand, all together, filters in the list of
12632	filters carry the semantics of the logical OR operation. So if it is
12633	desirable to create a match like "this vendor id OR this product id",
12634	one needs to create two filters and specify "any match" (see below)
12635	for unused attributes.
12636
12637	All filter attributes used for matching are strings. Each string
12638	is an expression representing a set of values of the corresponding
12639	device attribute, that will match the given filter. Currently, the
12640	following filtering expressions are supported:
12641
12642	<ul>
12643	<li><i>Interval filters</i>. Used to specify valid intervals for
12644	integer device attributes (Vendor ID, Product ID and Revision).
12645	The format of the string is:
12646
12647	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12648
12649	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12650	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12651	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12652	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12653	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12654	possible integer is assumed.
12655	</li>
12656	<li><i>Boolean filters</i>. Used to specify acceptable values for
12657	boolean device attributes. The format of the string is:
12658
12659	<tt>true\|false\|yes\|no\|0\|1</tt>
12660
12661	</li>
12662	<li><i>Exact match</i>. Used to specify a single value for the given
12663	device attribute. Any string that doesn't start with <tt>int:</tt>
12664	represents the exact match. String device attributes are compared to
12665	this string including case of symbols. Integer attributes are first
12666	converted to a string (see individual filter attributes) and then
12667	compared ignoring case.
12668
12669	</li>
12670	<li><i>Any match</i>. Any value of the corresponding device attribute
12671	will match the given filter. An empty or @c null string is
12672	used to construct this type of filtering expressions.
12673
12674	</li>
12675	</ul>
12676
12677	<note>
12678	On the Windows host platform, interval filters are not currently
12679	available. Also all string filter attributes
12680	(<link to="#manufacturer"/>, <link to="#product"/>,
12681	<link to="#serialNumber"/>) are ignored, so they behave as
12682	<i>any match</i> no matter what string expression is specified.
12683	</note>
12684
12685	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12686	</desc>
12687
12688	<attribute name="name" type="wstring">
12689	<desc>
12690	Visible name for this filter.
12691	This name is used to visually distinguish one filter from another,
12692	so it can neither be @c null nor an empty string.
12693	</desc>
12694	</attribute>
12695
12696	<attribute name="active" type="boolean">
12697	<desc>Whether this filter active or has been temporarily disabled.</desc>
12698	</attribute>
12699
12700	<attribute name="vendorId" type="wstring">
12701	<desc>
12702	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12703	The string representation for the <i>exact matching</i>
12704	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12705	(including leading zeroes).
12706	</desc>
12707	</attribute>
12708
12709	<attribute name="productId" type="wstring">
12710	<desc>
12711	<link to="IUSBDevice::productId">Product ID</link> filter.
12712	The string representation for the <i>exact matching</i>
12713	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12714	(including leading zeroes).
12715	</desc>
12716	</attribute>
12717
12718	<attribute name="revision" type="wstring">
12719	<desc>
12720	<link to="IUSBDevice::productId">Product revision number</link>
12721	filter. The string representation for the <i>exact matching</i>
12722	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12723	of the integer part of the revision, and <tt>F</tt> is the
12724	decimal digit of its fractional part (including leading and
12725	trailing zeros).
12726	Note that for interval filters, it's best to use the hexadecimal
12727	form, because the revision is stored as a 16 bit packed BCD value;
12728	so the expression <tt>int:0x0100-0x0199</tt> will match any
12729	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12730	</desc>
12731	</attribute>
12732
12733	<attribute name="manufacturer" type="wstring">
12734	<desc>
12735	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12736	</desc>
12737	</attribute>
12738
12739	<attribute name="product" type="wstring">
12740	<desc>
12741	<link to="IUSBDevice::product">Product</link> filter.
12742	</desc>
12743	</attribute>
12744
12745	<attribute name="serialNumber" type="wstring">
12746	<desc>
12747	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12748	</desc>
12749	</attribute>
12750
12751	<attribute name="port" type="wstring">
12752	<desc>
12753	<link to="IUSBDevice::port">Host USB port</link> filter.
12754	</desc>
12755	</attribute>
12756
12757	<attribute name="remote" type="wstring">
12758	<desc>
12759	<link to="IUSBDevice::remote">Remote state</link> filter.
12760	<note>
12761	This filter makes sense only for machine USB filters,
12762	i.e. it is ignored by IHostUSBDeviceFilter objects.
12763	</note>
12764	</desc>
12765	</attribute>
12766
12767	<attribute name="maskedInterfaces" type="unsigned long">
12768	<desc>
12769	This is an advanced option for hiding one or more USB interfaces
12770	from the guest. The value is a bit mask where the bits that are set
12771	means the corresponding USB interface should be hidden, masked off
12772	if you like.
12773	This feature only works on Linux hosts.
12774	</desc>
12775	</attribute>
12776
12777	</interface>
12778
12779
12780	<!--
12781	// IHostUSBDevice
12782	/////////////////////////////////////////////////////////////////////////
12783	-->
12784
12785	<enum
12786	name="USBDeviceState"
12787	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12788	>
12789	<desc>
12790	USB device state. This enumeration represents all possible states
12791	of the USB device physically attached to the host computer regarding
12792	its state on the host computer and availability to guest computers
12793	(all currently running virtual machines).
12794
12795	Once a supported USB device is attached to the host, global USB
12796	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12797	either ignore the device, or put it to USBDeviceState_Held state, or do
12798	nothing. Unless the device is ignored by global filters, filters of all
12799	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12800	activated that can put it to USBDeviceState_Captured state.
12801
12802	If the device was ignored by global filters, or didn't match
12803	any filters at all (including guest ones), it is handled by the host
12804	in a normal way. In this case, the device state is determined by
12805	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12806	or USBDeviceState_Available, depending on the current device usage.
12807
12808	Besides auto-capturing based on filters, the device can be manually
12809	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12810	state is USBDeviceState_Busy, USBDeviceState_Available or
12811	USBDeviceState_Held.
12812
12813	<note>
12814	Due to differences in USB stack implementations in Linux and Win32,
12815	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12816	only to the Linux version of the product. This also means that (<link
12817	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12818	device state is USBDeviceState_Held.
12819	</note>
12820
12821	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12822	</desc>
12823
12824	<const name="NotSupported" value="0">
12825	<desc>
12826	Not supported by the VirtualBox server, not available to guests.
12827	</desc>
12828	</const>
12829	<const name="Unavailable" value="1">
12830	<desc>
12831	Being used by the host computer exclusively,
12832	not available to guests.
12833	</desc>
12834	</const>
12835	<const name="Busy" value="2">
12836	<desc>
12837	Being used by the host computer, potentially available to guests.
12838	</desc>
12839	</const>
12840	<const name="Available" value="3">
12841	<desc>
12842	Not used by the host computer, available to guests (the host computer
12843	can also start using the device at any time).
12844	</desc>
12845	</const>
12846	<const name="Held" value="4">
12847	<desc>
12848	Held by the VirtualBox server (ignored by the host computer),
12849	available to guests.
12850	</desc>
12851	</const>
12852	<const name="Captured" value="5">
12853	<desc>
12854	Captured by one of the guest computers, not available
12855	to anybody else.
12856	</desc>
12857	</const>
12858	</enum>
12859
12860	<interface
12861	name="IHostUSBDevice" extends="IUSBDevice"
12862	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12863	wsmap="managed"
12864	>
12865	<desc>
12866	The IHostUSBDevice interface represents a physical USB device attached
12867	to the host computer.
12868
12869	Besides properties inherited from IUSBDevice, this interface adds the
12870	<link to="#state"/> property that holds the current state of the USB
12871	device.
12872
12873	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12874	</desc>
12875
12876	<attribute name="state" type="USBDeviceState" readonly="yes">
12877	<desc>
12878	Current state of the device.
12879	</desc>
12880	</attribute>
12881
12882	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
12883
12884	</interface>
12885
12886
12887	<!--
12888	// IHostUSBDeviceFilter
12889	/////////////////////////////////////////////////////////////////////////
12890	-->
12891
12892	<enum
12893	name="USBDeviceFilterAction"
12894	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
12895	>
12896	<desc>
12897	Actions for host USB device filters.
12898	<see>IHostUSBDeviceFilter, USBDeviceState</see>
12899	</desc>
12900
12901	<const name="Null" value="0">
12902	<desc>Null value (never used by the API).</desc>
12903	</const>
12904	<const name="Ignore" value="1">
12905	<desc>Ignore the matched USB device.</desc>
12906	</const>
12907	<const name="Hold" value="2">
12908	<desc>Hold the matched USB device.</desc>
12909	</const>
12910	</enum>
12911
12912	<interface
12913	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
12914	uuid="4cc70246-d74a-400f-8222-3900489c0374"
12915	wsmap="managed"
12916	>
12917	<desc>
12918	The IHostUSBDeviceFilter interface represents a global filter for a
12919	physical USB device used by the host computer. Used indirectly in
12920	<link to="IHost::USBDeviceFilters"/>.
12921
12922	Using filters of this type, the host computer determines the initial
12923	state of the USB device after it is physically attached to the
12924	host's USB controller.
12925
12926	<note>
12927	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
12928	filters, because it makes sense only for
12929	<link to="IUSBController::deviceFilters">machine USB filters</link>.
12930	</note>
12931
12932	<see>IHost::USBDeviceFilters</see>
12933	</desc>
12934
12935	<attribute name="action" type="USBDeviceFilterAction">
12936	<desc>
12937	Action performed by the host when an attached USB device
12938	matches this filter.
12939	</desc>
12940	</attribute>
12941
12942	</interface>
12943
12944	<!--
12945	// IAudioAdapter
12946	/////////////////////////////////////////////////////////////////////////
12947	-->
12948
12949	<enum
12950	name="AudioDriverType"
12951	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
12952	>
12953	<desc>
12954	Host audio driver type.
12955	</desc>
12956
12957	<const name="Null" value="0">
12958	<desc>Null value, also means "dummy audio driver".</desc>
12959	</const>
12960	<const name="WinMM" value="1">
12961	<desc>Windows multimedia (Windows hosts only).</desc>
12962	</const>
12963	<const name="OSS" value="2">
12964	<desc>Open Sound System (Linux hosts only).</desc>
12965	</const>
12966	<const name="ALSA" value="3">
12967	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
12968	</const>
12969	<const name="DirectSound" value="4">
12970	<desc>DirectSound (Windows hosts only).</desc>
12971	</const>
12972	<const name="CoreAudio" value="5">
12973	<desc>CoreAudio (Mac hosts only).</desc>
12974	</const>
12975	<const name="MMPM" value="6">
12976	<desc>Reserved for historical reasons.</desc>
12977	</const>
12978	<const name="Pulse" value="7">
12979	<desc>PulseAudio (Linux hosts only).</desc>
12980	</const>
12981	<const name="SolAudio" value="8">
12982	<desc>Solaris audio (Solaris hosts only).</desc>
12983	</const>
12984	</enum>
12985
12986	<enum
12987	name="AudioControllerType"
12988	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
12989	>
12990	<desc>
12991	Virtual audio controller type.
12992	</desc>
12993
12994	<const name="AC97" value="0"/>
12995	<const name="SB16" value="1"/>
12996	<const name="HDA" value="2"/>
12997	</enum>
12998
12999	<interface
13000	name="IAudioAdapter" extends="$unknown"
13001	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
13002	wsmap="managed"
13003	>
13004	<desc>
13005	The IAudioAdapter interface represents the virtual audio adapter of
13006	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
13007	</desc>
13008	<attribute name="enabled" type="boolean">
13009	<desc>
13010	Flag whether the audio adapter is present in the
13011	guest system. If disabled, the virtual guest hardware will
13012	not contain any audio adapter. Can only be changed when
13013	the VM is not running.
13014	</desc>
13015	</attribute>
13016	<attribute name="audioController" type="AudioControllerType">
13017	<desc>
13018	The audio hardware we emulate.
13019	</desc>
13020	</attribute>
13021	<attribute name="audioDriver" type="AudioDriverType">
13022	<desc>
13023	Audio driver the adapter is connected to. This setting
13024	can only be changed when the VM is not running.
13025	</desc>
13026	</attribute>
13027	</interface>
13028
13029	<enum
13030	name="AuthType"
13031	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
13032	>
13033	<desc>
13034	VirtualBox authentication type.
13035	</desc>
13036
13037	<const name="Null" value="0">
13038	<desc>Null value, also means "no authentication".</desc>
13039	</const>
13040	<const name="External" value="1"/>
13041	<const name="Guest" value="2"/>
13042	</enum>
13043
13044	<!--
13045	// IVRDEServer
13046	/////////////////////////////////////////////////////////////////////////
13047	-->
13048
13049	<interface
13050	name="IVRDEServer" extends="$unknown"
13051	uuid="be24e0db-e1d6-4d58-b85b-21053d1511b4"
13052	wsmap="managed"
13053	>
13054	<attribute name="enabled" type="boolean">
13055	<desc>VRDE server status.</desc>
13056	</attribute>
13057
13058	<attribute name="authType" type="AuthType">
13059	<desc>VRDE authentication method.</desc>
13060	</attribute>
13061
13062	<attribute name="authTimeout" type="unsigned long">
13063	<desc>Timeout for guest authentication. Milliseconds.</desc>
13064	</attribute>
13065
13066	<attribute name="allowMultiConnection" type="boolean">
13067	<desc>
13068	Flag whether multiple simultaneous connections to the VM are permitted.
13069	Note that this will be replaced by a more powerful mechanism in the future.
13070	</desc>
13071	</attribute>
13072
13073	<attribute name="reuseSingleConnection" type="boolean">
13074	<desc>
13075	Flag whether the existing connection must be dropped and a new connection
13076	must be established by the VRDE server, when a new client connects in single
13077	connection mode.
13078	</desc>
13079	</attribute>
13080
13081	<attribute name="VRDEExtPack" type="wstring">
13082	<desc>
13083	The name of Extension Pack providing VRDE for this VM. Overrides
13084	<link to="ISystemProperties::defaultVRDEExtPack"/>.
13085	</desc>
13086	</attribute>
13087
13088	<attribute name="AuthLibrary" type="wstring">
13089	<desc>
13090	Library used for authentication of RDP clients by this VM. Overrides
13091	<link to="ISystemProperties::VRDEAuthLibrary"/>.
13092	</desc>
13093	</attribute>
13094
13095	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
13096	<desc>
13097	Array of names of properties, which are supported by this VRDE server.
13098	</desc>
13099	</attribute>
13100
13101	<method name="setVRDEProperty">
13102	<desc>
13103	Sets a VRDE specific property string.
13104
13105	If you pass @c null or empty string as a key @a value, the given @a key
13106	will be deleted.
13107
13108	</desc>
13109	<param name="key" type="wstring" dir="in">
13110	<desc>Name of the key to set.</desc>
13111	</param>
13112	<param name="value" type="wstring" dir="in">
13113	<desc>Value to assign to the key.</desc>
13114	</param>
13115	</method>
13116
13117	<method name="getVRDEProperty">
13118	<desc>
13119	Returns a VRDE specific property string.
13120
13121	If the requested data @a key does not exist, this function will
13122	succeed and return an empty string in the @a value argument.
13123
13124	</desc>
13125	<param name="key" type="wstring" dir="in">
13126	<desc>Name of the key to get.</desc>
13127	</param>
13128	<param name="value" type="wstring" dir="return">
13129	<desc>Value of the requested key.</desc>
13130	</param>
13131	</method>
13132
13133	</interface>
13134
13135
13136	<!--
13137	// ISharedFolder
13138	/////////////////////////////////////////////////////////////////////////
13139	-->
13140
13141	<interface
13142	name="ISharedFolder" extends="$unknown"
13143	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
13144	wsmap="struct"
13145	>
13146	<desc>
13147	The ISharedFolder interface represents a folder in the host computer's
13148	file system accessible from the guest OS running inside a virtual
13149	machine using an associated logical name.
13150
13151	There are three types of shared folders:
13152	<ul>
13153	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13154	folders available to all virtual machines.</li>
13155	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13156	VM-specific shared folders available to the given virtual machine at
13157	startup.</li>
13158	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13159	VM-specific shared folders created in the session context (for
13160	example, when the virtual machine is running) and automatically
13161	discarded when the session is closed (the VM is powered off).</li>
13162	</ul>
13163
13164	Logical names of shared folders must be unique within the given scope
13165	(global, permanent or transient). However, they do not need to be unique
13166	across scopes. In this case, the definition of the shared folder in a
13167	more specific scope takes precedence over definitions in all other
13168	scopes. The order of precedence is (more specific to more general):
13169	<ol>
13170	<li>Transient definitions</li>
13171	<li>Permanent definitions</li>
13172	<li>Global definitions</li>
13173	</ol>
13174
13175	For example, if MyMachine has a shared folder named
13176	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13177	transient shared folder named <tt>C_DRIVE</tt> (that points
13178	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13179	of <tt>C_DRIVE</tt> in the guest OS so
13180	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13181	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13182	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13183	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13184	to <tt>C:\\</tt> if it still exists.
13185
13186	Note that permanent and transient shared folders of different machines
13187	are in different name spaces, so they don't overlap and don't need to
13188	have unique logical names.
13189
13190	<note>
13191	Global shared folders are not implemented in the current version of the
13192	product.
13193	</note>
13194	</desc>
13195
13196	<attribute name="name" type="wstring" readonly="yes">
13197	<desc>Logical name of the shared folder.</desc>
13198	</attribute>
13199
13200	<attribute name="hostPath" type="wstring" readonly="yes">
13201	<desc>Full path to the shared folder in the host file system.</desc>
13202	</attribute>
13203
13204	<attribute name="accessible" type="boolean" readonly="yes">
13205	<desc>
13206	Whether the folder defined by the host path is currently
13207	accessible or not.
13208	For example, the folder can be inaccessible if it is placed
13209	on the network share that is not available by the time
13210	this property is read.
13211	</desc>
13212	</attribute>
13213
13214	<attribute name="writable" type="boolean" readonly="yes">
13215	<desc>
13216	Whether the folder defined by the host path is writable or
13217	not.
13218	</desc>
13219	</attribute>
13220
13221	<attribute name="autoMount" type="boolean" readonly="yes">
13222	<desc>
13223	Whether the folder gets automatically mounted by the guest or not.
13224	</desc>
13225	</attribute>
13226
13227	<attribute name="lastAccessError" type="wstring" readonly="yes">
13228	<desc>
13229	Text message that represents the result of the last accessibility
13230	check.
13231
13232	Accessibility checks are performed each time the <link to="#accessible"/>
13233	attribute is read. An empty string is returned if the last
13234	accessibility check was successful. A non-empty string indicates a
13235	failure and should normally describe a reason of the failure (for
13236	example, a file read error).
13237	</desc>
13238	</attribute>
13239
13240	</interface>
13241
13242	<!--
13243	// ISession
13244	/////////////////////////////////////////////////////////////////////////
13245	-->
13246
13247	<interface
13248	name="IInternalSessionControl" extends="$unknown"
13249	uuid="a2fbf834-149d-41da-ae52-0dc3b0f032b3"
13250	internal="yes"
13251	wsmap="suppress"
13252	>
13253	<method name="getPID">
13254	<desc>PID of the process that has created this Session object.
13255	</desc>
13256	<param name="pid" type="unsigned long" dir="return"/>
13257	</method>
13258
13259	<method name="getRemoteConsole">
13260	<desc>
13261	Returns the console object suitable for remote control.
13262
13263	<result name="VBOX_E_INVALID_VM_STATE">
13264	Session state prevents operation.
13265	</result>
13266	<result name="VBOX_E_INVALID_OBJECT_STATE">
13267	Session type prevents operation.
13268	</result>
13269
13270	</desc>
13271	<param name="console" type="IConsole" dir="return"/>
13272	</method>
13273
13274	<method name="assignMachine">
13275	<desc>
13276	Assigns the machine object associated with this direct-type
13277	session or informs the session that it will be a remote one
13278	(if @a machine == @c null).
13279
13280	<result name="VBOX_E_INVALID_VM_STATE">
13281	Session state prevents operation.
13282	</result>
13283	<result name="VBOX_E_INVALID_OBJECT_STATE">
13284	Session type prevents operation.
13285	</result>
13286
13287	</desc>
13288	<param name="machine" type="IMachine" dir="in"/>
13289	</method>
13290
13291	<method name="assignRemoteMachine">
13292	<desc>
13293	Assigns the machine and the (remote) console object associated with
13294	this remote-type session.
13295
13296	<result name="VBOX_E_INVALID_VM_STATE">
13297	Session state prevents operation.
13298	</result>
13299
13300	</desc>
13301	<param name="machine" type="IMachine" dir="in"/>
13302	<param name="console" type="IConsole" dir="in"/>
13303	</method>
13304
13305	<method name="updateMachineState">
13306	<desc>
13307	Updates the machine state in the VM process.
13308	Must be called only in certain cases
13309	(see the method implementation).
13310
13311	<result name="VBOX_E_INVALID_VM_STATE">
13312	Session state prevents operation.
13313	</result>
13314	<result name="VBOX_E_INVALID_OBJECT_STATE">
13315	Session type prevents operation.
13316	</result>
13317
13318	</desc>
13319	<param name="aMachineState" type="MachineState" dir="in"/>
13320	</method>
13321
13322	<method name="uninitialize">
13323	<desc>
13324	Uninitializes (closes) this session. Used by VirtualBox to close
13325	the corresponding remote session when the direct session dies
13326	or gets closed.
13327
13328	<result name="VBOX_E_INVALID_VM_STATE">
13329	Session state prevents operation.
13330	</result>
13331
13332	</desc>
13333	</method>
13334
13335	<method name="onNetworkAdapterChange">
13336	<desc>
13337	Triggered when settings of a network adapter of the
13338	associated virtual machine have changed.
13339
13340	<result name="VBOX_E_INVALID_VM_STATE">
13341	Session state prevents operation.
13342	</result>
13343	<result name="VBOX_E_INVALID_OBJECT_STATE">
13344	Session type prevents operation.
13345	</result>
13346
13347	</desc>
13348	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13349	<param name="changeAdapter" type="boolean" dir="in"/>
13350	</method>
13351
13352	<method name="onSerialPortChange">
13353	<desc>
13354	Triggered when settings of a serial port of the
13355	associated virtual machine have changed.
13356
13357	<result name="VBOX_E_INVALID_VM_STATE">
13358	Session state prevents operation.
13359	</result>
13360	<result name="VBOX_E_INVALID_OBJECT_STATE">
13361	Session type prevents operation.
13362	</result>
13363
13364	</desc>
13365	<param name="serialPort" type="ISerialPort" dir="in"/>
13366	</method>
13367
13368	<method name="onParallelPortChange">
13369	<desc>
13370	Triggered when settings of a parallel port of the
13371	associated virtual machine have changed.
13372
13373	<result name="VBOX_E_INVALID_VM_STATE">
13374	Session state prevents operation.
13375	</result>
13376	<result name="VBOX_E_INVALID_OBJECT_STATE">
13377	Session type prevents operation.
13378	</result>
13379
13380	</desc>
13381	<param name="parallelPort" type="IParallelPort" dir="in"/>
13382	</method>
13383
13384	<method name="onStorageControllerChange">
13385	<desc>
13386	Triggered when settings of a storage controller of the
13387	associated virtual machine have changed.
13388
13389	<result name="VBOX_E_INVALID_VM_STATE">
13390	Session state prevents operation.
13391	</result>
13392	<result name="VBOX_E_INVALID_OBJECT_STATE">
13393	Session type prevents operation.
13394	</result>
13395
13396	</desc>
13397	</method>
13398
13399	<method name="onMediumChange">
13400	<desc>
13401	Triggered when attached media of the
13402	associated virtual machine have changed.
13403
13404	<result name="VBOX_E_INVALID_VM_STATE">
13405	Session state prevents operation.
13406	</result>
13407	<result name="VBOX_E_INVALID_OBJECT_STATE">
13408	Session type prevents operation.
13409	</result>
13410
13411	</desc>
13412
13413	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13414	<param name="force" type="boolean" dir="in"/>
13415	</method>
13416
13417	<method name="onCPUChange">
13418	<desc>
13419	Notification when a CPU changes.
13420	</desc>
13421	<param name="cpu" type="unsigned long" dir="in">
13422	<desc>The CPU which changed</desc>
13423	</param>
13424	<param name="add" type="boolean" dir="in">
13425	<desc>Flag whether the CPU was added or removed</desc>
13426	</param>
13427	</method>
13428
13429	<method name="onCPUExecutionCapChange">
13430	<desc>
13431	Notification when the CPU execution cap changes.
13432	</desc>
13433	<param name="executionCap" type="unsigned long" dir="in">
13434	<desc>The new CPU execution cap value. (1-100)</desc>
13435	</param>
13436	</method>
13437
13438	<method name="onVRDEServerChange">
13439	<desc>
13440	Triggered when settings of the VRDE server object of the
13441	associated virtual machine have changed.
13442
13443	<result name="VBOX_E_INVALID_VM_STATE">
13444	Session state prevents operation.
13445	</result>
13446	<result name="VBOX_E_INVALID_OBJECT_STATE">
13447	Session type prevents operation.
13448	</result>
13449
13450	</desc>
13451	<param name="restart" type="boolean" dir="in">
13452	<desc>Flag whether the server must be restarted</desc>
13453	</param>
13454	</method>
13455
13456	<method name="onUSBControllerChange">
13457	<desc>
13458	Triggered when settings of the USB controller object of the
13459	associated virtual machine have changed.
13460
13461	<result name="VBOX_E_INVALID_VM_STATE">
13462	Session state prevents operation.
13463	</result>
13464	<result name="VBOX_E_INVALID_OBJECT_STATE">
13465	Session type prevents operation.
13466	</result>
13467
13468	</desc>
13469	</method>
13470
13471	<method name="onSharedFolderChange">
13472	<desc>
13473	Triggered when a permanent (global or machine) shared folder has been
13474	created or removed.
13475	<note>
13476	We don't pass shared folder parameters in this notification because
13477	the order in which parallel notifications are delivered is not defined,
13478	therefore it could happen that these parameters were outdated by the
13479	time of processing this notification.
13480	</note>
13481
13482	<result name="VBOX_E_INVALID_VM_STATE">
13483	Session state prevents operation.
13484	</result>
13485	<result name="VBOX_E_INVALID_OBJECT_STATE">
13486	Session type prevents operation.
13487	</result>
13488
13489	</desc>
13490	<param name="global" type="boolean" dir="in"/>
13491	</method>
13492
13493	<method name="onUSBDeviceAttach">
13494	<desc>
13495	Triggered when a request to capture a USB device (as a result
13496	of matched USB filters or direct call to
13497	<link to="IConsole::attachUSBDevice"/>) has completed.
13498	A @c null @a error object means success, otherwise it
13499	describes a failure.
13500
13501	<result name="VBOX_E_INVALID_VM_STATE">
13502	Session state prevents operation.
13503	</result>
13504	<result name="VBOX_E_INVALID_OBJECT_STATE">
13505	Session type prevents operation.
13506	</result>
13507
13508	</desc>
13509	<param name="device" type="IUSBDevice" dir="in"/>
13510	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13511	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13512	</method>
13513
13514	<method name="onUSBDeviceDetach">
13515	<desc>
13516	Triggered when a request to release the USB device (as a result
13517	of machine termination or direct call to
13518	<link to="IConsole::detachUSBDevice"/>) has completed.
13519	A @c null @a error object means success, otherwise it
13520	describes a failure.
13521
13522	<result name="VBOX_E_INVALID_VM_STATE">
13523	Session state prevents operation.
13524	</result>
13525	<result name="VBOX_E_INVALID_OBJECT_STATE">
13526	Session type prevents operation.
13527	</result>
13528
13529	</desc>
13530	<param name="id" type="uuid" mod="string" dir="in"/>
13531	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13532	</method>
13533
13534	<method name="onShowWindow">
13535	<desc>
13536	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13537	<link to="IMachine::showConsoleWindow"/> in order to notify
13538	console listeners
13539	<link to="ICanShowWindowEvent"/>
13540	and <link to="IShowWindowEvent"/>.
13541
13542	<result name="VBOX_E_INVALID_OBJECT_STATE">
13543	Session type prevents operation.
13544	</result>
13545
13546	</desc>
13547	<param name="check" type="boolean" dir="in"/>
13548	<param name="canShow" type="boolean" dir="out"/>
13549	<param name="winId" type="long long" dir="out"/>
13550	</method>
13551
13552	<method name="onBandwidthGroupChange">
13553	<desc>
13554	Notification when one of the bandwidth groups change.
13555	</desc>
13556	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
13557	<desc>The bandwidth group which changed.</desc>
13558	</param>
13559	</method>
13560
13561	<method name="accessGuestProperty">
13562	<desc>
13563	Called by <link to="IMachine::getGuestProperty"/> and by
13564	<link to="IMachine::setGuestProperty"/> in order to read and
13565	modify guest properties.
13566
13567	<result name="VBOX_E_INVALID_VM_STATE">
13568	Machine session is not open.
13569	</result>
13570	<result name="VBOX_E_INVALID_OBJECT_STATE">
13571	Session type is not direct.
13572	</result>
13573
13574	</desc>
13575	<param name="name" type="wstring" dir="in"/>
13576	<param name="value" type="wstring" dir="in"/>
13577	<param name="flags" type="wstring" dir="in"/>
13578	<param name="isSetter" type="boolean" dir="in"/>
13579	<param name="retValue" type="wstring" dir="out"/>
13580	<param name="retTimestamp" type="long long" dir="out"/>
13581	<param name="retFlags" type="wstring" dir="out"/>
13582	</method>
13583
13584	<method name="enumerateGuestProperties">
13585	<desc>
13586	Return a list of the guest properties matching a set of patterns along
13587	with their values, time stamps and flags.
13588
13589	<result name="VBOX_E_INVALID_VM_STATE">
13590	Machine session is not open.
13591	</result>
13592	<result name="VBOX_E_INVALID_OBJECT_STATE">
13593	Session type is not direct.
13594	</result>
13595
13596	</desc>
13597	<param name="patterns" type="wstring" dir="in">
13598	<desc>
13599	The patterns to match the properties against as a comma-separated
13600	string. If this is empty, all properties currently set will be
13601	returned.
13602	</desc>
13603	</param>
13604	<param name="key" type="wstring" dir="out" safearray="yes">
13605	<desc>
13606	The key names of the properties returned.
13607	</desc>
13608	</param>
13609	<param name="value" type="wstring" dir="out" safearray="yes">
13610	<desc>
13611	The values of the properties returned. The array entries match the
13612	corresponding entries in the @a key array.
13613	</desc>
13614	</param>
13615	<param name="timestamp" type="long long" dir="out" safearray="yes">
13616	<desc>
13617	The time stamps of the properties returned. The array entries match
13618	the corresponding entries in the @a key array.
13619	</desc>
13620	</param>
13621	<param name="flags" type="wstring" dir="out" safearray="yes">
13622	<desc>
13623	The flags of the properties returned. The array entries match the
13624	corresponding entries in the @a key array.
13625	</desc>
13626	</param>
13627	</method>
13628
13629	<method name="onlineMergeMedium">
13630	<desc>
13631	Triggers online merging of a hard disk. Used internally when deleting
13632	a snapshot while a VM referring to the same hard disk chain is running.
13633
13634	<result name="VBOX_E_INVALID_VM_STATE">
13635	Machine session is not open.
13636	</result>
13637	<result name="VBOX_E_INVALID_OBJECT_STATE">
13638	Session type is not direct.
13639	</result>
13640
13641	</desc>
13642	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13643	<desc>The medium attachment to identify the medium chain.</desc>
13644	</param>
13645	<param name="sourceIdx" type="unsigned long" dir="in">
13646	<desc>The index of the source image in the chain.
13647	Redundant, but drastically reduces IPC.</desc>
13648	</param>
13649	<param name="targetIdx" type="unsigned long" dir="in">
13650	<desc>The index of the target image in the chain.
13651	Redundant, but drastically reduces IPC.</desc>
13652	</param>
13653	<param name="source" type="IMedium" dir="in">
13654	<desc>Merge source medium.</desc>
13655	</param>
13656	<param name="target" type="IMedium" dir="in">
13657	<desc>Merge target medium.</desc>
13658	</param>
13659	<param name="mergeForward" type="boolean" dir="in">
13660	<desc>Merge direction.</desc>
13661	</param>
13662	<param name="parentForTarget" type="IMedium" dir="in">
13663	<desc>For forward merges: new parent for target medium.</desc>
13664	</param>
13665	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13666	<desc>For backward merges: list of media which need their parent UUID
13667	updated.</desc>
13668	</param>
13669	<param name="progress" type="IProgress" dir="in">
13670	<desc>
13671	Progress object for this operation.
13672	</desc>
13673	</param>
13674	</method>
13675
13676	</interface>
13677
13678	<interface
13679	name="ISession" extends="$unknown"
13680	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13681	wsmap="managed"
13682	>
13683	<desc>
13684	The ISession interface represents a client process and allows for locking
13685	virtual machines (represented by IMachine objects) to prevent conflicting
13686	changes to the machine.
13687
13688	Any caller wishing to manipulate a virtual machine needs to create a session
13689	object first, which lives in its own process space. Such session objects are
13690	then associated with <link to="IMachine" /> objects living in the VirtualBox
13691	server process to coordinate such changes.
13692
13693	There are two typical scenarios in which sessions are used:
13694
13695	<ul>
13696	<li>To alter machine settings or control a running virtual machine, one
13697	needs to lock a machine for a given session (client process) by calling
13698	<link to="IMachine::lockMachine"/>.
13699
13700	Whereas multiple sessions may control a running virtual machine, only
13701	one process can obtain a write lock on the machine to prevent conflicting
13702	changes. A write lock is also needed if a process wants to actually run a
13703	virtual machine in its own context, such as the VirtualBox GUI or
13704	VBoxHeadless front-ends. They must also lock a machine for their own
13705	sessions before they are allowed to power up the virtual machine.
13706
13707	As a result, no machine settings can be altered while another process is
13708	already using it, either because that process is modifying machine settings
13709	or because the machine is running.
13710	</li>
13711	<li>
13712	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13713	VirtualBox GUI or VBoxHeadless), one would use
13714	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13715	as its first parameter. This session then identifies the caller and lets the
13716	caller control the started machine (for example, pause machine execution or
13717	power it down) as well as be notified about machine execution state changes.
13718	</li>
13719	</ul>
13720
13721	How sessions objects are created in a client process depends on whether you use
13722	the Main API via COM or via the webservice:
13723
13724	<ul>
13725	<li>When using the COM API directly, an object of the Session class from the
13726	VirtualBox type library needs to be created. In regular COM C++ client code,
13727	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13728	This object will then act as a local session object in further calls to open
13729	a session.
13730	</li>
13731
13732	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13733	a session object automatically whenever <link to="IWebsessionManager::logon" />
13734	is called. A managed object reference to that session object can be retrieved by
13735	calling <link to="IWebsessionManager::getSessionObject" />.
13736	</li>
13737	</ul>
13738	</desc>
13739
13740	<attribute name="state" type="SessionState" readonly="yes">
13741	<desc>Current state of this session.</desc>
13742	</attribute>
13743
13744	<attribute name="type" type="SessionType" readonly="yes">
13745	<desc>
13746	Type of this session. The value of this attribute is valid only
13747	if the session currently has a machine locked (i.e. its
13748	<link to="#state" /> is Locked), otherwise an error will be returned.
13749	</desc>
13750	</attribute>
13751
13752	<attribute name="machine" type="IMachine" readonly="yes">
13753	<desc>Machine object associated with this session.</desc>
13754	</attribute>
13755
13756	<attribute name="console" type="IConsole" readonly="yes">
13757	<desc>Console object associated with this session.</desc>
13758	</attribute>
13759
13760	<method name="unlockMachine">
13761	<desc>
13762	Unlocks a machine that was previously locked for the current session.
13763
13764	Calling this method is required every time a machine has been locked
13765	for a particular session using the <link to="IMachine::launchVMProcess" />
13766	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13767	the machine will be set to <link to="MachineState_Aborted" /> on the
13768	server, and changes made to the machine settings will be lost.
13769
13770	Generally, it is recommended to unlock all machines explicitly
13771	before terminating the application (regardless of the reason for
13772	the termination).
13773
13774	<note>
13775	Do not expect the session state (<link to="ISession::state" />
13776	to return to "Unlocked" immediately after you invoke this method,
13777	particularly if you have started a new VM process. The session
13778	state will automatically return to "Unlocked" once the VM is no
13779	longer executing, which can of course take a very long time.
13780	</note>
13781
13782	<result name="E_UNEXPECTED">
13783	Session is not locked.
13784	</result>
13785
13786	</desc>
13787	</method>
13788
13789	</interface>
13790
13791	<!--
13792	// IStorageController
13793	/////////////////////////////////////////////////////////////////////////
13794	-->
13795
13796	<enum
13797	name="StorageBus"
13798	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13799	>
13800	<desc>
13801	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13802	see <link to="IStorageController::bus" />.
13803	</desc>
13804	<const name="Null" value="0">
13805	<desc>@c null value. Never used by the API.</desc>
13806	</const>
13807	<const name="IDE" value="1"/>
13808	<const name="SATA" value="2"/>
13809	<const name="SCSI" value="3"/>
13810	<const name="Floppy" value="4"/>
13811	<const name="SAS" value="5"/>
13812	</enum>
13813
13814	<enum
13815	name="StorageControllerType"
13816	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13817	>
13818	<desc>
13819	The exact variant of storage controller hardware presented
13820	to the guest; see <link to="IStorageController::controllerType" />.
13821	</desc>
13822
13823	<const name="Null" value="0">
13824	<desc>@c null value. Never used by the API.</desc>
13825	</const>
13826	<const name="LsiLogic" value="1">
13827	<desc>A SCSI controller of the LsiLogic variant.</desc>
13828	</const>
13829	<const name="BusLogic" value="2">
13830	<desc>A SCSI controller of the BusLogic variant.</desc>
13831	</const>
13832	<const name="IntelAhci" value="3">
13833	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13834	</const>
13835	<const name="PIIX3" value="4">
13836	<desc>An IDE controller of the PIIX3 variant.</desc>
13837	</const>
13838	<const name="PIIX4" value="5">
13839	<desc>An IDE controller of the PIIX4 variant.</desc>
13840	</const>
13841	<const name="ICH6" value="6">
13842	<desc>An IDE controller of the ICH6 variant.</desc>
13843	</const>
13844	<const name="I82078" value="7">
13845	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13846	</const>
13847	<const name="LsiLogicSas" value="8">
13848	<desc>A variant of the LsiLogic controller using SAS.</desc>
13849	</const>
13850	</enum>
13851
13852	<enum
13853	name="ChipsetType"
13854	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13855	>
13856	<desc>
13857	Type of emulated chipset (mostly southbridge).
13858	</desc>
13859
13860	<const name="Null" value="0">
13861	<desc>@c null value. Never used by the API.</desc>
13862	</const>
13863	<const name="PIIX3" value="1">
13864	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13865	</const>
13866	<const name="ICH9" value="2">
13867	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13868	</const>
13869	</enum>
13870
13871	<interface
13872	name="IStorageController" extends="$unknown"
13873	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
13874	wsmap="managed"
13875	>
13876	<desc>
13877	Represents a storage controller that is attached to a virtual machine
13878	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
13879	attached to storage controllers in a real computer, virtual drives
13880	(represented by <link to="IMediumAttachment" />) are attached to virtual
13881	storage controllers, represented by this interface.
13882
13883	As opposed to physical hardware, VirtualBox has a very generic concept
13884	of a storage controller, and for purposes of the Main API, all virtual
13885	storage is attached to virtual machines via instances of this interface.
13886	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
13887	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
13888	is used, certain sub-types may be available and can be selected in
13889	<link to="#controllerType" />.
13890
13891	Depending on these settings, the guest operating system might see
13892	significantly different virtual hardware.
13893	</desc>
13894
13895	<attribute name="name" type="wstring" readonly="yes">
13896	<desc>
13897	Name of the storage controller, as originally specified with
13898	<link to="IMachine::addStorageController" />. This then uniquely
13899	identifies this controller with other method calls such as
13900	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
13901	</desc>
13902	</attribute>
13903
13904	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
13905	<desc>
13906	Maximum number of devices which can be attached to one port.
13907	</desc>
13908	</attribute>
13909
13910	<attribute name="minPortCount" type="unsigned long" readonly="yes">
13911	<desc>
13912	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
13913	</desc>
13914	</attribute>
13915
13916	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
13917	<desc>
13918	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
13919	</desc>
13920	</attribute>
13921
13922	<attribute name="instance" type="unsigned long">
13923	<desc>
13924	The instance number of the device in the running VM.
13925	</desc>
13926	</attribute>
13927
13928	<attribute name="portCount" type="unsigned long">
13929	<desc>
13930	The number of currently usable ports on the controller.
13931	The minimum and maximum number of ports for one controller are
13932	stored in <link to="IStorageController::minPortCount"/>
13933	and <link to="IStorageController::maxPortCount"/>.
13934	</desc>
13935	</attribute>
13936
13937	<attribute name="bus" type="StorageBus" readonly="yes">
13938	<desc>
13939	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
13940	</desc>
13941	</attribute>
13942
13943	<attribute name="controllerType" type="StorageControllerType">
13944	<desc>
13945	The exact variant of storage controller hardware presented
13946	to the guest.
13947	Depending on this value, VirtualBox will provide a different
13948	virtual storage controller hardware to the guest.
13949	For SATA, SAS and floppy controllers, only one variant is
13950	available, but for IDE and SCSI, there are several.
13951
13952	For SCSI controllers, the default type is LsiLogic.
13953	</desc>
13954	</attribute>
13955
13956	<attribute name="useHostIOCache" type="boolean">
13957	<desc>
13958	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
13959	caches and use synchronous file APIs on the host. This was the only option in the API before
13960	VirtualBox 3.2 and is still the default for IDE controllers.
13961
13962	If false, the host I/O cache will be disabled for image files attached to this storage controller.
13963	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
13964	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
13965	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
13966	virtual machines are running at the same time to prevent I/O cache related hangs.
13967	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
13968	</desc>
13969	</attribute>
13970
13971	<attribute name="bootable" type="boolean" readonly="yes">
13972	<desc>
13973	Returns whether it is possible to boot from disks attached to this controller.
13974	</desc>
13975	</attribute>
13976
13977	<method name="getIDEEmulationPort">
13978	<desc>
13979	Gets the corresponding port number which is emulated as an IDE device.
13980	Works only with SATA controllers.
13981
13982	<result name="E_INVALIDARG">
13983	The @a devicePosition is not in the range 0 to 3.
13984	</result>
13985	<result name="E_NOTIMPL">
13986	The storage controller type is not SATAIntelAhci.
13987	</result>
13988
13989	</desc>
13990	<param name="devicePosition" type="long" dir="in"/>
13991	<param name="portNumber" type="long" dir="return"/>
13992	</method>
13993
13994	<method name="setIDEEmulationPort">
13995	<desc>
13996	Sets the port number which is emulated as an IDE device.
13997	Works only with SATA controllers.
13998
13999	<result name="E_INVALIDARG">
14000	The @a devicePosition is not in the range 0 to 3 or the
14001	@a portNumber is not in the range 0 to 29.
14002	</result>
14003	<result name="E_NOTIMPL">
14004	The storage controller type is not SATAIntelAhci.
14005	</result>
14006
14007	</desc>
14008	<param name="devicePosition" type="long" dir="in"/>
14009	<param name="portNumber" type="long" dir="in"/>
14010	</method>
14011
14012	</interface>
14013
14014	<if target="wsdl">
14015
14016	<!--
14017	// IManagedObjectRef
14018	/////////////////////////////////////////////////////////////////////////
14019	-->
14020
14021	<interface
14022	name="IManagedObjectRef" extends="$unknown"
14023	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
14024	internal="yes"
14025	wsmap="managed"
14026	wscpp="hardcoded"
14027	>
14028	<desc>
14029	Managed object reference.
14030
14031	Only within the webservice, a managed object reference (which is really
14032	an opaque number) allows a webservice client to address an object
14033	that lives in the address space of the webservice server.
14034
14035	Behind each managed object reference, there is a COM object that lives
14036	in the webservice server's address space. The COM object is not freed
14037	until the managed object reference is released, either by an explicit
14038	call to <link to="IManagedObjectRef::release" /> or by logging off from
14039	the webservice (<link to="IWebsessionManager::logoff" />), which releases
14040	all objects created during the webservice session.
14041
14042	Whenever a method call of the VirtualBox API returns a COM object, the
14043	webservice representation of that method will instead return a
14044	managed object reference, which can then be used to invoke methods
14045	on that object.
14046	</desc>
14047
14048	<method name="getInterfaceName">
14049	<desc>
14050	Returns the name of the interface that this managed object represents,
14051	for example, "IMachine", as a string.
14052	</desc>
14053	<param name="return" type="wstring" dir="return"/>
14054	</method>
14055
14056	<method name="release">
14057	<desc>
14058	Releases this managed object reference and frees the resources that
14059	were allocated for it in the webservice server process. After calling
14060	this method, the identifier of the reference can no longer be used.
14061	</desc>
14062	</method>
14063
14064	</interface>
14065
14066	<!--
14067	// IWebsessionManager
14068	/////////////////////////////////////////////////////////////////////////
14069	-->
14070
14071	<interface
14072	name="IWebsessionManager" extends="$unknown"
14073	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
14074	internal="yes"
14075	wsmap="global"
14076	wscpp="hardcoded"
14077	>
14078	<desc>
14079	Websession manager. This provides essential services
14080	to webservice clients.
14081	</desc>
14082	<method name="logon">
14083	<desc>
14084	Logs a new client onto the webservice and returns a managed object reference to
14085	the IVirtualBox instance, which the client can then use as a basis to further
14086	queries, since all calls to the VirtualBox API are based on the IVirtualBox
14087	interface, in one way or the other.
14088	</desc>
14089	<param name="username" type="wstring" dir="in"/>
14090	<param name="password" type="wstring" dir="in"/>
14091	<param name="return" type="IVirtualBox" dir="return"/>
14092	</method>
14093
14094	<method name="getSessionObject">
14095	<desc>
14096	Returns a managed object reference to the internal ISession object that was created
14097	for this web service session when the client logged on.
14098
14099	<see>ISession</see>
14100	</desc>
14101	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14102	<param name="return" type="ISession" dir="return"/>
14103	</method>
14104
14105	<method name="logoff">
14106	<desc>
14107	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
14108	and destroys all resources associated with the session (most importantly, all
14109	managed objects created in the server while the session was active).
14110	</desc>
14111	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14112	</method>
14113
14114	</interface>
14115
14116	</if>
14117
14118	<!--
14119	// IPerformanceCollector & friends
14120	/////////////////////////////////////////////////////////////////////////
14121	-->
14122
14123	<interface
14124	name="IPerformanceMetric" extends="$unknown"
14125	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14126	>
14127	<desc>
14128	The IPerformanceMetric interface represents parameters of the given
14129	performance metric.
14130	</desc>
14131
14132	<attribute name="metricName" type="wstring" readonly="yes">
14133	<desc>
14134	Name of the metric.
14135	</desc>
14136	</attribute>
14137
14138	<attribute name="object" type="$unknown" readonly="yes">
14139	<desc>
14140	Object this metric belongs to.
14141	</desc>
14142	</attribute>
14143
14144	<attribute name="description" type="wstring" readonly="yes">
14145	<desc>
14146	Textual description of the metric.
14147	</desc>
14148	</attribute>
14149
14150	<attribute name="period" type="unsigned long" readonly="yes">
14151	<desc>
14152	Time interval between samples, measured in seconds.
14153	</desc>
14154	</attribute>
14155
14156	<attribute name="count" type="unsigned long" readonly="yes">
14157	<desc>
14158	Number of recent samples retained by the performance collector for this
14159	metric.
14160
14161	When the collected sample count exceeds this number, older samples
14162	are discarded.
14163	</desc>
14164	</attribute>
14165
14166	<attribute name="unit" type="wstring" readonly="yes">
14167	<desc>
14168	Unit of measurement.
14169	</desc>
14170	</attribute>
14171
14172	<attribute name="minimumValue" type="long" readonly="yes">
14173	<desc>
14174	Minimum possible value of this metric.
14175	</desc>
14176	</attribute>
14177
14178	<attribute name="maximumValue" type="long" readonly="yes">
14179	<desc>
14180	Maximum possible value of this metric.
14181	</desc>
14182	</attribute>
14183	</interface>
14184
14185	<interface
14186	name="IPerformanceCollector" extends="$unknown"
14187	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14188	wsmap="managed"
14189	>
14190	<desc>
14191	The IPerformanceCollector interface represents a service that collects
14192	and stores performance metrics data.
14193
14194	Performance metrics are associated with objects of interfaces like IHost
14195	and IMachine. Each object has a distinct set of performance metrics. The
14196	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14197
14198	Metric data is collected at the specified intervals and is retained
14199	internally. The interval and the number of retained samples can be set
14200	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14201	and collection settings are not persistent, they are discarded as soon as
14202	VBoxSVC process terminates. Moreover, metric settings and data associated
14203	with a particular VM only exist while VM is running. They disappear as
14204	soon as VM shuts down. It is not possible to set up metrics for machines
14205	that are powered off. One needs to start VM first, then set up metric
14206	collection parameters.
14207
14208	Metrics are organized hierarchically, with each level separated by a
14209	slash (/) character. Generally, the scheme for metric names is like this:
14210
14211	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14212
14213	"Category/Metric" together form the base metric name. A base metric is
14214	the smallest unit for which a sampling interval and the number of
14215	retained samples can be set. Only base metrics can be enabled and
14216	disabled. All sub-metrics are collected when their base metric is
14217	collected. Collected values for any set of sub-metrics can be queried
14218	with <link to="IPerformanceCollector::queryMetricsData" />.
14219
14220	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14221	category, "Load" metric, "User" submetric, "average" aggregate. An
14222	aggregate function is computed over all retained data. Valid aggregate
14223	functions are:
14224
14225	<ul>
14226	<li>avg -- average</li>
14227	<li>min -- minimum</li>
14228	<li>max -- maximum</li>
14229	</ul>
14230
14231	When setting up metric parameters, querying metric data, enabling or
14232	disabling metrics wildcards can be used in metric names to specify a
14233	subset of metrics. For example, to select all CPU-related metrics
14234	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14235	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14236
14237	The valid names for base metrics are:
14238
14239	<ul>
14240	<li>CPU/Load</li>
14241	<li>CPU/MHz</li>
14242	<li>RAM/Usage</li>
14243	</ul>
14244
14245	The general sequence for collecting and retrieving the metrics is:
14246	<ul>
14247	<li>
14248	Obtain an instance of IPerformanceCollector with
14249	<link to="IVirtualBox::performanceCollector" />
14250	</li>
14251	<li>
14252	Allocate and populate an array with references to objects the metrics
14253	will be collected for. Use references to IHost and IMachine objects.
14254	</li>
14255	<li>
14256	Allocate and populate an array with base metric names the data will
14257	be collected for.
14258	</li>
14259	<li>
14260	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14261	the metric data will be collected and stored.
14262	</li>
14263	<li>
14264	Wait for the data to get collected.
14265	</li>
14266	<li>
14267	Allocate and populate an array with references to objects the metric
14268	values will be queried for. You can re-use the object array used for
14269	setting base metrics.
14270	</li>
14271	<li>
14272	Allocate and populate an array with metric names the data will be
14273	collected for. Note that metric names differ from base metric names.
14274	</li>
14275	<li>
14276	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14277	that have been collected so far are returned. Note that the values
14278	are still retained internally and data collection continues.
14279	</li>
14280	</ul>
14281
14282	For an example of usage refer to the following files in VirtualBox SDK:
14283	<ul>
14284	<li>
14285	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14286	</li>
14287	<li>
14288	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14289	</li>
14290	</ul>
14291	</desc>
14292
14293	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14294	<desc>
14295	Array of unique names of metrics.
14296
14297	This array represents all metrics supported by the performance
14298	collector. Individual objects do not necessarily support all of them.
14299	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14300	list of supported metrics for a particular object.
14301	</desc>
14302	</attribute>
14303
14304	<method name="getMetrics">
14305	<desc>
14306	Returns parameters of specified metrics for a set of objects.
14307	<note>
14308	@c Null metrics array means all metrics. @c Null object array means
14309	all existing objects.
14310	</note>
14311	</desc>
14312	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14313	<desc>
14314	Metric name filter. Currently, only a comma-separated list of metrics
14315	is supported.
14316	</desc>
14317	</param>
14318	<param name="objects" type="$unknown" dir="in" safearray="yes">
14319	<desc>
14320	Set of objects to return metric parameters for.
14321	</desc>
14322	</param>
14323	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14324	<desc>
14325	Array of returned metric parameters.
14326	</desc>
14327	</param>
14328	</method>
14329
14330	<method name="setupMetrics">
14331	<desc>
14332	Sets parameters of specified base metrics for a set of objects. Returns
14333	an array of <link to="IPerformanceMetric" /> describing the metrics
14334	have been affected.
14335	<note>
14336	@c Null or empty metric name array means all metrics. @c Null or
14337	empty object array means all existing objects. If metric name array
14338	contains a single element and object array contains many, the single
14339	metric name array element is applied to each object array element to
14340	form metric/object pairs.
14341	</note>
14342	</desc>
14343	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14344	<desc>
14345	Metric name filter. Comma-separated list of metrics with wildcard
14346	support.
14347	</desc>
14348	</param>
14349	<param name="objects" type="$unknown" dir="in" safearray="yes">
14350	<desc>
14351	Set of objects to setup metric parameters for.
14352	</desc>
14353	</param>
14354	<param name="period" type="unsigned long" dir="in">
14355	<desc>
14356	Time interval in seconds between two consecutive samples of
14357	performance data.
14358	</desc>
14359	</param>
14360	<param name="count" type="unsigned long" dir="in">
14361	<desc>
14362	Number of samples to retain in performance data history. Older
14363	samples get discarded.
14364	</desc>
14365	</param>
14366	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14367	<desc>
14368	Array of metrics that have been modified by the call to this method.
14369	</desc>
14370	</param>
14371	</method>
14372
14373	<method name="enableMetrics">
14374	<desc>
14375	Turns on collecting specified base metrics. Returns an array of
14376	<link to="IPerformanceMetric" /> describing the metrics have been
14377	affected.
14378	<note>
14379	@c Null or empty metric name array means all metrics. @c Null or
14380	empty object array means all existing objects. If metric name array
14381	contains a single element and object array contains many, the single
14382	metric name array element is applied to each object array element to
14383	form metric/object pairs.
14384	</note>
14385	</desc>
14386	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14387	<desc>
14388	Metric name filter. Comma-separated list of metrics with wildcard
14389	support.
14390	</desc>
14391	</param>
14392	<param name="objects" type="$unknown" dir="in" safearray="yes">
14393	<desc>
14394	Set of objects to enable metrics for.
14395	</desc>
14396	</param>
14397	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14398	<desc>
14399	Array of metrics that have been modified by the call to this method.
14400	</desc>
14401	</param>
14402	</method>
14403
14404	<method name="disableMetrics">
14405	<desc>
14406	Turns off collecting specified base metrics. Returns an array of
14407	<link to="IPerformanceMetric" /> describing the metrics have been
14408	affected.
14409	<note>
14410	@c Null or empty metric name array means all metrics. @c Null or
14411	empty object array means all existing objects. If metric name array
14412	contains a single element and object array contains many, the single
14413	metric name array element is applied to each object array element to
14414	form metric/object pairs.
14415	</note>
14416	</desc>
14417	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14418	<desc>
14419	Metric name filter. Comma-separated list of metrics with wildcard
14420	support.
14421	</desc>
14422	</param>
14423	<param name="objects" type="$unknown" dir="in" safearray="yes">
14424	<desc>
14425	Set of objects to disable metrics for.
14426	</desc>
14427	</param>
14428	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14429	<desc>
14430	Array of metrics that have been modified by the call to this method.
14431	</desc>
14432	</param>
14433	</method>
14434
14435	<method name="queryMetricsData">
14436	<desc>
14437	Queries collected metrics data for a set of objects.
14438
14439	The data itself and related metric information are returned in seven
14440	parallel and one flattened array of arrays. Elements of
14441	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14442	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14443	the same index describe one set of values corresponding to a single
14444	metric.
14445
14446	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14447	start and length of a sub-array is indicated by
14448	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14449	value for metric <tt>metricNames[i]</tt> is at
14450	<tt>returnData[returnIndices[i]]</tt>.
14451
14452	<note>
14453	@c Null or empty metric name array means all metrics. @c Null or
14454	empty object array means all existing objects. If metric name array
14455	contains a single element and object array contains many, the single
14456	metric name array element is applied to each object array element to
14457	form metric/object pairs.
14458	</note>
14459	<note>
14460	Data collection continues behind the scenes after call to @c
14461	queryMetricsData. The return data can be seen as the snapshot of the
14462	current state at the time of @c queryMetricsData call. The internally
14463	kept metric values are not cleared by the call. This makes possible
14464	querying different subsets of metrics or aggregates with subsequent
14465	calls. If periodic querying is needed it is highly suggested to query
14466	the values with @c interval*count period to avoid confusion. This way
14467	a completely new set of data values will be provided by each query.
14468	</note>
14469	</desc>
14470	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14471	<desc>
14472	Metric name filter. Comma-separated list of metrics with wildcard
14473	support.
14474	</desc>
14475	</param>
14476	<param name="objects" type="$unknown" dir="in" safearray="yes">
14477	<desc>
14478	Set of objects to query metrics for.
14479	</desc>
14480	</param>
14481	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14482	<desc>
14483	Names of metrics returned in @c returnData.
14484	</desc>
14485	</param>
14486	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14487	<desc>
14488	Objects associated with metrics returned in @c returnData.
14489	</desc>
14490	</param>
14491	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14492	<desc>
14493	Units of measurement for each returned metric.
14494	</desc>
14495	</param>
14496	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14497	<desc>
14498	Divisor that should be applied to return values in order to get
14499	floating point values. For example:
14500	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14501	will retrieve the floating point value of i-th sample of the first
14502	metric.
14503	</desc>
14504	</param>
14505	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14506	<desc>
14507	Sequence numbers of the first elements of value sequences of
14508	particular metrics returned in @c returnData. For aggregate metrics
14509	it is the sequence number of the sample the aggregate started
14510	calculation from.
14511	</desc>
14512	</param>
14513	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14514	<desc>
14515	Indices of the first elements of value sequences of particular
14516	metrics returned in @c returnData.
14517	</desc>
14518	</param>
14519	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14520	<desc>
14521	Lengths of value sequences of particular metrics.
14522	</desc>
14523	</param>
14524	<param name="returnData" type="long" dir="return" safearray="yes">
14525	<desc>
14526	Flattened array of all metric data containing sequences of values for
14527	each metric.
14528	</desc>
14529	</param>
14530	</method>
14531
14532	</interface>
14533
14534	<enum
14535	name="NATAliasMode"
14536	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14537	>
14538	<desc></desc>
14539	<const name="AliasLog" value="0x1">
14540	<desc></desc>
14541	</const>
14542	<const name="AliasProxyOnly" value="0x02">
14543	<desc></desc>
14544	</const>
14545	<const name="AliasUseSamePorts" value="0x04">
14546	<desc></desc>
14547	</const>
14548	</enum>
14549
14550	<enum
14551	name="NATProtocol"
14552	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14553	>
14554	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14555	<const name="UDP" value="0">
14556	<desc>Port-forwarding uses UDP protocol.</desc>
14557	</const>
14558	<const name="TCP" value="1">
14559	<desc>Port-forwarding uses TCP protocol.</desc>
14560	</const>
14561	</enum>
14562
14563	<interface
14564	name="INATEngine" extends="$unknown"
14565	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14566	wsmap="managed"
14567	>
14568	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14569	allows for changing NAT behavior such as port-forwarding rules. This interface is
14570	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14571	<attribute name="network" type="wstring">
14572	<desc>The network attribute of the NAT engine (the same value is used with built-in
14573	DHCP server to fill corresponding fields of DHCP leases).</desc>
14574	</attribute>
14575	<attribute name="hostIP" type="wstring">
14576	<desc>IP of host interface to bind all opened sockets to.
14577	<note>Changing this does not change binding of port forwarding.</note>
14578	</desc>
14579	</attribute>
14580	<attribute name="tftpPrefix" type="wstring">
14581	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14582	the corresponding fields of DHCP leases.</desc>
14583	</attribute>
14584	<attribute name="tftpBootFile" type="wstring">
14585	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14586	the corresponding fields of DHCP leases.</desc>
14587	</attribute>
14588	<attribute name="tftpNextServer" type="wstring">
14589	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14590	the corresponding fields of DHCP leases.
14591	<note>The preferred form is IPv4 addresses.</note>
14592	</desc>
14593	</attribute>
14594	<attribute name="aliasMode" type="unsigned long">
14595	<desc></desc>
14596	</attribute>
14597	<attribute name="dnsPassDomain" type="boolean">
14598	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14599	</attribute>
14600	<attribute name="dnsProxy" type="boolean">
14601	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14602	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14603	</attribute>
14604	<attribute name="dnsUseHostResolver" type="boolean">
14605	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14606	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14607	</attribute>
14608	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14609	<desc>Array of NAT port-forwarding rules in string representation, in the following
14610	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14611	</attribute>
14612	<method name="setNetworkSettings">
14613	<desc>Sets network configuration of the NAT engine.</desc>
14614	<param name="mtu" type="unsigned long" dir="in">
14615	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14616	</param>
14617	<param name="sockSnd" type="unsigned long" dir="in">
14618	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14619	</param>
14620	<param name="sockRcv" type="unsigned long" dir="in">
14621	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14622	</param>
14623	<param name="TcpWndSnd" type="unsigned long" dir="in">
14624	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14625	establishing a new TCP connection.</desc>
14626	</param>
14627	<param name="TcpWndRcv" type="unsigned long" dir="in">
14628	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14629	establishing a new TCP connection.</desc>
14630	</param>
14631	</method>
14632	<method name="getNetworkSettings">
14633	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14634	for parameter descriptions.</desc>
14635	<param name="mtu" type="unsigned long" dir="out" />
14636	<param name="sockSnd" type="unsigned long" dir="out" />
14637	<param name="sockRcv" type="unsigned long" dir="out" />
14638	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14639	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14640	</method>
14641	<method name="addRedirect">
14642	<desc>Adds a new NAT port-forwarding rule.</desc>
14643	<param name="name" type="wstring" dir="in">
14644	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14645	auto-generates one using the other parameters.</desc>
14646	</param>
14647	<param name="proto" type="NATProtocol" dir="in">
14648	<desc>Protocol handled with the rule.</desc>
14649	</param>
14650	<param name="hostIp" type="wstring" dir="in">
14651	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14652	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14653	</param>
14654	<param name="hostPort" type="unsigned short" dir="in">
14655	<desc>The port number to listen on.</desc>
14656	</param>
14657	<param name="guestIp" type="wstring" dir="in">
14658	<desc>The IP address of the guest which the NAT engine will forward matching packets
14659	to. An empty IP address is acceptable, in which case the NAT engine will forward
14660	packets to the first DHCP lease (x.x.x.15).</desc>
14661	</param>
14662	<param name="guestPort" type="unsigned short" dir="in">
14663	<desc>The port number to forward.</desc>
14664	</param>
14665	</method>
14666	<method name="removeRedirect">
14667	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14668	<param name="name" type="wstring" dir="in">
14669	<desc>The name of the rule to delete.</desc>
14670	</param>
14671	</method>
14672	</interface>
14673
14674	<!--
14675	// IExtPackManager
14676	/////////////////////////////////////////////////////////////////////////
14677	-->
14678
14679	<interface
14680	name="IExtPackPlugIn" extends="$unknown"
14681	uuid="58000040-e718-4746-bbce-4b86d96da461"
14682	wsmap="suppress"
14683	>
14684	<desc>
14685	Interface for keeping information about a plug-in that ships with an
14686	extension pack.
14687	</desc>
14688	<attribute name="name" type="wstring" readonly="yes">
14689	<desc>The plug-in name.</desc>
14690	</attribute>
14691	<attribute name="description" type="wstring" readonly="yes">
14692	<desc>The plug-in description.</desc>
14693	</attribute>
14694	<attribute name="frontend" type="wstring" readonly="yes">
14695	<desc>
14696	The name of the frontend or component name this plug-in plugs into.
14697	</desc>
14698	</attribute>
14699	<attribute name="modulePath" type="wstring" readonly="yes">
14700	<desc> The module path. </desc>
14701	</attribute>
14702	</interface>
14703
14704	<interface
14705	name="IExtPackBase" extends="$unknown"
14706	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
14707	wsmap="suppress"
14708	>
14709	<desc>
14710	Interface for querying information about an extension pack as well as
14711	accessing COM objects within it.
14712	</desc>
14713	<attribute name="name" type="wstring" readonly="yes">
14714	<desc>The extension pack name. This is unique.</desc>
14715	</attribute>
14716	<attribute name="description" type="wstring" readonly="yes">
14717	<desc>The extension pack description.</desc>
14718	</attribute>
14719	<attribute name="version" type="wstring" readonly="yes">
14720	<desc>
14721	The extension pack version string. This is on the same form as
14722	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14723	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14724	or "1.2.3_BETA1-r45678-OSE"
14725	</desc>
14726	</attribute>
14727	<attribute name="revision" type="unsigned long" readonly="yes">
14728	<desc>The extension pack internal revision number.</desc>
14729	</attribute>
14730	<attribute name="VRDEModule" type="wstring" readonly="yes">
14731	<desc>The name of the VRDE module if the extension pack sports one.</desc>
14732	</attribute>
14733	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
14734	<desc>Plug-ins provided by this extension pack.</desc>
14735	</attribute>
14736	<attribute name="usable" type="boolean" readonly="yes">
14737	<desc>
14738	Indicates whether the extension pack is usable or not.
14739
14740	There are a number of reasons why an extension pack might be unusable,
14741	typical examples would be broken installation/file or that it is
14742	incompatible with the current VirtualBox version.
14743	</desc>
14744	</attribute>
14745	<attribute name="whyUnusable" type="wstring" readonly="yes">
14746	<desc>
14747	String indicating why the extension pack is not usable. This is an
14748	empty string if usable and always a non-empty string if not usable.
14749	</desc>
14750	</attribute>
14751	<attribute name="showLicense" type="boolean" readonly="yes">
14752	<desc>Whether to show the license before installation</desc>
14753	</attribute>
14754	<attribute name="license" type="wstring" readonly="yes">
14755	<desc>
14756	The default HTML license text for the extension pack. Same as
14757	calling <link to="#queryLicense">queryLicense</link> with
14758	preferredLocale and preferredLanguage as empty strings and format set
14759	to html.
14760	</desc>
14761	</attribute>
14762
14763	<method name="queryLicense">
14764	<desc>
14765	Full feature version of the license attribute.
14766	</desc>
14767	<param name="preferredLocale" type="wstring" dir="in">
14768	<desc>
14769	The preferred license locale. Pass an empty string to get the default
14770	license.
14771	</desc>
14772	</param>
14773	<param name="preferredLanguage" type="wstring" dir="in">
14774	<desc>
14775	The preferred license language. Pass an empty string to get the
14776	default language for the locale.
14777	</desc>
14778	</param>
14779	<param name="format" type="wstring" dir="in">
14780	<desc>
14781	The license format: html, rtf or txt. If a license is present there
14782	will always be an HTML of it, the rich text format (RTF) and plain
14783	text (txt) versions are optional. If
14784	</desc>
14785	</param>
14786	<param name="licenseText" type="wstring" dir="return">
14787	<desc>The license text.</desc>
14788	</param>
14789	</method>
14790
14791	</interface>
14792
14793	<interface
14794	name="IExtPack" extends="IExtPackBase"
14795	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
14796	wsmap="suppress"
14797	>
14798	<desc>
14799	Interface for querying information about an extension pack as well as
14800	accessing COM objects within it.
14801	</desc>
14802	<method name="queryObject">
14803	<desc>
14804	Queries the IUnknown interface to an object in the extension pack
14805	main module. This allows plug-ins and others to talk directly to an
14806	extension pack.
14807	</desc>
14808	<param name="objUuid" type="wstring" dir="in">
14809	<desc>The object ID. What exactly this is </desc>
14810	</param>
14811	<param name="returnInterface" type="$unknown" dir="return">
14812	<desc>The queried interface.</desc>
14813	</param>
14814	</method>
14815	</interface>
14816
14817	<interface
14818	name="IExtPackFile" extends="IExtPackBase"
14819	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
14820	wsmap="suppress"
14821	>
14822	<desc>
14823	Extension pack file (aka tarball, .vbox-extpack) representation returned
14824	by IExtPackManager::openExtPackFile. This provides the base extension
14825	pack information with the addition of the file name. It also provides an
14826	alternative to IExtPackManager::install.
14827	</desc>
14828	<attribute name="filePath" type="wstring" readonly="yes">
14829	<desc>
14830	The path to the extension pack file.
14831	</desc>
14832	</attribute>
14833
14834	<method name="install">
14835	<desc>
14836	Install the extension pack.
14837	</desc>
14838	<param name="replace" type="boolean" dir="in">
14839	<desc>
14840	Set this to automatically uninstall any existing extension pack with
14841	the same name as the one being installed.
14842	</desc>
14843	</param>
14844	<param name="displayInfo" type="wstring" dir="in">
14845	<desc>
14846	Platform specific display information. Reserved for future hacks.
14847	</desc>
14848	</param>
14849	<param name="progess" type="IProgress" dir="return">
14850	<desc>
14851	Progress object for the operation.
14852	</desc>
14853	</param>
14854	</method>
14855	</interface>
14856
14857	<interface
14858	name="IExtPackManager" extends="$unknown"
14859	uuid="2451b1ba-ab1c-42fb-b453-c58433bea8c7"
14860	wsmap="suppress"
14861	>
14862	<desc>
14863	Interface for managing VirtualBox Extension Packs.
14864
14865	TODO: Describe extension packs, how they are managed and how to create
14866	one.
14867	</desc>
14868
14869	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14870	<desc>
14871	List of the installed extension packs.
14872	</desc>
14873	</attribute>
14874
14875	<method name="find">
14876	<desc>
14877	Returns the extension pack with the specified name if found.
14878
14879	<result name="VBOX_E_OBJECT_NOT_FOUND">
14880	No extension pack matching @a name was found.
14881	</result>
14882	</desc>
14883	<param name="name" type="wstring" dir="in">
14884	<desc>The name of the extension pack to locate.</desc>
14885	</param>
14886	<param name="returnData" type="IExtPack" dir="return">
14887	<desc>The extension pack if found.</desc>
14888	</param>
14889	</method>
14890
14891	<method name="openExtPackFile">
14892	<desc>
14893	Attempts to open an extension pack file in preparation for
14894	installation.
14895	</desc>
14896	<param name="path" type="wstring" dir="in">
14897	<desc>The path of the extension pack tarball.</desc>
14898	</param>
14899	<param name="file" type="IExtPackFile" dir="return">
14900	<desc>The interface of the extension pack file object.</desc>
14901	</param>
14902	</method>
14903
14904	<method name="uninstall">
14905	<desc>Uninstalls an extension pack, removing all related files.</desc>
14906	<param name="name" type="wstring" dir="in">
14907	<desc>The name of the extension pack to uninstall.</desc>
14908	</param>
14909	<param name="forcedRemoval" type="boolean" dir="in">
14910	<desc>
14911	Forced removal of the extension pack. This means that the uninstall
14912	hook will not be called.
14913	</desc>
14914	</param>
14915	<param name="displayInfo" type="wstring" dir="in">
14916	<desc>
14917	Platform specific display information. Reserved for future hacks.
14918	</desc>
14919	</param>
14920	<param name="progess" type="IProgress" dir="return">
14921	<desc>
14922	Progress object for the operation.
14923	</desc>
14924	</param>
14925	</method>
14926
14927	<method name="cleanup">
14928	<desc>Cleans up failed installs and uninstalls</desc>
14929	</method>
14930
14931	<method name="QueryAllPlugInsForFrontend">
14932	<desc>
14933	Gets the path to all the plug-in modules for a given frontend.
14934
14935	This is a convenience method that is intended to simplify the plug-in
14936	loading process for a frontend.
14937	</desc>
14938	<param name="frontendName" type="wstring" dir="in">
14939	<desc>The name of the frontend or component.</desc>
14940	</param>
14941	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
14942	<desc>Array containing the plug-in modules (full paths).</desc>
14943	</param>
14944	</method>
14945
14946	<method name="IsExtPackUsable">
14947	<desc>Check if the given extension pack is loaded and usable.</desc>
14948	<param name="name" type="wstring" dir="in">
14949	<desc>The name of the extension pack to check for.</desc>
14950	</param>
14951	<param name="usable" type="boolean" dir="return"/>
14952	</method>
14953
14954	</interface>
14955
14956	<!--
14957	// BandwidthGroupType
14958	/////////////////////////////////////////////////////////////////////////
14959	-->
14960	<enum
14961	name="BandwidthGroupType"
14962	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
14963
14964	<desc>
14965	Type of a bandwidth control group.
14966	</desc>
14967
14968	<const name="Null" value="0">
14969	<desc>
14970	Null type, must be first.
14971	</desc>
14972	</const>
14973
14974	<const name="Disk" value="1">
14975	<desc>
14976	The bandwidth group controls disk I/O.
14977	</desc>
14978	</const>
14979
14980	<const name="Network" value="2">
14981	<desc>
14982	The bandwidth group controls network I/O.
14983	</desc>
14984	</const>
14985
14986	</enum>
14987
14988	<!--
14989	// IBandwidthGroup
14990	/////////////////////////////////////////////////////////////////////////
14991	-->
14992	<interface
14993	name="IBandwidthGroup" extends="$unknown"
14994	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
14995	wsmap="managed"
14996	>
14997	<desc>Represents one bandwidth group.</desc>
14998
14999	<attribute name="name" type="wstring" readonly="yes">
15000	<desc>Name of the group.</desc>
15001	</attribute>
15002
15003	<attribute name="type" type="BandwidthGroupType" readonly="yes">
15004	<desc>Type of the group.</desc>
15005	</attribute>
15006
15007	<attribute name="reference" type="unsigned long" readonly="yes">
15008	<desc>How many devices/medium attachements use this group.</desc>
15009	</attribute>
15010
15011	<attribute name="maxMbPerSec" type="unsigned long">
15012	<desc>The maximum number of MB which can be transfered by all
15013	entities attached to this group during one second.</desc>
15014	</attribute>
15015
15016	</interface>
15017
15018	<!--
15019	// IBandwidthControl
15020	/////////////////////////////////////////////////////////////////////////
15021	-->
15022	<interface
15023	name="IBandwidthControl" extends="$unknown"
15024	uuid="d0a24db0-f756-11df-98cf-0800200c9a66"
15025	wsmap="managed"
15026	>
15027	<desc>
15028	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
15029	This includes network and disk I/O.
15030	</desc>
15031
15032	<attribute name="numGroups" type="unsigned long" readonly="yes">
15033	<desc>
15034	The current number of existing bandwidth groups managed.
15035	</desc>
15036	</attribute>
15037
15038	<method name="CreateBandwidthGroup">
15039	<desc>
15040	Creates a new bandwidth group.
15041	</desc>
15042
15043	<param name="name" type="wstring" dir="in">
15044	<desc>Name of the bandwidth group.</desc>
15045	</param>
15046	<param name="type" type="BandwidthGroupType" dir="in">
15047	<desc>The type of the bandwidth group (network or disk).</desc>
15048	</param>
15049	<param name="maxBytesPerSec" type="unsigned long" dir="in">
15050	<desc>The maximum number of bytes which can be transfered by all
15051	entities attached to this group during one second.</desc>
15052	</param>
15053	</method>
15054
15055	<method name="DeleteBandwidthGroup">
15056	<desc>
15057	Deletes a new bandwidth group.
15058	</desc>
15059
15060	<param name="name" type="wstring" dir="in">
15061	<desc>Name of the bandwidth group to delete.</desc>
15062	</param>
15063	</method>
15064
15065	<method name="GetBandwidthGroup" const="yes">
15066	<desc>
15067	Get a bandwidth group by name.
15068	</desc>
15069
15070	<param name="name" type="wstring" dir="in">
15071	<desc>Name of the bandwidth group to get.</desc>
15072	</param>
15073	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
15074	<desc>Where to store the bandwidth group on success.</desc>
15075	</param>
15076	</method>
15077
15078	<method name="GetAllBandwidthGroups" const="yes">
15079	<desc>
15080	Get all managed bandwidth groups.
15081	</desc>
15082
15083	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
15084	<desc>The array of managed bandwidth groups.</desc>
15085	</param>
15086	</method>
15087	</interface>
15088
15089	<!--
15090	// IVirtualBoxClient
15091	/////////////////////////////////////////////////////////////////////////
15092	-->
15093
15094	<interface
15095	name="IVirtualBoxClient" extends="$unknown"
15096	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
15097	wsmap="suppress"
15098	>
15099	<desc>
15100	Convenience interface for client applications. Treat this as a
15101	singleton, i.e. never create more than one instance of this interface.
15102
15103	At the moment only available for clients of the local API (not usable
15104	via the webservice). Once the session logic is redesigned this might
15105	change.
15106	</desc>
15107
15108	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
15109	<desc>
15110	Reference to the server-side API root object.
15111	</desc>
15112	</attribute>
15113
15114	<attribute name="session" type="ISession" readonly="yes">
15115	<desc>
15116	Create a new session object and return the reference to it.
15117	</desc>
15118	</attribute>
15119
15120	<attribute name="eventSource" type="IEventSource" readonly="yes">
15121	<desc>
15122	Event source for VirtualBoxClient events.
15123	</desc>
15124	</attribute>
15125
15126	</interface>
15127
15128	<!--
15129	// Events
15130	/////////////////////////////////////////////////////////////////////////
15131	-->
15132	<enum
15133	name="VBoxEventType"
15134	uuid="e71c487f-755e-46e9-a476-dd6a5d134597"
15135	>
15136
15137	<desc>
15138	Type of an event.
15139	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15140	</desc>
15141
15142	<const name="Invalid" value="0">
15143	<desc>
15144	Invalid event, must be first.
15145	</desc>
15146	</const>
15147
15148	<const name="Any" value="1">
15149	<desc>
15150	Wildcard for all events.
15151	Events of this type are never delivered, and only used in
15152	registerListener() call to simplify registration.
15153	</desc>
15154	</const>
15155
15156	<const name="Vetoable" value="2">
15157	<desc>
15158	Wildcard for all vetoable events. Events of this type are never delivered, and only
15159	used in registerListener() call to simplify registration.
15160	</desc>
15161	</const>
15162
15163	<const name="MachineEvent" value="3">
15164	<desc>
15165	Wildcard for all machine events. Events of this type are never delivered, and only used in
15166	registerListener() call to simplify registration.
15167	</desc>
15168	</const>
15169
15170	<const name="SnapshotEvent" value="4">
15171	<desc>
15172	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
15173	registerListener() call to simplify registration.
15174	</desc>
15175	</const>
15176
15177	<const name="InputEvent" value="5">
15178	<desc>
15179	Wildcard for all input device (keyboard, mouse) events.
15180	Events of this type are never delivered, and only used in
15181	registerListener() call to simplify registration.
15182	</desc>
15183	</const>
15184
15185	<const name="LastWildcard" value="31">
15186	<desc>
15187	Last wildcard.
15188	</desc>
15189	</const>
15190
15191	<const name="OnMachineStateChanged" value="32">
15192	<desc>
15193	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
15194	</desc>
15195	</const>
15196	<const name="OnMachineDataChanged" value="33">
15197	<desc>
15198	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
15199	</desc>
15200	</const>
15201	<const name="OnExtraDataChanged" value="34">
15202	<desc>
15203	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
15204	</desc>
15205	</const>
15206	<const name="OnExtraDataCanChange" value="35">
15207	<desc>
15208	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
15209	</desc>
15210	</const>
15211	<const name="OnMediumRegistered" value="36">
15212	<desc>
15213	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
15214	</desc>
15215	</const>
15216	<const name="OnMachineRegistered" value="37">
15217	<desc>
15218	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
15219	</desc>
15220	</const>
15221	<const name="OnSessionStateChanged" value="38">
15222	<desc>
15223	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
15224	</desc>
15225	</const>
15226	<const name="OnSnapshotTaken" value="39">
15227	<desc>
15228	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
15229	</desc>
15230	</const>
15231	<const name="OnSnapshotDeleted" value="40">
15232	<desc>
15233	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
15234	</desc>
15235	</const>
15236	<const name="OnSnapshotChanged" value="41">
15237	<desc>
15238	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
15239	</desc>
15240	</const>
15241	<const name="OnGuestPropertyChanged" value="42">
15242	<desc>
15243	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
15244	</desc>
15245	</const>
15246	<!-- Console events -->
15247	<const name="OnMousePointerShapeChanged" value="43">
15248	<desc>
15249	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
15250	</desc>
15251	</const>
15252	<const name="OnMouseCapabilityChanged" value="44">
15253	<desc>
15254	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
15255	</desc>
15256	</const>
15257	<const name="OnKeyboardLedsChanged" value="45">
15258	<desc>
15259	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
15260	</desc>
15261	</const>
15262	<const name="OnStateChanged" value="46">
15263	<desc>
15264	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
15265	</desc>
15266	</const>
15267	<const name="OnAdditionsStateChanged" value="47">
15268	<desc>
15269	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
15270	</desc>
15271	</const>
15272	<const name="OnNetworkAdapterChanged" value="48">
15273	<desc>
15274	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
15275	</desc>
15276	</const>
15277	<const name="OnSerialPortChanged" value="49">
15278	<desc>
15279	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
15280	</desc>
15281	</const>
15282	<const name="OnParallelPortChanged" value="50">
15283	<desc>
15284	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
15285	</desc>
15286	</const>
15287	<const name="OnStorageControllerChanged" value="51">
15288	<desc>
15289	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
15290	</desc>
15291	</const>
15292	<const name="OnMediumChanged" value="52">
15293	<desc>
15294	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
15295	</desc>
15296	</const>
15297	<const name="OnVRDEServerChanged" value="53">
15298	<desc>
15299	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
15300	</desc>
15301	</const>
15302	<const name="OnUSBControllerChanged" value="54">
15303	<desc>
15304	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
15305	</desc>
15306	</const>
15307	<const name="OnUSBDeviceStateChanged" value="55">
15308	<desc>
15309	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
15310	</desc>
15311	</const>
15312	<const name="OnSharedFolderChanged" value="56">
15313	<desc>
15314	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
15315	</desc>
15316	</const>
15317	<const name="OnRuntimeError" value="57">
15318	<desc>
15319	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
15320	</desc>
15321	</const>
15322	<const name="OnCanShowWindow" value="58">
15323	<desc>
15324	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
15325	</desc>
15326	</const>
15327	<const name="OnShowWindow" value="59">
15328	<desc>
15329	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
15330	</desc>
15331	</const>
15332	<const name="OnCPUChanged" value="60">
15333	<desc>
15334	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
15335	</desc>
15336	</const>
15337	<const name="OnVRDEServerInfoChanged" value="61">
15338	<desc>
15339	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
15340	</desc>
15341	</const>
15342	<const name="OnEventSourceChanged" value="62">
15343	<desc>
15344	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
15345	</desc>
15346	</const>
15347	<const name="OnCPUExecutionCapChanged" value="63">
15348	<desc>
15349	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
15350	</desc>
15351	</const>
15352	<const name="OnGuestKeyboard" value="64">
15353	<desc>
15354	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
15355	</desc>
15356	</const>
15357	<const name="OnGuestMouse" value="65">
15358	<desc>
15359	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
15360	</desc>
15361	</const>
15362	<const name="OnNATRedirect" value="66">
15363	<desc>
15364	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
15365	</desc>
15366	</const>
15367	<const name="OnHostPciDevicePlug" value="67">
15368	<desc>
15369	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
15370	</desc>
15371	</const>
15372	<const name="OnVBoxSVCAvailabilityChanged" value="68">
15373	<desc>
15374	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
15375	</desc>
15376	</const>
15377	<const name="OnBandwidthGroupChanged" value="69">
15378	<desc>
15379	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
15380	</desc>
15381	</const>
15382	<const name="OnGuestMonitorChanged" value="70">
15383	<desc>
15384	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
15385	</desc>
15386	</const>
15387
15388	<!-- Last event marker -->
15389	<const name="Last" value="71">
15390	<desc>
15391	Must be last event, used for iterations and structures relying on numerical event values.
15392	</desc>
15393	</const>
15394
15395	</enum>
15396
15397	<interface
15398	name="IEventSource" extends="$unknown"
15399	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
15400	wsmap="managed"
15401	>
15402	<desc>
15403	Event source. Generally, any object which could generate events can be an event source,
15404	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
15405	an event source can work with listeners in either active or passive mode. In active mode it is up to
15406	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
15407	event source keeps track of pending events for each listener and returns available events on demand.
15408
15409	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15410	</desc>
15411
15412	<method name="createListener">
15413	<desc>
15414	Creates a new listener object, useful for passive mode.
15415	</desc>
15416	<param name="listener" type="IEventListener" dir="return"/>
15417	</method>
15418
15419	<method name="createAggregator">
15420	<desc>
15421	Creates an aggregator event source, collecting events from multiple sources.
15422	This way a single listener can listen for events coming from multiple sources,
15423	using a single blocking getEvent() on the returned aggregator.
15424	</desc>
15425	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
15426	<desc>
15427	Subordinate event source this one aggregatres.
15428	</desc>
15429	</param>
15430	<param name="result" type="IEventSource" dir="return"/>
15431	</method>
15432
15433	<method name="registerListener">
15434	<desc>
15435	Register an event listener.
15436
15437	<note>
15438	To avoid system overload, the VirtualBox server process checks if passive event
15439	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
15440	current implementation, if more than 500 pending events are detected for a passive
15441	event listener, it is forcefully unregistered by the system, and further
15442	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
15443	</note>
15444	</desc>
15445	<param name="listener" type="IEventListener" dir="in">
15446	<desc>Listener to register.</desc>
15447	</param>
15448	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
15449	<desc>
15450	Event types listener is interested in. One can use wildcards like -
15451	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
15452	than one event.
15453	</desc>
15454	</param>
15455	<param name="active" type="boolean" dir="in">
15456	<desc>
15457	Which mode this listener is operating in.
15458	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
15459	In passive mode, an internal event queue is created for this this IEventListener.
15460	For each event coming in, it is added to queues for all interested registered passive
15461	listeners. It is then up to the external code to call the listener's
15462	<link to="IEventListener::handleEvent" /> method. When done with an event, the
15463	external code must call <link to="#eventProcessed" />.
15464	</desc>
15465	</param>
15466	</method>
15467
15468	<method name="unregisterListener">
15469	<desc>
15470	Unregister an event listener. If listener is passive, and some waitable events are still
15471	in queue they are marked as processed automatically.
15472	</desc>
15473	<param name="listener" type="IEventListener" dir="in">
15474	<desc>Listener to unregister.</desc>
15475	</param>
15476	</method>
15477
15478	<method name="fireEvent">
15479	<desc>
15480	Fire an event for this source.
15481	</desc>
15482	<param name="event" type="IEvent" dir="in">
15483	<desc>Event to deliver.</desc>
15484	</param>
15485	<param name="timeout" type="long" dir="in">
15486	<desc>
15487	Maximum time to wait for event processing (if event is waitable), in ms;
15488	0 = no wait, -1 = indefinite wait.
15489	</desc>
15490	</param>
15491	<param name="result" type="boolean" dir="return">
15492	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
15493	</param>
15494	</method>
15495
15496	<method name="getEvent">
15497	<desc>
15498	Get events from this peer's event queue (for passive mode). Calling this method
15499	regularly is required for passive event listeners to avoid system overload;
15500	see <link to="IEventSource::registerListener" /> for details.
15501
15502	<result name="VBOX_E_OBJECT_NOT_FOUND">
15503	Listener is not registered, or autounregistered.
15504	</result>
15505	</desc>
15506	<param name="listener" type="IEventListener" dir="in">
15507	<desc>Which listener to get data for.</desc>
15508	</param>
15509	<param name="timeout" type="long" dir="in">
15510	<desc>
15511	Maximum time to wait for events, in ms;
15512	0 = no wait, -1 = indefinite wait.
15513	</desc>
15514	</param>
15515	<param name="event" type="IEvent" dir="return">
15516	<desc>Event retrieved, or null if none available.</desc>
15517	</param>
15518	</method>
15519
15520	<method name="eventProcessed">
15521	<desc>
15522	Must be called for waitable events after a particular listener finished its
15523	event processing. When all listeners of a particular event have called this
15524	method, the system will then call <link to="IEvent::setProcessed" />.
15525	</desc>
15526	<param name="listener" type="IEventListener" dir="in">
15527	<desc>Which listener processed event.</desc>
15528	</param>
15529	<param name="event" type="IEvent" dir="in">
15530	<desc>Which event.</desc>
15531	</param>
15532	</method>
15533
15534	</interface>
15535
15536	<interface
15537	name="IEventListener" extends="$unknown"
15538	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
15539	wsmap="managed"
15540	>
15541	<desc>
15542	Event listener. An event listener can work in either active or passive mode, depending on the way
15543	it was registered.
15544	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15545	</desc>
15546
15547	<method name="handleEvent">
15548	<desc>
15549	Handle event callback for active listeners. It is not called for passive listeners. After
15550	calling handleEvent() on all active listeners and having received acknowledgement from all
15551	passive listeners via IEventSource::eventProcessed(), the event is marked as processed and
15552	IEvent::waitProcessed() will return immediately.
15553	</desc>
15554	<param name="event" type="IEvent" dir="in">
15555	<desc>Event available.</desc>
15556	</param>
15557	</method>
15558
15559	</interface>
15560
15561	<interface
15562	name="IEvent" extends="$unknown"
15563	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
15564	wsmap="managed"
15565	>
15566	<desc>
15567	Abstract parent interface for VirtualBox events. Actual events will typically implement
15568	a more specific interface which derives from this (see below).
15569
15570	<b>Introduction to VirtualBox events</b>
15571
15572	Generally speaking, an event (represented by this interface) signals that something
15573	happened, while an event listener (see <link to="IEventListener" />) represents an
15574	entity that is interested in certain events. In order for this to work with
15575	unidirectional protocols (i.e. web services), the concepts of passive and active
15576	listener are used.
15577
15578	Event consumers can register themselves as listeners, providing an array of
15579	events they are interested in (see <link to="IEventSource::registerListener" />).
15580	When an event triggers, the listener is notified about the event. The exact
15581	mechanism of the notification depends on whether the listener was registered as
15582	an active or passive listener:
15583
15584	<ul>
15585	<li>An active listener is very similar to a callback: it is a function invoked
15586	by the API. As opposed to the callbacks that were used in the API before
15587	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
15588	</li>
15589
15590	<li>Passive listeners are somewhat trickier to implement, but do not require
15591	a client function to be callable, which is not an option with scripting
15592	languages or web service clients. Internally the <link to="IEventSource" />
15593	implementation maintains an event queue for each passive listener, and
15594	newly arrived events are put in this queue. When the listener calls
15595	<link to="IEventSource::getEvent"/>, first element from its internal event
15596	queue is returned. When the client completes processing of an event,
15597	the <link to="IEventSource::eventProcessed" /> function must be called,
15598	acknowledging that the event was processed. It supports implementing
15599	waitable events. On passive listener unregistration, all events from its
15600	queue are auto-acknowledged.
15601	</li>
15602	</ul>
15603
15604	Waitable events are useful in situations where the event generator wants to track
15605	delivery or a party wants to wait until all listeners have completed the event. A
15606	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
15607	listeners might veto a certain action, and thus the event producer has to make
15608	sure that all listeners have processed the event and not vetoed before taking
15609	the action.
15610
15611	A given event may have both passive and active listeners at the same time.
15612
15613	<b>Using events</b>
15614
15615	Any VirtualBox object capable of producing externally visible events provides an
15616	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
15617	This event source object is notified by VirtualBox once something has happened, so
15618	consumers may register event listeners with this event source. To register a listener,
15619	an object implementing the <link to="IEventListener" /> interface must be provided.
15620	For active listeners, such an object is typically created by the consumer, while for
15621	passive listeners <link to="IEventSource::createListener" /> should be used. Please
15622	note that a listener created with @c createListener() must not be used as an active listener.
15623
15624	Once created, the listener must be registered to listen for the desired events
15625	(see <link to="IEventSource::registerListener" />), providing an array of
15626	<link to="VBoxEventType" /> enums. Those elements can either be the individual
15627	event IDs or wildcards matching multiple event IDs.
15628
15629	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
15630	called automatically when the event is triggered, while passive listeners have to call
15631	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
15632	an event processing loop.
15633
15634	The IEvent interface is an abstract parent interface for all such VirtualBox events
15635	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
15636	or the event processing loop is to check the <link to="#type" /> attribute of the event and
15637	then cast to the appropriate specific interface using @c QueryInterface().
15638	</desc>
15639
15640	<attribute name="type" readonly="yes" type="VBoxEventType">
15641	<desc>
15642	Event type.
15643	</desc>
15644	</attribute>
15645
15646	<attribute name="source" readonly="yes" type="IEventSource">
15647	<desc>
15648	Source of this event.
15649	</desc>
15650	</attribute>
15651
15652	<attribute name="waitable" readonly="yes" type="boolean">
15653	<desc>
15654	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
15655	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
15656	as no additional overhead associated with waitability imposed.
15657	Waitable events are needed when one need to be able to wait for particular event processed,
15658	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
15659	until all consumers confirmed events.
15660	</desc>
15661	</attribute>
15662
15663	<method name="setProcessed">
15664	<desc>
15665	Internal method called by the system when all listeners of a particular event have called
15666	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
15667	</desc>
15668	</method>
15669
15670	<method name="waitProcessed">
15671	<desc>
15672	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
15673	described semantics, for non-waitable returns true immediately.
15674	</desc>
15675	<param name="timeout" type="long" dir="in">
15676	<desc>
15677	Maximum time to wait for event processeing, in ms;
15678	0 = no wait, -1 = indefinite wait.
15679	</desc>
15680	</param>
15681	<param name="result" type="boolean" dir="return">
15682	<desc>If this event was processed before timeout.</desc>
15683	</param>
15684	</method>
15685	</interface>
15686
15687
15688	<interface
15689	name="IReusableEvent" extends="IEvent"
15690	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
15691	wsmap="managed"
15692	>
15693	<desc>Base abstract interface for all reusable events.</desc>
15694
15695	<attribute name="generation" readonly="yes" type="unsigned long">
15696	<desc>Current generation of event, incremented on reuse.</desc>
15697	</attribute>
15698
15699	<method name="reuse">
15700	<desc>
15701	Marks an event as reused, increments 'generation', fields shall no
15702	longer be considered valid.
15703	</desc>
15704	</method>
15705	</interface>
15706
15707	<interface
15708	name="IMachineEvent" extends="IEvent"
15709	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
15710	wsmap="managed" id="MachineEvent"
15711	>
15712	<desc>Base abstract interface for all machine events.</desc>
15713
15714	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
15715	<desc>ID of the machine this event relates to.</desc>
15716	</attribute>
15717
15718	</interface>
15719
15720	<interface
15721	name="IMachineStateChangedEvent" extends="IMachineEvent"
15722	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
15723	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
15724	>
15725	<desc>Machine state change event.</desc>
15726
15727	<attribute name="state" readonly="yes" type="MachineState">
15728	<desc>New execution state.</desc>
15729	</attribute>
15730	</interface>
15731
15732	<interface
15733	name="IMachineDataChangedEvent" extends="IMachineEvent"
15734	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
15735	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
15736	>
15737	<desc>
15738	Any of the settings of the given machine has changed.
15739	</desc>
15740	</interface>
15741
15742	<interface
15743	name="IMediumRegisteredEvent" extends="IEvent"
15744	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
15745	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
15746	>
15747	<desc>
15748	The given medium was registered or unregistered
15749	within this VirtualBox installation.
15750	</desc>
15751
15752	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
15753	<desc>ID of the medium this event relates to.</desc>
15754	</attribute>
15755
15756	<attribute name="mediumType" readonly="yes" type="DeviceType">
15757	<desc>Type of the medium this event relates to.</desc>
15758	</attribute>
15759
15760	<attribute name="registered" type="boolean" readonly="yes">
15761	<desc>
15762	If @c true, the medium was registered, otherwise it was
15763	unregistered.
15764	</desc>
15765	</attribute>
15766	</interface>
15767
15768	<interface
15769	name="IMachineRegisteredEvent" extends="IMachineEvent"
15770	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
15771	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
15772	>
15773	<desc>
15774	The given machine was registered or unregistered
15775	within this VirtualBox installation.
15776	</desc>
15777
15778	<attribute name="registered" type="boolean" readonly="yes">
15779	<desc>
15780	If @c true, the machine was registered, otherwise it was
15781	unregistered.
15782	</desc>
15783	</attribute>
15784	</interface>
15785
15786	<interface
15787	name="ISessionStateChangedEvent" extends="IMachineEvent"
15788	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
15789	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
15790	>
15791	<desc>
15792	The state of the session for the given machine was changed.
15793	<see>IMachine::sessionState</see>
15794	</desc>
15795
15796	<attribute name="state" type="SessionState" readonly="yes">
15797	<desc>
15798	New session state.
15799	</desc>
15800	</attribute>
15801	</interface>
15802
15803	<interface
15804	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
15805	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
15806	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
15807	>
15808	<desc>
15809	Notification when a guest property has changed.
15810	</desc>
15811
15812	<attribute name="name" readonly="yes" type="wstring">
15813	<desc>
15814	The name of the property that has changed.
15815	</desc>
15816	</attribute>
15817
15818	<attribute name="value" readonly="yes" type="wstring">
15819	<desc>
15820	The new property value.
15821	</desc>
15822	</attribute>
15823
15824	<attribute name="flags" readonly="yes" type="wstring">
15825	<desc>
15826	The new property flags.
15827	</desc>
15828	</attribute>
15829
15830	</interface>
15831
15832	<interface
15833	name="ISnapshotEvent" extends="IMachineEvent"
15834	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
15835	wsmap="managed" id="SnapshotEvent"
15836	>
15837	<desc>Base interface for all snapshot events.</desc>
15838
15839	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
15840	<desc>ID of the snapshot this event relates to.</desc>
15841	</attribute>
15842
15843	</interface>
15844
15845	<interface
15846	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
15847	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
15848	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
15849	>
15850	<desc>
15851	A new snapshot of the machine has been taken.
15852	<see>ISnapshot</see>
15853	</desc>
15854	</interface>
15855
15856	<interface
15857	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
15858	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
15859	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
15860	>
15861	<desc>
15862	Snapshot of the given machine has been deleted.
15863
15864	<note>
15865	This notification is delivered <b>after</b> the snapshot
15866	object has been uninitialized on the server (so that any
15867	attempt to call its methods will return an error).
15868	</note>
15869
15870	<see>ISnapshot</see>
15871	</desc>
15872	</interface>
15873
15874	<interface
15875	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
15876	uuid="07541941-8079-447a-a33e-47a69c7980db"
15877	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
15878	>
15879	<desc>
15880	Snapshot properties (name and/or description) have been changed.
15881	<see>ISnapshot</see>
15882	</desc>
15883	</interface>
15884
15885	<interface
15886	name="IMousePointerShapeChangedEvent" extends="IEvent"
15887	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
15888	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
15889	>
15890	<desc>
15891	Notification when the guest mouse pointer shape has
15892	changed. The new shape data is given.
15893	</desc>
15894
15895	<attribute name="visible" type="boolean" readonly="yes">
15896	<desc>
15897	Flag whether the pointer is visible.
15898	</desc>
15899	</attribute>
15900	<attribute name="alpha" type="boolean" readonly="yes">
15901	<desc>
15902	Flag whether the pointer has an alpha channel.
15903	</desc>
15904	</attribute>
15905	<attribute name="xhot" type="unsigned long" readonly="yes">
15906	<desc>
15907	The pointer hot spot X coordinate.
15908	</desc>
15909	</attribute>
15910	<attribute name="yhot" type="unsigned long" readonly="yes">
15911	<desc>
15912	The pointer hot spot Y coordinate.
15913	</desc>
15914	</attribute>
15915	<attribute name="width" type="unsigned long" readonly="yes">
15916	<desc>
15917	Width of the pointer shape in pixels.
15918	</desc>
15919	</attribute>
15920	<attribute name="height" type="unsigned long" readonly="yes">
15921	<desc>
15922	Height of the pointer shape in pixels.
15923	</desc>
15924	</attribute>
15925	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
15926	<desc>
15927	Shape buffer arrays.
15928
15929	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
15930	followed by a 32-bpp XOR (color) mask.
15931
15932	For pointers without alpha channel the XOR mask pixels are 32
15933	bit values: (lsb)BGR0(msb). For pointers with alpha channel
15934	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
15935
15936	An AND mask is used for pointers with alpha channel, so if the
15937	callback does not support alpha, the pointer could be
15938	displayed as a normal color pointer.
15939
15940	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
15941	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
15942	height</tt>. The padding bits at the end of each scanline are
15943	undefined.
15944
15945	The XOR mask follows the AND mask on the next 4-byte aligned
15946	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
15947	Bytes in the gap between the AND and the XOR mask are undefined.
15948	The XOR mask scanlines have no gap between them and the size of
15949	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
15950
15951	<note>
15952	If @a shape is 0, only the pointer visibility is changed.
15953	</note>
15954	</desc>
15955	</attribute>
15956	</interface>
15957
15958	<interface
15959	name="IMouseCapabilityChangedEvent" extends="IEvent"
15960	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
15961	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
15962	>
15963	<desc>
15964	Notification when the mouse capabilities reported by the
15965	guest have changed. The new capabilities are passed.
15966	</desc>
15967	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
15968	<desc>
15969	Supports absolute coordinates.
15970	</desc>
15971	</attribute>
15972	<attribute name="supportsRelative" type="boolean" readonly="yes">
15973	<desc>
15974	Supports relative coordinates.
15975	</desc>
15976	</attribute>
15977	<attribute name="needsHostCursor" type="boolean" readonly="yes">
15978	<desc>
15979	If host cursor is needed.
15980	</desc>
15981	</attribute>
15982	</interface>
15983
15984	<interface
15985	name="IKeyboardLedsChangedEvent" extends="IEvent"
15986	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
15987	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
15988	>
15989	<desc>
15990	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
15991	to alter the state of the keyboard LEDs.
15992	</desc>
15993	<attribute name="numLock" type="boolean" readonly="yes">
15994	<desc>
15995	NumLock status.
15996	</desc>
15997	</attribute>
15998	<attribute name="capsLock" type="boolean" readonly="yes">
15999	<desc>
16000	CapsLock status.
16001	</desc>
16002	</attribute>
16003	<attribute name="scrollLock" type="boolean" readonly="yes">
16004	<desc>
16005	ScrollLock status.
16006	</desc>
16007	</attribute>
16008	</interface>
16009
16010	<interface
16011	name="IStateChangedEvent" extends="IEvent"
16012	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
16013	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
16014	>
16015	<desc>
16016	Notification when the execution state of the machine has changed.
16017	The new state is given.
16018	</desc>
16019	<attribute name="state" type="MachineState" readonly="yes">
16020	<desc>
16021	New machine state.
16022	</desc>
16023	</attribute>
16024	</interface>
16025
16026	<interface
16027	name="IAdditionsStateChangedEvent" extends="IEvent"
16028	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
16029	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
16030	>
16031	<desc>
16032	Notification when a Guest Additions property changes.
16033	Interested callees should query IGuest attributes to
16034	find out what has changed.
16035	</desc>
16036	</interface>
16037
16038	<interface
16039	name="INetworkAdapterChangedEvent" extends="IEvent"
16040	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
16041	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
16042	>
16043	<desc>
16044	Notification when a property of one of the
16045	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
16046	changes. Interested callees should use INetworkAdapter methods and
16047	attributes to find out what has changed.
16048	</desc>
16049	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
16050	<desc>
16051	Network adapter that is subject to change.
16052	</desc>
16053	</attribute>
16054	</interface>
16055
16056	<interface
16057	name="ISerialPortChangedEvent" extends="IEvent"
16058	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
16059	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
16060	>
16061	<desc>
16062	Notification when a property of one of the
16063	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
16064	Interested callees should use ISerialPort methods and attributes
16065	to find out what has changed.
16066	</desc>
16067	<attribute name="serialPort" type="ISerialPort" readonly="yes">
16068	<desc>
16069	Serial port that is subject to change.
16070	</desc>
16071	</attribute>
16072	</interface>
16073
16074	<interface
16075	name="IParallelPortChangedEvent" extends="IEvent"
16076	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
16077	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
16078	>
16079	<desc>
16080	Notification when a property of one of the
16081	virtual <link to="IMachine::getParallelPort">parallel ports</link>
16082	changes. Interested callees should use ISerialPort methods and
16083	attributes to find out what has changed.
16084	</desc>
16085	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
16086	<desc>
16087	Parallel port that is subject to change.
16088	</desc>
16089	</attribute>
16090	</interface>
16091
16092	<interface
16093	name="IStorageControllerChangedEvent" extends="IEvent"
16094	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
16095	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
16096	>
16097	<desc>
16098	Notification when a
16099	<link to="IMachine::mediumAttachments">medium attachment</link>
16100	changes.
16101	</desc>
16102	</interface>
16103
16104	<interface
16105	name="IMediumChangedEvent" extends="IEvent"
16106	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
16107	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
16108	>
16109	<desc>
16110	Notification when a
16111	<link to="IMachine::mediumAttachments">medium attachment</link>
16112	changes.
16113	</desc>
16114	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
16115	<desc>
16116	Medium attachment that is subject to change.
16117	</desc>
16118	</attribute>
16119	</interface>
16120
16121	<interface
16122	name="ICPUChangedEvent" extends="IEvent"
16123	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
16124	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
16125	>
16126	<desc>
16127	Notification when a CPU changes.
16128	</desc>
16129	<attribute name="cpu" type="unsigned long" readonly="yes">
16130	<desc>
16131	The CPU which changed.
16132	</desc>
16133	</attribute>
16134	<attribute name="add" type="boolean" readonly="yes">
16135	<desc>
16136	Flag whether the CPU was added or removed.
16137	</desc>
16138	</attribute>
16139	</interface>
16140
16141	<interface
16142	name="ICPUExecutionCapChangedEvent" extends="IEvent"
16143	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
16144	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
16145	>
16146	<desc>
16147	Notification when the CPU execution cap changes.
16148	</desc>
16149	<attribute name="executionCap" type="unsigned long" readonly="yes">
16150	<desc>
16151	The new CPU execution cap value. (1-100)
16152	</desc>
16153	</attribute>
16154	</interface>
16155
16156	<interface
16157	name="IGuestKeyboardEvent" extends="IEvent"
16158	uuid="88394258-7006-40d4-b339-472ee3801844"
16159	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
16160	>
16161	<desc>
16162	Notification when guest keyboard event happens.
16163	</desc>
16164	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
16165	<desc>
16166	Array of scancodes.
16167	</desc>
16168	</attribute>
16169	</interface>
16170
16171	<interface
16172	name="IGuestMouseEvent" extends="IReusableEvent"
16173	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
16174	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
16175	>
16176	<desc>
16177	Notification when guest mouse event happens.
16178	</desc>
16179
16180	<attribute name="absolute" type="boolean" readonly="yes">
16181	<desc>
16182	If this event is relative or absolute.
16183	</desc>
16184	</attribute>
16185
16186	<attribute name="x" type="long" readonly="yes">
16187	<desc>
16188	New X position, or X delta.
16189	</desc>
16190	</attribute>
16191
16192	<attribute name="y" type="long" readonly="yes">
16193	<desc>
16194	New Y position, or Y delta.
16195	</desc>
16196	</attribute>
16197
16198	<attribute name="z" type="long" readonly="yes">
16199	<desc>
16200	Z delta.
16201	</desc>
16202	</attribute>
16203
16204	<attribute name="w" type="long" readonly="yes">
16205	<desc>
16206	W delta.
16207	</desc>
16208	</attribute>
16209
16210	<attribute name="buttons" type="long" readonly="yes">
16211	<desc>
16212	Button state bitmask.
16213	</desc>
16214	</attribute>
16215
16216	</interface>
16217
16218
16219	<interface
16220	name="IVRDEServerChangedEvent" extends="IEvent"
16221	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
16222	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
16223	>
16224	<desc>
16225	Notification when a property of the
16226	<link to="IMachine::VRDEServer">VRDE server</link> changes.
16227	Interested callees should use IVRDEServer methods and attributes to
16228	find out what has changed.
16229	</desc>
16230	</interface>
16231
16232	<interface
16233	name="IVRDEServerInfoChangedEvent" extends="IEvent"
16234	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
16235	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
16236	>
16237	<desc>
16238	Notification when the status of the VRDE server changes. Interested callees
16239	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
16240	attributes to find out what is the current status.
16241	</desc>
16242	</interface>
16243
16244	<interface
16245	name="IUSBControllerChangedEvent" extends="IEvent"
16246	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
16247	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
16248	>
16249	<desc>
16250	Notification when a property of the virtual
16251	<link to="IMachine::USBController">USB controller</link> changes.
16252	Interested callees should use IUSBController methods and attributes to
16253	find out what has changed.
16254	</desc>
16255	</interface>
16256
16257	<interface
16258	name="IUSBDeviceStateChangedEvent" extends="IEvent"
16259	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
16260	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
16261	>
16262	<desc>
16263	Notification when a USB device is attached to or detached from
16264	the virtual USB controller.
16265
16266	This notification is sent as a result of the indirect
16267	request to attach the device because it matches one of the
16268	machine USB filters, or as a result of the direct request
16269	issued by <link to="IConsole::attachUSBDevice"/> or
16270	<link to="IConsole::detachUSBDevice"/>.
16271
16272	This notification is sent in case of both a succeeded and a
16273	failed request completion. When the request succeeds, the
16274	@a error parameter is @c null, and the given device has been
16275	already added to (when @a attached is @c true) or removed from
16276	(when @a attached is @c false) the collection represented by
16277	<link to="IConsole::USBDevices"/>. On failure, the collection
16278	doesn't change and the @a error parameter represents the error
16279	message describing the failure.
16280	</desc>
16281	<attribute name="device" type="IUSBDevice" readonly="yes">
16282	<desc>
16283	Device that is subject to state change.
16284	</desc>
16285	</attribute>
16286	<attribute name="attached" type="boolean" readonly="yes">
16287	<desc>
16288	@c true if the device was attached and @c false otherwise.
16289	</desc>
16290	</attribute>
16291	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
16292	<desc>
16293	@c null on success or an error message object on failure.
16294	</desc>
16295	</attribute>
16296	</interface>
16297
16298	<interface
16299	name="ISharedFolderChangedEvent" extends="IEvent"
16300	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
16301	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
16302	>
16303	<desc>
16304	Notification when a shared folder is added or removed.
16305	The @a scope argument defines one of three scopes:
16306	<link to="IVirtualBox::sharedFolders">global shared folders</link>
16307	(<link to="Scope_Global">Global</link>),
16308	<link to="IMachine::sharedFolders">permanent shared folders</link> of
16309	the machine (<link to="Scope_Machine">Machine</link>) or <link
16310	to="IConsole::sharedFolders">transient shared folders</link> of the
16311	machine (<link to="Scope_Session">Session</link>). Interested callees
16312	should use query the corresponding collections to find out what has
16313	changed.
16314	</desc>
16315	<attribute name="scope" type="Scope" readonly="yes">
16316	<desc>
16317	Scope of the notification.
16318	</desc>
16319	</attribute>
16320	</interface>
16321
16322	<interface
16323	name="IRuntimeErrorEvent" extends="IEvent"
16324	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
16325	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
16326	>
16327	<desc>
16328	Notification when an error happens during the virtual
16329	machine execution.
16330
16331	There are three kinds of runtime errors:
16332	<ul>
16333	<li><i>fatal</i></li>
16334	<li><i>non-fatal with retry</i></li>
16335	<li><i>non-fatal warnings</i></li>
16336	</ul>
16337
16338	<b>Fatal</b> errors are indicated by the @a fatal parameter set
16339	to @c true. In case of fatal errors, the virtual machine
16340	execution is always paused before calling this notification, and
16341	the notification handler is supposed either to immediately save
16342	the virtual machine state using <link to="IConsole::saveState"/>
16343	or power it off using <link to="IConsole::powerDown"/>.
16344	Resuming the execution can lead to unpredictable results.
16345
16346	<b>Non-fatal</b> errors and warnings are indicated by the
16347	@a fatal parameter set to @c false. If the virtual machine
16348	is in the Paused state by the time the error notification is
16349	received, it means that the user can <i>try to resume</i> the machine
16350	execution after attempting to solve the problem that caused the
16351	error. In this case, the notification handler is supposed
16352	to show an appropriate message to the user (depending on the
16353	value of the @a id parameter) that offers several actions such
16354	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
16355	wants to retry, the notification handler should continue
16356	the machine execution using the <link to="IConsole::resume"/>
16357	call. If the machine execution is not Paused during this
16358	notification, then it means this notification is a <i>warning</i>
16359	(for example, about a fatal condition that can happen very soon);
16360	no immediate action is required from the user, the machine
16361	continues its normal execution.
16362
16363	Note that in either case the notification handler
16364	<b>must not</b> perform any action directly on a thread
16365	where this notification is called. Everything it is allowed to
16366	do is to post a message to another thread that will then talk
16367	to the user and take the corresponding action.
16368
16369	Currently, the following error identifiers are known:
16370	<ul>
16371	<li><tt>"HostMemoryLow"</tt></li>
16372	<li><tt>"HostAudioNotResponding"</tt></li>
16373	<li><tt>"VDIStorageFull"</tt></li>
16374	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
16375	</ul>
16376	</desc>
16377	<attribute name="fatal" type="boolean" readonly="yes">
16378	<desc>
16379	Whether the error is fatal or not.
16380	</desc>
16381	</attribute>
16382	<attribute name="id" type="wstring" readonly="yes">
16383	<desc>
16384	Error identifier.
16385	</desc>
16386	</attribute>
16387	<attribute name="message" type="wstring" readonly="yes">
16388	<desc>
16389	Optional error message.
16390	</desc>
16391	</attribute>
16392	</interface>
16393
16394
16395	<interface
16396	name="IEventSourceChangedEvent" extends="IEvent"
16397	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
16398	waitable="yes"
16399	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
16400	>
16401	<desc>
16402	Notification when an event source state changes (listener added or removed).
16403	</desc>
16404
16405	<attribute name="listener" type="IEventListener" readonly="yes">
16406	<desc>
16407	Event listener which has changed.
16408	</desc>
16409	</attribute>
16410
16411	<attribute name="add" type="boolean" readonly="yes">
16412	<desc>
16413	Flag whether listener was added or removed.
16414	</desc>
16415	</attribute>
16416	</interface>
16417
16418	<interface
16419	name="IExtraDataChangedEvent" extends="IEvent"
16420	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
16421	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
16422	>
16423	<desc>
16424	Notification when machine specific or global extra data
16425	has changed.
16426	</desc>
16427	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16428	<desc>
16429	ID of the machine this event relates to.
16430	Null for global extra data changes.
16431	</desc>
16432	</attribute>
16433	<attribute name="key" type="wstring" readonly="yes">
16434	<desc>
16435	Extra data key that has changed.
16436	</desc>
16437	</attribute>
16438	<attribute name="value" type="wstring" readonly="yes">
16439	<desc>
16440	Extra data value for the given key.
16441	</desc>
16442	</attribute>
16443	</interface>
16444
16445	<interface
16446	name="IVetoEvent" extends="IEvent"
16447	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
16448	wsmap="managed"
16449	>
16450	<desc>Base abstract interface for veto events.</desc>
16451
16452	<method name="addVeto">
16453	<desc>
16454	Adds a veto on this event.
16455	</desc>
16456	<param name="reason" type="wstring" dir="in">
16457	<desc>
16458	Reason for veto, could be null or empty string.
16459	</desc>
16460	</param>
16461	</method>
16462
16463	<method name="isVetoed">
16464	<desc>
16465	If this event was vetoed.
16466	</desc>
16467	<param name="result" type="boolean" dir="return">
16468	<desc>
16469	Reason for veto.
16470	</desc>
16471	</param>
16472	</method>
16473
16474	<method name="getVetos">
16475	<desc>
16476	Current veto reason list, if size is 0 - no veto.
16477	</desc>
16478	<param name="result" type="wstring" dir="return" safearray="yes">
16479	<desc>
16480	Array of reasons for veto provided by different event handlers.
16481	</desc>
16482	</param>
16483	</method>
16484
16485	</interface>
16486
16487	<interface
16488	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
16489	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
16490	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
16491	waitable="true"
16492	>
16493	<desc>
16494	Notification when someone tries to change extra data for
16495	either the given machine or (if @c null) global extra data.
16496	This gives the chance to veto against changes.
16497	</desc>
16498	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16499	<desc>
16500	ID of the machine this event relates to.
16501	Null for global extra data changes.
16502	</desc>
16503	</attribute>
16504	<attribute name="key" type="wstring" readonly="yes">
16505	<desc>
16506	Extra data key that has changed.
16507	</desc>
16508	</attribute>
16509	<attribute name="value" type="wstring" readonly="yes">
16510	<desc>
16511	Extra data value for the given key.
16512	</desc>
16513	</attribute>
16514	</interface>
16515
16516	<interface
16517	name="ICanShowWindowEvent" extends="IVetoEvent"
16518	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
16519	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
16520	waitable="true"
16521	>
16522	<desc>
16523	Notification when a call to
16524	<link to="IMachine::canShowConsoleWindow"/> is made by a
16525	front-end to check if a subsequent call to
16526	<link to="IMachine::showConsoleWindow"/> can succeed.
16527
16528	The callee should give an answer appropriate to the current
16529	machine state using event veto. This answer must
16530	remain valid at least until the next
16531	<link to="IConsole::state">machine state</link> change.
16532	</desc>
16533	</interface>
16534
16535	<interface
16536	name="IShowWindowEvent" extends="IEvent"
16537	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
16538	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
16539	waitable="true"
16540	>
16541	<desc>
16542	Notification when a call to
16543	<link to="IMachine::showConsoleWindow"/>
16544	requests the console window to be activated and brought to
16545	foreground on the desktop of the host PC.
16546
16547	This notification should cause the VM console process to
16548	perform the requested action as described above. If it is
16549	impossible to do it at a time of this notification, this
16550	method should return a failure.
16551
16552	Note that many modern window managers on many platforms
16553	implement some sort of focus stealing prevention logic, so
16554	that it may be impossible to activate a window without the
16555	help of the currently active application (which is supposedly
16556	an initiator of this notification). In this case, this method
16557	must return a non-zero identifier that represents the
16558	top-level window of the VM console process. The caller, if it
16559	represents a currently active process, is responsible to use
16560	this identifier (in a platform-dependent manner) to perform
16561	actual window activation.
16562
16563	This method must set @a winId to zero if it has performed all
16564	actions necessary to complete the request and the console
16565	window is now active and in foreground, to indicate that no
16566	further action is required on the caller's side.
16567	</desc>
16568	<attribute name="winId" type="long long">
16569	<desc>
16570	Platform-dependent identifier of the top-level VM console
16571	window, or zero if this method has performed all actions
16572	necessary to implement the <i>show window</i> semantics for
16573	the given platform and/or this VirtualBox front-end.
16574	</desc>
16575	</attribute>
16576	</interface>
16577
16578	<interface
16579	name="INATRedirectEvent" extends="IMachineEvent"
16580	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
16581	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
16582	>
16583	<desc>
16584	Notification when NAT redirect rule added or removed.
16585	</desc>
16586	<attribute name="slot" type="unsigned long" readonly="yes">
16587	<desc>
16588	Adapter which NAT attached to.
16589	</desc>
16590	</attribute>
16591	<attribute name="remove" type="boolean" readonly="yes">
16592	<desc>
16593	Whether rule remove or add.
16594	</desc>
16595	</attribute>
16596	<attribute name="name" type="wstring" readonly="yes">
16597	<desc>
16598	Name of the rule.
16599	</desc>
16600	</attribute>
16601	<attribute name="proto" type="NATProtocol" readonly="yes">
16602	<desc>
16603	Protocol (TCP or UDP) of the redirect rule.
16604	</desc>
16605	</attribute>
16606	<attribute name="hostIp" type="wstring" readonly="yes">
16607	<desc>
16608	Host ip address to bind socket on.
16609	</desc>
16610	</attribute>
16611	<attribute name="hostPort" type="long" readonly="yes">
16612	<desc>
16613	Host port to bind socket on.
16614	</desc>
16615	</attribute>
16616	<attribute name="guestIp" type="wstring" readonly="yes">
16617	<desc>
16618	Guest ip address to redirect to.
16619	</desc>
16620	</attribute>
16621	<attribute name="guestPort" type="long" readonly="yes">
16622	<desc>
16623	Guest port to redirect to.
16624	</desc>
16625	</attribute>
16626	</interface>
16627
16628	<interface
16629	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
16630	waitable="yes"
16631	uuid="EDD4782B-DB74-43A0-B724-2BAA36F039CC"
16632	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
16633	>
16634	<desc>
16635	Notification when host PCI device is plugged/unplugged.
16636	</desc>
16637
16638	<attribute name="plugged" type="boolean" readonly="yes">
16639	<desc>
16640	If device successfully plugged or unplugged.
16641	</desc>
16642	</attribute>
16643
16644	<attribute name="success" type="boolean" readonly="yes">
16645	<desc>
16646	If operation was successful, if false - 'message' attribute
16647	may be of interest.
16648	</desc>
16649	</attribute>
16650
16651	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
16652	<desc>
16653	Attachment info for this device.
16654	</desc>
16655	</attribute>
16656
16657	<attribute name="eventContext" type="IEventContext" readonly="yes">
16658	<desc>
16659	Context object, passed into attachHostPciDevice() and
16660	attachHostPciDevice().
16661	</desc>
16662	</attribute>
16663
16664	<attribute name="message" type="wstring" readonly="yes">
16665	<desc>
16666	Optional error message.
16667	</desc>
16668	</attribute>
16669
16670	</interface>
16671
16672	<interface
16673	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
16674	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
16675	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
16676	>
16677	<desc>
16678	Notification when VBoxSVC becomes unavailable (due to a crash or similar
16679	unexpected circumstances) or available again.
16680	</desc>
16681
16682	<attribute name="available" type="boolean" readonly="yes">
16683	<desc>
16684	Whether VBoxSVC is available now.
16685	</desc>
16686	</attribute>
16687	</interface>
16688
16689	<interface
16690	name="IBandwidthGroupChangedEvent" extends="IEvent"
16691	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
16692	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
16693	>
16694	<desc>
16695	Notification when one of the bandwidth groups changed
16696	</desc>
16697	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
16698	<desc>
16699	The changed bandwidth group.
16700	</desc>
16701	</attribute>
16702	</interface>
16703
16704	<enum
16705	name="GuestMonitorChangedEventType"
16706	uuid="ef172985-7e36-4297-95be-e46396968d66"
16707	>
16708
16709	<desc>
16710	How the guest monitor has been changed.
16711	</desc>
16712
16713	<const name="Enabled" value="0">
16714	<desc>
16715	The guest monitor has been enabled by the guest.
16716	</desc>
16717	</const>
16718
16719	<const name="Disabled" value="1">
16720	<desc>
16721	The guest monitor has been disabled by the guest.
16722	</desc>
16723	</const>
16724
16725	<const name="NewOrigin" value="2">
16726	<desc>
16727	The guest monitor origin has changed in the guest.
16728	</desc>
16729	</const>
16730	</enum>
16731
16732	<interface
16733	name="IGuestMonitorChangedEvent" extends="IEvent"
16734	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
16735	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
16736	>
16737	<desc>
16738	Notification when the guest enables one of its monitors.
16739	</desc>
16740
16741	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
16742	<desc>
16743	What was changed for this guest monitor.
16744	</desc>
16745	</attribute>
16746
16747	<attribute name="screenId" type="unsigned long" readonly="yes">
16748	<desc>
16749	The monitor which was changed.
16750	</desc>
16751	</attribute>
16752
16753	<attribute name="originX" type="unsigned long" readonly="yes">
16754	<desc>
16755	Physical X origin relative to the primary screen.
16756	Valid for Enabled and NewOrigin.
16757	</desc>
16758	</attribute>
16759
16760	<attribute name="originY" type="unsigned long" readonly="yes">
16761	<desc>
16762	Physical Y origin relative to the primary screen.
16763	Valid for Enabled and NewOrigin.
16764	</desc>
16765	</attribute>
16766
16767	<attribute name="width" type="unsigned long" readonly="yes">
16768	<desc>
16769	Width of the screen.
16770	Valid for Enabled.
16771	</desc>
16772	</attribute>
16773
16774	<attribute name="height" type="unsigned long" readonly="yes">
16775	<desc>
16776	Height of the screen.
16777	Valid for Enabled.
16778	</desc>
16779	</attribute>
16780
16781	</interface>
16782
16783	<module name="VBoxSVC" context="LocalServer">
16784	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
16785	namespace="virtualbox.org">
16786	<interface name="IVirtualBox" default="yes"/>
16787	</class>
16788	</module>
16789
16790	<module name="VBoxC" context="InprocServer" threadingModel="Free">
16791	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
16792	namespace="virtualbox.org">
16793	<interface name="IVirtualBoxClient" default="yes"/>
16794	</class>
16795
16796	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
16797	namespace="virtualbox.org">
16798	<interface name="ISession" default="yes"/>
16799	</class>
16800	</module>
16801
16802	</library>
16803
16804	</idl>
16805
16806	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format