VirtualBox.xidl@ 40352

Last change on this file since 40352 was 40352, checked in by vboxsync, 13 years ago
Documentation: Typo.
Property svn:eol-style set to `native`
File size: 661.9 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2011 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). When pointers representing input arguments (such
275	as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490
491	<const name="Future" value="99999">
492	<desc>Settings version greater than "1.12", written by a future VirtualBox version.</desc>
493	</const>
494	</enum>
495
496	<enum
497	name="AccessMode"
498	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
499	>
500	<desc>
501	Access mode for opening files.
502	</desc>
503
504	<const name="ReadOnly" value="1"/>
505	<const name="ReadWrite" value="2"/>
506	</enum>
507
508	<enum
509	name="MachineState"
510	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
511	>
512	<desc>
513	Virtual machine execution state.
514
515	This enumeration represents possible values of the <link
516	to="IMachine::state"/> attribute.
517
518	Below is the basic virtual machine state diagram. It shows how the state
519	changes during virtual machine execution. The text in square braces shows
520	a method of the IConsole interface that performs the given state
521	transition.
522
523	<pre>
524	+---------[powerDown()] <- Stuck <--[failure]-+
525	V \|
526	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
527	\| \| \| \| V \|
528	\| Aborted -----+ +--> Running --[pause()]--> Paused
529	\| \| ^ \| ^ \|
530	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
531	\| ^ \| \| \| \|
532	\| \| +-----------------------------------------+-\|-------------------+ +
533	\| \| \| \| \|
534	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
535	\| \| \| \|
536	\| +-------- Saving <--------[saveState()]<----------+---------------------+
537	\| \| \|
538	+-------------- Stopping -------[powerDown()]<----------+---------------------+
539	</pre>
540
541	Note that states to the right from PoweredOff, Aborted and Saved in the
542	above diagram are called <i>online VM states</i>. These states
543	represent the virtual machine which is being executed in a dedicated
544	process (usually with a GUI window attached to it where you can see the
545	activity of the virtual machine and interact with it). There are two
546	special pseudo-states, FirstOnline and LastOnline, that can be used in
547	relational expressions to detect if the given machine state is online or
548	not:
549
550	<pre>
551	if (machine.GetState() >= MachineState_FirstOnline &&
552	machine.GetState() <= MachineState_LastOnline)
553	{
554	...the machine is being executed...
555	}
556	</pre>
557
558	When the virtual machine is in one of the online VM states (that is, being
559	executed), only a few machine settings can be modified. Methods working
560	with such settings contain an explicit note about that. An attempt to
561	change any other setting or perform a modifying operation during this time
562	will result in the @c VBOX_E_INVALID_VM_STATE error.
563
564	All online states except Running, Paused and Stuck are transitional: they
565	represent temporary conditions of the virtual machine that will last as
566	long as the operation that initiated such a condition.
567
568	The Stuck state is a special case. It means that execution of the machine
569	has reached the "Guru Meditation" condition. This condition indicates an
570	internal VMM (virtual machine manager) failure which may happen as a
571	result of either an unhandled low-level virtual hardware exception or one
572	of the recompiler exceptions (such as the <i>too-many-traps</i>
573	condition).
574
575	Note also that any online VM state may transit to the Aborted state. This
576	happens if the process that is executing the virtual machine terminates
577	unexpectedly (for example, crashes). Other than that, the Aborted state is
578	equivalent to PoweredOff.
579
580	There are also a few additional state diagrams that do not deal with
581	virtual machine execution and therefore are shown separately. The states
582	shown on these diagrams are called <i>offline VM states</i> (this includes
583	PoweredOff, Aborted and Saved too).
584
585	The first diagram shows what happens when a lengthy setup operation is
586	being executed (such as <link to="IMachine::attachDevice"/>).
587
588	<pre>
589	+----------------------------------(same state as before the call)------+
590	\| \|
591	+-> PoweredOff --+ \|
592	\| \| \|
593	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
594	\| \|
595	+-> Saved -------+
596	</pre>
597
598	The next two diagrams demonstrate the process of taking a snapshot of a
599	powered off virtual machine, restoring the state to that as of a snapshot
600	or deleting a snapshot, respectively.
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| +-->[takeSnapshot()] -------------------> Saving ------+
607	+-> Aborted -----+
608
609	+-> PoweredOff --+
610	\| \|
611	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
612	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
613	+-> Saved -------+ \|
614	\| \|
615	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
616	</pre>
617
618	Note that the Saving state is present in both the offline state group and
619	online state group. Currently, the only way to determine what group is
620	assumed in a particular case is to remember the previous machine state: if
621	it was Running or Paused, then Saving is an online state, otherwise it is
622	an offline state. This inconsistency may be removed in one of the future
623	versions of VirtualBox by adding a new state.
624
625	<note internal="yes">
626	For whoever decides to touch this enum: In order to keep the
627	comparisons involving FirstOnline and LastOnline pseudo-states valid,
628	the numeric values of these states must be correspondingly updated if
629	needed: for any online VM state, the condition
630	<tt>FirstOnline <= state <= LastOnline</tt> must be
631	@c true. The same relates to transient states for which
632	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
633	@c true.
634	</note>
635	</desc>
636
637	<const name="Null" value="0">
638	<desc>Null value (never used by the API).</desc>
639	</const>
640	<const name="PoweredOff" value="1">
641	<desc>
642	The machine is not running and has no saved execution state; it has
643	either never been started or been shut down successfully.
644	</desc>
645	</const>
646	<const name="Saved" value="2">
647	<desc>
648	The machine is not currently running, but the execution state of the machine
649	has been saved to an external file when it was running, from where
650	it can be resumed.
651	</desc>
652	</const>
653	<const name="Teleported" value="3">
654	<desc>
655	The machine was teleported to a different host (or process) and then
656	powered off. Take care when powering it on again may corrupt resources
657	it shares with the teleportation target (e.g. disk and network).
658	</desc>
659	</const>
660	<const name="Aborted" value="4">
661	<desc>
662	The process running the machine has terminated abnormally. This may
663	indicate a crash of the VM process in host execution context, or
664	the VM process has been terminated externally.
665	</desc>
666	</const>
667	<const name="Running" value="5">
668	<desc>
669	The machine is currently being executed.
670	<note internal="yes">
671	For whoever decides to touch this enum: In order to keep the
672	comparisons in the old source code valid, this state must immediately
673	precede the Paused state.
674	TODO: Lift this spectacularly wonderful restriction.
675	</note>
676	</desc>
677	</const>
678	<const name="Paused" value="6">
679	<desc>
680	Execution of the machine has been paused.
681	<note internal="yes">
682	For whoever decides to touch this enum: In order to keep the
683	comparisons in the old source code valid, this state must immediately
684	follow the Running state.
685	TODO: Lift this spectacularly wonderful restriction.
686	</note>
687	</desc>
688	</const>
689	<const name="Stuck" value="7">
690	<desc>
691	Execution of the machine has reached the "Guru Meditation"
692	condition. This indicates a severe error in the hypervisor itself.
693	<note internal="yes">
694	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
695	"Guru", perhaps? Or are there some other VMM states that are
696	intended to be lumped in here as well?
697	</note>
698	</desc>
699	</const>
700	<const name="Teleporting" value="8">
701	<desc>
702	The machine is about to be teleported to a different host or process.
703	It is possible to pause a machine in this state, but it will go to the
704	@c TeleportingPausedVM state and it will not be
705	possible to resume it again unless the teleportation fails.
706	</desc>
707	</const>
708	<const name="LiveSnapshotting" value="9">
709	<desc>
710	A live snapshot is being taken. The machine is running normally, but
711	some of the runtime configuration options are inaccessible. Also, if
712	paused while in this state it will transition to
713	@c Saving and it will not be resume the
714	execution until the snapshot operation has completed.
715	</desc>
716	</const>
717	<const name="Starting" value="10">
718	<desc>
719	Machine is being started after powering it on from a
720	zero execution state.
721	</desc>
722	</const>
723	<const name="Stopping" value="11">
724	<desc>
725	Machine is being normally stopped powering it off, or after the guest OS
726	has initiated a shutdown sequence.
727	</desc>
728	</const>
729	<const name="Saving" value="12">
730	<desc>
731	Machine is saving its execution state to a file, or an online
732	snapshot of the machine is being taken.
733	</desc>
734	</const>
735	<const name="Restoring" value="13">
736	<desc>
737	Execution state of the machine is being restored from a file
738	after powering it on from the saved execution state.
739	</desc>
740	</const>
741	<const name="TeleportingPausedVM" value="14">
742	<desc>
743	The machine is being teleported to another host or process, but it is
744	not running. This is the paused variant of the
745	@c state.
746	</desc>
747	</const>
748	<const name="TeleportingIn" value="15">
749	<desc>
750	Teleporting the machine state in from another host or process.
751	</desc>
752	</const>
753	<const name="FaultTolerantSyncing" value="16">
754	<desc>
755	The machine is being synced with a fault tolerant VM running elsewhere.
756	</desc>
757	</const>
758	<const name="DeletingSnapshotOnline" value="17">
759	<desc>
760	Like @c DeletingSnapshot, but the merging of media is ongoing in
761	the background while the machine is running.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotPaused" value="18">
765	<desc>
766	Like @c DeletingSnapshotOnline, but the machine was paused when the
767	merging of differencing media was started.
768	</desc>
769	</const>
770	<const name="RestoringSnapshot" value="19">
771	<desc>
772	A machine snapshot is being restored; this typically does not take long.
773	</desc>
774	</const>
775	<const name="DeletingSnapshot" value="20">
776	<desc>
777	A machine snapshot is being deleted; this can take a long time since this
778	may require merging differencing media. This value indicates that the
779	machine is not running while the snapshot is being deleted.
780	</desc>
781	</const>
782	<const name="SettingUp" value="21">
783	<desc>
784	Lengthy setup operation is in progress.
785	</desc>
786	</const>
787
788	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
789	<desc>
790	Pseudo-state: first online state (for use in relational expressions).
791	</desc>
792	</const>
793	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
794	<desc>
795	Pseudo-state: last online state (for use in relational expressions).
796	</desc>
797	</const>
798
799	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
800	<desc>
801	Pseudo-state: first transient state (for use in relational expressions).
802	</desc>
803	</const>
804	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
805	<desc>
806	Pseudo-state: last transient state (for use in relational expressions).
807	</desc>
808	</const>
809
810	</enum>
811
812	<enum
813	name="SessionState"
814	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
815	>
816	<desc>
817	Session state. This enumeration represents possible values of
818	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
819	attributes.
820	</desc>
821
822	<const name="Null" value="0">
823	<desc>Null value (never used by the API).</desc>
824	</const>
825	<const name="Unlocked" value="1">
826	<desc>
827	In <link to="IMachine::sessionState"/>, this means that the machine
828	is not locked for any sessions.
829
830	In <link to="ISession::state"/>, this means that no machine is
831	currently locked for this session.
832	</desc>
833	</const>
834	<const name="Locked" value="2">
835	<desc>
836	In <link to="IMachine::sessionState"/>, this means that the machine
837	is currently locked for a session, whose process identifier can
838	then be found in the <link to="IMachine::sessionPid" /> attribute.
839
840	In <link to="ISession::state"/>, this means that a machine is
841	currently locked for this session, and the mutable machine object
842	can be found in the <link to="ISession::machine"/> attribute
843	(see <link to="IMachine::lockMachine" /> for details).
844	</desc>
845	</const>
846	<const name="Spawning" value="3">
847	<desc>
848	A new process is being spawned for the machine as a result of
849	<link to="IMachine::launchVMProcess"/> call. This state also occurs
850	as a short transient state during an <link to="IMachine::lockMachine"/>
851	call.
852	</desc>
853	</const>
854	<const name="Unlocking" value="4">
855	<desc>
856	The session is being unlocked.
857	</desc>
858	</const>
859	</enum>
860
861	<enum
862	name="CPUPropertyType"
863	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
864	>
865	<desc>
866	Virtual CPU property type. This enumeration represents possible values of the
867	IMachine get- and setCPUProperty methods.
868	</desc>
869	<const name="Null" value="0">
870	<desc>Null value (never used by the API).</desc>
871	</const>
872	<const name="PAE" value="1">
873	<desc>
874	This setting determines whether VirtualBox will expose the Physical Address
875	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
876	is not available, it will not be reported.
877	</desc>
878	</const>
879	<const name="Synthetic" value="2">
880	<desc>
881	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
882	teleporting between host systems that differ significantly.
883	</desc>
884	</const>
885	</enum>
886
887
888	<enum
889	name="HWVirtExPropertyType"
890	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
891	>
892	<desc>
893	Hardware virtualization property type. This enumeration represents possible values
894	for the <link to="IMachine::getHWVirtExProperty"/> and
895	<link to="IMachine::setHWVirtExProperty"/> methods.
896	</desc>
897	<const name="Null" value="0">
898	<desc>Null value (never used by the API).</desc>
899	</const>
900	<const name="Enabled" value="1">
901	<desc>
902	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
903	such extensions are not available, they will not be used.
904	</desc>
905	</const>
906	<const name="Exclusive" value="2">
907	<desc>
908	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
909	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
910	feature of the host. To share these with other hypervisors, you must disable this property.
911	</desc>
912	</const>
913	<const name="VPID" value="3">
914	<desc>
915	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
916	</desc>
917	</const>
918	<const name="NestedPaging" value="4">
919	<desc>
920	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
921	</desc>
922	</const>
923	<const name="LargePages" value="5">
924	<desc>
925	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
926	</desc>
927	</const>
928	<const name="Force" value="6">
929	<desc>
930	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
931	not set, there will be an automatic fallback to software virtualization.
932	</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="FaultToleranceState"
938	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
939	>
940	<desc>
941	Used with <link to="IMachine::faultToleranceState" />.
942	</desc>
943	<const name="Inactive" value="1">
944	<desc>No fault tolerance enabled.</desc>
945	</const>
946	<const name="Master" value="2">
947	<desc>Fault tolerant master VM.</desc>
948	</const>
949	<const name="Standby" value="3">
950	<desc>Fault tolerant standby VM.</desc>
951	</const>
952	</enum>
953
954	<enum
955	name="LockType"
956	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
957	>
958	<desc>
959	Used with <link to="IMachine::lockMachine" />.
960	</desc>
961	<const name="Write" value="2">
962	<desc>Lock the machine for writing.</desc>
963	</const>
964	<const name="Shared" value="1">
965	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
966	</const>
967	</enum>
968
969	<enum
970	name="SessionType"
971	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
972	>
973	<desc>
974	Session type. This enumeration represents possible values of the
975	<link to="ISession::type"/> attribute.
976	</desc>
977
978	<const name="Null" value="0">
979	<desc>Null value (never used by the API).</desc>
980	</const>
981	<const name="WriteLock" value="1">
982	<desc>
983	Session has acquired an exclusive write lock on a machine
984	using <link to="IMachine::lockMachine"/>.
985	</desc>
986	</const>
987	<const name="Remote" value="2">
988	<desc>
989	Session has launched a VM process using
990	<link to="IMachine::launchVMProcess"/>
991	</desc>
992	</const>
993	<const name="Shared" value="3">
994	<desc>
995	Session has obtained a link to another session using
996	<link to="IMachine::lockMachine"/>
997	</desc>
998	</const>
999	</enum>
1000
1001	<enum
1002	name="DeviceType"
1003	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1004	>
1005	<desc>
1006	Device type.
1007	</desc>
1008	<const name="Null" value="0">
1009	<desc>
1010	Null value, may also mean "no device" (not allowed for
1011	<link to="IConsole::getDeviceActivity"/>).
1012	</desc>
1013	</const>
1014	<const name="Floppy" value="1">
1015	<desc>Floppy device.</desc>
1016	</const>
1017	<const name="DVD" value="2">
1018	<desc>CD/DVD-ROM device.</desc>
1019	</const>
1020	<const name="HardDisk" value="3">
1021	<desc>Hard disk device.</desc>
1022	</const>
1023	<const name="Network" value="4">
1024	<desc>Network device.</desc>
1025	</const>
1026	<const name="USB" value="5">
1027	<desc>USB device.</desc>
1028	</const>
1029	<const name="SharedFolder" value="6">
1030	<desc>Shared folder device.</desc>
1031	</const>
1032	</enum>
1033
1034	<enum
1035	name="DeviceActivity"
1036	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1037	>
1038	<desc>
1039	Device activity for <link to="IConsole::getDeviceActivity"/>.
1040	</desc>
1041
1042	<const name="Null" value="0"/>
1043	<const name="Idle" value="1"/>
1044	<const name="Reading" value="2"/>
1045	<const name="Writing" value="3"/>
1046	</enum>
1047
1048	<enum
1049	name="ClipboardMode"
1050	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1051	>
1052	<desc>
1053	Host-Guest clipboard interchange mode.
1054	</desc>
1055
1056	<const name="Disabled" value="0"/>
1057	<const name="HostToGuest" value="1"/>
1058	<const name="GuestToHost" value="2"/>
1059	<const name="Bidirectional" value="3"/>
1060	</enum>
1061
1062	<enum
1063	name="Scope"
1064	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1065	>
1066	<desc>
1067	Scope of the operation.
1068
1069	A generic enumeration used in various methods to define the action or
1070	argument scope.
1071	</desc>
1072
1073	<const name="Global" value="0"/>
1074	<const name="Machine" value="1"/>
1075	<const name="Session" value="2"/>
1076	</enum>
1077
1078	<enum
1079	name="BIOSBootMenuMode"
1080	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1081	>
1082	<desc>
1083	BIOS boot menu mode.
1084	</desc>
1085
1086	<const name="Disabled" value="0"/>
1087	<const name="MenuOnly" value="1"/>
1088	<const name="MessageAndMenu" value="2"/>
1089	</enum>
1090
1091	<enum
1092	name="ProcessorFeature"
1093	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1094	>
1095	<desc>
1096	CPU features.
1097	</desc>
1098
1099	<const name="HWVirtEx" value="0"/>
1100	<const name="PAE" value="1"/>
1101	<const name="LongMode" value="2"/>
1102	<const name="NestedPaging" value="3"/>
1103	</enum>
1104
1105	<enum
1106	name="FirmwareType"
1107	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1108	>
1109	<desc>
1110	Firmware type.
1111	</desc>
1112	<const name="BIOS" value="1">
1113	<desc>BIOS Firmware.</desc>
1114	</const>
1115	<const name="EFI" value="2">
1116	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1117	</const>
1118	<const name="EFI32" value="3">
1119	<desc>Efi firmware, 32-bit.</desc>
1120	</const>
1121	<const name="EFI64" value="4">
1122	<desc>Efi firmware, 64-bit.</desc>
1123	</const>
1124	<const name="EFIDUAL" value="5">
1125	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1126	</const>
1127	</enum>
1128
1129	<enum
1130	name="PointingHidType"
1131	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1132	>
1133	<desc>
1134	Type of pointing device used in a virtual machine.
1135	</desc>
1136	<const name="None" value="1">
1137	<desc>No mouse.</desc>
1138	</const>
1139	<const name="PS2Mouse" value="2">
1140	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1141	</const>
1142	<const name="USBMouse" value="3">
1143	<desc>USB mouse (relative pointer).</desc>
1144	</const>
1145	<const name="USBTablet" value="4">
1146	<desc>USB tablet (absolute pointer).</desc>
1147	</const>
1148	<const name="ComboMouse" value="5">
1149	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1150	Using of such device can have negative performance implications. </desc>
1151	</const>
1152	</enum>
1153
1154	<enum
1155	name="KeyboardHidType"
1156	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1157	>
1158	<desc>
1159	Type of keyboard device used in a virtual machine.
1160	</desc>
1161	<const name="None" value="1">
1162	<desc>No keyboard.</desc>
1163	</const>
1164	<const name="PS2Keyboard" value="2">
1165	<desc>PS/2 keyboard.</desc>
1166	</const>
1167	<const name="USBKeyboard" value="3">
1168	<desc>USB keyboard.</desc>
1169	</const>
1170	<const name="ComboKeyboard" value="4">
1171	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1172	Using of such device can have negative performance implications. </desc>
1173	</const>
1174	</enum>
1175
1176	<!--
1177	// IVirtualBoxErrorInfo
1178	/////////////////////////////////////////////////////////////////////////
1179	-->
1180
1181	<interface
1182	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1183	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1184	supportsErrorInfo="no"
1185	wsmap="managed"
1186	>
1187	<desc>
1188	The IVirtualBoxErrorInfo interface represents extended error information.
1189
1190	Extended error information can be set by VirtualBox components after
1191	unsuccessful or partially successful method invocation. This information
1192	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1193	and then shown to the client in addition to the plain 32-bit result code.
1194
1195	In MS COM, this interface extends the IErrorInfo interface,
1196	in XPCOM, it extends the nsIException interface. In both cases,
1197	it provides a set of common attributes to retrieve error
1198	information.
1199
1200	Sometimes invocation of some component's method may involve methods of
1201	other components that may also fail (independently of this method's
1202	failure), or a series of non-fatal errors may precede a fatal error that
1203	causes method failure. In cases like that, it may be desirable to preserve
1204	information about all errors happened during method invocation and deliver
1205	it to the caller. The <link to="#next"/> attribute is intended
1206	specifically for this purpose and allows to represent a chain of errors
1207	through a single IVirtualBoxErrorInfo object set after method invocation.
1208
1209	<note>errors are stored to a chain in the reverse order, i.e. the
1210	initial error object you query right after method invocation is the last
1211	error set by the callee, the object it points to in the @a next attribute
1212	is the previous error and so on, up to the first error (which is the last
1213	in the chain).</note>
1214	</desc>
1215
1216	<attribute name="resultCode" type="long" readonly="yes">
1217	<desc>
1218	Result code of the error.
1219	Usually, it will be the same as the result code returned
1220	by the method that provided this error information, but not
1221	always. For example, on Win32, CoCreateInstance() will most
1222	likely return E_NOINTERFACE upon unsuccessful component
1223	instantiation attempt, but not the value the component factory
1224	returned. Value is typed 'long', not 'result',
1225	to make interface usable from scripting languages.
1226	<note>
1227	In MS COM, there is no equivalent.
1228	In XPCOM, it is the same as nsIException::result.
1229	</note>
1230	</desc>
1231	</attribute>
1232
1233	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1234	<desc>
1235	UUID of the interface that defined the error.
1236	<note>
1237	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1238	data type.
1239	In XPCOM, there is no equivalent.
1240	</note>
1241	</desc>
1242	</attribute>
1243
1244	<attribute name="component" type="wstring" readonly="yes">
1245	<desc>
1246	Name of the component that generated the error.
1247	<note>
1248	In MS COM, it is the same as IErrorInfo::GetSource.
1249	In XPCOM, there is no equivalent.
1250	</note>
1251	</desc>
1252	</attribute>
1253
1254	<attribute name="text" type="wstring" readonly="yes">
1255	<desc>
1256	Text description of the error.
1257	<note>
1258	In MS COM, it is the same as IErrorInfo::GetDescription.
1259	In XPCOM, it is the same as nsIException::message.
1260	</note>
1261	</desc>
1262	</attribute>
1263
1264	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1265	<desc>
1266	Next error object if there is any, or @c null otherwise.
1267	<note>
1268	In MS COM, there is no equivalent.
1269	In XPCOM, it is the same as nsIException::inner.
1270	</note>
1271	</desc>
1272	</attribute>
1273
1274	</interface>
1275
1276	<!--
1277	// IVirtualBox
1278	/////////////////////////////////////////////////////////////////////////
1279	-->
1280
1281	<interface
1282	name="IDHCPServer" extends="$unknown"
1283	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1284	wsmap="managed"
1285	>
1286	<desc>
1287	The IDHCPServer interface represents the vbox dhcp server configuration.
1288
1289	To enumerate all the dhcp servers on the host, use the
1290	<link to="IVirtualBox::DHCPServers"/> attribute.
1291	</desc>
1292
1293	<attribute name="enabled" type="boolean">
1294	<desc>
1295	specifies if the dhcp server is enabled
1296	</desc>
1297	</attribute>
1298
1299	<attribute name="IPAddress" type="wstring" readonly="yes">
1300	<desc>
1301	specifies server IP
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="networkMask" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server network mask
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkName" type="wstring" readonly="yes">
1312	<desc>
1313	specifies internal network name the server is used for
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="lowerIP" type="wstring" readonly="yes">
1318	<desc>
1319	specifies from IP address in server address range
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="upperIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies to IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<method name="setConfiguration">
1330	<desc>
1331	configures the server
1332	<result name="E_INVALIDARG">
1333	invalid configuration supplied
1334	</result>
1335	</desc>
1336	<param name="IPAddress" type="wstring" dir="in">
1337	<desc>
1338	server IP address
1339	</desc>
1340	</param>
1341	<param name="networkMask" type="wstring" dir="in">
1342	<desc>
1343	server network mask
1344	</desc>
1345	</param>
1346	<param name="FromIPAddress" type="wstring" dir="in">
1347	<desc>
1348	server From IP address for address range
1349	</desc>
1350	</param>
1351	<param name="ToIPAddress" type="wstring" dir="in">
1352	<desc>
1353	server To IP address for address range
1354	</desc>
1355	</param>
1356	</method>
1357
1358	<method name="start">
1359	<desc>
1360	Starts DHCP server process.
1361	<result name="E_FAIL">
1362	Failed to start the process.
1363	</result>
1364	</desc>
1365	<param name="networkName" type="wstring" dir="in">
1366	<desc>
1367	Name of internal network DHCP server should attach to.
1368	</desc>
1369	</param>
1370	<param name="trunkName" type="wstring" dir="in">
1371	<desc>
1372	Name of internal network trunk.
1373	</desc>
1374	</param>
1375	<param name="trunkType" type="wstring" dir="in">
1376	<desc>
1377	Type of internal network trunk.
1378	</desc>
1379	</param>
1380	</method>
1381
1382	<method name="stop">
1383	<desc>
1384	Stops DHCP server process.
1385	<result name="E_FAIL">
1386	Failed to stop the process.
1387	</result>
1388	</desc>
1389	</method>
1390	</interface>
1391
1392	<interface
1393	name="IVirtualBox" extends="$unknown"
1394	uuid="c28be65f-1a8f-43b4-81f1-eb60cb516e66"
1395	wsmap="managed"
1396	>
1397	<desc>
1398	The IVirtualBox interface represents the main interface exposed by the
1399	product that provides virtual machine management.
1400
1401	An instance of IVirtualBox is required for the product to do anything
1402	useful. Even though the interface does not expose this, internally,
1403	IVirtualBox is implemented as a singleton and actually lives in the
1404	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1405	IVirtualBox can track the state of all virtual machines on a particular
1406	host, regardless of which frontend started them.
1407
1408	To enumerate all the virtual machines on the host, use the
1409	<link to="IVirtualBox::machines"/> attribute.
1410	</desc>
1411
1412	<attribute name="version" type="wstring" readonly="yes">
1413	<desc>
1414	A string representing the version number of the product. The
1415	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1416	last number represents the build number and will frequently change.
1417
1418	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1419	in prerelease builds. Non-Oracle builds may (/shall) also have a
1420	publisher tag, at the end. The publisher tag starts with an underscore
1421	just like the prerelease build type tag.
1422	</desc>
1423	</attribute>
1424
1425	<attribute name="revision" type="unsigned long" readonly="yes">
1426	<desc>
1427	The internal build revision number of the product.
1428	</desc>
1429	</attribute>
1430
1431	<attribute name="packageType" type="wstring" readonly="yes">
1432	<desc>
1433	A string representing the package type of this product. The
1434	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1435	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1436	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1437	this.
1438	</desc>
1439	</attribute>
1440
1441	<attribute name="APIVersion" type="wstring" readonly="yes">
1442	<desc>
1443	A string representing the VirtualBox API version number. The format is
1444	2 integer numbers divided by an underscore (e.g. 1_0). After the
1445	first public release of packages with a particular API version the
1446	API will not be changed in an incompatible way. Note that this
1447	guarantee does not apply to development builds, and also there is no
1448	guarantee that this version is identical to the first two integer
1449	numbers of the package version.
1450	</desc>
1451	</attribute>
1452
1453	<attribute name="homeFolder" type="wstring" readonly="yes">
1454	<desc>
1455	Full path to the directory where the global settings file,
1456	<tt>VirtualBox.xml</tt>, is stored.
1457
1458	In this version of VirtualBox, the value of this property is
1459	always <tt><user_dir>/.VirtualBox</tt> (where
1460	<tt><user_dir></tt> is the path to the user directory,
1461	as determined by the host OS), and cannot be changed.
1462
1463	This path is also used as the base to resolve relative paths in
1464	places where relative paths are allowed (unless otherwise
1465	expressly indicated).
1466	</desc>
1467	</attribute>
1468
1469	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1470	<desc>
1471	Full name of the global settings file.
1472	The value of this property corresponds to the value of
1473	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1474	</desc>
1475	</attribute>
1476
1477	<attribute name="host" type="IHost" readonly="yes">
1478	<desc>Associated host object.</desc>
1479	</attribute>
1480
1481	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1482	<desc>Associated system information object.</desc>
1483	</attribute>
1484
1485	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1486	<desc>
1487	Array of machine objects registered within this VirtualBox instance.
1488	</desc>
1489	</attribute>
1490
1491	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1492	<desc>
1493	Array of medium objects known to this VirtualBox installation.
1494
1495	This array contains only base media. All differencing
1496	media of the given base medium can be enumerated using
1497	<link to="IMedium::children"/>.
1498	</desc>
1499	</attribute>
1500
1501	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1502	<desc>
1503	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1508	<desc>
1509	Array of floppy image objects currently in use by this VirtualBox instance.
1510	</desc>
1511	</attribute>
1512
1513	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1514
1515	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1516
1517	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1518	<desc>
1519	Collection of global shared folders. Global shared folders are
1520	available to all virtual machines.
1521
1522	New shared folders are added to the collection using
1523	<link to="#createSharedFolder"/>. Existing shared folders can be
1524	removed using <link to="#removeSharedFolder"/>.
1525
1526	<note>
1527	In the current version of the product, global shared folders are not
1528	implemented and therefore this collection is always empty.
1529	</note>
1530	</desc>
1531	</attribute>
1532
1533	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1534	<desc>
1535	Associated performance collector object.
1536	</desc>
1537	</attribute>
1538
1539	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1540	<desc>
1541	DHCP servers.
1542	</desc>
1543	</attribute>
1544
1545	<attribute name="eventSource" type="IEventSource" readonly="yes">
1546	<desc>
1547	Event source for VirtualBox events.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1552	<desc>
1553	The extension pack manager.
1554	</desc>
1555	</attribute>
1556
1557
1558	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1559	<desc>
1560	Names of all internal networks.
1561	</desc>
1562	</attribute>
1563
1564	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1565	<desc>
1566	Names of all generic network drivers.
1567	</desc>
1568	</attribute>
1569
1570	<method name="composeMachineFilename">
1571	<desc>
1572	Returns a recommended full path of the settings file name for a new virtual
1573	machine.
1574
1575	This API serves two purposes:
1576
1577	<ul>
1578	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1579	for the @a settingsFile argument there, which means that API should use
1580	a recommended default file name.</li>
1581
1582	<li>It can be called manually by a client software before creating a machine,
1583	e.g. if that client wants to pre-create the machine directory to create
1584	virtual hard disks in that directory together with the new machine
1585	settings file. In that case, the file name should be stripped from the
1586	full settings file path returned by this function to obtain the
1587	machine directory.</li>
1588	</ul>
1589
1590	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1591	details about the machine name.
1592
1593	If @a baseFolder is a @c null or empty string (which is recommended), the
1594	default machine settings folder
1595	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1596	a base folder for the created machine, resulting in a file name like
1597	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1598	will be used.
1599
1600	This method does not access the host disks. In particular, it does not check
1601	for whether a machine of this name already exists.
1602	</desc>
1603	<param name="name" type="wstring" dir="in">
1604	<desc>Suggested machine name.</desc>
1605	</param>
1606	<param name="baseFolder" type="wstring" dir="in">
1607	<desc>Base machine folder (optional).</desc>
1608	</param>
1609	<param name="file" type="wstring" dir="return">
1610	<desc>Fully qualified path where the machine would be created.</desc>
1611	</param>
1612	</method>
1613
1614	<method name="createMachine">
1615	<desc>
1616	Creates a new virtual machine by creating a machine settings file at
1617	the given location.
1618
1619	VirtualBox machine settings files use a custom XML dialect. Starting
1620	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1621	and machine files can be created at arbitrary locations.
1622
1623	However, it is is recommended that machines be created in the default
1624	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1625	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1626	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1627	is called automatically to have such a recommended name composed based
1628	on the machine name given in the @a name argument.
1629
1630	If the resulting settings file already exists, this method will fail,
1631	unless @a forceOverwrite is set.
1632
1633	The new machine is created unregistered, with the initial configuration
1634	set according to the specified guest OS type. A typical sequence of
1635	actions to create a new virtual machine is as follows:
1636
1637	<ol>
1638	<li>
1639	Call this method to have a new machine created. The returned machine
1640	object will be "mutable" allowing to change any machine property.
1641	</li>
1642
1643	<li>
1644	Configure the machine using the appropriate attributes and methods.
1645	</li>
1646
1647	<li>
1648	Call <link to="IMachine::saveSettings" /> to write the settings
1649	to the machine's XML settings file. The configuration of the newly
1650	created machine will not be saved to disk until this method is
1651	called.
1652	</li>
1653
1654	<li>
1655	Call <link to="#registerMachine" /> to add the machine to the list
1656	of machines known to VirtualBox.
1657	</li>
1658	</ol>
1659
1660	The specified guest OS type identifier must match an ID of one of known
1661	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1662	array.
1663
1664	Optionally, you may specify an UUID of to assign to the created machine.
1665	However, this is not recommended and you should normally pass an empty
1666	(@c null) UUID to this method so that a new UUID will be automatically
1667	generated for every created machine. You can use UUID
1668	00000000-0000-0000-0000-000000000000 as @c null value.
1669
1670	<note>
1671	There is no way to change the name of the settings file or
1672	subfolder of the created machine directly.
1673	</note>
1674
1675	<result name="VBOX_E_OBJECT_NOT_FOUND">
1676	@a osTypeId is invalid.
1677	</result>
1678	<result name="VBOX_E_FILE_ERROR">
1679	Resulting settings file name is invalid or the settings file already
1680	exists or could not be created due to an I/O error.
1681	</result>
1682	<result name="E_INVALIDARG">
1683	@a name is empty or @c null.
1684	</result>
1685	</desc>
1686
1687	<param name="settingsFile" type="wstring" dir="in">
1688	<desc>Fully qualified path where the settings file should be created,
1689	or NULL for a default folder and file based on the @a name argument
1690	(see <link to="#composeMachineFilename" />).</desc>
1691	</param>
1692	<param name="name" type="wstring" dir="in">
1693	<desc>Machine name.</desc>
1694	</param>
1695	<param name="osTypeId" type="wstring" dir="in">
1696	<desc>Guest OS Type ID.</desc>
1697	</param>
1698	<param name="id" type="uuid" mod="string" dir="in">
1699	<desc>Machine UUID (optional).</desc>
1700	</param>
1701	<param name="forceOverwrite" type="boolean" dir="in">
1702	<desc>If true, an existing machine settings file will be overwritten.</desc>
1703	</param>
1704	<param name="machine" type="IMachine" dir="return">
1705	<desc>Created machine object.</desc>
1706	</param>
1707	</method>
1708
1709	<method name="openMachine">
1710	<desc>
1711	Opens a virtual machine from the existing settings file.
1712	The opened machine remains unregistered until you call
1713	<link to="#registerMachine"/>.
1714
1715	The specified settings file name must be fully qualified.
1716	The file must exist and be a valid machine XML settings file
1717	whose contents will be used to construct the machine object.
1718
1719	<result name="VBOX_E_FILE_ERROR">
1720	Settings file name invalid, not found or sharing violation.
1721	</result>
1722	</desc>
1723	<param name="settingsFile" type="wstring" dir="in">
1724	<desc>
1725	Name of the machine settings file.
1726	</desc>
1727	</param>
1728	<param name="machine" type="IMachine" dir="return">
1729	<desc>Opened machine object.</desc>
1730	</param>
1731	<note>
1732	<link to="IMachine::settingsModified"/> will return
1733	@c false for the created machine, until any of machine settings
1734	are changed.
1735	</note>
1736	</method>
1737
1738	<method name="registerMachine">
1739	<desc>
1740
1741	Registers the machine previously created using
1742	<link to="#createMachine"/> or opened using
1743	<link to="#openMachine"/> within this VirtualBox installation. After
1744	successful method invocation, the
1745	<link to="IMachineRegisteredEvent"/> event is fired.
1746
1747	<note>
1748	This method implicitly calls <link to="IMachine::saveSettings"/>
1749	to save all current machine settings before registering it.
1750	</note>
1751
1752	<result name="VBOX_E_OBJECT_NOT_FOUND">
1753	No matching virtual machine found.
1754	</result>
1755	<result name="VBOX_E_INVALID_OBJECT_STATE">
1756	Virtual machine was not created within this VirtualBox instance.
1757	</result>
1758
1759	</desc>
1760	<param name="machine" type="IMachine" dir="in"/>
1761	</method>
1762
1763	<method name="findMachine">
1764	<desc>
1765	Attempts to find a virtual machine given its name or UUID.
1766
1767	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1768	cannot safely be determined.</note>
1769
1770	<result name="VBOX_E_OBJECT_NOT_FOUND">
1771	Could not find registered machine matching @a nameOrId.
1772	</result>
1773
1774	</desc>
1775	<param name="nameOrId" type="wstring" dir="in">
1776	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1777	</param>
1778	<param name="machine" type="IMachine" dir="return">
1779	<desc>Machine object, if found.</desc>
1780	</param>
1781	</method>
1782
1783	<method name="createAppliance">
1784	<desc>
1785	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1786	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1787	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1788	</desc>
1789	<param name="appliance" type="IAppliance" dir="return">
1790	<desc>New appliance.</desc>
1791	</param>
1792	</method>
1793
1794	<method name="createHardDisk">
1795	<desc>
1796	Creates a new base medium object that will use the given storage
1797	format and location for medium data.
1798
1799	The actual storage unit is not created by this method. In order to
1800	do it, and before you are able to attach the created medium to
1801	virtual machines, you must call one of the following methods to
1802	allocate a format-specific storage unit at the specified location:
1803	<ul>
1804	<li><link to="IMedium::createBaseStorage"/></li>
1805	<li><link to="IMedium::createDiffStorage"/></li>
1806	</ul>
1807
1808	Some medium attributes, such as <link to="IMedium::id"/>, may
1809	remain uninitialized until the medium storage unit is successfully
1810	created by one of the above methods.
1811
1812	After the storage unit is successfully created, it will be
1813	accessible through the <link to="#findMedium"/> method and can
1814	be found in the <link to="#hardDisks"/> array.
1815
1816	The list of all storage formats supported by this VirtualBox
1817	installation can be obtained using
1818	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1819	attribute is empty or @c null then the default storage format
1820	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1821	be used for creating a storage unit of the medium.
1822
1823	Note that the format of the location string is storage format specific.
1824	See <link to="IMedium::location"/> and IMedium for more details.
1825
1826	<result name="VBOX_E_OBJECT_NOT_FOUND">
1827	@a format identifier is invalid. See
1828	<link to="ISystemProperties::mediumFormats"/>.
1829	</result>
1830	<result name="VBOX_E_FILE_ERROR">
1831	@a location is a not valid file name (for file-based formats only).
1832	</result>
1833	</desc>
1834	<param name="format" type="wstring" dir="in">
1835	<desc>
1836	Identifier of the storage format to use for the new medium.
1837	</desc>
1838	</param>
1839	<param name="location" type="wstring" dir="in">
1840	<desc>
1841	Location of the storage unit for the new medium.
1842	</desc>
1843	</param>
1844	<param name="medium" type="IMedium" dir="return">
1845	<desc>Created medium object.</desc>
1846	</param>
1847	</method>
1848
1849	<method name="openMedium">
1850	<desc>
1851	Opens a medium from an existing storage location.
1852
1853	Once a medium has been opened, it can be passed to other VirtualBox
1854	methods, in particular to <link to="IMachine::attachDevice" />.
1855
1856	Depending on the given device type, the file at the storage location
1857	must be in one of the media formats understood by VirtualBox:
1858
1859	<ul>
1860	<li>With a "HardDisk" device type, the file must be a hard disk image
1861	in one of the formats supported by VirtualBox (see
1862	<link to="ISystemProperties::mediumFormats" />).
1863	After this method succeeds, if the medium is a base medium, it
1864	will be added to the <link to="#hardDisks"/> array attribute. </li>
1865	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1866	After this method succeeds, the medium will be added to the
1867	<link to="#DVDImages"/> array attribute.</li>
1868	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1869	After this method succeeds, the medium will be added to the
1870	<link to="#floppyImages"/> array attribute.</li>
1871	</ul>
1872
1873	After having been opened, the medium can be found by the <link to="#findMedium"/>
1874	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1875
1876	The UUID of the newly opened medium will either be retrieved from the
1877	storage location, if the format supports it (e.g. for hard disk images),
1878	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1879	If for some reason you need to change the medium's UUID, use
1880	<link to="IMedium::setIDs" />.
1881
1882	If a differencing hard disk medium is to be opened by this method, the
1883	operation will succeed only if its parent medium and all ancestors,
1884	if any, are already known to this VirtualBox installation (for example,
1885	were opened by this method before).
1886
1887	This method attempts to guess the storage format of the specified medium
1888	by reading medium data at the specified location.
1889
1890	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1891	the image is opened for read/write access and must have according permissions,
1892	as VirtualBox may actually write status information into the disk's metadata
1893	sections.
1894
1895	Note that write access is required for all typical hard disk usage in VirtualBox,
1896	since VirtualBox may need to write metadata such as a UUID into the image.
1897	The only exception is opening a source image temporarily for copying and
1898	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1899	again soon.
1900
1901	The format of the location string is storage format specific. See
1902	<link to="IMedium::location"/> and IMedium for more details.
1903
1904	<result name="VBOX_E_FILE_ERROR">
1905	Invalid medium storage file location or could not find the medium
1906	at the specified location.
1907	</result>
1908	<result name="VBOX_E_IPRT_ERROR">
1909	Could not get medium storage format.
1910	</result>
1911	<result name="E_INVALIDARG">
1912	Invalid medium storage format.
1913	</result>
1914	<result name="VBOX_E_INVALID_OBJECT_STATE">
1915	Medium has already been added to a media registry.
1916	</result>
1917	</desc>
1918	<param name="location" type="wstring" dir="in">
1919	<desc>
1920	Location of the storage unit that contains medium data in one of
1921	the supported storage formats.
1922	</desc>
1923	</param>
1924	<param name="deviceType" type="DeviceType" dir="in">
1925	<desc>
1926	Must be one of "HardDisk", "DVD" or "Floppy".
1927	</desc>
1928	</param>
1929	<param name="accessMode" type="AccessMode" dir="in">
1930	<desc>Whether to open the image in read/write or read-only mode. For
1931	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1932	</param>
1933	<param name="forceNewUuid" type="boolean" dir="in">
1934	<desc>Allows the caller to request a completely new medium UUID for
1935	the image which is to be opened. Useful if one intends to open an exact
1936	copy of a previously opened image, as this would normally fail due to
1937	the duplicate UUID.</desc>
1938	</param>
1939	<param name="medium" type="IMedium" dir="return">
1940	<desc>Opened medium object.</desc>
1941	</param>
1942	</method>
1943
1944	<method name="findMedium">
1945	<desc>
1946	Returns a medium of the given type that uses the given fully qualified
1947	location or UUID to store medium data.
1948
1949	The given medium must be known to this VirtualBox installation, i.e.
1950	it must be previously created by <link to="#createHardDisk"/> or opened
1951	by <link to="#openMedium"/>.
1952
1953	The search is done by comparing the value of the @a location argument to
1954	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1955	attributes of each known medium.
1956
1957	On case sensitive file systems, a case sensitive comparison is performed,
1958	otherwise the case of symbols in the file path is ignored.
1959
1960	<result name="VBOX_E_OBJECT_NOT_FOUND">
1961	No medium object matching @a location found.
1962	</result>
1963	</desc>
1964	<param name="location" type="wstring" dir="in">
1965	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1966	</param>
1967	<param name="type" type="DeviceType" dir="in">
1968	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1969	</param>
1970	<param name="medium" type="IMedium" dir="return">
1971	<desc>Medium object, if found.</desc>
1972	</param>
1973	</method>
1974
1975	<method name="getGuestOSType">
1976	<desc>
1977	Returns an object describing the specified guest OS type.
1978
1979	The requested guest OS type is specified using a string which is a
1980	mnemonic identifier of the guest operating system, such as
1981	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1982	particular virtual machine can be read or set using the
1983	<link to="IMachine::OSTypeId"/> attribute.
1984
1985	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1986	available guest OS type objects. Each object has an
1987	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1988	the guest OS this object describes.
1989
1990	<result name="E_INVALIDARG">
1991	@a id is not a valid Guest OS type.
1992	</result>
1993
1994	</desc>
1995	<param name="id" type="uuid" mod="string" dir="in">
1996	<desc>Guest OS type ID string.</desc>
1997	</param>
1998	<param name="type" type="IGuestOSType" dir="return">
1999	<desc>Guest OS type object.</desc>
2000	</param>
2001	</method>
2002
2003	<method name="createSharedFolder">
2004	<desc>
2005	Creates a new global shared folder by associating the given logical
2006	name with the given host path, adds it to the collection of shared
2007	folders and starts sharing it. Refer to the description of
2008	<link to="ISharedFolder"/> to read more about logical names.
2009	<note>
2010	In the current implementation, this operation is not
2011	implemented.
2012	</note>
2013	</desc>
2014	<param name="name" type="wstring" dir="in">
2015	<desc>Unique logical name of the shared folder.</desc>
2016	</param>
2017	<param name="hostPath" type="wstring" dir="in">
2018	<desc>Full path to the shared folder in the host file system.</desc>
2019	</param>
2020	<param name="writable" type="boolean" dir="in">
2021	<desc>Whether the share is writable or readonly</desc>
2022	</param>
2023	<param name="automount" type="boolean" dir="in">
2024	<desc>Whether the share gets automatically mounted by the guest
2025	or not.</desc>
2026	</param>
2027	</method>
2028
2029	<method name="removeSharedFolder">
2030	<desc>
2031	Removes the global shared folder with the given name previously
2032	created by <link to="#createSharedFolder"/> from the collection of
2033	shared folders and stops sharing it.
2034	<note>
2035	In the current implementation, this operation is not
2036	implemented.
2037	</note>
2038	</desc>
2039	<param name="name" type="wstring" dir="in">
2040	<desc>Logical name of the shared folder to remove.</desc>
2041	</param>
2042	</method>
2043
2044	<method name="getExtraDataKeys">
2045	<desc>
2046	Returns an array representing the global extra data keys which currently
2047	have values defined.
2048	</desc>
2049	<param name="value" type="wstring" dir="return" safearray="yes">
2050	<desc>Array of extra data keys.</desc>
2051	</param>
2052	</method>
2053
2054	<method name="getExtraData">
2055	<desc>
2056	Returns associated global extra data.
2057
2058	If the requested data @a key does not exist, this function will
2059	succeed and return an empty string in the @a value argument.
2060
2061	<result name="VBOX_E_FILE_ERROR">
2062	Settings file not accessible.
2063	</result>
2064	<result name="VBOX_E_XML_ERROR">
2065	Could not parse the settings file.
2066	</result>
2067
2068	</desc>
2069	<param name="key" type="wstring" dir="in">
2070	<desc>Name of the data key to get.</desc>
2071	</param>
2072	<param name="value" type="wstring" dir="return">
2073	<desc>Value of the requested data key.</desc>
2074	</param>
2075	</method>
2076
2077	<method name="setExtraData">
2078	<desc>
2079	Sets associated global extra data.
2080
2081	If you pass @c null or empty string as a key @a value, the given @a key
2082	will be deleted.
2083
2084	<note>
2085	Before performing the actual data change, this method will ask all
2086	registered event listener using the
2087	<link to="IExtraDataCanChangeEvent"/>
2088	notification for a permission. If one of the listeners refuses the
2089	new value, the change will not be performed.
2090	</note>
2091	<note>
2092	On success, the
2093	<link to="IExtraDataChangedEvent"/> notification
2094	is called to inform all registered listeners about a successful data
2095	change.
2096	</note>
2097
2098	<result name="VBOX_E_FILE_ERROR">
2099	Settings file not accessible.
2100	</result>
2101	<result name="VBOX_E_XML_ERROR">
2102	Could not parse the settings file.
2103	</result>
2104	<result name="E_ACCESSDENIED">
2105	Modification request refused.
2106	</result>
2107
2108	</desc>
2109	<param name="key" type="wstring" dir="in">
2110	<desc>Name of the data key to set.</desc>
2111	</param>
2112	<param name="value" type="wstring" dir="in">
2113	<desc>Value to assign to the key.</desc>
2114	</param>
2115	</method>
2116
2117	<!--method name="createDHCPServerForInterface">
2118	<desc>
2119	Creates a dhcp server settings to be used for the given interface
2120	<result name="E_INVALIDARG">
2121	Host network interface @a name already exists.
2122	</result>
2123	</desc>
2124	<param name="interface" type="IHostNetworkInterface" dir="in">
2125	<desc>Network Interface</desc>
2126	</param>
2127	<param name="server" type="IDHCPServer" dir="out">
2128	<desc>Dhcp server settings</desc>
2129	</param>
2130	</method-->
2131
2132	<method name="createDHCPServer">
2133	<desc>
2134	Creates a dhcp server settings to be used for the given internal network name
2135	<result name="E_INVALIDARG">
2136	Host network interface @a name already exists.
2137	</result>
2138	</desc>
2139	<param name="name" type="wstring" dir="in">
2140	<desc>server name</desc>
2141	</param>
2142	<param name="server" type="IDHCPServer" dir="return">
2143	<desc>Dhcp server settings</desc>
2144	</param>
2145	</method>
2146
2147	<method name="findDHCPServerByNetworkName">
2148	<desc>
2149	Searches a dhcp server settings to be used for the given internal network name
2150	<result name="E_INVALIDARG">
2151	Host network interface @a name already exists.
2152	</result>
2153
2154	</desc>
2155	<param name="name" type="wstring" dir="in">
2156	<desc>server name</desc>
2157	</param>
2158	<param name="server" type="IDHCPServer" dir="return">
2159	<desc>Dhcp server settings</desc>
2160	</param>
2161	</method>
2162
2163	<!--method name="findDHCPServerForInterface">
2164	<desc>
2165	Searches a dhcp server settings to be used for the given interface
2166	<result name="E_INVALIDARG">
2167	Host network interface @a name already exists.
2168	</result>
2169	</desc>
2170	<param name="interface" type="IHostNetworkInterface" dir="in">
2171	<desc>Network Interface</desc>
2172	</param>
2173	<param name="server" type="IDHCPServer" dir="out">
2174	<desc>Dhcp server settings</desc>
2175	</param>
2176	</method-->
2177
2178	<method name="removeDHCPServer">
2179	<desc>
2180	Removes the dhcp server settings
2181	<result name="E_INVALIDARG">
2182	Host network interface @a name already exists.
2183	</result>
2184	</desc>
2185	<param name="server" type="IDHCPServer" dir="in">
2186	<desc>Dhcp server settings to be removed</desc>
2187	</param>
2188	</method>
2189
2190
2191	<method name="checkFirmwarePresent">
2192	<desc>
2193	Check if this VirtualBox installation has a firmware
2194	of the given type available, either system-wide or per-user.
2195	Optionally, this may return a hint where this firmware can be
2196	downloaded from.
2197	</desc>
2198	<param name="firmwareType" type="FirmwareType" dir="in">
2199	<desc>
2200	Type of firmware to check.
2201	</desc>
2202	</param>
2203	<param name="version" type="wstring" dir="in">
2204	<desc>Expected version number, usually empty string (presently ignored).</desc>
2205	</param>
2206
2207	<param name="url" type="wstring" dir="out">
2208	<desc>
2209	Suggested URL to download this firmware from.
2210	</desc>
2211	</param>
2212
2213	<param name="file" type="wstring" dir="out">
2214	<desc>
2215	Filename of firmware, only valid if result == TRUE.
2216	</desc>
2217	</param>
2218
2219	<param name="result" type="boolean" dir="return">
2220	<desc>If firmware of this type and version is available.</desc>
2221	</param>
2222	</method>
2223
2224	</interface>
2225
2226	<!--
2227	// IVFSExplorer
2228	/////////////////////////////////////////////////////////////////////////
2229	-->
2230
2231	<enum
2232	name="VFSType"
2233	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2234	>
2235	<desc>
2236	Virtual file systems supported by VFSExplorer.
2237	</desc>
2238
2239	<const name="File" value="1" />
2240	<const name="Cloud" value="2" />
2241	<const name="S3" value="3" />
2242	<const name="WebDav" value="4" />
2243	</enum>
2244
2245	<enum
2246	name="VFSFileType"
2247	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2248	>
2249	<desc>
2250	File types known by VFSExplorer.
2251	</desc>
2252
2253	<const name="Unknown" value="1" />
2254	<const name="Fifo" value="2" />
2255	<const name="DevChar" value="3" />
2256	<const name="Directory" value="4" />
2257	<const name="DevBlock" value="5" />
2258	<const name="File" value="6" />
2259	<const name="SymLink" value="7" />
2260	<const name="Socket" value="8" />
2261	<const name="WhiteOut" value="9" />
2262	</enum>
2263
2264	<interface
2265	name="IVFSExplorer" extends="$unknown"
2266	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2267	wsmap="managed"
2268	>
2269	<desc>
2270	The VFSExplorer interface unifies access to different file system
2271	types. This includes local file systems as well remote file systems like
2272	S3. For a list of supported types see <link to="VFSType" />.
2273	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2274	</desc>
2275
2276	<attribute name="path" type="wstring" readonly="yes">
2277	<desc>Returns the current path in the virtual file system.</desc>
2278	</attribute>
2279
2280	<attribute name="type" type="VFSType" readonly="yes">
2281	<desc>Returns the file system type which is currently in use.</desc>
2282	</attribute>
2283
2284	<method name="update">
2285	<desc>Updates the internal list of files/directories from the
2286	current directory level. Use <link to="#entryList" /> to get the full list
2287	after a call to this method.</desc>
2288
2289	<param name="aProgress" type="IProgress" dir="return">
2290	<desc>Progress object to track the operation completion.</desc>
2291	</param>
2292	</method>
2293
2294	<method name="cd">
2295	<desc>Change the current directory level.</desc>
2296
2297	<param name="aDir" type="wstring" dir="in">
2298	<desc>The name of the directory to go in.</desc>
2299	</param>
2300
2301	<param name="aProgress" type="IProgress" dir="return">
2302	<desc>Progress object to track the operation completion.</desc>
2303	</param>
2304	</method>
2305
2306	<method name="cdUp">
2307	<desc>Go one directory upwards from the current directory level.</desc>
2308
2309	<param name="aProgress" type="IProgress" dir="return">
2310	<desc>Progress object to track the operation completion.</desc>
2311	</param>
2312	</method>
2313
2314	<method name="entryList">
2315	<desc>Returns a list of files/directories after a call to <link
2316	to="#update" />. The user is responsible for keeping this internal
2317	list up do date.</desc>
2318
2319	<param name="aNames" type="wstring" safearray="yes" dir="out">
2320	<desc>The list of names for the entries.</desc>
2321	</param>
2322
2323	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2324	<desc>The list of types for the entries.</desc>
2325	</param>
2326
2327	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2328	<desc>The list of sizes (in bytes) for the entries.</desc>
2329	</param>
2330
2331	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2332	<desc>The list of file modes (in octal form) for the entries.</desc>
2333	</param>
2334	</method>
2335
2336	<method name="exists">
2337	<desc>Checks if the given file list exists in the current directory
2338	level.</desc>
2339
2340	<param name="aNames" type="wstring" safearray="yes" dir="in">
2341	<desc>The names to check.</desc>
2342	</param>
2343
2344	<param name="aExists" type="wstring" safearray="yes" dir="return">
2345	<desc>The names which exist.</desc>
2346	</param>
2347	</method>
2348
2349	<method name="remove">
2350	<desc>Deletes the given files in the current directory level.</desc>
2351
2352	<param name="aNames" type="wstring" safearray="yes" dir="in">
2353	<desc>The names to remove.</desc>
2354	</param>
2355
2356	<param name="aProgress" type="IProgress" dir="return">
2357	<desc>Progress object to track the operation completion.</desc>
2358	</param>
2359	</method>
2360
2361	</interface>
2362
2363	<enum
2364	name="ImportOptions" extends="$unknown"
2365	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2366	>
2367
2368	<desc>
2369	Import options, used with <link to="IAppliance::importMachines" />.
2370	</desc>
2371
2372	<const name="KeepAllMACs" value="1">
2373	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2374	</const>
2375	<const name="KeepNATMACs" value="2">
2376	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2377	</const>
2378
2379	</enum>
2380
2381
2382	<!--
2383	// IAppliance
2384	/////////////////////////////////////////////////////////////////////////
2385	-->
2386
2387	<interface
2388	name="IAppliance" extends="$unknown"
2389	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2390	wsmap="managed"
2391	>
2392	<desc>
2393	Represents a platform-independent appliance in OVF format. An instance of this is returned
2394	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2395	virtual machines within an appliance with VirtualBox.
2396
2397	The OVF standard suggests two different physical file formats:
2398
2399	<ol>
2400	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2401	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2402	this descriptor file references other files such as disk images, as OVF appliances typically
2403	do, those additional files must be in the same directory as the descriptor file.</li>
2404
2405	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2406	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2407	files and optionally other files.
2408
2409	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2410	be added with a later version.</li>
2411	</ol>
2412
2413	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2414	<link to="IMachine" /> involves the following sequence of API calls:
2415
2416	<ol>
2417	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2418	</li>
2419
2420	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2421	would like to import. So long as this file is syntactically valid, this will succeed
2422	and fill the appliance object with the parsed data from the OVF file.
2423	</li>
2424
2425	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2426	contents of the IAppliance attributes accordingly. These can be inspected by a
2427	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2428	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2429	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2430	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2431	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2432	The GUI can then give the user the option to confirm and/or change these suggestions.
2433	</li>
2434
2435	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2436	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2437	</li>
2438
2439	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2440	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2441	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2442	can be found in the <link to="#machines" /> array attribute.
2443	</li>
2444	</ol>
2445
2446	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2447
2448	<ol>
2449	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2450	an empty IAppliance object.
2451	</li>
2452
2453	<li>For each machine you would like to export, call <link to="IMachine::export" />
2454	with the IAppliance object you just created. Each such call creates one instance of
2455	<link to="IVirtualSystemDescription" /> inside the appliance.
2456	</li>
2457
2458	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2459	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2460	</li>
2461
2462	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2463	file written.</li>
2464	</ol>
2465
2466	</desc>
2467
2468	<attribute name="path" type="wstring" readonly="yes">
2469	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2470	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2471	<link to="#write" /> (for export).
2472	This attribute is empty until one of these methods has been called.
2473	</desc>
2474	</attribute>
2475
2476	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2477	<desc>
2478	Array of virtual disk definitions. One such description exists for each
2479	disk definition in the OVF; each string array item represents one such piece of
2480	disk information, with the information fields separated by tab (\\t) characters.
2481
2482	The caller should be prepared for additional fields being appended to
2483	this string in future versions of VirtualBox and therefore check for
2484	the number of tabs in the strings returned.
2485
2486	In the current version, the following eight fields are returned per string
2487	in the array:
2488
2489	<ol>
2490	<li>Disk ID (unique string identifier given to disk)</li>
2491
2492	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2493
2494	<li>Populated size (optional unsigned integer indicating the current size of the
2495	disk; can be approximate; -1 if unspecified)</li>
2496
2497	<li>Format (string identifying the disk format, typically
2498	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2499
2500	<li>Reference (where to find the disk image, typically a file name; if empty,
2501	then the disk should be created on import)</li>
2502
2503	<li>Image size (optional unsigned integer indicating the size of the image,
2504	which need not necessarily be the same as the values specified above, since
2505	the image may be compressed or sparse; -1 if not specified)</li>
2506
2507	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2508	presently unsupported and always -1)</li>
2509
2510	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2511	</ol>
2512	</desc>
2513	</attribute>
2514
2515	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2516	<desc> Array of virtual system descriptions. One such description is created
2517	for each virtual system (machine) found in the OVF.
2518	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2519	(for export) has been called.
2520	</desc>
2521	</attribute>
2522
2523	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2524	<desc>
2525	Contains the UUIDs of the machines created from the information in this appliances. This is only
2526	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2527	succeeded.
2528	</desc>
2529	</attribute>
2530
2531	<method name="read">
2532	<desc>
2533	Reads an OVF file into the appliance object.
2534
2535	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2536	mere fact that this method returns successfully does not mean that VirtualBox supports all
2537	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2538	</desc>
2539	<param name="file" type="wstring" dir="in">
2540	<desc>
2541	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2542	on whether the appliance is distributed as a set of files or as a single file, respectively).
2543	</desc>
2544	</param>
2545	<param name="aProgress" type="IProgress" dir="return">
2546	<desc>Progress object to track the operation completion.</desc>
2547	</param>
2548	</method>
2549
2550	<method name="interpret">
2551	<desc>
2552	Interprets the OVF data that was read when the appliance was constructed. After
2553	calling this method, one can inspect the
2554	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2555	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2556	the appliance.
2557
2558	Calling this method is the second step of importing an appliance into VirtualBox;
2559	see <link to="IAppliance" /> for an overview.
2560
2561	After calling this method, one should call <link to="#getWarnings" /> to find out
2562	if problems were encountered during the processing which might later lead to
2563	errors.
2564	</desc>
2565	</method>
2566
2567	<method name="importMachines">
2568	<desc>
2569	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2570	and other interfaces that match the information contained in the appliance as
2571	closely as possible, as represented by the import instructions in the
2572	<link to="#virtualSystemDescriptions" /> array.
2573
2574	Calling this method is the final step of importing an appliance into VirtualBox;
2575	see <link to="IAppliance" /> for an overview.
2576
2577	Since importing the appliance will most probably involve copying and converting
2578	disk images, which can take a long time, this method operates asynchronously and
2579	returns an IProgress object to allow the caller to monitor the progress.
2580
2581	After the import succeeded, the UUIDs of the IMachine instances created can be
2582	retrieved from the <link to="#machines" /> array attribute.
2583	</desc>
2584
2585	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2586	<desc>Options for the importing operation.</desc>
2587	</param>
2588
2589	<param name="aProgress" type="IProgress" dir="return">
2590	<desc>Progress object to track the operation completion.</desc>
2591	</param>
2592	</method>
2593
2594	<method name="createVFSExplorer">
2595	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2596
2597	<param name="aUri" type="wstring" dir="in">
2598	<desc>The URI describing the file system to use.</desc>
2599	</param>
2600
2601	<param name="aExplorer" type="IVFSExplorer" dir="return">
2602	<desc></desc>
2603	</param>
2604	</method>
2605
2606	<method name="write">
2607	<desc>
2608	Writes the contents of the appliance exports into a new OVF file.
2609
2610	Calling this method is the final step of exporting an appliance from VirtualBox;
2611	see <link to="IAppliance" /> for an overview.
2612
2613	Since exporting the appliance will most probably involve copying and converting
2614	disk images, which can take a long time, this method operates asynchronously and
2615	returns an IProgress object to allow the caller to monitor the progress.
2616	</desc>
2617	<param name="format" type="wstring" dir="in">
2618	<desc>
2619	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2620	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2621	</desc>
2622	</param>
2623	<param name="manifest" type="boolean" dir="in">
2624	<desc>
2625	Indicate if the optional manifest file (.mf) should be written. The manifest file
2626	is used for integrity checks prior import.
2627	</desc>
2628	</param>
2629	<param name="path" type="wstring" dir="in">
2630	<desc>
2631	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2632	on whether the appliance is distributed as a set of files or as a single file, respectively).
2633	</desc>
2634	</param>
2635	<param name="progress" type="IProgress" dir="return">
2636	<desc>Progress object to track the operation completion.</desc>
2637	</param>
2638	</method>
2639
2640	<method name="getWarnings">
2641	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2642
2643	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2644	<desc></desc>
2645	</param>
2646	</method>
2647
2648	</interface>
2649
2650	<enum
2651	name="VirtualSystemDescriptionType"
2652	uuid="303c0900-a746-4612-8c67-79003e91f459"
2653	>
2654	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2655	a configuration value.</desc>
2656
2657	<const name="Ignore" value="1" />
2658	<const name="OS" value="2" />
2659	<const name="Name" value="3" />
2660	<const name="Product" value="4" />
2661	<const name="Vendor" value="5" />
2662	<const name="Version" value="6" />
2663	<const name="ProductUrl" value="7" />
2664	<const name="VendorUrl" value="8" />
2665	<const name="Description" value="9" />
2666	<const name="License" value="10" />
2667	<const name="Miscellaneous" value="11" />
2668	<const name="CPU" value="12" />
2669	<const name="Memory" value="13" />
2670	<const name="HardDiskControllerIDE" value="14" />
2671	<const name="HardDiskControllerSATA" value="15" />
2672	<const name="HardDiskControllerSCSI" value="16" />
2673	<const name="HardDiskControllerSAS" value="17" />
2674	<const name="HardDiskImage" value="18" />
2675	<const name="Floppy" value="19" />
2676	<const name="CDROM" value="20" />
2677	<const name="NetworkAdapter" value="21" />
2678	<const name="USBController" value="22" />
2679	<const name="SoundCard" value="23" />
2680	<const name="SettingsFile" value="24">
2681	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2682	</const>
2683	</enum>
2684
2685	<enum
2686	name="VirtualSystemDescriptionValueType"
2687	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2688	>
2689	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2690	type to fetch.</desc>
2691
2692	<const name="Reference" value="1" />
2693	<const name="Original" value="2" />
2694	<const name="Auto" value="3" />
2695	<const name="ExtraConfig" value="4" />
2696
2697	</enum>
2698
2699	<interface
2700	name="IVirtualSystemDescription" extends="$unknown"
2701	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2702	wsmap="managed"
2703	>
2704
2705	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2706	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2707	<link to="IAppliance::interpret" /> has been called, that array contains information
2708	about how the virtual systems described in the OVF should best be imported into
2709	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2710	import an OVF into VirtualBox.
2711	</desc>
2712
2713	<attribute name="count" type="unsigned long" readonly="yes">
2714	<desc>Return the number of virtual system description entries.</desc>
2715	</attribute>
2716
2717	<method name="getDescription">
2718	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2719	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2720
2721	The list below identifies the value sets that are possible depending on the
2722	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2723	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2724	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2725	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2726	the @a aExtraConfigValues[] array item may also be used.
2727
2728	<ul>
2729	<li>
2730	"OS": the guest operating system type. There must be exactly one such array item on import. The
2731	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2732	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2733	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2734	</li>
2735	<li>
2736	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2737	if none is present on import, then an automatic name will be created from the operating system
2738	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2739	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2740	<link to="IMachine" /> name that does not exist yet.
2741	</li>
2742	<li>
2743	"Description": an arbitrary description.
2744	</li>
2745	<li>
2746	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2747	code to display such a license for agreement; the Main API does not enforce any such policy.
2748	</li>
2749	<li>
2750	Miscellaneous: reserved for future use.
2751	</li>
2752	<li>
2753	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2754	</li>
2755	<li>
2756	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2757	is present on import, then VirtualBox will set a meaningful default based on the operating system
2758	type.
2759	</li>
2760	<li>
2761	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2762	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2763	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2764	writes into the OVF.
2765	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2766	type can use to specify which hard disk controller a virtual disk should be connected to.
2767	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2768	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2769	its virtual machines supports four channels (primary master, primary slave, secondary master,
2770	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2771	</li>
2772	<li>
2773	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2774	has no value in @a aOvfValues[] or @a aVBoxValues[].
2775	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2776	</li>
2777	<li>
2778	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2779	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2780	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2781	whereas VirtualBox considers it a class of storage controllers of its own; see
2782	<link to="StorageControllerType" />).
2783	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2784	</li>
2785	<li>
2786	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2787	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2788
2789	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2790	a path since the image file should be in the same location as the OVF file itself), whereas the
2791	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2792	hard disk image. This means that on import the image will be copied and converted from the
2793	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2794
2795	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2796	format: "controller=<index>;channel=<c>"
2797	In this string, <index> must be an integer specifying the hard disk controller to connect
2798	the image to. That number must be the index of an array item with one of the hard disk controller
2799	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2800	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2801	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2802	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2803	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2804	</li>
2805	<li>
2806	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2807	attachment information as with "HardDiskImage" items.
2808	</li>
2809	<li>
2810	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2811	attachment information as with "HardDiskImage" items.
2812	</li>
2813	<li>
2814	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2815	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2816	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2817	</li>
2818	<li>
2819	"USBController": a USB controller. There can be at most one such item. If and only if such an
2820	item ispresent, USB support will be enabled for the new virtual machine.
2821	</li>
2822	<li>
2823	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2824	present, sound support will be enabled for the new virtual machine. Note that the virtual
2825	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2826	may be different from the virtual soundcard expected by the appliance.
2827	</li>
2828	</ul>
2829
2830	</desc>
2831
2832	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2833	<desc></desc>
2834	</param>
2835
2836	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2837	<desc></desc>
2838	</param>
2839
2840	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2841	<desc></desc>
2842	</param>
2843
2844	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2845	<desc></desc>
2846	</param>
2847
2848	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2849	<desc></desc>
2850	</param>
2851
2852	</method>
2853
2854	<method name="getDescriptionByType">
2855	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2856	should be returned.</desc>
2857
2858	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2871	<desc></desc>
2872	</param>
2873
2874	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2875	<desc></desc>
2876	</param>
2877
2878	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2879	<desc></desc>
2880	</param>
2881
2882	</method>
2883
2884	<method name="getValuesByType">
2885	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2886	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2887	values.</desc>
2888
2889	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2890	<desc></desc>
2891	</param>
2892
2893	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2894	<desc></desc>
2895	</param>
2896
2897	<param name="aValues" type="wstring" dir="return" safearray="yes">
2898	<desc></desc>
2899	</param>
2900
2901	</method>
2902
2903	<method name="setFinalValues">
2904	<desc>
2905	This method allows the appliance's user to change the configuration for the virtual
2906	system descriptions. For each array item returned from <link to="#getDescription" />,
2907	you must pass in one boolean value and one configuration value.
2908
2909	Each item in the boolean array determines whether the particular configuration item
2910	should be enabled.
2911	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2912	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2913	and SoundCard.
2914
2915	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2916	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2917	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2918	for valid configuration values for the individual array item types. If the
2919	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2920	</desc>
2921
2922	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2923	<desc></desc>
2924	</param>
2925
2926	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2927	<desc></desc>
2928	</param>
2929
2930	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2931	<desc></desc>
2932	</param>
2933	</method>
2934
2935	<method name="addDescription">
2936	<desc>
2937	This method adds an additional description entry to the stack of already
2938	available descriptions for this virtual system. This is handy for writing
2939	values which aren't directly supported by VirtualBox. One example would
2940	be the License type of <link to="VirtualSystemDescriptionType" />.
2941	</desc>
2942
2943	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2944	<desc></desc>
2945	</param>
2946
2947	<param name="aVBoxValue" type="wstring" dir="in">
2948	<desc></desc>
2949	</param>
2950
2951	<param name="aExtraConfigValue" type="wstring" dir="in">
2952	<desc></desc>
2953	</param>
2954	</method>
2955	</interface>
2956
2957
2958	<!--
2959	// IMachine
2960	/////////////////////////////////////////////////////////////////////////
2961	-->
2962
2963	<interface
2964	name="IInternalMachineControl" extends="$unknown"
2965	uuid="2087906d-bb92-43a0-8014-4cab009e4888"
2966	internal="yes"
2967	wsmap="suppress"
2968	>
2969	<method name="setRemoveSavedStateFile">
2970	<desc>
2971	Updates the flag whether the saved state file is removed on a
2972	machine state change from Saved to PoweredOff.
2973	</desc>
2974	<param name="aRemove" type="boolean" dir="in"/>
2975	</method>
2976
2977	<method name="updateState">
2978	<desc>
2979	Updates the VM state.
2980	<note>
2981	This operation will also update the settings file with the correct
2982	information about the saved state file and delete this file from disk
2983	when appropriate.
2984	</note>
2985	</desc>
2986	<param name="state" type="MachineState" dir="in"/>
2987	</method>
2988
2989	<method name="getIPCId">
2990	<param name="id" type="wstring" dir="return"/>
2991	</method>
2992
2993	<method name="beginPowerUp">
2994	<desc>
2995	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2996	gives it the progress object that should be part of any pending
2997	<link to="IMachine::launchVMProcess"/> operations. The progress
2998	object may be called back to reflect an early cancelation, so some care
2999	have to be taken with respect to any cancelation callbacks. The console
3000	object will call <link to="IInternalMachineControl::endPowerUp"/>
3001	to signal the completion of the progress object.
3002	</desc>
3003	<param name="aProgress" type="IProgress" dir="in" />
3004	</method>
3005
3006	<method name="endPowerUp">
3007	<desc>
3008	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3009	This method may query status information from the progress object it
3010	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3011	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3012	call in order to complete that progress object.
3013	</desc>
3014	<param name="result" type="long" dir="in"/>
3015	</method>
3016
3017	<method name="beginPoweringDown">
3018	<desc>
3019	Called by the VM process to inform the server it wants to
3020	stop the VM execution and power down.
3021	</desc>
3022	<param name="progress" type="IProgress" dir="out">
3023	<desc>
3024	Progress object created by VBoxSVC to wait until
3025	the VM is powered down.
3026	</desc>
3027	</param>
3028	</method>
3029
3030	<method name="endPoweringDown">
3031	<desc>
3032	Called by the VM process to inform the server that powering
3033	down previously requested by #beginPoweringDown is either
3034	successfully finished or there was a failure.
3035
3036	<result name="VBOX_E_FILE_ERROR">
3037	Settings file not accessible.
3038	</result>
3039	<result name="VBOX_E_XML_ERROR">
3040	Could not parse the settings file.
3041	</result>
3042
3043	</desc>
3044
3045	<param name="result" type="long" dir="in">
3046	<desc>@c S_OK to indicate success.
3047	</desc>
3048	</param>
3049	<param name="errMsg" type="wstring" dir="in">
3050	<desc>@c human readable error message in case of failure.
3051	</desc>
3052	</param>
3053	</method>
3054
3055	<method name="runUSBDeviceFilters">
3056	<desc>
3057	Asks the server to run USB devices filters of the associated
3058	machine against the given USB device and tell if there is
3059	a match.
3060	<note>
3061	Intended to be used only for remote USB devices. Local
3062	ones don't require to call this method (this is done
3063	implicitly by the Host and USBProxyService).
3064	</note>
3065	</desc>
3066	<param name="device" type="IUSBDevice" dir="in"/>
3067	<param name="matched" type="boolean" dir="out"/>
3068	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3069	</method>
3070
3071	<method name="captureUSBDevice">
3072	<desc>
3073	Requests a capture of the given host USB device.
3074	When the request is completed, the VM process will
3075	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3076	notification.
3077	</desc>
3078	<param name="id" type="uuid" mod="string" dir="in"/>
3079	</method>
3080
3081	<method name="detachUSBDevice">
3082	<desc>
3083	Notification that a VM is going to detach (@a done = @c false) or has
3084	already detached (@a done = @c true) the given USB device.
3085	When the @a done = @c true request is completed, the VM process will
3086	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3087	notification.
3088	<note>
3089	In the @a done = @c true case, the server must run its own filters
3090	and filters of all VMs but this one on the detached device
3091	as if it were just attached to the host computer.
3092	</note>
3093	</desc>
3094	<param name="id" type="uuid" mod="string" dir="in"/>
3095	<param name="done" type="boolean" dir="in"/>
3096	</method>
3097
3098	<method name="autoCaptureUSBDevices">
3099	<desc>
3100	Requests a capture all matching USB devices attached to the host.
3101	When the request is completed, the VM process will
3102	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3103	notification per every captured device.
3104	</desc>
3105	</method>
3106
3107	<method name="detachAllUSBDevices">
3108	<desc>
3109	Notification that a VM that is being powered down. The done
3110	parameter indicates whether which stage of the power down
3111	we're at. When @a done = @c false the VM is announcing its
3112	intentions, while when @a done = @c true the VM is reporting
3113	what it has done.
3114	<note>
3115	In the @a done = @c true case, the server must run its own filters
3116	and filters of all VMs but this one on all detach devices as
3117	if they were just attached to the host computer.
3118	</note>
3119	</desc>
3120	<param name="done" type="boolean" dir="in"/>
3121	</method>
3122
3123	<method name="onSessionEnd">
3124	<desc>
3125	Triggered by the given session object when the session is about
3126	to close normally.
3127	</desc>
3128	<param name="session" type="ISession" dir="in">
3129	<desc>Session that is being closed</desc>
3130	</param>
3131	<param name="progress" type="IProgress" dir="return">
3132	<desc>
3133	Used to wait until the corresponding machine is actually
3134	dissociated from the given session on the server.
3135	Returned only when this session is a direct one.
3136	</desc>
3137	</param>
3138	</method>
3139
3140	<method name="beginSavingState">
3141	<desc>
3142	Called by the VM process to inform the server it wants to
3143	save the current state and stop the VM execution.
3144	</desc>
3145	<param name="progress" type="IProgress" dir="out">
3146	<desc>
3147	Progress object created by VBoxSVC to wait until
3148	the state is saved.
3149	</desc>
3150	</param>
3151	<param name="stateFilePath" type="wstring" dir="out">
3152	<desc>
3153	File path the VM process must save the execution state to.
3154	</desc>
3155	</param>
3156	</method>
3157
3158	<method name="endSavingState">
3159	<desc>
3160	Called by the VM process to inform the server that saving
3161	the state previously requested by #beginSavingState is either
3162	successfully finished or there was a failure.
3163
3164	<result name="VBOX_E_FILE_ERROR">
3165	Settings file not accessible.
3166	</result>
3167	<result name="VBOX_E_XML_ERROR">
3168	Could not parse the settings file.
3169	</result>
3170
3171	</desc>
3172
3173	<param name="result" type="long" dir="in">
3174	<desc>@c S_OK to indicate success.
3175	</desc>
3176	</param>
3177	<param name="errMsg" type="wstring" dir="in">
3178	<desc>@c human readable error message in case of failure.
3179	</desc>
3180	</param>
3181	</method>
3182
3183	<method name="adoptSavedState">
3184	<desc>
3185	Gets called by <link to="IConsole::adoptSavedState"/>.
3186	<result name="VBOX_E_FILE_ERROR">
3187	Invalid saved state file path.
3188	</result>
3189	</desc>
3190	<param name="savedStateFile" type="wstring" dir="in">
3191	<desc>Path to the saved state file to adopt.</desc>
3192	</param>
3193	</method>
3194
3195	<method name="beginTakingSnapshot">
3196	<desc>
3197	Called from the VM process to request from the server to perform the
3198	server-side actions of creating a snapshot (creating differencing images
3199	and the snapshot object).
3200
3201	<result name="VBOX_E_FILE_ERROR">
3202	Settings file not accessible.
3203	</result>
3204	<result name="VBOX_E_XML_ERROR">
3205	Could not parse the settings file.
3206	</result>
3207	</desc>
3208	<param name="initiator" type="IConsole" dir="in">
3209	<desc>The console object that initiated this call.</desc>
3210	</param>
3211	<param name="name" type="wstring" dir="in">
3212	<desc>Snapshot name.</desc>
3213	</param>
3214	<param name="description" type="wstring" dir="in">
3215	<desc>Snapshot description.</desc>
3216	</param>
3217	<param name="consoleProgress" type="IProgress" dir="in">
3218	<desc>
3219	Progress object created by the VM process tracking the
3220	snapshot's progress. This has the following sub-operations:
3221	<ul>
3222	<li>setting up (weight 1);</li>
3223	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3224	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3225	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3226	<li>finishing up (weight 1)</li>
3227	</ul>
3228	</desc>
3229	</param>
3230	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3231	<desc>
3232	Whether this is an online snapshot (i.e. the machine is running).
3233	</desc>
3234	</param>
3235	<param name="stateFilePath" type="wstring" dir="out">
3236	<desc>
3237	File path the VM process must save the execution state to.
3238	</desc>
3239	</param>
3240	</method>
3241
3242	<method name="endTakingSnapshot">
3243	<desc>
3244	Called by the VM process to inform the server that the snapshot
3245	previously requested by #beginTakingSnapshot is either
3246	successfully taken or there was a failure.
3247	</desc>
3248
3249	<param name="success" type="boolean" dir="in">
3250	<desc>@c true to indicate success and @c false otherwise</desc>
3251	</param>
3252	</method>
3253
3254	<method name="deleteSnapshot">
3255	<desc>
3256	Gets called by <link to="IConsole::deleteSnapshot"/>,
3257	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3258	<link to="IConsole::deleteSnapshotRange"/>.
3259	<result name="VBOX_E_INVALID_OBJECT_STATE">
3260	Snapshot has more than one child snapshot. Only possible if the
3261	delete operation does not delete all children or the range does
3262	not meet the linearity condition.
3263	</result>
3264	</desc>
3265	<param name="initiator" type="IConsole" dir="in">
3266	<desc>The console object that initiated this call.</desc>
3267	</param>
3268	<param name="startId" type="uuid" mod="string" dir="in">
3269	<desc>UUID of the first snapshot to delete.</desc>
3270	</param>
3271	<param name="endId" type="uuid" mod="string" dir="in">
3272	<desc>UUID of the last snapshot to delete.</desc>
3273	</param>
3274	<param name="deleteAllChildren" type="boolean" dir="in">
3275	<desc>Whether all children should be deleted.</desc>
3276	</param>
3277	<param name="machineState" type="MachineState" dir="out">
3278	<desc>New machine state after this operation is started.</desc>
3279	</param>
3280	<param name="progress" type="IProgress" dir="return">
3281	<desc>Progress object to track the operation completion.</desc>
3282	</param>
3283	</method>
3284
3285	<method name="finishOnlineMergeMedium">
3286	<desc>
3287	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3288	</desc>
3289	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3290	<desc>The medium attachment which needs to be cleaned up.</desc>
3291	</param>
3292	<param name="source" type="IMedium" dir="in">
3293	<desc>Merge source medium.</desc>
3294	</param>
3295	<param name="target" type="IMedium" dir="in">
3296	<desc>Merge target medium.</desc>
3297	</param>
3298	<param name="mergeForward" type="boolean" dir="in">
3299	<desc>Merge direction.</desc>
3300	</param>
3301	<param name="parentForTarget" type="IMedium" dir="in">
3302	<desc>For forward merges: new parent for target medium.</desc>
3303	</param>
3304	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3305	<desc>For backward merges: list of media which need their parent UUID
3306	updated.</desc>
3307	</param>
3308	</method>
3309
3310	<method name="restoreSnapshot">
3311	<desc>
3312	Gets called by <link to="IConsole::restoreSnapshot"/>.
3313	</desc>
3314	<param name="initiator" type="IConsole" dir="in">
3315	<desc>The console object that initiated this call.</desc>
3316	</param>
3317	<param name="snapshot" type="ISnapshot" dir="in">
3318	<desc>The snapshot to restore the VM state from.</desc>
3319	</param>
3320	<param name="machineState" type="MachineState" dir="out">
3321	<desc>New machine state after this operation is started.</desc>
3322	</param>
3323	<param name="progress" type="IProgress" dir="return">
3324	<desc>Progress object to track the operation completion.</desc>
3325	</param>
3326	</method>
3327
3328	<method name="pullGuestProperties">
3329	<desc>
3330	Get the list of the guest properties matching a set of patterns along
3331	with their values, time stamps and flags and give responsibility for
3332	managing properties to the console.
3333	</desc>
3334	<param name="name" type="wstring" dir="out" safearray="yes">
3335	<desc>
3336	The names of the properties returned.
3337	</desc>
3338	</param>
3339	<param name="value" type="wstring" dir="out" safearray="yes">
3340	<desc>
3341	The values of the properties returned. The array entries match the
3342	corresponding entries in the @a name array.
3343	</desc>
3344	</param>
3345	<param name="timestamp" type="long long" dir="out" safearray="yes">
3346	<desc>
3347	The time stamps of the properties returned. The array entries match
3348	the corresponding entries in the @a name array.
3349	</desc>
3350	</param>
3351	<param name="flags" type="wstring" dir="out" safearray="yes">
3352	<desc>
3353	The flags of the properties returned. The array entries match the
3354	corresponding entries in the @a name array.
3355	</desc>
3356	</param>
3357	</method>
3358
3359	<method name="pushGuestProperty">
3360	<desc>
3361	Update a single guest property in IMachine.
3362	</desc>
3363	<param name="name" type="wstring" dir="in">
3364	<desc>
3365	The name of the property to be updated.
3366	</desc>
3367	</param>
3368	<param name="value" type="wstring" dir="in">
3369	<desc>
3370	The value of the property.
3371	</desc>
3372	</param>
3373	<param name="timestamp" type="long long" dir="in">
3374	<desc>
3375	The timestamp of the property.
3376	</desc>
3377	</param>
3378	<param name="flags" type="wstring" dir="in">
3379	<desc>
3380	The flags of the property.
3381	</desc>
3382	</param>
3383	</method>
3384
3385	<method name="lockMedia">
3386	<desc>
3387	Locks all media attached to the machine for writing and parents of
3388	attached differencing media (if any) for reading. This operation is
3389	atomic so that if it fails no media is actually locked.
3390
3391	This method is intended to be called when the machine is in Starting or
3392	Restoring state. The locked media will be automatically unlocked when
3393	the machine is powered off or crashed.
3394	</desc>
3395	</method>
3396	<method name="unlockMedia">
3397	<desc>
3398	Unlocks all media previously locked using
3399	<link to="IInternalMachineControl::lockMedia"/>.
3400
3401	This method is intended to be used with teleportation so that it is
3402	possible to teleport between processes on the same machine.
3403	</desc>
3404	</method>
3405
3406	<method name="ejectMedium">
3407	<desc>
3408	Tells VBoxSVC that the guest has ejected the medium associated with
3409	the medium attachment.
3410	</desc>
3411	<param name="attachment" type="IMediumAttachment" dir="in">
3412	<desc>
3413	The medium attachment where the eject happened.
3414	</desc>
3415	</param>
3416	<param name="newAttachment" type="IMediumAttachment" dir="return">
3417	<desc>
3418	A new reference to the medium attachment, as the config change can
3419	result in the creation of a new instance.
3420	</desc>
3421	</param>
3422	</method>
3423
3424	<method name="reportGuestStatistics">
3425	<desc>
3426	Passes collected guest statistics to VBoxSVC.
3427	</desc>
3428	<param name="validStats" type="unsigned long" dir="in">
3429	<desc>
3430	Mask defining which parameters are valid. For example: 0x11 means
3431	that cpuIdle and XXX are valid. Other parameters should be ignored.
3432	</desc>
3433	</param>
3434	<param name="cpuUser" type="unsigned long" dir="in">
3435	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3436	</param>
3437	<param name="cpuKernel" type="unsigned long" dir="in">
3438	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3439	</param>
3440	<param name="cpuIdle" type="unsigned long" dir="in">
3441	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3442	</param>
3443	<param name="memTotal" type="unsigned long" dir="in">
3444	<desc>Total amount of physical guest RAM.</desc>
3445	</param>
3446	<param name="memFree" type="unsigned long" dir="in">
3447	<desc>Free amount of physical guest RAM.</desc>
3448	</param>
3449	<param name="memBalloon" type="unsigned long" dir="in">
3450	<desc>Amount of ballooned physical guest RAM.</desc>
3451	</param>
3452	<param name="memShared" type="unsigned long" dir="in">
3453	<desc>Amount of shared physical guest RAM.</desc>
3454	</param>
3455	<param name="memCache" type="unsigned long" dir="in">
3456	<desc>Total amount of guest (disk) cache memory.</desc>
3457	</param>
3458	<param name="pagedTotal" type="unsigned long" dir="in">
3459	<desc>Total amount of space in the page file.</desc>
3460	</param>
3461	<param name="memAllocTotal" type="unsigned long" dir="in">
3462	<desc>Total amount of memory allocated by the hypervisor.</desc>
3463	</param>
3464	<param name="memFreeTotal" type="unsigned long" dir="in">
3465	<desc>Total amount of free memory available in the hypervisor.</desc>
3466	</param>
3467	<param name="memBalloonTotal" type="unsigned long" dir="in">
3468	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3469	</param>
3470	<param name="memSharedTotal" type="unsigned long" dir="in">
3471	<desc>Total amount of shared memory in the hypervisor.</desc>
3472	</param>
3473	</method>
3474	</interface>
3475
3476	<interface
3477	name="IBIOSSettings" extends="$unknown"
3478	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3479	wsmap="managed"
3480	>
3481	<desc>
3482	The IBIOSSettings interface represents BIOS settings of the virtual
3483	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3484	</desc>
3485	<attribute name="logoFadeIn" type="boolean">
3486	<desc>Fade in flag for BIOS logo animation.</desc>
3487	</attribute>
3488
3489	<attribute name="logoFadeOut" type="boolean">
3490	<desc>Fade out flag for BIOS logo animation.</desc>
3491	</attribute>
3492
3493	<attribute name="logoDisplayTime" type="unsigned long">
3494	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3495	</attribute>
3496
3497	<attribute name="logoImagePath" type="wstring">
3498	<desc>
3499	Local file system path for external BIOS splash image. Empty string
3500	means the default image is shown on boot.
3501	</desc>
3502	</attribute>
3503
3504	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3505	<desc>Mode of the BIOS boot device menu.</desc>
3506	</attribute>
3507
3508	<attribute name="ACPIEnabled" type="boolean">
3509	<desc>ACPI support flag.</desc>
3510	</attribute>
3511
3512	<attribute name="IOAPICEnabled" type="boolean">
3513	<desc>
3514	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3515	and support IRQs above 15.
3516	</desc>
3517	</attribute>
3518
3519	<attribute name="timeOffset" type="long long">
3520	<desc>
3521	Offset in milliseconds from the host system time. This allows for
3522	guests running with a different system date/time than the host.
3523	It is equivalent to setting the system date/time in the BIOS except
3524	it is not an absolute value but a relative one. Guest Additions
3525	time synchronization honors this offset.
3526	</desc>
3527	</attribute>
3528
3529	<attribute name="PXEDebugEnabled" type="boolean">
3530	<desc>
3531	PXE debug logging flag. If set, VirtualBox will write extensive
3532	PXE trace information to the release log.
3533	</desc>
3534	</attribute>
3535
3536	</interface>
3537
3538	<enum
3539	name="CleanupMode"
3540	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3541	>
3542	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3543	</desc>
3544	<const name="UnregisterOnly" value="1">
3545	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3546	</const>
3547	<const name="DetachAllReturnNone" value="2">
3548	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3549	</const>
3550	<const name="DetachAllReturnHardDisksOnly" value="3">
3551	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3552	</const>
3553	<const name="Full" value="4">
3554	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3555	</const>
3556	</enum>
3557
3558	<interface
3559	name="IPciAddress" extends="$unknown"
3560	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3561	wsmap="struct"
3562	>
3563
3564	<desc>
3565	Address on the PCI bus.
3566	</desc>
3567
3568	<attribute name="bus" type="short">
3569	<desc>
3570	Bus number.
3571	</desc>
3572	</attribute>
3573
3574	<attribute name="device" type="short">
3575	<desc>
3576	Device number.
3577	</desc>
3578	</attribute>
3579
3580	<attribute name="devFunction" type="short">
3581	<desc>
3582	Device function number.
3583	</desc>
3584	</attribute>
3585
3586	<method name="asLong">
3587	<desc>
3588	Convert PCI address into long.
3589	</desc>
3590	<param name="result" type="long" dir="return" />
3591	</method>
3592
3593	<method name="fromLong">
3594	<desc>
3595	Make PCI address from long.
3596	</desc>
3597	<param name="number" type="long" dir="in" />
3598	</method>
3599	</interface>
3600
3601	<interface
3602	name="IPciDeviceAttachment" extends="$unknown"
3603	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3604	wsmap="struct"
3605	>
3606
3607	<desc>
3608	Information about PCI attachments.
3609	</desc>
3610
3611	<attribute name="name" type="wstring" readonly="yes">
3612	<desc>
3613	Device name.
3614	</desc>
3615	</attribute>
3616
3617	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3618	<desc>
3619	If this is physical or virtual device.
3620	</desc>
3621	</attribute>
3622
3623	<attribute name="hostAddress" type="long" readonly="yes">
3624	<desc>
3625	Address of device on the host, applicable only to host devices.
3626	</desc>
3627	</attribute>
3628
3629	<attribute name="guestAddress" type="long" readonly="yes">
3630	<desc>
3631	Address of device on the guest.
3632	</desc>
3633	</attribute>
3634
3635	</interface>
3636
3637	<enum
3638	name="CloneMode" extends="$unknown"
3639	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3640	>
3641
3642	<desc>
3643	Clone mode, used with <link to="IMachine::cloneTo" />.
3644	</desc>
3645
3646	<const name="MachineState" value="1">
3647	<desc>Clone the state of the selected machine.</desc>
3648	</const>
3649	<const name="MachineAndChildStates" value="2">
3650	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3651	</const>
3652	<const name="AllStates" value="3">
3653	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3654	</const>
3655
3656	</enum>
3657
3658	<enum
3659	name="CloneOptions" extends="$unknown"
3660	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3661	>
3662
3663	<desc>
3664	Clone options, used with <link to="IMachine::cloneTo" />.
3665	</desc>
3666
3667	<const name="Link" value="1">
3668	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3669	</const>
3670	<const name="KeepAllMACs" value="2">
3671	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3672	</const>
3673	<const name="KeepNATMACs" value="3">
3674	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3675	</const>
3676	<const name="KeepDiskNames" value="4">
3677	<desc>Don't change the disk names.</desc>
3678	</const>
3679
3680	</enum>
3681
3682
3683	<interface
3684	name="IMachine" extends="$unknown"
3685	uuid="116704af-f221-4d9e-8697-c11331622907"
3686	wsmap="managed"
3687	>
3688	<desc>
3689	The IMachine interface represents a virtual machine, or guest, created
3690	in VirtualBox.
3691
3692	This interface is used in two contexts. First of all, a collection of
3693	objects implementing this interface is stored in the
3694	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3695	machines that are currently registered with this VirtualBox
3696	installation. Also, once a session has been opened for the given virtual
3697	machine (e.g. the virtual machine is running), the machine object
3698	associated with the open session can be queried from the session object;
3699	see <link to="ISession"/> for details.
3700
3701	The main role of this interface is to expose the settings of the virtual
3702	machine and provide methods to change various aspects of the virtual
3703	machine's configuration. For machine objects stored in the
3704	<link to="IVirtualBox::machines"/> collection, all attributes are
3705	read-only unless explicitly stated otherwise in individual attribute
3706	and method descriptions.
3707
3708	In order to change a machine setting, a session for this machine must be
3709	opened using one of the <link to="IMachine::lockMachine" /> or
3710	<link to="IMachine::launchVMProcess"/> methods. After the
3711	machine has been successfully locked for a session, a mutable machine object
3712	needs to be queried from the session object and then the desired settings
3713	changes can be applied to the returned object using IMachine attributes and
3714	methods. See the <link to="ISession"/> interface description for more
3715	information about sessions.
3716
3717	Note that IMachine does not provide methods to control virtual machine
3718	execution (such as start the machine, or power it down) -- these methods
3719	are grouped in a separate interface called <link to="IConsole" />.
3720
3721	<see><link to="ISession"/>, <link to="IConsole"/></see>
3722	</desc>
3723
3724	<attribute name="parent" type="IVirtualBox" readonly="yes">
3725	<desc>Associated parent object.</desc>
3726	</attribute>
3727
3728	<attribute name="accessible" type="boolean" readonly="yes">
3729	<desc>
3730	Whether this virtual machine is currently accessible or not.
3731
3732	A machine is always deemed accessible unless it is registered <i>and</i>
3733	its settings file cannot be read or parsed (either because the file itself
3734	is unavailable or has invalid XML contents).
3735
3736	Every time this property is read, the accessibility state of
3737	this machine is re-evaluated. If the returned value is @c false,
3738	the <link to="#accessError"/> property may be used to get the
3739	detailed error information describing the reason of
3740	inaccessibility, including XML error messages.
3741
3742	When the machine is inaccessible, only the following properties
3743	can be used on it:
3744	<ul>
3745	<li><link to="#parent"/></li>
3746	<li><link to="#id"/></li>
3747	<li><link to="#settingsFilePath"/></li>
3748	<li><link to="#accessible"/></li>
3749	<li><link to="#accessError"/></li>
3750	</ul>
3751
3752	An attempt to access any other property or method will return
3753	an error.
3754
3755	The only possible action you can perform on an inaccessible
3756	machine is to unregister it using the
3757	<link to="IMachine::unregister"/> call (or, to check
3758	for the accessibility state once more by querying this
3759	property).
3760
3761	<note>
3762	In the current implementation, once this property returns
3763	@c true, the machine will never become inaccessible
3764	later, even if its settings file cannot be successfully
3765	read/written any more (at least, until the VirtualBox
3766	server is restarted). This limitation may be removed in
3767	future releases.
3768	</note>
3769	</desc>
3770	</attribute>
3771
3772	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3773	<desc>
3774	Error information describing the reason of machine
3775	inaccessibility.
3776
3777	Reading this property is only valid after the last call to
3778	<link to="#accessible"/> returned @c false (i.e. the
3779	machine is currently inaccessible). Otherwise, a @c null
3780	IVirtualBoxErrorInfo object will be returned.
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="name" type="wstring">
3785	<desc>
3786	Name of the virtual machine.
3787
3788	Besides being used for human-readable identification purposes
3789	everywhere in VirtualBox, the virtual machine name is also used
3790	as a name of the machine's settings file and as a name of the
3791	subdirectory this settings file resides in. Thus, every time you
3792	change the value of this property, the settings file will be
3793	renamed once you call <link to="#saveSettings"/> to confirm the
3794	change. The containing subdirectory will be also renamed, but
3795	only if it has exactly the same name as the settings file
3796	itself prior to changing this property (for backward compatibility
3797	with previous API releases). The above implies the following
3798	limitations:
3799	<ul>
3800	<li>The machine name cannot be empty.</li>
3801	<li>The machine name can contain only characters that are valid
3802	file name characters according to the rules of the file
3803	system used to store VirtualBox configuration.</li>
3804	<li>You cannot have two or more machines with the same name
3805	if they use the same subdirectory for storing the machine
3806	settings files.</li>
3807	<li>You cannot change the name of the machine if it is running,
3808	or if any file in the directory containing the settings file
3809	is being used by another running machine or by any other
3810	process in the host operating system at a time when
3811	<link to="#saveSettings"/> is called.
3812	</li>
3813	</ul>
3814	If any of the above limitations are hit, <link to="#saveSettings"/>
3815	will return an appropriate error message explaining the exact
3816	reason and the changes you made to this machine will not be saved.
3817
3818	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3819	file is recommended, but not enforced. (Previous versions always
3820	used a generic ".xml" extension.)
3821	</desc>
3822	</attribute>
3823
3824	<attribute name="description" type="wstring">
3825	<desc>
3826	Description of the virtual machine.
3827
3828	The description attribute can contain any text and is
3829	typically used to describe the hardware and software
3830	configuration of the virtual machine in detail (i.e. network
3831	settings, versions of the installed software and so on).
3832	</desc>
3833	</attribute>
3834
3835	<attribute name="id" type="uuid" mod="string" readonly="yes">
3836	<desc>UUID of the virtual machine.</desc>
3837	</attribute>
3838
3839	<attribute name="OSTypeId" type="wstring">
3840	<desc>
3841	User-defined identifier of the Guest OS type.
3842	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3843	an IGuestOSType object representing details about the given
3844	Guest OS type.
3845	<note>
3846	This value may differ from the value returned by
3847	<link to="IGuest::OSTypeId"/> if Guest Additions are
3848	installed to the guest OS.
3849	</note>
3850	</desc>
3851	</attribute>
3852
3853	<attribute name="hardwareVersion" type="wstring">
3854	<desc>Hardware version identifier. Internal use only for now.</desc>
3855	</attribute>
3856
3857	<attribute name="hardwareUUID" type="uuid" mod="string">
3858	<desc>
3859	The UUID presented to the guest via memory tables, hardware and guest
3860	properties. For most VMs this is the same as the @a id, but for VMs
3861	which have been cloned or teleported it may be the same as the source
3862	VM. This latter is because the guest shouldn't notice that it was
3863	cloned or teleported.
3864	</desc>
3865	</attribute>
3866
3867	<attribute name="CPUCount" type="unsigned long">
3868	<desc>Number of virtual CPUs in the VM.</desc>
3869	</attribute>
3870
3871	<attribute name="CPUHotPlugEnabled" type="boolean">
3872	<desc>
3873	This setting determines whether VirtualBox allows CPU
3874	hotplugging for this machine.</desc>
3875	</attribute>
3876
3877	<attribute name="CPUExecutionCap" type="unsigned long">
3878	<desc>
3879	Means to limit the number of CPU cycles a guest can use. The unit
3880	is percentage of host CPU cycles per second. The valid range
3881	is 1 - 100. 100 (the default) implies no limit.
3882	</desc>
3883	</attribute>
3884
3885	<attribute name="memorySize" type="unsigned long">
3886	<desc>System memory size in megabytes.</desc>
3887	</attribute>
3888
3889	<attribute name="memoryBalloonSize" type="unsigned long">
3890	<desc>Memory balloon size in megabytes.</desc>
3891	</attribute>
3892
3893	<attribute name="pageFusionEnabled" type="boolean">
3894	<desc>
3895	This setting determines whether VirtualBox allows page
3896	fusion for this machine (64 bits host only).
3897	</desc>
3898	</attribute>
3899
3900	<attribute name="VRAMSize" type="unsigned long">
3901	<desc>Video memory size in megabytes.</desc>
3902	</attribute>
3903
3904	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3905	<desc>
3906	This setting determines whether VirtualBox allows this machine to make
3907	use of the 3D graphics support available on the host.</desc>
3908	</attribute>
3909
3910	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3911	<desc>
3912	This setting determines whether VirtualBox allows this machine to make
3913	use of the 2D video acceleration support available on the host.</desc>
3914	</attribute>
3915
3916	<attribute name="monitorCount" type="unsigned long">
3917	<desc>
3918	Number of virtual monitors.
3919	<note>
3920	Only effective on Windows XP and later guests with
3921	Guest Additions installed.
3922	</note>
3923	</desc>
3924	</attribute>
3925
3926	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3927	<desc>Object containing all BIOS settings.</desc>
3928	</attribute>
3929
3930	<attribute name="firmwareType" type="FirmwareType">
3931	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3932	bootstrap in this VM.</desc>
3933	</attribute>
3934
3935	<attribute name="pointingHidType" type="PointingHidType">
3936	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3937	The default is typically "PS2Mouse" but can vary depending on the
3938	requirements of the guest operating system.</desc>
3939	</attribute>
3940
3941	<attribute name="keyboardHidType" type="KeyboardHidType">
3942	<desc>Type of keyboard HID used in this VM.
3943	The default is typically "PS2Keyboard" but can vary depending on the
3944	requirements of the guest operating system.</desc>
3945	</attribute>
3946
3947	<attribute name="hpetEnabled" type="boolean">
3948	<desc>This attribute controls if High Precision Event Timer (HPET) is
3949	enabled in this VM. Use this property if you want to provide guests
3950	with additional time source, or if guest requires HPET to function correctly.
3951	Default is false.</desc>
3952	</attribute>
3953
3954	<attribute name="chipsetType" type="ChipsetType">
3955	<desc>Chipset type used in this VM.</desc>
3956	</attribute>
3957
3958	<attribute name="snapshotFolder" type="wstring">
3959	<desc>
3960	Full path to the directory used to store snapshot data
3961	(differencing media and saved state files) of this machine.
3962
3963	The initial value of this property is
3964	<tt><</tt><link to="#settingsFilePath">
3965	path_to_settings_file</link><tt>>/<</tt>
3966	<link to="#id">machine_uuid</link>
3967	<tt>></tt>.
3968
3969	Currently, it is an error to try to change this property on
3970	a machine that has snapshots (because this would require to
3971	move possibly large files to a different location).
3972	A separate method will be available for this purpose later.
3973
3974	<note>
3975	Setting this property to @c null or to an empty string will restore
3976	the initial value.
3977	</note>
3978	<note>
3979	When setting this property, the specified path can be
3980	absolute (full path) or relative to the directory where the
3981	<link to="#settingsFilePath">machine settings file</link>
3982	is located. When reading this property, a full path is
3983	always returned.
3984	</note>
3985	<note>
3986	The specified path may not exist, it will be created
3987	when necessary.
3988	</note>
3989	</desc>
3990	</attribute>
3991
3992	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3993	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3994	</attribute>
3995
3996	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
3997	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
3998
3999	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4000	<desc>Array of media attached to this machine.</desc>
4001	</attribute>
4002
4003	<attribute name="USBController" type="IUSBController" readonly="yes">
4004	<desc>
4005	Associated USB controller object.
4006
4007	<note>
4008	If USB functionality is not available in the given edition of
4009	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4010	</note>
4011	</desc>
4012	</attribute>
4013
4014	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4015	<desc>Associated audio adapter, always present.</desc>
4016	</attribute>
4017
4018	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4019	<desc>Array of storage controllers attached to this machine.</desc>
4020	</attribute>
4021
4022	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4023	<desc>
4024	Full name of the file containing machine settings data.
4025	</desc>
4026	</attribute>
4027
4028	<attribute name="settingsModified" type="boolean" readonly="yes">
4029	<desc>
4030	Whether the settings of this machine have been modified
4031	(but neither yet saved nor discarded).
4032	<note>
4033	Reading this property is only valid on instances returned
4034	by <link to="ISession::machine"/> and on new machines
4035	created by <link to="IVirtualBox::createMachine"/> or opened
4036	by <link to="IVirtualBox::openMachine"/> but not
4037	yet registered, or on unregistered machines after calling
4038	<link to="IMachine::unregister"/>. For all other
4039	cases, the settings can never be modified.
4040	</note>
4041	<note>
4042	For newly created unregistered machines, the value of this
4043	property is always @c true until <link to="#saveSettings"/>
4044	is called (no matter if any machine settings have been
4045	changed after the creation or not). For opened machines
4046	the value is set to @c false (and then follows to normal rules).
4047	</note>
4048	</desc>
4049	</attribute>
4050
4051	<attribute name="sessionState" type="SessionState" readonly="yes">
4052	<desc>Current session state for this machine.</desc>
4053	</attribute>
4054
4055	<attribute name="sessionType" type="wstring" readonly="yes">
4056	<desc>
4057	Type of the session. If <link to="#sessionState"/> is
4058	Spawning or Locked, this attribute contains the
4059	same value as passed to the
4060	<link to="IMachine::launchVMProcess"/> method in the
4061	@a type parameter. If the session was used with
4062	<link to="IMachine::lockMachine" />, or if
4063	<link to="#sessionState"/> is SessionClosed, the value of this
4064	attribute is an empty string.
4065	</desc>
4066	</attribute>
4067
4068	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4069	<desc>
4070	Identifier of the session process. This attribute contains the
4071	platform-dependent identifier of the process whose session was
4072	used with <link to="IMachine::lockMachine" /> call. The returned
4073	value is only valid if <link to="#sessionState"/> is Locked or
4074	Unlocking by the time this property is read.
4075	</desc>
4076	</attribute>
4077
4078	<attribute name="state" type="MachineState" readonly="yes">
4079	<desc>Current execution state of this machine.</desc>
4080	</attribute>
4081
4082	<attribute name="lastStateChange" type="long long" readonly="yes">
4083	<desc>
4084	Time stamp of the last execution state change,
4085	in milliseconds since 1970-01-01 UTC.
4086	</desc>
4087	</attribute>
4088
4089	<attribute name="stateFilePath" type="wstring" readonly="yes">
4090	<desc>
4091	Full path to the file that stores the execution state of
4092	the machine when it is in the <link to="MachineState_Saved"/> state.
4093	<note>
4094	When the machine is not in the Saved state, this attribute is
4095	an empty string.
4096	</note>
4097	</desc>
4098	</attribute>
4099
4100	<attribute name="logFolder" type="wstring" readonly="yes">
4101	<desc>
4102	Full path to the folder that stores a set of rotated log files
4103	recorded during machine execution. The most recent log file is
4104	named <tt>VBox.log</tt>, the previous log file is
4105	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4106	in the current version).
4107	</desc>
4108	</attribute>
4109
4110	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4111	<desc>
4112	Current snapshot of this machine. This is @c null if the machine
4113	currently has no snapshots. If it is not @c null, then it was
4114	set by one of <link to="IConsole::takeSnapshot" />,
4115	<link to="IConsole::deleteSnapshot" />
4116	or <link to="IConsole::restoreSnapshot" />, depending on which
4117	was called last. See <link to="ISnapshot"/> for details.
4118	</desc>
4119	</attribute>
4120
4121	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4122	<desc>
4123	Number of snapshots taken on this machine. Zero means the
4124	machine doesn't have any snapshots.
4125	</desc>
4126	</attribute>
4127
4128	<attribute name="currentStateModified" type="boolean" readonly="yes">
4129	<desc>
4130	Returns @c true if the current state of the machine is not
4131	identical to the state stored in the current snapshot.
4132
4133	The current state is identical to the current snapshot only
4134	directly after one of the following calls are made:
4135
4136	<ul>
4137	<li><link to="IConsole::restoreSnapshot"/>
4138	</li>
4139	<li><link to="IConsole::takeSnapshot"/> (issued on a
4140	"powered off" or "saved" machine, for which
4141	<link to="#settingsModified"/> returns @c false)
4142	</li>
4143	</ul>
4144
4145	The current state remains identical until one of the following
4146	happens:
4147	<ul>
4148	<li>settings of the machine are changed</li>
4149	<li>the saved state is deleted</li>
4150	<li>the current snapshot is deleted</li>
4151	<li>an attempt to execute the machine is made</li>
4152	</ul>
4153
4154	<note>
4155	For machines that don't have snapshots, this property is
4156	always @c false.
4157	</note>
4158	</desc>
4159	</attribute>
4160
4161	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4162	<desc>
4163	Collection of shared folders for this machine (permanent shared
4164	folders). These folders are shared automatically at machine startup
4165	and available only to the guest OS installed within this machine.
4166
4167	New shared folders are added to the collection using
4168	<link to="#createSharedFolder"/>. Existing shared folders can be
4169	removed using <link to="#removeSharedFolder"/>.
4170	</desc>
4171	</attribute>
4172
4173	<attribute name="clipboardMode" type="ClipboardMode">
4174	<desc>
4175	Synchronization mode between the host OS clipboard
4176	and the guest OS clipboard.
4177	</desc>
4178	</attribute>
4179
4180	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4181	<desc>
4182	A comma-separated list of simple glob patterns. Changes to guest
4183	properties whose name matches one of the patterns will generate an
4184	<link to="IGuestPropertyChangedEvent"/> signal.
4185	</desc>
4186	</attribute>
4187
4188	<attribute name="teleporterEnabled" type="boolean">
4189	<desc>
4190	When set to @a true, the virtual machine becomes a target teleporter
4191	the next time it is powered on. This can only set to @a true when the
4192	VM is in the @a PoweredOff or @a Aborted state.
4193
4194	<!-- This property is automatically set to @a false when the VM is powered
4195	on. (bird: This doesn't work yet ) -->
4196	</desc>
4197	</attribute>
4198
4199	<attribute name="teleporterPort" type="unsigned long">
4200	<desc>
4201	The TCP port the target teleporter will listen for incoming
4202	teleportations on.
4203
4204	0 means the port is automatically selected upon power on. The actual
4205	value can be read from this property while the machine is waiting for
4206	incoming teleportations.
4207	</desc>
4208	</attribute>
4209
4210	<attribute name="teleporterAddress" type="wstring">
4211	<desc>
4212	The address the target teleporter will listen on. If set to an empty
4213	string, it will listen on all addresses.
4214	</desc>
4215	</attribute>
4216
4217	<attribute name="teleporterPassword" type="wstring">
4218	<desc>
4219	The password to check for on the target teleporter. This is just a
4220	very basic measure to prevent simple hacks and operators accidentally
4221	beaming a virtual machine to the wrong place.
4222
4223	Note that you SET a plain text password while reading back a HASHED
4224	password. Setting a hashed password is currently not supported.
4225	</desc>
4226	</attribute>
4227
4228	<attribute name="faultToleranceState" type="FaultToleranceState">
4229	<desc>
4230	Fault tolerance state; disabled, source or target.
4231	This property can be changed at any time. If you change it for a running
4232	VM, then the fault tolerance address and port must be set beforehand.
4233	</desc>
4234	</attribute>
4235
4236	<attribute name="faultTolerancePort" type="unsigned long">
4237	<desc>
4238	The TCP port the fault tolerance source or target will use for
4239	communication.
4240	</desc>
4241	</attribute>
4242
4243	<attribute name="faultToleranceAddress" type="wstring">
4244	<desc>
4245	The address the fault tolerance source or target.
4246	</desc>
4247	</attribute>
4248
4249	<attribute name="faultTolerancePassword" type="wstring">
4250	<desc>
4251	The password to check for on the standby VM. This is just a
4252	very basic measure to prevent simple hacks and operators accidentally
4253	choosing the wrong standby VM.
4254	</desc>
4255	</attribute>
4256
4257	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4258	<desc>
4259	The interval in ms used for syncing the state between source and target.
4260	</desc>
4261	</attribute>
4262
4263	<attribute name="RTCUseUTC" type="boolean">
4264	<desc>
4265	When set to @a true, the RTC device of the virtual machine will run
4266	in UTC time, otherwise in local time. Especially Unix guests prefer
4267	the time in UTC.
4268	</desc>
4269	</attribute>
4270
4271	<attribute name="ioCacheEnabled" type="boolean">
4272	<desc>
4273	When set to @a true, the builtin I/O cache of the virtual machine
4274	will be enabled.
4275	</desc>
4276	</attribute>
4277
4278	<attribute name="ioCacheSize" type="unsigned long">
4279	<desc>
4280	Maximum size of the I/O cache in MB.
4281	</desc>
4282	</attribute>
4283
4284	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4285	<desc>
4286	Bandwidth control manager.
4287	</desc>
4288	</attribute>
4289
4290	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4291	<desc>Array of PCI devices assigned to this machine, to get list of all
4292	PCI devices attached to the machine use
4293	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4294	is intended to list only devices additional to what described in
4295	virtual hardware config. Usually, this list keeps host's physical
4296	devices assigned to the particular machine.
4297	</desc>
4298	</attribute>
4299
4300	<method name="lockMachine">
4301	<desc>
4302	Locks the machine for the given session to enable the caller
4303	to make changes to the machine or start the VM or control
4304	VM execution.
4305
4306	There are two ways to lock a machine for such uses:
4307
4308	<ul>
4309	<li>If you want to make changes to the machine settings,
4310	you must obtain an exclusive write lock on the machine
4311	by setting @a lockType to @c Write.
4312
4313	This will only succeed if no other process has locked
4314	the machine to prevent conflicting changes. Only after
4315	an exclusive write lock has been obtained using this method, one
4316	can change all VM settings or execute the VM in the process
4317	space of the session object. (Note that the latter is only of
4318	interest if you actually want to write a new front-end for
4319	virtual machines; but this API gets called internally by
4320	the existing front-ends such as VBoxHeadless and the VirtualBox
4321	GUI to acquire a write lock on the machine that they are running.)
4322
4323	On success, write-locking the machine for a session creates
4324	a second copy of the IMachine object. It is this second object
4325	upon which changes can be made; in VirtualBox terminology, the
4326	second copy is "mutable". It is only this second, mutable machine
4327	object upon which you can call methods that change the
4328	machine state. After having called this method, you can
4329	obtain this second, mutable machine object using the
4330	<link to="ISession::machine" /> attribute.
4331	</li>
4332	<li>If you only want to check the machine state or control
4333	machine execution without actually changing machine
4334	settings (e.g. to get access to VM statistics or take
4335	a snapshot or save the machine state), then set the
4336	@a lockType argument to @c Shared.
4337
4338	If no other session has obtained a lock, you will obtain an
4339	exclusive write lock as described above. However, if another
4340	session has already obtained such a lock, then a link to that
4341	existing session will be established which allows you
4342	to control that existing session.
4343
4344	To find out which type of lock was obtained, you can
4345	inspect <link to="ISession::type" />, which will have been
4346	set to either @c WriteLock or @c Shared.
4347	</li>
4348	</ul>
4349
4350	In either case, you can get access to the <link to="IConsole" />
4351	object which controls VM execution.
4352
4353	Also in all of the above cases, one must always call
4354	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4355	the machine's state will eventually be set to "Aborted".
4356
4357	To change settings on a machine, the following sequence is typically
4358	performed:
4359
4360	<ol>
4361	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4362
4363	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4364
4365	<li>Change the settings of the machine by invoking IMachine methods.</li>
4366
4367	<li>Call <link to="IMachine::saveSettings" />.</li>
4368
4369	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4370	</ol>
4371
4372	<result name="E_UNEXPECTED">
4373	Virtual machine not registered.
4374	</result>
4375	<result name="E_ACCESSDENIED">
4376	Process not started by OpenRemoteSession.
4377	</result>
4378	<result name="VBOX_E_INVALID_OBJECT_STATE">
4379	Session already open or being opened.
4380	</result>
4381	<result name="VBOX_E_VM_ERROR">
4382	Failed to assign machine to session.
4383	</result>
4384	</desc>
4385	<param name="session" type="ISession" dir="in">
4386	<desc>
4387	Session object for which the machine will be locked.
4388	</desc>
4389	</param>
4390	<param name="lockType" type="LockType" dir="in">
4391	<desc>
4392	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4393	If set to @c Shared, then either acquire an exclusive write lock or establish
4394	a link to an existing session.
4395	</desc>
4396	</param>
4397	</method>
4398
4399	<method name="launchVMProcess">
4400	<desc>
4401	Spawns a new process that will execute the virtual machine and obtains a shared
4402	lock on the machine for the calling session.
4403
4404	If launching the VM succeeds, the new VM process will create its own session
4405	and write-lock the machine for it, preventing conflicting changes from other
4406	processes. If the machine is already locked (because it is already running or
4407	because another session has a write lock), launching the VM process will therefore
4408	fail. Reversely, future attempts to obtain a write lock will also fail while the
4409	machine is running.
4410
4411	The caller's session object remains separate from the session opened by the new
4412	VM process. It receives its own <link to="IConsole" /> object which can be used
4413	to control machine execution, but it cannot be used to change all VM settings
4414	which would be available after a <link to="#lockMachine" /> call.
4415
4416	The caller must eventually release the session's shared lock by calling
4417	<link to="ISession::unlockMachine" /> on the local session object once this call
4418	has returned. However, the session's state (see <link to="ISession::state" />)
4419	will not return to "Unlocked" until the remote session has also unlocked
4420	the machine (i.e. the machine has stopped running).
4421
4422	Launching a VM process can take some time (a new VM is started in a new process,
4423	for which memory and other resources need to be set up). Because of this,
4424	an <link to="IProgress" /> object is returned to allow the caller to wait
4425	for this asynchronous operation to be completed. Until then, the caller's
4426	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4427	and <link to="ISession::console" /> attributes cannot be accessed.
4428	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4429	similar calls to wait for completion. Completion is signalled when the VM
4430	is powered on. If launching the VM fails, error messages can be queried
4431	via the progress object, if available.
4432
4433	The progress object will have at least 2 sub-operations. The first
4434	operation covers the period up to the new VM process calls powerUp.
4435	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4436	progress object. Because <link to="IConsole::powerUp"/> may require
4437	some extra sub-operations, the <link to="IProgress::operationCount"/>
4438	may change at the completion of operation.
4439
4440	For details on the teleportation progress operation, see
4441	<link to="IConsole::powerUp"/>.
4442
4443	The @a environment argument is a string containing definitions of
4444	environment variables in the following format:
4445	<pre>
4446	NAME[=VALUE]\n
4447	NAME[=VALUE]\n
4448	...
4449	</pre>
4450	where <tt>\\n</tt> is the new line character. These environment
4451	variables will be appended to the environment of the VirtualBox server
4452	process. If an environment variable exists both in the server process
4453	and in this list, the value from this list takes precedence over the
4454	server's variable. If the value of the environment variable is
4455	omitted, this variable will be removed from the resulting environment.
4456	If the environment string is @c null or empty, the server environment
4457	is inherited by the started process as is.
4458
4459	<result name="E_UNEXPECTED">
4460	Virtual machine not registered.
4461	</result>
4462	<result name="E_INVALIDARG">
4463	Invalid session type @a type.
4464	</result>
4465	<result name="VBOX_E_OBJECT_NOT_FOUND">
4466	No machine matching @a machineId found.
4467	</result>
4468	<result name="VBOX_E_INVALID_OBJECT_STATE">
4469	Session already open or being opened.
4470	</result>
4471	<result name="VBOX_E_IPRT_ERROR">
4472	Launching process for machine failed.
4473	</result>
4474	<result name="VBOX_E_VM_ERROR">
4475	Failed to assign machine to session.
4476	</result>
4477	</desc>
4478	<param name="session" type="ISession" dir="in">
4479	<desc>
4480	Client session object to which the VM process will be connected (this
4481	must be in "Unlocked" state).
4482	</desc>
4483	</param>
4484	<param name="type" type="wstring" dir="in">
4485	<desc>
4486	Front-end to use for the new VM process. The following are currently supported:
4487	<ul>
4488	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4489	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4490	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4491	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4492	the currently running VM or session owner. In this case the
4493	@a session parameter may be @c NULL (if it is non-null it isn't
4494	used in any way), and the @a progress return value will be always
4495	NULL. The operation completes immediately.</li>
4496	</ul>
4497	</desc>
4498	</param>
4499	<param name="environment" type="wstring" dir="in">
4500	<desc>
4501	Environment to pass to the VM process.
4502	</desc>
4503	</param>
4504	<param name="progress" type="IProgress" dir="return">
4505	<desc>Progress object to track the operation completion.</desc>
4506	</param>
4507	</method>
4508
4509	<method name="setBootOrder">
4510	<desc>
4511	Puts the given device to the specified position in
4512	the boot order.
4513
4514	To indicate that no device is associated with the given position,
4515	<link to="DeviceType_Null"/> should be used.
4516
4517	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4518
4519	<result name="E_INVALIDARG">
4520	Boot @a position out of range.
4521	</result>
4522	<result name="E_NOTIMPL">
4523	Booting from USB @a device currently not supported.
4524	</result>
4525
4526	</desc>
4527	<param name="position" type="unsigned long" dir="in">
4528	<desc>
4529	Position in the boot order (@c 1 to the total number of
4530	devices the machine can boot from, as returned by
4531	<link to="ISystemProperties::maxBootPosition"/>).
4532	</desc>
4533	</param>
4534	<param name="device" type="DeviceType" dir="in">
4535	<desc>
4536	The type of the device used to boot at the given position.
4537	</desc>
4538	</param>
4539	</method>
4540
4541	<method name="getBootOrder" const="yes">
4542	<desc>
4543	Returns the device type that occupies the specified
4544	position in the boot order.
4545
4546	@todo [remove?]
4547	If the machine can have more than one device of the returned type
4548	(such as hard disks), then a separate method should be used to
4549	retrieve the individual device that occupies the given position.
4550
4551	If here are no devices at the given position, then
4552	<link to="DeviceType_Null"/> is returned.
4553
4554	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4555
4556	<result name="E_INVALIDARG">
4557	Boot @a position out of range.
4558	</result>
4559
4560	</desc>
4561	<param name="position" type="unsigned long" dir="in">
4562	<desc>
4563	Position in the boot order (@c 1 to the total number of
4564	devices the machine can boot from, as returned by
4565	<link to="ISystemProperties::maxBootPosition"/>).
4566	</desc>
4567	</param>
4568	<param name="device" type="DeviceType" dir="return">
4569	<desc>
4570	Device at the given position.
4571	</desc>
4572	</param>
4573	</method>
4574
4575	<method name="attachDevice">
4576	<desc>
4577	Attaches a device and optionally mounts a medium to the given storage
4578	controller (<link to="IStorageController" />, identified by @a name),
4579	at the indicated port and device.
4580
4581	This method is intended for managing storage devices in general while a
4582	machine is powered off. It can be used to attach and detach fixed
4583	and removable media. The following kind of media can be attached
4584	to a machine:
4585
4586	<ul>
4587	<li>For fixed and removable media, you can pass in a medium that was
4588	previously opened using <link to="IVirtualBox::openMedium" />.
4589	</li>
4590
4591	<li>Only for storage devices supporting removable media (such as
4592	DVDs and floppies), you can also specify a null pointer to
4593	indicate an empty drive or one of the medium objects listed
4594	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4595	arrays to indicate a host drive.
4596	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4597	to change the media while the machine is running.
4598	</li>
4599	</ul>
4600
4601	In a VM's default configuration of virtual machines, the secondary
4602	master of the IDE controller is used for a CD/DVD drive.
4603
4604	After calling this returns successfully, a new instance of
4605	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4606	attachments (see <link to="IMachine::mediumAttachments"/>).
4607
4608	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4609	information about attaching media.
4610
4611	The specified device slot must not have a device attached to it,
4612	or this method will fail.
4613
4614	<note>
4615	You cannot attach a device to a newly created machine until
4616	this machine's settings are saved to disk using
4617	<link to="#saveSettings"/>.
4618	</note>
4619	<note>
4620	If the medium is being attached indirectly, a new differencing medium
4621	will implicitly be created for it and attached instead. If the
4622	changes made to the machine settings (including this indirect
4623	attachment) are later cancelled using <link to="#discardSettings"/>,
4624	this implicitly created differencing medium will implicitly
4625	be deleted.
4626	</note>
4627
4628	<result name="E_INVALIDARG">
4629	SATA device, SATA port, IDE port or IDE slot out of range, or
4630	file or UUID not found.
4631	</result>
4632	<result name="VBOX_E_INVALID_OBJECT_STATE">
4633	Machine must be registered before media can be attached.
4634	</result>
4635	<result name="VBOX_E_INVALID_VM_STATE">
4636	Invalid machine state.
4637	</result>
4638	<result name="VBOX_E_OBJECT_IN_USE">
4639	A medium is already attached to this or another virtual machine.
4640	</result>
4641
4642	</desc>
4643	<param name="name" type="wstring" dir="in">
4644	<desc>Name of the storage controller to attach the device to.</desc>
4645	</param>
4646	<param name="controllerPort" type="long" dir="in">
4647	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4648	the primary controller and 1 specifies the secondary controller.
4649	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4650	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4651	</param>
4652	<param name="device" type="long" dir="in">
4653	<desc>Device slot in the given port to attach the device to. This is only
4654	relevant for IDE controllers, for which 0 specifies the master device and
4655	1 specifies the slave device. For all other controller types, this must
4656	be 0.</desc>
4657	</param>
4658	<param name="type" type="DeviceType" dir="in">
4659	<desc>Device type of the attached device. For media opened by
4660	<link to="IVirtualBox::openMedium" />, this must match the device type
4661	specified there.</desc>
4662	</param>
4663	<param name="medium" type="IMedium" dir="in">
4664	<desc>Medium to mount or NULL for an empty drive.</desc>
4665	</param>
4666	</method>
4667
4668	<method name="detachDevice">
4669	<desc>
4670	Detaches the device attached to a device slot of the specified bus.
4671
4672	Detaching the device from the virtual machine is deferred. This means
4673	that the medium remains associated with the machine when this method
4674	returns and gets actually de-associated only after a successful
4675	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4676	for more detailed information about attaching media.
4677
4678	<note>
4679	You cannot detach a device from a running machine.
4680	</note>
4681	<note>
4682	Detaching differencing media implicitly created by <link
4683	to="#attachDevice"/> for the indirect attachment using this
4684	method will <b>not</b> implicitly delete them. The
4685	<link to="IMedium::deleteStorage"/> operation should be
4686	explicitly performed by the caller after the medium is successfully
4687	detached and the settings are saved with
4688	<link to="#saveSettings"/>, if it is the desired action.
4689	</note>
4690
4691	<result name="VBOX_E_INVALID_VM_STATE">
4692	Attempt to detach medium from a running virtual machine.
4693	</result>
4694	<result name="VBOX_E_OBJECT_NOT_FOUND">
4695	No medium attached to given slot/bus.
4696	</result>
4697	<result name="VBOX_E_NOT_SUPPORTED">
4698	Medium format does not support storage deletion.
4699	</result>
4700
4701	</desc>
4702	<param name="name" type="wstring" dir="in">
4703	<desc>Name of the storage controller to detach the medium from.</desc>
4704	</param>
4705	<param name="controllerPort" type="long" dir="in">
4706	<desc>Port number to detach the medium from.</desc>
4707	</param>
4708	<param name="device" type="long" dir="in">
4709	<desc>Device slot number to detach the medium from.</desc>
4710	</param>
4711	</method>
4712
4713	<method name="passthroughDevice">
4714	<desc>
4715	Sets the passthrough mode of an existing DVD device. Changing the
4716	setting while the VM is running is forbidden. The setting is only used
4717	if at VM start the device is configured as a host DVD drive, in all
4718	other cases it is ignored. The device must already exist; see
4719	<link to="IMachine::attachDevice"/> for how to attach a new device.
4720
4721	The @a controllerPort and @a device parameters specify the device slot and
4722	have have the same meaning as with <link to="IMachine::attachDevice" />.
4723
4724	<result name="E_INVALIDARG">
4725	SATA device, SATA port, IDE port or IDE slot out of range.
4726	</result>
4727	<result name="VBOX_E_INVALID_OBJECT_STATE">
4728	Attempt to modify an unregistered virtual machine.
4729	</result>
4730	<result name="VBOX_E_INVALID_VM_STATE">
4731	Invalid machine state.
4732	</result>
4733
4734	</desc>
4735	<param name="name" type="wstring" dir="in">
4736	<desc>Name of the storage controller.</desc>
4737	</param>
4738	<param name="controllerPort" type="long" dir="in">
4739	<desc>Storage controller port.</desc>
4740	</param>
4741	<param name="device" type="long" dir="in">
4742	<desc>Device slot in the given port.</desc>
4743	</param>
4744	<param name="passthrough" type="boolean" dir="in">
4745	<desc>New value for the passthrough setting.</desc>
4746	</param>
4747	</method>
4748
4749	<method name="temporaryEjectDevice">
4750	<desc>
4751	Sets the behavior for guest-triggered medium eject. In some situations
4752	it is desirable that such ejects update the VM configuration, and in
4753	others the eject should keep the VM configuration. The device must
4754	already exist; see <link to="IMachine::attachDevice"/> for how to
4755	attach a new device.
4756
4757	The @a controllerPort and @a device parameters specify the device slot and
4758	have have the same meaning as with <link to="IMachine::attachDevice" />.
4759
4760	<result name="E_INVALIDARG">
4761	SATA device, SATA port, IDE port or IDE slot out of range.
4762	</result>
4763	<result name="VBOX_E_INVALID_OBJECT_STATE">
4764	Attempt to modify an unregistered virtual machine.
4765	</result>
4766	<result name="VBOX_E_INVALID_VM_STATE">
4767	Invalid machine state.
4768	</result>
4769
4770	</desc>
4771	<param name="name" type="wstring" dir="in">
4772	<desc>Name of the storage controller.</desc>
4773	</param>
4774	<param name="controllerPort" type="long" dir="in">
4775	<desc>Storage controller port.</desc>
4776	</param>
4777	<param name="device" type="long" dir="in">
4778	<desc>Device slot in the given port.</desc>
4779	</param>
4780	<param name="temporaryEject" type="boolean" dir="in">
4781	<desc>New value for the eject behavior.</desc>
4782	</param>
4783	</method>
4784
4785	<method name="nonRotationalDevice">
4786	<desc>
4787	Sets a flag in the device information which indicates that the medium
4788	is not based on rotational technology, i.e. that the access times are
4789	more or less independent of the position on the medium. This may or may
4790	not be supported by a particular drive, and is silently ignored in the
4791	latter case. At the moment only hard disks (which is a misnomer in this
4792	context) accept this setting. Changing the setting while the VM is
4793	running is forbidden. The device must already exist; see
4794	<link to="IMachine::attachDevice"/> for how to attach a new device.
4795
4796	The @a controllerPort and @a device parameters specify the device slot and
4797	have have the same meaning as with <link to="IMachine::attachDevice" />.
4798
4799	<result name="E_INVALIDARG">
4800	SATA device, SATA port, IDE port or IDE slot out of range.
4801	</result>
4802	<result name="VBOX_E_INVALID_OBJECT_STATE">
4803	Attempt to modify an unregistered virtual machine.
4804	</result>
4805	<result name="VBOX_E_INVALID_VM_STATE">
4806	Invalid machine state.
4807	</result>
4808
4809	</desc>
4810	<param name="name" type="wstring" dir="in">
4811	<desc>Name of the storage controller.</desc>
4812	</param>
4813	<param name="controllerPort" type="long" dir="in">
4814	<desc>Storage controller port.</desc>
4815	</param>
4816	<param name="device" type="long" dir="in">
4817	<desc>Device slot in the given port.</desc>
4818	</param>
4819	<param name="nonRotational" type="boolean" dir="in">
4820	<desc>New value for the non-rotational device flag.</desc>
4821	</param>
4822	</method>
4823
4824	<method name="setAutoDiscardForDevice">
4825	<desc>
4826	Sets a flag in the device information which indicates that the medium
4827	supports discarding unsused blocks (called trimming for SATA or unmap
4828	for SCSI devices) .This may or may not be supported by a particular drive,
4829	and is silently ignored in the latter case. At the moment only hard disks
4830	(which is a misnomer in this context) accept this setting. Changing the
4831	setting while the VM is running is forbidden. The device must already
4832	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4833	device.
4834
4835	The @a controllerPort and @a device parameters specify the device slot and
4836	have have the same meaning as with <link to="IMachine::attachDevice" />.
4837
4838	<result name="E_INVALIDARG">
4839	SATA device, SATA port, SCSI port out of range.
4840	</result>
4841	<result name="VBOX_E_INVALID_OBJECT_STATE">
4842	Attempt to modify an unregistered virtual machine.
4843	</result>
4844	<result name="VBOX_E_INVALID_VM_STATE">
4845	Invalid machine state.
4846	</result>
4847
4848	</desc>
4849	<param name="name" type="wstring" dir="in">
4850	<desc>Name of the storage controller.</desc>
4851	</param>
4852	<param name="controllerPort" type="long" dir="in">
4853	<desc>Storage controller port.</desc>
4854	</param>
4855	<param name="device" type="long" dir="in">
4856	<desc>Device slot in the given port.</desc>
4857	</param>
4858	<param name="discard" type="boolean" dir="in">
4859	<desc>New value for the discard device flag.</desc>
4860	</param>
4861	</method>
4862
4863	<method name="setBandwidthGroupForDevice">
4864	<desc>
4865	Sets the bandwidth group of an existing storage device.
4866	The device must already exist; see <link to="IMachine::attachDevice"/>
4867	for how to attach a new device.
4868
4869	The @a controllerPort and @a device parameters specify the device slot and
4870	have have the same meaning as with <link to="IMachine::attachDevice" />.
4871
4872	<result name="E_INVALIDARG">
4873	SATA device, SATA port, IDE port or IDE slot out of range.
4874	</result>
4875	<result name="VBOX_E_INVALID_OBJECT_STATE">
4876	Attempt to modify an unregistered virtual machine.
4877	</result>
4878	<result name="VBOX_E_INVALID_VM_STATE">
4879	Invalid machine state.
4880	</result>
4881
4882	</desc>
4883	<param name="name" type="wstring" dir="in">
4884	<desc>Name of the storage controller.</desc>
4885	</param>
4886	<param name="controllerPort" type="long" dir="in">
4887	<desc>Storage controller port.</desc>
4888	</param>
4889	<param name="device" type="long" dir="in">
4890	<desc>Device slot in the given port.</desc>
4891	</param>
4892	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4893	<desc>New value for the bandwidth group or NULL for no group.</desc>
4894	</param>
4895	</method>
4896
4897	<method name="mountMedium">
4898	<desc>
4899	Mounts a medium (<link to="IMedium" />, identified
4900	by the given UUID @a id) to the given storage controller
4901	(<link to="IStorageController" />, identified by @a name),
4902	at the indicated port and device. The device must already exist;
4903	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4904
4905	This method is intended only for managing removable media, where the
4906	device is fixed but media is changeable at runtime (such as DVDs
4907	and floppies). It cannot be used for fixed media such as hard disks.
4908
4909	The @a controllerPort and @a device parameters specify the device slot and
4910	have have the same meaning as with <link to="IMachine::attachDevice" />.
4911
4912	The specified device slot can have a medium mounted, which will be
4913	unmounted first. Specifying a zero UUID (or an empty string) for
4914	@a medium does just an unmount.
4915
4916	See <link to="IMedium"/> for more detailed information about
4917	attaching media.
4918
4919	<result name="E_INVALIDARG">
4920	SATA device, SATA port, IDE port or IDE slot out of range.
4921	</result>
4922	<result name="VBOX_E_INVALID_OBJECT_STATE">
4923	Attempt to attach medium to an unregistered virtual machine.
4924	</result>
4925	<result name="VBOX_E_INVALID_VM_STATE">
4926	Invalid machine state.
4927	</result>
4928	<result name="VBOX_E_OBJECT_IN_USE">
4929	Medium already attached to this or another virtual machine.
4930	</result>
4931
4932	</desc>
4933	<param name="name" type="wstring" dir="in">
4934	<desc>Name of the storage controller to attach the medium to.</desc>
4935	</param>
4936	<param name="controllerPort" type="long" dir="in">
4937	<desc>Port to attach the medium to.</desc>
4938	</param>
4939	<param name="device" type="long" dir="in">
4940	<desc>Device slot in the given port to attach the medium to.</desc>
4941	</param>
4942	<param name="medium" type="IMedium" dir="in">
4943	<desc>Medium to mount or NULL for an empty drive.</desc>
4944	</param>
4945	<param name="force" type="boolean" dir="in">
4946	<desc>Allows to force unmount/mount of a medium which is locked by
4947	the device slot in the given port to attach the medium to.</desc>
4948	</param>
4949	</method>
4950
4951	<method name="getMedium" const="yes">
4952	<desc>
4953	Returns the virtual medium attached to a device slot of the specified
4954	bus.
4955
4956	Note that if the medium was indirectly attached by
4957	<link to="#mountMedium"/> to the given device slot then this
4958	method will return not the same object as passed to the
4959	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4960	more detailed information about mounting a medium.
4961
4962	<result name="VBOX_E_OBJECT_NOT_FOUND">
4963	No medium attached to given slot/bus.
4964	</result>
4965
4966	</desc>
4967	<param name="name" type="wstring" dir="in">
4968	<desc>Name of the storage controller the medium is attached to.</desc>
4969	</param>
4970	<param name="controllerPort" type="long" dir="in">
4971	<desc>Port to query.</desc>
4972	</param>
4973	<param name="device" type="long" dir="in">
4974	<desc>Device slot in the given port to query.</desc>
4975	</param>
4976	<param name="medium" type="IMedium" dir="return">
4977	<desc>Attached medium object.</desc>
4978	</param>
4979	</method>
4980
4981	<method name="getMediumAttachmentsOfController" const="yes">
4982	<desc>
4983	Returns an array of medium attachments which are attached to the
4984	the controller with the given name.
4985
4986	<result name="VBOX_E_OBJECT_NOT_FOUND">
4987	A storage controller with given name doesn't exist.
4988	</result>
4989	</desc>
4990	<param name="name" type="wstring" dir="in"/>
4991	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4992	</method>
4993
4994	<method name="getMediumAttachment" const="yes">
4995	<desc>
4996	Returns a medium attachment which corresponds to the controller with
4997	the given name, on the given port and device slot.
4998
4999	<result name="VBOX_E_OBJECT_NOT_FOUND">
5000	No attachment exists for the given controller/port/device combination.
5001	</result>
5002	</desc>
5003	<param name="name" type="wstring" dir="in"/>
5004	<param name="controllerPort" type="long" dir="in"/>
5005	<param name="device" type="long" dir="in"/>
5006	<param name="attachment" type="IMediumAttachment" dir="return"/>
5007	</method>
5008
5009	<method name="attachHostPciDevice">
5010	<desc>
5011	Attaches host PCI device with the given (host) PCI address to the
5012	PCI bus of the virtual machine. Please note, that this operation
5013	is two phase, as real attachment will happen when VM will start,
5014	and most information will be delivered as IHostPciDevicePlugEvent
5015	on IVirtualBox event source.
5016
5017	<see><link to="IHostPciDevicePlugEvent"/></see>
5018
5019	<result name="VBOX_E_INVALID_VM_STATE">
5020	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5021	</result>
5022	<result name="VBOX_E_PDM_ERROR">
5023	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5024	</result>
5025	<result name="VBOX_E_NOT_SUPPORTED">
5026	Hardware or host OS doesn't allow PCI device passthrought.
5027	</result>
5028	</desc>
5029	<param name="hostAddress" type="long" dir="in">
5030	<desc>Address of the host PCI device.</desc>
5031	</param>
5032	<param name="desiredGuestAddress" type="long" dir="in">
5033	<desc>Desired position of this device on guest PCI bus.</desc>
5034	</param>
5035	<param name="tryToUnbind" type="boolean" dir="in">
5036	<desc>If VMM shall try to unbind existing drivers from the
5037	device before attaching it to the guest.</desc>
5038	</param>
5039	</method>
5040
5041	<method name="detachHostPciDevice">
5042	<desc>
5043	Detach host PCI device from the virtual machine.
5044	Also HostPciDevicePlugEvent on IVirtualBox event source
5045	will be delivered. As currently we don't support hot device
5046	unplug, IHostPciDevicePlugEvent event is delivered immediately.
5047
5048	<see><link to="IHostPciDevicePlugEvent"/></see>
5049
5050	<result name="VBOX_E_INVALID_VM_STATE">
5051	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5052	</result>
5053	<result name="VBOX_E_OBJECT_NOT_FOUND">
5054	This host device is not attached to this machine.
5055	</result>
5056	<result name="VBOX_E_PDM_ERROR">
5057	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5058	</result>
5059	<result name="VBOX_E_NOT_SUPPORTED">
5060	Hardware or host OS doesn't allow PCI device passthrought.
5061	</result>
5062	</desc>
5063	<param name="hostAddress" type="long" dir="in">
5064	<desc>Address of the host PCI device.</desc>
5065	</param>
5066	</method>
5067
5068	<method name="getNetworkAdapter" const="yes">
5069	<desc>
5070	Returns the network adapter associated with the given slot.
5071	Slots are numbered sequentially, starting with zero. The total
5072	number of adapters per machine is defined by the
5073	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5074	so the maximum slot number is one less than that property's value.
5075
5076	<result name="E_INVALIDARG">
5077	Invalid @a slot number.
5078	</result>
5079
5080	</desc>
5081	<param name="slot" type="unsigned long" dir="in"/>
5082	<param name="adapter" type="INetworkAdapter" dir="return"/>
5083	</method>
5084
5085	<method name="addStorageController">
5086	<desc>
5087	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5088	machine and returns it as an instance of
5089	<link to="IStorageController" />.
5090
5091	@a name identifies the controller for subsequent calls such as
5092	<link to="#getStorageControllerByName" />,
5093	<link to="#getStorageControllerByInstance" />,
5094	<link to="#removeStorageController" />,
5095	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5096
5097	After the controller has been added, you can set its exact
5098	type by setting the <link to="IStorageController::controllerType" />.
5099
5100	<result name="VBOX_E_OBJECT_IN_USE">
5101	A storage controller with given name exists already.
5102	</result>
5103	<result name="E_INVALIDARG">
5104	Invalid @a controllerType.
5105	</result>
5106	</desc>
5107	<param name="name" type="wstring" dir="in"/>
5108	<param name="connectionType" type="StorageBus" dir="in"/>
5109	<param name="controller" type="IStorageController" dir="return"/>
5110	</method>
5111
5112	<method name="getStorageControllerByName" const="yes">
5113	<desc>
5114	Returns a storage controller with the given name.
5115
5116	<result name="VBOX_E_OBJECT_NOT_FOUND">
5117	A storage controller with given name doesn't exist.
5118	</result>
5119	</desc>
5120	<param name="name" type="wstring" dir="in"/>
5121	<param name="storageController" type="IStorageController" dir="return"/>
5122	</method>
5123
5124	<method name="getStorageControllerByInstance" const="yes">
5125	<desc>
5126	Returns a storage controller with the given instance number.
5127
5128	<result name="VBOX_E_OBJECT_NOT_FOUND">
5129	A storage controller with given instance number doesn't exist.
5130	</result>
5131	</desc>
5132	<param name="instance" type="unsigned long" dir="in"/>
5133	<param name="storageController" type="IStorageController" dir="return"/>
5134	</method>
5135
5136	<method name="removeStorageController">
5137	<desc>
5138	Removes a storage controller from the machine.
5139
5140	<result name="VBOX_E_OBJECT_NOT_FOUND">
5141	A storage controller with given name doesn't exist.
5142	</result>
5143	</desc>
5144	<param name="name" type="wstring" dir="in"/>
5145	</method>
5146
5147	<method name="setStorageControllerBootable">
5148	<desc>
5149	Sets the bootable flag of the storage controller with the given name.
5150
5151	<result name="VBOX_E_OBJECT_NOT_FOUND">
5152	A storage controller with given name doesn't exist.
5153	</result>
5154	<result name="VBOX_E_OBJECT_IN_USE">
5155	Another storage controller is marked as bootable already.
5156	</result>
5157	</desc>
5158	<param name="name" type="wstring" dir="in"/>
5159	<param name="bootable" type="boolean" dir="in"/>
5160	</method>
5161
5162	<method name="getSerialPort" const="yes">
5163	<desc>
5164	Returns the serial port associated with the given slot.
5165	Slots are numbered sequentially, starting with zero. The total
5166	number of serial ports per machine is defined by the
5167	<link to="ISystemProperties::serialPortCount"/> property,
5168	so the maximum slot number is one less than that property's value.
5169
5170	<result name="E_INVALIDARG">
5171	Invalid @a slot number.
5172	</result>
5173
5174	</desc>
5175	<param name="slot" type="unsigned long" dir="in"/>
5176	<param name="port" type="ISerialPort" dir="return"/>
5177	</method>
5178
5179	<method name="getParallelPort" const="yes">
5180	<desc>
5181	Returns the parallel port associated with the given slot.
5182	Slots are numbered sequentially, starting with zero. The total
5183	number of parallel ports per machine is defined by the
5184	<link to="ISystemProperties::parallelPortCount"/> property,
5185	so the maximum slot number is one less than that property's value.
5186
5187	<result name="E_INVALIDARG">
5188	Invalid @a slot number.
5189	</result>
5190
5191	</desc>
5192	<param name="slot" type="unsigned long" dir="in"/>
5193	<param name="port" type="IParallelPort" dir="return"/>
5194	</method>
5195
5196	<method name="getExtraDataKeys">
5197	<desc>
5198	Returns an array representing the machine-specific extra data keys
5199	which currently have values defined.
5200	</desc>
5201	<param name="value" type="wstring" dir="return" safearray="yes">
5202	<desc>Array of extra data keys.</desc>
5203	</param>
5204	</method>
5205
5206	<method name="getExtraData">
5207	<desc>
5208	Returns associated machine-specific extra data.
5209
5210	If the requested data @a key does not exist, this function will
5211	succeed and return an empty string in the @a value argument.
5212
5213	<result name="VBOX_E_FILE_ERROR">
5214	Settings file not accessible.
5215	</result>
5216	<result name="VBOX_E_XML_ERROR">
5217	Could not parse the settings file.
5218	</result>
5219
5220	</desc>
5221	<param name="key" type="wstring" dir="in">
5222	<desc>Name of the data key to get.</desc>
5223	</param>
5224	<param name="value" type="wstring" dir="return">
5225	<desc>Value of the requested data key.</desc>
5226	</param>
5227	</method>
5228
5229	<method name="setExtraData">
5230	<desc>
5231	Sets associated machine-specific extra data.
5232
5233	If you pass @c null or an empty string as a key @a value, the given
5234	@a key will be deleted.
5235
5236	<note>
5237	Before performing the actual data change, this method will ask all
5238	registered listeners using the
5239	<link to="IExtraDataCanChangeEvent"/>
5240	notification for a permission. If one of the listeners refuses the
5241	new value, the change will not be performed.
5242	</note>
5243	<note>
5244	On success, the
5245	<link to="IExtraDataChangedEvent"/> notification
5246	is called to inform all registered listeners about a successful data
5247	change.
5248	</note>
5249	<note>
5250	This method can be called outside the machine session and therefore
5251	it's a caller's responsibility to handle possible race conditions
5252	when several clients change the same key at the same time.
5253	</note>
5254
5255	<result name="VBOX_E_FILE_ERROR">
5256	Settings file not accessible.
5257	</result>
5258	<result name="VBOX_E_XML_ERROR">
5259	Could not parse the settings file.
5260	</result>
5261
5262	</desc>
5263	<param name="key" type="wstring" dir="in">
5264	<desc>Name of the data key to set.</desc>
5265	</param>
5266	<param name="value" type="wstring" dir="in">
5267	<desc>Value to assign to the key.</desc>
5268	</param>
5269	</method>
5270
5271	<method name="getCPUProperty" const="yes">
5272	<desc>
5273	Returns the virtual CPU boolean value of the specified property.
5274
5275	<result name="E_INVALIDARG">
5276	Invalid property.
5277	</result>
5278
5279	</desc>
5280	<param name="property" type="CPUPropertyType" dir="in">
5281	<desc>
5282	Property type to query.
5283	</desc>
5284	</param>
5285	<param name="value" type="boolean" dir="return">
5286	<desc>
5287	Property value.
5288	</desc>
5289	</param>
5290	</method>
5291
5292	<method name="setCPUProperty">
5293	<desc>
5294	Sets the virtual CPU boolean value of the specified property.
5295
5296	<result name="E_INVALIDARG">
5297	Invalid property.
5298	</result>
5299
5300	</desc>
5301	<param name="property" type="CPUPropertyType" dir="in">
5302	<desc>
5303	Property type to query.
5304	</desc>
5305	</param>
5306	<param name="value" type="boolean" dir="in">
5307	<desc>
5308	Property value.
5309	</desc>
5310	</param>
5311	</method>
5312
5313	<method name="getCPUIDLeaf" const="yes">
5314	<desc>
5315	Returns the virtual CPU cpuid information for the specified leaf.
5316
5317	Currently supported index values for cpuid:
5318	Standard CPUID leafs: 0 - 0xA
5319	Extended CPUID leafs: 0x80000000 - 0x8000000A
5320
5321	See the Intel and AMD programmer's manuals for detailed information
5322	about the cpuid instruction and its leafs.
5323	<result name="E_INVALIDARG">
5324	Invalid id.
5325	</result>
5326
5327	</desc>
5328	<param name="id" type="unsigned long" dir="in">
5329	<desc>
5330	CPUID leaf index.
5331	</desc>
5332	</param>
5333	<param name="valEax" type="unsigned long" dir="out">
5334	<desc>
5335	CPUID leaf value for register eax.
5336	</desc>
5337	</param>
5338	<param name="valEbx" type="unsigned long" dir="out">
5339	<desc>
5340	CPUID leaf value for register ebx.
5341	</desc>
5342	</param>
5343	<param name="valEcx" type="unsigned long" dir="out">
5344	<desc>
5345	CPUID leaf value for register ecx.
5346	</desc>
5347	</param>
5348	<param name="valEdx" type="unsigned long" dir="out">
5349	<desc>
5350	CPUID leaf value for register edx.
5351	</desc>
5352	</param>
5353	</method>
5354
5355	<method name="setCPUIDLeaf">
5356	<desc>
5357	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5358	are not passed unmodified. VirtualBox clears features that it doesn't support.
5359
5360	Currently supported index values for cpuid:
5361	Standard CPUID leafs: 0 - 0xA
5362	Extended CPUID leafs: 0x80000000 - 0x8000000A
5363
5364	See the Intel and AMD programmer's manuals for detailed information
5365	about the cpuid instruction and its leafs.
5366
5367	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5368	random crashes inside VMs.
5369	<result name="E_INVALIDARG">
5370	Invalid id.
5371	</result>
5372
5373	</desc>
5374	<param name="id" type="unsigned long" dir="in">
5375	<desc>
5376	CPUID leaf index.
5377	</desc>
5378	</param>
5379	<param name="valEax" type="unsigned long" dir="in">
5380	<desc>
5381	CPUID leaf value for register eax.
5382	</desc>
5383	</param>
5384	<param name="valEbx" type="unsigned long" dir="in">
5385	<desc>
5386	CPUID leaf value for register ebx.
5387	</desc>
5388	</param>
5389	<param name="valEcx" type="unsigned long" dir="in">
5390	<desc>
5391	CPUID leaf value for register ecx.
5392	</desc>
5393	</param>
5394	<param name="valEdx" type="unsigned long" dir="in">
5395	<desc>
5396	CPUID leaf value for register edx.
5397	</desc>
5398	</param>
5399	</method>
5400
5401	<method name="removeCPUIDLeaf">
5402	<desc>
5403	Removes the virtual CPU cpuid leaf for the specified index
5404
5405	<result name="E_INVALIDARG">
5406	Invalid id.
5407	</result>
5408
5409	</desc>
5410	<param name="id" type="unsigned long" dir="in">
5411	<desc>
5412	CPUID leaf index.
5413	</desc>
5414	</param>
5415	</method>
5416
5417	<method name="removeAllCPUIDLeaves">
5418	<desc>
5419	Removes all the virtual CPU cpuid leaves
5420	</desc>
5421	</method>
5422
5423	<method name="getHWVirtExProperty" const="yes">
5424	<desc>
5425	Returns the value of the specified hardware virtualization boolean property.
5426
5427	<result name="E_INVALIDARG">
5428	Invalid property.
5429	</result>
5430
5431	</desc>
5432	<param name="property" type="HWVirtExPropertyType" dir="in">
5433	<desc>
5434	Property type to query.
5435	</desc>
5436	</param>
5437	<param name="value" type="boolean" dir="return">
5438	<desc>
5439	Property value.
5440	</desc>
5441	</param>
5442	</method>
5443
5444	<method name="setHWVirtExProperty">
5445	<desc>
5446	Sets a new value for the specified hardware virtualization boolean property.
5447
5448	<result name="E_INVALIDARG">
5449	Invalid property.
5450	</result>
5451
5452	</desc>
5453	<param name="property" type="HWVirtExPropertyType" dir="in">
5454	<desc>
5455	Property type to set.
5456	</desc>
5457	</param>
5458	<param name="value" type="boolean" dir="in">
5459	<desc>
5460	New property value.
5461	</desc>
5462	</param>
5463	</method>
5464
5465	<method name="saveSettings">
5466	<desc>
5467	Saves any changes to machine settings made since the session
5468	has been opened or a new machine has been created, or since the
5469	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5470	For registered machines, new settings become visible to all
5471	other VirtualBox clients after successful invocation of this
5472	method.
5473	<note>
5474	The method sends <link to="IMachineDataChangedEvent"/>
5475	notification event after the configuration has been successfully
5476	saved (only for registered machines).
5477	</note>
5478	<note>
5479	Calling this method is only valid on instances returned
5480	by <link to="ISession::machine"/> and on new machines
5481	created by <link to="IVirtualBox::createMachine"/> but not
5482	yet registered, or on unregistered machines after calling
5483	<link to="IMachine::unregister"/>.
5484	</note>
5485
5486	<result name="VBOX_E_FILE_ERROR">
5487	Settings file not accessible.
5488	</result>
5489	<result name="VBOX_E_XML_ERROR">
5490	Could not parse the settings file.
5491	</result>
5492	<result name="E_ACCESSDENIED">
5493	Modification request refused.
5494	</result>
5495
5496	</desc>
5497	</method>
5498
5499	<method name="discardSettings">
5500	<desc>
5501	Discards any changes to the machine settings made since the session
5502	has been opened or since the last call to <link to="#saveSettings"/>
5503	or <link to="#discardSettings"/>.
5504	<note>
5505	Calling this method is only valid on instances returned
5506	by <link to="ISession::machine"/> and on new machines
5507	created by <link to="IVirtualBox::createMachine"/> or
5508	opened by <link to="IVirtualBox::openMachine"/> but not
5509	yet registered, or on unregistered machines after calling
5510	<link to="IMachine::unregister"/>.
5511	</note>
5512
5513	<result name="VBOX_E_INVALID_VM_STATE">
5514	Virtual machine is not mutable.
5515	</result>
5516
5517	</desc>
5518	</method>
5519
5520	<method name="unregister">
5521	<desc>
5522	Unregisters a machine previously registered with
5523	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5524	cleanup before the machine is unregistered.
5525
5526	This method does not delete any files. It only changes the machine configuration and
5527	the list of registered machines in the VirtualBox object. To delete the files which
5528	belonged to the machine, including the XML file of the machine itself, call
5529	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5530	from this method.
5531
5532	How thoroughly this method cleans up the machine configuration before unregistering
5533	the machine depends on the @a cleanupMode argument.
5534
5535	<ul>
5536	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5537	cleanup will be performed. The call will fail if the machine is in "Saved" state
5538	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5539	It is the responsibility of the caller to delete all such configuration in this mode.
5540	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5541	which it replaces.</li>
5542	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5543	state or if it has snapshots or media attached. All media attached to the current machine
5544	state or in snapshots will be detached. No medium objects will be returned;
5545	all of the machine's media will remain open.</li>
5546	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5547	except that all the hard disk medium objects which were detached from the machine will
5548	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5549	API for closing and deletion.</li>
5550	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5551	that all media will be returned in the array, including removable media like DVDs and
5552	floppies. This might be useful if the user wants to inspect in detail which media were
5553	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5554	in that case because users will typically want to preserve ISO and RAW image files.</li>
5555	</ul>
5556
5557	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5558	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5559	deleted with all its saved states and hard disk images, but images for removable
5560	drives (such as ISO and RAW files) will remain on disk.
5561
5562	This API does not verify whether the media files returned in the array are still
5563	attached to other machines (i.e. shared between several machines). If such a shared
5564	image is passed to <link to="#delete" /> however, closing the image will fail there
5565	and the image will be silently skipped.
5566
5567	This API may, however, move media from this machine's media registry to other media
5568	registries (see <link to="IMedium" /> for details on media registries). For machines
5569	created with VirtualBox 4.0 or later, if media from this machine's media registry
5570	are also attached to another machine (shared attachments), each such medium will be
5571	moved to another machine's registry. This is because without this machine's media
5572	registry, the other machine cannot find its media any more and would become inaccessible.
5573
5574	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5575	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5576	if media are moved to other machines' media registries.
5577
5578	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5579	is fired.
5580
5581	The call will fail if the machine is currently locked (see <link to="ISession" />).
5582
5583	<note>
5584	If the given machine is inaccessible (see <link to="#accessible"/>), it
5585	will be unregistered and fully uninitialized right afterwards. As a result,
5586	the returned machine object will be unusable and an attempt to call
5587	<b>any</b> method will return the "Object not ready" error.
5588	</note>
5589
5590	<result name="VBOX_E_INVALID_OBJECT_STATE">
5591	Machine is currently locked for a session.
5592	</result>
5593	</desc>
5594
5595	<param name="cleanupMode" type="CleanupMode" dir="in">
5596	<desc>How to clean up after the machine has been unregistered.</desc>
5597	</param>
5598	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5599	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5600	</param>
5601	</method>
5602
5603	<method name="delete">
5604	<desc>
5605	Deletes the files associated with this machine from disk. If medium objects are passed
5606	in with the @a aMedia argument, they are closed and, if closing was successful, their
5607	storage files are deleted as well. For convenience, this array of media files can be
5608	the same as the one returned from a previous <link to="#unregister" /> call.
5609
5610	This method must only be called on machines which are either write-locked (i.e. on instances
5611	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5612	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5613	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5614
5615	The following files will be deleted by this method:
5616	<ul>
5617	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5618	argument other than "UnregisterOnly", this will delete all saved state files that
5619	the machine had in use; possibly one if the machine was in "Saved" state and one
5620	for each online snapshot that the machine had.</li>
5621	<li>On each medium object passed in the @a aMedia array, this will call
5622	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5623	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5624	in use, e.g. because it is still attached to a second machine; in that case the
5625	storage will not be deleted.</li>
5626	<li>Finally, the machine's own XML file will be deleted.</li>
5627	</ul>
5628
5629	Since deleting large disk image files can be a time-consuming I/O operation, this
5630	method operates asynchronously and returns an IProgress object to allow the caller
5631	to monitor the progress. There will be one sub-operation for each file that is
5632	being deleted (saved state or medium storage file).
5633
5634	<note>
5635	<link to="#settingsModified"/> will return @c true after this
5636	method successfully returns.
5637	</note>
5638
5639	<result name="VBOX_E_INVALID_VM_STATE">
5640	Machine is registered but not write-locked.
5641	</result>
5642	<result name="VBOX_E_IPRT_ERROR">
5643	Could not delete the settings file.
5644	</result>
5645	</desc>
5646	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5647	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5648	</param>
5649	<param name="aProgress" type="IProgress" dir="return">
5650	<desc>Progress object to track the operation completion.</desc>
5651	</param>
5652	</method>
5653
5654	<method name="export">
5655	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5656	steps required to export VirtualBox machines to OVF.
5657	</desc>
5658
5659	<param name="aAppliance" type="IAppliance" dir="in">
5660	<desc>Appliance to export this machine to.</desc>
5661	</param>
5662	<param name="location" type="wstring" dir="in">
5663	<desc>The target location.</desc>
5664	</param>
5665	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5666	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5667	</param>
5668	</method >
5669
5670	<method name="findSnapshot">
5671	<desc>
5672	Returns a snapshot of this machine with the given name or UUID.
5673
5674	Returns a snapshot of this machine with the given UUID.
5675	A @c null argument can be used to obtain the first snapshot
5676	taken on this machine. To traverse the whole tree of snapshots
5677	starting from the root, inspect the root snapshot's
5678	<link to="ISnapshot::children" /> attribute and recurse over those children.
5679
5680	<result name="VBOX_E_OBJECT_NOT_FOUND">
5681	Virtual machine has no snapshots or snapshot not found.
5682	</result>
5683
5684	</desc>
5685	<param name="nameOrId" type="wstring" dir="in">
5686	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5687	</param>
5688	<param name="snapshot" type="ISnapshot" dir="return">
5689	<desc>Snapshot object with the given name.</desc>
5690	</param>
5691	</method>
5692
5693	<method name="createSharedFolder">
5694	<desc>
5695	Creates a new permanent shared folder by associating the given logical
5696	name with the given host path, adds it to the collection of shared
5697	folders and starts sharing it. Refer to the description of
5698	<link to="ISharedFolder"/> to read more about logical names.
5699
5700	<result name="VBOX_E_OBJECT_IN_USE">
5701	Shared folder already exists.
5702	</result>
5703	<result name="VBOX_E_FILE_ERROR">
5704	Shared folder @a hostPath not accessible.
5705	</result>
5706
5707	</desc>
5708	<param name="name" type="wstring" dir="in">
5709	<desc>Unique logical name of the shared folder.</desc>
5710	</param>
5711	<param name="hostPath" type="wstring" dir="in">
5712	<desc>Full path to the shared folder in the host file system.</desc>
5713	</param>
5714	<param name="writable" type="boolean" dir="in">
5715	<desc>Whether the share is writable or readonly.</desc>
5716	</param>
5717	<param name="automount" type="boolean" dir="in">
5718	<desc>Whether the share gets automatically mounted by the guest
5719	or not.</desc>
5720	</param>
5721	</method>
5722
5723	<method name="removeSharedFolder">
5724	<desc>
5725	Removes the permanent shared folder with the given name previously
5726	created by <link to="#createSharedFolder"/> from the collection of
5727	shared folders and stops sharing it.
5728
5729	<result name="VBOX_E_INVALID_VM_STATE">
5730	Virtual machine is not mutable.
5731	</result>
5732	<result name="VBOX_E_OBJECT_NOT_FOUND">
5733	Shared folder @a name does not exist.
5734	</result>
5735
5736	</desc>
5737	<param name="name" type="wstring" dir="in">
5738	<desc>Logical name of the shared folder to remove.</desc>
5739	</param>
5740	</method>
5741
5742	<method name="canShowConsoleWindow">
5743	<desc>
5744	Returns @c true if the VM console process can activate the
5745	console window and bring it to foreground on the desktop of
5746	the host PC.
5747	<note>
5748	This method will fail if a session for this machine is not
5749	currently open.
5750	</note>
5751
5752	<result name="VBOX_E_INVALID_VM_STATE">
5753	Machine session is not open.
5754	</result>
5755
5756	</desc>
5757	<param name="canShow" type="boolean" dir="return">
5758	<desc>
5759	@c true if the console window can be shown and @c false otherwise.
5760	</desc>
5761	</param>
5762	</method>
5763
5764	<method name="showConsoleWindow">
5765	<desc>
5766	Activates the console window and brings it to foreground on
5767	the desktop of the host PC. Many modern window managers on
5768	many platforms implement some sort of focus stealing
5769	prevention logic, so that it may be impossible to activate
5770	a window without the help of the currently active
5771	application. In this case, this method will return a non-zero
5772	identifier that represents the top-level window of the VM
5773	console process. The caller, if it represents a currently
5774	active process, is responsible to use this identifier (in a
5775	platform-dependent manner) to perform actual window
5776	activation.
5777	<note>
5778	This method will fail if a session for this machine is not
5779	currently open.
5780	</note>
5781
5782	<result name="VBOX_E_INVALID_VM_STATE">
5783	Machine session is not open.
5784	</result>
5785
5786	</desc>
5787	<param name="winId" type="long long" dir="return">
5788	<desc>
5789	Platform-dependent identifier of the top-level VM console
5790	window, or zero if this method has performed all actions
5791	necessary to implement the <i>show window</i> semantics for
5792	the given platform and/or VirtualBox front-end.
5793	</desc>
5794	</param>
5795	</method>
5796
5797	<method name="getGuestProperty" const="yes">
5798	<desc>
5799	Reads an entry from the machine's guest property store.
5800
5801	<result name="VBOX_E_INVALID_VM_STATE">
5802	Machine session is not open.
5803	</result>
5804
5805	</desc>
5806	<param name="name" type="wstring" dir="in">
5807	<desc>
5808	The name of the property to read.
5809	</desc>
5810	</param>
5811	<param name="value" type="wstring" dir="out">
5812	<desc>
5813	The value of the property. If the property does not exist then this
5814	will be empty.
5815	</desc>
5816	</param>
5817	<param name="timestamp" type="long long" dir="out">
5818	<desc>
5819	The time at which the property was last modified, as seen by the
5820	server process.
5821	</desc>
5822	</param>
5823	<param name="flags" type="wstring" dir="out">
5824	<desc>
5825	Additional property parameters, passed as a comma-separated list of
5826	"name=value" type entries.
5827	</desc>
5828	</param>
5829	</method>
5830
5831	<method name="getGuestPropertyValue" const="yes">
5832	<desc>
5833	Reads a value from the machine's guest property store.
5834
5835	<result name="VBOX_E_INVALID_VM_STATE">
5836	Machine session is not open.
5837	</result>
5838
5839	</desc>
5840	<param name="property" type="wstring" dir="in">
5841	<desc>
5842	The name of the property to read.
5843	</desc>
5844	</param>
5845	<param name="value" type="wstring" dir="return">
5846	<desc>
5847	The value of the property. If the property does not exist then this
5848	will be empty.
5849	</desc>
5850	</param>
5851	</method>
5852
5853	<method name="getGuestPropertyTimestamp" const="yes">
5854	<desc>
5855	Reads a property timestamp from the machine's guest property store.
5856
5857	<result name="VBOX_E_INVALID_VM_STATE">
5858	Machine session is not open.
5859	</result>
5860
5861	</desc>
5862	<param name="property" type="wstring" dir="in">
5863	<desc>
5864	The name of the property to read.
5865	</desc>
5866	</param>
5867	<param name="value" type="long long" dir="return">
5868	<desc>
5869	The timestamp. If the property does not exist then this will be
5870	empty.
5871	</desc>
5872	</param>
5873	</method>
5874
5875	<method name="setGuestProperty">
5876	<desc>
5877	Sets, changes or deletes an entry in the machine's guest property
5878	store.
5879
5880	<result name="E_ACCESSDENIED">
5881	Property cannot be changed.
5882	</result>
5883	<result name="E_INVALIDARG">
5884	Invalid @a flags.
5885	</result>
5886	<result name="VBOX_E_INVALID_VM_STATE">
5887	Virtual machine is not mutable or session not open.
5888	</result>
5889	<result name="VBOX_E_INVALID_OBJECT_STATE">
5890	Cannot set transient property when machine not running.
5891	</result>
5892
5893	</desc>
5894	<param name="property" type="wstring" dir="in">
5895	<desc>
5896	The name of the property to set, change or delete.
5897	</desc>
5898	</param>
5899	<param name="value" type="wstring" dir="in">
5900	<desc>
5901	The new value of the property to set, change or delete. If the
5902	property does not yet exist and value is non-empty, it will be
5903	created. If the value is @c null or empty, the property will be
5904	deleted if it exists.
5905	</desc>
5906	</param>
5907	<param name="flags" type="wstring" dir="in">
5908	<desc>
5909	Additional property parameters, passed as a comma-separated list of
5910	"name=value" type entries.
5911	</desc>
5912	</param>
5913	</method>
5914
5915	<method name="setGuestPropertyValue">
5916	<desc>
5917	Sets, changes or deletes a value in the machine's guest property
5918	store. The flags field will be left unchanged or created empty for a
5919	new property.
5920
5921	<result name="E_ACCESSDENIED">
5922	Property cannot be changed.
5923	</result>
5924	<result name="VBOX_E_INVALID_VM_STATE">
5925	Virtual machine is not mutable or session not open.
5926	</result>
5927	<result name="VBOX_E_INVALID_OBJECT_STATE">
5928	Cannot set transient property when machine not running.
5929	</result>
5930	</desc>
5931
5932	<param name="property" type="wstring" dir="in">
5933	<desc>
5934	The name of the property to set, change or delete.
5935	</desc>
5936	</param>
5937	<param name="value" type="wstring" dir="in">
5938	<desc>
5939	The new value of the property to set, change or delete. If the
5940	property does not yet exist and value is non-empty, it will be
5941	created. If the value is @c null or empty, the property will be
5942	deleted if it exists.
5943	</desc>
5944	</param>
5945	</method>
5946
5947	<method name="deleteGuestProperty" const="yes">
5948	<desc>
5949	Deletes an entry from the machine's guest property store.
5950
5951	<result name="VBOX_E_INVALID_VM_STATE">
5952	Machine session is not open.
5953	</result>
5954
5955	</desc>
5956	<param name="name" type="wstring" dir="in">
5957	<desc>
5958	The name of the property to delete.
5959	</desc>
5960	</param>
5961	</method>
5962
5963	<method name="enumerateGuestProperties" const="yes">
5964	<desc>
5965	Return a list of the guest properties matching a set of patterns along
5966	with their values, time stamps and flags.
5967	</desc>
5968	<param name="patterns" type="wstring" dir="in">
5969	<desc>
5970	The patterns to match the properties against, separated by '\|'
5971	characters. If this is empty or @c null, all properties will match.
5972	</desc>
5973	</param>
5974	<param name="name" type="wstring" dir="out" safearray="yes">
5975	<desc>
5976	The names of the properties returned.
5977	</desc>
5978	</param>
5979	<param name="value" type="wstring" dir="out" safearray="yes">
5980	<desc>
5981	The values of the properties returned. The array entries match the
5982	corresponding entries in the @a name array.
5983	</desc>
5984	</param>
5985	<param name="timestamp" type="long long" dir="out" safearray="yes">
5986	<desc>
5987	The time stamps of the properties returned. The array entries match
5988	the corresponding entries in the @a name array.
5989	</desc>
5990	</param>
5991	<param name="flags" type="wstring" dir="out" safearray="yes">
5992	<desc>
5993	The flags of the properties returned. The array entries match the
5994	corresponding entries in the @a name array.
5995	</desc>
5996	</param>
5997	</method>
5998
5999	<method name="querySavedGuestSize" const="yes">
6000	<desc>
6001	Returns the guest dimensions from the saved state.
6002	</desc>
6003	<param name="screenId" type="unsigned long" dir="in">
6004	<desc>
6005	Saved guest screen to query info from.
6006	</desc>
6007	</param>
6008	<param name="width" type="unsigned long" dir="out">
6009	<desc>
6010	Guest width at the time of the saved state was taken.
6011	</desc>
6012	</param>
6013	<param name="height" type="unsigned long" dir="out">
6014	<desc>
6015	Guest height at the time of the saved state was taken.
6016	</desc>
6017	</param>
6018	</method>
6019
6020	<method name="querySavedThumbnailSize">
6021	<desc>
6022	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6023	</desc>
6024	<param name="screenId" type="unsigned long" dir="in">
6025	<desc>
6026	Saved guest screen to query info from.
6027	</desc>
6028	</param>
6029	<param name="size" type="unsigned long" dir="out">
6030	<desc>
6031	Size of buffer required to store the bitmap.
6032	</desc>
6033	</param>
6034	<param name="width" type="unsigned long" dir="out">
6035	<desc>
6036	Bitmap width.
6037	</desc>
6038	</param>
6039	<param name="height" type="unsigned long" dir="out">
6040	<desc>
6041	Bitmap height.
6042	</desc>
6043	</param>
6044	</method>
6045
6046	<method name="readSavedThumbnailToArray">
6047	<desc>
6048	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6049	</desc>
6050	<param name="screenId" type="unsigned long" dir="in">
6051	<desc>
6052	Saved guest screen to read from.
6053	</desc>
6054	</param>
6055	<param name="BGR" type="boolean" dir="in">
6056	<desc>
6057	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6058	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6059	</desc>
6060	</param>
6061	<param name="width" type="unsigned long" dir="out">
6062	<desc>
6063	Bitmap width.
6064	</desc>
6065	</param>
6066	<param name="height" type="unsigned long" dir="out">
6067	<desc>
6068	Bitmap height.
6069	</desc>
6070	</param>
6071	<param name="data" type="octet" safearray="yes" dir="return">
6072	<desc>
6073	Array with resulting bitmap data.
6074	</desc>
6075	</param>
6076	</method>
6077
6078	<method name="readSavedThumbnailPNGToArray">
6079	<desc>
6080	Thumbnail in PNG format is retrieved to an array of bytes.
6081	</desc>
6082	<param name="screenId" type="unsigned long" dir="in">
6083	<desc>
6084	Saved guest screen to read from.
6085	</desc>
6086	</param>
6087	<param name="width" type="unsigned long" dir="out">
6088	<desc>
6089	Image width.
6090	</desc>
6091	</param>
6092	<param name="height" type="unsigned long" dir="out">
6093	<desc>
6094	Image height.
6095	</desc>
6096	</param>
6097	<param name="data" type="octet" dir="return" safearray="yes">
6098	<desc>
6099	Array with resulting PNG data.
6100	</desc>
6101	</param>
6102	</method>
6103
6104	<method name="querySavedScreenshotPNGSize">
6105	<desc>
6106	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6107	</desc>
6108	<param name="screenId" type="unsigned long" dir="in">
6109	<desc>
6110	Saved guest screen to query info from.
6111	</desc>
6112	</param>
6113	<param name="size" type="unsigned long" dir="out">
6114	<desc>
6115	Size of buffer required to store the PNG binary data.
6116	</desc>
6117	</param>
6118	<param name="width" type="unsigned long" dir="out">
6119	<desc>
6120	Image width.
6121	</desc>
6122	</param>
6123	<param name="height" type="unsigned long" dir="out">
6124	<desc>
6125	Image height.
6126	</desc>
6127	</param>
6128	</method>
6129
6130	<method name="readSavedScreenshotPNGToArray">
6131	<desc>
6132	Screenshot in PNG format is retrieved to an array of bytes.
6133	</desc>
6134	<param name="screenId" type="unsigned long" dir="in">
6135	<desc>
6136	Saved guest screen to read from.
6137	</desc>
6138	</param>
6139	<param name="width" type="unsigned long" dir="out">
6140	<desc>
6141	Image width.
6142	</desc>
6143	</param>
6144	<param name="height" type="unsigned long" dir="out">
6145	<desc>
6146	Image height.
6147	</desc>
6148	</param>
6149	<param name="data" type="octet" dir="return" safearray="yes">
6150	<desc>
6151	Array with resulting PNG data.
6152	</desc>
6153	</param>
6154	</method>
6155
6156	<method name="hotPlugCPU">
6157	<desc>
6158	Plugs a CPU into the machine.
6159	</desc>
6160	<param name="cpu" type="unsigned long" dir="in">
6161	<desc>
6162	The CPU id to insert.
6163	</desc>
6164	</param>
6165	</method>
6166
6167	<method name="hotUnplugCPU">
6168	<desc>
6169	Removes a CPU from the machine.
6170	</desc>
6171	<param name="cpu" type="unsigned long" dir="in">
6172	<desc>
6173	The CPU id to remove.
6174	</desc>
6175	</param>
6176	</method>
6177
6178	<method name="getCPUStatus">
6179	<desc>
6180	Returns the current status of the given CPU.
6181	</desc>
6182	<param name="cpu" type="unsigned long" dir="in">
6183	<desc>
6184	The CPU id to check for.
6185	</desc>
6186	</param>
6187	<param name="attached" type="boolean" dir="return">
6188	<desc>
6189	Status of the CPU.
6190	</desc>
6191	</param>
6192	</method>
6193
6194	<method name="queryLogFilename">
6195	<desc>
6196	Queries for the VM log file name of an given index. Returns an empty
6197	string if a log file with that index doesn't exists.
6198	</desc>
6199	<param name="idx" type="unsigned long" dir="in">
6200	<desc>
6201	Which log file name to query. 0=current log file.
6202	</desc>
6203	</param>
6204	<param name="filename" type="wstring" dir="return">
6205	<desc>
6206	On return the full path to the log file or an empty string on error.
6207	</desc>
6208	</param>
6209	</method>
6210
6211	<method name="readLog">
6212	<desc>
6213	Reads the VM log file. The chunk size is limited, so even if you
6214	ask for a big piece there might be less data returned.
6215	</desc>
6216	<param name="idx" type="unsigned long" dir="in">
6217	<desc>
6218	Which log file to read. 0=current log file.
6219	</desc>
6220	</param>
6221	<param name="offset" type="long long" dir="in">
6222	<desc>
6223	Offset in the log file.
6224	</desc>
6225	</param>
6226	<param name="size" type="long long" dir="in">
6227	<desc>
6228	Chunk size to read in the log file.
6229	</desc>
6230	</param>
6231	<param name="data" type="octet" dir="return" safearray="yes">
6232	<desc>
6233	Data read from the log file. A data size of 0 means end of file
6234	if the requested chunk size was not 0. This is the unprocessed
6235	file data, i.e. the line ending style depends on the platform of
6236	the system the server is running on.
6237	</desc>
6238	</param>
6239	</method>
6240
6241	<method name="cloneTo">
6242	<desc>
6243	Creates a clone of this machine, either as a full clone (which means
6244	creating independent copies of the hard disk media, save states and so
6245	on), or as a linked clone (which uses its own differencing media,
6246	sharing the parent media with the source machine).
6247
6248	The target machine object must have been created previously with <link
6249	to="IVirtualBox::createMachine"/>, and all the settings will be
6250	transferred except the VM name and the hardware UUID. You can set the
6251	VM name and the new hardware UUID when creating the target machine. The
6252	network MAC addresses are newly created for all newtwork adapters. You
6253	can change that behaviour with the options parameter. The operation is
6254	performed asynchronously, so the machine object will be not be usable
6255	until the @a progress object signals completion.
6256
6257	<result name="E_INVALIDARG">
6258	@a target is @c null.
6259	</result>
6260	</desc>
6261
6262	<param name="target" type="IMachine" dir="in">
6263	<desc>Target machine object.</desc>
6264	</param>
6265	<param name="mode" type="CloneMode" dir="in">
6266	<desc>Which states should be cloned.</desc>
6267	</param>
6268	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6269	<desc>Options for the cloning operation.</desc>
6270	</param>
6271	<param name="progress" type="IProgress" dir="return">
6272	<desc>Progress object to track the operation completion.</desc>
6273	</param>
6274	</method>
6275
6276	</interface>
6277
6278	<!--
6279	// IConsole
6280	/////////////////////////////////////////////////////////////////////////
6281	-->
6282
6283	<interface
6284	name="IVRDEServerInfo" extends="$unknown"
6285	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6286	wsmap="struct"
6287	>
6288	<desc>
6289	Contains information about the remote desktop (VRDE) server capabilities and status.
6290	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6291	</desc>
6292
6293	<attribute name="active" type="boolean" readonly="yes">
6294	<desc>
6295	Whether the remote desktop connection is active.
6296	</desc>
6297	</attribute>
6298
6299	<attribute name="port" type="long" readonly="yes">
6300	<desc>
6301	VRDE server port number. If this property is equal to <tt>0</tt>, then
6302	the VRDE server failed to start, usually because there are no free IP
6303	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6304	server has not yet been started.
6305	</desc>
6306	</attribute>
6307
6308	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6309	<desc>
6310	How many times a client connected.
6311	</desc>
6312	</attribute>
6313
6314	<attribute name="beginTime" type="long long" readonly="yes">
6315	<desc>
6316	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6317	</desc>
6318	</attribute>
6319
6320	<attribute name="endTime" type="long long" readonly="yes">
6321	<desc>
6322	When the last connection was terminated or the current time, if
6323	connection is still active, in milliseconds since 1970-01-01 UTC.
6324	</desc>
6325	</attribute>
6326
6327	<attribute name="bytesSent" type="long long" readonly="yes">
6328	<desc>
6329	How many bytes were sent in last or current, if still active, connection.
6330	</desc>
6331	</attribute>
6332
6333	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6334	<desc>
6335	How many bytes were sent in all connections.
6336	</desc>
6337	</attribute>
6338
6339	<attribute name="bytesReceived" type="long long" readonly="yes">
6340	<desc>
6341	How many bytes were received in last or current, if still active, connection.
6342	</desc>
6343	</attribute>
6344
6345	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6346	<desc>
6347	How many bytes were received in all connections.
6348	</desc>
6349	</attribute>
6350
6351	<attribute name="user" type="wstring" readonly="yes">
6352	<desc>
6353	Login user name supplied by the client.
6354	</desc>
6355	</attribute>
6356
6357	<attribute name="domain" type="wstring" readonly="yes">
6358	<desc>
6359	Login domain name supplied by the client.
6360	</desc>
6361	</attribute>
6362
6363	<attribute name="clientName" type="wstring" readonly="yes">
6364	<desc>
6365	The client name supplied by the client.
6366	</desc>
6367	</attribute>
6368
6369	<attribute name="clientIP" type="wstring" readonly="yes">
6370	<desc>
6371	The IP address of the client.
6372	</desc>
6373	</attribute>
6374
6375	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6376	<desc>
6377	The client software version number.
6378	</desc>
6379	</attribute>
6380
6381	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6382	<desc>
6383	Public key exchange method used when connection was established.
6384	Values: 0 - RDP4 public key exchange scheme.
6385	1 - X509 certificates were sent to client.
6386	</desc>
6387	</attribute>
6388
6389	</interface>
6390
6391	<interface
6392	name="IConsole" extends="$unknown"
6393	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6394	wsmap="managed"
6395	>
6396	<desc>
6397	The IConsole interface represents an interface to control virtual
6398	machine execution.
6399
6400	A console object gets created when a machine has been locked for a
6401	particular session (client process) using <link to="IMachine::lockMachine" />
6402	or <link to="IMachine::launchVMProcess"/>. The console object can
6403	then be found in the session's <link to="ISession::console" /> attribute.
6404
6405	Methods of the IConsole interface allow the caller to query the current
6406	virtual machine execution state, pause the machine or power it down, save
6407	the machine state or take a snapshot, attach and detach removable media
6408	and so on.
6409
6410	<see><link to="ISession"/></see>
6411	</desc>
6412
6413	<attribute name="machine" type="IMachine" readonly="yes">
6414	<desc>
6415	Machine object for this console session.
6416	<note>
6417	This is a convenience property, it has the same value as
6418	<link to="ISession::machine"/> of the corresponding session
6419	object.
6420	</note>
6421	</desc>
6422	</attribute>
6423
6424	<attribute name="state" type="MachineState" readonly="yes">
6425	<desc>
6426	Current execution state of the machine.
6427	<note>
6428	This property always returns the same value as the corresponding
6429	property of the IMachine object for this console session.
6430	For the process that owns (executes) the VM, this is the
6431	preferable way of querying the VM state, because no IPC
6432	calls are made.
6433	</note>
6434	</desc>
6435	</attribute>
6436
6437	<attribute name="guest" type="IGuest" readonly="yes">
6438	<desc>Guest object.</desc>
6439	</attribute>
6440
6441	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6442	<desc>
6443	Virtual keyboard object.
6444	<note>
6445	If the machine is not running, any attempt to use
6446	the returned object will result in an error.
6447	</note>
6448	</desc>
6449	</attribute>
6450
6451	<attribute name="mouse" type="IMouse" readonly="yes">
6452	<desc>
6453	Virtual mouse object.
6454	<note>
6455	If the machine is not running, any attempt to use
6456	the returned object will result in an error.
6457	</note>
6458	</desc>
6459	</attribute>
6460
6461	<attribute name="display" type="IDisplay" readonly="yes">
6462	<desc>Virtual display object.
6463	<note>
6464	If the machine is not running, any attempt to use
6465	the returned object will result in an error.
6466	</note>
6467	</desc>
6468	</attribute>
6469
6470	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6471	<desc>Debugging interface.</desc>
6472	</attribute>
6473
6474	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6475	<desc>
6476	Collection of USB devices currently attached to the virtual
6477	USB controller.
6478	<note>
6479	The collection is empty if the machine is not running.
6480	</note>
6481	</desc>
6482	</attribute>
6483
6484	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6485	<desc>
6486	List of USB devices currently attached to the remote VRDE client.
6487	Once a new device is physically attached to the remote host computer,
6488	it appears in this list and remains there until detached.
6489	</desc>
6490	</attribute>
6491
6492	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6493	<desc>
6494	Collection of shared folders for the current session. These folders
6495	are called transient shared folders because they are available to the
6496	guest OS running inside the associated virtual machine only for the
6497	duration of the session (as opposed to
6498	<link to="IMachine::sharedFolders"/> which represent permanent shared
6499	folders). When the session is closed (e.g. the machine is powered down),
6500	these folders are automatically discarded.
6501
6502	New shared folders are added to the collection using
6503	<link to="#createSharedFolder"/>. Existing shared folders can be
6504	removed using <link to="#removeSharedFolder"/>.
6505	</desc>
6506	</attribute>
6507
6508	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6509	<desc>
6510	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6511	</desc>
6512	</attribute>
6513
6514	<attribute name="eventSource" type="IEventSource" readonly="yes">
6515	<desc>
6516	Event source for console events.
6517	</desc>
6518	</attribute>
6519
6520	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6521	<desc>Array of PCI devices attached to this machine.</desc>
6522	</attribute>
6523
6524	<attribute name="useHostClipboard" type="boolean">
6525	<desc>
6526	Whether the guest clipboard should be connected to the host one or
6527	whether it should only be allowed access to the VRDE clipboard. This
6528	setting may not affect existing guest clipboard connections which
6529	are already connected to the host clipboard.
6530	</desc>
6531	</attribute>
6532
6533	<method name="powerUp">
6534	<desc>
6535	Starts the virtual machine execution using the current machine
6536	state (that is, its current execution state, current settings and
6537	current storage devices).
6538
6539	<note>
6540	This method is only useful for front-ends that want to actually
6541	execute virtual machines in their own process (like the VirtualBox
6542	or VBoxSDL front-ends). Unless you are intending to write such a
6543	front-end, do not call this method. If you simply want to
6544	start virtual machine execution using one of the existing front-ends
6545	(for example the VirtualBox GUI or headless server), use
6546	<link to="IMachine::launchVMProcess"/> instead; these
6547	front-ends will power up the machine automatically for you.
6548	</note>
6549
6550	If the machine is powered off or aborted, the execution will
6551	start from the beginning (as if the real hardware were just
6552	powered on).
6553
6554	If the machine is in the <link to="MachineState_Saved"/> state,
6555	it will continue its execution the point where the state has
6556	been saved.
6557
6558	If the machine <link to="IMachine::teleporterEnabled"/> property is
6559	enabled on the machine being powered up, the machine will wait for an
6560	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6561	state. The returned progress object will have at least three
6562	operations where the last three are defined as: (1) powering up and
6563	starting TCP server, (2) waiting for incoming teleportations, and
6564	(3) perform teleportation. These operations will be reflected as the
6565	last three operations of the progress objected returned by
6566	<link to="IMachine::launchVMProcess"/> as well.
6567
6568	<see><link to="#saveState"/></see>
6569
6570	<result name="VBOX_E_INVALID_VM_STATE">
6571	Virtual machine already running.
6572	</result>
6573	<result name="VBOX_E_HOST_ERROR">
6574	Host interface does not exist or name not set.
6575	</result>
6576	<result name="VBOX_E_FILE_ERROR">
6577	Invalid saved state file.
6578	</result>
6579	</desc>
6580	<param name="progress" type="IProgress" dir="return">
6581	<desc>Progress object to track the operation completion.</desc>
6582	</param>
6583	</method>
6584
6585	<method name="powerUpPaused">
6586	<desc>
6587	Identical to powerUp except that the VM will enter the
6588	<link to="MachineState_Paused"/> state, instead of
6589	<link to="MachineState_Running"/>.
6590
6591	<see><link to="#powerUp"/></see>
6592	<result name="VBOX_E_INVALID_VM_STATE">
6593	Virtual machine already running.
6594	</result>
6595	<result name="VBOX_E_HOST_ERROR">
6596	Host interface does not exist or name not set.
6597	</result>
6598	<result name="VBOX_E_FILE_ERROR">
6599	Invalid saved state file.
6600	</result>
6601	</desc>
6602	<param name="progress" type="IProgress" dir="return">
6603	<desc>Progress object to track the operation completion.</desc>
6604	</param>
6605	</method>
6606
6607	<method name="powerDown">
6608	<desc>
6609	Initiates the power down procedure to stop the virtual machine
6610	execution.
6611
6612	The completion of the power down procedure is tracked using the returned
6613	IProgress object. After the operation is complete, the machine will go
6614	to the PoweredOff state.
6615	<result name="VBOX_E_INVALID_VM_STATE">
6616	Virtual machine must be Running, Paused or Stuck to be powered down.
6617	</result>
6618	</desc>
6619	<param name="progress" type="IProgress" dir="return">
6620	<desc>Progress object to track the operation completion.</desc>
6621	</param>
6622	</method>
6623
6624	<method name="reset">
6625	<desc>Resets the virtual machine.
6626	<result name="VBOX_E_INVALID_VM_STATE">
6627	Virtual machine not in Running state.
6628	</result>
6629	<result name="VBOX_E_VM_ERROR">
6630	Virtual machine error in reset operation.
6631	</result>
6632	</desc>
6633	</method>
6634
6635	<method name="pause">
6636	<desc>Pauses the virtual machine execution.
6637	<result name="VBOX_E_INVALID_VM_STATE">
6638	Virtual machine not in Running state.
6639	</result>
6640	<result name="VBOX_E_VM_ERROR">
6641	Virtual machine error in suspend operation.
6642	</result>
6643	</desc>
6644	</method>
6645
6646	<method name="resume">
6647	<desc>Resumes the virtual machine execution.
6648	<result name="VBOX_E_INVALID_VM_STATE">
6649	Virtual machine not in Paused state.
6650	</result>
6651	<result name="VBOX_E_VM_ERROR">
6652	Virtual machine error in resume operation.
6653	</result>
6654	</desc>
6655	</method>
6656
6657	<method name="powerButton">
6658	<desc>Sends the ACPI power button event to the guest.
6659	<result name="VBOX_E_INVALID_VM_STATE">
6660	Virtual machine not in Running state.
6661	</result>
6662	<result name="VBOX_E_PDM_ERROR">
6663	Controlled power off failed.
6664	</result>
6665	</desc>
6666	</method>
6667
6668	<method name="sleepButton">
6669	<desc>Sends the ACPI sleep button event to the guest.
6670	<result name="VBOX_E_INVALID_VM_STATE">
6671	Virtual machine not in Running state.
6672	</result>
6673	<result name="VBOX_E_PDM_ERROR">
6674	Sending sleep button event failed.
6675	</result>
6676	</desc>
6677	</method>
6678
6679	<method name="getPowerButtonHandled">
6680	<desc>Checks if the last power button event was handled by guest.
6681	<result name="VBOX_E_PDM_ERROR">
6682	Checking if the event was handled by the guest OS failed.
6683	</result>
6684	</desc>
6685	<param name="handled" type="boolean" dir="return"/>
6686	</method>
6687
6688	<method name="getGuestEnteredACPIMode">
6689	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6690	G1 (sleeping). If this method returns @c false, the guest will
6691	most likely not respond to external ACPI events.
6692	<result name="VBOX_E_INVALID_VM_STATE">
6693	Virtual machine not in Running state.
6694	</result>
6695	</desc>
6696	<param name="entered" type="boolean" dir="return"/>
6697	</method>
6698
6699	<method name="saveState">
6700	<desc>
6701	Saves the current execution state of a running virtual machine
6702	and stops its execution.
6703
6704	After this operation completes, the machine will go to the
6705	Saved state. Next time it is powered up, this state will
6706	be restored and the machine will continue its execution from
6707	the place where it was saved.
6708
6709	This operation differs from taking a snapshot to the effect
6710	that it doesn't create new differencing media. Also, once
6711	the machine is powered up from the state saved using this method,
6712	the saved state is deleted, so it will be impossible to return
6713	to this state later.
6714
6715	<note>
6716	On success, this method implicitly calls
6717	<link to="IMachine::saveSettings"/> to save all current machine
6718	settings (including runtime changes to the DVD medium, etc.).
6719	Together with the impossibility to change any VM settings when it is
6720	in the Saved state, this guarantees adequate hardware
6721	configuration of the machine when it is restored from the saved
6722	state file.
6723	</note>
6724
6725	<note>
6726	The machine must be in the Running or Paused state, otherwise
6727	the operation will fail.
6728	</note>
6729	<result name="VBOX_E_INVALID_VM_STATE">
6730	Virtual machine state neither Running nor Paused.
6731	</result>
6732	<result name="VBOX_E_FILE_ERROR">
6733	Failed to create directory for saved state file.
6734	</result>
6735
6736	<see><link to="#takeSnapshot"/></see>
6737	</desc>
6738	<param name="progress" type="IProgress" dir="return">
6739	<desc>Progress object to track the operation completion.</desc>
6740	</param>
6741	</method>
6742
6743	<method name="adoptSavedState">
6744	<desc>
6745	Associates the given saved state file to the virtual machine.
6746
6747	On success, the machine will go to the Saved state. Next time it is
6748	powered up, it will be restored from the adopted saved state and
6749	continue execution from the place where the saved state file was
6750	created.
6751
6752	The specified saved state file path may be absolute or relative to the
6753	folder the VM normally saves the state to (usually,
6754	<link to="IMachine::snapshotFolder"/>).
6755
6756	<note>
6757	It's a caller's responsibility to make sure the given saved state
6758	file is compatible with the settings of this virtual machine that
6759	represent its virtual hardware (memory size, storage disk configuration
6760	etc.). If there is a mismatch, the behavior of the virtual machine
6761	is undefined.
6762	</note>
6763	<result name="VBOX_E_INVALID_VM_STATE">
6764	Virtual machine state neither PoweredOff nor Aborted.
6765	</result>
6766	</desc>
6767	<param name="savedStateFile" type="wstring" dir="in">
6768	<desc>Path to the saved state file to adopt.</desc>
6769	</param>
6770	</method>
6771
6772	<method name="discardSavedState">
6773	<desc>
6774	Forcibly resets the machine to "Powered Off" state if it is
6775	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6776	Next time the machine is powered up, a clean boot will occur.
6777	<note>
6778	This operation is equivalent to resetting or powering off
6779	the machine without doing a proper shutdown of the guest
6780	operating system; as with resetting a running phyiscal
6781	computer, it can can lead to data loss.
6782	</note>
6783	If @a fRemoveFile is @c true, the file in the machine directory
6784	into which the machine state was saved is also deleted. If
6785	this is @c false, then the state can be recovered and later
6786	re-inserted into a machine using <link to="#adoptSavedState" />.
6787	The location of the file can be found in the
6788	<link to="IMachine::stateFilePath" /> attribute.
6789	<result name="VBOX_E_INVALID_VM_STATE">
6790	Virtual machine not in state Saved.
6791	</result>
6792	</desc>
6793	<param name="fRemoveFile" type="boolean" dir="in" >
6794	<desc>Whether to also remove the saved state file.</desc>
6795	</param>
6796	</method>
6797
6798	<method name="getDeviceActivity">
6799	<desc>
6800	Gets the current activity type of a given device or device group.
6801	<result name="E_INVALIDARG">
6802	Invalid device type.
6803	</result>
6804	</desc>
6805	<param name="type" type="DeviceType" dir="in"/>
6806	<param name="activity" type="DeviceActivity" dir="return"/>
6807	</method>
6808
6809	<method name="attachUSBDevice">
6810	<desc>
6811	Attaches a host USB device with the given UUID to the
6812	USB controller of the virtual machine.
6813
6814	The device needs to be in one of the following states:
6815	<link to="USBDeviceState_Busy"/>,
6816	<link to="USBDeviceState_Available"/> or
6817	<link to="USBDeviceState_Held"/>,
6818	otherwise an error is immediately returned.
6819
6820	When the device state is
6821	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6822	be returned if the host computer refuses to release it for some reason.
6823
6824	<see><link to="IUSBController::deviceFilters"/>,
6825	<link to="USBDeviceState"/></see>
6826	<result name="VBOX_E_INVALID_VM_STATE">
6827	Virtual machine state neither Running nor Paused.
6828	</result>
6829	<result name="VBOX_E_PDM_ERROR">
6830	Virtual machine does not have a USB controller.
6831	</result>
6832	</desc>
6833	<param name="id" type="uuid" mod="string" dir="in">
6834	<desc>UUID of the host USB device to attach.</desc>
6835	</param>
6836	</method>
6837
6838	<method name="detachUSBDevice">
6839	<desc>
6840	Detaches an USB device with the given UUID from the USB controller
6841	of the virtual machine.
6842
6843	After this method succeeds, the VirtualBox server re-initiates
6844	all USB filters as if the device were just physically attached
6845	to the host, but filters of this machine are ignored to avoid
6846	a possible automatic re-attachment.
6847
6848	<see><link to="IUSBController::deviceFilters"/>,
6849	<link to="USBDeviceState"/></see>
6850
6851	<result name="VBOX_E_PDM_ERROR">
6852	Virtual machine does not have a USB controller.
6853	</result>
6854	<result name="E_INVALIDARG">
6855	USB device not attached to this virtual machine.
6856	</result>
6857	</desc>
6858	<param name="id" type="uuid" mod="string" dir="in">
6859	<desc>UUID of the USB device to detach.</desc>
6860	</param>
6861	<param name="device" type="IUSBDevice" dir="return">
6862	<desc>Detached USB device.</desc>
6863	</param>
6864	</method>
6865
6866	<method name="findUSBDeviceByAddress">
6867	<desc>
6868	Searches for a USB device with the given host address.
6869
6870	<result name="VBOX_E_OBJECT_NOT_FOUND">
6871	Given @c name does not correspond to any USB device.
6872	</result>
6873
6874	<see><link to="IUSBDevice::address"/></see>
6875	</desc>
6876	<param name="name" type="wstring" dir="in">
6877	<desc>
6878	Address of the USB device (as assigned by the host) to
6879	search for.
6880	</desc>
6881	</param>
6882	<param name="device" type="IUSBDevice" dir="return">
6883	<desc>Found USB device object.</desc>
6884	</param>
6885	</method>
6886
6887	<method name="findUSBDeviceById">
6888	<desc>
6889	Searches for a USB device with the given UUID.
6890
6891	<result name="VBOX_E_OBJECT_NOT_FOUND">
6892	Given @c id does not correspond to any USB device.
6893	</result>
6894
6895	<see><link to="IUSBDevice::id"/></see>
6896	</desc>
6897	<param name="id" type="uuid" mod="string" dir="in">
6898	<desc>UUID of the USB device to search for.</desc>
6899	</param>
6900	<param name="device" type="IUSBDevice" dir="return">
6901	<desc>Found USB device object.</desc>
6902	</param>
6903	</method>
6904
6905	<method name="createSharedFolder">
6906	<desc>
6907	Creates a transient new shared folder by associating the given logical
6908	name with the given host path, adds it to the collection of shared
6909	folders and starts sharing it. Refer to the description of
6910	<link to="ISharedFolder"/> to read more about logical names.
6911
6912	<result name="VBOX_E_INVALID_VM_STATE">
6913	Virtual machine in Saved state or currently changing state.
6914	</result>
6915	<result name="VBOX_E_FILE_ERROR">
6916	Shared folder already exists or not accessible.
6917	</result>
6918	</desc>
6919	<param name="name" type="wstring" dir="in">
6920	<desc>Unique logical name of the shared folder.</desc>
6921	</param>
6922	<param name="hostPath" type="wstring" dir="in">
6923	<desc>Full path to the shared folder in the host file system.</desc>
6924	</param>
6925	<param name="writable" type="boolean" dir="in">
6926	<desc>Whether the share is writable or readonly</desc>
6927	</param>
6928	<param name="automount" type="boolean" dir="in">
6929	<desc>Whether the share gets automatically mounted by the guest
6930	or not.</desc>
6931	</param>
6932	</method>
6933
6934	<method name="removeSharedFolder">
6935	<desc>
6936	Removes a transient shared folder with the given name previously
6937	created by <link to="#createSharedFolder"/> from the collection of
6938	shared folders and stops sharing it.
6939	<result name="VBOX_E_INVALID_VM_STATE">
6940	Virtual machine in Saved state or currently changing state.
6941	</result>
6942	<result name="VBOX_E_FILE_ERROR">
6943	Shared folder does not exists.
6944	</result>
6945	</desc>
6946	<param name="name" type="wstring" dir="in">
6947	<desc>Logical name of the shared folder to remove.</desc>
6948	</param>
6949	</method>
6950
6951	<method name="takeSnapshot">
6952	<desc>
6953	Saves the current execution state
6954	and all settings of the machine and creates differencing images
6955	for all normal (non-independent) media.
6956	See <link to="ISnapshot" /> for an introduction to snapshots.
6957
6958	This method can be called for a PoweredOff, Saved (see
6959	<link to="#saveState"/>), Running or
6960	Paused virtual machine. When the machine is PoweredOff, an
6961	offline snapshot is created. When the machine is Running a live
6962	snapshot is created, and an online snapshot is is created when Paused.
6963
6964	The taken snapshot is always based on the
6965	<link to="IMachine::currentSnapshot">current snapshot</link>
6966	of the associated virtual machine and becomes a new current snapshot.
6967
6968	<note>
6969	This method implicitly calls <link to="IMachine::saveSettings"/> to
6970	save all current machine settings before taking an offline snapshot.
6971	</note>
6972
6973	<result name="VBOX_E_INVALID_VM_STATE">
6974	Virtual machine currently changing state.
6975	</result>
6976	</desc>
6977	<param name="name" type="wstring" dir="in">
6978	<desc>Short name for the snapshot.</desc>
6979	</param>
6980	<param name="description" type="wstring" dir="in">
6981	<desc>Optional description of the snapshot.</desc>
6982	</param>
6983	<param name="progress" type="IProgress" dir="return">
6984	<desc>Progress object to track the operation completion.</desc>
6985	</param>
6986	</method>
6987
6988	<method name="deleteSnapshot">
6989	<desc>
6990	Starts deleting the specified snapshot asynchronously.
6991	See <link to="ISnapshot" /> for an introduction to snapshots.
6992
6993	The execution state and settings of the associated machine stored in
6994	the snapshot will be deleted. The contents of all differencing media of
6995	this snapshot will be merged with the contents of their dependent child
6996	media to keep the medium chain valid (in other words, all changes
6997	represented by media being deleted will be propagated to their child
6998	medium). After that, this snapshot's differencing medium will be
6999	deleted. The parent of this snapshot will become a new parent for all
7000	its child snapshots.
7001
7002	If the deleted snapshot is the current one, its parent snapshot will
7003	become a new current snapshot. The current machine state is not directly
7004	affected in this case, except that currently attached differencing
7005	media based on media of the deleted snapshot will be also merged as
7006	described above.
7007
7008	If the deleted snapshot is the first or current snapshot, then the
7009	respective IMachine attributes will be adjusted. Deleting the current
7010	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7011	to make all current machine settings permanent.
7012
7013	Deleting a snapshot has the following preconditions:
7014
7015	<ul>
7016	<li>Child media of all normal media of the deleted snapshot
7017	must be accessible (see <link to="IMedium::state"/>) for this
7018	operation to succeed. If only one running VM refers to all images
7019	which participates in merging the operation can be performed while
7020	the VM is running. Otherwise all virtual machines whose media are
7021	directly or indirectly based on the media of deleted snapshot must
7022	be powered off. In any case, online snapshot deleting usually is
7023	slower than the same operation without any running VM.</li>
7024
7025	<li>You cannot delete the snapshot if a medium attached to it has
7026	more than one child medium (differencing images) because otherwise
7027	merging would be impossible. This might be the case if there is
7028	more than one child snapshot or differencing images were created
7029	for other reason (e.g. implicitly because of multiple machine
7030	attachments).</li>
7031	</ul>
7032
7033	The virtual machine's <link to="IMachine::state">state</link> is
7034	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7035	"DeletingSnapshotPaused" while this operation is in progress.
7036
7037	<note>
7038	Merging medium contents can be very time and disk space
7039	consuming, if these media are big in size and have many
7040	children. However, if the snapshot being deleted is the last
7041	(head) snapshot on the branch, the operation will be rather
7042	quick.
7043	</note>
7044	<result name="VBOX_E_INVALID_VM_STATE">
7045	The running virtual machine prevents deleting this snapshot. This
7046	happens only in very specific situations, usually snapshots can be
7047	deleted without trouble while a VM is running. The error message
7048	text explains the reason for the failure.
7049	</result>
7050	</desc>
7051	<param name="id" type="uuid" mod="string" dir="in">
7052	<desc>UUID of the snapshot to delete.</desc>
7053	</param>
7054	<param name="progress" type="IProgress" dir="return">
7055	<desc>Progress object to track the operation completion.</desc>
7056	</param>
7057	</method>
7058
7059	<method name="deleteSnapshotAndAllChildren">
7060	<desc>
7061	Starts deleting the specified snapshot and all its children
7062	asynchronously. See <link to="ISnapshot" /> for an introduction to
7063	snapshots. The conditions and many details are the same as with
7064	<link to="#deleteSnapshot"/>.
7065
7066	This operation is very fast if the snapshot subtree does not include
7067	the current state. It is still significantly faster than deleting the
7068	snapshots one by one if the current state is in the subtree and there
7069	are more than one snapshots from current state to the snapshot which
7070	marks the subtree, since it eliminates the incremental image merging.
7071
7072	<note>This API method is right now not implemented!</note>
7073
7074	<result name="VBOX_E_INVALID_VM_STATE">
7075	The running virtual machine prevents deleting this snapshot. This
7076	happens only in very specific situations, usually snapshots can be
7077	deleted without trouble while a VM is running. The error message
7078	text explains the reason for the failure.
7079	</result>
7080	<result name="E_NOTIMPL">
7081	The method is not implemented yet.
7082	</result>
7083	</desc>
7084	<param name="id" type="uuid" mod="string" dir="in">
7085	<desc>UUID of the snapshot to delete, including all its children.</desc>
7086	</param>
7087	<param name="progress" type="IProgress" dir="return">
7088	<desc>Progress object to track the operation completion.</desc>
7089	</param>
7090	</method>
7091
7092	<method name="deleteSnapshotRange">
7093	<desc>
7094	Starts deleting the specified snapshot range. This is limited to
7095	linear snapshot lists, which means there may not be any other child
7096	snapshots other than the direct sequence between the start and end
7097	snapshot. If the start and end snapshot point to the same snapshot this
7098	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7099	<link to="ISnapshot" /> for an introduction to snapshots. The
7100	conditions and many details are the same as with
7101	<link to="#deleteSnapshot"/>.
7102
7103	This operation is generally faster than deleting snapshots one by one
7104	and often also needs less extra disk space before freeing up disk space
7105	by deleting the removed disk images corresponding to the snapshot.
7106
7107	<note>This API method is right now not implemented!</note>
7108
7109	<result name="VBOX_E_INVALID_VM_STATE">
7110	The running virtual machine prevents deleting this snapshot. This
7111	happens only in very specific situations, usually snapshots can be
7112	deleted without trouble while a VM is running. The error message
7113	text explains the reason for the failure.
7114	</result>
7115	<result name="E_NOTIMPL">
7116	The method is not implemented yet.
7117	</result>
7118	</desc>
7119	<param name="startId" type="uuid" mod="string" dir="in">
7120	<desc>UUID of the first snapshot to delete.</desc>
7121	</param>
7122	<param name="endId" type="uuid" mod="string" dir="in">
7123	<desc>UUID of the last snapshot to delete.</desc>
7124	</param>
7125	<param name="progress" type="IProgress" dir="return">
7126	<desc>Progress object to track the operation completion.</desc>
7127	</param>
7128	</method>
7129
7130	<method name="restoreSnapshot">
7131	<desc>
7132	Starts resetting the machine's current state to the state contained
7133	in the given snapshot, asynchronously. All current settings of the
7134	machine will be reset and changes stored in differencing media
7135	will be lost.
7136	See <link to="ISnapshot" /> for an introduction to snapshots.
7137
7138	After this operation is successfully completed, new empty differencing
7139	media are created for all normal media of the machine.
7140
7141	If the given snapshot is an online snapshot, the machine will go to
7142	the <link to="MachineState_Saved"> saved state</link>, so that the
7143	next time it is powered on, the execution state will be restored
7144	from the state of the snapshot.
7145
7146	<note>
7147	The machine must not be running, otherwise the operation will fail.
7148	</note>
7149
7150	<note>
7151	If the machine state is <link to="MachineState_Saved">Saved</link>
7152	prior to this operation, the saved state file will be implicitly
7153	deleted (as if <link to="IConsole::discardSavedState"/> were
7154	called).
7155	</note>
7156
7157	<result name="VBOX_E_INVALID_VM_STATE">
7158	Virtual machine is running.
7159	</result>
7160	</desc>
7161	<param name="snapshot" type="ISnapshot" dir="in">
7162	<desc>The snapshot to restore the VM state from.</desc>
7163	</param>
7164	<param name="progress" type="IProgress" dir="return">
7165	<desc>Progress object to track the operation completion.</desc>
7166	</param>
7167	</method>
7168
7169	<method name="teleport">
7170	<desc>
7171	Teleport the VM to a different host machine or process.
7172
7173	TODO explain the details.
7174
7175	<result name="VBOX_E_INVALID_VM_STATE">
7176	Virtual machine not running or paused.
7177	</result>
7178	</desc>
7179	<param name="hostname" type="wstring" dir="in">
7180	<desc>The name or IP of the host to teleport to.</desc>
7181	</param>
7182	<param name="tcpport" type="unsigned long" dir="in">
7183	<desc>The TCP port to connect to (1..65535).</desc>
7184	</param>
7185	<param name="password" type="wstring" dir="in">
7186	<desc>The password.</desc>
7187	</param>
7188	<param name="maxDowntime" type="unsigned long" dir="in">
7189	<desc>
7190	The maximum allowed downtime given as milliseconds. 0 is not a valid
7191	value. Recommended value: 250 ms.
7192
7193	The higher the value is, the greater the chance for a successful
7194	teleportation. A small value may easily result in the teleportation
7195	process taking hours and eventually fail.
7196
7197	<note>
7198	The current implementation treats this a guideline, not as an
7199	absolute rule.
7200	</note>
7201	</desc>
7202	</param>
7203	<param name="progress" type="IProgress" dir="return">
7204	<desc>Progress object to track the operation completion.</desc>
7205	</param>
7206	</method>
7207
7208	</interface>
7209
7210	<!--
7211	// IHost
7212	/////////////////////////////////////////////////////////////////////////
7213	-->
7214
7215	<enum
7216	name="HostNetworkInterfaceMediumType"
7217	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7218	>
7219	<desc>
7220	Type of encapsulation. Ethernet encapsulation includes both wired and
7221	wireless Ethernet connections.
7222	<see><link to="IHostNetworkInterface"/></see>
7223	</desc>
7224
7225	<const name="Unknown" value="0">
7226	<desc>
7227	The type of interface cannot be determined.
7228	</desc>
7229	</const>
7230	<const name="Ethernet" value="1">
7231	<desc>
7232	Ethernet frame encapsulation.
7233	</desc>
7234	</const>
7235	<const name="PPP" value="2">
7236	<desc>
7237	Point-to-point protocol encapsulation.
7238	</desc>
7239	</const>
7240	<const name="SLIP" value="3">
7241	<desc>
7242	Serial line IP encapsulation.
7243	</desc>
7244	</const>
7245	</enum>
7246
7247	<enum
7248	name="HostNetworkInterfaceStatus"
7249	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7250	>
7251	<desc>
7252	Current status of the interface.
7253	<see><link to="IHostNetworkInterface"/></see>
7254	</desc>
7255
7256	<const name="Unknown" value="0">
7257	<desc>
7258	The state of interface cannot be determined.
7259	</desc>
7260	</const>
7261	<const name="Up" value="1">
7262	<desc>
7263	The interface is fully operational.
7264	</desc>
7265	</const>
7266	<const name="Down" value="2">
7267	<desc>
7268	The interface is not functioning.
7269	</desc>
7270	</const>
7271	</enum>
7272
7273	<enum
7274	name="HostNetworkInterfaceType"
7275	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7276	>
7277	<desc>
7278	Network interface type.
7279	</desc>
7280	<const name="Bridged" value="1"/>
7281	<const name="HostOnly" value="2"/>
7282	</enum>
7283
7284	<interface
7285	name="IHostNetworkInterface" extends="$unknown"
7286	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7287	wsmap="managed"
7288	>
7289	<desc>
7290	Represents one of host's network interfaces. IP V6 address and network
7291	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7292	separated by colons.
7293	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7294	</desc>
7295	<attribute name="name" type="wstring" readonly="yes">
7296	<desc>Returns the host network interface name.</desc>
7297	</attribute>
7298
7299	<attribute name="id" type="uuid" mod="string" readonly="yes">
7300	<desc>Returns the interface UUID.</desc>
7301	</attribute>
7302
7303	<attribute name="networkName" type="wstring" readonly="yes">
7304	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7305	</attribute>
7306
7307	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7308	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7309	</attribute>
7310
7311	<attribute name="IPAddress" type="wstring" readonly="yes">
7312	<desc>Returns the IP V4 address of the interface.</desc>
7313	</attribute>
7314
7315	<attribute name="networkMask" type="wstring" readonly="yes">
7316	<desc>Returns the network mask of the interface.</desc>
7317	</attribute>
7318
7319	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7320	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7321	</attribute>
7322
7323	<attribute name="IPV6Address" type="wstring" readonly="yes">
7324	<desc>Returns the IP V6 address of the interface.</desc>
7325	</attribute>
7326
7327	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7328	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7329	</attribute>
7330
7331	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7332	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7333	</attribute>
7334
7335	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7336	<desc>Type of protocol encapsulation used.</desc>
7337	</attribute>
7338
7339	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7340	<desc>Status of the interface.</desc>
7341	</attribute>
7342
7343	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7344	<desc>specifies the host interface type.</desc>
7345	</attribute>
7346
7347	<method name="enableStaticIpConfig">
7348	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7349	<param name="IPAddress" type="wstring" dir="in">
7350	<desc>
7351	IP address.
7352	</desc>
7353	</param>
7354	<param name="networkMask" type="wstring" dir="in">
7355	<desc>
7356	network mask.
7357	</desc>
7358	</param>
7359	</method>
7360
7361	<method name="enableStaticIpConfigV6">
7362	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7363	<param name="IPV6Address" type="wstring" dir="in">
7364	<desc>
7365	IP address.
7366	</desc>
7367	</param>
7368	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7369	<desc>
7370	network mask.
7371	</desc>
7372	</param>
7373	</method>
7374
7375	<method name="enableDynamicIpConfig">
7376	<desc>enables the dynamic IP configuration.</desc>
7377	</method>
7378
7379	<method name="dhcpRediscover">
7380	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7381	</method>
7382
7383	</interface>
7384
7385	<interface
7386	name="IHost" extends="$unknown"
7387	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7388	wsmap="managed"
7389	>
7390	<desc>
7391	The IHost interface represents the physical machine that this VirtualBox
7392	installation runs on.
7393
7394	An object implementing this interface is returned by the
7395	<link to="IVirtualBox::host" /> attribute. This interface contains
7396	read-only information about the host's physical hardware (such as what
7397	processors and disks are available, what the host operating system is,
7398	and so on) and also allows for manipulating some of the host's hardware,
7399	such as global USB device filters and host interface networking.
7400
7401	</desc>
7402	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7403	<desc>List of DVD drives available on the host.</desc>
7404	</attribute>
7405
7406	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7407	<desc>List of floppy drives available on the host.</desc>
7408	</attribute>
7409
7410	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7411	<desc>
7412	List of USB devices currently attached to the host.
7413	Once a new device is physically attached to the host computer,
7414	it appears in this list and remains there until detached.
7415
7416	<note>
7417	If USB functionality is not available in the given edition of
7418	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7419	</note>
7420	</desc>
7421	</attribute>
7422
7423	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7424	<desc>
7425	List of USB device filters in action.
7426	When a new device is physically attached to the host computer,
7427	filters from this list are applied to it (in order they are stored
7428	in the list). The first matched filter will determine the
7429	<link to="IHostUSBDeviceFilter::action">action</link>
7430	performed on the device.
7431
7432	Unless the device is ignored by these filters, filters of all
7433	currently running virtual machines
7434	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7435
7436	<note>
7437	If USB functionality is not available in the given edition of
7438	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7439	</note>
7440
7441	<see><link to="IHostUSBDeviceFilter"/>,
7442	<link to="USBDeviceState"/></see>
7443	</desc>
7444	</attribute>
7445
7446	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7447	<desc>List of host network interfaces currently defined on the host.</desc>
7448	</attribute>
7449
7450	<attribute name="processorCount" type="unsigned long" readonly="yes">
7451	<desc>Number of (logical) CPUs installed in the host system.</desc>
7452	</attribute>
7453
7454	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7455	<desc>Number of (logical) CPUs online in the host system.</desc>
7456	</attribute>
7457
7458	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7459	<desc>Number of physical processor cores installed in the host system.</desc>
7460	</attribute>
7461
7462	<method name="getProcessorSpeed">
7463	<desc>Query the (approximate) maximum speed of a specified host CPU in
7464	Megahertz.
7465	</desc>
7466	<param name="cpuId" type="unsigned long" dir="in">
7467	<desc>
7468	Identifier of the CPU.
7469	</desc>
7470	</param>
7471	<param name="speed" type="unsigned long" dir="return">
7472	<desc>
7473	Speed value. 0 is returned if value is not known or @a cpuId is
7474	invalid.
7475	</desc>
7476	</param>
7477	</method>
7478
7479	<method name="getProcessorFeature">
7480	<desc>Query whether a CPU feature is supported or not.</desc>
7481	<param name="feature" type="ProcessorFeature" dir="in">
7482	<desc>
7483	CPU Feature identifier.
7484	</desc>
7485	</param>
7486	<param name="supported" type="boolean" dir="return">
7487	<desc>
7488	Feature is supported or not.
7489	</desc>
7490	</param>
7491	</method>
7492
7493	<method name="getProcessorDescription">
7494	<desc>Query the model string of a specified host CPU.
7495	</desc>
7496	<param name="cpuId" type="unsigned long" dir="in">
7497	<desc>
7498	Identifier of the CPU.
7499	<note>
7500	The current implementation might not necessarily return the
7501	description for this exact CPU.
7502	</note>
7503	</desc>
7504	</param>
7505	<param name="description" type="wstring" dir="return">
7506	<desc>
7507	Model string. An empty string is returned if value is not known or
7508	@a cpuId is invalid.
7509	</desc>
7510	</param>
7511	</method>
7512
7513	<method name="getProcessorCPUIDLeaf">
7514	<desc>
7515	Returns the CPU cpuid information for the specified leaf.
7516	</desc>
7517	<param name="cpuId" type="unsigned long" dir="in">
7518	<desc>
7519	Identifier of the CPU. The CPU most be online.
7520	<note>
7521	The current implementation might not necessarily return the
7522	description for this exact CPU.
7523	</note>
7524	</desc>
7525	</param>
7526	<param name="leaf" type="unsigned long" dir="in">
7527	<desc>
7528	CPUID leaf index (eax).
7529	</desc>
7530	</param>
7531	<param name="subLeaf" type="unsigned long" dir="in">
7532	<desc>
7533	CPUID leaf sub index (ecx). This currently only applies to cache
7534	information on Intel CPUs. Use 0 if retrieving values for
7535	<link to="IMachine::setCPUIDLeaf"/>.
7536	</desc>
7537	</param>
7538	<param name="valEax" type="unsigned long" dir="out">
7539	<desc>
7540	CPUID leaf value for register eax.
7541	</desc>
7542	</param>
7543	<param name="valEbx" type="unsigned long" dir="out">
7544	<desc>
7545	CPUID leaf value for register ebx.
7546	</desc>
7547	</param>
7548	<param name="valEcx" type="unsigned long" dir="out">
7549	<desc>
7550	CPUID leaf value for register ecx.
7551	</desc>
7552	</param>
7553	<param name="valEdx" type="unsigned long" dir="out">
7554	<desc>
7555	CPUID leaf value for register edx.
7556	</desc>
7557	</param>
7558	</method>
7559
7560	<attribute name="memorySize" type="unsigned long" readonly="yes">
7561	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7562	</attribute>
7563
7564	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7565	<desc>Available system memory in the host system.</desc>
7566	</attribute>
7567
7568	<attribute name="operatingSystem" type="wstring" readonly="yes">
7569	<desc>Name of the host system's operating system.</desc>
7570	</attribute>
7571
7572	<attribute name="OSVersion" type="wstring" readonly="yes">
7573	<desc>Host operating system's version string.</desc>
7574	</attribute>
7575
7576	<attribute name="UTCTime" type="long long" readonly="yes">
7577	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7578	</attribute>
7579
7580	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7581	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7582	</attribute>
7583
7584	<method name="createHostOnlyNetworkInterface">
7585	<desc>
7586	Creates a new adapter for Host Only Networking.
7587	<result name="E_INVALIDARG">
7588	Host network interface @a name already exists.
7589	</result>
7590	</desc>
7591	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7592	<desc>
7593	Created host interface object.
7594	</desc>
7595	</param>
7596	<param name="progress" type="IProgress" dir="return">
7597	<desc>
7598	Progress object to track the operation completion.
7599	</desc>
7600	</param>
7601	</method>
7602
7603	<method name="removeHostOnlyNetworkInterface">
7604	<desc>
7605	Removes the given Host Only Networking interface.
7606	<result name="VBOX_E_OBJECT_NOT_FOUND">
7607	No host network interface matching @a id found.
7608	</result>
7609	</desc>
7610	<param name="id" type="uuid" mod="string" dir="in">
7611	<desc>
7612	Adapter GUID.
7613	</desc>
7614	</param>
7615	<param name="progress" type="IProgress" dir="return">
7616	<desc>
7617	Progress object to track the operation completion.
7618	</desc>
7619	</param>
7620	</method>
7621
7622	<method name="createUSBDeviceFilter">
7623	<desc>
7624	Creates a new USB device filter. All attributes except
7625	the filter name are set to empty (any match),
7626	<i>active</i> is @c false (the filter is not active).
7627
7628	The created filter can be added to the list of filters using
7629	<link to="#insertUSBDeviceFilter"/>.
7630
7631	<see><link to="#USBDeviceFilters"/></see>
7632	</desc>
7633	<param name="name" type="wstring" dir="in">
7634	<desc>
7635	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7636	</desc>
7637	</param>
7638	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7639	<desc>Created filter object.</desc>
7640	</param>
7641	</method>
7642
7643	<method name="insertUSBDeviceFilter">
7644	<desc>
7645	Inserts the given USB device to the specified position
7646	in the list of filters.
7647
7648	Positions are numbered starting from @c 0. If the specified
7649	position is equal to or greater than the number of elements in
7650	the list, the filter is added at the end of the collection.
7651
7652	<note>
7653	Duplicates are not allowed, so an attempt to insert a
7654	filter already in the list is an error.
7655	</note>
7656	<note>
7657	If USB functionality is not available in the given edition of
7658	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7659	</note>
7660
7661	<see><link to="#USBDeviceFilters"/></see>
7662
7663	<result name="VBOX_E_INVALID_OBJECT_STATE">
7664	USB device filter is not created within this VirtualBox instance.
7665	</result>
7666	<result name="E_INVALIDARG">
7667	USB device filter already in list.
7668	</result>
7669
7670	</desc>
7671	<param name="position" type="unsigned long" dir="in">
7672	<desc>Position to insert the filter to.</desc>
7673	</param>
7674	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7675	<desc>USB device filter to insert.</desc>
7676	</param>
7677	</method>
7678
7679	<method name="removeUSBDeviceFilter">
7680	<desc>
7681	Removes a USB device filter from the specified position in the
7682	list of filters.
7683
7684	Positions are numbered starting from @c 0. Specifying a
7685	position equal to or greater than the number of elements in
7686	the list will produce an error.
7687
7688	<note>
7689	If USB functionality is not available in the given edition of
7690	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7691	</note>
7692
7693	<see><link to="#USBDeviceFilters"/></see>
7694
7695	<result name="E_INVALIDARG">
7696	USB device filter list empty or invalid @a position.
7697	</result>
7698
7699	</desc>
7700	<param name="position" type="unsigned long" dir="in">
7701	<desc>Position to remove the filter from.</desc>
7702	</param>
7703	</method>
7704
7705	<method name="findHostDVDDrive">
7706	<desc>
7707	Searches for a host DVD drive with the given @c name.
7708
7709	<result name="VBOX_E_OBJECT_NOT_FOUND">
7710	Given @c name does not correspond to any host drive.
7711	</result>
7712
7713	</desc>
7714	<param name="name" type="wstring" dir="in">
7715	<desc>Name of the host drive to search for</desc>
7716	</param>
7717	<param name="drive" type="IMedium" dir="return">
7718	<desc>Found host drive object</desc>
7719	</param>
7720	</method>
7721
7722	<method name="findHostFloppyDrive">
7723	<desc>
7724	Searches for a host floppy drive with the given @c name.
7725
7726	<result name="VBOX_E_OBJECT_NOT_FOUND">
7727	Given @c name does not correspond to any host floppy drive.
7728	</result>
7729
7730	</desc>
7731	<param name="name" type="wstring" dir="in">
7732	<desc>Name of the host floppy drive to search for</desc>
7733	</param>
7734	<param name="drive" type="IMedium" dir="return">
7735	<desc>Found host floppy drive object</desc>
7736	</param>
7737	</method>
7738
7739	<method name="findHostNetworkInterfaceByName">
7740	<desc>
7741	Searches through all host network interfaces for an interface with
7742	the given @c name.
7743	<note>
7744	The method returns an error if the given @c name does not
7745	correspond to any host network interface.
7746	</note>
7747	</desc>
7748	<param name="name" type="wstring" dir="in">
7749	<desc>Name of the host network interface to search for.</desc>
7750	</param>
7751	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7752	<desc>Found host network interface object.</desc>
7753	</param>
7754	</method>
7755	<method name="findHostNetworkInterfaceById">
7756	<desc>
7757	Searches through all host network interfaces for an interface with
7758	the given GUID.
7759	<note>
7760	The method returns an error if the given GUID does not
7761	correspond to any host network interface.
7762	</note>
7763	</desc>
7764	<param name="id" type="uuid" mod="string" dir="in">
7765	<desc>GUID of the host network interface to search for.</desc>
7766	</param>
7767	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7768	<desc>Found host network interface object.</desc>
7769	</param>
7770	</method>
7771	<method name="findHostNetworkInterfacesOfType">
7772	<desc>
7773	Searches through all host network interfaces and returns a list of interfaces of the specified type
7774	</desc>
7775	<param name="type" type="HostNetworkInterfaceType" dir="in">
7776	<desc>type of the host network interfaces to search for.</desc>
7777	</param>
7778	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7779	<desc>Found host network interface objects.</desc>
7780	</param>
7781	</method>
7782
7783	<method name="findUSBDeviceById">
7784	<desc>
7785	Searches for a USB device with the given UUID.
7786
7787	<result name="VBOX_E_OBJECT_NOT_FOUND">
7788	Given @c id does not correspond to any USB device.
7789	</result>
7790
7791	<see><link to="IUSBDevice::id"/></see>
7792	</desc>
7793	<param name="id" type="uuid" mod="string" dir="in">
7794	<desc>UUID of the USB device to search for.</desc>
7795	</param>
7796	<param name="device" type="IHostUSBDevice" dir="return">
7797	<desc>Found USB device object.</desc>
7798	</param>
7799	</method>
7800
7801	<method name="findUSBDeviceByAddress">
7802	<desc>
7803	Searches for a USB device with the given host address.
7804
7805	<result name="VBOX_E_OBJECT_NOT_FOUND">
7806	Given @c name does not correspond to any USB device.
7807	</result>
7808
7809	<see><link to="IUSBDevice::address"/></see>
7810	</desc>
7811	<param name="name" type="wstring" dir="in">
7812	<desc>
7813	Address of the USB device (as assigned by the host) to
7814	search for.
7815	</desc>
7816	</param>
7817	<param name="device" type="IHostUSBDevice" dir="return">
7818	<desc>Found USB device object.</desc>
7819	</param>
7820	</method>
7821
7822	<method name="generateMACAddress">
7823	<desc>
7824	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7825	</desc>
7826	<param name="address" type="wstring" dir="return">
7827	<desc>New Ethernet MAC address.</desc>
7828	</param>
7829	</method>
7830
7831	</interface>
7832
7833	<!--
7834	// ISystemProperties
7835	/////////////////////////////////////////////////////////////////////////
7836	-->
7837
7838	<interface
7839	name="ISystemProperties"
7840	extends="$unknown"
7841	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7842	wsmap="managed"
7843	>
7844	<desc>
7845	The ISystemProperties interface represents global properties of the given
7846	VirtualBox installation.
7847
7848	These properties define limits and default values for various attributes
7849	and parameters. Most of the properties are read-only, but some can be
7850	changed by a user.
7851	</desc>
7852
7853	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7854	<desc>Minimum guest system memory in Megabytes.</desc>
7855	</attribute>
7856
7857	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7858	<desc>Maximum guest system memory in Megabytes.</desc>
7859	</attribute>
7860
7861	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7862	<desc>Minimum guest video memory in Megabytes.</desc>
7863	</attribute>
7864
7865	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7866	<desc>Maximum guest video memory in Megabytes.</desc>
7867	</attribute>
7868
7869	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7870	<desc>Minimum CPU count.</desc>
7871	</attribute>
7872
7873	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7874	<desc>Maximum CPU count.</desc>
7875	</attribute>
7876
7877	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7878	<desc>Maximum of monitors which could be connected.</desc>
7879	</attribute>
7880
7881	<attribute name="infoVDSize" type="long long" readonly="yes">
7882	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7883	does not reflect the limits of any virtual disk image format.</desc>
7884	</attribute>
7885
7886	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7887	<desc>
7888	Maximum number of serial ports associated with every
7889	<link to="IMachine"/> instance.
7890	</desc>
7891	</attribute>
7892
7893	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7894	<desc>
7895	Maximum number of parallel ports associated with every
7896	<link to="IMachine"/> instance.
7897	</desc>
7898	</attribute>
7899
7900	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7901	<desc>
7902	Maximum device position in the boot order. This value corresponds
7903	to the total number of devices a machine can boot from, to make it
7904	possible to include all possible devices to the boot list.
7905	<see><link to="IMachine::setBootOrder"/></see>
7906	</desc>
7907	</attribute>
7908
7909	<attribute name="defaultMachineFolder" type="wstring">
7910	<desc>
7911	Full path to the default directory used to create new or open
7912	existing machines when a machine settings file name contains no
7913	path.
7914
7915	Starting with VirtualBox 4.0, by default, this attribute contains
7916	the full path of folder named "VirtualBox VMs" in the user's
7917	home directory, which depends on the host platform.
7918
7919	When setting this attribute, a full path must be specified.
7920	Setting this property to @c null or an empty string or the
7921	special value "Machines" (for compatibility reasons) will restore
7922	that default value.
7923
7924	If the folder specified herein does not exist, it will be created
7925	automatically as needed.
7926
7927	<see>
7928	<link to="IVirtualBox::createMachine"/>,
7929	<link to="IVirtualBox::openMachine"/>
7930	</see>
7931	</desc>
7932	</attribute>
7933
7934	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7935	<desc>
7936	List of all medium storage formats supported by this VirtualBox
7937	installation.
7938
7939	Keep in mind that the medium format identifier
7940	(<link to="IMediumFormat::id"/>) used in other API calls like
7941	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7942	medium format is a case-insensitive string. This means that, for
7943	example, all of the following strings:
7944	<pre>
7945	"VDI"
7946	"vdi"
7947	"VdI"</pre>
7948	refer to the same medium format.
7949
7950	Note that the virtual medium framework is backend-based, therefore
7951	the list of supported formats depends on what backends are currently
7952	installed.
7953
7954	<see><link to="IMediumFormat"/></see>
7955	</desc>
7956	</attribute>
7957
7958	<attribute name="defaultHardDiskFormat" type="wstring">
7959	<desc>
7960	Identifier of the default medium format used by VirtualBox.
7961
7962	The medium format set by this attribute is used by VirtualBox
7963	when the medium format was not specified explicitly. One example is
7964	<link to="IVirtualBox::createHardDisk"/> with the empty
7965	format argument. A more complex example is implicit creation of
7966	differencing media when taking a snapshot of a virtual machine:
7967	this operation will try to use a format of the parent medium first
7968	and if this format does not support differencing media the default
7969	format specified by this argument will be used.
7970
7971	The list of supported medium formats may be obtained by the
7972	<link to="#mediumFormats"/> call. Note that the default medium
7973	format must have a capability to create differencing media;
7974	otherwise operations that create media implicitly may fail
7975	unexpectedly.
7976
7977	The initial value of this property is <tt>"VDI"</tt> in the current
7978	version of the VirtualBox product, but may change in the future.
7979
7980	<note>
7981	Setting this property to @c null or empty string will restore the
7982	initial value.
7983	</note>
7984
7985	<see>
7986	<link to="#mediumFormats"/>,
7987	<link to="IMediumFormat::id"/>,
7988	<link to="IVirtualBox::createHardDisk"/>
7989	</see>
7990	</desc>
7991	</attribute>
7992
7993	<attribute name="freeDiskSpaceWarning" type="long long">
7994	<desc>Issue a warning if the free disk space is below (or in some disk
7995	intensive operation is expected to go below) the given size in
7996	bytes.</desc>
7997	</attribute>
7998
7999	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8000	<desc>Issue a warning if the free disk space is below (or in some disk
8001	intensive operation is expected to go below) the given percentage.</desc>
8002	</attribute>
8003
8004	<attribute name="freeDiskSpaceError" type="long long">
8005	<desc>Issue an error if the free disk space is below (or in some disk
8006	intensive operation is expected to go below) the given size in
8007	bytes.</desc>
8008	</attribute>
8009
8010	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8011	<desc>Issue an error if the free disk space is below (or in some disk
8012	intensive operation is expected to go below) the given percentage.</desc>
8013	</attribute>
8014
8015	<attribute name="VRDEAuthLibrary" type="wstring">
8016	<desc>
8017	Library that provides authentication for Remote Desktop clients. The library
8018	is used if a virtual machine's authentication type is set to "external"
8019	in the VM RemoteDisplay configuration.
8020
8021	The system library extension (".DLL" or ".so") must be omitted.
8022	A full path can be specified; if not, then the library must reside on the
8023	system's default library path.
8024
8025	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8026	of that name in one of the default VirtualBox library directories.
8027
8028	For details about VirtualBox authentication libraries and how to implement
8029	them, please refer to the VirtualBox manual.
8030
8031	<note>
8032	Setting this property to @c null or empty string will restore the
8033	initial value.
8034	</note>
8035	</desc>
8036	</attribute>
8037
8038	<attribute name="webServiceAuthLibrary" type="wstring">
8039	<desc>
8040	Library that provides authentication for webservice clients. The library
8041	is used if a virtual machine's authentication type is set to "external"
8042	in the VM RemoteDisplay configuration and will be called from
8043	within the <link to="IWebsessionManager::logon" /> implementation.
8044
8045	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8046	there is no per-VM setting for this, as the webservice is a global
8047	resource (if it is running). Only for this setting (for the webservice),
8048	setting this value to a literal <tt>"null"</tt> string disables authentication,
8049	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8050	no matter what user name and password are supplied.
8051
8052	The initial value of this property is <tt>"VBoxAuth"</tt>,
8053	meaning that the webservice will use the same authentication
8054	library that is used by default for VRDE (again, see
8055	<link to="ISystemProperties::VRDEAuthLibrary" />).
8056	The format and calling convention of authentication libraries
8057	is the same for the webservice as it is for VRDE.
8058
8059	<note>
8060	Setting this property to @c null or empty string will restore the
8061	initial value.
8062	</note>
8063	</desc>
8064	</attribute>
8065
8066	<attribute name="defaultVRDEExtPack" type="wstring">
8067	<desc>
8068	The name of the extension pack providing the default VRDE.
8069
8070	This attribute is for choosing between multiple extension packs
8071	providing VRDE. If only one is installed, it will automatically be the
8072	default one. The attribute value can be empty if no VRDE extension
8073	pack is installed.
8074
8075	For details about VirtualBox Remote Desktop Extension and how to
8076	implement one, please refer to the VirtualBox SDK.
8077	</desc>
8078	</attribute>
8079
8080	<attribute name="logHistoryCount" type="unsigned long">
8081	<desc>
8082	This value specifies how many old release log files are kept.
8083	</desc>
8084	</attribute>
8085
8086	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8087	<desc>This value hold the default audio driver for the current
8088	system.</desc>
8089	</attribute>
8090
8091
8092	<method name="getMaxNetworkAdapters">
8093	<desc>
8094	Maximum total number of network adapters associated with every
8095	<link to="IMachine"/> instance.
8096	</desc>
8097
8098	<param name="chipset" type="ChipsetType" dir="in">
8099	<desc>The chipset type to get the value for.</desc>
8100	</param>
8101
8102
8103	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8104	<desc>The maximum total number of network adapters allowed.</desc>
8105	</param>
8106
8107	</method>
8108
8109	<method name="getMaxNetworkAdaptersOfType">
8110	<desc>
8111	Maximum number of network adapters of a given attachment type,
8112	associated with every <link to="IMachine"/> instance.
8113	</desc>
8114
8115	<param name="chipset" type="ChipsetType" dir="in">
8116	<desc>The chipset type to get the value for.</desc>
8117	</param>
8118
8119	<param name="type" type="NetworkAttachmentType" dir="in">
8120	<desc>Type of attachment.</desc>
8121	</param>
8122
8123	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8124	<desc>The maximum number of network adapters allowed for
8125	particular chipset and attachment type.</desc>
8126	</param>
8127
8128	</method>
8129
8130
8131	<method name="getMaxDevicesPerPortForStorageBus">
8132	<desc>Returns the maximum number of devices which can be attached to a port
8133	for the given storage bus.</desc>
8134
8135	<param name="bus" type="StorageBus" dir="in">
8136	<desc>The storage bus type to get the value for.</desc>
8137	</param>
8138
8139	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8140	<desc>The maximum number of devices which can be attached to the port for the given
8141	storage bus.</desc>
8142	</param>
8143	</method>
8144
8145	<method name="getMinPortCountForStorageBus">
8146	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8147
8148	<param name="bus" type="StorageBus" dir="in">
8149	<desc>The storage bus type to get the value for.</desc>
8150	</param>
8151
8152	<param name="minPortCount" type="unsigned long" dir="return">
8153	<desc>The minimum number of ports for the given storage bus.</desc>
8154	</param>
8155	</method>
8156
8157	<method name="getMaxPortCountForStorageBus">
8158	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8159
8160	<param name="bus" type="StorageBus" dir="in">
8161	<desc>The storage bus type to get the value for.</desc>
8162	</param>
8163
8164	<param name="maxPortCount" type="unsigned long" dir="return">
8165	<desc>The maximum number of ports for the given storage bus.</desc>
8166	</param>
8167	</method>
8168
8169	<method name="getMaxInstancesOfStorageBus">
8170	<desc>Returns the maximum number of storage bus instances which
8171	can be configured for each VM. This corresponds to the number of
8172	storage controllers one can have. Value may depend on chipset type
8173	used.</desc>
8174
8175	<param name="chipset" type="ChipsetType" dir="in">
8176	<desc>The chipset type to get the value for.</desc>
8177	</param>
8178
8179	<param name="bus" type="StorageBus" dir="in">
8180	<desc>The storage bus type to get the value for.</desc>
8181	</param>
8182
8183	<param name="maxInstances" type="unsigned long" dir="return">
8184	<desc>The maximum number of instances for the given storage bus.</desc>
8185	</param>
8186	</method>
8187
8188	<method name="getDeviceTypesForStorageBus">
8189	<desc>Returns list of all the supported device types
8190	(<link to="DeviceType"/>) for the given type of storage
8191	bus.</desc>
8192
8193	<param name="bus" type="StorageBus" dir="in">
8194	<desc>The storage bus type to get the value for.</desc>
8195	</param>
8196
8197	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8198	<desc>The list of all supported device types for the given storage bus.</desc>
8199	</param>
8200	</method>
8201
8202	<method name="getDefaultIoCacheSettingForStorageController">
8203	<desc>Returns the default I/O cache setting for the
8204	given storage controller</desc>
8205
8206	<param name="controllerType" type="StorageControllerType" dir="in">
8207	<desc>The storage controller to the setting for.</desc>
8208	</param>
8209
8210	<param name="enabled" type="boolean" dir="return">
8211	<desc>Returned flag indicating the default value</desc>
8212	</param>
8213	</method>
8214	</interface>
8215
8216	<!--
8217	// IGuest
8218	/////////////////////////////////////////////////////////////////////////
8219	-->
8220
8221	<interface
8222	name="IGuestOSType" extends="$unknown"
8223	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8224	wsmap="struct"
8225	>
8226	<desc>
8227	</desc>
8228
8229	<attribute name="familyId" type="wstring" readonly="yes">
8230	<desc>Guest OS family identifier string.</desc>
8231	</attribute>
8232
8233	<attribute name="familyDescription" type="wstring" readonly="yes">
8234	<desc>Human readable description of the guest OS family.</desc>
8235	</attribute>
8236
8237	<attribute name="id" type="wstring" readonly="yes">
8238	<desc>Guest OS identifier string.</desc>
8239	</attribute>
8240
8241	<attribute name="description" type="wstring" readonly="yes">
8242	<desc>Human readable description of the guest OS.</desc>
8243	</attribute>
8244
8245	<attribute name="is64Bit" type="boolean" readonly="yes">
8246	<desc>Returns @c true if the given OS is 64-bit</desc>
8247	</attribute>
8248
8249	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8250	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8251	</attribute>
8252
8253	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8254	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8255	</attribute>
8256
8257	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8258	<desc>Recommended RAM size in Megabytes.</desc>
8259	</attribute>
8260
8261	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8262	<desc>Recommended video RAM size in Megabytes.</desc>
8263	</attribute>
8264
8265	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8266	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8267	</attribute>
8268
8269	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8270	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8271	</attribute>
8272
8273	<attribute name="recommendedHDD" type="long long" readonly="yes">
8274	<desc>Recommended hard disk size in bytes.</desc>
8275	</attribute>
8276
8277	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8278	<desc>Returns recommended network adapter for this OS type.</desc>
8279	</attribute>
8280
8281	<attribute name="recommendedPae" type="boolean" readonly="yes">
8282	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8283	</attribute>
8284
8285	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8286	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8287	</attribute>
8288
8289	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8290	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8291	</attribute>
8292
8293	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8294	<desc>Recommended storage controller type for HD drives.</desc>
8295	</attribute>
8296
8297	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8298	<desc>Recommended storage bus type for HD drives.</desc>
8299	</attribute>
8300
8301	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8302	<desc>Recommended firmware type.</desc>
8303	</attribute>
8304
8305	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8306	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8307	</attribute>
8308
8309	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8310	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8311	</attribute>
8312
8313	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8314	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8315	</attribute>
8316
8317	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8318	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8319	</attribute>
8320
8321	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8322	<desc>Recommended chipset type.</desc>
8323	</attribute>
8324
8325	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8326	<desc>Recommended audio type.</desc>
8327	</attribute>
8328
8329	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8330	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8331	</attribute>
8332
8333	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8334	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8335	</attribute>
8336
8337	</interface>
8338
8339	<enum
8340	name="AdditionsFacilityType"
8341	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8342	>
8343	<desc>
8344	Guest Additions facility IDs.
8345	</desc>
8346
8347	<const name="None" value="0">
8348	<desc>No/invalid facility.</desc>
8349	</const>
8350	<const name="VBoxGuestDriver" value="20">
8351	<desc>VirtualBox base driver (VBoxGuest).</desc>
8352	</const>
8353	<const name="AutoLogon" value="90">
8354	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8355	</const>
8356	<const name="VBoxService" value="100">
8357	<desc>VirtualBox system service (VBoxService).</desc>
8358	</const>
8359	<const name="VBoxTrayClient" value="101">
8360	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8361	</const>
8362	<const name="Seamless" value="1000">
8363	<desc>Seamless guest desktop integration.</desc>
8364	</const>
8365	<const name="Graphics" value="1100">
8366	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8367	are not immediately acted on and guest display resizes are probably not initiated by
8368	the guest additions.
8369	</desc>
8370	</const>
8371	<const name="All" value="2147483646">
8372	<desc>All facilities selected.</desc>
8373	</const>
8374	</enum>
8375
8376	<enum
8377	name="AdditionsFacilityClass"
8378	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8379	>
8380	<desc>
8381	Guest Additions facility classes.
8382	</desc>
8383
8384	<const name="None" value="0">
8385	<desc>No/invalid class.</desc>
8386	</const>
8387	<const name="Driver" value="10">
8388	<desc>Driver.</desc>
8389	</const>
8390	<const name="Service" value="30">
8391	<desc>System service.</desc>
8392	</const>
8393	<const name="Program" value="50">
8394	<desc>Program.</desc>
8395	</const>
8396	<const name="Feature" value="100">
8397	<desc>Feature.</desc>
8398	</const>
8399	<const name="ThirdParty" value="999">
8400	<desc>Third party.</desc>
8401	</const>
8402	<const name="All" value="2147483646">
8403	<desc>All facility classes selected.</desc>
8404	</const>
8405	</enum>
8406
8407	<enum
8408	name="AdditionsFacilityStatus"
8409	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8410	>
8411	<desc>
8412	Guest Additions facility states.
8413	</desc>
8414
8415	<const name="Inactive" value="0">
8416	<desc>Facility is not active.</desc>
8417	</const>
8418	<const name="Paused" value="1">
8419	<desc>Facility has been paused.</desc>
8420	</const>
8421	<const name="PreInit" value="20">
8422	<desc>Facility is preparing to initialize.</desc>
8423	</const>
8424	<const name="Init" value="30">
8425	<desc>Facility is initializing.</desc>
8426	</const>
8427	<const name="Active" value="50">
8428	<desc>Facility is up and running.</desc>
8429	</const>
8430	<const name="Terminating" value="100">
8431	<desc>Facility is shutting down.</desc>
8432	</const>
8433	<const name="Terminated" value="101">
8434	<desc>Facility successfully shut down.</desc>
8435	</const>
8436	<const name="Failed" value="800">
8437	<desc>Facility failed to start.</desc>
8438	</const>
8439	<const name="Unknown" value="999">
8440	<desc>Facility status is unknown.</desc>
8441	</const>
8442	</enum>
8443
8444	<interface
8445	name="IAdditionsFacility" extends="$unknown"
8446	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8447	wsmap="struct"
8448	>
8449	<desc>
8450	Structure representing a Guest Additions facility.
8451	</desc>
8452
8453	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8454	<desc>The class this facility is part of.</desc>
8455	</attribute>
8456
8457	<attribute name="lastUpdated" type="long long" readonly="yes">
8458	<desc>
8459	Time stamp of the last status update,
8460	in milliseconds since 1970-01-01 UTC.
8461	</desc>
8462	</attribute>
8463
8464	<attribute name="name" type="wstring" readonly="yes">
8465	<desc>The facility's friendly name.</desc>
8466	</attribute>
8467
8468	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8469	<desc>The current status.</desc>
8470	</attribute>
8471
8472	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8473	<desc>The facility's type ID.</desc>
8474	</attribute>
8475	</interface>
8476
8477	<enum
8478	name="AdditionsRunLevelType"
8479	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8480	>
8481	<desc>
8482	Guest Additions run level type.
8483	</desc>
8484
8485	<const name="None" value="0">
8486	<desc>Guest Additions are not loaded.</desc>
8487	</const>
8488	<const name="System" value="1">
8489	<desc>Guest drivers are loaded.</desc>
8490	</const>
8491	<const name="Userland" value="2">
8492	<desc>Common components (such as application services) are loaded.</desc>
8493	</const>
8494	<const name="Desktop" value="3">
8495	<desc>Per-user desktop components are loaded.</desc>
8496	</const>
8497	</enum>
8498
8499	<enum
8500	name="AdditionsUpdateFlag"
8501	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8502	>
8503	<desc>
8504	Guest Additions update flags.
8505	</desc>
8506
8507	<const name="None" value="0">
8508	<desc>No flag set.</desc>
8509	</const>
8510	<const name="WaitForUpdateStartOnly" value="1">
8511	<desc>Only wait for the update process being started and do not
8512	wait while peforming the actual update.</desc>
8513	</const>
8514	</enum>
8515
8516	<enum
8517	name="ExecuteProcessFlag"
8518	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8519	>
8520	<desc>
8521	Guest process execution flags.
8522	</desc>
8523
8524	<const name="None" value="0">
8525	<desc>No flag set.</desc>
8526	</const>
8527	<const name="WaitForProcessStartOnly" value="1">
8528	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8529	process itself then uses an infinite timeout.</desc>
8530	</const>
8531	<const name="IgnoreOrphanedProcesses" value="2">
8532	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8533	</const>
8534	<const name="Hidden" value="4">
8535	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8536	</const>
8537	<const name="NoProfile" value="8">
8538	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8539	</const>
8540	<const name="WaitForStdOut" value="16">
8541	<desc>The guest process waits until all data from stdout is read out.</desc>
8542	</const>
8543	<const name="WaitForStdErr" value="32">
8544	<desc>The guest process waits until all data from stderr is read out.</desc>
8545	</const>
8546	</enum>
8547
8548	<enum
8549	name="ExecuteProcessStatus"
8550	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8551	>
8552	<desc>
8553	Guest process execution status.
8554	</desc>
8555	<const name="Undefined" value="0">
8556	<desc>Process is in an undefined state.</desc>
8557	</const>
8558
8559	<const name="Started" value="1">
8560	<desc>Process has been started.</desc>
8561	</const>
8562	<const name="TerminatedNormally" value="2">
8563	<desc>Process terminated normally.</desc>
8564	</const>
8565	<const name="TerminatedSignal" value="3">
8566	<desc>Process terminated via signal.</desc>
8567	</const>
8568	<const name="TerminatedAbnormally" value="4">
8569	<desc>Process terminated abnormally.</desc>
8570	</const>
8571	<const name="TimedOutKilled" value="5">
8572	<desc>Process timed out and was killed.</desc>
8573	</const>
8574	<const name="TimedOutAbnormally" value="6">
8575	<desc>Process timed out and was not killed successfully.</desc>
8576	</const>
8577	<const name="Down" value="7">
8578	<desc>Service/OS is stopping, process was killed.</desc>
8579	</const>
8580	<const name="Error" value="8">
8581	<desc>Something went wrong (error code in flags).</desc>
8582	</const>
8583	</enum>
8584
8585	<enum
8586	name="ProcessInputFlag"
8587	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8588	>
8589	<desc>
8590	Guest process input flags.
8591	</desc>
8592	<const name="None" value="0">
8593	<desc>No flag set.</desc>
8594	</const>
8595	<const name="EndOfFile" value="1">
8596	<desc>End of file (input) reached.</desc>
8597	</const>
8598	</enum>
8599
8600	<enum
8601	name="ProcessOutputFlag"
8602	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8603	>
8604	<desc>
8605	Guest process output flags for specifying which
8606	type of output to retrieve.
8607	</desc>
8608	<const name="None" value="0">
8609	<desc>No flags set. Get output from stdout.</desc>
8610	</const>
8611	<const name="StdErr" value="1">
8612	<desc>Get output from stderr.</desc>
8613	</const>
8614	</enum>
8615
8616	<enum
8617	name="CopyFileFlag"
8618	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8619	>
8620	<desc>
8621	Host/Guest copy flags. At the moment none of these flags
8622	are implemented.
8623	</desc>
8624	<const name="None" value="0">
8625	<desc>No flag set.</desc>
8626	</const>
8627	<const name="Recursive" value="1">
8628	<desc>Copy directories recursively.</desc>
8629	</const>
8630	<const name="Update" value="2">
8631	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8632	</const>
8633	<const name="FollowLinks" value="4">
8634	<desc>Follow symbolic links.</desc>
8635	</const>
8636	</enum>
8637
8638	<enum
8639	name="DirectoryCreateFlag"
8640	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8641	>
8642	<desc>
8643	Directory creation flags.
8644	</desc>
8645	<const name="None" value="0">
8646	<desc>No flag set.</desc>
8647	</const>
8648	<const name="Parents" value="1">
8649	<desc>No error if existing, make parent directories as needed.</desc>
8650	</const>
8651	</enum>
8652
8653	<enum
8654	name="DragAndDropAction"
8655	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8656	>
8657	<desc>
8658	Possible actions within an Drag and Drop operation.
8659	</desc>
8660
8661	<const name="Ignore" value="0">
8662	<desc>Do nothing.</desc>
8663	</const>
8664
8665	<const name="Copy" value="1">
8666	<desc>Copy the item to the target.</desc>
8667	</const>
8668
8669	<const name="Move" value="2">
8670	<desc>Move the item to the target.</desc>
8671	</const>
8672
8673	<const name="Link" value="3">
8674	<desc>Link the item from within the target.</desc>
8675	</const>
8676	</enum>
8677
8678	<enum
8679	name="DirectoryOpenFlag"
8680	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8681	>
8682	<desc>
8683	Directory open flags.
8684	</desc>
8685	<const name="None" value="0">
8686	<desc>No flag set.</desc>
8687	</const>
8688	</enum>
8689
8690	<enum
8691	name="GuestDirEntryType"
8692	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8693	>
8694	<desc>
8695	Guest directory entry type.
8696	</desc>
8697	<const name="Unknown" value="0">
8698	<desc>Unknown.</desc>
8699	</const>
8700	<const name="Directory" value="4">
8701	<desc>Regular file.</desc>
8702	</const>
8703	<const name="File" value="10">
8704	<desc>Regular file.</desc>
8705	</const>
8706	<const name="Symlink" value="12">
8707	<desc>Symbolic link.</desc>
8708	</const>
8709	</enum>
8710
8711	<interface
8712	name="IGuestDirEntry" extends="$unknown"
8713	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8714	wsmap="struct"
8715	>
8716	<desc>
8717	Structure representing a directory entry on the guest OS.
8718	</desc>
8719	<attribute name="nodeId" type="long long" readonly="yes">
8720	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8721	</attribute>
8722	<attribute name="name" type="wstring" readonly="yes">
8723	<desc>The filename.</desc>
8724	</attribute>
8725	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8726	<desc>The entry type.</desc>
8727	</attribute>
8728	</interface>
8729
8730	<interface
8731	name="IGuest" extends="$unknown"
8732	uuid="88696240-7411-4fe6-bb5e-ef56fb8a61f3"
8733	wsmap="managed"
8734	>
8735	<desc>
8736	The IGuest interface represents information about the operating system
8737	running inside the virtual machine. Used in
8738	<link to="IConsole::guest"/>.
8739
8740	IGuest provides information about the guest operating system, whether
8741	Guest Additions are installed and other OS-specific virtual machine
8742	properties.
8743	</desc>
8744
8745	<attribute name="OSTypeId" type="wstring" readonly="yes">
8746	<desc>
8747	Identifier of the Guest OS type as reported by the Guest
8748	Additions.
8749	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8750	an IGuestOSType object representing details about the given
8751	Guest OS type.
8752	<note>
8753	If Guest Additions are not installed, this value will be
8754	the same as <link to="IMachine::OSTypeId"/>.
8755	</note>
8756	</desc>
8757	</attribute>
8758
8759	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8760	<desc>
8761	Current run level of the Guest Additions.
8762	</desc>
8763	</attribute>
8764
8765	<attribute name="additionsVersion" type="wstring" readonly="yes">
8766	<desc>
8767	Version of the Guest Additions in the same format as
8768	<link to="IVirtualBox::version"/>.
8769	</desc>
8770	</attribute>
8771
8772	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
8773	<desc>
8774	The internal build revision number of the additions.
8775
8776	See also <link to="IVirtualBox::revision"/>.
8777	</desc>
8778	</attribute>
8779
8780	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8781	<desc>
8782	Array of current known facilities. Only returns facilities where a status is known,
8783	e.g. facilities with an unknown status will not be returned.
8784	</desc>
8785	</attribute>
8786
8787	<attribute name="memoryBalloonSize" type="unsigned long">
8788	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8789	</attribute>
8790
8791	<attribute name="statisticsUpdateInterval" type="unsigned long">
8792	<desc>Interval to update guest statistics in seconds.</desc>
8793	</attribute>
8794
8795	<method name="internalGetStatistics">
8796	<desc>
8797	Internal method; do not use as it might change at any time.
8798	</desc>
8799	<param name="cpuUser" type="unsigned long" dir="out">
8800	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8801	</param>
8802	<param name="cpuKernel" type="unsigned long" dir="out">
8803	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8804	</param>
8805	<param name="cpuIdle" type="unsigned long" dir="out">
8806	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8807	</param>
8808	<param name="memTotal" type="unsigned long" dir="out">
8809	<desc>Total amount of physical guest RAM.</desc>
8810	</param>
8811	<param name="memFree" type="unsigned long" dir="out">
8812	<desc>Free amount of physical guest RAM.</desc>
8813	</param>
8814	<param name="memBalloon" type="unsigned long" dir="out">
8815	<desc>Amount of ballooned physical guest RAM.</desc>
8816	</param>
8817	<param name="memShared" type="unsigned long" dir="out">
8818	<desc>Amount of shared physical guest RAM.</desc>
8819	</param>
8820	<param name="memCache" type="unsigned long" dir="out">
8821	<desc>Total amount of guest (disk) cache memory.</desc>
8822	</param>
8823	<param name="pagedTotal" type="unsigned long" dir="out">
8824	<desc>Total amount of space in the page file.</desc>
8825	</param>
8826	<param name="memAllocTotal" type="unsigned long" dir="out">
8827	<desc>Total amount of memory allocated by the hypervisor.</desc>
8828	</param>
8829	<param name="memFreeTotal" type="unsigned long" dir="out">
8830	<desc>Total amount of free memory available in the hypervisor.</desc>
8831	</param>
8832	<param name="memBalloonTotal" type="unsigned long" dir="out">
8833	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8834	</param>
8835	<param name="memSharedTotal" type="unsigned long" dir="out">
8836	<desc>Total amount of shared memory in the hypervisor.</desc>
8837	</param>
8838	</method>
8839
8840	<method name="getFacilityStatus">
8841	<desc>
8842	Get the current status of a Guest Additions facility.
8843	</desc>
8844	<param name="facility" type="AdditionsFacilityType" dir="in">
8845	<desc>Facility to check status for.</desc>
8846	</param>
8847	<param name="timestamp" type="long long" dir="out">
8848	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8849	</param>
8850	<param name="status" type="AdditionsFacilityStatus" dir="return">
8851	<desc>The current (latest) facility status.</desc>
8852	</param>
8853	</method>
8854
8855	<method name="getAdditionsStatus">
8856	<desc>
8857	Retrieve the current status of a certain Guest Additions run level.
8858
8859	<result name="VBOX_E_NOT_SUPPORTED">
8860	Wrong status level specified.
8861	</result>
8862
8863	</desc>
8864	<param name="level" type="AdditionsRunLevelType" dir="in">
8865	<desc>Status level to check</desc>
8866	</param>
8867	<param name="active" type="boolean" dir="return">
8868	<desc>Flag whether the status level has been reached or not</desc>
8869	</param>
8870	</method>
8871
8872	<method name="setCredentials">
8873	<desc>
8874	Store login credentials that can be queried by guest operating
8875	systems with Additions installed. The credentials are transient
8876	to the session and the guest may also choose to erase them. Note
8877	that the caller cannot determine whether the guest operating system
8878	has queried or made use of the credentials.
8879
8880	<result name="VBOX_E_VM_ERROR">
8881	VMM device is not available.
8882	</result>
8883
8884	</desc>
8885	<param name="userName" type="wstring" dir="in">
8886	<desc>User name string, can be empty</desc>
8887	</param>
8888	<param name="password" type="wstring" dir="in">
8889	<desc>Password string, can be empty</desc>
8890	</param>
8891	<param name="domain" type="wstring" dir="in">
8892	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8893	</param>
8894	<param name="allowInteractiveLogon" type="boolean" dir="in">
8895	<desc>
8896	Flag whether the guest should alternatively allow the user to
8897	interactively specify different credentials. This flag might
8898	not be supported by all versions of the Additions.
8899	</desc>
8900	</param>
8901	</method>
8902
8903	<method name="dragHGEnter">
8904	<desc>
8905	Informs the guest about a Drag and Drop enter event.
8906
8907	This is used in Host - Guest direction.
8908
8909	<result name="VBOX_E_VM_ERROR">
8910	VMM device is not available.
8911	</result>
8912
8913	</desc>
8914	<param name="screenId" type="unsigned long" dir="in">
8915	<desc>The screen id where the Drag and Drop event occured.</desc>
8916	</param>
8917	<param name="y" type="unsigned long" dir="in">
8918	<desc>y-position of the event.</desc>
8919	</param>
8920	<param name="x" type="unsigned long" dir="in">
8921	<desc>x-position of the event.</desc>
8922	</param>
8923	<param name="defaultAction" type="DragAndDropAction" dir="in">
8924	<desc>The default action to use.</desc>
8925	</param>
8926	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8927	<desc>The actions which are allowed.</desc>
8928	</param>
8929	<param name="formats" type="wstring" dir="in" safearray="yes">
8930	<desc>The supported mime types.</desc>
8931	</param>
8932	<param name="resultAction" type="DragAndDropAction" dir="return">
8933	<desc>The resulting action of this event.</desc>
8934	</param>
8935	</method>
8936
8937	<method name="dragHGMove">
8938	<desc>
8939	Informs the guest about a Drag and Drop move event.
8940
8941	This is used in Host - Guest direction.
8942
8943	<result name="VBOX_E_VM_ERROR">
8944	VMM device is not available.
8945	</result>
8946
8947	</desc>
8948	<param name="screenId" type="unsigned long" dir="in">
8949	<desc>The screen id where the Drag and Drop event occured.</desc>
8950	</param>
8951	<param name="x" type="unsigned long" dir="in">
8952	<desc>x-position of the event.</desc>
8953	</param>
8954	<param name="y" type="unsigned long" dir="in">
8955	<desc>y-position of the event.</desc>
8956	</param>
8957	<param name="defaultAction" type="DragAndDropAction" dir="in">
8958	<desc>The default action to use.</desc>
8959	</param>
8960	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8961	<desc>The actions which are allowed.</desc>
8962	</param>
8963	<param name="formats" type="wstring" dir="in" safearray="yes">
8964	<desc>The supported mime types.</desc>
8965	</param>
8966	<param name="resultAction" type="DragAndDropAction" dir="return">
8967	<desc>The resulting action of this event.</desc>
8968	</param>
8969	</method>
8970
8971	<method name="dragHGLeave">
8972	<desc>
8973	Informs the guest about a Drag and Drop leave event.
8974
8975	This is used in Host - Guest direction.
8976
8977	<result name="VBOX_E_VM_ERROR">
8978	VMM device is not available.
8979	</result>
8980
8981	</desc>
8982	<param name="screenId" type="unsigned long" dir="in">
8983	<desc>The screen id where the Drag and Drop event occured.</desc>
8984	</param>
8985	</method>
8986
8987	<method name="dragHGDrop">
8988	<desc>
8989	Informs the guest about a drop event.
8990
8991	This is used in Host - Guest direction.
8992
8993	<result name="VBOX_E_VM_ERROR">
8994	VMM device is not available.
8995	</result>
8996
8997	</desc>
8998	<param name="screenId" type="unsigned long" dir="in">
8999	<desc>The screen id where the Drag and Drop event occured.</desc>
9000	</param>
9001	<param name="x" type="unsigned long" dir="in">
9002	<desc>x-position of the event.</desc>
9003	</param>
9004	<param name="y" type="unsigned long" dir="in">
9005	<desc>y-position of the event.</desc>
9006	</param>
9007	<param name="defaultAction" type="DragAndDropAction" dir="in">
9008	<desc>The default action to use.</desc>
9009	</param>
9010	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9011	<desc>The actions which are allowed.</desc>
9012	</param>
9013	<param name="formats" type="wstring" dir="in" safearray="yes">
9014	<desc>The supported mime types.</desc>
9015	</param>
9016	<param name="format" type="wstring" dir="out">
9017	<desc>The resulting format of this event.</desc>
9018	</param>
9019	<param name="resultAction" type="DragAndDropAction" dir="return">
9020	<desc>The resulting action of this event.</desc>
9021	</param>
9022	</method>
9023
9024	<method name="dragHGPutData">
9025	<desc>
9026	Informs the guest about a drop data event.
9027
9028	This is used in Host - Guest direction.
9029
9030	<result name="VBOX_E_VM_ERROR">
9031	VMM device is not available.
9032	</result>
9033
9034	</desc>
9035	<param name="screenId" type="unsigned long" dir="in">
9036	<desc>The screen id where the Drag and Drop event occured.</desc>
9037	</param>
9038	<param name="format" type="wstring" dir="in">
9039	<desc>The mime type the data is in.</desc>
9040	</param>
9041	<param name="data" type="octet" dir="in" safearray="yes">
9042	<desc>The actual data.</desc>
9043	</param>
9044	<param name="progress" type="IProgress" dir="return">
9045	<desc>Progress object to track the operation completion.</desc>
9046	</param>
9047	</method>
9048
9049	<method name="dragGHPending">
9050	<desc>
9051	Ask the guest if there is any Drag and Drop operation pending in the guest.
9052
9053	If no Drag and Drop operation is pending currently, Ignore is returned.
9054
9055	This is used in Guest - Host direction.
9056
9057	<result name="VBOX_E_VM_ERROR">
9058	VMM device is not available.
9059	</result>
9060
9061	</desc>
9062	<param name="screenId" type="unsigned long" dir="in">
9063	<desc>The screen id where the Drag and Drop event occured.</desc>
9064	</param>
9065	<param name="format" type="wstring" dir="out" safearray="yes">
9066	<desc>On return the supported mime types.</desc>
9067	</param>
9068	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
9069	<desc>On return the actions which are allowed.</desc>
9070	</param>
9071	<param name="defaultAction" type="DragAndDropAction" dir="return">
9072	<desc>On return the default action to use.</desc>
9073	</param>
9074	</method>
9075
9076	<method name="dragGHDropped">
9077	<desc>
9078	Informs the guest that a drop event occured for a pending Drag and Drop event.
9079
9080	This is used in Guest - Host direction.
9081
9082	<result name="VBOX_E_VM_ERROR">
9083	VMM device is not available.
9084	</result>
9085
9086	</desc>
9087
9088	<param name="format" type="wstring" dir="in">
9089	<desc>The mime type the data must be in.</desc>
9090	</param>
9091	<param name="action" type="DragAndDropAction" dir="in">
9092	<desc>The action to use.</desc>
9093	</param>
9094	<param name="progress" type="IProgress" dir="return">
9095	<desc>Progress object to track the operation completion.</desc>
9096	</param>
9097	</method>
9098
9099	<method name="dragGHGetData">
9100	<desc>
9101	Fetch the data of a previously Drag and Drop event from the guest.
9102
9103	This is used in Guest - Host direction.
9104
9105	<result name="VBOX_E_VM_ERROR">
9106	VMM device is not available.
9107	</result>
9108
9109	</desc>
9110
9111	<param name="data" type="octet" safearray="yes" dir="return">
9112	<desc>The actual data.</desc>
9113	</param>
9114	</method>
9115
9116	<method name="executeProcess">
9117	<desc>
9118	Executes an existing program inside the guest VM.
9119
9120	<note>
9121	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9122	to serve up to 25 guest processes at a time. If all 25 guest processes
9123	are still active and running, starting a new guest process will result in an
9124	appropriate error message.
9125
9126	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9127	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9128	set, the guest process will not exit until all data from the specified
9129	stream(s) is/are read out.
9130
9131	To raise or lower the guest process execution limit, either the guest property
9132	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9133	command line by specifying "--control-procs-max-kept" needs to be modified.
9134	A restart of the guest OS is required afterwards. To serve unlimited guest
9135	processes, a value of "0" needs to be set (not recommended).
9136	</note>
9137
9138	<result name="VBOX_E_IPRT_ERROR">
9139	Could not execute process.
9140	</result>
9141
9142	</desc>
9143	<param name="execName" type="wstring" dir="in">
9144	<desc>
9145	Full path name of the command to execute on the guest; the
9146	commands has to exists in the guest VM in order to be executed.
9147	</desc>
9148	</param>
9149	<param name="flags" type="unsigned long" dir="in">
9150	<desc>
9151	<link to="ExecuteProcessFlag"/> flags.
9152	</desc>
9153	</param>
9154	<param name="arguments" type="wstring" safearray="yes" dir="in">
9155	<desc>
9156	Array of arguments passed to the execution command.
9157	</desc>
9158	</param>
9159	<param name="environment" type="wstring" safearray="yes" dir="in">
9160	<desc>
9161	Environment variables that can be set while the command is being
9162	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9163	variable just set its name ("NAME") without a value.
9164	</desc>
9165	</param>
9166	<param name="userName" type="wstring" dir="in">
9167	<desc>
9168	User name under which the command will be executed; has to exist
9169	and have the appropriate rights to execute programs in the VM.
9170	</desc>
9171	</param>
9172	<param name="password" type="wstring" dir="in">
9173	<desc>
9174	Password of the user account specified.
9175	</desc>
9176	</param>
9177	<param name="timeoutMS" type="unsigned long" dir="in">
9178	<desc>
9179	The maximum timeout value (in msec) to wait for finished program
9180	execution. Pass 0 for an infinite timeout.
9181	</desc>
9182	</param>
9183	<param name="pid" type="unsigned long" dir="out">
9184	<desc>
9185	The PID (process ID) of the started command for later reference.
9186	</desc>
9187	</param>
9188	<param name="progress" type="IProgress" dir="return">
9189	<desc>Progress object to track the operation completion.</desc>
9190	</param>
9191	</method>
9192
9193	<method name="getProcessOutput">
9194	<desc>
9195	Retrieves output of a formerly started and running guest process.
9196
9197	<note>
9198	Starting with VirtualBox 4.1.8 this only will return output data
9199	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9200	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9201	<link to="ExecuteProcessFlag"/> is set in the
9202	former <link to="#executeProcess"/> call for this guest process.
9203	</note>
9204
9205	<result name="VBOX_E_IPRT_ERROR">
9206	Could not retrieve output.
9207	</result>
9208
9209	</desc>
9210	<param name="pid" type="unsigned long" dir="in">
9211	<desc>
9212	Process id returned by earlier <link to="#executeProcess"/> call.
9213	</desc>
9214	</param>
9215	<param name="flags" type="unsigned long" dir="in">
9216	<desc>
9217	<link to="ProcessOutputFlag"/> flags.
9218	</desc>
9219	</param>
9220	<param name="timeoutMS" type="unsigned long" dir="in">
9221	<desc>
9222	The maximum timeout value (in msec) to wait for output
9223	data. Pass 0 for an infinite timeout.
9224	</desc>
9225	</param>
9226	<param name="size" type="long long" dir="in">
9227	<desc>
9228	Size in bytes to read in the buffer.
9229	</desc>
9230	</param>
9231	<param name="data" type="octet" safearray="yes" dir="return">
9232	<desc>
9233	Buffer for retrieving the actual output. A data size of 0 means end of file
9234	if the requested size was not 0. This is the unprocessed
9235	output data, i.e. the line ending style depends on the platform of
9236	the system the server is running on.
9237	</desc>
9238	</param>
9239	</method>
9240
9241	<method name="getProcessStatus">
9242	<desc>
9243	Retrieves status, exit code and the exit reason of a formerly started
9244	guest process. If a guest process exited or got terminated this function
9245	returns its final status and removes this process from the list of
9246	known guest processes for further retrieval.
9247
9248	<result name="VBOX_E_IPRT_ERROR">
9249	Process with specified PID was not found.
9250	</result>
9251
9252	</desc>
9253	<param name="pid" type="unsigned long" dir="in">
9254	<desc>
9255	Process id returned by earlier <link to="#executeProcess"/> call.
9256	</desc>
9257	</param>
9258	<param name="exitcode" type="unsigned long" dir="out">
9259	<desc>
9260	The exit code (if available).
9261	</desc>
9262	</param>
9263	<param name="flags" type="unsigned long" dir="out">
9264	<desc>
9265	Additional flags of process status. Not used at the moment and
9266	must be set to 0.
9267	</desc>
9268	</param>
9269	<param name="reason" type="ExecuteProcessStatus" dir="return">
9270	<desc>
9271	The current process status.
9272	</desc>
9273	</param>
9274	</method>
9275
9276	<method name="copyFromGuest">
9277	<desc>
9278	Copies files/directories from guest to the host.
9279
9280	<result name="VBOX_E_IPRT_ERROR">
9281	Error while copying.
9282	</result>
9283
9284	</desc>
9285	<param name="source" type="wstring" dir="in">
9286	<desc>
9287	Source file on the guest to copy.
9288	</desc>
9289	</param>
9290	<param name="dest" type="wstring" dir="in">
9291	<desc>
9292	Destination path on the host.
9293	</desc>
9294	</param>
9295	<param name="userName" type="wstring" dir="in">
9296	<desc>
9297	User name under which the copy command will be executed; the
9298	user has to exist and have the appropriate rights to read from
9299	the source path.
9300	</desc>
9301	</param>
9302	<param name="password" type="wstring" dir="in">
9303	<desc>
9304	Password of the user account specified.
9305	</desc>
9306	</param>
9307	<param name="flags" type="unsigned long" dir="in">
9308	<desc>
9309	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9310	</desc>
9311	</param>
9312	<param name="progress" type="IProgress" dir="return">
9313	<desc>Progress object to track the operation completion.</desc>
9314	</param>
9315	</method>
9316
9317	<method name="copyToGuest">
9318	<desc>
9319	Copies files/directories from host to the guest.
9320
9321	<result name="VBOX_E_IPRT_ERROR">
9322	Error while copying.
9323	</result>
9324
9325	</desc>
9326	<param name="source" type="wstring" dir="in">
9327	<desc>
9328	Source file on the host to copy.
9329	</desc>
9330	</param>
9331	<param name="dest" type="wstring" dir="in">
9332	<desc>
9333	Destination path on the guest.
9334	</desc>
9335	</param>
9336	<param name="userName" type="wstring" dir="in">
9337	<desc>
9338	User name under which the copy command will be executed; the
9339	user has to exist and have the appropriate rights to write to
9340	the destination path.
9341	</desc>
9342	</param>
9343	<param name="password" type="wstring" dir="in">
9344	<desc>
9345	Password of the user account specified.
9346	</desc>
9347	</param>
9348	<param name="flags" type="unsigned long" dir="in">
9349	<desc>
9350	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9351	</desc>
9352	</param>
9353	<param name="progress" type="IProgress" dir="return">
9354	<desc>Progress object to track the operation completion.</desc>
9355	</param>
9356	</method>
9357
9358	<method name="directoryClose">
9359	<desc>
9360	Closes a formerly opened guest directory.
9361
9362	<result name="VBOX_E_IPRT_ERROR">
9363	Error while closing directory.
9364	</result>
9365
9366	</desc>
9367	<param name="handle" type="unsigned long" dir="in">
9368	<desc>
9369	Handle of opened directory to close.
9370	</desc>
9371	</param>
9372	</method>
9373
9374	<method name="directoryCreate">
9375	<desc>
9376	Creates a directory on the guest.
9377
9378	<result name="VBOX_E_IPRT_ERROR">
9379	Error while creating directory.
9380	</result>
9381
9382	</desc>
9383	<param name="directory" type="wstring" dir="in">
9384	<desc>
9385	Directory to create.
9386	</desc>
9387	</param>
9388	<param name="userName" type="wstring" dir="in">
9389	<desc>
9390	User name under which the directory creation will be executed; the
9391	user has to exist and have the appropriate rights to create the
9392	desired directory.
9393	</desc>
9394	</param>
9395	<param name="password" type="wstring" dir="in">
9396	<desc>
9397	Password of the user account specified.
9398	</desc>
9399	</param>
9400	<param name="mode" type="unsigned long" dir="in">
9401	<desc>
9402	File mode.
9403	</desc>
9404	</param>
9405	<param name="flags" type="unsigned long" dir="in">
9406	<desc>
9407	<link to="DirectoryCreateFlag"/> flags.
9408	</desc>
9409	</param>
9410	</method>
9411
9412	<method name="directoryOpen">
9413	<desc>
9414	Opens a directory on the guest.
9415
9416	<result name="VBOX_E_IPRT_ERROR">
9417	Error while opening / reading directory.
9418	</result>
9419
9420	</desc>
9421	<param name="directory" type="wstring" dir="in">
9422	<desc>
9423	Directory to read.
9424	</desc>
9425	</param>
9426	<param name="filter" type="wstring" dir="in">
9427	<desc>
9428	Directory filter (DOS style wildcards). Set to empty
9429	string if no filter required.
9430	</desc>
9431	</param>
9432	<param name="flags" type="unsigned long" dir="in">
9433	<desc>
9434	<link to="DirectoryOpenFlag"/> flags.
9435	</desc>
9436	</param>
9437	<param name="userName" type="wstring" dir="in">
9438	<desc>
9439	User name under which the directory reading will be performed; the
9440	user has to exist and have the appropriate rights to access / read the
9441	desired directory.
9442	</desc>
9443	</param>
9444	<param name="password" type="wstring" dir="in">
9445	<desc>
9446	Password of the user account specified.
9447	</desc>
9448	</param>
9449	<param name="handle" type="unsigned long" dir="return">
9450	<desc>
9451	Handle of opened directory returned by openDirectory.
9452	</desc>
9453	</param>
9454	</method>
9455
9456	<method name="directoryRead">
9457	<desc>
9458	Reads the next directory entry of an opened guest directory.
9459
9460	<result name="E_ABORT">
9461	When the end of the directory has been reached.
9462	</result>
9463
9464	<result name="VBOX_E_IPRT_ERROR">
9465	Error while opening / reading directory.
9466	</result>
9467
9468	</desc>
9469	<param name="handle" type="unsigned long" dir="in">
9470	<desc>
9471	Handle of opened directory returned by openDirectory.
9472	</desc>
9473	</param>
9474	<param name="entry" type="IGuestDirEntry" dir="return">
9475	<desc>
9476	Information about next directory entry on success.
9477	</desc>
9478	</param>
9479	</method>
9480
9481	<method name="fileExists">
9482	<desc>
9483	Checks if the specified file name exists and is a regular file.
9484
9485	If the file name ends with a slash or backslash, the function assumes
9486	it's a directory and will check if the specified directory exists and
9487	is a regular directory.
9488
9489	<result name="VBOX_E_IPRT_ERROR">
9490	Error while looking up information.
9491	</result>
9492
9493	</desc>
9494	<param name="file" type="wstring" dir="in">
9495	<desc>
9496	Full path of file to check.
9497	</desc>
9498	</param>
9499	<param name="userName" type="wstring" dir="in">
9500	<desc>
9501	User name under which the lookup will be performed; the
9502	user has to exist and have the appropriate rights to access / read the
9503	desired directory.
9504	</desc>
9505	</param>
9506	<param name="password" type="wstring" dir="in">
9507	<desc>
9508	Password of the user account specified.
9509	</desc>
9510	</param>
9511	<param name="exists" type="boolean" dir="return">
9512	<desc>
9513	True if it's a regular file, false if it isn't (or doesn't exist).
9514	</desc>
9515	</param>
9516	</method>
9517
9518	<method name="fileQuerySize">
9519	<desc>
9520	Queries the size of a file, given the path to it.
9521
9522	<result name="VBOX_E_IPRT_ERROR">
9523	Error while looking up information.
9524	</result>
9525
9526	</desc>
9527	<param name="file" type="wstring" dir="in">
9528	<desc>
9529	Full path of file to query file size for.
9530	</desc>
9531	</param>
9532	<param name="userName" type="wstring" dir="in">
9533	<desc>
9534	User name under which the lookup will be performed; the
9535	user has to exist and have the appropriate rights to access / read the
9536	desired directory.
9537	</desc>
9538	</param>
9539	<param name="password" type="wstring" dir="in">
9540	<desc>
9541	Password of the user account specified.
9542	</desc>
9543	</param>
9544	<param name="size" type="long long" dir="return">
9545	<desc>
9546	Size (in bytes) of file specified.
9547	</desc>
9548	</param>
9549	</method>
9550
9551	<method name="setProcessInput">
9552	<desc>
9553	Sends input into a formerly started process.
9554
9555	<result name="VBOX_E_IPRT_ERROR">
9556	Could not send input.
9557	</result>
9558
9559	</desc>
9560	<param name="pid" type="unsigned long" dir="in">
9561	<desc>
9562	Process id returned by earlier <link to="#executeProcess"/> call.
9563	</desc>
9564	</param>
9565	<param name="flags" type="unsigned long" dir="in">
9566	<desc>
9567	<link to="ProcessInputFlag"/> flags.
9568	</desc>
9569	</param>
9570	<param name="timeoutMS" type="unsigned long" dir="in">
9571	<desc>
9572	The maximum timeout value (in msec) to wait for getting the
9573	data transfered to the guest. Pass 0 for an infinite timeout.
9574	</desc>
9575	</param>
9576	<param name="data" type="octet" dir="in" safearray="yes">
9577	<desc>
9578	Buffer of input data to send to the started process to.
9579	</desc>
9580	</param>
9581	<param name="written" type="unsigned long" dir="return">
9582	<desc>
9583	Number of bytes written.
9584	</desc>
9585	</param>
9586	</method>
9587
9588	<method name="updateGuestAdditions">
9589	<desc>
9590	Updates already installed Guest Additions in a VM
9591	(Windows guests only).
9592
9593	<result name="VBOX_E_IPRT_ERROR">
9594	Error while updating.
9595	</result>
9596
9597	</desc>
9598	<param name="source" type="wstring" dir="in">
9599	<desc>
9600	Path to the Guest Additions .ISO file to use for the upate.
9601	</desc>
9602	</param>
9603	<param name="flags" type="unsigned long" dir="in">
9604	<desc>
9605	<link to="AdditionsUpdateFlag"/> flags.
9606	</desc>
9607	</param>
9608	<param name="progress" type="IProgress" dir="return">
9609	<desc>Progress object to track the operation completion.</desc>
9610	</param>
9611	</method>
9612
9613	</interface>
9614
9615
9616	<!--
9617	// IProgress
9618	/////////////////////////////////////////////////////////////////////////
9619	-->
9620
9621	<interface
9622	name="IProgress" extends="$unknown"
9623	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9624	wsmap="managed"
9625	>
9626	<desc>
9627	The IProgress interface is used to track and control
9628	asynchronous tasks within VirtualBox.
9629
9630	An instance of this is returned every time VirtualBox starts
9631	an asynchronous task (in other words, a separate thread) which
9632	continues to run after a method call returns. For example,
9633	<link to="IConsole::saveState" />, which saves the state of
9634	a running virtual machine, can take a long time to complete.
9635	To be able to display a progress bar, a user interface such as
9636	the VirtualBox graphical user interface can use the IProgress
9637	object returned by that method.
9638
9639	Note that IProgress is a "read-only" interface in the sense
9640	that only the VirtualBox internals behind the Main API can
9641	create and manipulate progress objects, whereas client code
9642	can only use the IProgress object to monitor a task's
9643	progress and, if <link to="#cancelable" /> is @c true,
9644	cancel the task by calling <link to="#cancel" />.
9645
9646	A task represented by IProgress consists of either one or
9647	several sub-operations that run sequentially, one by one (see
9648	<link to="#operation" /> and <link to="#operationCount" />).
9649	Every operation is identified by a number (starting from 0)
9650	and has a separate description.
9651
9652	You can find the individual percentage of completion of the current
9653	operation in <link to="#operationPercent" /> and the
9654	percentage of completion of the task as a whole
9655	in <link to="#percent" />.
9656
9657	Similarly, you can wait for the completion of a particular
9658	operation via <link to="#waitForOperationCompletion" /> or
9659	for the completion of the whole task via
9660	<link to="#waitForCompletion" />.
9661	</desc>
9662
9663	<attribute name="id" type="uuid" mod="string" readonly="yes">
9664	<desc>ID of the task.</desc>
9665	</attribute>
9666
9667	<attribute name="description" type="wstring" readonly="yes">
9668	<desc>Description of the task.</desc>
9669	</attribute>
9670
9671	<attribute name="initiator" type="$unknown" readonly="yes">
9672	<desc>Initiator of the task.</desc>
9673	</attribute>
9674
9675	<attribute name="cancelable" type="boolean" readonly="yes">
9676	<desc>Whether the task can be interrupted.</desc>
9677	</attribute>
9678
9679	<attribute name="percent" type="unsigned long" readonly="yes">
9680	<desc>
9681	Current progress value of the task as a whole, in percent.
9682	This value depends on how many operations are already complete.
9683	Returns 100 if <link to="#completed" /> is @c true.
9684	</desc>
9685	</attribute>
9686
9687	<attribute name="timeRemaining" type="long" readonly="yes">
9688	<desc>
9689	Estimated remaining time until the task completes, in
9690	seconds. Returns 0 once the task has completed; returns -1
9691	if the remaining time cannot be computed, in particular if
9692	the current progress is 0.
9693
9694	Even if a value is returned, the estimate will be unreliable
9695	for low progress values. It will become more reliable as the
9696	task progresses; it is not recommended to display an ETA
9697	before at least 20% of a task have completed.
9698	</desc>
9699	</attribute>
9700
9701	<attribute name="completed" type="boolean" readonly="yes">
9702	<desc>Whether the task has been completed.</desc>
9703	</attribute>
9704
9705	<attribute name="canceled" type="boolean" readonly="yes">
9706	<desc>Whether the task has been canceled.</desc>
9707	</attribute>
9708
9709	<attribute name="resultCode" type="long" readonly="yes">
9710	<desc>
9711	Result code of the progress task.
9712	Valid only if <link to="#completed"/> is @c true.
9713	</desc>
9714	</attribute>
9715
9716	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9717	<desc>
9718	Extended information about the unsuccessful result of the
9719	progress operation. May be @c null if no extended information
9720	is available.
9721	Valid only if <link to="#completed"/> is @c true and
9722	<link to="#resultCode"/> indicates a failure.
9723	</desc>
9724	</attribute>
9725
9726	<attribute name="operationCount" type="unsigned long" readonly="yes">
9727	<desc>
9728	Number of sub-operations this task is divided into.
9729	Every task consists of at least one suboperation.
9730	</desc>
9731	</attribute>
9732
9733	<attribute name="operation" type="unsigned long" readonly="yes">
9734	<desc>Number of the sub-operation being currently executed.</desc>
9735	</attribute>
9736
9737	<attribute name="operationDescription" type="wstring" readonly="yes">
9738	<desc>
9739	Description of the sub-operation being currently executed.
9740	</desc>
9741	</attribute>
9742
9743	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9744	<desc>Progress value of the current sub-operation only, in percent.</desc>
9745	</attribute>
9746
9747	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9748	<desc>Weight value of the current sub-operation only.</desc>
9749	</attribute>
9750
9751	<attribute name="timeout" type="unsigned long">
9752	<desc>
9753	When non-zero, this specifies the number of milliseconds after which
9754	the operation will automatically be canceled. This can only be set on
9755	cancelable objects.
9756	</desc>
9757	</attribute>
9758
9759	<method name="setCurrentOperationProgress">
9760	<desc>Internal method, not to be called externally.</desc>
9761	<param name="percent" type="unsigned long" dir="in" />
9762	</method>
9763	<method name="setNextOperation">
9764	<desc>Internal method, not to be called externally.</desc>
9765	<param name="nextOperationDescription" type="wstring" dir="in" />
9766	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9767	</method>
9768
9769	<method name="waitForCompletion">
9770	<desc>
9771	Waits until the task is done (including all sub-operations)
9772	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9773
9774	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9775	thread are not processed while waiting. Neglecting event queues may
9776	have dire consequences (degrade performance, resource hogs,
9777	deadlocks, etc.), this is specially so for the main thread on
9778	platforms using XPCOM. Callers are adviced wait for short periods
9779	and service their event queues between calls, or to create a worker
9780	thread to do the waiting.
9781
9782	<result name="VBOX_E_IPRT_ERROR">
9783	Failed to wait for task completion.
9784	</result>
9785	</desc>
9786
9787	<param name="timeout" type="long" dir="in">
9788	<desc>
9789	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9790	</desc>
9791	</param>
9792	</method>
9793
9794	<method name="waitForOperationCompletion">
9795	<desc>
9796	Waits until the given operation is done with a given timeout in
9797	milliseconds; specify -1 for an indefinite wait.
9798
9799	See <link to="#waitForCompletion"> for event queue considerations.</link>
9800
9801	<result name="VBOX_E_IPRT_ERROR">
9802	Failed to wait for operation completion.
9803	</result>
9804
9805	</desc>
9806	<param name="operation" type="unsigned long" dir="in">
9807	<desc>
9808	Number of the operation to wait for.
9809	Must be less than <link to="#operationCount"/>.
9810	</desc>
9811	</param>
9812	<param name="timeout" type="long" dir="in">
9813	<desc>
9814	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9815	</desc>
9816	</param>
9817	</method>
9818
9819	<method name="waitForAsyncProgressCompletion">
9820	<desc>
9821	Waits until the other task is completed (including all
9822	sub-operations) and forward all changes from the other progress to
9823	this progress. This means sub-operation number, description, percent
9824	and so on.
9825
9826	You have to take care on setting up at least the same count on
9827	sub-operations in this progress object like there are in the other
9828	progress object.
9829
9830	If the other progress object supports cancel and this object gets any
9831	cancel request (when here enabled as well), it will be forwarded to
9832	the other progress object.
9833
9834	If there is an error in the other progress, this error isn't
9835	automatically transfered to this progress object. So you have to
9836	check any operation error within the other progress object, after
9837	this method returns.
9838	</desc>
9839
9840	<param name="pProgressAsync" type="IProgress" dir="in">
9841	<desc>
9842	The progress object of the asynchrony process.
9843	</desc>
9844	</param>
9845	</method>
9846
9847	<method name="cancel">
9848	<desc>
9849	Cancels the task.
9850	<note>
9851	If <link to="#cancelable"/> is @c false, then this method will fail.
9852	</note>
9853
9854	<result name="VBOX_E_INVALID_OBJECT_STATE">
9855	Operation cannot be canceled.
9856	</result>
9857
9858	</desc>
9859	</method>
9860
9861	</interface>
9862
9863	<!--
9864	// ISnapshot
9865	/////////////////////////////////////////////////////////////////////////
9866	-->
9867
9868	<interface
9869	name="ISnapshot" extends="$unknown"
9870	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9871	wsmap="managed"
9872	>
9873	<desc>
9874	The ISnapshot interface represents a snapshot of the virtual
9875	machine.
9876
9877	Together with the differencing media that are created
9878	when a snapshot is taken, a machine can be brought back to
9879	the exact state it was in when the snapshot was taken.
9880
9881	The ISnapshot interface has no methods, only attributes; snapshots
9882	are controlled through methods of the <link to="IConsole" /> interface
9883	which also manage the media associated with the snapshot.
9884	The following operations exist:
9885
9886	<ul>
9887	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9888	by creating new, empty differencing images for the machine's
9889	media and saving the VM settings and (if the VM is running)
9890	the current VM state in the snapshot.
9891
9892	The differencing images will then receive all data written to
9893	the machine's media, while their parent (base) images
9894	remain unmodified after the snapshot has been taken (see
9895	<link to="IMedium" /> for details about differencing images).
9896	This simplifies restoring a machine to the state of a snapshot:
9897	only the differencing images need to be deleted.
9898
9899	The current machine state is not changed by taking a snapshot
9900	except that <link to="IMachine::currentSnapshot" /> is set to
9901	the newly created snapshot, which is also added to the machine's
9902	snapshots tree.
9903	</li>
9904
9905	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9906	the state of a previous snapshot by deleting the differencing
9907	image of each of the machine's media and setting the machine's
9908	settings and state to the state that was saved in the snapshot (if any).
9909
9910	This destroys the machine's current state. After calling this,
9911	<link to="IMachine::currentSnapshot" /> points to the snapshot
9912	that was restored.
9913	</li>
9914
9915	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9916	without affecting the current machine state.
9917
9918	This does not change the current machine state, but instead frees the
9919	resources allocated when the snapshot was taken: the settings and machine
9920	state file are deleted (if any), and the snapshot's differencing image for
9921	each of the machine's media gets merged with its parent image.
9922
9923	Neither the current machine state nor other snapshots are affected
9924	by this operation, except that parent media will be modified
9925	to contain the disk data associated with the snapshot being deleted.
9926
9927	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9928	attribute is set to the current snapshot's parent or NULL if it
9929	has no parent. Otherwise the attribute is unchanged.
9930	</li>
9931	</ul>
9932
9933	Each snapshot contains a copy of virtual machine's settings (hardware
9934	configuration etc.). This copy is contained in an immutable (read-only)
9935	instance of <link to="IMachine" /> which is available from the snapshot's
9936	<link to="#machine" /> attribute. When restoring the snapshot, these
9937	settings are copied back to the original machine.
9938
9939	In addition, if the machine was running when the
9940	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9941	the current VM state is saved in the snapshot (similarly to what happens
9942	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9943	because when restoring it, the VM will be running.
9944
9945	If the machine was in <link to="MachineState_Saved">saved</link> saved,
9946	the snapshot receives a copy of the execution state file
9947	(<link to="IMachine::stateFilePath"/>).
9948
9949	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9950	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9951	it then contains a so-called "zero execution state", representing a
9952	machine that is powered off.
9953	</desc>
9954
9955	<attribute name="id" type="uuid" mod="string" readonly="yes">
9956	<desc>UUID of the snapshot.</desc>
9957	</attribute>
9958
9959	<attribute name="name" type="wstring">
9960	<desc>Short name of the snapshot.
9961	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9962	be called implicitly.</note>
9963	</desc>
9964	</attribute>
9965
9966	<attribute name="description" type="wstring">
9967	<desc>Optional description of the snapshot.
9968	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9969	be called implicitly.</note>
9970	</desc>
9971	</attribute>
9972
9973	<attribute name="timeStamp" type="long long" readonly="yes">
9974	<desc>
9975	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9976	</desc>
9977	</attribute>
9978
9979	<attribute name="online" type="boolean" readonly="yes">
9980	<desc>
9981	@c true if this snapshot is an online snapshot and @c false otherwise.
9982
9983	When this attribute is @c true, the
9984	<link to="IMachine::stateFilePath"/> attribute of the
9985	<link to="#machine"/> object associated with this snapshot
9986	will point to the saved state file. Otherwise, it will be
9987	an empty string.
9988	</desc>
9989	</attribute>
9990
9991	<attribute name="machine" type="IMachine" readonly="yes">
9992	<desc>
9993	Virtual machine this snapshot is taken on. This object
9994	stores all settings the machine had when taking this snapshot.
9995	<note>
9996	The returned machine object is immutable, i.e. no
9997	any settings can be changed.
9998	</note>
9999	</desc>
10000	</attribute>
10001
10002	<attribute name="parent" type="ISnapshot" readonly="yes">
10003	<desc>
10004	Parent snapshot (a snapshot this one is based on), or
10005	@c null if the snapshot has no parent (i.e. is the first snapshot).
10006	</desc>
10007	</attribute>
10008
10009	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
10010	<desc>
10011	Child snapshots (all snapshots having this one as a parent).
10012	By inspecting this attribute starting with a machine's root snapshot
10013	(which can be obtained by calling <link to="IMachine::findSnapshot" />
10014	with a @c null UUID), a machine's snapshots tree can be iterated over.
10015	</desc>
10016	</attribute>
10017
10018	<method name="getChildrenCount" const="yes">
10019	<desc>
10020	Returns the number of direct childrens of this snapshot.
10021	</desc>
10022	<param name="childrenCount" type="unsigned long" dir="return">
10023	<desc>
10024	</desc>
10025	</param>
10026	</method>
10027
10028	</interface>
10029
10030
10031	<!--
10032	// IMedium
10033	/////////////////////////////////////////////////////////////////////////
10034	-->
10035
10036	<enum
10037	name="MediumState"
10038	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
10039	>
10040	<desc>
10041	Virtual medium state.
10042	<see><link to="IMedium"/></see>
10043	</desc>
10044
10045	<const name="NotCreated" value="0">
10046	<desc>
10047	Associated medium storage does not exist (either was not created yet or
10048	was deleted).
10049	</desc>
10050	</const>
10051	<const name="Created" value="1">
10052	<desc>
10053	Associated storage exists and accessible; this gets set if the
10054	accessibility check performed by <link to="IMedium::refreshState" />
10055	was successful.
10056	</desc>
10057	</const>
10058	<const name="LockedRead" value="2">
10059	<desc>
10060	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
10061	no data modification is possible.
10062	</desc>
10063	</const>
10064	<const name="LockedWrite" value="3">
10065	<desc>
10066	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
10067	no concurrent data reading or modification is possible.
10068	</desc>
10069	</const>
10070	<const name="Inaccessible" value="4">
10071	<desc>
10072	Medium accessibility check (see <link to="IMedium::refreshState" />) has
10073	not yet been performed, or else, associated medium storage is not
10074	accessible. In the first case, <link to="IMedium::lastAccessError"/>
10075	is empty, in the second case, it describes the error that occurred.
10076	</desc>
10077	</const>
10078	<const name="Creating" value="5">
10079	<desc>
10080	Associated medium storage is being created.
10081	</desc>
10082	</const>
10083	<const name="Deleting" value="6">
10084	<desc>
10085	Associated medium storage is being deleted.
10086	</desc>
10087	</const>
10088	</enum>
10089
10090	<enum
10091	name="MediumType"
10092	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10093	>
10094	<desc>
10095	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10096	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10097	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10098	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10099	</desc>
10100
10101	<const name="Normal" value="0">
10102	<desc>
10103	Normal medium (attached directly or indirectly, preserved
10104	when taking snapshots).
10105	</desc>
10106	</const>
10107	<const name="Immutable" value="1">
10108	<desc>
10109	Immutable medium (attached indirectly, changes are wiped out
10110	the next time the virtual machine is started).
10111	</desc>
10112	</const>
10113	<const name="Writethrough" value="2">
10114	<desc>
10115	Write through medium (attached directly, ignored when
10116	taking snapshots).
10117	</desc>
10118	</const>
10119	<const name="Shareable" value="3">
10120	<desc>
10121	Allow using this medium concurrently by several machines.
10122	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10123	</desc>
10124	</const>
10125	<const name="Readonly" value="4">
10126	<desc>
10127	A readonly medium, which can of course be used by several machines.
10128	<note>Present and accepted since VirtualBox 4.0.</note>
10129	</desc>
10130	</const>
10131	<const name="MultiAttach" value="5">
10132	<desc>
10133	A medium which is is indirectly attached, so that one base medium can
10134	be used for several VMs which have their own differencing medium to
10135	store their modifications. In some sense a variant of Immutable
10136	with unset AutoReset flag in each differencing medium.
10137	<note>Present and accepted since VirtualBox 4.0.</note>
10138	</desc>
10139	</const>
10140	</enum>
10141
10142	<enum
10143	name="MediumVariant"
10144	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
10145	>
10146	<desc>
10147	Virtual medium image variant. More than one flag may be set.
10148	<see><link to="IMedium"/></see>
10149	</desc>
10150
10151	<const name="Standard" value="0">
10152	<desc>
10153	No particular variant requested, results in using the backend default.
10154	</desc>
10155	</const>
10156	<const name="VmdkSplit2G" value="0x01">
10157	<desc>
10158	VMDK image split in chunks of less than 2GByte.
10159	</desc>
10160	</const>
10161	<const name="VmdkStreamOptimized" value="0x04">
10162	<desc>
10163	VMDK streamOptimized image. Special import/export format which is
10164	read-only/append-only.
10165	</desc>
10166	</const>
10167	<const name="VmdkESX" value="0x08">
10168	<desc>
10169	VMDK format variant used on ESX products.
10170	</desc>
10171	</const>
10172	<const name="Fixed" value="0x10000">
10173	<desc>
10174	Fixed image. Only allowed for base images.
10175	</desc>
10176	</const>
10177	<const name="Diff" value="0x20000">
10178	<desc>
10179	Differencing image. Only allowed for child images.
10180	</desc>
10181	</const>
10182	<const name="NoCreateDir" value="0x40000000">
10183	<desc>
10184	Special flag which suppresses automatic creation of the subdirectory.
10185	Only used when passing the medium variant as an input parameter.
10186	</desc>
10187	</const>
10188	</enum>
10189
10190	<interface
10191	name="IMediumAttachment" extends="$unknown"
10192	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10193	wsmap="struct"
10194	>
10195	<desc>
10196	The IMediumAttachment interface links storage media to virtual machines.
10197	For each medium (<link to="IMedium"/>) which has been attached to a
10198	storage controller (<link to="IStorageController"/>) of a machine
10199	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10200	method, one instance of IMediumAttachment is added to the machine's
10201	<link to="IMachine::mediumAttachments"/> array attribute.
10202
10203	Each medium attachment specifies the storage controller as well as a
10204	port and device number and the IMedium instance representing a virtual
10205	hard disk or floppy or DVD image.
10206
10207	For removable media (DVDs or floppies), there are two additional
10208	options. For one, the IMedium instance can be @c null to represent
10209	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10210	secondly, the medium can be one of the pseudo-media for host drives
10211	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10212
10213	<h3>Attaching Hard Disks</h3>
10214
10215	Hard disks are attached to virtual machines using the
10216	<link to="IMachine::attachDevice"/> method and detached using the
10217	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10218	type (see <link to="IMedium::type" />), hard disks are attached either
10219	<i>directly</i> or <i>indirectly</i>.
10220
10221	When a hard disk is being attached directly, it is associated with the
10222	virtual machine and used for hard disk operations when the machine is
10223	running. When a hard disk is being attached indirectly, a new differencing
10224	hard disk linked to it is implicitly created and this differencing hard
10225	disk is associated with the machine and used for hard disk operations.
10226	This also means that if <link to="IMachine::attachDevice"/> performs
10227	a direct attachment then the same hard disk will be returned in response
10228	to the subsequent <link to="IMachine::getMedium"/> call; however if
10229	an indirect attachment is performed then
10230	<link to="IMachine::getMedium"/> will return the implicitly created
10231	differencing hard disk, not the original one passed to <link
10232	to="IMachine::attachDevice"/>. In detail:
10233
10234	<ul>
10235	<li><b>Normal base</b> hard disks that do not have children (i.e.
10236	differencing hard disks linked to them) and that are not already
10237	attached to virtual machines in snapshots are attached <b>directly</b>.
10238	Otherwise, they are attached <b>indirectly</b> because having
10239	dependent children or being part of the snapshot makes it impossible
10240	to modify hard disk contents without breaking the integrity of the
10241	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10242	quickly determine the kind of the attachment for the given hard
10243	disk. Note that if a normal base hard disk is to be indirectly
10244	attached to a virtual machine with snapshots then a special
10245	procedure called <i>smart attachment</i> is performed (see below).</li>
10246	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10247	they are attached <b>directly</b> if they do not have children and are
10248	not attached to virtual machines in snapshots, and <b>indirectly</b>
10249	otherwise. Note that the smart attachment procedure is never performed
10250	for differencing hard disks.</li>
10251	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10252	they are designed to be non-writable. If an immutable hard disk is
10253	attached to a virtual machine with snapshots then a special
10254	procedure called smart attachment is performed (see below).</li>
10255	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10256	also as designed. This also means that writethrough hard disks cannot
10257	have other hard disks linked to them at all.</li>
10258	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10259	also as designed. This also means that shareable hard disks cannot
10260	have other hard disks linked to them at all. They behave almost
10261	like writethrough hard disks, except that shareable hard disks can
10262	be attached to several virtual machines which are running, allowing
10263	concurrent accesses. You need special cluster software running in
10264	the virtual machines to make use of such disks.</li>
10265	</ul>
10266
10267	Note that the same hard disk, regardless of its type, may be attached to
10268	more than one virtual machine at a time. In this case, the machine that is
10269	started first gains exclusive access to the hard disk and attempts to
10270	start other machines having this hard disk attached will fail until the
10271	first machine is powered down.
10272
10273	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10274	that the given hard disk remains associated with the given machine after a
10275	successful <link to="IMachine::detachDevice"/> call until
10276	<link to="IMachine::saveSettings"/> is called to save all changes to
10277	machine settings to disk. This deferring is necessary to guarantee that
10278	the hard disk configuration may be restored at any time by a call to
10279	<link to="IMachine::discardSettings"/> before the settings
10280	are saved (committed).
10281
10282	Note that if <link to="IMachine::discardSettings"/> is called after
10283	indirectly attaching some hard disks to the machine but before a call to
10284	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10285	all differencing hard disks implicitly created by
10286	<link to="IMachine::attachDevice"/> for these indirect attachments.
10287	Such implicitly created hard disks will also be immediately deleted when
10288	detached explicitly using the <link to="IMachine::detachDevice"/>
10289	call if it is made before <link to="IMachine::saveSettings"/>. This
10290	implicit deletion is safe because newly created differencing hard
10291	disks do not contain any user data.
10292
10293	However, keep in mind that detaching differencing hard disks that were
10294	implicitly created by <link to="IMachine::attachDevice"/>
10295	before the last <link to="IMachine::saveSettings"/> call will
10296	<b>not</b> implicitly delete them as they may already contain some data
10297	(for example, as a result of virtual machine execution). If these hard
10298	disks are no more necessary, the caller can always delete them explicitly
10299	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10300	from this machine by the <link to="IMachine::saveSettings"/> call.
10301
10302	<h3>Smart Attachment</h3>
10303
10304	When normal base or immutable hard disks are indirectly attached to a
10305	virtual machine then some additional steps are performed to make sure the
10306	virtual machine will have the most recent "view" of the hard disk being
10307	attached. These steps include walking through the machine's snapshots
10308	starting from the current one and going through ancestors up to the first
10309	snapshot. Hard disks attached to the virtual machine in all
10310	of the encountered snapshots are checked whether they are descendants of
10311	the given normal base or immutable hard disk. The first found child (which
10312	is the differencing hard disk) will be used instead of the normal base or
10313	immutable hard disk as a parent for creating a new differencing hard disk
10314	that will be actually attached to the machine. And only if no descendants
10315	are found or if the virtual machine does not have any snapshots then the
10316	normal base or immutable hard disk will be used itself as a parent for
10317	this differencing hard disk.
10318
10319	It is easier to explain what smart attachment does using the
10320	following example:
10321	<pre>
10322	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10323
10324	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10325	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10326	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10327	Snapshot 4 (none) Snapshot 4 (none)
10328	CurState (none) CurState (D3->D2.vdi)
10329
10330	NOT
10331	...
10332	CurState (D3->B.vdi)
10333	</pre>
10334	The first column is the virtual machine configuration before the base hard
10335	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10336	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10337	mean that the hard disk that is actually attached to the machine is a
10338	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10339	another hard disk, <tt>B.vdi</tt>.
10340
10341	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10342	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10343	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10344	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10345	it cannot be attached directly and needs an indirect attachment (i.e.
10346	implicit creation of a new differencing hard disk). Due to the smart
10347	attachment procedure, the new differencing hard disk
10348	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10349	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10350	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10351	machine.
10352
10353	Note that if there is more than one descendant hard disk of the given base
10354	hard disk found in a snapshot, and there is an exact device, channel and
10355	bus match, then this exact match will be used. Otherwise, the youngest
10356	descendant will be picked up.
10357
10358	There is one more important aspect of the smart attachment procedure which
10359	is not related to snapshots at all. Before walking through the snapshots
10360	as described above, the backup copy of the current list of hard disk
10361	attachment is searched for descendants. This backup copy is created when
10362	the hard disk configuration is changed for the first time after the last
10363	<link to="IMachine::saveSettings"/> call and used by
10364	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10365	changes. When such a descendant is found in this backup copy, it will be
10366	simply re-attached back, without creating a new differencing hard disk for
10367	it. This optimization is necessary to make it possible to re-attach the
10368	base or immutable hard disk to a different bus, channel or device slot
10369	without losing the contents of the differencing hard disk actually
10370	attached to the machine in place of it.
10371
10372	</desc>
10373
10374	<attribute name="medium" type="IMedium" readonly="yes">
10375	<desc>Medium object associated with this attachment; it
10376	can be @c null for removable devices.</desc>
10377	</attribute>
10378
10379	<attribute name="controller" type="wstring" readonly="yes">
10380	<desc>Name of the storage controller of this attachment; this
10381	refers to one of the controllers in <link to="IMachine::storageControllers" />
10382	by name.</desc>
10383	</attribute>
10384
10385	<attribute name="port" type="long" readonly="yes">
10386	<desc>Port number of this attachment.
10387	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10388	</desc>
10389	</attribute>
10390
10391	<attribute name="device" type="long" readonly="yes">
10392	<desc>Device slot number of this attachment.
10393	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10394	</desc>
10395	</attribute>
10396
10397	<attribute name="type" type="DeviceType" readonly="yes">
10398	<desc>Device type of this attachment.</desc>
10399	</attribute>
10400
10401	<attribute name="passthrough" type="boolean" readonly="yes">
10402	<desc>Pass I/O requests through to a device on the host.</desc>
10403	</attribute>
10404
10405	<attribute name="temporaryEject" type="boolean" readonly="yes">
10406	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10407	</attribute>
10408
10409	<attribute name="isEjected" type="boolean" readonly="yes">
10410	<desc>Signals that the removable medium has been ejected. This is not
10411	necessarily equivalent to having a @c null medium association.</desc>
10412	</attribute>
10413
10414	<attribute name="nonRotational" type="boolean" readonly="yes">
10415	<desc>Whether the associated medium is non-rotational.</desc>
10416	</attribute>
10417
10418	<attribute name="discard" type="boolean" readonly="yes">
10419	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10420	</attribute>
10421
10422	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10423	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10424	</attribute>
10425
10426	</interface>
10427
10428	<interface
10429	name="IMedium" extends="$unknown"
10430	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10431	wsmap="managed"
10432	>
10433	<desc>
10434	The IMedium interface represents virtual storage for a machine's
10435	hard disks, CD/DVD or floppy drives. It will typically represent
10436	a disk image on the host, for example a VDI or VMDK file representing
10437	a virtual hard disk, or an ISO or RAW file representing virtual
10438	removable media, but can also point to a network location (e.g.
10439	for iSCSI targets).
10440
10441	Instances of IMedium are connected to virtual machines by way of medium
10442	attachments, which link the storage medium to a particular device slot
10443	of a storage controller of the virtual machine.
10444	In the VirtualBox API, virtual storage is therefore always represented
10445	by the following chain of object links:
10446
10447	<ul>
10448	<li><link to="IMachine::storageControllers"/> contains an array of
10449	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10450	these are instances of <link to="IStorageController"/>).</li>
10451	<li><link to="IMachine::mediumAttachments"/> contains an array of
10452	medium attachments (instances of <link to="IMediumAttachment"/>
10453	created by <link to="IMachine::attachDevice" />),
10454	each containing a storage controller from the above array, a
10455	port/device specification, and an instance of IMedium representing
10456	the medium storage (image file).
10457
10458	For removable media, the storage medium is optional; a medium
10459	attachment with no medium represents a CD/DVD or floppy drive
10460	with no medium inserted. By contrast, hard disk attachments
10461	will always have an IMedium object attached.</li>
10462	<li>Each IMedium in turn points to a storage unit (such as a file
10463	on the host computer or a network resource) that holds actual
10464	data. This location is represented by the <link to="#location"/>
10465	attribute.</li>
10466	</ul>
10467
10468	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10469	new hard disk media can be created with the VirtualBox API using the
10470	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10471	disks (see below) are usually implicitly created by VirtualBox as
10472	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10473	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10474	should be created with external tools and then opened from within VirtualBox.
10475
10476	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10477	drive. In that case the <link to="#id" /> attribute contains the UUID of
10478	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10479
10480	<h3>Media registries</h3>
10481
10482	When a medium has been opened or created using one of the aforementioned
10483	APIs, it becomes "known" to VirtualBox. Known media can be attached
10484	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
10485	They also appear in the global
10486	<link to="IVirtualBox::hardDisks" />,
10487	<link to="IVirtualBox::DVDImages" /> and
10488	<link to="IVirtualBox::floppyImages" /> arrays.
10489
10490	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10491	in the VirtualBox.xml file, which was shared between all machines and made
10492	transporting machines and their media from one host to another difficult.
10493
10494	Starting with VirtualBox 4.0, media are only added to a registry when they are
10495	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10496	backwards compatibility, which registry a medium is added to depends on which
10497	VirtualBox version created a machine:
10498
10499	<ul>
10500	<li>If the medium has first been attached to a machine which was created by
10501	VirtualBox 4.0 or later, it is added to that machine's media registry in
10502	the machine XML settings file. This way all information about a machine's
10503	media attachments is contained in a single file and can be transported
10504	easily.</li>
10505	<li>For older media attachments (i.e. if the medium was first attached to a
10506	machine which was created with a VirtualBox version before 4.0), media
10507	continue to be registered in the global VirtualBox settings file, for
10508	backwards compatibility.</li>
10509	</ul>
10510
10511	See <link to="IVirtualBox::openMedium" /> for more information.
10512
10513	Media are removed from media registries by the <link to="IMedium::close"/>,
10514	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10515
10516	<h3>Accessibility checks</h3>
10517
10518	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10519	method is called explicitly on a medium. This is done to make the VirtualBox object
10520	ready for serving requests as fast as possible and let the end-user
10521	application decide if it needs to check media accessibility right away or not.
10522
10523	As a result, when VirtualBox starts up (e.g. the VirtualBox
10524	object gets created for the first time), all known media are in the
10525	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10526	attribute is an empty string because no actual accessibility check has
10527	been made yet.
10528
10529	After calling <link to="#refreshState" />, a medium is considered
10530	<i>accessible</i> if its storage unit can be read. In that case, the
10531	<link to="#state"/> attribute has a value of "Created". If the storage
10532	unit cannot be read (for example, because it is located on a disconnected
10533	network resource, or was accidentally deleted outside VirtualBox),
10534	the medium is considered <i>inaccessible</i>, which is indicated by the
10535	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10536	obtained by reading the <link to="#lastAccessError"/> attribute.
10537
10538	<h3>Medium types</h3>
10539
10540	There are five types of medium behavior which are stored in the
10541	<link to="#type"/> attribute (see <link to="MediumType" />) and
10542	which define the medium's behavior with attachments and snapshots.
10543
10544	All media can be also divided in two groups: <i>base</i> media and
10545	<i>differencing</i> media. A base medium contains all sectors of the
10546	medium data in its own storage and therefore can be used independently.
10547	In contrast, a differencing medium is a "delta" to some other medium and
10548	contains only those sectors which differ from that other medium, which is
10549	then called a <i>parent</i>. The differencing medium is said to be
10550	<i>linked to</i> that parent. The parent may be itself a differencing
10551	medium, thus forming a chain of linked media. The last element in that
10552	chain must always be a base medium. Note that several differencing
10553	media may be linked to the same parent medium.
10554
10555	Differencing media can be distinguished from base media by querying the
10556	<link to="#parent"/> attribute: base media do not have parents they would
10557	depend on, so the value of this attribute is always @c null for them.
10558	Using this attribute, it is possible to walk up the medium tree (from the
10559	child medium to its parent). It is also possible to walk down the tree
10560	using the <link to="#children"/> attribute.
10561
10562	Note that the type of all differencing media is "normal"; all other
10563	values are meaningless for them. Base media may be of any type.
10564
10565	<h3>Automatic composition of the file name part</h3>
10566
10567	Another extension to the <link to="IMedium::location"/> attribute is that
10568	there is a possibility to cause VirtualBox to compose a unique value for
10569	the file name part of the location using the UUID of the hard disk. This
10570	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10571	e.g. before the storage unit is created, and works as follows. You set the
10572	value of the <link to="IMedium::location"/> attribute to a location
10573	specification which only contains the path specification but not the file
10574	name part and ends with either a forward slash or a backslash character.
10575	In response, VirtualBox will generate a new UUID for the hard disk and
10576	compose the file name using the following pattern:
10577	<pre>
10578	<path>/{<uuid>}.<ext>
10579	</pre>
10580	where <tt><path></tt> is the supplied path specification,
10581	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10582	is the default extension for the storage format of this hard disk. After
10583	that, you may call any of the methods that create a new hard disk storage
10584	unit and they will use the generated UUID and file name.
10585	</desc>
10586
10587	<attribute name="id" type="uuid" mod="string" readonly="yes">
10588	<desc>
10589	UUID of the medium. For a newly created medium, this value is a randomly
10590	generated UUID.
10591
10592	<note>
10593	For media in one of MediumState_NotCreated, MediumState_Creating or
10594	MediumState_Deleting states, the value of this property is undefined
10595	and will most likely be an empty UUID.
10596	</note>
10597	</desc>
10598	</attribute>
10599
10600	<attribute name="description" type="wstring">
10601	<desc>
10602	Optional description of the medium. For a newly created medium the value
10603	of this attribute is an empty string.
10604
10605	Medium types that don't support this attribute will return E_NOTIMPL in
10606	attempt to get or set this attribute's value.
10607
10608	<note>
10609	For some storage types, reading this attribute may return an outdated
10610	(last known) value when <link to="#state"/> is <link
10611	to="MediumState_Inaccessible"/> or <link
10612	to="MediumState_LockedWrite"/> because the value of this attribute is
10613	stored within the storage unit itself. Also note that changing the
10614	attribute value is not possible in such case, as well as when the
10615	medium is the <link to="MediumState_LockedRead"/> state.
10616	</note>
10617	</desc>
10618	</attribute>
10619
10620	<attribute name="state" type="MediumState" readonly="yes">
10621	<desc>
10622	Returns the current medium state, which is the last state set by
10623	the accessibility check performed by <link to="#refreshState"/>.
10624	If that method has not yet been called on the medium, the state
10625	is "Inaccessible"; as opposed to truly inaccessible media, the
10626	value of <link to="#lastAccessError"/> will be an empty string in
10627	that case.
10628
10629	<note>As of version 3.1, this no longer performs an accessibility check
10630	automatically; call <link to="#refreshState"/> for that.
10631	</note>
10632	</desc>
10633	</attribute>
10634
10635	<attribute name="variant" type="unsigned long" readonly="yes">
10636	<desc>
10637	Returns the storage format variant information for this medium
10638	as a combination of the flags described at <link to="MediumVariant" />.
10639	Before <link to="#refreshState"/> is called this method returns
10640	an undefined value.
10641	</desc>
10642	</attribute>
10643
10644	<attribute name="location" type="wstring">
10645	<desc>
10646	Location of the storage unit holding medium data.
10647
10648	The format of the location string is medium type specific. For medium
10649	types using regular files in a host's file system, the location
10650	string is the full file name.
10651
10652	Some medium types may support changing the storage unit location by
10653	simply changing the value of this property. If this operation is not
10654	supported, the implementation will return E_NOTIMPL in attempt to set
10655	this attribute's value.
10656
10657	When setting a value of the location attribute which is a regular file
10658	in the host's file system, the given file name may be either relative to
10659	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10660	absolute. Note that if the given location specification does not contain
10661	the file extension part then a proper default extension will be
10662	automatically appended by the implementation depending on the medium type.
10663	</desc>
10664	</attribute>
10665
10666	<attribute name="name" type="wstring" readonly="yes">
10667	<desc>
10668	Name of the storage unit holding medium data.
10669
10670	The returned string is a short version of the <link to="#location"/>
10671	attribute that is suitable for representing the medium in situations
10672	where the full location specification is too long (such as lists
10673	and comboboxes in GUI frontends). This string is also used by frontends
10674	to sort the media list alphabetically when needed.
10675
10676	For example, for locations that are regular files in the host's file
10677	system, the value of this attribute is just the file name (+ extension),
10678	without the path specification.
10679
10680	Note that as opposed to the <link to="#location"/> attribute, the name
10681	attribute will not necessary be unique for a list of media of the
10682	given type and format.
10683	</desc>
10684	</attribute>
10685
10686	<attribute name="deviceType" type="DeviceType" readonly="yes">
10687	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10688	medium.</desc>
10689	</attribute>
10690
10691	<attribute name="hostDrive" type="boolean" readonly="yes">
10692	<desc>True if this corresponds to a drive on the host.</desc>
10693	</attribute>
10694
10695	<attribute name="size" type="long long" readonly="yes">
10696	<desc>
10697	Physical size of the storage unit used to hold medium data (in bytes).
10698
10699	<note>
10700	For media whose <link to="#state"/> is <link
10701	to="MediumState_Inaccessible"/>, the value of this property is the
10702	last known size. For <link to="MediumState_NotCreated"/> media,
10703	the returned value is zero.
10704	</note>
10705	</desc>
10706	</attribute>
10707
10708	<attribute name="format" type="wstring" readonly="yes">
10709	<desc>
10710	Storage format of this medium.
10711
10712	The value of this attribute is a string that specifies a backend used
10713	to store medium data. The storage format is defined when you create a
10714	new medium or automatically detected when you open an existing medium,
10715	and cannot be changed later.
10716
10717	The list of all storage formats supported by this VirtualBox
10718	installation can be obtained using
10719	<link to="ISystemProperties::mediumFormats"/>.
10720	</desc>
10721	</attribute>
10722
10723	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10724	<desc>
10725	Storage medium format object corresponding to this medium.
10726
10727	The value of this attribute is a reference to the medium format object
10728	that specifies the backend properties used to store medium data. The
10729	storage format is defined when you create a new medium or automatically
10730	detected when you open an existing medium, and cannot be changed later.
10731
10732	<note>@c null is returned if there is no associated medium format
10733	object. This can e.g. happen for medium objects representing host
10734	drives and other special medium objects.</note>
10735	</desc>
10736	</attribute>
10737
10738	<attribute name="type" type="MediumType">
10739	<desc>
10740	Type (role) of this medium.
10741
10742	The following constraints apply when changing the value of this
10743	attribute:
10744	<ul>
10745	<li>If a medium is attached to a virtual machine (either in the
10746	current state or in one of the snapshots), its type cannot be
10747	changed.
10748	</li>
10749	<li>As long as the medium has children, its type cannot be set
10750	to <link to="MediumType_Writethrough"/>.
10751	</li>
10752	<li>The type of all differencing media is
10753	<link to="MediumType_Normal"/> and cannot be changed.
10754	</li>
10755	</ul>
10756
10757	The type of a newly created or opened medium is set to
10758	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10759	which have a type of <link to="MediumType_Writethrough"/>.
10760	</desc>
10761	</attribute>
10762
10763	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10764	<desc>
10765	Returns which medium types can selected for this medium.
10766
10767	<result name="E_NOTIMPL">
10768	This attribute is not implemented at the moment.
10769	</result>
10770	</desc>
10771	</attribute>
10772
10773	<attribute name="parent" type="IMedium" readonly="yes">
10774	<desc>
10775	Parent of this medium (the medium this medium is directly based
10776	on).
10777
10778	Only differencing media have parents. For base (non-differencing)
10779	media, @c null is returned.
10780	</desc>
10781	</attribute>
10782
10783	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10784	<desc>
10785	Children of this medium (all differencing media directly based
10786	on this medium). A @c null array is returned if this medium
10787	does not have any children.
10788	</desc>
10789	</attribute>
10790
10791	<attribute name="base" type="IMedium" readonly="yes">
10792	<desc>
10793	Base medium of this medium.
10794
10795	If this is a differencing medium, its base medium is the medium
10796	the given medium branch starts from. For all other types of media, this
10797	property returns the medium object itself (i.e. the same object this
10798	property is read on).
10799	</desc>
10800	</attribute>
10801
10802	<attribute name="readOnly" type="boolean" readonly="yes">
10803	<desc>
10804	Returns @c true if this medium is read-only and @c false otherwise.
10805
10806	A medium is considered to be read-only when its contents cannot be
10807	modified without breaking the integrity of other parties that depend on
10808	this medium such as its child media or snapshots of virtual machines
10809	where this medium is attached to these machines. If there are no
10810	children and no such snapshots then there is no dependency and the
10811	medium is not read-only.
10812
10813	The value of this attribute can be used to determine the kind of the
10814	attachment that will take place when attaching this medium to a
10815	virtual machine. If the value is @c false then the medium will
10816	be attached directly. If the value is @c true then the medium
10817	will be attached indirectly by creating a new differencing child
10818	medium for that. See the interface description for more information.
10819
10820	Note that all <link to="MediumType_Immutable">Immutable</link> media
10821	are always read-only while all
10822	<link to="MediumType_Writethrough">Writethrough</link> media are
10823	always not.
10824
10825	<note>
10826	The read-only condition represented by this attribute is related to
10827	the medium type and usage, not to the current
10828	<link to="IMedium::state">medium state</link> and not to the read-only
10829	state of the storage unit.
10830	</note>
10831	</desc>
10832	</attribute>
10833
10834	<attribute name="logicalSize" type="long long" readonly="yes">
10835	<desc>
10836	Logical size of this medium (in bytes), as reported to the
10837	guest OS running inside the virtual machine this medium is
10838	attached to. The logical size is defined when the medium is created
10839	and cannot be changed later.
10840
10841	<note>
10842	Reading this property on a differencing medium will return the size
10843	of its <link to="#base"/> medium.
10844	</note>
10845	<note>
10846	For media whose state is <link to="#state"/> is <link
10847	to="MediumState_Inaccessible"/>, the value of this property is the
10848	last known logical size. For <link to="MediumState_NotCreated"/>
10849	media, the returned value is zero.
10850	</note>
10851	</desc>
10852	</attribute>
10853
10854	<attribute name="autoReset" type="boolean">
10855	<desc>
10856	Whether this differencing medium will be automatically reset each
10857	time a virtual machine it is attached to is powered up. This
10858	attribute is automatically set to @c true for the last
10859	differencing image of an "immutable" medium (see
10860	<link to="MediumType" />).
10861
10862	See <link to="#reset"/> for more information about resetting
10863	differencing media.
10864
10865	<note>
10866	Reading this property on a base (non-differencing) medium will
10867	always @c false. Changing the value of this property in this
10868	case is not supported.
10869	</note>
10870
10871	<result name="VBOX_E_NOT_SUPPORTED">
10872	This is not a differencing medium (when changing the attribute
10873	value).
10874	</result>
10875	</desc>
10876	</attribute>
10877
10878	<attribute name="lastAccessError" type="wstring" readonly="yes">
10879	<desc>
10880	Text message that represents the result of the last accessibility
10881	check performed by <link to="#refreshState"/>.
10882
10883	An empty string is returned if the last accessibility check
10884	was successful or has not yet been called. As a result, if
10885	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10886	then <link to="#refreshState"/> has yet to be called; this is the
10887	default value of media after VirtualBox initialization.
10888	A non-empty string indicates a failure and should normally describe
10889	a reason of the failure (for example, a file read error).
10890	</desc>
10891	</attribute>
10892
10893	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10894	<desc>
10895	Array of UUIDs of all machines this medium is attached to.
10896
10897	A @c null array is returned if this medium is not attached to any
10898	machine or to any machine's snapshot.
10899
10900	<note>
10901	The returned array will include a machine even if this medium is not
10902	attached to that machine in the current state but attached to it in
10903	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10904	details.
10905	</note>
10906	</desc>
10907	</attribute>
10908
10909	<method name="setIDs">
10910	<desc>
10911	Changes the UUID and parent UUID for a hard disk medium.
10912	</desc>
10913	<param name="setImageId" type="boolean" dir="in">
10914	<desc>
10915	Select whether a new image UUID is set or not.
10916	</desc>
10917	</param>
10918	<param name="imageId" type="uuid" mod="string" dir="in">
10919	<desc>
10920	New UUID for the image. If an empty string is passed, then a new
10921	UUID is automatically created, provided that @a setImageId is @c true.
10922	Specifying a zero UUID is not allowed.
10923	</desc>
10924	</param>
10925	<param name="setParentId" type="boolean" dir="in">
10926	<desc>
10927	Select whether a new parent UUID is set or not.
10928	</desc>
10929	</param>
10930	<param name="parentId" type="uuid" mod="string" dir="in">
10931	<desc>
10932	New parent UUID for the image. If an empty string is passed, then a
10933	new UUID is automatically created, provided @a setParentId is
10934	@c true. A zero UUID is valid.
10935	</desc>
10936	</param>
10937	<result name="E_INVALIDARG">
10938	Invalid parameter combination.
10939	</result>
10940	<result name="VBOX_E_NOT_SUPPORTED">
10941	Medium is not a hard disk medium.
10942	</result>
10943	</method>
10944
10945	<method name="refreshState">
10946	<desc>
10947	If the current medium state (see <link to="MediumState"/>) is one of
10948	"Created", "Inaccessible" or "LockedRead", then this performs an
10949	accessibility check on the medium and sets the value of the <link to="#state"/>
10950	attribute accordingly; that value is also returned for convenience.
10951
10952	For all other state values, this does not perform a refresh but returns
10953	the state only.
10954
10955	The refresh, if performed, may take a long time (several seconds or even
10956	minutes, depending on the storage unit location and format) because it performs an
10957	accessibility check of the storage unit. This check may cause a significant
10958	delay if the storage unit of the given medium is, for example, a file located
10959	on a network share which is not currently accessible due to connectivity
10960	problems. In that case, the call will not return until a timeout
10961	interval defined by the host OS for this operation expires. For this reason,
10962	it is recommended to never read this attribute on the main UI thread to avoid
10963	making the UI unresponsive.
10964
10965	If the last known state of the medium is "Created" and the accessibility
10966	check fails, then the state would be set to "Inaccessible", and
10967	<link to="#lastAccessError"/> may be used to get more details about the
10968	failure. If the state of the medium is "LockedRead", then it remains the
10969	same, and a non-empty value of <link to="#lastAccessError"/> will
10970	indicate a failed accessibility check in this case.
10971
10972	Note that not all medium states are applicable to all medium types.
10973	</desc>
10974	<param name="state" type="MediumState" dir="return">
10975	<desc>
10976	New medium state.
10977	</desc>
10978	</param>
10979	</method>
10980
10981	<method name="getSnapshotIds">
10982	<desc>
10983	Returns an array of UUIDs of all snapshots of the given machine where
10984	this medium is attached to.
10985
10986	If the medium is attached to the machine in the current state, then the
10987	first element in the array will always be the ID of the queried machine
10988	(i.e. the value equal to the @c machineId argument), followed by
10989	snapshot IDs (if any).
10990
10991	If the medium is not attached to the machine in the current state, then
10992	the array will contain only snapshot IDs.
10993
10994	The returned array may be @c null if this medium is not attached
10995	to the given machine at all, neither in the current state nor in one of
10996	the snapshots.
10997	</desc>
10998	<param name="machineId" type="uuid" mod="string" dir="in">
10999	<desc>
11000	UUID of the machine to query.
11001	</desc>
11002	</param>
11003	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
11004	<desc>
11005	Array of snapshot UUIDs of the given machine using this medium.
11006	</desc>
11007	</param>
11008	</method>
11009
11010	<method name="lockRead">
11011	<desc>
11012	Locks this medium for reading.
11013
11014	A read lock is shared: many clients can simultaneously lock the
11015	same medium for reading unless it is already locked for writing (see
11016	<link to="#lockWrite"/>) in which case an error is returned.
11017
11018	When the medium is locked for reading, it cannot be modified
11019	from within VirtualBox. This means that any method that changes
11020	the properties of this medium or contents of the storage unit
11021	will return an error (unless explicitly stated otherwise). That
11022	includes an attempt to start a virtual machine that wants to
11023	write to the the medium.
11024
11025	When the virtual machine is started up, it locks for reading all
11026	media it uses in read-only mode. If some medium cannot be locked
11027	for reading, the startup procedure will fail.
11028	A medium is typically locked for reading while it is used by a running
11029	virtual machine but has a depending differencing image that receives
11030	the actual write operations. This way one base medium can have
11031	multiple child differencing images which can be written to
11032	simultaneously. Read-only media such as DVD and floppy images are
11033	also locked for reading only (so they can be in use by multiple
11034	machines simultaneously).
11035
11036	A medium is also locked for reading when it is the source of a
11037	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11038
11039	The medium locked for reading must be unlocked using the <link
11040	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
11041	can be nested and must be followed by the same number of paired
11042	<link to="#unlockRead"/> calls.
11043
11044	This method sets the medium state (see <link to="#state"/>) to
11045	"LockedRead" on success. The medium's previous state must be
11046	one of "Created", "Inaccessible" or "LockedRead".
11047
11048	Locking an inaccessible medium is not an error; this method performs
11049	a logical lock that prevents modifications of this medium through
11050	the VirtualBox API, not a physical file-system lock of the underlying
11051	storage unit.
11052
11053	This method returns the current state of the medium
11054	<i>before</i> the operation.
11055
11056	<result name="VBOX_E_INVALID_OBJECT_STATE">
11057	Invalid medium state (e.g. not created, locked, inaccessible,
11058	creating, deleting).
11059	</result>
11060
11061	</desc>
11062	<param name="state" type="MediumState" dir="return">
11063	<desc>
11064	State of the medium after the operation.
11065	</desc>
11066	</param>
11067	</method>
11068
11069	<method name="unlockRead">
11070	<desc>
11071	Cancels the read lock previously set by <link to="#lockRead"/>.
11072
11073	For both success and failure, this method returns the current state
11074	of the medium <i>after</i> the operation.
11075
11076	See <link to="#lockRead"/> for more details.
11077
11078	<result name="VBOX_E_INVALID_OBJECT_STATE">
11079	Medium not locked for reading.
11080	</result>
11081
11082	</desc>
11083	<param name="state" type="MediumState" dir="return">
11084	<desc>
11085	State of the medium after the operation.
11086	</desc>
11087	</param>
11088	</method>
11089
11090	<method name="lockWrite">
11091	<desc>
11092	Locks this medium for writing.
11093
11094	A write lock, as opposed to <link to="#lockRead"/>, is
11095	exclusive: there may be only one client holding a write lock,
11096	and there may be no read locks while the write lock is held.
11097	As a result, read-locking fails if a write lock is held, and
11098	write-locking fails if either a read or another write lock is held.
11099
11100	When a medium is locked for writing, it cannot be modified
11101	from within VirtualBox, and it is not guaranteed that the values
11102	of its properties are up-to-date. Any method that changes the
11103	properties of this medium or contents of the storage unit will
11104	return an error (unless explicitly stated otherwise).
11105
11106	When a virtual machine is started up, it locks for writing all
11107	media it uses to write data to. If any medium could not be locked
11108	for writing, the startup procedure will fail. If a medium has
11109	differencing images, then while the machine is running, only
11110	the last ("leaf") differencing image is locked for writing,
11111	whereas its parents are locked for reading only.
11112
11113	A medium is also locked for writing when it is the target of a
11114	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11115
11116	The medium locked for writing must be unlocked using the <link
11117	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11118
11119	This method sets the medium state (see <link to="#state"/>) to
11120	"LockedWrite" on success. The medium's previous state must be
11121	either "Created" or "Inaccessible".
11122
11123	Locking an inaccessible medium is not an error; this method performs
11124	a logical lock that prevents modifications of this medium through
11125	the VirtualBox API, not a physical file-system lock of the underlying
11126	storage unit.
11127
11128	For both, success and failure, this method returns the current
11129	state of the medium <i>before</i> the operation.
11130
11131	<result name="VBOX_E_INVALID_OBJECT_STATE">
11132	Invalid medium state (e.g. not created, locked, inaccessible,
11133	creating, deleting).
11134	</result>
11135
11136	</desc>
11137	<param name="state" type="MediumState" dir="return">
11138	<desc>
11139	State of the medium after the operation.
11140	</desc>
11141	</param>
11142	</method>
11143
11144	<method name="unlockWrite">
11145	<desc>
11146	Cancels the write lock previously set by <link to="#lockWrite"/>.
11147
11148	For both success and failure, this method returns the current
11149	state of the medium <i>after</i> the operation.
11150
11151	See <link to="#lockWrite"/> for more details.
11152
11153	<result name="VBOX_E_INVALID_OBJECT_STATE">
11154	Medium not locked for writing.
11155	</result>
11156
11157	</desc>
11158	<param name="state" type="MediumState" dir="return">
11159	<desc>
11160	State of the medium after the operation.
11161	</desc>
11162	</param>
11163	</method>
11164
11165	<method name="close">
11166	<desc>
11167	Closes this medium.
11168
11169	The medium must not be attached to any known virtual machine
11170	and must not have any known child media, otherwise the
11171	operation will fail.
11172
11173	When the medium is successfully closed, it is removed from
11174	the list of registered media, but its storage unit is not
11175	deleted. In particular, this means that this medium can
11176	later be opened again using the <link to="IVirtualBox::openMedium"/>
11177	call.
11178
11179	Note that after this method successfully returns, the given medium
11180	object becomes uninitialized. This means that any attempt
11181	to call any of its methods or attributes will fail with the
11182	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11183
11184	<result name="VBOX_E_INVALID_OBJECT_STATE">
11185	Invalid medium state (other than not created, created or
11186	inaccessible).
11187	</result>
11188	<result name="VBOX_E_OBJECT_IN_USE">
11189	Medium attached to virtual machine.
11190	</result>
11191	<result name="VBOX_E_FILE_ERROR">
11192	Settings file not accessible.
11193	</result>
11194	<result name="VBOX_E_XML_ERROR">
11195	Could not parse the settings file.
11196	</result>
11197
11198	</desc>
11199	</method>
11200
11201	<!-- property methods -->
11202
11203	<method name="getProperty" const="yes">
11204	<desc>
11205	Returns the value of the custom medium property with the given name.
11206
11207	The list of all properties supported by the given medium format can
11208	be obtained with <link to="IMediumFormat::describeProperties"/>.
11209
11210	<note>If this method returns an empty string in @a value, the requested
11211	property is supported but currently not assigned any value.</note>
11212
11213	<result name="VBOX_E_OBJECT_NOT_FOUND">
11214	Requested property does not exist (not supported by the format).
11215	</result>
11216	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11217	</desc>
11218	<param name="name" type="wstring" dir="in">
11219	<desc>Name of the property to get.</desc>
11220	</param>
11221	<param name="value" type="wstring" dir="return">
11222	<desc>Current property value.</desc>
11223	</param>
11224	</method>
11225
11226	<method name="setProperty">
11227	<desc>
11228	Sets the value of the custom medium property with the given name.
11229
11230	The list of all properties supported by the given medium format can
11231	be obtained with <link to="IMediumFormat::describeProperties"/>.
11232
11233	<note>Setting the property value to @c null or an empty string is
11234	equivalent to deleting the existing value. A default value (if it is
11235	defined for this property) will be used by the format backend in this
11236	case.</note>
11237
11238	<result name="VBOX_E_OBJECT_NOT_FOUND">
11239	Requested property does not exist (not supported by the format).
11240	</result>
11241	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11242	</desc>
11243	<param name="name" type="wstring" dir="in">
11244	<desc>Name of the property to set.</desc>
11245	</param>
11246	<param name="value" type="wstring" dir="in">
11247	<desc>Property value to set.</desc>
11248	</param>
11249	</method>
11250
11251	<method name="getProperties" const="yes">
11252	<desc>
11253	Returns values for a group of properties in one call.
11254
11255	The names of the properties to get are specified using the @a names
11256	argument which is a list of comma-separated property names or
11257	an empty string if all properties are to be returned.
11258	<note>Currently the value of this argument is ignored and the method
11259	always returns all existing properties.</note>
11260
11261	The list of all properties supported by the given medium format can
11262	be obtained with <link to="IMediumFormat::describeProperties"/>.
11263
11264	The method returns two arrays, the array of property names corresponding
11265	to the @a names argument and the current values of these properties.
11266	Both arrays have the same number of elements with each element at the
11267	given index in the first array corresponds to an element at the same
11268	index in the second array.
11269
11270	For properties that do not have assigned values, an empty string is
11271	returned at the appropriate index in the @a returnValues array.
11272
11273	</desc>
11274	<param name="names" type="wstring" dir="in">
11275	<desc>
11276	Names of properties to get.
11277	</desc>
11278	</param>
11279	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11280	<desc>Names of returned properties.</desc>
11281	</param>
11282	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11283	<desc>Values of returned properties.</desc>
11284	</param>
11285	</method>
11286
11287	<method name="setProperties">
11288	<desc>
11289	Sets values for a group of properties in one call.
11290
11291	The names of the properties to set are passed in the @a names
11292	array along with the new values for them in the @a values array. Both
11293	arrays have the same number of elements with each element at the given
11294	index in the first array corresponding to an element at the same index
11295	in the second array.
11296
11297	If there is at least one property name in @a names that is not valid,
11298	the method will fail before changing the values of any other properties
11299	from the @a names array.
11300
11301	Using this method over <link to="#setProperty"/> is preferred if you
11302	need to set several properties at once since it is more efficient.
11303
11304	The list of all properties supported by the given medium format can
11305	be obtained with <link to="IMediumFormat::describeProperties"/>.
11306
11307	Setting the property value to @c null or an empty string is equivalent
11308	to deleting the existing value. A default value (if it is defined for
11309	this property) will be used by the format backend in this case.
11310	</desc>
11311	<param name="names" type="wstring" safearray="yes" dir="in">
11312	<desc>Names of properties to set.</desc>
11313	</param>
11314	<param name="values" type="wstring" safearray="yes" dir="in">
11315	<desc>Values of properties to set.</desc>
11316	</param>
11317	</method>
11318
11319	<!-- storage methods -->
11320
11321	<method name="createBaseStorage">
11322	<desc>
11323	Starts creating a hard disk storage unit (fixed/dynamic, according
11324	to the variant flags) in in the background. The previous storage unit
11325	created for this object, if any, must first be deleted using
11326	<link to="#deleteStorage"/>, otherwise the operation will fail.
11327
11328	Before the operation starts, the medium is placed in
11329	<link to="MediumState_Creating"/> state. If the create operation
11330	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11331	state.
11332
11333	After the returned progress object reports that the operation has
11334	successfully completed, the medium state will be set to <link
11335	to="MediumState_Created"/>, the medium will be remembered by this
11336	VirtualBox installation and may be attached to virtual machines.
11337
11338	<result name="VBOX_E_NOT_SUPPORTED">
11339	The variant of storage creation operation is not supported. See <link
11340	to="IMediumFormat::capabilities"/>.
11341	</result>
11342	</desc>
11343	<param name="logicalSize" type="long long" dir="in">
11344	<desc>Maximum logical size of the medium in bytes.</desc>
11345	</param>
11346	<param name="variant" type="unsigned long" dir="in">
11347	<desc>Exact image variant which should be created (as a combination of
11348	<link to="MediumVariant" /> flags).</desc>
11349	</param>
11350	<param name="progress" type="IProgress" dir="return">
11351	<desc>Progress object to track the operation completion.</desc>
11352	</param>
11353	</method>
11354
11355	<method name="deleteStorage">
11356	<desc>
11357	Starts deleting the storage unit of this medium.
11358
11359	The medium must not be attached to any known virtual machine and must
11360	not have any known child media, otherwise the operation will fail.
11361	It will also fail if there is no storage unit to delete or if deletion
11362	is already in progress, or if the medium is being in use (locked for
11363	read or for write) or inaccessible. Therefore, the only valid state for
11364	this operation to succeed is <link to="MediumState_Created"/>.
11365
11366	Before the operation starts, the medium is placed in
11367	<link to="MediumState_Deleting"/> state and gets removed from the list
11368	of remembered hard disks (media registry). If the delete operation
11369	fails, the medium will be remembered again and placed back to
11370	<link to="MediumState_Created"/> state.
11371
11372	After the returned progress object reports that the operation is
11373	complete, the medium state will be set to
11374	<link to="MediumState_NotCreated"/> and you will be able to use one of
11375	the storage creation methods to create it again.
11376
11377	<see><link to="#close"/></see>
11378
11379	<result name="VBOX_E_OBJECT_IN_USE">
11380	Medium is attached to a virtual machine.
11381	</result>
11382	<result name="VBOX_E_NOT_SUPPORTED">
11383	Storage deletion is not allowed because neither of storage creation
11384	operations are supported. See
11385	<link to="IMediumFormat::capabilities"/>.
11386	</result>
11387
11388	<note>
11389	If the deletion operation fails, it is not guaranteed that the storage
11390	unit still exists. You may check the <link to="IMedium::state"/> value
11391	to answer this question.
11392	</note>
11393	</desc>
11394	<param name="progress" type="IProgress" dir="return">
11395	<desc>Progress object to track the operation completion.</desc>
11396	</param>
11397	</method>
11398
11399	<!-- diff methods -->
11400
11401	<method name="createDiffStorage">
11402	<desc>
11403	Starts creating an empty differencing storage unit based on this
11404	medium in the format and at the location defined by the @a target
11405	argument.
11406
11407	The target medium must be in <link to="MediumState_NotCreated"/>
11408	state (i.e. must not have an existing storage unit). Upon successful
11409	completion, this operation will set the type of the target medium to
11410	<link to="MediumType_Normal"/> and create a storage unit necessary to
11411	represent the differencing medium data in the given format (according
11412	to the storage format of the target object).
11413
11414	After the returned progress object reports that the operation is
11415	successfully complete, the target medium gets remembered by this
11416	VirtualBox installation and may be attached to virtual machines.
11417
11418	<note>
11419	The medium will be set to <link to="MediumState_LockedRead"/>
11420	state for the duration of this operation.
11421	</note>
11422	<result name="VBOX_E_OBJECT_IN_USE">
11423	Medium not in @c NotCreated state.
11424	</result>
11425	</desc>
11426	<param name="target" type="IMedium" dir="in">
11427	<desc>Target medium.</desc>
11428	</param>
11429	<param name="variant" type="unsigned long" dir="in">
11430	<desc>Exact image variant which should be created (as a combination of
11431	<link to="MediumVariant" /> flags).</desc>
11432	</param>
11433	<param name="progress" type="IProgress" dir="return">
11434	<desc>Progress object to track the operation completion.</desc>
11435	</param>
11436	</method>
11437
11438	<method name="mergeTo">
11439	<desc>
11440	Starts merging the contents of this medium and all intermediate
11441	differencing media in the chain to the given target medium.
11442
11443	The target medium must be either a descendant of this medium or
11444	its ancestor (otherwise this method will immediately return a failure).
11445	It follows that there are two logical directions of the merge operation:
11446	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11447	ancestor (<i>backward merge</i>). Let us consider the following medium
11448	chain:
11449
11450	<pre>Base <- Diff_1 <- Diff_2</pre>
11451
11452	Here, calling this method on the <tt>Base</tt> medium object with
11453	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11454	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11455	merge. Note that in both cases the contents of the resulting medium
11456	will be the same, the only difference is the medium object that takes
11457	the result of the merge operation. In case of the forward merge in the
11458	above example, the result will be written to <tt>Diff_2</tt>; in case of
11459	the backward merge, the result will be written to <tt>Base</tt>. In
11460	other words, the result of the operation is always stored in the target
11461	medium.
11462
11463	Upon successful operation completion, the storage units of all media in
11464	the chain between this (source) medium and the target medium, including
11465	the source medium itself, will be automatically deleted and the
11466	relevant medium objects (including this medium) will become
11467	uninitialized. This means that any attempt to call any of
11468	their methods or attributes will fail with the
11469	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11470	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11471	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11472	Note that <tt>Diff_2</tt> in this case will become a base medium
11473	itself since it will no longer be based on any other medium.
11474
11475	Considering the above, all of the following conditions must be met in
11476	order for the merge operation to succeed:
11477	<ul>
11478	<li>
11479	Neither this (source) medium nor any intermediate
11480	differencing medium in the chain between it and the target
11481	medium is attached to any virtual machine.
11482	</li>
11483	<li>
11484	Neither the source medium nor the target medium is an
11485	<link to="MediumType_Immutable"/> medium.
11486	</li>
11487	<li>
11488	The part of the medium tree from the source medium to the
11489	target medium is a linear chain, i.e. all medium in this
11490	chain have exactly one child which is the next medium in this
11491	chain. The only exception from this rule is the target medium in
11492	the forward merge operation; it is allowed to have any number of
11493	child media because the merge operation will not change its
11494	logical contents (as it is seen by the guest OS or by children).
11495	</li>
11496	<li>
11497	None of the involved media are in
11498	<link to="MediumState_LockedRead"/> or
11499	<link to="MediumState_LockedWrite"/> state.
11500	</li>
11501	</ul>
11502
11503	<note>
11504	This (source) medium and all intermediates will be placed to <link
11505	to="MediumState_Deleting"/> state and the target medium will be
11506	placed to <link to="MediumState_LockedWrite"/> state and for the
11507	duration of this operation.
11508	</note>
11509	</desc>
11510	<param name="target" type="IMedium" dir="in">
11511	<desc>Target medium.</desc>
11512	</param>
11513	<param name="progress" type="IProgress" dir="return">
11514	<desc>Progress object to track the operation completion.</desc>
11515	</param>
11516	</method>
11517
11518	<!-- clone method -->
11519
11520	<method name="cloneTo">
11521	<desc>
11522	Starts creating a clone of this medium in the format and at the
11523	location defined by the @a target argument.
11524
11525	The target medium must be either in <link to="MediumState_NotCreated"/>
11526	state (i.e. must not have an existing storage unit) or in
11527	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11528	big enough to hold the data or else the copy will be partial). Upon
11529	successful completion, the cloned medium will contain exactly the
11530	same sector data as the medium being cloned, except that in the
11531	first case a new UUID for the clone will be randomly generated, and in
11532	the second case the UUID will remain unchanged.
11533
11534	The @a parent argument defines which medium will be the parent
11535	of the clone. Passing a @c null reference indicates that the clone will
11536	be a base image, i.e. completely independent. It is possible to specify
11537	an arbitrary medium for this parameter, including the parent of the
11538	medium which is being cloned. Even cloning to a child of the source
11539	medium is possible. Note that when cloning to an existing image, the
11540	@a parent argument is ignored.
11541
11542	After the returned progress object reports that the operation is
11543	successfully complete, the target medium gets remembered by this
11544	VirtualBox installation and may be attached to virtual machines.
11545
11546	<note>
11547	This medium will be placed to <link to="MediumState_LockedRead"/>
11548	state for the duration of this operation.
11549	</note>
11550	<result name="E_NOTIMPL">
11551	The specified cloning variant is not supported at the moment.
11552	</result>
11553	</desc>
11554	<param name="target" type="IMedium" dir="in">
11555	<desc>Target medium.</desc>
11556	</param>
11557	<param name="variant" type="unsigned long" dir="in">
11558	<desc>Exact image variant which should be created (as a combination of
11559	<link to="MediumVariant" /> flags).</desc>
11560	</param>
11561	<param name="parent" type="IMedium" dir="in">
11562	<desc>Parent of the cloned medium.</desc>
11563	</param>
11564	<param name="progress" type="IProgress" dir="return">
11565	<desc>Progress object to track the operation completion.</desc>
11566	</param>
11567	</method>
11568
11569	<!-- other methods -->
11570
11571	<method name="compact">
11572	<desc>
11573	Starts compacting of this medium. This means that the medium is
11574	transformed into a possibly more compact storage representation.
11575	This potentially creates temporary images, which can require a
11576	substantial amount of additional disk space.
11577
11578	This medium will be placed to <link to="MediumState_LockedWrite"/>
11579	state and all its parent media (if any) will be placed to
11580	<link to="MediumState_LockedRead"/> state for the duration of this
11581	operation.
11582
11583	Please note that the results can be either returned straight away,
11584	or later as the result of the background operation via the object
11585	returned via the @a progress parameter.
11586
11587	<result name="VBOX_E_NOT_SUPPORTED">
11588	Medium format does not support compacting (but potentially
11589	needs it).
11590	</result>
11591	</desc>
11592	<param name="progress" type="IProgress" dir="return">
11593	<desc>Progress object to track the operation completion.</desc>
11594	</param>
11595	</method>
11596
11597	<method name="resize">
11598	<desc>
11599	Starts resizing this medium. This means that the nominal size of the
11600	medium is set to the new value. Both increasing and decreasing the
11601	size is possible, and there are no safety checks, since VirtualBox
11602	does not make any assumptions about the medium contents.
11603
11604	Resizing usually needs additional disk space, and possibly also
11605	some temporary disk space. Note that resize does not create a full
11606	temporary copy of the medium, so the additional disk space requirement
11607	is usually much lower than using the clone operation.
11608
11609	This medium will be placed to <link to="MediumState_LockedWrite"/>
11610	state for the duration of this operation.
11611
11612	Please note that the results can be either returned straight away,
11613	or later as the result of the background operation via the object
11614	returned via the @a progress parameter.
11615
11616	<result name="VBOX_E_NOT_SUPPORTED">
11617	Medium format does not support resizing.
11618	</result>
11619	</desc>
11620	<param name="logicalSize" type="long long" dir="in">
11621	<desc>New nominal capacity of the medium in bytes.</desc>
11622	</param>
11623	<param name="progress" type="IProgress" dir="return">
11624	<desc>Progress object to track the operation completion.</desc>
11625	</param>
11626	</method>
11627
11628	<method name="reset">
11629	<desc>
11630	Starts erasing the contents of this differencing medium.
11631
11632	This operation will reset the differencing medium to its initial
11633	state when it does not contain any sector data and any read operation is
11634	redirected to its parent medium. This automatically gets called
11635	during VM power-up for every medium whose <link to="#autoReset" />
11636	attribute is @c true.
11637
11638	The medium will be write-locked for the duration of this operation (see
11639	<link to="#lockWrite" />).
11640
11641	<result name="VBOX_E_NOT_SUPPORTED">
11642	This is not a differencing medium.
11643	</result>
11644	<result name="VBOX_E_INVALID_OBJECT_STATE">
11645	Medium is not in <link to="MediumState_Created"/> or
11646	<link to="MediumState_Inaccessible"/> state.
11647	</result>
11648	</desc>
11649	<param name="progress" type="IProgress" dir="return">
11650	<desc>Progress object to track the operation completion.</desc>
11651	</param>
11652	</method>
11653
11654	</interface>
11655
11656
11657	<!--
11658	// IMediumFormat
11659	/////////////////////////////////////////////////////////////////////////
11660	-->
11661
11662	<enum
11663	name="DataType"
11664	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11665	>
11666	<const name="Int32" value="0"/>
11667	<const name="Int8" value="1"/>
11668	<const name="String" value="2"/>
11669	</enum>
11670
11671	<enum
11672	name="DataFlags"
11673	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11674	>
11675	<const name="None" value="0x00"/>
11676	<const name="Mandatory" value="0x01"/>
11677	<const name="Expert" value="0x02"/>
11678	<const name="Array" value="0x04"/>
11679	<const name="FlagMask" value="0x07"/>
11680	</enum>
11681
11682	<enum
11683	name="MediumFormatCapabilities"
11684	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11685	>
11686	<desc>
11687	Medium format capability flags.
11688	</desc>
11689
11690	<const name="Uuid" value="0x01">
11691	<desc>
11692	Supports UUIDs as expected by VirtualBox code.
11693	</desc>
11694	</const>
11695
11696	<const name="CreateFixed" value="0x02">
11697	<desc>
11698	Supports creating fixed size images, allocating all space instantly.
11699	</desc>
11700	</const>
11701
11702	<const name="CreateDynamic" value="0x04">
11703	<desc>
11704	Supports creating dynamically growing images, allocating space on
11705	demand.
11706	</desc>
11707	</const>
11708
11709	<const name="CreateSplit2G" value="0x08">
11710	<desc>
11711	Supports creating images split in chunks of a bit less than 2 GBytes.
11712	</desc>
11713	</const>
11714
11715	<const name="Differencing" value="0x10">
11716	<desc>
11717	Supports being used as a format for differencing media (see <link
11718	to="IMedium::createDiffStorage"/>).
11719	</desc>
11720	</const>
11721
11722	<const name="Asynchronous" value="0x20">
11723	<desc>
11724	Supports asynchronous I/O operations for at least some configurations.
11725	</desc>
11726	</const>
11727
11728	<const name="File" value="0x40">
11729	<desc>
11730	The format backend operates on files (the <link to="IMedium::location"/>
11731	attribute of the medium specifies a file used to store medium
11732	data; for a list of supported file extensions see
11733	<link to="IMediumFormat::describeFileExtensions"/>).
11734	</desc>
11735	</const>
11736
11737	<const name="Properties" value="0x80">
11738	<desc>
11739	The format backend uses the property interface to configure the storage
11740	location and properties (the <link to="IMediumFormat::describeProperties"/>
11741	method is used to get access to properties supported by the given medium format).
11742	</desc>
11743	</const>
11744
11745	<const name="TcpNetworking" value="0x100">
11746	<desc>
11747	The format backend uses the TCP networking interface for network access.
11748	</desc>
11749	</const>
11750
11751	<const name="VFS" value="0x200">
11752	<desc>
11753	The format backend supports virtual filesystem functionality.
11754	</desc>
11755	</const>
11756
11757	<const name="CapabilityMask" value="0x3FF"/>
11758	</enum>
11759
11760	<interface
11761	name="IMediumFormat" extends="$unknown"
11762	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11763	wsmap="managed"
11764	>
11765	<desc>
11766	The IMediumFormat interface represents a medium format.
11767
11768	Each medium format has an associated backend which is used to handle
11769	media stored in this format. This interface provides information
11770	about the properties of the associated backend.
11771
11772	Each medium format is identified by a string represented by the
11773	<link to="#id"/> attribute. This string is used in calls like
11774	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11775	format.
11776
11777	The list of all supported medium formats can be obtained using
11778	<link to="ISystemProperties::mediumFormats"/>.
11779
11780	<see><link to="IMedium"/></see>
11781	</desc>
11782
11783	<attribute name="id" type="wstring" readonly="yes">
11784	<desc>
11785	Identifier of this format.
11786
11787	The format identifier is a non-@c null non-empty ASCII string. Note that
11788	this string is case-insensitive. This means that, for example, all of
11789	the following strings:
11790	<pre>
11791	"VDI"
11792	"vdi"
11793	"VdI"</pre>
11794	refer to the same medium format.
11795
11796	This string is used in methods of other interfaces where it is necessary
11797	to specify a medium format, such as
11798	<link to="IVirtualBox::createHardDisk"/>.
11799	</desc>
11800	</attribute>
11801
11802	<attribute name="name" type="wstring" readonly="yes">
11803	<desc>
11804	Human readable description of this format.
11805
11806	Mainly for use in file open dialogs.
11807	</desc>
11808	</attribute>
11809
11810	<attribute name="capabilities" type="unsigned long" readonly="yes">
11811	<desc>
11812	Capabilities of the format as a set of bit flags.
11813
11814	For the meaning of individual capability flags see
11815	<link to="MediumFormatCapabilities"/>.
11816	</desc>
11817	</attribute>
11818
11819	<method name="describeFileExtensions">
11820	<desc>
11821	Returns two arrays describing the supported file extensions.
11822
11823	The first array contains the supported extensions and the seconds one
11824	the type each extension supports. Both have the same size.
11825
11826	Note that some backends do not work on files, so this array may be
11827	empty.
11828
11829	<see><link to="IMediumFormat::capabilities"/></see>
11830	</desc>
11831	<param name="extensions" type="wstring" safearray="yes" dir="out">
11832	<desc>The array of supported extensions.</desc>
11833	</param>
11834	<param name="type" type="DeviceType" safearray="yes" dir="out">
11835	<desc>The array which indicates the device type for every given extension.</desc>
11836	</param>
11837	</method>
11838
11839	<method name="describeProperties" const="yes">
11840	<desc>
11841	Returns several arrays describing the properties supported by this
11842	format.
11843
11844	An element with the given index in each array describes one
11845	property. Thus, the number of elements in each returned array is the
11846	same and corresponds to the number of supported properties.
11847
11848	The returned arrays are filled in only if the
11849	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11850	All arguments must be non-@c null.
11851
11852	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11853	</desc>
11854
11855	<param name="names" type="wstring" safearray="yes" dir="out">
11856	<desc>Array of property names.</desc>
11857	</param>
11858	<param name="description" type="wstring" safearray="yes" dir="out">
11859	<desc>Array of property descriptions.</desc>
11860	</param>
11861	<param name="types" type="DataType" safearray="yes" dir="out">
11862	<desc>Array of property types.</desc>
11863	</param>
11864	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11865	<desc>Array of property flags.</desc>
11866	</param>
11867	<param name="defaults" type="wstring" safearray="yes" dir="out">
11868	<desc>Array of default property values.</desc>
11869	</param>
11870	</method>
11871
11872	</interface>
11873
11874
11875	<!--
11876	// IKeyboard
11877	/////////////////////////////////////////////////////////////////////////
11878	-->
11879
11880	<interface
11881	name="IKeyboard" extends="$unknown"
11882	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11883	wsmap="managed"
11884	>
11885	<desc>
11886	The IKeyboard interface represents the virtual machine's keyboard. Used
11887	in <link to="IConsole::keyboard"/>.
11888
11889	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11890	to the virtual machine.
11891
11892	</desc>
11893	<method name="putScancode">
11894	<desc>Sends a scancode to the keyboard.
11895
11896	<result name="VBOX_E_IPRT_ERROR">
11897	Could not send scan code to virtual keyboard.
11898	</result>
11899
11900	</desc>
11901	<param name="scancode" type="long" dir="in"/>
11902	</method>
11903
11904	<method name="putScancodes">
11905	<desc>Sends an array of scancodes to the keyboard.
11906
11907	<result name="VBOX_E_IPRT_ERROR">
11908	Could not send all scan codes to virtual keyboard.
11909	</result>
11910
11911	</desc>
11912	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11913	<param name="codesStored" type="unsigned long" dir="return"/>
11914	</method>
11915
11916	<method name="putCAD">
11917	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11918	function is nothing special, it is just a convenience function
11919	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11920
11921	<result name="VBOX_E_IPRT_ERROR">
11922	Could not send all scan codes to virtual keyboard.
11923	</result>
11924
11925	</desc>
11926	</method>
11927
11928	<attribute name="eventSource" type="IEventSource" readonly="yes">
11929	<desc>
11930	Event source for keyboard events.
11931	</desc>
11932	</attribute>
11933
11934	</interface>
11935
11936
11937	<!--
11938	// IMouse
11939	/////////////////////////////////////////////////////////////////////////
11940	-->
11941
11942	<enum
11943	name="MouseButtonState"
11944	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
11945	>
11946	<desc>
11947	Mouse button state.
11948	</desc>
11949
11950	<const name="LeftButton" value="0x01"/>
11951	<const name="RightButton" value="0x02"/>
11952	<const name="MiddleButton" value="0x04"/>
11953	<const name="WheelUp" value="0x08"/>
11954	<const name="WheelDown" value="0x10"/>
11955	<const name="XButton1" value="0x20"/>
11956	<const name="XButton2" value="0x40"/>
11957	<const name="MouseStateMask" value="0x7F"/>
11958	</enum>
11959
11960	<interface
11961	name="IMouse" extends="$unknown"
11962	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
11963	wsmap="managed"
11964	>
11965	<desc>
11966	The IMouse interface represents the virtual machine's mouse. Used in
11967	<link to="IConsole::mouse"/>.
11968
11969	Through this interface, the virtual machine's virtual mouse can be
11970	controlled.
11971	</desc>
11972
11973	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11974	<desc>
11975	Whether the guest OS supports absolute mouse pointer positioning
11976	or not.
11977	<note>
11978	You can use the <link to="IMouseCapabilityChangedEvent"/>
11979	event to be instantly informed about changes of this attribute
11980	during virtual machine execution.
11981	</note>
11982	<see><link to="#putMouseEventAbsolute"/></see>
11983	</desc>
11984	</attribute>
11985
11986	<attribute name="relativeSupported" type="boolean" readonly="yes">
11987	<desc>
11988	Whether the guest OS supports relative mouse pointer positioning
11989	or not.
11990	<note>
11991	You can use the <link to="IMouseCapabilityChangedEvent"/>
11992	event to be instantly informed about changes of this attribute
11993	during virtual machine execution.
11994	</note>
11995	<see><link to="#putMouseEvent"/></see>
11996	</desc>
11997	</attribute>
11998
11999	<attribute name="needsHostCursor" type="boolean" readonly="yes">
12000	<desc>
12001	Whether the guest OS can currently switch to drawing it's own mouse
12002	cursor on demand.
12003	<note>
12004	You can use the <link to="IMouseCapabilityChangedEvent"/>
12005	event to be instantly informed about changes of this attribute
12006	during virtual machine execution.
12007	</note>
12008	<see><link to="#putMouseEvent"/></see>
12009	</desc>
12010	</attribute>
12011
12012	<method name="putMouseEvent">
12013	<desc>
12014	Initiates a mouse event using relative pointer movements
12015	along x and y axis.
12016
12017	<result name="E_ACCESSDENIED">
12018	Console not powered up.
12019	</result>
12020	<result name="VBOX_E_IPRT_ERROR">
12021	Could not send mouse event to virtual mouse.
12022	</result>
12023
12024	</desc>
12025
12026	<param name="dx" type="long" dir="in">
12027	<desc>
12028	Amount of pixels the mouse should move to the right.
12029	Negative values move the mouse to the left.
12030	</desc>
12031	</param>
12032	<param name="dy" type="long" dir="in">
12033	<desc>
12034	Amount of pixels the mouse should move downwards.
12035	Negative values move the mouse upwards.
12036	</desc>
12037	</param>
12038	<param name="dz" type="long" dir="in">
12039	<desc>
12040	Amount of mouse wheel moves.
12041	Positive values describe clockwise wheel rotations,
12042	negative values describe counterclockwise rotations.
12043	</desc>
12044	</param>
12045	<param name="dw" type="long" dir="in">
12046	<desc>
12047	Amount of horizontal mouse wheel moves.
12048	Positive values describe a movement to the left,
12049	negative values describe a movement to the right.
12050	</desc>
12051	</param>
12052	<param name="buttonState" type="long" dir="in">
12053	<desc>
12054	The current state of mouse buttons. Every bit represents
12055	a mouse button as follows:
12056	<table>
12057	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12058	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12059	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12060	</table>
12061	A value of <tt>1</tt> means the corresponding button is pressed.
12062	otherwise it is released.
12063	</desc>
12064	</param>
12065	</method>
12066
12067	<method name="putMouseEventAbsolute">
12068	<desc>
12069	Positions the mouse pointer using absolute x and y coordinates.
12070	These coordinates are expressed in pixels and
12071	start from <tt>[1,1]</tt> which corresponds to the top left
12072	corner of the virtual display.
12073
12074	<result name="E_ACCESSDENIED">
12075	Console not powered up.
12076	</result>
12077	<result name="VBOX_E_IPRT_ERROR">
12078	Could not send mouse event to virtual mouse.
12079	</result>
12080
12081	<note>
12082	This method will have effect only if absolute mouse
12083	positioning is supported by the guest OS.
12084	</note>
12085
12086	<see><link to="#absoluteSupported"/></see>
12087	</desc>
12088
12089	<param name="x" type="long" dir="in">
12090	<desc>
12091	X coordinate of the pointer in pixels, starting from @c 1.
12092	</desc>
12093	</param>
12094	<param name="y" type="long" dir="in">
12095	<desc>
12096	Y coordinate of the pointer in pixels, starting from @c 1.
12097	</desc>
12098	</param>
12099	<param name="dz" type="long" dir="in">
12100	<desc>
12101	Amount of mouse wheel moves.
12102	Positive values describe clockwise wheel rotations,
12103	negative values describe counterclockwise rotations.
12104	</desc>
12105	</param>
12106	<param name="dw" type="long" dir="in">
12107	<desc>
12108	Amount of horizontal mouse wheel moves.
12109	Positive values describe a movement to the left,
12110	negative values describe a movement to the right.
12111	</desc>
12112	</param>
12113	<param name="buttonState" type="long" dir="in">
12114	<desc>
12115	The current state of mouse buttons. Every bit represents
12116	a mouse button as follows:
12117	<table>
12118	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12119	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12120	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12121	</table>
12122	A value of @c 1 means the corresponding button is pressed.
12123	otherwise it is released.
12124	</desc>
12125	</param>
12126	</method>
12127
12128	<attribute name="eventSource" type="IEventSource" readonly="yes">
12129	<desc>
12130	Event source for mouse events.
12131	</desc>
12132	</attribute>
12133
12134	</interface>
12135
12136	<!--
12137	// IDisplay
12138	/////////////////////////////////////////////////////////////////////////
12139	-->
12140
12141	<enum
12142	name="FramebufferPixelFormat"
12143	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12144	>
12145	<desc>
12146	Format of the video memory buffer. Constants represented by this enum can
12147	be used to test for particular values of <link
12148	to="IFramebuffer::pixelFormat"/>. See also <link
12149	to="IFramebuffer::requestResize"/>.
12150
12151	See also www.fourcc.org for more information about FOURCC pixel formats.
12152	</desc>
12153
12154	<const name="Opaque" value="0">
12155	<desc>
12156	Unknown buffer format (the user may not assume any particular format of
12157	the buffer).
12158	</desc>
12159	</const>
12160	<const name="FOURCC_RGB" value="0x32424752">
12161	<desc>
12162	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12163	bit layout).
12164	</desc>
12165	</const>
12166	</enum>
12167
12168	<interface
12169	name="IFramebuffer" extends="$unknown"
12170	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12171	wsmap="suppress"
12172	>
12173	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12174	<desc>Address of the start byte of the frame buffer.</desc>
12175	</attribute>
12176
12177	<attribute name="width" type="unsigned long" readonly="yes">
12178	<desc>Frame buffer width, in pixels.</desc>
12179	</attribute>
12180
12181	<attribute name="height" type="unsigned long" readonly="yes">
12182	<desc>Frame buffer height, in pixels.</desc>
12183	</attribute>
12184
12185	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12186	<desc>
12187	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12188	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12189	are: 8, 15, 16, 24 and 32.
12190	</desc>
12191	</attribute>
12192
12193	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12194	<desc>
12195	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12196	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12197	size of the scan line must be aligned to 32 bits.
12198	</desc>
12199	</attribute>
12200
12201	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12202	<desc>
12203	Frame buffer pixel format. It's either one of the values defined by <link
12204	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12205	<note>
12206	This attribute must never return <link
12207	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12208	<link to="#address"/> points to must be always known.
12209	</note>
12210	</desc>
12211	</attribute>
12212
12213	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12214	<desc>
12215	Defines whether this frame buffer uses the virtual video card's memory
12216	buffer (guest VRAM) directly or not. See <link
12217	to="IFramebuffer::requestResize"/> for more information.
12218	</desc>
12219	</attribute>
12220
12221	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12222	<desc>
12223	Hint from the frame buffer about how much of the standard
12224	screen height it wants to use for itself. This information is
12225	exposed to the guest through the VESA BIOS and VMMDev interface
12226	so that it can use it for determining its video mode table. It
12227	is not guaranteed that the guest respects the value.
12228	</desc>
12229	</attribute>
12230
12231	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12232	<desc>
12233	An alpha-blended overlay which is superposed over the frame buffer.
12234	The initial purpose is to allow the display of icons providing
12235	information about the VM state, including disk activity, in front
12236	ends which do not have other means of doing that. The overlay is
12237	designed to controlled exclusively by IDisplay. It has no locking
12238	of its own, and any changes made to it are not guaranteed to be
12239	visible until the affected portion of IFramebuffer is updated. The
12240	overlay can be created lazily the first time it is requested. This
12241	attribute can also return @c null to signal that the overlay is not
12242	implemented.
12243	</desc>
12244	</attribute>
12245
12246	<attribute name="winId" type="long long" readonly="yes">
12247	<desc>
12248	Platform-dependent identifier of the window where context of this
12249	frame buffer is drawn, or zero if there's no such window.
12250	</desc>
12251	</attribute>
12252
12253	<method name="lock">
12254	<desc>
12255	Locks the frame buffer.
12256	Gets called by the IDisplay object where this frame buffer is
12257	bound to.
12258	</desc>
12259	</method>
12260
12261	<method name="unlock">
12262	<desc>
12263	Unlocks the frame buffer.
12264	Gets called by the IDisplay object where this frame buffer is
12265	bound to.
12266	</desc>
12267	</method>
12268
12269	<method name="notifyUpdate">
12270	<desc>
12271	Informs about an update.
12272	Gets called by the display object where this buffer is
12273	registered.
12274	</desc>
12275	<param name="x" type="unsigned long" dir="in"/>
12276	<param name="y" type="unsigned long" dir="in"/>
12277	<param name="width" type="unsigned long" dir="in"/>
12278	<param name="height" type="unsigned long" dir="in"/>
12279	</method>
12280
12281	<method name="requestResize">
12282	<desc>
12283	Requests a size and pixel format change.
12284
12285	There are two modes of working with the video buffer of the virtual
12286	machine. The <i>indirect</i> mode implies that the IFramebuffer
12287	implementation allocates a memory buffer for the requested display mode
12288	and provides it to the virtual machine. In <i>direct</i> mode, the
12289	IFramebuffer implementation uses the memory buffer allocated and owned
12290	by the virtual machine. This buffer represents the video memory of the
12291	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12292	usually faster because the implementation gets a raw pointer to the
12293	guest VRAM buffer which it can directly use for visualizing the contents
12294	of the virtual display, as opposed to the indirect mode where the
12295	contents of guest VRAM are copied to the memory buffer provided by
12296	the implementation every time a display update occurs.
12297
12298	It is important to note that the direct mode is really fast only when
12299	the implementation uses the given guest VRAM buffer directly, for
12300	example, by blitting it to the window representing the virtual machine's
12301	display, which saves at least one copy operation comparing to the
12302	indirect mode. However, using the guest VRAM buffer directly is not
12303	always possible: the format and the color depth of this buffer may be
12304	not supported by the target window, or it may be unknown (opaque) as in
12305	case of text or non-linear multi-plane VGA video modes. In this case,
12306	the indirect mode (that is always available) should be used as a
12307	fallback: when the guest VRAM contents are copied to the
12308	implementation-provided memory buffer, color and format conversion is
12309	done automatically by the underlying code.
12310
12311	The @a pixelFormat parameter defines whether the direct mode is
12312	available or not. If @a pixelFormat is <link
12313	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12314	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12315	@a bytesPerLine parameters must be ignored and the implementation must use
12316	the indirect mode (where it provides its own buffer in one of the
12317	supported formats). In all other cases, @a pixelFormat together with
12318	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12319	buffer pointed to by the @a VRAM parameter and the implementation is
12320	free to choose which mode to use. To indicate that this frame buffer uses
12321	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12322	attribute must return @c true and <link to="#address"/> must
12323	return exactly the same address that is passed in the @a VRAM parameter
12324	of this method; otherwise it is assumed that the indirect strategy is
12325	chosen.
12326
12327	The @a width and @a height parameters represent the size of the
12328	requested display mode in both modes. In case of indirect mode, the
12329	provided memory buffer should be big enough to store data of the given
12330	display mode. In case of direct mode, it is guaranteed that the given
12331	@a VRAM buffer contains enough space to represent the display mode of the
12332	given size. Note that this frame buffer's <link to="#width"/> and <link
12333	to="#height"/> attributes must return exactly the same values as
12334	passed to this method after the resize is completed (see below).
12335
12336	The @a finished output parameter determines if the implementation has
12337	finished resizing the frame buffer or not. If, for some reason, the
12338	resize cannot be finished immediately during this call, @a finished
12339	must be set to @c false, and the implementation must call
12340	<link to="IDisplay::resizeCompleted"/> after it has returned from
12341	this method as soon as possible. If @a finished is @c false, the
12342	machine will not call any frame buffer methods until
12343	<link to="IDisplay::resizeCompleted"/> is called.
12344
12345	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12346	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12347	this frame buffer must return exactly the same values as specified in the
12348	parameters of this method, after the resize is completed. If the
12349	indirect mode is chosen, these attributes must return values describing
12350	the format of the implementation's own memory buffer <link
12351	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12352	value must always correlate with <link to="#pixelFormat"/>. Note that
12353	the <link to="#pixelFormat"/> attribute must never return <link
12354	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12355
12356	<note>
12357	This method is called by the IDisplay object under the
12358	<link to="#lock"/> provided by this IFramebuffer
12359	implementation. If this method returns @c false in @a finished, then
12360	this lock is not released until
12361	<link to="IDisplay::resizeCompleted"/> is called.
12362	</note>
12363	</desc>
12364	<param name="screenId" type="unsigned long" dir="in">
12365	<desc>
12366	Logical screen number. Must be used in the corresponding call to
12367	<link to="IDisplay::resizeCompleted"/> if this call is made.
12368	</desc>
12369	</param>
12370	<param name="pixelFormat" type="unsigned long" dir="in">
12371	<desc>
12372	Pixel format of the memory buffer pointed to by @a VRAM.
12373	See also <link to="FramebufferPixelFormat"/>.
12374	</desc>
12375	</param>
12376	<param name="VRAM" type="octet" mod="ptr" dir="in">
12377	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12378	</param>
12379	<param name="bitsPerPixel" type="unsigned long" dir="in">
12380	<desc>Color depth, bits per pixel.</desc>
12381	</param>
12382	<param name="bytesPerLine" type="unsigned long" dir="in">
12383	<desc>Size of one scan line, in bytes.</desc>
12384	</param>
12385	<param name="width" type="unsigned long" dir="in">
12386	<desc>Width of the guest display, in pixels.</desc>
12387	</param>
12388	<param name="height" type="unsigned long" dir="in">
12389	<desc>Height of the guest display, in pixels.</desc>
12390	</param>
12391	<param name="finished" type="boolean" dir="return">
12392	<desc>
12393	Can the VM start using the new frame buffer immediately
12394	after this method returns or it should wait for
12395	<link to="IDisplay::resizeCompleted"/>.
12396	</desc>
12397	</param>
12398	</method>
12399
12400	<method name="videoModeSupported">
12401	<desc>
12402	Returns whether the frame buffer implementation is willing to
12403	support a given video mode. In case it is not able to render
12404	the video mode (or for some reason not willing), it should
12405	return @c false. Usually this method is called when the guest
12406	asks the VMM device whether a given video mode is supported
12407	so the information returned is directly exposed to the guest.
12408	It is important that this method returns very quickly.
12409	</desc>
12410	<param name="width" type="unsigned long" dir="in"/>
12411	<param name="height" type="unsigned long" dir="in"/>
12412	<param name="bpp" type="unsigned long" dir="in"/>
12413	<param name="supported" type="boolean" dir="return"/>
12414	</method>
12415
12416	<method name="getVisibleRegion">
12417	<desc>
12418	Returns the visible region of this frame buffer.
12419
12420	If the @a rectangles parameter is @c null then the value of the
12421	@a count parameter is ignored and the number of elements necessary to
12422	describe the current visible region is returned in @a countCopied.
12423
12424	If @a rectangles is not @c null but @a count is less
12425	than the required number of elements to store region data, the method
12426	will report a failure. If @a count is equal or greater than the
12427	required number of elements, then the actual number of elements copied
12428	to the provided array will be returned in @a countCopied.
12429
12430	<note>
12431	The address of the provided array must be in the process space of
12432	this IFramebuffer object.
12433	</note>
12434	<note>
12435	Method not yet implemented.
12436	</note>
12437	</desc>
12438	<param name="rectangles" type="octet" mod="ptr" dir="in">
12439	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12440	</param>
12441	<param name="count" type="unsigned long" dir="in">
12442	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12443	</param>
12444	<param name="countCopied" type="unsigned long" dir="return">
12445	<desc>Number of elements copied to the @a rectangles array.</desc>
12446	</param>
12447	</method>
12448
12449	<method name="setVisibleRegion">
12450	<desc>
12451	Suggests a new visible region to this frame buffer. This region
12452	represents the area of the VM display which is a union of regions of
12453	all top-level windows of the guest operating system running inside the
12454	VM (if the Guest Additions for this system support this
12455	functionality). This information may be used by the frontends to
12456	implement the seamless desktop integration feature.
12457
12458	<note>
12459	The address of the provided array must be in the process space of
12460	this IFramebuffer object.
12461	</note>
12462	<note>
12463	The IFramebuffer implementation must make a copy of the provided
12464	array of rectangles.
12465	</note>
12466	<note>
12467	Method not yet implemented.
12468	</note>
12469	</desc>
12470	<param name="rectangles" type="octet" mod="ptr" dir="in">
12471	<desc>Pointer to the @c RTRECT array.</desc>
12472	</param>
12473	<param name="count" type="unsigned long" dir="in">
12474	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12475	</param>
12476	</method>
12477
12478	<method name="processVHWACommand">
12479	<desc>
12480	Posts a Video HW Acceleration Command to the frame buffer for processing.
12481	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12482	are posted from quest to the host to be processed by the host hardware.
12483
12484	<note>
12485	The address of the provided command must be in the process space of
12486	this IFramebuffer object.
12487	</note>
12488	</desc>
12489
12490	<param name="command" type="octet" mod="ptr" dir="in">
12491	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12492	</param>
12493	</method>
12494
12495	</interface>
12496
12497	<interface
12498	name="IFramebufferOverlay" extends="IFramebuffer"
12499	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12500	wsmap="suppress"
12501	>
12502	<desc>
12503	The IFramebufferOverlay interface represents an alpha blended overlay
12504	for displaying status icons above an IFramebuffer. It is always created
12505	not visible, so that it must be explicitly shown. It only covers a
12506	portion of the IFramebuffer, determined by its width, height and
12507	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12508	that order) format, and may be written to directly. Do re-read the
12509	width though, after setting it, as it may be adjusted (increased) to
12510	make it more suitable for the front end.
12511	</desc>
12512	<attribute name="x" type="unsigned long" readonly="yes">
12513	<desc>X position of the overlay, relative to the frame buffer.</desc>
12514	</attribute>
12515
12516	<attribute name="y" type="unsigned long" readonly="yes">
12517	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12518	</attribute>
12519
12520	<attribute name="visible" type="boolean" readonly="no">
12521	<desc>
12522	Whether the overlay is currently visible.
12523	</desc>
12524	</attribute>
12525
12526	<attribute name="alpha" type="unsigned long" readonly="no">
12527	<desc>
12528	The global alpha value for the overlay. This may or may not be
12529	supported by a given front end.
12530	</desc>
12531	</attribute>
12532
12533	<method name="move">
12534	<desc>
12535	Changes the overlay's position relative to the IFramebuffer.
12536	</desc>
12537	<param name="x" type="unsigned long" dir="in"/>
12538	<param name="y" type="unsigned long" dir="in"/>
12539	</method>
12540
12541	</interface>
12542
12543	<interface
12544	name="IDisplay" extends="$unknown"
12545	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
12546	wsmap="managed"
12547	>
12548	<desc>
12549	The IDisplay interface represents the virtual machine's display.
12550
12551	The object implementing this interface is contained in each
12552	<link to="IConsole::display"/> attribute and represents the visual
12553	output of the virtual machine.
12554
12555	The virtual display supports pluggable output targets represented by the
12556	IFramebuffer interface. Examples of the output target are a window on
12557	the host computer or an RDP session's display on a remote computer.
12558	</desc>
12559	<method name="getScreenResolution">
12560	<desc>Queries display width, height and color depth for given screen.</desc>
12561	<param name="screenId" type="unsigned long" dir="in"/>
12562	<param name="width" type="unsigned long" dir="out"/>
12563	<param name="height" type="unsigned long" dir="out"/>
12564	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12565	</method>
12566
12567	<method name="setFramebuffer">
12568	<desc>
12569	Sets the framebuffer for given screen.
12570	</desc>
12571	<param name="screenId" type="unsigned long" dir="in"/>
12572	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12573	</method>
12574
12575	<method name="getFramebuffer">
12576	<desc>
12577	Queries the framebuffer for given screen.
12578	</desc>
12579	<param name="screenId" type="unsigned long" dir="in"/>
12580	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12581	<param name="xOrigin" type="long" dir="out"/>
12582	<param name="yOrigin" type="long" dir="out"/>
12583	</method>
12584
12585	<method name="setVideoModeHint">
12586	<desc>
12587	Asks VirtualBox to request the given video mode from
12588	the guest. This is just a hint and it cannot be guaranteed
12589	that the requested resolution will be used. Guest Additions
12590	are required for the request to be seen by guests. The caller
12591	should issue the request and wait for a resolution change and
12592	after a timeout retry.
12593
12594	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12595	parameters means that the corresponding values should be taken from the
12596	current video mode (i.e. left unchanged).
12597
12598	If the guest OS supports multi-monitor configuration then the @a display
12599	parameter specifies the number of the guest display to send the hint to:
12600	@c 0 is the primary display, @c 1 is the first secondary and
12601	so on. If the multi-monitor configuration is not supported, @a display
12602	must be @c 0.
12603
12604	<result name="E_INVALIDARG">
12605	The @a display is not associated with any monitor.
12606	</result>
12607
12608	</desc>
12609	<param name="width" type="unsigned long" dir="in"/>
12610	<param name="height" type="unsigned long" dir="in"/>
12611	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12612	<param name="display" type="unsigned long" dir="in"/>
12613	</method>
12614
12615	<method name="setSeamlessMode">
12616	<desc>
12617	Enables or disables seamless guest display rendering (seamless desktop
12618	integration) mode.
12619	<note>
12620	Calling this method has no effect if <link
12621	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12622	does not return @c Active.
12623	</note>
12624	</desc>
12625	<param name="enabled" type="boolean" dir="in"/>
12626	</method>
12627
12628	<method name="takeScreenShot">
12629	<desc>
12630	Takes a screen shot of the requested size and copies it to the
12631	32-bpp buffer allocated by the caller and pointed to by @a address.
12632	A pixel consists of 4 bytes in order: B, G, R, 0.
12633
12634	<note>This API can be used only locally by a VM process through the
12635	COM/XPCOM C++ API as it requires pointer support. It is not
12636	available for scripting langages, Java or any webservice clients.
12637	Unless you are writing a new VM frontend use
12638	<link to="#takeScreenShotToArray" />.
12639	</note>
12640
12641	<result name="E_NOTIMPL">
12642	Feature not implemented.
12643	</result>
12644	<result name="VBOX_E_IPRT_ERROR">
12645	Could not take a screenshot.
12646	</result>
12647
12648	</desc>
12649	<param name="screenId" type="unsigned long" dir="in"/>
12650	<param name="address" type="octet" mod="ptr" dir="in"/>
12651	<param name="width" type="unsigned long" dir="in"/>
12652	<param name="height" type="unsigned long" dir="in"/>
12653	</method>
12654
12655	<method name="takeScreenShotToArray">
12656	<desc>
12657	Takes a guest screen shot of the requested size and returns it as
12658	an array of bytes in uncompressed 32-bit RGBA format.
12659	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12660
12661	This API is slow, but could be the only option to get guest screenshot
12662	for scriptable languages not allowed to manipulate with addresses
12663	directly.
12664
12665	<result name="E_NOTIMPL">
12666	Feature not implemented.
12667	</result>
12668	<result name="VBOX_E_IPRT_ERROR">
12669	Could not take a screenshot.
12670	</result>
12671	</desc>
12672	<param name="screenId" type="unsigned long" dir="in">
12673	<desc>
12674	Monitor to take screenshot from.
12675	</desc>
12676	</param>
12677	<param name="width" type="unsigned long" dir="in">
12678	<desc>
12679	Desired image width.
12680	</desc>
12681	</param>
12682	<param name="height" type="unsigned long" dir="in">
12683	<desc>
12684	Desired image height.
12685	</desc>
12686	</param>
12687	<param name="screenData" type="octet" dir="return" safearray="yes">
12688	<desc>
12689	Array with resulting screen data.
12690	</desc>
12691	</param>
12692	</method>
12693
12694	<method name="takeScreenShotPNGToArray">
12695	<desc>
12696	Takes a guest screen shot of the requested size and returns it as
12697	PNG image in array.
12698
12699	<result name="E_NOTIMPL">
12700	Feature not implemented.
12701	</result>
12702	<result name="VBOX_E_IPRT_ERROR">
12703	Could not take a screenshot.
12704	</result>
12705	</desc>
12706	<param name="screenId" type="unsigned long" dir="in">
12707	<desc>
12708	Monitor to take the screenshot from.
12709	</desc>
12710	</param>
12711	<param name="width" type="unsigned long" dir="in">
12712	<desc>
12713	Desired image width.
12714	</desc>
12715	</param>
12716	<param name="height" type="unsigned long" dir="in">
12717	<desc>
12718	Desired image height.
12719	</desc>
12720	</param>
12721	<param name="screenData" type="octet" dir="return" safearray="yes">
12722	<desc>
12723	Array with resulting screen data.
12724	</desc>
12725	</param>
12726	</method>
12727
12728	<method name="drawToScreen">
12729	<desc>
12730	Draws a 32-bpp image of the specified size from the given buffer
12731	to the given point on the VM display.
12732
12733	<result name="E_NOTIMPL">
12734	Feature not implemented.
12735	</result>
12736	<result name="VBOX_E_IPRT_ERROR">
12737	Could not draw to screen.
12738	</result>
12739
12740	</desc>
12741	<param name="screenId" type="unsigned long" dir="in">
12742	<desc>
12743	Monitor to take the screenshot from.
12744	</desc>
12745	</param>
12746	<param name="address" type="octet" mod="ptr" dir="in">
12747	<desc>
12748	Address to store the screenshot to
12749	</desc>
12750	</param>
12751	<param name="x" type="unsigned long" dir="in">
12752	<desc>
12753	Relative to the screen top left corner.
12754	</desc>
12755	</param>
12756	<param name="y" type="unsigned long" dir="in">
12757	<desc>
12758	Relative to the screen top left corner.
12759	</desc>
12760	</param>
12761	<param name="width" type="unsigned long" dir="in">
12762	<desc>
12763	Desired image width.
12764	</desc>
12765	</param>
12766	<param name="height" type="unsigned long" dir="in">
12767	<desc>
12768	Desired image height.
12769	</desc>
12770	</param>
12771	</method>
12772
12773	<method name="invalidateAndUpdate">
12774	<desc>
12775	Does a full invalidation of the VM display and instructs the VM
12776	to update it.
12777
12778	<result name="VBOX_E_IPRT_ERROR">
12779	Could not invalidate and update screen.
12780	</result>
12781
12782	</desc>
12783	</method>
12784
12785	<method name="resizeCompleted">
12786	<desc>
12787	Signals that a framebuffer has completed the resize operation.
12788
12789	<result name="VBOX_E_NOT_SUPPORTED">
12790	Operation only valid for external frame buffers.
12791	</result>
12792
12793	</desc>
12794	<param name="screenId" type="unsigned long" dir="in"/>
12795	</method>
12796
12797	<method name="completeVHWACommand">
12798	<desc>
12799	Signals that the Video HW Acceleration command has completed.
12800	</desc>
12801
12802	<param name="command" type="octet" mod="ptr" dir="in">
12803	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12804	</param>
12805	</method>
12806
12807	</interface>
12808
12809	<!--
12810	// INetworkAdapter
12811	/////////////////////////////////////////////////////////////////////////
12812	-->
12813
12814	<enum
12815	name="NetworkAttachmentType"
12816	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12817	>
12818	<desc>
12819	Network attachment type.
12820	</desc>
12821
12822	<const name="Null" value="0">
12823	<desc>Null value, also means "not attached".</desc>
12824	</const>
12825	<const name="NAT" value="1"/>
12826	<const name="Bridged" value="2"/>
12827	<const name="Internal" value="3"/>
12828	<const name="HostOnly" value="4"/>
12829	<const name="Generic" value="5"/>
12830	</enum>
12831
12832	<enum
12833	name="NetworkAdapterType"
12834	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12835	>
12836	<desc>
12837	Network adapter type.
12838	</desc>
12839
12840	<const name="Null" value="0">
12841	<desc>Null value (never used by the API).</desc>
12842	</const>
12843	<const name="Am79C970A" value="1">
12844	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12845	</const>
12846	<const name="Am79C973" value="2">
12847	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12848	</const>
12849	<const name="I82540EM" value="3">
12850	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12851	</const>
12852	<const name="I82543GC" value="4">
12853	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12854	</const>
12855	<const name="I82545EM" value="5">
12856	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12857	</const>
12858	<const name="Virtio" value="6">
12859	<desc>Virtio network device.</desc>
12860	</const>
12861	</enum>
12862
12863	<enum
12864	name="NetworkAdapterPromiscModePolicy"
12865	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12866	>
12867	<desc>
12868	The promiscuous mode policy of an interface.
12869	</desc>
12870
12871	<const name="Deny" value="1">
12872	<desc>Deny promiscuous mode requests.</desc>
12873	</const>
12874	<const name="AllowNetwork" value="2">
12875	<desc>
12876	Allow promicuous mode, but restrict the scope it to the internal
12877	network so that it only applies to other VMs.
12878	</desc>
12879	</const>
12880	<const name="AllowAll" value="3">
12881	<desc>
12882	Allow promicuous mode, include unrelated traffic going over the wire
12883	and internally on the host.
12884	</desc>
12885	</const>
12886	</enum>
12887
12888	<interface
12889	name="INetworkAdapter" extends="$unknown"
12890	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12891	wsmap="managed"
12892	>
12893	<desc>
12894	Represents a virtual network adapter that is attached to a virtual machine.
12895	Each virtual machine has a fixed number of network adapter slots with one
12896	instance of this attached to each of them. Call
12897	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12898	is attached to a given slot in a given machine.
12899
12900	Each network adapter can be in one of five attachment modes, which are
12901	represented by the <link to="NetworkAttachmentType" /> enumeration;
12902	see the <link to="#attachmentType" /> attribute.
12903	</desc>
12904
12905	<attribute name="adapterType" type="NetworkAdapterType">
12906	<desc>
12907	Type of the virtual network adapter. Depending on this value,
12908	VirtualBox will provide a different virtual network hardware
12909	to the guest.
12910	</desc>
12911	</attribute>
12912
12913	<attribute name="slot" type="unsigned long" readonly="yes">
12914	<desc>
12915	Slot number this adapter is plugged into. Corresponds to
12916	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12917	to obtain this instance.
12918	</desc>
12919	</attribute>
12920
12921	<attribute name="enabled" type="boolean">
12922	<desc>
12923	Flag whether the network adapter is present in the
12924	guest system. If disabled, the virtual guest hardware will
12925	not contain this network adapter. Can only be changed when
12926	the VM is not running.
12927	</desc>
12928	</attribute>
12929
12930	<attribute name="MACAddress" type="wstring">
12931	<desc>
12932	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
12933	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
12934	</desc>
12935	</attribute>
12936
12937	<attribute name="attachmentType" type="NetworkAttachmentType">
12938	<desc>
12939	Sets/Gets network attachment type of this network adapter.
12940	</desc>
12941	</attribute>
12942
12943	<attribute name="bridgedInterface" type="wstring">
12944	<desc>
12945	Name of the network interface the VM should be bridged to.
12946	</desc>
12947	</attribute>
12948
12949	<attribute name="hostOnlyInterface" type="wstring">
12950	<desc>
12951	Name of the host only network interface the VM is attached to.
12952	</desc>
12953	</attribute>
12954
12955	<attribute name="internalNetwork" type="wstring">
12956	<desc>
12957	Name of the internal network the VM is attached to.
12958	</desc>
12959	</attribute>
12960
12961	<attribute name="NATNetwork" type="wstring">
12962	<desc>
12963	Name of the NAT network the VM is attached to.
12964	</desc>
12965	</attribute>
12966
12967	<attribute name="genericDriver" type="wstring">
12968	<desc>
12969	Name of the driver to use for the "Generic" network attachment type.
12970	</desc>
12971	</attribute>
12972
12973	<attribute name="cableConnected" type="boolean">
12974	<desc>
12975	Flag whether the adapter reports the cable as connected or not.
12976	It can be used to report offline situations to a VM.
12977	</desc>
12978	</attribute>
12979
12980	<attribute name="lineSpeed" type="unsigned long">
12981	<desc>
12982	Line speed reported by custom drivers, in units of 1 kbps.
12983	</desc>
12984	</attribute>
12985
12986	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
12987	<desc>
12988	The promiscuous mode policy of the network adapter when attached to an
12989	internal network, host only network or a bridge.
12990	</desc>
12991	</attribute>
12992
12993	<attribute name="traceEnabled" type="boolean">
12994	<desc>
12995	Flag whether network traffic from/to the network card should be traced.
12996	Can only be toggled when the VM is turned off.
12997	</desc>
12998	</attribute>
12999
13000	<attribute name="traceFile" type="wstring">
13001	<desc>
13002	Filename where a network trace will be stored. If not set, VBox-pid.pcap
13003	will be used.
13004	</desc>
13005	</attribute>
13006
13007	<attribute name="natDriver" type="INATEngine" readonly="yes">
13008	<desc>
13009	Points to the NAT engine which handles the network address translation
13010	for this interface. This is active only when the interface actually uses
13011	NAT.
13012	</desc>
13013	</attribute>
13014
13015	<attribute name="bootPriority" type="unsigned long">
13016	<desc>
13017	Network boot priority of the adapter. Priority 1 is highest. If not set,
13018	the priority is considered to be at the lowest possible setting.
13019	</desc>
13020	</attribute>
13021
13022	<attribute name="bandwidthGroup" type="IBandwidthGroup">
13023	<desc>The bandwidth group this network adapter is assigned to.</desc>
13024	</attribute>
13025
13026	<!-- property methods -->
13027
13028	<method name="getProperty" const="yes">
13029	<desc>
13030	Returns the value of the network attachment property with the given name.
13031
13032	If the requested data @a key does not exist, this function will
13033	succeed and return an empty string in the @a value argument.
13034
13035	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13036	</desc>
13037	<param name="key" type="wstring" dir="in">
13038	<desc>Name of the property to get.</desc>
13039	</param>
13040	<param name="value" type="wstring" dir="return">
13041	<desc>Current property value.</desc>
13042	</param>
13043	</method>
13044
13045	<method name="setProperty">
13046	<desc>
13047	Sets the value of the network attachment property with the given name.
13048
13049	Setting the property value to @c null or an empty string is equivalent
13050	to deleting the existing value.
13051
13052	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13053	</desc>
13054	<param name="key" type="wstring" dir="in">
13055	<desc>Name of the property to set.</desc>
13056	</param>
13057	<param name="value" type="wstring" dir="in">
13058	<desc>Property value to set.</desc>
13059	</param>
13060	</method>
13061
13062	<method name="getProperties" const="yes">
13063	<desc>
13064	Returns values for a group of properties in one call.
13065
13066	The names of the properties to get are specified using the @a names
13067	argument which is a list of comma-separated property names or
13068	an empty string if all properties are to be returned.
13069	<note>Currently the value of this argument is ignored and the method
13070	always returns all existing properties.</note>
13071
13072	The method returns two arrays, the array of property names corresponding
13073	to the @a names argument and the current values of these properties.
13074	Both arrays have the same number of elements with each element at the
13075	given index in the first array corresponds to an element at the same
13076	index in the second array.
13077	</desc>
13078	<param name="names" type="wstring" dir="in">
13079	<desc>
13080	Names of properties to get.
13081	</desc>
13082	</param>
13083	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13084	<desc>Names of returned properties.</desc>
13085	</param>
13086	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13087	<desc>Values of returned properties.</desc>
13088	</param>
13089	</method>
13090
13091	</interface>
13092
13093
13094	<!--
13095	// ISerialPort
13096	/////////////////////////////////////////////////////////////////////////
13097	-->
13098
13099	<enum
13100	name="PortMode"
13101	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13102	>
13103	<desc>
13104	The PortMode enumeration represents possible communication modes for
13105	the virtual serial port device.
13106	</desc>
13107
13108	<const name="Disconnected" value="0">
13109	<desc>Virtual device is not attached to any real host device.</desc>
13110	</const>
13111	<const name="HostPipe" value="1">
13112	<desc>Virtual device is attached to a host pipe.</desc>
13113	</const>
13114	<const name="HostDevice" value="2">
13115	<desc>Virtual device is attached to a host device.</desc>
13116	</const>
13117	<const name="RawFile" value="3">
13118	<desc>Virtual device is attached to a raw file.</desc>
13119	</const>
13120	</enum>
13121
13122	<interface
13123	name="ISerialPort" extends="$unknown"
13124	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13125	wsmap="managed"
13126	>
13127
13128	<desc>
13129	The ISerialPort interface represents the virtual serial port device.
13130
13131	The virtual serial port device acts like an ordinary serial port
13132	inside the virtual machine. This device communicates to the real
13133	serial port hardware in one of two modes: host pipe or host device.
13134
13135	In host pipe mode, the #path attribute specifies the path to the pipe on
13136	the host computer that represents a serial port. The #server attribute
13137	determines if this pipe is created by the virtual machine process at
13138	machine startup or it must already exist before starting machine
13139	execution.
13140
13141	In host device mode, the #path attribute specifies the name of the
13142	serial port device on the host computer.
13143
13144	There is also a third communication mode: the disconnected mode. In this
13145	mode, the guest OS running inside the virtual machine will be able to
13146	detect the serial port, but all port write operations will be discarded
13147	and all port read operations will return no data.
13148
13149	<see><link to="IMachine::getSerialPort"/></see>
13150	</desc>
13151
13152	<attribute name="slot" type="unsigned long" readonly="yes">
13153	<desc>
13154	Slot number this serial port is plugged into. Corresponds to
13155	the value you pass to <link to="IMachine::getSerialPort"/>
13156	to obtain this instance.
13157	</desc>
13158	</attribute>
13159
13160	<attribute name="enabled" type="boolean">
13161	<desc>
13162	Flag whether the serial port is enabled. If disabled,
13163	the serial port will not be reported to the guest OS.
13164	</desc>
13165	</attribute>
13166
13167	<attribute name="IOBase" type="unsigned long">
13168	<desc>Base I/O address of the serial port.</desc>
13169	</attribute>
13170
13171	<attribute name="IRQ" type="unsigned long">
13172	<desc>IRQ number of the serial port.</desc>
13173	</attribute>
13174
13175	<attribute name="hostMode" type="PortMode">
13176	<desc>
13177	How is this port connected to the host.
13178	<note>
13179	Changing this attribute may fail if the conditions for
13180	<link to="#path"/> are not met.
13181	</note>
13182	</desc>
13183	</attribute>
13184
13185	<attribute name="server" type="boolean">
13186	<desc>
13187	Flag whether this serial port acts as a server (creates a new pipe on
13188	the host) or as a client (uses the existing pipe). This attribute is
13189	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13190	</desc>
13191	</attribute>
13192
13193	<attribute name="path" type="wstring">
13194	<desc>
13195	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13196	PortMode_HostPipe, or the host serial device name when
13197	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13198	cases, setting a @c null or empty string as the attribute's value
13199	is an error. Otherwise, the value of this property is ignored.
13200	</desc>
13201	</attribute>
13202
13203	</interface>
13204
13205	<!--
13206	// IParallelPort
13207	/////////////////////////////////////////////////////////////////////////
13208	-->
13209
13210	<interface
13211	name="IParallelPort" extends="$unknown"
13212	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13213	wsmap="managed"
13214	>
13215
13216	<desc>
13217	The IParallelPort interface represents the virtual parallel port device.
13218
13219	The virtual parallel port device acts like an ordinary parallel port
13220	inside the virtual machine. This device communicates to the real
13221	parallel port hardware using the name of the parallel device on the host
13222	computer specified in the #path attribute.
13223
13224	Each virtual parallel port device is assigned a base I/O address and an
13225	IRQ number that will be reported to the guest operating system and used
13226	to operate the given parallel port from within the virtual machine.
13227
13228	<see><link to="IMachine::getParallelPort"/></see>
13229	</desc>
13230
13231	<attribute name="slot" type="unsigned long" readonly="yes">
13232	<desc>
13233	Slot number this parallel port is plugged into. Corresponds to
13234	the value you pass to <link to="IMachine::getParallelPort"/>
13235	to obtain this instance.
13236	</desc>
13237	</attribute>
13238
13239	<attribute name="enabled" type="boolean">
13240	<desc>
13241	Flag whether the parallel port is enabled. If disabled,
13242	the parallel port will not be reported to the guest OS.
13243	</desc>
13244	</attribute>
13245
13246	<attribute name="IOBase" type="unsigned long">
13247	<desc>Base I/O address of the parallel port.</desc>
13248	</attribute>
13249
13250	<attribute name="IRQ" type="unsigned long">
13251	<desc>IRQ number of the parallel port.</desc>
13252	</attribute>
13253
13254	<attribute name="path" type="wstring">
13255	<desc>
13256	Host parallel device name. If this parallel port is enabled, setting a
13257	@c null or an empty string as this attribute's value will result in
13258	an error.
13259	</desc>
13260	</attribute>
13261
13262	</interface>
13263
13264
13265	<!--
13266	// IMachineDebugger
13267	/////////////////////////////////////////////////////////////////////////
13268	-->
13269
13270	<interface
13271	name="IMachineDebugger" extends="$unknown"
13272	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13273	wsmap="suppress"
13274	>
13275	<method name="dumpGuestCore">
13276	<desc>
13277	Takes a core dump of the guest.
13278
13279	See include/VBox/dbgfcorefmt.h for details on the file format.
13280	</desc>
13281	<param name="filename" type="wstring" dir="in">
13282	<desc>
13283	The name of the output file. The file must not exist.
13284	</desc>
13285	</param>
13286	<param name="compression" type="wstring" dir="in">
13287	<desc>
13288	Reserved for future compression method indicator.
13289	</desc>
13290	</param>
13291	</method>
13292
13293	<method name="dumpHostProcessCore">
13294	<desc>
13295	Takes a core dump of the VM process on the host.
13296
13297	This feature is not implemented in the 4.0.0 release but it may show up
13298	in a dot release.
13299	</desc>
13300	<param name="filename" type="wstring" dir="in">
13301	<desc>
13302	The name of the output file. The file must not exist.
13303	</desc>
13304	</param>
13305	<param name="compression" type="wstring" dir="in">
13306	<desc>
13307	Reserved for future compression method indicator.
13308	</desc>
13309	</param>
13310	</method>
13311
13312	<method name="info">
13313	<desc>
13314	Interfaces with the info dumpers (DBGFInfo).
13315
13316	This feature is not implemented in the 4.0.0 release but it may show up
13317	in a dot release.
13318	</desc>
13319	<param name="name" type="wstring" dir="in">
13320	<desc>
13321	The name of the info item.
13322	</desc>
13323	</param>
13324	<param name="args" type="wstring" dir="in">
13325	<desc>
13326	Arguments to the info dumper.
13327	</desc>
13328	</param>
13329	<param name="info" type="wstring" dir="return">
13330	<desc>
13331	The into string.
13332	</desc>
13333	</param>
13334	</method>
13335
13336	<method name="injectNMI">
13337	<desc>
13338	Inject an NMI into a running VT-x/AMD-V VM.
13339	</desc>
13340	</method>
13341
13342	<method name="modifyLogGroups">
13343	<desc>
13344	Modifies the group settings of the debug or release logger.
13345	</desc>
13346	<param name="settings" type="wstring" dir="in">
13347	<desc>
13348	The group settings string. See iprt/log.h for details. To target the
13349	release logger, prefix the string with "release:".
13350	</desc>
13351	</param>
13352	</method>
13353
13354	<method name="modifyLogFlags">
13355	<desc>
13356	Modifies the debug or release logger flags.
13357	</desc>
13358	<param name="settings" type="wstring" dir="in">
13359	<desc>
13360	The flags settings string. See iprt/log.h for details. To target the
13361	release logger, prefix the string with "release:".
13362	</desc>
13363	</param>
13364	</method>
13365
13366	<method name="modifyLogDestinations">
13367	<desc>
13368	Modifies the debug or release logger destinations.
13369	</desc>
13370	<param name="settings" type="wstring" dir="in">
13371	<desc>
13372	The destination settings string. See iprt/log.h for details. To target the
13373	release logger, prefix the string with "release:".
13374	</desc>
13375	</param>
13376	</method>
13377
13378	<method name="readPhysicalMemory">
13379	<desc>
13380	Reads guest physical memory, no side effects (MMIO++).
13381
13382	This feature is not implemented in the 4.0.0 release but may show up
13383	in a dot release.
13384	</desc>
13385	<param name="address" type="long long" dir="in">
13386	<desc>The guest physical address.</desc>
13387	</param>
13388	<param name="size" type="unsigned long" dir="in">
13389	<desc>The number of bytes to read.</desc>
13390	</param>
13391	<param name="bytes" type="octet" safearray="yes" dir="return">
13392	<desc>The bytes read.</desc>
13393	</param>
13394	</method>
13395
13396	<method name="writePhysicalMemory">
13397	<desc>
13398	Writes guest physical memory, access handles (MMIO++) are ignored.
13399
13400	This feature is not implemented in the 4.0.0 release but may show up
13401	in a dot release.
13402	</desc>
13403	<param name="address" type="long long" dir="in">
13404	<desc>The guest physical address.</desc>
13405	</param>
13406	<param name="size" type="unsigned long" dir="in">
13407	<desc>The number of bytes to read.</desc>
13408	</param>
13409	<param name="bytes" type="octet" safearray="yes" dir="in">
13410	<desc>The bytes to write.</desc>
13411	</param>
13412	</method>
13413
13414	<method name="readVirtualMemory">
13415	<desc>
13416	Reads guest virtual memory, no side effects (MMIO++).
13417
13418	This feature is not implemented in the 4.0.0 release but may show up
13419	in a dot release.
13420	</desc>
13421	<param name="cpuId" type="unsigned long" dir="in">
13422	<desc>The identifier of the Virtual CPU.</desc>
13423	</param>
13424	<param name="address" type="long long" dir="in">
13425	<desc>The guest virtual address.</desc>
13426	</param>
13427	<param name="size" type="unsigned long" dir="in">
13428	<desc>The number of bytes to read.</desc>
13429	</param>
13430	<param name="bytes" type="octet" safearray="yes" dir="return">
13431	<desc>The bytes read.</desc>
13432	</param>
13433	</method>
13434
13435	<method name="writeVirtualMemory">
13436	<desc>
13437	Writes guest virtual memory, access handles (MMIO++) are ignored.
13438
13439	This feature is not implemented in the 4.0.0 release but may show up
13440	in a dot release.
13441	</desc>
13442	<param name="cpuId" type="unsigned long" dir="in">
13443	<desc>The identifier of the Virtual CPU.</desc>
13444	</param>
13445	<param name="address" type="long long" dir="in">
13446	<desc>The guest virtual address.</desc>
13447	</param>
13448	<param name="size" type="unsigned long" dir="in">
13449	<desc>The number of bytes to read.</desc>
13450	</param>
13451	<param name="bytes" type="octet" safearray="yes" dir="in">
13452	<desc>The bytes to write.</desc>
13453	</param>
13454	</method>
13455
13456	<method name="detectOS">
13457	<desc>
13458	Tries to (re-)detect the guest OS kernel.
13459
13460	This feature is not implemented in the 4.0.0 release but may show up
13461	in a dot release.
13462	</desc>
13463	<param name="os" type="wstring" dir="return">
13464	<desc>
13465	The detected OS kernel on success.
13466	</desc>
13467	</param>
13468	</method>
13469
13470	<method name="getRegister">
13471	<desc>
13472	Gets one register.
13473
13474	This feature is not implemented in the 4.0.0 release but may show up
13475	in a dot release.
13476	</desc>
13477	<param name="cpuId" type="unsigned long" dir="in">
13478	<desc>The identifier of the Virtual CPU.</desc>
13479	</param>
13480	<param name="name" type="wstring" dir="in">
13481	<desc>The register name, case is ignored.</desc>
13482	</param>
13483	<param name="value" type="wstring" dir="return">
13484	<desc>
13485	The register value. This is usually a hex value (always 0x prefixed)
13486	but other format may be used for floating point registers (TBD).
13487	</desc>
13488	</param>
13489	</method>
13490
13491	<method name="getRegisters">
13492	<desc>
13493	Gets all the registers for the given CPU.
13494
13495	This feature is not implemented in the 4.0.0 release but may show up
13496	in a dot release.
13497	</desc>
13498	<param name="cpuId" type="unsigned long" dir="in">
13499	<desc>The identifier of the Virtual CPU.</desc>
13500	</param>
13501	<param name="names" type="wstring" dir="out" safearray="yes">
13502	<desc>Array containing the lowercase register names.</desc>
13503	</param>
13504	<param name="values" type="wstring" dir="out" safearray="yes">
13505	<desc>
13506	Array paralell to the names holding the register values as if the
13507	register was returned by <link to="IMachineDebugger::getRegister"/>.
13508	</desc>
13509	</param>
13510	</method>
13511
13512	<method name="setRegister">
13513	<desc>
13514	Gets one register.
13515
13516	This feature is not implemented in the 4.0.0 release but may show up
13517	in a dot release.
13518	</desc>
13519	<param name="cpuId" type="unsigned long" dir="in">
13520	<desc>The identifier of the Virtual CPU.</desc>
13521	</param>
13522	<param name="name" type="wstring" dir="in">
13523	<desc>The register name, case is ignored.</desc>
13524	</param>
13525	<param name="value" type="wstring" dir="in">
13526	<desc>
13527	The new register value. Hexadecimal, decimal and octal formattings
13528	are supported in addition to any special formattings returned by
13529	the getters.
13530	</desc>
13531	</param>
13532	</method>
13533
13534	<method name="setRegisters">
13535	<desc>
13536	Sets zero or more registers atomically.
13537
13538	This feature is not implemented in the 4.0.0 release but may show up
13539	in a dot release.
13540	</desc>
13541	<param name="cpuId" type="unsigned long" dir="in">
13542	<desc>The identifier of the Virtual CPU.</desc>
13543	</param>
13544	<param name="names" type="wstring" dir="in" safearray="yes">
13545	<desc>Array containing the register names, case ignored.</desc>
13546	</param>
13547	<param name="values" type="wstring" dir="in" safearray="yes">
13548	<desc>
13549	Array paralell to the names holding the register values. See
13550	<link to="IMachineDebugger::setRegister"/> for formatting
13551	guidelines.
13552	</desc>
13553	</param>
13554	</method>
13555
13556	<method name="dumpGuestStack">
13557	<desc>
13558	Produce a simple stack dump using the current guest state.
13559
13560	This feature is not implemented in the 4.0.0 release but may show up
13561	in a dot release.
13562	</desc>
13563	<param name="cpuId" type="unsigned long" dir="in">
13564	<desc>The identifier of the Virtual CPU.</desc>
13565	</param>
13566	<param name="stack" type="wstring" dir="return">
13567	<desc>String containing the formatted stack dump.</desc>
13568	</param>
13569	</method>
13570
13571	<method name="resetStats">
13572	<desc>
13573	Reset VM statistics.
13574	</desc>
13575	<param name="pattern" type="wstring" dir="in">
13576	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13577	</param>
13578	</method>
13579
13580	<method name="dumpStats">
13581	<desc>
13582	Dumps VM statistics.
13583	</desc>
13584	<param name="pattern" type="wstring" dir="in">
13585	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13586	</param>
13587	</method>
13588
13589	<method name="getStats">
13590	<desc>
13591	Get the VM statistics in a XMLish format.
13592	</desc>
13593	<param name="pattern" type="wstring" dir="in">
13594	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13595	</param>
13596	<param name="withDescriptions" type="boolean" dir="in">
13597	<desc>Whether to include the descriptions.</desc>
13598	</param>
13599	<param name="stats" type="wstring" dir="out">
13600	<desc>The XML document containing the statistics.</desc>
13601	</param>
13602	</method>
13603
13604	<attribute name="singleStep" type="boolean">
13605	<desc>Switch for enabling single-stepping.</desc>
13606	</attribute>
13607
13608	<attribute name="recompileUser" type="boolean">
13609	<desc>Switch for forcing code recompilation for user mode code.</desc>
13610	</attribute>
13611
13612	<attribute name="recompileSupervisor" type="boolean">
13613	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13614	</attribute>
13615
13616	<attribute name="PATMEnabled" type="boolean">
13617	<desc>Switch for enabling and disabling the PATM component.</desc>
13618	</attribute>
13619
13620	<attribute name="CSAMEnabled" type="boolean">
13621	<desc>Switch for enabling and disabling the CSAM component.</desc>
13622	</attribute>
13623
13624	<attribute name="logEnabled" type="boolean">
13625	<desc>Switch for enabling and disabling the debug logger.</desc>
13626	</attribute>
13627
13628	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13629	<desc>The debug logger flags.</desc>
13630	</attribute>
13631
13632	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13633	<desc>The debug logger's group settings.</desc>
13634	</attribute>
13635
13636	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13637	<desc>The debug logger's destination settings.</desc>
13638	</attribute>
13639
13640	<attribute name="logRelFlags" type="wstring" readonly="yes">
13641	<desc>The release logger flags.</desc>
13642	</attribute>
13643
13644	<attribute name="logRelGroups" type="wstring" readonly="yes">
13645	<desc>The release logger's group settings.</desc>
13646	</attribute>
13647
13648	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13649	<desc>The relase logger's destination settings.</desc>
13650	</attribute>
13651
13652	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13653	<desc>
13654	Flag indicating whether the VM is currently making use of CPU hardware
13655	virtualization extensions.
13656	</desc>
13657	</attribute>
13658
13659	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13660	<desc>
13661	Flag indicating whether the VM is currently making use of the nested paging
13662	CPU hardware virtualization extension.
13663	</desc>
13664	</attribute>
13665
13666	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13667	<desc>
13668	Flag indicating whether the VM is currently making use of the VPID
13669	VT-x extension.
13670	</desc>
13671	</attribute>
13672
13673	<attribute name="OSName" type="wstring" readonly="yes">
13674	<desc>
13675	Query the guest OS kernel name as detected by the DBGF.
13676
13677	This feature is not implemented in the 4.0.0 release but may show up
13678	in a dot release.
13679	</desc>
13680	</attribute>
13681
13682	<attribute name="OSVersion" type="wstring" readonly="yes">
13683	<desc>
13684	Query the guest OS kernel version string as detected by the DBGF.
13685
13686	This feature is not implemented in the 4.0.0 release but may show up
13687	in a dot release.
13688	</desc>
13689	</attribute>
13690
13691	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13692	<desc>
13693	Flag indicating whether the VM is currently making use of the Physical
13694	Address Extension CPU feature.
13695	</desc>
13696	</attribute>
13697
13698	<attribute name="virtualTimeRate" type="unsigned long">
13699	<desc>
13700	The rate at which the virtual time runs expressed as a percentage.
13701	The accepted range is 2% to 20000%.
13702	</desc>
13703	</attribute>
13704
13705	<attribute name="VM" type="long long" readonly="yes">
13706	<desc>
13707	Gets the VM handle. This is only for internal use while
13708	we carve the details of this interface.
13709	</desc>
13710	</attribute>
13711
13712	</interface>
13713
13714	<!--
13715	// IUSBController
13716	/////////////////////////////////////////////////////////////////////////
13717	-->
13718
13719	<interface
13720	name="IUSBController" extends="$unknown"
13721	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13722	wsmap="managed"
13723	>
13724	<attribute name="enabled" type="boolean">
13725	<desc>
13726	Flag whether the USB controller is present in the
13727	guest system. If disabled, the virtual guest hardware will
13728	not contain any USB controller. Can only be changed when
13729	the VM is powered off.
13730	</desc>
13731	</attribute>
13732
13733	<attribute name="enabledEhci" type="boolean">
13734	<desc>
13735	Flag whether the USB EHCI controller is present in the
13736	guest system. If disabled, the virtual guest hardware will
13737	not contain a USB EHCI controller. Can only be changed when
13738	the VM is powered off.
13739	</desc>
13740	</attribute>
13741
13742	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13743	<desc>
13744	Flag whether there is an USB proxy available.
13745	</desc>
13746	</attribute>
13747
13748	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13749	<desc>
13750	USB standard version which the controller implements.
13751	This is a BCD which means that the major version is in the
13752	high byte and minor version is in the low byte.
13753	</desc>
13754	</attribute>
13755
13756	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13757	<desc>
13758	List of USB device filters associated with the machine.
13759
13760	If the machine is currently running, these filters are activated
13761	every time a new (supported) USB device is attached to the host
13762	computer that was not ignored by global filters
13763	(<link to="IHost::USBDeviceFilters"/>).
13764
13765	These filters are also activated when the machine is powered up.
13766	They are run against a list of all currently available USB
13767	devices (in states
13768	<link to="USBDeviceState_Available"/>,
13769	<link to="USBDeviceState_Busy"/>,
13770	<link to="USBDeviceState_Held"/>) that were not previously
13771	ignored by global filters.
13772
13773	If at least one filter matches the USB device in question, this
13774	device is automatically captured (attached to) the virtual USB
13775	controller of this machine.
13776
13777	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13778	</desc>
13779	</attribute>
13780
13781	<method name="createDeviceFilter">
13782	<desc>
13783	Creates a new USB device filter. All attributes except
13784	the filter name are set to empty (any match),
13785	<i>active</i> is @c false (the filter is not active).
13786
13787	The created filter can then be added to the list of filters using
13788	<link to="#insertDeviceFilter"/>.
13789
13790	<result name="VBOX_E_INVALID_VM_STATE">
13791	The virtual machine is not mutable.
13792	</result>
13793
13794	<see><link to="#deviceFilters"/></see>
13795	</desc>
13796	<param name="name" type="wstring" dir="in">
13797	<desc>
13798	Filter name. See <link to="IUSBDeviceFilter::name"/>
13799	for more info.
13800	</desc>
13801	</param>
13802	<param name="filter" type="IUSBDeviceFilter" dir="return">
13803	<desc>Created filter object.</desc>
13804	</param>
13805	</method>
13806
13807	<method name="insertDeviceFilter">
13808	<desc>
13809	Inserts the given USB device to the specified position
13810	in the list of filters.
13811
13812	Positions are numbered starting from <tt>0</tt>. If the specified
13813	position is equal to or greater than the number of elements in
13814	the list, the filter is added to the end of the collection.
13815
13816	<note>
13817	Duplicates are not allowed, so an attempt to insert a
13818	filter that is already in the collection, will return an
13819	error.
13820	</note>
13821
13822	<result name="VBOX_E_INVALID_VM_STATE">
13823	Virtual machine is not mutable.
13824	</result>
13825	<result name="E_INVALIDARG">
13826	USB device filter not created within this VirtualBox instance.
13827	</result>
13828	<result name="VBOX_E_INVALID_OBJECT_STATE">
13829	USB device filter already in list.
13830	</result>
13831
13832	<see><link to="#deviceFilters"/></see>
13833	</desc>
13834	<param name="position" type="unsigned long" dir="in">
13835	<desc>Position to insert the filter to.</desc>
13836	</param>
13837	<param name="filter" type="IUSBDeviceFilter" dir="in">
13838	<desc>USB device filter to insert.</desc>
13839	</param>
13840	</method>
13841
13842	<method name="removeDeviceFilter">
13843	<desc>
13844	Removes a USB device filter from the specified position in the
13845	list of filters.
13846
13847	Positions are numbered starting from <tt>0</tt>. Specifying a
13848	position equal to or greater than the number of elements in
13849	the list will produce an error.
13850
13851	<see><link to="#deviceFilters"/></see>
13852
13853	<result name="VBOX_E_INVALID_VM_STATE">
13854	Virtual machine is not mutable.
13855	</result>
13856	<result name="E_INVALIDARG">
13857	USB device filter list empty or invalid @a position.
13858	</result>
13859
13860	</desc>
13861	<param name="position" type="unsigned long" dir="in">
13862	<desc>Position to remove the filter from.</desc>
13863	</param>
13864	<param name="filter" type="IUSBDeviceFilter" dir="return">
13865	<desc>Removed USB device filter.</desc>
13866	</param>
13867	</method>
13868
13869	</interface>
13870
13871
13872	<!--
13873	// IUSBDevice
13874	/////////////////////////////////////////////////////////////////////////
13875	-->
13876
13877	<interface
13878	name="IUSBDevice" extends="$unknown"
13879	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13880	wsmap="managed"
13881	>
13882	<desc>
13883	The IUSBDevice interface represents a virtual USB device attached to the
13884	virtual machine.
13885
13886	A collection of objects implementing this interface is stored in the
13887	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13888	attached to a running virtual machine's USB controller.
13889	</desc>
13890
13891	<attribute name="id" type="uuid" mod="string" readonly="yes">
13892	<desc>
13893	Unique USB device ID. This ID is built from #vendorId,
13894	#productId, #revision and #serialNumber.
13895	</desc>
13896	</attribute>
13897
13898	<attribute name="vendorId" type="unsigned short" readonly="yes">
13899	<desc>Vendor ID.</desc>
13900	</attribute>
13901
13902	<attribute name="productId" type="unsigned short" readonly="yes">
13903	<desc>Product ID.</desc>
13904	</attribute>
13905
13906	<attribute name="revision" type="unsigned short" readonly="yes">
13907	<desc>
13908	Product revision number. This is a packed BCD represented as
13909	unsigned short. The high byte is the integer part and the low
13910	byte is the decimal.
13911	</desc>
13912	</attribute>
13913
13914	<attribute name="manufacturer" type="wstring" readonly="yes">
13915	<desc>Manufacturer string.</desc>
13916	</attribute>
13917
13918	<attribute name="product" type="wstring" readonly="yes">
13919	<desc>Product string.</desc>
13920	</attribute>
13921
13922	<attribute name="serialNumber" type="wstring" readonly="yes">
13923	<desc>Serial number string.</desc>
13924	</attribute>
13925
13926	<attribute name="address" type="wstring" readonly="yes">
13927	<desc>Host specific address of the device.</desc>
13928	</attribute>
13929
13930	<attribute name="port" type="unsigned short" readonly="yes">
13931	<desc>
13932	Host USB port number the device is physically
13933	connected to.
13934	</desc>
13935	</attribute>
13936
13937	<attribute name="version" type="unsigned short" readonly="yes">
13938	<desc>
13939	The major USB version of the device - 1 or 2.
13940	</desc>
13941	</attribute>
13942
13943	<attribute name="portVersion" type="unsigned short" readonly="yes">
13944	<desc>
13945	The major USB version of the host USB port the device is
13946	physically connected to - 1 or 2. For devices not connected to
13947	anything this will have the same value as the version attribute.
13948	</desc>
13949	</attribute>
13950
13951	<attribute name="remote" type="boolean" readonly="yes">
13952	<desc>
13953	Whether the device is physically connected to a remote VRDE
13954	client or to a local host machine.
13955	</desc>
13956	</attribute>
13957
13958	</interface>
13959
13960
13961	<!--
13962	// IUSBDeviceFilter
13963	/////////////////////////////////////////////////////////////////////////
13964	-->
13965
13966	<interface
13967	name="IUSBDeviceFilter" extends="$unknown"
13968	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
13969	wsmap="managed"
13970	>
13971	<desc>
13972	The IUSBDeviceFilter interface represents an USB device filter used
13973	to perform actions on a group of USB devices.
13974
13975	This type of filters is used by running virtual machines to
13976	automatically capture selected USB devices once they are physically
13977	attached to the host computer.
13978
13979	A USB device is matched to the given device filter if and only if all
13980	attributes of the device match the corresponding attributes of the
13981	filter (that is, attributes are joined together using the logical AND
13982	operation). On the other hand, all together, filters in the list of
13983	filters carry the semantics of the logical OR operation. So if it is
13984	desirable to create a match like "this vendor id OR this product id",
13985	one needs to create two filters and specify "any match" (see below)
13986	for unused attributes.
13987
13988	All filter attributes used for matching are strings. Each string
13989	is an expression representing a set of values of the corresponding
13990	device attribute, that will match the given filter. Currently, the
13991	following filtering expressions are supported:
13992
13993	<ul>
13994	<li><i>Interval filters</i>. Used to specify valid intervals for
13995	integer device attributes (Vendor ID, Product ID and Revision).
13996	The format of the string is:
13997
13998	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
13999
14000	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
14001	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
14002	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
14003	is omitted before a dash (<tt>-</tt>), the minimum possible integer
14004	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
14005	possible integer is assumed.
14006	</li>
14007	<li><i>Boolean filters</i>. Used to specify acceptable values for
14008	boolean device attributes. The format of the string is:
14009
14010	<tt>true\|false\|yes\|no\|0\|1</tt>
14011
14012	</li>
14013	<li><i>Exact match</i>. Used to specify a single value for the given
14014	device attribute. Any string that doesn't start with <tt>int:</tt>
14015	represents the exact match. String device attributes are compared to
14016	this string including case of symbols. Integer attributes are first
14017	converted to a string (see individual filter attributes) and then
14018	compared ignoring case.
14019
14020	</li>
14021	<li><i>Any match</i>. Any value of the corresponding device attribute
14022	will match the given filter. An empty or @c null string is
14023	used to construct this type of filtering expressions.
14024
14025	</li>
14026	</ul>
14027
14028	<note>
14029	On the Windows host platform, interval filters are not currently
14030	available. Also all string filter attributes
14031	(<link to="#manufacturer"/>, <link to="#product"/>,
14032	<link to="#serialNumber"/>) are ignored, so they behave as
14033	<i>any match</i> no matter what string expression is specified.
14034	</note>
14035
14036	<see><link to="IUSBController::deviceFilters"/>,
14037	<link to="IHostUSBDeviceFilter"/></see>
14038	</desc>
14039
14040	<attribute name="name" type="wstring">
14041	<desc>
14042	Visible name for this filter.
14043	This name is used to visually distinguish one filter from another,
14044	so it can neither be @c null nor an empty string.
14045	</desc>
14046	</attribute>
14047
14048	<attribute name="active" type="boolean">
14049	<desc>Whether this filter active or has been temporarily disabled.</desc>
14050	</attribute>
14051
14052	<attribute name="vendorId" type="wstring">
14053	<desc>
14054	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
14055	The string representation for the <i>exact matching</i>
14056	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14057	(including leading zeroes).
14058	</desc>
14059	</attribute>
14060
14061	<attribute name="productId" type="wstring">
14062	<desc>
14063	<link to="IUSBDevice::productId">Product ID</link> filter.
14064	The string representation for the <i>exact matching</i>
14065	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14066	(including leading zeroes).
14067	</desc>
14068	</attribute>
14069
14070	<attribute name="revision" type="wstring">
14071	<desc>
14072	<link to="IUSBDevice::productId">Product revision number</link>
14073	filter. The string representation for the <i>exact matching</i>
14074	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
14075	of the integer part of the revision, and <tt>F</tt> is the
14076	decimal digit of its fractional part (including leading and
14077	trailing zeros).
14078	Note that for interval filters, it's best to use the hexadecimal
14079	form, because the revision is stored as a 16 bit packed BCD value;
14080	so the expression <tt>int:0x0100-0x0199</tt> will match any
14081	revision from <tt>1.0</tt> to <tt>1.99</tt>.
14082	</desc>
14083	</attribute>
14084
14085	<attribute name="manufacturer" type="wstring">
14086	<desc>
14087	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14088	</desc>
14089	</attribute>
14090
14091	<attribute name="product" type="wstring">
14092	<desc>
14093	<link to="IUSBDevice::product">Product</link> filter.
14094	</desc>
14095	</attribute>
14096
14097	<attribute name="serialNumber" type="wstring">
14098	<desc>
14099	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14100	</desc>
14101	</attribute>
14102
14103	<attribute name="port" type="wstring">
14104	<desc>
14105	<link to="IUSBDevice::port">Host USB port</link> filter.
14106	</desc>
14107	</attribute>
14108
14109	<attribute name="remote" type="wstring">
14110	<desc>
14111	<link to="IUSBDevice::remote">Remote state</link> filter.
14112	<note>
14113	This filter makes sense only for machine USB filters,
14114	i.e. it is ignored by IHostUSBDeviceFilter objects.
14115	</note>
14116	</desc>
14117	</attribute>
14118
14119	<attribute name="maskedInterfaces" type="unsigned long">
14120	<desc>
14121	This is an advanced option for hiding one or more USB interfaces
14122	from the guest. The value is a bit mask where the bits that are set
14123	means the corresponding USB interface should be hidden, masked off
14124	if you like.
14125	This feature only works on Linux hosts.
14126	</desc>
14127	</attribute>
14128
14129	</interface>
14130
14131
14132	<!--
14133	// IHostUSBDevice
14134	/////////////////////////////////////////////////////////////////////////
14135	-->
14136
14137	<enum
14138	name="USBDeviceState"
14139	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14140	>
14141	<desc>
14142	USB device state. This enumeration represents all possible states
14143	of the USB device physically attached to the host computer regarding
14144	its state on the host computer and availability to guest computers
14145	(all currently running virtual machines).
14146
14147	Once a supported USB device is attached to the host, global USB
14148	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14149	either ignore the device, or put it to USBDeviceState_Held state, or do
14150	nothing. Unless the device is ignored by global filters, filters of all
14151	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14152	activated that can put it to USBDeviceState_Captured state.
14153
14154	If the device was ignored by global filters, or didn't match
14155	any filters at all (including guest ones), it is handled by the host
14156	in a normal way. In this case, the device state is determined by
14157	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14158	or USBDeviceState_Available, depending on the current device usage.
14159
14160	Besides auto-capturing based on filters, the device can be manually
14161	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14162	state is USBDeviceState_Busy, USBDeviceState_Available or
14163	USBDeviceState_Held.
14164
14165	<note>
14166	Due to differences in USB stack implementations in Linux and Win32,
14167	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14168	only to the Linux version of the product. This also means that (<link
14169	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14170	device state is USBDeviceState_Held.
14171	</note>
14172
14173	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14174	</desc>
14175
14176	<const name="NotSupported" value="0">
14177	<desc>
14178	Not supported by the VirtualBox server, not available to guests.
14179	</desc>
14180	</const>
14181	<const name="Unavailable" value="1">
14182	<desc>
14183	Being used by the host computer exclusively,
14184	not available to guests.
14185	</desc>
14186	</const>
14187	<const name="Busy" value="2">
14188	<desc>
14189	Being used by the host computer, potentially available to guests.
14190	</desc>
14191	</const>
14192	<const name="Available" value="3">
14193	<desc>
14194	Not used by the host computer, available to guests (the host computer
14195	can also start using the device at any time).
14196	</desc>
14197	</const>
14198	<const name="Held" value="4">
14199	<desc>
14200	Held by the VirtualBox server (ignored by the host computer),
14201	available to guests.
14202	</desc>
14203	</const>
14204	<const name="Captured" value="5">
14205	<desc>
14206	Captured by one of the guest computers, not available
14207	to anybody else.
14208	</desc>
14209	</const>
14210	</enum>
14211
14212	<interface
14213	name="IHostUSBDevice" extends="IUSBDevice"
14214	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14215	wsmap="managed"
14216	>
14217	<desc>
14218	The IHostUSBDevice interface represents a physical USB device attached
14219	to the host computer.
14220
14221	Besides properties inherited from IUSBDevice, this interface adds the
14222	<link to="#state"/> property that holds the current state of the USB
14223	device.
14224
14225	<see><link to="IHost::USBDevices"/>,
14226	<link to="IHost::USBDeviceFilters"/></see>
14227	</desc>
14228
14229	<attribute name="state" type="USBDeviceState" readonly="yes">
14230	<desc>
14231	Current state of the device.
14232	</desc>
14233	</attribute>
14234
14235	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14236
14237	</interface>
14238
14239
14240	<!--
14241	// IHostUSBDeviceFilter
14242	/////////////////////////////////////////////////////////////////////////
14243	-->
14244
14245	<enum
14246	name="USBDeviceFilterAction"
14247	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14248	>
14249	<desc>
14250	Actions for host USB device filters.
14251	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14252	</desc>
14253
14254	<const name="Null" value="0">
14255	<desc>Null value (never used by the API).</desc>
14256	</const>
14257	<const name="Ignore" value="1">
14258	<desc>Ignore the matched USB device.</desc>
14259	</const>
14260	<const name="Hold" value="2">
14261	<desc>Hold the matched USB device.</desc>
14262	</const>
14263	</enum>
14264
14265	<interface
14266	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14267	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14268	wsmap="managed"
14269	>
14270	<desc>
14271	The IHostUSBDeviceFilter interface represents a global filter for a
14272	physical USB device used by the host computer. Used indirectly in
14273	<link to="IHost::USBDeviceFilters"/>.
14274
14275	Using filters of this type, the host computer determines the initial
14276	state of the USB device after it is physically attached to the
14277	host's USB controller.
14278
14279	<note>
14280	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14281	filters, because it makes sense only for
14282	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14283	</note>
14284
14285	<see><link to="IHost::USBDeviceFilters"/></see>
14286	</desc>
14287
14288	<attribute name="action" type="USBDeviceFilterAction">
14289	<desc>
14290	Action performed by the host when an attached USB device
14291	matches this filter.
14292	</desc>
14293	</attribute>
14294
14295	</interface>
14296
14297	<!--
14298	// IAudioAdapter
14299	/////////////////////////////////////////////////////////////////////////
14300	-->
14301
14302	<enum
14303	name="AudioDriverType"
14304	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14305	>
14306	<desc>
14307	Host audio driver type.
14308	</desc>
14309
14310	<const name="Null" value="0">
14311	<desc>Null value, also means "dummy audio driver".</desc>
14312	</const>
14313	<const name="WinMM" value="1">
14314	<desc>Windows multimedia (Windows hosts only).</desc>
14315	</const>
14316	<const name="OSS" value="2">
14317	<desc>Open Sound System (Linux hosts only).</desc>
14318	</const>
14319	<const name="ALSA" value="3">
14320	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14321	</const>
14322	<const name="DirectSound" value="4">
14323	<desc>DirectSound (Windows hosts only).</desc>
14324	</const>
14325	<const name="CoreAudio" value="5">
14326	<desc>CoreAudio (Mac hosts only).</desc>
14327	</const>
14328	<const name="MMPM" value="6">
14329	<desc>Reserved for historical reasons.</desc>
14330	</const>
14331	<const name="Pulse" value="7">
14332	<desc>PulseAudio (Linux hosts only).</desc>
14333	</const>
14334	<const name="SolAudio" value="8">
14335	<desc>Solaris audio (Solaris hosts only).</desc>
14336	</const>
14337	</enum>
14338
14339	<enum
14340	name="AudioControllerType"
14341	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14342	>
14343	<desc>
14344	Virtual audio controller type.
14345	</desc>
14346
14347	<const name="AC97" value="0"/>
14348	<const name="SB16" value="1"/>
14349	<const name="HDA" value="2"/>
14350	</enum>
14351
14352	<interface
14353	name="IAudioAdapter" extends="$unknown"
14354	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14355	wsmap="managed"
14356	>
14357	<desc>
14358	The IAudioAdapter interface represents the virtual audio adapter of
14359	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14360	</desc>
14361	<attribute name="enabled" type="boolean">
14362	<desc>
14363	Flag whether the audio adapter is present in the
14364	guest system. If disabled, the virtual guest hardware will
14365	not contain any audio adapter. Can only be changed when
14366	the VM is not running.
14367	</desc>
14368	</attribute>
14369	<attribute name="audioController" type="AudioControllerType">
14370	<desc>
14371	The audio hardware we emulate.
14372	</desc>
14373	</attribute>
14374	<attribute name="audioDriver" type="AudioDriverType">
14375	<desc>
14376	Audio driver the adapter is connected to. This setting
14377	can only be changed when the VM is not running.
14378	</desc>
14379	</attribute>
14380	</interface>
14381
14382	<enum
14383	name="AuthType"
14384	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14385	>
14386	<desc>
14387	VirtualBox authentication type.
14388	</desc>
14389
14390	<const name="Null" value="0">
14391	<desc>Null value, also means "no authentication".</desc>
14392	</const>
14393	<const name="External" value="1"/>
14394	<const name="Guest" value="2"/>
14395	</enum>
14396
14397	<!--
14398	// IVRDEServer
14399	/////////////////////////////////////////////////////////////////////////
14400	-->
14401
14402	<interface
14403	name="IVRDEServer" extends="$unknown"
14404	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14405	wsmap="managed"
14406	>
14407	<attribute name="enabled" type="boolean">
14408	<desc>VRDE server status.</desc>
14409	</attribute>
14410
14411	<attribute name="authType" type="AuthType">
14412	<desc>VRDE authentication method.</desc>
14413	</attribute>
14414
14415	<attribute name="authTimeout" type="unsigned long">
14416	<desc>Timeout for guest authentication. Milliseconds.</desc>
14417	</attribute>
14418
14419	<attribute name="allowMultiConnection" type="boolean">
14420	<desc>
14421	Flag whether multiple simultaneous connections to the VM are permitted.
14422	Note that this will be replaced by a more powerful mechanism in the future.
14423	</desc>
14424	</attribute>
14425
14426	<attribute name="reuseSingleConnection" type="boolean">
14427	<desc>
14428	Flag whether the existing connection must be dropped and a new connection
14429	must be established by the VRDE server, when a new client connects in single
14430	connection mode.
14431	</desc>
14432	</attribute>
14433
14434	<attribute name="VRDEExtPack" type="wstring">
14435	<desc>
14436	The name of Extension Pack providing VRDE for this VM. Overrides
14437	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14438	</desc>
14439	</attribute>
14440
14441	<attribute name="authLibrary" type="wstring">
14442	<desc>
14443	Library used for authentication of RDP clients by this VM. Overrides
14444	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14445	</desc>
14446	</attribute>
14447
14448	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14449	<desc>
14450	Array of names of properties, which are supported by this VRDE server.
14451	</desc>
14452	</attribute>
14453
14454	<method name="setVRDEProperty">
14455	<desc>
14456	Sets a VRDE specific property string.
14457
14458	If you pass @c null or empty string as a key @a value, the given @a key
14459	will be deleted.
14460
14461	</desc>
14462	<param name="key" type="wstring" dir="in">
14463	<desc>Name of the key to set.</desc>
14464	</param>
14465	<param name="value" type="wstring" dir="in">
14466	<desc>Value to assign to the key.</desc>
14467	</param>
14468	</method>
14469
14470	<method name="getVRDEProperty" const="yes">
14471	<desc>
14472	Returns a VRDE specific property string.
14473
14474	If the requested data @a key does not exist, this function will
14475	succeed and return an empty string in the @a value argument.
14476
14477	</desc>
14478	<param name="key" type="wstring" dir="in">
14479	<desc>Name of the key to get.</desc>
14480	</param>
14481	<param name="value" type="wstring" dir="return">
14482	<desc>Value of the requested key.</desc>
14483	</param>
14484	</method>
14485
14486	</interface>
14487
14488
14489	<!--
14490	// ISharedFolder
14491	/////////////////////////////////////////////////////////////////////////
14492	-->
14493
14494	<interface
14495	name="ISharedFolder" extends="$unknown"
14496	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14497	wsmap="struct"
14498	>
14499	<desc>
14500	The ISharedFolder interface represents a folder in the host computer's
14501	file system accessible from the guest OS running inside a virtual
14502	machine using an associated logical name.
14503
14504	There are three types of shared folders:
14505	<ul>
14506	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14507	folders available to all virtual machines.</li>
14508	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14509	VM-specific shared folders available to the given virtual machine at
14510	startup.</li>
14511	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14512	VM-specific shared folders created in the session context (for
14513	example, when the virtual machine is running) and automatically
14514	discarded when the session is closed (the VM is powered off).</li>
14515	</ul>
14516
14517	Logical names of shared folders must be unique within the given scope
14518	(global, permanent or transient). However, they do not need to be unique
14519	across scopes. In this case, the definition of the shared folder in a
14520	more specific scope takes precedence over definitions in all other
14521	scopes. The order of precedence is (more specific to more general):
14522	<ol>
14523	<li>Transient definitions</li>
14524	<li>Permanent definitions</li>
14525	<li>Global definitions</li>
14526	</ol>
14527
14528	For example, if MyMachine has a shared folder named
14529	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14530	transient shared folder named <tt>C_DRIVE</tt> (that points
14531	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14532	of <tt>C_DRIVE</tt> in the guest OS so
14533	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14534	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14535	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14536	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14537	to <tt>C:\\</tt> if it still exists.
14538
14539	Note that permanent and transient shared folders of different machines
14540	are in different name spaces, so they don't overlap and don't need to
14541	have unique logical names.
14542
14543	<note>
14544	Global shared folders are not implemented in the current version of the
14545	product.
14546	</note>
14547	</desc>
14548
14549	<attribute name="name" type="wstring" readonly="yes">
14550	<desc>Logical name of the shared folder.</desc>
14551	</attribute>
14552
14553	<attribute name="hostPath" type="wstring" readonly="yes">
14554	<desc>Full path to the shared folder in the host file system.</desc>
14555	</attribute>
14556
14557	<attribute name="accessible" type="boolean" readonly="yes">
14558	<desc>
14559	Whether the folder defined by the host path is currently
14560	accessible or not.
14561	For example, the folder can be inaccessible if it is placed
14562	on the network share that is not available by the time
14563	this property is read.
14564	</desc>
14565	</attribute>
14566
14567	<attribute name="writable" type="boolean" readonly="yes">
14568	<desc>
14569	Whether the folder defined by the host path is writable or
14570	not.
14571	</desc>
14572	</attribute>
14573
14574	<attribute name="autoMount" type="boolean" readonly="yes">
14575	<desc>
14576	Whether the folder gets automatically mounted by the guest or not.
14577	</desc>
14578	</attribute>
14579
14580	<attribute name="lastAccessError" type="wstring" readonly="yes">
14581	<desc>
14582	Text message that represents the result of the last accessibility
14583	check.
14584
14585	Accessibility checks are performed each time the <link to="#accessible"/>
14586	attribute is read. An empty string is returned if the last
14587	accessibility check was successful. A non-empty string indicates a
14588	failure and should normally describe a reason of the failure (for
14589	example, a file read error).
14590	</desc>
14591	</attribute>
14592
14593	</interface>
14594
14595	<!--
14596	// ISession
14597	/////////////////////////////////////////////////////////////////////////
14598	-->
14599
14600	<interface
14601	name="IInternalSessionControl" extends="$unknown"
14602	uuid="0bdda5da-67c8-47be-a610-b83a7fa3e8b6"
14603	internal="yes"
14604	wsmap="suppress"
14605	>
14606	<method name="getPID">
14607	<desc>PID of the process that has created this Session object.
14608	</desc>
14609	<param name="pid" type="unsigned long" dir="return"/>
14610	</method>
14611
14612	<method name="getRemoteConsole">
14613	<desc>
14614	Returns the console object suitable for remote control.
14615
14616	<result name="VBOX_E_INVALID_VM_STATE">
14617	Session state prevents operation.
14618	</result>
14619	<result name="VBOX_E_INVALID_OBJECT_STATE">
14620	Session type prevents operation.
14621	</result>
14622
14623	</desc>
14624	<param name="console" type="IConsole" dir="return"/>
14625	</method>
14626
14627	<method name="assignMachine">
14628	<desc>
14629	Assigns the machine object associated with this direct-type
14630	session or informs the session that it will be a remote one
14631	(if @a machine == @c null).
14632
14633	<result name="VBOX_E_INVALID_VM_STATE">
14634	Session state prevents operation.
14635	</result>
14636	<result name="VBOX_E_INVALID_OBJECT_STATE">
14637	Session type prevents operation.
14638	</result>
14639
14640	</desc>
14641	<param name="machine" type="IMachine" dir="in"/>
14642	</method>
14643
14644	<method name="assignRemoteMachine">
14645	<desc>
14646	Assigns the machine and the (remote) console object associated with
14647	this remote-type session.
14648
14649	<result name="VBOX_E_INVALID_VM_STATE">
14650	Session state prevents operation.
14651	</result>
14652
14653	</desc>
14654	<param name="machine" type="IMachine" dir="in"/>
14655	<param name="console" type="IConsole" dir="in"/>
14656	</method>
14657
14658	<method name="updateMachineState">
14659	<desc>
14660	Updates the machine state in the VM process.
14661	Must be called only in certain cases
14662	(see the method implementation).
14663
14664	<result name="VBOX_E_INVALID_VM_STATE">
14665	Session state prevents operation.
14666	</result>
14667	<result name="VBOX_E_INVALID_OBJECT_STATE">
14668	Session type prevents operation.
14669	</result>
14670
14671	</desc>
14672	<param name="aMachineState" type="MachineState" dir="in"/>
14673	</method>
14674
14675	<method name="uninitialize">
14676	<desc>
14677	Uninitializes (closes) this session. Used by VirtualBox to close
14678	the corresponding remote session when the direct session dies
14679	or gets closed.
14680
14681	<result name="VBOX_E_INVALID_VM_STATE">
14682	Session state prevents operation.
14683	</result>
14684
14685	</desc>
14686	</method>
14687
14688	<method name="onNetworkAdapterChange">
14689	<desc>
14690	Triggered when settings of a network adapter of the
14691	associated virtual machine have changed.
14692
14693	<result name="VBOX_E_INVALID_VM_STATE">
14694	Session state prevents operation.
14695	</result>
14696	<result name="VBOX_E_INVALID_OBJECT_STATE">
14697	Session type prevents operation.
14698	</result>
14699
14700	</desc>
14701	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14702	<param name="changeAdapter" type="boolean" dir="in"/>
14703	</method>
14704
14705	<method name="onSerialPortChange">
14706	<desc>
14707	Triggered when settings of a serial port of the
14708	associated virtual machine have changed.
14709
14710	<result name="VBOX_E_INVALID_VM_STATE">
14711	Session state prevents operation.
14712	</result>
14713	<result name="VBOX_E_INVALID_OBJECT_STATE">
14714	Session type prevents operation.
14715	</result>
14716
14717	</desc>
14718	<param name="serialPort" type="ISerialPort" dir="in"/>
14719	</method>
14720
14721	<method name="onParallelPortChange">
14722	<desc>
14723	Triggered when settings of a parallel port of the
14724	associated virtual machine have changed.
14725
14726	<result name="VBOX_E_INVALID_VM_STATE">
14727	Session state prevents operation.
14728	</result>
14729	<result name="VBOX_E_INVALID_OBJECT_STATE">
14730	Session type prevents operation.
14731	</result>
14732
14733	</desc>
14734	<param name="parallelPort" type="IParallelPort" dir="in"/>
14735	</method>
14736
14737	<method name="onStorageControllerChange">
14738	<desc>
14739	Triggered when settings of a storage controller of the
14740	associated virtual machine have changed.
14741
14742	<result name="VBOX_E_INVALID_VM_STATE">
14743	Session state prevents operation.
14744	</result>
14745	<result name="VBOX_E_INVALID_OBJECT_STATE">
14746	Session type prevents operation.
14747	</result>
14748
14749	</desc>
14750	</method>
14751
14752	<method name="onMediumChange">
14753	<desc>
14754	Triggered when attached media of the
14755	associated virtual machine have changed.
14756
14757	<result name="VBOX_E_INVALID_VM_STATE">
14758	Session state prevents operation.
14759	</result>
14760	<result name="VBOX_E_INVALID_OBJECT_STATE">
14761	Session type prevents operation.
14762	</result>
14763
14764	</desc>
14765
14766	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14767	<desc>The medium attachment which changed.</desc>
14768	</param>
14769	<param name="force" type="boolean" dir="in">
14770	<desc>If the medium change was forced.</desc>
14771	</param>
14772	</method>
14773
14774	<method name="onStorageDeviceChange">
14775	<desc>
14776	Triggered when attached storage devices of the
14777	associated virtual machine have changed.
14778
14779	<result name="VBOX_E_INVALID_VM_STATE">
14780	Session state prevents operation.
14781	</result>
14782	<result name="VBOX_E_INVALID_OBJECT_STATE">
14783	Session type prevents operation.
14784	</result>
14785
14786	</desc>
14787
14788	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14789	<desc>The medium attachment which changed.</desc>
14790	</param>
14791	<param name="remove" type="boolean" dir="in">
14792	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14793	</param>
14794	</method>
14795
14796	<method name="onCPUChange">
14797	<desc>
14798	Notification when a CPU changes.
14799	</desc>
14800	<param name="cpu" type="unsigned long" dir="in">
14801	<desc>The CPU which changed</desc>
14802	</param>
14803	<param name="add" type="boolean" dir="in">
14804	<desc>Flag whether the CPU was added or removed</desc>
14805	</param>
14806	</method>
14807
14808	<method name="onCPUExecutionCapChange">
14809	<desc>
14810	Notification when the CPU execution cap changes.
14811	</desc>
14812	<param name="executionCap" type="unsigned long" dir="in">
14813	<desc>The new CPU execution cap value. (1-100)</desc>
14814	</param>
14815	</method>
14816
14817	<method name="onVRDEServerChange">
14818	<desc>
14819	Triggered when settings of the VRDE server object of the
14820	associated virtual machine have changed.
14821
14822	<result name="VBOX_E_INVALID_VM_STATE">
14823	Session state prevents operation.
14824	</result>
14825	<result name="VBOX_E_INVALID_OBJECT_STATE">
14826	Session type prevents operation.
14827	</result>
14828
14829	</desc>
14830	<param name="restart" type="boolean" dir="in">
14831	<desc>Flag whether the server must be restarted</desc>
14832	</param>
14833	</method>
14834
14835	<method name="onUSBControllerChange">
14836	<desc>
14837	Triggered when settings of the USB controller object of the
14838	associated virtual machine have changed.
14839
14840	<result name="VBOX_E_INVALID_VM_STATE">
14841	Session state prevents operation.
14842	</result>
14843	<result name="VBOX_E_INVALID_OBJECT_STATE">
14844	Session type prevents operation.
14845	</result>
14846
14847	</desc>
14848	</method>
14849
14850	<method name="onSharedFolderChange">
14851	<desc>
14852	Triggered when a permanent (global or machine) shared folder has been
14853	created or removed.
14854	<note>
14855	We don't pass shared folder parameters in this notification because
14856	the order in which parallel notifications are delivered is not defined,
14857	therefore it could happen that these parameters were outdated by the
14858	time of processing this notification.
14859	</note>
14860
14861	<result name="VBOX_E_INVALID_VM_STATE">
14862	Session state prevents operation.
14863	</result>
14864	<result name="VBOX_E_INVALID_OBJECT_STATE">
14865	Session type prevents operation.
14866	</result>
14867
14868	</desc>
14869	<param name="global" type="boolean" dir="in"/>
14870	</method>
14871
14872	<method name="onUSBDeviceAttach">
14873	<desc>
14874	Triggered when a request to capture a USB device (as a result
14875	of matched USB filters or direct call to
14876	<link to="IConsole::attachUSBDevice"/>) has completed.
14877	A @c null @a error object means success, otherwise it
14878	describes a failure.
14879
14880	<result name="VBOX_E_INVALID_VM_STATE">
14881	Session state prevents operation.
14882	</result>
14883	<result name="VBOX_E_INVALID_OBJECT_STATE">
14884	Session type prevents operation.
14885	</result>
14886
14887	</desc>
14888	<param name="device" type="IUSBDevice" dir="in"/>
14889	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14890	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14891	</method>
14892
14893	<method name="onUSBDeviceDetach">
14894	<desc>
14895	Triggered when a request to release the USB device (as a result
14896	of machine termination or direct call to
14897	<link to="IConsole::detachUSBDevice"/>) has completed.
14898	A @c null @a error object means success, otherwise it
14899	describes a failure.
14900
14901	<result name="VBOX_E_INVALID_VM_STATE">
14902	Session state prevents operation.
14903	</result>
14904	<result name="VBOX_E_INVALID_OBJECT_STATE">
14905	Session type prevents operation.
14906	</result>
14907
14908	</desc>
14909	<param name="id" type="uuid" mod="string" dir="in"/>
14910	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14911	</method>
14912
14913	<method name="onShowWindow">
14914	<desc>
14915	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14916	<link to="IMachine::showConsoleWindow"/> in order to notify
14917	console listeners
14918	<link to="ICanShowWindowEvent"/>
14919	and <link to="IShowWindowEvent"/>.
14920
14921	<result name="VBOX_E_INVALID_OBJECT_STATE">
14922	Session type prevents operation.
14923	</result>
14924
14925	</desc>
14926	<param name="check" type="boolean" dir="in"/>
14927	<param name="canShow" type="boolean" dir="out"/>
14928	<param name="winId" type="long long" dir="out"/>
14929	</method>
14930
14931	<method name="onBandwidthGroupChange">
14932	<desc>
14933	Notification when one of the bandwidth groups change.
14934	</desc>
14935	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
14936	<desc>The bandwidth group which changed.</desc>
14937	</param>
14938	</method>
14939
14940	<method name="accessGuestProperty">
14941	<desc>
14942	Called by <link to="IMachine::getGuestProperty"/> and by
14943	<link to="IMachine::setGuestProperty"/> in order to read and
14944	modify guest properties.
14945
14946	<result name="VBOX_E_INVALID_VM_STATE">
14947	Machine session is not open.
14948	</result>
14949	<result name="VBOX_E_INVALID_OBJECT_STATE">
14950	Session type is not direct.
14951	</result>
14952
14953	</desc>
14954	<param name="name" type="wstring" dir="in"/>
14955	<param name="value" type="wstring" dir="in"/>
14956	<param name="flags" type="wstring" dir="in"/>
14957	<param name="isSetter" type="boolean" dir="in"/>
14958	<param name="retValue" type="wstring" dir="out"/>
14959	<param name="retTimestamp" type="long long" dir="out"/>
14960	<param name="retFlags" type="wstring" dir="out"/>
14961	</method>
14962
14963	<method name="enumerateGuestProperties" const="yes">
14964	<desc>
14965	Return a list of the guest properties matching a set of patterns along
14966	with their values, time stamps and flags.
14967
14968	<result name="VBOX_E_INVALID_VM_STATE">
14969	Machine session is not open.
14970	</result>
14971	<result name="VBOX_E_INVALID_OBJECT_STATE">
14972	Session type is not direct.
14973	</result>
14974
14975	</desc>
14976	<param name="patterns" type="wstring" dir="in">
14977	<desc>
14978	The patterns to match the properties against as a comma-separated
14979	string. If this is empty, all properties currently set will be
14980	returned.
14981	</desc>
14982	</param>
14983	<param name="key" type="wstring" dir="out" safearray="yes">
14984	<desc>
14985	The key names of the properties returned.
14986	</desc>
14987	</param>
14988	<param name="value" type="wstring" dir="out" safearray="yes">
14989	<desc>
14990	The values of the properties returned. The array entries match the
14991	corresponding entries in the @a key array.
14992	</desc>
14993	</param>
14994	<param name="timestamp" type="long long" dir="out" safearray="yes">
14995	<desc>
14996	The time stamps of the properties returned. The array entries match
14997	the corresponding entries in the @a key array.
14998	</desc>
14999	</param>
15000	<param name="flags" type="wstring" dir="out" safearray="yes">
15001	<desc>
15002	The flags of the properties returned. The array entries match the
15003	corresponding entries in the @a key array.
15004	</desc>
15005	</param>
15006	</method>
15007
15008	<method name="onlineMergeMedium">
15009	<desc>
15010	Triggers online merging of a hard disk. Used internally when deleting
15011	a snapshot while a VM referring to the same hard disk chain is running.
15012
15013	<result name="VBOX_E_INVALID_VM_STATE">
15014	Machine session is not open.
15015	</result>
15016	<result name="VBOX_E_INVALID_OBJECT_STATE">
15017	Session type is not direct.
15018	</result>
15019
15020	</desc>
15021	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
15022	<desc>The medium attachment to identify the medium chain.</desc>
15023	</param>
15024	<param name="sourceIdx" type="unsigned long" dir="in">
15025	<desc>The index of the source image in the chain.
15026	Redundant, but drastically reduces IPC.</desc>
15027	</param>
15028	<param name="targetIdx" type="unsigned long" dir="in">
15029	<desc>The index of the target image in the chain.
15030	Redundant, but drastically reduces IPC.</desc>
15031	</param>
15032	<param name="source" type="IMedium" dir="in">
15033	<desc>Merge source medium.</desc>
15034	</param>
15035	<param name="target" type="IMedium" dir="in">
15036	<desc>Merge target medium.</desc>
15037	</param>
15038	<param name="mergeForward" type="boolean" dir="in">
15039	<desc>Merge direction.</desc>
15040	</param>
15041	<param name="parentForTarget" type="IMedium" dir="in">
15042	<desc>For forward merges: new parent for target medium.</desc>
15043	</param>
15044	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
15045	<desc>For backward merges: list of media which need their parent UUID
15046	updated.</desc>
15047	</param>
15048	<param name="progress" type="IProgress" dir="in">
15049	<desc>
15050	Progress object for this operation.
15051	</desc>
15052	</param>
15053	</method>
15054
15055	<method name="enableVMMStatistics">
15056	<desc>
15057	Enables or disables collection of VMM RAM statistics.
15058
15059	<result name="VBOX_E_INVALID_VM_STATE">
15060	Machine session is not open.
15061	</result>
15062	<result name="VBOX_E_INVALID_OBJECT_STATE">
15063	Session type is not direct.
15064	</result>
15065
15066	</desc>
15067	<param name="enable" type="boolean" dir="in">
15068	<desc>True enables statistics collection.</desc>
15069	</param>
15070	</method>
15071
15072	</interface>
15073
15074	<interface
15075	name="ISession" extends="$unknown"
15076	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
15077	wsmap="managed"
15078	>
15079	<desc>
15080	The ISession interface represents a client process and allows for locking
15081	virtual machines (represented by IMachine objects) to prevent conflicting
15082	changes to the machine.
15083
15084	Any caller wishing to manipulate a virtual machine needs to create a session
15085	object first, which lives in its own process space. Such session objects are
15086	then associated with <link to="IMachine" /> objects living in the VirtualBox
15087	server process to coordinate such changes.
15088
15089	There are two typical scenarios in which sessions are used:
15090
15091	<ul>
15092	<li>To alter machine settings or control a running virtual machine, one
15093	needs to lock a machine for a given session (client process) by calling
15094	<link to="IMachine::lockMachine"/>.
15095
15096	Whereas multiple sessions may control a running virtual machine, only
15097	one process can obtain a write lock on the machine to prevent conflicting
15098	changes. A write lock is also needed if a process wants to actually run a
15099	virtual machine in its own context, such as the VirtualBox GUI or
15100	VBoxHeadless front-ends. They must also lock a machine for their own
15101	sessions before they are allowed to power up the virtual machine.
15102
15103	As a result, no machine settings can be altered while another process is
15104	already using it, either because that process is modifying machine settings
15105	or because the machine is running.
15106	</li>
15107	<li>
15108	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15109	VirtualBox GUI or VBoxHeadless), one would use
15110	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15111	as its first parameter. This session then identifies the caller and lets the
15112	caller control the started machine (for example, pause machine execution or
15113	power it down) as well as be notified about machine execution state changes.
15114	</li>
15115	</ul>
15116
15117	How sessions objects are created in a client process depends on whether you use
15118	the Main API via COM or via the webservice:
15119
15120	<ul>
15121	<li>When using the COM API directly, an object of the Session class from the
15122	VirtualBox type library needs to be created. In regular COM C++ client code,
15123	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15124	This object will then act as a local session object in further calls to open
15125	a session.
15126	</li>
15127
15128	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15129	a session object automatically whenever <link to="IWebsessionManager::logon" />
15130	is called. A managed object reference to that session object can be retrieved by
15131	calling <link to="IWebsessionManager::getSessionObject" />.
15132	</li>
15133	</ul>
15134	</desc>
15135
15136	<attribute name="state" type="SessionState" readonly="yes">
15137	<desc>Current state of this session.</desc>
15138	</attribute>
15139
15140	<attribute name="type" type="SessionType" readonly="yes">
15141	<desc>
15142	Type of this session. The value of this attribute is valid only
15143	if the session currently has a machine locked (i.e. its
15144	<link to="#state" /> is Locked), otherwise an error will be returned.
15145	</desc>
15146	</attribute>
15147
15148	<attribute name="machine" type="IMachine" readonly="yes">
15149	<desc>Machine object associated with this session.</desc>
15150	</attribute>
15151
15152	<attribute name="console" type="IConsole" readonly="yes">
15153	<desc>Console object associated with this session.</desc>
15154	</attribute>
15155
15156	<method name="unlockMachine">
15157	<desc>
15158	Unlocks a machine that was previously locked for the current session.
15159
15160	Calling this method is required every time a machine has been locked
15161	for a particular session using the <link to="IMachine::launchVMProcess" />
15162	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15163	the machine will be set to <link to="MachineState_Aborted" /> on the
15164	server, and changes made to the machine settings will be lost.
15165
15166	Generally, it is recommended to unlock all machines explicitly
15167	before terminating the application (regardless of the reason for
15168	the termination).
15169
15170	<note>
15171	Do not expect the session state (<link to="ISession::state" />
15172	to return to "Unlocked" immediately after you invoke this method,
15173	particularly if you have started a new VM process. The session
15174	state will automatically return to "Unlocked" once the VM is no
15175	longer executing, which can of course take a very long time.
15176	</note>
15177
15178	<result name="E_UNEXPECTED">
15179	Session is not locked.
15180	</result>
15181
15182	</desc>
15183	</method>
15184
15185	</interface>
15186
15187	<!--
15188	// IStorageController
15189	/////////////////////////////////////////////////////////////////////////
15190	-->
15191
15192	<enum
15193	name="StorageBus"
15194	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15195	>
15196	<desc>
15197	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15198	see <link to="IStorageController::bus" />.
15199	</desc>
15200	<const name="Null" value="0">
15201	<desc>@c null value. Never used by the API.</desc>
15202	</const>
15203	<const name="IDE" value="1"/>
15204	<const name="SATA" value="2"/>
15205	<const name="SCSI" value="3"/>
15206	<const name="Floppy" value="4"/>
15207	<const name="SAS" value="5"/>
15208	</enum>
15209
15210	<enum
15211	name="StorageControllerType"
15212	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15213	>
15214	<desc>
15215	The exact variant of storage controller hardware presented
15216	to the guest; see <link to="IStorageController::controllerType" />.
15217	</desc>
15218
15219	<const name="Null" value="0">
15220	<desc>@c null value. Never used by the API.</desc>
15221	</const>
15222	<const name="LsiLogic" value="1">
15223	<desc>A SCSI controller of the LsiLogic variant.</desc>
15224	</const>
15225	<const name="BusLogic" value="2">
15226	<desc>A SCSI controller of the BusLogic variant.</desc>
15227	</const>
15228	<const name="IntelAhci" value="3">
15229	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15230	</const>
15231	<const name="PIIX3" value="4">
15232	<desc>An IDE controller of the PIIX3 variant.</desc>
15233	</const>
15234	<const name="PIIX4" value="5">
15235	<desc>An IDE controller of the PIIX4 variant.</desc>
15236	</const>
15237	<const name="ICH6" value="6">
15238	<desc>An IDE controller of the ICH6 variant.</desc>
15239	</const>
15240	<const name="I82078" value="7">
15241	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15242	</const>
15243	<const name="LsiLogicSas" value="8">
15244	<desc>A variant of the LsiLogic controller using SAS.</desc>
15245	</const>
15246	</enum>
15247
15248	<enum
15249	name="ChipsetType"
15250	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15251	>
15252	<desc>
15253	Type of emulated chipset (mostly southbridge).
15254	</desc>
15255
15256	<const name="Null" value="0">
15257	<desc>@c null value. Never used by the API.</desc>
15258	</const>
15259	<const name="PIIX3" value="1">
15260	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15261	</const>
15262	<const name="ICH9" value="2">
15263	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15264	</const>
15265	</enum>
15266
15267	<interface
15268	name="IStorageController" extends="$unknown"
15269	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15270	wsmap="managed"
15271	>
15272	<desc>
15273	Represents a storage controller that is attached to a virtual machine
15274	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15275	attached to storage controllers in a real computer, virtual drives
15276	(represented by <link to="IMediumAttachment" />) are attached to virtual
15277	storage controllers, represented by this interface.
15278
15279	As opposed to physical hardware, VirtualBox has a very generic concept
15280	of a storage controller, and for purposes of the Main API, all virtual
15281	storage is attached to virtual machines via instances of this interface.
15282	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15283	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15284	is used, certain sub-types may be available and can be selected in
15285	<link to="#controllerType" />.
15286
15287	Depending on these settings, the guest operating system might see
15288	significantly different virtual hardware.
15289	</desc>
15290
15291	<attribute name="name" type="wstring" readonly="yes">
15292	<desc>
15293	Name of the storage controller, as originally specified with
15294	<link to="IMachine::addStorageController" />. This then uniquely
15295	identifies this controller with other method calls such as
15296	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15297	</desc>
15298	</attribute>
15299
15300	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15301	<desc>
15302	Maximum number of devices which can be attached to one port.
15303	</desc>
15304	</attribute>
15305
15306	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15307	<desc>
15308	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15309	</desc>
15310	</attribute>
15311
15312	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15313	<desc>
15314	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15315	</desc>
15316	</attribute>
15317
15318	<attribute name="instance" type="unsigned long">
15319	<desc>
15320	The instance number of the device in the running VM.
15321	</desc>
15322	</attribute>
15323
15324	<attribute name="portCount" type="unsigned long">
15325	<desc>
15326	The number of currently usable ports on the controller.
15327	The minimum and maximum number of ports for one controller are
15328	stored in <link to="IStorageController::minPortCount"/>
15329	and <link to="IStorageController::maxPortCount"/>.
15330	</desc>
15331	</attribute>
15332
15333	<attribute name="bus" type="StorageBus" readonly="yes">
15334	<desc>
15335	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15336	</desc>
15337	</attribute>
15338
15339	<attribute name="controllerType" type="StorageControllerType">
15340	<desc>
15341	The exact variant of storage controller hardware presented
15342	to the guest.
15343	Depending on this value, VirtualBox will provide a different
15344	virtual storage controller hardware to the guest.
15345	For SATA, SAS and floppy controllers, only one variant is
15346	available, but for IDE and SCSI, there are several.
15347
15348	For SCSI controllers, the default type is LsiLogic.
15349	</desc>
15350	</attribute>
15351
15352	<attribute name="useHostIOCache" type="boolean">
15353	<desc>
15354	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15355	caches and use synchronous file APIs on the host. This was the only option in the API before
15356	VirtualBox 3.2 and is still the default for IDE controllers.
15357
15358	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15359	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15360	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15361	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15362	virtual machines are running at the same time to prevent I/O cache related hangs.
15363	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15364	</desc>
15365	</attribute>
15366
15367	<attribute name="bootable" type="boolean" readonly="yes">
15368	<desc>
15369	Returns whether it is possible to boot from disks attached to this controller.
15370	</desc>
15371	</attribute>
15372
15373	<method name="getIDEEmulationPort">
15374	<desc>
15375	Gets the corresponding port number which is emulated as an IDE device.
15376	Works only with SATA controllers.
15377
15378	<result name="E_INVALIDARG">
15379	The @a devicePosition is not in the range 0 to 3.
15380	</result>
15381	<result name="E_NOTIMPL">
15382	The storage controller type is not SATAIntelAhci.
15383	</result>
15384
15385	</desc>
15386	<param name="devicePosition" type="long" dir="in"/>
15387	<param name="portNumber" type="long" dir="return"/>
15388	</method>
15389
15390	<method name="setIDEEmulationPort">
15391	<desc>
15392	Sets the port number which is emulated as an IDE device.
15393	Works only with SATA controllers.
15394
15395	<result name="E_INVALIDARG">
15396	The @a devicePosition is not in the range 0 to 3 or the
15397	@a portNumber is not in the range 0 to 29.
15398	</result>
15399	<result name="E_NOTIMPL">
15400	The storage controller type is not SATAIntelAhci.
15401	</result>
15402
15403	</desc>
15404	<param name="devicePosition" type="long" dir="in"/>
15405	<param name="portNumber" type="long" dir="in"/>
15406	</method>
15407
15408	</interface>
15409
15410	<if target="wsdl">
15411
15412	<!--
15413	// IManagedObjectRef
15414	/////////////////////////////////////////////////////////////////////////
15415	-->
15416
15417	<interface
15418	name="IManagedObjectRef" extends="$unknown"
15419	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15420	internal="yes"
15421	wsmap="managed"
15422	wscpp="hardcoded"
15423	>
15424	<desc>
15425	Managed object reference.
15426
15427	Only within the webservice, a managed object reference (which is really
15428	an opaque number) allows a webservice client to address an object
15429	that lives in the address space of the webservice server.
15430
15431	Behind each managed object reference, there is a COM object that lives
15432	in the webservice server's address space. The COM object is not freed
15433	until the managed object reference is released, either by an explicit
15434	call to <link to="IManagedObjectRef::release" /> or by logging off from
15435	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15436	all objects created during the webservice session.
15437
15438	Whenever a method call of the VirtualBox API returns a COM object, the
15439	webservice representation of that method will instead return a
15440	managed object reference, which can then be used to invoke methods
15441	on that object.
15442	</desc>
15443
15444	<method name="getInterfaceName">
15445	<desc>
15446	Returns the name of the interface that this managed object represents,
15447	for example, "IMachine", as a string.
15448	</desc>
15449	<param name="return" type="wstring" dir="return"/>
15450	</method>
15451
15452	<method name="release">
15453	<desc>
15454	Releases this managed object reference and frees the resources that
15455	were allocated for it in the webservice server process. After calling
15456	this method, the identifier of the reference can no longer be used.
15457	</desc>
15458	</method>
15459
15460	</interface>
15461
15462	<!--
15463	// IWebsessionManager
15464	/////////////////////////////////////////////////////////////////////////
15465	-->
15466
15467	<interface
15468	name="IWebsessionManager" extends="$unknown"
15469	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15470	internal="yes"
15471	wsmap="global"
15472	wscpp="hardcoded"
15473	>
15474	<desc>
15475	Websession manager. This provides essential services
15476	to webservice clients.
15477	</desc>
15478	<method name="logon">
15479	<desc>
15480	Logs a new client onto the webservice and returns a managed object reference to
15481	the IVirtualBox instance, which the client can then use as a basis to further
15482	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15483	interface, in one way or the other.
15484	</desc>
15485	<param name="username" type="wstring" dir="in"/>
15486	<param name="password" type="wstring" dir="in"/>
15487	<param name="return" type="IVirtualBox" dir="return"/>
15488	</method>
15489
15490	<method name="getSessionObject">
15491	<desc>
15492	Returns a managed object reference to the internal ISession object that was created
15493	for this web service session when the client logged on.
15494
15495	<see><link to="ISession"/></see>
15496	</desc>
15497	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15498	<param name="return" type="ISession" dir="return"/>
15499	</method>
15500
15501	<method name="logoff">
15502	<desc>
15503	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
15504	and destroys all resources associated with the session (most importantly, all
15505	managed objects created in the server while the session was active).
15506	</desc>
15507	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15508	</method>
15509
15510	</interface>
15511
15512	</if>
15513
15514	<!--
15515	// IPerformanceCollector & friends
15516	/////////////////////////////////////////////////////////////////////////
15517	-->
15518
15519	<interface
15520	name="IPerformanceMetric" extends="$unknown"
15521	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15522	>
15523	<desc>
15524	The IPerformanceMetric interface represents parameters of the given
15525	performance metric.
15526	</desc>
15527
15528	<attribute name="metricName" type="wstring" readonly="yes">
15529	<desc>
15530	Name of the metric.
15531	</desc>
15532	</attribute>
15533
15534	<attribute name="object" type="$unknown" readonly="yes">
15535	<desc>
15536	Object this metric belongs to.
15537	</desc>
15538	</attribute>
15539
15540	<attribute name="description" type="wstring" readonly="yes">
15541	<desc>
15542	Textual description of the metric.
15543	</desc>
15544	</attribute>
15545
15546	<attribute name="period" type="unsigned long" readonly="yes">
15547	<desc>
15548	Time interval between samples, measured in seconds.
15549	</desc>
15550	</attribute>
15551
15552	<attribute name="count" type="unsigned long" readonly="yes">
15553	<desc>
15554	Number of recent samples retained by the performance collector for this
15555	metric.
15556
15557	When the collected sample count exceeds this number, older samples
15558	are discarded.
15559	</desc>
15560	</attribute>
15561
15562	<attribute name="unit" type="wstring" readonly="yes">
15563	<desc>
15564	Unit of measurement.
15565	</desc>
15566	</attribute>
15567
15568	<attribute name="minimumValue" type="long" readonly="yes">
15569	<desc>
15570	Minimum possible value of this metric.
15571	</desc>
15572	</attribute>
15573
15574	<attribute name="maximumValue" type="long" readonly="yes">
15575	<desc>
15576	Maximum possible value of this metric.
15577	</desc>
15578	</attribute>
15579	</interface>
15580
15581	<interface
15582	name="IPerformanceCollector" extends="$unknown"
15583	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15584	wsmap="managed"
15585	>
15586	<desc>
15587	The IPerformanceCollector interface represents a service that collects
15588	and stores performance metrics data.
15589
15590	Performance metrics are associated with objects of interfaces like IHost
15591	and IMachine. Each object has a distinct set of performance metrics. The
15592	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15593
15594	Metric data is collected at the specified intervals and is retained
15595	internally. The interval and the number of retained samples can be set
15596	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15597	and collection settings are not persistent, they are discarded as soon as
15598	VBoxSVC process terminates. Moreover, metric settings and data associated
15599	with a particular VM only exist while VM is running. They disappear as
15600	soon as VM shuts down. It is not possible to set up metrics for machines
15601	that are powered off. One needs to start VM first, then set up metric
15602	collection parameters.
15603
15604	Metrics are organized hierarchically, with each level separated by a
15605	slash (/) character. Generally, the scheme for metric names is like this:
15606
15607	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15608
15609	"Category/Metric" together form the base metric name. A base metric is
15610	the smallest unit for which a sampling interval and the number of
15611	retained samples can be set. Only base metrics can be enabled and
15612	disabled. All sub-metrics are collected when their base metric is
15613	collected. Collected values for any set of sub-metrics can be queried
15614	with <link to="IPerformanceCollector::queryMetricsData" />.
15615
15616	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15617	category, "Load" metric, "User" submetric, "average" aggregate. An
15618	aggregate function is computed over all retained data. Valid aggregate
15619	functions are:
15620
15621	<ul>
15622	<li>avg -- average</li>
15623	<li>min -- minimum</li>
15624	<li>max -- maximum</li>
15625	</ul>
15626
15627	When setting up metric parameters, querying metric data, enabling or
15628	disabling metrics wildcards can be used in metric names to specify a
15629	subset of metrics. For example, to select all CPU-related metrics
15630	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15631	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15632
15633	The valid names for base metrics are:
15634
15635	<ul>
15636	<li>CPU/Load</li>
15637	<li>CPU/MHz</li>
15638	<li>RAM/Usage</li>
15639	<li>RAM/VMM</li>
15640	</ul>
15641
15642	The general sequence for collecting and retrieving the metrics is:
15643	<ul>
15644	<li>
15645	Obtain an instance of IPerformanceCollector with
15646	<link to="IVirtualBox::performanceCollector" />
15647	</li>
15648	<li>
15649	Allocate and populate an array with references to objects the metrics
15650	will be collected for. Use references to IHost and IMachine objects.
15651	</li>
15652	<li>
15653	Allocate and populate an array with base metric names the data will
15654	be collected for.
15655	</li>
15656	<li>
15657	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15658	the metric data will be collected and stored.
15659	</li>
15660	<li>
15661	Wait for the data to get collected.
15662	</li>
15663	<li>
15664	Allocate and populate an array with references to objects the metric
15665	values will be queried for. You can re-use the object array used for
15666	setting base metrics.
15667	</li>
15668	<li>
15669	Allocate and populate an array with metric names the data will be
15670	collected for. Note that metric names differ from base metric names.
15671	</li>
15672	<li>
15673	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15674	that have been collected so far are returned. Note that the values
15675	are still retained internally and data collection continues.
15676	</li>
15677	</ul>
15678
15679	For an example of usage refer to the following files in VirtualBox SDK:
15680	<ul>
15681	<li>
15682	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15683	</li>
15684	<li>
15685	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15686	</li>
15687	</ul>
15688	</desc>
15689
15690	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15691	<desc>
15692	Array of unique names of metrics.
15693
15694	This array represents all metrics supported by the performance
15695	collector. Individual objects do not necessarily support all of them.
15696	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15697	list of supported metrics for a particular object.
15698	</desc>
15699	</attribute>
15700
15701	<method name="getMetrics">
15702	<desc>
15703	Returns parameters of specified metrics for a set of objects.
15704	<note>
15705	@c Null metrics array means all metrics. @c Null object array means
15706	all existing objects.
15707	</note>
15708	</desc>
15709	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15710	<desc>
15711	Metric name filter. Currently, only a comma-separated list of metrics
15712	is supported.
15713	</desc>
15714	</param>
15715	<param name="objects" type="$unknown" dir="in" safearray="yes">
15716	<desc>
15717	Set of objects to return metric parameters for.
15718	</desc>
15719	</param>
15720	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15721	<desc>
15722	Array of returned metric parameters.
15723	</desc>
15724	</param>
15725	</method>
15726
15727	<method name="setupMetrics">
15728	<desc>
15729	Sets parameters of specified base metrics for a set of objects. Returns
15730	an array of <link to="IPerformanceMetric" /> describing the metrics
15731	have been affected.
15732	<note>
15733	@c Null or empty metric name array means all metrics. @c Null or
15734	empty object array means all existing objects. If metric name array
15735	contains a single element and object array contains many, the single
15736	metric name array element is applied to each object array element to
15737	form metric/object pairs.
15738	</note>
15739	</desc>
15740	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15741	<desc>
15742	Metric name filter. Comma-separated list of metrics with wildcard
15743	support.
15744	</desc>
15745	</param>
15746	<param name="objects" type="$unknown" dir="in" safearray="yes">
15747	<desc>
15748	Set of objects to setup metric parameters for.
15749	</desc>
15750	</param>
15751	<param name="period" type="unsigned long" dir="in">
15752	<desc>
15753	Time interval in seconds between two consecutive samples of
15754	performance data.
15755	</desc>
15756	</param>
15757	<param name="count" type="unsigned long" dir="in">
15758	<desc>
15759	Number of samples to retain in performance data history. Older
15760	samples get discarded.
15761	</desc>
15762	</param>
15763	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15764	<desc>
15765	Array of metrics that have been modified by the call to this method.
15766	</desc>
15767	</param>
15768	</method>
15769
15770	<method name="enableMetrics">
15771	<desc>
15772	Turns on collecting specified base metrics. Returns an array of
15773	<link to="IPerformanceMetric" /> describing the metrics have been
15774	affected.
15775	<note>
15776	@c Null or empty metric name array means all metrics. @c Null or
15777	empty object array means all existing objects. If metric name array
15778	contains a single element and object array contains many, the single
15779	metric name array element is applied to each object array element to
15780	form metric/object pairs.
15781	</note>
15782	</desc>
15783	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15784	<desc>
15785	Metric name filter. Comma-separated list of metrics with wildcard
15786	support.
15787	</desc>
15788	</param>
15789	<param name="objects" type="$unknown" dir="in" safearray="yes">
15790	<desc>
15791	Set of objects to enable metrics for.
15792	</desc>
15793	</param>
15794	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15795	<desc>
15796	Array of metrics that have been modified by the call to this method.
15797	</desc>
15798	</param>
15799	</method>
15800
15801	<method name="disableMetrics">
15802	<desc>
15803	Turns off collecting specified base metrics. Returns an array of
15804	<link to="IPerformanceMetric" /> describing the metrics have been
15805	affected.
15806	<note>
15807	@c Null or empty metric name array means all metrics. @c Null or
15808	empty object array means all existing objects. If metric name array
15809	contains a single element and object array contains many, the single
15810	metric name array element is applied to each object array element to
15811	form metric/object pairs.
15812	</note>
15813	</desc>
15814	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15815	<desc>
15816	Metric name filter. Comma-separated list of metrics with wildcard
15817	support.
15818	</desc>
15819	</param>
15820	<param name="objects" type="$unknown" dir="in" safearray="yes">
15821	<desc>
15822	Set of objects to disable metrics for.
15823	</desc>
15824	</param>
15825	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15826	<desc>
15827	Array of metrics that have been modified by the call to this method.
15828	</desc>
15829	</param>
15830	</method>
15831
15832	<method name="queryMetricsData">
15833	<desc>
15834	Queries collected metrics data for a set of objects.
15835
15836	The data itself and related metric information are returned in seven
15837	parallel and one flattened array of arrays. Elements of
15838	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15839	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15840	the same index describe one set of values corresponding to a single
15841	metric.
15842
15843	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15844	start and length of a sub-array is indicated by
15845	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15846	value for metric <tt>metricNames[i]</tt> is at
15847	<tt>returnData[returnIndices[i]]</tt>.
15848
15849	<note>
15850	@c Null or empty metric name array means all metrics. @c Null or
15851	empty object array means all existing objects. If metric name array
15852	contains a single element and object array contains many, the single
15853	metric name array element is applied to each object array element to
15854	form metric/object pairs.
15855	</note>
15856	<note>
15857	Data collection continues behind the scenes after call to @c
15858	queryMetricsData. The return data can be seen as the snapshot of the
15859	current state at the time of @c queryMetricsData call. The internally
15860	kept metric values are not cleared by the call. This makes possible
15861	querying different subsets of metrics or aggregates with subsequent
15862	calls. If periodic querying is needed it is highly suggested to query
15863	the values with @c interval*count period to avoid confusion. This way
15864	a completely new set of data values will be provided by each query.
15865	</note>
15866	</desc>
15867	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15868	<desc>
15869	Metric name filter. Comma-separated list of metrics with wildcard
15870	support.
15871	</desc>
15872	</param>
15873	<param name="objects" type="$unknown" dir="in" safearray="yes">
15874	<desc>
15875	Set of objects to query metrics for.
15876	</desc>
15877	</param>
15878	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15879	<desc>
15880	Names of metrics returned in @c returnData.
15881	</desc>
15882	</param>
15883	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15884	<desc>
15885	Objects associated with metrics returned in @c returnData.
15886	</desc>
15887	</param>
15888	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15889	<desc>
15890	Units of measurement for each returned metric.
15891	</desc>
15892	</param>
15893	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15894	<desc>
15895	Divisor that should be applied to return values in order to get
15896	floating point values. For example:
15897	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15898	will retrieve the floating point value of i-th sample of the first
15899	metric.
15900	</desc>
15901	</param>
15902	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15903	<desc>
15904	Sequence numbers of the first elements of value sequences of
15905	particular metrics returned in @c returnData. For aggregate metrics
15906	it is the sequence number of the sample the aggregate started
15907	calculation from.
15908	</desc>
15909	</param>
15910	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15911	<desc>
15912	Indices of the first elements of value sequences of particular
15913	metrics returned in @c returnData.
15914	</desc>
15915	</param>
15916	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15917	<desc>
15918	Lengths of value sequences of particular metrics.
15919	</desc>
15920	</param>
15921	<param name="returnData" type="long" dir="return" safearray="yes">
15922	<desc>
15923	Flattened array of all metric data containing sequences of values for
15924	each metric.
15925	</desc>
15926	</param>
15927	</method>
15928
15929	</interface>
15930
15931	<enum
15932	name="NATAliasMode"
15933	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
15934	>
15935	<desc></desc>
15936	<const name="AliasLog" value="0x1">
15937	<desc></desc>
15938	</const>
15939	<const name="AliasProxyOnly" value="0x02">
15940	<desc></desc>
15941	</const>
15942	<const name="AliasUseSamePorts" value="0x04">
15943	<desc></desc>
15944	</const>
15945	</enum>
15946
15947	<enum
15948	name="NATProtocol"
15949	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
15950	>
15951	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
15952	<const name="UDP" value="0">
15953	<desc>Port-forwarding uses UDP protocol.</desc>
15954	</const>
15955	<const name="TCP" value="1">
15956	<desc>Port-forwarding uses TCP protocol.</desc>
15957	</const>
15958	</enum>
15959
15960	<interface
15961	name="INATEngine" extends="$unknown"
15962	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
15963	wsmap="managed"
15964	>
15965	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
15966	allows for changing NAT behavior such as port-forwarding rules. This interface is
15967	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
15968	<attribute name="network" type="wstring">
15969	<desc>The network attribute of the NAT engine (the same value is used with built-in
15970	DHCP server to fill corresponding fields of DHCP leases).</desc>
15971	</attribute>
15972	<attribute name="hostIP" type="wstring">
15973	<desc>IP of host interface to bind all opened sockets to.
15974	<note>Changing this does not change binding of port forwarding.</note>
15975	</desc>
15976	</attribute>
15977	<attribute name="tftpPrefix" type="wstring">
15978	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
15979	the corresponding fields of DHCP leases.</desc>
15980	</attribute>
15981	<attribute name="tftpBootFile" type="wstring">
15982	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
15983	the corresponding fields of DHCP leases.</desc>
15984	</attribute>
15985	<attribute name="tftpNextServer" type="wstring">
15986	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
15987	the corresponding fields of DHCP leases.
15988	<note>The preferred form is IPv4 addresses.</note>
15989	</desc>
15990	</attribute>
15991	<attribute name="aliasMode" type="unsigned long">
15992	<desc></desc>
15993	</attribute>
15994	<attribute name="dnsPassDomain" type="boolean">
15995	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
15996	</attribute>
15997	<attribute name="dnsProxy" type="boolean">
15998	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15999	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
16000	</attribute>
16001	<attribute name="dnsUseHostResolver" type="boolean">
16002	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16003	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
16004	</attribute>
16005	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
16006	<desc>Array of NAT port-forwarding rules in string representation, in the following
16007	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
16008	</attribute>
16009	<method name="setNetworkSettings">
16010	<desc>Sets network configuration of the NAT engine.</desc>
16011	<param name="mtu" type="unsigned long" dir="in">
16012	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
16013	</param>
16014	<param name="sockSnd" type="unsigned long" dir="in">
16015	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
16016	</param>
16017	<param name="sockRcv" type="unsigned long" dir="in">
16018	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
16019	</param>
16020	<param name="TcpWndSnd" type="unsigned long" dir="in">
16021	<desc>Initial size of the NAT engine's sending TCP window in bytes when
16022	establishing a new TCP connection.</desc>
16023	</param>
16024	<param name="TcpWndRcv" type="unsigned long" dir="in">
16025	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
16026	establishing a new TCP connection.</desc>
16027	</param>
16028	</method>
16029	<method name="getNetworkSettings">
16030	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
16031	for parameter descriptions.</desc>
16032	<param name="mtu" type="unsigned long" dir="out" />
16033	<param name="sockSnd" type="unsigned long" dir="out" />
16034	<param name="sockRcv" type="unsigned long" dir="out" />
16035	<param name="TcpWndSnd" type="unsigned long" dir="out" />
16036	<param name="TcpWndRcv" type="unsigned long" dir="out" />
16037	</method>
16038	<method name="addRedirect">
16039	<desc>Adds a new NAT port-forwarding rule.</desc>
16040	<param name="name" type="wstring" dir="in">
16041	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
16042	auto-generates one using the other parameters.</desc>
16043	</param>
16044	<param name="proto" type="NATProtocol" dir="in">
16045	<desc>Protocol handled with the rule.</desc>
16046	</param>
16047	<param name="hostIp" type="wstring" dir="in">
16048	<desc>IP of the host interface to which the rule should apply. An empty ip address is
16049	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
16050	</param>
16051	<param name="hostPort" type="unsigned short" dir="in">
16052	<desc>The port number to listen on.</desc>
16053	</param>
16054	<param name="guestIp" type="wstring" dir="in">
16055	<desc>The IP address of the guest which the NAT engine will forward matching packets
16056	to. An empty IP address is acceptable, in which case the NAT engine will forward
16057	packets to the first DHCP lease (x.x.x.15).</desc>
16058	</param>
16059	<param name="guestPort" type="unsigned short" dir="in">
16060	<desc>The port number to forward.</desc>
16061	</param>
16062	</method>
16063	<method name="removeRedirect">
16064	<desc>Removes a port-forwarding rule that was previously registered.</desc>
16065	<param name="name" type="wstring" dir="in">
16066	<desc>The name of the rule to delete.</desc>
16067	</param>
16068	</method>
16069	</interface>
16070
16071	<!--
16072	// IExtPackManager
16073	/////////////////////////////////////////////////////////////////////////
16074	-->
16075
16076	<interface
16077	name="IExtPackPlugIn" extends="$unknown"
16078	uuid="58000040-e718-4746-bbce-4b86d96da461"
16079	wsmap="suppress"
16080	>
16081	<desc>
16082	Interface for keeping information about a plug-in that ships with an
16083	extension pack.
16084	</desc>
16085	<attribute name="name" type="wstring" readonly="yes">
16086	<desc>The plug-in name.</desc>
16087	</attribute>
16088	<attribute name="description" type="wstring" readonly="yes">
16089	<desc>The plug-in description.</desc>
16090	</attribute>
16091	<attribute name="frontend" type="wstring" readonly="yes">
16092	<desc>
16093	The name of the frontend or component name this plug-in plugs into.
16094	</desc>
16095	</attribute>
16096	<attribute name="modulePath" type="wstring" readonly="yes">
16097	<desc> The module path. </desc>
16098	</attribute>
16099	</interface>
16100
16101	<interface
16102	name="IExtPackBase" extends="$unknown"
16103	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16104	wsmap="suppress"
16105	>
16106	<desc>
16107	Interface for querying information about an extension pack as well as
16108	accessing COM objects within it.
16109	</desc>
16110	<attribute name="name" type="wstring" readonly="yes">
16111	<desc>The extension pack name. This is unique.</desc>
16112	</attribute>
16113	<attribute name="description" type="wstring" readonly="yes">
16114	<desc>The extension pack description.</desc>
16115	</attribute>
16116	<attribute name="version" type="wstring" readonly="yes">
16117	<desc>
16118	The extension pack version string. This is restricted to the dotted
16119	version number and optionally a build indicator. No tree revision or
16120	tag will be included in the string as those things are available as
16121	separate properties. An optional publisher tag may be present like for
16122	<link to="IVirtualBox::version"/>.
16123
16124	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16125	</desc>
16126	</attribute>
16127	<attribute name="revision" type="unsigned long" readonly="yes">
16128	<desc>The extension pack internal revision number.</desc>
16129	</attribute>
16130	<attribute name="edition" type="wstring" readonly="yes">
16131	<desc>
16132	Edition indicator. This is usually empty.
16133
16134	Can for instance be used to help distinguishing between two editions
16135	of the same extension pack where only the license, service contract or
16136	something differs.
16137	</desc>
16138	</attribute>
16139	<attribute name="VRDEModule" type="wstring" readonly="yes">
16140	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16141	</attribute>
16142	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16143	<desc>Plug-ins provided by this extension pack.</desc>
16144	</attribute>
16145	<attribute name="usable" type="boolean" readonly="yes">
16146	<desc>
16147	Indicates whether the extension pack is usable or not.
16148
16149	There are a number of reasons why an extension pack might be unusable,
16150	typical examples would be broken installation/file or that it is
16151	incompatible with the current VirtualBox version.
16152	</desc>
16153	</attribute>
16154	<attribute name="whyUnusable" type="wstring" readonly="yes">
16155	<desc>
16156	String indicating why the extension pack is not usable. This is an
16157	empty string if usable and always a non-empty string if not usable.
16158	</desc>
16159	</attribute>
16160	<attribute name="showLicense" type="boolean" readonly="yes">
16161	<desc>Whether to show the license before installation</desc>
16162	</attribute>
16163	<attribute name="license" type="wstring" readonly="yes">
16164	<desc>
16165	The default HTML license text for the extension pack. Same as
16166	calling <link to="#queryLicense">queryLicense</link> with
16167	preferredLocale and preferredLanguage as empty strings and format set
16168	to html.
16169	</desc>
16170	</attribute>
16171
16172	<method name="queryLicense">
16173	<desc>
16174	Full feature version of the license attribute.
16175	</desc>
16176	<param name="preferredLocale" type="wstring" dir="in">
16177	<desc>
16178	The preferred license locale. Pass an empty string to get the default
16179	license.
16180	</desc>
16181	</param>
16182	<param name="preferredLanguage" type="wstring" dir="in">
16183	<desc>
16184	The preferred license language. Pass an empty string to get the
16185	default language for the locale.
16186	</desc>
16187	</param>
16188	<param name="format" type="wstring" dir="in">
16189	<desc>
16190	The license format: html, rtf or txt. If a license is present there
16191	will always be an HTML of it, the rich text format (RTF) and plain
16192	text (txt) versions are optional. If
16193	</desc>
16194	</param>
16195	<param name="licenseText" type="wstring" dir="return">
16196	<desc>The license text.</desc>
16197	</param>
16198	</method>
16199
16200	</interface>
16201
16202	<interface
16203	name="IExtPack" extends="IExtPackBase"
16204	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16205	wsmap="suppress"
16206	>
16207	<desc>
16208	Interface for querying information about an extension pack as well as
16209	accessing COM objects within it.
16210	</desc>
16211	<method name="queryObject">
16212	<desc>
16213	Queries the IUnknown interface to an object in the extension pack
16214	main module. This allows plug-ins and others to talk directly to an
16215	extension pack.
16216	</desc>
16217	<param name="objUuid" type="wstring" dir="in">
16218	<desc>The object ID. What exactly this is </desc>
16219	</param>
16220	<param name="returnInterface" type="$unknown" dir="return">
16221	<desc>The queried interface.</desc>
16222	</param>
16223	</method>
16224	</interface>
16225
16226	<interface
16227	name="IExtPackFile" extends="IExtPackBase"
16228	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16229	wsmap="suppress"
16230	>
16231	<desc>
16232	Extension pack file (aka tarball, .vbox-extpack) representation returned
16233	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16234	extension pack information with the addition of the file name.
16235	</desc>
16236	<attribute name="filePath" type="wstring" readonly="yes">
16237	<desc>
16238	The path to the extension pack file.
16239	</desc>
16240	</attribute>
16241
16242	<method name="install">
16243	<desc>
16244	Install the extension pack.
16245	</desc>
16246	<param name="replace" type="boolean" dir="in">
16247	<desc>
16248	Set this to automatically uninstall any existing extension pack with
16249	the same name as the one being installed.
16250	</desc>
16251	</param>
16252	<param name="displayInfo" type="wstring" dir="in">
16253	<desc>
16254	Platform specific display information. Reserved for future hacks.
16255	</desc>
16256	</param>
16257	<param name="progess" type="IProgress" dir="return">
16258	<desc>
16259	Progress object for the operation.
16260	</desc>
16261	</param>
16262	</method>
16263	</interface>
16264
16265	<interface
16266	name="IExtPackManager" extends="$unknown"
16267	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16268	wsmap="suppress"
16269	>
16270	<desc>
16271	Interface for managing VirtualBox Extension Packs.
16272
16273	TODO: Describe extension packs, how they are managed and how to create
16274	one.
16275	</desc>
16276
16277	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16278	<desc>
16279	List of the installed extension packs.
16280	</desc>
16281	</attribute>
16282
16283	<method name="find">
16284	<desc>
16285	Returns the extension pack with the specified name if found.
16286
16287	<result name="VBOX_E_OBJECT_NOT_FOUND">
16288	No extension pack matching @a name was found.
16289	</result>
16290	</desc>
16291	<param name="name" type="wstring" dir="in">
16292	<desc>The name of the extension pack to locate.</desc>
16293	</param>
16294	<param name="returnData" type="IExtPack" dir="return">
16295	<desc>The extension pack if found.</desc>
16296	</param>
16297	</method>
16298
16299	<method name="openExtPackFile">
16300	<desc>
16301	Attempts to open an extension pack file in preparation for
16302	installation.
16303	</desc>
16304	<param name="path" type="wstring" dir="in">
16305	<desc>The path of the extension pack tarball. This can optionally be
16306	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
16307	</param>
16308	<param name="file" type="IExtPackFile" dir="return">
16309	<desc>The interface of the extension pack file object.</desc>
16310	</param>
16311	</method>
16312
16313	<method name="uninstall">
16314	<desc>Uninstalls an extension pack, removing all related files.</desc>
16315	<param name="name" type="wstring" dir="in">
16316	<desc>The name of the extension pack to uninstall.</desc>
16317	</param>
16318	<param name="forcedRemoval" type="boolean" dir="in">
16319	<desc>
16320	Forced removal of the extension pack. This means that the uninstall
16321	hook will not be called.
16322	</desc>
16323	</param>
16324	<param name="displayInfo" type="wstring" dir="in">
16325	<desc>
16326	Platform specific display information. Reserved for future hacks.
16327	</desc>
16328	</param>
16329	<param name="progess" type="IProgress" dir="return">
16330	<desc>
16331	Progress object for the operation.
16332	</desc>
16333	</param>
16334	</method>
16335
16336	<method name="cleanup">
16337	<desc>Cleans up failed installs and uninstalls</desc>
16338	</method>
16339
16340	<method name="queryAllPlugInsForFrontend">
16341	<desc>
16342	Gets the path to all the plug-in modules for a given frontend.
16343
16344	This is a convenience method that is intended to simplify the plug-in
16345	loading process for a frontend.
16346	</desc>
16347	<param name="frontendName" type="wstring" dir="in">
16348	<desc>The name of the frontend or component.</desc>
16349	</param>
16350	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16351	<desc>Array containing the plug-in modules (full paths).</desc>
16352	</param>
16353	</method>
16354
16355	<method name="isExtPackUsable">
16356	<desc>Check if the given extension pack is loaded and usable.</desc>
16357	<param name="name" type="wstring" dir="in">
16358	<desc>The name of the extension pack to check for.</desc>
16359	</param>
16360	<param name="usable" type="boolean" dir="return">
16361	<desc>Is the given extension pack loaded and usable.</desc>
16362	</param>
16363	</method>
16364
16365	</interface>
16366
16367	<!--
16368	// BandwidthGroupType
16369	/////////////////////////////////////////////////////////////////////////
16370	-->
16371	<enum
16372	name="BandwidthGroupType"
16373	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16374
16375	<desc>
16376	Type of a bandwidth control group.
16377	</desc>
16378
16379	<const name="Null" value="0">
16380	<desc>
16381	Null type, must be first.
16382	</desc>
16383	</const>
16384
16385	<const name="Disk" value="1">
16386	<desc>
16387	The bandwidth group controls disk I/O.
16388	</desc>
16389	</const>
16390
16391	<const name="Network" value="2">
16392	<desc>
16393	The bandwidth group controls network I/O.
16394	</desc>
16395	</const>
16396
16397	</enum>
16398
16399	<!--
16400	// IBandwidthGroup
16401	/////////////////////////////////////////////////////////////////////////
16402	-->
16403	<interface
16404	name="IBandwidthGroup" extends="$unknown"
16405	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16406	wsmap="managed"
16407	>
16408	<desc>Represents one bandwidth group.</desc>
16409
16410	<attribute name="name" type="wstring" readonly="yes">
16411	<desc>Name of the group.</desc>
16412	</attribute>
16413
16414	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16415	<desc>Type of the group.</desc>
16416	</attribute>
16417
16418	<attribute name="reference" type="unsigned long" readonly="yes">
16419	<desc>How many devices/medium attachements use this group.</desc>
16420	</attribute>
16421
16422	<attribute name="maxMbPerSec" type="unsigned long">
16423	<desc>The maximum number of MBytes which can be transfered by all
16424	entities attached to this group during one second.</desc>
16425	</attribute>
16426
16427	</interface>
16428
16429	<!--
16430	// IBandwidthControl
16431	/////////////////////////////////////////////////////////////////////////
16432	-->
16433	<interface
16434	name="IBandwidthControl" extends="$unknown"
16435	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16436	wsmap="managed"
16437	>
16438	<desc>
16439	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16440	This includes network and disk I/O.
16441	</desc>
16442
16443	<attribute name="numGroups" type="unsigned long" readonly="yes">
16444	<desc>
16445	The current number of existing bandwidth groups managed.
16446	</desc>
16447	</attribute>
16448
16449	<method name="createBandwidthGroup">
16450	<desc>
16451	Creates a new bandwidth group.
16452	</desc>
16453
16454	<param name="name" type="wstring" dir="in">
16455	<desc>Name of the bandwidth group.</desc>
16456	</param>
16457	<param name="type" type="BandwidthGroupType" dir="in">
16458	<desc>The type of the bandwidth group (network or disk).</desc>
16459	</param>
16460	<param name="maxMbPerSec" type="unsigned long" dir="in">
16461	<desc>The maximum number of MBytes which can be transfered by all
16462	entities attached to this group during one second.</desc>
16463	</param>
16464	</method>
16465
16466	<method name="deleteBandwidthGroup">
16467	<desc>
16468	Deletes a new bandwidth group.
16469	</desc>
16470
16471	<param name="name" type="wstring" dir="in">
16472	<desc>Name of the bandwidth group to delete.</desc>
16473	</param>
16474	</method>
16475
16476	<method name="getBandwidthGroup" const="yes">
16477	<desc>
16478	Get a bandwidth group by name.
16479	</desc>
16480
16481	<param name="name" type="wstring" dir="in">
16482	<desc>Name of the bandwidth group to get.</desc>
16483	</param>
16484	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16485	<desc>Where to store the bandwidth group on success.</desc>
16486	</param>
16487	</method>
16488
16489	<method name="getAllBandwidthGroups" const="yes">
16490	<desc>
16491	Get all managed bandwidth groups.
16492	</desc>
16493
16494	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16495	<desc>The array of managed bandwidth groups.</desc>
16496	</param>
16497	</method>
16498	</interface>
16499
16500	<!--
16501	// IVirtualBoxClient
16502	/////////////////////////////////////////////////////////////////////////
16503	-->
16504
16505	<interface
16506	name="IVirtualBoxClient" extends="$unknown"
16507	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16508	wsmap="suppress"
16509	>
16510	<desc>
16511	Convenience interface for client applications. Treat this as a
16512	singleton, i.e. never create more than one instance of this interface.
16513
16514	At the moment only available for clients of the local API (not usable
16515	via the webservice). Once the session logic is redesigned this might
16516	change.
16517	</desc>
16518
16519	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16520	<desc>
16521	Reference to the server-side API root object.
16522	</desc>
16523	</attribute>
16524
16525	<attribute name="session" type="ISession" readonly="yes">
16526	<desc>
16527	Create a new session object and return the reference to it.
16528	</desc>
16529	</attribute>
16530
16531	<attribute name="eventSource" type="IEventSource" readonly="yes">
16532	<desc>
16533	Event source for VirtualBoxClient events.
16534	</desc>
16535	</attribute>
16536
16537	</interface>
16538
16539	<!--
16540	// Events
16541	/////////////////////////////////////////////////////////////////////////
16542	-->
16543	<enum
16544	name="VBoxEventType"
16545	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
16546	>
16547
16548	<desc>
16549	Type of an event.
16550	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16551	</desc>
16552
16553	<const name="Invalid" value="0">
16554	<desc>
16555	Invalid event, must be first.
16556	</desc>
16557	</const>
16558
16559	<const name="Any" value="1">
16560	<desc>
16561	Wildcard for all events.
16562	Events of this type are never delivered, and only used in
16563	<link to="IEventSource::registerListener"/> call to simplify registration.
16564	</desc>
16565	</const>
16566
16567	<const name="Vetoable" value="2">
16568	<desc>
16569	Wildcard for all vetoable events. Events of this type are never delivered, and only
16570	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16571	</desc>
16572	</const>
16573
16574	<const name="MachineEvent" value="3">
16575	<desc>
16576	Wildcard for all machine events. Events of this type are never delivered, and only used in
16577	<link to="IEventSource::registerListener"/> call to simplify registration.
16578	</desc>
16579	</const>
16580
16581	<const name="SnapshotEvent" value="4">
16582	<desc>
16583	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16584	<link to="IEventSource::registerListener"/> call to simplify registration.
16585	</desc>
16586	</const>
16587
16588	<const name="InputEvent" value="5">
16589	<desc>
16590	Wildcard for all input device (keyboard, mouse) events.
16591	Events of this type are never delivered, and only used in
16592	<link to="IEventSource::registerListener"/> call to simplify registration.
16593	</desc>
16594	</const>
16595
16596	<const name="LastWildcard" value="31">
16597	<desc>
16598	Last wildcard.
16599	</desc>
16600	</const>
16601
16602	<const name="OnMachineStateChanged" value="32">
16603	<desc>
16604	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16605	</desc>
16606	</const>
16607	<const name="OnMachineDataChanged" value="33">
16608	<desc>
16609	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16610	</desc>
16611	</const>
16612	<const name="OnExtraDataChanged" value="34">
16613	<desc>
16614	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16615	</desc>
16616	</const>
16617	<const name="OnExtraDataCanChange" value="35">
16618	<desc>
16619	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16620	</desc>
16621	</const>
16622	<const name="OnMediumRegistered" value="36">
16623	<desc>
16624	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16625	</desc>
16626	</const>
16627	<const name="OnMachineRegistered" value="37">
16628	<desc>
16629	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16630	</desc>
16631	</const>
16632	<const name="OnSessionStateChanged" value="38">
16633	<desc>
16634	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16635	</desc>
16636	</const>
16637	<const name="OnSnapshotTaken" value="39">
16638	<desc>
16639	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16640	</desc>
16641	</const>
16642	<const name="OnSnapshotDeleted" value="40">
16643	<desc>
16644	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16645	</desc>
16646	</const>
16647	<const name="OnSnapshotChanged" value="41">
16648	<desc>
16649	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16650	</desc>
16651	</const>
16652	<const name="OnGuestPropertyChanged" value="42">
16653	<desc>
16654	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16655	</desc>
16656	</const>
16657	<!-- Console events -->
16658	<const name="OnMousePointerShapeChanged" value="43">
16659	<desc>
16660	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16661	</desc>
16662	</const>
16663	<const name="OnMouseCapabilityChanged" value="44">
16664	<desc>
16665	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16666	</desc>
16667	</const>
16668	<const name="OnKeyboardLedsChanged" value="45">
16669	<desc>
16670	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16671	</desc>
16672	</const>
16673	<const name="OnStateChanged" value="46">
16674	<desc>
16675	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16676	</desc>
16677	</const>
16678	<const name="OnAdditionsStateChanged" value="47">
16679	<desc>
16680	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16681	</desc>
16682	</const>
16683	<const name="OnNetworkAdapterChanged" value="48">
16684	<desc>
16685	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16686	</desc>
16687	</const>
16688	<const name="OnSerialPortChanged" value="49">
16689	<desc>
16690	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16691	</desc>
16692	</const>
16693	<const name="OnParallelPortChanged" value="50">
16694	<desc>
16695	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16696	</desc>
16697	</const>
16698	<const name="OnStorageControllerChanged" value="51">
16699	<desc>
16700	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16701	</desc>
16702	</const>
16703	<const name="OnMediumChanged" value="52">
16704	<desc>
16705	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16706	</desc>
16707	</const>
16708	<const name="OnVRDEServerChanged" value="53">
16709	<desc>
16710	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16711	</desc>
16712	</const>
16713	<const name="OnUSBControllerChanged" value="54">
16714	<desc>
16715	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16716	</desc>
16717	</const>
16718	<const name="OnUSBDeviceStateChanged" value="55">
16719	<desc>
16720	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16721	</desc>
16722	</const>
16723	<const name="OnSharedFolderChanged" value="56">
16724	<desc>
16725	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16726	</desc>
16727	</const>
16728	<const name="OnRuntimeError" value="57">
16729	<desc>
16730	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16731	</desc>
16732	</const>
16733	<const name="OnCanShowWindow" value="58">
16734	<desc>
16735	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16736	</desc>
16737	</const>
16738	<const name="OnShowWindow" value="59">
16739	<desc>
16740	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16741	</desc>
16742	</const>
16743	<const name="OnCPUChanged" value="60">
16744	<desc>
16745	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16746	</desc>
16747	</const>
16748	<const name="OnVRDEServerInfoChanged" value="61">
16749	<desc>
16750	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16751	</desc>
16752	</const>
16753	<const name="OnEventSourceChanged" value="62">
16754	<desc>
16755	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16756	</desc>
16757	</const>
16758	<const name="OnCPUExecutionCapChanged" value="63">
16759	<desc>
16760	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16761	</desc>
16762	</const>
16763	<const name="OnGuestKeyboard" value="64">
16764	<desc>
16765	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16766	</desc>
16767	</const>
16768	<const name="OnGuestMouse" value="65">
16769	<desc>
16770	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16771	</desc>
16772	</const>
16773	<const name="OnNATRedirect" value="66">
16774	<desc>
16775	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16776	</desc>
16777	</const>
16778	<const name="OnHostPciDevicePlug" value="67">
16779	<desc>
16780	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16781	</desc>
16782	</const>
16783	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16784	<desc>
16785	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16786	</desc>
16787	</const>
16788	<const name="OnBandwidthGroupChanged" value="69">
16789	<desc>
16790	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16791	</desc>
16792	</const>
16793	<const name="OnGuestMonitorChanged" value="70">
16794	<desc>
16795	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16796	</desc>
16797	</const>
16798	<const name="OnStorageDeviceChanged" value="71">
16799	<desc>
16800	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16801	</desc>
16802	</const>
16803
16804	<!-- Last event marker -->
16805	<const name="Last" value="72">
16806	<desc>
16807	Must be last event, used for iterations and structures relying on numerical event values.
16808	</desc>
16809	</const>
16810
16811	</enum>
16812
16813	<interface
16814	name="IEventSource" extends="$unknown"
16815	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16816	wsmap="managed"
16817	>
16818	<desc>
16819	Event source. Generally, any object which could generate events can be an event source,
16820	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16821	an event source can work with listeners in either active or passive mode. In active mode it is up to
16822	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16823	event source keeps track of pending events for each listener and returns available events on demand.
16824
16825	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16826	</desc>
16827
16828	<method name="createListener">
16829	<desc>
16830	Creates a new listener object, useful for passive mode.
16831	</desc>
16832	<param name="listener" type="IEventListener" dir="return"/>
16833	</method>
16834
16835	<method name="createAggregator">
16836	<desc>
16837	Creates an aggregator event source, collecting events from multiple sources.
16838	This way a single listener can listen for events coming from multiple sources,
16839	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16840	</desc>
16841	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16842	<desc>
16843	Subordinate event source this one aggregatres.
16844	</desc>
16845	</param>
16846	<param name="result" type="IEventSource" dir="return">
16847	<desc>
16848	Event source aggregating passed sources.
16849	</desc>
16850	</param>
16851	</method>
16852
16853	<method name="registerListener">
16854	<desc>
16855	Register an event listener.
16856
16857	<note>
16858	To avoid system overload, the VirtualBox server process checks if passive event
16859	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16860	current implementation, if more than 500 pending events are detected for a passive
16861	event listener, it is forcefully unregistered by the system, and further
16862	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16863	</note>
16864	</desc>
16865	<param name="listener" type="IEventListener" dir="in">
16866	<desc>Listener to register.</desc>
16867	</param>
16868	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16869	<desc>
16870	Event types listener is interested in. One can use wildcards like -
16871	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16872	than one event.
16873	</desc>
16874	</param>
16875	<param name="active" type="boolean" dir="in">
16876	<desc>
16877	Which mode this listener is operating in.
16878	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16879	In passive mode, an internal event queue is created for this this IEventListener.
16880	For each event coming in, it is added to queues for all interested registered passive
16881	listeners. It is then up to the external code to call the listener's
16882	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16883	external code must call <link to="#eventProcessed" />.
16884	</desc>
16885	</param>
16886	</method>
16887
16888	<method name="unregisterListener">
16889	<desc>
16890	Unregister an event listener. If listener is passive, and some waitable events are still
16891	in queue they are marked as processed automatically.
16892	</desc>
16893	<param name="listener" type="IEventListener" dir="in">
16894	<desc>Listener to unregister.</desc>
16895	</param>
16896	</method>
16897
16898	<method name="fireEvent">
16899	<desc>
16900	Fire an event for this source.
16901	</desc>
16902	<param name="event" type="IEvent" dir="in">
16903	<desc>Event to deliver.</desc>
16904	</param>
16905	<param name="timeout" type="long" dir="in">
16906	<desc>
16907	Maximum time to wait for event processing (if event is waitable), in ms;
16908	0 = no wait, -1 = indefinite wait.
16909	</desc>
16910	</param>
16911	<param name="result" type="boolean" dir="return">
16912	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16913	</param>
16914	</method>
16915
16916	<method name="getEvent">
16917	<desc>
16918	Get events from this peer's event queue (for passive mode). Calling this method
16919	regularly is required for passive event listeners to avoid system overload;
16920	see <link to="IEventSource::registerListener" /> for details.
16921
16922	<result name="VBOX_E_OBJECT_NOT_FOUND">
16923	Listener is not registered, or autounregistered.
16924	</result>
16925	</desc>
16926	<param name="listener" type="IEventListener" dir="in">
16927	<desc>Which listener to get data for.</desc>
16928	</param>
16929	<param name="timeout" type="long" dir="in">
16930	<desc>
16931	Maximum time to wait for events, in ms;
16932	0 = no wait, -1 = indefinite wait.
16933	</desc>
16934	</param>
16935	<param name="event" type="IEvent" dir="return">
16936	<desc>Event retrieved, or null if none available.</desc>
16937	</param>
16938	</method>
16939
16940	<method name="eventProcessed">
16941	<desc>
16942	Must be called for waitable events after a particular listener finished its
16943	event processing. When all listeners of a particular event have called this
16944	method, the system will then call <link to="IEvent::setProcessed" />.
16945	</desc>
16946	<param name="listener" type="IEventListener" dir="in">
16947	<desc>Which listener processed event.</desc>
16948	</param>
16949	<param name="event" type="IEvent" dir="in">
16950	<desc>Which event.</desc>
16951	</param>
16952	</method>
16953
16954	</interface>
16955
16956	<interface
16957	name="IEventListener" extends="$unknown"
16958	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
16959	wsmap="managed"
16960	>
16961	<desc>
16962	Event listener. An event listener can work in either active or passive mode, depending on the way
16963	it was registered.
16964	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16965	</desc>
16966
16967	<method name="handleEvent">
16968	<desc>
16969	Handle event callback for active listeners. It is not called for
16970	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
16971	and having received acknowledgement from all passive listeners via
16972	<link to="IEventSource::eventProcessed"/>, the event is marked as
16973	processed and <link to="IEvent::waitProcessed"/> will return
16974	immediately.
16975	</desc>
16976	<param name="event" type="IEvent" dir="in">
16977	<desc>Event available.</desc>
16978	</param>
16979	</method>
16980
16981	</interface>
16982
16983	<interface
16984	name="IEvent" extends="$unknown"
16985	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
16986	wsmap="managed"
16987	>
16988	<desc>
16989	Abstract parent interface for VirtualBox events. Actual events will typically implement
16990	a more specific interface which derives from this (see below).
16991
16992	<b>Introduction to VirtualBox events</b>
16993
16994	Generally speaking, an event (represented by this interface) signals that something
16995	happened, while an event listener (see <link to="IEventListener" />) represents an
16996	entity that is interested in certain events. In order for this to work with
16997	unidirectional protocols (i.e. web services), the concepts of passive and active
16998	listener are used.
16999
17000	Event consumers can register themselves as listeners, providing an array of
17001	events they are interested in (see <link to="IEventSource::registerListener" />).
17002	When an event triggers, the listener is notified about the event. The exact
17003	mechanism of the notification depends on whether the listener was registered as
17004	an active or passive listener:
17005
17006	<ul>
17007	<li>An active listener is very similar to a callback: it is a function invoked
17008	by the API. As opposed to the callbacks that were used in the API before
17009	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
17010	</li>
17011
17012	<li>Passive listeners are somewhat trickier to implement, but do not require
17013	a client function to be callable, which is not an option with scripting
17014	languages or web service clients. Internally the <link to="IEventSource" />
17015	implementation maintains an event queue for each passive listener, and
17016	newly arrived events are put in this queue. When the listener calls
17017	<link to="IEventSource::getEvent"/>, first element from its internal event
17018	queue is returned. When the client completes processing of an event,
17019	the <link to="IEventSource::eventProcessed" /> function must be called,
17020	acknowledging that the event was processed. It supports implementing
17021	waitable events. On passive listener unregistration, all events from its
17022	queue are auto-acknowledged.
17023	</li>
17024	</ul>
17025
17026	Waitable events are useful in situations where the event generator wants to track
17027	delivery or a party wants to wait until all listeners have completed the event. A
17028	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
17029	listeners might veto a certain action, and thus the event producer has to make
17030	sure that all listeners have processed the event and not vetoed before taking
17031	the action.
17032
17033	A given event may have both passive and active listeners at the same time.
17034
17035	<b>Using events</b>
17036
17037	Any VirtualBox object capable of producing externally visible events provides an
17038	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
17039	This event source object is notified by VirtualBox once something has happened, so
17040	consumers may register event listeners with this event source. To register a listener,
17041	an object implementing the <link to="IEventListener" /> interface must be provided.
17042	For active listeners, such an object is typically created by the consumer, while for
17043	passive listeners <link to="IEventSource::createListener" /> should be used. Please
17044	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
17045
17046	Once created, the listener must be registered to listen for the desired events
17047	(see <link to="IEventSource::registerListener" />), providing an array of
17048	<link to="VBoxEventType" /> enums. Those elements can either be the individual
17049	event IDs or wildcards matching multiple event IDs.
17050
17051	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
17052	called automatically when the event is triggered, while passive listeners have to call
17053	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
17054	an event processing loop.
17055
17056	The IEvent interface is an abstract parent interface for all such VirtualBox events
17057	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
17058	or the event processing loop is to check the <link to="#type" /> attribute of the event and
17059	then cast to the appropriate specific interface using @c QueryInterface().
17060	</desc>
17061
17062	<attribute name="type" readonly="yes" type="VBoxEventType">
17063	<desc>
17064	Event type.
17065	</desc>
17066	</attribute>
17067
17068	<attribute name="source" readonly="yes" type="IEventSource">
17069	<desc>
17070	Source of this event.
17071	</desc>
17072	</attribute>
17073
17074	<attribute name="waitable" readonly="yes" type="boolean">
17075	<desc>
17076	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
17077	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
17078	as no additional overhead associated with waitability imposed.
17079	Waitable events are needed when one need to be able to wait for particular event processed,
17080	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
17081	until all consumers confirmed events.
17082	</desc>
17083	</attribute>
17084
17085	<method name="setProcessed">
17086	<desc>
17087	Internal method called by the system when all listeners of a particular event have called
17088	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
17089	</desc>
17090	</method>
17091
17092	<method name="waitProcessed">
17093	<desc>
17094	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
17095	described semantics, for non-waitable returns true immediately.
17096	</desc>
17097	<param name="timeout" type="long" dir="in">
17098	<desc>
17099	Maximum time to wait for event processeing, in ms;
17100	0 = no wait, -1 = indefinite wait.
17101	</desc>
17102	</param>
17103	<param name="result" type="boolean" dir="return">
17104	<desc>If this event was processed before timeout.</desc>
17105	</param>
17106	</method>
17107	</interface>
17108
17109
17110	<interface
17111	name="IReusableEvent" extends="IEvent"
17112	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17113	wsmap="managed"
17114	>
17115	<desc>Base abstract interface for all reusable events.</desc>
17116
17117	<attribute name="generation" readonly="yes" type="unsigned long">
17118	<desc>Current generation of event, incremented on reuse.</desc>
17119	</attribute>
17120
17121	<method name="reuse">
17122	<desc>
17123	Marks an event as reused, increments 'generation', fields shall no
17124	longer be considered valid.
17125	</desc>
17126	</method>
17127	</interface>
17128
17129	<interface
17130	name="IMachineEvent" extends="IEvent"
17131	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17132	wsmap="managed" id="MachineEvent"
17133	>
17134	<desc>Base abstract interface for all machine events.</desc>
17135
17136	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17137	<desc>ID of the machine this event relates to.</desc>
17138	</attribute>
17139
17140	</interface>
17141
17142	<interface
17143	name="IMachineStateChangedEvent" extends="IMachineEvent"
17144	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17145	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17146	>
17147	<desc>Machine state change event.</desc>
17148
17149	<attribute name="state" readonly="yes" type="MachineState">
17150	<desc>New execution state.</desc>
17151	</attribute>
17152	</interface>
17153
17154	<interface
17155	name="IMachineDataChangedEvent" extends="IMachineEvent"
17156	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17157	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17158	>
17159	<desc>
17160	Any of the settings of the given machine has changed.
17161	</desc>
17162
17163	<attribute name="temporary" readonly="yes" type="boolean">
17164	<desc>@c true if the settings change is temporary. All permanent
17165	settings changes will trigger an event, and only temporary settings
17166	changes for running VMs will trigger an event. Note: sending events
17167	for temporary changes is NOT IMPLEMENTED.</desc>
17168	</attribute>
17169	</interface>
17170
17171	<interface
17172	name="IMediumRegisteredEvent" extends="IEvent"
17173	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17174	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17175	>
17176	<desc>
17177	The given medium was registered or unregistered
17178	within this VirtualBox installation.
17179	</desc>
17180
17181	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17182	<desc>ID of the medium this event relates to.</desc>
17183	</attribute>
17184
17185	<attribute name="mediumType" readonly="yes" type="DeviceType">
17186	<desc>Type of the medium this event relates to.</desc>
17187	</attribute>
17188
17189	<attribute name="registered" type="boolean" readonly="yes">
17190	<desc>
17191	If @c true, the medium was registered, otherwise it was
17192	unregistered.
17193	</desc>
17194	</attribute>
17195	</interface>
17196
17197	<interface
17198	name="IMachineRegisteredEvent" extends="IMachineEvent"
17199	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17200	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17201	>
17202	<desc>
17203	The given machine was registered or unregistered
17204	within this VirtualBox installation.
17205	</desc>
17206
17207	<attribute name="registered" type="boolean" readonly="yes">
17208	<desc>
17209	If @c true, the machine was registered, otherwise it was
17210	unregistered.
17211	</desc>
17212	</attribute>
17213	</interface>
17214
17215	<interface
17216	name="ISessionStateChangedEvent" extends="IMachineEvent"
17217	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17218	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17219	>
17220	<desc>
17221	The state of the session for the given machine was changed.
17222	<see><link to="IMachine::sessionState"/></see>
17223	</desc>
17224
17225	<attribute name="state" type="SessionState" readonly="yes">
17226	<desc>
17227	New session state.
17228	</desc>
17229	</attribute>
17230	</interface>
17231
17232	<interface
17233	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17234	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17235	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17236	>
17237	<desc>
17238	Notification when a guest property has changed.
17239	</desc>
17240
17241	<attribute name="name" readonly="yes" type="wstring">
17242	<desc>
17243	The name of the property that has changed.
17244	</desc>
17245	</attribute>
17246
17247	<attribute name="value" readonly="yes" type="wstring">
17248	<desc>
17249	The new property value.
17250	</desc>
17251	</attribute>
17252
17253	<attribute name="flags" readonly="yes" type="wstring">
17254	<desc>
17255	The new property flags.
17256	</desc>
17257	</attribute>
17258
17259	</interface>
17260
17261	<interface
17262	name="ISnapshotEvent" extends="IMachineEvent"
17263	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17264	wsmap="managed" id="SnapshotEvent"
17265	>
17266	<desc>Base interface for all snapshot events.</desc>
17267
17268	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17269	<desc>ID of the snapshot this event relates to.</desc>
17270	</attribute>
17271
17272	</interface>
17273
17274	<interface
17275	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17276	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17277	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17278	>
17279	<desc>
17280	A new snapshot of the machine has been taken.
17281	<see><link to="ISnapshot"/></see>
17282	</desc>
17283	</interface>
17284
17285	<interface
17286	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17287	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17288	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17289	>
17290	<desc>
17291	Snapshot of the given machine has been deleted.
17292
17293	<note>
17294	This notification is delivered <b>after</b> the snapshot
17295	object has been uninitialized on the server (so that any
17296	attempt to call its methods will return an error).
17297	</note>
17298
17299	<see><link to="ISnapshot"/></see>
17300	</desc>
17301	</interface>
17302
17303	<interface
17304	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17305	uuid="07541941-8079-447a-a33e-47a69c7980db"
17306	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17307	>
17308	<desc>
17309	Snapshot properties (name and/or description) have been changed.
17310	<see><link to="ISnapshot"/></see>
17311	</desc>
17312	</interface>
17313
17314	<interface
17315	name="IMousePointerShapeChangedEvent" extends="IEvent"
17316	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17317	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17318	>
17319	<desc>
17320	Notification when the guest mouse pointer shape has
17321	changed. The new shape data is given.
17322	</desc>
17323
17324	<attribute name="visible" type="boolean" readonly="yes">
17325	<desc>
17326	Flag whether the pointer is visible.
17327	</desc>
17328	</attribute>
17329	<attribute name="alpha" type="boolean" readonly="yes">
17330	<desc>
17331	Flag whether the pointer has an alpha channel.
17332	</desc>
17333	</attribute>
17334	<attribute name="xhot" type="unsigned long" readonly="yes">
17335	<desc>
17336	The pointer hot spot X coordinate.
17337	</desc>
17338	</attribute>
17339	<attribute name="yhot" type="unsigned long" readonly="yes">
17340	<desc>
17341	The pointer hot spot Y coordinate.
17342	</desc>
17343	</attribute>
17344	<attribute name="width" type="unsigned long" readonly="yes">
17345	<desc>
17346	Width of the pointer shape in pixels.
17347	</desc>
17348	</attribute>
17349	<attribute name="height" type="unsigned long" readonly="yes">
17350	<desc>
17351	Height of the pointer shape in pixels.
17352	</desc>
17353	</attribute>
17354	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17355	<desc>
17356	Shape buffer arrays.
17357
17358	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17359	followed by a 32-bpp XOR (color) mask.
17360
17361	For pointers without alpha channel the XOR mask pixels are 32
17362	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17363	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17364
17365	An AND mask is used for pointers with alpha channel, so if the
17366	callback does not support alpha, the pointer could be
17367	displayed as a normal color pointer.
17368
17369	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17370	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17371	height</tt>. The padding bits at the end of each scanline are
17372	undefined.
17373
17374	The XOR mask follows the AND mask on the next 4-byte aligned
17375	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17376	Bytes in the gap between the AND and the XOR mask are undefined.
17377	The XOR mask scanlines have no gap between them and the size of
17378	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17379
17380	<note>
17381	If @a shape is 0, only the pointer visibility is changed.
17382	</note>
17383	</desc>
17384	</attribute>
17385	</interface>
17386
17387	<interface
17388	name="IMouseCapabilityChangedEvent" extends="IEvent"
17389	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17390	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17391	>
17392	<desc>
17393	Notification when the mouse capabilities reported by the
17394	guest have changed. The new capabilities are passed.
17395	</desc>
17396	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17397	<desc>
17398	Supports absolute coordinates.
17399	</desc>
17400	</attribute>
17401	<attribute name="supportsRelative" type="boolean" readonly="yes">
17402	<desc>
17403	Supports relative coordinates.
17404	</desc>
17405	</attribute>
17406	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17407	<desc>
17408	If host cursor is needed.
17409	</desc>
17410	</attribute>
17411	</interface>
17412
17413	<interface
17414	name="IKeyboardLedsChangedEvent" extends="IEvent"
17415	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17416	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17417	>
17418	<desc>
17419	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17420	to alter the state of the keyboard LEDs.
17421	</desc>
17422	<attribute name="numLock" type="boolean" readonly="yes">
17423	<desc>
17424	NumLock status.
17425	</desc>
17426	</attribute>
17427	<attribute name="capsLock" type="boolean" readonly="yes">
17428	<desc>
17429	CapsLock status.
17430	</desc>
17431	</attribute>
17432	<attribute name="scrollLock" type="boolean" readonly="yes">
17433	<desc>
17434	ScrollLock status.
17435	</desc>
17436	</attribute>
17437	</interface>
17438
17439	<interface
17440	name="IStateChangedEvent" extends="IEvent"
17441	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17442	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17443	>
17444	<desc>
17445	Notification when the execution state of the machine has changed.
17446	The new state is given.
17447	</desc>
17448	<attribute name="state" type="MachineState" readonly="yes">
17449	<desc>
17450	New machine state.
17451	</desc>
17452	</attribute>
17453	</interface>
17454
17455	<interface
17456	name="IAdditionsStateChangedEvent" extends="IEvent"
17457	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17458	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17459	>
17460	<desc>
17461	Notification when a Guest Additions property changes.
17462	Interested callees should query IGuest attributes to
17463	find out what has changed.
17464	</desc>
17465	</interface>
17466
17467	<interface
17468	name="INetworkAdapterChangedEvent" extends="IEvent"
17469	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17470	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17471	>
17472	<desc>
17473	Notification when a property of one of the
17474	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17475	changes. Interested callees should use INetworkAdapter methods and
17476	attributes to find out what has changed.
17477	</desc>
17478	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17479	<desc>
17480	Network adapter that is subject to change.
17481	</desc>
17482	</attribute>
17483	</interface>
17484
17485	<interface
17486	name="ISerialPortChangedEvent" extends="IEvent"
17487	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17488	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17489	>
17490	<desc>
17491	Notification when a property of one of the
17492	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17493	Interested callees should use ISerialPort methods and attributes
17494	to find out what has changed.
17495	</desc>
17496	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17497	<desc>
17498	Serial port that is subject to change.
17499	</desc>
17500	</attribute>
17501	</interface>
17502
17503	<interface
17504	name="IParallelPortChangedEvent" extends="IEvent"
17505	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17506	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17507	>
17508	<desc>
17509	Notification when a property of one of the
17510	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17511	changes. Interested callees should use ISerialPort methods and
17512	attributes to find out what has changed.
17513	</desc>
17514	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17515	<desc>
17516	Parallel port that is subject to change.
17517	</desc>
17518	</attribute>
17519	</interface>
17520
17521	<interface
17522	name="IStorageControllerChangedEvent" extends="IEvent"
17523	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17524	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17525	>
17526	<desc>
17527	Notification when a
17528	<link to="IMachine::mediumAttachments">medium attachment</link>
17529	changes.
17530	</desc>
17531	</interface>
17532
17533	<interface
17534	name="IMediumChangedEvent" extends="IEvent"
17535	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17536	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17537	>
17538	<desc>
17539	Notification when a
17540	<link to="IMachine::mediumAttachments">medium attachment</link>
17541	changes.
17542	</desc>
17543	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17544	<desc>
17545	Medium attachment that is subject to change.
17546	</desc>
17547	</attribute>
17548	</interface>
17549
17550	<interface
17551	name="ICPUChangedEvent" extends="IEvent"
17552	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17553	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17554	>
17555	<desc>
17556	Notification when a CPU changes.
17557	</desc>
17558	<attribute name="cpu" type="unsigned long" readonly="yes">
17559	<desc>
17560	The CPU which changed.
17561	</desc>
17562	</attribute>
17563	<attribute name="add" type="boolean" readonly="yes">
17564	<desc>
17565	Flag whether the CPU was added or removed.
17566	</desc>
17567	</attribute>
17568	</interface>
17569
17570	<interface
17571	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17572	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17573	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17574	>
17575	<desc>
17576	Notification when the CPU execution cap changes.
17577	</desc>
17578	<attribute name="executionCap" type="unsigned long" readonly="yes">
17579	<desc>
17580	The new CPU execution cap value. (1-100)
17581	</desc>
17582	</attribute>
17583	</interface>
17584
17585	<interface
17586	name="IGuestKeyboardEvent" extends="IEvent"
17587	uuid="88394258-7006-40d4-b339-472ee3801844"
17588	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17589	>
17590	<desc>
17591	Notification when guest keyboard event happens.
17592	</desc>
17593	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17594	<desc>
17595	Array of scancodes.
17596	</desc>
17597	</attribute>
17598	</interface>
17599
17600	<interface
17601	name="IGuestMouseEvent" extends="IReusableEvent"
17602	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17603	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17604	>
17605	<desc>
17606	Notification when guest mouse event happens.
17607	</desc>
17608
17609	<attribute name="absolute" type="boolean" readonly="yes">
17610	<desc>
17611	If this event is relative or absolute.
17612	</desc>
17613	</attribute>
17614
17615	<attribute name="x" type="long" readonly="yes">
17616	<desc>
17617	New X position, or X delta.
17618	</desc>
17619	</attribute>
17620
17621	<attribute name="y" type="long" readonly="yes">
17622	<desc>
17623	New Y position, or Y delta.
17624	</desc>
17625	</attribute>
17626
17627	<attribute name="z" type="long" readonly="yes">
17628	<desc>
17629	Z delta.
17630	</desc>
17631	</attribute>
17632
17633	<attribute name="w" type="long" readonly="yes">
17634	<desc>
17635	W delta.
17636	</desc>
17637	</attribute>
17638
17639	<attribute name="buttons" type="long" readonly="yes">
17640	<desc>
17641	Button state bitmask.
17642	</desc>
17643	</attribute>
17644
17645	</interface>
17646
17647
17648	<interface
17649	name="IVRDEServerChangedEvent" extends="IEvent"
17650	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17651	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17652	>
17653	<desc>
17654	Notification when a property of the
17655	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17656	Interested callees should use IVRDEServer methods and attributes to
17657	find out what has changed.
17658	</desc>
17659	</interface>
17660
17661	<interface
17662	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17663	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17664	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17665	>
17666	<desc>
17667	Notification when the status of the VRDE server changes. Interested callees
17668	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17669	attributes to find out what is the current status.
17670	</desc>
17671	</interface>
17672
17673	<interface
17674	name="IUSBControllerChangedEvent" extends="IEvent"
17675	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17676	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17677	>
17678	<desc>
17679	Notification when a property of the virtual
17680	<link to="IMachine::USBController">USB controller</link> changes.
17681	Interested callees should use IUSBController methods and attributes to
17682	find out what has changed.
17683	</desc>
17684	</interface>
17685
17686	<interface
17687	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17688	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17689	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17690	>
17691	<desc>
17692	Notification when a USB device is attached to or detached from
17693	the virtual USB controller.
17694
17695	This notification is sent as a result of the indirect
17696	request to attach the device because it matches one of the
17697	machine USB filters, or as a result of the direct request
17698	issued by <link to="IConsole::attachUSBDevice"/> or
17699	<link to="IConsole::detachUSBDevice"/>.
17700
17701	This notification is sent in case of both a succeeded and a
17702	failed request completion. When the request succeeds, the
17703	@a error parameter is @c null, and the given device has been
17704	already added to (when @a attached is @c true) or removed from
17705	(when @a attached is @c false) the collection represented by
17706	<link to="IConsole::USBDevices"/>. On failure, the collection
17707	doesn't change and the @a error parameter represents the error
17708	message describing the failure.
17709	</desc>
17710	<attribute name="device" type="IUSBDevice" readonly="yes">
17711	<desc>
17712	Device that is subject to state change.
17713	</desc>
17714	</attribute>
17715	<attribute name="attached" type="boolean" readonly="yes">
17716	<desc>
17717	@c true if the device was attached and @c false otherwise.
17718	</desc>
17719	</attribute>
17720	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17721	<desc>
17722	@c null on success or an error message object on failure.
17723	</desc>
17724	</attribute>
17725	</interface>
17726
17727	<interface
17728	name="ISharedFolderChangedEvent" extends="IEvent"
17729	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17730	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17731	>
17732	<desc>
17733	Notification when a shared folder is added or removed.
17734	The @a scope argument defines one of three scopes:
17735	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17736	(<link to="Scope_Global">Global</link>),
17737	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17738	the machine (<link to="Scope_Machine">Machine</link>) or <link
17739	to="IConsole::sharedFolders">transient shared folders</link> of the
17740	machine (<link to="Scope_Session">Session</link>). Interested callees
17741	should use query the corresponding collections to find out what has
17742	changed.
17743	</desc>
17744	<attribute name="scope" type="Scope" readonly="yes">
17745	<desc>
17746	Scope of the notification.
17747	</desc>
17748	</attribute>
17749	</interface>
17750
17751	<interface
17752	name="IRuntimeErrorEvent" extends="IEvent"
17753	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17754	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17755	>
17756	<desc>
17757	Notification when an error happens during the virtual
17758	machine execution.
17759
17760	There are three kinds of runtime errors:
17761	<ul>
17762	<li><i>fatal</i></li>
17763	<li><i>non-fatal with retry</i></li>
17764	<li><i>non-fatal warnings</i></li>
17765	</ul>
17766
17767	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17768	to @c true. In case of fatal errors, the virtual machine
17769	execution is always paused before calling this notification, and
17770	the notification handler is supposed either to immediately save
17771	the virtual machine state using <link to="IConsole::saveState"/>
17772	or power it off using <link to="IConsole::powerDown"/>.
17773	Resuming the execution can lead to unpredictable results.
17774
17775	<b>Non-fatal</b> errors and warnings are indicated by the
17776	@a fatal parameter set to @c false. If the virtual machine
17777	is in the Paused state by the time the error notification is
17778	received, it means that the user can <i>try to resume</i> the machine
17779	execution after attempting to solve the problem that caused the
17780	error. In this case, the notification handler is supposed
17781	to show an appropriate message to the user (depending on the
17782	value of the @a id parameter) that offers several actions such
17783	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17784	wants to retry, the notification handler should continue
17785	the machine execution using the <link to="IConsole::resume"/>
17786	call. If the machine execution is not Paused during this
17787	notification, then it means this notification is a <i>warning</i>
17788	(for example, about a fatal condition that can happen very soon);
17789	no immediate action is required from the user, the machine
17790	continues its normal execution.
17791
17792	Note that in either case the notification handler
17793	<b>must not</b> perform any action directly on a thread
17794	where this notification is called. Everything it is allowed to
17795	do is to post a message to another thread that will then talk
17796	to the user and take the corresponding action.
17797
17798	Currently, the following error identifiers are known:
17799	<ul>
17800	<li><tt>"HostMemoryLow"</tt></li>
17801	<li><tt>"HostAudioNotResponding"</tt></li>
17802	<li><tt>"VDIStorageFull"</tt></li>
17803	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17804	</ul>
17805	</desc>
17806	<attribute name="fatal" type="boolean" readonly="yes">
17807	<desc>
17808	Whether the error is fatal or not.
17809	</desc>
17810	</attribute>
17811	<attribute name="id" type="wstring" readonly="yes">
17812	<desc>
17813	Error identifier.
17814	</desc>
17815	</attribute>
17816	<attribute name="message" type="wstring" readonly="yes">
17817	<desc>
17818	Optional error message.
17819	</desc>
17820	</attribute>
17821	</interface>
17822
17823
17824	<interface
17825	name="IEventSourceChangedEvent" extends="IEvent"
17826	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17827	waitable="yes"
17828	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17829	>
17830	<desc>
17831	Notification when an event source state changes (listener added or removed).
17832	</desc>
17833
17834	<attribute name="listener" type="IEventListener" readonly="yes">
17835	<desc>
17836	Event listener which has changed.
17837	</desc>
17838	</attribute>
17839
17840	<attribute name="add" type="boolean" readonly="yes">
17841	<desc>
17842	Flag whether listener was added or removed.
17843	</desc>
17844	</attribute>
17845	</interface>
17846
17847	<interface
17848	name="IExtraDataChangedEvent" extends="IEvent"
17849	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17850	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17851	>
17852	<desc>
17853	Notification when machine specific or global extra data
17854	has changed.
17855	</desc>
17856	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17857	<desc>
17858	ID of the machine this event relates to.
17859	Null for global extra data changes.
17860	</desc>
17861	</attribute>
17862	<attribute name="key" type="wstring" readonly="yes">
17863	<desc>
17864	Extra data key that has changed.
17865	</desc>
17866	</attribute>
17867	<attribute name="value" type="wstring" readonly="yes">
17868	<desc>
17869	Extra data value for the given key.
17870	</desc>
17871	</attribute>
17872	</interface>
17873
17874	<interface
17875	name="IVetoEvent" extends="IEvent"
17876	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17877	wsmap="managed"
17878	>
17879	<desc>Base abstract interface for veto events.</desc>
17880
17881	<method name="addVeto">
17882	<desc>
17883	Adds a veto on this event.
17884	</desc>
17885	<param name="reason" type="wstring" dir="in">
17886	<desc>
17887	Reason for veto, could be null or empty string.
17888	</desc>
17889	</param>
17890	</method>
17891
17892	<method name="isVetoed">
17893	<desc>
17894	If this event was vetoed.
17895	</desc>
17896	<param name="result" type="boolean" dir="return">
17897	<desc>
17898	Reason for veto.
17899	</desc>
17900	</param>
17901	</method>
17902
17903	<method name="getVetos">
17904	<desc>
17905	Current veto reason list, if size is 0 - no veto.
17906	</desc>
17907	<param name="result" type="wstring" dir="return" safearray="yes">
17908	<desc>
17909	Array of reasons for veto provided by different event handlers.
17910	</desc>
17911	</param>
17912	</method>
17913
17914	</interface>
17915
17916	<interface
17917	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17918	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17919	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17920	waitable="true"
17921	>
17922	<desc>
17923	Notification when someone tries to change extra data for
17924	either the given machine or (if @c null) global extra data.
17925	This gives the chance to veto against changes.
17926	</desc>
17927	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17928	<desc>
17929	ID of the machine this event relates to.
17930	Null for global extra data changes.
17931	</desc>
17932	</attribute>
17933	<attribute name="key" type="wstring" readonly="yes">
17934	<desc>
17935	Extra data key that has changed.
17936	</desc>
17937	</attribute>
17938	<attribute name="value" type="wstring" readonly="yes">
17939	<desc>
17940	Extra data value for the given key.
17941	</desc>
17942	</attribute>
17943	</interface>
17944
17945	<interface
17946	name="ICanShowWindowEvent" extends="IVetoEvent"
17947	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
17948	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
17949	waitable="true"
17950	>
17951	<desc>
17952	Notification when a call to
17953	<link to="IMachine::canShowConsoleWindow"/> is made by a
17954	front-end to check if a subsequent call to
17955	<link to="IMachine::showConsoleWindow"/> can succeed.
17956
17957	The callee should give an answer appropriate to the current
17958	machine state using event veto. This answer must
17959	remain valid at least until the next
17960	<link to="IConsole::state">machine state</link> change.
17961	</desc>
17962	</interface>
17963
17964	<interface
17965	name="IShowWindowEvent" extends="IEvent"
17966	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
17967	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
17968	waitable="true"
17969	>
17970	<desc>
17971	Notification when a call to
17972	<link to="IMachine::showConsoleWindow"/>
17973	requests the console window to be activated and brought to
17974	foreground on the desktop of the host PC.
17975
17976	This notification should cause the VM console process to
17977	perform the requested action as described above. If it is
17978	impossible to do it at a time of this notification, this
17979	method should return a failure.
17980
17981	Note that many modern window managers on many platforms
17982	implement some sort of focus stealing prevention logic, so
17983	that it may be impossible to activate a window without the
17984	help of the currently active application (which is supposedly
17985	an initiator of this notification). In this case, this method
17986	must return a non-zero identifier that represents the
17987	top-level window of the VM console process. The caller, if it
17988	represents a currently active process, is responsible to use
17989	this identifier (in a platform-dependent manner) to perform
17990	actual window activation.
17991
17992	This method must set @a winId to zero if it has performed all
17993	actions necessary to complete the request and the console
17994	window is now active and in foreground, to indicate that no
17995	further action is required on the caller's side.
17996	</desc>
17997	<attribute name="winId" type="long long">
17998	<desc>
17999	Platform-dependent identifier of the top-level VM console
18000	window, or zero if this method has performed all actions
18001	necessary to implement the <i>show window</i> semantics for
18002	the given platform and/or this VirtualBox front-end.
18003	</desc>
18004	</attribute>
18005	</interface>
18006
18007	<interface
18008	name="INATRedirectEvent" extends="IMachineEvent"
18009	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
18010	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
18011	>
18012	<desc>
18013	Notification when NAT redirect rule added or removed.
18014	</desc>
18015	<attribute name="slot" type="unsigned long" readonly="yes">
18016	<desc>
18017	Adapter which NAT attached to.
18018	</desc>
18019	</attribute>
18020	<attribute name="remove" type="boolean" readonly="yes">
18021	<desc>
18022	Whether rule remove or add.
18023	</desc>
18024	</attribute>
18025	<attribute name="name" type="wstring" readonly="yes">
18026	<desc>
18027	Name of the rule.
18028	</desc>
18029	</attribute>
18030	<attribute name="proto" type="NATProtocol" readonly="yes">
18031	<desc>
18032	Protocol (TCP or UDP) of the redirect rule.
18033	</desc>
18034	</attribute>
18035	<attribute name="hostIp" type="wstring" readonly="yes">
18036	<desc>
18037	Host ip address to bind socket on.
18038	</desc>
18039	</attribute>
18040	<attribute name="hostPort" type="long" readonly="yes">
18041	<desc>
18042	Host port to bind socket on.
18043	</desc>
18044	</attribute>
18045	<attribute name="guestIp" type="wstring" readonly="yes">
18046	<desc>
18047	Guest ip address to redirect to.
18048	</desc>
18049	</attribute>
18050	<attribute name="guestPort" type="long" readonly="yes">
18051	<desc>
18052	Guest port to redirect to.
18053	</desc>
18054	</attribute>
18055	</interface>
18056
18057	<interface
18058	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
18059	waitable="yes"
18060	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
18061	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
18062	>
18063	<desc>
18064	Notification when host PCI device is plugged/unplugged. Plugging
18065	usually takes place on VM startup, unplug - when
18066	<link to="IMachine::detachHostPciDevice"/> is called.
18067
18068	<see><link to="IMachine::detachHostPciDevice"/></see>
18069
18070	</desc>
18071
18072	<attribute name="plugged" type="boolean" readonly="yes">
18073	<desc>
18074	If device successfully plugged or unplugged.
18075	</desc>
18076	</attribute>
18077
18078	<attribute name="success" type="boolean" readonly="yes">
18079	<desc>
18080	If operation was successful, if false - 'message' attribute
18081	may be of interest.
18082	</desc>
18083	</attribute>
18084
18085	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
18086	<desc>
18087	Attachment info for this device.
18088	</desc>
18089	</attribute>
18090
18091	<attribute name="message" type="wstring" readonly="yes">
18092	<desc>
18093	Optional error message.
18094	</desc>
18095	</attribute>
18096
18097	</interface>
18098
18099	<interface
18100	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
18101	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
18102	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
18103	>
18104	<desc>
18105	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18106	unexpected circumstances) or available again.
18107	</desc>
18108
18109	<attribute name="available" type="boolean" readonly="yes">
18110	<desc>
18111	Whether VBoxSVC is available now.
18112	</desc>
18113	</attribute>
18114	</interface>
18115
18116	<interface
18117	name="IBandwidthGroupChangedEvent" extends="IEvent"
18118	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18119	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18120	>
18121	<desc>
18122	Notification when one of the bandwidth groups changed
18123	</desc>
18124	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18125	<desc>
18126	The changed bandwidth group.
18127	</desc>
18128	</attribute>
18129	</interface>
18130
18131	<enum
18132	name="GuestMonitorChangedEventType"
18133	uuid="ef172985-7e36-4297-95be-e46396968d66"
18134	>
18135
18136	<desc>
18137	How the guest monitor has been changed.
18138	</desc>
18139
18140	<const name="Enabled" value="0">
18141	<desc>
18142	The guest monitor has been enabled by the guest.
18143	</desc>
18144	</const>
18145
18146	<const name="Disabled" value="1">
18147	<desc>
18148	The guest monitor has been disabled by the guest.
18149	</desc>
18150	</const>
18151
18152	<const name="NewOrigin" value="2">
18153	<desc>
18154	The guest monitor origin has changed in the guest.
18155	</desc>
18156	</const>
18157	</enum>
18158
18159	<interface
18160	name="IGuestMonitorChangedEvent" extends="IEvent"
18161	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18162	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18163	>
18164	<desc>
18165	Notification when the guest enables one of its monitors.
18166	</desc>
18167
18168	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18169	<desc>
18170	What was changed for this guest monitor.
18171	</desc>
18172	</attribute>
18173
18174	<attribute name="screenId" type="unsigned long" readonly="yes">
18175	<desc>
18176	The monitor which was changed.
18177	</desc>
18178	</attribute>
18179
18180	<attribute name="originX" type="unsigned long" readonly="yes">
18181	<desc>
18182	Physical X origin relative to the primary screen.
18183	Valid for Enabled and NewOrigin.
18184	</desc>
18185	</attribute>
18186
18187	<attribute name="originY" type="unsigned long" readonly="yes">
18188	<desc>
18189	Physical Y origin relative to the primary screen.
18190	Valid for Enabled and NewOrigin.
18191	</desc>
18192	</attribute>
18193
18194	<attribute name="width" type="unsigned long" readonly="yes">
18195	<desc>
18196	Width of the screen.
18197	Valid for Enabled.
18198	</desc>
18199	</attribute>
18200
18201	<attribute name="height" type="unsigned long" readonly="yes">
18202	<desc>
18203	Height of the screen.
18204	Valid for Enabled.
18205	</desc>
18206	</attribute>
18207
18208	</interface>
18209
18210	<interface
18211	name="IStorageDeviceChangedEvent" extends="IEvent"
18212	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18213	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18214	>
18215	<desc>
18216	Notification when a
18217	<link to="IMachine::mediumAttachments">storage device</link>
18218	is attached or removed.
18219	</desc>
18220	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18221	<desc>
18222	Storage device that is subject to change.
18223	</desc>
18224	</attribute>
18225	<attribute name="removed" type="boolean" readonly="yes">
18226	<desc>
18227	Flag whether the device was removed or added to the VM.
18228	</desc>
18229	</attribute>
18230	</interface>
18231
18232	<module name="VBoxSVC" context="LocalServer">
18233	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18234	namespace="virtualbox.org">
18235	<interface name="IVirtualBox" default="yes"/>
18236	</class>
18237	</module>
18238
18239	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18240	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18241	namespace="virtualbox.org">
18242	<interface name="IVirtualBoxClient" default="yes"/>
18243	</class>
18244
18245	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18246	namespace="virtualbox.org">
18247	<interface name="ISession" default="yes"/>
18248	</class>
18249	</module>
18250
18251	</library>
18252
18253	</idl>
18254
18255	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format