VirtualBox.xidl@ 39668

Last change on this file since 39668 was 39668, checked in by vboxsync, 13 years ago
Implemented the log setting properties (read-only).
Property svn:eol-style set to `native`
File size: 657.8 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	</desc>
1418	</attribute>
1419
1420	<attribute name="revision" type="unsigned long" readonly="yes">
1421	<desc>
1422	The internal build revision number of the product.
1423	</desc>
1424	</attribute>
1425
1426	<attribute name="packageType" type="wstring" readonly="yes">
1427	<desc>
1428	A string representing the package type of this product. The
1429	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1430	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1431	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1432	this.
1433	</desc>
1434	</attribute>
1435
1436	<attribute name="APIVersion" type="wstring" readonly="yes">
1437	<desc>
1438	A string representing the VirtualBox API version number. The format is
1439	2 integer numbers divided by an underscore (e.g. 1_0). After the
1440	first public release of packages with a particular API version the
1441	API will not be changed in an incompatible way. Note that this
1442	guarantee does not apply to development builds, and also there is no
1443	guarantee that this version is identical to the first two integer
1444	numbers of the package version.
1445	</desc>
1446	</attribute>
1447
1448	<attribute name="homeFolder" type="wstring" readonly="yes">
1449	<desc>
1450	Full path to the directory where the global settings file,
1451	<tt>VirtualBox.xml</tt>, is stored.
1452
1453	In this version of VirtualBox, the value of this property is
1454	always <tt><user_dir>/.VirtualBox</tt> (where
1455	<tt><user_dir></tt> is the path to the user directory,
1456	as determined by the host OS), and cannot be changed.
1457
1458	This path is also used as the base to resolve relative paths in
1459	places where relative paths are allowed (unless otherwise
1460	expressly indicated).
1461	</desc>
1462	</attribute>
1463
1464	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1465	<desc>
1466	Full name of the global settings file.
1467	The value of this property corresponds to the value of
1468	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1469	</desc>
1470	</attribute>
1471
1472	<attribute name="host" type="IHost" readonly="yes">
1473	<desc>Associated host object.</desc>
1474	</attribute>
1475
1476	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1477	<desc>Associated system information object.</desc>
1478	</attribute>
1479
1480	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1481	<desc>
1482	Array of machine objects registered within this VirtualBox instance.
1483	</desc>
1484	</attribute>
1485
1486	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1487	<desc>
1488	Array of medium objects known to this VirtualBox installation.
1489
1490	This array contains only base media. All differencing
1491	media of the given base medium can be enumerated using
1492	<link to="IMedium::children"/>.
1493	</desc>
1494	</attribute>
1495
1496	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1497	<desc>
1498	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1499	</desc>
1500	</attribute>
1501
1502	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1503	<desc>
1504	Array of floppy image objects currently in use by this VirtualBox instance.
1505	</desc>
1506	</attribute>
1507
1508	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1509
1510	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1511
1512	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1513	<desc>
1514	Collection of global shared folders. Global shared folders are
1515	available to all virtual machines.
1516
1517	New shared folders are added to the collection using
1518	<link to="#createSharedFolder"/>. Existing shared folders can be
1519	removed using <link to="#removeSharedFolder"/>.
1520
1521	<note>
1522	In the current version of the product, global shared folders are not
1523	implemented and therefore this collection is always empty.
1524	</note>
1525	</desc>
1526	</attribute>
1527
1528	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1529	<desc>
1530	Associated performance collector object.
1531	</desc>
1532	</attribute>
1533
1534	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1535	<desc>
1536	DHCP servers.
1537	</desc>
1538	</attribute>
1539
1540	<attribute name="eventSource" type="IEventSource" readonly="yes">
1541	<desc>
1542	Event source for VirtualBox events.
1543	</desc>
1544	</attribute>
1545
1546	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1547	<desc>
1548	The extension pack manager.
1549	</desc>
1550	</attribute>
1551
1552
1553	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1554	<desc>
1555	Names of all internal networks.
1556	</desc>
1557	</attribute>
1558
1559	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1560	<desc>
1561	Names of all generic network drivers.
1562	</desc>
1563	</attribute>
1564
1565	<method name="composeMachineFilename">
1566	<desc>
1567	Returns a recommended full path of the settings file name for a new virtual
1568	machine.
1569
1570	This API serves two purposes:
1571
1572	<ul>
1573	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1574	for the @a settingsFile argument there, which means that API should use
1575	a recommended default file name.</li>
1576
1577	<li>It can be called manually by a client software before creating a machine,
1578	e.g. if that client wants to pre-create the machine directory to create
1579	virtual hard disks in that directory together with the new machine
1580	settings file. In that case, the file name should be stripped from the
1581	full settings file path returned by this function to obtain the
1582	machine directory.</li>
1583	</ul>
1584
1585	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1586	details about the machine name.
1587
1588	If @a baseFolder is a @c null or empty string (which is recommended), the
1589	default machine settings folder
1590	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1591	a base folder for the created machine, resulting in a file name like
1592	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1593	will be used.
1594
1595	This method does not access the host disks. In particular, it does not check
1596	for whether a machine of this name already exists.
1597	</desc>
1598	<param name="name" type="wstring" dir="in">
1599	<desc>Suggested machine name.</desc>
1600	</param>
1601	<param name="baseFolder" type="wstring" dir="in">
1602	<desc>Base machine folder (optional).</desc>
1603	</param>
1604	<param name="file" type="wstring" dir="return">
1605	<desc>Fully qualified path where the machine would be created.</desc>
1606	</param>
1607	</method>
1608
1609	<method name="createMachine">
1610	<desc>
1611	Creates a new virtual machine by creating a machine settings file at
1612	the given location.
1613
1614	VirtualBox machine settings files use a custom XML dialect. Starting
1615	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1616	and machine files can be created at arbitrary locations.
1617
1618	However, it is is recommended that machines be created in the default
1619	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1620	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1621	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1622	is called automatically to have such a recommended name composed based
1623	on the machine name given in the @a name argument.
1624
1625	If the resulting settings file already exists, this method will fail,
1626	unless @a forceOverwrite is set.
1627
1628	The new machine is created unregistered, with the initial configuration
1629	set according to the specified guest OS type. A typical sequence of
1630	actions to create a new virtual machine is as follows:
1631
1632	<ol>
1633	<li>
1634	Call this method to have a new machine created. The returned machine
1635	object will be "mutable" allowing to change any machine property.
1636	</li>
1637
1638	<li>
1639	Configure the machine using the appropriate attributes and methods.
1640	</li>
1641
1642	<li>
1643	Call <link to="IMachine::saveSettings" /> to write the settings
1644	to the machine's XML settings file. The configuration of the newly
1645	created machine will not be saved to disk until this method is
1646	called.
1647	</li>
1648
1649	<li>
1650	Call <link to="#registerMachine" /> to add the machine to the list
1651	of machines known to VirtualBox.
1652	</li>
1653	</ol>
1654
1655	The specified guest OS type identifier must match an ID of one of known
1656	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1657	array.
1658
1659	Optionally, you may specify an UUID of to assign to the created machine.
1660	However, this is not recommended and you should normally pass an empty
1661	(@c null) UUID to this method so that a new UUID will be automatically
1662	generated for every created machine. You can use UUID
1663	00000000-0000-0000-0000-000000000000 as @c null value.
1664
1665	<note>
1666	There is no way to change the name of the settings file or
1667	subfolder of the created machine directly.
1668	</note>
1669
1670	<result name="VBOX_E_OBJECT_NOT_FOUND">
1671	@a osTypeId is invalid.
1672	</result>
1673	<result name="VBOX_E_FILE_ERROR">
1674	Resulting settings file name is invalid or the settings file already
1675	exists or could not be created due to an I/O error.
1676	</result>
1677	<result name="E_INVALIDARG">
1678	@a name is empty or @c null.
1679	</result>
1680	</desc>
1681
1682	<param name="settingsFile" type="wstring" dir="in">
1683	<desc>Fully qualified path where the settings file should be created,
1684	or NULL for a default folder and file based on the @a name argument
1685	(see <link to="#composeMachineFilename" />).</desc>
1686	</param>
1687	<param name="name" type="wstring" dir="in">
1688	<desc>Machine name.</desc>
1689	</param>
1690	<param name="osTypeId" type="wstring" dir="in">
1691	<desc>Guest OS Type ID.</desc>
1692	</param>
1693	<param name="id" type="uuid" mod="string" dir="in">
1694	<desc>Machine UUID (optional).</desc>
1695	</param>
1696	<param name="forceOverwrite" type="boolean" dir="in">
1697	<desc>If true, an existing machine settings file will be overwritten.</desc>
1698	</param>
1699	<param name="machine" type="IMachine" dir="return">
1700	<desc>Created machine object.</desc>
1701	</param>
1702	</method>
1703
1704	<method name="openMachine">
1705	<desc>
1706	Opens a virtual machine from the existing settings file.
1707	The opened machine remains unregistered until you call
1708	<link to="#registerMachine"/>.
1709
1710	The specified settings file name must be fully qualified.
1711	The file must exist and be a valid machine XML settings file
1712	whose contents will be used to construct the machine object.
1713
1714	<result name="VBOX_E_FILE_ERROR">
1715	Settings file name invalid, not found or sharing violation.
1716	</result>
1717	</desc>
1718	<param name="settingsFile" type="wstring" dir="in">
1719	<desc>
1720	Name of the machine settings file.
1721	</desc>
1722	</param>
1723	<param name="machine" type="IMachine" dir="return">
1724	<desc>Opened machine object.</desc>
1725	</param>
1726	<note>
1727	<link to="IMachine::settingsModified"/> will return
1728	@c false for the created machine, until any of machine settings
1729	are changed.
1730	</note>
1731	</method>
1732
1733	<method name="registerMachine">
1734	<desc>
1735
1736	Registers the machine previously created using
1737	<link to="#createMachine"/> or opened using
1738	<link to="#openMachine"/> within this VirtualBox installation. After
1739	successful method invocation, the
1740	<link to="IMachineRegisteredEvent"/> event is fired.
1741
1742	<note>
1743	This method implicitly calls <link to="IMachine::saveSettings"/>
1744	to save all current machine settings before registering it.
1745	</note>
1746
1747	<result name="VBOX_E_OBJECT_NOT_FOUND">
1748	No matching virtual machine found.
1749	</result>
1750	<result name="VBOX_E_INVALID_OBJECT_STATE">
1751	Virtual machine was not created within this VirtualBox instance.
1752	</result>
1753
1754	</desc>
1755	<param name="machine" type="IMachine" dir="in"/>
1756	</method>
1757
1758	<method name="findMachine">
1759	<desc>
1760	Attempts to find a virtual machine given its name or UUID.
1761
1762	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1763	cannot safely be determined.</note>
1764
1765	<result name="VBOX_E_OBJECT_NOT_FOUND">
1766	Could not find registered machine matching @a nameOrId.
1767	</result>
1768
1769	</desc>
1770	<param name="nameOrId" type="wstring" dir="in">
1771	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1772	</param>
1773	<param name="machine" type="IMachine" dir="return">
1774	<desc>Machine object, if found.</desc>
1775	</param>
1776	</method>
1777
1778	<method name="createAppliance">
1779	<desc>
1780	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1781	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1782	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1783	</desc>
1784	<param name="appliance" type="IAppliance" dir="return">
1785	<desc>New appliance.</desc>
1786	</param>
1787	</method>
1788
1789	<method name="createHardDisk">
1790	<desc>
1791	Creates a new base medium object that will use the given storage
1792	format and location for medium data.
1793
1794	The actual storage unit is not created by this method. In order to
1795	do it, and before you are able to attach the created medium to
1796	virtual machines, you must call one of the following methods to
1797	allocate a format-specific storage unit at the specified location:
1798	<ul>
1799	<li><link to="IMedium::createBaseStorage"/></li>
1800	<li><link to="IMedium::createDiffStorage"/></li>
1801	</ul>
1802
1803	Some medium attributes, such as <link to="IMedium::id"/>, may
1804	remain uninitialized until the medium storage unit is successfully
1805	created by one of the above methods.
1806
1807	After the storage unit is successfully created, it will be
1808	accessible through the <link to="#findMedium"/> method and can
1809	be found in the <link to="#hardDisks"/> array.
1810
1811	The list of all storage formats supported by this VirtualBox
1812	installation can be obtained using
1813	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1814	attribute is empty or @c null then the default storage format
1815	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1816	be used for creating a storage unit of the medium.
1817
1818	Note that the format of the location string is storage format specific.
1819	See <link to="IMedium::location"/> and IMedium for more details.
1820
1821	<result name="VBOX_E_OBJECT_NOT_FOUND">
1822	@a format identifier is invalid. See
1823	<link to="ISystemProperties::mediumFormats"/>.
1824	</result>
1825	<result name="VBOX_E_FILE_ERROR">
1826	@a location is a not valid file name (for file-based formats only).
1827	</result>
1828	</desc>
1829	<param name="format" type="wstring" dir="in">
1830	<desc>
1831	Identifier of the storage format to use for the new medium.
1832	</desc>
1833	</param>
1834	<param name="location" type="wstring" dir="in">
1835	<desc>
1836	Location of the storage unit for the new medium.
1837	</desc>
1838	</param>
1839	<param name="medium" type="IMedium" dir="return">
1840	<desc>Created medium object.</desc>
1841	</param>
1842	</method>
1843
1844	<method name="openMedium">
1845	<desc>
1846	Opens a medium from an existing storage location.
1847
1848	Once a medium has been opened, it can be passed to other VirtualBox
1849	methods, in particular to <link to="IMachine::attachDevice" />.
1850
1851	Depending on the given device type, the file at the storage location
1852	must be in one of the media formats understood by VirtualBox:
1853
1854	<ul>
1855	<li>With a "HardDisk" device type, the file must be a hard disk image
1856	in one of the formats supported by VirtualBox (see
1857	<link to="ISystemProperties::mediumFormats" />).
1858	After this method succeeds, if the medium is a base medium, it
1859	will be added to the <link to="#hardDisks"/> array attribute. </li>
1860	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1861	After this method succeeds, the medium will be added to the
1862	<link to="#DVDImages"/> array attribute.</li>
1863	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1864	After this method succeeds, the medium will be added to the
1865	<link to="#floppyImages"/> array attribute.</li>
1866	</ul>
1867
1868	After having been opened, the medium can be found by the <link to="#findMedium"/>
1869	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1870
1871	The UUID of the newly opened medium will either be retrieved from the
1872	storage location, if the format supports it (e.g. for hard disk images),
1873	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1874	If for some reason you need to change the medium's UUID, use
1875	<link to="IMedium::setIDs" />.
1876
1877	If a differencing hard disk medium is to be opened by this method, the
1878	operation will succeed only if its parent medium and all ancestors,
1879	if any, are already known to this VirtualBox installation (for example,
1880	were opened by this method before).
1881
1882	This method attempts to guess the storage format of the specified medium
1883	by reading medium data at the specified location.
1884
1885	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1886	the image is opened for read/write access and must have according permissions,
1887	as VirtualBox may actually write status information into the disk's metadata
1888	sections.
1889
1890	Note that write access is required for all typical hard disk usage in VirtualBox,
1891	since VirtualBox may need to write metadata such as a UUID into the image.
1892	The only exception is opening a source image temporarily for copying and
1893	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1894	again soon.
1895
1896	The format of the location string is storage format specific. See
1897	<link to="IMedium::location"/> and IMedium for more details.
1898
1899	<result name="VBOX_E_FILE_ERROR">
1900	Invalid medium storage file location or could not find the medium
1901	at the specified location.
1902	</result>
1903	<result name="VBOX_E_IPRT_ERROR">
1904	Could not get medium storage format.
1905	</result>
1906	<result name="E_INVALIDARG">
1907	Invalid medium storage format.
1908	</result>
1909	<result name="VBOX_E_INVALID_OBJECT_STATE">
1910	Medium has already been added to a media registry.
1911	</result>
1912	</desc>
1913	<param name="location" type="wstring" dir="in">
1914	<desc>
1915	Location of the storage unit that contains medium data in one of
1916	the supported storage formats.
1917	</desc>
1918	</param>
1919	<param name="deviceType" type="DeviceType" dir="in">
1920	<desc>
1921	Must be one of "HardDisk", "DVD" or "Floppy".
1922	</desc>
1923	</param>
1924	<param name="accessMode" type="AccessMode" dir="in">
1925	<desc>Whether to open the image in read/write or read-only mode. For
1926	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1927	</param>
1928	<param name="forceNewUuid" type="boolean" dir="in">
1929	<desc>Allows the caller to request a completely new medium UUID for
1930	the image which is to be opened. Useful if one intends to open an exact
1931	copy of a previously opened image, as this would normally fail due to
1932	the duplicate UUID.</desc>
1933	</param>
1934	<param name="medium" type="IMedium" dir="return">
1935	<desc>Opened medium object.</desc>
1936	</param>
1937	</method>
1938
1939	<method name="findMedium">
1940	<desc>
1941	Returns a medium of the given type that uses the given fully qualified
1942	location or UUID to store medium data.
1943
1944	The given medium must be known to this VirtualBox installation, i.e.
1945	it must be previously created by <link to="#createHardDisk"/> or opened
1946	by <link to="#openMedium"/>.
1947
1948	The search is done by comparing the value of the @a location argument to
1949	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1950	attributes of each known medium.
1951
1952	On case sensitive file systems, a case sensitive comparison is performed,
1953	otherwise the case of symbols in the file path is ignored.
1954
1955	<result name="VBOX_E_OBJECT_NOT_FOUND">
1956	No medium object matching @a location found.
1957	</result>
1958	</desc>
1959	<param name="location" type="wstring" dir="in">
1960	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1961	</param>
1962	<param name="type" type="DeviceType" dir="in">
1963	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1964	</param>
1965	<param name="medium" type="IMedium" dir="return">
1966	<desc>Medium object, if found.</desc>
1967	</param>
1968	</method>
1969
1970	<method name="getGuestOSType">
1971	<desc>
1972	Returns an object describing the specified guest OS type.
1973
1974	The requested guest OS type is specified using a string which is a
1975	mnemonic identifier of the guest operating system, such as
1976	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1977	particular virtual machine can be read or set using the
1978	<link to="IMachine::OSTypeId"/> attribute.
1979
1980	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1981	available guest OS type objects. Each object has an
1982	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1983	the guest OS this object describes.
1984
1985	<result name="E_INVALIDARG">
1986	@a id is not a valid Guest OS type.
1987	</result>
1988
1989	</desc>
1990	<param name="id" type="uuid" mod="string" dir="in">
1991	<desc>Guest OS type ID string.</desc>
1992	</param>
1993	<param name="type" type="IGuestOSType" dir="return">
1994	<desc>Guest OS type object.</desc>
1995	</param>
1996	</method>
1997
1998	<method name="createSharedFolder">
1999	<desc>
2000	Creates a new global shared folder by associating the given logical
2001	name with the given host path, adds it to the collection of shared
2002	folders and starts sharing it. Refer to the description of
2003	<link to="ISharedFolder"/> to read more about logical names.
2004	<note>
2005	In the current implementation, this operation is not
2006	implemented.
2007	</note>
2008	</desc>
2009	<param name="name" type="wstring" dir="in">
2010	<desc>Unique logical name of the shared folder.</desc>
2011	</param>
2012	<param name="hostPath" type="wstring" dir="in">
2013	<desc>Full path to the shared folder in the host file system.</desc>
2014	</param>
2015	<param name="writable" type="boolean" dir="in">
2016	<desc>Whether the share is writable or readonly</desc>
2017	</param>
2018	<param name="automount" type="boolean" dir="in">
2019	<desc>Whether the share gets automatically mounted by the guest
2020	or not.</desc>
2021	</param>
2022	</method>
2023
2024	<method name="removeSharedFolder">
2025	<desc>
2026	Removes the global shared folder with the given name previously
2027	created by <link to="#createSharedFolder"/> from the collection of
2028	shared folders and stops sharing it.
2029	<note>
2030	In the current implementation, this operation is not
2031	implemented.
2032	</note>
2033	</desc>
2034	<param name="name" type="wstring" dir="in">
2035	<desc>Logical name of the shared folder to remove.</desc>
2036	</param>
2037	</method>
2038
2039	<method name="getExtraDataKeys">
2040	<desc>
2041	Returns an array representing the global extra data keys which currently
2042	have values defined.
2043	</desc>
2044	<param name="value" type="wstring" dir="return" safearray="yes">
2045	<desc>Array of extra data keys.</desc>
2046	</param>
2047	</method>
2048
2049	<method name="getExtraData">
2050	<desc>
2051	Returns associated global extra data.
2052
2053	If the requested data @a key does not exist, this function will
2054	succeed and return an empty string in the @a value argument.
2055
2056	<result name="VBOX_E_FILE_ERROR">
2057	Settings file not accessible.
2058	</result>
2059	<result name="VBOX_E_XML_ERROR">
2060	Could not parse the settings file.
2061	</result>
2062
2063	</desc>
2064	<param name="key" type="wstring" dir="in">
2065	<desc>Name of the data key to get.</desc>
2066	</param>
2067	<param name="value" type="wstring" dir="return">
2068	<desc>Value of the requested data key.</desc>
2069	</param>
2070	</method>
2071
2072	<method name="setExtraData">
2073	<desc>
2074	Sets associated global extra data.
2075
2076	If you pass @c null or empty string as a key @a value, the given @a key
2077	will be deleted.
2078
2079	<note>
2080	Before performing the actual data change, this method will ask all
2081	registered event listener using the
2082	<link to="IExtraDataCanChangeEvent"/>
2083	notification for a permission. If one of the listeners refuses the
2084	new value, the change will not be performed.
2085	</note>
2086	<note>
2087	On success, the
2088	<link to="IExtraDataChangedEvent"/> notification
2089	is called to inform all registered listeners about a successful data
2090	change.
2091	</note>
2092
2093	<result name="VBOX_E_FILE_ERROR">
2094	Settings file not accessible.
2095	</result>
2096	<result name="VBOX_E_XML_ERROR">
2097	Could not parse the settings file.
2098	</result>
2099	<result name="E_ACCESSDENIED">
2100	Modification request refused.
2101	</result>
2102
2103	</desc>
2104	<param name="key" type="wstring" dir="in">
2105	<desc>Name of the data key to set.</desc>
2106	</param>
2107	<param name="value" type="wstring" dir="in">
2108	<desc>Value to assign to the key.</desc>
2109	</param>
2110	</method>
2111
2112	<!--method name="createDHCPServerForInterface">
2113	<desc>
2114	Creates a dhcp server settings to be used for the given interface
2115	<result name="E_INVALIDARG">
2116	Host network interface @a name already exists.
2117	</result>
2118	</desc>
2119	<param name="interface" type="IHostNetworkInterface" dir="in">
2120	<desc>Network Interface</desc>
2121	</param>
2122	<param name="server" type="IDHCPServer" dir="out">
2123	<desc>Dhcp server settings</desc>
2124	</param>
2125	</method-->
2126
2127	<method name="createDHCPServer">
2128	<desc>
2129	Creates a dhcp server settings to be used for the given internal network name
2130	<result name="E_INVALIDARG">
2131	Host network interface @a name already exists.
2132	</result>
2133	</desc>
2134	<param name="name" type="wstring" dir="in">
2135	<desc>server name</desc>
2136	</param>
2137	<param name="server" type="IDHCPServer" dir="return">
2138	<desc>Dhcp server settings</desc>
2139	</param>
2140	</method>
2141
2142	<method name="findDHCPServerByNetworkName">
2143	<desc>
2144	Searches a dhcp server settings to be used for the given internal network name
2145	<result name="E_INVALIDARG">
2146	Host network interface @a name already exists.
2147	</result>
2148
2149	</desc>
2150	<param name="name" type="wstring" dir="in">
2151	<desc>server name</desc>
2152	</param>
2153	<param name="server" type="IDHCPServer" dir="return">
2154	<desc>Dhcp server settings</desc>
2155	</param>
2156	</method>
2157
2158	<!--method name="findDHCPServerForInterface">
2159	<desc>
2160	Searches a dhcp server settings to be used for the given interface
2161	<result name="E_INVALIDARG">
2162	Host network interface @a name already exists.
2163	</result>
2164	</desc>
2165	<param name="interface" type="IHostNetworkInterface" dir="in">
2166	<desc>Network Interface</desc>
2167	</param>
2168	<param name="server" type="IDHCPServer" dir="out">
2169	<desc>Dhcp server settings</desc>
2170	</param>
2171	</method-->
2172
2173	<method name="removeDHCPServer">
2174	<desc>
2175	Removes the dhcp server settings
2176	<result name="E_INVALIDARG">
2177	Host network interface @a name already exists.
2178	</result>
2179	</desc>
2180	<param name="server" type="IDHCPServer" dir="in">
2181	<desc>Dhcp server settings to be removed</desc>
2182	</param>
2183	</method>
2184
2185
2186	<method name="checkFirmwarePresent">
2187	<desc>
2188	Check if this VirtualBox installation has a firmware
2189	of the given type available, either system-wide or per-user.
2190	Optionally, this may return a hint where this firmware can be
2191	downloaded from.
2192	</desc>
2193	<param name="firmwareType" type="FirmwareType" dir="in">
2194	<desc>
2195	Type of firmware to check.
2196	</desc>
2197	</param>
2198	<param name="version" type="wstring" dir="in">
2199	<desc>Expected version number, usually empty string (presently ignored).</desc>
2200	</param>
2201
2202	<param name="url" type="wstring" dir="out">
2203	<desc>
2204	Suggested URL to download this firmware from.
2205	</desc>
2206	</param>
2207
2208	<param name="file" type="wstring" dir="out">
2209	<desc>
2210	Filename of firmware, only valid if result == TRUE.
2211	</desc>
2212	</param>
2213
2214	<param name="result" type="boolean" dir="return">
2215	<desc>If firmware of this type and version is available.</desc>
2216	</param>
2217	</method>
2218
2219	</interface>
2220
2221	<!--
2222	// IVFSExplorer
2223	/////////////////////////////////////////////////////////////////////////
2224	-->
2225
2226	<enum
2227	name="VFSType"
2228	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2229	>
2230	<desc>
2231	Virtual file systems supported by VFSExplorer.
2232	</desc>
2233
2234	<const name="File" value="1" />
2235	<const name="Cloud" value="2" />
2236	<const name="S3" value="3" />
2237	<const name="WebDav" value="4" />
2238	</enum>
2239
2240	<enum
2241	name="VFSFileType"
2242	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2243	>
2244	<desc>
2245	File types known by VFSExplorer.
2246	</desc>
2247
2248	<const name="Unknown" value="1" />
2249	<const name="Fifo" value="2" />
2250	<const name="DevChar" value="3" />
2251	<const name="Directory" value="4" />
2252	<const name="DevBlock" value="5" />
2253	<const name="File" value="6" />
2254	<const name="SymLink" value="7" />
2255	<const name="Socket" value="8" />
2256	<const name="WhiteOut" value="9" />
2257	</enum>
2258
2259	<interface
2260	name="IVFSExplorer" extends="$unknown"
2261	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2262	wsmap="managed"
2263	>
2264	<desc>
2265	The VFSExplorer interface unifies access to different file system
2266	types. This includes local file systems as well remote file systems like
2267	S3. For a list of supported types see <link to="VFSType" />.
2268	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2269	</desc>
2270
2271	<attribute name="path" type="wstring" readonly="yes">
2272	<desc>Returns the current path in the virtual file system.</desc>
2273	</attribute>
2274
2275	<attribute name="type" type="VFSType" readonly="yes">
2276	<desc>Returns the file system type which is currently in use.</desc>
2277	</attribute>
2278
2279	<method name="update">
2280	<desc>Updates the internal list of files/directories from the
2281	current directory level. Use <link to="#entryList" /> to get the full list
2282	after a call to this method.</desc>
2283
2284	<param name="aProgress" type="IProgress" dir="return">
2285	<desc>Progress object to track the operation completion.</desc>
2286	</param>
2287	</method>
2288
2289	<method name="cd">
2290	<desc>Change the current directory level.</desc>
2291
2292	<param name="aDir" type="wstring" dir="in">
2293	<desc>The name of the directory to go in.</desc>
2294	</param>
2295
2296	<param name="aProgress" type="IProgress" dir="return">
2297	<desc>Progress object to track the operation completion.</desc>
2298	</param>
2299	</method>
2300
2301	<method name="cdUp">
2302	<desc>Go one directory upwards from the current directory level.</desc>
2303
2304	<param name="aProgress" type="IProgress" dir="return">
2305	<desc>Progress object to track the operation completion.</desc>
2306	</param>
2307	</method>
2308
2309	<method name="entryList">
2310	<desc>Returns a list of files/directories after a call to <link
2311	to="#update" />. The user is responsible for keeping this internal
2312	list up do date.</desc>
2313
2314	<param name="aNames" type="wstring" safearray="yes" dir="out">
2315	<desc>The list of names for the entries.</desc>
2316	</param>
2317
2318	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2319	<desc>The list of types for the entries.</desc>
2320	</param>
2321
2322	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2323	<desc>The list of sizes (in bytes) for the entries.</desc>
2324	</param>
2325
2326	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2327	<desc>The list of file modes (in octal form) for the entries.</desc>
2328	</param>
2329	</method>
2330
2331	<method name="exists">
2332	<desc>Checks if the given file list exists in the current directory
2333	level.</desc>
2334
2335	<param name="aNames" type="wstring" safearray="yes" dir="in">
2336	<desc>The names to check.</desc>
2337	</param>
2338
2339	<param name="aExists" type="wstring" safearray="yes" dir="return">
2340	<desc>The names which exist.</desc>
2341	</param>
2342	</method>
2343
2344	<method name="remove">
2345	<desc>Deletes the given files in the current directory level.</desc>
2346
2347	<param name="aNames" type="wstring" safearray="yes" dir="in">
2348	<desc>The names to remove.</desc>
2349	</param>
2350
2351	<param name="aProgress" type="IProgress" dir="return">
2352	<desc>Progress object to track the operation completion.</desc>
2353	</param>
2354	</method>
2355
2356	</interface>
2357
2358	<enum
2359	name="ImportOptions" extends="$unknown"
2360	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2361	>
2362
2363	<desc>
2364	Import options, used with <link to="IAppliance::importMachines" />.
2365	</desc>
2366
2367	<const name="KeepAllMACs" value="1">
2368	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2369	</const>
2370	<const name="KeepNATMACs" value="2">
2371	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2372	</const>
2373
2374	</enum>
2375
2376
2377	<!--
2378	// IAppliance
2379	/////////////////////////////////////////////////////////////////////////
2380	-->
2381
2382	<interface
2383	name="IAppliance" extends="$unknown"
2384	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2385	wsmap="managed"
2386	>
2387	<desc>
2388	Represents a platform-independent appliance in OVF format. An instance of this is returned
2389	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2390	virtual machines within an appliance with VirtualBox.
2391
2392	The OVF standard suggests two different physical file formats:
2393
2394	<ol>
2395	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2396	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2397	this descriptor file references other files such as disk images, as OVF appliances typically
2398	do, those additional files must be in the same directory as the descriptor file.</li>
2399
2400	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2401	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2402	files and optionally other files.
2403
2404	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2405	be added with a later version.</li>
2406	</ol>
2407
2408	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2409	<link to="IMachine" /> involves the following sequence of API calls:
2410
2411	<ol>
2412	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2413	</li>
2414
2415	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2416	would like to import. So long as this file is syntactically valid, this will succeed
2417	and fill the appliance object with the parsed data from the OVF file.
2418	</li>
2419
2420	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2421	contents of the IAppliance attributes accordingly. These can be inspected by a
2422	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2423	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2424	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2425	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2426	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2427	The GUI can then give the user the option to confirm and/or change these suggestions.
2428	</li>
2429
2430	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2431	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2432	</li>
2433
2434	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2435	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2436	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2437	can be found in the <link to="#machines" /> array attribute.
2438	</li>
2439	</ol>
2440
2441	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2442
2443	<ol>
2444	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2445	an empty IAppliance object.
2446	</li>
2447
2448	<li>For each machine you would like to export, call <link to="IMachine::export" />
2449	with the IAppliance object you just created. Each such call creates one instance of
2450	<link to="IVirtualSystemDescription" /> inside the appliance.
2451	</li>
2452
2453	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2454	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2455	</li>
2456
2457	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2458	file written.</li>
2459	</ol>
2460
2461	</desc>
2462
2463	<attribute name="path" type="wstring" readonly="yes">
2464	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2465	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2466	<link to="#write" /> (for export).
2467	This attribute is empty until one of these methods has been called.
2468	</desc>
2469	</attribute>
2470
2471	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2472	<desc>
2473	Array of virtual disk definitions. One such description exists for each
2474	disk definition in the OVF; each string array item represents one such piece of
2475	disk information, with the information fields separated by tab (\\t) characters.
2476
2477	The caller should be prepared for additional fields being appended to
2478	this string in future versions of VirtualBox and therefore check for
2479	the number of tabs in the strings returned.
2480
2481	In the current version, the following eight fields are returned per string
2482	in the array:
2483
2484	<ol>
2485	<li>Disk ID (unique string identifier given to disk)</li>
2486
2487	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2488
2489	<li>Populated size (optional unsigned integer indicating the current size of the
2490	disk; can be approximate; -1 if unspecified)</li>
2491
2492	<li>Format (string identifying the disk format, typically
2493	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2494
2495	<li>Reference (where to find the disk image, typically a file name; if empty,
2496	then the disk should be created on import)</li>
2497
2498	<li>Image size (optional unsigned integer indicating the size of the image,
2499	which need not necessarily be the same as the values specified above, since
2500	the image may be compressed or sparse; -1 if not specified)</li>
2501
2502	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2503	presently unsupported and always -1)</li>
2504
2505	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2506	</ol>
2507	</desc>
2508	</attribute>
2509
2510	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2511	<desc> Array of virtual system descriptions. One such description is created
2512	for each virtual system (machine) found in the OVF.
2513	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2514	(for export) has been called.
2515	</desc>
2516	</attribute>
2517
2518	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2519	<desc>
2520	Contains the UUIDs of the machines created from the information in this appliances. This is only
2521	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2522	succeeded.
2523	</desc>
2524	</attribute>
2525
2526	<method name="read">
2527	<desc>
2528	Reads an OVF file into the appliance object.
2529
2530	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2531	mere fact that this method returns successfully does not mean that VirtualBox supports all
2532	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2533	</desc>
2534	<param name="file" type="wstring" dir="in">
2535	<desc>
2536	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2537	on whether the appliance is distributed as a set of files or as a single file, respectively).
2538	</desc>
2539	</param>
2540	<param name="aProgress" type="IProgress" dir="return">
2541	<desc>Progress object to track the operation completion.</desc>
2542	</param>
2543	</method>
2544
2545	<method name="interpret">
2546	<desc>
2547	Interprets the OVF data that was read when the appliance was constructed. After
2548	calling this method, one can inspect the
2549	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2550	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2551	the appliance.
2552
2553	Calling this method is the second step of importing an appliance into VirtualBox;
2554	see <link to="IAppliance" /> for an overview.
2555
2556	After calling this method, one should call <link to="#getWarnings" /> to find out
2557	if problems were encountered during the processing which might later lead to
2558	errors.
2559	</desc>
2560	</method>
2561
2562	<method name="importMachines">
2563	<desc>
2564	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2565	and other interfaces that match the information contained in the appliance as
2566	closely as possible, as represented by the import instructions in the
2567	<link to="#virtualSystemDescriptions" /> array.
2568
2569	Calling this method is the final step of importing an appliance into VirtualBox;
2570	see <link to="IAppliance" /> for an overview.
2571
2572	Since importing the appliance will most probably involve copying and converting
2573	disk images, which can take a long time, this method operates asynchronously and
2574	returns an IProgress object to allow the caller to monitor the progress.
2575
2576	After the import succeeded, the UUIDs of the IMachine instances created can be
2577	retrieved from the <link to="#machines" /> array attribute.
2578	</desc>
2579
2580	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2581	<desc>Options for the importing operation.</desc>
2582	</param>
2583
2584	<param name="aProgress" type="IProgress" dir="return">
2585	<desc>Progress object to track the operation completion.</desc>
2586	</param>
2587	</method>
2588
2589	<method name="createVFSExplorer">
2590	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2591
2592	<param name="aUri" type="wstring" dir="in">
2593	<desc>The URI describing the file system to use.</desc>
2594	</param>
2595
2596	<param name="aExplorer" type="IVFSExplorer" dir="return">
2597	<desc></desc>
2598	</param>
2599	</method>
2600
2601	<method name="write">
2602	<desc>
2603	Writes the contents of the appliance exports into a new OVF file.
2604
2605	Calling this method is the final step of exporting an appliance from VirtualBox;
2606	see <link to="IAppliance" /> for an overview.
2607
2608	Since exporting the appliance will most probably involve copying and converting
2609	disk images, which can take a long time, this method operates asynchronously and
2610	returns an IProgress object to allow the caller to monitor the progress.
2611	</desc>
2612	<param name="format" type="wstring" dir="in">
2613	<desc>
2614	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2615	future versions of VirtualBox may support additional formats.
2616	</desc>
2617	</param>
2618	<param name="manifest" type="boolean" dir="in">
2619	<desc>
2620	Indicate if the optional manifest file (.mf) should be written. The manifest file
2621	is used for integrity checks prior import.
2622	</desc>
2623	</param>
2624	<param name="path" type="wstring" dir="in">
2625	<desc>
2626	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2627	on whether the appliance is distributed as a set of files or as a single file, respectively).
2628	</desc>
2629	</param>
2630	<param name="progress" type="IProgress" dir="return">
2631	<desc>Progress object to track the operation completion.</desc>
2632	</param>
2633	</method>
2634
2635	<method name="getWarnings">
2636	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2637
2638	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2639	<desc></desc>
2640	</param>
2641	</method>
2642
2643	</interface>
2644
2645	<enum
2646	name="VirtualSystemDescriptionType"
2647	uuid="303c0900-a746-4612-8c67-79003e91f459"
2648	>
2649	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2650	a configuration value.</desc>
2651
2652	<const name="Ignore" value="1" />
2653	<const name="OS" value="2" />
2654	<const name="Name" value="3" />
2655	<const name="Product" value="4" />
2656	<const name="Vendor" value="5" />
2657	<const name="Version" value="6" />
2658	<const name="ProductUrl" value="7" />
2659	<const name="VendorUrl" value="8" />
2660	<const name="Description" value="9" />
2661	<const name="License" value="10" />
2662	<const name="Miscellaneous" value="11" />
2663	<const name="CPU" value="12" />
2664	<const name="Memory" value="13" />
2665	<const name="HardDiskControllerIDE" value="14" />
2666	<const name="HardDiskControllerSATA" value="15" />
2667	<const name="HardDiskControllerSCSI" value="16" />
2668	<const name="HardDiskControllerSAS" value="17" />
2669	<const name="HardDiskImage" value="18" />
2670	<const name="Floppy" value="19" />
2671	<const name="CDROM" value="20" />
2672	<const name="NetworkAdapter" value="21" />
2673	<const name="USBController" value="22" />
2674	<const name="SoundCard" value="23" />
2675	<const name="SettingsFile" value="24">
2676	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2677	</const>
2678	</enum>
2679
2680	<enum
2681	name="VirtualSystemDescriptionValueType"
2682	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2683	>
2684	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2685	type to fetch.</desc>
2686
2687	<const name="Reference" value="1" />
2688	<const name="Original" value="2" />
2689	<const name="Auto" value="3" />
2690	<const name="ExtraConfig" value="4" />
2691
2692	</enum>
2693
2694	<interface
2695	name="IVirtualSystemDescription" extends="$unknown"
2696	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2697	wsmap="managed"
2698	>
2699
2700	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2701	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2702	<link to="IAppliance::interpret" /> has been called, that array contains information
2703	about how the virtual systems described in the OVF should best be imported into
2704	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2705	import an OVF into VirtualBox.
2706	</desc>
2707
2708	<attribute name="count" type="unsigned long" readonly="yes">
2709	<desc>Return the number of virtual system description entries.</desc>
2710	</attribute>
2711
2712	<method name="getDescription">
2713	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2714	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2715
2716	The list below identifies the value sets that are possible depending on the
2717	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2718	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2719	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2720	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2721	the @a aExtraConfigValues[] array item may also be used.
2722
2723	<ul>
2724	<li>
2725	"OS": the guest operating system type. There must be exactly one such array item on import. The
2726	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2727	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2728	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2729	</li>
2730	<li>
2731	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2732	if none is present on import, then an automatic name will be created from the operating system
2733	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2734	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2735	<link to="IMachine" /> name that does not exist yet.
2736	</li>
2737	<li>
2738	"Description": an arbitrary description.
2739	</li>
2740	<li>
2741	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2742	code to display such a license for agreement; the Main API does not enforce any such policy.
2743	</li>
2744	<li>
2745	Miscellaneous: reserved for future use.
2746	</li>
2747	<li>
2748	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2749	</li>
2750	<li>
2751	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2752	is present on import, then VirtualBox will set a meaningful default based on the operating system
2753	type.
2754	</li>
2755	<li>
2756	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2757	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2758	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2759	writes into the OVF.
2760	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2761	type can use to specify which hard disk controller a virtual disk should be connected to.
2762	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2763	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2764	its virtual machines supports four channels (primary master, primary slave, secondary master,
2765	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2766	</li>
2767	<li>
2768	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2769	has no value in @a aOvfValues[] or @a aVBoxValues[].
2770	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2771	</li>
2772	<li>
2773	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2774	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2775	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2776	whereas VirtualBox considers it a class of storage controllers of its own; see
2777	<link to="StorageControllerType" />).
2778	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2779	</li>
2780	<li>
2781	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2782	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2783
2784	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2785	a path since the image file should be in the same location as the OVF file itself), whereas the
2786	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2787	hard disk image. This means that on import the image will be copied and converted from the
2788	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2789
2790	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2791	format: "controller=<index>;channel=<c>"
2792	In this string, <index> must be an integer specifying the hard disk controller to connect
2793	the image to. That number must be the index of an array item with one of the hard disk controller
2794	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2795	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2796	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2797	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2798	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2799	</li>
2800	<li>
2801	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2802	attachment information as with "HardDiskImage" items.
2803	</li>
2804	<li>
2805	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2806	attachment information as with "HardDiskImage" items.
2807	</li>
2808	<li>
2809	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2810	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2811	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2812	</li>
2813	<li>
2814	"USBController": a USB controller. There can be at most one such item. If and only if such an
2815	item ispresent, USB support will be enabled for the new virtual machine.
2816	</li>
2817	<li>
2818	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2819	present, sound support will be enabled for the new virtual machine. Note that the virtual
2820	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2821	may be different from the virtual soundcard expected by the appliance.
2822	</li>
2823	</ul>
2824
2825	</desc>
2826
2827	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2828	<desc></desc>
2829	</param>
2830
2831	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2832	<desc></desc>
2833	</param>
2834
2835	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2836	<desc></desc>
2837	</param>
2838
2839	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2840	<desc></desc>
2841	</param>
2842
2843	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2844	<desc></desc>
2845	</param>
2846
2847	</method>
2848
2849	<method name="getDescriptionByType">
2850	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2851	should be returned.</desc>
2852
2853	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2854	<desc></desc>
2855	</param>
2856
2857	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2858	<desc></desc>
2859	</param>
2860
2861	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2862	<desc></desc>
2863	</param>
2864
2865	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2866	<desc></desc>
2867	</param>
2868
2869	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2870	<desc></desc>
2871	</param>
2872
2873	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2874	<desc></desc>
2875	</param>
2876
2877	</method>
2878
2879	<method name="getValuesByType">
2880	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2881	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2882	values.</desc>
2883
2884	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2885	<desc></desc>
2886	</param>
2887
2888	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2889	<desc></desc>
2890	</param>
2891
2892	<param name="aValues" type="wstring" dir="return" safearray="yes">
2893	<desc></desc>
2894	</param>
2895
2896	</method>
2897
2898	<method name="setFinalValues">
2899	<desc>
2900	This method allows the appliance's user to change the configuration for the virtual
2901	system descriptions. For each array item returned from <link to="#getDescription" />,
2902	you must pass in one boolean value and one configuration value.
2903
2904	Each item in the boolean array determines whether the particular configuration item
2905	should be enabled.
2906	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2907	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2908	and SoundCard.
2909
2910	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2911	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2912	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2913	for valid configuration values for the individual array item types. If the
2914	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2915	</desc>
2916
2917	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2918	<desc></desc>
2919	</param>
2920
2921	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2922	<desc></desc>
2923	</param>
2924
2925	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2926	<desc></desc>
2927	</param>
2928	</method>
2929
2930	<method name="addDescription">
2931	<desc>
2932	This method adds an additional description entry to the stack of already
2933	available descriptions for this virtual system. This is handy for writing
2934	values which aren't directly supported by VirtualBox. One example would
2935	be the License type of <link to="VirtualSystemDescriptionType" />.
2936	</desc>
2937
2938	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2939	<desc></desc>
2940	</param>
2941
2942	<param name="aVBoxValue" type="wstring" dir="in">
2943	<desc></desc>
2944	</param>
2945
2946	<param name="aExtraConfigValue" type="wstring" dir="in">
2947	<desc></desc>
2948	</param>
2949	</method>
2950	</interface>
2951
2952
2953	<!--
2954	// IMachine
2955	/////////////////////////////////////////////////////////////////////////
2956	-->
2957
2958	<interface
2959	name="IInternalMachineControl" extends="$unknown"
2960	uuid="2087906d-bb92-43a0-8014-4cab009e4888"
2961	internal="yes"
2962	wsmap="suppress"
2963	>
2964	<method name="setRemoveSavedStateFile">
2965	<desc>
2966	Updates the flag whether the saved state file is removed on a
2967	machine state change from Saved to PoweredOff.
2968	</desc>
2969	<param name="aRemove" type="boolean" dir="in"/>
2970	</method>
2971
2972	<method name="updateState">
2973	<desc>
2974	Updates the VM state.
2975	<note>
2976	This operation will also update the settings file with the correct
2977	information about the saved state file and delete this file from disk
2978	when appropriate.
2979	</note>
2980	</desc>
2981	<param name="state" type="MachineState" dir="in"/>
2982	</method>
2983
2984	<method name="getIPCId">
2985	<param name="id" type="wstring" dir="return"/>
2986	</method>
2987
2988	<method name="beginPowerUp">
2989	<desc>
2990	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2991	gives it the progress object that should be part of any pending
2992	<link to="IMachine::launchVMProcess"/> operations. The progress
2993	object may be called back to reflect an early cancelation, so some care
2994	have to be taken with respect to any cancelation callbacks. The console
2995	object will call <link to="IInternalMachineControl::endPowerUp"/>
2996	to signal the completion of the progress object.
2997	</desc>
2998	<param name="aProgress" type="IProgress" dir="in" />
2999	</method>
3000
3001	<method name="endPowerUp">
3002	<desc>
3003	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3004	This method may query status information from the progress object it
3005	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3006	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3007	call in order to complete that progress object.
3008	</desc>
3009	<param name="result" type="long" dir="in"/>
3010	</method>
3011
3012	<method name="beginPoweringDown">
3013	<desc>
3014	Called by the VM process to inform the server it wants to
3015	stop the VM execution and power down.
3016	</desc>
3017	<param name="progress" type="IProgress" dir="out">
3018	<desc>
3019	Progress object created by VBoxSVC to wait until
3020	the VM is powered down.
3021	</desc>
3022	</param>
3023	</method>
3024
3025	<method name="endPoweringDown">
3026	<desc>
3027	Called by the VM process to inform the server that powering
3028	down previously requested by #beginPoweringDown is either
3029	successfully finished or there was a failure.
3030
3031	<result name="VBOX_E_FILE_ERROR">
3032	Settings file not accessible.
3033	</result>
3034	<result name="VBOX_E_XML_ERROR">
3035	Could not parse the settings file.
3036	</result>
3037
3038	</desc>
3039
3040	<param name="result" type="long" dir="in">
3041	<desc>@c S_OK to indicate success.
3042	</desc>
3043	</param>
3044	<param name="errMsg" type="wstring" dir="in">
3045	<desc>@c human readable error message in case of failure.
3046	</desc>
3047	</param>
3048	</method>
3049
3050	<method name="runUSBDeviceFilters">
3051	<desc>
3052	Asks the server to run USB devices filters of the associated
3053	machine against the given USB device and tell if there is
3054	a match.
3055	<note>
3056	Intended to be used only for remote USB devices. Local
3057	ones don't require to call this method (this is done
3058	implicitly by the Host and USBProxyService).
3059	</note>
3060	</desc>
3061	<param name="device" type="IUSBDevice" dir="in"/>
3062	<param name="matched" type="boolean" dir="out"/>
3063	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3064	</method>
3065
3066	<method name="captureUSBDevice">
3067	<desc>
3068	Requests a capture of the given host USB device.
3069	When the request is completed, the VM process will
3070	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3071	notification.
3072	</desc>
3073	<param name="id" type="uuid" mod="string" dir="in"/>
3074	</method>
3075
3076	<method name="detachUSBDevice">
3077	<desc>
3078	Notification that a VM is going to detach (@a done = @c false) or has
3079	already detached (@a done = @c true) the given USB device.
3080	When the @a done = @c true request is completed, the VM process will
3081	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3082	notification.
3083	<note>
3084	In the @a done = @c true case, the server must run its own filters
3085	and filters of all VMs but this one on the detached device
3086	as if it were just attached to the host computer.
3087	</note>
3088	</desc>
3089	<param name="id" type="uuid" mod="string" dir="in"/>
3090	<param name="done" type="boolean" dir="in"/>
3091	</method>
3092
3093	<method name="autoCaptureUSBDevices">
3094	<desc>
3095	Requests a capture all matching USB devices attached to the host.
3096	When the request is completed, the VM process will
3097	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3098	notification per every captured device.
3099	</desc>
3100	</method>
3101
3102	<method name="detachAllUSBDevices">
3103	<desc>
3104	Notification that a VM that is being powered down. The done
3105	parameter indicates whether which stage of the power down
3106	we're at. When @a done = @c false the VM is announcing its
3107	intentions, while when @a done = @c true the VM is reporting
3108	what it has done.
3109	<note>
3110	In the @a done = @c true case, the server must run its own filters
3111	and filters of all VMs but this one on all detach devices as
3112	if they were just attached to the host computer.
3113	</note>
3114	</desc>
3115	<param name="done" type="boolean" dir="in"/>
3116	</method>
3117
3118	<method name="onSessionEnd">
3119	<desc>
3120	Triggered by the given session object when the session is about
3121	to close normally.
3122	</desc>
3123	<param name="session" type="ISession" dir="in">
3124	<desc>Session that is being closed</desc>
3125	</param>
3126	<param name="progress" type="IProgress" dir="return">
3127	<desc>
3128	Used to wait until the corresponding machine is actually
3129	dissociated from the given session on the server.
3130	Returned only when this session is a direct one.
3131	</desc>
3132	</param>
3133	</method>
3134
3135	<method name="beginSavingState">
3136	<desc>
3137	Called by the VM process to inform the server it wants to
3138	save the current state and stop the VM execution.
3139	</desc>
3140	<param name="progress" type="IProgress" dir="out">
3141	<desc>
3142	Progress object created by VBoxSVC to wait until
3143	the state is saved.
3144	</desc>
3145	</param>
3146	<param name="stateFilePath" type="wstring" dir="out">
3147	<desc>
3148	File path the VM process must save the execution state to.
3149	</desc>
3150	</param>
3151	</method>
3152
3153	<method name="endSavingState">
3154	<desc>
3155	Called by the VM process to inform the server that saving
3156	the state previously requested by #beginSavingState is either
3157	successfully finished or there was a failure.
3158
3159	<result name="VBOX_E_FILE_ERROR">
3160	Settings file not accessible.
3161	</result>
3162	<result name="VBOX_E_XML_ERROR">
3163	Could not parse the settings file.
3164	</result>
3165
3166	</desc>
3167
3168	<param name="result" type="long" dir="in">
3169	<desc>@c S_OK to indicate success.
3170	</desc>
3171	</param>
3172	<param name="errMsg" type="wstring" dir="in">
3173	<desc>@c human readable error message in case of failure.
3174	</desc>
3175	</param>
3176	</method>
3177
3178	<method name="adoptSavedState">
3179	<desc>
3180	Gets called by <link to="IConsole::adoptSavedState"/>.
3181	<result name="VBOX_E_FILE_ERROR">
3182	Invalid saved state file path.
3183	</result>
3184	</desc>
3185	<param name="savedStateFile" type="wstring" dir="in">
3186	<desc>Path to the saved state file to adopt.</desc>
3187	</param>
3188	</method>
3189
3190	<method name="beginTakingSnapshot">
3191	<desc>
3192	Called from the VM process to request from the server to perform the
3193	server-side actions of creating a snapshot (creating differencing images
3194	and the snapshot object).
3195
3196	<result name="VBOX_E_FILE_ERROR">
3197	Settings file not accessible.
3198	</result>
3199	<result name="VBOX_E_XML_ERROR">
3200	Could not parse the settings file.
3201	</result>
3202	</desc>
3203	<param name="initiator" type="IConsole" dir="in">
3204	<desc>The console object that initiated this call.</desc>
3205	</param>
3206	<param name="name" type="wstring" dir="in">
3207	<desc>Snapshot name.</desc>
3208	</param>
3209	<param name="description" type="wstring" dir="in">
3210	<desc>Snapshot description.</desc>
3211	</param>
3212	<param name="consoleProgress" type="IProgress" dir="in">
3213	<desc>
3214	Progress object created by the VM process tracking the
3215	snapshot's progress. This has the following sub-operations:
3216	<ul>
3217	<li>setting up (weight 1);</li>
3218	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3219	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3220	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3221	<li>finishing up (weight 1)</li>
3222	</ul>
3223	</desc>
3224	</param>
3225	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3226	<desc>
3227	Whether this is an online snapshot (i.e. the machine is running).
3228	</desc>
3229	</param>
3230	<param name="stateFilePath" type="wstring" dir="out">
3231	<desc>
3232	File path the VM process must save the execution state to.
3233	</desc>
3234	</param>
3235	</method>
3236
3237	<method name="endTakingSnapshot">
3238	<desc>
3239	Called by the VM process to inform the server that the snapshot
3240	previously requested by #beginTakingSnapshot is either
3241	successfully taken or there was a failure.
3242	</desc>
3243
3244	<param name="success" type="boolean" dir="in">
3245	<desc>@c true to indicate success and @c false otherwise</desc>
3246	</param>
3247	</method>
3248
3249	<method name="deleteSnapshot">
3250	<desc>
3251	Gets called by <link to="IConsole::deleteSnapshot"/>,
3252	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3253	<link to="IConsole::deleteSnapshotRange"/>.
3254	<result name="VBOX_E_INVALID_OBJECT_STATE">
3255	Snapshot has more than one child snapshot. Only possible if the
3256	delete operation does not delete all children or the range does
3257	not meet the linearity condition.
3258	</result>
3259	</desc>
3260	<param name="initiator" type="IConsole" dir="in">
3261	<desc>The console object that initiated this call.</desc>
3262	</param>
3263	<param name="startId" type="uuid" mod="string" dir="in">
3264	<desc>UUID of the first snapshot to delete.</desc>
3265	</param>
3266	<param name="endId" type="uuid" mod="string" dir="in">
3267	<desc>UUID of the last snapshot to delete.</desc>
3268	</param>
3269	<param name="deleteAllChildren" type="boolean" dir="in">
3270	<desc>Whether all children should be deleted.</desc>
3271	</param>
3272	<param name="machineState" type="MachineState" dir="out">
3273	<desc>New machine state after this operation is started.</desc>
3274	</param>
3275	<param name="progress" type="IProgress" dir="return">
3276	<desc>Progress object to track the operation completion.</desc>
3277	</param>
3278	</method>
3279
3280	<method name="finishOnlineMergeMedium">
3281	<desc>
3282	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3283	</desc>
3284	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3285	<desc>The medium attachment which needs to be cleaned up.</desc>
3286	</param>
3287	<param name="source" type="IMedium" dir="in">
3288	<desc>Merge source medium.</desc>
3289	</param>
3290	<param name="target" type="IMedium" dir="in">
3291	<desc>Merge target medium.</desc>
3292	</param>
3293	<param name="mergeForward" type="boolean" dir="in">
3294	<desc>Merge direction.</desc>
3295	</param>
3296	<param name="parentForTarget" type="IMedium" dir="in">
3297	<desc>For forward merges: new parent for target medium.</desc>
3298	</param>
3299	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3300	<desc>For backward merges: list of media which need their parent UUID
3301	updated.</desc>
3302	</param>
3303	</method>
3304
3305	<method name="restoreSnapshot">
3306	<desc>
3307	Gets called by <link to="IConsole::restoreSnapshot"/>.
3308	</desc>
3309	<param name="initiator" type="IConsole" dir="in">
3310	<desc>The console object that initiated this call.</desc>
3311	</param>
3312	<param name="snapshot" type="ISnapshot" dir="in">
3313	<desc>The snapshot to restore the VM state from.</desc>
3314	</param>
3315	<param name="machineState" type="MachineState" dir="out">
3316	<desc>New machine state after this operation is started.</desc>
3317	</param>
3318	<param name="progress" type="IProgress" dir="return">
3319	<desc>Progress object to track the operation completion.</desc>
3320	</param>
3321	</method>
3322
3323	<method name="pullGuestProperties">
3324	<desc>
3325	Get the list of the guest properties matching a set of patterns along
3326	with their values, time stamps and flags and give responsibility for
3327	managing properties to the console.
3328	</desc>
3329	<param name="name" type="wstring" dir="out" safearray="yes">
3330	<desc>
3331	The names of the properties returned.
3332	</desc>
3333	</param>
3334	<param name="value" type="wstring" dir="out" safearray="yes">
3335	<desc>
3336	The values of the properties returned. The array entries match the
3337	corresponding entries in the @a name array.
3338	</desc>
3339	</param>
3340	<param name="timestamp" type="long long" dir="out" safearray="yes">
3341	<desc>
3342	The time stamps of the properties returned. The array entries match
3343	the corresponding entries in the @a name array.
3344	</desc>
3345	</param>
3346	<param name="flags" type="wstring" dir="out" safearray="yes">
3347	<desc>
3348	The flags of the properties returned. The array entries match the
3349	corresponding entries in the @a name array.
3350	</desc>
3351	</param>
3352	</method>
3353
3354	<method name="pushGuestProperty">
3355	<desc>
3356	Update a single guest property in IMachine.
3357	</desc>
3358	<param name="name" type="wstring" dir="in">
3359	<desc>
3360	The name of the property to be updated.
3361	</desc>
3362	</param>
3363	<param name="value" type="wstring" dir="in">
3364	<desc>
3365	The value of the property.
3366	</desc>
3367	</param>
3368	<param name="timestamp" type="long long" dir="in">
3369	<desc>
3370	The timestamp of the property.
3371	</desc>
3372	</param>
3373	<param name="flags" type="wstring" dir="in">
3374	<desc>
3375	The flags of the property.
3376	</desc>
3377	</param>
3378	</method>
3379
3380	<method name="lockMedia">
3381	<desc>
3382	Locks all media attached to the machine for writing and parents of
3383	attached differencing media (if any) for reading. This operation is
3384	atomic so that if it fails no media is actually locked.
3385
3386	This method is intended to be called when the machine is in Starting or
3387	Restoring state. The locked media will be automatically unlocked when
3388	the machine is powered off or crashed.
3389	</desc>
3390	</method>
3391	<method name="unlockMedia">
3392	<desc>
3393	Unlocks all media previously locked using
3394	<link to="IInternalMachineControl::lockMedia"/>.
3395
3396	This method is intended to be used with teleportation so that it is
3397	possible to teleport between processes on the same machine.
3398	</desc>
3399	</method>
3400
3401	<method name="ejectMedium">
3402	<desc>
3403	Tells VBoxSVC that the guest has ejected the medium associated with
3404	the medium attachment.
3405	</desc>
3406	<param name="attachment" type="IMediumAttachment" dir="in">
3407	<desc>
3408	The medium attachment where the eject happened.
3409	</desc>
3410	</param>
3411	<param name="newAttachment" type="IMediumAttachment" dir="return">
3412	<desc>
3413	A new reference to the medium attachment, as the config change can
3414	result in the creation of a new instance.
3415	</desc>
3416	</param>
3417	</method>
3418	</interface>
3419
3420	<interface
3421	name="IBIOSSettings" extends="$unknown"
3422	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3423	wsmap="managed"
3424	>
3425	<desc>
3426	The IBIOSSettings interface represents BIOS settings of the virtual
3427	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3428	</desc>
3429	<attribute name="logoFadeIn" type="boolean">
3430	<desc>Fade in flag for BIOS logo animation.</desc>
3431	</attribute>
3432
3433	<attribute name="logoFadeOut" type="boolean">
3434	<desc>Fade out flag for BIOS logo animation.</desc>
3435	</attribute>
3436
3437	<attribute name="logoDisplayTime" type="unsigned long">
3438	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3439	</attribute>
3440
3441	<attribute name="logoImagePath" type="wstring">
3442	<desc>
3443	Local file system path for external BIOS splash image. Empty string
3444	means the default image is shown on boot.
3445	</desc>
3446	</attribute>
3447
3448	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3449	<desc>Mode of the BIOS boot device menu.</desc>
3450	</attribute>
3451
3452	<attribute name="ACPIEnabled" type="boolean">
3453	<desc>ACPI support flag.</desc>
3454	</attribute>
3455
3456	<attribute name="IOAPICEnabled" type="boolean">
3457	<desc>
3458	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3459	and support IRQs above 15.
3460	</desc>
3461	</attribute>
3462
3463	<attribute name="timeOffset" type="long long">
3464	<desc>
3465	Offset in milliseconds from the host system time. This allows for
3466	guests running with a different system date/time than the host.
3467	It is equivalent to setting the system date/time in the BIOS except
3468	it is not an absolute value but a relative one. Guest Additions
3469	time synchronization honors this offset.
3470	</desc>
3471	</attribute>
3472
3473	<attribute name="PXEDebugEnabled" type="boolean">
3474	<desc>
3475	PXE debug logging flag. If set, VirtualBox will write extensive
3476	PXE trace information to the release log.
3477	</desc>
3478	</attribute>
3479
3480	</interface>
3481
3482	<enum
3483	name="CleanupMode"
3484	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3485	>
3486	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3487	</desc>
3488	<const name="UnregisterOnly" value="1">
3489	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3490	</const>
3491	<const name="DetachAllReturnNone" value="2">
3492	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3493	</const>
3494	<const name="DetachAllReturnHardDisksOnly" value="3">
3495	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3496	</const>
3497	<const name="Full" value="4">
3498	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3499	</const>
3500	</enum>
3501
3502	<interface
3503	name="IPciAddress" extends="$unknown"
3504	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3505	wsmap="struct"
3506	>
3507
3508	<desc>
3509	Address on the PCI bus.
3510	</desc>
3511
3512	<attribute name="bus" type="short">
3513	<desc>
3514	Bus number.
3515	</desc>
3516	</attribute>
3517
3518	<attribute name="device" type="short">
3519	<desc>
3520	Device number.
3521	</desc>
3522	</attribute>
3523
3524	<attribute name="devFunction" type="short">
3525	<desc>
3526	Device function number.
3527	</desc>
3528	</attribute>
3529
3530	<method name="asLong">
3531	<desc>
3532	Convert PCI address into long.
3533	</desc>
3534	<param name="result" type="long" dir="return" />
3535	</method>
3536
3537	<method name="fromLong">
3538	<desc>
3539	Make PCI address from long.
3540	</desc>
3541	<param name="number" type="long" dir="in" />
3542	</method>
3543	</interface>
3544
3545	<interface
3546	name="IPciDeviceAttachment" extends="$unknown"
3547	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3548	wsmap="struct"
3549	>
3550
3551	<desc>
3552	Information about PCI attachments.
3553	</desc>
3554
3555	<attribute name="name" type="wstring" readonly="yes">
3556	<desc>
3557	Device name.
3558	</desc>
3559	</attribute>
3560
3561	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3562	<desc>
3563	If this is physical or virtual device.
3564	</desc>
3565	</attribute>
3566
3567	<attribute name="hostAddress" type="long" readonly="yes">
3568	<desc>
3569	Address of device on the host, applicable only to host devices.
3570	</desc>
3571	</attribute>
3572
3573	<attribute name="guestAddress" type="long" readonly="yes">
3574	<desc>
3575	Address of device on the guest.
3576	</desc>
3577	</attribute>
3578
3579	</interface>
3580
3581	<enum
3582	name="CloneMode" extends="$unknown"
3583	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3584	>
3585
3586	<desc>
3587	Clone mode, used with <link to="IMachine::cloneTo" />.
3588	</desc>
3589
3590	<const name="MachineState" value="1">
3591	<desc>Clone the state of the selected machine.</desc>
3592	</const>
3593	<const name="MachineAndChildStates" value="2">
3594	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3595	</const>
3596	<const name="AllStates" value="3">
3597	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3598	</const>
3599
3600	</enum>
3601
3602	<enum
3603	name="CloneOptions" extends="$unknown"
3604	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3605	>
3606
3607	<desc>
3608	Clone options, used with <link to="IMachine::cloneTo" />.
3609	</desc>
3610
3611	<const name="Link" value="1">
3612	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3613	</const>
3614	<const name="KeepAllMACs" value="2">
3615	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3616	</const>
3617	<const name="KeepNATMACs" value="3">
3618	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3619	</const>
3620	<const name="KeepDiskNames" value="4">
3621	<desc>Don't change the disk names.</desc>
3622	</const>
3623
3624	</enum>
3625
3626
3627	<interface
3628	name="IMachine" extends="$unknown"
3629	uuid="5a8e9425-aa0d-4703-9f28-2353fc4ee623"
3630	wsmap="managed"
3631	>
3632	<desc>
3633	The IMachine interface represents a virtual machine, or guest, created
3634	in VirtualBox.
3635
3636	This interface is used in two contexts. First of all, a collection of
3637	objects implementing this interface is stored in the
3638	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3639	machines that are currently registered with this VirtualBox
3640	installation. Also, once a session has been opened for the given virtual
3641	machine (e.g. the virtual machine is running), the machine object
3642	associated with the open session can be queried from the session object;
3643	see <link to="ISession"/> for details.
3644
3645	The main role of this interface is to expose the settings of the virtual
3646	machine and provide methods to change various aspects of the virtual
3647	machine's configuration. For machine objects stored in the
3648	<link to="IVirtualBox::machines"/> collection, all attributes are
3649	read-only unless explicitly stated otherwise in individual attribute
3650	and method descriptions.
3651
3652	In order to change a machine setting, a session for this machine must be
3653	opened using one of the <link to="IMachine::lockMachine" /> or
3654	<link to="IMachine::launchVMProcess"/> methods. After the
3655	machine has been successfully locked for a session, a mutable machine object
3656	needs to be queried from the session object and then the desired settings
3657	changes can be applied to the returned object using IMachine attributes and
3658	methods. See the <link to="ISession"/> interface description for more
3659	information about sessions.
3660
3661	Note that IMachine does not provide methods to control virtual machine
3662	execution (such as start the machine, or power it down) -- these methods
3663	are grouped in a separate interface called <link to="IConsole" />.
3664
3665	<see><link to="ISession"/>, <link to="IConsole"/></see>
3666	</desc>
3667
3668	<attribute name="parent" type="IVirtualBox" readonly="yes">
3669	<desc>Associated parent object.</desc>
3670	</attribute>
3671
3672	<attribute name="accessible" type="boolean" readonly="yes">
3673	<desc>
3674	Whether this virtual machine is currently accessible or not.
3675
3676	A machine is always deemed accessible unless it is registered <i>and</i>
3677	its settings file cannot be read or parsed (either because the file itself
3678	is unavailable or has invalid XML contents).
3679
3680	Every time this property is read, the accessibility state of
3681	this machine is re-evaluated. If the returned value is @c false,
3682	the <link to="#accessError"/> property may be used to get the
3683	detailed error information describing the reason of
3684	inaccessibility, including XML error messages.
3685
3686	When the machine is inaccessible, only the following properties
3687	can be used on it:
3688	<ul>
3689	<li><link to="#parent"/></li>
3690	<li><link to="#id"/></li>
3691	<li><link to="#settingsFilePath"/></li>
3692	<li><link to="#accessible"/></li>
3693	<li><link to="#accessError"/></li>
3694	</ul>
3695
3696	An attempt to access any other property or method will return
3697	an error.
3698
3699	The only possible action you can perform on an inaccessible
3700	machine is to unregister it using the
3701	<link to="IMachine::unregister"/> call (or, to check
3702	for the accessibility state once more by querying this
3703	property).
3704
3705	<note>
3706	In the current implementation, once this property returns
3707	@c true, the machine will never become inaccessible
3708	later, even if its settings file cannot be successfully
3709	read/written any more (at least, until the VirtualBox
3710	server is restarted). This limitation may be removed in
3711	future releases.
3712	</note>
3713	</desc>
3714	</attribute>
3715
3716	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3717	<desc>
3718	Error information describing the reason of machine
3719	inaccessibility.
3720
3721	Reading this property is only valid after the last call to
3722	<link to="#accessible"/> returned @c false (i.e. the
3723	machine is currently inaccessible). Otherwise, a @c null
3724	IVirtualBoxErrorInfo object will be returned.
3725	</desc>
3726	</attribute>
3727
3728	<attribute name="name" type="wstring">
3729	<desc>
3730	Name of the virtual machine.
3731
3732	Besides being used for human-readable identification purposes
3733	everywhere in VirtualBox, the virtual machine name is also used
3734	as a name of the machine's settings file and as a name of the
3735	subdirectory this settings file resides in. Thus, every time you
3736	change the value of this property, the settings file will be
3737	renamed once you call <link to="#saveSettings"/> to confirm the
3738	change. The containing subdirectory will be also renamed, but
3739	only if it has exactly the same name as the settings file
3740	itself prior to changing this property (for backward compatibility
3741	with previous API releases). The above implies the following
3742	limitations:
3743	<ul>
3744	<li>The machine name cannot be empty.</li>
3745	<li>The machine name can contain only characters that are valid
3746	file name characters according to the rules of the file
3747	system used to store VirtualBox configuration.</li>
3748	<li>You cannot have two or more machines with the same name
3749	if they use the same subdirectory for storing the machine
3750	settings files.</li>
3751	<li>You cannot change the name of the machine if it is running,
3752	or if any file in the directory containing the settings file
3753	is being used by another running machine or by any other
3754	process in the host operating system at a time when
3755	<link to="#saveSettings"/> is called.
3756	</li>
3757	</ul>
3758	If any of the above limitations are hit, <link to="#saveSettings"/>
3759	will return an appropriate error message explaining the exact
3760	reason and the changes you made to this machine will not be saved.
3761
3762	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3763	file is recommended, but not enforced. (Previous versions always
3764	used a generic ".xml" extension.)
3765	</desc>
3766	</attribute>
3767
3768	<attribute name="description" type="wstring">
3769	<desc>
3770	Description of the virtual machine.
3771
3772	The description attribute can contain any text and is
3773	typically used to describe the hardware and software
3774	configuration of the virtual machine in detail (i.e. network
3775	settings, versions of the installed software and so on).
3776	</desc>
3777	</attribute>
3778
3779	<attribute name="id" type="uuid" mod="string" readonly="yes">
3780	<desc>UUID of the virtual machine.</desc>
3781	</attribute>
3782
3783	<attribute name="OSTypeId" type="wstring">
3784	<desc>
3785	User-defined identifier of the Guest OS type.
3786	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3787	an IGuestOSType object representing details about the given
3788	Guest OS type.
3789	<note>
3790	This value may differ from the value returned by
3791	<link to="IGuest::OSTypeId"/> if Guest Additions are
3792	installed to the guest OS.
3793	</note>
3794	</desc>
3795	</attribute>
3796
3797	<attribute name="hardwareVersion" type="wstring">
3798	<desc>Hardware version identifier. Internal use only for now.</desc>
3799	</attribute>
3800
3801	<attribute name="hardwareUUID" type="uuid" mod="string">
3802	<desc>
3803	The UUID presented to the guest via memory tables, hardware and guest
3804	properties. For most VMs this is the same as the @a id, but for VMs
3805	which have been cloned or teleported it may be the same as the source
3806	VM. This latter is because the guest shouldn't notice that it was
3807	cloned or teleported.
3808	</desc>
3809	</attribute>
3810
3811	<attribute name="CPUCount" type="unsigned long">
3812	<desc>Number of virtual CPUs in the VM.</desc>
3813	</attribute>
3814
3815	<attribute name="CPUHotPlugEnabled" type="boolean">
3816	<desc>
3817	This setting determines whether VirtualBox allows CPU
3818	hotplugging for this machine.</desc>
3819	</attribute>
3820
3821	<attribute name="CPUExecutionCap" type="unsigned long">
3822	<desc>
3823	Means to limit the number of CPU cycles a guest can use. The unit
3824	is percentage of host CPU cycles per second. The valid range
3825	is 1 - 100. 100 (the default) implies no limit.
3826	</desc>
3827	</attribute>
3828
3829	<attribute name="memorySize" type="unsigned long">
3830	<desc>System memory size in megabytes.</desc>
3831	</attribute>
3832
3833	<attribute name="memoryBalloonSize" type="unsigned long">
3834	<desc>Memory balloon size in megabytes.</desc>
3835	</attribute>
3836
3837	<attribute name="pageFusionEnabled" type="boolean">
3838	<desc>
3839	This setting determines whether VirtualBox allows page
3840	fusion for this machine (64 bits host only).
3841	</desc>
3842	</attribute>
3843
3844	<attribute name="VRAMSize" type="unsigned long">
3845	<desc>Video memory size in megabytes.</desc>
3846	</attribute>
3847
3848	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3849	<desc>
3850	This setting determines whether VirtualBox allows this machine to make
3851	use of the 3D graphics support available on the host.</desc>
3852	</attribute>
3853
3854	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3855	<desc>
3856	This setting determines whether VirtualBox allows this machine to make
3857	use of the 2D video acceleration support available on the host.</desc>
3858	</attribute>
3859
3860	<attribute name="monitorCount" type="unsigned long">
3861	<desc>
3862	Number of virtual monitors.
3863	<note>
3864	Only effective on Windows XP and later guests with
3865	Guest Additions installed.
3866	</note>
3867	</desc>
3868	</attribute>
3869
3870	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3871	<desc>Object containing all BIOS settings.</desc>
3872	</attribute>
3873
3874	<attribute name="firmwareType" type="FirmwareType">
3875	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3876	bootstrap in this VM.</desc>
3877	</attribute>
3878
3879	<attribute name="pointingHidType" type="PointingHidType">
3880	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3881	The default is typically "PS2Mouse" but can vary depending on the
3882	requirements of the guest operating system.</desc>
3883	</attribute>
3884
3885	<attribute name="keyboardHidType" type="KeyboardHidType">
3886	<desc>Type of keyboard HID used in this VM.
3887	The default is typically "PS2Keyboard" but can vary depending on the
3888	requirements of the guest operating system.</desc>
3889	</attribute>
3890
3891	<attribute name="hpetEnabled" type="boolean">
3892	<desc>This attribute controls if High Precision Event Timer (HPET) is
3893	enabled in this VM. Use this property if you want to provide guests
3894	with additional time source, or if guest requires HPET to function correctly.
3895	Default is false.</desc>
3896	</attribute>
3897
3898	<attribute name="chipsetType" type="ChipsetType">
3899	<desc>Chipset type used in this VM.</desc>
3900	</attribute>
3901
3902	<attribute name="snapshotFolder" type="wstring">
3903	<desc>
3904	Full path to the directory used to store snapshot data
3905	(differencing media and saved state files) of this machine.
3906
3907	The initial value of this property is
3908	<tt><</tt><link to="#settingsFilePath">
3909	path_to_settings_file</link><tt>>/<</tt>
3910	<link to="#id">machine_uuid</link>
3911	<tt>></tt>.
3912
3913	Currently, it is an error to try to change this property on
3914	a machine that has snapshots (because this would require to
3915	move possibly large files to a different location).
3916	A separate method will be available for this purpose later.
3917
3918	<note>
3919	Setting this property to @c null or to an empty string will restore
3920	the initial value.
3921	</note>
3922	<note>
3923	When setting this property, the specified path can be
3924	absolute (full path) or relative to the directory where the
3925	<link to="#settingsFilePath">machine settings file</link>
3926	is located. When reading this property, a full path is
3927	always returned.
3928	</note>
3929	<note>
3930	The specified path may not exist, it will be created
3931	when necessary.
3932	</note>
3933	</desc>
3934	</attribute>
3935
3936	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3937	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3938	</attribute>
3939
3940	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
3941	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
3942
3943	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3944	<desc>Array of media attached to this machine.</desc>
3945	</attribute>
3946
3947	<attribute name="USBController" type="IUSBController" readonly="yes">
3948	<desc>
3949	Associated USB controller object.
3950
3951	<note>
3952	If USB functionality is not available in the given edition of
3953	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3954	</note>
3955	</desc>
3956	</attribute>
3957
3958	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3959	<desc>Associated audio adapter, always present.</desc>
3960	</attribute>
3961
3962	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3963	<desc>Array of storage controllers attached to this machine.</desc>
3964	</attribute>
3965
3966	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3967	<desc>
3968	Full name of the file containing machine settings data.
3969	</desc>
3970	</attribute>
3971
3972	<attribute name="settingsModified" type="boolean" readonly="yes">
3973	<desc>
3974	Whether the settings of this machine have been modified
3975	(but neither yet saved nor discarded).
3976	<note>
3977	Reading this property is only valid on instances returned
3978	by <link to="ISession::machine"/> and on new machines
3979	created by <link to="IVirtualBox::createMachine"/> or opened
3980	by <link to="IVirtualBox::openMachine"/> but not
3981	yet registered, or on unregistered machines after calling
3982	<link to="IMachine::unregister"/>. For all other
3983	cases, the settings can never be modified.
3984	</note>
3985	<note>
3986	For newly created unregistered machines, the value of this
3987	property is always @c true until <link to="#saveSettings"/>
3988	is called (no matter if any machine settings have been
3989	changed after the creation or not). For opened machines
3990	the value is set to @c false (and then follows to normal rules).
3991	</note>
3992	</desc>
3993	</attribute>
3994
3995	<attribute name="sessionState" type="SessionState" readonly="yes">
3996	<desc>Current session state for this machine.</desc>
3997	</attribute>
3998
3999	<attribute name="sessionType" type="wstring" readonly="yes">
4000	<desc>
4001	Type of the session. If <link to="#sessionState"/> is
4002	Spawning or Locked, this attribute contains the
4003	same value as passed to the
4004	<link to="IMachine::launchVMProcess"/> method in the
4005	@a type parameter. If the session was used with
4006	<link to="IMachine::lockMachine" />, or if
4007	<link to="#sessionState"/> is SessionClosed, the value of this
4008	attribute is an empty string.
4009	</desc>
4010	</attribute>
4011
4012	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4013	<desc>
4014	Identifier of the session process. This attribute contains the
4015	platform-dependent identifier of the process whose session was
4016	used with <link to="IMachine::lockMachine" /> call. The returned
4017	value is only valid if <link to="#sessionState"/> is Locked or
4018	Unlocking by the time this property is read.
4019	</desc>
4020	</attribute>
4021
4022	<attribute name="state" type="MachineState" readonly="yes">
4023	<desc>Current execution state of this machine.</desc>
4024	</attribute>
4025
4026	<attribute name="lastStateChange" type="long long" readonly="yes">
4027	<desc>
4028	Time stamp of the last execution state change,
4029	in milliseconds since 1970-01-01 UTC.
4030	</desc>
4031	</attribute>
4032
4033	<attribute name="stateFilePath" type="wstring" readonly="yes">
4034	<desc>
4035	Full path to the file that stores the execution state of
4036	the machine when it is in the <link to="MachineState_Saved"/> state.
4037	<note>
4038	When the machine is not in the Saved state, this attribute is
4039	an empty string.
4040	</note>
4041	</desc>
4042	</attribute>
4043
4044	<attribute name="logFolder" type="wstring" readonly="yes">
4045	<desc>
4046	Full path to the folder that stores a set of rotated log files
4047	recorded during machine execution. The most recent log file is
4048	named <tt>VBox.log</tt>, the previous log file is
4049	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4050	in the current version).
4051	</desc>
4052	</attribute>
4053
4054	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4055	<desc>
4056	Current snapshot of this machine. This is @c null if the machine
4057	currently has no snapshots. If it is not @c null, then it was
4058	set by one of <link to="IConsole::takeSnapshot" />,
4059	<link to="IConsole::deleteSnapshot" />
4060	or <link to="IConsole::restoreSnapshot" />, depending on which
4061	was called last. See <link to="ISnapshot"/> for details.
4062	</desc>
4063	</attribute>
4064
4065	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4066	<desc>
4067	Number of snapshots taken on this machine. Zero means the
4068	machine doesn't have any snapshots.
4069	</desc>
4070	</attribute>
4071
4072	<attribute name="currentStateModified" type="boolean" readonly="yes">
4073	<desc>
4074	Returns @c true if the current state of the machine is not
4075	identical to the state stored in the current snapshot.
4076
4077	The current state is identical to the current snapshot only
4078	directly after one of the following calls are made:
4079
4080	<ul>
4081	<li><link to="IConsole::restoreSnapshot"/>
4082	</li>
4083	<li><link to="IConsole::takeSnapshot"/> (issued on a
4084	"powered off" or "saved" machine, for which
4085	<link to="#settingsModified"/> returns @c false)
4086	</li>
4087	</ul>
4088
4089	The current state remains identical until one of the following
4090	happens:
4091	<ul>
4092	<li>settings of the machine are changed</li>
4093	<li>the saved state is deleted</li>
4094	<li>the current snapshot is deleted</li>
4095	<li>an attempt to execute the machine is made</li>
4096	</ul>
4097
4098	<note>
4099	For machines that don't have snapshots, this property is
4100	always @c false.
4101	</note>
4102	</desc>
4103	</attribute>
4104
4105	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4106	<desc>
4107	Collection of shared folders for this machine (permanent shared
4108	folders). These folders are shared automatically at machine startup
4109	and available only to the guest OS installed within this machine.
4110
4111	New shared folders are added to the collection using
4112	<link to="#createSharedFolder"/>. Existing shared folders can be
4113	removed using <link to="#removeSharedFolder"/>.
4114	</desc>
4115	</attribute>
4116
4117	<attribute name="clipboardMode" type="ClipboardMode">
4118	<desc>
4119	Synchronization mode between the host OS clipboard
4120	and the guest OS clipboard.
4121	</desc>
4122	</attribute>
4123
4124	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4125	<desc>
4126	A comma-separated list of simple glob patterns. Changes to guest
4127	properties whose name matches one of the patterns will generate an
4128	<link to="IGuestPropertyChangedEvent"/> signal.
4129	</desc>
4130	</attribute>
4131
4132	<attribute name="teleporterEnabled" type="boolean">
4133	<desc>
4134	When set to @a true, the virtual machine becomes a target teleporter
4135	the next time it is powered on. This can only set to @a true when the
4136	VM is in the @a PoweredOff or @a Aborted state.
4137
4138	<!-- This property is automatically set to @a false when the VM is powered
4139	on. (bird: This doesn't work yet ) -->
4140	</desc>
4141	</attribute>
4142
4143	<attribute name="teleporterPort" type="unsigned long">
4144	<desc>
4145	The TCP port the target teleporter will listen for incoming
4146	teleportations on.
4147
4148	0 means the port is automatically selected upon power on. The actual
4149	value can be read from this property while the machine is waiting for
4150	incoming teleportations.
4151	</desc>
4152	</attribute>
4153
4154	<attribute name="teleporterAddress" type="wstring">
4155	<desc>
4156	The address the target teleporter will listen on. If set to an empty
4157	string, it will listen on all addresses.
4158	</desc>
4159	</attribute>
4160
4161	<attribute name="teleporterPassword" type="wstring">
4162	<desc>
4163	The password to check for on the target teleporter. This is just a
4164	very basic measure to prevent simple hacks and operators accidentally
4165	beaming a virtual machine to the wrong place.
4166	</desc>
4167	</attribute>
4168
4169	<attribute name="faultToleranceState" type="FaultToleranceState">
4170	<desc>
4171	Fault tolerance state; disabled, source or target.
4172	This property can be changed at any time. If you change it for a running
4173	VM, then the fault tolerance address and port must be set beforehand.
4174	</desc>
4175	</attribute>
4176
4177	<attribute name="faultTolerancePort" type="unsigned long">
4178	<desc>
4179	The TCP port the fault tolerance source or target will use for
4180	communication.
4181	</desc>
4182	</attribute>
4183
4184	<attribute name="faultToleranceAddress" type="wstring">
4185	<desc>
4186	The address the fault tolerance source or target.
4187	</desc>
4188	</attribute>
4189
4190	<attribute name="faultTolerancePassword" type="wstring">
4191	<desc>
4192	The password to check for on the standby VM. This is just a
4193	very basic measure to prevent simple hacks and operators accidentally
4194	choosing the wrong standby VM.
4195	</desc>
4196	</attribute>
4197
4198	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4199	<desc>
4200	The interval in ms used for syncing the state between source and target.
4201	</desc>
4202	</attribute>
4203
4204	<attribute name="RTCUseUTC" type="boolean">
4205	<desc>
4206	When set to @a true, the RTC device of the virtual machine will run
4207	in UTC time, otherwise in local time. Especially Unix guests prefer
4208	the time in UTC.
4209	</desc>
4210	</attribute>
4211
4212	<attribute name="ioCacheEnabled" type="boolean">
4213	<desc>
4214	When set to @a true, the builtin I/O cache of the virtual machine
4215	will be enabled.
4216	</desc>
4217	</attribute>
4218
4219	<attribute name="ioCacheSize" type="unsigned long">
4220	<desc>
4221	Maximum size of the I/O cache in MB.
4222	</desc>
4223	</attribute>
4224
4225	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4226	<desc>
4227	Bandwidth control manager.
4228	</desc>
4229	</attribute>
4230
4231	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4232	<desc>Array of PCI devices assigned to this machine, to get list of all
4233	PCI devices attached to the machine use
4234	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4235	is intended to list only devices additional to what described in
4236	virtual hardware config. Usually, this list keeps host's physical
4237	devices assigned to the particular machine.
4238	</desc>
4239	</attribute>
4240
4241	<method name="lockMachine">
4242	<desc>
4243	Locks the machine for the given session to enable the caller
4244	to make changes to the machine or start the VM or control
4245	VM execution.
4246
4247	There are two ways to lock a machine for such uses:
4248
4249	<ul>
4250	<li>If you want to make changes to the machine settings,
4251	you must obtain an exclusive write lock on the machine
4252	by setting @a lockType to @c Write.
4253
4254	This will only succeed if no other process has locked
4255	the machine to prevent conflicting changes. Only after
4256	an exclusive write lock has been obtained using this method, one
4257	can change all VM settings or execute the VM in the process
4258	space of the session object. (Note that the latter is only of
4259	interest if you actually want to write a new front-end for
4260	virtual machines; but this API gets called internally by
4261	the existing front-ends such as VBoxHeadless and the VirtualBox
4262	GUI to acquire a write lock on the machine that they are running.)
4263
4264	On success, write-locking the machine for a session creates
4265	a second copy of the IMachine object. It is this second object
4266	upon which changes can be made; in VirtualBox terminology, the
4267	second copy is "mutable". It is only this second, mutable machine
4268	object upon which you can call methods that change the
4269	machine state. After having called this method, you can
4270	obtain this second, mutable machine object using the
4271	<link to="ISession::machine" /> attribute.
4272	</li>
4273	<li>If you only want to check the machine state or control
4274	machine execution without actually changing machine
4275	settings (e.g. to get access to VM statistics or take
4276	a snapshot or save the machine state), then set the
4277	@a lockType argument to @c Shared.
4278
4279	If no other session has obtained a lock, you will obtain an
4280	exclusive write lock as described above. However, if another
4281	session has already obtained such a lock, then a link to that
4282	existing session will be established which allows you
4283	to control that existing session.
4284
4285	To find out which type of lock was obtained, you can
4286	inspect <link to="ISession::type" />, which will have been
4287	set to either @c WriteLock or @c Shared.
4288	</li>
4289	</ul>
4290
4291	In either case, you can get access to the <link to="IConsole" />
4292	object which controls VM execution.
4293
4294	Also in all of the above cases, one must always call
4295	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4296	the machine's state will eventually be set to "Aborted".
4297
4298	To change settings on a machine, the following sequence is typically
4299	performed:
4300
4301	<ol>
4302	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4303
4304	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4305
4306	<li>Change the settings of the machine by invoking IMachine methods.</li>
4307
4308	<li>Call <link to="IMachine::saveSettings" />.</li>
4309
4310	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4311	</ol>
4312
4313	<result name="E_UNEXPECTED">
4314	Virtual machine not registered.
4315	</result>
4316	<result name="E_ACCESSDENIED">
4317	Process not started by OpenRemoteSession.
4318	</result>
4319	<result name="VBOX_E_INVALID_OBJECT_STATE">
4320	Session already open or being opened.
4321	</result>
4322	<result name="VBOX_E_VM_ERROR">
4323	Failed to assign machine to session.
4324	</result>
4325	</desc>
4326	<param name="session" type="ISession" dir="in">
4327	<desc>
4328	Session object for which the machine will be locked.
4329	</desc>
4330	</param>
4331	<param name="lockType" type="LockType" dir="in">
4332	<desc>
4333	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4334	If set to @c Shared, then either acquire an exclusive write lock or establish
4335	a link to an existing session.
4336	</desc>
4337	</param>
4338	</method>
4339
4340	<method name="launchVMProcess">
4341	<desc>
4342	Spawns a new process that will execute the virtual machine and obtains a shared
4343	lock on the machine for the calling session.
4344
4345	If launching the VM succeeds, the new VM process will create its own session
4346	and write-lock the machine for it, preventing conflicting changes from other
4347	processes. If the machine is already locked (because it is already running or
4348	because another session has a write lock), launching the VM process will therefore
4349	fail. Reversely, future attempts to obtain a write lock will also fail while the
4350	machine is running.
4351
4352	The caller's session object remains separate from the session opened by the new
4353	VM process. It receives its own <link to="IConsole" /> object which can be used
4354	to control machine execution, but it cannot be used to change all VM settings
4355	which would be available after a <link to="#lockMachine" /> call.
4356
4357	The caller must eventually release the session's shared lock by calling
4358	<link to="ISession::unlockMachine" /> on the local session object once this call
4359	has returned. However, the session's state (see <link to="ISession::state" />)
4360	will not return to "Unlocked" until the remote session has also unlocked
4361	the machine (i.e. the machine has stopped running).
4362
4363	Launching a VM process can take some time (a new VM is started in a new process,
4364	for which memory and other resources need to be set up). Because of this,
4365	an <link to="IProgress" /> object is returned to allow the caller to wait
4366	for this asynchronous operation to be completed. Until then, the caller's
4367	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4368	and <link to="ISession::console" /> attributes cannot be accessed.
4369	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4370	similar calls to wait for completion. Completion is signalled when the VM
4371	is powered on. If launching the VM fails, error messages can be queried
4372	via the progress object, if available.
4373
4374	The progress object will have at least 2 sub-operations. The first
4375	operation covers the period up to the new VM process calls powerUp.
4376	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4377	progress object. Because <link to="IConsole::powerUp"/> may require
4378	some extra sub-operations, the <link to="IProgress::operationCount"/>
4379	may change at the completion of operation.
4380
4381	For details on the teleportation progress operation, see
4382	<link to="IConsole::powerUp"/>.
4383
4384	The @a environment argument is a string containing definitions of
4385	environment variables in the following format:
4386	<pre>
4387	NAME[=VALUE]\n
4388	NAME[=VALUE]\n
4389	...
4390	</pre>
4391	where <tt>\\n</tt> is the new line character. These environment
4392	variables will be appended to the environment of the VirtualBox server
4393	process. If an environment variable exists both in the server process
4394	and in this list, the value from this list takes precedence over the
4395	server's variable. If the value of the environment variable is
4396	omitted, this variable will be removed from the resulting environment.
4397	If the environment string is @c null or empty, the server environment
4398	is inherited by the started process as is.
4399
4400	<result name="E_UNEXPECTED">
4401	Virtual machine not registered.
4402	</result>
4403	<result name="E_INVALIDARG">
4404	Invalid session type @a type.
4405	</result>
4406	<result name="VBOX_E_OBJECT_NOT_FOUND">
4407	No machine matching @a machineId found.
4408	</result>
4409	<result name="VBOX_E_INVALID_OBJECT_STATE">
4410	Session already open or being opened.
4411	</result>
4412	<result name="VBOX_E_IPRT_ERROR">
4413	Launching process for machine failed.
4414	</result>
4415	<result name="VBOX_E_VM_ERROR">
4416	Failed to assign machine to session.
4417	</result>
4418	</desc>
4419	<param name="session" type="ISession" dir="in">
4420	<desc>
4421	Client session object to which the VM process will be connected (this
4422	must be in "Unlocked" state).
4423	</desc>
4424	</param>
4425	<param name="type" type="wstring" dir="in">
4426	<desc>
4427	Front-end to use for the new VM process. The following are currently supported:
4428	<ul>
4429	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4430	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4431	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4432	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4433	the currently running VM or session owner. In this case the
4434	@a session parameter may be @c NULL (if it is non-null it isn't
4435	used in any way), and the @a progress return value will be always
4436	NULL. The operation completes immediately.</li>
4437	</ul>
4438	</desc>
4439	</param>
4440	<param name="environment" type="wstring" dir="in">
4441	<desc>
4442	Environment to pass to the VM process.
4443	</desc>
4444	</param>
4445	<param name="progress" type="IProgress" dir="return">
4446	<desc>Progress object to track the operation completion.</desc>
4447	</param>
4448	</method>
4449
4450	<method name="setBootOrder">
4451	<desc>
4452	Puts the given device to the specified position in
4453	the boot order.
4454
4455	To indicate that no device is associated with the given position,
4456	<link to="DeviceType_Null"/> should be used.
4457
4458	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4459
4460	<result name="E_INVALIDARG">
4461	Boot @a position out of range.
4462	</result>
4463	<result name="E_NOTIMPL">
4464	Booting from USB @a device currently not supported.
4465	</result>
4466
4467	</desc>
4468	<param name="position" type="unsigned long" dir="in">
4469	<desc>
4470	Position in the boot order (@c 1 to the total number of
4471	devices the machine can boot from, as returned by
4472	<link to="ISystemProperties::maxBootPosition"/>).
4473	</desc>
4474	</param>
4475	<param name="device" type="DeviceType" dir="in">
4476	<desc>
4477	The type of the device used to boot at the given position.
4478	</desc>
4479	</param>
4480	</method>
4481
4482	<method name="getBootOrder" const="yes">
4483	<desc>
4484	Returns the device type that occupies the specified
4485	position in the boot order.
4486
4487	@todo [remove?]
4488	If the machine can have more than one device of the returned type
4489	(such as hard disks), then a separate method should be used to
4490	retrieve the individual device that occupies the given position.
4491
4492	If here are no devices at the given position, then
4493	<link to="DeviceType_Null"/> is returned.
4494
4495	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4496
4497	<result name="E_INVALIDARG">
4498	Boot @a position out of range.
4499	</result>
4500
4501	</desc>
4502	<param name="position" type="unsigned long" dir="in">
4503	<desc>
4504	Position in the boot order (@c 1 to the total number of
4505	devices the machine can boot from, as returned by
4506	<link to="ISystemProperties::maxBootPosition"/>).
4507	</desc>
4508	</param>
4509	<param name="device" type="DeviceType" dir="return">
4510	<desc>
4511	Device at the given position.
4512	</desc>
4513	</param>
4514	</method>
4515
4516	<method name="attachDevice">
4517	<desc>
4518	Attaches a device and optionally mounts a medium to the given storage
4519	controller (<link to="IStorageController" />, identified by @a name),
4520	at the indicated port and device.
4521
4522	This method is intended for managing storage devices in general while a
4523	machine is powered off. It can be used to attach and detach fixed
4524	and removable media. The following kind of media can be attached
4525	to a machine:
4526
4527	<ul>
4528	<li>For fixed and removable media, you can pass in a medium that was
4529	previously opened using <link to="IVirtualBox::openMedium" />.
4530	</li>
4531
4532	<li>Only for storage devices supporting removable media (such as
4533	DVDs and floppies), you can also specify a null pointer to
4534	indicate an empty drive or one of the medium objects listed
4535	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4536	arrays to indicate a host drive.
4537	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4538	to change the media while the machine is running.
4539	</li>
4540	</ul>
4541
4542	In a VM's default configuration of virtual machines, the secondary
4543	master of the IDE controller is used for a CD/DVD drive.
4544
4545	After calling this returns successfully, a new instance of
4546	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4547	attachments (see <link to="IMachine::mediumAttachments"/>).
4548
4549	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4550	information about attaching media.
4551
4552	The specified device slot must not have a device attached to it,
4553	or this method will fail.
4554
4555	<note>
4556	You cannot attach a device to a newly created machine until
4557	this machine's settings are saved to disk using
4558	<link to="#saveSettings"/>.
4559	</note>
4560	<note>
4561	If the medium is being attached indirectly, a new differencing medium
4562	will implicitly be created for it and attached instead. If the
4563	changes made to the machine settings (including this indirect
4564	attachment) are later cancelled using <link to="#discardSettings"/>,
4565	this implicitly created differencing medium will implicitly
4566	be deleted.
4567	</note>
4568
4569	<result name="E_INVALIDARG">
4570	SATA device, SATA port, IDE port or IDE slot out of range, or
4571	file or UUID not found.
4572	</result>
4573	<result name="VBOX_E_INVALID_OBJECT_STATE">
4574	Machine must be registered before media can be attached.
4575	</result>
4576	<result name="VBOX_E_INVALID_VM_STATE">
4577	Invalid machine state.
4578	</result>
4579	<result name="VBOX_E_OBJECT_IN_USE">
4580	A medium is already attached to this or another virtual machine.
4581	</result>
4582
4583	</desc>
4584	<param name="name" type="wstring" dir="in">
4585	<desc>Name of the storage controller to attach the device to.</desc>
4586	</param>
4587	<param name="controllerPort" type="long" dir="in">
4588	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4589	the primary controller and 1 specifies the secondary controller.
4590	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4591	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4592	</param>
4593	<param name="device" type="long" dir="in">
4594	<desc>Device slot in the given port to attach the device to. This is only
4595	relevant for IDE controllers, for which 0 specifies the master device and
4596	1 specifies the slave device. For all other controller types, this must
4597	be 0.</desc>
4598	</param>
4599	<param name="type" type="DeviceType" dir="in">
4600	<desc>Device type of the attached device. For media opened by
4601	<link to="IVirtualBox::openMedium" />, this must match the device type
4602	specified there.</desc>
4603	</param>
4604	<param name="medium" type="IMedium" dir="in">
4605	<desc>Medium to mount or NULL for an empty drive.</desc>
4606	</param>
4607	</method>
4608
4609	<method name="detachDevice">
4610	<desc>
4611	Detaches the device attached to a device slot of the specified bus.
4612
4613	Detaching the device from the virtual machine is deferred. This means
4614	that the medium remains associated with the machine when this method
4615	returns and gets actually de-associated only after a successful
4616	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4617	for more detailed information about attaching media.
4618
4619	<note>
4620	You cannot detach a device from a running machine.
4621	</note>
4622	<note>
4623	Detaching differencing media implicitly created by <link
4624	to="#attachDevice"/> for the indirect attachment using this
4625	method will <b>not</b> implicitly delete them. The
4626	<link to="IMedium::deleteStorage"/> operation should be
4627	explicitly performed by the caller after the medium is successfully
4628	detached and the settings are saved with
4629	<link to="#saveSettings"/>, if it is the desired action.
4630	</note>
4631
4632	<result name="VBOX_E_INVALID_VM_STATE">
4633	Attempt to detach medium from a running virtual machine.
4634	</result>
4635	<result name="VBOX_E_OBJECT_NOT_FOUND">
4636	No medium attached to given slot/bus.
4637	</result>
4638	<result name="VBOX_E_NOT_SUPPORTED">
4639	Medium format does not support storage deletion.
4640	</result>
4641
4642	</desc>
4643	<param name="name" type="wstring" dir="in">
4644	<desc>Name of the storage controller to detach the medium from.</desc>
4645	</param>
4646	<param name="controllerPort" type="long" dir="in">
4647	<desc>Port number to detach the medium from.</desc>
4648	</param>
4649	<param name="device" type="long" dir="in">
4650	<desc>Device slot number to detach the medium from.</desc>
4651	</param>
4652	</method>
4653
4654	<method name="passthroughDevice">
4655	<desc>
4656	Sets the passthrough mode of an existing DVD device. Changing the
4657	setting while the VM is running is forbidden. The setting is only used
4658	if at VM start the device is configured as a host DVD drive, in all
4659	other cases it is ignored. The device must already exist; see
4660	<link to="IMachine::attachDevice"/> for how to attach a new device.
4661
4662	The @a controllerPort and @a device parameters specify the device slot and
4663	have have the same meaning as with <link to="IMachine::attachDevice" />.
4664
4665	<result name="E_INVALIDARG">
4666	SATA device, SATA port, IDE port or IDE slot out of range.
4667	</result>
4668	<result name="VBOX_E_INVALID_OBJECT_STATE">
4669	Attempt to modify an unregistered virtual machine.
4670	</result>
4671	<result name="VBOX_E_INVALID_VM_STATE">
4672	Invalid machine state.
4673	</result>
4674
4675	</desc>
4676	<param name="name" type="wstring" dir="in">
4677	<desc>Name of the storage controller.</desc>
4678	</param>
4679	<param name="controllerPort" type="long" dir="in">
4680	<desc>Storage controller port.</desc>
4681	</param>
4682	<param name="device" type="long" dir="in">
4683	<desc>Device slot in the given port.</desc>
4684	</param>
4685	<param name="passthrough" type="boolean" dir="in">
4686	<desc>New value for the passthrough setting.</desc>
4687	</param>
4688	</method>
4689
4690	<method name="temporaryEjectDevice">
4691	<desc>
4692	Sets the behavior for guest-triggered medium eject. In some situations
4693	it is desirable that such ejects update the VM configuration, and in
4694	others the eject should keep the VM configuration. The device must
4695	already exist; see <link to="IMachine::attachDevice"/> for how to
4696	attach a new device.
4697
4698	The @a controllerPort and @a device parameters specify the device slot and
4699	have have the same meaning as with <link to="IMachine::attachDevice" />.
4700
4701	<result name="E_INVALIDARG">
4702	SATA device, SATA port, IDE port or IDE slot out of range.
4703	</result>
4704	<result name="VBOX_E_INVALID_OBJECT_STATE">
4705	Attempt to modify an unregistered virtual machine.
4706	</result>
4707	<result name="VBOX_E_INVALID_VM_STATE">
4708	Invalid machine state.
4709	</result>
4710
4711	</desc>
4712	<param name="name" type="wstring" dir="in">
4713	<desc>Name of the storage controller.</desc>
4714	</param>
4715	<param name="controllerPort" type="long" dir="in">
4716	<desc>Storage controller port.</desc>
4717	</param>
4718	<param name="device" type="long" dir="in">
4719	<desc>Device slot in the given port.</desc>
4720	</param>
4721	<param name="temporaryEject" type="boolean" dir="in">
4722	<desc>New value for the eject behavior.</desc>
4723	</param>
4724	</method>
4725
4726	<method name="nonRotationalDevice">
4727	<desc>
4728	Sets a flag in the device information which indicates that the medium
4729	is not based on rotational technology, i.e. that the access times are
4730	more or less independent of the position on the medium. This may or may
4731	not be supported by a particular drive, and is silently ignored in the
4732	latter case. At the moment only hard disks (which is a misnomer in this
4733	context) accept this setting. Changing the setting while the VM is
4734	running is forbidden. The device must already exist; see
4735	<link to="IMachine::attachDevice"/> for how to attach a new device.
4736
4737	The @a controllerPort and @a device parameters specify the device slot and
4738	have have the same meaning as with <link to="IMachine::attachDevice" />.
4739
4740	<result name="E_INVALIDARG">
4741	SATA device, SATA port, IDE port or IDE slot out of range.
4742	</result>
4743	<result name="VBOX_E_INVALID_OBJECT_STATE">
4744	Attempt to modify an unregistered virtual machine.
4745	</result>
4746	<result name="VBOX_E_INVALID_VM_STATE">
4747	Invalid machine state.
4748	</result>
4749
4750	</desc>
4751	<param name="name" type="wstring" dir="in">
4752	<desc>Name of the storage controller.</desc>
4753	</param>
4754	<param name="controllerPort" type="long" dir="in">
4755	<desc>Storage controller port.</desc>
4756	</param>
4757	<param name="device" type="long" dir="in">
4758	<desc>Device slot in the given port.</desc>
4759	</param>
4760	<param name="nonRotational" type="boolean" dir="in">
4761	<desc>New value for the non-rotational device flag.</desc>
4762	</param>
4763	</method>
4764
4765	<method name="setAutoDiscardForDevice">
4766	<desc>
4767	Sets a flag in the device information which indicates that the medium
4768	supports discarding unsused blocks (called trimming for SATA or unmap
4769	for SCSI devices) .This may or may not be supported by a particular drive,
4770	and is silently ignored in the latter case. At the moment only hard disks
4771	(which is a misnomer in this context) accept this setting. Changing the
4772	setting while the VM is running is forbidden. The device must already
4773	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4774	device.
4775
4776	The @a controllerPort and @a device parameters specify the device slot and
4777	have have the same meaning as with <link to="IMachine::attachDevice" />.
4778
4779	<result name="E_INVALIDARG">
4780	SATA device, SATA port, SCSI port out of range.
4781	</result>
4782	<result name="VBOX_E_INVALID_OBJECT_STATE">
4783	Attempt to modify an unregistered virtual machine.
4784	</result>
4785	<result name="VBOX_E_INVALID_VM_STATE">
4786	Invalid machine state.
4787	</result>
4788
4789	</desc>
4790	<param name="name" type="wstring" dir="in">
4791	<desc>Name of the storage controller.</desc>
4792	</param>
4793	<param name="controllerPort" type="long" dir="in">
4794	<desc>Storage controller port.</desc>
4795	</param>
4796	<param name="device" type="long" dir="in">
4797	<desc>Device slot in the given port.</desc>
4798	</param>
4799	<param name="discard" type="boolean" dir="in">
4800	<desc>New value for the discard device flag.</desc>
4801	</param>
4802	</method>
4803
4804	<method name="setBandwidthGroupForDevice">
4805	<desc>
4806	Sets the bandwidth group of an existing storage device.
4807	The device must already exist; see <link to="IMachine::attachDevice"/>
4808	for how to attach a new device.
4809
4810	The @a controllerPort and @a device parameters specify the device slot and
4811	have have the same meaning as with <link to="IMachine::attachDevice" />.
4812
4813	<result name="E_INVALIDARG">
4814	SATA device, SATA port, IDE port or IDE slot out of range.
4815	</result>
4816	<result name="VBOX_E_INVALID_OBJECT_STATE">
4817	Attempt to modify an unregistered virtual machine.
4818	</result>
4819	<result name="VBOX_E_INVALID_VM_STATE">
4820	Invalid machine state.
4821	</result>
4822
4823	</desc>
4824	<param name="name" type="wstring" dir="in">
4825	<desc>Name of the storage controller.</desc>
4826	</param>
4827	<param name="controllerPort" type="long" dir="in">
4828	<desc>Storage controller port.</desc>
4829	</param>
4830	<param name="device" type="long" dir="in">
4831	<desc>Device slot in the given port.</desc>
4832	</param>
4833	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4834	<desc>New value for the bandwidth group or NULL for no group.</desc>
4835	</param>
4836	</method>
4837
4838	<method name="mountMedium">
4839	<desc>
4840	Mounts a medium (<link to="IMedium" />, identified
4841	by the given UUID @a id) to the given storage controller
4842	(<link to="IStorageController" />, identified by @a name),
4843	at the indicated port and device. The device must already exist;
4844	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4845
4846	This method is intended only for managing removable media, where the
4847	device is fixed but media is changeable at runtime (such as DVDs
4848	and floppies). It cannot be used for fixed media such as hard disks.
4849
4850	The @a controllerPort and @a device parameters specify the device slot and
4851	have have the same meaning as with <link to="IMachine::attachDevice" />.
4852
4853	The specified device slot can have a medium mounted, which will be
4854	unmounted first. Specifying a zero UUID (or an empty string) for
4855	@a medium does just an unmount.
4856
4857	See <link to="IMedium"/> for more detailed information about
4858	attaching media.
4859
4860	<result name="E_INVALIDARG">
4861	SATA device, SATA port, IDE port or IDE slot out of range.
4862	</result>
4863	<result name="VBOX_E_INVALID_OBJECT_STATE">
4864	Attempt to attach medium to an unregistered virtual machine.
4865	</result>
4866	<result name="VBOX_E_INVALID_VM_STATE">
4867	Invalid machine state.
4868	</result>
4869	<result name="VBOX_E_OBJECT_IN_USE">
4870	Medium already attached to this or another virtual machine.
4871	</result>
4872
4873	</desc>
4874	<param name="name" type="wstring" dir="in">
4875	<desc>Name of the storage controller to attach the medium to.</desc>
4876	</param>
4877	<param name="controllerPort" type="long" dir="in">
4878	<desc>Port to attach the medium to.</desc>
4879	</param>
4880	<param name="device" type="long" dir="in">
4881	<desc>Device slot in the given port to attach the medium to.</desc>
4882	</param>
4883	<param name="medium" type="IMedium" dir="in">
4884	<desc>Medium to mount or NULL for an empty drive.</desc>
4885	</param>
4886	<param name="force" type="boolean" dir="in">
4887	<desc>Allows to force unmount/mount of a medium which is locked by
4888	the device slot in the given port to attach the medium to.</desc>
4889	</param>
4890	</method>
4891
4892	<method name="getMedium" const="yes">
4893	<desc>
4894	Returns the virtual medium attached to a device slot of the specified
4895	bus.
4896
4897	Note that if the medium was indirectly attached by
4898	<link to="#mountMedium"/> to the given device slot then this
4899	method will return not the same object as passed to the
4900	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4901	more detailed information about mounting a medium.
4902
4903	<result name="VBOX_E_OBJECT_NOT_FOUND">
4904	No medium attached to given slot/bus.
4905	</result>
4906
4907	</desc>
4908	<param name="name" type="wstring" dir="in">
4909	<desc>Name of the storage controller the medium is attached to.</desc>
4910	</param>
4911	<param name="controllerPort" type="long" dir="in">
4912	<desc>Port to query.</desc>
4913	</param>
4914	<param name="device" type="long" dir="in">
4915	<desc>Device slot in the given port to query.</desc>
4916	</param>
4917	<param name="medium" type="IMedium" dir="return">
4918	<desc>Attached medium object.</desc>
4919	</param>
4920	</method>
4921
4922	<method name="getMediumAttachmentsOfController" const="yes">
4923	<desc>
4924	Returns an array of medium attachments which are attached to the
4925	the controller with the given name.
4926
4927	<result name="VBOX_E_OBJECT_NOT_FOUND">
4928	A storage controller with given name doesn't exist.
4929	</result>
4930	</desc>
4931	<param name="name" type="wstring" dir="in"/>
4932	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4933	</method>
4934
4935	<method name="getMediumAttachment" const="yes">
4936	<desc>
4937	Returns a medium attachment which corresponds to the controller with
4938	the given name, on the given port and device slot.
4939
4940	<result name="VBOX_E_OBJECT_NOT_FOUND">
4941	No attachment exists for the given controller/port/device combination.
4942	</result>
4943	</desc>
4944	<param name="name" type="wstring" dir="in"/>
4945	<param name="controllerPort" type="long" dir="in"/>
4946	<param name="device" type="long" dir="in"/>
4947	<param name="attachment" type="IMediumAttachment" dir="return"/>
4948	</method>
4949
4950	<method name="attachHostPciDevice">
4951	<desc>
4952	Attaches host PCI device with the given (host) PCI address to the
4953	PCI bus of the virtual machine. Please note, that this operation
4954	is two phase, as real attachment will happen when VM will start,
4955	and most information will be delivered as IHostPciDevicePlugEvent
4956	on IVirtualBox event source.
4957
4958	<see><link to="IHostPciDevicePlugEvent"/></see>
4959
4960	<result name="VBOX_E_INVALID_VM_STATE">
4961	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4962	</result>
4963	<result name="VBOX_E_PDM_ERROR">
4964	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4965	</result>
4966	<result name="VBOX_E_NOT_SUPPORTED">
4967	Hardware or host OS doesn't allow PCI device passthrought.
4968	</result>
4969	</desc>
4970	<param name="hostAddress" type="long" dir="in">
4971	<desc>Address of the host PCI device.</desc>
4972	</param>
4973	<param name="desiredGuestAddress" type="long" dir="in">
4974	<desc>Desired position of this device on guest PCI bus.</desc>
4975	</param>
4976	<param name="tryToUnbind" type="boolean" dir="in">
4977	<desc>If VMM shall try to unbind existing drivers from the
4978	device before attaching it to the guest.</desc>
4979	</param>
4980	</method>
4981
4982	<method name="detachHostPciDevice">
4983	<desc>
4984	Detach host PCI device from the virtual machine.
4985	Also HostPciDevicePlugEvent on IVirtualBox event source
4986	will be delivered. As currently we don't support hot device
4987	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4988
4989	<see><link to="IHostPciDevicePlugEvent"/></see>
4990
4991	<result name="VBOX_E_INVALID_VM_STATE">
4992	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4993	</result>
4994	<result name="VBOX_E_OBJECT_NOT_FOUND">
4995	This host device is not attached to this machine.
4996	</result>
4997	<result name="VBOX_E_PDM_ERROR">
4998	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4999	</result>
5000	<result name="VBOX_E_NOT_SUPPORTED">
5001	Hardware or host OS doesn't allow PCI device passthrought.
5002	</result>
5003	</desc>
5004	<param name="hostAddress" type="long" dir="in">
5005	<desc>Address of the host PCI device.</desc>
5006	</param>
5007	</method>
5008
5009	<method name="getNetworkAdapter" const="yes">
5010	<desc>
5011	Returns the network adapter associated with the given slot.
5012	Slots are numbered sequentially, starting with zero. The total
5013	number of adapters per machine is defined by the
5014	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5015	so the maximum slot number is one less than that property's value.
5016
5017	<result name="E_INVALIDARG">
5018	Invalid @a slot number.
5019	</result>
5020
5021	</desc>
5022	<param name="slot" type="unsigned long" dir="in"/>
5023	<param name="adapter" type="INetworkAdapter" dir="return"/>
5024	</method>
5025
5026	<method name="addStorageController">
5027	<desc>
5028	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5029	machine and returns it as an instance of
5030	<link to="IStorageController" />.
5031
5032	@a name identifies the controller for subsequent calls such as
5033	<link to="#getStorageControllerByName" />,
5034	<link to="#getStorageControllerByInstance" />,
5035	<link to="#removeStorageController" />,
5036	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5037
5038	After the controller has been added, you can set its exact
5039	type by setting the <link to="IStorageController::controllerType" />.
5040
5041	<result name="VBOX_E_OBJECT_IN_USE">
5042	A storage controller with given name exists already.
5043	</result>
5044	<result name="E_INVALIDARG">
5045	Invalid @a controllerType.
5046	</result>
5047	</desc>
5048	<param name="name" type="wstring" dir="in"/>
5049	<param name="connectionType" type="StorageBus" dir="in"/>
5050	<param name="controller" type="IStorageController" dir="return"/>
5051	</method>
5052
5053	<method name="getStorageControllerByName" const="yes">
5054	<desc>
5055	Returns a storage controller with the given name.
5056
5057	<result name="VBOX_E_OBJECT_NOT_FOUND">
5058	A storage controller with given name doesn't exist.
5059	</result>
5060	</desc>
5061	<param name="name" type="wstring" dir="in"/>
5062	<param name="storageController" type="IStorageController" dir="return"/>
5063	</method>
5064
5065	<method name="getStorageControllerByInstance" const="yes">
5066	<desc>
5067	Returns a storage controller with the given instance number.
5068
5069	<result name="VBOX_E_OBJECT_NOT_FOUND">
5070	A storage controller with given instance number doesn't exist.
5071	</result>
5072	</desc>
5073	<param name="instance" type="unsigned long" dir="in"/>
5074	<param name="storageController" type="IStorageController" dir="return"/>
5075	</method>
5076
5077	<method name="removeStorageController">
5078	<desc>
5079	Removes a storage controller from the machine.
5080
5081	<result name="VBOX_E_OBJECT_NOT_FOUND">
5082	A storage controller with given name doesn't exist.
5083	</result>
5084	</desc>
5085	<param name="name" type="wstring" dir="in"/>
5086	</method>
5087
5088	<method name="setStorageControllerBootable">
5089	<desc>
5090	Sets the bootable flag of the storage controller with the given name.
5091
5092	<result name="VBOX_E_OBJECT_NOT_FOUND">
5093	A storage controller with given name doesn't exist.
5094	</result>
5095	<result name="VBOX_E_OBJECT_IN_USE">
5096	Another storage controller is marked as bootable already.
5097	</result>
5098	</desc>
5099	<param name="name" type="wstring" dir="in"/>
5100	<param name="bootable" type="boolean" dir="in"/>
5101	</method>
5102
5103	<method name="getSerialPort" const="yes">
5104	<desc>
5105	Returns the serial port associated with the given slot.
5106	Slots are numbered sequentially, starting with zero. The total
5107	number of serial ports per machine is defined by the
5108	<link to="ISystemProperties::serialPortCount"/> property,
5109	so the maximum slot number is one less than that property's value.
5110
5111	<result name="E_INVALIDARG">
5112	Invalid @a slot number.
5113	</result>
5114
5115	</desc>
5116	<param name="slot" type="unsigned long" dir="in"/>
5117	<param name="port" type="ISerialPort" dir="return"/>
5118	</method>
5119
5120	<method name="getParallelPort" const="yes">
5121	<desc>
5122	Returns the parallel port associated with the given slot.
5123	Slots are numbered sequentially, starting with zero. The total
5124	number of parallel ports per machine is defined by the
5125	<link to="ISystemProperties::parallelPortCount"/> property,
5126	so the maximum slot number is one less than that property's value.
5127
5128	<result name="E_INVALIDARG">
5129	Invalid @a slot number.
5130	</result>
5131
5132	</desc>
5133	<param name="slot" type="unsigned long" dir="in"/>
5134	<param name="port" type="IParallelPort" dir="return"/>
5135	</method>
5136
5137	<method name="getExtraDataKeys">
5138	<desc>
5139	Returns an array representing the machine-specific extra data keys
5140	which currently have values defined.
5141	</desc>
5142	<param name="value" type="wstring" dir="return" safearray="yes">
5143	<desc>Array of extra data keys.</desc>
5144	</param>
5145	</method>
5146
5147	<method name="getExtraData">
5148	<desc>
5149	Returns associated machine-specific extra data.
5150
5151	If the requested data @a key does not exist, this function will
5152	succeed and return an empty string in the @a value argument.
5153
5154	<result name="VBOX_E_FILE_ERROR">
5155	Settings file not accessible.
5156	</result>
5157	<result name="VBOX_E_XML_ERROR">
5158	Could not parse the settings file.
5159	</result>
5160
5161	</desc>
5162	<param name="key" type="wstring" dir="in">
5163	<desc>Name of the data key to get.</desc>
5164	</param>
5165	<param name="value" type="wstring" dir="return">
5166	<desc>Value of the requested data key.</desc>
5167	</param>
5168	</method>
5169
5170	<method name="setExtraData">
5171	<desc>
5172	Sets associated machine-specific extra data.
5173
5174	If you pass @c null or an empty string as a key @a value, the given
5175	@a key will be deleted.
5176
5177	<note>
5178	Before performing the actual data change, this method will ask all
5179	registered listeners using the
5180	<link to="IExtraDataCanChangeEvent"/>
5181	notification for a permission. If one of the listeners refuses the
5182	new value, the change will not be performed.
5183	</note>
5184	<note>
5185	On success, the
5186	<link to="IExtraDataChangedEvent"/> notification
5187	is called to inform all registered listeners about a successful data
5188	change.
5189	</note>
5190	<note>
5191	This method can be called outside the machine session and therefore
5192	it's a caller's responsibility to handle possible race conditions
5193	when several clients change the same key at the same time.
5194	</note>
5195
5196	<result name="VBOX_E_FILE_ERROR">
5197	Settings file not accessible.
5198	</result>
5199	<result name="VBOX_E_XML_ERROR">
5200	Could not parse the settings file.
5201	</result>
5202
5203	</desc>
5204	<param name="key" type="wstring" dir="in">
5205	<desc>Name of the data key to set.</desc>
5206	</param>
5207	<param name="value" type="wstring" dir="in">
5208	<desc>Value to assign to the key.</desc>
5209	</param>
5210	</method>
5211
5212	<method name="getCPUProperty" const="yes">
5213	<desc>
5214	Returns the virtual CPU boolean value of the specified property.
5215
5216	<result name="E_INVALIDARG">
5217	Invalid property.
5218	</result>
5219
5220	</desc>
5221	<param name="property" type="CPUPropertyType" dir="in">
5222	<desc>
5223	Property type to query.
5224	</desc>
5225	</param>
5226	<param name="value" type="boolean" dir="return">
5227	<desc>
5228	Property value.
5229	</desc>
5230	</param>
5231	</method>
5232
5233	<method name="setCPUProperty">
5234	<desc>
5235	Sets the virtual CPU boolean value of the specified property.
5236
5237	<result name="E_INVALIDARG">
5238	Invalid property.
5239	</result>
5240
5241	</desc>
5242	<param name="property" type="CPUPropertyType" dir="in">
5243	<desc>
5244	Property type to query.
5245	</desc>
5246	</param>
5247	<param name="value" type="boolean" dir="in">
5248	<desc>
5249	Property value.
5250	</desc>
5251	</param>
5252	</method>
5253
5254	<method name="getCPUIDLeaf" const="yes">
5255	<desc>
5256	Returns the virtual CPU cpuid information for the specified leaf.
5257
5258	Currently supported index values for cpuid:
5259	Standard CPUID leafs: 0 - 0xA
5260	Extended CPUID leafs: 0x80000000 - 0x8000000A
5261
5262	See the Intel and AMD programmer's manuals for detailed information
5263	about the cpuid instruction and its leafs.
5264	<result name="E_INVALIDARG">
5265	Invalid id.
5266	</result>
5267
5268	</desc>
5269	<param name="id" type="unsigned long" dir="in">
5270	<desc>
5271	CPUID leaf index.
5272	</desc>
5273	</param>
5274	<param name="valEax" type="unsigned long" dir="out">
5275	<desc>
5276	CPUID leaf value for register eax.
5277	</desc>
5278	</param>
5279	<param name="valEbx" type="unsigned long" dir="out">
5280	<desc>
5281	CPUID leaf value for register ebx.
5282	</desc>
5283	</param>
5284	<param name="valEcx" type="unsigned long" dir="out">
5285	<desc>
5286	CPUID leaf value for register ecx.
5287	</desc>
5288	</param>
5289	<param name="valEdx" type="unsigned long" dir="out">
5290	<desc>
5291	CPUID leaf value for register edx.
5292	</desc>
5293	</param>
5294	</method>
5295
5296	<method name="setCPUIDLeaf">
5297	<desc>
5298	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5299	are not passed unmodified. VirtualBox clears features that it doesn't support.
5300
5301	Currently supported index values for cpuid:
5302	Standard CPUID leafs: 0 - 0xA
5303	Extended CPUID leafs: 0x80000000 - 0x8000000A
5304
5305	See the Intel and AMD programmer's manuals for detailed information
5306	about the cpuid instruction and its leafs.
5307
5308	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5309	random crashes inside VMs.
5310	<result name="E_INVALIDARG">
5311	Invalid id.
5312	</result>
5313
5314	</desc>
5315	<param name="id" type="unsigned long" dir="in">
5316	<desc>
5317	CPUID leaf index.
5318	</desc>
5319	</param>
5320	<param name="valEax" type="unsigned long" dir="in">
5321	<desc>
5322	CPUID leaf value for register eax.
5323	</desc>
5324	</param>
5325	<param name="valEbx" type="unsigned long" dir="in">
5326	<desc>
5327	CPUID leaf value for register ebx.
5328	</desc>
5329	</param>
5330	<param name="valEcx" type="unsigned long" dir="in">
5331	<desc>
5332	CPUID leaf value for register ecx.
5333	</desc>
5334	</param>
5335	<param name="valEdx" type="unsigned long" dir="in">
5336	<desc>
5337	CPUID leaf value for register edx.
5338	</desc>
5339	</param>
5340	</method>
5341
5342	<method name="removeCPUIDLeaf">
5343	<desc>
5344	Removes the virtual CPU cpuid leaf for the specified index
5345
5346	<result name="E_INVALIDARG">
5347	Invalid id.
5348	</result>
5349
5350	</desc>
5351	<param name="id" type="unsigned long" dir="in">
5352	<desc>
5353	CPUID leaf index.
5354	</desc>
5355	</param>
5356	</method>
5357
5358	<method name="removeAllCPUIDLeaves">
5359	<desc>
5360	Removes all the virtual CPU cpuid leaves
5361	</desc>
5362	</method>
5363
5364	<method name="getHWVirtExProperty" const="yes">
5365	<desc>
5366	Returns the value of the specified hardware virtualization boolean property.
5367
5368	<result name="E_INVALIDARG">
5369	Invalid property.
5370	</result>
5371
5372	</desc>
5373	<param name="property" type="HWVirtExPropertyType" dir="in">
5374	<desc>
5375	Property type to query.
5376	</desc>
5377	</param>
5378	<param name="value" type="boolean" dir="return">
5379	<desc>
5380	Property value.
5381	</desc>
5382	</param>
5383	</method>
5384
5385	<method name="setHWVirtExProperty">
5386	<desc>
5387	Sets a new value for the specified hardware virtualization boolean property.
5388
5389	<result name="E_INVALIDARG">
5390	Invalid property.
5391	</result>
5392
5393	</desc>
5394	<param name="property" type="HWVirtExPropertyType" dir="in">
5395	<desc>
5396	Property type to set.
5397	</desc>
5398	</param>
5399	<param name="value" type="boolean" dir="in">
5400	<desc>
5401	New property value.
5402	</desc>
5403	</param>
5404	</method>
5405
5406	<method name="saveSettings">
5407	<desc>
5408	Saves any changes to machine settings made since the session
5409	has been opened or a new machine has been created, or since the
5410	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5411	For registered machines, new settings become visible to all
5412	other VirtualBox clients after successful invocation of this
5413	method.
5414	<note>
5415	The method sends <link to="IMachineDataChangedEvent"/>
5416	notification event after the configuration has been successfully
5417	saved (only for registered machines).
5418	</note>
5419	<note>
5420	Calling this method is only valid on instances returned
5421	by <link to="ISession::machine"/> and on new machines
5422	created by <link to="IVirtualBox::createMachine"/> but not
5423	yet registered, or on unregistered machines after calling
5424	<link to="IMachine::unregister"/>.
5425	</note>
5426
5427	<result name="VBOX_E_FILE_ERROR">
5428	Settings file not accessible.
5429	</result>
5430	<result name="VBOX_E_XML_ERROR">
5431	Could not parse the settings file.
5432	</result>
5433	<result name="E_ACCESSDENIED">
5434	Modification request refused.
5435	</result>
5436
5437	</desc>
5438	</method>
5439
5440	<method name="discardSettings">
5441	<desc>
5442	Discards any changes to the machine settings made since the session
5443	has been opened or since the last call to <link to="#saveSettings"/>
5444	or <link to="#discardSettings"/>.
5445	<note>
5446	Calling this method is only valid on instances returned
5447	by <link to="ISession::machine"/> and on new machines
5448	created by <link to="IVirtualBox::createMachine"/> or
5449	opened by <link to="IVirtualBox::openMachine"/> but not
5450	yet registered, or on unregistered machines after calling
5451	<link to="IMachine::unregister"/>.
5452	</note>
5453
5454	<result name="VBOX_E_INVALID_VM_STATE">
5455	Virtual machine is not mutable.
5456	</result>
5457
5458	</desc>
5459	</method>
5460
5461	<method name="unregister">
5462	<desc>
5463	Unregisters a machine previously registered with
5464	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5465	cleanup before the machine is unregistered.
5466
5467	This method does not delete any files. It only changes the machine configuration and
5468	the list of registered machines in the VirtualBox object. To delete the files which
5469	belonged to the machine, including the XML file of the machine itself, call
5470	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5471	from this method.
5472
5473	How thoroughly this method cleans up the machine configuration before unregistering
5474	the machine depends on the @a cleanupMode argument.
5475
5476	<ul>
5477	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5478	cleanup will be performed. The call will fail if the machine is in "Saved" state
5479	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5480	It is the responsibility of the caller to delete all such configuration in this mode.
5481	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5482	which it replaces.</li>
5483	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5484	state or if it has snapshots or media attached. All media attached to the current machine
5485	state or in snapshots will be detached. No medium objects will be returned;
5486	all of the machine's media will remain open.</li>
5487	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5488	except that all the hard disk medium objects which were detached from the machine will
5489	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5490	API for closing and deletion.</li>
5491	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5492	that all media will be returned in the array, including removable media like DVDs and
5493	floppies. This might be useful if the user wants to inspect in detail which media were
5494	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5495	in that case because users will typically want to preserve ISO and RAW image files.</li>
5496	</ul>
5497
5498	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5499	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5500	deleted with all its saved states and hard disk images, but images for removable
5501	drives (such as ISO and RAW files) will remain on disk.
5502
5503	This API does not verify whether the media files returned in the array are still
5504	attached to other machines (i.e. shared between several machines). If such a shared
5505	image is passed to <link to="#delete" /> however, closing the image will fail there
5506	and the image will be silently skipped.
5507
5508	This API may, however, move media from this machine's media registry to other media
5509	registries (see <link to="IMedium" /> for details on media registries). For machines
5510	created with VirtualBox 4.0 or later, if media from this machine's media registry
5511	are also attached to another machine (shared attachments), each such medium will be
5512	moved to another machine's registry. This is because without this machine's media
5513	registry, the other machine cannot find its media any more and would become inaccessible.
5514
5515	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5516	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5517	if media are moved to other machines' media registries.
5518
5519	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5520	is fired.
5521
5522	The call will fail if the machine is currently locked (see <link to="ISession" />).
5523
5524	<note>
5525	If the given machine is inaccessible (see <link to="#accessible"/>), it
5526	will be unregistered and fully uninitialized right afterwards. As a result,
5527	the returned machine object will be unusable and an attempt to call
5528	<b>any</b> method will return the "Object not ready" error.
5529	</note>
5530
5531	<result name="VBOX_E_INVALID_OBJECT_STATE">
5532	Machine is currently locked for a session.
5533	</result>
5534	</desc>
5535
5536	<param name="cleanupMode" type="CleanupMode" dir="in">
5537	<desc>How to clean up after the machine has been unregistered.</desc>
5538	</param>
5539	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5540	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5541	</param>
5542	</method>
5543
5544	<method name="delete">
5545	<desc>
5546	Deletes the files associated with this machine from disk. If medium objects are passed
5547	in with the @a aMedia argument, they are closed and, if closing was successful, their
5548	storage files are deleted as well. For convenience, this array of media files can be
5549	the same as the one returned from a previous <link to="#unregister" /> call.
5550
5551	This method must only be called on machines which are either write-locked (i.e. on instances
5552	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5553	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5554	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5555
5556	The following files will be deleted by this method:
5557	<ul>
5558	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5559	argument other than "UnregisterOnly", this will delete all saved state files that
5560	the machine had in use; possibly one if the machine was in "Saved" state and one
5561	for each online snapshot that the machine had.</li>
5562	<li>On each medium object passed in the @a aMedia array, this will call
5563	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5564	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5565	in use, e.g. because it is still attached to a second machine; in that case the
5566	storage will not be deleted.</li>
5567	<li>Finally, the machine's own XML file will be deleted.</li>
5568	</ul>
5569
5570	Since deleting large disk image files can be a time-consuming I/O operation, this
5571	method operates asynchronously and returns an IProgress object to allow the caller
5572	to monitor the progress. There will be one sub-operation for each file that is
5573	being deleted (saved state or medium storage file).
5574
5575	<note>
5576	<link to="#settingsModified"/> will return @c true after this
5577	method successfully returns.
5578	</note>
5579
5580	<result name="VBOX_E_INVALID_VM_STATE">
5581	Machine is registered but not write-locked.
5582	</result>
5583	<result name="VBOX_E_IPRT_ERROR">
5584	Could not delete the settings file.
5585	</result>
5586	</desc>
5587	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5588	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5589	</param>
5590	<param name="aProgress" type="IProgress" dir="return">
5591	<desc>Progress object to track the operation completion.</desc>
5592	</param>
5593	</method>
5594
5595	<method name="export">
5596	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5597	steps required to export VirtualBox machines to OVF.
5598	</desc>
5599
5600	<param name="aAppliance" type="IAppliance" dir="in">
5601	<desc>Appliance to export this machine to.</desc>
5602	</param>
5603	<param name="location" type="wstring" dir="in">
5604	<desc>The target location.</desc>
5605	</param>
5606	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5607	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5608	</param>
5609	</method >
5610
5611	<method name="findSnapshot">
5612	<desc>
5613	Returns a snapshot of this machine with the given name or UUID.
5614
5615	Returns a snapshot of this machine with the given UUID.
5616	A @c null argument can be used to obtain the first snapshot
5617	taken on this machine. To traverse the whole tree of snapshots
5618	starting from the root, inspect the root snapshot's
5619	<link to="ISnapshot::children" /> attribute and recurse over those children.
5620
5621	<result name="VBOX_E_OBJECT_NOT_FOUND">
5622	Virtual machine has no snapshots or snapshot not found.
5623	</result>
5624
5625	</desc>
5626	<param name="nameOrId" type="wstring" dir="in">
5627	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5628	</param>
5629	<param name="snapshot" type="ISnapshot" dir="return">
5630	<desc>Snapshot object with the given name.</desc>
5631	</param>
5632	</method>
5633
5634	<method name="createSharedFolder">
5635	<desc>
5636	Creates a new permanent shared folder by associating the given logical
5637	name with the given host path, adds it to the collection of shared
5638	folders and starts sharing it. Refer to the description of
5639	<link to="ISharedFolder"/> to read more about logical names.
5640
5641	<result name="VBOX_E_OBJECT_IN_USE">
5642	Shared folder already exists.
5643	</result>
5644	<result name="VBOX_E_FILE_ERROR">
5645	Shared folder @a hostPath not accessible.
5646	</result>
5647
5648	</desc>
5649	<param name="name" type="wstring" dir="in">
5650	<desc>Unique logical name of the shared folder.</desc>
5651	</param>
5652	<param name="hostPath" type="wstring" dir="in">
5653	<desc>Full path to the shared folder in the host file system.</desc>
5654	</param>
5655	<param name="writable" type="boolean" dir="in">
5656	<desc>Whether the share is writable or readonly.</desc>
5657	</param>
5658	<param name="automount" type="boolean" dir="in">
5659	<desc>Whether the share gets automatically mounted by the guest
5660	or not.</desc>
5661	</param>
5662	</method>
5663
5664	<method name="removeSharedFolder">
5665	<desc>
5666	Removes the permanent shared folder with the given name previously
5667	created by <link to="#createSharedFolder"/> from the collection of
5668	shared folders and stops sharing it.
5669
5670	<result name="VBOX_E_INVALID_VM_STATE">
5671	Virtual machine is not mutable.
5672	</result>
5673	<result name="VBOX_E_OBJECT_NOT_FOUND">
5674	Shared folder @a name does not exist.
5675	</result>
5676
5677	</desc>
5678	<param name="name" type="wstring" dir="in">
5679	<desc>Logical name of the shared folder to remove.</desc>
5680	</param>
5681	</method>
5682
5683	<method name="canShowConsoleWindow">
5684	<desc>
5685	Returns @c true if the VM console process can activate the
5686	console window and bring it to foreground on the desktop of
5687	the host PC.
5688	<note>
5689	This method will fail if a session for this machine is not
5690	currently open.
5691	</note>
5692
5693	<result name="VBOX_E_INVALID_VM_STATE">
5694	Machine session is not open.
5695	</result>
5696
5697	</desc>
5698	<param name="canShow" type="boolean" dir="return">
5699	<desc>
5700	@c true if the console window can be shown and @c false otherwise.
5701	</desc>
5702	</param>
5703	</method>
5704
5705	<method name="showConsoleWindow">
5706	<desc>
5707	Activates the console window and brings it to foreground on
5708	the desktop of the host PC. Many modern window managers on
5709	many platforms implement some sort of focus stealing
5710	prevention logic, so that it may be impossible to activate
5711	a window without the help of the currently active
5712	application. In this case, this method will return a non-zero
5713	identifier that represents the top-level window of the VM
5714	console process. The caller, if it represents a currently
5715	active process, is responsible to use this identifier (in a
5716	platform-dependent manner) to perform actual window
5717	activation.
5718	<note>
5719	This method will fail if a session for this machine is not
5720	currently open.
5721	</note>
5722
5723	<result name="VBOX_E_INVALID_VM_STATE">
5724	Machine session is not open.
5725	</result>
5726
5727	</desc>
5728	<param name="winId" type="long long" dir="return">
5729	<desc>
5730	Platform-dependent identifier of the top-level VM console
5731	window, or zero if this method has performed all actions
5732	necessary to implement the <i>show window</i> semantics for
5733	the given platform and/or VirtualBox front-end.
5734	</desc>
5735	</param>
5736	</method>
5737
5738	<method name="getGuestProperty" const="yes">
5739	<desc>
5740	Reads an entry from the machine's guest property store.
5741
5742	<result name="VBOX_E_INVALID_VM_STATE">
5743	Machine session is not open.
5744	</result>
5745
5746	</desc>
5747	<param name="name" type="wstring" dir="in">
5748	<desc>
5749	The name of the property to read.
5750	</desc>
5751	</param>
5752	<param name="value" type="wstring" dir="out">
5753	<desc>
5754	The value of the property. If the property does not exist then this
5755	will be empty.
5756	</desc>
5757	</param>
5758	<param name="timestamp" type="long long" dir="out">
5759	<desc>
5760	The time at which the property was last modified, as seen by the
5761	server process.
5762	</desc>
5763	</param>
5764	<param name="flags" type="wstring" dir="out">
5765	<desc>
5766	Additional property parameters, passed as a comma-separated list of
5767	"name=value" type entries.
5768	</desc>
5769	</param>
5770	</method>
5771
5772	<method name="getGuestPropertyValue" const="yes">
5773	<desc>
5774	Reads a value from the machine's guest property store.
5775
5776	<result name="VBOX_E_INVALID_VM_STATE">
5777	Machine session is not open.
5778	</result>
5779
5780	</desc>
5781	<param name="property" type="wstring" dir="in">
5782	<desc>
5783	The name of the property to read.
5784	</desc>
5785	</param>
5786	<param name="value" type="wstring" dir="return">
5787	<desc>
5788	The value of the property. If the property does not exist then this
5789	will be empty.
5790	</desc>
5791	</param>
5792	</method>
5793
5794	<method name="getGuestPropertyTimestamp" const="yes">
5795	<desc>
5796	Reads a property timestamp from the machine's guest property store.
5797
5798	<result name="VBOX_E_INVALID_VM_STATE">
5799	Machine session is not open.
5800	</result>
5801
5802	</desc>
5803	<param name="property" type="wstring" dir="in">
5804	<desc>
5805	The name of the property to read.
5806	</desc>
5807	</param>
5808	<param name="value" type="long long" dir="return">
5809	<desc>
5810	The timestamp. If the property does not exist then this will be
5811	empty.
5812	</desc>
5813	</param>
5814	</method>
5815
5816	<method name="setGuestProperty">
5817	<desc>
5818	Sets, changes or deletes an entry in the machine's guest property
5819	store.
5820
5821	<result name="E_ACCESSDENIED">
5822	Property cannot be changed.
5823	</result>
5824	<result name="E_INVALIDARG">
5825	Invalid @a flags.
5826	</result>
5827	<result name="VBOX_E_INVALID_VM_STATE">
5828	Virtual machine is not mutable or session not open.
5829	</result>
5830	<result name="VBOX_E_INVALID_OBJECT_STATE">
5831	Cannot set transient property when machine not running.
5832	</result>
5833
5834	</desc>
5835	<param name="property" type="wstring" dir="in">
5836	<desc>
5837	The name of the property to set, change or delete.
5838	</desc>
5839	</param>
5840	<param name="value" type="wstring" dir="in">
5841	<desc>
5842	The new value of the property to set, change or delete. If the
5843	property does not yet exist and value is non-empty, it will be
5844	created. If the value is @c null or empty, the property will be
5845	deleted if it exists.
5846	</desc>
5847	</param>
5848	<param name="flags" type="wstring" dir="in">
5849	<desc>
5850	Additional property parameters, passed as a comma-separated list of
5851	"name=value" type entries.
5852	</desc>
5853	</param>
5854	</method>
5855
5856	<method name="setGuestPropertyValue">
5857	<desc>
5858	Sets, changes or deletes a value in the machine's guest property
5859	store. The flags field will be left unchanged or created empty for a
5860	new property.
5861
5862	<result name="E_ACCESSDENIED">
5863	Property cannot be changed.
5864	</result>
5865	<result name="VBOX_E_INVALID_VM_STATE">
5866	Virtual machine is not mutable or session not open.
5867	</result>
5868	<result name="VBOX_E_INVALID_OBJECT_STATE">
5869	Cannot set transient property when machine not running.
5870	</result>
5871	</desc>
5872
5873	<param name="property" type="wstring" dir="in">
5874	<desc>
5875	The name of the property to set, change or delete.
5876	</desc>
5877	</param>
5878	<param name="value" type="wstring" dir="in">
5879	<desc>
5880	The new value of the property to set, change or delete. If the
5881	property does not yet exist and value is non-empty, it will be
5882	created. If the value is @c null or empty, the property will be
5883	deleted if it exists.
5884	</desc>
5885	</param>
5886	</method>
5887
5888	<method name="enumerateGuestProperties" const="yes">
5889	<desc>
5890	Return a list of the guest properties matching a set of patterns along
5891	with their values, time stamps and flags.
5892	</desc>
5893	<param name="patterns" type="wstring" dir="in">
5894	<desc>
5895	The patterns to match the properties against, separated by '\|'
5896	characters. If this is empty or @c null, all properties will match.
5897	</desc>
5898	</param>
5899	<param name="name" type="wstring" dir="out" safearray="yes">
5900	<desc>
5901	The names of the properties returned.
5902	</desc>
5903	</param>
5904	<param name="value" type="wstring" dir="out" safearray="yes">
5905	<desc>
5906	The values of the properties returned. The array entries match the
5907	corresponding entries in the @a name array.
5908	</desc>
5909	</param>
5910	<param name="timestamp" type="long long" dir="out" safearray="yes">
5911	<desc>
5912	The time stamps of the properties returned. The array entries match
5913	the corresponding entries in the @a name array.
5914	</desc>
5915	</param>
5916	<param name="flags" type="wstring" dir="out" safearray="yes">
5917	<desc>
5918	The flags of the properties returned. The array entries match the
5919	corresponding entries in the @a name array.
5920	</desc>
5921	</param>
5922	</method>
5923
5924	<method name="querySavedGuestSize" const="yes">
5925	<desc>
5926	Returns the guest dimensions from the saved state.
5927	</desc>
5928	<param name="screenId" type="unsigned long" dir="in">
5929	<desc>
5930	Saved guest screen to query info from.
5931	</desc>
5932	</param>
5933	<param name="width" type="unsigned long" dir="out">
5934	<desc>
5935	Guest width at the time of the saved state was taken.
5936	</desc>
5937	</param>
5938	<param name="height" type="unsigned long" dir="out">
5939	<desc>
5940	Guest height at the time of the saved state was taken.
5941	</desc>
5942	</param>
5943	</method>
5944
5945	<method name="querySavedThumbnailSize">
5946	<desc>
5947	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5948	</desc>
5949	<param name="screenId" type="unsigned long" dir="in">
5950	<desc>
5951	Saved guest screen to query info from.
5952	</desc>
5953	</param>
5954	<param name="size" type="unsigned long" dir="out">
5955	<desc>
5956	Size of buffer required to store the bitmap.
5957	</desc>
5958	</param>
5959	<param name="width" type="unsigned long" dir="out">
5960	<desc>
5961	Bitmap width.
5962	</desc>
5963	</param>
5964	<param name="height" type="unsigned long" dir="out">
5965	<desc>
5966	Bitmap height.
5967	</desc>
5968	</param>
5969	</method>
5970
5971	<method name="readSavedThumbnailToArray">
5972	<desc>
5973	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5974	</desc>
5975	<param name="screenId" type="unsigned long" dir="in">
5976	<desc>
5977	Saved guest screen to read from.
5978	</desc>
5979	</param>
5980	<param name="BGR" type="boolean" dir="in">
5981	<desc>
5982	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5983	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5984	</desc>
5985	</param>
5986	<param name="width" type="unsigned long" dir="out">
5987	<desc>
5988	Bitmap width.
5989	</desc>
5990	</param>
5991	<param name="height" type="unsigned long" dir="out">
5992	<desc>
5993	Bitmap height.
5994	</desc>
5995	</param>
5996	<param name="data" type="octet" safearray="yes" dir="return">
5997	<desc>
5998	Array with resulting bitmap data.
5999	</desc>
6000	</param>
6001	</method>
6002
6003	<method name="readSavedThumbnailPNGToArray">
6004	<desc>
6005	Thumbnail in PNG format is retrieved to an array of bytes.
6006	</desc>
6007	<param name="screenId" type="unsigned long" dir="in">
6008	<desc>
6009	Saved guest screen to read from.
6010	</desc>
6011	</param>
6012	<param name="width" type="unsigned long" dir="out">
6013	<desc>
6014	Image width.
6015	</desc>
6016	</param>
6017	<param name="height" type="unsigned long" dir="out">
6018	<desc>
6019	Image height.
6020	</desc>
6021	</param>
6022	<param name="data" type="octet" dir="return" safearray="yes">
6023	<desc>
6024	Array with resulting PNG data.
6025	</desc>
6026	</param>
6027	</method>
6028
6029	<method name="querySavedScreenshotPNGSize">
6030	<desc>
6031	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6032	</desc>
6033	<param name="screenId" type="unsigned long" dir="in">
6034	<desc>
6035	Saved guest screen to query info from.
6036	</desc>
6037	</param>
6038	<param name="size" type="unsigned long" dir="out">
6039	<desc>
6040	Size of buffer required to store the PNG binary data.
6041	</desc>
6042	</param>
6043	<param name="width" type="unsigned long" dir="out">
6044	<desc>
6045	Image width.
6046	</desc>
6047	</param>
6048	<param name="height" type="unsigned long" dir="out">
6049	<desc>
6050	Image height.
6051	</desc>
6052	</param>
6053	</method>
6054
6055	<method name="readSavedScreenshotPNGToArray">
6056	<desc>
6057	Screenshot in PNG format is retrieved to an array of bytes.
6058	</desc>
6059	<param name="screenId" type="unsigned long" dir="in">
6060	<desc>
6061	Saved guest screen to read from.
6062	</desc>
6063	</param>
6064	<param name="width" type="unsigned long" dir="out">
6065	<desc>
6066	Image width.
6067	</desc>
6068	</param>
6069	<param name="height" type="unsigned long" dir="out">
6070	<desc>
6071	Image height.
6072	</desc>
6073	</param>
6074	<param name="data" type="octet" dir="return" safearray="yes">
6075	<desc>
6076	Array with resulting PNG data.
6077	</desc>
6078	</param>
6079	</method>
6080
6081	<method name="hotPlugCPU">
6082	<desc>
6083	Plugs a CPU into the machine.
6084	</desc>
6085	<param name="cpu" type="unsigned long" dir="in">
6086	<desc>
6087	The CPU id to insert.
6088	</desc>
6089	</param>
6090	</method>
6091
6092	<method name="hotUnplugCPU">
6093	<desc>
6094	Removes a CPU from the machine.
6095	</desc>
6096	<param name="cpu" type="unsigned long" dir="in">
6097	<desc>
6098	The CPU id to remove.
6099	</desc>
6100	</param>
6101	</method>
6102
6103	<method name="getCPUStatus">
6104	<desc>
6105	Returns the current status of the given CPU.
6106	</desc>
6107	<param name="cpu" type="unsigned long" dir="in">
6108	<desc>
6109	The CPU id to check for.
6110	</desc>
6111	</param>
6112	<param name="attached" type="boolean" dir="return">
6113	<desc>
6114	Status of the CPU.
6115	</desc>
6116	</param>
6117	</method>
6118
6119	<method name="queryLogFilename">
6120	<desc>
6121	Queries for the VM log file name of an given index. Returns an empty
6122	string if a log file with that index doesn't exists.
6123	</desc>
6124	<param name="idx" type="unsigned long" dir="in">
6125	<desc>
6126	Which log file name to query. 0=current log file.
6127	</desc>
6128	</param>
6129	<param name="filename" type="wstring" dir="return">
6130	<desc>
6131	On return the full path to the log file or an empty string on error.
6132	</desc>
6133	</param>
6134	</method>
6135
6136	<method name="readLog">
6137	<desc>
6138	Reads the VM log file. The chunk size is limited, so even if you
6139	ask for a big piece there might be less data returned.
6140	</desc>
6141	<param name="idx" type="unsigned long" dir="in">
6142	<desc>
6143	Which log file to read. 0=current log file.
6144	</desc>
6145	</param>
6146	<param name="offset" type="long long" dir="in">
6147	<desc>
6148	Offset in the log file.
6149	</desc>
6150	</param>
6151	<param name="size" type="long long" dir="in">
6152	<desc>
6153	Chunk size to read in the log file.
6154	</desc>
6155	</param>
6156	<param name="data" type="octet" dir="return" safearray="yes">
6157	<desc>
6158	Data read from the log file. A data size of 0 means end of file
6159	if the requested chunk size was not 0. This is the unprocessed
6160	file data, i.e. the line ending style depends on the platform of
6161	the system the server is running on.
6162	</desc>
6163	</param>
6164	</method>
6165
6166	<method name="cloneTo">
6167	<desc>
6168	Creates a clone of this machine, either as a full clone (which means
6169	creating independent copies of the hard disk media, save states and so
6170	on), or as a linked clone (which uses its own differencing media,
6171	sharing the parent media with the source machine).
6172
6173	The target machine object must have been created previously with <link
6174	to="IVirtualBox::createMachine"/>, and all the settings will be
6175	transferred except the VM name and the hardware UUID. You can set the
6176	VM name and the new hardware UUID when creating the target machine. The
6177	network MAC addresses are newly created for all newtwork adapters. You
6178	can change that behaviour with the options parameter. The operation is
6179	performed asynchronously, so the machine object will be not be usable
6180	until the @a progress object signals completion.
6181
6182	<result name="E_INVALIDARG">
6183	@a target is @c null.
6184	</result>
6185	</desc>
6186
6187	<param name="target" type="IMachine" dir="in">
6188	<desc>Target machine object.</desc>
6189	</param>
6190	<param name="mode" type="CloneMode" dir="in">
6191	<desc>Which states should be cloned.</desc>
6192	</param>
6193	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6194	<desc>Options for the cloning operation.</desc>
6195	</param>
6196	<param name="progress" type="IProgress" dir="return">
6197	<desc>Progress object to track the operation completion.</desc>
6198	</param>
6199	</method>
6200
6201	</interface>
6202
6203	<!--
6204	// IConsole
6205	/////////////////////////////////////////////////////////////////////////
6206	-->
6207
6208	<interface
6209	name="IVRDEServerInfo" extends="$unknown"
6210	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6211	wsmap="struct"
6212	>
6213	<desc>
6214	Contains information about the remote desktop (VRDE) server capabilities and status.
6215	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6216	</desc>
6217
6218	<attribute name="active" type="boolean" readonly="yes">
6219	<desc>
6220	Whether the remote desktop connection is active.
6221	</desc>
6222	</attribute>
6223
6224	<attribute name="port" type="long" readonly="yes">
6225	<desc>
6226	VRDE server port number. If this property is equal to <tt>0</tt>, then
6227	the VRDE server failed to start, usually because there are no free IP
6228	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6229	server has not yet been started.
6230	</desc>
6231	</attribute>
6232
6233	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6234	<desc>
6235	How many times a client connected.
6236	</desc>
6237	</attribute>
6238
6239	<attribute name="beginTime" type="long long" readonly="yes">
6240	<desc>
6241	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6242	</desc>
6243	</attribute>
6244
6245	<attribute name="endTime" type="long long" readonly="yes">
6246	<desc>
6247	When the last connection was terminated or the current time, if
6248	connection is still active, in milliseconds since 1970-01-01 UTC.
6249	</desc>
6250	</attribute>
6251
6252	<attribute name="bytesSent" type="long long" readonly="yes">
6253	<desc>
6254	How many bytes were sent in last or current, if still active, connection.
6255	</desc>
6256	</attribute>
6257
6258	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6259	<desc>
6260	How many bytes were sent in all connections.
6261	</desc>
6262	</attribute>
6263
6264	<attribute name="bytesReceived" type="long long" readonly="yes">
6265	<desc>
6266	How many bytes were received in last or current, if still active, connection.
6267	</desc>
6268	</attribute>
6269
6270	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6271	<desc>
6272	How many bytes were received in all connections.
6273	</desc>
6274	</attribute>
6275
6276	<attribute name="user" type="wstring" readonly="yes">
6277	<desc>
6278	Login user name supplied by the client.
6279	</desc>
6280	</attribute>
6281
6282	<attribute name="domain" type="wstring" readonly="yes">
6283	<desc>
6284	Login domain name supplied by the client.
6285	</desc>
6286	</attribute>
6287
6288	<attribute name="clientName" type="wstring" readonly="yes">
6289	<desc>
6290	The client name supplied by the client.
6291	</desc>
6292	</attribute>
6293
6294	<attribute name="clientIP" type="wstring" readonly="yes">
6295	<desc>
6296	The IP address of the client.
6297	</desc>
6298	</attribute>
6299
6300	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6301	<desc>
6302	The client software version number.
6303	</desc>
6304	</attribute>
6305
6306	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6307	<desc>
6308	Public key exchange method used when connection was established.
6309	Values: 0 - RDP4 public key exchange scheme.
6310	1 - X509 certificates were sent to client.
6311	</desc>
6312	</attribute>
6313
6314	</interface>
6315
6316	<interface
6317	name="IConsole" extends="$unknown"
6318	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6319	wsmap="managed"
6320	>
6321	<desc>
6322	The IConsole interface represents an interface to control virtual
6323	machine execution.
6324
6325	A console object gets created when a machine has been locked for a
6326	particular session (client process) using <link to="IMachine::lockMachine" />
6327	or <link to="IMachine::launchVMProcess"/>. The console object can
6328	then be found in the session's <link to="ISession::console" /> attribute.
6329
6330	Methods of the IConsole interface allow the caller to query the current
6331	virtual machine execution state, pause the machine or power it down, save
6332	the machine state or take a snapshot, attach and detach removable media
6333	and so on.
6334
6335	<see><link to="ISession"/></see>
6336	</desc>
6337
6338	<attribute name="machine" type="IMachine" readonly="yes">
6339	<desc>
6340	Machine object for this console session.
6341	<note>
6342	This is a convenience property, it has the same value as
6343	<link to="ISession::machine"/> of the corresponding session
6344	object.
6345	</note>
6346	</desc>
6347	</attribute>
6348
6349	<attribute name="state" type="MachineState" readonly="yes">
6350	<desc>
6351	Current execution state of the machine.
6352	<note>
6353	This property always returns the same value as the corresponding
6354	property of the IMachine object for this console session.
6355	For the process that owns (executes) the VM, this is the
6356	preferable way of querying the VM state, because no IPC
6357	calls are made.
6358	</note>
6359	</desc>
6360	</attribute>
6361
6362	<attribute name="guest" type="IGuest" readonly="yes">
6363	<desc>Guest object.</desc>
6364	</attribute>
6365
6366	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6367	<desc>
6368	Virtual keyboard object.
6369	<note>
6370	If the machine is not running, any attempt to use
6371	the returned object will result in an error.
6372	</note>
6373	</desc>
6374	</attribute>
6375
6376	<attribute name="mouse" type="IMouse" readonly="yes">
6377	<desc>
6378	Virtual mouse object.
6379	<note>
6380	If the machine is not running, any attempt to use
6381	the returned object will result in an error.
6382	</note>
6383	</desc>
6384	</attribute>
6385
6386	<attribute name="display" type="IDisplay" readonly="yes">
6387	<desc>Virtual display object.
6388	<note>
6389	If the machine is not running, any attempt to use
6390	the returned object will result in an error.
6391	</note>
6392	</desc>
6393	</attribute>
6394
6395	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6396	<desc>Debugging interface.</desc>
6397	</attribute>
6398
6399	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6400	<desc>
6401	Collection of USB devices currently attached to the virtual
6402	USB controller.
6403	<note>
6404	The collection is empty if the machine is not running.
6405	</note>
6406	</desc>
6407	</attribute>
6408
6409	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6410	<desc>
6411	List of USB devices currently attached to the remote VRDE client.
6412	Once a new device is physically attached to the remote host computer,
6413	it appears in this list and remains there until detached.
6414	</desc>
6415	</attribute>
6416
6417	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6418	<desc>
6419	Collection of shared folders for the current session. These folders
6420	are called transient shared folders because they are available to the
6421	guest OS running inside the associated virtual machine only for the
6422	duration of the session (as opposed to
6423	<link to="IMachine::sharedFolders"/> which represent permanent shared
6424	folders). When the session is closed (e.g. the machine is powered down),
6425	these folders are automatically discarded.
6426
6427	New shared folders are added to the collection using
6428	<link to="#createSharedFolder"/>. Existing shared folders can be
6429	removed using <link to="#removeSharedFolder"/>.
6430	</desc>
6431	</attribute>
6432
6433	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6434	<desc>
6435	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6436	</desc>
6437	</attribute>
6438
6439	<attribute name="eventSource" type="IEventSource" readonly="yes">
6440	<desc>
6441	Event source for console events.
6442	</desc>
6443	</attribute>
6444
6445	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6446	<desc>Array of PCI devices attached to this machine.</desc>
6447	</attribute>
6448
6449	<attribute name="useHostClipboard" type="boolean">
6450	<desc>
6451	Whether the guest clipboard should be connected to the host one or
6452	whether it should only be allowed access to the VRDE clipboard. This
6453	setting may not affect existing guest clipboard connections which
6454	are already connected to the host clipboard.
6455	</desc>
6456	</attribute>
6457
6458	<method name="powerUp">
6459	<desc>
6460	Starts the virtual machine execution using the current machine
6461	state (that is, its current execution state, current settings and
6462	current storage devices).
6463
6464	<note>
6465	This method is only useful for front-ends that want to actually
6466	execute virtual machines in their own process (like the VirtualBox
6467	or VBoxSDL front-ends). Unless you are intending to write such a
6468	front-end, do not call this method. If you simply want to
6469	start virtual machine execution using one of the existing front-ends
6470	(for example the VirtualBox GUI or headless server), use
6471	<link to="IMachine::launchVMProcess"/> instead; these
6472	front-ends will power up the machine automatically for you.
6473	</note>
6474
6475	If the machine is powered off or aborted, the execution will
6476	start from the beginning (as if the real hardware were just
6477	powered on).
6478
6479	If the machine is in the <link to="MachineState_Saved"/> state,
6480	it will continue its execution the point where the state has
6481	been saved.
6482
6483	If the machine <link to="IMachine::teleporterEnabled"/> property is
6484	enabled on the machine being powered up, the machine will wait for an
6485	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6486	state. The returned progress object will have at least three
6487	operations where the last three are defined as: (1) powering up and
6488	starting TCP server, (2) waiting for incoming teleportations, and
6489	(3) perform teleportation. These operations will be reflected as the
6490	last three operations of the progress objected returned by
6491	<link to="IMachine::launchVMProcess"/> as well.
6492
6493	<see><link to="#saveState"/></see>
6494
6495	<result name="VBOX_E_INVALID_VM_STATE">
6496	Virtual machine already running.
6497	</result>
6498	<result name="VBOX_E_HOST_ERROR">
6499	Host interface does not exist or name not set.
6500	</result>
6501	<result name="VBOX_E_FILE_ERROR">
6502	Invalid saved state file.
6503	</result>
6504	</desc>
6505	<param name="progress" type="IProgress" dir="return">
6506	<desc>Progress object to track the operation completion.</desc>
6507	</param>
6508	</method>
6509
6510	<method name="powerUpPaused">
6511	<desc>
6512	Identical to powerUp except that the VM will enter the
6513	<link to="MachineState_Paused"/> state, instead of
6514	<link to="MachineState_Running"/>.
6515
6516	<see><link to="#powerUp"/></see>
6517	<result name="VBOX_E_INVALID_VM_STATE">
6518	Virtual machine already running.
6519	</result>
6520	<result name="VBOX_E_HOST_ERROR">
6521	Host interface does not exist or name not set.
6522	</result>
6523	<result name="VBOX_E_FILE_ERROR">
6524	Invalid saved state file.
6525	</result>
6526	</desc>
6527	<param name="progress" type="IProgress" dir="return">
6528	<desc>Progress object to track the operation completion.</desc>
6529	</param>
6530	</method>
6531
6532	<method name="powerDown">
6533	<desc>
6534	Initiates the power down procedure to stop the virtual machine
6535	execution.
6536
6537	The completion of the power down procedure is tracked using the returned
6538	IProgress object. After the operation is complete, the machine will go
6539	to the PoweredOff state.
6540	<result name="VBOX_E_INVALID_VM_STATE">
6541	Virtual machine must be Running, Paused or Stuck to be powered down.
6542	</result>
6543	</desc>
6544	<param name="progress" type="IProgress" dir="return">
6545	<desc>Progress object to track the operation completion.</desc>
6546	</param>
6547	</method>
6548
6549	<method name="reset">
6550	<desc>Resets the virtual machine.
6551	<result name="VBOX_E_INVALID_VM_STATE">
6552	Virtual machine not in Running state.
6553	</result>
6554	<result name="VBOX_E_VM_ERROR">
6555	Virtual machine error in reset operation.
6556	</result>
6557	</desc>
6558	</method>
6559
6560	<method name="pause">
6561	<desc>Pauses the virtual machine execution.
6562	<result name="VBOX_E_INVALID_VM_STATE">
6563	Virtual machine not in Running state.
6564	</result>
6565	<result name="VBOX_E_VM_ERROR">
6566	Virtual machine error in suspend operation.
6567	</result>
6568	</desc>
6569	</method>
6570
6571	<method name="resume">
6572	<desc>Resumes the virtual machine execution.
6573	<result name="VBOX_E_INVALID_VM_STATE">
6574	Virtual machine not in Paused state.
6575	</result>
6576	<result name="VBOX_E_VM_ERROR">
6577	Virtual machine error in resume operation.
6578	</result>
6579	</desc>
6580	</method>
6581
6582	<method name="powerButton">
6583	<desc>Sends the ACPI power button event to the guest.
6584	<result name="VBOX_E_INVALID_VM_STATE">
6585	Virtual machine not in Running state.
6586	</result>
6587	<result name="VBOX_E_PDM_ERROR">
6588	Controlled power off failed.
6589	</result>
6590	</desc>
6591	</method>
6592
6593	<method name="sleepButton">
6594	<desc>Sends the ACPI sleep button event to the guest.
6595	<result name="VBOX_E_INVALID_VM_STATE">
6596	Virtual machine not in Running state.
6597	</result>
6598	<result name="VBOX_E_PDM_ERROR">
6599	Sending sleep button event failed.
6600	</result>
6601	</desc>
6602	</method>
6603
6604	<method name="getPowerButtonHandled">
6605	<desc>Checks if the last power button event was handled by guest.
6606	<result name="VBOX_E_PDM_ERROR">
6607	Checking if the event was handled by the guest OS failed.
6608	</result>
6609	</desc>
6610	<param name="handled" type="boolean" dir="return"/>
6611	</method>
6612
6613	<method name="getGuestEnteredACPIMode">
6614	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6615	G1 (sleeping). If this method returns @c false, the guest will
6616	most likely not respond to external ACPI events.
6617	<result name="VBOX_E_INVALID_VM_STATE">
6618	Virtual machine not in Running state.
6619	</result>
6620	</desc>
6621	<param name="entered" type="boolean" dir="return"/>
6622	</method>
6623
6624	<method name="saveState">
6625	<desc>
6626	Saves the current execution state of a running virtual machine
6627	and stops its execution.
6628
6629	After this operation completes, the machine will go to the
6630	Saved state. Next time it is powered up, this state will
6631	be restored and the machine will continue its execution from
6632	the place where it was saved.
6633
6634	This operation differs from taking a snapshot to the effect
6635	that it doesn't create new differencing media. Also, once
6636	the machine is powered up from the state saved using this method,
6637	the saved state is deleted, so it will be impossible to return
6638	to this state later.
6639
6640	<note>
6641	On success, this method implicitly calls
6642	<link to="IMachine::saveSettings"/> to save all current machine
6643	settings (including runtime changes to the DVD medium, etc.).
6644	Together with the impossibility to change any VM settings when it is
6645	in the Saved state, this guarantees adequate hardware
6646	configuration of the machine when it is restored from the saved
6647	state file.
6648	</note>
6649
6650	<note>
6651	The machine must be in the Running or Paused state, otherwise
6652	the operation will fail.
6653	</note>
6654	<result name="VBOX_E_INVALID_VM_STATE">
6655	Virtual machine state neither Running nor Paused.
6656	</result>
6657	<result name="VBOX_E_FILE_ERROR">
6658	Failed to create directory for saved state file.
6659	</result>
6660
6661	<see><link to="#takeSnapshot"/></see>
6662	</desc>
6663	<param name="progress" type="IProgress" dir="return">
6664	<desc>Progress object to track the operation completion.</desc>
6665	</param>
6666	</method>
6667
6668	<method name="adoptSavedState">
6669	<desc>
6670	Associates the given saved state file to the virtual machine.
6671
6672	On success, the machine will go to the Saved state. Next time it is
6673	powered up, it will be restored from the adopted saved state and
6674	continue execution from the place where the saved state file was
6675	created.
6676
6677	The specified saved state file path may be absolute or relative to the
6678	folder the VM normally saves the state to (usually,
6679	<link to="IMachine::snapshotFolder"/>).
6680
6681	<note>
6682	It's a caller's responsibility to make sure the given saved state
6683	file is compatible with the settings of this virtual machine that
6684	represent its virtual hardware (memory size, storage disk configuration
6685	etc.). If there is a mismatch, the behavior of the virtual machine
6686	is undefined.
6687	</note>
6688	<result name="VBOX_E_INVALID_VM_STATE">
6689	Virtual machine state neither PoweredOff nor Aborted.
6690	</result>
6691	</desc>
6692	<param name="savedStateFile" type="wstring" dir="in">
6693	<desc>Path to the saved state file to adopt.</desc>
6694	</param>
6695	</method>
6696
6697	<method name="discardSavedState">
6698	<desc>
6699	Forcibly resets the machine to "Powered Off" state if it is
6700	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6701	Next time the machine is powered up, a clean boot will occur.
6702	<note>
6703	This operation is equivalent to resetting or powering off
6704	the machine without doing a proper shutdown of the guest
6705	operating system; as with resetting a running phyiscal
6706	computer, it can can lead to data loss.
6707	</note>
6708	If @a fRemoveFile is @c true, the file in the machine directory
6709	into which the machine state was saved is also deleted. If
6710	this is @c false, then the state can be recovered and later
6711	re-inserted into a machine using <link to="#adoptSavedState" />.
6712	The location of the file can be found in the
6713	<link to="IMachine::stateFilePath" /> attribute.
6714	<result name="VBOX_E_INVALID_VM_STATE">
6715	Virtual machine not in state Saved.
6716	</result>
6717	</desc>
6718	<param name="fRemoveFile" type="boolean" dir="in" >
6719	<desc>Whether to also remove the saved state file.</desc>
6720	</param>
6721	</method>
6722
6723	<method name="getDeviceActivity">
6724	<desc>
6725	Gets the current activity type of a given device or device group.
6726	<result name="E_INVALIDARG">
6727	Invalid device type.
6728	</result>
6729	</desc>
6730	<param name="type" type="DeviceType" dir="in"/>
6731	<param name="activity" type="DeviceActivity" dir="return"/>
6732	</method>
6733
6734	<method name="attachUSBDevice">
6735	<desc>
6736	Attaches a host USB device with the given UUID to the
6737	USB controller of the virtual machine.
6738
6739	The device needs to be in one of the following states:
6740	<link to="USBDeviceState_Busy"/>,
6741	<link to="USBDeviceState_Available"/> or
6742	<link to="USBDeviceState_Held"/>,
6743	otherwise an error is immediately returned.
6744
6745	When the device state is
6746	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6747	be returned if the host computer refuses to release it for some reason.
6748
6749	<see><link to="IUSBController::deviceFilters"/>,
6750	<link to="USBDeviceState"/></see>
6751	<result name="VBOX_E_INVALID_VM_STATE">
6752	Virtual machine state neither Running nor Paused.
6753	</result>
6754	<result name="VBOX_E_PDM_ERROR">
6755	Virtual machine does not have a USB controller.
6756	</result>
6757	</desc>
6758	<param name="id" type="uuid" mod="string" dir="in">
6759	<desc>UUID of the host USB device to attach.</desc>
6760	</param>
6761	</method>
6762
6763	<method name="detachUSBDevice">
6764	<desc>
6765	Detaches an USB device with the given UUID from the USB controller
6766	of the virtual machine.
6767
6768	After this method succeeds, the VirtualBox server re-initiates
6769	all USB filters as if the device were just physically attached
6770	to the host, but filters of this machine are ignored to avoid
6771	a possible automatic re-attachment.
6772
6773	<see><link to="IUSBController::deviceFilters"/>,
6774	<link to="USBDeviceState"/></see>
6775
6776	<result name="VBOX_E_PDM_ERROR">
6777	Virtual machine does not have a USB controller.
6778	</result>
6779	<result name="E_INVALIDARG">
6780	USB device not attached to this virtual machine.
6781	</result>
6782	</desc>
6783	<param name="id" type="uuid" mod="string" dir="in">
6784	<desc>UUID of the USB device to detach.</desc>
6785	</param>
6786	<param name="device" type="IUSBDevice" dir="return">
6787	<desc>Detached USB device.</desc>
6788	</param>
6789	</method>
6790
6791	<method name="findUSBDeviceByAddress">
6792	<desc>
6793	Searches for a USB device with the given host address.
6794
6795	<result name="VBOX_E_OBJECT_NOT_FOUND">
6796	Given @c name does not correspond to any USB device.
6797	</result>
6798
6799	<see><link to="IUSBDevice::address"/></see>
6800	</desc>
6801	<param name="name" type="wstring" dir="in">
6802	<desc>
6803	Address of the USB device (as assigned by the host) to
6804	search for.
6805	</desc>
6806	</param>
6807	<param name="device" type="IUSBDevice" dir="return">
6808	<desc>Found USB device object.</desc>
6809	</param>
6810	</method>
6811
6812	<method name="findUSBDeviceById">
6813	<desc>
6814	Searches for a USB device with the given UUID.
6815
6816	<result name="VBOX_E_OBJECT_NOT_FOUND">
6817	Given @c id does not correspond to any USB device.
6818	</result>
6819
6820	<see><link to="IUSBDevice::id"/></see>
6821	</desc>
6822	<param name="id" type="uuid" mod="string" dir="in">
6823	<desc>UUID of the USB device to search for.</desc>
6824	</param>
6825	<param name="device" type="IUSBDevice" dir="return">
6826	<desc>Found USB device object.</desc>
6827	</param>
6828	</method>
6829
6830	<method name="createSharedFolder">
6831	<desc>
6832	Creates a transient new shared folder by associating the given logical
6833	name with the given host path, adds it to the collection of shared
6834	folders and starts sharing it. Refer to the description of
6835	<link to="ISharedFolder"/> to read more about logical names.
6836
6837	<result name="VBOX_E_INVALID_VM_STATE">
6838	Virtual machine in Saved state or currently changing state.
6839	</result>
6840	<result name="VBOX_E_FILE_ERROR">
6841	Shared folder already exists or not accessible.
6842	</result>
6843	</desc>
6844	<param name="name" type="wstring" dir="in">
6845	<desc>Unique logical name of the shared folder.</desc>
6846	</param>
6847	<param name="hostPath" type="wstring" dir="in">
6848	<desc>Full path to the shared folder in the host file system.</desc>
6849	</param>
6850	<param name="writable" type="boolean" dir="in">
6851	<desc>Whether the share is writable or readonly</desc>
6852	</param>
6853	<param name="automount" type="boolean" dir="in">
6854	<desc>Whether the share gets automatically mounted by the guest
6855	or not.</desc>
6856	</param>
6857	</method>
6858
6859	<method name="removeSharedFolder">
6860	<desc>
6861	Removes a transient shared folder with the given name previously
6862	created by <link to="#createSharedFolder"/> from the collection of
6863	shared folders and stops sharing it.
6864	<result name="VBOX_E_INVALID_VM_STATE">
6865	Virtual machine in Saved state or currently changing state.
6866	</result>
6867	<result name="VBOX_E_FILE_ERROR">
6868	Shared folder does not exists.
6869	</result>
6870	</desc>
6871	<param name="name" type="wstring" dir="in">
6872	<desc>Logical name of the shared folder to remove.</desc>
6873	</param>
6874	</method>
6875
6876	<method name="takeSnapshot">
6877	<desc>
6878	Saves the current execution state
6879	and all settings of the machine and creates differencing images
6880	for all normal (non-independent) media.
6881	See <link to="ISnapshot" /> for an introduction to snapshots.
6882
6883	This method can be called for a PoweredOff, Saved (see
6884	<link to="#saveState"/>), Running or
6885	Paused virtual machine. When the machine is PoweredOff, an
6886	offline snapshot is created. When the machine is Running a live
6887	snapshot is created, and an online snapshot is is created when Paused.
6888
6889	The taken snapshot is always based on the
6890	<link to="IMachine::currentSnapshot">current snapshot</link>
6891	of the associated virtual machine and becomes a new current snapshot.
6892
6893	<note>
6894	This method implicitly calls <link to="IMachine::saveSettings"/> to
6895	save all current machine settings before taking an offline snapshot.
6896	</note>
6897
6898	<result name="VBOX_E_INVALID_VM_STATE">
6899	Virtual machine currently changing state.
6900	</result>
6901	</desc>
6902	<param name="name" type="wstring" dir="in">
6903	<desc>Short name for the snapshot.</desc>
6904	</param>
6905	<param name="description" type="wstring" dir="in">
6906	<desc>Optional description of the snapshot.</desc>
6907	</param>
6908	<param name="progress" type="IProgress" dir="return">
6909	<desc>Progress object to track the operation completion.</desc>
6910	</param>
6911	</method>
6912
6913	<method name="deleteSnapshot">
6914	<desc>
6915	Starts deleting the specified snapshot asynchronously.
6916	See <link to="ISnapshot" /> for an introduction to snapshots.
6917
6918	The execution state and settings of the associated machine stored in
6919	the snapshot will be deleted. The contents of all differencing media of
6920	this snapshot will be merged with the contents of their dependent child
6921	media to keep the medium chain valid (in other words, all changes
6922	represented by media being deleted will be propagated to their child
6923	medium). After that, this snapshot's differencing medium will be
6924	deleted. The parent of this snapshot will become a new parent for all
6925	its child snapshots.
6926
6927	If the deleted snapshot is the current one, its parent snapshot will
6928	become a new current snapshot. The current machine state is not directly
6929	affected in this case, except that currently attached differencing
6930	media based on media of the deleted snapshot will be also merged as
6931	described above.
6932
6933	If the deleted snapshot is the first or current snapshot, then the
6934	respective IMachine attributes will be adjusted. Deleting the current
6935	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6936	to make all current machine settings permanent.
6937
6938	Deleting a snapshot has the following preconditions:
6939
6940	<ul>
6941	<li>Child media of all normal media of the deleted snapshot
6942	must be accessible (see <link to="IMedium::state"/>) for this
6943	operation to succeed. If only one running VM refers to all images
6944	which participates in merging the operation can be performed while
6945	the VM is running. Otherwise all virtual machines whose media are
6946	directly or indirectly based on the media of deleted snapshot must
6947	be powered off. In any case, online snapshot deleting usually is
6948	slower than the same operation without any running VM.</li>
6949
6950	<li>You cannot delete the snapshot if a medium attached to it has
6951	more than one child medium (differencing images) because otherwise
6952	merging would be impossible. This might be the case if there is
6953	more than one child snapshot or differencing images were created
6954	for other reason (e.g. implicitly because of multiple machine
6955	attachments).</li>
6956	</ul>
6957
6958	The virtual machine's <link to="IMachine::state">state</link> is
6959	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6960	"DeletingSnapshotPaused" while this operation is in progress.
6961
6962	<note>
6963	Merging medium contents can be very time and disk space
6964	consuming, if these media are big in size and have many
6965	children. However, if the snapshot being deleted is the last
6966	(head) snapshot on the branch, the operation will be rather
6967	quick.
6968	</note>
6969	<result name="VBOX_E_INVALID_VM_STATE">
6970	The running virtual machine prevents deleting this snapshot. This
6971	happens only in very specific situations, usually snapshots can be
6972	deleted without trouble while a VM is running. The error message
6973	text explains the reason for the failure.
6974	</result>
6975	</desc>
6976	<param name="id" type="uuid" mod="string" dir="in">
6977	<desc>UUID of the snapshot to delete.</desc>
6978	</param>
6979	<param name="progress" type="IProgress" dir="return">
6980	<desc>Progress object to track the operation completion.</desc>
6981	</param>
6982	</method>
6983
6984	<method name="deleteSnapshotAndAllChildren">
6985	<desc>
6986	Starts deleting the specified snapshot and all its children
6987	asynchronously. See <link to="ISnapshot" /> for an introduction to
6988	snapshots. The conditions and many details are the same as with
6989	<link to="#deleteSnapshot"/>.
6990
6991	This operation is very fast if the snapshot subtree does not include
6992	the current state. It is still significantly faster than deleting the
6993	snapshots one by one if the current state is in the subtree and there
6994	are more than one snapshots from current state to the snapshot which
6995	marks the subtree, since it eliminates the incremental image merging.
6996
6997	<note>This API method is right now not implemented!</note>
6998
6999	<result name="VBOX_E_INVALID_VM_STATE">
7000	The running virtual machine prevents deleting this snapshot. This
7001	happens only in very specific situations, usually snapshots can be
7002	deleted without trouble while a VM is running. The error message
7003	text explains the reason for the failure.
7004	</result>
7005	<result name="E_NOTIMPL">
7006	The method is not implemented yet.
7007	</result>
7008	</desc>
7009	<param name="id" type="uuid" mod="string" dir="in">
7010	<desc>UUID of the snapshot to delete, including all its children.</desc>
7011	</param>
7012	<param name="progress" type="IProgress" dir="return">
7013	<desc>Progress object to track the operation completion.</desc>
7014	</param>
7015	</method>
7016
7017	<method name="deleteSnapshotRange">
7018	<desc>
7019	Starts deleting the specified snapshot range. This is limited to
7020	linear snapshot lists, which means there may not be any other child
7021	snapshots other than the direct sequence between the start and end
7022	snapshot. If the start and end snapshot point to the same snapshot this
7023	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7024	<link to="ISnapshot" /> for an introduction to snapshots. The
7025	conditions and many details are the same as with
7026	<link to="#deleteSnapshot"/>.
7027
7028	This operation is generally faster than deleting snapshots one by one
7029	and often also needs less extra disk space before freeing up disk space
7030	by deleting the removed disk images corresponding to the snapshot.
7031
7032	<note>This API method is right now not implemented!</note>
7033
7034	<result name="VBOX_E_INVALID_VM_STATE">
7035	The running virtual machine prevents deleting this snapshot. This
7036	happens only in very specific situations, usually snapshots can be
7037	deleted without trouble while a VM is running. The error message
7038	text explains the reason for the failure.
7039	</result>
7040	<result name="E_NOTIMPL">
7041	The method is not implemented yet.
7042	</result>
7043	</desc>
7044	<param name="startId" type="uuid" mod="string" dir="in">
7045	<desc>UUID of the first snapshot to delete.</desc>
7046	</param>
7047	<param name="endId" type="uuid" mod="string" dir="in">
7048	<desc>UUID of the last snapshot to delete.</desc>
7049	</param>
7050	<param name="progress" type="IProgress" dir="return">
7051	<desc>Progress object to track the operation completion.</desc>
7052	</param>
7053	</method>
7054
7055	<method name="restoreSnapshot">
7056	<desc>
7057	Starts resetting the machine's current state to the state contained
7058	in the given snapshot, asynchronously. All current settings of the
7059	machine will be reset and changes stored in differencing media
7060	will be lost.
7061	See <link to="ISnapshot" /> for an introduction to snapshots.
7062
7063	After this operation is successfully completed, new empty differencing
7064	media are created for all normal media of the machine.
7065
7066	If the given snapshot is an online snapshot, the machine will go to
7067	the <link to="MachineState_Saved"> saved state</link>, so that the
7068	next time it is powered on, the execution state will be restored
7069	from the state of the snapshot.
7070
7071	<note>
7072	The machine must not be running, otherwise the operation will fail.
7073	</note>
7074
7075	<note>
7076	If the machine state is <link to="MachineState_Saved">Saved</link>
7077	prior to this operation, the saved state file will be implicitly
7078	deleted (as if <link to="IConsole::discardSavedState"/> were
7079	called).
7080	</note>
7081
7082	<result name="VBOX_E_INVALID_VM_STATE">
7083	Virtual machine is running.
7084	</result>
7085	</desc>
7086	<param name="snapshot" type="ISnapshot" dir="in">
7087	<desc>The snapshot to restore the VM state from.</desc>
7088	</param>
7089	<param name="progress" type="IProgress" dir="return">
7090	<desc>Progress object to track the operation completion.</desc>
7091	</param>
7092	</method>
7093
7094	<method name="teleport">
7095	<desc>
7096	Teleport the VM to a different host machine or process.
7097
7098	TODO explain the details.
7099
7100	<result name="VBOX_E_INVALID_VM_STATE">
7101	Virtual machine not running or paused.
7102	</result>
7103	</desc>
7104	<param name="hostname" type="wstring" dir="in">
7105	<desc>The name or IP of the host to teleport to.</desc>
7106	</param>
7107	<param name="tcpport" type="unsigned long" dir="in">
7108	<desc>The TCP port to connect to (1..65535).</desc>
7109	</param>
7110	<param name="password" type="wstring" dir="in">
7111	<desc>The password.</desc>
7112	</param>
7113	<param name="maxDowntime" type="unsigned long" dir="in">
7114	<desc>
7115	The maximum allowed downtime given as milliseconds. 0 is not a valid
7116	value. Recommended value: 250 ms.
7117
7118	The higher the value is, the greater the chance for a successful
7119	teleportation. A small value may easily result in the teleportation
7120	process taking hours and eventually fail.
7121
7122	<note>
7123	The current implementation treats this a guideline, not as an
7124	absolute rule.
7125	</note>
7126	</desc>
7127	</param>
7128	<param name="progress" type="IProgress" dir="return">
7129	<desc>Progress object to track the operation completion.</desc>
7130	</param>
7131	</method>
7132
7133	</interface>
7134
7135	<!--
7136	// IHost
7137	/////////////////////////////////////////////////////////////////////////
7138	-->
7139
7140	<enum
7141	name="HostNetworkInterfaceMediumType"
7142	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7143	>
7144	<desc>
7145	Type of encapsulation. Ethernet encapsulation includes both wired and
7146	wireless Ethernet connections.
7147	<see><link to="IHostNetworkInterface"/></see>
7148	</desc>
7149
7150	<const name="Unknown" value="0">
7151	<desc>
7152	The type of interface cannot be determined.
7153	</desc>
7154	</const>
7155	<const name="Ethernet" value="1">
7156	<desc>
7157	Ethernet frame encapsulation.
7158	</desc>
7159	</const>
7160	<const name="PPP" value="2">
7161	<desc>
7162	Point-to-point protocol encapsulation.
7163	</desc>
7164	</const>
7165	<const name="SLIP" value="3">
7166	<desc>
7167	Serial line IP encapsulation.
7168	</desc>
7169	</const>
7170	</enum>
7171
7172	<enum
7173	name="HostNetworkInterfaceStatus"
7174	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7175	>
7176	<desc>
7177	Current status of the interface.
7178	<see><link to="IHostNetworkInterface"/></see>
7179	</desc>
7180
7181	<const name="Unknown" value="0">
7182	<desc>
7183	The state of interface cannot be determined.
7184	</desc>
7185	</const>
7186	<const name="Up" value="1">
7187	<desc>
7188	The interface is fully operational.
7189	</desc>
7190	</const>
7191	<const name="Down" value="2">
7192	<desc>
7193	The interface is not functioning.
7194	</desc>
7195	</const>
7196	</enum>
7197
7198	<enum
7199	name="HostNetworkInterfaceType"
7200	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7201	>
7202	<desc>
7203	Network interface type.
7204	</desc>
7205	<const name="Bridged" value="1"/>
7206	<const name="HostOnly" value="2"/>
7207	</enum>
7208
7209	<interface
7210	name="IHostNetworkInterface" extends="$unknown"
7211	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7212	wsmap="managed"
7213	>
7214	<desc>
7215	Represents one of host's network interfaces. IP V6 address and network
7216	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7217	separated by colons.
7218	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7219	</desc>
7220	<attribute name="name" type="wstring" readonly="yes">
7221	<desc>Returns the host network interface name.</desc>
7222	</attribute>
7223
7224	<attribute name="id" type="uuid" mod="string" readonly="yes">
7225	<desc>Returns the interface UUID.</desc>
7226	</attribute>
7227
7228	<attribute name="networkName" type="wstring" readonly="yes">
7229	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7230	</attribute>
7231
7232	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7233	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7234	</attribute>
7235
7236	<attribute name="IPAddress" type="wstring" readonly="yes">
7237	<desc>Returns the IP V4 address of the interface.</desc>
7238	</attribute>
7239
7240	<attribute name="networkMask" type="wstring" readonly="yes">
7241	<desc>Returns the network mask of the interface.</desc>
7242	</attribute>
7243
7244	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7245	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7246	</attribute>
7247
7248	<attribute name="IPV6Address" type="wstring" readonly="yes">
7249	<desc>Returns the IP V6 address of the interface.</desc>
7250	</attribute>
7251
7252	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7253	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7254	</attribute>
7255
7256	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7257	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7258	</attribute>
7259
7260	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7261	<desc>Type of protocol encapsulation used.</desc>
7262	</attribute>
7263
7264	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7265	<desc>Status of the interface.</desc>
7266	</attribute>
7267
7268	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7269	<desc>specifies the host interface type.</desc>
7270	</attribute>
7271
7272	<method name="enableStaticIpConfig">
7273	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7274	<param name="IPAddress" type="wstring" dir="in">
7275	<desc>
7276	IP address.
7277	</desc>
7278	</param>
7279	<param name="networkMask" type="wstring" dir="in">
7280	<desc>
7281	network mask.
7282	</desc>
7283	</param>
7284	</method>
7285
7286	<method name="enableStaticIpConfigV6">
7287	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7288	<param name="IPV6Address" type="wstring" dir="in">
7289	<desc>
7290	IP address.
7291	</desc>
7292	</param>
7293	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7294	<desc>
7295	network mask.
7296	</desc>
7297	</param>
7298	</method>
7299
7300	<method name="enableDynamicIpConfig">
7301	<desc>enables the dynamic IP configuration.</desc>
7302	</method>
7303
7304	<method name="dhcpRediscover">
7305	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7306	</method>
7307
7308	</interface>
7309
7310	<interface
7311	name="IHost" extends="$unknown"
7312	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7313	wsmap="managed"
7314	>
7315	<desc>
7316	The IHost interface represents the physical machine that this VirtualBox
7317	installation runs on.
7318
7319	An object implementing this interface is returned by the
7320	<link to="IVirtualBox::host" /> attribute. This interface contains
7321	read-only information about the host's physical hardware (such as what
7322	processors and disks are available, what the host operating system is,
7323	and so on) and also allows for manipulating some of the host's hardware,
7324	such as global USB device filters and host interface networking.
7325
7326	</desc>
7327	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7328	<desc>List of DVD drives available on the host.</desc>
7329	</attribute>
7330
7331	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7332	<desc>List of floppy drives available on the host.</desc>
7333	</attribute>
7334
7335	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7336	<desc>
7337	List of USB devices currently attached to the host.
7338	Once a new device is physically attached to the host computer,
7339	it appears in this list and remains there until detached.
7340
7341	<note>
7342	If USB functionality is not available in the given edition of
7343	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7344	</note>
7345	</desc>
7346	</attribute>
7347
7348	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7349	<desc>
7350	List of USB device filters in action.
7351	When a new device is physically attached to the host computer,
7352	filters from this list are applied to it (in order they are stored
7353	in the list). The first matched filter will determine the
7354	<link to="IHostUSBDeviceFilter::action">action</link>
7355	performed on the device.
7356
7357	Unless the device is ignored by these filters, filters of all
7358	currently running virtual machines
7359	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7360
7361	<note>
7362	If USB functionality is not available in the given edition of
7363	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7364	</note>
7365
7366	<see><link to="IHostUSBDeviceFilter"/>,
7367	<link to="USBDeviceState"/></see>
7368	</desc>
7369	</attribute>
7370
7371	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7372	<desc>List of host network interfaces currently defined on the host.</desc>
7373	</attribute>
7374
7375	<attribute name="processorCount" type="unsigned long" readonly="yes">
7376	<desc>Number of (logical) CPUs installed in the host system.</desc>
7377	</attribute>
7378
7379	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7380	<desc>Number of (logical) CPUs online in the host system.</desc>
7381	</attribute>
7382
7383	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7384	<desc>Number of physical processor cores installed in the host system.</desc>
7385	</attribute>
7386
7387	<method name="getProcessorSpeed">
7388	<desc>Query the (approximate) maximum speed of a specified host CPU in
7389	Megahertz.
7390	</desc>
7391	<param name="cpuId" type="unsigned long" dir="in">
7392	<desc>
7393	Identifier of the CPU.
7394	</desc>
7395	</param>
7396	<param name="speed" type="unsigned long" dir="return">
7397	<desc>
7398	Speed value. 0 is returned if value is not known or @a cpuId is
7399	invalid.
7400	</desc>
7401	</param>
7402	</method>
7403
7404	<method name="getProcessorFeature">
7405	<desc>Query whether a CPU feature is supported or not.</desc>
7406	<param name="feature" type="ProcessorFeature" dir="in">
7407	<desc>
7408	CPU Feature identifier.
7409	</desc>
7410	</param>
7411	<param name="supported" type="boolean" dir="return">
7412	<desc>
7413	Feature is supported or not.
7414	</desc>
7415	</param>
7416	</method>
7417
7418	<method name="getProcessorDescription">
7419	<desc>Query the model string of a specified host CPU.
7420	</desc>
7421	<param name="cpuId" type="unsigned long" dir="in">
7422	<desc>
7423	Identifier of the CPU.
7424	<note>
7425	The current implementation might not necessarily return the
7426	description for this exact CPU.
7427	</note>
7428	</desc>
7429	</param>
7430	<param name="description" type="wstring" dir="return">
7431	<desc>
7432	Model string. An empty string is returned if value is not known or
7433	@a cpuId is invalid.
7434	</desc>
7435	</param>
7436	</method>
7437
7438	<method name="getProcessorCPUIDLeaf">
7439	<desc>
7440	Returns the CPU cpuid information for the specified leaf.
7441	</desc>
7442	<param name="cpuId" type="unsigned long" dir="in">
7443	<desc>
7444	Identifier of the CPU. The CPU most be online.
7445	<note>
7446	The current implementation might not necessarily return the
7447	description for this exact CPU.
7448	</note>
7449	</desc>
7450	</param>
7451	<param name="leaf" type="unsigned long" dir="in">
7452	<desc>
7453	CPUID leaf index (eax).
7454	</desc>
7455	</param>
7456	<param name="subLeaf" type="unsigned long" dir="in">
7457	<desc>
7458	CPUID leaf sub index (ecx). This currently only applies to cache
7459	information on Intel CPUs. Use 0 if retrieving values for
7460	<link to="IMachine::setCPUIDLeaf"/>.
7461	</desc>
7462	</param>
7463	<param name="valEax" type="unsigned long" dir="out">
7464	<desc>
7465	CPUID leaf value for register eax.
7466	</desc>
7467	</param>
7468	<param name="valEbx" type="unsigned long" dir="out">
7469	<desc>
7470	CPUID leaf value for register ebx.
7471	</desc>
7472	</param>
7473	<param name="valEcx" type="unsigned long" dir="out">
7474	<desc>
7475	CPUID leaf value for register ecx.
7476	</desc>
7477	</param>
7478	<param name="valEdx" type="unsigned long" dir="out">
7479	<desc>
7480	CPUID leaf value for register edx.
7481	</desc>
7482	</param>
7483	</method>
7484
7485	<attribute name="memorySize" type="unsigned long" readonly="yes">
7486	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7487	</attribute>
7488
7489	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7490	<desc>Available system memory in the host system.</desc>
7491	</attribute>
7492
7493	<attribute name="operatingSystem" type="wstring" readonly="yes">
7494	<desc>Name of the host system's operating system.</desc>
7495	</attribute>
7496
7497	<attribute name="OSVersion" type="wstring" readonly="yes">
7498	<desc>Host operating system's version string.</desc>
7499	</attribute>
7500
7501	<attribute name="UTCTime" type="long long" readonly="yes">
7502	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7503	</attribute>
7504
7505	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7506	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7507	</attribute>
7508
7509	<method name="createHostOnlyNetworkInterface">
7510	<desc>
7511	Creates a new adapter for Host Only Networking.
7512	<result name="E_INVALIDARG">
7513	Host network interface @a name already exists.
7514	</result>
7515	</desc>
7516	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7517	<desc>
7518	Created host interface object.
7519	</desc>
7520	</param>
7521	<param name="progress" type="IProgress" dir="return">
7522	<desc>
7523	Progress object to track the operation completion.
7524	</desc>
7525	</param>
7526	</method>
7527
7528	<method name="removeHostOnlyNetworkInterface">
7529	<desc>
7530	Removes the given Host Only Networking interface.
7531	<result name="VBOX_E_OBJECT_NOT_FOUND">
7532	No host network interface matching @a id found.
7533	</result>
7534	</desc>
7535	<param name="id" type="uuid" mod="string" dir="in">
7536	<desc>
7537	Adapter GUID.
7538	</desc>
7539	</param>
7540	<param name="progress" type="IProgress" dir="return">
7541	<desc>
7542	Progress object to track the operation completion.
7543	</desc>
7544	</param>
7545	</method>
7546
7547	<method name="createUSBDeviceFilter">
7548	<desc>
7549	Creates a new USB device filter. All attributes except
7550	the filter name are set to empty (any match),
7551	<i>active</i> is @c false (the filter is not active).
7552
7553	The created filter can be added to the list of filters using
7554	<link to="#insertUSBDeviceFilter"/>.
7555
7556	<see><link to="#USBDeviceFilters"/></see>
7557	</desc>
7558	<param name="name" type="wstring" dir="in">
7559	<desc>
7560	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7561	</desc>
7562	</param>
7563	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7564	<desc>Created filter object.</desc>
7565	</param>
7566	</method>
7567
7568	<method name="insertUSBDeviceFilter">
7569	<desc>
7570	Inserts the given USB device to the specified position
7571	in the list of filters.
7572
7573	Positions are numbered starting from @c 0. If the specified
7574	position is equal to or greater than the number of elements in
7575	the list, the filter is added at the end of the collection.
7576
7577	<note>
7578	Duplicates are not allowed, so an attempt to insert a
7579	filter already in the list is an error.
7580	</note>
7581	<note>
7582	If USB functionality is not available in the given edition of
7583	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7584	</note>
7585
7586	<see><link to="#USBDeviceFilters"/></see>
7587
7588	<result name="VBOX_E_INVALID_OBJECT_STATE">
7589	USB device filter is not created within this VirtualBox instance.
7590	</result>
7591	<result name="E_INVALIDARG">
7592	USB device filter already in list.
7593	</result>
7594
7595	</desc>
7596	<param name="position" type="unsigned long" dir="in">
7597	<desc>Position to insert the filter to.</desc>
7598	</param>
7599	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7600	<desc>USB device filter to insert.</desc>
7601	</param>
7602	</method>
7603
7604	<method name="removeUSBDeviceFilter">
7605	<desc>
7606	Removes a USB device filter from the specified position in the
7607	list of filters.
7608
7609	Positions are numbered starting from @c 0. Specifying a
7610	position equal to or greater than the number of elements in
7611	the list will produce an error.
7612
7613	<note>
7614	If USB functionality is not available in the given edition of
7615	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7616	</note>
7617
7618	<see><link to="#USBDeviceFilters"/></see>
7619
7620	<result name="E_INVALIDARG">
7621	USB device filter list empty or invalid @a position.
7622	</result>
7623
7624	</desc>
7625	<param name="position" type="unsigned long" dir="in">
7626	<desc>Position to remove the filter from.</desc>
7627	</param>
7628	</method>
7629
7630	<method name="findHostDVDDrive">
7631	<desc>
7632	Searches for a host DVD drive with the given @c name.
7633
7634	<result name="VBOX_E_OBJECT_NOT_FOUND">
7635	Given @c name does not correspond to any host drive.
7636	</result>
7637
7638	</desc>
7639	<param name="name" type="wstring" dir="in">
7640	<desc>Name of the host drive to search for</desc>
7641	</param>
7642	<param name="drive" type="IMedium" dir="return">
7643	<desc>Found host drive object</desc>
7644	</param>
7645	</method>
7646
7647	<method name="findHostFloppyDrive">
7648	<desc>
7649	Searches for a host floppy drive with the given @c name.
7650
7651	<result name="VBOX_E_OBJECT_NOT_FOUND">
7652	Given @c name does not correspond to any host floppy drive.
7653	</result>
7654
7655	</desc>
7656	<param name="name" type="wstring" dir="in">
7657	<desc>Name of the host floppy drive to search for</desc>
7658	</param>
7659	<param name="drive" type="IMedium" dir="return">
7660	<desc>Found host floppy drive object</desc>
7661	</param>
7662	</method>
7663
7664	<method name="findHostNetworkInterfaceByName">
7665	<desc>
7666	Searches through all host network interfaces for an interface with
7667	the given @c name.
7668	<note>
7669	The method returns an error if the given @c name does not
7670	correspond to any host network interface.
7671	</note>
7672	</desc>
7673	<param name="name" type="wstring" dir="in">
7674	<desc>Name of the host network interface to search for.</desc>
7675	</param>
7676	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7677	<desc>Found host network interface object.</desc>
7678	</param>
7679	</method>
7680	<method name="findHostNetworkInterfaceById">
7681	<desc>
7682	Searches through all host network interfaces for an interface with
7683	the given GUID.
7684	<note>
7685	The method returns an error if the given GUID does not
7686	correspond to any host network interface.
7687	</note>
7688	</desc>
7689	<param name="id" type="uuid" mod="string" dir="in">
7690	<desc>GUID of the host network interface to search for.</desc>
7691	</param>
7692	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7693	<desc>Found host network interface object.</desc>
7694	</param>
7695	</method>
7696	<method name="findHostNetworkInterfacesOfType">
7697	<desc>
7698	Searches through all host network interfaces and returns a list of interfaces of the specified type
7699	</desc>
7700	<param name="type" type="HostNetworkInterfaceType" dir="in">
7701	<desc>type of the host network interfaces to search for.</desc>
7702	</param>
7703	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7704	<desc>Found host network interface objects.</desc>
7705	</param>
7706	</method>
7707
7708	<method name="findUSBDeviceById">
7709	<desc>
7710	Searches for a USB device with the given UUID.
7711
7712	<result name="VBOX_E_OBJECT_NOT_FOUND">
7713	Given @c id does not correspond to any USB device.
7714	</result>
7715
7716	<see><link to="IUSBDevice::id"/></see>
7717	</desc>
7718	<param name="id" type="uuid" mod="string" dir="in">
7719	<desc>UUID of the USB device to search for.</desc>
7720	</param>
7721	<param name="device" type="IHostUSBDevice" dir="return">
7722	<desc>Found USB device object.</desc>
7723	</param>
7724	</method>
7725
7726	<method name="findUSBDeviceByAddress">
7727	<desc>
7728	Searches for a USB device with the given host address.
7729
7730	<result name="VBOX_E_OBJECT_NOT_FOUND">
7731	Given @c name does not correspond to any USB device.
7732	</result>
7733
7734	<see><link to="IUSBDevice::address"/></see>
7735	</desc>
7736	<param name="name" type="wstring" dir="in">
7737	<desc>
7738	Address of the USB device (as assigned by the host) to
7739	search for.
7740	</desc>
7741	</param>
7742	<param name="device" type="IHostUSBDevice" dir="return">
7743	<desc>Found USB device object.</desc>
7744	</param>
7745	</method>
7746
7747	<method name="generateMACAddress">
7748	<desc>
7749	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7750	</desc>
7751	<param name="address" type="wstring" dir="return">
7752	<desc>New Ethernet MAC address.</desc>
7753	</param>
7754	</method>
7755
7756	</interface>
7757
7758	<!--
7759	// ISystemProperties
7760	/////////////////////////////////////////////////////////////////////////
7761	-->
7762
7763	<interface
7764	name="ISystemProperties"
7765	extends="$unknown"
7766	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7767	wsmap="managed"
7768	>
7769	<desc>
7770	The ISystemProperties interface represents global properties of the given
7771	VirtualBox installation.
7772
7773	These properties define limits and default values for various attributes
7774	and parameters. Most of the properties are read-only, but some can be
7775	changed by a user.
7776	</desc>
7777
7778	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7779	<desc>Minimum guest system memory in Megabytes.</desc>
7780	</attribute>
7781
7782	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7783	<desc>Maximum guest system memory in Megabytes.</desc>
7784	</attribute>
7785
7786	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7787	<desc>Minimum guest video memory in Megabytes.</desc>
7788	</attribute>
7789
7790	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7791	<desc>Maximum guest video memory in Megabytes.</desc>
7792	</attribute>
7793
7794	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7795	<desc>Minimum CPU count.</desc>
7796	</attribute>
7797
7798	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7799	<desc>Maximum CPU count.</desc>
7800	</attribute>
7801
7802	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7803	<desc>Maximum of monitors which could be connected.</desc>
7804	</attribute>
7805
7806	<attribute name="infoVDSize" type="long long" readonly="yes">
7807	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7808	does not reflect the limits of any virtual disk image format.</desc>
7809	</attribute>
7810
7811	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7812	<desc>
7813	Maximum number of serial ports associated with every
7814	<link to="IMachine"/> instance.
7815	</desc>
7816	</attribute>
7817
7818	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7819	<desc>
7820	Maximum number of parallel ports associated with every
7821	<link to="IMachine"/> instance.
7822	</desc>
7823	</attribute>
7824
7825	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7826	<desc>
7827	Maximum device position in the boot order. This value corresponds
7828	to the total number of devices a machine can boot from, to make it
7829	possible to include all possible devices to the boot list.
7830	<see><link to="IMachine::setBootOrder"/></see>
7831	</desc>
7832	</attribute>
7833
7834	<attribute name="defaultMachineFolder" type="wstring">
7835	<desc>
7836	Full path to the default directory used to create new or open
7837	existing machines when a machine settings file name contains no
7838	path.
7839
7840	Starting with VirtualBox 4.0, by default, this attribute contains
7841	the full path of folder named "VirtualBox VMs" in the user's
7842	home directory, which depends on the host platform.
7843
7844	When setting this attribute, a full path must be specified.
7845	Setting this property to @c null or an empty string or the
7846	special value "Machines" (for compatibility reasons) will restore
7847	that default value.
7848
7849	If the folder specified herein does not exist, it will be created
7850	automatically as needed.
7851
7852	<see>
7853	<link to="IVirtualBox::createMachine"/>,
7854	<link to="IVirtualBox::openMachine"/>
7855	</see>
7856	</desc>
7857	</attribute>
7858
7859	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7860	<desc>
7861	List of all medium storage formats supported by this VirtualBox
7862	installation.
7863
7864	Keep in mind that the medium format identifier
7865	(<link to="IMediumFormat::id"/>) used in other API calls like
7866	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7867	medium format is a case-insensitive string. This means that, for
7868	example, all of the following strings:
7869	<pre>
7870	"VDI"
7871	"vdi"
7872	"VdI"</pre>
7873	refer to the same medium format.
7874
7875	Note that the virtual medium framework is backend-based, therefore
7876	the list of supported formats depends on what backends are currently
7877	installed.
7878
7879	<see><link to="IMediumFormat"/></see>
7880	</desc>
7881	</attribute>
7882
7883	<attribute name="defaultHardDiskFormat" type="wstring">
7884	<desc>
7885	Identifier of the default medium format used by VirtualBox.
7886
7887	The medium format set by this attribute is used by VirtualBox
7888	when the medium format was not specified explicitly. One example is
7889	<link to="IVirtualBox::createHardDisk"/> with the empty
7890	format argument. A more complex example is implicit creation of
7891	differencing media when taking a snapshot of a virtual machine:
7892	this operation will try to use a format of the parent medium first
7893	and if this format does not support differencing media the default
7894	format specified by this argument will be used.
7895
7896	The list of supported medium formats may be obtained by the
7897	<link to="#mediumFormats"/> call. Note that the default medium
7898	format must have a capability to create differencing media;
7899	otherwise operations that create media implicitly may fail
7900	unexpectedly.
7901
7902	The initial value of this property is <tt>"VDI"</tt> in the current
7903	version of the VirtualBox product, but may change in the future.
7904
7905	<note>
7906	Setting this property to @c null or empty string will restore the
7907	initial value.
7908	</note>
7909
7910	<see>
7911	<link to="#mediumFormats"/>,
7912	<link to="IMediumFormat::id"/>,
7913	<link to="IVirtualBox::createHardDisk"/>
7914	</see>
7915	</desc>
7916	</attribute>
7917
7918	<attribute name="freeDiskSpaceWarning" type="long long">
7919	<desc>Issue a warning if the free disk space is below (or in some disk
7920	intensive operation is expected to go below) the given size in
7921	bytes.</desc>
7922	</attribute>
7923
7924	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7925	<desc>Issue a warning if the free disk space is below (or in some disk
7926	intensive operation is expected to go below) the given percentage.</desc>
7927	</attribute>
7928
7929	<attribute name="freeDiskSpaceError" type="long long">
7930	<desc>Issue an error if the free disk space is below (or in some disk
7931	intensive operation is expected to go below) the given size in
7932	bytes.</desc>
7933	</attribute>
7934
7935	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7936	<desc>Issue an error if the free disk space is below (or in some disk
7937	intensive operation is expected to go below) the given percentage.</desc>
7938	</attribute>
7939
7940	<attribute name="VRDEAuthLibrary" type="wstring">
7941	<desc>
7942	Library that provides authentication for Remote Desktop clients. The library
7943	is used if a virtual machine's authentication type is set to "external"
7944	in the VM RemoteDisplay configuration.
7945
7946	The system library extension (".DLL" or ".so") must be omitted.
7947	A full path can be specified; if not, then the library must reside on the
7948	system's default library path.
7949
7950	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7951	of that name in one of the default VirtualBox library directories.
7952
7953	For details about VirtualBox authentication libraries and how to implement
7954	them, please refer to the VirtualBox manual.
7955
7956	<note>
7957	Setting this property to @c null or empty string will restore the
7958	initial value.
7959	</note>
7960	</desc>
7961	</attribute>
7962
7963	<attribute name="webServiceAuthLibrary" type="wstring">
7964	<desc>
7965	Library that provides authentication for webservice clients. The library
7966	is used if a virtual machine's authentication type is set to "external"
7967	in the VM RemoteDisplay configuration and will be called from
7968	within the <link to="IWebsessionManager::logon" /> implementation.
7969
7970	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7971	there is no per-VM setting for this, as the webservice is a global
7972	resource (if it is running). Only for this setting (for the webservice),
7973	setting this value to a literal <tt>"null"</tt> string disables authentication,
7974	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7975	no matter what user name and password are supplied.
7976
7977	The initial value of this property is <tt>"VBoxAuth"</tt>,
7978	meaning that the webservice will use the same authentication
7979	library that is used by default for VRDE (again, see
7980	<link to="ISystemProperties::VRDEAuthLibrary" />).
7981	The format and calling convention of authentication libraries
7982	is the same for the webservice as it is for VRDE.
7983
7984	<note>
7985	Setting this property to @c null or empty string will restore the
7986	initial value.
7987	</note>
7988	</desc>
7989	</attribute>
7990
7991	<attribute name="defaultVRDEExtPack" type="wstring">
7992	<desc>
7993	The name of the extension pack providing the default VRDE.
7994
7995	This attribute is for choosing between multiple extension packs
7996	providing VRDE. If only one is installed, it will automatically be the
7997	default one. The attribute value can be empty if no VRDE extension
7998	pack is installed.
7999
8000	For details about VirtualBox Remote Desktop Extension and how to
8001	implement one, please refer to the VirtualBox SDK.
8002	</desc>
8003	</attribute>
8004
8005	<attribute name="logHistoryCount" type="unsigned long">
8006	<desc>
8007	This value specifies how many old release log files are kept.
8008	</desc>
8009	</attribute>
8010
8011	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8012	<desc>This value hold the default audio driver for the current
8013	system.</desc>
8014	</attribute>
8015
8016
8017	<method name="getMaxNetworkAdapters">
8018	<desc>
8019	Maximum total number of network adapters associated with every
8020	<link to="IMachine"/> instance.
8021	</desc>
8022
8023	<param name="chipset" type="ChipsetType" dir="in">
8024	<desc>The chipset type to get the value for.</desc>
8025	</param>
8026
8027
8028	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8029	<desc>The maximum total number of network adapters allowed.</desc>
8030	</param>
8031
8032	</method>
8033
8034	<method name="getMaxNetworkAdaptersOfType">
8035	<desc>
8036	Maximum number of network adapters of a given attachment type,
8037	associated with every <link to="IMachine"/> instance.
8038	</desc>
8039
8040	<param name="chipset" type="ChipsetType" dir="in">
8041	<desc>The chipset type to get the value for.</desc>
8042	</param>
8043
8044	<param name="type" type="NetworkAttachmentType" dir="in">
8045	<desc>Type of attachment.</desc>
8046	</param>
8047
8048	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8049	<desc>The maximum number of network adapters allowed for
8050	particular chipset and attachment type.</desc>
8051	</param>
8052
8053	</method>
8054
8055
8056	<method name="getMaxDevicesPerPortForStorageBus">
8057	<desc>Returns the maximum number of devices which can be attached to a port
8058	for the given storage bus.</desc>
8059
8060	<param name="bus" type="StorageBus" dir="in">
8061	<desc>The storage bus type to get the value for.</desc>
8062	</param>
8063
8064	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8065	<desc>The maximum number of devices which can be attached to the port for the given
8066	storage bus.</desc>
8067	</param>
8068	</method>
8069
8070	<method name="getMinPortCountForStorageBus">
8071	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8072
8073	<param name="bus" type="StorageBus" dir="in">
8074	<desc>The storage bus type to get the value for.</desc>
8075	</param>
8076
8077	<param name="minPortCount" type="unsigned long" dir="return">
8078	<desc>The minimum number of ports for the given storage bus.</desc>
8079	</param>
8080	</method>
8081
8082	<method name="getMaxPortCountForStorageBus">
8083	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8084
8085	<param name="bus" type="StorageBus" dir="in">
8086	<desc>The storage bus type to get the value for.</desc>
8087	</param>
8088
8089	<param name="maxPortCount" type="unsigned long" dir="return">
8090	<desc>The maximum number of ports for the given storage bus.</desc>
8091	</param>
8092	</method>
8093
8094	<method name="getMaxInstancesOfStorageBus">
8095	<desc>Returns the maximum number of storage bus instances which
8096	can be configured for each VM. This corresponds to the number of
8097	storage controllers one can have. Value may depend on chipset type
8098	used.</desc>
8099
8100	<param name="chipset" type="ChipsetType" dir="in">
8101	<desc>The chipset type to get the value for.</desc>
8102	</param>
8103
8104	<param name="bus" type="StorageBus" dir="in">
8105	<desc>The storage bus type to get the value for.</desc>
8106	</param>
8107
8108	<param name="maxInstances" type="unsigned long" dir="return">
8109	<desc>The maximum number of instances for the given storage bus.</desc>
8110	</param>
8111	</method>
8112
8113	<method name="getDeviceTypesForStorageBus">
8114	<desc>Returns list of all the supported device types
8115	(<link to="DeviceType"/>) for the given type of storage
8116	bus.</desc>
8117
8118	<param name="bus" type="StorageBus" dir="in">
8119	<desc>The storage bus type to get the value for.</desc>
8120	</param>
8121
8122	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8123	<desc>The list of all supported device types for the given storage bus.</desc>
8124	</param>
8125	</method>
8126
8127	<method name="getDefaultIoCacheSettingForStorageController">
8128	<desc>Returns the default I/O cache setting for the
8129	given storage controller</desc>
8130
8131	<param name="controllerType" type="StorageControllerType" dir="in">
8132	<desc>The storage controller to the setting for.</desc>
8133	</param>
8134
8135	<param name="enabled" type="boolean" dir="return">
8136	<desc>Returned flag indicating the default value</desc>
8137	</param>
8138	</method>
8139	</interface>
8140
8141	<!--
8142	// IGuest
8143	/////////////////////////////////////////////////////////////////////////
8144	-->
8145
8146	<interface
8147	name="IGuestOSType" extends="$unknown"
8148	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8149	wsmap="struct"
8150	>
8151	<desc>
8152	</desc>
8153
8154	<attribute name="familyId" type="wstring" readonly="yes">
8155	<desc>Guest OS family identifier string.</desc>
8156	</attribute>
8157
8158	<attribute name="familyDescription" type="wstring" readonly="yes">
8159	<desc>Human readable description of the guest OS family.</desc>
8160	</attribute>
8161
8162	<attribute name="id" type="wstring" readonly="yes">
8163	<desc>Guest OS identifier string.</desc>
8164	</attribute>
8165
8166	<attribute name="description" type="wstring" readonly="yes">
8167	<desc>Human readable description of the guest OS.</desc>
8168	</attribute>
8169
8170	<attribute name="is64Bit" type="boolean" readonly="yes">
8171	<desc>Returns @c true if the given OS is 64-bit</desc>
8172	</attribute>
8173
8174	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8175	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8176	</attribute>
8177
8178	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8179	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8180	</attribute>
8181
8182	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8183	<desc>Recommended RAM size in Megabytes.</desc>
8184	</attribute>
8185
8186	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8187	<desc>Recommended video RAM size in Megabytes.</desc>
8188	</attribute>
8189
8190	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8191	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8192	</attribute>
8193
8194	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8195	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8196	</attribute>
8197
8198	<attribute name="recommendedHDD" type="long long" readonly="yes">
8199	<desc>Recommended hard disk size in bytes.</desc>
8200	</attribute>
8201
8202	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8203	<desc>Returns recommended network adapter for this OS type.</desc>
8204	</attribute>
8205
8206	<attribute name="recommendedPae" type="boolean" readonly="yes">
8207	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8208	</attribute>
8209
8210	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8211	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8212	</attribute>
8213
8214	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8215	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8216	</attribute>
8217
8218	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8219	<desc>Recommended storage controller type for HD drives.</desc>
8220	</attribute>
8221
8222	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8223	<desc>Recommended storage bus type for HD drives.</desc>
8224	</attribute>
8225
8226	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8227	<desc>Recommended firmware type.</desc>
8228	</attribute>
8229
8230	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8231	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8232	</attribute>
8233
8234	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8235	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8236	</attribute>
8237
8238	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8239	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8240	</attribute>
8241
8242	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8243	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8244	</attribute>
8245
8246	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8247	<desc>Recommended chipset type.</desc>
8248	</attribute>
8249
8250	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8251	<desc>Recommended audio type.</desc>
8252	</attribute>
8253
8254	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8255	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8256	</attribute>
8257
8258	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8259	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8260	</attribute>
8261
8262	</interface>
8263
8264	<enum
8265	name="AdditionsFacilityType"
8266	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8267	>
8268	<desc>
8269	Guest Additions facility IDs.
8270	</desc>
8271
8272	<const name="None" value="0">
8273	<desc>No/invalid facility.</desc>
8274	</const>
8275	<const name="VBoxGuestDriver" value="20">
8276	<desc>VirtualBox base driver (VBoxGuest).</desc>
8277	</const>
8278	<const name="VBoxService" value="100">
8279	<desc>VirtualBox system service (VBoxService).</desc>
8280	</const>
8281	<const name="VBoxTrayClient" value="101">
8282	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8283	</const>
8284	<const name="Seamless" value="1000">
8285	<desc>Seamless guest desktop integration.</desc>
8286	</const>
8287	<const name="Graphics" value="1100">
8288	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8289	are not immediately acted on and guest display resizes are probably not initiated by
8290	the guest additions.
8291	</desc>
8292	</const>
8293	<const name="All" value="2147483646">
8294	<desc>All facilities selected.</desc>
8295	</const>
8296	</enum>
8297
8298	<enum
8299	name="AdditionsFacilityClass"
8300	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8301	>
8302	<desc>
8303	Guest Additions facility classes.
8304	</desc>
8305
8306	<const name="None" value="0">
8307	<desc>No/invalid class.</desc>
8308	</const>
8309	<const name="Driver" value="10">
8310	<desc>Driver.</desc>
8311	</const>
8312	<const name="Service" value="30">
8313	<desc>System service.</desc>
8314	</const>
8315	<const name="Program" value="50">
8316	<desc>Program.</desc>
8317	</const>
8318	<const name="Feature" value="100">
8319	<desc>Feature.</desc>
8320	</const>
8321	<const name="ThirdParty" value="999">
8322	<desc>Third party.</desc>
8323	</const>
8324	<const name="All" value="2147483646">
8325	<desc>All facility classes selected.</desc>
8326	</const>
8327	</enum>
8328
8329	<enum
8330	name="AdditionsFacilityStatus"
8331	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8332	>
8333	<desc>
8334	Guest Additions facility states.
8335	</desc>
8336
8337	<const name="Inactive" value="0">
8338	<desc>Facility is not active.</desc>
8339	</const>
8340	<const name="Paused" value="1">
8341	<desc>Facility has been paused.</desc>
8342	</const>
8343	<const name="PreInit" value="20">
8344	<desc>Facility is preparing to initialize.</desc>
8345	</const>
8346	<const name="Init" value="30">
8347	<desc>Facility is initializing.</desc>
8348	</const>
8349	<const name="Active" value="50">
8350	<desc>Facility is up and running.</desc>
8351	</const>
8352	<const name="Terminating" value="100">
8353	<desc>Facility is shutting down.</desc>
8354	</const>
8355	<const name="Terminated" value="101">
8356	<desc>Facility successfully shut down.</desc>
8357	</const>
8358	<const name="Failed" value="800">
8359	<desc>Facility failed to start.</desc>
8360	</const>
8361	<const name="Unknown" value="999">
8362	<desc>Facility status is unknown.</desc>
8363	</const>
8364	</enum>
8365
8366	<interface
8367	name="IAdditionsFacility" extends="$unknown"
8368	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8369	wsmap="struct"
8370	>
8371	<desc>
8372	Structure representing a Guest Additions facility.
8373	</desc>
8374
8375	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8376	<desc>The class this facility is part of.</desc>
8377	</attribute>
8378
8379	<attribute name="lastUpdated" type="long long" readonly="yes">
8380	<desc>
8381	Time stamp of the last status update,
8382	in milliseconds since 1970-01-01 UTC.
8383	</desc>
8384	</attribute>
8385
8386	<attribute name="name" type="wstring" readonly="yes">
8387	<desc>The facility's friendly name.</desc>
8388	</attribute>
8389
8390	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8391	<desc>The current status.</desc>
8392	</attribute>
8393
8394	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8395	<desc>The facility's type ID.</desc>
8396	</attribute>
8397	</interface>
8398
8399	<enum
8400	name="AdditionsRunLevelType"
8401	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8402	>
8403	<desc>
8404	Guest Additions run level type.
8405	</desc>
8406
8407	<const name="None" value="0">
8408	<desc>Guest Additions are not loaded.</desc>
8409	</const>
8410	<const name="System" value="1">
8411	<desc>Guest drivers are loaded.</desc>
8412	</const>
8413	<const name="Userland" value="2">
8414	<desc>Common components (such as application services) are loaded.</desc>
8415	</const>
8416	<const name="Desktop" value="3">
8417	<desc>Per-user desktop components are loaded.</desc>
8418	</const>
8419	</enum>
8420
8421	<enum
8422	name="AdditionsUpdateFlag"
8423	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8424	>
8425	<desc>
8426	Guest Additions update flags.
8427	</desc>
8428
8429	<const name="None" value="0">
8430	<desc>No flag set.</desc>
8431	</const>
8432	<const name="WaitForUpdateStartOnly" value="1">
8433	<desc>Only wait for the update process being started and do not
8434	wait while peforming the actual update.</desc>
8435	</const>
8436	</enum>
8437
8438	<enum
8439	name="ExecuteProcessFlag"
8440	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8441	>
8442	<desc>
8443	Guest process execution flags.
8444	</desc>
8445
8446	<const name="None" value="0">
8447	<desc>No flag set.</desc>
8448	</const>
8449	<const name="WaitForProcessStartOnly" value="1">
8450	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8451	process itself then uses an infinite timeout.</desc>
8452	</const>
8453	<const name="IgnoreOrphanedProcesses" value="2">
8454	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8455	</const>
8456	<const name="Hidden" value="4">
8457	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8458	</const>
8459	<const name="NoProfile" value="8">
8460	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8461	</const>
8462	<const name="WaitForStdOut" value="16">
8463	<desc>The guest process waits until all data from stdout is read out.</desc>
8464	</const>
8465	<const name="WaitForStdErr" value="32">
8466	<desc>The guest process waits until all data from stderr is read out.</desc>
8467	</const>
8468	</enum>
8469
8470	<enum
8471	name="ExecuteProcessStatus"
8472	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8473	>
8474	<desc>
8475	Guest process execution status.
8476	</desc>
8477	<const name="Undefined" value="0">
8478	<desc>Process is in an undefined state.</desc>
8479	</const>
8480
8481	<const name="Started" value="1">
8482	<desc>Process has been started.</desc>
8483	</const>
8484	<const name="TerminatedNormally" value="2">
8485	<desc>Process terminated normally.</desc>
8486	</const>
8487	<const name="TerminatedSignal" value="3">
8488	<desc>Process terminated via signal.</desc>
8489	</const>
8490	<const name="TerminatedAbnormally" value="4">
8491	<desc>Process terminated abnormally.</desc>
8492	</const>
8493	<const name="TimedOutKilled" value="5">
8494	<desc>Process timed out and was killed.</desc>
8495	</const>
8496	<const name="TimedOutAbnormally" value="6">
8497	<desc>Process timed out and was not killed successfully.</desc>
8498	</const>
8499	<const name="Down" value="7">
8500	<desc>Service/OS is stopping, process was killed.</desc>
8501	</const>
8502	<const name="Error" value="8">
8503	<desc>Something went wrong (error code in flags).</desc>
8504	</const>
8505	</enum>
8506
8507	<enum
8508	name="ProcessInputFlag"
8509	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8510	>
8511	<desc>
8512	Guest process input flags.
8513	</desc>
8514	<const name="None" value="0">
8515	<desc>No flag set.</desc>
8516	</const>
8517	<const name="EndOfFile" value="1">
8518	<desc>End of file (input) reached.</desc>
8519	</const>
8520	</enum>
8521
8522	<enum
8523	name="ProcessOutputFlag"
8524	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8525	>
8526	<desc>
8527	Guest process output flags for specifying which
8528	type of output to retrieve.
8529	</desc>
8530	<const name="None" value="0">
8531	<desc>No flags set. Get output from stdout.</desc>
8532	</const>
8533	<const name="StdErr" value="1">
8534	<desc>Get output from stderr.</desc>
8535	</const>
8536	</enum>
8537
8538	<enum
8539	name="CopyFileFlag"
8540	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8541	>
8542	<desc>
8543	Host/Guest copy flags. At the moment none of these flags
8544	are implemented.
8545	</desc>
8546	<const name="None" value="0">
8547	<desc>No flag set.</desc>
8548	</const>
8549	<const name="Recursive" value="1">
8550	<desc>Copy directories recursively.</desc>
8551	</const>
8552	<const name="Update" value="2">
8553	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8554	</const>
8555	<const name="FollowLinks" value="4">
8556	<desc>Follow symbolic links.</desc>
8557	</const>
8558	</enum>
8559
8560	<enum
8561	name="DirectoryCreateFlag"
8562	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8563	>
8564	<desc>
8565	Directory creation flags.
8566	</desc>
8567	<const name="None" value="0">
8568	<desc>No flag set.</desc>
8569	</const>
8570	<const name="Parents" value="1">
8571	<desc>No error if existing, make parent directories as needed.</desc>
8572	</const>
8573	</enum>
8574
8575	<enum
8576	name="DragAndDropAction"
8577	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8578	>
8579	<desc>
8580	Possible actions within an Drag and Drop operation.
8581	</desc>
8582
8583	<const name="Ignore" value="0">
8584	<desc>Do nothing.</desc>
8585	</const>
8586
8587	<const name="Copy" value="1">
8588	<desc>Copy the item to the target.</desc>
8589	</const>
8590
8591	<const name="Move" value="2">
8592	<desc>Move the item to the target.</desc>
8593	</const>
8594
8595	<const name="Link" value="3">
8596	<desc>Link the item from within the target.</desc>
8597	</const>
8598	</enum>
8599
8600	<enum
8601	name="DirectoryOpenFlag"
8602	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8603	>
8604	<desc>
8605	Directory open flags.
8606	</desc>
8607	<const name="None" value="0">
8608	<desc>No flag set.</desc>
8609	</const>
8610	</enum>
8611
8612	<enum
8613	name="GuestDirEntryType"
8614	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8615	>
8616	<desc>
8617	Guest directory entry type.
8618	</desc>
8619	<const name="Unknown" value="0">
8620	<desc>Unknown.</desc>
8621	</const>
8622	<const name="Directory" value="4">
8623	<desc>Regular file.</desc>
8624	</const>
8625	<const name="File" value="10">
8626	<desc>Regular file.</desc>
8627	</const>
8628	<const name="Symlink" value="12">
8629	<desc>Symbolic link.</desc>
8630	</const>
8631	</enum>
8632
8633	<interface
8634	name="IGuestDirEntry" extends="$unknown"
8635	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8636	wsmap="struct"
8637	>
8638	<desc>
8639	Structure representing a directory entry on the guest OS.
8640	</desc>
8641	<attribute name="nodeId" type="long long" readonly="yes">
8642	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8643	</attribute>
8644	<attribute name="name" type="wstring" readonly="yes">
8645	<desc>The filename.</desc>
8646	</attribute>
8647	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8648	<desc>The entry type.</desc>
8649	</attribute>
8650	</interface>
8651
8652	<interface
8653	name="IGuest" extends="$unknown"
8654	uuid="1E404590-608E-492C-B00A-90C9EEB6C33F"
8655	wsmap="managed"
8656	>
8657	<desc>
8658	The IGuest interface represents information about the operating system
8659	running inside the virtual machine. Used in
8660	<link to="IConsole::guest"/>.
8661
8662	IGuest provides information about the guest operating system, whether
8663	Guest Additions are installed and other OS-specific virtual machine
8664	properties.
8665	</desc>
8666
8667	<attribute name="OSTypeId" type="wstring" readonly="yes">
8668	<desc>
8669	Identifier of the Guest OS type as reported by the Guest
8670	Additions.
8671	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8672	an IGuestOSType object representing details about the given
8673	Guest OS type.
8674	<note>
8675	If Guest Additions are not installed, this value will be
8676	the same as <link to="IMachine::OSTypeId"/>.
8677	</note>
8678	</desc>
8679	</attribute>
8680
8681	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8682	<desc>
8683	Current run level of the Guest Additions.
8684	</desc>
8685	</attribute>
8686
8687	<attribute name="additionsVersion" type="wstring" readonly="yes">
8688	<desc>
8689	Version of the Guest Additions including the revision (3 decimal numbers
8690	separated by dots + revision number) installed on the guest or empty
8691	when the Additions are not installed.
8692	</desc>
8693	</attribute>
8694
8695	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8696	<desc>
8697	Array of current known facilities. Only returns facilities where a status is known,
8698	e.g. facilities with an unknown status will not be returned.
8699	</desc>
8700	</attribute>
8701
8702	<attribute name="memoryBalloonSize" type="unsigned long">
8703	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8704	</attribute>
8705
8706	<attribute name="statisticsUpdateInterval" type="unsigned long">
8707	<desc>Interval to update guest statistics in seconds.</desc>
8708	</attribute>
8709
8710	<method name="internalGetStatistics">
8711	<desc>
8712	Internal method; do not use as it might change at any time.
8713	</desc>
8714	<param name="cpuUser" type="unsigned long" dir="out">
8715	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8716	</param>
8717	<param name="cpuKernel" type="unsigned long" dir="out">
8718	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8719	</param>
8720	<param name="cpuIdle" type="unsigned long" dir="out">
8721	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8722	</param>
8723	<param name="memTotal" type="unsigned long" dir="out">
8724	<desc>Total amount of physical guest RAM.</desc>
8725	</param>
8726	<param name="memFree" type="unsigned long" dir="out">
8727	<desc>Free amount of physical guest RAM.</desc>
8728	</param>
8729	<param name="memBalloon" type="unsigned long" dir="out">
8730	<desc>Amount of ballooned physical guest RAM.</desc>
8731	</param>
8732	<param name="memShared" type="unsigned long" dir="out">
8733	<desc>Amount of shared physical guest RAM.</desc>
8734	</param>
8735	<param name="memCache" type="unsigned long" dir="out">
8736	<desc>Total amount of guest (disk) cache memory.</desc>
8737	</param>
8738	<param name="pagedTotal" type="unsigned long" dir="out">
8739	<desc>Total amount of space in the page file.</desc>
8740	</param>
8741	<param name="memAllocTotal" type="unsigned long" dir="out">
8742	<desc>Total amount of memory allocated by the hypervisor.</desc>
8743	</param>
8744	<param name="memFreeTotal" type="unsigned long" dir="out">
8745	<desc>Total amount of free memory available in the hypervisor.</desc>
8746	</param>
8747	<param name="memBalloonTotal" type="unsigned long" dir="out">
8748	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8749	</param>
8750	<param name="memSharedTotal" type="unsigned long" dir="out">
8751	<desc>Total amount of shared memory in the hypervisor.</desc>
8752	</param>
8753	</method>
8754
8755	<method name="getFacilityStatus">
8756	<desc>
8757	Get the current status of a Guest Additions facility.
8758	</desc>
8759	<param name="facility" type="AdditionsFacilityType" dir="in">
8760	<desc>Facility to check status for.</desc>
8761	</param>
8762	<param name="timestamp" type="long long" dir="out">
8763	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8764	</param>
8765	<param name="status" type="AdditionsFacilityStatus" dir="return">
8766	<desc>The current (latest) facility status.</desc>
8767	</param>
8768	</method>
8769
8770	<method name="getAdditionsStatus">
8771	<desc>
8772	Retrieve the current status of a certain Guest Additions run level.
8773
8774	<result name="VBOX_E_NOT_SUPPORTED">
8775	Wrong status level specified.
8776	</result>
8777
8778	</desc>
8779	<param name="level" type="AdditionsRunLevelType" dir="in">
8780	<desc>Status level to check</desc>
8781	</param>
8782	<param name="active" type="boolean" dir="return">
8783	<desc>Flag whether the status level has been reached or not</desc>
8784	</param>
8785	</method>
8786
8787	<method name="setCredentials">
8788	<desc>
8789	Store login credentials that can be queried by guest operating
8790	systems with Additions installed. The credentials are transient
8791	to the session and the guest may also choose to erase them. Note
8792	that the caller cannot determine whether the guest operating system
8793	has queried or made use of the credentials.
8794
8795	<result name="VBOX_E_VM_ERROR">
8796	VMM device is not available.
8797	</result>
8798
8799	</desc>
8800	<param name="userName" type="wstring" dir="in">
8801	<desc>User name string, can be empty</desc>
8802	</param>
8803	<param name="password" type="wstring" dir="in">
8804	<desc>Password string, can be empty</desc>
8805	</param>
8806	<param name="domain" type="wstring" dir="in">
8807	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8808	</param>
8809	<param name="allowInteractiveLogon" type="boolean" dir="in">
8810	<desc>
8811	Flag whether the guest should alternatively allow the user to
8812	interactively specify different credentials. This flag might
8813	not be supported by all versions of the Additions.
8814	</desc>
8815	</param>
8816	</method>
8817
8818	<method name="dragHGEnter">
8819	<desc>
8820	Informs the guest about a Drag and Drop enter event.
8821
8822	This is used in Host - Guest direction.
8823
8824	<result name="VBOX_E_VM_ERROR">
8825	VMM device is not available.
8826	</result>
8827
8828	</desc>
8829	<param name="screenId" type="unsigned long" dir="in">
8830	<desc>The screen id where the Drag and Drop event occured.</desc>
8831	</param>
8832	<param name="y" type="unsigned long" dir="in">
8833	<desc>y-position of the event.</desc>
8834	</param>
8835	<param name="x" type="unsigned long" dir="in">
8836	<desc>x-position of the event.</desc>
8837	</param>
8838	<param name="defaultAction" type="DragAndDropAction" dir="in">
8839	<desc>The default action to use.</desc>
8840	</param>
8841	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8842	<desc>The actions which are allowed.</desc>
8843	</param>
8844	<param name="formats" type="wstring" dir="in" safearray="yes">
8845	<desc>The supported mime types.</desc>
8846	</param>
8847	<param name="resultAction" type="DragAndDropAction" dir="return">
8848	<desc>The resulting action of this event.</desc>
8849	</param>
8850	</method>
8851
8852	<method name="dragHGMove">
8853	<desc>
8854	Informs the guest about a Drag and Drop move event.
8855
8856	This is used in Host - Guest direction.
8857
8858	<result name="VBOX_E_VM_ERROR">
8859	VMM device is not available.
8860	</result>
8861
8862	</desc>
8863	<param name="screenId" type="unsigned long" dir="in">
8864	<desc>The screen id where the Drag and Drop event occured.</desc>
8865	</param>
8866	<param name="x" type="unsigned long" dir="in">
8867	<desc>x-position of the event.</desc>
8868	</param>
8869	<param name="y" type="unsigned long" dir="in">
8870	<desc>y-position of the event.</desc>
8871	</param>
8872	<param name="defaultAction" type="DragAndDropAction" dir="in">
8873	<desc>The default action to use.</desc>
8874	</param>
8875	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8876	<desc>The actions which are allowed.</desc>
8877	</param>
8878	<param name="formats" type="wstring" dir="in" safearray="yes">
8879	<desc>The supported mime types.</desc>
8880	</param>
8881	<param name="resultAction" type="DragAndDropAction" dir="return">
8882	<desc>The resulting action of this event.</desc>
8883	</param>
8884	</method>
8885
8886	<method name="dragHGLeave">
8887	<desc>
8888	Informs the guest about a Drag and Drop leave event.
8889
8890	This is used in Host - Guest direction.
8891
8892	<result name="VBOX_E_VM_ERROR">
8893	VMM device is not available.
8894	</result>
8895
8896	</desc>
8897	<param name="screenId" type="unsigned long" dir="in">
8898	<desc>The screen id where the Drag and Drop event occured.</desc>
8899	</param>
8900	</method>
8901
8902	<method name="dragHGDrop">
8903	<desc>
8904	Informs the guest about a drop event.
8905
8906	This is used in Host - Guest direction.
8907
8908	<result name="VBOX_E_VM_ERROR">
8909	VMM device is not available.
8910	</result>
8911
8912	</desc>
8913	<param name="screenId" type="unsigned long" dir="in">
8914	<desc>The screen id where the Drag and Drop event occured.</desc>
8915	</param>
8916	<param name="x" type="unsigned long" dir="in">
8917	<desc>x-position of the event.</desc>
8918	</param>
8919	<param name="y" type="unsigned long" dir="in">
8920	<desc>y-position of the event.</desc>
8921	</param>
8922	<param name="defaultAction" type="DragAndDropAction" dir="in">
8923	<desc>The default action to use.</desc>
8924	</param>
8925	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8926	<desc>The actions which are allowed.</desc>
8927	</param>
8928	<param name="formats" type="wstring" dir="in" safearray="yes">
8929	<desc>The supported mime types.</desc>
8930	</param>
8931	<param name="format" type="wstring" dir="out">
8932	<desc>The resulting format of this event.</desc>
8933	</param>
8934	<param name="resultAction" type="DragAndDropAction" dir="return">
8935	<desc>The resulting action of this event.</desc>
8936	</param>
8937	</method>
8938
8939	<method name="dragHGPutData">
8940	<desc>
8941	Informs the guest about a drop data event.
8942
8943	This is used in Host - Guest direction.
8944
8945	<result name="VBOX_E_VM_ERROR">
8946	VMM device is not available.
8947	</result>
8948
8949	</desc>
8950	<param name="screenId" type="unsigned long" dir="in">
8951	<desc>The screen id where the Drag and Drop event occured.</desc>
8952	</param>
8953	<param name="format" type="wstring" dir="in">
8954	<desc>The mime type the data is in.</desc>
8955	</param>
8956	<param name="data" type="octet" dir="in" safearray="yes">
8957	<desc>The actual data.</desc>
8958	</param>
8959	<param name="progress" type="IProgress" dir="return">
8960	<desc>Progress object to track the operation completion.</desc>
8961	</param>
8962	</method>
8963
8964	<method name="dragGHPending">
8965	<desc>
8966	Ask the guest if there is any Drag and Drop operation pending in the guest.
8967
8968	If no Drag and Drop operation is pending currently, Ignore is returned.
8969
8970	This is used in Guest - Host direction.
8971
8972	<result name="VBOX_E_VM_ERROR">
8973	VMM device is not available.
8974	</result>
8975
8976	</desc>
8977	<param name="screenId" type="unsigned long" dir="in">
8978	<desc>The screen id where the Drag and Drop event occured.</desc>
8979	</param>
8980	<param name="format" type="wstring" dir="out" safearray="yes">
8981	<desc>On return the supported mime types.</desc>
8982	</param>
8983	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
8984	<desc>On return the actions which are allowed.</desc>
8985	</param>
8986	<param name="defaultAction" type="DragAndDropAction" dir="return">
8987	<desc>On return the default action to use.</desc>
8988	</param>
8989	</method>
8990
8991	<method name="dragGHDropped">
8992	<desc>
8993	Informs the guest that a drop event occured for a pending Drag and Drop event.
8994
8995	This is used in Guest - Host direction.
8996
8997	<result name="VBOX_E_VM_ERROR">
8998	VMM device is not available.
8999	</result>
9000
9001	</desc>
9002
9003	<param name="format" type="wstring" dir="in">
9004	<desc>The mime type the data must be in.</desc>
9005	</param>
9006	<param name="action" type="DragAndDropAction" dir="in">
9007	<desc>The action to use.</desc>
9008	</param>
9009	<param name="progress" type="IProgress" dir="return">
9010	<desc>Progress object to track the operation completion.</desc>
9011	</param>
9012	</method>
9013
9014	<method name="dragGHGetData">
9015	<desc>
9016	Fetch the data of a previously Drag and Drop event from the guest.
9017
9018	This is used in Guest - Host direction.
9019
9020	<result name="VBOX_E_VM_ERROR">
9021	VMM device is not available.
9022	</result>
9023
9024	</desc>
9025
9026	<param name="data" type="octet" safearray="yes" dir="return">
9027	<desc>The actual data.</desc>
9028	</param>
9029	</method>
9030
9031	<method name="executeProcess">
9032	<desc>
9033	Executes an existing program inside the guest VM.
9034
9035	<note>
9036	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9037	to serve up to 25 guest processes at a time. If all 25 guest processes
9038	are still active and running, starting a new guest process will result in an
9039	appropriate error message.
9040
9041	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9042	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9043	set, the guest process will not exit until all data from the specified
9044	stream(s) is/are read out.
9045
9046	To raise or lower the guest process execution limit, either the guest property
9047	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9048	command line by specifying "--control-procs-max-kept" needs to be modified.
9049	A restart of the guest OS is required afterwards. To serve unlimited guest
9050	processes, a value of "0" needs to be set (not recommended).
9051	</note>
9052
9053	<result name="VBOX_E_IPRT_ERROR">
9054	Could not execute process.
9055	</result>
9056
9057	</desc>
9058	<param name="execName" type="wstring" dir="in">
9059	<desc>
9060	Full path name of the command to execute on the guest; the
9061	commands has to exists in the guest VM in order to be executed.
9062	</desc>
9063	</param>
9064	<param name="flags" type="unsigned long" dir="in">
9065	<desc>
9066	<link to="ExecuteProcessFlag"/> flags.
9067	</desc>
9068	</param>
9069	<param name="arguments" type="wstring" safearray="yes" dir="in">
9070	<desc>
9071	Array of arguments passed to the execution command.
9072	</desc>
9073	</param>
9074	<param name="environment" type="wstring" safearray="yes" dir="in">
9075	<desc>
9076	Environment variables that can be set while the command is being
9077	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9078	variable just set its name ("NAME") without a value.
9079	</desc>
9080	</param>
9081	<param name="userName" type="wstring" dir="in">
9082	<desc>
9083	User name under which the command will be executed; has to exist
9084	and have the appropriate rights to execute programs in the VM.
9085	</desc>
9086	</param>
9087	<param name="password" type="wstring" dir="in">
9088	<desc>
9089	Password of the user account specified.
9090	</desc>
9091	</param>
9092	<param name="timeoutMS" type="unsigned long" dir="in">
9093	<desc>
9094	The maximum timeout value (in msec) to wait for finished program
9095	execution. Pass 0 for an infinite timeout.
9096	</desc>
9097	</param>
9098	<param name="pid" type="unsigned long" dir="out">
9099	<desc>
9100	The PID (process ID) of the started command for later reference.
9101	</desc>
9102	</param>
9103	<param name="progress" type="IProgress" dir="return">
9104	<desc>Progress object to track the operation completion.</desc>
9105	</param>
9106	</method>
9107
9108	<method name="getProcessOutput">
9109	<desc>
9110	Retrieves output of a formerly started and running guest process.
9111
9112	<note>
9113	Starting with VirtualBox 4.1.8 this only will return output data
9114	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9115	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9116	<link to="ExecuteProcessFlag"/> is set in the
9117	former <link to="#executeProcess"/> call for this guest process.
9118	</note>
9119
9120	<result name="VBOX_E_IPRT_ERROR">
9121	Could not retrieve output.
9122	</result>
9123
9124	</desc>
9125	<param name="pid" type="unsigned long" dir="in">
9126	<desc>
9127	Process id returned by earlier <link to="#executeProcess"/> call.
9128	</desc>
9129	</param>
9130	<param name="flags" type="unsigned long" dir="in">
9131	<desc>
9132	<link to="ProcessOutputFlag"/> flags.
9133	</desc>
9134	</param>
9135	<param name="timeoutMS" type="unsigned long" dir="in">
9136	<desc>
9137	The maximum timeout value (in msec) to wait for output
9138	data. Pass 0 for an infinite timeout.
9139	</desc>
9140	</param>
9141	<param name="size" type="long long" dir="in">
9142	<desc>
9143	Size in bytes to read in the buffer.
9144	</desc>
9145	</param>
9146	<param name="data" type="octet" safearray="yes" dir="return">
9147	<desc>
9148	Buffer for retrieving the actual output. A data size of 0 means end of file
9149	if the requested size was not 0. This is the unprocessed
9150	output data, i.e. the line ending style depends on the platform of
9151	the system the server is running on.
9152	</desc>
9153	</param>
9154	</method>
9155
9156	<method name="getProcessStatus">
9157	<desc>
9158	Retrieves status, exit code and the exit reason of a formerly started
9159	guest process. If a guest process exited or got terminated this function
9160	returns its final status and removes this process from the list of
9161	known guest processes for further retrieval.
9162
9163	<result name="VBOX_E_IPRT_ERROR">
9164	Process with specified PID was not found.
9165	</result>
9166
9167	</desc>
9168	<param name="pid" type="unsigned long" dir="in">
9169	<desc>
9170	Process id returned by earlier <link to="#executeProcess"/> call.
9171	</desc>
9172	</param>
9173	<param name="exitcode" type="unsigned long" dir="out">
9174	<desc>
9175	The exit code (if available).
9176	</desc>
9177	</param>
9178	<param name="flags" type="unsigned long" dir="out">
9179	<desc>
9180	Additional flags of process status. Not used at the moment and
9181	must be set to 0.
9182	</desc>
9183	</param>
9184	<param name="reason" type="ExecuteProcessStatus" dir="return">
9185	<desc>
9186	The current process status.
9187	</desc>
9188	</param>
9189	</method>
9190
9191	<method name="copyFromGuest">
9192	<desc>
9193	Copies files/directories from guest to the host.
9194
9195	<result name="VBOX_E_IPRT_ERROR">
9196	Error while copying.
9197	</result>
9198
9199	</desc>
9200	<param name="source" type="wstring" dir="in">
9201	<desc>
9202	Source file on the guest to copy.
9203	</desc>
9204	</param>
9205	<param name="dest" type="wstring" dir="in">
9206	<desc>
9207	Destination path on the host.
9208	</desc>
9209	</param>
9210	<param name="userName" type="wstring" dir="in">
9211	<desc>
9212	User name under which the copy command will be executed; the
9213	user has to exist and have the appropriate rights to read from
9214	the source path.
9215	</desc>
9216	</param>
9217	<param name="password" type="wstring" dir="in">
9218	<desc>
9219	Password of the user account specified.
9220	</desc>
9221	</param>
9222	<param name="flags" type="unsigned long" dir="in">
9223	<desc>
9224	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9225	</desc>
9226	</param>
9227	<param name="progress" type="IProgress" dir="return">
9228	<desc>Progress object to track the operation completion.</desc>
9229	</param>
9230	</method>
9231
9232	<method name="copyToGuest">
9233	<desc>
9234	Copies files/directories from host to the guest.
9235
9236	<result name="VBOX_E_IPRT_ERROR">
9237	Error while copying.
9238	</result>
9239
9240	</desc>
9241	<param name="source" type="wstring" dir="in">
9242	<desc>
9243	Source file on the host to copy.
9244	</desc>
9245	</param>
9246	<param name="dest" type="wstring" dir="in">
9247	<desc>
9248	Destination path on the guest.
9249	</desc>
9250	</param>
9251	<param name="userName" type="wstring" dir="in">
9252	<desc>
9253	User name under which the copy command will be executed; the
9254	user has to exist and have the appropriate rights to write to
9255	the destination path.
9256	</desc>
9257	</param>
9258	<param name="password" type="wstring" dir="in">
9259	<desc>
9260	Password of the user account specified.
9261	</desc>
9262	</param>
9263	<param name="flags" type="unsigned long" dir="in">
9264	<desc>
9265	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9266	</desc>
9267	</param>
9268	<param name="progress" type="IProgress" dir="return">
9269	<desc>Progress object to track the operation completion.</desc>
9270	</param>
9271	</method>
9272
9273	<method name="directoryClose">
9274	<desc>
9275	Closes a formerly opened guest directory.
9276
9277	<result name="VBOX_E_IPRT_ERROR">
9278	Error while closing directory.
9279	</result>
9280
9281	</desc>
9282	<param name="handle" type="unsigned long" dir="in">
9283	<desc>
9284	Handle of opened directory to close.
9285	</desc>
9286	</param>
9287	</method>
9288
9289	<method name="directoryCreate">
9290	<desc>
9291	Creates a directory on the guest.
9292
9293	<result name="VBOX_E_IPRT_ERROR">
9294	Error while creating directory.
9295	</result>
9296
9297	</desc>
9298	<param name="directory" type="wstring" dir="in">
9299	<desc>
9300	Directory to create.
9301	</desc>
9302	</param>
9303	<param name="userName" type="wstring" dir="in">
9304	<desc>
9305	User name under which the directory creation will be executed; the
9306	user has to exist and have the appropriate rights to create the
9307	desired directory.
9308	</desc>
9309	</param>
9310	<param name="password" type="wstring" dir="in">
9311	<desc>
9312	Password of the user account specified.
9313	</desc>
9314	</param>
9315	<param name="mode" type="unsigned long" dir="in">
9316	<desc>
9317	File mode.
9318	</desc>
9319	</param>
9320	<param name="flags" type="unsigned long" dir="in">
9321	<desc>
9322	<link to="DirectoryCreateFlag"/> flags.
9323	</desc>
9324	</param>
9325	</method>
9326
9327	<method name="directoryOpen">
9328	<desc>
9329	Opens a directory on the guest.
9330
9331	<result name="VBOX_E_IPRT_ERROR">
9332	Error while opening / reading directory.
9333	</result>
9334
9335	</desc>
9336	<param name="directory" type="wstring" dir="in">
9337	<desc>
9338	Directory to read.
9339	</desc>
9340	</param>
9341	<param name="filter" type="wstring" dir="in">
9342	<desc>
9343	Directory filter (DOS style wildcards). Set to empty
9344	string if no filter required.
9345	</desc>
9346	</param>
9347	<param name="flags" type="unsigned long" dir="in">
9348	<desc>
9349	<link to="DirectoryOpenFlag"/> flags.
9350	</desc>
9351	</param>
9352	<param name="userName" type="wstring" dir="in">
9353	<desc>
9354	User name under which the directory reading will be performed; the
9355	user has to exist and have the appropriate rights to access / read the
9356	desired directory.
9357	</desc>
9358	</param>
9359	<param name="password" type="wstring" dir="in">
9360	<desc>
9361	Password of the user account specified.
9362	</desc>
9363	</param>
9364	<param name="handle" type="unsigned long" dir="return">
9365	<desc>
9366	Handle of opened directory returned by openDirectory.
9367	</desc>
9368	</param>
9369	</method>
9370
9371	<method name="directoryRead">
9372	<desc>
9373	Reads the next directory entry of an opened guest directory.
9374
9375	<result name="E_ABORT">
9376	When the end of the directory has been reached.
9377	</result>
9378
9379	<result name="VBOX_E_IPRT_ERROR">
9380	Error while opening / reading directory.
9381	</result>
9382
9383	</desc>
9384	<param name="handle" type="unsigned long" dir="in">
9385	<desc>
9386	Handle of opened directory returned by openDirectory.
9387	</desc>
9388	</param>
9389	<param name="entry" type="IGuestDirEntry" dir="return">
9390	<desc>
9391	Information about next directory entry on success.
9392	</desc>
9393	</param>
9394	</method>
9395
9396	<method name="fileExists">
9397	<desc>
9398	Checks if the specified file name exists and is a regular file.
9399
9400	If the file name ends with a slash or backslash, the function assumes
9401	it's a directory and will check if the specified directory exists and
9402	is a regular directory.
9403
9404	<result name="VBOX_E_IPRT_ERROR">
9405	Error while looking up information.
9406	</result>
9407
9408	</desc>
9409	<param name="file" type="wstring" dir="in">
9410	<desc>
9411	Full path of file to check.
9412	</desc>
9413	</param>
9414	<param name="userName" type="wstring" dir="in">
9415	<desc>
9416	User name under which the lookup will be performed; the
9417	user has to exist and have the appropriate rights to access / read the
9418	desired directory.
9419	</desc>
9420	</param>
9421	<param name="password" type="wstring" dir="in">
9422	<desc>
9423	Password of the user account specified.
9424	</desc>
9425	</param>
9426	<param name="exists" type="boolean" dir="return">
9427	<desc>
9428	True if it's a regular file, false if it isn't (or doesn't exist).
9429	</desc>
9430	</param>
9431	</method>
9432
9433	<method name="fileQuerySize">
9434	<desc>
9435	Queries the size of a file, given the path to it.
9436
9437	<result name="VBOX_E_IPRT_ERROR">
9438	Error while looking up information.
9439	</result>
9440
9441	</desc>
9442	<param name="file" type="wstring" dir="in">
9443	<desc>
9444	Full path of file to query file size for.
9445	</desc>
9446	</param>
9447	<param name="userName" type="wstring" dir="in">
9448	<desc>
9449	User name under which the lookup will be performed; the
9450	user has to exist and have the appropriate rights to access / read the
9451	desired directory.
9452	</desc>
9453	</param>
9454	<param name="password" type="wstring" dir="in">
9455	<desc>
9456	Password of the user account specified.
9457	</desc>
9458	</param>
9459	<param name="size" type="long long" dir="return">
9460	<desc>
9461	Size (in bytes) of file specified.
9462	</desc>
9463	</param>
9464	</method>
9465
9466	<method name="setProcessInput">
9467	<desc>
9468	Sends input into a formerly started process.
9469
9470	<result name="VBOX_E_IPRT_ERROR">
9471	Could not send input.
9472	</result>
9473
9474	</desc>
9475	<param name="pid" type="unsigned long" dir="in">
9476	<desc>
9477	Process id returned by earlier <link to="#executeProcess"/> call.
9478	</desc>
9479	</param>
9480	<param name="flags" type="unsigned long" dir="in">
9481	<desc>
9482	<link to="ProcessInputFlag"/> flags.
9483	</desc>
9484	</param>
9485	<param name="timeoutMS" type="unsigned long" dir="in">
9486	<desc>
9487	The maximum timeout value (in msec) to wait for getting the
9488	data transfered to the guest. Pass 0 for an infinite timeout.
9489	</desc>
9490	</param>
9491	<param name="data" type="octet" dir="in" safearray="yes">
9492	<desc>
9493	Buffer of input data to send to the started process to.
9494	</desc>
9495	</param>
9496	<param name="written" type="unsigned long" dir="return">
9497	<desc>
9498	Number of bytes written.
9499	</desc>
9500	</param>
9501	</method>
9502
9503	<method name="updateGuestAdditions">
9504	<desc>
9505	Updates already installed Guest Additions in a VM
9506	(Windows guests only).
9507
9508	<result name="VBOX_E_IPRT_ERROR">
9509	Error while updating.
9510	</result>
9511
9512	</desc>
9513	<param name="source" type="wstring" dir="in">
9514	<desc>
9515	Path to the Guest Additions .ISO file to use for the upate.
9516	</desc>
9517	</param>
9518	<param name="flags" type="unsigned long" dir="in">
9519	<desc>
9520	<link to="AdditionsUpdateFlag"/> flags.
9521	</desc>
9522	</param>
9523	<param name="progress" type="IProgress" dir="return">
9524	<desc>Progress object to track the operation completion.</desc>
9525	</param>
9526	</method>
9527
9528	</interface>
9529
9530
9531	<!--
9532	// IProgress
9533	/////////////////////////////////////////////////////////////////////////
9534	-->
9535
9536	<interface
9537	name="IProgress" extends="$unknown"
9538	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9539	wsmap="managed"
9540	>
9541	<desc>
9542	The IProgress interface is used to track and control
9543	asynchronous tasks within VirtualBox.
9544
9545	An instance of this is returned every time VirtualBox starts
9546	an asynchronous task (in other words, a separate thread) which
9547	continues to run after a method call returns. For example,
9548	<link to="IConsole::saveState" />, which saves the state of
9549	a running virtual machine, can take a long time to complete.
9550	To be able to display a progress bar, a user interface such as
9551	the VirtualBox graphical user interface can use the IProgress
9552	object returned by that method.
9553
9554	Note that IProgress is a "read-only" interface in the sense
9555	that only the VirtualBox internals behind the Main API can
9556	create and manipulate progress objects, whereas client code
9557	can only use the IProgress object to monitor a task's
9558	progress and, if <link to="#cancelable" /> is @c true,
9559	cancel the task by calling <link to="#cancel" />.
9560
9561	A task represented by IProgress consists of either one or
9562	several sub-operations that run sequentially, one by one (see
9563	<link to="#operation" /> and <link to="#operationCount" />).
9564	Every operation is identified by a number (starting from 0)
9565	and has a separate description.
9566
9567	You can find the individual percentage of completion of the current
9568	operation in <link to="#operationPercent" /> and the
9569	percentage of completion of the task as a whole
9570	in <link to="#percent" />.
9571
9572	Similarly, you can wait for the completion of a particular
9573	operation via <link to="#waitForOperationCompletion" /> or
9574	for the completion of the whole task via
9575	<link to="#waitForCompletion" />.
9576	</desc>
9577
9578	<attribute name="id" type="uuid" mod="string" readonly="yes">
9579	<desc>ID of the task.</desc>
9580	</attribute>
9581
9582	<attribute name="description" type="wstring" readonly="yes">
9583	<desc>Description of the task.</desc>
9584	</attribute>
9585
9586	<attribute name="initiator" type="$unknown" readonly="yes">
9587	<desc>Initiator of the task.</desc>
9588	</attribute>
9589
9590	<attribute name="cancelable" type="boolean" readonly="yes">
9591	<desc>Whether the task can be interrupted.</desc>
9592	</attribute>
9593
9594	<attribute name="percent" type="unsigned long" readonly="yes">
9595	<desc>
9596	Current progress value of the task as a whole, in percent.
9597	This value depends on how many operations are already complete.
9598	Returns 100 if <link to="#completed" /> is @c true.
9599	</desc>
9600	</attribute>
9601
9602	<attribute name="timeRemaining" type="long" readonly="yes">
9603	<desc>
9604	Estimated remaining time until the task completes, in
9605	seconds. Returns 0 once the task has completed; returns -1
9606	if the remaining time cannot be computed, in particular if
9607	the current progress is 0.
9608
9609	Even if a value is returned, the estimate will be unreliable
9610	for low progress values. It will become more reliable as the
9611	task progresses; it is not recommended to display an ETA
9612	before at least 20% of a task have completed.
9613	</desc>
9614	</attribute>
9615
9616	<attribute name="completed" type="boolean" readonly="yes">
9617	<desc>Whether the task has been completed.</desc>
9618	</attribute>
9619
9620	<attribute name="canceled" type="boolean" readonly="yes">
9621	<desc>Whether the task has been canceled.</desc>
9622	</attribute>
9623
9624	<attribute name="resultCode" type="long" readonly="yes">
9625	<desc>
9626	Result code of the progress task.
9627	Valid only if <link to="#completed"/> is @c true.
9628	</desc>
9629	</attribute>
9630
9631	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9632	<desc>
9633	Extended information about the unsuccessful result of the
9634	progress operation. May be @c null if no extended information
9635	is available.
9636	Valid only if <link to="#completed"/> is @c true and
9637	<link to="#resultCode"/> indicates a failure.
9638	</desc>
9639	</attribute>
9640
9641	<attribute name="operationCount" type="unsigned long" readonly="yes">
9642	<desc>
9643	Number of sub-operations this task is divided into.
9644	Every task consists of at least one suboperation.
9645	</desc>
9646	</attribute>
9647
9648	<attribute name="operation" type="unsigned long" readonly="yes">
9649	<desc>Number of the sub-operation being currently executed.</desc>
9650	</attribute>
9651
9652	<attribute name="operationDescription" type="wstring" readonly="yes">
9653	<desc>
9654	Description of the sub-operation being currently executed.
9655	</desc>
9656	</attribute>
9657
9658	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9659	<desc>Progress value of the current sub-operation only, in percent.</desc>
9660	</attribute>
9661
9662	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9663	<desc>Weight value of the current sub-operation only.</desc>
9664	</attribute>
9665
9666	<attribute name="timeout" type="unsigned long">
9667	<desc>
9668	When non-zero, this specifies the number of milliseconds after which
9669	the operation will automatically be canceled. This can only be set on
9670	cancelable objects.
9671	</desc>
9672	</attribute>
9673
9674	<method name="setCurrentOperationProgress">
9675	<desc>Internal method, not to be called externally.</desc>
9676	<param name="percent" type="unsigned long" dir="in" />
9677	</method>
9678	<method name="setNextOperation">
9679	<desc>Internal method, not to be called externally.</desc>
9680	<param name="nextOperationDescription" type="wstring" dir="in" />
9681	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9682	</method>
9683
9684	<method name="waitForCompletion">
9685	<desc>
9686	Waits until the task is done (including all sub-operations)
9687	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9688
9689	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9690	thread are not processed while waiting. Neglecting event queues may
9691	have dire consequences (degrade performance, resource hogs,
9692	deadlocks, etc.), this is specially so for the main thread on
9693	platforms using XPCOM. Callers are adviced wait for short periods
9694	and service their event queues between calls, or to create a worker
9695	thread to do the waiting.
9696
9697	<result name="VBOX_E_IPRT_ERROR">
9698	Failed to wait for task completion.
9699	</result>
9700	</desc>
9701
9702	<param name="timeout" type="long" dir="in">
9703	<desc>
9704	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9705	</desc>
9706	</param>
9707	</method>
9708
9709	<method name="waitForOperationCompletion">
9710	<desc>
9711	Waits until the given operation is done with a given timeout in
9712	milliseconds; specify -1 for an indefinite wait.
9713
9714	See <link to="#waitForCompletion"> for event queue considerations.</link>
9715
9716	<result name="VBOX_E_IPRT_ERROR">
9717	Failed to wait for operation completion.
9718	</result>
9719
9720	</desc>
9721	<param name="operation" type="unsigned long" dir="in">
9722	<desc>
9723	Number of the operation to wait for.
9724	Must be less than <link to="#operationCount"/>.
9725	</desc>
9726	</param>
9727	<param name="timeout" type="long" dir="in">
9728	<desc>
9729	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9730	</desc>
9731	</param>
9732	</method>
9733
9734	<method name="waitForAsyncProgressCompletion">
9735	<desc>
9736	Waits until the other task is completed (including all
9737	sub-operations) and forward all changes from the other progress to
9738	this progress. This means sub-operation number, description, percent
9739	and so on.
9740
9741	You have to take care on setting up at least the same count on
9742	sub-operations in this progress object like there are in the other
9743	progress object.
9744
9745	If the other progress object supports cancel and this object gets any
9746	cancel request (when here enabled as well), it will be forwarded to
9747	the other progress object.
9748
9749	If there is an error in the other progress, this error isn't
9750	automatically transfered to this progress object. So you have to
9751	check any operation error within the other progress object, after
9752	this method returns.
9753	</desc>
9754
9755	<param name="pProgressAsync" type="IProgress" dir="in">
9756	<desc>
9757	The progress object of the asynchrony process.
9758	</desc>
9759	</param>
9760	</method>
9761
9762	<method name="cancel">
9763	<desc>
9764	Cancels the task.
9765	<note>
9766	If <link to="#cancelable"/> is @c false, then this method will fail.
9767	</note>
9768
9769	<result name="VBOX_E_INVALID_OBJECT_STATE">
9770	Operation cannot be canceled.
9771	</result>
9772
9773	</desc>
9774	</method>
9775
9776	</interface>
9777
9778	<!--
9779	// ISnapshot
9780	/////////////////////////////////////////////////////////////////////////
9781	-->
9782
9783	<interface
9784	name="ISnapshot" extends="$unknown"
9785	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9786	wsmap="managed"
9787	>
9788	<desc>
9789	The ISnapshot interface represents a snapshot of the virtual
9790	machine.
9791
9792	Together with the differencing media that are created
9793	when a snapshot is taken, a machine can be brought back to
9794	the exact state it was in when the snapshot was taken.
9795
9796	The ISnapshot interface has no methods, only attributes; snapshots
9797	are controlled through methods of the <link to="IConsole" /> interface
9798	which also manage the media associated with the snapshot.
9799	The following operations exist:
9800
9801	<ul>
9802	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9803	by creating new, empty differencing images for the machine's
9804	media and saving the VM settings and (if the VM is running)
9805	the current VM state in the snapshot.
9806
9807	The differencing images will then receive all data written to
9808	the machine's media, while their parent (base) images
9809	remain unmodified after the snapshot has been taken (see
9810	<link to="IMedium" /> for details about differencing images).
9811	This simplifies restoring a machine to the state of a snapshot:
9812	only the differencing images need to be deleted.
9813
9814	The current machine state is not changed by taking a snapshot
9815	except that <link to="IMachine::currentSnapshot" /> is set to
9816	the newly created snapshot, which is also added to the machine's
9817	snapshots tree.
9818	</li>
9819
9820	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9821	the state of a previous snapshot by deleting the differencing
9822	image of each of the machine's media and setting the machine's
9823	settings and state to the state that was saved in the snapshot (if any).
9824
9825	This destroys the machine's current state. After calling this,
9826	<link to="IMachine::currentSnapshot" /> points to the snapshot
9827	that was restored.
9828	</li>
9829
9830	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9831	without affecting the current machine state.
9832
9833	This does not change the current machine state, but instead frees the
9834	resources allocated when the snapshot was taken: the settings and machine
9835	state file are deleted (if any), and the snapshot's differencing image for
9836	each of the machine's media gets merged with its parent image.
9837
9838	Neither the current machine state nor other snapshots are affected
9839	by this operation, except that parent media will be modified
9840	to contain the disk data associated with the snapshot being deleted.
9841
9842	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9843	attribute is set to the current snapshot's parent or NULL if it
9844	has no parent. Otherwise the attribute is unchanged.
9845	</li>
9846	</ul>
9847
9848	Each snapshot contains a copy of virtual machine's settings (hardware
9849	configuration etc.). This copy is contained in an immutable (read-only)
9850	instance of <link to="IMachine" /> which is available from the snapshot's
9851	<link to="#machine" /> attribute. When restoring the snapshot, these
9852	settings are copied back to the original machine.
9853
9854	In addition, if the machine was running when the
9855	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9856	the current VM state is saved in the snapshot (similarly to what happens
9857	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9858	because when restoring it, the VM will be running.
9859
9860	If the machine was in <link to="MachineState_Saved">saved</link> saved,
9861	the snapshot receives a copy of the execution state file
9862	(<link to="IMachine::stateFilePath"/>).
9863
9864	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9865	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9866	it then contains a so-called "zero execution state", representing a
9867	machine that is powered off.
9868	</desc>
9869
9870	<attribute name="id" type="uuid" mod="string" readonly="yes">
9871	<desc>UUID of the snapshot.</desc>
9872	</attribute>
9873
9874	<attribute name="name" type="wstring">
9875	<desc>Short name of the snapshot.
9876	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9877	be called implicitly.</note>
9878	</desc>
9879	</attribute>
9880
9881	<attribute name="description" type="wstring">
9882	<desc>Optional description of the snapshot.
9883	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9884	be called implicitly.</note>
9885	</desc>
9886	</attribute>
9887
9888	<attribute name="timeStamp" type="long long" readonly="yes">
9889	<desc>
9890	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9891	</desc>
9892	</attribute>
9893
9894	<attribute name="online" type="boolean" readonly="yes">
9895	<desc>
9896	@c true if this snapshot is an online snapshot and @c false otherwise.
9897
9898	When this attribute is @c true, the
9899	<link to="IMachine::stateFilePath"/> attribute of the
9900	<link to="#machine"/> object associated with this snapshot
9901	will point to the saved state file. Otherwise, it will be
9902	an empty string.
9903	</desc>
9904	</attribute>
9905
9906	<attribute name="machine" type="IMachine" readonly="yes">
9907	<desc>
9908	Virtual machine this snapshot is taken on. This object
9909	stores all settings the machine had when taking this snapshot.
9910	<note>
9911	The returned machine object is immutable, i.e. no
9912	any settings can be changed.
9913	</note>
9914	</desc>
9915	</attribute>
9916
9917	<attribute name="parent" type="ISnapshot" readonly="yes">
9918	<desc>
9919	Parent snapshot (a snapshot this one is based on), or
9920	@c null if the snapshot has no parent (i.e. is the first snapshot).
9921	</desc>
9922	</attribute>
9923
9924	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
9925	<desc>
9926	Child snapshots (all snapshots having this one as a parent).
9927	By inspecting this attribute starting with a machine's root snapshot
9928	(which can be obtained by calling <link to="IMachine::findSnapshot" />
9929	with a @c null UUID), a machine's snapshots tree can be iterated over.
9930	</desc>
9931	</attribute>
9932
9933	<method name="getChildrenCount" const="yes">
9934	<desc>
9935	Returns the number of direct childrens of this snapshot.
9936	</desc>
9937	<param name="childrenCount" type="unsigned long" dir="return">
9938	<desc>
9939	</desc>
9940	</param>
9941	</method>
9942
9943	</interface>
9944
9945
9946	<!--
9947	// IMedium
9948	/////////////////////////////////////////////////////////////////////////
9949	-->
9950
9951	<enum
9952	name="MediumState"
9953	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9954	>
9955	<desc>
9956	Virtual medium state.
9957	<see><link to="IMedium"/></see>
9958	</desc>
9959
9960	<const name="NotCreated" value="0">
9961	<desc>
9962	Associated medium storage does not exist (either was not created yet or
9963	was deleted).
9964	</desc>
9965	</const>
9966	<const name="Created" value="1">
9967	<desc>
9968	Associated storage exists and accessible; this gets set if the
9969	accessibility check performed by <link to="IMedium::refreshState" />
9970	was successful.
9971	</desc>
9972	</const>
9973	<const name="LockedRead" value="2">
9974	<desc>
9975	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
9976	no data modification is possible.
9977	</desc>
9978	</const>
9979	<const name="LockedWrite" value="3">
9980	<desc>
9981	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
9982	no concurrent data reading or modification is possible.
9983	</desc>
9984	</const>
9985	<const name="Inaccessible" value="4">
9986	<desc>
9987	Medium accessibility check (see <link to="IMedium::refreshState" />) has
9988	not yet been performed, or else, associated medium storage is not
9989	accessible. In the first case, <link to="IMedium::lastAccessError"/>
9990	is empty, in the second case, it describes the error that occurred.
9991	</desc>
9992	</const>
9993	<const name="Creating" value="5">
9994	<desc>
9995	Associated medium storage is being created.
9996	</desc>
9997	</const>
9998	<const name="Deleting" value="6">
9999	<desc>
10000	Associated medium storage is being deleted.
10001	</desc>
10002	</const>
10003	</enum>
10004
10005	<enum
10006	name="MediumType"
10007	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10008	>
10009	<desc>
10010	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10011	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10012	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10013	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10014	</desc>
10015
10016	<const name="Normal" value="0">
10017	<desc>
10018	Normal medium (attached directly or indirectly, preserved
10019	when taking snapshots).
10020	</desc>
10021	</const>
10022	<const name="Immutable" value="1">
10023	<desc>
10024	Immutable medium (attached indirectly, changes are wiped out
10025	the next time the virtual machine is started).
10026	</desc>
10027	</const>
10028	<const name="Writethrough" value="2">
10029	<desc>
10030	Write through medium (attached directly, ignored when
10031	taking snapshots).
10032	</desc>
10033	</const>
10034	<const name="Shareable" value="3">
10035	<desc>
10036	Allow using this medium concurrently by several machines.
10037	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10038	</desc>
10039	</const>
10040	<const name="Readonly" value="4">
10041	<desc>
10042	A readonly medium, which can of course be used by several machines.
10043	<note>Present and accepted since VirtualBox 4.0.</note>
10044	</desc>
10045	</const>
10046	<const name="MultiAttach" value="5">
10047	<desc>
10048	A medium which is is indirectly attached, so that one base medium can
10049	be used for several VMs which have their own differencing medium to
10050	store their modifications. In some sense a variant of Immutable
10051	with unset AutoReset flag in each differencing medium.
10052	<note>Present and accepted since VirtualBox 4.0.</note>
10053	</desc>
10054	</const>
10055	</enum>
10056
10057	<enum
10058	name="MediumVariant"
10059	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
10060	>
10061	<desc>
10062	Virtual medium image variant. More than one flag may be set.
10063	<see><link to="IMedium"/></see>
10064	</desc>
10065
10066	<const name="Standard" value="0">
10067	<desc>
10068	No particular variant requested, results in using the backend default.
10069	</desc>
10070	</const>
10071	<const name="VmdkSplit2G" value="0x01">
10072	<desc>
10073	VMDK image split in chunks of less than 2GByte.
10074	</desc>
10075	</const>
10076	<const name="VmdkStreamOptimized" value="0x04">
10077	<desc>
10078	VMDK streamOptimized image. Special import/export format which is
10079	read-only/append-only.
10080	</desc>
10081	</const>
10082	<const name="VmdkESX" value="0x08">
10083	<desc>
10084	VMDK format variant used on ESX products.
10085	</desc>
10086	</const>
10087	<const name="Fixed" value="0x10000">
10088	<desc>
10089	Fixed image. Only allowed for base images.
10090	</desc>
10091	</const>
10092	<const name="Diff" value="0x20000">
10093	<desc>
10094	Differencing image. Only allowed for child images.
10095	</desc>
10096	</const>
10097	<const name="NoCreateDir" value="0x40000000">
10098	<desc>
10099	Special flag which suppresses automatic creation of the subdirectory.
10100	Only used when passing the medium variant as an input parameter.
10101	</desc>
10102	</const>
10103	</enum>
10104
10105	<interface
10106	name="IMediumAttachment" extends="$unknown"
10107	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10108	wsmap="struct"
10109	>
10110	<desc>
10111	The IMediumAttachment interface links storage media to virtual machines.
10112	For each medium (<link to="IMedium"/>) which has been attached to a
10113	storage controller (<link to="IStorageController"/>) of a machine
10114	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10115	method, one instance of IMediumAttachment is added to the machine's
10116	<link to="IMachine::mediumAttachments"/> array attribute.
10117
10118	Each medium attachment specifies the storage controller as well as a
10119	port and device number and the IMedium instance representing a virtual
10120	hard disk or floppy or DVD image.
10121
10122	For removable media (DVDs or floppies), there are two additional
10123	options. For one, the IMedium instance can be @c null to represent
10124	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10125	secondly, the medium can be one of the pseudo-media for host drives
10126	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10127
10128	<h3>Attaching Hard Disks</h3>
10129
10130	Hard disks are attached to virtual machines using the
10131	<link to="IMachine::attachDevice"/> method and detached using the
10132	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10133	type (see <link to="IMedium::type" />), hard disks are attached either
10134	<i>directly</i> or <i>indirectly</i>.
10135
10136	When a hard disk is being attached directly, it is associated with the
10137	virtual machine and used for hard disk operations when the machine is
10138	running. When a hard disk is being attached indirectly, a new differencing
10139	hard disk linked to it is implicitly created and this differencing hard
10140	disk is associated with the machine and used for hard disk operations.
10141	This also means that if <link to="IMachine::attachDevice"/> performs
10142	a direct attachment then the same hard disk will be returned in response
10143	to the subsequent <link to="IMachine::getMedium"/> call; however if
10144	an indirect attachment is performed then
10145	<link to="IMachine::getMedium"/> will return the implicitly created
10146	differencing hard disk, not the original one passed to <link
10147	to="IMachine::attachDevice"/>. In detail:
10148
10149	<ul>
10150	<li><b>Normal base</b> hard disks that do not have children (i.e.
10151	differencing hard disks linked to them) and that are not already
10152	attached to virtual machines in snapshots are attached <b>directly</b>.
10153	Otherwise, they are attached <b>indirectly</b> because having
10154	dependent children or being part of the snapshot makes it impossible
10155	to modify hard disk contents without breaking the integrity of the
10156	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10157	quickly determine the kind of the attachment for the given hard
10158	disk. Note that if a normal base hard disk is to be indirectly
10159	attached to a virtual machine with snapshots then a special
10160	procedure called <i>smart attachment</i> is performed (see below).</li>
10161	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10162	they are attached <b>directly</b> if they do not have children and are
10163	not attached to virtual machines in snapshots, and <b>indirectly</b>
10164	otherwise. Note that the smart attachment procedure is never performed
10165	for differencing hard disks.</li>
10166	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10167	they are designed to be non-writable. If an immutable hard disk is
10168	attached to a virtual machine with snapshots then a special
10169	procedure called smart attachment is performed (see below).</li>
10170	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10171	also as designed. This also means that writethrough hard disks cannot
10172	have other hard disks linked to them at all.</li>
10173	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10174	also as designed. This also means that shareable hard disks cannot
10175	have other hard disks linked to them at all. They behave almost
10176	like writethrough hard disks, except that shareable hard disks can
10177	be attached to several virtual machines which are running, allowing
10178	concurrent accesses. You need special cluster software running in
10179	the virtual machines to make use of such disks.</li>
10180	</ul>
10181
10182	Note that the same hard disk, regardless of its type, may be attached to
10183	more than one virtual machine at a time. In this case, the machine that is
10184	started first gains exclusive access to the hard disk and attempts to
10185	start other machines having this hard disk attached will fail until the
10186	first machine is powered down.
10187
10188	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10189	that the given hard disk remains associated with the given machine after a
10190	successful <link to="IMachine::detachDevice"/> call until
10191	<link to="IMachine::saveSettings"/> is called to save all changes to
10192	machine settings to disk. This deferring is necessary to guarantee that
10193	the hard disk configuration may be restored at any time by a call to
10194	<link to="IMachine::discardSettings"/> before the settings
10195	are saved (committed).
10196
10197	Note that if <link to="IMachine::discardSettings"/> is called after
10198	indirectly attaching some hard disks to the machine but before a call to
10199	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10200	all differencing hard disks implicitly created by
10201	<link to="IMachine::attachDevice"/> for these indirect attachments.
10202	Such implicitly created hard disks will also be immediately deleted when
10203	detached explicitly using the <link to="IMachine::detachDevice"/>
10204	call if it is made before <link to="IMachine::saveSettings"/>. This
10205	implicit deletion is safe because newly created differencing hard
10206	disks do not contain any user data.
10207
10208	However, keep in mind that detaching differencing hard disks that were
10209	implicitly created by <link to="IMachine::attachDevice"/>
10210	before the last <link to="IMachine::saveSettings"/> call will
10211	<b>not</b> implicitly delete them as they may already contain some data
10212	(for example, as a result of virtual machine execution). If these hard
10213	disks are no more necessary, the caller can always delete them explicitly
10214	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10215	from this machine by the <link to="IMachine::saveSettings"/> call.
10216
10217	<h3>Smart Attachment</h3>
10218
10219	When normal base or immutable hard disks are indirectly attached to a
10220	virtual machine then some additional steps are performed to make sure the
10221	virtual machine will have the most recent "view" of the hard disk being
10222	attached. These steps include walking through the machine's snapshots
10223	starting from the current one and going through ancestors up to the first
10224	snapshot. Hard disks attached to the virtual machine in all
10225	of the encountered snapshots are checked whether they are descendants of
10226	the given normal base or immutable hard disk. The first found child (which
10227	is the differencing hard disk) will be used instead of the normal base or
10228	immutable hard disk as a parent for creating a new differencing hard disk
10229	that will be actually attached to the machine. And only if no descendants
10230	are found or if the virtual machine does not have any snapshots then the
10231	normal base or immutable hard disk will be used itself as a parent for
10232	this differencing hard disk.
10233
10234	It is easier to explain what smart attachment does using the
10235	following example:
10236	<pre>
10237	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10238
10239	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10240	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10241	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10242	Snapshot 4 (none) Snapshot 4 (none)
10243	CurState (none) CurState (D3->D2.vdi)
10244
10245	NOT
10246	...
10247	CurState (D3->B.vdi)
10248	</pre>
10249	The first column is the virtual machine configuration before the base hard
10250	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10251	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10252	mean that the hard disk that is actually attached to the machine is a
10253	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10254	another hard disk, <tt>B.vdi</tt>.
10255
10256	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10257	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10258	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10259	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10260	it cannot be attached directly and needs an indirect attachment (i.e.
10261	implicit creation of a new differencing hard disk). Due to the smart
10262	attachment procedure, the new differencing hard disk
10263	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10264	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10265	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10266	machine.
10267
10268	Note that if there is more than one descendant hard disk of the given base
10269	hard disk found in a snapshot, and there is an exact device, channel and
10270	bus match, then this exact match will be used. Otherwise, the youngest
10271	descendant will be picked up.
10272
10273	There is one more important aspect of the smart attachment procedure which
10274	is not related to snapshots at all. Before walking through the snapshots
10275	as described above, the backup copy of the current list of hard disk
10276	attachment is searched for descendants. This backup copy is created when
10277	the hard disk configuration is changed for the first time after the last
10278	<link to="IMachine::saveSettings"/> call and used by
10279	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10280	changes. When such a descendant is found in this backup copy, it will be
10281	simply re-attached back, without creating a new differencing hard disk for
10282	it. This optimization is necessary to make it possible to re-attach the
10283	base or immutable hard disk to a different bus, channel or device slot
10284	without losing the contents of the differencing hard disk actually
10285	attached to the machine in place of it.
10286
10287	</desc>
10288
10289	<attribute name="medium" type="IMedium" readonly="yes">
10290	<desc>Medium object associated with this attachment; it
10291	can be @c null for removable devices.</desc>
10292	</attribute>
10293
10294	<attribute name="controller" type="wstring" readonly="yes">
10295	<desc>Name of the storage controller of this attachment; this
10296	refers to one of the controllers in <link to="IMachine::storageControllers" />
10297	by name.</desc>
10298	</attribute>
10299
10300	<attribute name="port" type="long" readonly="yes">
10301	<desc>Port number of this attachment.
10302	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10303	</desc>
10304	</attribute>
10305
10306	<attribute name="device" type="long" readonly="yes">
10307	<desc>Device slot number of this attachment.
10308	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10309	</desc>
10310	</attribute>
10311
10312	<attribute name="type" type="DeviceType" readonly="yes">
10313	<desc>Device type of this attachment.</desc>
10314	</attribute>
10315
10316	<attribute name="passthrough" type="boolean" readonly="yes">
10317	<desc>Pass I/O requests through to a device on the host.</desc>
10318	</attribute>
10319
10320	<attribute name="temporaryEject" type="boolean" readonly="yes">
10321	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10322	</attribute>
10323
10324	<attribute name="isEjected" type="boolean" readonly="yes">
10325	<desc>Signals that the removable medium has been ejected. This is not
10326	necessarily equivalent to having a @c null medium association.</desc>
10327	</attribute>
10328
10329	<attribute name="nonRotational" type="boolean" readonly="yes">
10330	<desc>Whether the associated medium is non-rotational.</desc>
10331	</attribute>
10332
10333	<attribute name="discard" type="boolean" readonly="yes">
10334	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10335	</attribute>
10336
10337	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10338	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10339	</attribute>
10340
10341	</interface>
10342
10343	<interface
10344	name="IMedium" extends="$unknown"
10345	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10346	wsmap="managed"
10347	>
10348	<desc>
10349	The IMedium interface represents virtual storage for a machine's
10350	hard disks, CD/DVD or floppy drives. It will typically represent
10351	a disk image on the host, for example a VDI or VMDK file representing
10352	a virtual hard disk, or an ISO or RAW file representing virtual
10353	removable media, but can also point to a network location (e.g.
10354	for iSCSI targets).
10355
10356	Instances of IMedium are connected to virtual machines by way of medium
10357	attachments, which link the storage medium to a particular device slot
10358	of a storage controller of the virtual machine.
10359	In the VirtualBox API, virtual storage is therefore always represented
10360	by the following chain of object links:
10361
10362	<ul>
10363	<li><link to="IMachine::storageControllers"/> contains an array of
10364	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10365	these are instances of <link to="IStorageController"/>).</li>
10366	<li><link to="IMachine::mediumAttachments"/> contains an array of
10367	medium attachments (instances of <link to="IMediumAttachment"/>
10368	created by <link to="IMachine::attachDevice" />),
10369	each containing a storage controller from the above array, a
10370	port/device specification, and an instance of IMedium representing
10371	the medium storage (image file).
10372
10373	For removable media, the storage medium is optional; a medium
10374	attachment with no medium represents a CD/DVD or floppy drive
10375	with no medium inserted. By contrast, hard disk attachments
10376	will always have an IMedium object attached.</li>
10377	<li>Each IMedium in turn points to a storage unit (such as a file
10378	on the host computer or a network resource) that holds actual
10379	data. This location is represented by the <link to="#location"/>
10380	attribute.</li>
10381	</ul>
10382
10383	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10384	new hard disk media can be created with the VirtualBox API using the
10385	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10386	disks (see below) are usually implicitly created by VirtualBox as
10387	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10388	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10389	should be created with external tools and then opened from within VirtualBox.
10390
10391	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10392	drive. In that case the <link to="#id" /> attribute contains the UUID of
10393	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10394
10395	<h3>Media registries</h3>
10396
10397	When a medium has been opened or created using one of the aforementioned
10398	APIs, it becomes "known" to VirtualBox. Known media can be attached
10399	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
10400	They also appear in the global
10401	<link to="IVirtualBox::hardDisks" />,
10402	<link to="IVirtualBox::DVDImages" /> and
10403	<link to="IVirtualBox::floppyImages" /> arrays.
10404
10405	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10406	in the VirtualBox.xml file, which was shared between all machines and made
10407	transporting machines and their media from one host to another difficult.
10408
10409	Starting with VirtualBox 4.0, media are only added to a registry when they are
10410	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10411	backwards compatibility, which registry a medium is added to depends on which
10412	VirtualBox version created a machine:
10413
10414	<ul>
10415	<li>If the medium has first been attached to a machine which was created by
10416	VirtualBox 4.0 or later, it is added to that machine's media registry in
10417	the machine XML settings file. This way all information about a machine's
10418	media attachments is contained in a single file and can be transported
10419	easily.</li>
10420	<li>For older media attachments (i.e. if the medium was first attached to a
10421	machine which was created with a VirtualBox version before 4.0), media
10422	continue to be registered in the global VirtualBox settings file, for
10423	backwards compatibility.</li>
10424	</ul>
10425
10426	See <link to="IVirtualBox::openMedium" /> for more information.
10427
10428	Media are removed from media registries by the <link to="IMedium::close"/>,
10429	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10430
10431	<h3>Accessibility checks</h3>
10432
10433	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10434	method is called explicitly on a medium. This is done to make the VirtualBox object
10435	ready for serving requests as fast as possible and let the end-user
10436	application decide if it needs to check media accessibility right away or not.
10437
10438	As a result, when VirtualBox starts up (e.g. the VirtualBox
10439	object gets created for the first time), all known media are in the
10440	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10441	attribute is an empty string because no actual accessibility check has
10442	been made yet.
10443
10444	After calling <link to="#refreshState" />, a medium is considered
10445	<i>accessible</i> if its storage unit can be read. In that case, the
10446	<link to="#state"/> attribute has a value of "Created". If the storage
10447	unit cannot be read (for example, because it is located on a disconnected
10448	network resource, or was accidentally deleted outside VirtualBox),
10449	the medium is considered <i>inaccessible</i>, which is indicated by the
10450	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10451	obtained by reading the <link to="#lastAccessError"/> attribute.
10452
10453	<h3>Medium types</h3>
10454
10455	There are five types of medium behavior which are stored in the
10456	<link to="#type"/> attribute (see <link to="MediumType" />) and
10457	which define the medium's behavior with attachments and snapshots.
10458
10459	All media can be also divided in two groups: <i>base</i> media and
10460	<i>differencing</i> media. A base medium contains all sectors of the
10461	medium data in its own storage and therefore can be used independently.
10462	In contrast, a differencing medium is a "delta" to some other medium and
10463	contains only those sectors which differ from that other medium, which is
10464	then called a <i>parent</i>. The differencing medium is said to be
10465	<i>linked to</i> that parent. The parent may be itself a differencing
10466	medium, thus forming a chain of linked media. The last element in that
10467	chain must always be a base medium. Note that several differencing
10468	media may be linked to the same parent medium.
10469
10470	Differencing media can be distinguished from base media by querying the
10471	<link to="#parent"/> attribute: base media do not have parents they would
10472	depend on, so the value of this attribute is always @c null for them.
10473	Using this attribute, it is possible to walk up the medium tree (from the
10474	child medium to its parent). It is also possible to walk down the tree
10475	using the <link to="#children"/> attribute.
10476
10477	Note that the type of all differencing media is "normal"; all other
10478	values are meaningless for them. Base media may be of any type.
10479
10480	<h3>Automatic composition of the file name part</h3>
10481
10482	Another extension to the <link to="IMedium::location"/> attribute is that
10483	there is a possibility to cause VirtualBox to compose a unique value for
10484	the file name part of the location using the UUID of the hard disk. This
10485	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10486	e.g. before the storage unit is created, and works as follows. You set the
10487	value of the <link to="IMedium::location"/> attribute to a location
10488	specification which only contains the path specification but not the file
10489	name part and ends with either a forward slash or a backslash character.
10490	In response, VirtualBox will generate a new UUID for the hard disk and
10491	compose the file name using the following pattern:
10492	<pre>
10493	<path>/{<uuid>}.<ext>
10494	</pre>
10495	where <tt><path></tt> is the supplied path specification,
10496	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10497	is the default extension for the storage format of this hard disk. After
10498	that, you may call any of the methods that create a new hard disk storage
10499	unit and they will use the generated UUID and file name.
10500	</desc>
10501
10502	<attribute name="id" type="uuid" mod="string" readonly="yes">
10503	<desc>
10504	UUID of the medium. For a newly created medium, this value is a randomly
10505	generated UUID.
10506
10507	<note>
10508	For media in one of MediumState_NotCreated, MediumState_Creating or
10509	MediumState_Deleting states, the value of this property is undefined
10510	and will most likely be an empty UUID.
10511	</note>
10512	</desc>
10513	</attribute>
10514
10515	<attribute name="description" type="wstring">
10516	<desc>
10517	Optional description of the medium. For a newly created medium the value
10518	of this attribute is an empty string.
10519
10520	Medium types that don't support this attribute will return E_NOTIMPL in
10521	attempt to get or set this attribute's value.
10522
10523	<note>
10524	For some storage types, reading this attribute may return an outdated
10525	(last known) value when <link to="#state"/> is <link
10526	to="MediumState_Inaccessible"/> or <link
10527	to="MediumState_LockedWrite"/> because the value of this attribute is
10528	stored within the storage unit itself. Also note that changing the
10529	attribute value is not possible in such case, as well as when the
10530	medium is the <link to="MediumState_LockedRead"/> state.
10531	</note>
10532	</desc>
10533	</attribute>
10534
10535	<attribute name="state" type="MediumState" readonly="yes">
10536	<desc>
10537	Returns the current medium state, which is the last state set by
10538	the accessibility check performed by <link to="#refreshState"/>.
10539	If that method has not yet been called on the medium, the state
10540	is "Inaccessible"; as opposed to truly inaccessible media, the
10541	value of <link to="#lastAccessError"/> will be an empty string in
10542	that case.
10543
10544	<note>As of version 3.1, this no longer performs an accessibility check
10545	automatically; call <link to="#refreshState"/> for that.
10546	</note>
10547	</desc>
10548	</attribute>
10549
10550	<attribute name="variant" type="unsigned long" readonly="yes">
10551	<desc>
10552	Returns the storage format variant information for this medium
10553	as a combination of the flags described at <link to="MediumVariant" />.
10554	Before <link to="#refreshState"/> is called this method returns
10555	an undefined value.
10556	</desc>
10557	</attribute>
10558
10559	<attribute name="location" type="wstring">
10560	<desc>
10561	Location of the storage unit holding medium data.
10562
10563	The format of the location string is medium type specific. For medium
10564	types using regular files in a host's file system, the location
10565	string is the full file name.
10566
10567	Some medium types may support changing the storage unit location by
10568	simply changing the value of this property. If this operation is not
10569	supported, the implementation will return E_NOTIMPL in attempt to set
10570	this attribute's value.
10571
10572	When setting a value of the location attribute which is a regular file
10573	in the host's file system, the given file name may be either relative to
10574	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10575	absolute. Note that if the given location specification does not contain
10576	the file extension part then a proper default extension will be
10577	automatically appended by the implementation depending on the medium type.
10578	</desc>
10579	</attribute>
10580
10581	<attribute name="name" type="wstring" readonly="yes">
10582	<desc>
10583	Name of the storage unit holding medium data.
10584
10585	The returned string is a short version of the <link to="#location"/>
10586	attribute that is suitable for representing the medium in situations
10587	where the full location specification is too long (such as lists
10588	and comboboxes in GUI frontends). This string is also used by frontends
10589	to sort the media list alphabetically when needed.
10590
10591	For example, for locations that are regular files in the host's file
10592	system, the value of this attribute is just the file name (+ extension),
10593	without the path specification.
10594
10595	Note that as opposed to the <link to="#location"/> attribute, the name
10596	attribute will not necessary be unique for a list of media of the
10597	given type and format.
10598	</desc>
10599	</attribute>
10600
10601	<attribute name="deviceType" type="DeviceType" readonly="yes">
10602	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10603	medium.</desc>
10604	</attribute>
10605
10606	<attribute name="hostDrive" type="boolean" readonly="yes">
10607	<desc>True if this corresponds to a drive on the host.</desc>
10608	</attribute>
10609
10610	<attribute name="size" type="long long" readonly="yes">
10611	<desc>
10612	Physical size of the storage unit used to hold medium data (in bytes).
10613
10614	<note>
10615	For media whose <link to="#state"/> is <link
10616	to="MediumState_Inaccessible"/>, the value of this property is the
10617	last known size. For <link to="MediumState_NotCreated"/> media,
10618	the returned value is zero.
10619	</note>
10620	</desc>
10621	</attribute>
10622
10623	<attribute name="format" type="wstring" readonly="yes">
10624	<desc>
10625	Storage format of this medium.
10626
10627	The value of this attribute is a string that specifies a backend used
10628	to store medium data. The storage format is defined when you create a
10629	new medium or automatically detected when you open an existing medium,
10630	and cannot be changed later.
10631
10632	The list of all storage formats supported by this VirtualBox
10633	installation can be obtained using
10634	<link to="ISystemProperties::mediumFormats"/>.
10635	</desc>
10636	</attribute>
10637
10638	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10639	<desc>
10640	Storage medium format object corresponding to this medium.
10641
10642	The value of this attribute is a reference to the medium format object
10643	that specifies the backend properties used to store medium data. The
10644	storage format is defined when you create a new medium or automatically
10645	detected when you open an existing medium, and cannot be changed later.
10646
10647	<note>@c null is returned if there is no associated medium format
10648	object. This can e.g. happen for medium objects representing host
10649	drives and other special medium objects.</note>
10650	</desc>
10651	</attribute>
10652
10653	<attribute name="type" type="MediumType">
10654	<desc>
10655	Type (role) of this medium.
10656
10657	The following constraints apply when changing the value of this
10658	attribute:
10659	<ul>
10660	<li>If a medium is attached to a virtual machine (either in the
10661	current state or in one of the snapshots), its type cannot be
10662	changed.
10663	</li>
10664	<li>As long as the medium has children, its type cannot be set
10665	to <link to="MediumType_Writethrough"/>.
10666	</li>
10667	<li>The type of all differencing media is
10668	<link to="MediumType_Normal"/> and cannot be changed.
10669	</li>
10670	</ul>
10671
10672	The type of a newly created or opened medium is set to
10673	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10674	which have a type of <link to="MediumType_Writethrough"/>.
10675	</desc>
10676	</attribute>
10677
10678	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10679	<desc>
10680	Returns which medium types can selected for this medium.
10681
10682	<result name="E_NOTIMPL">
10683	This attribute is not implemented at the moment.
10684	</result>
10685	</desc>
10686	</attribute>
10687
10688	<attribute name="parent" type="IMedium" readonly="yes">
10689	<desc>
10690	Parent of this medium (the medium this medium is directly based
10691	on).
10692
10693	Only differencing media have parents. For base (non-differencing)
10694	media, @c null is returned.
10695	</desc>
10696	</attribute>
10697
10698	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10699	<desc>
10700	Children of this medium (all differencing media directly based
10701	on this medium). A @c null array is returned if this medium
10702	does not have any children.
10703	</desc>
10704	</attribute>
10705
10706	<attribute name="base" type="IMedium" readonly="yes">
10707	<desc>
10708	Base medium of this medium.
10709
10710	If this is a differencing medium, its base medium is the medium
10711	the given medium branch starts from. For all other types of media, this
10712	property returns the medium object itself (i.e. the same object this
10713	property is read on).
10714	</desc>
10715	</attribute>
10716
10717	<attribute name="readOnly" type="boolean" readonly="yes">
10718	<desc>
10719	Returns @c true if this medium is read-only and @c false otherwise.
10720
10721	A medium is considered to be read-only when its contents cannot be
10722	modified without breaking the integrity of other parties that depend on
10723	this medium such as its child media or snapshots of virtual machines
10724	where this medium is attached to these machines. If there are no
10725	children and no such snapshots then there is no dependency and the
10726	medium is not read-only.
10727
10728	The value of this attribute can be used to determine the kind of the
10729	attachment that will take place when attaching this medium to a
10730	virtual machine. If the value is @c false then the medium will
10731	be attached directly. If the value is @c true then the medium
10732	will be attached indirectly by creating a new differencing child
10733	medium for that. See the interface description for more information.
10734
10735	Note that all <link to="MediumType_Immutable">Immutable</link> media
10736	are always read-only while all
10737	<link to="MediumType_Writethrough">Writethrough</link> media are
10738	always not.
10739
10740	<note>
10741	The read-only condition represented by this attribute is related to
10742	the medium type and usage, not to the current
10743	<link to="IMedium::state">medium state</link> and not to the read-only
10744	state of the storage unit.
10745	</note>
10746	</desc>
10747	</attribute>
10748
10749	<attribute name="logicalSize" type="long long" readonly="yes">
10750	<desc>
10751	Logical size of this medium (in bytes), as reported to the
10752	guest OS running inside the virtual machine this medium is
10753	attached to. The logical size is defined when the medium is created
10754	and cannot be changed later.
10755
10756	<note>
10757	Reading this property on a differencing medium will return the size
10758	of its <link to="#base"/> medium.
10759	</note>
10760	<note>
10761	For media whose state is <link to="#state"/> is <link
10762	to="MediumState_Inaccessible"/>, the value of this property is the
10763	last known logical size. For <link to="MediumState_NotCreated"/>
10764	media, the returned value is zero.
10765	</note>
10766	</desc>
10767	</attribute>
10768
10769	<attribute name="autoReset" type="boolean">
10770	<desc>
10771	Whether this differencing medium will be automatically reset each
10772	time a virtual machine it is attached to is powered up. This
10773	attribute is automatically set to @c true for the last
10774	differencing image of an "immutable" medium (see
10775	<link to="MediumType" />).
10776
10777	See <link to="#reset"/> for more information about resetting
10778	differencing media.
10779
10780	<note>
10781	Reading this property on a base (non-differencing) medium will
10782	always @c false. Changing the value of this property in this
10783	case is not supported.
10784	</note>
10785
10786	<result name="VBOX_E_NOT_SUPPORTED">
10787	This is not a differencing medium (when changing the attribute
10788	value).
10789	</result>
10790	</desc>
10791	</attribute>
10792
10793	<attribute name="lastAccessError" type="wstring" readonly="yes">
10794	<desc>
10795	Text message that represents the result of the last accessibility
10796	check performed by <link to="#refreshState"/>.
10797
10798	An empty string is returned if the last accessibility check
10799	was successful or has not yet been called. As a result, if
10800	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10801	then <link to="#refreshState"/> has yet to be called; this is the
10802	default value of media after VirtualBox initialization.
10803	A non-empty string indicates a failure and should normally describe
10804	a reason of the failure (for example, a file read error).
10805	</desc>
10806	</attribute>
10807
10808	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10809	<desc>
10810	Array of UUIDs of all machines this medium is attached to.
10811
10812	A @c null array is returned if this medium is not attached to any
10813	machine or to any machine's snapshot.
10814
10815	<note>
10816	The returned array will include a machine even if this medium is not
10817	attached to that machine in the current state but attached to it in
10818	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10819	details.
10820	</note>
10821	</desc>
10822	</attribute>
10823
10824	<method name="setIDs">
10825	<desc>
10826	Changes the UUID and parent UUID for a hard disk medium.
10827	</desc>
10828	<param name="setImageId" type="boolean" dir="in">
10829	<desc>
10830	Select whether a new image UUID is set or not.
10831	</desc>
10832	</param>
10833	<param name="imageId" type="uuid" mod="string" dir="in">
10834	<desc>
10835	New UUID for the image. If an empty string is passed, then a new
10836	UUID is automatically created, provided that @a setImageId is @c true.
10837	Specifying a zero UUID is not allowed.
10838	</desc>
10839	</param>
10840	<param name="setParentId" type="boolean" dir="in">
10841	<desc>
10842	Select whether a new parent UUID is set or not.
10843	</desc>
10844	</param>
10845	<param name="parentId" type="uuid" mod="string" dir="in">
10846	<desc>
10847	New parent UUID for the image. If an empty string is passed, then a
10848	new UUID is automatically created, provided @a setParentId is
10849	@c true. A zero UUID is valid.
10850	</desc>
10851	</param>
10852	<result name="E_INVALIDARG">
10853	Invalid parameter combination.
10854	</result>
10855	<result name="VBOX_E_NOT_SUPPORTED">
10856	Medium is not a hard disk medium.
10857	</result>
10858	</method>
10859
10860	<method name="refreshState">
10861	<desc>
10862	If the current medium state (see <link to="MediumState"/>) is one of
10863	"Created", "Inaccessible" or "LockedRead", then this performs an
10864	accessibility check on the medium and sets the value of the <link to="#state"/>
10865	attribute accordingly; that value is also returned for convenience.
10866
10867	For all other state values, this does not perform a refresh but returns
10868	the state only.
10869
10870	The refresh, if performed, may take a long time (several seconds or even
10871	minutes, depending on the storage unit location and format) because it performs an
10872	accessibility check of the storage unit. This check may cause a significant
10873	delay if the storage unit of the given medium is, for example, a file located
10874	on a network share which is not currently accessible due to connectivity
10875	problems. In that case, the call will not return until a timeout
10876	interval defined by the host OS for this operation expires. For this reason,
10877	it is recommended to never read this attribute on the main UI thread to avoid
10878	making the UI unresponsive.
10879
10880	If the last known state of the medium is "Created" and the accessibility
10881	check fails, then the state would be set to "Inaccessible", and
10882	<link to="#lastAccessError"/> may be used to get more details about the
10883	failure. If the state of the medium is "LockedRead", then it remains the
10884	same, and a non-empty value of <link to="#lastAccessError"/> will
10885	indicate a failed accessibility check in this case.
10886
10887	Note that not all medium states are applicable to all medium types.
10888	</desc>
10889	<param name="state" type="MediumState" dir="return">
10890	<desc>
10891	New medium state.
10892	</desc>
10893	</param>
10894	</method>
10895
10896	<method name="getSnapshotIds">
10897	<desc>
10898	Returns an array of UUIDs of all snapshots of the given machine where
10899	this medium is attached to.
10900
10901	If the medium is attached to the machine in the current state, then the
10902	first element in the array will always be the ID of the queried machine
10903	(i.e. the value equal to the @c machineId argument), followed by
10904	snapshot IDs (if any).
10905
10906	If the medium is not attached to the machine in the current state, then
10907	the array will contain only snapshot IDs.
10908
10909	The returned array may be @c null if this medium is not attached
10910	to the given machine at all, neither in the current state nor in one of
10911	the snapshots.
10912	</desc>
10913	<param name="machineId" type="uuid" mod="string" dir="in">
10914	<desc>
10915	UUID of the machine to query.
10916	</desc>
10917	</param>
10918	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
10919	<desc>
10920	Array of snapshot UUIDs of the given machine using this medium.
10921	</desc>
10922	</param>
10923	</method>
10924
10925	<method name="lockRead">
10926	<desc>
10927	Locks this medium for reading.
10928
10929	A read lock is shared: many clients can simultaneously lock the
10930	same medium for reading unless it is already locked for writing (see
10931	<link to="#lockWrite"/>) in which case an error is returned.
10932
10933	When the medium is locked for reading, it cannot be modified
10934	from within VirtualBox. This means that any method that changes
10935	the properties of this medium or contents of the storage unit
10936	will return an error (unless explicitly stated otherwise). That
10937	includes an attempt to start a virtual machine that wants to
10938	write to the the medium.
10939
10940	When the virtual machine is started up, it locks for reading all
10941	media it uses in read-only mode. If some medium cannot be locked
10942	for reading, the startup procedure will fail.
10943	A medium is typically locked for reading while it is used by a running
10944	virtual machine but has a depending differencing image that receives
10945	the actual write operations. This way one base medium can have
10946	multiple child differencing images which can be written to
10947	simultaneously. Read-only media such as DVD and floppy images are
10948	also locked for reading only (so they can be in use by multiple
10949	machines simultaneously).
10950
10951	A medium is also locked for reading when it is the source of a
10952	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10953
10954	The medium locked for reading must be unlocked using the <link
10955	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
10956	can be nested and must be followed by the same number of paired
10957	<link to="#unlockRead"/> calls.
10958
10959	This method sets the medium state (see <link to="#state"/>) to
10960	"LockedRead" on success. The medium's previous state must be
10961	one of "Created", "Inaccessible" or "LockedRead".
10962
10963	Locking an inaccessible medium is not an error; this method performs
10964	a logical lock that prevents modifications of this medium through
10965	the VirtualBox API, not a physical file-system lock of the underlying
10966	storage unit.
10967
10968	This method returns the current state of the medium
10969	<i>before</i> the operation.
10970
10971	<result name="VBOX_E_INVALID_OBJECT_STATE">
10972	Invalid medium state (e.g. not created, locked, inaccessible,
10973	creating, deleting).
10974	</result>
10975
10976	</desc>
10977	<param name="state" type="MediumState" dir="return">
10978	<desc>
10979	State of the medium after the operation.
10980	</desc>
10981	</param>
10982	</method>
10983
10984	<method name="unlockRead">
10985	<desc>
10986	Cancels the read lock previously set by <link to="#lockRead"/>.
10987
10988	For both success and failure, this method returns the current state
10989	of the medium <i>after</i> the operation.
10990
10991	See <link to="#lockRead"/> for more details.
10992
10993	<result name="VBOX_E_INVALID_OBJECT_STATE">
10994	Medium not locked for reading.
10995	</result>
10996
10997	</desc>
10998	<param name="state" type="MediumState" dir="return">
10999	<desc>
11000	State of the medium after the operation.
11001	</desc>
11002	</param>
11003	</method>
11004
11005	<method name="lockWrite">
11006	<desc>
11007	Locks this medium for writing.
11008
11009	A write lock, as opposed to <link to="#lockRead"/>, is
11010	exclusive: there may be only one client holding a write lock,
11011	and there may be no read locks while the write lock is held.
11012	As a result, read-locking fails if a write lock is held, and
11013	write-locking fails if either a read or another write lock is held.
11014
11015	When a medium is locked for writing, it cannot be modified
11016	from within VirtualBox, and it is not guaranteed that the values
11017	of its properties are up-to-date. Any method that changes the
11018	properties of this medium or contents of the storage unit will
11019	return an error (unless explicitly stated otherwise).
11020
11021	When a virtual machine is started up, it locks for writing all
11022	media it uses to write data to. If any medium could not be locked
11023	for writing, the startup procedure will fail. If a medium has
11024	differencing images, then while the machine is running, only
11025	the last ("leaf") differencing image is locked for writing,
11026	whereas its parents are locked for reading only.
11027
11028	A medium is also locked for writing when it is the target of a
11029	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11030
11031	The medium locked for writing must be unlocked using the <link
11032	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11033
11034	This method sets the medium state (see <link to="#state"/>) to
11035	"LockedWrite" on success. The medium's previous state must be
11036	either "Created" or "Inaccessible".
11037
11038	Locking an inaccessible medium is not an error; this method performs
11039	a logical lock that prevents modifications of this medium through
11040	the VirtualBox API, not a physical file-system lock of the underlying
11041	storage unit.
11042
11043	For both, success and failure, this method returns the current
11044	state of the medium <i>before</i> the operation.
11045
11046	<result name="VBOX_E_INVALID_OBJECT_STATE">
11047	Invalid medium state (e.g. not created, locked, inaccessible,
11048	creating, deleting).
11049	</result>
11050
11051	</desc>
11052	<param name="state" type="MediumState" dir="return">
11053	<desc>
11054	State of the medium after the operation.
11055	</desc>
11056	</param>
11057	</method>
11058
11059	<method name="unlockWrite">
11060	<desc>
11061	Cancels the write lock previously set by <link to="#lockWrite"/>.
11062
11063	For both success and failure, this method returns the current
11064	state of the medium <i>after</i> the operation.
11065
11066	See <link to="#lockWrite"/> for more details.
11067
11068	<result name="VBOX_E_INVALID_OBJECT_STATE">
11069	Medium not locked for writing.
11070	</result>
11071
11072	</desc>
11073	<param name="state" type="MediumState" dir="return">
11074	<desc>
11075	State of the medium after the operation.
11076	</desc>
11077	</param>
11078	</method>
11079
11080	<method name="close">
11081	<desc>
11082	Closes this medium.
11083
11084	The medium must not be attached to any known virtual machine
11085	and must not have any known child media, otherwise the
11086	operation will fail.
11087
11088	When the medium is successfully closed, it is removed from
11089	the list of registered media, but its storage unit is not
11090	deleted. In particular, this means that this medium can
11091	later be opened again using the <link to="IVirtualBox::openMedium"/>
11092	call.
11093
11094	Note that after this method successfully returns, the given medium
11095	object becomes uninitialized. This means that any attempt
11096	to call any of its methods or attributes will fail with the
11097	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11098
11099	<result name="VBOX_E_INVALID_OBJECT_STATE">
11100	Invalid medium state (other than not created, created or
11101	inaccessible).
11102	</result>
11103	<result name="VBOX_E_OBJECT_IN_USE">
11104	Medium attached to virtual machine.
11105	</result>
11106	<result name="VBOX_E_FILE_ERROR">
11107	Settings file not accessible.
11108	</result>
11109	<result name="VBOX_E_XML_ERROR">
11110	Could not parse the settings file.
11111	</result>
11112
11113	</desc>
11114	</method>
11115
11116	<!-- property methods -->
11117
11118	<method name="getProperty" const="yes">
11119	<desc>
11120	Returns the value of the custom medium property with the given name.
11121
11122	The list of all properties supported by the given medium format can
11123	be obtained with <link to="IMediumFormat::describeProperties"/>.
11124
11125	<note>If this method returns an empty string in @a value, the requested
11126	property is supported but currently not assigned any value.</note>
11127
11128	<result name="VBOX_E_OBJECT_NOT_FOUND">
11129	Requested property does not exist (not supported by the format).
11130	</result>
11131	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11132	</desc>
11133	<param name="name" type="wstring" dir="in">
11134	<desc>Name of the property to get.</desc>
11135	</param>
11136	<param name="value" type="wstring" dir="return">
11137	<desc>Current property value.</desc>
11138	</param>
11139	</method>
11140
11141	<method name="setProperty">
11142	<desc>
11143	Sets the value of the custom medium property with the given name.
11144
11145	The list of all properties supported by the given medium format can
11146	be obtained with <link to="IMediumFormat::describeProperties"/>.
11147
11148	<note>Setting the property value to @c null or an empty string is
11149	equivalent to deleting the existing value. A default value (if it is
11150	defined for this property) will be used by the format backend in this
11151	case.</note>
11152
11153	<result name="VBOX_E_OBJECT_NOT_FOUND">
11154	Requested property does not exist (not supported by the format).
11155	</result>
11156	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11157	</desc>
11158	<param name="name" type="wstring" dir="in">
11159	<desc>Name of the property to set.</desc>
11160	</param>
11161	<param name="value" type="wstring" dir="in">
11162	<desc>Property value to set.</desc>
11163	</param>
11164	</method>
11165
11166	<method name="getProperties" const="yes">
11167	<desc>
11168	Returns values for a group of properties in one call.
11169
11170	The names of the properties to get are specified using the @a names
11171	argument which is a list of comma-separated property names or
11172	an empty string if all properties are to be returned.
11173	<note>Currently the value of this argument is ignored and the method
11174	always returns all existing properties.</note>
11175
11176	The list of all properties supported by the given medium format can
11177	be obtained with <link to="IMediumFormat::describeProperties"/>.
11178
11179	The method returns two arrays, the array of property names corresponding
11180	to the @a names argument and the current values of these properties.
11181	Both arrays have the same number of elements with each element at the
11182	given index in the first array corresponds to an element at the same
11183	index in the second array.
11184
11185	For properties that do not have assigned values, an empty string is
11186	returned at the appropriate index in the @a returnValues array.
11187
11188	</desc>
11189	<param name="names" type="wstring" dir="in">
11190	<desc>
11191	Names of properties to get.
11192	</desc>
11193	</param>
11194	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11195	<desc>Names of returned properties.</desc>
11196	</param>
11197	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11198	<desc>Values of returned properties.</desc>
11199	</param>
11200	</method>
11201
11202	<method name="setProperties">
11203	<desc>
11204	Sets values for a group of properties in one call.
11205
11206	The names of the properties to set are passed in the @a names
11207	array along with the new values for them in the @a values array. Both
11208	arrays have the same number of elements with each element at the given
11209	index in the first array corresponding to an element at the same index
11210	in the second array.
11211
11212	If there is at least one property name in @a names that is not valid,
11213	the method will fail before changing the values of any other properties
11214	from the @a names array.
11215
11216	Using this method over <link to="#setProperty"/> is preferred if you
11217	need to set several properties at once since it is more efficient.
11218
11219	The list of all properties supported by the given medium format can
11220	be obtained with <link to="IMediumFormat::describeProperties"/>.
11221
11222	Setting the property value to @c null or an empty string is equivalent
11223	to deleting the existing value. A default value (if it is defined for
11224	this property) will be used by the format backend in this case.
11225	</desc>
11226	<param name="names" type="wstring" safearray="yes" dir="in">
11227	<desc>Names of properties to set.</desc>
11228	</param>
11229	<param name="values" type="wstring" safearray="yes" dir="in">
11230	<desc>Values of properties to set.</desc>
11231	</param>
11232	</method>
11233
11234	<!-- storage methods -->
11235
11236	<method name="createBaseStorage">
11237	<desc>
11238	Starts creating a hard disk storage unit (fixed/dynamic, according
11239	to the variant flags) in in the background. The previous storage unit
11240	created for this object, if any, must first be deleted using
11241	<link to="#deleteStorage"/>, otherwise the operation will fail.
11242
11243	Before the operation starts, the medium is placed in
11244	<link to="MediumState_Creating"/> state. If the create operation
11245	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11246	state.
11247
11248	After the returned progress object reports that the operation has
11249	successfully completed, the medium state will be set to <link
11250	to="MediumState_Created"/>, the medium will be remembered by this
11251	VirtualBox installation and may be attached to virtual machines.
11252
11253	<result name="VBOX_E_NOT_SUPPORTED">
11254	The variant of storage creation operation is not supported. See <link
11255	to="IMediumFormat::capabilities"/>.
11256	</result>
11257	</desc>
11258	<param name="logicalSize" type="long long" dir="in">
11259	<desc>Maximum logical size of the medium in bytes.</desc>
11260	</param>
11261	<param name="variant" type="unsigned long" dir="in">
11262	<desc>Exact image variant which should be created (as a combination of
11263	<link to="MediumVariant" /> flags).</desc>
11264	</param>
11265	<param name="progress" type="IProgress" dir="return">
11266	<desc>Progress object to track the operation completion.</desc>
11267	</param>
11268	</method>
11269
11270	<method name="deleteStorage">
11271	<desc>
11272	Starts deleting the storage unit of this medium.
11273
11274	The medium must not be attached to any known virtual machine and must
11275	not have any known child media, otherwise the operation will fail.
11276	It will also fail if there is no storage unit to delete or if deletion
11277	is already in progress, or if the medium is being in use (locked for
11278	read or for write) or inaccessible. Therefore, the only valid state for
11279	this operation to succeed is <link to="MediumState_Created"/>.
11280
11281	Before the operation starts, the medium is placed in
11282	<link to="MediumState_Deleting"/> state and gets removed from the list
11283	of remembered hard disks (media registry). If the delete operation
11284	fails, the medium will be remembered again and placed back to
11285	<link to="MediumState_Created"/> state.
11286
11287	After the returned progress object reports that the operation is
11288	complete, the medium state will be set to
11289	<link to="MediumState_NotCreated"/> and you will be able to use one of
11290	the storage creation methods to create it again.
11291
11292	<see><link to="#close"/></see>
11293
11294	<result name="VBOX_E_OBJECT_IN_USE">
11295	Medium is attached to a virtual machine.
11296	</result>
11297	<result name="VBOX_E_NOT_SUPPORTED">
11298	Storage deletion is not allowed because neither of storage creation
11299	operations are supported. See
11300	<link to="IMediumFormat::capabilities"/>.
11301	</result>
11302
11303	<note>
11304	If the deletion operation fails, it is not guaranteed that the storage
11305	unit still exists. You may check the <link to="IMedium::state"/> value
11306	to answer this question.
11307	</note>
11308	</desc>
11309	<param name="progress" type="IProgress" dir="return">
11310	<desc>Progress object to track the operation completion.</desc>
11311	</param>
11312	</method>
11313
11314	<!-- diff methods -->
11315
11316	<method name="createDiffStorage">
11317	<desc>
11318	Starts creating an empty differencing storage unit based on this
11319	medium in the format and at the location defined by the @a target
11320	argument.
11321
11322	The target medium must be in <link to="MediumState_NotCreated"/>
11323	state (i.e. must not have an existing storage unit). Upon successful
11324	completion, this operation will set the type of the target medium to
11325	<link to="MediumType_Normal"/> and create a storage unit necessary to
11326	represent the differencing medium data in the given format (according
11327	to the storage format of the target object).
11328
11329	After the returned progress object reports that the operation is
11330	successfully complete, the target medium gets remembered by this
11331	VirtualBox installation and may be attached to virtual machines.
11332
11333	<note>
11334	The medium will be set to <link to="MediumState_LockedRead"/>
11335	state for the duration of this operation.
11336	</note>
11337	<result name="VBOX_E_OBJECT_IN_USE">
11338	Medium not in @c NotCreated state.
11339	</result>
11340	</desc>
11341	<param name="target" type="IMedium" dir="in">
11342	<desc>Target medium.</desc>
11343	</param>
11344	<param name="variant" type="unsigned long" dir="in">
11345	<desc>Exact image variant which should be created (as a combination of
11346	<link to="MediumVariant" /> flags).</desc>
11347	</param>
11348	<param name="progress" type="IProgress" dir="return">
11349	<desc>Progress object to track the operation completion.</desc>
11350	</param>
11351	</method>
11352
11353	<method name="mergeTo">
11354	<desc>
11355	Starts merging the contents of this medium and all intermediate
11356	differencing media in the chain to the given target medium.
11357
11358	The target medium must be either a descendant of this medium or
11359	its ancestor (otherwise this method will immediately return a failure).
11360	It follows that there are two logical directions of the merge operation:
11361	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11362	ancestor (<i>backward merge</i>). Let us consider the following medium
11363	chain:
11364
11365	<pre>Base <- Diff_1 <- Diff_2</pre>
11366
11367	Here, calling this method on the <tt>Base</tt> medium object with
11368	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11369	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11370	merge. Note that in both cases the contents of the resulting medium
11371	will be the same, the only difference is the medium object that takes
11372	the result of the merge operation. In case of the forward merge in the
11373	above example, the result will be written to <tt>Diff_2</tt>; in case of
11374	the backward merge, the result will be written to <tt>Base</tt>. In
11375	other words, the result of the operation is always stored in the target
11376	medium.
11377
11378	Upon successful operation completion, the storage units of all media in
11379	the chain between this (source) medium and the target medium, including
11380	the source medium itself, will be automatically deleted and the
11381	relevant medium objects (including this medium) will become
11382	uninitialized. This means that any attempt to call any of
11383	their methods or attributes will fail with the
11384	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11385	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11386	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11387	Note that <tt>Diff_2</tt> in this case will become a base medium
11388	itself since it will no longer be based on any other medium.
11389
11390	Considering the above, all of the following conditions must be met in
11391	order for the merge operation to succeed:
11392	<ul>
11393	<li>
11394	Neither this (source) medium nor any intermediate
11395	differencing medium in the chain between it and the target
11396	medium is attached to any virtual machine.
11397	</li>
11398	<li>
11399	Neither the source medium nor the target medium is an
11400	<link to="MediumType_Immutable"/> medium.
11401	</li>
11402	<li>
11403	The part of the medium tree from the source medium to the
11404	target medium is a linear chain, i.e. all medium in this
11405	chain have exactly one child which is the next medium in this
11406	chain. The only exception from this rule is the target medium in
11407	the forward merge operation; it is allowed to have any number of
11408	child media because the merge operation will not change its
11409	logical contents (as it is seen by the guest OS or by children).
11410	</li>
11411	<li>
11412	None of the involved media are in
11413	<link to="MediumState_LockedRead"/> or
11414	<link to="MediumState_LockedWrite"/> state.
11415	</li>
11416	</ul>
11417
11418	<note>
11419	This (source) medium and all intermediates will be placed to <link
11420	to="MediumState_Deleting"/> state and the target medium will be
11421	placed to <link to="MediumState_LockedWrite"/> state and for the
11422	duration of this operation.
11423	</note>
11424	</desc>
11425	<param name="target" type="IMedium" dir="in">
11426	<desc>Target medium.</desc>
11427	</param>
11428	<param name="progress" type="IProgress" dir="return">
11429	<desc>Progress object to track the operation completion.</desc>
11430	</param>
11431	</method>
11432
11433	<!-- clone method -->
11434
11435	<method name="cloneTo">
11436	<desc>
11437	Starts creating a clone of this medium in the format and at the
11438	location defined by the @a target argument.
11439
11440	The target medium must be either in <link to="MediumState_NotCreated"/>
11441	state (i.e. must not have an existing storage unit) or in
11442	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11443	big enough to hold the data or else the copy will be partial). Upon
11444	successful completion, the cloned medium will contain exactly the
11445	same sector data as the medium being cloned, except that in the
11446	first case a new UUID for the clone will be randomly generated, and in
11447	the second case the UUID will remain unchanged.
11448
11449	The @a parent argument defines which medium will be the parent
11450	of the clone. Passing a @c null reference indicates that the clone will
11451	be a base image, i.e. completely independent. It is possible to specify
11452	an arbitrary medium for this parameter, including the parent of the
11453	medium which is being cloned. Even cloning to a child of the source
11454	medium is possible. Note that when cloning to an existing image, the
11455	@a parent argument is ignored.
11456
11457	After the returned progress object reports that the operation is
11458	successfully complete, the target medium gets remembered by this
11459	VirtualBox installation and may be attached to virtual machines.
11460
11461	<note>
11462	This medium will be placed to <link to="MediumState_LockedRead"/>
11463	state for the duration of this operation.
11464	</note>
11465	<result name="E_NOTIMPL">
11466	The specified cloning variant is not supported at the moment.
11467	</result>
11468	</desc>
11469	<param name="target" type="IMedium" dir="in">
11470	<desc>Target medium.</desc>
11471	</param>
11472	<param name="variant" type="unsigned long" dir="in">
11473	<desc>Exact image variant which should be created (as a combination of
11474	<link to="MediumVariant" /> flags).</desc>
11475	</param>
11476	<param name="parent" type="IMedium" dir="in">
11477	<desc>Parent of the cloned medium.</desc>
11478	</param>
11479	<param name="progress" type="IProgress" dir="return">
11480	<desc>Progress object to track the operation completion.</desc>
11481	</param>
11482	</method>
11483
11484	<!-- other methods -->
11485
11486	<method name="compact">
11487	<desc>
11488	Starts compacting of this medium. This means that the medium is
11489	transformed into a possibly more compact storage representation.
11490	This potentially creates temporary images, which can require a
11491	substantial amount of additional disk space.
11492
11493	This medium will be placed to <link to="MediumState_LockedWrite"/>
11494	state and all its parent media (if any) will be placed to
11495	<link to="MediumState_LockedRead"/> state for the duration of this
11496	operation.
11497
11498	Please note that the results can be either returned straight away,
11499	or later as the result of the background operation via the object
11500	returned via the @a progress parameter.
11501
11502	<result name="VBOX_E_NOT_SUPPORTED">
11503	Medium format does not support compacting (but potentially
11504	needs it).
11505	</result>
11506	</desc>
11507	<param name="progress" type="IProgress" dir="return">
11508	<desc>Progress object to track the operation completion.</desc>
11509	</param>
11510	</method>
11511
11512	<method name="resize">
11513	<desc>
11514	Starts resizing this medium. This means that the nominal size of the
11515	medium is set to the new value. Both increasing and decreasing the
11516	size is possible, and there are no safety checks, since VirtualBox
11517	does not make any assumptions about the medium contents.
11518
11519	Resizing usually needs additional disk space, and possibly also
11520	some temporary disk space. Note that resize does not create a full
11521	temporary copy of the medium, so the additional disk space requirement
11522	is usually much lower than using the clone operation.
11523
11524	This medium will be placed to <link to="MediumState_LockedWrite"/>
11525	state for the duration of this operation.
11526
11527	Please note that the results can be either returned straight away,
11528	or later as the result of the background operation via the object
11529	returned via the @a progress parameter.
11530
11531	<result name="VBOX_E_NOT_SUPPORTED">
11532	Medium format does not support resizing.
11533	</result>
11534	</desc>
11535	<param name="logicalSize" type="long long" dir="in">
11536	<desc>New nominal capacity of the medium in bytes.</desc>
11537	</param>
11538	<param name="progress" type="IProgress" dir="return">
11539	<desc>Progress object to track the operation completion.</desc>
11540	</param>
11541	</method>
11542
11543	<method name="reset">
11544	<desc>
11545	Starts erasing the contents of this differencing medium.
11546
11547	This operation will reset the differencing medium to its initial
11548	state when it does not contain any sector data and any read operation is
11549	redirected to its parent medium. This automatically gets called
11550	during VM power-up for every medium whose <link to="#autoReset" />
11551	attribute is @c true.
11552
11553	The medium will be write-locked for the duration of this operation (see
11554	<link to="#lockWrite" />).
11555
11556	<result name="VBOX_E_NOT_SUPPORTED">
11557	This is not a differencing medium.
11558	</result>
11559	<result name="VBOX_E_INVALID_OBJECT_STATE">
11560	Medium is not in <link to="MediumState_Created"/> or
11561	<link to="MediumState_Inaccessible"/> state.
11562	</result>
11563	</desc>
11564	<param name="progress" type="IProgress" dir="return">
11565	<desc>Progress object to track the operation completion.</desc>
11566	</param>
11567	</method>
11568
11569	</interface>
11570
11571
11572	<!--
11573	// IMediumFormat
11574	/////////////////////////////////////////////////////////////////////////
11575	-->
11576
11577	<enum
11578	name="DataType"
11579	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11580	>
11581	<const name="Int32" value="0"/>
11582	<const name="Int8" value="1"/>
11583	<const name="String" value="2"/>
11584	</enum>
11585
11586	<enum
11587	name="DataFlags"
11588	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11589	>
11590	<const name="None" value="0x00"/>
11591	<const name="Mandatory" value="0x01"/>
11592	<const name="Expert" value="0x02"/>
11593	<const name="Array" value="0x04"/>
11594	<const name="FlagMask" value="0x07"/>
11595	</enum>
11596
11597	<enum
11598	name="MediumFormatCapabilities"
11599	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11600	>
11601	<desc>
11602	Medium format capability flags.
11603	</desc>
11604
11605	<const name="Uuid" value="0x01">
11606	<desc>
11607	Supports UUIDs as expected by VirtualBox code.
11608	</desc>
11609	</const>
11610
11611	<const name="CreateFixed" value="0x02">
11612	<desc>
11613	Supports creating fixed size images, allocating all space instantly.
11614	</desc>
11615	</const>
11616
11617	<const name="CreateDynamic" value="0x04">
11618	<desc>
11619	Supports creating dynamically growing images, allocating space on
11620	demand.
11621	</desc>
11622	</const>
11623
11624	<const name="CreateSplit2G" value="0x08">
11625	<desc>
11626	Supports creating images split in chunks of a bit less than 2 GBytes.
11627	</desc>
11628	</const>
11629
11630	<const name="Differencing" value="0x10">
11631	<desc>
11632	Supports being used as a format for differencing media (see <link
11633	to="IMedium::createDiffStorage"/>).
11634	</desc>
11635	</const>
11636
11637	<const name="Asynchronous" value="0x20">
11638	<desc>
11639	Supports asynchronous I/O operations for at least some configurations.
11640	</desc>
11641	</const>
11642
11643	<const name="File" value="0x40">
11644	<desc>
11645	The format backend operates on files (the <link to="IMedium::location"/>
11646	attribute of the medium specifies a file used to store medium
11647	data; for a list of supported file extensions see
11648	<link to="IMediumFormat::describeFileExtensions"/>).
11649	</desc>
11650	</const>
11651
11652	<const name="Properties" value="0x80">
11653	<desc>
11654	The format backend uses the property interface to configure the storage
11655	location and properties (the <link to="IMediumFormat::describeProperties"/>
11656	method is used to get access to properties supported by the given medium format).
11657	</desc>
11658	</const>
11659
11660	<const name="TcpNetworking" value="0x100">
11661	<desc>
11662	The format backend uses the TCP networking interface for network access.
11663	</desc>
11664	</const>
11665
11666	<const name="VFS" value="0x200">
11667	<desc>
11668	The format backend supports virtual filesystem functionality.
11669	</desc>
11670	</const>
11671
11672	<const name="CapabilityMask" value="0x3FF"/>
11673	</enum>
11674
11675	<interface
11676	name="IMediumFormat" extends="$unknown"
11677	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11678	wsmap="managed"
11679	>
11680	<desc>
11681	The IMediumFormat interface represents a medium format.
11682
11683	Each medium format has an associated backend which is used to handle
11684	media stored in this format. This interface provides information
11685	about the properties of the associated backend.
11686
11687	Each medium format is identified by a string represented by the
11688	<link to="#id"/> attribute. This string is used in calls like
11689	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11690	format.
11691
11692	The list of all supported medium formats can be obtained using
11693	<link to="ISystemProperties::mediumFormats"/>.
11694
11695	<see><link to="IMedium"/></see>
11696	</desc>
11697
11698	<attribute name="id" type="wstring" readonly="yes">
11699	<desc>
11700	Identifier of this format.
11701
11702	The format identifier is a non-@c null non-empty ASCII string. Note that
11703	this string is case-insensitive. This means that, for example, all of
11704	the following strings:
11705	<pre>
11706	"VDI"
11707	"vdi"
11708	"VdI"</pre>
11709	refer to the same medium format.
11710
11711	This string is used in methods of other interfaces where it is necessary
11712	to specify a medium format, such as
11713	<link to="IVirtualBox::createHardDisk"/>.
11714	</desc>
11715	</attribute>
11716
11717	<attribute name="name" type="wstring" readonly="yes">
11718	<desc>
11719	Human readable description of this format.
11720
11721	Mainly for use in file open dialogs.
11722	</desc>
11723	</attribute>
11724
11725	<attribute name="capabilities" type="unsigned long" readonly="yes">
11726	<desc>
11727	Capabilities of the format as a set of bit flags.
11728
11729	For the meaning of individual capability flags see
11730	<link to="MediumFormatCapabilities"/>.
11731	</desc>
11732	</attribute>
11733
11734	<method name="describeFileExtensions">
11735	<desc>
11736	Returns two arrays describing the supported file extensions.
11737
11738	The first array contains the supported extensions and the seconds one
11739	the type each extension supports. Both have the same size.
11740
11741	Note that some backends do not work on files, so this array may be
11742	empty.
11743
11744	<see><link to="IMediumFormat::capabilities"/></see>
11745	</desc>
11746	<param name="extensions" type="wstring" safearray="yes" dir="out">
11747	<desc>The array of supported extensions.</desc>
11748	</param>
11749	<param name="type" type="DeviceType" safearray="yes" dir="out">
11750	<desc>The array which indicates the device type for every given extension.</desc>
11751	</param>
11752	</method>
11753
11754	<method name="describeProperties" const="yes">
11755	<desc>
11756	Returns several arrays describing the properties supported by this
11757	format.
11758
11759	An element with the given index in each array describes one
11760	property. Thus, the number of elements in each returned array is the
11761	same and corresponds to the number of supported properties.
11762
11763	The returned arrays are filled in only if the
11764	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11765	All arguments must be non-@c null.
11766
11767	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11768	</desc>
11769
11770	<param name="names" type="wstring" safearray="yes" dir="out">
11771	<desc>Array of property names.</desc>
11772	</param>
11773	<param name="description" type="wstring" safearray="yes" dir="out">
11774	<desc>Array of property descriptions.</desc>
11775	</param>
11776	<param name="types" type="DataType" safearray="yes" dir="out">
11777	<desc>Array of property types.</desc>
11778	</param>
11779	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11780	<desc>Array of property flags.</desc>
11781	</param>
11782	<param name="defaults" type="wstring" safearray="yes" dir="out">
11783	<desc>Array of default property values.</desc>
11784	</param>
11785	</method>
11786
11787	</interface>
11788
11789
11790	<!--
11791	// IKeyboard
11792	/////////////////////////////////////////////////////////////////////////
11793	-->
11794
11795	<interface
11796	name="IKeyboard" extends="$unknown"
11797	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11798	wsmap="managed"
11799	>
11800	<desc>
11801	The IKeyboard interface represents the virtual machine's keyboard. Used
11802	in <link to="IConsole::keyboard"/>.
11803
11804	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11805	to the virtual machine.
11806
11807	</desc>
11808	<method name="putScancode">
11809	<desc>Sends a scancode to the keyboard.
11810
11811	<result name="VBOX_E_IPRT_ERROR">
11812	Could not send scan code to virtual keyboard.
11813	</result>
11814
11815	</desc>
11816	<param name="scancode" type="long" dir="in"/>
11817	</method>
11818
11819	<method name="putScancodes">
11820	<desc>Sends an array of scancodes to the keyboard.
11821
11822	<result name="VBOX_E_IPRT_ERROR">
11823	Could not send all scan codes to virtual keyboard.
11824	</result>
11825
11826	</desc>
11827	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11828	<param name="codesStored" type="unsigned long" dir="return"/>
11829	</method>
11830
11831	<method name="putCAD">
11832	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11833	function is nothing special, it is just a convenience function
11834	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11835
11836	<result name="VBOX_E_IPRT_ERROR">
11837	Could not send all scan codes to virtual keyboard.
11838	</result>
11839
11840	</desc>
11841	</method>
11842
11843	<attribute name="eventSource" type="IEventSource" readonly="yes">
11844	<desc>
11845	Event source for keyboard events.
11846	</desc>
11847	</attribute>
11848
11849	</interface>
11850
11851
11852	<!--
11853	// IMouse
11854	/////////////////////////////////////////////////////////////////////////
11855	-->
11856
11857	<enum
11858	name="MouseButtonState"
11859	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
11860	>
11861	<desc>
11862	Mouse button state.
11863	</desc>
11864
11865	<const name="LeftButton" value="0x01"/>
11866	<const name="RightButton" value="0x02"/>
11867	<const name="MiddleButton" value="0x04"/>
11868	<const name="WheelUp" value="0x08"/>
11869	<const name="WheelDown" value="0x10"/>
11870	<const name="XButton1" value="0x20"/>
11871	<const name="XButton2" value="0x40"/>
11872	<const name="MouseStateMask" value="0x7F"/>
11873	</enum>
11874
11875	<interface
11876	name="IMouse" extends="$unknown"
11877	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
11878	wsmap="managed"
11879	>
11880	<desc>
11881	The IMouse interface represents the virtual machine's mouse. Used in
11882	<link to="IConsole::mouse"/>.
11883
11884	Through this interface, the virtual machine's virtual mouse can be
11885	controlled.
11886	</desc>
11887
11888	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11889	<desc>
11890	Whether the guest OS supports absolute mouse pointer positioning
11891	or not.
11892	<note>
11893	You can use the <link to="IMouseCapabilityChangedEvent"/>
11894	event to be instantly informed about changes of this attribute
11895	during virtual machine execution.
11896	</note>
11897	<see><link to="#putMouseEventAbsolute"/></see>
11898	</desc>
11899	</attribute>
11900
11901	<attribute name="relativeSupported" type="boolean" readonly="yes">
11902	<desc>
11903	Whether the guest OS supports relative mouse pointer positioning
11904	or not.
11905	<note>
11906	You can use the <link to="IMouseCapabilityChangedEvent"/>
11907	event to be instantly informed about changes of this attribute
11908	during virtual machine execution.
11909	</note>
11910	<see><link to="#putMouseEvent"/></see>
11911	</desc>
11912	</attribute>
11913
11914	<attribute name="needsHostCursor" type="boolean" readonly="yes">
11915	<desc>
11916	Whether the guest OS can currently switch to drawing it's own mouse
11917	cursor on demand.
11918	<note>
11919	You can use the <link to="IMouseCapabilityChangedEvent"/>
11920	event to be instantly informed about changes of this attribute
11921	during virtual machine execution.
11922	</note>
11923	<see><link to="#putMouseEvent"/></see>
11924	</desc>
11925	</attribute>
11926
11927	<method name="putMouseEvent">
11928	<desc>
11929	Initiates a mouse event using relative pointer movements
11930	along x and y axis.
11931
11932	<result name="E_ACCESSDENIED">
11933	Console not powered up.
11934	</result>
11935	<result name="VBOX_E_IPRT_ERROR">
11936	Could not send mouse event to virtual mouse.
11937	</result>
11938
11939	</desc>
11940
11941	<param name="dx" type="long" dir="in">
11942	<desc>
11943	Amount of pixels the mouse should move to the right.
11944	Negative values move the mouse to the left.
11945	</desc>
11946	</param>
11947	<param name="dy" type="long" dir="in">
11948	<desc>
11949	Amount of pixels the mouse should move downwards.
11950	Negative values move the mouse upwards.
11951	</desc>
11952	</param>
11953	<param name="dz" type="long" dir="in">
11954	<desc>
11955	Amount of mouse wheel moves.
11956	Positive values describe clockwise wheel rotations,
11957	negative values describe counterclockwise rotations.
11958	</desc>
11959	</param>
11960	<param name="dw" type="long" dir="in">
11961	<desc>
11962	Amount of horizontal mouse wheel moves.
11963	Positive values describe a movement to the left,
11964	negative values describe a movement to the right.
11965	</desc>
11966	</param>
11967	<param name="buttonState" type="long" dir="in">
11968	<desc>
11969	The current state of mouse buttons. Every bit represents
11970	a mouse button as follows:
11971	<table>
11972	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11973	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11974	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11975	</table>
11976	A value of <tt>1</tt> means the corresponding button is pressed.
11977	otherwise it is released.
11978	</desc>
11979	</param>
11980	</method>
11981
11982	<method name="putMouseEventAbsolute">
11983	<desc>
11984	Positions the mouse pointer using absolute x and y coordinates.
11985	These coordinates are expressed in pixels and
11986	start from <tt>[1,1]</tt> which corresponds to the top left
11987	corner of the virtual display.
11988
11989	<result name="E_ACCESSDENIED">
11990	Console not powered up.
11991	</result>
11992	<result name="VBOX_E_IPRT_ERROR">
11993	Could not send mouse event to virtual mouse.
11994	</result>
11995
11996	<note>
11997	This method will have effect only if absolute mouse
11998	positioning is supported by the guest OS.
11999	</note>
12000
12001	<see><link to="#absoluteSupported"/></see>
12002	</desc>
12003
12004	<param name="x" type="long" dir="in">
12005	<desc>
12006	X coordinate of the pointer in pixels, starting from @c 1.
12007	</desc>
12008	</param>
12009	<param name="y" type="long" dir="in">
12010	<desc>
12011	Y coordinate of the pointer in pixels, starting from @c 1.
12012	</desc>
12013	</param>
12014	<param name="dz" type="long" dir="in">
12015	<desc>
12016	Amount of mouse wheel moves.
12017	Positive values describe clockwise wheel rotations,
12018	negative values describe counterclockwise rotations.
12019	</desc>
12020	</param>
12021	<param name="dw" type="long" dir="in">
12022	<desc>
12023	Amount of horizontal mouse wheel moves.
12024	Positive values describe a movement to the left,
12025	negative values describe a movement to the right.
12026	</desc>
12027	</param>
12028	<param name="buttonState" type="long" dir="in">
12029	<desc>
12030	The current state of mouse buttons. Every bit represents
12031	a mouse button as follows:
12032	<table>
12033	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12034	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12035	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12036	</table>
12037	A value of @c 1 means the corresponding button is pressed.
12038	otherwise it is released.
12039	</desc>
12040	</param>
12041	</method>
12042
12043	<attribute name="eventSource" type="IEventSource" readonly="yes">
12044	<desc>
12045	Event source for mouse events.
12046	</desc>
12047	</attribute>
12048
12049	</interface>
12050
12051	<!--
12052	// IDisplay
12053	/////////////////////////////////////////////////////////////////////////
12054	-->
12055
12056	<enum
12057	name="FramebufferPixelFormat"
12058	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12059	>
12060	<desc>
12061	Format of the video memory buffer. Constants represented by this enum can
12062	be used to test for particular values of <link
12063	to="IFramebuffer::pixelFormat"/>. See also <link
12064	to="IFramebuffer::requestResize"/>.
12065
12066	See also www.fourcc.org for more information about FOURCC pixel formats.
12067	</desc>
12068
12069	<const name="Opaque" value="0">
12070	<desc>
12071	Unknown buffer format (the user may not assume any particular format of
12072	the buffer).
12073	</desc>
12074	</const>
12075	<const name="FOURCC_RGB" value="0x32424752">
12076	<desc>
12077	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12078	bit layout).
12079	</desc>
12080	</const>
12081	</enum>
12082
12083	<interface
12084	name="IFramebuffer" extends="$unknown"
12085	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12086	wsmap="suppress"
12087	>
12088	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12089	<desc>Address of the start byte of the frame buffer.</desc>
12090	</attribute>
12091
12092	<attribute name="width" type="unsigned long" readonly="yes">
12093	<desc>Frame buffer width, in pixels.</desc>
12094	</attribute>
12095
12096	<attribute name="height" type="unsigned long" readonly="yes">
12097	<desc>Frame buffer height, in pixels.</desc>
12098	</attribute>
12099
12100	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12101	<desc>
12102	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12103	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12104	are: 8, 15, 16, 24 and 32.
12105	</desc>
12106	</attribute>
12107
12108	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12109	<desc>
12110	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12111	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12112	size of the scan line must be aligned to 32 bits.
12113	</desc>
12114	</attribute>
12115
12116	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12117	<desc>
12118	Frame buffer pixel format. It's either one of the values defined by <link
12119	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12120	<note>
12121	This attribute must never return <link
12122	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12123	<link to="#address"/> points to must be always known.
12124	</note>
12125	</desc>
12126	</attribute>
12127
12128	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12129	<desc>
12130	Defines whether this frame buffer uses the virtual video card's memory
12131	buffer (guest VRAM) directly or not. See <link
12132	to="IFramebuffer::requestResize"/> for more information.
12133	</desc>
12134	</attribute>
12135
12136	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12137	<desc>
12138	Hint from the frame buffer about how much of the standard
12139	screen height it wants to use for itself. This information is
12140	exposed to the guest through the VESA BIOS and VMMDev interface
12141	so that it can use it for determining its video mode table. It
12142	is not guaranteed that the guest respects the value.
12143	</desc>
12144	</attribute>
12145
12146	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12147	<desc>
12148	An alpha-blended overlay which is superposed over the frame buffer.
12149	The initial purpose is to allow the display of icons providing
12150	information about the VM state, including disk activity, in front
12151	ends which do not have other means of doing that. The overlay is
12152	designed to controlled exclusively by IDisplay. It has no locking
12153	of its own, and any changes made to it are not guaranteed to be
12154	visible until the affected portion of IFramebuffer is updated. The
12155	overlay can be created lazily the first time it is requested. This
12156	attribute can also return @c null to signal that the overlay is not
12157	implemented.
12158	</desc>
12159	</attribute>
12160
12161	<attribute name="winId" type="long long" readonly="yes">
12162	<desc>
12163	Platform-dependent identifier of the window where context of this
12164	frame buffer is drawn, or zero if there's no such window.
12165	</desc>
12166	</attribute>
12167
12168	<method name="lock">
12169	<desc>
12170	Locks the frame buffer.
12171	Gets called by the IDisplay object where this frame buffer is
12172	bound to.
12173	</desc>
12174	</method>
12175
12176	<method name="unlock">
12177	<desc>
12178	Unlocks the frame buffer.
12179	Gets called by the IDisplay object where this frame buffer is
12180	bound to.
12181	</desc>
12182	</method>
12183
12184	<method name="notifyUpdate">
12185	<desc>
12186	Informs about an update.
12187	Gets called by the display object where this buffer is
12188	registered.
12189	</desc>
12190	<param name="x" type="unsigned long" dir="in"/>
12191	<param name="y" type="unsigned long" dir="in"/>
12192	<param name="width" type="unsigned long" dir="in"/>
12193	<param name="height" type="unsigned long" dir="in"/>
12194	</method>
12195
12196	<method name="requestResize">
12197	<desc>
12198	Requests a size and pixel format change.
12199
12200	There are two modes of working with the video buffer of the virtual
12201	machine. The <i>indirect</i> mode implies that the IFramebuffer
12202	implementation allocates a memory buffer for the requested display mode
12203	and provides it to the virtual machine. In <i>direct</i> mode, the
12204	IFramebuffer implementation uses the memory buffer allocated and owned
12205	by the virtual machine. This buffer represents the video memory of the
12206	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12207	usually faster because the implementation gets a raw pointer to the
12208	guest VRAM buffer which it can directly use for visualizing the contents
12209	of the virtual display, as opposed to the indirect mode where the
12210	contents of guest VRAM are copied to the memory buffer provided by
12211	the implementation every time a display update occurs.
12212
12213	It is important to note that the direct mode is really fast only when
12214	the implementation uses the given guest VRAM buffer directly, for
12215	example, by blitting it to the window representing the virtual machine's
12216	display, which saves at least one copy operation comparing to the
12217	indirect mode. However, using the guest VRAM buffer directly is not
12218	always possible: the format and the color depth of this buffer may be
12219	not supported by the target window, or it may be unknown (opaque) as in
12220	case of text or non-linear multi-plane VGA video modes. In this case,
12221	the indirect mode (that is always available) should be used as a
12222	fallback: when the guest VRAM contents are copied to the
12223	implementation-provided memory buffer, color and format conversion is
12224	done automatically by the underlying code.
12225
12226	The @a pixelFormat parameter defines whether the direct mode is
12227	available or not. If @a pixelFormat is <link
12228	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12229	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12230	@a bytesPerLine parameters must be ignored and the implementation must use
12231	the indirect mode (where it provides its own buffer in one of the
12232	supported formats). In all other cases, @a pixelFormat together with
12233	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12234	buffer pointed to by the @a VRAM parameter and the implementation is
12235	free to choose which mode to use. To indicate that this frame buffer uses
12236	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12237	attribute must return @c true and <link to="#address"/> must
12238	return exactly the same address that is passed in the @a VRAM parameter
12239	of this method; otherwise it is assumed that the indirect strategy is
12240	chosen.
12241
12242	The @a width and @a height parameters represent the size of the
12243	requested display mode in both modes. In case of indirect mode, the
12244	provided memory buffer should be big enough to store data of the given
12245	display mode. In case of direct mode, it is guaranteed that the given
12246	@a VRAM buffer contains enough space to represent the display mode of the
12247	given size. Note that this frame buffer's <link to="#width"/> and <link
12248	to="#height"/> attributes must return exactly the same values as
12249	passed to this method after the resize is completed (see below).
12250
12251	The @a finished output parameter determines if the implementation has
12252	finished resizing the frame buffer or not. If, for some reason, the
12253	resize cannot be finished immediately during this call, @a finished
12254	must be set to @c false, and the implementation must call
12255	<link to="IDisplay::resizeCompleted"/> after it has returned from
12256	this method as soon as possible. If @a finished is @c false, the
12257	machine will not call any frame buffer methods until
12258	<link to="IDisplay::resizeCompleted"/> is called.
12259
12260	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12261	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12262	this frame buffer must return exactly the same values as specified in the
12263	parameters of this method, after the resize is completed. If the
12264	indirect mode is chosen, these attributes must return values describing
12265	the format of the implementation's own memory buffer <link
12266	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12267	value must always correlate with <link to="#pixelFormat"/>. Note that
12268	the <link to="#pixelFormat"/> attribute must never return <link
12269	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12270
12271	<note>
12272	This method is called by the IDisplay object under the
12273	<link to="#lock"/> provided by this IFramebuffer
12274	implementation. If this method returns @c false in @a finished, then
12275	this lock is not released until
12276	<link to="IDisplay::resizeCompleted"/> is called.
12277	</note>
12278	</desc>
12279	<param name="screenId" type="unsigned long" dir="in">
12280	<desc>
12281	Logical screen number. Must be used in the corresponding call to
12282	<link to="IDisplay::resizeCompleted"/> if this call is made.
12283	</desc>
12284	</param>
12285	<param name="pixelFormat" type="unsigned long" dir="in">
12286	<desc>
12287	Pixel format of the memory buffer pointed to by @a VRAM.
12288	See also <link to="FramebufferPixelFormat"/>.
12289	</desc>
12290	</param>
12291	<param name="VRAM" type="octet" mod="ptr" dir="in">
12292	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12293	</param>
12294	<param name="bitsPerPixel" type="unsigned long" dir="in">
12295	<desc>Color depth, bits per pixel.</desc>
12296	</param>
12297	<param name="bytesPerLine" type="unsigned long" dir="in">
12298	<desc>Size of one scan line, in bytes.</desc>
12299	</param>
12300	<param name="width" type="unsigned long" dir="in">
12301	<desc>Width of the guest display, in pixels.</desc>
12302	</param>
12303	<param name="height" type="unsigned long" dir="in">
12304	<desc>Height of the guest display, in pixels.</desc>
12305	</param>
12306	<param name="finished" type="boolean" dir="return">
12307	<desc>
12308	Can the VM start using the new frame buffer immediately
12309	after this method returns or it should wait for
12310	<link to="IDisplay::resizeCompleted"/>.
12311	</desc>
12312	</param>
12313	</method>
12314
12315	<method name="videoModeSupported">
12316	<desc>
12317	Returns whether the frame buffer implementation is willing to
12318	support a given video mode. In case it is not able to render
12319	the video mode (or for some reason not willing), it should
12320	return @c false. Usually this method is called when the guest
12321	asks the VMM device whether a given video mode is supported
12322	so the information returned is directly exposed to the guest.
12323	It is important that this method returns very quickly.
12324	</desc>
12325	<param name="width" type="unsigned long" dir="in"/>
12326	<param name="height" type="unsigned long" dir="in"/>
12327	<param name="bpp" type="unsigned long" dir="in"/>
12328	<param name="supported" type="boolean" dir="return"/>
12329	</method>
12330
12331	<method name="getVisibleRegion">
12332	<desc>
12333	Returns the visible region of this frame buffer.
12334
12335	If the @a rectangles parameter is @c null then the value of the
12336	@a count parameter is ignored and the number of elements necessary to
12337	describe the current visible region is returned in @a countCopied.
12338
12339	If @a rectangles is not @c null but @a count is less
12340	than the required number of elements to store region data, the method
12341	will report a failure. If @a count is equal or greater than the
12342	required number of elements, then the actual number of elements copied
12343	to the provided array will be returned in @a countCopied.
12344
12345	<note>
12346	The address of the provided array must be in the process space of
12347	this IFramebuffer object.
12348	</note>
12349	<note>
12350	Method not yet implemented.
12351	</note>
12352	</desc>
12353	<param name="rectangles" type="octet" mod="ptr" dir="in">
12354	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12355	</param>
12356	<param name="count" type="unsigned long" dir="in">
12357	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12358	</param>
12359	<param name="countCopied" type="unsigned long" dir="return">
12360	<desc>Number of elements copied to the @a rectangles array.</desc>
12361	</param>
12362	</method>
12363
12364	<method name="setVisibleRegion">
12365	<desc>
12366	Suggests a new visible region to this frame buffer. This region
12367	represents the area of the VM display which is a union of regions of
12368	all top-level windows of the guest operating system running inside the
12369	VM (if the Guest Additions for this system support this
12370	functionality). This information may be used by the frontends to
12371	implement the seamless desktop integration feature.
12372
12373	<note>
12374	The address of the provided array must be in the process space of
12375	this IFramebuffer object.
12376	</note>
12377	<note>
12378	The IFramebuffer implementation must make a copy of the provided
12379	array of rectangles.
12380	</note>
12381	<note>
12382	Method not yet implemented.
12383	</note>
12384	</desc>
12385	<param name="rectangles" type="octet" mod="ptr" dir="in">
12386	<desc>Pointer to the @c RTRECT array.</desc>
12387	</param>
12388	<param name="count" type="unsigned long" dir="in">
12389	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12390	</param>
12391	</method>
12392
12393	<method name="processVHWACommand">
12394	<desc>
12395	Posts a Video HW Acceleration Command to the frame buffer for processing.
12396	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12397	are posted from quest to the host to be processed by the host hardware.
12398
12399	<note>
12400	The address of the provided command must be in the process space of
12401	this IFramebuffer object.
12402	</note>
12403	</desc>
12404
12405	<param name="command" type="octet" mod="ptr" dir="in">
12406	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12407	</param>
12408	</method>
12409
12410	</interface>
12411
12412	<interface
12413	name="IFramebufferOverlay" extends="IFramebuffer"
12414	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12415	wsmap="suppress"
12416	>
12417	<desc>
12418	The IFramebufferOverlay interface represents an alpha blended overlay
12419	for displaying status icons above an IFramebuffer. It is always created
12420	not visible, so that it must be explicitly shown. It only covers a
12421	portion of the IFramebuffer, determined by its width, height and
12422	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12423	that order) format, and may be written to directly. Do re-read the
12424	width though, after setting it, as it may be adjusted (increased) to
12425	make it more suitable for the front end.
12426	</desc>
12427	<attribute name="x" type="unsigned long" readonly="yes">
12428	<desc>X position of the overlay, relative to the frame buffer.</desc>
12429	</attribute>
12430
12431	<attribute name="y" type="unsigned long" readonly="yes">
12432	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12433	</attribute>
12434
12435	<attribute name="visible" type="boolean" readonly="no">
12436	<desc>
12437	Whether the overlay is currently visible.
12438	</desc>
12439	</attribute>
12440
12441	<attribute name="alpha" type="unsigned long" readonly="no">
12442	<desc>
12443	The global alpha value for the overlay. This may or may not be
12444	supported by a given front end.
12445	</desc>
12446	</attribute>
12447
12448	<method name="move">
12449	<desc>
12450	Changes the overlay's position relative to the IFramebuffer.
12451	</desc>
12452	<param name="x" type="unsigned long" dir="in"/>
12453	<param name="y" type="unsigned long" dir="in"/>
12454	</method>
12455
12456	</interface>
12457
12458	<interface
12459	name="IDisplay" extends="$unknown"
12460	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
12461	wsmap="managed"
12462	>
12463	<desc>
12464	The IDisplay interface represents the virtual machine's display.
12465
12466	The object implementing this interface is contained in each
12467	<link to="IConsole::display"/> attribute and represents the visual
12468	output of the virtual machine.
12469
12470	The virtual display supports pluggable output targets represented by the
12471	IFramebuffer interface. Examples of the output target are a window on
12472	the host computer or an RDP session's display on a remote computer.
12473	</desc>
12474	<method name="getScreenResolution">
12475	<desc>Queries display width, height and color depth for given screen.</desc>
12476	<param name="screenId" type="unsigned long" dir="in"/>
12477	<param name="width" type="unsigned long" dir="out"/>
12478	<param name="height" type="unsigned long" dir="out"/>
12479	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12480	</method>
12481
12482	<method name="setFramebuffer">
12483	<desc>
12484	Sets the framebuffer for given screen.
12485	</desc>
12486	<param name="screenId" type="unsigned long" dir="in"/>
12487	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12488	</method>
12489
12490	<method name="getFramebuffer">
12491	<desc>
12492	Queries the framebuffer for given screen.
12493	</desc>
12494	<param name="screenId" type="unsigned long" dir="in"/>
12495	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12496	<param name="xOrigin" type="long" dir="out"/>
12497	<param name="yOrigin" type="long" dir="out"/>
12498	</method>
12499
12500	<method name="setVideoModeHint">
12501	<desc>
12502	Asks VirtualBox to request the given video mode from
12503	the guest. This is just a hint and it cannot be guaranteed
12504	that the requested resolution will be used. Guest Additions
12505	are required for the request to be seen by guests. The caller
12506	should issue the request and wait for a resolution change and
12507	after a timeout retry.
12508
12509	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12510	parameters means that the corresponding values should be taken from the
12511	current video mode (i.e. left unchanged).
12512
12513	If the guest OS supports multi-monitor configuration then the @a display
12514	parameter specifies the number of the guest display to send the hint to:
12515	@c 0 is the primary display, @c 1 is the first secondary and
12516	so on. If the multi-monitor configuration is not supported, @a display
12517	must be @c 0.
12518
12519	<result name="E_INVALIDARG">
12520	The @a display is not associated with any monitor.
12521	</result>
12522
12523	</desc>
12524	<param name="width" type="unsigned long" dir="in"/>
12525	<param name="height" type="unsigned long" dir="in"/>
12526	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12527	<param name="display" type="unsigned long" dir="in"/>
12528	</method>
12529
12530	<method name="setSeamlessMode">
12531	<desc>
12532	Enables or disables seamless guest display rendering (seamless desktop
12533	integration) mode.
12534	<note>
12535	Calling this method has no effect if <link
12536	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12537	does not return @c Active.
12538	</note>
12539	</desc>
12540	<param name="enabled" type="boolean" dir="in"/>
12541	</method>
12542
12543	<method name="takeScreenShot">
12544	<desc>
12545	Takes a screen shot of the requested size and copies it to the
12546	32-bpp buffer allocated by the caller and pointed to by @a address.
12547	A pixel consists of 4 bytes in order: B, G, R, 0.
12548
12549	<note>This API can be used only locally by a VM process through the
12550	COM/XPCOM C++ API as it requires pointer support. It is not
12551	available for scripting langages, Java or any webservice clients.
12552	Unless you are writing a new VM frontend use
12553	<link to="#takeScreenShotToArray" />.
12554	</note>
12555
12556	<result name="E_NOTIMPL">
12557	Feature not implemented.
12558	</result>
12559	<result name="VBOX_E_IPRT_ERROR">
12560	Could not take a screenshot.
12561	</result>
12562
12563	</desc>
12564	<param name="screenId" type="unsigned long" dir="in"/>
12565	<param name="address" type="octet" mod="ptr" dir="in"/>
12566	<param name="width" type="unsigned long" dir="in"/>
12567	<param name="height" type="unsigned long" dir="in"/>
12568	</method>
12569
12570	<method name="takeScreenShotToArray">
12571	<desc>
12572	Takes a guest screen shot of the requested size and returns it as
12573	an array of bytes in uncompressed 32-bit RGBA format.
12574	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12575
12576	This API is slow, but could be the only option to get guest screenshot
12577	for scriptable languages not allowed to manipulate with addresses
12578	directly.
12579
12580	<result name="E_NOTIMPL">
12581	Feature not implemented.
12582	</result>
12583	<result name="VBOX_E_IPRT_ERROR">
12584	Could not take a screenshot.
12585	</result>
12586	</desc>
12587	<param name="screenId" type="unsigned long" dir="in">
12588	<desc>
12589	Monitor to take screenshot from.
12590	</desc>
12591	</param>
12592	<param name="width" type="unsigned long" dir="in">
12593	<desc>
12594	Desired image width.
12595	</desc>
12596	</param>
12597	<param name="height" type="unsigned long" dir="in">
12598	<desc>
12599	Desired image height.
12600	</desc>
12601	</param>
12602	<param name="screenData" type="octet" dir="return" safearray="yes">
12603	<desc>
12604	Array with resulting screen data.
12605	</desc>
12606	</param>
12607	</method>
12608
12609	<method name="takeScreenShotPNGToArray">
12610	<desc>
12611	Takes a guest screen shot of the requested size and returns it as
12612	PNG image in array.
12613
12614	<result name="E_NOTIMPL">
12615	Feature not implemented.
12616	</result>
12617	<result name="VBOX_E_IPRT_ERROR">
12618	Could not take a screenshot.
12619	</result>
12620	</desc>
12621	<param name="screenId" type="unsigned long" dir="in">
12622	<desc>
12623	Monitor to take the screenshot from.
12624	</desc>
12625	</param>
12626	<param name="width" type="unsigned long" dir="in">
12627	<desc>
12628	Desired image width.
12629	</desc>
12630	</param>
12631	<param name="height" type="unsigned long" dir="in">
12632	<desc>
12633	Desired image height.
12634	</desc>
12635	</param>
12636	<param name="screenData" type="octet" dir="return" safearray="yes">
12637	<desc>
12638	Array with resulting screen data.
12639	</desc>
12640	</param>
12641	</method>
12642
12643	<method name="drawToScreen">
12644	<desc>
12645	Draws a 32-bpp image of the specified size from the given buffer
12646	to the given point on the VM display.
12647
12648	<result name="E_NOTIMPL">
12649	Feature not implemented.
12650	</result>
12651	<result name="VBOX_E_IPRT_ERROR">
12652	Could not draw to screen.
12653	</result>
12654
12655	</desc>
12656	<param name="screenId" type="unsigned long" dir="in">
12657	<desc>
12658	Monitor to take the screenshot from.
12659	</desc>
12660	</param>
12661	<param name="address" type="octet" mod="ptr" dir="in">
12662	<desc>
12663	Address to store the screenshot to
12664	</desc>
12665	</param>
12666	<param name="x" type="unsigned long" dir="in">
12667	<desc>
12668	Relative to the screen top left corner.
12669	</desc>
12670	</param>
12671	<param name="y" type="unsigned long" dir="in">
12672	<desc>
12673	Relative to the screen top left corner.
12674	</desc>
12675	</param>
12676	<param name="width" type="unsigned long" dir="in">
12677	<desc>
12678	Desired image width.
12679	</desc>
12680	</param>
12681	<param name="height" type="unsigned long" dir="in">
12682	<desc>
12683	Desired image height.
12684	</desc>
12685	</param>
12686	</method>
12687
12688	<method name="invalidateAndUpdate">
12689	<desc>
12690	Does a full invalidation of the VM display and instructs the VM
12691	to update it.
12692
12693	<result name="VBOX_E_IPRT_ERROR">
12694	Could not invalidate and update screen.
12695	</result>
12696
12697	</desc>
12698	</method>
12699
12700	<method name="resizeCompleted">
12701	<desc>
12702	Signals that a framebuffer has completed the resize operation.
12703
12704	<result name="VBOX_E_NOT_SUPPORTED">
12705	Operation only valid for external frame buffers.
12706	</result>
12707
12708	</desc>
12709	<param name="screenId" type="unsigned long" dir="in"/>
12710	</method>
12711
12712	<method name="completeVHWACommand">
12713	<desc>
12714	Signals that the Video HW Acceleration command has completed.
12715	</desc>
12716
12717	<param name="command" type="octet" mod="ptr" dir="in">
12718	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12719	</param>
12720	</method>
12721
12722	</interface>
12723
12724	<!--
12725	// INetworkAdapter
12726	/////////////////////////////////////////////////////////////////////////
12727	-->
12728
12729	<enum
12730	name="NetworkAttachmentType"
12731	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12732	>
12733	<desc>
12734	Network attachment type.
12735	</desc>
12736
12737	<const name="Null" value="0">
12738	<desc>Null value, also means "not attached".</desc>
12739	</const>
12740	<const name="NAT" value="1"/>
12741	<const name="Bridged" value="2"/>
12742	<const name="Internal" value="3"/>
12743	<const name="HostOnly" value="4"/>
12744	<const name="Generic" value="5"/>
12745	</enum>
12746
12747	<enum
12748	name="NetworkAdapterType"
12749	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12750	>
12751	<desc>
12752	Network adapter type.
12753	</desc>
12754
12755	<const name="Null" value="0">
12756	<desc>Null value (never used by the API).</desc>
12757	</const>
12758	<const name="Am79C970A" value="1">
12759	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12760	</const>
12761	<const name="Am79C973" value="2">
12762	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12763	</const>
12764	<const name="I82540EM" value="3">
12765	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12766	</const>
12767	<const name="I82543GC" value="4">
12768	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12769	</const>
12770	<const name="I82545EM" value="5">
12771	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12772	</const>
12773	<const name="Virtio" value="6">
12774	<desc>Virtio network device.</desc>
12775	</const>
12776	</enum>
12777
12778	<enum
12779	name="NetworkAdapterPromiscModePolicy"
12780	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12781	>
12782	<desc>
12783	The promiscuous mode policy of an interface.
12784	</desc>
12785
12786	<const name="Deny" value="1">
12787	<desc>Deny promiscuous mode requests.</desc>
12788	</const>
12789	<const name="AllowNetwork" value="2">
12790	<desc>
12791	Allow promicuous mode, but restrict the scope it to the internal
12792	network so that it only applies to other VMs.
12793	</desc>
12794	</const>
12795	<const name="AllowAll" value="3">
12796	<desc>
12797	Allow promicuous mode, include unrelated traffic going over the wire
12798	and internally on the host.
12799	</desc>
12800	</const>
12801	</enum>
12802
12803	<interface
12804	name="INetworkAdapter" extends="$unknown"
12805	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12806	wsmap="managed"
12807	>
12808	<desc>
12809	Represents a virtual network adapter that is attached to a virtual machine.
12810	Each virtual machine has a fixed number of network adapter slots with one
12811	instance of this attached to each of them. Call
12812	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12813	is attached to a given slot in a given machine.
12814
12815	Each network adapter can be in one of five attachment modes, which are
12816	represented by the <link to="NetworkAttachmentType" /> enumeration;
12817	see the <link to="#attachmentType" /> attribute.
12818	</desc>
12819
12820	<attribute name="adapterType" type="NetworkAdapterType">
12821	<desc>
12822	Type of the virtual network adapter. Depending on this value,
12823	VirtualBox will provide a different virtual network hardware
12824	to the guest.
12825	</desc>
12826	</attribute>
12827
12828	<attribute name="slot" type="unsigned long" readonly="yes">
12829	<desc>
12830	Slot number this adapter is plugged into. Corresponds to
12831	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12832	to obtain this instance.
12833	</desc>
12834	</attribute>
12835
12836	<attribute name="enabled" type="boolean">
12837	<desc>
12838	Flag whether the network adapter is present in the
12839	guest system. If disabled, the virtual guest hardware will
12840	not contain this network adapter. Can only be changed when
12841	the VM is not running.
12842	</desc>
12843	</attribute>
12844
12845	<attribute name="MACAddress" type="wstring">
12846	<desc>
12847	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
12848	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
12849	</desc>
12850	</attribute>
12851
12852	<attribute name="attachmentType" type="NetworkAttachmentType">
12853	<desc>
12854	Sets/Gets network attachment type of this network adapter.
12855	</desc>
12856	</attribute>
12857
12858	<attribute name="bridgedInterface" type="wstring">
12859	<desc>
12860	Name of the network interface the VM should be bridged to.
12861	</desc>
12862	</attribute>
12863
12864	<attribute name="hostOnlyInterface" type="wstring">
12865	<desc>
12866	Name of the host only network interface the VM is attached to.
12867	</desc>
12868	</attribute>
12869
12870	<attribute name="internalNetwork" type="wstring">
12871	<desc>
12872	Name of the internal network the VM is attached to.
12873	</desc>
12874	</attribute>
12875
12876	<attribute name="NATNetwork" type="wstring">
12877	<desc>
12878	Name of the NAT network the VM is attached to.
12879	</desc>
12880	</attribute>
12881
12882	<attribute name="genericDriver" type="wstring">
12883	<desc>
12884	Name of the driver to use for the "Generic" network attachment type.
12885	</desc>
12886	</attribute>
12887
12888	<attribute name="cableConnected" type="boolean">
12889	<desc>
12890	Flag whether the adapter reports the cable as connected or not.
12891	It can be used to report offline situations to a VM.
12892	</desc>
12893	</attribute>
12894
12895	<attribute name="lineSpeed" type="unsigned long">
12896	<desc>
12897	Line speed reported by custom drivers, in units of 1 kbps.
12898	</desc>
12899	</attribute>
12900
12901	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
12902	<desc>
12903	The promiscuous mode policy of the network adapter when attached to an
12904	internal network, host only network or a bridge.
12905	</desc>
12906	</attribute>
12907
12908	<attribute name="traceEnabled" type="boolean">
12909	<desc>
12910	Flag whether network traffic from/to the network card should be traced.
12911	Can only be toggled when the VM is turned off.
12912	</desc>
12913	</attribute>
12914
12915	<attribute name="traceFile" type="wstring">
12916	<desc>
12917	Filename where a network trace will be stored. If not set, VBox-pid.pcap
12918	will be used.
12919	</desc>
12920	</attribute>
12921
12922	<attribute name="natDriver" type="INATEngine" readonly="yes">
12923	<desc>
12924	Points to the NAT engine which handles the network address translation
12925	for this interface. This is active only when the interface actually uses
12926	NAT.
12927	</desc>
12928	</attribute>
12929
12930	<attribute name="bootPriority" type="unsigned long">
12931	<desc>
12932	Network boot priority of the adapter. Priority 1 is highest. If not set,
12933	the priority is considered to be at the lowest possible setting.
12934	</desc>
12935	</attribute>
12936
12937	<attribute name="bandwidthGroup" type="IBandwidthGroup">
12938	<desc>The bandwidth group this network adapter is assigned to.</desc>
12939	</attribute>
12940
12941	<!-- property methods -->
12942
12943	<method name="getProperty" const="yes">
12944	<desc>
12945	Returns the value of the network attachment property with the given name.
12946
12947	If the requested data @a key does not exist, this function will
12948	succeed and return an empty string in the @a value argument.
12949
12950	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12951	</desc>
12952	<param name="key" type="wstring" dir="in">
12953	<desc>Name of the property to get.</desc>
12954	</param>
12955	<param name="value" type="wstring" dir="return">
12956	<desc>Current property value.</desc>
12957	</param>
12958	</method>
12959
12960	<method name="setProperty">
12961	<desc>
12962	Sets the value of the network attachment property with the given name.
12963
12964	Setting the property value to @c null or an empty string is equivalent
12965	to deleting the existing value.
12966
12967	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12968	</desc>
12969	<param name="key" type="wstring" dir="in">
12970	<desc>Name of the property to set.</desc>
12971	</param>
12972	<param name="value" type="wstring" dir="in">
12973	<desc>Property value to set.</desc>
12974	</param>
12975	</method>
12976
12977	<method name="getProperties" const="yes">
12978	<desc>
12979	Returns values for a group of properties in one call.
12980
12981	The names of the properties to get are specified using the @a names
12982	argument which is a list of comma-separated property names or
12983	an empty string if all properties are to be returned.
12984	<note>Currently the value of this argument is ignored and the method
12985	always returns all existing properties.</note>
12986
12987	The method returns two arrays, the array of property names corresponding
12988	to the @a names argument and the current values of these properties.
12989	Both arrays have the same number of elements with each element at the
12990	given index in the first array corresponds to an element at the same
12991	index in the second array.
12992	</desc>
12993	<param name="names" type="wstring" dir="in">
12994	<desc>
12995	Names of properties to get.
12996	</desc>
12997	</param>
12998	<param name="returnNames" type="wstring" safearray="yes" dir="out">
12999	<desc>Names of returned properties.</desc>
13000	</param>
13001	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13002	<desc>Values of returned properties.</desc>
13003	</param>
13004	</method>
13005
13006	</interface>
13007
13008
13009	<!--
13010	// ISerialPort
13011	/////////////////////////////////////////////////////////////////////////
13012	-->
13013
13014	<enum
13015	name="PortMode"
13016	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13017	>
13018	<desc>
13019	The PortMode enumeration represents possible communication modes for
13020	the virtual serial port device.
13021	</desc>
13022
13023	<const name="Disconnected" value="0">
13024	<desc>Virtual device is not attached to any real host device.</desc>
13025	</const>
13026	<const name="HostPipe" value="1">
13027	<desc>Virtual device is attached to a host pipe.</desc>
13028	</const>
13029	<const name="HostDevice" value="2">
13030	<desc>Virtual device is attached to a host device.</desc>
13031	</const>
13032	<const name="RawFile" value="3">
13033	<desc>Virtual device is attached to a raw file.</desc>
13034	</const>
13035	</enum>
13036
13037	<interface
13038	name="ISerialPort" extends="$unknown"
13039	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13040	wsmap="managed"
13041	>
13042
13043	<desc>
13044	The ISerialPort interface represents the virtual serial port device.
13045
13046	The virtual serial port device acts like an ordinary serial port
13047	inside the virtual machine. This device communicates to the real
13048	serial port hardware in one of two modes: host pipe or host device.
13049
13050	In host pipe mode, the #path attribute specifies the path to the pipe on
13051	the host computer that represents a serial port. The #server attribute
13052	determines if this pipe is created by the virtual machine process at
13053	machine startup or it must already exist before starting machine
13054	execution.
13055
13056	In host device mode, the #path attribute specifies the name of the
13057	serial port device on the host computer.
13058
13059	There is also a third communication mode: the disconnected mode. In this
13060	mode, the guest OS running inside the virtual machine will be able to
13061	detect the serial port, but all port write operations will be discarded
13062	and all port read operations will return no data.
13063
13064	<see><link to="IMachine::getSerialPort"/></see>
13065	</desc>
13066
13067	<attribute name="slot" type="unsigned long" readonly="yes">
13068	<desc>
13069	Slot number this serial port is plugged into. Corresponds to
13070	the value you pass to <link to="IMachine::getSerialPort"/>
13071	to obtain this instance.
13072	</desc>
13073	</attribute>
13074
13075	<attribute name="enabled" type="boolean">
13076	<desc>
13077	Flag whether the serial port is enabled. If disabled,
13078	the serial port will not be reported to the guest OS.
13079	</desc>
13080	</attribute>
13081
13082	<attribute name="IOBase" type="unsigned long">
13083	<desc>Base I/O address of the serial port.</desc>
13084	</attribute>
13085
13086	<attribute name="IRQ" type="unsigned long">
13087	<desc>IRQ number of the serial port.</desc>
13088	</attribute>
13089
13090	<attribute name="hostMode" type="PortMode">
13091	<desc>
13092	How is this port connected to the host.
13093	<note>
13094	Changing this attribute may fail if the conditions for
13095	<link to="#path"/> are not met.
13096	</note>
13097	</desc>
13098	</attribute>
13099
13100	<attribute name="server" type="boolean">
13101	<desc>
13102	Flag whether this serial port acts as a server (creates a new pipe on
13103	the host) or as a client (uses the existing pipe). This attribute is
13104	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13105	</desc>
13106	</attribute>
13107
13108	<attribute name="path" type="wstring">
13109	<desc>
13110	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13111	PortMode_HostPipe, or the host serial device name when
13112	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13113	cases, setting a @c null or empty string as the attribute's value
13114	is an error. Otherwise, the value of this property is ignored.
13115	</desc>
13116	</attribute>
13117
13118	</interface>
13119
13120	<!--
13121	// IParallelPort
13122	/////////////////////////////////////////////////////////////////////////
13123	-->
13124
13125	<interface
13126	name="IParallelPort" extends="$unknown"
13127	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13128	wsmap="managed"
13129	>
13130
13131	<desc>
13132	The IParallelPort interface represents the virtual parallel port device.
13133
13134	The virtual parallel port device acts like an ordinary parallel port
13135	inside the virtual machine. This device communicates to the real
13136	parallel port hardware using the name of the parallel device on the host
13137	computer specified in the #path attribute.
13138
13139	Each virtual parallel port device is assigned a base I/O address and an
13140	IRQ number that will be reported to the guest operating system and used
13141	to operate the given parallel port from within the virtual machine.
13142
13143	<see><link to="IMachine::getParallelPort"/></see>
13144	</desc>
13145
13146	<attribute name="slot" type="unsigned long" readonly="yes">
13147	<desc>
13148	Slot number this parallel port is plugged into. Corresponds to
13149	the value you pass to <link to="IMachine::getParallelPort"/>
13150	to obtain this instance.
13151	</desc>
13152	</attribute>
13153
13154	<attribute name="enabled" type="boolean">
13155	<desc>
13156	Flag whether the parallel port is enabled. If disabled,
13157	the parallel port will not be reported to the guest OS.
13158	</desc>
13159	</attribute>
13160
13161	<attribute name="IOBase" type="unsigned long">
13162	<desc>Base I/O address of the parallel port.</desc>
13163	</attribute>
13164
13165	<attribute name="IRQ" type="unsigned long">
13166	<desc>IRQ number of the parallel port.</desc>
13167	</attribute>
13168
13169	<attribute name="path" type="wstring">
13170	<desc>
13171	Host parallel device name. If this parallel port is enabled, setting a
13172	@c null or an empty string as this attribute's value will result in
13173	an error.
13174	</desc>
13175	</attribute>
13176
13177	</interface>
13178
13179
13180	<!--
13181	// IMachineDebugger
13182	/////////////////////////////////////////////////////////////////////////
13183	-->
13184
13185	<interface
13186	name="IMachineDebugger" extends="$unknown"
13187	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13188	wsmap="suppress"
13189	>
13190	<method name="dumpGuestCore">
13191	<desc>
13192	Takes a core dump of the guest.
13193
13194	See include/VBox/dbgfcorefmt.h for details on the file format.
13195	</desc>
13196	<param name="filename" type="wstring" dir="in">
13197	<desc>
13198	The name of the output file. The file must not exist.
13199	</desc>
13200	</param>
13201	<param name="compression" type="wstring" dir="in">
13202	<desc>
13203	Reserved for future compression method indicator.
13204	</desc>
13205	</param>
13206	</method>
13207
13208	<method name="dumpHostProcessCore">
13209	<desc>
13210	Takes a core dump of the VM process on the host.
13211
13212	This feature is not implemented in the 4.0.0 release but it may show up
13213	in a dot release.
13214	</desc>
13215	<param name="filename" type="wstring" dir="in">
13216	<desc>
13217	The name of the output file. The file must not exist.
13218	</desc>
13219	</param>
13220	<param name="compression" type="wstring" dir="in">
13221	<desc>
13222	Reserved for future compression method indicator.
13223	</desc>
13224	</param>
13225	</method>
13226
13227	<method name="info">
13228	<desc>
13229	Interfaces with the info dumpers (DBGFInfo).
13230
13231	This feature is not implemented in the 4.0.0 release but it may show up
13232	in a dot release.
13233	</desc>
13234	<param name="name" type="wstring" dir="in">
13235	<desc>
13236	The name of the info item.
13237	</desc>
13238	</param>
13239	<param name="args" type="wstring" dir="in">
13240	<desc>
13241	Arguments to the info dumper.
13242	</desc>
13243	</param>
13244	<param name="info" type="wstring" dir="return">
13245	<desc>
13246	The into string.
13247	</desc>
13248	</param>
13249	</method>
13250
13251	<method name="injectNMI">
13252	<desc>
13253	Inject an NMI into a running VT-x/AMD-V VM.
13254	</desc>
13255	</method>
13256
13257	<method name="modifyLogGroups">
13258	<desc>
13259	Modifies the group settings of the debug or release logger.
13260	</desc>
13261	<param name="settings" type="wstring" dir="in">
13262	<desc>
13263	The group settings string. See iprt/log.h for details. To target the
13264	release logger, prefix the string with "release:".
13265	</desc>
13266	</param>
13267	</method>
13268
13269	<method name="modifyLogFlags">
13270	<desc>
13271	Modifies the debug or release logger flags.
13272	</desc>
13273	<param name="settings" type="wstring" dir="in">
13274	<desc>
13275	The flags settings string. See iprt/log.h for details. To target the
13276	release logger, prefix the string with "release:".
13277	</desc>
13278	</param>
13279	</method>
13280
13281	<method name="modifyLogDestinations">
13282	<desc>
13283	Modifies the debug or release logger destinations.
13284	</desc>
13285	<param name="settings" type="wstring" dir="in">
13286	<desc>
13287	The destination settings string. See iprt/log.h for details. To target the
13288	release logger, prefix the string with "release:".
13289	</desc>
13290	</param>
13291	</method>
13292
13293	<method name="readPhysicalMemory">
13294	<desc>
13295	Reads guest physical memory, no side effects (MMIO++).
13296
13297	This feature is not implemented in the 4.0.0 release but may show up
13298	in a dot release.
13299	</desc>
13300	<param name="address" type="long long" dir="in">
13301	<desc>The guest physical address.</desc>
13302	</param>
13303	<param name="size" type="unsigned long" dir="in">
13304	<desc>The number of bytes to read.</desc>
13305	</param>
13306	<param name="bytes" type="octet" safearray="yes" dir="return">
13307	<desc>The bytes read.</desc>
13308	</param>
13309	</method>
13310
13311	<method name="writePhysicalMemory">
13312	<desc>
13313	Writes guest physical memory, access handles (MMIO++) are ignored.
13314
13315	This feature is not implemented in the 4.0.0 release but may show up
13316	in a dot release.
13317	</desc>
13318	<param name="address" type="long long" dir="in">
13319	<desc>The guest physical address.</desc>
13320	</param>
13321	<param name="size" type="unsigned long" dir="in">
13322	<desc>The number of bytes to read.</desc>
13323	</param>
13324	<param name="bytes" type="octet" safearray="yes" dir="in">
13325	<desc>The bytes to write.</desc>
13326	</param>
13327	</method>
13328
13329	<method name="readVirtualMemory">
13330	<desc>
13331	Reads guest virtual memory, no side effects (MMIO++).
13332
13333	This feature is not implemented in the 4.0.0 release but may show up
13334	in a dot release.
13335	</desc>
13336	<param name="cpuId" type="unsigned long" dir="in">
13337	<desc>The identifier of the Virtual CPU.</desc>
13338	</param>
13339	<param name="address" type="long long" dir="in">
13340	<desc>The guest virtual address.</desc>
13341	</param>
13342	<param name="size" type="unsigned long" dir="in">
13343	<desc>The number of bytes to read.</desc>
13344	</param>
13345	<param name="bytes" type="octet" safearray="yes" dir="return">
13346	<desc>The bytes read.</desc>
13347	</param>
13348	</method>
13349
13350	<method name="writeVirtualMemory">
13351	<desc>
13352	Writes guest virtual memory, access handles (MMIO++) are ignored.
13353
13354	This feature is not implemented in the 4.0.0 release but may show up
13355	in a dot release.
13356	</desc>
13357	<param name="cpuId" type="unsigned long" dir="in">
13358	<desc>The identifier of the Virtual CPU.</desc>
13359	</param>
13360	<param name="address" type="long long" dir="in">
13361	<desc>The guest virtual address.</desc>
13362	</param>
13363	<param name="size" type="unsigned long" dir="in">
13364	<desc>The number of bytes to read.</desc>
13365	</param>
13366	<param name="bytes" type="octet" safearray="yes" dir="in">
13367	<desc>The bytes to write.</desc>
13368	</param>
13369	</method>
13370
13371	<method name="detectOS">
13372	<desc>
13373	Tries to (re-)detect the guest OS kernel.
13374
13375	This feature is not implemented in the 4.0.0 release but may show up
13376	in a dot release.
13377	</desc>
13378	<param name="os" type="wstring" dir="return">
13379	<desc>
13380	The detected OS kernel on success.
13381	</desc>
13382	</param>
13383	</method>
13384
13385	<method name="getRegister">
13386	<desc>
13387	Gets one register.
13388
13389	This feature is not implemented in the 4.0.0 release but may show up
13390	in a dot release.
13391	</desc>
13392	<param name="cpuId" type="unsigned long" dir="in">
13393	<desc>The identifier of the Virtual CPU.</desc>
13394	</param>
13395	<param name="name" type="wstring" dir="in">
13396	<desc>The register name, case is ignored.</desc>
13397	</param>
13398	<param name="value" type="wstring" dir="return">
13399	<desc>
13400	The register value. This is usually a hex value (always 0x prefixed)
13401	but other format may be used for floating point registers (TBD).
13402	</desc>
13403	</param>
13404	</method>
13405
13406	<method name="getRegisters">
13407	<desc>
13408	Gets all the registers for the given CPU.
13409
13410	This feature is not implemented in the 4.0.0 release but may show up
13411	in a dot release.
13412	</desc>
13413	<param name="cpuId" type="unsigned long" dir="in">
13414	<desc>The identifier of the Virtual CPU.</desc>
13415	</param>
13416	<param name="names" type="wstring" dir="out" safearray="yes">
13417	<desc>Array containing the lowercase register names.</desc>
13418	</param>
13419	<param name="values" type="wstring" dir="out" safearray="yes">
13420	<desc>
13421	Array paralell to the names holding the register values as if the
13422	register was returned by <link to="IMachineDebugger::getRegister"/>.
13423	</desc>
13424	</param>
13425	</method>
13426
13427	<method name="setRegister">
13428	<desc>
13429	Gets one register.
13430
13431	This feature is not implemented in the 4.0.0 release but may show up
13432	in a dot release.
13433	</desc>
13434	<param name="cpuId" type="unsigned long" dir="in">
13435	<desc>The identifier of the Virtual CPU.</desc>
13436	</param>
13437	<param name="name" type="wstring" dir="in">
13438	<desc>The register name, case is ignored.</desc>
13439	</param>
13440	<param name="value" type="wstring" dir="in">
13441	<desc>
13442	The new register value. Hexadecimal, decimal and octal formattings
13443	are supported in addition to any special formattings returned by
13444	the getters.
13445	</desc>
13446	</param>
13447	</method>
13448
13449	<method name="setRegisters">
13450	<desc>
13451	Sets zero or more registers atomically.
13452
13453	This feature is not implemented in the 4.0.0 release but may show up
13454	in a dot release.
13455	</desc>
13456	<param name="cpuId" type="unsigned long" dir="in">
13457	<desc>The identifier of the Virtual CPU.</desc>
13458	</param>
13459	<param name="names" type="wstring" dir="in" safearray="yes">
13460	<desc>Array containing the register names, case ignored.</desc>
13461	</param>
13462	<param name="values" type="wstring" dir="in" safearray="yes">
13463	<desc>
13464	Array paralell to the names holding the register values. See
13465	<link to="IMachineDebugger::setRegister"/> for formatting
13466	guidelines.
13467	</desc>
13468	</param>
13469	</method>
13470
13471	<method name="dumpGuestStack">
13472	<desc>
13473	Produce a simple stack dump using the current guest state.
13474
13475	This feature is not implemented in the 4.0.0 release but may show up
13476	in a dot release.
13477	</desc>
13478	<param name="cpuId" type="unsigned long" dir="in">
13479	<desc>The identifier of the Virtual CPU.</desc>
13480	</param>
13481	<param name="stack" type="wstring" dir="return">
13482	<desc>String containing the formatted stack dump.</desc>
13483	</param>
13484	</method>
13485
13486	<method name="resetStats">
13487	<desc>
13488	Reset VM statistics.
13489	</desc>
13490	<param name="pattern" type="wstring" dir="in">
13491	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13492	</param>
13493	</method>
13494
13495	<method name="dumpStats">
13496	<desc>
13497	Dumps VM statistics.
13498	</desc>
13499	<param name="pattern" type="wstring" dir="in">
13500	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13501	</param>
13502	</method>
13503
13504	<method name="getStats">
13505	<desc>
13506	Get the VM statistics in a XMLish format.
13507	</desc>
13508	<param name="pattern" type="wstring" dir="in">
13509	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13510	</param>
13511	<param name="withDescriptions" type="boolean" dir="in">
13512	<desc>Whether to include the descriptions.</desc>
13513	</param>
13514	<param name="stats" type="wstring" dir="out">
13515	<desc>The XML document containing the statistics.</desc>
13516	</param>
13517	</method>
13518
13519	<attribute name="singlestep" type="boolean">
13520	<desc>Switch for enabling singlestepping.</desc>
13521	</attribute>
13522
13523	<attribute name="recompileUser" type="boolean">
13524	<desc>Switch for forcing code recompilation for user mode code.</desc>
13525	</attribute>
13526
13527	<attribute name="recompileSupervisor" type="boolean">
13528	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13529	</attribute>
13530
13531	<attribute name="PATMEnabled" type="boolean">
13532	<desc>Switch for enabling and disabling the PATM component.</desc>
13533	</attribute>
13534
13535	<attribute name="CSAMEnabled" type="boolean">
13536	<desc>Switch for enabling and disabling the CSAM component.</desc>
13537	</attribute>
13538
13539	<attribute name="logEnabled" type="boolean">
13540	<desc>Switch for enabling and disabling the debug logger.</desc>
13541	</attribute>
13542
13543	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13544	<desc>The debug logger flags.</desc>
13545	</attribute>
13546
13547	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13548	<desc>The debug logger's group settings.</desc>
13549	</attribute>
13550
13551	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13552	<desc>The debug logger's destination settings.</desc>
13553	</attribute>
13554
13555	<attribute name="logRelFlags" type="wstring" readonly="yes">
13556	<desc>The release logger flags.</desc>
13557	</attribute>
13558
13559	<attribute name="logRelGroups" type="wstring" readonly="yes">
13560	<desc>The release logger's group settings.</desc>
13561	</attribute>
13562
13563	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13564	<desc>The relase logger's destination settings.</desc>
13565	</attribute>
13566
13567	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13568	<desc>
13569	Flag indicating whether the VM is currently making use of CPU hardware
13570	virtualization extensions.
13571	</desc>
13572	</attribute>
13573
13574	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13575	<desc>
13576	Flag indicating whether the VM is currently making use of the nested paging
13577	CPU hardware virtualization extension.
13578	</desc>
13579	</attribute>
13580
13581	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13582	<desc>
13583	Flag indicating whether the VM is currently making use of the VPID
13584	VT-x extension.
13585	</desc>
13586	</attribute>
13587
13588	<attribute name="OSName" type="wstring" readonly="yes">
13589	<desc>
13590	Query the guest OS kernel name as detected by the DBGF.
13591
13592	This feature is not implemented in the 4.0.0 release but may show up
13593	in a dot release.
13594	</desc>
13595	</attribute>
13596
13597	<attribute name="OSVersion" type="wstring" readonly="yes">
13598	<desc>
13599	Query the guest OS kernel version string as detected by the DBGF.
13600
13601	This feature is not implemented in the 4.0.0 release but may show up
13602	in a dot release.
13603	</desc>
13604	</attribute>
13605
13606	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13607	<desc>
13608	Flag indicating whether the VM is currently making use of the Physical
13609	Address Extension CPU feature.
13610	</desc>
13611	</attribute>
13612
13613	<attribute name="virtualTimeRate" type="unsigned long">
13614	<desc>
13615	The rate at which the virtual time runs expressed as a percentage.
13616	The accepted range is 2% to 20000%.
13617	</desc>
13618	</attribute>
13619
13620	<attribute name="VM" type="long long" readonly="yes">
13621	<desc>
13622	Gets the VM handle. This is only for internal use while
13623	we carve the details of this interface.
13624	</desc>
13625	</attribute>
13626
13627	</interface>
13628
13629	<!--
13630	// IUSBController
13631	/////////////////////////////////////////////////////////////////////////
13632	-->
13633
13634	<interface
13635	name="IUSBController" extends="$unknown"
13636	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13637	wsmap="managed"
13638	>
13639	<attribute name="enabled" type="boolean">
13640	<desc>
13641	Flag whether the USB controller is present in the
13642	guest system. If disabled, the virtual guest hardware will
13643	not contain any USB controller. Can only be changed when
13644	the VM is powered off.
13645	</desc>
13646	</attribute>
13647
13648	<attribute name="enabledEhci" type="boolean">
13649	<desc>
13650	Flag whether the USB EHCI controller is present in the
13651	guest system. If disabled, the virtual guest hardware will
13652	not contain a USB EHCI controller. Can only be changed when
13653	the VM is powered off.
13654	</desc>
13655	</attribute>
13656
13657	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13658	<desc>
13659	Flag whether there is an USB proxy available.
13660	</desc>
13661	</attribute>
13662
13663	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13664	<desc>
13665	USB standard version which the controller implements.
13666	This is a BCD which means that the major version is in the
13667	high byte and minor version is in the low byte.
13668	</desc>
13669	</attribute>
13670
13671	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13672	<desc>
13673	List of USB device filters associated with the machine.
13674
13675	If the machine is currently running, these filters are activated
13676	every time a new (supported) USB device is attached to the host
13677	computer that was not ignored by global filters
13678	(<link to="IHost::USBDeviceFilters"/>).
13679
13680	These filters are also activated when the machine is powered up.
13681	They are run against a list of all currently available USB
13682	devices (in states
13683	<link to="USBDeviceState_Available"/>,
13684	<link to="USBDeviceState_Busy"/>,
13685	<link to="USBDeviceState_Held"/>) that were not previously
13686	ignored by global filters.
13687
13688	If at least one filter matches the USB device in question, this
13689	device is automatically captured (attached to) the virtual USB
13690	controller of this machine.
13691
13692	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13693	</desc>
13694	</attribute>
13695
13696	<method name="createDeviceFilter">
13697	<desc>
13698	Creates a new USB device filter. All attributes except
13699	the filter name are set to empty (any match),
13700	<i>active</i> is @c false (the filter is not active).
13701
13702	The created filter can then be added to the list of filters using
13703	<link to="#insertDeviceFilter"/>.
13704
13705	<result name="VBOX_E_INVALID_VM_STATE">
13706	The virtual machine is not mutable.
13707	</result>
13708
13709	<see><link to="#deviceFilters"/></see>
13710	</desc>
13711	<param name="name" type="wstring" dir="in">
13712	<desc>
13713	Filter name. See <link to="IUSBDeviceFilter::name"/>
13714	for more info.
13715	</desc>
13716	</param>
13717	<param name="filter" type="IUSBDeviceFilter" dir="return">
13718	<desc>Created filter object.</desc>
13719	</param>
13720	</method>
13721
13722	<method name="insertDeviceFilter">
13723	<desc>
13724	Inserts the given USB device to the specified position
13725	in the list of filters.
13726
13727	Positions are numbered starting from <tt>0</tt>. If the specified
13728	position is equal to or greater than the number of elements in
13729	the list, the filter is added to the end of the collection.
13730
13731	<note>
13732	Duplicates are not allowed, so an attempt to insert a
13733	filter that is already in the collection, will return an
13734	error.
13735	</note>
13736
13737	<result name="VBOX_E_INVALID_VM_STATE">
13738	Virtual machine is not mutable.
13739	</result>
13740	<result name="E_INVALIDARG">
13741	USB device filter not created within this VirtualBox instance.
13742	</result>
13743	<result name="VBOX_E_INVALID_OBJECT_STATE">
13744	USB device filter already in list.
13745	</result>
13746
13747	<see><link to="#deviceFilters"/></see>
13748	</desc>
13749	<param name="position" type="unsigned long" dir="in">
13750	<desc>Position to insert the filter to.</desc>
13751	</param>
13752	<param name="filter" type="IUSBDeviceFilter" dir="in">
13753	<desc>USB device filter to insert.</desc>
13754	</param>
13755	</method>
13756
13757	<method name="removeDeviceFilter">
13758	<desc>
13759	Removes a USB device filter from the specified position in the
13760	list of filters.
13761
13762	Positions are numbered starting from <tt>0</tt>. Specifying a
13763	position equal to or greater than the number of elements in
13764	the list will produce an error.
13765
13766	<see><link to="#deviceFilters"/></see>
13767
13768	<result name="VBOX_E_INVALID_VM_STATE">
13769	Virtual machine is not mutable.
13770	</result>
13771	<result name="E_INVALIDARG">
13772	USB device filter list empty or invalid @a position.
13773	</result>
13774
13775	</desc>
13776	<param name="position" type="unsigned long" dir="in">
13777	<desc>Position to remove the filter from.</desc>
13778	</param>
13779	<param name="filter" type="IUSBDeviceFilter" dir="return">
13780	<desc>Removed USB device filter.</desc>
13781	</param>
13782	</method>
13783
13784	</interface>
13785
13786
13787	<!--
13788	// IUSBDevice
13789	/////////////////////////////////////////////////////////////////////////
13790	-->
13791
13792	<interface
13793	name="IUSBDevice" extends="$unknown"
13794	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13795	wsmap="managed"
13796	>
13797	<desc>
13798	The IUSBDevice interface represents a virtual USB device attached to the
13799	virtual machine.
13800
13801	A collection of objects implementing this interface is stored in the
13802	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13803	attached to a running virtual machine's USB controller.
13804	</desc>
13805
13806	<attribute name="id" type="uuid" mod="string" readonly="yes">
13807	<desc>
13808	Unique USB device ID. This ID is built from #vendorId,
13809	#productId, #revision and #serialNumber.
13810	</desc>
13811	</attribute>
13812
13813	<attribute name="vendorId" type="unsigned short" readonly="yes">
13814	<desc>Vendor ID.</desc>
13815	</attribute>
13816
13817	<attribute name="productId" type="unsigned short" readonly="yes">
13818	<desc>Product ID.</desc>
13819	</attribute>
13820
13821	<attribute name="revision" type="unsigned short" readonly="yes">
13822	<desc>
13823	Product revision number. This is a packed BCD represented as
13824	unsigned short. The high byte is the integer part and the low
13825	byte is the decimal.
13826	</desc>
13827	</attribute>
13828
13829	<attribute name="manufacturer" type="wstring" readonly="yes">
13830	<desc>Manufacturer string.</desc>
13831	</attribute>
13832
13833	<attribute name="product" type="wstring" readonly="yes">
13834	<desc>Product string.</desc>
13835	</attribute>
13836
13837	<attribute name="serialNumber" type="wstring" readonly="yes">
13838	<desc>Serial number string.</desc>
13839	</attribute>
13840
13841	<attribute name="address" type="wstring" readonly="yes">
13842	<desc>Host specific address of the device.</desc>
13843	</attribute>
13844
13845	<attribute name="port" type="unsigned short" readonly="yes">
13846	<desc>
13847	Host USB port number the device is physically
13848	connected to.
13849	</desc>
13850	</attribute>
13851
13852	<attribute name="version" type="unsigned short" readonly="yes">
13853	<desc>
13854	The major USB version of the device - 1 or 2.
13855	</desc>
13856	</attribute>
13857
13858	<attribute name="portVersion" type="unsigned short" readonly="yes">
13859	<desc>
13860	The major USB version of the host USB port the device is
13861	physically connected to - 1 or 2. For devices not connected to
13862	anything this will have the same value as the version attribute.
13863	</desc>
13864	</attribute>
13865
13866	<attribute name="remote" type="boolean" readonly="yes">
13867	<desc>
13868	Whether the device is physically connected to a remote VRDE
13869	client or to a local host machine.
13870	</desc>
13871	</attribute>
13872
13873	</interface>
13874
13875
13876	<!--
13877	// IUSBDeviceFilter
13878	/////////////////////////////////////////////////////////////////////////
13879	-->
13880
13881	<interface
13882	name="IUSBDeviceFilter" extends="$unknown"
13883	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
13884	wsmap="managed"
13885	>
13886	<desc>
13887	The IUSBDeviceFilter interface represents an USB device filter used
13888	to perform actions on a group of USB devices.
13889
13890	This type of filters is used by running virtual machines to
13891	automatically capture selected USB devices once they are physically
13892	attached to the host computer.
13893
13894	A USB device is matched to the given device filter if and only if all
13895	attributes of the device match the corresponding attributes of the
13896	filter (that is, attributes are joined together using the logical AND
13897	operation). On the other hand, all together, filters in the list of
13898	filters carry the semantics of the logical OR operation. So if it is
13899	desirable to create a match like "this vendor id OR this product id",
13900	one needs to create two filters and specify "any match" (see below)
13901	for unused attributes.
13902
13903	All filter attributes used for matching are strings. Each string
13904	is an expression representing a set of values of the corresponding
13905	device attribute, that will match the given filter. Currently, the
13906	following filtering expressions are supported:
13907
13908	<ul>
13909	<li><i>Interval filters</i>. Used to specify valid intervals for
13910	integer device attributes (Vendor ID, Product ID and Revision).
13911	The format of the string is:
13912
13913	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
13914
13915	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
13916	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
13917	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
13918	is omitted before a dash (<tt>-</tt>), the minimum possible integer
13919	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
13920	possible integer is assumed.
13921	</li>
13922	<li><i>Boolean filters</i>. Used to specify acceptable values for
13923	boolean device attributes. The format of the string is:
13924
13925	<tt>true\|false\|yes\|no\|0\|1</tt>
13926
13927	</li>
13928	<li><i>Exact match</i>. Used to specify a single value for the given
13929	device attribute. Any string that doesn't start with <tt>int:</tt>
13930	represents the exact match. String device attributes are compared to
13931	this string including case of symbols. Integer attributes are first
13932	converted to a string (see individual filter attributes) and then
13933	compared ignoring case.
13934
13935	</li>
13936	<li><i>Any match</i>. Any value of the corresponding device attribute
13937	will match the given filter. An empty or @c null string is
13938	used to construct this type of filtering expressions.
13939
13940	</li>
13941	</ul>
13942
13943	<note>
13944	On the Windows host platform, interval filters are not currently
13945	available. Also all string filter attributes
13946	(<link to="#manufacturer"/>, <link to="#product"/>,
13947	<link to="#serialNumber"/>) are ignored, so they behave as
13948	<i>any match</i> no matter what string expression is specified.
13949	</note>
13950
13951	<see><link to="IUSBController::deviceFilters"/>,
13952	<link to="IHostUSBDeviceFilter"/></see>
13953	</desc>
13954
13955	<attribute name="name" type="wstring">
13956	<desc>
13957	Visible name for this filter.
13958	This name is used to visually distinguish one filter from another,
13959	so it can neither be @c null nor an empty string.
13960	</desc>
13961	</attribute>
13962
13963	<attribute name="active" type="boolean">
13964	<desc>Whether this filter active or has been temporarily disabled.</desc>
13965	</attribute>
13966
13967	<attribute name="vendorId" type="wstring">
13968	<desc>
13969	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
13970	The string representation for the <i>exact matching</i>
13971	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
13972	(including leading zeroes).
13973	</desc>
13974	</attribute>
13975
13976	<attribute name="productId" type="wstring">
13977	<desc>
13978	<link to="IUSBDevice::productId">Product ID</link> filter.
13979	The string representation for the <i>exact matching</i>
13980	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
13981	(including leading zeroes).
13982	</desc>
13983	</attribute>
13984
13985	<attribute name="revision" type="wstring">
13986	<desc>
13987	<link to="IUSBDevice::productId">Product revision number</link>
13988	filter. The string representation for the <i>exact matching</i>
13989	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
13990	of the integer part of the revision, and <tt>F</tt> is the
13991	decimal digit of its fractional part (including leading and
13992	trailing zeros).
13993	Note that for interval filters, it's best to use the hexadecimal
13994	form, because the revision is stored as a 16 bit packed BCD value;
13995	so the expression <tt>int:0x0100-0x0199</tt> will match any
13996	revision from <tt>1.0</tt> to <tt>1.99</tt>.
13997	</desc>
13998	</attribute>
13999
14000	<attribute name="manufacturer" type="wstring">
14001	<desc>
14002	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14003	</desc>
14004	</attribute>
14005
14006	<attribute name="product" type="wstring">
14007	<desc>
14008	<link to="IUSBDevice::product">Product</link> filter.
14009	</desc>
14010	</attribute>
14011
14012	<attribute name="serialNumber" type="wstring">
14013	<desc>
14014	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14015	</desc>
14016	</attribute>
14017
14018	<attribute name="port" type="wstring">
14019	<desc>
14020	<link to="IUSBDevice::port">Host USB port</link> filter.
14021	</desc>
14022	</attribute>
14023
14024	<attribute name="remote" type="wstring">
14025	<desc>
14026	<link to="IUSBDevice::remote">Remote state</link> filter.
14027	<note>
14028	This filter makes sense only for machine USB filters,
14029	i.e. it is ignored by IHostUSBDeviceFilter objects.
14030	</note>
14031	</desc>
14032	</attribute>
14033
14034	<attribute name="maskedInterfaces" type="unsigned long">
14035	<desc>
14036	This is an advanced option for hiding one or more USB interfaces
14037	from the guest. The value is a bit mask where the bits that are set
14038	means the corresponding USB interface should be hidden, masked off
14039	if you like.
14040	This feature only works on Linux hosts.
14041	</desc>
14042	</attribute>
14043
14044	</interface>
14045
14046
14047	<!--
14048	// IHostUSBDevice
14049	/////////////////////////////////////////////////////////////////////////
14050	-->
14051
14052	<enum
14053	name="USBDeviceState"
14054	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14055	>
14056	<desc>
14057	USB device state. This enumeration represents all possible states
14058	of the USB device physically attached to the host computer regarding
14059	its state on the host computer and availability to guest computers
14060	(all currently running virtual machines).
14061
14062	Once a supported USB device is attached to the host, global USB
14063	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14064	either ignore the device, or put it to USBDeviceState_Held state, or do
14065	nothing. Unless the device is ignored by global filters, filters of all
14066	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14067	activated that can put it to USBDeviceState_Captured state.
14068
14069	If the device was ignored by global filters, or didn't match
14070	any filters at all (including guest ones), it is handled by the host
14071	in a normal way. In this case, the device state is determined by
14072	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14073	or USBDeviceState_Available, depending on the current device usage.
14074
14075	Besides auto-capturing based on filters, the device can be manually
14076	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14077	state is USBDeviceState_Busy, USBDeviceState_Available or
14078	USBDeviceState_Held.
14079
14080	<note>
14081	Due to differences in USB stack implementations in Linux and Win32,
14082	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14083	only to the Linux version of the product. This also means that (<link
14084	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14085	device state is USBDeviceState_Held.
14086	</note>
14087
14088	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14089	</desc>
14090
14091	<const name="NotSupported" value="0">
14092	<desc>
14093	Not supported by the VirtualBox server, not available to guests.
14094	</desc>
14095	</const>
14096	<const name="Unavailable" value="1">
14097	<desc>
14098	Being used by the host computer exclusively,
14099	not available to guests.
14100	</desc>
14101	</const>
14102	<const name="Busy" value="2">
14103	<desc>
14104	Being used by the host computer, potentially available to guests.
14105	</desc>
14106	</const>
14107	<const name="Available" value="3">
14108	<desc>
14109	Not used by the host computer, available to guests (the host computer
14110	can also start using the device at any time).
14111	</desc>
14112	</const>
14113	<const name="Held" value="4">
14114	<desc>
14115	Held by the VirtualBox server (ignored by the host computer),
14116	available to guests.
14117	</desc>
14118	</const>
14119	<const name="Captured" value="5">
14120	<desc>
14121	Captured by one of the guest computers, not available
14122	to anybody else.
14123	</desc>
14124	</const>
14125	</enum>
14126
14127	<interface
14128	name="IHostUSBDevice" extends="IUSBDevice"
14129	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14130	wsmap="managed"
14131	>
14132	<desc>
14133	The IHostUSBDevice interface represents a physical USB device attached
14134	to the host computer.
14135
14136	Besides properties inherited from IUSBDevice, this interface adds the
14137	<link to="#state"/> property that holds the current state of the USB
14138	device.
14139
14140	<see><link to="IHost::USBDevices"/>,
14141	<link to="IHost::USBDeviceFilters"/></see>
14142	</desc>
14143
14144	<attribute name="state" type="USBDeviceState" readonly="yes">
14145	<desc>
14146	Current state of the device.
14147	</desc>
14148	</attribute>
14149
14150	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14151
14152	</interface>
14153
14154
14155	<!--
14156	// IHostUSBDeviceFilter
14157	/////////////////////////////////////////////////////////////////////////
14158	-->
14159
14160	<enum
14161	name="USBDeviceFilterAction"
14162	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14163	>
14164	<desc>
14165	Actions for host USB device filters.
14166	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14167	</desc>
14168
14169	<const name="Null" value="0">
14170	<desc>Null value (never used by the API).</desc>
14171	</const>
14172	<const name="Ignore" value="1">
14173	<desc>Ignore the matched USB device.</desc>
14174	</const>
14175	<const name="Hold" value="2">
14176	<desc>Hold the matched USB device.</desc>
14177	</const>
14178	</enum>
14179
14180	<interface
14181	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14182	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14183	wsmap="managed"
14184	>
14185	<desc>
14186	The IHostUSBDeviceFilter interface represents a global filter for a
14187	physical USB device used by the host computer. Used indirectly in
14188	<link to="IHost::USBDeviceFilters"/>.
14189
14190	Using filters of this type, the host computer determines the initial
14191	state of the USB device after it is physically attached to the
14192	host's USB controller.
14193
14194	<note>
14195	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14196	filters, because it makes sense only for
14197	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14198	</note>
14199
14200	<see><link to="IHost::USBDeviceFilters"/></see>
14201	</desc>
14202
14203	<attribute name="action" type="USBDeviceFilterAction">
14204	<desc>
14205	Action performed by the host when an attached USB device
14206	matches this filter.
14207	</desc>
14208	</attribute>
14209
14210	</interface>
14211
14212	<!--
14213	// IAudioAdapter
14214	/////////////////////////////////////////////////////////////////////////
14215	-->
14216
14217	<enum
14218	name="AudioDriverType"
14219	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14220	>
14221	<desc>
14222	Host audio driver type.
14223	</desc>
14224
14225	<const name="Null" value="0">
14226	<desc>Null value, also means "dummy audio driver".</desc>
14227	</const>
14228	<const name="WinMM" value="1">
14229	<desc>Windows multimedia (Windows hosts only).</desc>
14230	</const>
14231	<const name="OSS" value="2">
14232	<desc>Open Sound System (Linux hosts only).</desc>
14233	</const>
14234	<const name="ALSA" value="3">
14235	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14236	</const>
14237	<const name="DirectSound" value="4">
14238	<desc>DirectSound (Windows hosts only).</desc>
14239	</const>
14240	<const name="CoreAudio" value="5">
14241	<desc>CoreAudio (Mac hosts only).</desc>
14242	</const>
14243	<const name="MMPM" value="6">
14244	<desc>Reserved for historical reasons.</desc>
14245	</const>
14246	<const name="Pulse" value="7">
14247	<desc>PulseAudio (Linux hosts only).</desc>
14248	</const>
14249	<const name="SolAudio" value="8">
14250	<desc>Solaris audio (Solaris hosts only).</desc>
14251	</const>
14252	</enum>
14253
14254	<enum
14255	name="AudioControllerType"
14256	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14257	>
14258	<desc>
14259	Virtual audio controller type.
14260	</desc>
14261
14262	<const name="AC97" value="0"/>
14263	<const name="SB16" value="1"/>
14264	<const name="HDA" value="2"/>
14265	</enum>
14266
14267	<interface
14268	name="IAudioAdapter" extends="$unknown"
14269	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14270	wsmap="managed"
14271	>
14272	<desc>
14273	The IAudioAdapter interface represents the virtual audio adapter of
14274	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14275	</desc>
14276	<attribute name="enabled" type="boolean">
14277	<desc>
14278	Flag whether the audio adapter is present in the
14279	guest system. If disabled, the virtual guest hardware will
14280	not contain any audio adapter. Can only be changed when
14281	the VM is not running.
14282	</desc>
14283	</attribute>
14284	<attribute name="audioController" type="AudioControllerType">
14285	<desc>
14286	The audio hardware we emulate.
14287	</desc>
14288	</attribute>
14289	<attribute name="audioDriver" type="AudioDriverType">
14290	<desc>
14291	Audio driver the adapter is connected to. This setting
14292	can only be changed when the VM is not running.
14293	</desc>
14294	</attribute>
14295	</interface>
14296
14297	<enum
14298	name="AuthType"
14299	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14300	>
14301	<desc>
14302	VirtualBox authentication type.
14303	</desc>
14304
14305	<const name="Null" value="0">
14306	<desc>Null value, also means "no authentication".</desc>
14307	</const>
14308	<const name="External" value="1"/>
14309	<const name="Guest" value="2"/>
14310	</enum>
14311
14312	<!--
14313	// IVRDEServer
14314	/////////////////////////////////////////////////////////////////////////
14315	-->
14316
14317	<interface
14318	name="IVRDEServer" extends="$unknown"
14319	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14320	wsmap="managed"
14321	>
14322	<attribute name="enabled" type="boolean">
14323	<desc>VRDE server status.</desc>
14324	</attribute>
14325
14326	<attribute name="authType" type="AuthType">
14327	<desc>VRDE authentication method.</desc>
14328	</attribute>
14329
14330	<attribute name="authTimeout" type="unsigned long">
14331	<desc>Timeout for guest authentication. Milliseconds.</desc>
14332	</attribute>
14333
14334	<attribute name="allowMultiConnection" type="boolean">
14335	<desc>
14336	Flag whether multiple simultaneous connections to the VM are permitted.
14337	Note that this will be replaced by a more powerful mechanism in the future.
14338	</desc>
14339	</attribute>
14340
14341	<attribute name="reuseSingleConnection" type="boolean">
14342	<desc>
14343	Flag whether the existing connection must be dropped and a new connection
14344	must be established by the VRDE server, when a new client connects in single
14345	connection mode.
14346	</desc>
14347	</attribute>
14348
14349	<attribute name="VRDEExtPack" type="wstring">
14350	<desc>
14351	The name of Extension Pack providing VRDE for this VM. Overrides
14352	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14353	</desc>
14354	</attribute>
14355
14356	<attribute name="authLibrary" type="wstring">
14357	<desc>
14358	Library used for authentication of RDP clients by this VM. Overrides
14359	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14360	</desc>
14361	</attribute>
14362
14363	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14364	<desc>
14365	Array of names of properties, which are supported by this VRDE server.
14366	</desc>
14367	</attribute>
14368
14369	<method name="setVRDEProperty">
14370	<desc>
14371	Sets a VRDE specific property string.
14372
14373	If you pass @c null or empty string as a key @a value, the given @a key
14374	will be deleted.
14375
14376	</desc>
14377	<param name="key" type="wstring" dir="in">
14378	<desc>Name of the key to set.</desc>
14379	</param>
14380	<param name="value" type="wstring" dir="in">
14381	<desc>Value to assign to the key.</desc>
14382	</param>
14383	</method>
14384
14385	<method name="getVRDEProperty" const="yes">
14386	<desc>
14387	Returns a VRDE specific property string.
14388
14389	If the requested data @a key does not exist, this function will
14390	succeed and return an empty string in the @a value argument.
14391
14392	</desc>
14393	<param name="key" type="wstring" dir="in">
14394	<desc>Name of the key to get.</desc>
14395	</param>
14396	<param name="value" type="wstring" dir="return">
14397	<desc>Value of the requested key.</desc>
14398	</param>
14399	</method>
14400
14401	</interface>
14402
14403
14404	<!--
14405	// ISharedFolder
14406	/////////////////////////////////////////////////////////////////////////
14407	-->
14408
14409	<interface
14410	name="ISharedFolder" extends="$unknown"
14411	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14412	wsmap="struct"
14413	>
14414	<desc>
14415	The ISharedFolder interface represents a folder in the host computer's
14416	file system accessible from the guest OS running inside a virtual
14417	machine using an associated logical name.
14418
14419	There are three types of shared folders:
14420	<ul>
14421	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14422	folders available to all virtual machines.</li>
14423	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14424	VM-specific shared folders available to the given virtual machine at
14425	startup.</li>
14426	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14427	VM-specific shared folders created in the session context (for
14428	example, when the virtual machine is running) and automatically
14429	discarded when the session is closed (the VM is powered off).</li>
14430	</ul>
14431
14432	Logical names of shared folders must be unique within the given scope
14433	(global, permanent or transient). However, they do not need to be unique
14434	across scopes. In this case, the definition of the shared folder in a
14435	more specific scope takes precedence over definitions in all other
14436	scopes. The order of precedence is (more specific to more general):
14437	<ol>
14438	<li>Transient definitions</li>
14439	<li>Permanent definitions</li>
14440	<li>Global definitions</li>
14441	</ol>
14442
14443	For example, if MyMachine has a shared folder named
14444	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14445	transient shared folder named <tt>C_DRIVE</tt> (that points
14446	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14447	of <tt>C_DRIVE</tt> in the guest OS so
14448	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14449	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14450	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14451	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14452	to <tt>C:\\</tt> if it still exists.
14453
14454	Note that permanent and transient shared folders of different machines
14455	are in different name spaces, so they don't overlap and don't need to
14456	have unique logical names.
14457
14458	<note>
14459	Global shared folders are not implemented in the current version of the
14460	product.
14461	</note>
14462	</desc>
14463
14464	<attribute name="name" type="wstring" readonly="yes">
14465	<desc>Logical name of the shared folder.</desc>
14466	</attribute>
14467
14468	<attribute name="hostPath" type="wstring" readonly="yes">
14469	<desc>Full path to the shared folder in the host file system.</desc>
14470	</attribute>
14471
14472	<attribute name="accessible" type="boolean" readonly="yes">
14473	<desc>
14474	Whether the folder defined by the host path is currently
14475	accessible or not.
14476	For example, the folder can be inaccessible if it is placed
14477	on the network share that is not available by the time
14478	this property is read.
14479	</desc>
14480	</attribute>
14481
14482	<attribute name="writable" type="boolean" readonly="yes">
14483	<desc>
14484	Whether the folder defined by the host path is writable or
14485	not.
14486	</desc>
14487	</attribute>
14488
14489	<attribute name="autoMount" type="boolean" readonly="yes">
14490	<desc>
14491	Whether the folder gets automatically mounted by the guest or not.
14492	</desc>
14493	</attribute>
14494
14495	<attribute name="lastAccessError" type="wstring" readonly="yes">
14496	<desc>
14497	Text message that represents the result of the last accessibility
14498	check.
14499
14500	Accessibility checks are performed each time the <link to="#accessible"/>
14501	attribute is read. An empty string is returned if the last
14502	accessibility check was successful. A non-empty string indicates a
14503	failure and should normally describe a reason of the failure (for
14504	example, a file read error).
14505	</desc>
14506	</attribute>
14507
14508	</interface>
14509
14510	<!--
14511	// ISession
14512	/////////////////////////////////////////////////////////////////////////
14513	-->
14514
14515	<interface
14516	name="IInternalSessionControl" extends="$unknown"
14517	uuid="0bdda5da-67c8-47be-a610-b83a7fa3e8b6"
14518	internal="yes"
14519	wsmap="suppress"
14520	>
14521	<method name="getPID">
14522	<desc>PID of the process that has created this Session object.
14523	</desc>
14524	<param name="pid" type="unsigned long" dir="return"/>
14525	</method>
14526
14527	<method name="getRemoteConsole">
14528	<desc>
14529	Returns the console object suitable for remote control.
14530
14531	<result name="VBOX_E_INVALID_VM_STATE">
14532	Session state prevents operation.
14533	</result>
14534	<result name="VBOX_E_INVALID_OBJECT_STATE">
14535	Session type prevents operation.
14536	</result>
14537
14538	</desc>
14539	<param name="console" type="IConsole" dir="return"/>
14540	</method>
14541
14542	<method name="assignMachine">
14543	<desc>
14544	Assigns the machine object associated with this direct-type
14545	session or informs the session that it will be a remote one
14546	(if @a machine == @c null).
14547
14548	<result name="VBOX_E_INVALID_VM_STATE">
14549	Session state prevents operation.
14550	</result>
14551	<result name="VBOX_E_INVALID_OBJECT_STATE">
14552	Session type prevents operation.
14553	</result>
14554
14555	</desc>
14556	<param name="machine" type="IMachine" dir="in"/>
14557	</method>
14558
14559	<method name="assignRemoteMachine">
14560	<desc>
14561	Assigns the machine and the (remote) console object associated with
14562	this remote-type session.
14563
14564	<result name="VBOX_E_INVALID_VM_STATE">
14565	Session state prevents operation.
14566	</result>
14567
14568	</desc>
14569	<param name="machine" type="IMachine" dir="in"/>
14570	<param name="console" type="IConsole" dir="in"/>
14571	</method>
14572
14573	<method name="updateMachineState">
14574	<desc>
14575	Updates the machine state in the VM process.
14576	Must be called only in certain cases
14577	(see the method implementation).
14578
14579	<result name="VBOX_E_INVALID_VM_STATE">
14580	Session state prevents operation.
14581	</result>
14582	<result name="VBOX_E_INVALID_OBJECT_STATE">
14583	Session type prevents operation.
14584	</result>
14585
14586	</desc>
14587	<param name="aMachineState" type="MachineState" dir="in"/>
14588	</method>
14589
14590	<method name="uninitialize">
14591	<desc>
14592	Uninitializes (closes) this session. Used by VirtualBox to close
14593	the corresponding remote session when the direct session dies
14594	or gets closed.
14595
14596	<result name="VBOX_E_INVALID_VM_STATE">
14597	Session state prevents operation.
14598	</result>
14599
14600	</desc>
14601	</method>
14602
14603	<method name="onNetworkAdapterChange">
14604	<desc>
14605	Triggered when settings of a network adapter of the
14606	associated virtual machine have changed.
14607
14608	<result name="VBOX_E_INVALID_VM_STATE">
14609	Session state prevents operation.
14610	</result>
14611	<result name="VBOX_E_INVALID_OBJECT_STATE">
14612	Session type prevents operation.
14613	</result>
14614
14615	</desc>
14616	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14617	<param name="changeAdapter" type="boolean" dir="in"/>
14618	</method>
14619
14620	<method name="onSerialPortChange">
14621	<desc>
14622	Triggered when settings of a serial port of the
14623	associated virtual machine have changed.
14624
14625	<result name="VBOX_E_INVALID_VM_STATE">
14626	Session state prevents operation.
14627	</result>
14628	<result name="VBOX_E_INVALID_OBJECT_STATE">
14629	Session type prevents operation.
14630	</result>
14631
14632	</desc>
14633	<param name="serialPort" type="ISerialPort" dir="in"/>
14634	</method>
14635
14636	<method name="onParallelPortChange">
14637	<desc>
14638	Triggered when settings of a parallel port of the
14639	associated virtual machine have changed.
14640
14641	<result name="VBOX_E_INVALID_VM_STATE">
14642	Session state prevents operation.
14643	</result>
14644	<result name="VBOX_E_INVALID_OBJECT_STATE">
14645	Session type prevents operation.
14646	</result>
14647
14648	</desc>
14649	<param name="parallelPort" type="IParallelPort" dir="in"/>
14650	</method>
14651
14652	<method name="onStorageControllerChange">
14653	<desc>
14654	Triggered when settings of a storage controller of the
14655	associated virtual machine have changed.
14656
14657	<result name="VBOX_E_INVALID_VM_STATE">
14658	Session state prevents operation.
14659	</result>
14660	<result name="VBOX_E_INVALID_OBJECT_STATE">
14661	Session type prevents operation.
14662	</result>
14663
14664	</desc>
14665	</method>
14666
14667	<method name="onMediumChange">
14668	<desc>
14669	Triggered when attached media of the
14670	associated virtual machine have changed.
14671
14672	<result name="VBOX_E_INVALID_VM_STATE">
14673	Session state prevents operation.
14674	</result>
14675	<result name="VBOX_E_INVALID_OBJECT_STATE">
14676	Session type prevents operation.
14677	</result>
14678
14679	</desc>
14680
14681	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14682	<desc>The medium attachment which changed.</desc>
14683	</param>
14684	<param name="force" type="boolean" dir="in">
14685	<desc>If the medium change was forced.</desc>
14686	</param>
14687	</method>
14688
14689	<method name="onStorageDeviceChange">
14690	<desc>
14691	Triggered when attached storage devices of the
14692	associated virtual machine have changed.
14693
14694	<result name="VBOX_E_INVALID_VM_STATE">
14695	Session state prevents operation.
14696	</result>
14697	<result name="VBOX_E_INVALID_OBJECT_STATE">
14698	Session type prevents operation.
14699	</result>
14700
14701	</desc>
14702
14703	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14704	<desc>The medium attachment which changed.</desc>
14705	</param>
14706	<param name="remove" type="boolean" dir="in">
14707	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14708	</param>
14709	</method>
14710
14711	<method name="onCPUChange">
14712	<desc>
14713	Notification when a CPU changes.
14714	</desc>
14715	<param name="cpu" type="unsigned long" dir="in">
14716	<desc>The CPU which changed</desc>
14717	</param>
14718	<param name="add" type="boolean" dir="in">
14719	<desc>Flag whether the CPU was added or removed</desc>
14720	</param>
14721	</method>
14722
14723	<method name="onCPUExecutionCapChange">
14724	<desc>
14725	Notification when the CPU execution cap changes.
14726	</desc>
14727	<param name="executionCap" type="unsigned long" dir="in">
14728	<desc>The new CPU execution cap value. (1-100)</desc>
14729	</param>
14730	</method>
14731
14732	<method name="onVRDEServerChange">
14733	<desc>
14734	Triggered when settings of the VRDE server object of the
14735	associated virtual machine have changed.
14736
14737	<result name="VBOX_E_INVALID_VM_STATE">
14738	Session state prevents operation.
14739	</result>
14740	<result name="VBOX_E_INVALID_OBJECT_STATE">
14741	Session type prevents operation.
14742	</result>
14743
14744	</desc>
14745	<param name="restart" type="boolean" dir="in">
14746	<desc>Flag whether the server must be restarted</desc>
14747	</param>
14748	</method>
14749
14750	<method name="onUSBControllerChange">
14751	<desc>
14752	Triggered when settings of the USB controller object of the
14753	associated virtual machine have changed.
14754
14755	<result name="VBOX_E_INVALID_VM_STATE">
14756	Session state prevents operation.
14757	</result>
14758	<result name="VBOX_E_INVALID_OBJECT_STATE">
14759	Session type prevents operation.
14760	</result>
14761
14762	</desc>
14763	</method>
14764
14765	<method name="onSharedFolderChange">
14766	<desc>
14767	Triggered when a permanent (global or machine) shared folder has been
14768	created or removed.
14769	<note>
14770	We don't pass shared folder parameters in this notification because
14771	the order in which parallel notifications are delivered is not defined,
14772	therefore it could happen that these parameters were outdated by the
14773	time of processing this notification.
14774	</note>
14775
14776	<result name="VBOX_E_INVALID_VM_STATE">
14777	Session state prevents operation.
14778	</result>
14779	<result name="VBOX_E_INVALID_OBJECT_STATE">
14780	Session type prevents operation.
14781	</result>
14782
14783	</desc>
14784	<param name="global" type="boolean" dir="in"/>
14785	</method>
14786
14787	<method name="onUSBDeviceAttach">
14788	<desc>
14789	Triggered when a request to capture a USB device (as a result
14790	of matched USB filters or direct call to
14791	<link to="IConsole::attachUSBDevice"/>) has completed.
14792	A @c null @a error object means success, otherwise it
14793	describes a failure.
14794
14795	<result name="VBOX_E_INVALID_VM_STATE">
14796	Session state prevents operation.
14797	</result>
14798	<result name="VBOX_E_INVALID_OBJECT_STATE">
14799	Session type prevents operation.
14800	</result>
14801
14802	</desc>
14803	<param name="device" type="IUSBDevice" dir="in"/>
14804	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14805	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14806	</method>
14807
14808	<method name="onUSBDeviceDetach">
14809	<desc>
14810	Triggered when a request to release the USB device (as a result
14811	of machine termination or direct call to
14812	<link to="IConsole::detachUSBDevice"/>) has completed.
14813	A @c null @a error object means success, otherwise it
14814	describes a failure.
14815
14816	<result name="VBOX_E_INVALID_VM_STATE">
14817	Session state prevents operation.
14818	</result>
14819	<result name="VBOX_E_INVALID_OBJECT_STATE">
14820	Session type prevents operation.
14821	</result>
14822
14823	</desc>
14824	<param name="id" type="uuid" mod="string" dir="in"/>
14825	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14826	</method>
14827
14828	<method name="onShowWindow">
14829	<desc>
14830	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14831	<link to="IMachine::showConsoleWindow"/> in order to notify
14832	console listeners
14833	<link to="ICanShowWindowEvent"/>
14834	and <link to="IShowWindowEvent"/>.
14835
14836	<result name="VBOX_E_INVALID_OBJECT_STATE">
14837	Session type prevents operation.
14838	</result>
14839
14840	</desc>
14841	<param name="check" type="boolean" dir="in"/>
14842	<param name="canShow" type="boolean" dir="out"/>
14843	<param name="winId" type="long long" dir="out"/>
14844	</method>
14845
14846	<method name="onBandwidthGroupChange">
14847	<desc>
14848	Notification when one of the bandwidth groups change.
14849	</desc>
14850	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
14851	<desc>The bandwidth group which changed.</desc>
14852	</param>
14853	</method>
14854
14855	<method name="accessGuestProperty">
14856	<desc>
14857	Called by <link to="IMachine::getGuestProperty"/> and by
14858	<link to="IMachine::setGuestProperty"/> in order to read and
14859	modify guest properties.
14860
14861	<result name="VBOX_E_INVALID_VM_STATE">
14862	Machine session is not open.
14863	</result>
14864	<result name="VBOX_E_INVALID_OBJECT_STATE">
14865	Session type is not direct.
14866	</result>
14867
14868	</desc>
14869	<param name="name" type="wstring" dir="in"/>
14870	<param name="value" type="wstring" dir="in"/>
14871	<param name="flags" type="wstring" dir="in"/>
14872	<param name="isSetter" type="boolean" dir="in"/>
14873	<param name="retValue" type="wstring" dir="out"/>
14874	<param name="retTimestamp" type="long long" dir="out"/>
14875	<param name="retFlags" type="wstring" dir="out"/>
14876	</method>
14877
14878	<method name="enumerateGuestProperties" const="yes">
14879	<desc>
14880	Return a list of the guest properties matching a set of patterns along
14881	with their values, time stamps and flags.
14882
14883	<result name="VBOX_E_INVALID_VM_STATE">
14884	Machine session is not open.
14885	</result>
14886	<result name="VBOX_E_INVALID_OBJECT_STATE">
14887	Session type is not direct.
14888	</result>
14889
14890	</desc>
14891	<param name="patterns" type="wstring" dir="in">
14892	<desc>
14893	The patterns to match the properties against as a comma-separated
14894	string. If this is empty, all properties currently set will be
14895	returned.
14896	</desc>
14897	</param>
14898	<param name="key" type="wstring" dir="out" safearray="yes">
14899	<desc>
14900	The key names of the properties returned.
14901	</desc>
14902	</param>
14903	<param name="value" type="wstring" dir="out" safearray="yes">
14904	<desc>
14905	The values of the properties returned. The array entries match the
14906	corresponding entries in the @a key array.
14907	</desc>
14908	</param>
14909	<param name="timestamp" type="long long" dir="out" safearray="yes">
14910	<desc>
14911	The time stamps of the properties returned. The array entries match
14912	the corresponding entries in the @a key array.
14913	</desc>
14914	</param>
14915	<param name="flags" type="wstring" dir="out" safearray="yes">
14916	<desc>
14917	The flags of the properties returned. The array entries match the
14918	corresponding entries in the @a key array.
14919	</desc>
14920	</param>
14921	</method>
14922
14923	<method name="onlineMergeMedium">
14924	<desc>
14925	Triggers online merging of a hard disk. Used internally when deleting
14926	a snapshot while a VM referring to the same hard disk chain is running.
14927
14928	<result name="VBOX_E_INVALID_VM_STATE">
14929	Machine session is not open.
14930	</result>
14931	<result name="VBOX_E_INVALID_OBJECT_STATE">
14932	Session type is not direct.
14933	</result>
14934
14935	</desc>
14936	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14937	<desc>The medium attachment to identify the medium chain.</desc>
14938	</param>
14939	<param name="sourceIdx" type="unsigned long" dir="in">
14940	<desc>The index of the source image in the chain.
14941	Redundant, but drastically reduces IPC.</desc>
14942	</param>
14943	<param name="targetIdx" type="unsigned long" dir="in">
14944	<desc>The index of the target image in the chain.
14945	Redundant, but drastically reduces IPC.</desc>
14946	</param>
14947	<param name="source" type="IMedium" dir="in">
14948	<desc>Merge source medium.</desc>
14949	</param>
14950	<param name="target" type="IMedium" dir="in">
14951	<desc>Merge target medium.</desc>
14952	</param>
14953	<param name="mergeForward" type="boolean" dir="in">
14954	<desc>Merge direction.</desc>
14955	</param>
14956	<param name="parentForTarget" type="IMedium" dir="in">
14957	<desc>For forward merges: new parent for target medium.</desc>
14958	</param>
14959	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
14960	<desc>For backward merges: list of media which need their parent UUID
14961	updated.</desc>
14962	</param>
14963	<param name="progress" type="IProgress" dir="in">
14964	<desc>
14965	Progress object for this operation.
14966	</desc>
14967	</param>
14968	</method>
14969
14970	</interface>
14971
14972	<interface
14973	name="ISession" extends="$unknown"
14974	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
14975	wsmap="managed"
14976	>
14977	<desc>
14978	The ISession interface represents a client process and allows for locking
14979	virtual machines (represented by IMachine objects) to prevent conflicting
14980	changes to the machine.
14981
14982	Any caller wishing to manipulate a virtual machine needs to create a session
14983	object first, which lives in its own process space. Such session objects are
14984	then associated with <link to="IMachine" /> objects living in the VirtualBox
14985	server process to coordinate such changes.
14986
14987	There are two typical scenarios in which sessions are used:
14988
14989	<ul>
14990	<li>To alter machine settings or control a running virtual machine, one
14991	needs to lock a machine for a given session (client process) by calling
14992	<link to="IMachine::lockMachine"/>.
14993
14994	Whereas multiple sessions may control a running virtual machine, only
14995	one process can obtain a write lock on the machine to prevent conflicting
14996	changes. A write lock is also needed if a process wants to actually run a
14997	virtual machine in its own context, such as the VirtualBox GUI or
14998	VBoxHeadless front-ends. They must also lock a machine for their own
14999	sessions before they are allowed to power up the virtual machine.
15000
15001	As a result, no machine settings can be altered while another process is
15002	already using it, either because that process is modifying machine settings
15003	or because the machine is running.
15004	</li>
15005	<li>
15006	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15007	VirtualBox GUI or VBoxHeadless), one would use
15008	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15009	as its first parameter. This session then identifies the caller and lets the
15010	caller control the started machine (for example, pause machine execution or
15011	power it down) as well as be notified about machine execution state changes.
15012	</li>
15013	</ul>
15014
15015	How sessions objects are created in a client process depends on whether you use
15016	the Main API via COM or via the webservice:
15017
15018	<ul>
15019	<li>When using the COM API directly, an object of the Session class from the
15020	VirtualBox type library needs to be created. In regular COM C++ client code,
15021	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15022	This object will then act as a local session object in further calls to open
15023	a session.
15024	</li>
15025
15026	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15027	a session object automatically whenever <link to="IWebsessionManager::logon" />
15028	is called. A managed object reference to that session object can be retrieved by
15029	calling <link to="IWebsessionManager::getSessionObject" />.
15030	</li>
15031	</ul>
15032	</desc>
15033
15034	<attribute name="state" type="SessionState" readonly="yes">
15035	<desc>Current state of this session.</desc>
15036	</attribute>
15037
15038	<attribute name="type" type="SessionType" readonly="yes">
15039	<desc>
15040	Type of this session. The value of this attribute is valid only
15041	if the session currently has a machine locked (i.e. its
15042	<link to="#state" /> is Locked), otherwise an error will be returned.
15043	</desc>
15044	</attribute>
15045
15046	<attribute name="machine" type="IMachine" readonly="yes">
15047	<desc>Machine object associated with this session.</desc>
15048	</attribute>
15049
15050	<attribute name="console" type="IConsole" readonly="yes">
15051	<desc>Console object associated with this session.</desc>
15052	</attribute>
15053
15054	<method name="unlockMachine">
15055	<desc>
15056	Unlocks a machine that was previously locked for the current session.
15057
15058	Calling this method is required every time a machine has been locked
15059	for a particular session using the <link to="IMachine::launchVMProcess" />
15060	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15061	the machine will be set to <link to="MachineState_Aborted" /> on the
15062	server, and changes made to the machine settings will be lost.
15063
15064	Generally, it is recommended to unlock all machines explicitly
15065	before terminating the application (regardless of the reason for
15066	the termination).
15067
15068	<note>
15069	Do not expect the session state (<link to="ISession::state" />
15070	to return to "Unlocked" immediately after you invoke this method,
15071	particularly if you have started a new VM process. The session
15072	state will automatically return to "Unlocked" once the VM is no
15073	longer executing, which can of course take a very long time.
15074	</note>
15075
15076	<result name="E_UNEXPECTED">
15077	Session is not locked.
15078	</result>
15079
15080	</desc>
15081	</method>
15082
15083	</interface>
15084
15085	<!--
15086	// IStorageController
15087	/////////////////////////////////////////////////////////////////////////
15088	-->
15089
15090	<enum
15091	name="StorageBus"
15092	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15093	>
15094	<desc>
15095	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15096	see <link to="IStorageController::bus" />.
15097	</desc>
15098	<const name="Null" value="0">
15099	<desc>@c null value. Never used by the API.</desc>
15100	</const>
15101	<const name="IDE" value="1"/>
15102	<const name="SATA" value="2"/>
15103	<const name="SCSI" value="3"/>
15104	<const name="Floppy" value="4"/>
15105	<const name="SAS" value="5"/>
15106	</enum>
15107
15108	<enum
15109	name="StorageControllerType"
15110	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15111	>
15112	<desc>
15113	The exact variant of storage controller hardware presented
15114	to the guest; see <link to="IStorageController::controllerType" />.
15115	</desc>
15116
15117	<const name="Null" value="0">
15118	<desc>@c null value. Never used by the API.</desc>
15119	</const>
15120	<const name="LsiLogic" value="1">
15121	<desc>A SCSI controller of the LsiLogic variant.</desc>
15122	</const>
15123	<const name="BusLogic" value="2">
15124	<desc>A SCSI controller of the BusLogic variant.</desc>
15125	</const>
15126	<const name="IntelAhci" value="3">
15127	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15128	</const>
15129	<const name="PIIX3" value="4">
15130	<desc>An IDE controller of the PIIX3 variant.</desc>
15131	</const>
15132	<const name="PIIX4" value="5">
15133	<desc>An IDE controller of the PIIX4 variant.</desc>
15134	</const>
15135	<const name="ICH6" value="6">
15136	<desc>An IDE controller of the ICH6 variant.</desc>
15137	</const>
15138	<const name="I82078" value="7">
15139	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15140	</const>
15141	<const name="LsiLogicSas" value="8">
15142	<desc>A variant of the LsiLogic controller using SAS.</desc>
15143	</const>
15144	</enum>
15145
15146	<enum
15147	name="ChipsetType"
15148	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15149	>
15150	<desc>
15151	Type of emulated chipset (mostly southbridge).
15152	</desc>
15153
15154	<const name="Null" value="0">
15155	<desc>@c null value. Never used by the API.</desc>
15156	</const>
15157	<const name="PIIX3" value="1">
15158	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15159	</const>
15160	<const name="ICH9" value="2">
15161	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15162	</const>
15163	</enum>
15164
15165	<interface
15166	name="IStorageController" extends="$unknown"
15167	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15168	wsmap="managed"
15169	>
15170	<desc>
15171	Represents a storage controller that is attached to a virtual machine
15172	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15173	attached to storage controllers in a real computer, virtual drives
15174	(represented by <link to="IMediumAttachment" />) are attached to virtual
15175	storage controllers, represented by this interface.
15176
15177	As opposed to physical hardware, VirtualBox has a very generic concept
15178	of a storage controller, and for purposes of the Main API, all virtual
15179	storage is attached to virtual machines via instances of this interface.
15180	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15181	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15182	is used, certain sub-types may be available and can be selected in
15183	<link to="#controllerType" />.
15184
15185	Depending on these settings, the guest operating system might see
15186	significantly different virtual hardware.
15187	</desc>
15188
15189	<attribute name="name" type="wstring" readonly="yes">
15190	<desc>
15191	Name of the storage controller, as originally specified with
15192	<link to="IMachine::addStorageController" />. This then uniquely
15193	identifies this controller with other method calls such as
15194	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15195	</desc>
15196	</attribute>
15197
15198	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15199	<desc>
15200	Maximum number of devices which can be attached to one port.
15201	</desc>
15202	</attribute>
15203
15204	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15205	<desc>
15206	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15207	</desc>
15208	</attribute>
15209
15210	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15211	<desc>
15212	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15213	</desc>
15214	</attribute>
15215
15216	<attribute name="instance" type="unsigned long">
15217	<desc>
15218	The instance number of the device in the running VM.
15219	</desc>
15220	</attribute>
15221
15222	<attribute name="portCount" type="unsigned long">
15223	<desc>
15224	The number of currently usable ports on the controller.
15225	The minimum and maximum number of ports for one controller are
15226	stored in <link to="IStorageController::minPortCount"/>
15227	and <link to="IStorageController::maxPortCount"/>.
15228	</desc>
15229	</attribute>
15230
15231	<attribute name="bus" type="StorageBus" readonly="yes">
15232	<desc>
15233	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15234	</desc>
15235	</attribute>
15236
15237	<attribute name="controllerType" type="StorageControllerType">
15238	<desc>
15239	The exact variant of storage controller hardware presented
15240	to the guest.
15241	Depending on this value, VirtualBox will provide a different
15242	virtual storage controller hardware to the guest.
15243	For SATA, SAS and floppy controllers, only one variant is
15244	available, but for IDE and SCSI, there are several.
15245
15246	For SCSI controllers, the default type is LsiLogic.
15247	</desc>
15248	</attribute>
15249
15250	<attribute name="useHostIOCache" type="boolean">
15251	<desc>
15252	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15253	caches and use synchronous file APIs on the host. This was the only option in the API before
15254	VirtualBox 3.2 and is still the default for IDE controllers.
15255
15256	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15257	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15258	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15259	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15260	virtual machines are running at the same time to prevent I/O cache related hangs.
15261	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15262	</desc>
15263	</attribute>
15264
15265	<attribute name="bootable" type="boolean" readonly="yes">
15266	<desc>
15267	Returns whether it is possible to boot from disks attached to this controller.
15268	</desc>
15269	</attribute>
15270
15271	<method name="getIDEEmulationPort">
15272	<desc>
15273	Gets the corresponding port number which is emulated as an IDE device.
15274	Works only with SATA controllers.
15275
15276	<result name="E_INVALIDARG">
15277	The @a devicePosition is not in the range 0 to 3.
15278	</result>
15279	<result name="E_NOTIMPL">
15280	The storage controller type is not SATAIntelAhci.
15281	</result>
15282
15283	</desc>
15284	<param name="devicePosition" type="long" dir="in"/>
15285	<param name="portNumber" type="long" dir="return"/>
15286	</method>
15287
15288	<method name="setIDEEmulationPort">
15289	<desc>
15290	Sets the port number which is emulated as an IDE device.
15291	Works only with SATA controllers.
15292
15293	<result name="E_INVALIDARG">
15294	The @a devicePosition is not in the range 0 to 3 or the
15295	@a portNumber is not in the range 0 to 29.
15296	</result>
15297	<result name="E_NOTIMPL">
15298	The storage controller type is not SATAIntelAhci.
15299	</result>
15300
15301	</desc>
15302	<param name="devicePosition" type="long" dir="in"/>
15303	<param name="portNumber" type="long" dir="in"/>
15304	</method>
15305
15306	</interface>
15307
15308	<if target="wsdl">
15309
15310	<!--
15311	// IManagedObjectRef
15312	/////////////////////////////////////////////////////////////////////////
15313	-->
15314
15315	<interface
15316	name="IManagedObjectRef" extends="$unknown"
15317	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15318	internal="yes"
15319	wsmap="managed"
15320	wscpp="hardcoded"
15321	>
15322	<desc>
15323	Managed object reference.
15324
15325	Only within the webservice, a managed object reference (which is really
15326	an opaque number) allows a webservice client to address an object
15327	that lives in the address space of the webservice server.
15328
15329	Behind each managed object reference, there is a COM object that lives
15330	in the webservice server's address space. The COM object is not freed
15331	until the managed object reference is released, either by an explicit
15332	call to <link to="IManagedObjectRef::release" /> or by logging off from
15333	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15334	all objects created during the webservice session.
15335
15336	Whenever a method call of the VirtualBox API returns a COM object, the
15337	webservice representation of that method will instead return a
15338	managed object reference, which can then be used to invoke methods
15339	on that object.
15340	</desc>
15341
15342	<method name="getInterfaceName">
15343	<desc>
15344	Returns the name of the interface that this managed object represents,
15345	for example, "IMachine", as a string.
15346	</desc>
15347	<param name="return" type="wstring" dir="return"/>
15348	</method>
15349
15350	<method name="release">
15351	<desc>
15352	Releases this managed object reference and frees the resources that
15353	were allocated for it in the webservice server process. After calling
15354	this method, the identifier of the reference can no longer be used.
15355	</desc>
15356	</method>
15357
15358	</interface>
15359
15360	<!--
15361	// IWebsessionManager
15362	/////////////////////////////////////////////////////////////////////////
15363	-->
15364
15365	<interface
15366	name="IWebsessionManager" extends="$unknown"
15367	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15368	internal="yes"
15369	wsmap="global"
15370	wscpp="hardcoded"
15371	>
15372	<desc>
15373	Websession manager. This provides essential services
15374	to webservice clients.
15375	</desc>
15376	<method name="logon">
15377	<desc>
15378	Logs a new client onto the webservice and returns a managed object reference to
15379	the IVirtualBox instance, which the client can then use as a basis to further
15380	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15381	interface, in one way or the other.
15382	</desc>
15383	<param name="username" type="wstring" dir="in"/>
15384	<param name="password" type="wstring" dir="in"/>
15385	<param name="return" type="IVirtualBox" dir="return"/>
15386	</method>
15387
15388	<method name="getSessionObject">
15389	<desc>
15390	Returns a managed object reference to the internal ISession object that was created
15391	for this web service session when the client logged on.
15392
15393	<see><link to="ISession"/></see>
15394	</desc>
15395	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15396	<param name="return" type="ISession" dir="return"/>
15397	</method>
15398
15399	<method name="logoff">
15400	<desc>
15401	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
15402	and destroys all resources associated with the session (most importantly, all
15403	managed objects created in the server while the session was active).
15404	</desc>
15405	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15406	</method>
15407
15408	</interface>
15409
15410	</if>
15411
15412	<!--
15413	// IPerformanceCollector & friends
15414	/////////////////////////////////////////////////////////////////////////
15415	-->
15416
15417	<interface
15418	name="IPerformanceMetric" extends="$unknown"
15419	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15420	>
15421	<desc>
15422	The IPerformanceMetric interface represents parameters of the given
15423	performance metric.
15424	</desc>
15425
15426	<attribute name="metricName" type="wstring" readonly="yes">
15427	<desc>
15428	Name of the metric.
15429	</desc>
15430	</attribute>
15431
15432	<attribute name="object" type="$unknown" readonly="yes">
15433	<desc>
15434	Object this metric belongs to.
15435	</desc>
15436	</attribute>
15437
15438	<attribute name="description" type="wstring" readonly="yes">
15439	<desc>
15440	Textual description of the metric.
15441	</desc>
15442	</attribute>
15443
15444	<attribute name="period" type="unsigned long" readonly="yes">
15445	<desc>
15446	Time interval between samples, measured in seconds.
15447	</desc>
15448	</attribute>
15449
15450	<attribute name="count" type="unsigned long" readonly="yes">
15451	<desc>
15452	Number of recent samples retained by the performance collector for this
15453	metric.
15454
15455	When the collected sample count exceeds this number, older samples
15456	are discarded.
15457	</desc>
15458	</attribute>
15459
15460	<attribute name="unit" type="wstring" readonly="yes">
15461	<desc>
15462	Unit of measurement.
15463	</desc>
15464	</attribute>
15465
15466	<attribute name="minimumValue" type="long" readonly="yes">
15467	<desc>
15468	Minimum possible value of this metric.
15469	</desc>
15470	</attribute>
15471
15472	<attribute name="maximumValue" type="long" readonly="yes">
15473	<desc>
15474	Maximum possible value of this metric.
15475	</desc>
15476	</attribute>
15477	</interface>
15478
15479	<interface
15480	name="IPerformanceCollector" extends="$unknown"
15481	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15482	wsmap="managed"
15483	>
15484	<desc>
15485	The IPerformanceCollector interface represents a service that collects
15486	and stores performance metrics data.
15487
15488	Performance metrics are associated with objects of interfaces like IHost
15489	and IMachine. Each object has a distinct set of performance metrics. The
15490	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15491
15492	Metric data is collected at the specified intervals and is retained
15493	internally. The interval and the number of retained samples can be set
15494	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15495	and collection settings are not persistent, they are discarded as soon as
15496	VBoxSVC process terminates. Moreover, metric settings and data associated
15497	with a particular VM only exist while VM is running. They disappear as
15498	soon as VM shuts down. It is not possible to set up metrics for machines
15499	that are powered off. One needs to start VM first, then set up metric
15500	collection parameters.
15501
15502	Metrics are organized hierarchically, with each level separated by a
15503	slash (/) character. Generally, the scheme for metric names is like this:
15504
15505	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15506
15507	"Category/Metric" together form the base metric name. A base metric is
15508	the smallest unit for which a sampling interval and the number of
15509	retained samples can be set. Only base metrics can be enabled and
15510	disabled. All sub-metrics are collected when their base metric is
15511	collected. Collected values for any set of sub-metrics can be queried
15512	with <link to="IPerformanceCollector::queryMetricsData" />.
15513
15514	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15515	category, "Load" metric, "User" submetric, "average" aggregate. An
15516	aggregate function is computed over all retained data. Valid aggregate
15517	functions are:
15518
15519	<ul>
15520	<li>avg -- average</li>
15521	<li>min -- minimum</li>
15522	<li>max -- maximum</li>
15523	</ul>
15524
15525	When setting up metric parameters, querying metric data, enabling or
15526	disabling metrics wildcards can be used in metric names to specify a
15527	subset of metrics. For example, to select all CPU-related metrics
15528	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15529	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15530
15531	The valid names for base metrics are:
15532
15533	<ul>
15534	<li>CPU/Load</li>
15535	<li>CPU/MHz</li>
15536	<li>RAM/Usage</li>
15537	<li>RAM/VMM</li>
15538	</ul>
15539
15540	The general sequence for collecting and retrieving the metrics is:
15541	<ul>
15542	<li>
15543	Obtain an instance of IPerformanceCollector with
15544	<link to="IVirtualBox::performanceCollector" />
15545	</li>
15546	<li>
15547	Allocate and populate an array with references to objects the metrics
15548	will be collected for. Use references to IHost and IMachine objects.
15549	</li>
15550	<li>
15551	Allocate and populate an array with base metric names the data will
15552	be collected for.
15553	</li>
15554	<li>
15555	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15556	the metric data will be collected and stored.
15557	</li>
15558	<li>
15559	Wait for the data to get collected.
15560	</li>
15561	<li>
15562	Allocate and populate an array with references to objects the metric
15563	values will be queried for. You can re-use the object array used for
15564	setting base metrics.
15565	</li>
15566	<li>
15567	Allocate and populate an array with metric names the data will be
15568	collected for. Note that metric names differ from base metric names.
15569	</li>
15570	<li>
15571	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15572	that have been collected so far are returned. Note that the values
15573	are still retained internally and data collection continues.
15574	</li>
15575	</ul>
15576
15577	For an example of usage refer to the following files in VirtualBox SDK:
15578	<ul>
15579	<li>
15580	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15581	</li>
15582	<li>
15583	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15584	</li>
15585	</ul>
15586	</desc>
15587
15588	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15589	<desc>
15590	Array of unique names of metrics.
15591
15592	This array represents all metrics supported by the performance
15593	collector. Individual objects do not necessarily support all of them.
15594	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15595	list of supported metrics for a particular object.
15596	</desc>
15597	</attribute>
15598
15599	<method name="getMetrics">
15600	<desc>
15601	Returns parameters of specified metrics for a set of objects.
15602	<note>
15603	@c Null metrics array means all metrics. @c Null object array means
15604	all existing objects.
15605	</note>
15606	</desc>
15607	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15608	<desc>
15609	Metric name filter. Currently, only a comma-separated list of metrics
15610	is supported.
15611	</desc>
15612	</param>
15613	<param name="objects" type="$unknown" dir="in" safearray="yes">
15614	<desc>
15615	Set of objects to return metric parameters for.
15616	</desc>
15617	</param>
15618	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15619	<desc>
15620	Array of returned metric parameters.
15621	</desc>
15622	</param>
15623	</method>
15624
15625	<method name="setupMetrics">
15626	<desc>
15627	Sets parameters of specified base metrics for a set of objects. Returns
15628	an array of <link to="IPerformanceMetric" /> describing the metrics
15629	have been affected.
15630	<note>
15631	@c Null or empty metric name array means all metrics. @c Null or
15632	empty object array means all existing objects. If metric name array
15633	contains a single element and object array contains many, the single
15634	metric name array element is applied to each object array element to
15635	form metric/object pairs.
15636	</note>
15637	</desc>
15638	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15639	<desc>
15640	Metric name filter. Comma-separated list of metrics with wildcard
15641	support.
15642	</desc>
15643	</param>
15644	<param name="objects" type="$unknown" dir="in" safearray="yes">
15645	<desc>
15646	Set of objects to setup metric parameters for.
15647	</desc>
15648	</param>
15649	<param name="period" type="unsigned long" dir="in">
15650	<desc>
15651	Time interval in seconds between two consecutive samples of
15652	performance data.
15653	</desc>
15654	</param>
15655	<param name="count" type="unsigned long" dir="in">
15656	<desc>
15657	Number of samples to retain in performance data history. Older
15658	samples get discarded.
15659	</desc>
15660	</param>
15661	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15662	<desc>
15663	Array of metrics that have been modified by the call to this method.
15664	</desc>
15665	</param>
15666	</method>
15667
15668	<method name="enableMetrics">
15669	<desc>
15670	Turns on collecting specified base metrics. Returns an array of
15671	<link to="IPerformanceMetric" /> describing the metrics have been
15672	affected.
15673	<note>
15674	@c Null or empty metric name array means all metrics. @c Null or
15675	empty object array means all existing objects. If metric name array
15676	contains a single element and object array contains many, the single
15677	metric name array element is applied to each object array element to
15678	form metric/object pairs.
15679	</note>
15680	</desc>
15681	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15682	<desc>
15683	Metric name filter. Comma-separated list of metrics with wildcard
15684	support.
15685	</desc>
15686	</param>
15687	<param name="objects" type="$unknown" dir="in" safearray="yes">
15688	<desc>
15689	Set of objects to enable metrics for.
15690	</desc>
15691	</param>
15692	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15693	<desc>
15694	Array of metrics that have been modified by the call to this method.
15695	</desc>
15696	</param>
15697	</method>
15698
15699	<method name="disableMetrics">
15700	<desc>
15701	Turns off collecting specified base metrics. Returns an array of
15702	<link to="IPerformanceMetric" /> describing the metrics have been
15703	affected.
15704	<note>
15705	@c Null or empty metric name array means all metrics. @c Null or
15706	empty object array means all existing objects. If metric name array
15707	contains a single element and object array contains many, the single
15708	metric name array element is applied to each object array element to
15709	form metric/object pairs.
15710	</note>
15711	</desc>
15712	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15713	<desc>
15714	Metric name filter. Comma-separated list of metrics with wildcard
15715	support.
15716	</desc>
15717	</param>
15718	<param name="objects" type="$unknown" dir="in" safearray="yes">
15719	<desc>
15720	Set of objects to disable metrics for.
15721	</desc>
15722	</param>
15723	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15724	<desc>
15725	Array of metrics that have been modified by the call to this method.
15726	</desc>
15727	</param>
15728	</method>
15729
15730	<method name="queryMetricsData">
15731	<desc>
15732	Queries collected metrics data for a set of objects.
15733
15734	The data itself and related metric information are returned in seven
15735	parallel and one flattened array of arrays. Elements of
15736	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15737	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15738	the same index describe one set of values corresponding to a single
15739	metric.
15740
15741	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15742	start and length of a sub-array is indicated by
15743	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15744	value for metric <tt>metricNames[i]</tt> is at
15745	<tt>returnData[returnIndices[i]]</tt>.
15746
15747	<note>
15748	@c Null or empty metric name array means all metrics. @c Null or
15749	empty object array means all existing objects. If metric name array
15750	contains a single element and object array contains many, the single
15751	metric name array element is applied to each object array element to
15752	form metric/object pairs.
15753	</note>
15754	<note>
15755	Data collection continues behind the scenes after call to @c
15756	queryMetricsData. The return data can be seen as the snapshot of the
15757	current state at the time of @c queryMetricsData call. The internally
15758	kept metric values are not cleared by the call. This makes possible
15759	querying different subsets of metrics or aggregates with subsequent
15760	calls. If periodic querying is needed it is highly suggested to query
15761	the values with @c interval*count period to avoid confusion. This way
15762	a completely new set of data values will be provided by each query.
15763	</note>
15764	</desc>
15765	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15766	<desc>
15767	Metric name filter. Comma-separated list of metrics with wildcard
15768	support.
15769	</desc>
15770	</param>
15771	<param name="objects" type="$unknown" dir="in" safearray="yes">
15772	<desc>
15773	Set of objects to query metrics for.
15774	</desc>
15775	</param>
15776	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15777	<desc>
15778	Names of metrics returned in @c returnData.
15779	</desc>
15780	</param>
15781	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15782	<desc>
15783	Objects associated with metrics returned in @c returnData.
15784	</desc>
15785	</param>
15786	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15787	<desc>
15788	Units of measurement for each returned metric.
15789	</desc>
15790	</param>
15791	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15792	<desc>
15793	Divisor that should be applied to return values in order to get
15794	floating point values. For example:
15795	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15796	will retrieve the floating point value of i-th sample of the first
15797	metric.
15798	</desc>
15799	</param>
15800	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15801	<desc>
15802	Sequence numbers of the first elements of value sequences of
15803	particular metrics returned in @c returnData. For aggregate metrics
15804	it is the sequence number of the sample the aggregate started
15805	calculation from.
15806	</desc>
15807	</param>
15808	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15809	<desc>
15810	Indices of the first elements of value sequences of particular
15811	metrics returned in @c returnData.
15812	</desc>
15813	</param>
15814	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15815	<desc>
15816	Lengths of value sequences of particular metrics.
15817	</desc>
15818	</param>
15819	<param name="returnData" type="long" dir="return" safearray="yes">
15820	<desc>
15821	Flattened array of all metric data containing sequences of values for
15822	each metric.
15823	</desc>
15824	</param>
15825	</method>
15826
15827	</interface>
15828
15829	<enum
15830	name="NATAliasMode"
15831	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
15832	>
15833	<desc></desc>
15834	<const name="AliasLog" value="0x1">
15835	<desc></desc>
15836	</const>
15837	<const name="AliasProxyOnly" value="0x02">
15838	<desc></desc>
15839	</const>
15840	<const name="AliasUseSamePorts" value="0x04">
15841	<desc></desc>
15842	</const>
15843	</enum>
15844
15845	<enum
15846	name="NATProtocol"
15847	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
15848	>
15849	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
15850	<const name="UDP" value="0">
15851	<desc>Port-forwarding uses UDP protocol.</desc>
15852	</const>
15853	<const name="TCP" value="1">
15854	<desc>Port-forwarding uses TCP protocol.</desc>
15855	</const>
15856	</enum>
15857
15858	<interface
15859	name="INATEngine" extends="$unknown"
15860	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
15861	wsmap="managed"
15862	>
15863	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
15864	allows for changing NAT behavior such as port-forwarding rules. This interface is
15865	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
15866	<attribute name="network" type="wstring">
15867	<desc>The network attribute of the NAT engine (the same value is used with built-in
15868	DHCP server to fill corresponding fields of DHCP leases).</desc>
15869	</attribute>
15870	<attribute name="hostIP" type="wstring">
15871	<desc>IP of host interface to bind all opened sockets to.
15872	<note>Changing this does not change binding of port forwarding.</note>
15873	</desc>
15874	</attribute>
15875	<attribute name="tftpPrefix" type="wstring">
15876	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
15877	the corresponding fields of DHCP leases.</desc>
15878	</attribute>
15879	<attribute name="tftpBootFile" type="wstring">
15880	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
15881	the corresponding fields of DHCP leases.</desc>
15882	</attribute>
15883	<attribute name="tftpNextServer" type="wstring">
15884	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
15885	the corresponding fields of DHCP leases.
15886	<note>The preferred form is IPv4 addresses.</note>
15887	</desc>
15888	</attribute>
15889	<attribute name="aliasMode" type="unsigned long">
15890	<desc></desc>
15891	</attribute>
15892	<attribute name="dnsPassDomain" type="boolean">
15893	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
15894	</attribute>
15895	<attribute name="dnsProxy" type="boolean">
15896	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15897	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
15898	</attribute>
15899	<attribute name="dnsUseHostResolver" type="boolean">
15900	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15901	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
15902	</attribute>
15903	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
15904	<desc>Array of NAT port-forwarding rules in string representation, in the following
15905	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
15906	</attribute>
15907	<method name="setNetworkSettings">
15908	<desc>Sets network configuration of the NAT engine.</desc>
15909	<param name="mtu" type="unsigned long" dir="in">
15910	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
15911	</param>
15912	<param name="sockSnd" type="unsigned long" dir="in">
15913	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
15914	</param>
15915	<param name="sockRcv" type="unsigned long" dir="in">
15916	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
15917	</param>
15918	<param name="TcpWndSnd" type="unsigned long" dir="in">
15919	<desc>Initial size of the NAT engine's sending TCP window in bytes when
15920	establishing a new TCP connection.</desc>
15921	</param>
15922	<param name="TcpWndRcv" type="unsigned long" dir="in">
15923	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
15924	establishing a new TCP connection.</desc>
15925	</param>
15926	</method>
15927	<method name="getNetworkSettings">
15928	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
15929	for parameter descriptions.</desc>
15930	<param name="mtu" type="unsigned long" dir="out" />
15931	<param name="sockSnd" type="unsigned long" dir="out" />
15932	<param name="sockRcv" type="unsigned long" dir="out" />
15933	<param name="TcpWndSnd" type="unsigned long" dir="out" />
15934	<param name="TcpWndRcv" type="unsigned long" dir="out" />
15935	</method>
15936	<method name="addRedirect">
15937	<desc>Adds a new NAT port-forwarding rule.</desc>
15938	<param name="name" type="wstring" dir="in">
15939	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
15940	auto-generates one using the other parameters.</desc>
15941	</param>
15942	<param name="proto" type="NATProtocol" dir="in">
15943	<desc>Protocol handled with the rule.</desc>
15944	</param>
15945	<param name="hostIp" type="wstring" dir="in">
15946	<desc>IP of the host interface to which the rule should apply. An empty ip address is
15947	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
15948	</param>
15949	<param name="hostPort" type="unsigned short" dir="in">
15950	<desc>The port number to listen on.</desc>
15951	</param>
15952	<param name="guestIp" type="wstring" dir="in">
15953	<desc>The IP address of the guest which the NAT engine will forward matching packets
15954	to. An empty IP address is acceptable, in which case the NAT engine will forward
15955	packets to the first DHCP lease (x.x.x.15).</desc>
15956	</param>
15957	<param name="guestPort" type="unsigned short" dir="in">
15958	<desc>The port number to forward.</desc>
15959	</param>
15960	</method>
15961	<method name="removeRedirect">
15962	<desc>Removes a port-forwarding rule that was previously registered.</desc>
15963	<param name="name" type="wstring" dir="in">
15964	<desc>The name of the rule to delete.</desc>
15965	</param>
15966	</method>
15967	</interface>
15968
15969	<!--
15970	// IExtPackManager
15971	/////////////////////////////////////////////////////////////////////////
15972	-->
15973
15974	<interface
15975	name="IExtPackPlugIn" extends="$unknown"
15976	uuid="58000040-e718-4746-bbce-4b86d96da461"
15977	wsmap="suppress"
15978	>
15979	<desc>
15980	Interface for keeping information about a plug-in that ships with an
15981	extension pack.
15982	</desc>
15983	<attribute name="name" type="wstring" readonly="yes">
15984	<desc>The plug-in name.</desc>
15985	</attribute>
15986	<attribute name="description" type="wstring" readonly="yes">
15987	<desc>The plug-in description.</desc>
15988	</attribute>
15989	<attribute name="frontend" type="wstring" readonly="yes">
15990	<desc>
15991	The name of the frontend or component name this plug-in plugs into.
15992	</desc>
15993	</attribute>
15994	<attribute name="modulePath" type="wstring" readonly="yes">
15995	<desc> The module path. </desc>
15996	</attribute>
15997	</interface>
15998
15999	<interface
16000	name="IExtPackBase" extends="$unknown"
16001	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16002	wsmap="suppress"
16003	>
16004	<desc>
16005	Interface for querying information about an extension pack as well as
16006	accessing COM objects within it.
16007	</desc>
16008	<attribute name="name" type="wstring" readonly="yes">
16009	<desc>The extension pack name. This is unique.</desc>
16010	</attribute>
16011	<attribute name="description" type="wstring" readonly="yes">
16012	<desc>The extension pack description.</desc>
16013	</attribute>
16014	<attribute name="version" type="wstring" readonly="yes">
16015	<desc>
16016	The extension pack version string. This is restricted to the dotted
16017	version number and a build indicator. No tree revision or tag will be
16018	included in the string as those things are available as separate
16019	properties. Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16020	</desc>
16021	</attribute>
16022	<attribute name="revision" type="unsigned long" readonly="yes">
16023	<desc>The extension pack internal revision number.</desc>
16024	</attribute>
16025	<attribute name="edition" type="wstring" readonly="yes">
16026	<desc>
16027	Edition indicator. This is usually empty.
16028
16029	Can for instance be used to help distinguishing between two editions
16030	of the same extension pack where only the license, service contract or
16031	something differs.
16032	</desc>
16033	</attribute>
16034	<attribute name="VRDEModule" type="wstring" readonly="yes">
16035	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16036	</attribute>
16037	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16038	<desc>Plug-ins provided by this extension pack.</desc>
16039	</attribute>
16040	<attribute name="usable" type="boolean" readonly="yes">
16041	<desc>
16042	Indicates whether the extension pack is usable or not.
16043
16044	There are a number of reasons why an extension pack might be unusable,
16045	typical examples would be broken installation/file or that it is
16046	incompatible with the current VirtualBox version.
16047	</desc>
16048	</attribute>
16049	<attribute name="whyUnusable" type="wstring" readonly="yes">
16050	<desc>
16051	String indicating why the extension pack is not usable. This is an
16052	empty string if usable and always a non-empty string if not usable.
16053	</desc>
16054	</attribute>
16055	<attribute name="showLicense" type="boolean" readonly="yes">
16056	<desc>Whether to show the license before installation</desc>
16057	</attribute>
16058	<attribute name="license" type="wstring" readonly="yes">
16059	<desc>
16060	The default HTML license text for the extension pack. Same as
16061	calling <link to="#queryLicense">queryLicense</link> with
16062	preferredLocale and preferredLanguage as empty strings and format set
16063	to html.
16064	</desc>
16065	</attribute>
16066
16067	<method name="queryLicense">
16068	<desc>
16069	Full feature version of the license attribute.
16070	</desc>
16071	<param name="preferredLocale" type="wstring" dir="in">
16072	<desc>
16073	The preferred license locale. Pass an empty string to get the default
16074	license.
16075	</desc>
16076	</param>
16077	<param name="preferredLanguage" type="wstring" dir="in">
16078	<desc>
16079	The preferred license language. Pass an empty string to get the
16080	default language for the locale.
16081	</desc>
16082	</param>
16083	<param name="format" type="wstring" dir="in">
16084	<desc>
16085	The license format: html, rtf or txt. If a license is present there
16086	will always be an HTML of it, the rich text format (RTF) and plain
16087	text (txt) versions are optional. If
16088	</desc>
16089	</param>
16090	<param name="licenseText" type="wstring" dir="return">
16091	<desc>The license text.</desc>
16092	</param>
16093	</method>
16094
16095	</interface>
16096
16097	<interface
16098	name="IExtPack" extends="IExtPackBase"
16099	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16100	wsmap="suppress"
16101	>
16102	<desc>
16103	Interface for querying information about an extension pack as well as
16104	accessing COM objects within it.
16105	</desc>
16106	<method name="queryObject">
16107	<desc>
16108	Queries the IUnknown interface to an object in the extension pack
16109	main module. This allows plug-ins and others to talk directly to an
16110	extension pack.
16111	</desc>
16112	<param name="objUuid" type="wstring" dir="in">
16113	<desc>The object ID. What exactly this is </desc>
16114	</param>
16115	<param name="returnInterface" type="$unknown" dir="return">
16116	<desc>The queried interface.</desc>
16117	</param>
16118	</method>
16119	</interface>
16120
16121	<interface
16122	name="IExtPackFile" extends="IExtPackBase"
16123	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16124	wsmap="suppress"
16125	>
16126	<desc>
16127	Extension pack file (aka tarball, .vbox-extpack) representation returned
16128	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16129	extension pack information with the addition of the file name.
16130	</desc>
16131	<attribute name="filePath" type="wstring" readonly="yes">
16132	<desc>
16133	The path to the extension pack file.
16134	</desc>
16135	</attribute>
16136
16137	<method name="install">
16138	<desc>
16139	Install the extension pack.
16140	</desc>
16141	<param name="replace" type="boolean" dir="in">
16142	<desc>
16143	Set this to automatically uninstall any existing extension pack with
16144	the same name as the one being installed.
16145	</desc>
16146	</param>
16147	<param name="displayInfo" type="wstring" dir="in">
16148	<desc>
16149	Platform specific display information. Reserved for future hacks.
16150	</desc>
16151	</param>
16152	<param name="progess" type="IProgress" dir="return">
16153	<desc>
16154	Progress object for the operation.
16155	</desc>
16156	</param>
16157	</method>
16158	</interface>
16159
16160	<interface
16161	name="IExtPackManager" extends="$unknown"
16162	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16163	wsmap="suppress"
16164	>
16165	<desc>
16166	Interface for managing VirtualBox Extension Packs.
16167
16168	TODO: Describe extension packs, how they are managed and how to create
16169	one.
16170	</desc>
16171
16172	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16173	<desc>
16174	List of the installed extension packs.
16175	</desc>
16176	</attribute>
16177
16178	<method name="find">
16179	<desc>
16180	Returns the extension pack with the specified name if found.
16181
16182	<result name="VBOX_E_OBJECT_NOT_FOUND">
16183	No extension pack matching @a name was found.
16184	</result>
16185	</desc>
16186	<param name="name" type="wstring" dir="in">
16187	<desc>The name of the extension pack to locate.</desc>
16188	</param>
16189	<param name="returnData" type="IExtPack" dir="return">
16190	<desc>The extension pack if found.</desc>
16191	</param>
16192	</method>
16193
16194	<method name="openExtPackFile">
16195	<desc>
16196	Attempts to open an extension pack file in preparation for
16197	installation.
16198	</desc>
16199	<param name="path" type="wstring" dir="in">
16200	<desc>The path of the extension pack tarball.</desc>
16201	</param>
16202	<param name="file" type="IExtPackFile" dir="return">
16203	<desc>The interface of the extension pack file object.</desc>
16204	</param>
16205	</method>
16206
16207	<method name="uninstall">
16208	<desc>Uninstalls an extension pack, removing all related files.</desc>
16209	<param name="name" type="wstring" dir="in">
16210	<desc>The name of the extension pack to uninstall.</desc>
16211	</param>
16212	<param name="forcedRemoval" type="boolean" dir="in">
16213	<desc>
16214	Forced removal of the extension pack. This means that the uninstall
16215	hook will not be called.
16216	</desc>
16217	</param>
16218	<param name="displayInfo" type="wstring" dir="in">
16219	<desc>
16220	Platform specific display information. Reserved for future hacks.
16221	</desc>
16222	</param>
16223	<param name="progess" type="IProgress" dir="return">
16224	<desc>
16225	Progress object for the operation.
16226	</desc>
16227	</param>
16228	</method>
16229
16230	<method name="cleanup">
16231	<desc>Cleans up failed installs and uninstalls</desc>
16232	</method>
16233
16234	<method name="queryAllPlugInsForFrontend">
16235	<desc>
16236	Gets the path to all the plug-in modules for a given frontend.
16237
16238	This is a convenience method that is intended to simplify the plug-in
16239	loading process for a frontend.
16240	</desc>
16241	<param name="frontendName" type="wstring" dir="in">
16242	<desc>The name of the frontend or component.</desc>
16243	</param>
16244	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16245	<desc>Array containing the plug-in modules (full paths).</desc>
16246	</param>
16247	</method>
16248
16249	<method name="isExtPackUsable">
16250	<desc>Check if the given extension pack is loaded and usable.</desc>
16251	<param name="name" type="wstring" dir="in">
16252	<desc>The name of the extension pack to check for.</desc>
16253	</param>
16254	<param name="usable" type="boolean" dir="return">
16255	<desc>Is the given extension pack loaded and usable.</desc>
16256	</param>
16257	</method>
16258
16259	</interface>
16260
16261	<!--
16262	// BandwidthGroupType
16263	/////////////////////////////////////////////////////////////////////////
16264	-->
16265	<enum
16266	name="BandwidthGroupType"
16267	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16268
16269	<desc>
16270	Type of a bandwidth control group.
16271	</desc>
16272
16273	<const name="Null" value="0">
16274	<desc>
16275	Null type, must be first.
16276	</desc>
16277	</const>
16278
16279	<const name="Disk" value="1">
16280	<desc>
16281	The bandwidth group controls disk I/O.
16282	</desc>
16283	</const>
16284
16285	<const name="Network" value="2">
16286	<desc>
16287	The bandwidth group controls network I/O.
16288	</desc>
16289	</const>
16290
16291	</enum>
16292
16293	<!--
16294	// IBandwidthGroup
16295	/////////////////////////////////////////////////////////////////////////
16296	-->
16297	<interface
16298	name="IBandwidthGroup" extends="$unknown"
16299	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16300	wsmap="managed"
16301	>
16302	<desc>Represents one bandwidth group.</desc>
16303
16304	<attribute name="name" type="wstring" readonly="yes">
16305	<desc>Name of the group.</desc>
16306	</attribute>
16307
16308	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16309	<desc>Type of the group.</desc>
16310	</attribute>
16311
16312	<attribute name="reference" type="unsigned long" readonly="yes">
16313	<desc>How many devices/medium attachements use this group.</desc>
16314	</attribute>
16315
16316	<attribute name="maxMbPerSec" type="unsigned long">
16317	<desc>The maximum number of MBytes which can be transfered by all
16318	entities attached to this group during one second.</desc>
16319	</attribute>
16320
16321	</interface>
16322
16323	<!--
16324	// IBandwidthControl
16325	/////////////////////////////////////////////////////////////////////////
16326	-->
16327	<interface
16328	name="IBandwidthControl" extends="$unknown"
16329	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16330	wsmap="managed"
16331	>
16332	<desc>
16333	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16334	This includes network and disk I/O.
16335	</desc>
16336
16337	<attribute name="numGroups" type="unsigned long" readonly="yes">
16338	<desc>
16339	The current number of existing bandwidth groups managed.
16340	</desc>
16341	</attribute>
16342
16343	<method name="createBandwidthGroup">
16344	<desc>
16345	Creates a new bandwidth group.
16346	</desc>
16347
16348	<param name="name" type="wstring" dir="in">
16349	<desc>Name of the bandwidth group.</desc>
16350	</param>
16351	<param name="type" type="BandwidthGroupType" dir="in">
16352	<desc>The type of the bandwidth group (network or disk).</desc>
16353	</param>
16354	<param name="maxMbPerSec" type="unsigned long" dir="in">
16355	<desc>The maximum number of MBytes which can be transfered by all
16356	entities attached to this group during one second.</desc>
16357	</param>
16358	</method>
16359
16360	<method name="deleteBandwidthGroup">
16361	<desc>
16362	Deletes a new bandwidth group.
16363	</desc>
16364
16365	<param name="name" type="wstring" dir="in">
16366	<desc>Name of the bandwidth group to delete.</desc>
16367	</param>
16368	</method>
16369
16370	<method name="getBandwidthGroup" const="yes">
16371	<desc>
16372	Get a bandwidth group by name.
16373	</desc>
16374
16375	<param name="name" type="wstring" dir="in">
16376	<desc>Name of the bandwidth group to get.</desc>
16377	</param>
16378	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16379	<desc>Where to store the bandwidth group on success.</desc>
16380	</param>
16381	</method>
16382
16383	<method name="getAllBandwidthGroups" const="yes">
16384	<desc>
16385	Get all managed bandwidth groups.
16386	</desc>
16387
16388	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16389	<desc>The array of managed bandwidth groups.</desc>
16390	</param>
16391	</method>
16392	</interface>
16393
16394	<!--
16395	// IVirtualBoxClient
16396	/////////////////////////////////////////////////////////////////////////
16397	-->
16398
16399	<interface
16400	name="IVirtualBoxClient" extends="$unknown"
16401	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16402	wsmap="suppress"
16403	>
16404	<desc>
16405	Convenience interface for client applications. Treat this as a
16406	singleton, i.e. never create more than one instance of this interface.
16407
16408	At the moment only available for clients of the local API (not usable
16409	via the webservice). Once the session logic is redesigned this might
16410	change.
16411	</desc>
16412
16413	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16414	<desc>
16415	Reference to the server-side API root object.
16416	</desc>
16417	</attribute>
16418
16419	<attribute name="session" type="ISession" readonly="yes">
16420	<desc>
16421	Create a new session object and return the reference to it.
16422	</desc>
16423	</attribute>
16424
16425	<attribute name="eventSource" type="IEventSource" readonly="yes">
16426	<desc>
16427	Event source for VirtualBoxClient events.
16428	</desc>
16429	</attribute>
16430
16431	</interface>
16432
16433	<!--
16434	// Events
16435	/////////////////////////////////////////////////////////////////////////
16436	-->
16437	<enum
16438	name="VBoxEventType"
16439	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
16440	>
16441
16442	<desc>
16443	Type of an event.
16444	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16445	</desc>
16446
16447	<const name="Invalid" value="0">
16448	<desc>
16449	Invalid event, must be first.
16450	</desc>
16451	</const>
16452
16453	<const name="Any" value="1">
16454	<desc>
16455	Wildcard for all events.
16456	Events of this type are never delivered, and only used in
16457	<link to="IEventSource::registerListener"/> call to simplify registration.
16458	</desc>
16459	</const>
16460
16461	<const name="Vetoable" value="2">
16462	<desc>
16463	Wildcard for all vetoable events. Events of this type are never delivered, and only
16464	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16465	</desc>
16466	</const>
16467
16468	<const name="MachineEvent" value="3">
16469	<desc>
16470	Wildcard for all machine events. Events of this type are never delivered, and only used in
16471	<link to="IEventSource::registerListener"/> call to simplify registration.
16472	</desc>
16473	</const>
16474
16475	<const name="SnapshotEvent" value="4">
16476	<desc>
16477	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16478	<link to="IEventSource::registerListener"/> call to simplify registration.
16479	</desc>
16480	</const>
16481
16482	<const name="InputEvent" value="5">
16483	<desc>
16484	Wildcard for all input device (keyboard, mouse) events.
16485	Events of this type are never delivered, and only used in
16486	<link to="IEventSource::registerListener"/> call to simplify registration.
16487	</desc>
16488	</const>
16489
16490	<const name="LastWildcard" value="31">
16491	<desc>
16492	Last wildcard.
16493	</desc>
16494	</const>
16495
16496	<const name="OnMachineStateChanged" value="32">
16497	<desc>
16498	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16499	</desc>
16500	</const>
16501	<const name="OnMachineDataChanged" value="33">
16502	<desc>
16503	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16504	</desc>
16505	</const>
16506	<const name="OnExtraDataChanged" value="34">
16507	<desc>
16508	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16509	</desc>
16510	</const>
16511	<const name="OnExtraDataCanChange" value="35">
16512	<desc>
16513	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16514	</desc>
16515	</const>
16516	<const name="OnMediumRegistered" value="36">
16517	<desc>
16518	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16519	</desc>
16520	</const>
16521	<const name="OnMachineRegistered" value="37">
16522	<desc>
16523	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16524	</desc>
16525	</const>
16526	<const name="OnSessionStateChanged" value="38">
16527	<desc>
16528	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16529	</desc>
16530	</const>
16531	<const name="OnSnapshotTaken" value="39">
16532	<desc>
16533	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16534	</desc>
16535	</const>
16536	<const name="OnSnapshotDeleted" value="40">
16537	<desc>
16538	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16539	</desc>
16540	</const>
16541	<const name="OnSnapshotChanged" value="41">
16542	<desc>
16543	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16544	</desc>
16545	</const>
16546	<const name="OnGuestPropertyChanged" value="42">
16547	<desc>
16548	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16549	</desc>
16550	</const>
16551	<!-- Console events -->
16552	<const name="OnMousePointerShapeChanged" value="43">
16553	<desc>
16554	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16555	</desc>
16556	</const>
16557	<const name="OnMouseCapabilityChanged" value="44">
16558	<desc>
16559	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16560	</desc>
16561	</const>
16562	<const name="OnKeyboardLedsChanged" value="45">
16563	<desc>
16564	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16565	</desc>
16566	</const>
16567	<const name="OnStateChanged" value="46">
16568	<desc>
16569	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16570	</desc>
16571	</const>
16572	<const name="OnAdditionsStateChanged" value="47">
16573	<desc>
16574	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16575	</desc>
16576	</const>
16577	<const name="OnNetworkAdapterChanged" value="48">
16578	<desc>
16579	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16580	</desc>
16581	</const>
16582	<const name="OnSerialPortChanged" value="49">
16583	<desc>
16584	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16585	</desc>
16586	</const>
16587	<const name="OnParallelPortChanged" value="50">
16588	<desc>
16589	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16590	</desc>
16591	</const>
16592	<const name="OnStorageControllerChanged" value="51">
16593	<desc>
16594	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16595	</desc>
16596	</const>
16597	<const name="OnMediumChanged" value="52">
16598	<desc>
16599	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16600	</desc>
16601	</const>
16602	<const name="OnVRDEServerChanged" value="53">
16603	<desc>
16604	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16605	</desc>
16606	</const>
16607	<const name="OnUSBControllerChanged" value="54">
16608	<desc>
16609	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16610	</desc>
16611	</const>
16612	<const name="OnUSBDeviceStateChanged" value="55">
16613	<desc>
16614	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16615	</desc>
16616	</const>
16617	<const name="OnSharedFolderChanged" value="56">
16618	<desc>
16619	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16620	</desc>
16621	</const>
16622	<const name="OnRuntimeError" value="57">
16623	<desc>
16624	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16625	</desc>
16626	</const>
16627	<const name="OnCanShowWindow" value="58">
16628	<desc>
16629	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16630	</desc>
16631	</const>
16632	<const name="OnShowWindow" value="59">
16633	<desc>
16634	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16635	</desc>
16636	</const>
16637	<const name="OnCPUChanged" value="60">
16638	<desc>
16639	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16640	</desc>
16641	</const>
16642	<const name="OnVRDEServerInfoChanged" value="61">
16643	<desc>
16644	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16645	</desc>
16646	</const>
16647	<const name="OnEventSourceChanged" value="62">
16648	<desc>
16649	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16650	</desc>
16651	</const>
16652	<const name="OnCPUExecutionCapChanged" value="63">
16653	<desc>
16654	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16655	</desc>
16656	</const>
16657	<const name="OnGuestKeyboard" value="64">
16658	<desc>
16659	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16660	</desc>
16661	</const>
16662	<const name="OnGuestMouse" value="65">
16663	<desc>
16664	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16665	</desc>
16666	</const>
16667	<const name="OnNATRedirect" value="66">
16668	<desc>
16669	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16670	</desc>
16671	</const>
16672	<const name="OnHostPciDevicePlug" value="67">
16673	<desc>
16674	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16675	</desc>
16676	</const>
16677	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16678	<desc>
16679	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16680	</desc>
16681	</const>
16682	<const name="OnBandwidthGroupChanged" value="69">
16683	<desc>
16684	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16685	</desc>
16686	</const>
16687	<const name="OnGuestMonitorChanged" value="70">
16688	<desc>
16689	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16690	</desc>
16691	</const>
16692	<const name="OnStorageDeviceChanged" value="71">
16693	<desc>
16694	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16695	</desc>
16696	</const>
16697
16698	<!-- Last event marker -->
16699	<const name="Last" value="72">
16700	<desc>
16701	Must be last event, used for iterations and structures relying on numerical event values.
16702	</desc>
16703	</const>
16704
16705	</enum>
16706
16707	<interface
16708	name="IEventSource" extends="$unknown"
16709	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16710	wsmap="managed"
16711	>
16712	<desc>
16713	Event source. Generally, any object which could generate events can be an event source,
16714	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16715	an event source can work with listeners in either active or passive mode. In active mode it is up to
16716	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16717	event source keeps track of pending events for each listener and returns available events on demand.
16718
16719	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16720	</desc>
16721
16722	<method name="createListener">
16723	<desc>
16724	Creates a new listener object, useful for passive mode.
16725	</desc>
16726	<param name="listener" type="IEventListener" dir="return"/>
16727	</method>
16728
16729	<method name="createAggregator">
16730	<desc>
16731	Creates an aggregator event source, collecting events from multiple sources.
16732	This way a single listener can listen for events coming from multiple sources,
16733	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16734	</desc>
16735	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16736	<desc>
16737	Subordinate event source this one aggregatres.
16738	</desc>
16739	</param>
16740	<param name="result" type="IEventSource" dir="return">
16741	<desc>
16742	Event source aggregating passed sources.
16743	</desc>
16744	</param>
16745	</method>
16746
16747	<method name="registerListener">
16748	<desc>
16749	Register an event listener.
16750
16751	<note>
16752	To avoid system overload, the VirtualBox server process checks if passive event
16753	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16754	current implementation, if more than 500 pending events are detected for a passive
16755	event listener, it is forcefully unregistered by the system, and further
16756	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16757	</note>
16758	</desc>
16759	<param name="listener" type="IEventListener" dir="in">
16760	<desc>Listener to register.</desc>
16761	</param>
16762	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16763	<desc>
16764	Event types listener is interested in. One can use wildcards like -
16765	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16766	than one event.
16767	</desc>
16768	</param>
16769	<param name="active" type="boolean" dir="in">
16770	<desc>
16771	Which mode this listener is operating in.
16772	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16773	In passive mode, an internal event queue is created for this this IEventListener.
16774	For each event coming in, it is added to queues for all interested registered passive
16775	listeners. It is then up to the external code to call the listener's
16776	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16777	external code must call <link to="#eventProcessed" />.
16778	</desc>
16779	</param>
16780	</method>
16781
16782	<method name="unregisterListener">
16783	<desc>
16784	Unregister an event listener. If listener is passive, and some waitable events are still
16785	in queue they are marked as processed automatically.
16786	</desc>
16787	<param name="listener" type="IEventListener" dir="in">
16788	<desc>Listener to unregister.</desc>
16789	</param>
16790	</method>
16791
16792	<method name="fireEvent">
16793	<desc>
16794	Fire an event for this source.
16795	</desc>
16796	<param name="event" type="IEvent" dir="in">
16797	<desc>Event to deliver.</desc>
16798	</param>
16799	<param name="timeout" type="long" dir="in">
16800	<desc>
16801	Maximum time to wait for event processing (if event is waitable), in ms;
16802	0 = no wait, -1 = indefinite wait.
16803	</desc>
16804	</param>
16805	<param name="result" type="boolean" dir="return">
16806	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16807	</param>
16808	</method>
16809
16810	<method name="getEvent">
16811	<desc>
16812	Get events from this peer's event queue (for passive mode). Calling this method
16813	regularly is required for passive event listeners to avoid system overload;
16814	see <link to="IEventSource::registerListener" /> for details.
16815
16816	<result name="VBOX_E_OBJECT_NOT_FOUND">
16817	Listener is not registered, or autounregistered.
16818	</result>
16819	</desc>
16820	<param name="listener" type="IEventListener" dir="in">
16821	<desc>Which listener to get data for.</desc>
16822	</param>
16823	<param name="timeout" type="long" dir="in">
16824	<desc>
16825	Maximum time to wait for events, in ms;
16826	0 = no wait, -1 = indefinite wait.
16827	</desc>
16828	</param>
16829	<param name="event" type="IEvent" dir="return">
16830	<desc>Event retrieved, or null if none available.</desc>
16831	</param>
16832	</method>
16833
16834	<method name="eventProcessed">
16835	<desc>
16836	Must be called for waitable events after a particular listener finished its
16837	event processing. When all listeners of a particular event have called this
16838	method, the system will then call <link to="IEvent::setProcessed" />.
16839	</desc>
16840	<param name="listener" type="IEventListener" dir="in">
16841	<desc>Which listener processed event.</desc>
16842	</param>
16843	<param name="event" type="IEvent" dir="in">
16844	<desc>Which event.</desc>
16845	</param>
16846	</method>
16847
16848	</interface>
16849
16850	<interface
16851	name="IEventListener" extends="$unknown"
16852	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
16853	wsmap="managed"
16854	>
16855	<desc>
16856	Event listener. An event listener can work in either active or passive mode, depending on the way
16857	it was registered.
16858	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16859	</desc>
16860
16861	<method name="handleEvent">
16862	<desc>
16863	Handle event callback for active listeners. It is not called for
16864	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
16865	and having received acknowledgement from all passive listeners via
16866	<link to="IEventSource::eventProcessed"/>, the event is marked as
16867	processed and <link to="IEvent::waitProcessed"/> will return
16868	immediately.
16869	</desc>
16870	<param name="event" type="IEvent" dir="in">
16871	<desc>Event available.</desc>
16872	</param>
16873	</method>
16874
16875	</interface>
16876
16877	<interface
16878	name="IEvent" extends="$unknown"
16879	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
16880	wsmap="managed"
16881	>
16882	<desc>
16883	Abstract parent interface for VirtualBox events. Actual events will typically implement
16884	a more specific interface which derives from this (see below).
16885
16886	<b>Introduction to VirtualBox events</b>
16887
16888	Generally speaking, an event (represented by this interface) signals that something
16889	happened, while an event listener (see <link to="IEventListener" />) represents an
16890	entity that is interested in certain events. In order for this to work with
16891	unidirectional protocols (i.e. web services), the concepts of passive and active
16892	listener are used.
16893
16894	Event consumers can register themselves as listeners, providing an array of
16895	events they are interested in (see <link to="IEventSource::registerListener" />).
16896	When an event triggers, the listener is notified about the event. The exact
16897	mechanism of the notification depends on whether the listener was registered as
16898	an active or passive listener:
16899
16900	<ul>
16901	<li>An active listener is very similar to a callback: it is a function invoked
16902	by the API. As opposed to the callbacks that were used in the API before
16903	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
16904	</li>
16905
16906	<li>Passive listeners are somewhat trickier to implement, but do not require
16907	a client function to be callable, which is not an option with scripting
16908	languages or web service clients. Internally the <link to="IEventSource" />
16909	implementation maintains an event queue for each passive listener, and
16910	newly arrived events are put in this queue. When the listener calls
16911	<link to="IEventSource::getEvent"/>, first element from its internal event
16912	queue is returned. When the client completes processing of an event,
16913	the <link to="IEventSource::eventProcessed" /> function must be called,
16914	acknowledging that the event was processed. It supports implementing
16915	waitable events. On passive listener unregistration, all events from its
16916	queue are auto-acknowledged.
16917	</li>
16918	</ul>
16919
16920	Waitable events are useful in situations where the event generator wants to track
16921	delivery or a party wants to wait until all listeners have completed the event. A
16922	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
16923	listeners might veto a certain action, and thus the event producer has to make
16924	sure that all listeners have processed the event and not vetoed before taking
16925	the action.
16926
16927	A given event may have both passive and active listeners at the same time.
16928
16929	<b>Using events</b>
16930
16931	Any VirtualBox object capable of producing externally visible events provides an
16932	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
16933	This event source object is notified by VirtualBox once something has happened, so
16934	consumers may register event listeners with this event source. To register a listener,
16935	an object implementing the <link to="IEventListener" /> interface must be provided.
16936	For active listeners, such an object is typically created by the consumer, while for
16937	passive listeners <link to="IEventSource::createListener" /> should be used. Please
16938	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
16939
16940	Once created, the listener must be registered to listen for the desired events
16941	(see <link to="IEventSource::registerListener" />), providing an array of
16942	<link to="VBoxEventType" /> enums. Those elements can either be the individual
16943	event IDs or wildcards matching multiple event IDs.
16944
16945	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
16946	called automatically when the event is triggered, while passive listeners have to call
16947	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
16948	an event processing loop.
16949
16950	The IEvent interface is an abstract parent interface for all such VirtualBox events
16951	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
16952	or the event processing loop is to check the <link to="#type" /> attribute of the event and
16953	then cast to the appropriate specific interface using @c QueryInterface().
16954	</desc>
16955
16956	<attribute name="type" readonly="yes" type="VBoxEventType">
16957	<desc>
16958	Event type.
16959	</desc>
16960	</attribute>
16961
16962	<attribute name="source" readonly="yes" type="IEventSource">
16963	<desc>
16964	Source of this event.
16965	</desc>
16966	</attribute>
16967
16968	<attribute name="waitable" readonly="yes" type="boolean">
16969	<desc>
16970	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
16971	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
16972	as no additional overhead associated with waitability imposed.
16973	Waitable events are needed when one need to be able to wait for particular event processed,
16974	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
16975	until all consumers confirmed events.
16976	</desc>
16977	</attribute>
16978
16979	<method name="setProcessed">
16980	<desc>
16981	Internal method called by the system when all listeners of a particular event have called
16982	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
16983	</desc>
16984	</method>
16985
16986	<method name="waitProcessed">
16987	<desc>
16988	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
16989	described semantics, for non-waitable returns true immediately.
16990	</desc>
16991	<param name="timeout" type="long" dir="in">
16992	<desc>
16993	Maximum time to wait for event processeing, in ms;
16994	0 = no wait, -1 = indefinite wait.
16995	</desc>
16996	</param>
16997	<param name="result" type="boolean" dir="return">
16998	<desc>If this event was processed before timeout.</desc>
16999	</param>
17000	</method>
17001	</interface>
17002
17003
17004	<interface
17005	name="IReusableEvent" extends="IEvent"
17006	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17007	wsmap="managed"
17008	>
17009	<desc>Base abstract interface for all reusable events.</desc>
17010
17011	<attribute name="generation" readonly="yes" type="unsigned long">
17012	<desc>Current generation of event, incremented on reuse.</desc>
17013	</attribute>
17014
17015	<method name="reuse">
17016	<desc>
17017	Marks an event as reused, increments 'generation', fields shall no
17018	longer be considered valid.
17019	</desc>
17020	</method>
17021	</interface>
17022
17023	<interface
17024	name="IMachineEvent" extends="IEvent"
17025	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17026	wsmap="managed" id="MachineEvent"
17027	>
17028	<desc>Base abstract interface for all machine events.</desc>
17029
17030	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17031	<desc>ID of the machine this event relates to.</desc>
17032	</attribute>
17033
17034	</interface>
17035
17036	<interface
17037	name="IMachineStateChangedEvent" extends="IMachineEvent"
17038	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17039	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17040	>
17041	<desc>Machine state change event.</desc>
17042
17043	<attribute name="state" readonly="yes" type="MachineState">
17044	<desc>New execution state.</desc>
17045	</attribute>
17046	</interface>
17047
17048	<interface
17049	name="IMachineDataChangedEvent" extends="IMachineEvent"
17050	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17051	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17052	>
17053	<desc>
17054	Any of the settings of the given machine has changed.
17055	</desc>
17056
17057	<attribute name="temporary" readonly="yes" type="boolean">
17058	<desc>@c true if the settings change is temporary. All permanent
17059	settings changes will trigger an event, and only temporary settings
17060	changes for running VMs will trigger an event. Note: sending events
17061	for temporary changes is NOT IMPLEMENTED.</desc>
17062	</attribute>
17063	</interface>
17064
17065	<interface
17066	name="IMediumRegisteredEvent" extends="IEvent"
17067	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17068	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17069	>
17070	<desc>
17071	The given medium was registered or unregistered
17072	within this VirtualBox installation.
17073	</desc>
17074
17075	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17076	<desc>ID of the medium this event relates to.</desc>
17077	</attribute>
17078
17079	<attribute name="mediumType" readonly="yes" type="DeviceType">
17080	<desc>Type of the medium this event relates to.</desc>
17081	</attribute>
17082
17083	<attribute name="registered" type="boolean" readonly="yes">
17084	<desc>
17085	If @c true, the medium was registered, otherwise it was
17086	unregistered.
17087	</desc>
17088	</attribute>
17089	</interface>
17090
17091	<interface
17092	name="IMachineRegisteredEvent" extends="IMachineEvent"
17093	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17094	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17095	>
17096	<desc>
17097	The given machine was registered or unregistered
17098	within this VirtualBox installation.
17099	</desc>
17100
17101	<attribute name="registered" type="boolean" readonly="yes">
17102	<desc>
17103	If @c true, the machine was registered, otherwise it was
17104	unregistered.
17105	</desc>
17106	</attribute>
17107	</interface>
17108
17109	<interface
17110	name="ISessionStateChangedEvent" extends="IMachineEvent"
17111	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17112	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17113	>
17114	<desc>
17115	The state of the session for the given machine was changed.
17116	<see><link to="IMachine::sessionState"/></see>
17117	</desc>
17118
17119	<attribute name="state" type="SessionState" readonly="yes">
17120	<desc>
17121	New session state.
17122	</desc>
17123	</attribute>
17124	</interface>
17125
17126	<interface
17127	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17128	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17129	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17130	>
17131	<desc>
17132	Notification when a guest property has changed.
17133	</desc>
17134
17135	<attribute name="name" readonly="yes" type="wstring">
17136	<desc>
17137	The name of the property that has changed.
17138	</desc>
17139	</attribute>
17140
17141	<attribute name="value" readonly="yes" type="wstring">
17142	<desc>
17143	The new property value.
17144	</desc>
17145	</attribute>
17146
17147	<attribute name="flags" readonly="yes" type="wstring">
17148	<desc>
17149	The new property flags.
17150	</desc>
17151	</attribute>
17152
17153	</interface>
17154
17155	<interface
17156	name="ISnapshotEvent" extends="IMachineEvent"
17157	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17158	wsmap="managed" id="SnapshotEvent"
17159	>
17160	<desc>Base interface for all snapshot events.</desc>
17161
17162	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17163	<desc>ID of the snapshot this event relates to.</desc>
17164	</attribute>
17165
17166	</interface>
17167
17168	<interface
17169	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17170	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17171	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17172	>
17173	<desc>
17174	A new snapshot of the machine has been taken.
17175	<see><link to="ISnapshot"/></see>
17176	</desc>
17177	</interface>
17178
17179	<interface
17180	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17181	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17182	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17183	>
17184	<desc>
17185	Snapshot of the given machine has been deleted.
17186
17187	<note>
17188	This notification is delivered <b>after</b> the snapshot
17189	object has been uninitialized on the server (so that any
17190	attempt to call its methods will return an error).
17191	</note>
17192
17193	<see><link to="ISnapshot"/></see>
17194	</desc>
17195	</interface>
17196
17197	<interface
17198	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17199	uuid="07541941-8079-447a-a33e-47a69c7980db"
17200	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17201	>
17202	<desc>
17203	Snapshot properties (name and/or description) have been changed.
17204	<see><link to="ISnapshot"/></see>
17205	</desc>
17206	</interface>
17207
17208	<interface
17209	name="IMousePointerShapeChangedEvent" extends="IEvent"
17210	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17211	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17212	>
17213	<desc>
17214	Notification when the guest mouse pointer shape has
17215	changed. The new shape data is given.
17216	</desc>
17217
17218	<attribute name="visible" type="boolean" readonly="yes">
17219	<desc>
17220	Flag whether the pointer is visible.
17221	</desc>
17222	</attribute>
17223	<attribute name="alpha" type="boolean" readonly="yes">
17224	<desc>
17225	Flag whether the pointer has an alpha channel.
17226	</desc>
17227	</attribute>
17228	<attribute name="xhot" type="unsigned long" readonly="yes">
17229	<desc>
17230	The pointer hot spot X coordinate.
17231	</desc>
17232	</attribute>
17233	<attribute name="yhot" type="unsigned long" readonly="yes">
17234	<desc>
17235	The pointer hot spot Y coordinate.
17236	</desc>
17237	</attribute>
17238	<attribute name="width" type="unsigned long" readonly="yes">
17239	<desc>
17240	Width of the pointer shape in pixels.
17241	</desc>
17242	</attribute>
17243	<attribute name="height" type="unsigned long" readonly="yes">
17244	<desc>
17245	Height of the pointer shape in pixels.
17246	</desc>
17247	</attribute>
17248	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17249	<desc>
17250	Shape buffer arrays.
17251
17252	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17253	followed by a 32-bpp XOR (color) mask.
17254
17255	For pointers without alpha channel the XOR mask pixels are 32
17256	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17257	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17258
17259	An AND mask is used for pointers with alpha channel, so if the
17260	callback does not support alpha, the pointer could be
17261	displayed as a normal color pointer.
17262
17263	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17264	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17265	height</tt>. The padding bits at the end of each scanline are
17266	undefined.
17267
17268	The XOR mask follows the AND mask on the next 4-byte aligned
17269	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17270	Bytes in the gap between the AND and the XOR mask are undefined.
17271	The XOR mask scanlines have no gap between them and the size of
17272	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17273
17274	<note>
17275	If @a shape is 0, only the pointer visibility is changed.
17276	</note>
17277	</desc>
17278	</attribute>
17279	</interface>
17280
17281	<interface
17282	name="IMouseCapabilityChangedEvent" extends="IEvent"
17283	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17284	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17285	>
17286	<desc>
17287	Notification when the mouse capabilities reported by the
17288	guest have changed. The new capabilities are passed.
17289	</desc>
17290	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17291	<desc>
17292	Supports absolute coordinates.
17293	</desc>
17294	</attribute>
17295	<attribute name="supportsRelative" type="boolean" readonly="yes">
17296	<desc>
17297	Supports relative coordinates.
17298	</desc>
17299	</attribute>
17300	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17301	<desc>
17302	If host cursor is needed.
17303	</desc>
17304	</attribute>
17305	</interface>
17306
17307	<interface
17308	name="IKeyboardLedsChangedEvent" extends="IEvent"
17309	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17310	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17311	>
17312	<desc>
17313	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17314	to alter the state of the keyboard LEDs.
17315	</desc>
17316	<attribute name="numLock" type="boolean" readonly="yes">
17317	<desc>
17318	NumLock status.
17319	</desc>
17320	</attribute>
17321	<attribute name="capsLock" type="boolean" readonly="yes">
17322	<desc>
17323	CapsLock status.
17324	</desc>
17325	</attribute>
17326	<attribute name="scrollLock" type="boolean" readonly="yes">
17327	<desc>
17328	ScrollLock status.
17329	</desc>
17330	</attribute>
17331	</interface>
17332
17333	<interface
17334	name="IStateChangedEvent" extends="IEvent"
17335	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17336	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17337	>
17338	<desc>
17339	Notification when the execution state of the machine has changed.
17340	The new state is given.
17341	</desc>
17342	<attribute name="state" type="MachineState" readonly="yes">
17343	<desc>
17344	New machine state.
17345	</desc>
17346	</attribute>
17347	</interface>
17348
17349	<interface
17350	name="IAdditionsStateChangedEvent" extends="IEvent"
17351	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17352	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17353	>
17354	<desc>
17355	Notification when a Guest Additions property changes.
17356	Interested callees should query IGuest attributes to
17357	find out what has changed.
17358	</desc>
17359	</interface>
17360
17361	<interface
17362	name="INetworkAdapterChangedEvent" extends="IEvent"
17363	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17364	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17365	>
17366	<desc>
17367	Notification when a property of one of the
17368	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17369	changes. Interested callees should use INetworkAdapter methods and
17370	attributes to find out what has changed.
17371	</desc>
17372	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17373	<desc>
17374	Network adapter that is subject to change.
17375	</desc>
17376	</attribute>
17377	</interface>
17378
17379	<interface
17380	name="ISerialPortChangedEvent" extends="IEvent"
17381	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17382	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17383	>
17384	<desc>
17385	Notification when a property of one of the
17386	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17387	Interested callees should use ISerialPort methods and attributes
17388	to find out what has changed.
17389	</desc>
17390	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17391	<desc>
17392	Serial port that is subject to change.
17393	</desc>
17394	</attribute>
17395	</interface>
17396
17397	<interface
17398	name="IParallelPortChangedEvent" extends="IEvent"
17399	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17400	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17401	>
17402	<desc>
17403	Notification when a property of one of the
17404	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17405	changes. Interested callees should use ISerialPort methods and
17406	attributes to find out what has changed.
17407	</desc>
17408	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17409	<desc>
17410	Parallel port that is subject to change.
17411	</desc>
17412	</attribute>
17413	</interface>
17414
17415	<interface
17416	name="IStorageControllerChangedEvent" extends="IEvent"
17417	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17418	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17419	>
17420	<desc>
17421	Notification when a
17422	<link to="IMachine::mediumAttachments">medium attachment</link>
17423	changes.
17424	</desc>
17425	</interface>
17426
17427	<interface
17428	name="IMediumChangedEvent" extends="IEvent"
17429	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17430	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17431	>
17432	<desc>
17433	Notification when a
17434	<link to="IMachine::mediumAttachments">medium attachment</link>
17435	changes.
17436	</desc>
17437	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17438	<desc>
17439	Medium attachment that is subject to change.
17440	</desc>
17441	</attribute>
17442	</interface>
17443
17444	<interface
17445	name="ICPUChangedEvent" extends="IEvent"
17446	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17447	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17448	>
17449	<desc>
17450	Notification when a CPU changes.
17451	</desc>
17452	<attribute name="cpu" type="unsigned long" readonly="yes">
17453	<desc>
17454	The CPU which changed.
17455	</desc>
17456	</attribute>
17457	<attribute name="add" type="boolean" readonly="yes">
17458	<desc>
17459	Flag whether the CPU was added or removed.
17460	</desc>
17461	</attribute>
17462	</interface>
17463
17464	<interface
17465	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17466	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17467	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17468	>
17469	<desc>
17470	Notification when the CPU execution cap changes.
17471	</desc>
17472	<attribute name="executionCap" type="unsigned long" readonly="yes">
17473	<desc>
17474	The new CPU execution cap value. (1-100)
17475	</desc>
17476	</attribute>
17477	</interface>
17478
17479	<interface
17480	name="IGuestKeyboardEvent" extends="IEvent"
17481	uuid="88394258-7006-40d4-b339-472ee3801844"
17482	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17483	>
17484	<desc>
17485	Notification when guest keyboard event happens.
17486	</desc>
17487	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17488	<desc>
17489	Array of scancodes.
17490	</desc>
17491	</attribute>
17492	</interface>
17493
17494	<interface
17495	name="IGuestMouseEvent" extends="IReusableEvent"
17496	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17497	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17498	>
17499	<desc>
17500	Notification when guest mouse event happens.
17501	</desc>
17502
17503	<attribute name="absolute" type="boolean" readonly="yes">
17504	<desc>
17505	If this event is relative or absolute.
17506	</desc>
17507	</attribute>
17508
17509	<attribute name="x" type="long" readonly="yes">
17510	<desc>
17511	New X position, or X delta.
17512	</desc>
17513	</attribute>
17514
17515	<attribute name="y" type="long" readonly="yes">
17516	<desc>
17517	New Y position, or Y delta.
17518	</desc>
17519	</attribute>
17520
17521	<attribute name="z" type="long" readonly="yes">
17522	<desc>
17523	Z delta.
17524	</desc>
17525	</attribute>
17526
17527	<attribute name="w" type="long" readonly="yes">
17528	<desc>
17529	W delta.
17530	</desc>
17531	</attribute>
17532
17533	<attribute name="buttons" type="long" readonly="yes">
17534	<desc>
17535	Button state bitmask.
17536	</desc>
17537	</attribute>
17538
17539	</interface>
17540
17541
17542	<interface
17543	name="IVRDEServerChangedEvent" extends="IEvent"
17544	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17545	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17546	>
17547	<desc>
17548	Notification when a property of the
17549	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17550	Interested callees should use IVRDEServer methods and attributes to
17551	find out what has changed.
17552	</desc>
17553	</interface>
17554
17555	<interface
17556	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17557	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17558	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17559	>
17560	<desc>
17561	Notification when the status of the VRDE server changes. Interested callees
17562	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17563	attributes to find out what is the current status.
17564	</desc>
17565	</interface>
17566
17567	<interface
17568	name="IUSBControllerChangedEvent" extends="IEvent"
17569	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17570	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17571	>
17572	<desc>
17573	Notification when a property of the virtual
17574	<link to="IMachine::USBController">USB controller</link> changes.
17575	Interested callees should use IUSBController methods and attributes to
17576	find out what has changed.
17577	</desc>
17578	</interface>
17579
17580	<interface
17581	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17582	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17583	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17584	>
17585	<desc>
17586	Notification when a USB device is attached to or detached from
17587	the virtual USB controller.
17588
17589	This notification is sent as a result of the indirect
17590	request to attach the device because it matches one of the
17591	machine USB filters, or as a result of the direct request
17592	issued by <link to="IConsole::attachUSBDevice"/> or
17593	<link to="IConsole::detachUSBDevice"/>.
17594
17595	This notification is sent in case of both a succeeded and a
17596	failed request completion. When the request succeeds, the
17597	@a error parameter is @c null, and the given device has been
17598	already added to (when @a attached is @c true) or removed from
17599	(when @a attached is @c false) the collection represented by
17600	<link to="IConsole::USBDevices"/>. On failure, the collection
17601	doesn't change and the @a error parameter represents the error
17602	message describing the failure.
17603	</desc>
17604	<attribute name="device" type="IUSBDevice" readonly="yes">
17605	<desc>
17606	Device that is subject to state change.
17607	</desc>
17608	</attribute>
17609	<attribute name="attached" type="boolean" readonly="yes">
17610	<desc>
17611	@c true if the device was attached and @c false otherwise.
17612	</desc>
17613	</attribute>
17614	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17615	<desc>
17616	@c null on success or an error message object on failure.
17617	</desc>
17618	</attribute>
17619	</interface>
17620
17621	<interface
17622	name="ISharedFolderChangedEvent" extends="IEvent"
17623	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17624	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17625	>
17626	<desc>
17627	Notification when a shared folder is added or removed.
17628	The @a scope argument defines one of three scopes:
17629	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17630	(<link to="Scope_Global">Global</link>),
17631	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17632	the machine (<link to="Scope_Machine">Machine</link>) or <link
17633	to="IConsole::sharedFolders">transient shared folders</link> of the
17634	machine (<link to="Scope_Session">Session</link>). Interested callees
17635	should use query the corresponding collections to find out what has
17636	changed.
17637	</desc>
17638	<attribute name="scope" type="Scope" readonly="yes">
17639	<desc>
17640	Scope of the notification.
17641	</desc>
17642	</attribute>
17643	</interface>
17644
17645	<interface
17646	name="IRuntimeErrorEvent" extends="IEvent"
17647	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17648	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17649	>
17650	<desc>
17651	Notification when an error happens during the virtual
17652	machine execution.
17653
17654	There are three kinds of runtime errors:
17655	<ul>
17656	<li><i>fatal</i></li>
17657	<li><i>non-fatal with retry</i></li>
17658	<li><i>non-fatal warnings</i></li>
17659	</ul>
17660
17661	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17662	to @c true. In case of fatal errors, the virtual machine
17663	execution is always paused before calling this notification, and
17664	the notification handler is supposed either to immediately save
17665	the virtual machine state using <link to="IConsole::saveState"/>
17666	or power it off using <link to="IConsole::powerDown"/>.
17667	Resuming the execution can lead to unpredictable results.
17668
17669	<b>Non-fatal</b> errors and warnings are indicated by the
17670	@a fatal parameter set to @c false. If the virtual machine
17671	is in the Paused state by the time the error notification is
17672	received, it means that the user can <i>try to resume</i> the machine
17673	execution after attempting to solve the problem that caused the
17674	error. In this case, the notification handler is supposed
17675	to show an appropriate message to the user (depending on the
17676	value of the @a id parameter) that offers several actions such
17677	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17678	wants to retry, the notification handler should continue
17679	the machine execution using the <link to="IConsole::resume"/>
17680	call. If the machine execution is not Paused during this
17681	notification, then it means this notification is a <i>warning</i>
17682	(for example, about a fatal condition that can happen very soon);
17683	no immediate action is required from the user, the machine
17684	continues its normal execution.
17685
17686	Note that in either case the notification handler
17687	<b>must not</b> perform any action directly on a thread
17688	where this notification is called. Everything it is allowed to
17689	do is to post a message to another thread that will then talk
17690	to the user and take the corresponding action.
17691
17692	Currently, the following error identifiers are known:
17693	<ul>
17694	<li><tt>"HostMemoryLow"</tt></li>
17695	<li><tt>"HostAudioNotResponding"</tt></li>
17696	<li><tt>"VDIStorageFull"</tt></li>
17697	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17698	</ul>
17699	</desc>
17700	<attribute name="fatal" type="boolean" readonly="yes">
17701	<desc>
17702	Whether the error is fatal or not.
17703	</desc>
17704	</attribute>
17705	<attribute name="id" type="wstring" readonly="yes">
17706	<desc>
17707	Error identifier.
17708	</desc>
17709	</attribute>
17710	<attribute name="message" type="wstring" readonly="yes">
17711	<desc>
17712	Optional error message.
17713	</desc>
17714	</attribute>
17715	</interface>
17716
17717
17718	<interface
17719	name="IEventSourceChangedEvent" extends="IEvent"
17720	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17721	waitable="yes"
17722	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17723	>
17724	<desc>
17725	Notification when an event source state changes (listener added or removed).
17726	</desc>
17727
17728	<attribute name="listener" type="IEventListener" readonly="yes">
17729	<desc>
17730	Event listener which has changed.
17731	</desc>
17732	</attribute>
17733
17734	<attribute name="add" type="boolean" readonly="yes">
17735	<desc>
17736	Flag whether listener was added or removed.
17737	</desc>
17738	</attribute>
17739	</interface>
17740
17741	<interface
17742	name="IExtraDataChangedEvent" extends="IEvent"
17743	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17744	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17745	>
17746	<desc>
17747	Notification when machine specific or global extra data
17748	has changed.
17749	</desc>
17750	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17751	<desc>
17752	ID of the machine this event relates to.
17753	Null for global extra data changes.
17754	</desc>
17755	</attribute>
17756	<attribute name="key" type="wstring" readonly="yes">
17757	<desc>
17758	Extra data key that has changed.
17759	</desc>
17760	</attribute>
17761	<attribute name="value" type="wstring" readonly="yes">
17762	<desc>
17763	Extra data value for the given key.
17764	</desc>
17765	</attribute>
17766	</interface>
17767
17768	<interface
17769	name="IVetoEvent" extends="IEvent"
17770	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17771	wsmap="managed"
17772	>
17773	<desc>Base abstract interface for veto events.</desc>
17774
17775	<method name="addVeto">
17776	<desc>
17777	Adds a veto on this event.
17778	</desc>
17779	<param name="reason" type="wstring" dir="in">
17780	<desc>
17781	Reason for veto, could be null or empty string.
17782	</desc>
17783	</param>
17784	</method>
17785
17786	<method name="isVetoed">
17787	<desc>
17788	If this event was vetoed.
17789	</desc>
17790	<param name="result" type="boolean" dir="return">
17791	<desc>
17792	Reason for veto.
17793	</desc>
17794	</param>
17795	</method>
17796
17797	<method name="getVetos">
17798	<desc>
17799	Current veto reason list, if size is 0 - no veto.
17800	</desc>
17801	<param name="result" type="wstring" dir="return" safearray="yes">
17802	<desc>
17803	Array of reasons for veto provided by different event handlers.
17804	</desc>
17805	</param>
17806	</method>
17807
17808	</interface>
17809
17810	<interface
17811	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17812	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17813	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17814	waitable="true"
17815	>
17816	<desc>
17817	Notification when someone tries to change extra data for
17818	either the given machine or (if @c null) global extra data.
17819	This gives the chance to veto against changes.
17820	</desc>
17821	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17822	<desc>
17823	ID of the machine this event relates to.
17824	Null for global extra data changes.
17825	</desc>
17826	</attribute>
17827	<attribute name="key" type="wstring" readonly="yes">
17828	<desc>
17829	Extra data key that has changed.
17830	</desc>
17831	</attribute>
17832	<attribute name="value" type="wstring" readonly="yes">
17833	<desc>
17834	Extra data value for the given key.
17835	</desc>
17836	</attribute>
17837	</interface>
17838
17839	<interface
17840	name="ICanShowWindowEvent" extends="IVetoEvent"
17841	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
17842	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
17843	waitable="true"
17844	>
17845	<desc>
17846	Notification when a call to
17847	<link to="IMachine::canShowConsoleWindow"/> is made by a
17848	front-end to check if a subsequent call to
17849	<link to="IMachine::showConsoleWindow"/> can succeed.
17850
17851	The callee should give an answer appropriate to the current
17852	machine state using event veto. This answer must
17853	remain valid at least until the next
17854	<link to="IConsole::state">machine state</link> change.
17855	</desc>
17856	</interface>
17857
17858	<interface
17859	name="IShowWindowEvent" extends="IEvent"
17860	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
17861	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
17862	waitable="true"
17863	>
17864	<desc>
17865	Notification when a call to
17866	<link to="IMachine::showConsoleWindow"/>
17867	requests the console window to be activated and brought to
17868	foreground on the desktop of the host PC.
17869
17870	This notification should cause the VM console process to
17871	perform the requested action as described above. If it is
17872	impossible to do it at a time of this notification, this
17873	method should return a failure.
17874
17875	Note that many modern window managers on many platforms
17876	implement some sort of focus stealing prevention logic, so
17877	that it may be impossible to activate a window without the
17878	help of the currently active application (which is supposedly
17879	an initiator of this notification). In this case, this method
17880	must return a non-zero identifier that represents the
17881	top-level window of the VM console process. The caller, if it
17882	represents a currently active process, is responsible to use
17883	this identifier (in a platform-dependent manner) to perform
17884	actual window activation.
17885
17886	This method must set @a winId to zero if it has performed all
17887	actions necessary to complete the request and the console
17888	window is now active and in foreground, to indicate that no
17889	further action is required on the caller's side.
17890	</desc>
17891	<attribute name="winId" type="long long">
17892	<desc>
17893	Platform-dependent identifier of the top-level VM console
17894	window, or zero if this method has performed all actions
17895	necessary to implement the <i>show window</i> semantics for
17896	the given platform and/or this VirtualBox front-end.
17897	</desc>
17898	</attribute>
17899	</interface>
17900
17901	<interface
17902	name="INATRedirectEvent" extends="IMachineEvent"
17903	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
17904	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
17905	>
17906	<desc>
17907	Notification when NAT redirect rule added or removed.
17908	</desc>
17909	<attribute name="slot" type="unsigned long" readonly="yes">
17910	<desc>
17911	Adapter which NAT attached to.
17912	</desc>
17913	</attribute>
17914	<attribute name="remove" type="boolean" readonly="yes">
17915	<desc>
17916	Whether rule remove or add.
17917	</desc>
17918	</attribute>
17919	<attribute name="name" type="wstring" readonly="yes">
17920	<desc>
17921	Name of the rule.
17922	</desc>
17923	</attribute>
17924	<attribute name="proto" type="NATProtocol" readonly="yes">
17925	<desc>
17926	Protocol (TCP or UDP) of the redirect rule.
17927	</desc>
17928	</attribute>
17929	<attribute name="hostIp" type="wstring" readonly="yes">
17930	<desc>
17931	Host ip address to bind socket on.
17932	</desc>
17933	</attribute>
17934	<attribute name="hostPort" type="long" readonly="yes">
17935	<desc>
17936	Host port to bind socket on.
17937	</desc>
17938	</attribute>
17939	<attribute name="guestIp" type="wstring" readonly="yes">
17940	<desc>
17941	Guest ip address to redirect to.
17942	</desc>
17943	</attribute>
17944	<attribute name="guestPort" type="long" readonly="yes">
17945	<desc>
17946	Guest port to redirect to.
17947	</desc>
17948	</attribute>
17949	</interface>
17950
17951	<interface
17952	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
17953	waitable="yes"
17954	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
17955	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
17956	>
17957	<desc>
17958	Notification when host PCI device is plugged/unplugged. Plugging
17959	usually takes place on VM startup, unplug - when
17960	<link to="IMachine::detachHostPciDevice"/> is called.
17961
17962	<see><link to="IMachine::detachHostPciDevice"/></see>
17963
17964	</desc>
17965
17966	<attribute name="plugged" type="boolean" readonly="yes">
17967	<desc>
17968	If device successfully plugged or unplugged.
17969	</desc>
17970	</attribute>
17971
17972	<attribute name="success" type="boolean" readonly="yes">
17973	<desc>
17974	If operation was successful, if false - 'message' attribute
17975	may be of interest.
17976	</desc>
17977	</attribute>
17978
17979	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
17980	<desc>
17981	Attachment info for this device.
17982	</desc>
17983	</attribute>
17984
17985	<attribute name="message" type="wstring" readonly="yes">
17986	<desc>
17987	Optional error message.
17988	</desc>
17989	</attribute>
17990
17991	</interface>
17992
17993	<interface
17994	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
17995	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
17996	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
17997	>
17998	<desc>
17999	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18000	unexpected circumstances) or available again.
18001	</desc>
18002
18003	<attribute name="available" type="boolean" readonly="yes">
18004	<desc>
18005	Whether VBoxSVC is available now.
18006	</desc>
18007	</attribute>
18008	</interface>
18009
18010	<interface
18011	name="IBandwidthGroupChangedEvent" extends="IEvent"
18012	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18013	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18014	>
18015	<desc>
18016	Notification when one of the bandwidth groups changed
18017	</desc>
18018	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18019	<desc>
18020	The changed bandwidth group.
18021	</desc>
18022	</attribute>
18023	</interface>
18024
18025	<enum
18026	name="GuestMonitorChangedEventType"
18027	uuid="ef172985-7e36-4297-95be-e46396968d66"
18028	>
18029
18030	<desc>
18031	How the guest monitor has been changed.
18032	</desc>
18033
18034	<const name="Enabled" value="0">
18035	<desc>
18036	The guest monitor has been enabled by the guest.
18037	</desc>
18038	</const>
18039
18040	<const name="Disabled" value="1">
18041	<desc>
18042	The guest monitor has been disabled by the guest.
18043	</desc>
18044	</const>
18045
18046	<const name="NewOrigin" value="2">
18047	<desc>
18048	The guest monitor origin has changed in the guest.
18049	</desc>
18050	</const>
18051	</enum>
18052
18053	<interface
18054	name="IGuestMonitorChangedEvent" extends="IEvent"
18055	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18056	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18057	>
18058	<desc>
18059	Notification when the guest enables one of its monitors.
18060	</desc>
18061
18062	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18063	<desc>
18064	What was changed for this guest monitor.
18065	</desc>
18066	</attribute>
18067
18068	<attribute name="screenId" type="unsigned long" readonly="yes">
18069	<desc>
18070	The monitor which was changed.
18071	</desc>
18072	</attribute>
18073
18074	<attribute name="originX" type="unsigned long" readonly="yes">
18075	<desc>
18076	Physical X origin relative to the primary screen.
18077	Valid for Enabled and NewOrigin.
18078	</desc>
18079	</attribute>
18080
18081	<attribute name="originY" type="unsigned long" readonly="yes">
18082	<desc>
18083	Physical Y origin relative to the primary screen.
18084	Valid for Enabled and NewOrigin.
18085	</desc>
18086	</attribute>
18087
18088	<attribute name="width" type="unsigned long" readonly="yes">
18089	<desc>
18090	Width of the screen.
18091	Valid for Enabled.
18092	</desc>
18093	</attribute>
18094
18095	<attribute name="height" type="unsigned long" readonly="yes">
18096	<desc>
18097	Height of the screen.
18098	Valid for Enabled.
18099	</desc>
18100	</attribute>
18101
18102	</interface>
18103
18104	<interface
18105	name="IStorageDeviceChangedEvent" extends="IEvent"
18106	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18107	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18108	>
18109	<desc>
18110	Notification when a
18111	<link to="IMachine::mediumAttachments">storage device</link>
18112	is attached or removed.
18113	</desc>
18114	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18115	<desc>
18116	Storage device that is subject to change.
18117	</desc>
18118	</attribute>
18119	<attribute name="removed" type="boolean" readonly="yes">
18120	<desc>
18121	Flag whether the device was removed or added to the VM.
18122	</desc>
18123	</attribute>
18124	</interface>
18125
18126	<module name="VBoxSVC" context="LocalServer">
18127	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18128	namespace="virtualbox.org">
18129	<interface name="IVirtualBox" default="yes"/>
18130	</class>
18131	</module>
18132
18133	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18134	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18135	namespace="virtualbox.org">
18136	<interface name="IVirtualBoxClient" default="yes"/>
18137	</class>
18138
18139	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18140	namespace="virtualbox.org">
18141	<interface name="ISession" default="yes"/>
18142	</class>
18143	</module>
18144
18145	</library>
18146
18147	</idl>
18148
18149	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format